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.13\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-06-30 15:51+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:2972 ../src/guestfs.pod:2976 ../src/guestfs.pod:2980 ../src/guestfs.pod:2984 ../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:2789 ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2810 ../src/guestfs-actions.pod:2817 ../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:2785 ../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:5979 ../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
5075 "Safety and liveness tests of components that libguestfs depends upon (not of "
5076 "libguestfs itself). Mainly this is for qemu and the kernel."
5080 #: ../src/guestfs.pod:2666
5085 #: ../src/guestfs.pod:2668
5086 msgid "Outside contributions, experimental parts."
5090 #: ../src/guestfs.pod:2670
5095 #: ../src/guestfs.pod:2672
5097 "The daemon that runs inside the libguestfs appliance and carries out "
5102 #: ../src/guestfs.pod:2675
5107 #: ../src/guestfs.pod:2677
5108 msgid "L<virt-df(1)> command and documentation."
5112 #: ../src/guestfs.pod:2679
5117 #: ../src/guestfs.pod:2681
5118 msgid "L<virt-edit(1)> command and documentation."
5122 #: ../src/guestfs.pod:2683
5127 #: ../src/guestfs.pod:2685
5128 msgid "C API example code."
5132 #: ../src/guestfs.pod:2687
5137 #: ../src/guestfs.pod:2689
5139 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5140 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5141 "L<virt-tar-out(1)>."
5145 #: ../src/guestfs.pod:2693
5150 #: ../src/guestfs.pod:2695
5151 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5155 #: ../src/guestfs.pod:2697
5156 msgid "C<generator>"
5160 #: ../src/guestfs.pod:2699
5162 "The crucially important generator, used to automatically generate large "
5163 "amounts of boilerplate C code for things like RPC and bindings."
5167 #: ../src/guestfs.pod:2702
5172 #: ../src/guestfs.pod:2704
5173 msgid "Files used by the test suite."
5177 #: ../src/guestfs.pod:2706
5178 msgid "Some \"phony\" guest images which we test against."
5182 #: ../src/guestfs.pod:2708
5183 msgid "C<inspector>"
5187 #: ../src/guestfs.pod:2710
5188 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5192 #: ../src/guestfs.pod:2712
5197 #: ../src/guestfs.pod:2714
5198 msgid "Logo used on the website. The fish is called Arthur by the way."
5202 #: ../src/guestfs.pod:2716
5207 #: ../src/guestfs.pod:2718
5208 msgid "M4 macros used by autoconf."
5212 #: ../src/guestfs.pod:2720
5217 #: ../src/guestfs.pod:2722
5218 msgid "Translations of simple gettext strings."
5222 #: ../src/guestfs.pod:2724
5227 #: ../src/guestfs.pod:2726
5229 "The build infrastructure and PO files for translations of manpages and POD "
5230 "files. Eventually this will be combined with the C<po> directory, but that "
5231 "is rather complicated."
5235 #: ../src/guestfs.pod:2730
5236 msgid "C<regressions>"
5240 #: ../src/guestfs.pod:2732
5241 msgid "Regression tests."
5245 #: ../src/guestfs.pod:2734
5250 #: ../src/guestfs.pod:2736
5251 msgid "L<virt-rescue(1)> command and documentation."
5255 #: ../src/guestfs.pod:2738
5260 #: ../src/guestfs.pod:2740
5261 msgid "Source code to the C library."
5265 #: ../src/guestfs.pod:2742
5270 #: ../src/guestfs.pod:2744
5271 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5275 #: ../src/guestfs.pod:2746
5276 msgid "C<test-tool>"
5280 #: ../src/guestfs.pod:2748
5282 "Test tool for end users to test if their qemu/kernel combination will work "
5287 #: ../src/guestfs.pod:2751
5292 #: ../src/guestfs.pod:2753
5297 #: ../src/guestfs.pod:2755
5302 #: ../src/guestfs.pod:2757
5307 #: ../src/guestfs.pod:2759
5312 #: ../src/guestfs.pod:2761
5317 #: ../src/guestfs.pod:2763
5322 #: ../src/guestfs.pod:2765
5327 #: ../src/guestfs.pod:2767
5328 msgid "Language bindings."
5332 #: ../src/guestfs.pod:2771
5337 #: ../src/guestfs.pod:2773
5338 msgid "PROTOCOL LIMITS"
5342 #: ../src/guestfs.pod:2775
5344 "Internally libguestfs uses a message-based protocol to pass API calls and "
5345 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5346 "plenty more detail about this). The maximum message size used by the "
5347 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5348 "aware of this limit. The API calls which may be affected are individually "
5349 "documented, with a link back to this section of the documentation."
5353 #: ../src/guestfs.pod:2783
5355 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5356 "a simple string. Because this string is at some point internally encoded as "
5357 "a message, the maximum size that it can return is slightly under 4 MB. If "
5358 "the requested file is larger than this then you will get an error."
5362 #: ../src/guestfs.pod:2789
5364 "In order to transfer large files into and out of the guest filesystem, you "
5365 "need to use particular calls that support this. The sections L</UPLOADING> "
5366 "and L</DOWNLOADING> document how to do this."
5370 #: ../src/guestfs.pod:2793
5372 "You might also consider mounting the disk image using our FUSE filesystem "
5373 "support (L<guestmount(1)>)."
5377 #: ../src/guestfs.pod:2796
5378 msgid "MAXIMUM NUMBER OF DISKS"
5382 #: ../src/guestfs.pod:2798
5383 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5387 #: ../src/guestfs.pod:2801
5389 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5390 "slots. However febootstrap only understands disks with names C</dev/vda> "
5391 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5396 #: ../src/guestfs.pod:2806
5398 "We are working to substantially raise this limit in future versions but it "
5399 "requires complex changes to qemu."
5403 #: ../src/guestfs.pod:2809
5405 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5406 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5407 "requires changes to qemu."
5411 #: ../src/guestfs.pod:2813
5412 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5416 #: ../src/guestfs.pod:2815
5417 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5421 #: ../src/guestfs.pod:2817
5423 "This is because it reserves 4 bits for the minor device number (thus "
5424 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5428 #: ../src/guestfs.pod:2820
5430 "If you attach a disk with more than 15 partitions, the extra partitions are "
5431 "ignored by libguestfs."
5435 #: ../src/guestfs.pod:2823
5436 msgid "MAXIMUM SIZE OF A DISK"
5440 #: ../src/guestfs.pod:2825
5441 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5445 #: ../src/guestfs.pod:2827
5447 "We have tested block devices up to 1 exabyte (2**60 or "
5448 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5453 #: ../src/guestfs.pod:2831
5455 "Although libguestfs probably does not impose any limit, the underlying host "
5456 "storage will. If you store disk images on a host ext4 filesystem, then the "
5457 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5458 "TB). If you store disk images as host logical volumes then you are limited "
5459 "by the maximum size of an LV."
5463 #: ../src/guestfs.pod:2837
5465 "For the hugest disk image files, we recommend using XFS on the host for "
5470 #: ../src/guestfs.pod:2840
5471 msgid "MAXIMUM SIZE OF A PARTITION"
5475 #: ../src/guestfs.pod:2842
5477 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5478 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5479 "address a partition located beyond 2 TB on the disk."
5483 #: ../src/guestfs.pod:2846
5485 "It is recommended that you use GPT partitions on disks which are larger than "
5486 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5487 "which are theoretically larger than the largest disk we could support."
5491 #: ../src/guestfs.pod:2851
5492 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5496 #: ../src/guestfs.pod:2853
5498 "This depends on the filesystem type. libguestfs itself does not impose any "
5499 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5500 "what these limits are."
5504 #: ../src/guestfs.pod:2857
5505 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5509 #: ../src/guestfs.pod:2859
5511 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5512 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5513 "uploads and downloads."
5517 #: ../src/guestfs.pod:2863
5518 msgid "INSPECTION LIMITS"
5522 #: ../src/guestfs.pod:2865
5524 "The inspection code has several arbitrary limits on things like the size of "
5525 "Windows Registry hive it will read, and the length of product name. These "
5526 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5527 "memory and disk space on the host, and should not be reached in practice. "
5528 "See the source code for more information."
5532 #: ../src/guestfs.pod:2871 ../fish/guestfish.pod:1017 ../test-tool/libguestfs-test-tool.pod:82
5533 msgid "ENVIRONMENT VARIABLES"
5537 #: ../src/guestfs.pod:2875 ../fish/guestfish.pod:1048
5538 msgid "LIBGUESTFS_APPEND"
5542 #: ../src/guestfs.pod:2877 ../fish/guestfish.pod:1050
5543 msgid "Pass additional options to the guest kernel."
5547 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1052
5548 msgid "LIBGUESTFS_DEBUG"
5552 #: ../src/guestfs.pod:2881
5554 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5555 "effect as calling C<guestfs_set_verbose (g, 1)>."
5559 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1057
5560 msgid "LIBGUESTFS_MEMSIZE"
5564 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1059
5565 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5569 #: ../src/guestfs.pod:2889 ../fish/guestfish.pod:1062
5572 " LIBGUESTFS_MEMSIZE=700\n"
5577 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1064
5578 msgid "LIBGUESTFS_PATH"
5582 #: ../src/guestfs.pod:2893
5584 "Set the path that libguestfs uses to search for a supermin appliance. See "
5585 "the discussion of paths in section L</PATH> above."
5589 #: ../src/guestfs.pod:2896 ../fish/guestfish.pod:1069
5590 msgid "LIBGUESTFS_QEMU"
5594 #: ../src/guestfs.pod:2898 ../fish/guestfish.pod:1071
5596 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5597 "which was found at compile time by the configure script is used."
5601 #: ../src/guestfs.pod:2902
5602 msgid "See also L</QEMU WRAPPERS> above."
5606 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1075
5607 msgid "LIBGUESTFS_TRACE"
5611 #: ../src/guestfs.pod:2906
5613 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5614 "effect as calling C<guestfs_set_trace (g, 1)>."
5618 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1084
5623 #: ../src/guestfs.pod:2911 ../fish/guestfish.pod:1086
5625 "Location of temporary directory, defaults to C</tmp> except for the cached "
5626 "supermin appliance which defaults to C</var/tmp>."
5630 #: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1089
5632 "If libguestfs was compiled to use the supermin appliance then the real "
5633 "appliance is cached in this directory, shared between all handles belonging "
5634 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5635 "use in case C</var/tmp> is not large enough."
5639 #: ../src/guestfs.pod:2922 ../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
5644 #: ../src/guestfs.pod:2924
5646 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5647 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5648 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5649 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5650 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5651 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5652 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5653 "L<http://libguestfs.org/>."
5657 #: ../src/guestfs.pod:2951
5659 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5660 "L<lvm(8)>, L<disktype(1)>."
5664 #: ../src/guestfs.pod:2958 ../tools/virt-win-reg.pl:759 ../tools/virt-make-fs.pl:553
5669 #: ../src/guestfs.pod:2960
5670 msgid "To get a list of bugs against libguestfs use this link:"
5674 #: ../src/guestfs.pod:2962
5675 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5679 #: ../src/guestfs.pod:2964
5680 msgid "To report a new bug against libguestfs use this link:"
5684 #: ../src/guestfs.pod:2966
5685 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5689 #: ../src/guestfs.pod:2968
5690 msgid "When reporting a bug, please check:"
5694 #: ../src/guestfs.pod:2974
5695 msgid "That the bug hasn't been reported already."
5699 #: ../src/guestfs.pod:2978
5700 msgid "That you are testing a recent version."
5704 #: ../src/guestfs.pod:2982
5705 msgid "Describe the bug accurately, and give a way to reproduce it."
5709 #: ../src/guestfs.pod:2986
5711 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5716 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1180 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5721 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1182 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5722 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5726 #: ../src/guestfs.pod:2995 ../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
5731 #: ../src/guestfs.pod:2997 ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:99
5732 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5736 #: ../src/guestfs.pod:3000
5738 "This library is free software; you can redistribute it and/or modify it "
5739 "under the terms of the GNU Lesser General Public License as published by the "
5740 "Free Software Foundation; either version 2 of the License, or (at your "
5741 "option) any later version."
5745 #: ../src/guestfs.pod:3005
5747 "This library is distributed in the hope that it will be useful, but WITHOUT "
5748 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5749 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5754 #: ../src/guestfs.pod:3010
5756 "You should have received a copy of the GNU Lesser General Public License "
5757 "along with this library; if not, write to the Free Software Foundation, "
5758 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5762 #: ../src/guestfs-actions.pod:1
5763 msgid "guestfs_add_cdrom"
5767 #: ../src/guestfs-actions.pod:3
5771 " guestfs_add_cdrom (guestfs_h *g,\n"
5772 " const char *filename);\n"
5777 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5778 msgid "This function adds a virtual CD-ROM disk image to the guest."
5782 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5783 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5787 #: ../src/guestfs-actions.pod:17
5789 "This call checks for the existence of C<filename>. This stops you from "
5790 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5791 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5796 #: ../src/guestfs-actions.pod:24
5798 "If you just want to add an ISO file (often you use this as an efficient way "
5799 "to transfer large files into the guest), then you should probably use "
5800 "C<guestfs_add_drive_ro> instead."
5804 #: ../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:2271 ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:2476 ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:3551 ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3591 ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:3774 ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3801 ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3984 ../src/guestfs-actions.pod:4007 ../src/guestfs-actions.pod:4039 ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4176 ../src/guestfs-actions.pod:4189 ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4221 ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4347 ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:4450 ../src/guestfs-actions.pod:4464 ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:4495 ../src/guestfs-actions.pod:4510 ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4711 ../src/guestfs-actions.pod:4730 ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:4759 ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4787 ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4870 ../src/guestfs-actions.pod:4909 ../src/guestfs-actions.pod:4929 ../src/guestfs-actions.pod:4943 ../src/guestfs-actions.pod:4960 ../src/guestfs-actions.pod:5009 ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5060 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5105 ../src/guestfs-actions.pod:5123 ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5314 ../src/guestfs-actions.pod:5336 ../src/guestfs-actions.pod:5354 ../src/guestfs-actions.pod:5386 ../src/guestfs-actions.pod:5452 ../src/guestfs-actions.pod:5469 ../src/guestfs-actions.pod:5482 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5785 ../src/guestfs-actions.pod:5804 ../src/guestfs-actions.pod:5823 ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5863 ../src/guestfs-actions.pod:5875 ../src/guestfs-actions.pod:5889 ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6012 ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6072 ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6112 ../src/guestfs-actions.pod:6129 ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6181 ../src/guestfs-actions.pod:6200 ../src/guestfs-actions.pod:6224 ../src/guestfs-actions.pod:6243 ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6277 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6344 ../src/guestfs-actions.pod:6377 ../src/guestfs-actions.pod:6499 ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:6645 ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6680 ../src/guestfs-actions.pod:6693 ../src/guestfs-actions.pod:6706 ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:6734 ../src/guestfs-actions.pod:6793 ../src/guestfs-actions.pod:6810 ../src/guestfs-actions.pod:6826 ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6859 ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6928 ../src/guestfs-actions.pod:6942 ../src/guestfs-actions.pod:6983 ../src/guestfs-actions.pod:6996 ../src/guestfs-actions.pod:7014 ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7084 ../src/guestfs-actions.pod:7203 ../src/guestfs-actions.pod:7221 ../src/guestfs-actions.pod:7235 ../src/guestfs-actions.pod:7290 ../src/guestfs-actions.pod:7303 ../src/guestfs-actions.pod:7348 ../src/guestfs-actions.pod:7381 ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7468 ../src/guestfs-actions.pod:7535 ../src/guestfs-actions.pod:7554 ../src/guestfs-actions.pod:7583
5805 msgid "This function returns 0 on success or -1 on error."
5809 #: ../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
5811 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5816 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:1949 ../src/guestfs-actions.pod:1970 ../src/guestfs-actions.pod:4535 ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6352 ../src/guestfs-actions.pod:6385 ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:7386 ../src/guestfs-actions.pod:7476 ../src/guestfs-actions.pod:7646 ../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
5818 "Deprecated functions will not be removed from the API, but the fact that "
5819 "they are deprecated indicates that there are problems with correct use of "
5824 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:2019 ../src/guestfs-actions.pod:2122 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:6014 ../src/guestfs-actions.pod:6131 ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:6736 ../src/guestfs-actions.pod:6861 ../src/guestfs-actions.pod:7390
5825 msgid "(Added in 0.3)"
5829 #: ../src/guestfs-actions.pod:41
5830 msgid "guestfs_add_domain"
5834 #: ../src/guestfs-actions.pod:43
5838 " guestfs_add_domain (guestfs_h *g,\n"
5839 " const char *dom,\n"
5845 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4856
5847 "You may supply a list of optional arguments to this call. Use zero or more "
5848 "of the following pairs of parameters, and terminate the list with C<-1> on "
5849 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5853 #: ../src/guestfs-actions.pod:53
5856 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5857 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5858 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5859 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5860 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
5865 #: ../src/guestfs-actions.pod:59
5867 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5868 "It works by connecting to libvirt, requesting the domain and domain XML from "
5869 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5874 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
5876 "The number of disks added is returned. This operation is atomic: if an "
5877 "error is returned, then no disks are added."
5881 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
5883 "This function does some minimal checks to make sure the libvirt domain is "
5884 "not running (unless C<readonly> is true). In a future version we will try "
5885 "to acquire the libvirt lock on each disk."
5889 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
5891 "Disks must be accessible locally. This often means that adding disks from a "
5892 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5893 "unless those disks are accessible via the same device path locally too."
5897 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
5899 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5900 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5901 "default libvirt URI (or one set through an environment variable, see the "
5902 "libvirt documentation for full details)."
5906 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
5908 "The optional C<live> flag controls whether this call will try to connect to "
5909 "a running virtual machine C<guestfsd> process if it sees a suitable "
5910 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5911 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5912 "DAEMONS> for more information."
5916 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
5918 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5919 "passed instead of the domain name. The C<dom> string is treated as a UUID "
5920 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
5925 #: ../src/guestfs-actions.pod:94
5927 "The other optional parameters are passed directly through to "
5928 "C<guestfs_add_drive_opts>."
5932 #: ../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:1991 ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2086 ../src/guestfs-actions.pod:2109 ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:2874 ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:5032 ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:5592 ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7414 ../src/guestfs-actions.pod:7427
5933 msgid "On error this function returns -1."
5937 #: ../src/guestfs-actions.pod:99
5938 msgid "(Added in 1.7.4)"
5942 #: ../src/guestfs-actions.pod:101
5943 msgid "guestfs_add_domain_va"
5947 #: ../src/guestfs-actions.pod:103
5951 " guestfs_add_domain_va (guestfs_h *g,\n"
5952 " const char *dom,\n"
5958 #: ../src/guestfs-actions.pod:108
5959 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5963 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4614 ../src/guestfs-actions.pod:4884 ../src/guestfs-actions.pod:4896
5964 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5968 #: ../src/guestfs-actions.pod:112
5969 msgid "guestfs_add_domain_argv"
5973 #: ../src/guestfs-actions.pod:114
5977 " guestfs_add_domain_argv (guestfs_h *g,\n"
5978 " const char *dom,\n"
5979 " const struct guestfs_add_domain_argv *optargs);\n"
5984 #: ../src/guestfs-actions.pod:119
5985 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5989 #: ../src/guestfs-actions.pod:123
5990 msgid "guestfs_add_drive"
5994 #: ../src/guestfs-actions.pod:125
5998 " guestfs_add_drive (guestfs_h *g,\n"
5999 " const char *filename);\n"
6004 #: ../src/guestfs-actions.pod:129
6006 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6007 "optional parameters, so the disk is added writable, with the format being "
6008 "detected automatically."
6012 #: ../src/guestfs-actions.pod:133
6014 "Automatic detection of the format opens you up to a potential security hole "
6015 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6016 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6017 "you should think about replacing calls to this function with calls to "
6018 "C<guestfs_add_drive_opts>, and specifying the format."
6022 #: ../src/guestfs-actions.pod:144
6023 msgid "guestfs_add_drive_opts"
6027 #: ../src/guestfs-actions.pod:146
6031 " guestfs_add_drive_opts (guestfs_h *g,\n"
6032 " const char *filename,\n"
6038 #: ../src/guestfs-actions.pod:156
6041 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6042 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6043 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6048 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6050 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6051 "The first time you call this function, the disk appears as C</dev/sda>, the "
6052 "second time as C</dev/sdb>, and so on."
6056 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6058 "You don't necessarily need to be root when using libguestfs. However you "
6059 "obviously do need sufficient permissions to access the filename for whatever "
6060 "operations you want to perform (ie. read access if you just want to read the "
6061 "image or write access if you want to modify the image)."
6065 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6066 msgid "This call checks that C<filename> exists."
6070 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3049
6071 msgid "The optional arguments are:"
6075 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6080 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6082 "If true then the image is treated as read-only. Writes are still allowed, "
6083 "but they are stored in a temporary snapshot overlay which is discarded at "
6084 "the end. The disk that you add is not modified."
6088 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6093 #: ../src/guestfs-actions.pod:185
6095 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6096 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6097 "Possible formats include C<raw> and C<qcow2>."
6101 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6103 "Automatic detection of the format opens you up to a potential security hole "
6104 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6105 "RHBZ#642934. Specifying the format closes this security hole."
6109 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6114 #: ../src/guestfs-actions.pod:196
6116 "This rarely-used option lets you emulate the behaviour of the deprecated "
6117 "C<guestfs_add_drive_with_if> call (q.v.)"
6121 #: ../src/guestfs-actions.pod:203
6122 msgid "(Added in 1.5.23)"
6126 #: ../src/guestfs-actions.pod:205
6127 msgid "guestfs_add_drive_opts_va"
6131 #: ../src/guestfs-actions.pod:207
6135 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6136 " const char *filename,\n"
6142 #: ../src/guestfs-actions.pod:212
6143 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6147 #: ../src/guestfs-actions.pod:216
6148 msgid "guestfs_add_drive_opts_argv"
6152 #: ../src/guestfs-actions.pod:218
6156 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6157 " const char *filename,\n"
6158 " const struct guestfs_add_drive_opts_argv "
6164 #: ../src/guestfs-actions.pod:223
6165 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6169 #: ../src/guestfs-actions.pod:227
6170 msgid "guestfs_add_drive_ro"
6174 #: ../src/guestfs-actions.pod:229
6178 " guestfs_add_drive_ro (guestfs_h *g,\n"
6179 " const char *filename);\n"
6184 #: ../src/guestfs-actions.pod:233
6186 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6187 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6188 "disk is added read-only, with the format being detected automatically."
6192 #: ../src/guestfs-actions.pod:240
6193 msgid "(Added in 1.0.38)"
6197 #: ../src/guestfs-actions.pod:242
6198 msgid "guestfs_add_drive_ro_with_if"
6202 #: ../src/guestfs-actions.pod:244
6206 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6207 " const char *filename,\n"
6208 " const char *iface);\n"
6213 #: ../src/guestfs-actions.pod:249
6215 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6216 "QEMU interface emulation to use at run time."
6220 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2361
6221 msgid "(Added in 1.0.84)"
6225 #: ../src/guestfs-actions.pod:263
6226 msgid "guestfs_add_drive_with_if"
6230 #: ../src/guestfs-actions.pod:265
6234 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6235 " const char *filename,\n"
6236 " const char *iface);\n"
6241 #: ../src/guestfs-actions.pod:270
6243 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6244 "QEMU interface emulation to use at run time."
6248 #: ../src/guestfs-actions.pod:284
6249 msgid "guestfs_aug_clear"
6253 #: ../src/guestfs-actions.pod:286
6257 " guestfs_aug_clear (guestfs_h *g,\n"
6258 " const char *augpath);\n"
6263 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6265 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6266 "L<augtool(1)> C<clear> command."
6270 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2111
6271 msgid "(Added in 1.3.4)"
6275 #: ../src/guestfs-actions.pod:297
6276 msgid "guestfs_aug_close"
6280 #: ../src/guestfs-actions.pod:299
6284 " guestfs_aug_close (guestfs_h *g);\n"
6289 #: ../src/guestfs-actions.pod:302
6291 "Close the current Augeas handle and free up any resources used by it. After "
6292 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6293 "any other Augeas functions."
6297 #: ../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:5643
6298 msgid "(Added in 0.7)"
6302 #: ../src/guestfs-actions.pod:311
6303 msgid "guestfs_aug_defnode"
6307 #: ../src/guestfs-actions.pod:313
6310 " struct guestfs_int_bool *\n"
6311 " guestfs_aug_defnode (guestfs_h *g,\n"
6312 " const char *name,\n"
6313 " const char *expr,\n"
6314 " const char *val);\n"
6319 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6320 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6324 #: ../src/guestfs-actions.pod:322
6326 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6327 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6328 "containing that single node."
6332 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6334 "On success this returns a pair containing the number of nodes in the "
6335 "nodeset, and a boolean flag if a node was created."
6339 #: ../src/guestfs-actions.pod:330
6341 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6342 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6346 #: ../src/guestfs-actions.pod:336
6347 msgid "guestfs_aug_defvar"
6351 #: ../src/guestfs-actions.pod:338
6355 " guestfs_aug_defvar (guestfs_h *g,\n"
6356 " const char *name,\n"
6357 " const char *expr);\n"
6362 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6364 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6365 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6369 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6371 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6372 "evaluates to something which is not a nodeset."
6376 #: ../src/guestfs-actions.pod:354
6377 msgid "guestfs_aug_get"
6381 #: ../src/guestfs-actions.pod:356
6385 " guestfs_aug_get (guestfs_h *g,\n"
6386 " const char *augpath);\n"
6391 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6393 "Look up the value associated with C<path>. If C<path> matches exactly one "
6394 "node, the C<value> is returned."
6398 #: ../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:1943 ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:2134 ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2530 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2957 ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3006 ../src/guestfs-actions.pod:3040 ../src/guestfs-actions.pod:3099 ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3746 ../src/guestfs-actions.pod:4096 ../src/guestfs-actions.pod:4266 ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:5178 ../src/guestfs-actions.pod:5371 ../src/guestfs-actions.pod:5541 ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:5768 ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6421 ../src/guestfs-actions.pod:6438 ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:7143 ../src/guestfs-actions.pod:7162 ../src/guestfs-actions.pod:7180 ../src/guestfs-actions.pod:7360 ../src/guestfs-actions.pod:7640
6400 "This function returns a string, or NULL on error. I<The caller must free "
6401 "the returned string after use>."
6405 #: ../src/guestfs-actions.pod:368
6406 msgid "guestfs_aug_init"
6410 #: ../src/guestfs-actions.pod:370
6414 " guestfs_aug_init (guestfs_h *g,\n"
6415 " const char *root,\n"
6421 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6423 "Create a new Augeas handle for editing configuration files. If there was "
6424 "any previous Augeas handle associated with this guestfs session, then it is "
6429 #: ../src/guestfs-actions.pod:379
6430 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6434 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6435 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6439 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6441 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6442 "logical I<or> of the following integers:"
6446 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6447 msgid "C<AUG_SAVE_BACKUP> = 1"
6451 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6452 msgid "Keep the original file with a C<.augsave> extension."
6456 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6457 msgid "C<AUG_SAVE_NEWFILE> = 2"
6461 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6463 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6464 "original. Overrides C<AUG_SAVE_BACKUP>."
6468 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6469 msgid "C<AUG_TYPE_CHECK> = 4"
6473 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6474 msgid "Typecheck lenses (can be expensive)."
6478 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6479 msgid "C<AUG_NO_STDINC> = 8"
6483 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6484 msgid "Do not use standard load path for modules."
6488 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6489 msgid "C<AUG_SAVE_NOOP> = 16"
6493 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6494 msgid "Make save a no-op, just record what would have been changed."
6498 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6499 msgid "C<AUG_NO_LOAD> = 32"
6503 #: ../src/guestfs-actions.pod:414
6504 msgid "Do not load the tree in C<guestfs_aug_init>."
6508 #: ../src/guestfs-actions.pod:418
6509 msgid "To close the handle, you can call C<guestfs_aug_close>."
6513 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6514 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6518 #: ../src/guestfs-actions.pod:426
6519 msgid "guestfs_aug_insert"
6523 #: ../src/guestfs-actions.pod:428
6527 " guestfs_aug_insert (guestfs_h *g,\n"
6528 " const char *augpath,\n"
6529 " const char *label,\n"
6535 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6537 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6538 "or after C<path> (depending on the boolean flag C<before>)."
6542 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6544 "C<path> must match exactly one existing node in the tree, and C<label> must "
6545 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6549 #: ../src/guestfs-actions.pod:446
6550 msgid "guestfs_aug_load"
6554 #: ../src/guestfs-actions.pod:448
6558 " guestfs_aug_load (guestfs_h *g);\n"
6563 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6564 msgid "Load files into the tree."
6568 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6569 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6573 #: ../src/guestfs-actions.pod:460
6574 msgid "guestfs_aug_ls"
6578 #: ../src/guestfs-actions.pod:462
6582 " guestfs_aug_ls (guestfs_h *g,\n"
6583 " const char *augpath);\n"
6588 #: ../src/guestfs-actions.pod:466
6590 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6591 "sorting the resulting nodes into alphabetical order."
6595 #: ../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:2206 ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2241 ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2308 ../src/guestfs-actions.pod:2379 ../src/guestfs-actions.pod:2428 ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:3059 ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3649 ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3728 ../src/guestfs-actions.pod:3833 ../src/guestfs-actions.pod:4238 ../src/guestfs-actions.pod:4993 ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5639 ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6546 ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:6771 ../src/guestfs-actions.pod:7253 ../src/guestfs-actions.pod:7273 ../src/guestfs-actions.pod:7320 ../src/guestfs-actions.pod:7492 ../src/guestfs-actions.pod:7511 ../src/guestfs-actions.pod:7597 ../src/guestfs-actions.pod:7616 ../src/guestfs-actions.pod:7662 ../src/guestfs-actions.pod:7681
6597 "This function returns a NULL-terminated array of strings (like "
6598 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6599 "strings and the array after use>."
6603 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:3413 ../src/guestfs-actions.pod:3444 ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4129 ../src/guestfs-actions.pod:4316 ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:4512 ../src/guestfs-actions.pod:4997 ../src/guestfs-actions.pod:5454 ../src/guestfs-actions.pod:5851 ../src/guestfs-actions.pod:5865 ../src/guestfs-actions.pod:5877 ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6985 ../src/guestfs-actions.pod:6998 ../src/guestfs-actions.pod:7237 ../src/guestfs-actions.pod:7480
6604 msgid "(Added in 0.8)"
6608 #: ../src/guestfs-actions.pod:475
6609 msgid "guestfs_aug_match"
6613 #: ../src/guestfs-actions.pod:477
6617 " guestfs_aug_match (guestfs_h *g,\n"
6618 " const char *augpath);\n"
6623 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6625 "Returns a list of paths which match the path expression C<path>. The "
6626 "returned paths are sufficiently qualified so that they match exactly one "
6627 "node in the current tree."
6631 #: ../src/guestfs-actions.pod:491
6632 msgid "guestfs_aug_mv"
6636 #: ../src/guestfs-actions.pod:493
6640 " guestfs_aug_mv (guestfs_h *g,\n"
6641 " const char *src,\n"
6642 " const char *dest);\n"
6647 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6649 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6650 "C<dest> is overwritten if it exists."
6654 #: ../src/guestfs-actions.pod:505
6655 msgid "guestfs_aug_rm"
6659 #: ../src/guestfs-actions.pod:507
6663 " guestfs_aug_rm (guestfs_h *g,\n"
6664 " const char *augpath);\n"
6669 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6670 msgid "Remove C<path> and all of its children."
6674 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
6675 msgid "On success this returns the number of entries which were removed."
6679 #: ../src/guestfs-actions.pod:519
6680 msgid "guestfs_aug_save"
6684 #: ../src/guestfs-actions.pod:521
6688 " guestfs_aug_save (guestfs_h *g);\n"
6693 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
6694 msgid "This writes all pending changes to disk."
6698 #: ../src/guestfs-actions.pod:526
6700 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6705 #: ../src/guestfs-actions.pod:533
6706 msgid "guestfs_aug_set"
6710 #: ../src/guestfs-actions.pod:535
6714 " guestfs_aug_set (guestfs_h *g,\n"
6715 " const char *augpath,\n"
6716 " const char *val);\n"
6721 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
6722 msgid "Set the value associated with C<path> to C<val>."
6726 #: ../src/guestfs-actions.pod:542
6728 "In the Augeas API, it is possible to clear a node by setting the value to "
6729 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6730 "this call. Instead you must use the C<guestfs_aug_clear> call."
6734 #: ../src/guestfs-actions.pod:551
6735 msgid "guestfs_available"
6739 #: ../src/guestfs-actions.pod:553
6743 " guestfs_available (guestfs_h *g,\n"
6744 " char *const *groups);\n"
6749 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
6751 "This command is used to check the availability of some groups of "
6752 "functionality in the appliance, which not all builds of the libguestfs "
6753 "appliance will be able to provide."
6757 #: ../src/guestfs-actions.pod:561
6759 "The libguestfs groups, and the functions that those groups correspond to, "
6760 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6761 "runtime by calling C<guestfs_available_all_groups>."
6765 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
6767 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6768 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6769 "and Augeas (configuration file editing) functions."
6773 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
6774 msgid "The command returns no error if I<all> requested groups are available."
6778 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
6780 "It fails with an error if one or more of the requested groups is unavailable "
6785 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
6787 "If an unknown group name is included in the list of groups then an error is "
6792 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
6797 #: ../src/guestfs-actions.pod:585
6798 msgid "You must call C<guestfs_launch> before calling this function."
6802 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
6804 "The reason is because we don't know what groups are supported by the "
6805 "appliance/daemon until it is running and can be queried."
6809 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
6811 "If a group of functions is available, this does not necessarily mean that "
6812 "they will work. You still have to check for errors when calling individual "
6813 "API functions even if they are available."
6817 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
6819 "It is usually the job of distro packagers to build complete functionality "
6820 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6821 "with all requirements satisfied, will support everything."
6825 #: ../src/guestfs-actions.pod:607
6827 "This call was added in version C<1.0.80>. In previous versions of "
6828 "libguestfs all you could do would be to speculatively execute a command to "
6829 "find out if the daemon implemented it. See also C<guestfs_version>."
6833 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
6834 msgid "(Added in 1.0.80)"
6838 #: ../src/guestfs-actions.pod:618
6839 msgid "guestfs_available_all_groups"
6843 #: ../src/guestfs-actions.pod:620
6847 " guestfs_available_all_groups (guestfs_h *g);\n"
6852 #: ../src/guestfs-actions.pod:623
6854 "This command returns a list of all optional groups that this daemon knows "
6855 "about. Note this returns both supported and unsupported groups. To find "
6856 "out which ones the daemon can actually support you have to call "
6857 "C<guestfs_available> on each member of the returned list."
6861 #: ../src/guestfs-actions.pod:629
6862 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6866 #: ../src/guestfs-actions.pod:635
6867 msgid "(Added in 1.3.15)"
6871 #: ../src/guestfs-actions.pod:637
6872 msgid "guestfs_base64_in"
6876 #: ../src/guestfs-actions.pod:639
6880 " guestfs_base64_in (guestfs_h *g,\n"
6881 " const char *base64file,\n"
6882 " const char *filename);\n"
6887 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
6888 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6892 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
6893 msgid "(Added in 1.3.5)"
6897 #: ../src/guestfs-actions.pod:651
6898 msgid "guestfs_base64_out"
6902 #: ../src/guestfs-actions.pod:653
6906 " guestfs_base64_out (guestfs_h *g,\n"
6907 " const char *filename,\n"
6908 " const char *base64file);\n"
6913 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
6915 "This command downloads the contents of C<filename>, writing it out to local "
6916 "file C<base64file> encoded as base64."
6920 #: ../src/guestfs-actions.pod:665
6921 msgid "guestfs_blockdev_flushbufs"
6925 #: ../src/guestfs-actions.pod:667
6929 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6930 " const char *device);\n"
6935 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
6936 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6940 #: ../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
6941 msgid "This uses the L<blockdev(8)> command."
6945 #: ../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
6946 msgid "(Added in 0.9.3)"
6950 #: ../src/guestfs-actions.pod:680
6951 msgid "guestfs_blockdev_getbsz"
6955 #: ../src/guestfs-actions.pod:682
6959 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6960 " const char *device);\n"
6965 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
6966 msgid "This returns the block size of a device."
6970 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788 ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
6972 "(Note this is different from both I<size in blocks> and I<filesystem block "
6977 #: ../src/guestfs-actions.pod:697
6978 msgid "guestfs_blockdev_getro"
6982 #: ../src/guestfs-actions.pod:699
6986 " guestfs_blockdev_getro (guestfs_h *g,\n"
6987 " const char *device);\n"
6992 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
6994 "Returns a boolean indicating if the block device is read-only (true if "
6995 "read-only, false if not)."
6999 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1919 ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:2072 ../src/guestfs-actions.pod:2097 ../src/guestfs-actions.pod:2120 ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3190 ../src/guestfs-actions.pod:3352 ../src/guestfs-actions.pod:3366 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3411 ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3442 ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3469 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:5142
7000 msgid "This function returns a C truth value on success or -1 on error."
7004 #: ../src/guestfs-actions.pod:712
7005 msgid "guestfs_blockdev_getsize64"
7009 #: ../src/guestfs-actions.pod:714
7013 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7014 " const char *device);\n"
7019 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7020 msgid "This returns the size of the device in bytes."
7024 #: ../src/guestfs-actions.pod:720
7025 msgid "See also C<guestfs_blockdev_getsz>."
7029 #: ../src/guestfs-actions.pod:728
7030 msgid "guestfs_blockdev_getss"
7034 #: ../src/guestfs-actions.pod:730
7038 " guestfs_blockdev_getss (guestfs_h *g,\n"
7039 " const char *device);\n"
7044 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7046 "This returns the size of sectors on a block device. Usually 512, but can be "
7047 "larger for modern devices."
7051 #: ../src/guestfs-actions.pod:737
7053 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7058 #: ../src/guestfs-actions.pod:746
7059 msgid "guestfs_blockdev_getsz"
7063 #: ../src/guestfs-actions.pod:748
7067 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7068 " const char *device);\n"
7073 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7075 "This returns the size of the device in units of 512-byte sectors (even if "
7076 "the sectorsize isn't 512 bytes ... weird)."
7080 #: ../src/guestfs-actions.pod:755
7082 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7083 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7087 #: ../src/guestfs-actions.pod:765
7088 msgid "guestfs_blockdev_rereadpt"
7092 #: ../src/guestfs-actions.pod:767
7096 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7097 " const char *device);\n"
7102 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7103 msgid "Reread the partition table on C<device>."
7107 #: ../src/guestfs-actions.pod:779
7108 msgid "guestfs_blockdev_setbsz"
7112 #: ../src/guestfs-actions.pod:781
7116 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7117 " const char *device,\n"
7118 " int blocksize);\n"
7123 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7124 msgid "This sets the block size of a device."
7128 #: ../src/guestfs-actions.pod:797
7129 msgid "guestfs_blockdev_setro"
7133 #: ../src/guestfs-actions.pod:799
7137 " guestfs_blockdev_setro (guestfs_h *g,\n"
7138 " const char *device);\n"
7143 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7144 msgid "Sets the block device named C<device> to read-only."
7148 #: ../src/guestfs-actions.pod:811
7149 msgid "guestfs_blockdev_setrw"
7153 #: ../src/guestfs-actions.pod:813
7157 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7158 " const char *device);\n"
7163 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7164 msgid "Sets the block device named C<device> to read-write."
7168 #: ../src/guestfs-actions.pod:825
7169 msgid "guestfs_case_sensitive_path"
7173 #: ../src/guestfs-actions.pod:827
7177 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7178 " const char *path);\n"
7183 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
7185 "This can be used to resolve case insensitive paths on a filesystem which is "
7186 "case sensitive. The use case is to resolve paths which you have read from "
7187 "Windows configuration files or the Windows Registry, to the true path."
7191 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
7193 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7194 "(and probably others), which is that although the underlying filesystem is "
7195 "case-insensitive, the driver exports the filesystem to Linux as "
7200 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
7202 "One consequence of this is that special directories such as C<c:\\windows> "
7203 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7204 "precise details of how they were created. In Windows itself this would not "
7209 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
7211 "Bug or feature? You decide: "
7212 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7216 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
7218 "This function resolves the true case of each element in the path and returns "
7219 "the case-sensitive path."
7223 #: ../src/guestfs-actions.pod:853
7225 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7226 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7227 "how the directories were originally created under Windows)."
7231 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
7232 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7236 #: ../src/guestfs-actions.pod:861
7237 msgid "See also C<guestfs_realpath>."
7241 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7165
7242 msgid "(Added in 1.0.75)"
7246 #: ../src/guestfs-actions.pod:868
7251 #: ../src/guestfs-actions.pod:870
7255 " guestfs_cat (guestfs_h *g,\n"
7256 " const char *path);\n"
7261 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5629 ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3717
7262 msgid "Return the contents of the file named C<path>."
7266 #: ../src/guestfs-actions.pod:876
7268 "Note that this function cannot correctly handle binary files (specifically, "
7269 "files containing C<\\0> character which is treated as end of string). For "
7270 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7271 "functions which have a more complex interface."
7275 #: ../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:2226 ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2312 ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:5411 ../src/guestfs-actions.pod:5437 ../src/guestfs-actions.pod:5568 ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6550 ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6751 ../src/guestfs-actions.pod:6775 ../src/guestfs-actions.pod:7444 ../src/guestfs-actions.pod:7470 ../src/guestfs-actions.pod:7496 ../src/guestfs-actions.pod:7515 ../src/guestfs-actions.pod:7601 ../src/guestfs-actions.pod:7620 ../src/guestfs-actions.pod:7666 ../src/guestfs-actions.pod:7685 ../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
7277 "Because of the message protocol, there is a transfer limit of somewhere "
7278 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7282 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:3749 ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:5517 ../src/guestfs-actions.pod:5531 ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7338
7283 msgid "(Added in 0.4)"
7287 #: ../src/guestfs-actions.pod:889
7288 msgid "guestfs_checksum"
7292 #: ../src/guestfs-actions.pod:891
7296 " guestfs_checksum (guestfs_h *g,\n"
7297 " const char *csumtype,\n"
7298 " const char *path);\n"
7303 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
7304 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7308 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
7310 "The type of checksum to compute is given by the C<csumtype> parameter which "
7311 "must have one of the following values:"
7315 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
7320 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
7322 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7327 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
7332 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
7333 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7337 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
7342 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
7343 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7347 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
7352 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
7353 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7357 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
7362 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
7363 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7367 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
7372 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
7373 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7377 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
7382 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
7383 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7387 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
7388 msgid "The checksum is returned as a printable string."
7392 #: ../src/guestfs-actions.pod:937
7393 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7397 #: ../src/guestfs-actions.pod:939
7398 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7402 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:2088 ../src/guestfs-actions.pod:3368 ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:7021
7403 msgid "(Added in 1.0.2)"
7407 #: ../src/guestfs-actions.pod:946
7408 msgid "guestfs_checksum_device"
7412 #: ../src/guestfs-actions.pod:948
7416 " guestfs_checksum_device (guestfs_h *g,\n"
7417 " const char *csumtype,\n"
7418 " const char *device);\n"
7423 #: ../src/guestfs-actions.pod:953
7425 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7426 "device named C<device>. For the types of checksums supported see the "
7427 "C<guestfs_checksum> command."
7431 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5144 ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:5338 ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:6944 ../src/guestfs-actions.pod:7350
7432 msgid "(Added in 1.3.2)"
7436 #: ../src/guestfs-actions.pod:962
7437 msgid "guestfs_checksums_out"
7441 #: ../src/guestfs-actions.pod:964
7445 " guestfs_checksums_out (guestfs_h *g,\n"
7446 " const char *csumtype,\n"
7447 " const char *directory,\n"
7448 " const char *sumsfile);\n"
7453 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
7455 "This command computes the checksums of all regular files in C<directory> and "
7456 "then emits a list of those checksums to the local output file C<sumsfile>."
7460 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
7462 "This can be used for verifying the integrity of a virtual machine. However "
7463 "to be properly secure you should pay attention to the output of the checksum "
7464 "command (it uses the ones from GNU coreutils). In particular when the "
7465 "filename is not printable, coreutils uses a special backslash syntax. For "
7466 "more information, see the GNU coreutils info file."
7470 #: ../src/guestfs-actions.pod:984
7471 msgid "(Added in 1.3.7)"
7475 #: ../src/guestfs-actions.pod:986
7476 msgid "guestfs_chmod"
7480 #: ../src/guestfs-actions.pod:988
7484 " guestfs_chmod (guestfs_h *g,\n"
7486 " const char *path);\n"
7491 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
7493 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7498 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
7500 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7501 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7506 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4690 ../src/guestfs-actions.pod:4709 ../src/guestfs-actions.pod:4728 ../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
7507 msgid "The mode actually set is affected by the umask."
7511 #: ../src/guestfs-actions.pod:1006
7512 msgid "guestfs_chown"
7516 #: ../src/guestfs-actions.pod:1008
7520 " guestfs_chown (guestfs_h *g,\n"
7523 " const char *path);\n"
7528 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
7529 msgid "Change the file owner to C<owner> and group to C<group>."
7533 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3587 ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2464
7535 "Only numeric uid and gid are supported. If you want to use names, you will "
7536 "need to locate and parse the password file yourself (Augeas support makes "
7537 "this relatively easy)."
7541 #: ../src/guestfs-actions.pod:1024
7542 msgid "guestfs_command"
7546 #: ../src/guestfs-actions.pod:1026
7550 " guestfs_command (guestfs_h *g,\n"
7551 " char *const *arguments);\n"
7556 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
7558 "This call runs a command from the guest filesystem. The filesystem must be "
7559 "mounted, and must contain a compatible operating system (ie. something "
7560 "Linux, with the same or compatible processor architecture)."
7564 #: ../src/guestfs-actions.pod:1035
7566 "The single parameter is an argv-style list of arguments. The first element "
7567 "is the name of the program to run. Subsequent elements are parameters. The "
7568 "list must be non-empty (ie. must contain a program name). Note that the "
7569 "command runs directly, and is I<not> invoked via the shell (see "
7574 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
7575 msgid "The return value is anything printed to I<stdout> by the command."
7579 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
7581 "If the command returns a non-zero exit status, then this function returns an "
7582 "error message. The error message string is the content of I<stderr> from "
7587 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
7589 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7590 "C</bin>. If you require a program from another location, you should provide "
7591 "the full path in the first parameter."
7595 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
7597 "Shared libraries and data files required by the program must be available on "
7598 "filesystems which are mounted in the correct places. It is the caller's "
7599 "responsibility to ensure all filesystems that are needed are mounted at the "
7604 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1551
7605 msgid "(Added in 0.9.1)"
7609 #: ../src/guestfs-actions.pod:1068
7610 msgid "guestfs_command_lines"
7614 #: ../src/guestfs-actions.pod:1070
7618 " guestfs_command_lines (guestfs_h *g,\n"
7619 " char *const *arguments);\n"
7624 #: ../src/guestfs-actions.pod:1074
7626 "This is the same as C<guestfs_command>, but splits the result into a list of "
7631 #: ../src/guestfs-actions.pod:1077
7632 msgid "See also: C<guestfs_sh_lines>"
7636 #: ../src/guestfs-actions.pod:1088
7637 msgid "guestfs_config"
7641 #: ../src/guestfs-actions.pod:1090
7645 " guestfs_config (guestfs_h *g,\n"
7646 " const char *qemuparam,\n"
7647 " const char *qemuvalue);\n"
7652 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
7654 "This can be used to add arbitrary qemu command line parameters of the form "
7655 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7656 "setting some parameters which would interfere with parameters that we use."
7660 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
7661 msgid "The first character of C<param> string must be a C<-> (dash)."
7665 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
7666 msgid "C<value> can be NULL."
7670 #: ../src/guestfs-actions.pod:1108
7671 msgid "guestfs_copy_size"
7675 #: ../src/guestfs-actions.pod:1110
7679 " guestfs_copy_size (guestfs_h *g,\n"
7680 " const char *src,\n"
7681 " const char *dest,\n"
7687 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
7689 "This command copies exactly C<size> bytes from one source device or file "
7690 "C<src> to another destination device or file C<dest>."
7694 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
7696 "Note this will fail if the source is too short or if the destination is not "
7701 #: ../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:3568 ../src/guestfs-actions.pod:7016 ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7537 ../src/guestfs-actions.pod:7556
7703 "This long-running command can generate progress notification messages so "
7704 "that the caller can display a progress bar or indicator. To receive these "
7705 "messages, the caller must register a progress event callback. See "
7706 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7710 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:7257 ../src/guestfs-actions.pod:7277 ../src/guestfs-actions.pod:7363
7711 msgid "(Added in 1.0.87)"
7715 #: ../src/guestfs-actions.pod:1131
7720 #: ../src/guestfs-actions.pod:1133
7724 " guestfs_cp (guestfs_h *g,\n"
7725 " const char *src,\n"
7726 " const char *dest);\n"
7731 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
7733 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7734 "destination filename or destination directory."
7738 #: ../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:5011 ../src/guestfs-actions.pod:5388
7739 msgid "(Added in 1.0.18)"
7743 #: ../src/guestfs-actions.pod:1145
7744 msgid "guestfs_cp_a"
7748 #: ../src/guestfs-actions.pod:1147
7752 " guestfs_cp_a (guestfs_h *g,\n"
7753 " const char *src,\n"
7754 " const char *dest);\n"
7759 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
7761 "This copies a file or directory from C<src> to C<dest> recursively using the "
7766 #: ../src/guestfs-actions.pod:1159
7771 #: ../src/guestfs-actions.pod:1161
7775 " guestfs_dd (guestfs_h *g,\n"
7776 " const char *src,\n"
7777 " const char *dest);\n"
7782 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
7784 "This command copies from one source device or file C<src> to another "
7785 "destination device or file C<dest>. Normally you would use this to copy to "
7786 "or from a device or partition, for example to duplicate a filesystem."
7790 #: ../src/guestfs-actions.pod:1171
7792 "If the destination is a device, it must be as large or larger than the "
7793 "source file or device, otherwise the copy will fail. This command cannot do "
7794 "partial copies (see C<guestfs_copy_size>)."
7798 #: ../src/guestfs-actions.pod:1179
7803 #: ../src/guestfs-actions.pod:1181
7807 " guestfs_df (guestfs_h *g);\n"
7812 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
7813 msgid "This command runs the C<df> command to report disk space used."
7817 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
7819 "This command is mostly useful for interactive sessions. It is I<not> "
7820 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7825 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210 ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2291 ../src/guestfs-actions.pod:2315 ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:4379 ../src/guestfs-actions.pod:4911 ../src/guestfs-actions.pod:6754 ../src/guestfs-actions.pod:6778 ../src/guestfs-actions.pod:7403 ../src/guestfs-actions.pod:7416 ../src/guestfs-actions.pod:7429
7826 msgid "(Added in 1.0.54)"
7830 #: ../src/guestfs-actions.pod:1195
7831 msgid "guestfs_df_h"
7835 #: ../src/guestfs-actions.pod:1197
7839 " guestfs_df_h (guestfs_h *g);\n"
7844 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
7846 "This command runs the C<df -h> command to report disk space used in "
7847 "human-readable format."
7851 #: ../src/guestfs-actions.pod:1212
7852 msgid "guestfs_dmesg"
7856 #: ../src/guestfs-actions.pod:1214
7860 " guestfs_dmesg (guestfs_h *g);\n"
7865 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
7867 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7868 "This is sometimes useful for extended debugging of problems."
7872 #: ../src/guestfs-actions.pod:1221
7874 "Another way to get the same information is to enable verbose messages with "
7875 "C<guestfs_set_verbose> or by setting the environment variable "
7876 "C<LIBGUESTFS_DEBUG=1> before running the program."
7880 #: ../src/guestfs-actions.pod:1231
7881 msgid "guestfs_download"
7885 #: ../src/guestfs-actions.pod:1233
7889 " guestfs_download (guestfs_h *g,\n"
7890 " const char *remotefilename,\n"
7891 " const char *filename);\n"
7896 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263 ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
7898 "Download file C<remotefilename> and save it as C<filename> on the local "
7903 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4668
7904 msgid "C<filename> can also be a named pipe."
7908 #: ../src/guestfs-actions.pod:1243
7909 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7913 #: ../src/guestfs-actions.pod:1254
7914 msgid "guestfs_download_offset"
7918 #: ../src/guestfs-actions.pod:1256
7922 " guestfs_download_offset (guestfs_h *g,\n"
7923 " const char *remotefilename,\n"
7924 " const char *filename,\n"
7925 " int64_t offset,\n"
7931 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
7933 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7934 "region must be within the file or device)."
7938 #: ../src/guestfs-actions.pod:1269
7940 "Note that there is no limit on the amount of data that can be downloaded "
7941 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7942 "full amount unless an error occurs."
7946 #: ../src/guestfs-actions.pod:1274
7947 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7951 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:7055
7952 msgid "(Added in 1.5.17)"
7956 #: ../src/guestfs-actions.pod:1285
7957 msgid "guestfs_drop_caches"
7961 #: ../src/guestfs-actions.pod:1287
7965 " guestfs_drop_caches (guestfs_h *g,\n"
7966 " int whattodrop);\n"
7971 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
7973 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7974 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7975 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7979 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
7980 msgid "Setting C<whattodrop> to 3 should drop everything."
7984 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
7986 "This automatically calls L<sync(2)> before the operation, so that the "
7987 "maximum guest memory is freed."
7991 #: ../src/guestfs-actions.pod:1305
7996 #: ../src/guestfs-actions.pod:1307
8000 " guestfs_du (guestfs_h *g,\n"
8001 " const char *path);\n"
8006 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
8008 "This command runs the C<du -s> command to estimate file space usage for "
8013 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
8015 "C<path> can be a file or a directory. If C<path> is a directory then the "
8016 "estimate includes the contents of the directory and all subdirectories "
8021 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
8022 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8026 #: ../src/guestfs-actions.pod:1330
8027 msgid "guestfs_e2fsck_f"
8031 #: ../src/guestfs-actions.pod:1332
8035 " guestfs_e2fsck_f (guestfs_h *g,\n"
8036 " const char *device);\n"
8041 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
8043 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8044 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8049 #: ../src/guestfs-actions.pod:1340
8051 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8052 "Normally you should use C<guestfs_fsck>."
8056 #: ../src/guestfs-actions.pod:1345
8057 msgid "(Added in 1.0.29)"
8061 #: ../src/guestfs-actions.pod:1347
8062 msgid "guestfs_echo_daemon"
8066 #: ../src/guestfs-actions.pod:1349
8070 " guestfs_echo_daemon (guestfs_h *g,\n"
8071 " char *const *words);\n"
8076 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
8078 "This command concatenates the list of C<words> passed with single spaces "
8079 "between them and returns the resulting string."
8083 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
8084 msgid "You can use this command to test the connection through to the daemon."
8088 #: ../src/guestfs-actions.pod:1358
8089 msgid "See also C<guestfs_ping_daemon>."
8093 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:6226
8094 msgid "(Added in 1.0.69)"
8098 #: ../src/guestfs-actions.pod:1365
8099 msgid "guestfs_egrep"
8103 #: ../src/guestfs-actions.pod:1367
8107 " guestfs_egrep (guestfs_h *g,\n"
8108 " const char *regex,\n"
8109 " const char *path);\n"
8114 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
8115 msgid "This calls the external C<egrep> program and returns the matching lines."
8119 #: ../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:2229 ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:2404 ../src/guestfs-actions.pod:2417 ../src/guestfs-actions.pod:2432 ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2500 ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:3776 ../src/guestfs-actions.pod:3789 ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:5722 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:6622 ../src/guestfs-actions.pod:6634 ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:6682 ../src/guestfs-actions.pod:6695 ../src/guestfs-actions.pod:6708 ../src/guestfs-actions.pod:6721 ../src/guestfs-actions.pod:7499 ../src/guestfs-actions.pod:7518 ../src/guestfs-actions.pod:7604 ../src/guestfs-actions.pod:7623 ../src/guestfs-actions.pod:7669 ../src/guestfs-actions.pod:7688
8120 msgid "(Added in 1.0.66)"
8124 #: ../src/guestfs-actions.pod:1384
8125 msgid "guestfs_egrepi"
8129 #: ../src/guestfs-actions.pod:1386
8133 " guestfs_egrepi (guestfs_h *g,\n"
8134 " const char *regex,\n"
8135 " const char *path);\n"
8140 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
8141 msgid "This calls the external C<egrep -i> program and returns the matching lines."
8145 #: ../src/guestfs-actions.pod:1403
8146 msgid "guestfs_equal"
8150 #: ../src/guestfs-actions.pod:1405
8154 " guestfs_equal (guestfs_h *g,\n"
8155 " const char *file1,\n"
8156 " const char *file2);\n"
8161 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
8163 "This compares the two files C<file1> and C<file2> and returns true if their "
8164 "content is exactly equal, or false otherwise."
8168 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
8169 msgid "The external L<cmp(1)> program is used for the comparison."
8173 #: ../src/guestfs-actions.pod:1419
8174 msgid "guestfs_exists"
8178 #: ../src/guestfs-actions.pod:1421
8182 " guestfs_exists (guestfs_h *g,\n"
8183 " const char *path);\n"
8188 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
8190 "This returns C<true> if and only if there is a file, directory (or anything) "
8191 "with the given C<path> name."
8195 #: ../src/guestfs-actions.pod:1428
8196 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8200 #: ../src/guestfs-actions.pod:1434
8201 msgid "guestfs_fallocate"
8205 #: ../src/guestfs-actions.pod:1436
8209 " guestfs_fallocate (guestfs_h *g,\n"
8210 " const char *path,\n"
8216 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467 ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8218 "This command preallocates a file (containing zero bytes) named C<path> of "
8219 "size C<len> bytes. If the file exists already, it is overwritten."
8223 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
8225 "Do not confuse this with the guestfish-specific C<alloc> command which "
8226 "allocates a file in the host and attaches it as a device."
8230 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
8232 "This function is deprecated. In new code, use the C<fallocate64> call "
8237 #: ../src/guestfs-actions.pod:1460
8238 msgid "guestfs_fallocate64"
8242 #: ../src/guestfs-actions.pod:1462
8246 " guestfs_fallocate64 (guestfs_h *g,\n"
8247 " const char *path,\n"
8253 #: ../src/guestfs-actions.pod:1471
8255 "Note that this call allocates disk blocks for the file. To create a sparse "
8256 "file use C<guestfs_truncate_size> instead."
8260 #: ../src/guestfs-actions.pod:1474
8262 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8263 "oversight it only allowed 30 bit lengths to be specified, effectively "
8264 "limiting the maximum size of files created through that call to 1GB."
8268 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
8270 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8271 "commands which create a file in the host and attach it as a device."
8275 #: ../src/guestfs-actions.pod:1485
8276 msgid "(Added in 1.3.17)"
8280 #: ../src/guestfs-actions.pod:1487
8281 msgid "guestfs_fgrep"
8285 #: ../src/guestfs-actions.pod:1489
8289 " guestfs_fgrep (guestfs_h *g,\n"
8290 " const char *pattern,\n"
8291 " const char *path);\n"
8296 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
8297 msgid "This calls the external C<fgrep> program and returns the matching lines."
8301 #: ../src/guestfs-actions.pod:1506
8302 msgid "guestfs_fgrepi"
8306 #: ../src/guestfs-actions.pod:1508
8310 " guestfs_fgrepi (guestfs_h *g,\n"
8311 " const char *pattern,\n"
8312 " const char *path);\n"
8317 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
8318 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8322 #: ../src/guestfs-actions.pod:1525
8323 msgid "guestfs_file"
8327 #: ../src/guestfs-actions.pod:1527
8331 " guestfs_file (guestfs_h *g,\n"
8332 " const char *path);\n"
8337 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
8339 "This call uses the standard L<file(1)> command to determine the type or "
8340 "contents of the file."
8344 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
8346 "This call will also transparently look inside various types of compressed "
8351 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
8353 "The exact command which runs is C<file -zb path>. Note in particular that "
8354 "the filename is not prepended to the output (the I<-b> option)."
8358 #: ../src/guestfs-actions.pod:1541 ../fish/guestfish-actions.pod:1019
8360 "The output depends on the output of the underlying L<file(1)> command and it "
8361 "can change in future in ways beyond our control. In other words, the output "
8362 "is not guaranteed by the ABI."
8366 #: ../src/guestfs-actions.pod:1545
8368 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8369 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8373 #: ../src/guestfs-actions.pod:1553
8374 msgid "guestfs_file_architecture"
8378 #: ../src/guestfs-actions.pod:1555
8382 " guestfs_file_architecture (guestfs_h *g,\n"
8383 " const char *filename);\n"
8388 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1030
8390 "This detects the architecture of the binary C<filename>, and returns it if "
8395 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
8396 msgid "Currently defined architectures are:"
8400 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1037
8405 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1039
8407 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8408 "irrespective of the precise processor requirements of the binary."
8412 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
8417 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1044
8418 msgid "64 bit x86-64."
8422 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1046
8427 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1048
8428 msgid "32 bit SPARC."
8432 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1050
8437 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1052
8438 msgid "64 bit SPARC V9 and above."
8442 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1054
8447 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1056
8448 msgid "Intel Itanium."
8452 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1058
8457 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1060
8458 msgid "32 bit Power PC."
8462 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1062
8467 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1064
8468 msgid "64 bit Power PC."
8472 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1068
8473 msgid "Libguestfs may return other architecture strings in future."
8477 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1070
8478 msgid "The function works on at least the following types of files:"
8482 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1076
8483 msgid "many types of Un*x and Linux binary"
8487 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1080
8488 msgid "many types of Un*x and Linux shared library"
8492 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1084
8493 msgid "Windows Win32 and Win64 binaries"
8497 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1088
8498 msgid "Windows Win32 and Win64 DLLs"
8502 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1090
8503 msgid "Win32 binaries and DLLs return C<i386>."
8507 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1092
8508 msgid "Win64 binaries and DLLs return C<x86_64>."
8512 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1096
8513 msgid "Linux kernel modules"
8517 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1100
8518 msgid "Linux new-style initrd images"
8522 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1104
8523 msgid "some non-x86 Linux vmlinuz kernels"
8527 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1108
8528 msgid "What it can't do currently:"
8532 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1114
8533 msgid "static libraries (libfoo.a)"
8537 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1118
8538 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8542 #: ../src/guestfs-actions.pod:1651 ../fish/guestfish-actions.pod:1122
8543 msgid "x86 Linux vmlinuz kernels"
8547 #: ../src/guestfs-actions.pod:1653 ../fish/guestfish-actions.pod:1124
8549 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8550 "compressed code, and are horribly hard to unpack. If you want to find the "
8551 "architecture of a kernel, use the architecture of the associated initrd or "
8552 "kernel module(s) instead."
8556 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2533 ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2689 ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2894 ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3339 ../src/guestfs-actions.pod:3471
8557 msgid "(Added in 1.5.3)"
8561 #: ../src/guestfs-actions.pod:1665
8562 msgid "guestfs_filesize"
8566 #: ../src/guestfs-actions.pod:1667
8570 " guestfs_filesize (guestfs_h *g,\n"
8571 " const char *file);\n"
8576 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1135
8577 msgid "This command returns the size of C<file> in bytes."
8581 #: ../src/guestfs-actions.pod:1673
8583 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8584 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8585 "devices, use C<guestfs_blockdev_getsize64>."
8589 #: ../src/guestfs-actions.pod:1679
8590 msgid "(Added in 1.0.82)"
8594 #: ../src/guestfs-actions.pod:1681
8595 msgid "guestfs_fill"
8599 #: ../src/guestfs-actions.pod:1683
8603 " guestfs_fill (guestfs_h *g,\n"
8606 " const char *path);\n"
8611 #: ../src/guestfs-actions.pod:1689 ../fish/guestfish-actions.pod:1145
8613 "This command creates a new file called C<path>. The initial content of the "
8614 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8619 #: ../src/guestfs-actions.pod:1693
8621 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8622 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8623 "bytes use C<guestfs_fill_pattern>."
8627 #: ../src/guestfs-actions.pod:1705
8628 msgid "(Added in 1.0.79)"
8632 #: ../src/guestfs-actions.pod:1707
8633 msgid "guestfs_fill_pattern"
8637 #: ../src/guestfs-actions.pod:1709
8641 " guestfs_fill_pattern (guestfs_h *g,\n"
8642 " const char *pattern,\n"
8644 " const char *path);\n"
8649 #: ../src/guestfs-actions.pod:1715
8651 "This function is like C<guestfs_fill> except that it creates a new file of "
8652 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8653 "pattern is truncated if necessary to ensure the length of the file is "
8654 "exactly C<len> bytes."
8658 #: ../src/guestfs-actions.pod:1727
8659 msgid "(Added in 1.3.12)"
8663 #: ../src/guestfs-actions.pod:1729
8664 msgid "guestfs_find"
8668 #: ../src/guestfs-actions.pod:1731
8672 " guestfs_find (guestfs_h *g,\n"
8673 " const char *directory);\n"
8678 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1167
8680 "This command lists out all files and directories, recursively, starting at "
8681 "C<directory>. It is essentially equivalent to running the shell command "
8682 "C<find directory -print> but some post-processing happens on the output, "
8687 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1172
8689 "This returns a list of strings I<without any prefix>. Thus if the directory "
8694 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
8704 #: ../src/guestfs-actions.pod:1747
8705 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8709 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1182
8720 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1187
8721 msgid "If C<directory> is not a directory, then this command returns an error."
8725 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
8726 msgid "The returned list is sorted."
8730 #: ../src/guestfs-actions.pod:1760
8731 msgid "See also C<guestfs_find0>."
8735 #: ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:5806
8736 msgid "(Added in 1.0.27)"
8740 #: ../src/guestfs-actions.pod:1771
8741 msgid "guestfs_find0"
8745 #: ../src/guestfs-actions.pod:1773
8749 " guestfs_find0 (guestfs_h *g,\n"
8750 " const char *directory,\n"
8751 " const char *files);\n"
8756 #: ../src/guestfs-actions.pod:1778 ../fish/guestfish-actions.pod:1201
8758 "This command lists out all files and directories, recursively, starting at "
8759 "C<directory>, placing the resulting list in the external file called "
8764 #: ../src/guestfs-actions.pod:1782
8766 "This command works the same way as C<guestfs_find> with the following "
8771 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1212
8772 msgid "The resulting list is written to an external file."
8776 #: ../src/guestfs-actions.pod:1793 ../fish/guestfish-actions.pod:1216
8778 "Items (filenames) in the result are separated by C<\\0> characters. See "
8779 "L<find(1)> option I<-print0>."
8783 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1221
8784 msgid "This command is not limited in the number of names that it can return."
8788 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1226
8789 msgid "The result list is not sorted."
8793 #: ../src/guestfs-actions.pod:1809
8794 msgid "(Added in 1.0.74)"
8798 #: ../src/guestfs-actions.pod:1811
8799 msgid "guestfs_findfs_label"
8803 #: ../src/guestfs-actions.pod:1813
8807 " guestfs_findfs_label (guestfs_h *g,\n"
8808 " const char *label);\n"
8813 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1236
8815 "This command searches the filesystems and returns the one which has the "
8816 "given label. An error is returned if no such filesystem can be found."
8820 #: ../src/guestfs-actions.pod:1821
8821 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8825 #: ../src/guestfs-actions.pod:1828
8826 msgid "guestfs_findfs_uuid"
8830 #: ../src/guestfs-actions.pod:1830
8834 " guestfs_findfs_uuid (guestfs_h *g,\n"
8835 " const char *uuid);\n"
8840 #: ../src/guestfs-actions.pod:1834 ../fish/guestfish-actions.pod:1246
8842 "This command searches the filesystems and returns the one which has the "
8843 "given UUID. An error is returned if no such filesystem can be found."
8847 #: ../src/guestfs-actions.pod:1838
8848 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8852 #: ../src/guestfs-actions.pod:1845
8853 msgid "guestfs_fsck"
8857 #: ../src/guestfs-actions.pod:1847
8861 " guestfs_fsck (guestfs_h *g,\n"
8862 " const char *fstype,\n"
8863 " const char *device);\n"
8868 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1256
8870 "This runs the filesystem checker (fsck) on C<device> which should have "
8871 "filesystem type C<fstype>."
8875 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
8877 "The returned integer is the status. See L<fsck(8)> for the list of status "
8878 "codes from C<fsck>."
8882 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1268
8883 msgid "Multiple status codes can be summed together."
8887 #: ../src/guestfs-actions.pod:1868 ../fish/guestfish-actions.pod:1272
8889 "A non-zero return code can mean \"success\", for example if errors have been "
8890 "corrected on the filesystem."
8894 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1277
8895 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8899 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1282
8900 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8904 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:7542
8905 msgid "(Added in 1.0.16)"
8909 #: ../src/guestfs-actions.pod:1884
8910 msgid "guestfs_get_append"
8914 #: ../src/guestfs-actions.pod:1886
8918 " guestfs_get_append (guestfs_h *g);\n"
8923 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
8925 "Return the additional kernel options which are added to the guest kernel "
8930 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
8931 msgid "If C<NULL> then no options are added."
8935 #: ../src/guestfs-actions.pod:1894
8937 "This function returns a string which may be NULL. There is no way to return "
8938 "an error from this function. The string is owned by the guest handle and "
8939 "must I<not> be freed."
8943 #: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:6389 ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6448 ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7223 ../src/guestfs-actions.pod:7585
8944 msgid "(Added in 1.0.26)"
8948 #: ../src/guestfs-actions.pod:1900
8949 msgid "guestfs_get_attach_method"
8953 #: ../src/guestfs-actions.pod:1902
8957 " guestfs_get_attach_method (guestfs_h *g);\n"
8962 #: ../src/guestfs-actions.pod:1905
8963 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8967 #: ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:5996
8968 msgid "(Added in 1.9.8)"
8972 #: ../src/guestfs-actions.pod:1912
8973 msgid "guestfs_get_autosync"
8977 #: ../src/guestfs-actions.pod:1914
8981 " guestfs_get_autosync (guestfs_h *g);\n"
8986 #: ../src/guestfs-actions.pod:1917 ../fish/guestfish-actions.pod:1303
8987 msgid "Get the autosync flag."
8991 #: ../src/guestfs-actions.pod:1923
8992 msgid "guestfs_get_direct"
8996 #: ../src/guestfs-actions.pod:1925
9000 " guestfs_get_direct (guestfs_h *g);\n"
9005 #: ../src/guestfs-actions.pod:1928 ../fish/guestfish-actions.pod:1309
9006 msgid "Return the direct appliance mode flag."
9010 #: ../src/guestfs-actions.pod:1932 ../src/guestfs-actions.pod:6037
9011 msgid "(Added in 1.0.72)"
9015 #: ../src/guestfs-actions.pod:1934
9016 msgid "guestfs_get_e2label"
9020 #: ../src/guestfs-actions.pod:1936
9024 " guestfs_get_e2label (guestfs_h *g,\n"
9025 " const char *device);\n"
9030 #: ../src/guestfs-actions.pod:1940 ../fish/guestfish-actions.pod:1315
9031 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9035 #: ../src/guestfs-actions.pod:1946 ../fish/guestfish-actions.pod:1318
9037 "This function is deprecated. In new code, use the C<vfs_label> call "
9042 #: ../src/guestfs-actions.pod:1953 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6074
9043 msgid "(Added in 1.0.15)"
9047 #: ../src/guestfs-actions.pod:1955
9048 msgid "guestfs_get_e2uuid"
9052 #: ../src/guestfs-actions.pod:1957
9056 " guestfs_get_e2uuid (guestfs_h *g,\n"
9057 " const char *device);\n"
9062 #: ../src/guestfs-actions.pod:1961 ../fish/guestfish-actions.pod:1329
9063 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9067 #: ../src/guestfs-actions.pod:1967 ../fish/guestfish-actions.pod:1332
9068 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9072 #: ../src/guestfs-actions.pod:1976
9073 msgid "guestfs_get_memsize"
9077 #: ../src/guestfs-actions.pod:1978
9081 " guestfs_get_memsize (guestfs_h *g);\n"
9086 #: ../src/guestfs-actions.pod:1981 ../fish/guestfish-actions.pod:1343
9087 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
9091 #: ../src/guestfs-actions.pod:1984
9093 "If C<guestfs_set_memsize> was not called on this handle, and if "
9094 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9095 "value for memsize."
9099 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:6090 ../src/guestfs-actions.pod:6197 ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401 ../fish/guestfish-actions.pod:4043 ../fish/guestfish-actions.pod:4130
9100 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9104 #: ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:4497 ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4713 ../src/guestfs-actions.pod:4732 ../src/guestfs-actions.pod:4744 ../src/guestfs-actions.pod:4761 ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:6095 ../src/guestfs-actions.pod:6356 ../src/guestfs-actions.pod:6971
9105 msgid "(Added in 1.0.55)"
9109 #: ../src/guestfs-actions.pod:1995
9110 msgid "guestfs_get_network"
9114 #: ../src/guestfs-actions.pod:1997
9118 " guestfs_get_network (guestfs_h *g);\n"
9123 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1357
9124 msgid "This returns the enable network flag."
9128 #: ../src/guestfs-actions.pod:2004 ../src/guestfs-actions.pod:6114
9129 msgid "(Added in 1.5.4)"
9133 #: ../src/guestfs-actions.pod:2006
9134 msgid "guestfs_get_path"
9138 #: ../src/guestfs-actions.pod:2008
9142 " guestfs_get_path (guestfs_h *g);\n"
9147 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1363
9148 msgid "Return the current search path."
9152 #: ../src/guestfs-actions.pod:2013 ../fish/guestfish-actions.pod:1365
9154 "This is always non-NULL. If it wasn't set already, then this will return "
9159 #: ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2045
9161 "This function returns a string, or NULL on error. The string is owned by "
9162 "the guest handle and must I<not> be freed."
9166 #: ../src/guestfs-actions.pod:2021
9167 msgid "guestfs_get_pid"
9171 #: ../src/guestfs-actions.pod:2023
9175 " guestfs_get_pid (guestfs_h *g);\n"
9180 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1374
9182 "Return the process ID of the qemu subprocess. If there is no qemu "
9183 "subprocess, then this will return an error."
9187 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1377
9188 msgid "This is an internal call used for debugging and testing."
9192 #: ../src/guestfs-actions.pod:2033
9193 msgid "(Added in 1.0.56)"
9197 #: ../src/guestfs-actions.pod:2035
9198 msgid "guestfs_get_qemu"
9202 #: ../src/guestfs-actions.pod:2037
9206 " guestfs_get_qemu (guestfs_h *g);\n"
9211 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1383
9212 msgid "Return the current qemu binary."
9216 #: ../src/guestfs-actions.pod:2042 ../fish/guestfish-actions.pod:1385
9218 "This is always non-NULL. If it wasn't set already, then this will return "
9219 "the default qemu binary name."
9223 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:6159
9224 msgid "(Added in 1.0.6)"
9228 #: ../src/guestfs-actions.pod:2050
9229 msgid "guestfs_get_recovery_proc"
9233 #: ../src/guestfs-actions.pod:2052
9237 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9242 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1392
9243 msgid "Return the recovery process enabled flag."
9247 #: ../src/guestfs-actions.pod:2059 ../src/guestfs-actions.pod:3593 ../src/guestfs-actions.pod:3904 ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5757 ../src/guestfs-actions.pod:6183 ../src/guestfs-actions.pod:6874 ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:7086
9248 msgid "(Added in 1.0.77)"
9252 #: ../src/guestfs-actions.pod:2061
9253 msgid "guestfs_get_selinux"
9257 #: ../src/guestfs-actions.pod:2063
9261 " guestfs_get_selinux (guestfs_h *g);\n"
9266 #: ../src/guestfs-actions.pod:2066
9268 "This returns the current setting of the selinux flag which is passed to the "
9269 "appliance at boot time. See C<guestfs_set_selinux>."
9273 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:2137 ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6260
9274 msgid "(Added in 1.0.67)"
9278 #: ../src/guestfs-actions.pod:2076
9279 msgid "guestfs_get_state"
9283 #: ../src/guestfs-actions.pod:2078
9287 " guestfs_get_state (guestfs_h *g);\n"
9292 #: ../src/guestfs-actions.pod:2081 ../fish/guestfish-actions.pod:1408
9294 "This returns the current state as an opaque integer. This is only useful "
9295 "for printing debug and internal error messages."
9299 #: ../src/guestfs-actions.pod:2084 ../src/guestfs-actions.pod:3364 ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3481 ../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
9300 msgid "For more information on states, see L<guestfs(3)>."
9304 #: ../src/guestfs-actions.pod:2090
9305 msgid "guestfs_get_trace"
9309 #: ../src/guestfs-actions.pod:2092
9313 " guestfs_get_trace (guestfs_h *g);\n"
9318 #: ../src/guestfs-actions.pod:2095 ../fish/guestfish-actions.pod:1417
9319 msgid "Return the command trace flag."
9323 #: ../src/guestfs-actions.pod:2101
9324 msgid "guestfs_get_umask"
9328 #: ../src/guestfs-actions.pod:2103
9332 " guestfs_get_umask (guestfs_h *g);\n"
9337 #: ../src/guestfs-actions.pod:2106
9339 "Return the current umask. By default the umask is C<022> unless it has been "
9340 "set by calling C<guestfs_umask>."
9344 #: ../src/guestfs-actions.pod:2113
9345 msgid "guestfs_get_verbose"
9349 #: ../src/guestfs-actions.pod:2115
9353 " guestfs_get_verbose (guestfs_h *g);\n"
9358 #: ../src/guestfs-actions.pod:2118 ../fish/guestfish-actions.pod:1430
9359 msgid "This returns the verbose messages flag."
9363 #: ../src/guestfs-actions.pod:2124
9364 msgid "guestfs_getcon"
9368 #: ../src/guestfs-actions.pod:2126
9372 " guestfs_getcon (guestfs_h *g);\n"
9377 #: ../src/guestfs-actions.pod:2129 ../fish/guestfish-actions.pod:1436
9378 msgid "This gets the SELinux security context of the daemon."
9382 #: ../src/guestfs-actions.pod:2131
9383 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9387 #: ../src/guestfs-actions.pod:2139
9388 msgid "guestfs_getxattr"
9392 #: ../src/guestfs-actions.pod:2141
9396 " guestfs_getxattr (guestfs_h *g,\n"
9397 " const char *path,\n"
9398 " const char *name,\n"
9399 " size_t *size_r);\n"
9404 #: ../src/guestfs-actions.pod:2147
9406 "Get a single extended attribute from file C<path> named C<name>. This call "
9407 "follows symlinks. If you want to lookup an extended attribute for the "
9408 "symlink itself, use C<guestfs_lgetxattr>."
9412 #: ../src/guestfs-actions.pod:2151 ../src/guestfs-actions.pod:3607
9414 "Normally it is better to get all extended attributes from a file in one go "
9415 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9416 "implementations are buggy and do not provide a way to list out attributes. "
9417 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9418 "extended attributes you want in advance and call this function."
9422 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:3614 ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2483
9424 "Extended attribute values are blobs of binary data. If there is no extended "
9425 "attribute named C<name>, this returns an error."
9429 #: ../src/guestfs-actions.pod:2161
9430 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9434 #: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:2354 ../src/guestfs-actions.pod:2824 ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:5614
9436 "This function returns a buffer, or NULL on error. The size of the returned "
9437 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9442 #: ../src/guestfs-actions.pod:2167 ../src/guestfs-actions.pod:3623
9443 msgid "(Added in 1.7.24)"
9447 #: ../src/guestfs-actions.pod:2169
9448 msgid "guestfs_getxattrs"
9452 #: ../src/guestfs-actions.pod:2171
9455 " struct guestfs_xattr_list *\n"
9456 " guestfs_getxattrs (guestfs_h *g,\n"
9457 " const char *path);\n"
9462 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1465
9463 msgid "This call lists the extended attributes of the file or directory C<path>."
9467 #: ../src/guestfs-actions.pod:2178 ../fish/guestfish-actions.pod:1468
9469 "At the system call level, this is a combination of the L<listxattr(2)> and "
9470 "L<getxattr(2)> calls."
9474 #: ../src/guestfs-actions.pod:2181
9475 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9479 #: ../src/guestfs-actions.pod:2183 ../src/guestfs-actions.pod:3635 ../src/guestfs-actions.pod:4300
9481 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9482 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9486 #: ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3854 ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:6279 ../src/guestfs-actions.pod:7650
9487 msgid "(Added in 1.0.59)"
9491 #: ../src/guestfs-actions.pod:2189
9492 msgid "guestfs_glob_expand"
9496 #: ../src/guestfs-actions.pod:2191
9500 " guestfs_glob_expand (guestfs_h *g,\n"
9501 " const char *pattern);\n"
9506 #: ../src/guestfs-actions.pod:2195 ../fish/guestfish-actions.pod:1477
9508 "This command searches for all the pathnames matching C<pattern> according to "
9509 "the wildcard expansion rules used by the shell."
9513 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1481
9514 msgid "If no paths match, then this returns an empty list (note: not an error)."
9518 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1484
9520 "It is just a wrapper around the C L<glob(3)> function with flags "
9521 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9525 #: ../src/guestfs-actions.pod:2210 ../src/guestfs-actions.pod:6472 ../src/guestfs-actions.pod:6489
9526 msgid "(Added in 1.0.50)"
9530 #: ../src/guestfs-actions.pod:2212
9531 msgid "guestfs_grep"
9535 #: ../src/guestfs-actions.pod:2214
9539 " guestfs_grep (guestfs_h *g,\n"
9540 " const char *regex,\n"
9541 " const char *path);\n"
9546 #: ../src/guestfs-actions.pod:2219 ../fish/guestfish-actions.pod:1492
9547 msgid "This calls the external C<grep> program and returns the matching lines."
9551 #: ../src/guestfs-actions.pod:2231
9552 msgid "guestfs_grepi"
9556 #: ../src/guestfs-actions.pod:2233
9560 " guestfs_grepi (guestfs_h *g,\n"
9561 " const char *regex,\n"
9562 " const char *path);\n"
9567 #: ../src/guestfs-actions.pod:2238 ../fish/guestfish-actions.pod:1502
9568 msgid "This calls the external C<grep -i> program and returns the matching lines."
9572 #: ../src/guestfs-actions.pod:2250
9573 msgid "guestfs_grub_install"
9577 #: ../src/guestfs-actions.pod:2252
9581 " guestfs_grub_install (guestfs_h *g,\n"
9582 " const char *root,\n"
9583 " const char *device);\n"
9588 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1512
9590 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9591 "the root directory being C<root>."
9595 #: ../src/guestfs-actions.pod:2260 ../fish/guestfish-actions.pod:1515
9597 "Note: If grub-install reports the error \"No suitable drive was found in the "
9598 "generated device map.\" it may be that you need to create a "
9599 "C</boot/grub/device.map> file first that contains the mapping between grub "
9600 "device names and Linux device names. It is usually sufficient to create a "
9605 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
9613 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1524
9614 msgid "replacing C</dev/vda> with the name of the installation device."
9618 #: ../src/guestfs-actions.pod:2273
9619 msgid "(Added in 1.0.17)"
9623 #: ../src/guestfs-actions.pod:2275
9624 msgid "guestfs_head"
9628 #: ../src/guestfs-actions.pod:2277
9632 " guestfs_head (guestfs_h *g,\n"
9633 " const char *path);\n"
9638 #: ../src/guestfs-actions.pod:2281 ../fish/guestfish-actions.pod:1530
9640 "This command returns up to the first 10 lines of a file as a list of "
9645 #: ../src/guestfs-actions.pod:2293
9646 msgid "guestfs_head_n"
9650 #: ../src/guestfs-actions.pod:2295
9654 " guestfs_head_n (guestfs_h *g,\n"
9656 " const char *path);\n"
9661 #: ../src/guestfs-actions.pod:2300 ../fish/guestfish-actions.pod:1540
9663 "If the parameter C<nrlines> is a positive number, this returns the first "
9664 "C<nrlines> lines of the file C<path>."
9668 #: ../src/guestfs-actions.pod:2303 ../fish/guestfish-actions.pod:1543
9670 "If the parameter C<nrlines> is a negative number, this returns lines from "
9671 "the file C<path>, excluding the last C<nrlines> lines."
9675 #: ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4508
9676 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9680 #: ../src/guestfs-actions.pod:2317
9681 msgid "guestfs_hexdump"
9685 #: ../src/guestfs-actions.pod:2319
9689 " guestfs_hexdump (guestfs_h *g,\n"
9690 " const char *path);\n"
9695 #: ../src/guestfs-actions.pod:2323 ../fish/guestfish-actions.pod:1555
9697 "This runs C<hexdump -C> on the given C<path>. The result is the "
9698 "human-readable, canonical hex dump of the file."
9702 #: ../src/guestfs-actions.pod:2332 ../src/guestfs-actions.pod:6553 ../src/guestfs-actions.pod:6608
9703 msgid "(Added in 1.0.22)"
9707 #: ../src/guestfs-actions.pod:2334
9708 msgid "guestfs_initrd_cat"
9712 #: ../src/guestfs-actions.pod:2336
9716 " guestfs_initrd_cat (guestfs_h *g,\n"
9717 " const char *initrdpath,\n"
9718 " const char *filename,\n"
9719 " size_t *size_r);\n"
9724 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1565
9726 "This command unpacks the file C<filename> from the initrd file called "
9727 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9732 #: ../src/guestfs-actions.pod:2346 ../fish/guestfish-actions.pod:1569
9734 "For example, in guestfish you could use the following command to examine the "
9735 "boot script (usually called C</init>) contained in a Linux initrd or "
9740 #: ../src/guestfs-actions.pod:2350 ../fish/guestfish-actions.pod:1573
9743 " initrd-cat /boot/initrd-<version>.img init\n"
9748 #: ../src/guestfs-actions.pod:2352
9749 msgid "See also C<guestfs_initrd_list>."
9753 #: ../src/guestfs-actions.pod:2363
9754 msgid "guestfs_initrd_list"
9758 #: ../src/guestfs-actions.pod:2365
9762 " guestfs_initrd_list (guestfs_h *g,\n"
9763 " const char *path);\n"
9768 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1584
9769 msgid "This command lists out files contained in an initrd."
9773 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1586
9775 "The files are listed without any initial C</> character. The files are "
9776 "listed in the order they appear (not necessarily alphabetical). Directory "
9777 "names are listed as separate items."
9781 #: ../src/guestfs-actions.pod:2375 ../fish/guestfish-actions.pod:1590
9783 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9784 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9789 #: ../src/guestfs-actions.pod:2385
9790 msgid "guestfs_inotify_add_watch"
9794 #: ../src/guestfs-actions.pod:2387
9798 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9799 " const char *path,\n"
9805 #: ../src/guestfs-actions.pod:2392 ../fish/guestfish-actions.pod:1598
9806 msgid "Watch C<path> for the events listed in C<mask>."
9810 #: ../src/guestfs-actions.pod:2394 ../fish/guestfish-actions.pod:1600
9812 "Note that if C<path> is a directory then events within that directory are "
9813 "watched, but this does I<not> happen recursively (in subdirectories)."
9817 #: ../src/guestfs-actions.pod:2398 ../fish/guestfish-actions.pod:1604
9819 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9820 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9824 #: ../src/guestfs-actions.pod:2406
9825 msgid "guestfs_inotify_close"
9829 #: ../src/guestfs-actions.pod:2408
9833 " guestfs_inotify_close (guestfs_h *g);\n"
9838 #: ../src/guestfs-actions.pod:2411 ../fish/guestfish-actions.pod:1612
9840 "This closes the inotify handle which was previously opened by inotify_init. "
9841 "It removes all watches, throws away any pending events, and deallocates all "
9846 #: ../src/guestfs-actions.pod:2419
9847 msgid "guestfs_inotify_files"
9851 #: ../src/guestfs-actions.pod:2421
9855 " guestfs_inotify_files (guestfs_h *g);\n"
9860 #: ../src/guestfs-actions.pod:2424
9862 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9863 "returns a list of pathnames of objects that were touched. The returned "
9864 "pathnames are sorted and deduplicated."
9868 #: ../src/guestfs-actions.pod:2434
9869 msgid "guestfs_inotify_init"
9873 #: ../src/guestfs-actions.pod:2436
9877 " guestfs_inotify_init (guestfs_h *g,\n"
9878 " int maxevents);\n"
9883 #: ../src/guestfs-actions.pod:2440 ../fish/guestfish-actions.pod:1628
9885 "This command creates a new inotify handle. The inotify subsystem can be "
9886 "used to notify events which happen to objects in the guest filesystem."
9890 #: ../src/guestfs-actions.pod:2444
9892 "C<maxevents> is the maximum number of events which will be queued up between "
9893 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9894 "passed as C<0>, then the kernel (or previously set) default is used. For "
9895 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9896 "throws away events, but records the fact that it threw them away by setting "
9897 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9898 "C<guestfs_inotify_read>)."
9902 #: ../src/guestfs-actions.pod:2454
9904 "Before any events are generated, you have to add some watches to the "
9905 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9906 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9910 #: ../src/guestfs-actions.pod:2460
9912 "Queued up events should be read periodically by calling "
9913 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9914 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9915 "often enough then you risk the internal queue overflowing."
9919 #: ../src/guestfs-actions.pod:2467
9921 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9922 "This also removes any watches automatically."
9926 #: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1659
9928 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9929 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9930 "that there is one global inotify handle per libguestfs instance."
9934 #: ../src/guestfs-actions.pod:2480
9935 msgid "guestfs_inotify_read"
9939 #: ../src/guestfs-actions.pod:2482
9942 " struct guestfs_inotify_event_list *\n"
9943 " guestfs_inotify_read (guestfs_h *g);\n"
9948 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1668
9950 "Return the complete queue of events that have happened since the previous "
9955 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1671
9956 msgid "If no events have happened, this returns an empty list."
9960 #: ../src/guestfs-actions.pod:2490 ../fish/guestfish-actions.pod:1673
9962 "I<Note>: In order to make sure that all events have been read, you must call "
9963 "this function repeatedly until it returns an empty list. The reason is that "
9964 "the call will read events up to the maximum appliance-to-host message size "
9965 "and leave remaining events in the queue."
9969 #: ../src/guestfs-actions.pod:2496
9971 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9972 "there was an error. I<The caller must call "
9973 "C<guestfs_free_inotify_event_list> after use>."
9977 #: ../src/guestfs-actions.pod:2502
9978 msgid "guestfs_inotify_rm_watch"
9982 #: ../src/guestfs-actions.pod:2504
9986 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9992 #: ../src/guestfs-actions.pod:2508
9994 "Remove a previously defined inotify watch. See "
9995 "C<guestfs_inotify_add_watch>."
9999 #: ../src/guestfs-actions.pod:2515
10000 msgid "guestfs_inspect_get_arch"
10004 #: ../src/guestfs-actions.pod:2517
10008 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10009 " const char *root);\n"
10014 #: ../src/guestfs-actions.pod:2521
10016 "This returns the architecture of the inspected operating system. The "
10017 "possible return values are listed under C<guestfs_file_architecture>."
10021 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1694
10023 "If the architecture could not be determined, then the string C<unknown> is "
10028 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2955 ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:3004 ../src/guestfs-actions.pod:3057 ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3117 ../src/guestfs-actions.pod:3137 ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3170 ../src/guestfs-actions.pod:3188 ../src/guestfs-actions.pod:3290 ../src/guestfs-actions.pod:3331 ../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
10029 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10033 #: ../src/guestfs-actions.pod:2535
10034 msgid "guestfs_inspect_get_distro"
10038 #: ../src/guestfs-actions.pod:2537
10042 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10043 " const char *root);\n"
10048 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:1703
10049 msgid "This returns the distro (distribution) of the inspected operating system."
10053 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1706
10054 msgid "Currently defined distros are:"
10058 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1710
10059 msgid "\"archlinux\""
10063 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1712
10064 msgid "Arch Linux."
10068 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1714
10073 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1716
10078 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1718
10083 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1720
10088 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1722
10093 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1724
10098 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1726
10103 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1728
10108 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1730
10109 msgid "\"linuxmint\""
10113 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1732
10114 msgid "Linux Mint."
10118 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1734
10119 msgid "\"mandriva\""
10123 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1736
10128 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1738
10133 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1740
10138 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1742
10143 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1744
10148 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1746
10149 msgid "\"redhat-based\""
10153 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1748
10154 msgid "Some Red Hat-derived distro."
10158 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1750
10163 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1752
10164 msgid "Red Hat Enterprise Linux."
10168 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1754
10169 msgid "\"scientificlinux\""
10173 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1756
10174 msgid "Scientific Linux."
10178 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1758
10179 msgid "\"slackware\""
10183 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1760
10188 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1762
10193 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1764
10198 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:1850 ../fish/guestfish-actions.pod:2114
10199 msgid "\"unknown\""
10203 #: ../src/guestfs-actions.pod:2606 ../fish/guestfish-actions.pod:1768
10204 msgid "The distro could not be determined."
10208 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:2106
10209 msgid "\"windows\""
10213 #: ../src/guestfs-actions.pod:2610 ../fish/guestfish-actions.pod:1772
10215 "Windows does not have distributions. This string is returned if the OS type "
10220 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:1777 ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:2120
10222 "Future versions of libguestfs may return other strings here. The caller "
10223 "should be prepared to handle any string."
10227 #: ../src/guestfs-actions.pod:2625
10228 msgid "guestfs_inspect_get_drive_mappings"
10232 #: ../src/guestfs-actions.pod:2627
10236 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10237 " const char *root);\n"
10242 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1786
10244 "This call is useful for Windows which uses a primitive system of assigning "
10245 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10246 "Windows Registry to find out how disks/partitions are mapped to drive "
10247 "letters, and returns a hash table as in the example below:"
10251 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1792
10254 " C => /dev/vda2\n"
10255 " E => /dev/vdb1\n"
10256 " F => /dev/vdc1\n"
10261 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1796
10263 "Note that keys are drive letters. For Windows, the key is case insensitive "
10264 "and just contains the drive letter, without the customary colon separator "
10269 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1800
10271 "In future we may support other operating systems that also used drive "
10272 "letters, but the keys for those might not be case insensitive and might be "
10273 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10278 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1805
10280 "For Windows guests, currently only hard drive mappings are returned. "
10281 "Removable disks (eg. DVD-ROMs) are ignored."
10285 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1808
10287 "For guests that do not use drive mappings, or if the drive mappings could "
10288 "not be determined, this returns an empty hash table."
10292 #: ../src/guestfs-actions.pod:2656
10294 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10295 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10299 #: ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2928 ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:6910
10301 "This function returns a NULL-terminated array of strings, or NULL if there "
10302 "was an error. The array of strings will always have length C<2n+1>, where "
10303 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10304 "caller must free the strings and the array after use>."
10308 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:3122
10309 msgid "(Added in 1.9.17)"
10313 #: ../src/guestfs-actions.pod:2668
10314 msgid "guestfs_inspect_get_filesystems"
10318 #: ../src/guestfs-actions.pod:2670
10322 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10323 " const char *root);\n"
10328 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1819
10330 "This returns a list of all the filesystems that we think are associated with "
10331 "this operating system. This includes the root filesystem, other ordinary "
10332 "filesystems, and non-mounted devices like swap partitions."
10336 #: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1824
10338 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10339 "to be shared between operating systems."
10343 #: ../src/guestfs-actions.pod:2682
10345 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10346 "C<guestfs_inspect_get_mountpoints>."
10350 #: ../src/guestfs-actions.pod:2691
10351 msgid "guestfs_inspect_get_format"
10355 #: ../src/guestfs-actions.pod:2693
10359 " guestfs_inspect_get_format (guestfs_h *g,\n"
10360 " const char *root);\n"
10365 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1834
10367 "This returns the format of the inspected operating system. You can use it "
10368 "to detect install images, live CDs and similar."
10372 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1837
10373 msgid "Currently defined formats are:"
10377 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1841
10378 msgid "\"installed\""
10382 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1843
10383 msgid "This is an installed operating system."
10387 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1845
10388 msgid "\"installer\""
10392 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1847
10394 "The disk image being inspected is not an installed operating system, but a "
10395 "I<bootable> install disk, live CD, or similar."
10399 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1852
10400 msgid "The format of this disk image is not known."
10404 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:3158 ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:5825
10405 msgid "(Added in 1.9.4)"
10409 #: ../src/guestfs-actions.pod:2729
10410 msgid "guestfs_inspect_get_hostname"
10414 #: ../src/guestfs-actions.pod:2731
10418 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10419 " const char *root);\n"
10424 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:1865
10426 "This function returns the hostname of the operating system as found by "
10427 "inspection of the guest's configuration files."
10431 #: ../src/guestfs-actions.pod:2738 ../fish/guestfish-actions.pod:1868
10433 "If the hostname could not be determined, then the string C<unknown> is "
10438 #: ../src/guestfs-actions.pod:2746
10439 msgid "(Added in 1.7.9)"
10443 #: ../src/guestfs-actions.pod:2748
10444 msgid "guestfs_inspect_get_icon"
10448 #: ../src/guestfs-actions.pod:2750
10452 " guestfs_inspect_get_icon (guestfs_h *g,\n"
10453 " const char *root,\n"
10454 " size_t *size_r,\n"
10460 #: ../src/guestfs-actions.pod:2761
10463 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
10464 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
10469 #: ../src/guestfs-actions.pod:2764 ../fish/guestfish-actions.pod:1877
10471 "This function returns an icon corresponding to the inspected operating "
10472 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
10473 "to PNG if necessary)."
10477 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1881
10479 "If it was not possible to get an icon this function returns a zero-length "
10480 "(non-NULL) buffer. I<Callers must check for this case>."
10484 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1884
10486 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
10487 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
10488 "this file will be returned. You can disable favicons by passing the "
10489 "optional C<favicon> boolean as false (default is true)."
10493 #: ../src/guestfs-actions.pod:2777 ../fish/guestfish-actions.pod:1890
10495 "If finding the favicon fails, then we look in other places in the guest for "
10500 #: ../src/guestfs-actions.pod:2780 ../fish/guestfish-actions.pod:1893
10502 "If the optional C<highquality> boolean is true then only high quality icons "
10503 "are returned, which means only icons of high resolution with an alpha "
10504 "channel. The default (false) is to return any icon we can, even if it is of "
10505 "substandard quality."
10509 #: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:1904
10511 "Unlike most other inspection API calls, the guest's disks must be mounted up "
10512 "before you call this, since it needs to read information from the guest "
10513 "filesystem during the call."
10517 #: ../src/guestfs-actions.pod:2797 ../fish/guestfish-actions.pod:1910
10519 "B<Security:> The icon data comes from the untrusted guest, and should be "
10520 "treated with caution. PNG files have been known to contain exploits. "
10521 "Ensure that libpng (or other relevant libraries) are fully up to date before "
10522 "trying to process or display the icon."
10526 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
10528 "The PNG image returned can be any size. It might not be square. Libguestfs "
10529 "tries to return the largest, highest quality icon available. The "
10530 "application must scale the icon to the required size."
10534 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
10536 "Extracting icons from Windows guests requires the external C<wrestool> "
10537 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
10538 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
10539 "installed separately."
10543 #: ../src/guestfs-actions.pod:2819 ../fish/guestfish-actions.pod:1932
10545 "Operating system icons are usually trademarks. Seek legal advice before "
10546 "using trademarks in applications."
10550 #: ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:3653 ../src/guestfs-actions.pod:4872
10551 msgid "(Added in 1.11.12)"
10555 #: ../src/guestfs-actions.pod:2830
10556 msgid "guestfs_inspect_get_icon_va"
10560 #: ../src/guestfs-actions.pod:2832
10564 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
10565 " const char *root,\n"
10566 " size_t *size_r,\n"
10567 " va_list args);\n"
10572 #: ../src/guestfs-actions.pod:2838
10573 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
10577 #: ../src/guestfs-actions.pod:2842
10578 msgid "guestfs_inspect_get_icon_argv"
10582 #: ../src/guestfs-actions.pod:2844
10586 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
10587 " const char *root,\n"
10588 " size_t *size_r,\n"
10589 " const struct guestfs_inspect_get_icon_argv "
10595 #: ../src/guestfs-actions.pod:2850
10596 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
10600 #: ../src/guestfs-actions.pod:2854
10601 msgid "guestfs_inspect_get_major_version"
10605 #: ../src/guestfs-actions.pod:2856
10609 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10610 " const char *root);\n"
10615 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1943
10616 msgid "This returns the major version number of the inspected operating system."
10620 #: ../src/guestfs-actions.pod:2863 ../fish/guestfish-actions.pod:1946
10622 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10623 "popular public names used by the operating system. Notably the operating "
10624 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10625 "1). You can find out the real versions corresponding to releases of Windows "
10626 "by consulting Wikipedia or MSDN."
10630 #: ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2887 ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:1964
10631 msgid "If the version could not be determined, then C<0> is returned."
10635 #: ../src/guestfs-actions.pod:2878
10636 msgid "guestfs_inspect_get_minor_version"
10640 #: ../src/guestfs-actions.pod:2880
10644 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10645 " const char *root);\n"
10650 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1961
10651 msgid "This returns the minor version number of the inspected operating system."
10655 #: ../src/guestfs-actions.pod:2889
10657 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10658 "C<guestfs_inspect_get_major_version>."
10662 #: ../src/guestfs-actions.pod:2896
10663 msgid "guestfs_inspect_get_mountpoints"
10667 #: ../src/guestfs-actions.pod:2898
10671 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10672 " const char *root);\n"
10677 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:1973
10679 "This returns a hash of where we think the filesystems associated with this "
10680 "operating system should be mounted. Callers should note that this is at "
10681 "best an educated guess made by reading configuration files such as "
10682 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10683 "are non-existent or not mountable and callers should be prepared to handle "
10684 "or ignore failures if they try to mount them."
10688 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:1982
10690 "Each element in the returned hashtable has a key which is the path of the "
10691 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10692 "mounted there (eg. C</dev/sda1>)."
10696 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:1987
10697 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10701 #: ../src/guestfs-actions.pod:2919
10703 "For operating systems like Windows which still use drive letters, this call "
10704 "will only return an entry for the first drive \"mounted on\" C</>. For "
10705 "information about the mapping of drive letters to partitions, see "
10706 "C<guestfs_inspect_get_drive_mappings>."
10710 #: ../src/guestfs-actions.pod:2925
10712 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10713 "C<guestfs_inspect_get_filesystems>."
10717 #: ../src/guestfs-actions.pod:2936
10718 msgid "guestfs_inspect_get_package_format"
10722 #: ../src/guestfs-actions.pod:2938
10726 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10727 " const char *root);\n"
10732 #: ../src/guestfs-actions.pod:2942
10734 "This function and C<guestfs_inspect_get_package_management> return the "
10735 "package format and package management tool used by the inspected operating "
10736 "system. For example for Fedora these functions would return C<rpm> (package "
10737 "format) and C<yum> (package management)."
10741 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2009
10743 "This returns the string C<unknown> if we could not determine the package "
10744 "format I<or> if the operating system does not have a real packaging system "
10749 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2013
10751 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10752 "Future versions of libguestfs may return other strings."
10756 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:2988
10757 msgid "(Added in 1.7.5)"
10761 #: ../src/guestfs-actions.pod:2962
10762 msgid "guestfs_inspect_get_package_management"
10766 #: ../src/guestfs-actions.pod:2964
10770 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10771 " const char *root);\n"
10776 #: ../src/guestfs-actions.pod:2968
10778 "C<guestfs_inspect_get_package_format> and this function return the package "
10779 "format and package management tool used by the inspected operating system. "
10780 "For example for Fedora these functions would return C<rpm> (package format) "
10781 "and C<yum> (package management)."
10785 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2028
10787 "This returns the string C<unknown> if we could not determine the package "
10788 "management tool I<or> if the operating system does not have a real packaging "
10789 "system (eg. Windows)."
10793 #: ../src/guestfs-actions.pod:2978 ../fish/guestfish-actions.pod:2032
10795 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10796 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10797 "libguestfs may return other strings."
10801 #: ../src/guestfs-actions.pod:2990
10802 msgid "guestfs_inspect_get_product_name"
10806 #: ../src/guestfs-actions.pod:2992
10810 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10811 " const char *root);\n"
10816 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2043
10818 "This returns the product name of the inspected operating system. The "
10819 "product name is generally some freeform string which can be displayed to the "
10820 "user, but should not be parsed by programs."
10824 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2048
10826 "If the product name could not be determined, then the string C<unknown> is "
10831 #: ../src/guestfs-actions.pod:3011
10832 msgid "guestfs_inspect_get_product_variant"
10836 #: ../src/guestfs-actions.pod:3013
10840 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10841 " const char *root);\n"
10846 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2057
10847 msgid "This returns the product variant of the inspected operating system."
10851 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2060
10853 "For Windows guests, this returns the contents of the Registry key "
10854 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10855 "which is usually a string such as C<Client> or C<Server> (other values are "
10856 "possible). This can be used to distinguish consumer and enterprise versions "
10857 "of Windows that have the same version number (for example, Windows 7 and "
10858 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10859 "the latter is C<Server>)."
10863 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2069
10865 "For enterprise Linux guests, in future we intend this to return the product "
10866 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10867 "implemented at present."
10871 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2073
10873 "If the product variant could not be determined, then the string C<unknown> "
10878 #: ../src/guestfs-actions.pod:3036
10880 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10881 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10885 #: ../src/guestfs-actions.pod:3043
10886 msgid "(Added in 1.9.13)"
10890 #: ../src/guestfs-actions.pod:3045
10891 msgid "guestfs_inspect_get_roots"
10895 #: ../src/guestfs-actions.pod:3047
10899 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10904 #: ../src/guestfs-actions.pod:3050
10906 "This function is a convenient way to get the list of root devices, as "
10907 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10908 "the whole inspection process."
10912 #: ../src/guestfs-actions.pod:3054
10914 "This returns an empty list if either no root devices were found or the "
10915 "caller has not called C<guestfs_inspect_os>."
10919 #: ../src/guestfs-actions.pod:3063
10920 msgid "(Added in 1.7.3)"
10924 #: ../src/guestfs-actions.pod:3065
10925 msgid "guestfs_inspect_get_type"
10929 #: ../src/guestfs-actions.pod:3067
10933 " guestfs_inspect_get_type (guestfs_h *g,\n"
10934 " const char *root);\n"
10939 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2097
10941 "This returns the type of the inspected operating system. Currently defined "
10946 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2102
10951 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2104
10952 msgid "Any Linux-based operating system."
10956 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2108
10957 msgid "Any Microsoft Windows operating system."
10961 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:2110
10962 msgid "\"freebsd\""
10966 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2112
10971 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2116
10972 msgid "The operating system type could not be determined."
10976 #: ../src/guestfs-actions.pod:3104
10977 msgid "guestfs_inspect_get_windows_current_control_set"
10981 #: ../src/guestfs-actions.pod:3106
10985 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
10986 " const char *root);\n"
10991 #: ../src/guestfs-actions.pod:3110 ../fish/guestfish-actions.pod:2129
10993 "This returns the Windows CurrentControlSet of the inspected guest. The "
10994 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10998 #: ../src/guestfs-actions.pod:3113 ../fish/guestfish-actions.pod:2132
11000 "This call assumes that the guest is Windows and that the Registry could be "
11001 "examined by inspection. If this is not the case then an error is returned."
11005 #: ../src/guestfs-actions.pod:3124
11006 msgid "guestfs_inspect_get_windows_systemroot"
11010 #: ../src/guestfs-actions.pod:3126
11014 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11015 " const char *root);\n"
11020 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2142
11022 "This returns the Windows systemroot of the inspected guest. The systemroot "
11023 "is a directory path such as C</WINDOWS>."
11027 #: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2145
11029 "This call assumes that the guest is Windows and that the systemroot could be "
11030 "determined by inspection. If this is not the case then an error is "
11035 #: ../src/guestfs-actions.pod:3142
11036 msgid "(Added in 1.5.25)"
11040 #: ../src/guestfs-actions.pod:3144
11041 msgid "guestfs_inspect_is_live"
11045 #: ../src/guestfs-actions.pod:3146
11049 " guestfs_inspect_is_live (guestfs_h *g,\n"
11050 " const char *root);\n"
11055 #: ../src/guestfs-actions.pod:3150
11057 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11058 "disk), then this returns true if a live image was detected on the disk."
11062 #: ../src/guestfs-actions.pod:3160
11063 msgid "guestfs_inspect_is_multipart"
11067 #: ../src/guestfs-actions.pod:3162
11071 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11072 " const char *root);\n"
11077 #: ../src/guestfs-actions.pod:3166
11079 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11080 "disk), then this returns true if the disk is part of a set."
11084 #: ../src/guestfs-actions.pod:3176
11085 msgid "guestfs_inspect_is_netinst"
11089 #: ../src/guestfs-actions.pod:3178
11093 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11094 " const char *root);\n"
11099 #: ../src/guestfs-actions.pod:3182
11101 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11102 "disk), then this returns true if the disk is a network installer, ie. not a "
11103 "self-contained install CD but one which is likely to require network access "
11104 "to complete the install."
11108 #: ../src/guestfs-actions.pod:3194
11109 msgid "guestfs_inspect_list_applications"
11113 #: ../src/guestfs-actions.pod:3196
11116 " struct guestfs_application_list *\n"
11117 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11118 " const char *root);\n"
11123 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2187
11124 msgid "Return the list of applications installed in the operating system."
11128 #: ../src/guestfs-actions.pod:3202
11130 "I<Note:> This call works differently from other parts of the inspection "
11131 "API. You have to call C<guestfs_inspect_os>, then "
11132 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11133 "this. Listing applications is a significantly more difficult operation "
11134 "which requires access to the full filesystem. Also note that unlike the "
11135 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11136 "the libguestfs handle, this call actually reads parts of the mounted "
11137 "filesystems during the call."
11141 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2199
11143 "This returns an empty list if the inspection code was not able to determine "
11144 "the list of applications."
11148 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2202
11149 msgid "The application structure contains the following fields:"
11153 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2206
11154 msgid "C<app_name>"
11158 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2208
11160 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11161 "guests, this is the package name."
11165 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2211
11166 msgid "C<app_display_name>"
11170 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2213
11172 "The display name of the application, sometimes localized to the install "
11173 "language of the guest operating system."
11177 #: ../src/guestfs-actions.pod:3229 ../fish/guestfish-actions.pod:2216
11179 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11180 "to display something can use C<app_name> instead."
11184 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2219
11185 msgid "C<app_epoch>"
11189 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2221
11191 "For package managers which use epochs, this contains the epoch of the "
11192 "package (an integer). If unavailable, this is returned as C<0>."
11196 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2224
11197 msgid "C<app_version>"
11201 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2226
11203 "The version string of the application or package. If unavailable this is "
11204 "returned as an empty string C<\"\">."
11208 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2229
11209 msgid "C<app_release>"
11213 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2231
11215 "The release string of the application or package, for package managers that "
11216 "use this. If unavailable this is returned as an empty string C<\"\">."
11220 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2235
11221 msgid "C<app_install_path>"
11225 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2237
11227 "The installation path of the application (on operating systems such as "
11228 "Windows which use installation paths). This path is in the format used by "
11229 "the guest operating system, it is not a libguestfs path."
11233 #: ../src/guestfs-actions.pod:3255 ../fish/guestfish-actions.pod:2242
11234 msgid "If unavailable this is returned as an empty string C<\"\">."
11238 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2244
11239 msgid "C<app_trans_path>"
11243 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2246
11245 "The install path translated into a libguestfs path. If unavailable this is "
11246 "returned as an empty string C<\"\">."
11250 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2249
11251 msgid "C<app_publisher>"
11255 #: ../src/guestfs-actions.pod:3264 ../fish/guestfish-actions.pod:2251
11257 "The name of the publisher of the application, for package managers that use "
11258 "this. If unavailable this is returned as an empty string C<\"\">."
11262 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2255
11267 #: ../src/guestfs-actions.pod:3270 ../fish/guestfish-actions.pod:2257
11269 "The URL (eg. upstream URL) of the application. If unavailable this is "
11270 "returned as an empty string C<\"\">."
11274 #: ../src/guestfs-actions.pod:3273 ../fish/guestfish-actions.pod:2260
11275 msgid "C<app_source_package>"
11279 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2262
11281 "For packaging systems which support this, the name of the source package. "
11282 "If unavailable this is returned as an empty string C<\"\">."
11286 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2265
11287 msgid "C<app_summary>"
11291 #: ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:2267
11293 "A short (usually one line) description of the application or package. If "
11294 "unavailable this is returned as an empty string C<\"\">."
11298 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2270
11299 msgid "C<app_description>"
11303 #: ../src/guestfs-actions.pod:3285 ../fish/guestfish-actions.pod:2272
11305 "A longer description of the application or package. If unavailable this is "
11306 "returned as an empty string C<\"\">."
11310 #: ../src/guestfs-actions.pod:3292
11312 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11313 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11318 #: ../src/guestfs-actions.pod:3296
11319 msgid "(Added in 1.7.8)"
11323 #: ../src/guestfs-actions.pod:3298
11324 msgid "guestfs_inspect_os"
11328 #: ../src/guestfs-actions.pod:3300
11332 " guestfs_inspect_os (guestfs_h *g);\n"
11337 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2283
11339 "This function uses other libguestfs functions and certain heuristics to "
11340 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11341 "for operating systems."
11345 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2287
11346 msgid "The list returned is empty if no operating systems were found."
11350 #: ../src/guestfs-actions.pod:3309 ../fish/guestfish-actions.pod:2289
11352 "If one operating system was found, then this returns a list with a single "
11353 "element, which is the name of the root filesystem of this operating system. "
11354 "It is also possible for this function to return a list containing more than "
11355 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11356 "element being the root filesystem of one of the operating systems."
11360 #: ../src/guestfs-actions.pod:3316
11362 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11363 "functions in order to query further information about each operating system, "
11364 "such as the name and version."
11368 #: ../src/guestfs-actions.pod:3321
11370 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11371 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11372 "the contents. This should be called with no disks currently mounted. The "
11373 "function may also use Augeas, so any existing Augeas handle will be closed."
11377 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2307
11379 "This function cannot decrypt encrypted disks. The caller must do that first "
11380 "(supplying the necessary keys) if the disk is encrypted."
11384 #: ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3664 ../src/guestfs-actions.pod:3726
11385 msgid "See also C<guestfs_list_filesystems>."
11389 #: ../src/guestfs-actions.pod:3341
11390 msgid "guestfs_is_blockdev"
11394 #: ../src/guestfs-actions.pod:3343
11398 " guestfs_is_blockdev (guestfs_h *g,\n"
11399 " const char *path);\n"
11404 #: ../src/guestfs-actions.pod:3347 ../fish/guestfish-actions.pod:2319
11406 "This returns C<true> if and only if there is a block device with the given "
11411 #: ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3379 ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3496 ../src/guestfs-actions.pod:3511
11412 msgid "See also C<guestfs_stat>."
11416 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3428 ../src/guestfs-actions.pod:3500 ../src/guestfs-actions.pod:3515
11417 msgid "(Added in 1.5.10)"
11421 #: ../src/guestfs-actions.pod:3356
11422 msgid "guestfs_is_busy"
11426 #: ../src/guestfs-actions.pod:3358
11430 " guestfs_is_busy (guestfs_h *g);\n"
11435 #: ../src/guestfs-actions.pod:3361 ../fish/guestfish-actions.pod:2328
11437 "This returns true iff this handle is busy processing a command (in the "
11442 #: ../src/guestfs-actions.pod:3370
11443 msgid "guestfs_is_chardev"
11447 #: ../src/guestfs-actions.pod:3372
11451 " guestfs_is_chardev (guestfs_h *g,\n"
11452 " const char *path);\n"
11457 #: ../src/guestfs-actions.pod:3376 ../fish/guestfish-actions.pod:2337
11459 "This returns C<true> if and only if there is a character device with the "
11460 "given C<path> name."
11464 #: ../src/guestfs-actions.pod:3385
11465 msgid "guestfs_is_config"
11469 #: ../src/guestfs-actions.pod:3387
11473 " guestfs_is_config (guestfs_h *g);\n"
11478 #: ../src/guestfs-actions.pod:3390 ../fish/guestfish-actions.pod:2346
11480 "This returns true iff this handle is being configured (in the C<CONFIG> "
11485 #: ../src/guestfs-actions.pod:3399
11486 msgid "guestfs_is_dir"
11490 #: ../src/guestfs-actions.pod:3401
11494 " guestfs_is_dir (guestfs_h *g,\n"
11495 " const char *path);\n"
11500 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2355
11502 "This returns C<true> if and only if there is a directory with the given "
11503 "C<path> name. Note that it returns false for other objects like files."
11507 #: ../src/guestfs-actions.pod:3415
11508 msgid "guestfs_is_fifo"
11512 #: ../src/guestfs-actions.pod:3417
11516 " guestfs_is_fifo (guestfs_h *g,\n"
11517 " const char *path);\n"
11522 #: ../src/guestfs-actions.pod:3421 ../fish/guestfish-actions.pod:2365
11524 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11525 "given C<path> name."
11529 #: ../src/guestfs-actions.pod:3430
11530 msgid "guestfs_is_file"
11534 #: ../src/guestfs-actions.pod:3432
11538 " guestfs_is_file (guestfs_h *g,\n"
11539 " const char *path);\n"
11544 #: ../src/guestfs-actions.pod:3436 ../fish/guestfish-actions.pod:2374
11546 "This returns C<true> if and only if there is a regular file with the given "
11547 "C<path> name. Note that it returns false for other objects like "
11552 #: ../src/guestfs-actions.pod:3446
11553 msgid "guestfs_is_launching"
11557 #: ../src/guestfs-actions.pod:3448
11561 " guestfs_is_launching (guestfs_h *g);\n"
11566 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2384
11568 "This returns true iff this handle is launching the subprocess (in the "
11569 "C<LAUNCHING> state)."
11573 #: ../src/guestfs-actions.pod:3460
11574 msgid "guestfs_is_lv"
11578 #: ../src/guestfs-actions.pod:3462
11582 " guestfs_is_lv (guestfs_h *g,\n"
11583 " const char *device);\n"
11588 #: ../src/guestfs-actions.pod:3466 ../fish/guestfish-actions.pod:2393
11590 "This command tests whether C<device> is a logical volume, and returns true "
11591 "iff this is the case."
11595 #: ../src/guestfs-actions.pod:3473
11596 msgid "guestfs_is_ready"
11600 #: ../src/guestfs-actions.pod:3475
11604 " guestfs_is_ready (guestfs_h *g);\n"
11609 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2400
11611 "This returns true iff this handle is ready to accept commands (in the "
11616 #: ../src/guestfs-actions.pod:3487
11617 msgid "guestfs_is_socket"
11621 #: ../src/guestfs-actions.pod:3489
11625 " guestfs_is_socket (guestfs_h *g,\n"
11626 " const char *path);\n"
11631 #: ../src/guestfs-actions.pod:3493 ../fish/guestfish-actions.pod:2409
11633 "This returns C<true> if and only if there is a Unix domain socket with the "
11634 "given C<path> name."
11638 #: ../src/guestfs-actions.pod:3502
11639 msgid "guestfs_is_symlink"
11643 #: ../src/guestfs-actions.pod:3504
11647 " guestfs_is_symlink (guestfs_h *g,\n"
11648 " const char *path);\n"
11653 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2418
11655 "This returns C<true> if and only if there is a symbolic link with the given "
11660 #: ../src/guestfs-actions.pod:3517
11661 msgid "guestfs_is_zero"
11665 #: ../src/guestfs-actions.pod:3519
11669 " guestfs_is_zero (guestfs_h *g,\n"
11670 " const char *path);\n"
11675 #: ../src/guestfs-actions.pod:3523 ../fish/guestfish-actions.pod:2427
11677 "This returns true iff the file exists and the file is empty or it contains "
11682 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3542
11683 msgid "(Added in 1.11.8)"
11687 #: ../src/guestfs-actions.pod:3530
11688 msgid "guestfs_is_zero_device"
11692 #: ../src/guestfs-actions.pod:3532
11696 " guestfs_is_zero_device (guestfs_h *g,\n"
11697 " const char *device);\n"
11702 #: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2434
11703 msgid "This returns true iff the device exists and contains all zero bytes."
11707 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2436
11708 msgid "Note that for large devices this can take a long time to run."
11712 #: ../src/guestfs-actions.pod:3544
11713 msgid "guestfs_kill_subprocess"
11717 #: ../src/guestfs-actions.pod:3546
11721 " guestfs_kill_subprocess (guestfs_h *g);\n"
11726 #: ../src/guestfs-actions.pod:3549 ../fish/guestfish-actions.pod:2442
11727 msgid "This kills the qemu subprocess. You should never need to call this."
11731 #: ../src/guestfs-actions.pod:3555
11732 msgid "guestfs_launch"
11736 #: ../src/guestfs-actions.pod:3557
11740 " guestfs_launch (guestfs_h *g);\n"
11745 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2450
11747 "Internally libguestfs is implemented by running a virtual machine using "
11752 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2453
11754 "You should call this after configuring the handle (eg. adding drives) but "
11755 "before performing any actions."
11759 #: ../src/guestfs-actions.pod:3575
11760 msgid "guestfs_lchown"
11764 #: ../src/guestfs-actions.pod:3577
11768 " guestfs_lchown (guestfs_h *g,\n"
11771 " const char *path);\n"
11776 #: ../src/guestfs-actions.pod:3583
11778 "Change the file owner to C<owner> and group to C<group>. This is like "
11779 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11780 "changed, not the target."
11784 #: ../src/guestfs-actions.pod:3595
11785 msgid "guestfs_lgetxattr"
11789 #: ../src/guestfs-actions.pod:3597
11793 " guestfs_lgetxattr (guestfs_h *g,\n"
11794 " const char *path,\n"
11795 " const char *name,\n"
11796 " size_t *size_r);\n"
11801 #: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2472
11803 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11804 "is a symlink, then this call returns an extended attribute from the symlink."
11808 #: ../src/guestfs-actions.pod:3617
11809 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11813 #: ../src/guestfs-actions.pod:3625
11814 msgid "guestfs_lgetxattrs"
11818 #: ../src/guestfs-actions.pod:3627
11821 " struct guestfs_xattr_list *\n"
11822 " guestfs_lgetxattrs (guestfs_h *g,\n"
11823 " const char *path);\n"
11828 #: ../src/guestfs-actions.pod:3631
11830 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11831 "then it returns the extended attributes of the link itself."
11835 #: ../src/guestfs-actions.pod:3641
11836 msgid "guestfs_list_9p"
11840 #: ../src/guestfs-actions.pod:3643
11844 " guestfs_list_9p (guestfs_h *g);\n"
11849 #: ../src/guestfs-actions.pod:3646 ../fish/guestfish-actions.pod:2500
11851 "List all 9p filesystems attached to the guest. A list of mount tags is "
11856 #: ../src/guestfs-actions.pod:3655
11857 msgid "guestfs_list_devices"
11861 #: ../src/guestfs-actions.pod:3657
11865 " guestfs_list_devices (guestfs_h *g);\n"
11870 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2507
11871 msgid "List all the block devices."
11875 #: ../src/guestfs-actions.pod:3662 ../fish/guestfish-actions.pod:2509
11876 msgid "The full block device names are returned, eg. C</dev/sda>."
11880 #: ../src/guestfs-actions.pod:3672
11881 msgid "guestfs_list_filesystems"
11885 #: ../src/guestfs-actions.pod:3674
11889 " guestfs_list_filesystems (guestfs_h *g);\n"
11894 #: ../src/guestfs-actions.pod:3677 ../fish/guestfish-actions.pod:2517
11896 "This inspection command looks for filesystems on partitions, block devices "
11897 "and logical volumes, returning a list of devices containing filesystems and "
11902 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2521
11904 "The return value is a hash, where the keys are the devices containing "
11905 "filesystems, and the values are the filesystem types. For example:"
11909 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2525
11912 " \"/dev/sda1\" => \"ntfs\"\n"
11913 " \"/dev/sda2\" => \"ext2\"\n"
11914 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11915 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11920 #: ../src/guestfs-actions.pod:3690 ../fish/guestfish-actions.pod:2530
11922 "The value can have the special value \"unknown\", meaning the content of the "
11923 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11927 #: ../src/guestfs-actions.pod:3694
11929 "This command runs other libguestfs commands, which might include "
11930 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11931 "soon after launch and only when nothing is mounted."
11935 #: ../src/guestfs-actions.pod:3698
11937 "Not all of the filesystems returned will be mountable. In particular, swap "
11938 "partitions are returned in the list. Also this command does not check that "
11939 "each filesystem found is valid and mountable, and some filesystems might be "
11940 "mountable but require special options. Filesystems may not all belong to a "
11941 "single logical operating system (use C<guestfs_inspect_os> to look for "
11946 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:5374
11947 msgid "(Added in 1.5.15)"
11951 #: ../src/guestfs-actions.pod:3714
11952 msgid "guestfs_list_partitions"
11956 #: ../src/guestfs-actions.pod:3716
11960 " guestfs_list_partitions (guestfs_h *g);\n"
11965 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2550
11966 msgid "List all the partitions detected on all block devices."
11970 #: ../src/guestfs-actions.pod:3721 ../fish/guestfish-actions.pod:2552
11971 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11975 #: ../src/guestfs-actions.pod:3723
11977 "This does not return logical volumes. For that you will need to call "
11982 #: ../src/guestfs-actions.pod:3734
11987 #: ../src/guestfs-actions.pod:3736
11991 " guestfs_ll (guestfs_h *g,\n"
11992 " const char *directory);\n"
11997 #: ../src/guestfs-actions.pod:3740 ../fish/guestfish-actions.pod:2563
11999 "List the files in C<directory> (relative to the root directory, there is no "
12000 "cwd) in the format of 'ls -la'."
12004 #: ../src/guestfs-actions.pod:3743 ../fish/guestfish-actions.pod:2566
12006 "This command is mostly useful for interactive sessions. It is I<not> "
12007 "intended that you try to parse the output string."
12011 #: ../src/guestfs-actions.pod:3751
12016 #: ../src/guestfs-actions.pod:3753
12020 " guestfs_ln (guestfs_h *g,\n"
12021 " const char *target,\n"
12022 " const char *linkname);\n"
12027 #: ../src/guestfs-actions.pod:3758 ../fish/guestfish-actions.pod:2573
12028 msgid "This command creates a hard link using the C<ln> command."
12032 #: ../src/guestfs-actions.pod:3764
12033 msgid "guestfs_ln_f"
12037 #: ../src/guestfs-actions.pod:3766
12041 " guestfs_ln_f (guestfs_h *g,\n"
12042 " const char *target,\n"
12043 " const char *linkname);\n"
12048 #: ../src/guestfs-actions.pod:3771 ../fish/guestfish-actions.pod:2579
12050 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12051 "option removes the link (C<linkname>) if it exists already."
12055 #: ../src/guestfs-actions.pod:3778
12056 msgid "guestfs_ln_s"
12060 #: ../src/guestfs-actions.pod:3780
12064 " guestfs_ln_s (guestfs_h *g,\n"
12065 " const char *target,\n"
12066 " const char *linkname);\n"
12071 #: ../src/guestfs-actions.pod:3785 ../fish/guestfish-actions.pod:2586
12072 msgid "This command creates a symbolic link using the C<ln -s> command."
12076 #: ../src/guestfs-actions.pod:3791
12077 msgid "guestfs_ln_sf"
12081 #: ../src/guestfs-actions.pod:3793
12085 " guestfs_ln_sf (guestfs_h *g,\n"
12086 " const char *target,\n"
12087 " const char *linkname);\n"
12092 #: ../src/guestfs-actions.pod:3798 ../fish/guestfish-actions.pod:2592
12094 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12095 "option removes the link (C<linkname>) if it exists already."
12099 #: ../src/guestfs-actions.pod:3805
12100 msgid "guestfs_lremovexattr"
12104 #: ../src/guestfs-actions.pod:3807
12108 " guestfs_lremovexattr (guestfs_h *g,\n"
12109 " const char *xattr,\n"
12110 " const char *path);\n"
12115 #: ../src/guestfs-actions.pod:3812
12117 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12118 "link, then it removes an extended attribute of the link itself."
12122 #: ../src/guestfs-actions.pod:3820
12127 #: ../src/guestfs-actions.pod:3822
12131 " guestfs_ls (guestfs_h *g,\n"
12132 " const char *directory);\n"
12137 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2607
12139 "List the files in C<directory> (relative to the root directory, there is no "
12140 "cwd). The '.' and '..' entries are not returned, but hidden files are "
12145 #: ../src/guestfs-actions.pod:3830
12147 "This command is mostly useful for interactive sessions. Programs should "
12148 "probably use C<guestfs_readdir> instead."
12152 #: ../src/guestfs-actions.pod:3839
12153 msgid "guestfs_lsetxattr"
12157 #: ../src/guestfs-actions.pod:3841
12161 " guestfs_lsetxattr (guestfs_h *g,\n"
12162 " const char *xattr,\n"
12163 " const char *val,\n"
12165 " const char *path);\n"
12170 #: ../src/guestfs-actions.pod:3848
12172 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12173 "then it sets an extended attribute of the link itself."
12177 #: ../src/guestfs-actions.pod:3856
12178 msgid "guestfs_lstat"
12182 #: ../src/guestfs-actions.pod:3858
12185 " struct guestfs_stat *\n"
12186 " guestfs_lstat (guestfs_h *g,\n"
12187 " const char *path);\n"
12192 #: ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:2626 ../fish/guestfish-actions.pod:4343
12193 msgid "Returns file information for the given C<path>."
12197 #: ../src/guestfs-actions.pod:3864
12199 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12200 "link, then the link is stat-ed, not the file it refers to."
12204 #: ../src/guestfs-actions.pod:3868 ../fish/guestfish-actions.pod:2632
12205 msgid "This is the same as the C<lstat(2)> system call."
12209 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:6513
12211 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12212 "error. I<The caller must call C<guestfs_free_stat> after use>."
12216 #: ../src/guestfs-actions.pod:3874 ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6535 ../src/guestfs-actions.pod:6916
12217 msgid "(Added in 0.9.2)"
12221 #: ../src/guestfs-actions.pod:3876
12222 msgid "guestfs_lstatlist"
12226 #: ../src/guestfs-actions.pod:3878
12229 " struct guestfs_stat_list *\n"
12230 " guestfs_lstatlist (guestfs_h *g,\n"
12231 " const char *path,\n"
12232 " char *const *names);\n"
12237 #: ../src/guestfs-actions.pod:3883
12239 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12240 "files, where all files are in the directory C<path>. C<names> is the list "
12241 "of files from this directory."
12245 #: ../src/guestfs-actions.pod:3887 ../fish/guestfish-actions.pod:2642
12247 "On return you get a list of stat structs, with a one-to-one correspondence "
12248 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12249 "then the C<ino> field of that structure is set to C<-1>."
12253 #: ../src/guestfs-actions.pod:3892
12255 "This call is intended for programs that want to efficiently list a directory "
12256 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12257 "for a similarly efficient call for getting extended attributes. Very long "
12258 "directory listings might cause the protocol message size to be exceeded, "
12259 "causing this call to fail. The caller must split up such requests into "
12260 "smaller groups of names."
12264 #: ../src/guestfs-actions.pod:3900
12266 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12267 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12271 #: ../src/guestfs-actions.pod:3906
12272 msgid "guestfs_luks_add_key"
12276 #: ../src/guestfs-actions.pod:3908
12280 " guestfs_luks_add_key (guestfs_h *g,\n"
12281 " const char *device,\n"
12282 " const char *key,\n"
12283 " const char *newkey,\n"
12289 #: ../src/guestfs-actions.pod:3915 ../fish/guestfish-actions.pod:2659
12291 "This command adds a new key on LUKS device C<device>. C<key> is any "
12292 "existing key, and is used to access the device. C<newkey> is the new key to "
12293 "add. C<keyslot> is the key slot that will be replaced."
12297 #: ../src/guestfs-actions.pod:3920
12299 "Note that if C<keyslot> already contains a key, then this command will "
12300 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12304 #: ../src/guestfs-actions.pod:3926 ../src/guestfs-actions.pod:3966 ../src/guestfs-actions.pod:3989 ../src/guestfs-actions.pod:4009 ../src/guestfs-actions.pod:4041 ../src/guestfs-actions.pod:4060
12306 "This function takes a key or passphrase parameter which could contain "
12307 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12312 #: ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:4013
12313 msgid "(Added in 1.5.2)"
12317 #: ../src/guestfs-actions.pod:3932
12318 msgid "guestfs_luks_close"
12322 #: ../src/guestfs-actions.pod:3934
12326 " guestfs_luks_close (guestfs_h *g,\n"
12327 " const char *device);\n"
12332 #: ../src/guestfs-actions.pod:3938
12334 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12335 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12336 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12337 "underlying block device."
12341 #: ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:4045 ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4162
12342 msgid "(Added in 1.5.1)"
12346 #: ../src/guestfs-actions.pod:3948
12347 msgid "guestfs_luks_format"
12351 #: ../src/guestfs-actions.pod:3950
12355 " guestfs_luks_format (guestfs_h *g,\n"
12356 " const char *device,\n"
12357 " const char *key,\n"
12363 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2685
12365 "This command erases existing data on C<device> and formats the device as a "
12366 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12367 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12371 #: ../src/guestfs-actions.pod:3963 ../src/guestfs-actions.pod:3986 ../src/guestfs-actions.pod:4126 ../src/guestfs-actions.pod:5125 ../src/guestfs-actions.pod:5907 ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6379 ../src/guestfs-actions.pod:7561 ../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
12373 "B<This command is dangerous. Without careful use you can easily destroy all "
12378 #: ../src/guestfs-actions.pod:3972
12379 msgid "guestfs_luks_format_cipher"
12383 #: ../src/guestfs-actions.pod:3974
12387 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12388 " const char *device,\n"
12389 " const char *key,\n"
12391 " const char *cipher);\n"
12396 #: ../src/guestfs-actions.pod:3981
12398 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12399 "set the C<cipher> used."
12403 #: ../src/guestfs-actions.pod:3995
12404 msgid "guestfs_luks_kill_slot"
12408 #: ../src/guestfs-actions.pod:3997
12412 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12413 " const char *device,\n"
12414 " const char *key,\n"
12420 #: ../src/guestfs-actions.pod:4003 ../fish/guestfish-actions.pod:2713
12422 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12423 "device C<device>. C<key> must be one of the I<other> keys."
12427 #: ../src/guestfs-actions.pod:4015
12428 msgid "guestfs_luks_open"
12432 #: ../src/guestfs-actions.pod:4017
12436 " guestfs_luks_open (guestfs_h *g,\n"
12437 " const char *device,\n"
12438 " const char *key,\n"
12439 " const char *mapname);\n"
12444 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2724
12446 "This command opens a block device which has been encrypted according to the "
12447 "Linux Unified Key Setup (LUKS) standard."
12451 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2727
12452 msgid "C<device> is the encrypted block device or partition."
12456 #: ../src/guestfs-actions.pod:4028 ../fish/guestfish-actions.pod:2729
12458 "The caller must supply one of the keys associated with the LUKS block "
12459 "device, in the C<key> parameter."
12463 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2732
12465 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12466 "writes to this block device are decrypted from and encrypted to the "
12467 "underlying C<device> respectively."
12471 #: ../src/guestfs-actions.pod:4035
12473 "If this block device contains LVM volume groups, then calling "
12474 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12479 #: ../src/guestfs-actions.pod:4047
12480 msgid "guestfs_luks_open_ro"
12484 #: ../src/guestfs-actions.pod:4049
12488 " guestfs_luks_open_ro (guestfs_h *g,\n"
12489 " const char *device,\n"
12490 " const char *key,\n"
12491 " const char *mapname);\n"
12496 #: ../src/guestfs-actions.pod:4055
12498 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12503 #: ../src/guestfs-actions.pod:4066
12504 msgid "guestfs_lvcreate"
12508 #: ../src/guestfs-actions.pod:4068
12512 " guestfs_lvcreate (guestfs_h *g,\n"
12513 " const char *logvol,\n"
12514 " const char *volgroup,\n"
12520 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:2757
12522 "This creates an LVM logical volume called C<logvol> on the volume group "
12523 "C<volgroup>, with C<size> megabytes."
12527 #: ../src/guestfs-actions.pod:4081
12528 msgid "guestfs_lvm_canonical_lv_name"
12532 #: ../src/guestfs-actions.pod:4083
12536 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12537 " const char *lvname);\n"
12542 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2764
12544 "This converts alternative naming schemes for LVs that you might find to the "
12545 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12550 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2768
12552 "This command returns an error if the C<lvname> parameter does not refer to a "
12557 #: ../src/guestfs-actions.pod:4094
12558 msgid "See also C<guestfs_is_lv>."
12562 #: ../src/guestfs-actions.pod:4099
12563 msgid "(Added in 1.5.24)"
12567 #: ../src/guestfs-actions.pod:4101
12568 msgid "guestfs_lvm_clear_filter"
12572 #: ../src/guestfs-actions.pod:4103
12576 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12581 #: ../src/guestfs-actions.pod:4106
12583 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12584 "see every block device."
12588 #: ../src/guestfs-actions.pod:4109 ../src/guestfs-actions.pod:4151 ../fish/guestfish-actions.pod:2780 ../fish/guestfish-actions.pod:2811
12589 msgid "This command also clears the LVM cache and performs a volume group scan."
12593 #: ../src/guestfs-actions.pod:4116
12594 msgid "guestfs_lvm_remove_all"
12598 #: ../src/guestfs-actions.pod:4118
12602 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12607 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2787
12609 "This command removes all LVM logical volumes, volume groups and physical "
12614 #: ../src/guestfs-actions.pod:4131
12615 msgid "guestfs_lvm_set_filter"
12619 #: ../src/guestfs-actions.pod:4133
12623 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12624 " char *const *devices);\n"
12629 #: ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:2797
12631 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12632 "block devices in the list C<devices>, and will ignore all other attached "
12637 #: ../src/guestfs-actions.pod:4141 ../fish/guestfish-actions.pod:2801
12639 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12640 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12641 "there are two types of duplication possible: either cloned PVs/VGs which "
12642 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12643 "same name. In normal operation you cannot create this situation, but you "
12644 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12645 "inside the LVM metadata."
12649 #: ../src/guestfs-actions.pod:4154 ../fish/guestfish-actions.pod:2814
12650 msgid "You can filter whole block devices or individual partitions."
12654 #: ../src/guestfs-actions.pod:4156 ../fish/guestfish-actions.pod:2816
12656 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12657 "filesystem), even if you are not filtering out that VG."
12661 #: ../src/guestfs-actions.pod:4164
12662 msgid "guestfs_lvremove"
12666 #: ../src/guestfs-actions.pod:4166
12670 " guestfs_lvremove (guestfs_h *g,\n"
12671 " const char *device);\n"
12676 #: ../src/guestfs-actions.pod:4170 ../fish/guestfish-actions.pod:2824
12678 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12679 "LV, such as C</dev/VG/LV>."
12683 #: ../src/guestfs-actions.pod:4173 ../fish/guestfish-actions.pod:2827
12685 "You can also remove all LVs in a volume group by specifying the VG name, "
12690 #: ../src/guestfs-actions.pod:4178 ../src/guestfs-actions.pod:5471 ../src/guestfs-actions.pod:7292
12691 msgid "(Added in 1.0.13)"
12695 #: ../src/guestfs-actions.pod:4180
12696 msgid "guestfs_lvrename"
12700 #: ../src/guestfs-actions.pod:4182
12704 " guestfs_lvrename (guestfs_h *g,\n"
12705 " const char *logvol,\n"
12706 " const char *newlogvol);\n"
12711 #: ../src/guestfs-actions.pod:4187 ../fish/guestfish-actions.pod:2834
12712 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12716 #: ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:7305
12717 msgid "(Added in 1.0.83)"
12721 #: ../src/guestfs-actions.pod:4193
12722 msgid "guestfs_lvresize"
12726 #: ../src/guestfs-actions.pod:4195
12730 " guestfs_lvresize (guestfs_h *g,\n"
12731 " const char *device,\n"
12737 #: ../src/guestfs-actions.pod:4200 ../fish/guestfish-actions.pod:2840
12739 "This resizes (expands or shrinks) an existing LVM logical volume to "
12740 "C<mbytes>. When reducing, data in the reduced part is lost."
12744 #: ../src/guestfs-actions.pod:4208
12745 msgid "guestfs_lvresize_free"
12749 #: ../src/guestfs-actions.pod:4210
12753 " guestfs_lvresize_free (guestfs_h *g,\n"
12754 " const char *lv,\n"
12760 #: ../src/guestfs-actions.pod:4215 ../fish/guestfish-actions.pod:2848
12762 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12763 "remaining free space in the volume group. Commonly you would call this with "
12764 "pc = 100 which expands the logical volume as much as possible, using all "
12765 "remaining free space in the volume group."
12769 #: ../src/guestfs-actions.pod:4223
12770 msgid "(Added in 1.3.3)"
12774 #: ../src/guestfs-actions.pod:4225
12775 msgid "guestfs_lvs"
12779 #: ../src/guestfs-actions.pod:4227
12783 " guestfs_lvs (guestfs_h *g);\n"
12788 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2858
12790 "List all the logical volumes detected. This is the equivalent of the "
12791 "L<lvs(8)> command."
12795 #: ../src/guestfs-actions.pod:4233 ../fish/guestfish-actions.pod:2861
12797 "This returns a list of the logical volume device names "
12798 "(eg. C</dev/VolGroup00/LogVol00>)."
12802 #: ../src/guestfs-actions.pod:4236
12803 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12807 #: ../src/guestfs-actions.pod:4244
12808 msgid "guestfs_lvs_full"
12812 #: ../src/guestfs-actions.pod:4246
12815 " struct guestfs_lvm_lv_list *\n"
12816 " guestfs_lvs_full (guestfs_h *g);\n"
12821 #: ../src/guestfs-actions.pod:4249 ../fish/guestfish-actions.pod:2870
12823 "List all the logical volumes detected. This is the equivalent of the "
12824 "L<lvs(8)> command. The \"full\" version includes all fields."
12828 #: ../src/guestfs-actions.pod:4252
12830 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12831 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12836 #: ../src/guestfs-actions.pod:4258
12837 msgid "guestfs_lvuuid"
12841 #: ../src/guestfs-actions.pod:4260
12845 " guestfs_lvuuid (guestfs_h *g,\n"
12846 " const char *device);\n"
12851 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2877
12852 msgid "This command returns the UUID of the LVM LV C<device>."
12856 #: ../src/guestfs-actions.pod:4271
12857 msgid "guestfs_lxattrlist"
12861 #: ../src/guestfs-actions.pod:4273
12864 " struct guestfs_xattr_list *\n"
12865 " guestfs_lxattrlist (guestfs_h *g,\n"
12866 " const char *path,\n"
12867 " char *const *names);\n"
12872 #: ../src/guestfs-actions.pod:4278 ../fish/guestfish-actions.pod:2883
12874 "This call allows you to get the extended attributes of multiple files, where "
12875 "all files are in the directory C<path>. C<names> is the list of files from "
12880 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2887
12882 "On return you get a flat list of xattr structs which must be interpreted "
12883 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12884 "C<attrval> in this struct is zero-length to indicate there was an error "
12885 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12886 "number (the number of following attributes for this file, which could be "
12887 "C<\"0\">). Then after the first xattr struct are the zero or more "
12888 "attributes for the first named file. This repeats for the second and "
12889 "subsequent files."
12893 #: ../src/guestfs-actions.pod:4292
12895 "This call is intended for programs that want to efficiently list a directory "
12896 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12897 "a similarly efficient call for getting standard stats. Very long directory "
12898 "listings might cause the protocol message size to be exceeded, causing this "
12899 "call to fail. The caller must split up such requests into smaller groups of "
12904 #: ../src/guestfs-actions.pod:4306
12905 msgid "guestfs_mkdir"
12909 #: ../src/guestfs-actions.pod:4308
12913 " guestfs_mkdir (guestfs_h *g,\n"
12914 " const char *path);\n"
12919 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:2909
12920 msgid "Create a directory named C<path>."
12924 #: ../src/guestfs-actions.pod:4318
12925 msgid "guestfs_mkdir_mode"
12929 #: ../src/guestfs-actions.pod:4320
12933 " guestfs_mkdir_mode (guestfs_h *g,\n"
12934 " const char *path,\n"
12940 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2915
12942 "This command creates a directory, setting the initial permissions of the "
12943 "directory to C<mode>."
12947 #: ../src/guestfs-actions.pod:4328 ../fish/guestfish-actions.pod:2918
12949 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12950 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12955 #: ../src/guestfs-actions.pod:4332
12956 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12960 #: ../src/guestfs-actions.pod:4338
12961 msgid "guestfs_mkdir_p"
12965 #: ../src/guestfs-actions.pod:4340
12969 " guestfs_mkdir_p (guestfs_h *g,\n"
12970 " const char *path);\n"
12975 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2928
12977 "Create a directory named C<path>, creating any parent directories as "
12978 "necessary. This is like the C<mkdir -p> shell command."
12982 #: ../src/guestfs-actions.pod:4351
12983 msgid "guestfs_mkdtemp"
12987 #: ../src/guestfs-actions.pod:4353
12991 " guestfs_mkdtemp (guestfs_h *g,\n"
12992 " const char *template);\n"
12997 #: ../src/guestfs-actions.pod:4357 ../fish/guestfish-actions.pod:2935
12999 "This command creates a temporary directory. The C<template> parameter "
13000 "should be a full pathname for the temporary directory name with the final "
13001 "six characters being \"XXXXXX\"."
13005 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2940
13007 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13008 "being suitable for Windows filesystems."
13012 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:2943
13013 msgid "The name of the temporary directory that was created is returned."
13017 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2946
13018 msgid "The temporary directory is created with mode 0700 and is owned by root."
13022 #: ../src/guestfs-actions.pod:4371 ../fish/guestfish-actions.pod:2949
13024 "The caller is responsible for deleting the temporary directory and its "
13025 "contents after use."
13029 #: ../src/guestfs-actions.pod:4374 ../fish/guestfish-actions.pod:2952
13030 msgid "See also: L<mkdtemp(3)>"
13034 #: ../src/guestfs-actions.pod:4381
13035 msgid "guestfs_mke2fs_J"
13039 #: ../src/guestfs-actions.pod:4383
13043 " guestfs_mke2fs_J (guestfs_h *g,\n"
13044 " const char *fstype,\n"
13045 " int blocksize,\n"
13046 " const char *device,\n"
13047 " const char *journal);\n"
13052 #: ../src/guestfs-actions.pod:4390 ../fish/guestfish-actions.pod:2958
13054 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13055 "C<journal>. It is equivalent to the command:"
13059 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2962
13062 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13067 #: ../src/guestfs-actions.pod:4396
13068 msgid "See also C<guestfs_mke2journal>."
13072 #: ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:4436 ../src/guestfs-actions.pod:4452 ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4480 ../src/guestfs-actions.pod:4539 ../src/guestfs-actions.pod:4804
13073 msgid "(Added in 1.0.68)"
13077 #: ../src/guestfs-actions.pod:4402
13078 msgid "guestfs_mke2fs_JL"
13082 #: ../src/guestfs-actions.pod:4404
13086 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13087 " const char *fstype,\n"
13088 " int blocksize,\n"
13089 " const char *device,\n"
13090 " const char *label);\n"
13095 #: ../src/guestfs-actions.pod:4411 ../fish/guestfish-actions.pod:2970
13097 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13098 "the journal labeled C<label>."
13102 #: ../src/guestfs-actions.pod:4414
13103 msgid "See also C<guestfs_mke2journal_L>."
13107 #: ../src/guestfs-actions.pod:4420
13108 msgid "guestfs_mke2fs_JU"
13112 #: ../src/guestfs-actions.pod:4422
13116 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13117 " const char *fstype,\n"
13118 " int blocksize,\n"
13119 " const char *device,\n"
13120 " const char *uuid);\n"
13125 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2979
13127 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13128 "the journal with UUID C<uuid>."
13132 #: ../src/guestfs-actions.pod:4432
13133 msgid "See also C<guestfs_mke2journal_U>."
13137 #: ../src/guestfs-actions.pod:4438
13138 msgid "guestfs_mke2journal"
13142 #: ../src/guestfs-actions.pod:4440
13146 " guestfs_mke2journal (guestfs_h *g,\n"
13147 " int blocksize,\n"
13148 " const char *device);\n"
13153 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2988
13155 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13160 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2991
13163 " mke2fs -O journal_dev -b blocksize device\n"
13168 #: ../src/guestfs-actions.pod:4454
13169 msgid "guestfs_mke2journal_L"
13173 #: ../src/guestfs-actions.pod:4456
13177 " guestfs_mke2journal_L (guestfs_h *g,\n"
13178 " int blocksize,\n"
13179 " const char *label,\n"
13180 " const char *device);\n"
13185 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2997
13186 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13190 #: ../src/guestfs-actions.pod:4468
13191 msgid "guestfs_mke2journal_U"
13195 #: ../src/guestfs-actions.pod:4470
13199 " guestfs_mke2journal_U (guestfs_h *g,\n"
13200 " int blocksize,\n"
13201 " const char *uuid,\n"
13202 " const char *device);\n"
13207 #: ../src/guestfs-actions.pod:4476 ../fish/guestfish-actions.pod:3003
13208 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13212 #: ../src/guestfs-actions.pod:4482
13213 msgid "guestfs_mkfifo"
13217 #: ../src/guestfs-actions.pod:4484
13221 " guestfs_mkfifo (guestfs_h *g,\n"
13223 " const char *path);\n"
13228 #: ../src/guestfs-actions.pod:4489
13230 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13231 "is just a convenient wrapper around C<guestfs_mknod>."
13235 #: ../src/guestfs-actions.pod:4499
13236 msgid "guestfs_mkfs"
13240 #: ../src/guestfs-actions.pod:4501
13244 " guestfs_mkfs (guestfs_h *g,\n"
13245 " const char *fstype,\n"
13246 " const char *device);\n"
13251 #: ../src/guestfs-actions.pod:4506 ../fish/guestfish-actions.pod:3019
13253 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13254 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13258 #: ../src/guestfs-actions.pod:4514
13259 msgid "guestfs_mkfs_b"
13263 #: ../src/guestfs-actions.pod:4516
13267 " guestfs_mkfs_b (guestfs_h *g,\n"
13268 " const char *fstype,\n"
13269 " int blocksize,\n"
13270 " const char *device);\n"
13275 #: ../src/guestfs-actions.pod:4522
13277 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13278 "block size of the resulting filesystem. Supported block sizes depend on the "
13279 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13283 #: ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3032 ../fish/guestfish-actions.pod:3059
13285 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13290 #: ../src/guestfs-actions.pod:4532 ../fish/guestfish-actions.pod:3035
13292 "This function is deprecated. In new code, use the C<mkfs_opts> call "
13297 #: ../src/guestfs-actions.pod:4541
13298 msgid "guestfs_mkfs_opts"
13302 #: ../src/guestfs-actions.pod:4543
13306 " guestfs_mkfs_opts (guestfs_h *g,\n"
13307 " const char *fstype,\n"
13308 " const char *device,\n"
13314 #: ../src/guestfs-actions.pod:4554
13317 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13318 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13323 #: ../src/guestfs-actions.pod:4557 ../fish/guestfish-actions.pod:3046
13325 "This function creates a filesystem on C<device>. The filesystem type is "
13326 "C<fstype>, for example C<ext3>."
13330 #: ../src/guestfs-actions.pod:4564 ../fish/guestfish-actions.pod:3053
13331 msgid "C<blocksize>"
13335 #: ../src/guestfs-actions.pod:4566 ../fish/guestfish-actions.pod:3055
13337 "The filesystem block size. Supported block sizes depend on the filesystem "
13338 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13343 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3062
13344 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13348 #: ../src/guestfs-actions.pod:4575 ../fish/guestfish-actions.pod:3064
13349 msgid "C<features>"
13353 #: ../src/guestfs-actions.pod:4577 ../fish/guestfish-actions.pod:3066
13354 msgid "This passes the I<-O> parameter to the external mkfs program."
13358 #: ../src/guestfs-actions.pod:4579 ../fish/guestfish-actions.pod:3068
13360 "For certain filesystem types, this allows extra filesystem features to be "
13361 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13365 #: ../src/guestfs-actions.pod:4583 ../fish/guestfish-actions.pod:3072
13367 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13372 #: ../src/guestfs-actions.pod:4590
13373 msgid "(Added in 1.7.19)"
13377 #: ../src/guestfs-actions.pod:4592
13378 msgid "guestfs_mkfs_opts_va"
13382 #: ../src/guestfs-actions.pod:4594
13386 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13387 " const char *fstype,\n"
13388 " const char *device,\n"
13389 " va_list args);\n"
13394 #: ../src/guestfs-actions.pod:4600
13395 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13399 #: ../src/guestfs-actions.pod:4604
13400 msgid "guestfs_mkfs_opts_argv"
13404 #: ../src/guestfs-actions.pod:4606
13408 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13409 " const char *fstype,\n"
13410 " const char *device,\n"
13411 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13416 #: ../src/guestfs-actions.pod:4612
13417 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13421 #: ../src/guestfs-actions.pod:4616
13422 msgid "guestfs_mkmountpoint"
13426 #: ../src/guestfs-actions.pod:4618
13430 " guestfs_mkmountpoint (guestfs_h *g,\n"
13431 " const char *exemptpath);\n"
13436 #: ../src/guestfs-actions.pod:4622
13438 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13439 "that can be used to create extra mountpoints before mounting the first "
13444 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3087
13446 "These calls are I<only> necessary in some very limited circumstances, mainly "
13447 "the case where you want to mount a mix of unrelated and/or read-only "
13448 "filesystems together."
13452 #: ../src/guestfs-actions.pod:4630 ../fish/guestfish-actions.pod:3091
13454 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13455 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13456 "inside that. You can unpack this as follows in guestfish:"
13460 #: ../src/guestfs-actions.pod:4635 ../fish/guestfish-actions.pod:3096
13463 " add-ro Fedora-11-i686-Live.iso\n"
13465 " mkmountpoint /cd\n"
13466 " mkmountpoint /sqsh\n"
13467 " mkmountpoint /ext3fs\n"
13468 " mount /dev/sda /cd\n"
13469 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13470 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13475 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3105
13476 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13480 #: ../src/guestfs-actions.pod:4646
13482 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13483 "may get unexpected errors if you try to mix these calls. It is safest to "
13484 "manually unmount filesystems and remove mountpoints after use."
13488 #: ../src/guestfs-actions.pod:4650
13490 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13491 "first, so for this to work for manual mountpoints, you must ensure that the "
13492 "innermost mountpoints have the longest pathnames, as in the example code "
13497 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3116
13498 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13502 #: ../src/guestfs-actions.pod:4657
13504 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13505 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13506 "can also trigger these issues."
13510 #: ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4979 ../src/guestfs-actions.pod:5891
13511 msgid "(Added in 1.0.62)"
13515 #: ../src/guestfs-actions.pod:4665
13516 msgid "guestfs_mknod"
13520 #: ../src/guestfs-actions.pod:4667
13524 " guestfs_mknod (guestfs_h *g,\n"
13528 " const char *path);\n"
13533 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3126
13535 "This call creates block or character special devices, or named pipes "
13540 #: ../src/guestfs-actions.pod:4677 ../fish/guestfish-actions.pod:3129
13542 "The C<mode> parameter should be the mode, using the standard constants. "
13543 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13544 "used when creating block and character special devices."
13548 #: ../src/guestfs-actions.pod:4682
13550 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13551 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13552 "regular file). These constants are available in the standard Linux header "
13553 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13554 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13555 "the appropriate constant for you."
13559 #: ../src/guestfs-actions.pod:4696
13560 msgid "guestfs_mknod_b"
13564 #: ../src/guestfs-actions.pod:4698
13568 " guestfs_mknod_b (guestfs_h *g,\n"
13572 " const char *path);\n"
13577 #: ../src/guestfs-actions.pod:4705
13579 "This call creates a block device node called C<path> with mode C<mode> and "
13580 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13581 "wrapper around C<guestfs_mknod>."
13585 #: ../src/guestfs-actions.pod:4715
13586 msgid "guestfs_mknod_c"
13590 #: ../src/guestfs-actions.pod:4717
13594 " guestfs_mknod_c (guestfs_h *g,\n"
13598 " const char *path);\n"
13603 #: ../src/guestfs-actions.pod:4724
13605 "This call creates a char device node called C<path> with mode C<mode> and "
13606 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13607 "wrapper around C<guestfs_mknod>."
13611 #: ../src/guestfs-actions.pod:4734
13612 msgid "guestfs_mkswap"
13616 #: ../src/guestfs-actions.pod:4736
13620 " guestfs_mkswap (guestfs_h *g,\n"
13621 " const char *device);\n"
13626 #: ../src/guestfs-actions.pod:4740 ../fish/guestfish-actions.pod:3168
13627 msgid "Create a swap partition on C<device>."
13631 #: ../src/guestfs-actions.pod:4746
13632 msgid "guestfs_mkswap_L"
13636 #: ../src/guestfs-actions.pod:4748
13640 " guestfs_mkswap_L (guestfs_h *g,\n"
13641 " const char *label,\n"
13642 " const char *device);\n"
13647 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3174
13648 msgid "Create a swap partition on C<device> with label C<label>."
13652 #: ../src/guestfs-actions.pod:4755 ../fish/guestfish-actions.pod:3176
13654 "Note that you cannot attach a swap label to a block device "
13655 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13656 "the kernel or swap tools."
13660 #: ../src/guestfs-actions.pod:4763
13661 msgid "guestfs_mkswap_U"
13665 #: ../src/guestfs-actions.pod:4765
13669 " guestfs_mkswap_U (guestfs_h *g,\n"
13670 " const char *uuid,\n"
13671 " const char *device);\n"
13676 #: ../src/guestfs-actions.pod:4770 ../fish/guestfish-actions.pod:3184
13677 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13681 #: ../src/guestfs-actions.pod:4776
13682 msgid "guestfs_mkswap_file"
13686 #: ../src/guestfs-actions.pod:4778
13690 " guestfs_mkswap_file (guestfs_h *g,\n"
13691 " const char *path);\n"
13696 #: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3190
13697 msgid "Create a swap file."
13701 #: ../src/guestfs-actions.pod:4784
13703 "This command just writes a swap file signature to an existing file. To "
13704 "create the file itself, use something like C<guestfs_fallocate>."
13708 #: ../src/guestfs-actions.pod:4791
13709 msgid "guestfs_modprobe"
13713 #: ../src/guestfs-actions.pod:4793
13717 " guestfs_modprobe (guestfs_h *g,\n"
13718 " const char *modulename);\n"
13723 #: ../src/guestfs-actions.pod:4797 ../fish/guestfish-actions.pod:3199
13724 msgid "This loads a kernel module in the appliance."
13728 #: ../src/guestfs-actions.pod:4799 ../fish/guestfish-actions.pod:3201
13730 "The kernel module must have been whitelisted when libguestfs was built (see "
13731 "C<appliance/kmod.whitelist.in> in the source)."
13735 #: ../src/guestfs-actions.pod:4806
13736 msgid "guestfs_mount"
13740 #: ../src/guestfs-actions.pod:4808
13744 " guestfs_mount (guestfs_h *g,\n"
13745 " const char *device,\n"
13746 " const char *mountpoint);\n"
13751 #: ../src/guestfs-actions.pod:4813 ../fish/guestfish-actions.pod:3208
13753 "Mount a guest disk at a position in the filesystem. Block devices are named "
13754 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13755 "those block devices contain partitions, they will have the usual names "
13756 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13760 #: ../src/guestfs-actions.pod:4819 ../fish/guestfish-actions.pod:3214
13762 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13763 "mounted on C</> before others can be mounted. Other filesystems can only be "
13764 "mounted on directories which already exist."
13768 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3219
13770 "The mounted filesystem is writable, if we have sufficient permissions on the "
13771 "underlying device."
13775 #: ../src/guestfs-actions.pod:4827
13777 "B<Important note:> When you use this call, the filesystem options C<sync> "
13778 "and C<noatime> are set implicitly. This was originally done because we "
13779 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13780 "very large negative performance impact and negligible effect on "
13781 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13782 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13783 "(use an empty string for the first parameter if you don't want any options)."
13787 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3232
13789 "This function is deprecated. In new code, use the C<mount_options> call "
13794 #: ../src/guestfs-actions.pod:4848
13795 msgid "guestfs_mount_9p"
13799 #: ../src/guestfs-actions.pod:4850
13803 " guestfs_mount_9p (guestfs_h *g,\n"
13804 " const char *mounttag,\n"
13805 " const char *mountpoint,\n"
13811 #: ../src/guestfs-actions.pod:4861
13814 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
13819 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3243
13821 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
13826 #: ../src/guestfs-actions.pod:4866 ../fish/guestfish-actions.pod:3246
13828 "If required, C<trans=virtio> will be automatically added to the options. "
13829 "Any other options required can be passed in the optional C<options> "
13834 #: ../src/guestfs-actions.pod:4874
13835 msgid "guestfs_mount_9p_va"
13839 #: ../src/guestfs-actions.pod:4876
13843 " guestfs_mount_9p_va (guestfs_h *g,\n"
13844 " const char *mounttag,\n"
13845 " const char *mountpoint,\n"
13846 " va_list args);\n"
13851 #: ../src/guestfs-actions.pod:4882
13852 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
13856 #: ../src/guestfs-actions.pod:4886
13857 msgid "guestfs_mount_9p_argv"
13861 #: ../src/guestfs-actions.pod:4888
13865 " guestfs_mount_9p_argv (guestfs_h *g,\n"
13866 " const char *mounttag,\n"
13867 " const char *mountpoint,\n"
13868 " const struct guestfs_mount_9p_argv *optargs);\n"
13873 #: ../src/guestfs-actions.pod:4894
13874 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
13878 #: ../src/guestfs-actions.pod:4898
13879 msgid "guestfs_mount_loop"
13883 #: ../src/guestfs-actions.pod:4900
13887 " guestfs_mount_loop (guestfs_h *g,\n"
13888 " const char *file,\n"
13889 " const char *mountpoint);\n"
13894 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3256
13896 "This command lets you mount C<file> (a filesystem image in a file) on a "
13897 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13902 #: ../src/guestfs-actions.pod:4913
13903 msgid "guestfs_mount_options"
13907 #: ../src/guestfs-actions.pod:4915
13911 " guestfs_mount_options (guestfs_h *g,\n"
13912 " const char *options,\n"
13913 " const char *device,\n"
13914 " const char *mountpoint);\n"
13919 #: ../src/guestfs-actions.pod:4921
13921 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13922 "the mount options as for the L<mount(8)> I<-o> flag."
13926 #: ../src/guestfs-actions.pod:4925 ../fish/guestfish-actions.pod:3268
13928 "If the C<options> parameter is an empty string, then no options are passed "
13929 "(all options default to whatever the filesystem uses)."
13933 #: ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:4945 ../src/guestfs-actions.pod:4962
13934 msgid "(Added in 1.0.10)"
13938 #: ../src/guestfs-actions.pod:4933
13939 msgid "guestfs_mount_ro"
13943 #: ../src/guestfs-actions.pod:4935
13947 " guestfs_mount_ro (guestfs_h *g,\n"
13948 " const char *device,\n"
13949 " const char *mountpoint);\n"
13954 #: ../src/guestfs-actions.pod:4940
13956 "This is the same as the C<guestfs_mount> command, but it mounts the "
13957 "filesystem with the read-only (I<-o ro>) flag."
13961 #: ../src/guestfs-actions.pod:4947
13962 msgid "guestfs_mount_vfs"
13966 #: ../src/guestfs-actions.pod:4949
13970 " guestfs_mount_vfs (guestfs_h *g,\n"
13971 " const char *options,\n"
13972 " const char *vfstype,\n"
13973 " const char *device,\n"
13974 " const char *mountpoint);\n"
13979 #: ../src/guestfs-actions.pod:4956
13981 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13982 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13987 #: ../src/guestfs-actions.pod:4964
13988 msgid "guestfs_mountpoints"
13992 #: ../src/guestfs-actions.pod:4966
13996 " guestfs_mountpoints (guestfs_h *g);\n"
14001 #: ../src/guestfs-actions.pod:4969
14003 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14004 "devices. This one returns a hash table (map) of device name to directory "
14005 "where the device is mounted."
14009 #: ../src/guestfs-actions.pod:4981
14010 msgid "guestfs_mounts"
14014 #: ../src/guestfs-actions.pod:4983
14018 " guestfs_mounts (guestfs_h *g);\n"
14023 #: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3299
14025 "This returns the list of currently mounted filesystems. It returns the list "
14026 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14030 #: ../src/guestfs-actions.pod:4989 ../fish/guestfish-actions.pod:3302
14031 msgid "Some internal mounts are not shown."
14035 #: ../src/guestfs-actions.pod:4991
14036 msgid "See also: C<guestfs_mountpoints>"
14040 #: ../src/guestfs-actions.pod:4999
14045 #: ../src/guestfs-actions.pod:5001
14049 " guestfs_mv (guestfs_h *g,\n"
14050 " const char *src,\n"
14051 " const char *dest);\n"
14056 #: ../src/guestfs-actions.pod:5006 ../fish/guestfish-actions.pod:3310
14058 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14059 "destination filename or destination directory."
14063 #: ../src/guestfs-actions.pod:5013
14064 msgid "guestfs_ntfs_3g_probe"
14068 #: ../src/guestfs-actions.pod:5015
14072 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14074 " const char *device);\n"
14079 #: ../src/guestfs-actions.pod:5020 ../fish/guestfish-actions.pod:3317
14081 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14082 "C<device> for mountability. (Not all NTFS volumes can be mounted "
14083 "read-write, and some cannot be mounted at all)."
14087 #: ../src/guestfs-actions.pod:5024 ../fish/guestfish-actions.pod:3321
14089 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14090 "can be mounted read-write. Set it to false if you want to test if the "
14091 "volume can be mounted read-only."
14095 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3325
14097 "The return value is an integer which C<0> if the operation would succeed, or "
14098 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14102 #: ../src/guestfs-actions.pod:5034
14103 msgid "(Added in 1.0.43)"
14107 #: ../src/guestfs-actions.pod:5036
14108 msgid "guestfs_ntfsresize"
14112 #: ../src/guestfs-actions.pod:5038
14116 " guestfs_ntfsresize (guestfs_h *g,\n"
14117 " const char *device);\n"
14122 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3333
14124 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14125 "size of the underlying device. See also L<ntfsresize(8)>."
14129 #: ../src/guestfs-actions.pod:5050
14130 msgid "guestfs_ntfsresize_size"
14134 #: ../src/guestfs-actions.pod:5052
14138 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14139 " const char *device,\n"
14140 " int64_t size);\n"
14145 #: ../src/guestfs-actions.pod:5057
14147 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14148 "to specify the new size (in bytes) explicitly."
14152 #: ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5571 ../src/guestfs-actions.pod:5839 ../src/guestfs-actions.pod:7447
14153 msgid "(Added in 1.3.14)"
14157 #: ../src/guestfs-actions.pod:5064
14158 msgid "guestfs_part_add"
14162 #: ../src/guestfs-actions.pod:5066
14166 " guestfs_part_add (guestfs_h *g,\n"
14167 " const char *device,\n"
14168 " const char *prlogex,\n"
14169 " int64_t startsect,\n"
14170 " int64_t endsect);\n"
14175 #: ../src/guestfs-actions.pod:5073
14177 "This command adds a partition to C<device>. If there is no partition table "
14178 "on the device, call C<guestfs_part_init> first."
14182 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3351
14184 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14185 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14186 "C<logical>) and C<e> (or C<extended>) partition types."
14190 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3356
14192 "C<startsect> and C<endsect> are the start and end of the partition in "
14193 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14194 "from the end of the disk (C<-1> is the last sector)."
14198 #: ../src/guestfs-actions.pod:5085
14200 "Creating a partition which covers the whole disk is not so easy. Use "
14201 "C<guestfs_part_disk> to do that."
14205 #: ../src/guestfs-actions.pod:5090 ../src/guestfs-actions.pod:5128 ../src/guestfs-actions.pod:5181 ../src/guestfs-actions.pod:5259 ../src/guestfs-actions.pod:5297 ../src/guestfs-actions.pod:5316 ../src/guestfs-actions.pod:5356
14206 msgid "(Added in 1.0.78)"
14210 #: ../src/guestfs-actions.pod:5092
14211 msgid "guestfs_part_del"
14215 #: ../src/guestfs-actions.pod:5094
14219 " guestfs_part_del (guestfs_h *g,\n"
14220 " const char *device,\n"
14226 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3367
14227 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14231 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3369
14233 "Note that in the case of MBR partitioning, deleting an extended partition "
14234 "also deletes any logical partitions it contains."
14238 #: ../src/guestfs-actions.pod:5109
14239 msgid "guestfs_part_disk"
14243 #: ../src/guestfs-actions.pod:5111
14247 " guestfs_part_disk (guestfs_h *g,\n"
14248 " const char *device,\n"
14249 " const char *parttype);\n"
14254 #: ../src/guestfs-actions.pod:5116
14256 "This command is simply a combination of C<guestfs_part_init> followed by "
14257 "C<guestfs_part_add> to create a single primary partition covering the whole "
14262 #: ../src/guestfs-actions.pod:5120
14264 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14265 "possible values are described in C<guestfs_part_init>."
14269 #: ../src/guestfs-actions.pod:5130
14270 msgid "guestfs_part_get_bootable"
14274 #: ../src/guestfs-actions.pod:5132
14278 " guestfs_part_get_bootable (guestfs_h *g,\n"
14279 " const char *device,\n"
14285 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3391
14287 "This command returns true if the partition C<partnum> on C<device> has the "
14288 "bootable flag set."
14292 #: ../src/guestfs-actions.pod:5140
14293 msgid "See also C<guestfs_part_set_bootable>."
14297 #: ../src/guestfs-actions.pod:5146
14298 msgid "guestfs_part_get_mbr_id"
14302 #: ../src/guestfs-actions.pod:5148
14306 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14307 " const char *device,\n"
14313 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3400
14315 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14316 "partition C<partnum>."
14320 #: ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5332
14322 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14323 "undefined results for other partition table types (see "
14324 "C<guestfs_part_get_parttype>)."
14328 #: ../src/guestfs-actions.pod:5164
14329 msgid "guestfs_part_get_parttype"
14333 #: ../src/guestfs-actions.pod:5166
14337 " guestfs_part_get_parttype (guestfs_h *g,\n"
14338 " const char *device);\n"
14343 #: ../src/guestfs-actions.pod:5170 ../fish/guestfish-actions.pod:3411
14345 "This command examines the partition table on C<device> and returns the "
14346 "partition table type (format) being used."
14350 #: ../src/guestfs-actions.pod:5173
14352 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14353 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14354 "possible, although unusual. See C<guestfs_part_init> for a full list."
14358 #: ../src/guestfs-actions.pod:5183
14359 msgid "guestfs_part_init"
14363 #: ../src/guestfs-actions.pod:5185
14367 " guestfs_part_init (guestfs_h *g,\n"
14368 " const char *device,\n"
14369 " const char *parttype);\n"
14374 #: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:3423
14376 "This creates an empty partition table on C<device> of one of the partition "
14377 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14378 "(for large disks)."
14382 #: ../src/guestfs-actions.pod:5194
14384 "Initially there are no partitions. Following this, you should call "
14385 "C<guestfs_part_add> for each partition required."
14389 #: ../src/guestfs-actions.pod:5197 ../fish/guestfish-actions.pod:3430
14390 msgid "Possible values for C<parttype> are:"
14394 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3434
14395 msgid "B<efi> | B<gpt>"
14399 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3436
14400 msgid "Intel EFI / GPT partition table."
14404 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3438
14406 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14407 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14408 "the C<mbr> format."
14412 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3442
14413 msgid "B<mbr> | B<msdos>"
14417 #: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:3444
14419 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14420 "Windows. This partition type will B<only> work for device sizes up to 2 "
14421 "TB. For large disks we recommend using C<gpt>."
14425 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3451
14426 msgid "Other partition table types that may work but are not supported include:"
14430 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3456
14435 #: ../src/guestfs-actions.pod:5225 ../fish/guestfish-actions.pod:3458
14436 msgid "AIX disk labels."
14440 #: ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:3460
14441 msgid "B<amiga> | B<rdb>"
14445 #: ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:3462
14446 msgid "Amiga \"Rigid Disk Block\" format."
14450 #: ../src/guestfs-actions.pod:5231 ../fish/guestfish-actions.pod:3464
14455 #: ../src/guestfs-actions.pod:5233 ../fish/guestfish-actions.pod:3466
14456 msgid "BSD disk labels."
14460 #: ../src/guestfs-actions.pod:5235 ../fish/guestfish-actions.pod:3468
14465 #: ../src/guestfs-actions.pod:5237 ../fish/guestfish-actions.pod:3470
14466 msgid "DASD, used on IBM mainframes."
14470 #: ../src/guestfs-actions.pod:5239 ../fish/guestfish-actions.pod:3472
14475 #: ../src/guestfs-actions.pod:5241 ../fish/guestfish-actions.pod:3474
14476 msgid "MIPS/SGI volumes."
14480 #: ../src/guestfs-actions.pod:5243 ../fish/guestfish-actions.pod:3476
14485 #: ../src/guestfs-actions.pod:5245 ../fish/guestfish-actions.pod:3478
14486 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14490 #: ../src/guestfs-actions.pod:5247 ../fish/guestfish-actions.pod:3480
14495 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3482
14496 msgid "NEC PC-98 format, common in Japan apparently."
14500 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3484
14505 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:3486
14506 msgid "Sun disk labels."
14510 #: ../src/guestfs-actions.pod:5261
14511 msgid "guestfs_part_list"
14515 #: ../src/guestfs-actions.pod:5263
14518 " struct guestfs_partition_list *\n"
14519 " guestfs_part_list (guestfs_h *g,\n"
14520 " const char *device);\n"
14525 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3494
14527 "This command parses the partition table on C<device> and returns the list of "
14528 "partitions found."
14532 #: ../src/guestfs-actions.pod:5270 ../fish/guestfish-actions.pod:3497
14533 msgid "The fields in the returned structure are:"
14537 #: ../src/guestfs-actions.pod:5274 ../fish/guestfish-actions.pod:3501
14538 msgid "B<part_num>"
14542 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3503
14543 msgid "Partition number, counting from 1."
14547 #: ../src/guestfs-actions.pod:5278 ../fish/guestfish-actions.pod:3505
14548 msgid "B<part_start>"
14552 #: ../src/guestfs-actions.pod:5280
14554 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14555 "the device's sector size, see C<guestfs_blockdev_getss>."
14559 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3510
14560 msgid "B<part_end>"
14564 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3512
14565 msgid "End of the partition in bytes."
14569 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3514
14570 msgid "B<part_size>"
14574 #: ../src/guestfs-actions.pod:5289 ../fish/guestfish-actions.pod:3516
14575 msgid "Size of the partition in bytes."
14579 #: ../src/guestfs-actions.pod:5293
14581 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14582 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14587 #: ../src/guestfs-actions.pod:5299
14588 msgid "guestfs_part_set_bootable"
14592 #: ../src/guestfs-actions.pod:5301
14596 " guestfs_part_set_bootable (guestfs_h *g,\n"
14597 " const char *device,\n"
14599 " int bootable);\n"
14604 #: ../src/guestfs-actions.pod:5307 ../fish/guestfish-actions.pod:3524
14606 "This sets the bootable flag on partition numbered C<partnum> on device "
14607 "C<device>. Note that partitions are numbered from 1."
14611 #: ../src/guestfs-actions.pod:5310 ../fish/guestfish-actions.pod:3527
14613 "The bootable flag is used by some operating systems (notably Windows) to "
14614 "determine which partition to boot from. It is by no means universally "
14619 #: ../src/guestfs-actions.pod:5318
14620 msgid "guestfs_part_set_mbr_id"
14624 #: ../src/guestfs-actions.pod:5320
14628 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14629 " const char *device,\n"
14636 #: ../src/guestfs-actions.pod:5326 ../fish/guestfish-actions.pod:3535
14638 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14639 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14640 "documentation are in fact hexadecimal numbers, but usually documented "
14641 "without any leading \"0x\" which might be confusing."
14645 #: ../src/guestfs-actions.pod:5340
14646 msgid "guestfs_part_set_name"
14650 #: ../src/guestfs-actions.pod:5342
14654 " guestfs_part_set_name (guestfs_h *g,\n"
14655 " const char *device,\n"
14657 " const char *name);\n"
14662 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3549
14664 "This sets the partition name on partition numbered C<partnum> on device "
14665 "C<device>. Note that partitions are numbered from 1."
14669 #: ../src/guestfs-actions.pod:5351 ../fish/guestfish-actions.pod:3552
14671 "The partition name can only be set on certain types of partition table. "
14672 "This works on C<gpt> but not on C<mbr> partitions."
14676 #: ../src/guestfs-actions.pod:5358
14677 msgid "guestfs_part_to_dev"
14681 #: ../src/guestfs-actions.pod:5360
14685 " guestfs_part_to_dev (guestfs_h *g,\n"
14686 " const char *partition);\n"
14691 #: ../src/guestfs-actions.pod:5364 ../fish/guestfish-actions.pod:3559
14693 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14694 "partition number, returning the device name (eg. \"/dev/sdb\")."
14698 #: ../src/guestfs-actions.pod:5368
14700 "The named partition must exist, for example as a string returned from "
14701 "C<guestfs_list_partitions>."
14705 #: ../src/guestfs-actions.pod:5376
14706 msgid "guestfs_ping_daemon"
14710 #: ../src/guestfs-actions.pod:5378
14714 " guestfs_ping_daemon (guestfs_h *g);\n"
14719 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3570
14721 "This is a test probe into the guestfs daemon running inside the qemu "
14722 "subprocess. Calling this function checks that the daemon responds to the "
14723 "ping message, without affecting the daemon or attached block device(s) in "
14728 #: ../src/guestfs-actions.pod:5390
14729 msgid "guestfs_pread"
14733 #: ../src/guestfs-actions.pod:5392
14737 " guestfs_pread (guestfs_h *g,\n"
14738 " const char *path,\n"
14740 " int64_t offset,\n"
14741 " size_t *size_r);\n"
14746 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3579
14748 "This command lets you read part of a file. It reads C<count> bytes of the "
14749 "file, starting at C<offset>, from file C<path>."
14753 #: ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3582 ../fish/guestfish-actions.pod:3597
14755 "This may read fewer bytes than requested. For further details see the "
14756 "L<pread(2)> system call."
14760 #: ../src/guestfs-actions.pod:5405
14761 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14765 #: ../src/guestfs-actions.pod:5416
14766 msgid "guestfs_pread_device"
14770 #: ../src/guestfs-actions.pod:5418
14774 " guestfs_pread_device (guestfs_h *g,\n"
14775 " const char *device,\n"
14777 " int64_t offset,\n"
14778 " size_t *size_r);\n"
14783 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3594
14785 "This command lets you read part of a file. It reads C<count> bytes of "
14786 "C<device>, starting at C<offset>."
14790 #: ../src/guestfs-actions.pod:5431
14791 msgid "See also C<guestfs_pread>."
14795 #: ../src/guestfs-actions.pod:5440
14796 msgid "(Added in 1.5.21)"
14800 #: ../src/guestfs-actions.pod:5442
14801 msgid "guestfs_pvcreate"
14805 #: ../src/guestfs-actions.pod:5444
14809 " guestfs_pvcreate (guestfs_h *g,\n"
14810 " const char *device);\n"
14815 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3609
14817 "This creates an LVM physical volume on the named C<device>, where C<device> "
14818 "should usually be a partition name such as C</dev/sda1>."
14822 #: ../src/guestfs-actions.pod:5456
14823 msgid "guestfs_pvremove"
14827 #: ../src/guestfs-actions.pod:5458
14831 " guestfs_pvremove (guestfs_h *g,\n"
14832 " const char *device);\n"
14837 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3617
14839 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14844 #: ../src/guestfs-actions.pod:5465 ../fish/guestfish-actions.pod:3620
14846 "The implementation uses the C<pvremove> command which refuses to wipe "
14847 "physical volumes that contain any volume groups, so you have to remove those "
14852 #: ../src/guestfs-actions.pod:5473
14853 msgid "guestfs_pvresize"
14857 #: ../src/guestfs-actions.pod:5475
14861 " guestfs_pvresize (guestfs_h *g,\n"
14862 " const char *device);\n"
14867 #: ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:3628
14869 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14870 "the new size of the underlying device."
14874 #: ../src/guestfs-actions.pod:5486
14875 msgid "guestfs_pvresize_size"
14879 #: ../src/guestfs-actions.pod:5488
14883 " guestfs_pvresize_size (guestfs_h *g,\n"
14884 " const char *device,\n"
14885 " int64_t size);\n"
14890 #: ../src/guestfs-actions.pod:5493
14892 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14893 "specify the new size (in bytes) explicitly."
14897 #: ../src/guestfs-actions.pod:5500
14898 msgid "guestfs_pvs"
14902 #: ../src/guestfs-actions.pod:5502
14906 " guestfs_pvs (guestfs_h *g);\n"
14911 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3642
14913 "List all the physical volumes detected. This is the equivalent of the "
14914 "L<pvs(8)> command."
14918 #: ../src/guestfs-actions.pod:5508 ../fish/guestfish-actions.pod:3645
14920 "This returns a list of just the device names that contain PVs "
14921 "(eg. C</dev/sda2>)."
14925 #: ../src/guestfs-actions.pod:5511
14926 msgid "See also C<guestfs_pvs_full>."
14930 #: ../src/guestfs-actions.pod:5519
14931 msgid "guestfs_pvs_full"
14935 #: ../src/guestfs-actions.pod:5521
14938 " struct guestfs_lvm_pv_list *\n"
14939 " guestfs_pvs_full (guestfs_h *g);\n"
14944 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3654
14946 "List all the physical volumes detected. This is the equivalent of the "
14947 "L<pvs(8)> command. The \"full\" version includes all fields."
14951 #: ../src/guestfs-actions.pod:5527
14953 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14954 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14959 #: ../src/guestfs-actions.pod:5533
14960 msgid "guestfs_pvuuid"
14964 #: ../src/guestfs-actions.pod:5535
14968 " guestfs_pvuuid (guestfs_h *g,\n"
14969 " const char *device);\n"
14974 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3661
14975 msgid "This command returns the UUID of the LVM PV C<device>."
14979 #: ../src/guestfs-actions.pod:5546
14980 msgid "guestfs_pwrite"
14984 #: ../src/guestfs-actions.pod:5548
14988 " guestfs_pwrite (guestfs_h *g,\n"
14989 " const char *path,\n"
14990 " const char *content,\n"
14991 " size_t content_size,\n"
14992 " int64_t offset);\n"
14997 #: ../src/guestfs-actions.pod:5555 ../fish/guestfish-actions.pod:3667
14999 "This command writes to part of a file. It writes the data buffer C<content> "
15000 "to the file C<path> starting at offset C<offset>."
15004 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3670
15006 "This command implements the L<pwrite(2)> system call, and like that system "
15007 "call it may not write the full data requested. The return value is the "
15008 "number of bytes that were actually written to the file. This could even be "
15009 "0, although short writes are unlikely for regular files in ordinary "
15014 #: ../src/guestfs-actions.pod:5564
15015 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15019 #: ../src/guestfs-actions.pod:5573
15020 msgid "guestfs_pwrite_device"
15024 #: ../src/guestfs-actions.pod:5575
15028 " guestfs_pwrite_device (guestfs_h *g,\n"
15029 " const char *device,\n"
15030 " const char *content,\n"
15031 " size_t content_size,\n"
15032 " int64_t offset);\n"
15037 #: ../src/guestfs-actions.pod:5582 ../fish/guestfish-actions.pod:3685
15039 "This command writes to part of a device. It writes the data buffer "
15040 "C<content> to C<device> starting at offset C<offset>."
15044 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3688
15046 "This command implements the L<pwrite(2)> system call, and like that system "
15047 "call it may not write the full data requested (although short writes to disk "
15048 "devices and partitions are probably impossible with standard Linux kernels)."
15052 #: ../src/guestfs-actions.pod:5590
15053 msgid "See also C<guestfs_pwrite>."
15057 #: ../src/guestfs-actions.pod:5597
15058 msgid "(Added in 1.5.20)"
15062 #: ../src/guestfs-actions.pod:5599
15063 msgid "guestfs_read_file"
15067 #: ../src/guestfs-actions.pod:5601
15071 " guestfs_read_file (guestfs_h *g,\n"
15072 " const char *path,\n"
15073 " size_t *size_r);\n"
15078 #: ../src/guestfs-actions.pod:5606 ../fish/guestfish-actions.pod:3702
15079 msgid "This calls returns the contents of the file C<path> as a buffer."
15083 #: ../src/guestfs-actions.pod:5609
15085 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15086 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15087 "function is limited in the total size of file that can be handled."
15091 #: ../src/guestfs-actions.pod:5621
15092 msgid "(Added in 1.0.63)"
15096 #: ../src/guestfs-actions.pod:5623
15097 msgid "guestfs_read_lines"
15101 #: ../src/guestfs-actions.pod:5625
15105 " guestfs_read_lines (guestfs_h *g,\n"
15106 " const char *path);\n"
15111 #: ../src/guestfs-actions.pod:5631 ../fish/guestfish-actions.pod:3719
15113 "The file contents are returned as a list of lines. Trailing C<LF> and "
15114 "C<CRLF> character sequences are I<not> returned."
15118 #: ../src/guestfs-actions.pod:5634
15120 "Note that this function cannot correctly handle binary files (specifically, "
15121 "files containing C<\\0> character which is treated as end of line). For "
15122 "those you need to use the C<guestfs_read_file> function which has a more "
15123 "complex interface."
15127 #: ../src/guestfs-actions.pod:5645
15128 msgid "guestfs_readdir"
15132 #: ../src/guestfs-actions.pod:5647
15135 " struct guestfs_dirent_list *\n"
15136 " guestfs_readdir (guestfs_h *g,\n"
15137 " const char *dir);\n"
15142 #: ../src/guestfs-actions.pod:5651 ../fish/guestfish-actions.pod:3731
15143 msgid "This returns the list of directory entries in directory C<dir>."
15147 #: ../src/guestfs-actions.pod:5653 ../fish/guestfish-actions.pod:3733
15149 "All entries in the directory are returned, including C<.> and C<..>. The "
15150 "entries are I<not> sorted, but returned in the same order as the underlying "
15155 #: ../src/guestfs-actions.pod:5657 ../fish/guestfish-actions.pod:3737
15157 "Also this call returns basic file type information about each file. The "
15158 "C<ftyp> field will contain one of the following characters:"
15162 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3742
15167 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:3744
15168 msgid "Block special"
15172 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3746
15177 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3748
15178 msgid "Char special"
15182 #: ../src/guestfs-actions.pod:5670 ../fish/guestfish-actions.pod:3750
15187 #: ../src/guestfs-actions.pod:5672 ../fish/guestfish-actions.pod:3752
15192 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3754
15197 #: ../src/guestfs-actions.pod:5676 ../fish/guestfish-actions.pod:3756
15198 msgid "FIFO (named pipe)"
15202 #: ../src/guestfs-actions.pod:5678 ../fish/guestfish-actions.pod:3758
15207 #: ../src/guestfs-actions.pod:5680 ../fish/guestfish-actions.pod:3760
15208 msgid "Symbolic link"
15212 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3762
15217 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3764
15218 msgid "Regular file"
15222 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3766
15227 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3768
15232 #: ../src/guestfs-actions.pod:5690 ../fish/guestfish-actions.pod:3770
15237 #: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3772
15238 msgid "Unknown file type"
15242 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3774
15247 #: ../src/guestfs-actions.pod:5696 ../fish/guestfish-actions.pod:3776
15248 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15252 #: ../src/guestfs-actions.pod:5701
15254 "This function is primarily intended for use by programs. To get a simple "
15255 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15256 "consumption, use C<guestfs_ll>."
15260 #: ../src/guestfs-actions.pod:5705
15262 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15263 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
15268 #: ../src/guestfs-actions.pod:5711
15269 msgid "guestfs_readlink"
15273 #: ../src/guestfs-actions.pod:5713
15277 " guestfs_readlink (guestfs_h *g,\n"
15278 " const char *path);\n"
15283 #: ../src/guestfs-actions.pod:5717 ../fish/guestfish-actions.pod:3789
15284 msgid "This command reads the target of a symbolic link."
15288 #: ../src/guestfs-actions.pod:5724
15289 msgid "guestfs_readlinklist"
15293 #: ../src/guestfs-actions.pod:5726
15297 " guestfs_readlinklist (guestfs_h *g,\n"
15298 " const char *path,\n"
15299 " char *const *names);\n"
15304 #: ../src/guestfs-actions.pod:5731 ../fish/guestfish-actions.pod:3795
15306 "This call allows you to do a C<readlink> operation on multiple files, where "
15307 "all files are in the directory C<path>. C<names> is the list of files from "
15312 #: ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:3799
15314 "On return you get a list of strings, with a one-to-one correspondence to the "
15315 "C<names> list. Each string is the value of the symbolic link."
15319 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3803
15321 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15322 "result string is the empty string C<\"\">. However the whole operation is "
15323 "completed even if there were C<readlink(2)> errors, and so you can call this "
15324 "function with names where you don't know if they are symbolic links already "
15325 "(albeit slightly less efficient)."
15329 #: ../src/guestfs-actions.pod:5746 ../fish/guestfish-actions.pod:3810
15331 "This call is intended for programs that want to efficiently list a directory "
15332 "contents without making many round-trips. Very long directory listings "
15333 "might cause the protocol message size to be exceeded, causing this call to "
15334 "fail. The caller must split up such requests into smaller groups of names."
15338 #: ../src/guestfs-actions.pod:5759
15339 msgid "guestfs_realpath"
15343 #: ../src/guestfs-actions.pod:5761
15347 " guestfs_realpath (guestfs_h *g,\n"
15348 " const char *path);\n"
15353 #: ../src/guestfs-actions.pod:5765 ../fish/guestfish-actions.pod:3821
15355 "Return the canonicalized absolute pathname of C<path>. The returned path "
15356 "has no C<.>, C<..> or symbolic link path elements."
15360 #: ../src/guestfs-actions.pod:5773
15361 msgid "guestfs_removexattr"
15365 #: ../src/guestfs-actions.pod:5775
15369 " guestfs_removexattr (guestfs_h *g,\n"
15370 " const char *xattr,\n"
15371 " const char *path);\n"
15376 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3828
15377 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
15381 #: ../src/guestfs-actions.pod:5783
15382 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15386 #: ../src/guestfs-actions.pod:5789
15387 msgid "guestfs_resize2fs"
15391 #: ../src/guestfs-actions.pod:5791
15395 " guestfs_resize2fs (guestfs_h *g,\n"
15396 " const char *device);\n"
15401 #: ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3837
15403 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15404 "underlying device."
15408 #: ../src/guestfs-actions.pod:5798
15410 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15411 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15412 "sometimes gives an error about this and sometimes not. In any case, it is "
15413 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15417 #: ../src/guestfs-actions.pod:5808
15418 msgid "guestfs_resize2fs_M"
15422 #: ../src/guestfs-actions.pod:5810
15426 " guestfs_resize2fs_M (guestfs_h *g,\n"
15427 " const char *device);\n"
15432 #: ../src/guestfs-actions.pod:5814
15434 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15435 "resized to its minimum size. This works like the I<-M> option to the "
15436 "C<resize2fs> command."
15440 #: ../src/guestfs-actions.pod:5818
15442 "To get the resulting size of the filesystem you should call "
15443 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15444 "These two numbers, multiplied together, give the resulting size of the "
15445 "minimal filesystem in bytes."
15449 #: ../src/guestfs-actions.pod:5827
15450 msgid "guestfs_resize2fs_size"
15454 #: ../src/guestfs-actions.pod:5829
15458 " guestfs_resize2fs_size (guestfs_h *g,\n"
15459 " const char *device,\n"
15460 " int64_t size);\n"
15465 #: ../src/guestfs-actions.pod:5834
15467 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15468 "to specify the new size (in bytes) explicitly."
15472 #: ../src/guestfs-actions.pod:5841
15477 #: ../src/guestfs-actions.pod:5843
15481 " guestfs_rm (guestfs_h *g,\n"
15482 " const char *path);\n"
15487 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3870
15488 msgid "Remove the single file C<path>."
15492 #: ../src/guestfs-actions.pod:5853
15493 msgid "guestfs_rm_rf"
15497 #: ../src/guestfs-actions.pod:5855
15501 " guestfs_rm_rf (guestfs_h *g,\n"
15502 " const char *path);\n"
15507 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3876
15509 "Remove the file or directory C<path>, recursively removing the contents if "
15510 "its a directory. This is like the C<rm -rf> shell command."
15514 #: ../src/guestfs-actions.pod:5867
15515 msgid "guestfs_rmdir"
15519 #: ../src/guestfs-actions.pod:5869
15523 " guestfs_rmdir (guestfs_h *g,\n"
15524 " const char *path);\n"
15529 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3884
15530 msgid "Remove the single directory C<path>."
15534 #: ../src/guestfs-actions.pod:5879
15535 msgid "guestfs_rmmountpoint"
15539 #: ../src/guestfs-actions.pod:5881
15543 " guestfs_rmmountpoint (guestfs_h *g,\n"
15544 " const char *exemptpath);\n"
15549 #: ../src/guestfs-actions.pod:5885
15551 "This calls removes a mountpoint that was previously created with "
15552 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15556 #: ../src/guestfs-actions.pod:5893
15557 msgid "guestfs_scrub_device"
15561 #: ../src/guestfs-actions.pod:5895
15565 " guestfs_scrub_device (guestfs_h *g,\n"
15566 " const char *device);\n"
15571 #: ../src/guestfs-actions.pod:5899 ../fish/guestfish-actions.pod:3898
15573 "This command writes patterns over C<device> to make data retrieval more "
15578 #: ../src/guestfs-actions.pod:5902 ../src/guestfs-actions.pod:5923 ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:3901 ../fish/guestfish-actions.pod:3916 ../fish/guestfish-actions.pod:3929
15580 "It is an interface to the L<scrub(1)> program. See that manual page for "
15585 #: ../src/guestfs-actions.pod:5910 ../src/guestfs-actions.pod:5928 ../src/guestfs-actions.pod:5947
15586 msgid "(Added in 1.0.52)"
15590 #: ../src/guestfs-actions.pod:5912
15591 msgid "guestfs_scrub_file"
15595 #: ../src/guestfs-actions.pod:5914
15599 " guestfs_scrub_file (guestfs_h *g,\n"
15600 " const char *file);\n"
15605 #: ../src/guestfs-actions.pod:5918 ../fish/guestfish-actions.pod:3911
15607 "This command writes patterns over a file to make data retrieval more "
15612 #: ../src/guestfs-actions.pod:5921 ../fish/guestfish-actions.pod:3914
15613 msgid "The file is I<removed> after scrubbing."
15617 #: ../src/guestfs-actions.pod:5930
15618 msgid "guestfs_scrub_freespace"
15622 #: ../src/guestfs-actions.pod:5932
15626 " guestfs_scrub_freespace (guestfs_h *g,\n"
15627 " const char *dir);\n"
15632 #: ../src/guestfs-actions.pod:5936
15634 "This command creates the directory C<dir> and then fills it with files until "
15635 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15636 "and deletes them. The intention is to scrub any free space on the partition "
15637 "containing C<dir>."
15641 #: ../src/guestfs-actions.pod:5949
15642 msgid "guestfs_set_append"
15646 #: ../src/guestfs-actions.pod:5951
15650 " guestfs_set_append (guestfs_h *g,\n"
15651 " const char *append);\n"
15656 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:3938
15658 "This function is used to add additional options to the guest kernel command "
15663 #: ../src/guestfs-actions.pod:5958 ../fish/guestfish-actions.pod:3941
15665 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15666 "environment variable."
15670 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:3944
15672 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15673 "(libguestfs always adds a few of its own)."
15677 #: ../src/guestfs-actions.pod:5968
15678 msgid "guestfs_set_attach_method"
15682 #: ../src/guestfs-actions.pod:5970
15686 " guestfs_set_attach_method (guestfs_h *g,\n"
15687 " const char *attachmethod);\n"
15692 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:3953
15694 "Set the method that libguestfs uses to connect to the back end guestfsd "
15695 "daemon. Possible methods are:"
15699 #: ../src/guestfs-actions.pod:5981 ../fish/guestfish-actions.pod:3960
15701 "Launch an appliance and connect to it. This is the ordinary method and the "
15706 #: ../src/guestfs-actions.pod:5984 ../fish/guestfish-actions.pod:3963
15707 msgid "C<unix:I<path>>"
15711 #: ../src/guestfs-actions.pod:5986 ../fish/guestfish-actions.pod:3965
15712 msgid "Connect to the Unix domain socket I<path>."
15716 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:3967
15718 "This method lets you connect to an existing daemon or (using virtio-serial) "
15719 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15720 "RUNNING DAEMONS>."
15724 #: ../src/guestfs-actions.pod:5998
15725 msgid "guestfs_set_autosync"
15729 #: ../src/guestfs-actions.pod:6000
15733 " guestfs_set_autosync (guestfs_h *g,\n"
15734 " int autosync);\n"
15739 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:3979
15741 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15742 "effort attempt to make filesystems consistent and synchronized when the "
15743 "handle is closed (also if the program exits without closing handles)."
15747 #: ../src/guestfs-actions.pod:6009 ../fish/guestfish-actions.pod:3984
15749 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15750 "disabled by default)."
15754 #: ../src/guestfs-actions.pod:6016
15755 msgid "guestfs_set_direct"
15759 #: ../src/guestfs-actions.pod:6018
15763 " guestfs_set_direct (guestfs_h *g,\n"
15769 #: ../src/guestfs-actions.pod:6022 ../fish/guestfish-actions.pod:3993
15771 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15772 "passed directly through to the appliance once it is launched."
15776 #: ../src/guestfs-actions.pod:6026
15778 "One consequence of this is that log messages aren't caught by the library "
15779 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15784 #: ../src/guestfs-actions.pod:6030 ../fish/guestfish-actions.pod:4001
15785 msgid "You probably don't want to use this unless you know what you are doing."
15789 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4004
15790 msgid "The default is disabled."
15794 #: ../src/guestfs-actions.pod:6039
15795 msgid "guestfs_set_e2label"
15799 #: ../src/guestfs-actions.pod:6041
15803 " guestfs_set_e2label (guestfs_h *g,\n"
15804 " const char *device,\n"
15805 " const char *label);\n"
15810 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4010
15812 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15813 "C<label>. Filesystem labels are limited to 16 characters."
15817 #: ../src/guestfs-actions.pod:6050
15819 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15820 "the existing label on a filesystem."
15824 #: ../src/guestfs-actions.pod:6057
15825 msgid "guestfs_set_e2uuid"
15829 #: ../src/guestfs-actions.pod:6059
15833 " guestfs_set_e2uuid (guestfs_h *g,\n"
15834 " const char *device,\n"
15835 " const char *uuid);\n"
15840 #: ../src/guestfs-actions.pod:6064 ../fish/guestfish-actions.pod:4021
15842 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15843 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15844 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15848 #: ../src/guestfs-actions.pod:6069
15850 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15851 "the existing UUID of a filesystem."
15855 #: ../src/guestfs-actions.pod:6076
15856 msgid "guestfs_set_memsize"
15860 #: ../src/guestfs-actions.pod:6078
15864 " guestfs_set_memsize (guestfs_h *g,\n"
15870 #: ../src/guestfs-actions.pod:6082
15872 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15873 "This only has any effect if called before C<guestfs_launch>."
15877 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4039
15879 "You can also change this by setting the environment variable "
15880 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15884 #: ../src/guestfs-actions.pod:6097
15885 msgid "guestfs_set_network"
15889 #: ../src/guestfs-actions.pod:6099
15893 " guestfs_set_network (guestfs_h *g,\n"
15899 #: ../src/guestfs-actions.pod:6103 ../fish/guestfish-actions.pod:4052
15901 "If C<network> is true, then the network is enabled in the libguestfs "
15902 "appliance. The default is false."
15906 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4055
15908 "This affects whether commands are able to access the network (see "
15909 "L<guestfs(3)/RUNNING COMMANDS>)."
15913 #: ../src/guestfs-actions.pod:6109
15915 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15920 #: ../src/guestfs-actions.pod:6116
15921 msgid "guestfs_set_path"
15925 #: ../src/guestfs-actions.pod:6118
15929 " guestfs_set_path (guestfs_h *g,\n"
15930 " const char *searchpath);\n"
15935 #: ../src/guestfs-actions.pod:6122 ../fish/guestfish-actions.pod:4067
15936 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15940 #: ../src/guestfs-actions.pod:6124 ../fish/guestfish-actions.pod:4069
15942 "The default is C<$libdir/guestfs> unless overridden by setting "
15943 "C<LIBGUESTFS_PATH> environment variable."
15947 #: ../src/guestfs-actions.pod:6127 ../fish/guestfish-actions.pod:4072
15948 msgid "Setting C<path> to C<NULL> restores the default path."
15952 #: ../src/guestfs-actions.pod:6133
15953 msgid "guestfs_set_qemu"
15957 #: ../src/guestfs-actions.pod:6135
15961 " guestfs_set_qemu (guestfs_h *g,\n"
15962 " const char *qemu);\n"
15967 #: ../src/guestfs-actions.pod:6139 ../fish/guestfish-actions.pod:4080
15968 msgid "Set the qemu binary that we will use."
15972 #: ../src/guestfs-actions.pod:6141 ../fish/guestfish-actions.pod:4082
15973 msgid "The default is chosen when the library was compiled by the configure script."
15977 #: ../src/guestfs-actions.pod:6144 ../fish/guestfish-actions.pod:4085
15979 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15984 #: ../src/guestfs-actions.pod:6147 ../fish/guestfish-actions.pod:4088
15985 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15989 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4090
15991 "Note that you should call this function as early as possible after creating "
15992 "the handle. This is because some pre-launch operations depend on testing "
15993 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15994 "don't retest features, and so you might see inconsistent results. Using the "
15995 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15996 "the qemu binary at the same time as the handle is created."
16000 #: ../src/guestfs-actions.pod:6161
16001 msgid "guestfs_set_recovery_proc"
16005 #: ../src/guestfs-actions.pod:6163
16009 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16010 " int recoveryproc);\n"
16015 #: ../src/guestfs-actions.pod:6167
16017 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16018 "not create a recovery process. The purpose of the recovery process is to "
16019 "stop runaway qemu processes in the case where the main program aborts "
16024 #: ../src/guestfs-actions.pod:6172
16026 "This only has any effect if called before C<guestfs_launch>, and the default "
16031 #: ../src/guestfs-actions.pod:6175 ../fish/guestfish-actions.pod:4112
16033 "About the only time when you would want to disable this is if the main "
16034 "process will fork itself into the background (\"daemonize\" itself). In "
16035 "this case the recovery process thinks that the main program has disappeared "
16036 "and so kills qemu, which is not very helpful."
16040 #: ../src/guestfs-actions.pod:6185
16041 msgid "guestfs_set_selinux"
16045 #: ../src/guestfs-actions.pod:6187
16049 " guestfs_set_selinux (guestfs_h *g,\n"
16055 #: ../src/guestfs-actions.pod:6191 ../fish/guestfish-actions.pod:4124
16057 "This sets the selinux flag that is passed to the appliance at boot time. "
16058 "The default is C<selinux=0> (disabled)."
16062 #: ../src/guestfs-actions.pod:6194 ../fish/guestfish-actions.pod:4127
16064 "Note that if SELinux is enabled, it is always in Permissive mode "
16065 "(C<enforcing=0>)."
16069 #: ../src/guestfs-actions.pod:6204
16070 msgid "guestfs_set_trace"
16074 #: ../src/guestfs-actions.pod:6206
16078 " guestfs_set_trace (guestfs_h *g,\n"
16084 #: ../src/guestfs-actions.pod:6210 ../fish/guestfish-actions.pod:4139
16086 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16087 "return values are traced."
16091 #: ../src/guestfs-actions.pod:6213 ../fish/guestfish-actions.pod:4142
16093 "If you want to trace C API calls into libguestfs (and other libraries) then "
16094 "possibly a better way is to use the external ltrace(1) command."
16098 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4146
16100 "Command traces are disabled unless the environment variable "
16101 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16105 #: ../src/guestfs-actions.pod:6220
16107 "Trace messages are normally sent to C<stderr>, unless you register a "
16108 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16112 #: ../src/guestfs-actions.pod:6228
16113 msgid "guestfs_set_verbose"
16117 #: ../src/guestfs-actions.pod:6230
16121 " guestfs_set_verbose (guestfs_h *g,\n"
16127 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4159
16128 msgid "If C<verbose> is true, this turns on verbose messages."
16132 #: ../src/guestfs-actions.pod:6236 ../fish/guestfish-actions.pod:4161
16134 "Verbose messages are disabled unless the environment variable "
16135 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16139 #: ../src/guestfs-actions.pod:6239
16141 "Verbose messages are normally sent to C<stderr>, unless you register a "
16142 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16146 #: ../src/guestfs-actions.pod:6247
16147 msgid "guestfs_setcon"
16151 #: ../src/guestfs-actions.pod:6249
16155 " guestfs_setcon (guestfs_h *g,\n"
16156 " const char *context);\n"
16161 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4172
16163 "This sets the SELinux security context of the daemon to the string "
16168 #: ../src/guestfs-actions.pod:6256 ../fish/guestfish-actions.pod:4175
16169 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16173 #: ../src/guestfs-actions.pod:6262
16174 msgid "guestfs_setxattr"
16178 #: ../src/guestfs-actions.pod:6264
16182 " guestfs_setxattr (guestfs_h *g,\n"
16183 " const char *xattr,\n"
16184 " const char *val,\n"
16186 " const char *path);\n"
16191 #: ../src/guestfs-actions.pod:6271 ../fish/guestfish-actions.pod:4181
16193 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16194 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16198 #: ../src/guestfs-actions.pod:6275
16199 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16203 #: ../src/guestfs-actions.pod:6281
16204 msgid "guestfs_sfdisk"
16208 #: ../src/guestfs-actions.pod:6283
16212 " guestfs_sfdisk (guestfs_h *g,\n"
16213 " const char *device,\n"
16217 " char *const *lines);\n"
16222 #: ../src/guestfs-actions.pod:6291 ../fish/guestfish-actions.pod:4191
16224 "This is a direct interface to the L<sfdisk(8)> program for creating "
16225 "partitions on block devices."
16229 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4194
16230 msgid "C<device> should be a block device, for example C</dev/sda>."
16234 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4196
16236 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16237 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
16238 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16239 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16240 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16241 "the kernel) cannot work out the right geometry and you will need to tell it."
16245 #: ../src/guestfs-actions.pod:6304 ../fish/guestfish-actions.pod:4204
16247 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16248 "refer to the L<sfdisk(8)> manpage."
16252 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4207
16254 "To create a single partition occupying the whole disk, you would pass "
16255 "C<lines> as a single element list, when the single element being the string "
16260 #: ../src/guestfs-actions.pod:6311
16261 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16265 #: ../src/guestfs-actions.pod:6319 ../src/guestfs-actions.pod:6349 ../src/guestfs-actions.pod:6382 ../fish/guestfish-actions.pod:4217 ../fish/guestfish-actions.pod:4240 ../fish/guestfish-actions.pod:4262
16266 msgid "This function is deprecated. In new code, use the C<part_add> call instead."
16270 #: ../src/guestfs-actions.pod:6328
16271 msgid "guestfs_sfdiskM"
16275 #: ../src/guestfs-actions.pod:6330
16279 " guestfs_sfdiskM (guestfs_h *g,\n"
16280 " const char *device,\n"
16281 " char *const *lines);\n"
16286 #: ../src/guestfs-actions.pod:6335
16288 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16289 "partition sizes are specified in megabytes only (rounded to the nearest "
16290 "cylinder) and you don't need to specify the cyls, heads and sectors "
16291 "parameters which were rarely if ever used anyway."
16295 #: ../src/guestfs-actions.pod:6341
16297 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16298 "C<guestfs_part_disk>"
16302 #: ../src/guestfs-actions.pod:6358
16303 msgid "guestfs_sfdisk_N"
16307 #: ../src/guestfs-actions.pod:6360
16311 " guestfs_sfdisk_N (guestfs_h *g,\n"
16312 " const char *device,\n"
16317 " const char *line);\n"
16322 #: ../src/guestfs-actions.pod:6369 ../fish/guestfish-actions.pod:4251
16324 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16325 "(note: C<n> counts from 1)."
16329 #: ../src/guestfs-actions.pod:6372
16331 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16332 "for the cyls/heads/sectors parameters."
16336 #: ../src/guestfs-actions.pod:6375
16337 msgid "See also: C<guestfs_part_add>"
16341 #: ../src/guestfs-actions.pod:6391
16342 msgid "guestfs_sfdisk_disk_geometry"
16346 #: ../src/guestfs-actions.pod:6393
16350 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16351 " const char *device);\n"
16356 #: ../src/guestfs-actions.pod:6397
16358 "This displays the disk geometry of C<device> read from the partition table. "
16359 "Especially in the case where the underlying block device has been resized, "
16360 "this can be different from the kernel's idea of the geometry (see "
16361 "C<guestfs_sfdisk_kernel_geometry>)."
16365 #: ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:6418 ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4287
16366 msgid "The result is in human-readable format, and not designed to be parsed."
16370 #: ../src/guestfs-actions.pod:6410
16371 msgid "guestfs_sfdisk_kernel_geometry"
16375 #: ../src/guestfs-actions.pod:6412
16379 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16380 " const char *device);\n"
16385 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4285
16386 msgid "This displays the kernel's idea of the geometry of C<device>."
16390 #: ../src/guestfs-actions.pod:6426
16391 msgid "guestfs_sfdisk_l"
16395 #: ../src/guestfs-actions.pod:6428
16399 " guestfs_sfdisk_l (guestfs_h *g,\n"
16400 " const char *device);\n"
16405 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4294
16407 "This displays the partition table on C<device>, in the human-readable output "
16408 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16412 #: ../src/guestfs-actions.pod:6436
16413 msgid "See also: C<guestfs_part_list>"
16417 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4300
16419 "This function is deprecated. In new code, use the C<part_list> call "
16424 #: ../src/guestfs-actions.pod:6450
16429 #: ../src/guestfs-actions.pod:6452
16433 " guestfs_sh (guestfs_h *g,\n"
16434 " const char *command);\n"
16439 #: ../src/guestfs-actions.pod:6456 ../fish/guestfish-actions.pod:4311
16441 "This call runs a command from the guest filesystem via the guest's "
16446 #: ../src/guestfs-actions.pod:6459
16447 msgid "This is like C<guestfs_command>, but passes the command to:"
16451 #: ../src/guestfs-actions.pod:6461 ../fish/guestfish-actions.pod:4316
16454 " /bin/sh -c \"command\"\n"
16459 #: ../src/guestfs-actions.pod:6463 ../fish/guestfish-actions.pod:4318
16461 "Depending on the guest's shell, this usually results in wildcards being "
16462 "expanded, shell expressions being interpolated and so on."
16466 #: ../src/guestfs-actions.pod:6467
16467 msgid "All the provisos about C<guestfs_command> apply to this call."
16471 #: ../src/guestfs-actions.pod:6474
16472 msgid "guestfs_sh_lines"
16476 #: ../src/guestfs-actions.pod:6476
16480 " guestfs_sh_lines (guestfs_h *g,\n"
16481 " const char *command);\n"
16486 #: ../src/guestfs-actions.pod:6480
16488 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16493 #: ../src/guestfs-actions.pod:6483
16494 msgid "See also: C<guestfs_command_lines>"
16498 #: ../src/guestfs-actions.pod:6491
16499 msgid "guestfs_sleep"
16503 #: ../src/guestfs-actions.pod:6493
16507 " guestfs_sleep (guestfs_h *g,\n"
16513 #: ../src/guestfs-actions.pod:6497 ../fish/guestfish-actions.pod:4337
16514 msgid "Sleep for C<secs> seconds."
16518 #: ../src/guestfs-actions.pod:6501
16519 msgid "(Added in 1.0.41)"
16523 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-structs.pod:109
16524 msgid "guestfs_stat"
16528 #: ../src/guestfs-actions.pod:6505
16531 " struct guestfs_stat *\n"
16532 " guestfs_stat (guestfs_h *g,\n"
16533 " const char *path);\n"
16538 #: ../src/guestfs-actions.pod:6511 ../fish/guestfish-actions.pod:4345
16539 msgid "This is the same as the C<stat(2)> system call."
16543 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-structs.pod:135
16544 msgid "guestfs_statvfs"
16548 #: ../src/guestfs-actions.pod:6521
16551 " struct guestfs_statvfs *\n"
16552 " guestfs_statvfs (guestfs_h *g,\n"
16553 " const char *path);\n"
16558 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4351
16560 "Returns file system statistics for any mounted file system. C<path> should "
16561 "be a file or directory in the mounted file system (typically it is the mount "
16562 "point itself, but it doesn't need to be)."
16566 #: ../src/guestfs-actions.pod:6529 ../fish/guestfish-actions.pod:4355
16567 msgid "This is the same as the C<statvfs(2)> system call."
16571 #: ../src/guestfs-actions.pod:6531
16573 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16574 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16578 #: ../src/guestfs-actions.pod:6537
16579 msgid "guestfs_strings"
16583 #: ../src/guestfs-actions.pod:6539
16587 " guestfs_strings (guestfs_h *g,\n"
16588 " const char *path);\n"
16593 #: ../src/guestfs-actions.pod:6543 ../fish/guestfish-actions.pod:4361
16595 "This runs the L<strings(1)> command on a file and returns the list of "
16596 "printable strings found."
16600 #: ../src/guestfs-actions.pod:6555
16601 msgid "guestfs_strings_e"
16605 #: ../src/guestfs-actions.pod:6557
16609 " guestfs_strings_e (guestfs_h *g,\n"
16610 " const char *encoding,\n"
16611 " const char *path);\n"
16616 #: ../src/guestfs-actions.pod:6562
16618 "This is like the C<guestfs_strings> command, but allows you to specify the "
16619 "encoding of strings that are looked for in the source file C<path>."
16623 #: ../src/guestfs-actions.pod:6566 ../fish/guestfish-actions.pod:4375
16624 msgid "Allowed encodings are:"
16628 #: ../src/guestfs-actions.pod:6570 ../fish/guestfish-actions.pod:4379
16633 #: ../src/guestfs-actions.pod:6572
16635 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16636 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16640 #: ../src/guestfs-actions.pod:6575 ../fish/guestfish-actions.pod:4384
16645 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4386
16646 msgid "Single 8-bit-byte characters."
16650 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4388
16655 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4390
16656 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16660 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4393
16661 msgid "l (lower case letter L)"
16665 #: ../src/guestfs-actions.pod:6586 ../fish/guestfish-actions.pod:4395
16667 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16668 "examining binaries in Windows guests."
16672 #: ../src/guestfs-actions.pod:6589 ../fish/guestfish-actions.pod:4398
16677 #: ../src/guestfs-actions.pod:6591 ../fish/guestfish-actions.pod:4400
16678 msgid "32-bit big endian such as UCS-4BE."
16682 #: ../src/guestfs-actions.pod:6593 ../fish/guestfish-actions.pod:4402
16687 #: ../src/guestfs-actions.pod:6595 ../fish/guestfish-actions.pod:4404
16688 msgid "32-bit little endian such as UCS-4LE."
16692 #: ../src/guestfs-actions.pod:6599 ../fish/guestfish-actions.pod:4408
16693 msgid "The returned strings are transcoded to UTF-8."
16697 #: ../src/guestfs-actions.pod:6610
16698 msgid "guestfs_swapoff_device"
16702 #: ../src/guestfs-actions.pod:6612
16706 " guestfs_swapoff_device (guestfs_h *g,\n"
16707 " const char *device);\n"
16712 #: ../src/guestfs-actions.pod:6616
16714 "This command disables the libguestfs appliance swap device or partition "
16715 "named C<device>. See C<guestfs_swapon_device>."
16719 #: ../src/guestfs-actions.pod:6624
16720 msgid "guestfs_swapoff_file"
16724 #: ../src/guestfs-actions.pod:6626
16728 " guestfs_swapoff_file (guestfs_h *g,\n"
16729 " const char *file);\n"
16734 #: ../src/guestfs-actions.pod:6630 ../fish/guestfish-actions.pod:4425
16735 msgid "This command disables the libguestfs appliance swap on file."
16739 #: ../src/guestfs-actions.pod:6636
16740 msgid "guestfs_swapoff_label"
16744 #: ../src/guestfs-actions.pod:6638
16748 " guestfs_swapoff_label (guestfs_h *g,\n"
16749 " const char *label);\n"
16754 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4431
16756 "This command disables the libguestfs appliance swap on labeled swap "
16761 #: ../src/guestfs-actions.pod:6649
16762 msgid "guestfs_swapoff_uuid"
16766 #: ../src/guestfs-actions.pod:6651
16770 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16771 " const char *uuid);\n"
16776 #: ../src/guestfs-actions.pod:6655 ../fish/guestfish-actions.pod:4438
16778 "This command disables the libguestfs appliance swap partition with the given "
16783 #: ../src/guestfs-actions.pod:6662
16784 msgid "guestfs_swapon_device"
16788 #: ../src/guestfs-actions.pod:6664
16792 " guestfs_swapon_device (guestfs_h *g,\n"
16793 " const char *device);\n"
16798 #: ../src/guestfs-actions.pod:6668
16800 "This command enables the libguestfs appliance to use the swap device or "
16801 "partition named C<device>. The increased memory is made available for all "
16802 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16806 #: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4450
16808 "Note that you should not swap to existing guest swap partitions unless you "
16809 "know what you are doing. They may contain hibernation information, or other "
16810 "information that the guest doesn't want you to trash. You also risk leaking "
16811 "information about the host to the guest this way. Instead, attach a new "
16812 "host device to the guest and swap on that."
16816 #: ../src/guestfs-actions.pod:6684
16817 msgid "guestfs_swapon_file"
16821 #: ../src/guestfs-actions.pod:6686
16825 " guestfs_swapon_file (guestfs_h *g,\n"
16826 " const char *file);\n"
16831 #: ../src/guestfs-actions.pod:6690
16833 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16838 #: ../src/guestfs-actions.pod:6697
16839 msgid "guestfs_swapon_label"
16843 #: ../src/guestfs-actions.pod:6699
16847 " guestfs_swapon_label (guestfs_h *g,\n"
16848 " const char *label);\n"
16853 #: ../src/guestfs-actions.pod:6703
16855 "This command enables swap to a labeled swap partition. See "
16856 "C<guestfs_swapon_device> for other notes."
16860 #: ../src/guestfs-actions.pod:6710
16861 msgid "guestfs_swapon_uuid"
16865 #: ../src/guestfs-actions.pod:6712
16869 " guestfs_swapon_uuid (guestfs_h *g,\n"
16870 " const char *uuid);\n"
16875 #: ../src/guestfs-actions.pod:6716
16877 "This command enables swap to a swap partition with the given UUID. See "
16878 "C<guestfs_swapon_device> for other notes."
16882 #: ../src/guestfs-actions.pod:6723
16883 msgid "guestfs_sync"
16887 #: ../src/guestfs-actions.pod:6725
16891 " guestfs_sync (guestfs_h *g);\n"
16896 #: ../src/guestfs-actions.pod:6728 ../fish/guestfish-actions.pod:4482
16898 "This syncs the disk, so that any writes are flushed through to the "
16899 "underlying disk image."
16903 #: ../src/guestfs-actions.pod:6731 ../fish/guestfish-actions.pod:4485
16905 "You should always call this if you have modified a disk image, before "
16906 "closing the handle."
16910 #: ../src/guestfs-actions.pod:6738
16911 msgid "guestfs_tail"
16915 #: ../src/guestfs-actions.pod:6740
16919 " guestfs_tail (guestfs_h *g,\n"
16920 " const char *path);\n"
16925 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4492
16926 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16930 #: ../src/guestfs-actions.pod:6756
16931 msgid "guestfs_tail_n"
16935 #: ../src/guestfs-actions.pod:6758
16939 " guestfs_tail_n (guestfs_h *g,\n"
16941 " const char *path);\n"
16946 #: ../src/guestfs-actions.pod:6763 ../fish/guestfish-actions.pod:4502
16948 "If the parameter C<nrlines> is a positive number, this returns the last "
16949 "C<nrlines> lines of the file C<path>."
16953 #: ../src/guestfs-actions.pod:6766 ../fish/guestfish-actions.pod:4505
16955 "If the parameter C<nrlines> is a negative number, this returns lines from "
16956 "the file C<path>, starting with the C<-nrlines>th line."
16960 #: ../src/guestfs-actions.pod:6780
16961 msgid "guestfs_tar_in"
16965 #: ../src/guestfs-actions.pod:6782
16969 " guestfs_tar_in (guestfs_h *g,\n"
16970 " const char *tarfile,\n"
16971 " const char *directory);\n"
16976 #: ../src/guestfs-actions.pod:6787 ../fish/guestfish-actions.pod:4517
16978 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16979 "tar file) into C<directory>."
16983 #: ../src/guestfs-actions.pod:6790
16984 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16988 #: ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6828 ../src/guestfs-actions.pod:6844
16989 msgid "(Added in 1.0.3)"
16993 #: ../src/guestfs-actions.pod:6797
16994 msgid "guestfs_tar_out"
16998 #: ../src/guestfs-actions.pod:6799
17002 " guestfs_tar_out (guestfs_h *g,\n"
17003 " const char *directory,\n"
17004 " const char *tarfile);\n"
17009 #: ../src/guestfs-actions.pod:6804 ../fish/guestfish-actions.pod:4529
17011 "This command packs the contents of C<directory> and downloads it to local "
17016 #: ../src/guestfs-actions.pod:6807
17018 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17019 "C<guestfs_txz_out>."
17023 #: ../src/guestfs-actions.pod:6814
17024 msgid "guestfs_tgz_in"
17028 #: ../src/guestfs-actions.pod:6816
17032 " guestfs_tgz_in (guestfs_h *g,\n"
17033 " const char *tarball,\n"
17034 " const char *directory);\n"
17039 #: ../src/guestfs-actions.pod:6821 ../fish/guestfish-actions.pod:4541
17041 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17042 "tar file) into C<directory>."
17046 #: ../src/guestfs-actions.pod:6824
17047 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17051 #: ../src/guestfs-actions.pod:6830
17052 msgid "guestfs_tgz_out"
17056 #: ../src/guestfs-actions.pod:6832
17060 " guestfs_tgz_out (guestfs_h *g,\n"
17061 " const char *directory,\n"
17062 " const char *tarball);\n"
17067 #: ../src/guestfs-actions.pod:6837 ../fish/guestfish-actions.pod:4552
17069 "This command packs the contents of C<directory> and downloads it to local "
17074 #: ../src/guestfs-actions.pod:6840
17075 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17079 #: ../src/guestfs-actions.pod:6846
17080 msgid "guestfs_touch"
17084 #: ../src/guestfs-actions.pod:6848
17088 " guestfs_touch (guestfs_h *g,\n"
17089 " const char *path);\n"
17094 #: ../src/guestfs-actions.pod:6852 ../fish/guestfish-actions.pod:4563
17096 "Touch acts like the L<touch(1)> command. It can be used to update the "
17097 "timestamps on a file, or, if the file does not exist, to create a new "
17098 "zero-length file."
17102 #: ../src/guestfs-actions.pod:6856 ../fish/guestfish-actions.pod:4567
17104 "This command only works on regular files, and will fail on other file types "
17105 "such as directories, symbolic links, block special etc."
17109 #: ../src/guestfs-actions.pod:6863
17110 msgid "guestfs_truncate"
17114 #: ../src/guestfs-actions.pod:6865
17118 " guestfs_truncate (guestfs_h *g,\n"
17119 " const char *path);\n"
17124 #: ../src/guestfs-actions.pod:6869 ../fish/guestfish-actions.pod:4574
17126 "This command truncates C<path> to a zero-length file. The file must exist "
17131 #: ../src/guestfs-actions.pod:6876
17132 msgid "guestfs_truncate_size"
17136 #: ../src/guestfs-actions.pod:6878
17140 " guestfs_truncate_size (guestfs_h *g,\n"
17141 " const char *path,\n"
17142 " int64_t size);\n"
17147 #: ../src/guestfs-actions.pod:6883 ../fish/guestfish-actions.pod:4581
17149 "This command truncates C<path> to size C<size> bytes. The file must exist "
17154 #: ../src/guestfs-actions.pod:6886
17156 "If the current file size is less than C<size> then the file is extended to "
17157 "the required size with zero bytes. This creates a sparse file (ie. disk "
17158 "blocks are not allocated for the file until you write to it). To create a "
17159 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17163 #: ../src/guestfs-actions.pod:6896
17164 msgid "guestfs_tune2fs_l"
17168 #: ../src/guestfs-actions.pod:6898
17172 " guestfs_tune2fs_l (guestfs_h *g,\n"
17173 " const char *device);\n"
17178 #: ../src/guestfs-actions.pod:6902 ../fish/guestfish-actions.pod:4594
17180 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17185 #: ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:4597
17187 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17188 "for more details. The list of fields returned isn't clearly defined, and "
17189 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17190 "and the filesystem itself."
17194 #: ../src/guestfs-actions.pod:6918
17195 msgid "guestfs_txz_in"
17199 #: ../src/guestfs-actions.pod:6920
17203 " guestfs_txz_in (guestfs_h *g,\n"
17204 " const char *tarball,\n"
17205 " const char *directory);\n"
17210 #: ../src/guestfs-actions.pod:6925 ../fish/guestfish-actions.pod:4606
17212 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17213 "tar file) into C<directory>."
17217 #: ../src/guestfs-actions.pod:6932
17218 msgid "guestfs_txz_out"
17222 #: ../src/guestfs-actions.pod:6934
17226 " guestfs_txz_out (guestfs_h *g,\n"
17227 " const char *directory,\n"
17228 " const char *tarball);\n"
17233 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4615
17235 "This command packs the contents of C<directory> and downloads it to local "
17236 "file C<tarball> (as an xz compressed tar archive)."
17240 #: ../src/guestfs-actions.pod:6946
17241 msgid "guestfs_umask"
17245 #: ../src/guestfs-actions.pod:6948
17249 " guestfs_umask (guestfs_h *g,\n"
17255 #: ../src/guestfs-actions.pod:6952 ../fish/guestfish-actions.pod:4624
17257 "This function sets the mask used for creating new files and device nodes to "
17262 #: ../src/guestfs-actions.pod:6955 ../fish/guestfish-actions.pod:4627
17264 "Typical umask values would be C<022> which creates new files with "
17265 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17266 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17270 #: ../src/guestfs-actions.pod:6960 ../fish/guestfish-actions.pod:4632
17272 "The default umask is C<022>. This is important because it means that "
17273 "directories and device nodes will be created with C<0644> or C<0755> mode "
17274 "even if you specify C<0777>."
17278 #: ../src/guestfs-actions.pod:6964
17280 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17281 "C<guestfs_mkdir>."
17285 #: ../src/guestfs-actions.pod:6967 ../fish/guestfish-actions.pod:4639
17286 msgid "This call returns the previous umask."
17290 #: ../src/guestfs-actions.pod:6973
17291 msgid "guestfs_umount"
17295 #: ../src/guestfs-actions.pod:6975
17299 " guestfs_umount (guestfs_h *g,\n"
17300 " const char *pathordevice);\n"
17305 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4647
17307 "This unmounts the given filesystem. The filesystem may be specified either "
17308 "by its mountpoint (path) or the device which contains the filesystem."
17312 #: ../src/guestfs-actions.pod:6987
17313 msgid "guestfs_umount_all"
17317 #: ../src/guestfs-actions.pod:6989
17321 " guestfs_umount_all (guestfs_h *g);\n"
17326 #: ../src/guestfs-actions.pod:6992 ../fish/guestfish-actions.pod:4657
17327 msgid "This unmounts all mounted filesystems."
17331 #: ../src/guestfs-actions.pod:6994 ../fish/guestfish-actions.pod:4659
17332 msgid "Some internal mounts are not unmounted by this call."
17336 #: ../src/guestfs-actions.pod:7000
17337 msgid "guestfs_upload"
17341 #: ../src/guestfs-actions.pod:7002
17345 " guestfs_upload (guestfs_h *g,\n"
17346 " const char *filename,\n"
17347 " const char *remotefilename);\n"
17352 #: ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7031 ../fish/guestfish-actions.pod:4665 ../fish/guestfish-actions.pod:4678
17353 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17357 #: ../src/guestfs-actions.pod:7012
17358 msgid "See also C<guestfs_download>."
17362 #: ../src/guestfs-actions.pod:7023
17363 msgid "guestfs_upload_offset"
17367 #: ../src/guestfs-actions.pod:7025
17371 " guestfs_upload_offset (guestfs_h *g,\n"
17372 " const char *filename,\n"
17373 " const char *remotefilename,\n"
17374 " int64_t offset);\n"
17379 #: ../src/guestfs-actions.pod:7034 ../fish/guestfish-actions.pod:4681
17381 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17382 "The intention is to overwrite parts of existing files or devices, although "
17383 "if a non-existant file is specified then it is created with a \"hole\" "
17384 "before C<offset>. The size of the data written is implicit in the size of "
17385 "the source C<filename>."
17389 #: ../src/guestfs-actions.pod:7041
17391 "Note that there is no limit on the amount of data that can be uploaded with "
17392 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17393 "full amount unless an error occurs."
17397 #: ../src/guestfs-actions.pod:7046
17398 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17402 #: ../src/guestfs-actions.pod:7057
17403 msgid "guestfs_utimens"
17407 #: ../src/guestfs-actions.pod:7059
17411 " guestfs_utimens (guestfs_h *g,\n"
17412 " const char *path,\n"
17413 " int64_t atsecs,\n"
17414 " int64_t atnsecs,\n"
17415 " int64_t mtsecs,\n"
17416 " int64_t mtnsecs);\n"
17421 #: ../src/guestfs-actions.pod:7067 ../fish/guestfish-actions.pod:4701
17422 msgid "This command sets the timestamps of a file with nanosecond precision."
17426 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4704
17428 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17433 #: ../src/guestfs-actions.pod:7073 ../fish/guestfish-actions.pod:4707
17435 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17436 "nanoseconds from the epoch."
17440 #: ../src/guestfs-actions.pod:7076 ../fish/guestfish-actions.pod:4710
17442 "If the C<*nsecs> field contains the special value C<-1> then the "
17443 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17444 "ignored in this case)."
17448 #: ../src/guestfs-actions.pod:7080 ../fish/guestfish-actions.pod:4714
17450 "If the C<*nsecs> field contains the special value C<-2> then the "
17451 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17456 #: ../src/guestfs-actions.pod:7088 ../src/guestfs-structs.pod:175
17457 msgid "guestfs_version"
17461 #: ../src/guestfs-actions.pod:7090
17464 " struct guestfs_version *\n"
17465 " guestfs_version (guestfs_h *g);\n"
17470 #: ../src/guestfs-actions.pod:7093 ../fish/guestfish-actions.pod:4722
17471 msgid "Return the libguestfs version number that the program is linked against."
17475 #: ../src/guestfs-actions.pod:7096 ../fish/guestfish-actions.pod:4725
17477 "Note that because of dynamic linking this is not necessarily the version of "
17478 "libguestfs that you compiled against. You can compile the program, and then "
17479 "at runtime dynamically link against a completely different C<libguestfs.so> "
17484 #: ../src/guestfs-actions.pod:7101 ../fish/guestfish-actions.pod:4730
17486 "This call was added in version C<1.0.58>. In previous versions of "
17487 "libguestfs there was no way to get the version number. From C code you can "
17488 "use dynamic linker functions to find out if this symbol exists (if it "
17489 "doesn't, then it's an earlier version)."
17493 #: ../src/guestfs-actions.pod:7107 ../fish/guestfish-actions.pod:4736
17495 "The call returns a structure with four elements. The first three (C<major>, "
17496 "C<minor> and C<release>) are numbers and correspond to the usual version "
17497 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17498 "but may be used for distro-specific information."
17502 #: ../src/guestfs-actions.pod:7113 ../fish/guestfish-actions.pod:4742
17503 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
17507 #: ../src/guestfs-actions.pod:7116 ../fish/guestfish-actions.pod:4745
17508 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17512 #: ../src/guestfs-actions.pod:7118
17514 "I<Note:> Don't use this call to test for availability of features. In "
17515 "enterprise distributions we backport features from later versions into "
17516 "earlier versions, making this an unreliable way to test for features. Use "
17517 "C<guestfs_available> instead."
17521 #: ../src/guestfs-actions.pod:7124
17523 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17524 "error. I<The caller must call C<guestfs_free_version> after use>."
17528 #: ../src/guestfs-actions.pod:7128
17529 msgid "(Added in 1.0.58)"
17533 #: ../src/guestfs-actions.pod:7130
17534 msgid "guestfs_vfs_label"
17538 #: ../src/guestfs-actions.pod:7132
17542 " guestfs_vfs_label (guestfs_h *g,\n"
17543 " const char *device);\n"
17548 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4757
17549 msgid "This returns the filesystem label of the filesystem on C<device>."
17553 #: ../src/guestfs-actions.pod:7139 ../fish/guestfish-actions.pod:4760
17554 msgid "If the filesystem is unlabeled, this returns the empty string."
17558 #: ../src/guestfs-actions.pod:7141
17559 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17563 #: ../src/guestfs-actions.pod:7146 ../src/guestfs-actions.pod:7183
17564 msgid "(Added in 1.3.18)"
17568 #: ../src/guestfs-actions.pod:7148
17569 msgid "guestfs_vfs_type"
17573 #: ../src/guestfs-actions.pod:7150
17577 " guestfs_vfs_type (guestfs_h *g,\n"
17578 " const char *device);\n"
17583 #: ../src/guestfs-actions.pod:7154 ../fish/guestfish-actions.pod:4768
17585 "This command gets the filesystem type corresponding to the filesystem on "
17590 #: ../src/guestfs-actions.pod:7157 ../fish/guestfish-actions.pod:4771
17592 "For most filesystems, the result is the name of the Linux VFS module which "
17593 "would be used to mount this filesystem if you mounted it without specifying "
17594 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17598 #: ../src/guestfs-actions.pod:7167
17599 msgid "guestfs_vfs_uuid"
17603 #: ../src/guestfs-actions.pod:7169
17607 " guestfs_vfs_uuid (guestfs_h *g,\n"
17608 " const char *device);\n"
17613 #: ../src/guestfs-actions.pod:7173 ../fish/guestfish-actions.pod:4780
17614 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17618 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4783
17619 msgid "If the filesystem does not have a UUID, this returns the empty string."
17623 #: ../src/guestfs-actions.pod:7178
17624 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17628 #: ../src/guestfs-actions.pod:7185
17629 msgid "guestfs_vg_activate"
17633 #: ../src/guestfs-actions.pod:7187
17637 " guestfs_vg_activate (guestfs_h *g,\n"
17639 " char *const *volgroups);\n"
17644 #: ../src/guestfs-actions.pod:7192 ../fish/guestfish-actions.pod:4791
17646 "This command activates or (if C<activate> is false) deactivates all logical "
17647 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17648 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17649 "deactivated, then those devices disappear."
17653 #: ../src/guestfs-actions.pod:7198 ../fish/guestfish-actions.pod:4797
17654 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17658 #: ../src/guestfs-actions.pod:7200 ../fish/guestfish-actions.pod:4799
17660 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17661 "activated or deactivated."
17665 #: ../src/guestfs-actions.pod:7207
17666 msgid "guestfs_vg_activate_all"
17670 #: ../src/guestfs-actions.pod:7209
17674 " guestfs_vg_activate_all (guestfs_h *g,\n"
17675 " int activate);\n"
17680 #: ../src/guestfs-actions.pod:7213 ../fish/guestfish-actions.pod:4806
17682 "This command activates or (if C<activate> is false) deactivates all logical "
17683 "volumes in all volume groups. If activated, then they are made known to the "
17684 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17685 "those devices disappear."
17689 #: ../src/guestfs-actions.pod:7219 ../fish/guestfish-actions.pod:4812
17690 msgid "This command is the same as running C<vgchange -a y|n>"
17694 #: ../src/guestfs-actions.pod:7225
17695 msgid "guestfs_vgcreate"
17699 #: ../src/guestfs-actions.pod:7227
17703 " guestfs_vgcreate (guestfs_h *g,\n"
17704 " const char *volgroup,\n"
17705 " char *const *physvols);\n"
17710 #: ../src/guestfs-actions.pod:7232 ../fish/guestfish-actions.pod:4818
17712 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17713 "of physical volumes C<physvols>."
17717 #: ../src/guestfs-actions.pod:7239
17718 msgid "guestfs_vglvuuids"
17722 #: ../src/guestfs-actions.pod:7241
17726 " guestfs_vglvuuids (guestfs_h *g,\n"
17727 " const char *vgname);\n"
17732 #: ../src/guestfs-actions.pod:7245 ../fish/guestfish-actions.pod:4825
17734 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17735 "volumes created in this volume group."
17739 #: ../src/guestfs-actions.pod:7248
17741 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17742 "associate logical volumes and volume groups."
17746 #: ../src/guestfs-actions.pod:7251
17747 msgid "See also C<guestfs_vgpvuuids>."
17751 #: ../src/guestfs-actions.pod:7259
17752 msgid "guestfs_vgpvuuids"
17756 #: ../src/guestfs-actions.pod:7261
17760 " guestfs_vgpvuuids (guestfs_h *g,\n"
17761 " const char *vgname);\n"
17766 #: ../src/guestfs-actions.pod:7265 ../fish/guestfish-actions.pod:4837
17768 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17769 "volumes that this volume group resides on."
17773 #: ../src/guestfs-actions.pod:7268
17775 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17776 "associate physical volumes and volume groups."
17780 #: ../src/guestfs-actions.pod:7271
17781 msgid "See also C<guestfs_vglvuuids>."
17785 #: ../src/guestfs-actions.pod:7279
17786 msgid "guestfs_vgremove"
17790 #: ../src/guestfs-actions.pod:7281
17794 " guestfs_vgremove (guestfs_h *g,\n"
17795 " const char *vgname);\n"
17800 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4849
17801 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17805 #: ../src/guestfs-actions.pod:7287 ../fish/guestfish-actions.pod:4851
17806 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17810 #: ../src/guestfs-actions.pod:7294
17811 msgid "guestfs_vgrename"
17815 #: ../src/guestfs-actions.pod:7296
17819 " guestfs_vgrename (guestfs_h *g,\n"
17820 " const char *volgroup,\n"
17821 " const char *newvolgroup);\n"
17826 #: ../src/guestfs-actions.pod:7301 ../fish/guestfish-actions.pod:4858
17827 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17831 #: ../src/guestfs-actions.pod:7307
17832 msgid "guestfs_vgs"
17836 #: ../src/guestfs-actions.pod:7309
17840 " guestfs_vgs (guestfs_h *g);\n"
17845 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4864
17847 "List all the volumes groups detected. This is the equivalent of the "
17848 "L<vgs(8)> command."
17852 #: ../src/guestfs-actions.pod:7315 ../fish/guestfish-actions.pod:4867
17854 "This returns a list of just the volume group names that were detected "
17855 "(eg. C<VolGroup00>)."
17859 #: ../src/guestfs-actions.pod:7318
17860 msgid "See also C<guestfs_vgs_full>."
17864 #: ../src/guestfs-actions.pod:7326
17865 msgid "guestfs_vgs_full"
17869 #: ../src/guestfs-actions.pod:7328
17872 " struct guestfs_lvm_vg_list *\n"
17873 " guestfs_vgs_full (guestfs_h *g);\n"
17878 #: ../src/guestfs-actions.pod:7331 ../fish/guestfish-actions.pod:4876
17880 "List all the volumes groups detected. This is the equivalent of the "
17881 "L<vgs(8)> command. The \"full\" version includes all fields."
17885 #: ../src/guestfs-actions.pod:7334
17887 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17888 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17893 #: ../src/guestfs-actions.pod:7340
17894 msgid "guestfs_vgscan"
17898 #: ../src/guestfs-actions.pod:7342
17902 " guestfs_vgscan (guestfs_h *g);\n"
17907 #: ../src/guestfs-actions.pod:7345 ../fish/guestfish-actions.pod:4883
17909 "This rescans all block devices and rebuilds the list of LVM physical "
17910 "volumes, volume groups and logical volumes."
17914 #: ../src/guestfs-actions.pod:7352
17915 msgid "guestfs_vguuid"
17919 #: ../src/guestfs-actions.pod:7354
17923 " guestfs_vguuid (guestfs_h *g,\n"
17924 " const char *vgname);\n"
17929 #: ../src/guestfs-actions.pod:7358 ../fish/guestfish-actions.pod:4890
17930 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17934 #: ../src/guestfs-actions.pod:7365
17935 msgid "guestfs_wait_ready"
17939 #: ../src/guestfs-actions.pod:7367
17943 " guestfs_wait_ready (guestfs_h *g);\n"
17948 #: ../src/guestfs-actions.pod:7370
17949 msgid "This function is a no op."
17953 #: ../src/guestfs-actions.pod:7372
17955 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17956 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17957 "is no longer necessary because C<guestfs_launch> now does the waiting."
17961 #: ../src/guestfs-actions.pod:7377
17963 "If you see any calls to this function in code then you can just remove them, "
17964 "unless you want to retain compatibility with older versions of the API."
17968 #: ../src/guestfs-actions.pod:7383
17969 msgid "This function is deprecated. In new code, use the C<launch> call instead."
17973 #: ../src/guestfs-actions.pod:7392
17974 msgid "guestfs_wc_c"
17978 #: ../src/guestfs-actions.pod:7394
17982 " guestfs_wc_c (guestfs_h *g,\n"
17983 " const char *path);\n"
17988 #: ../src/guestfs-actions.pod:7398 ../fish/guestfish-actions.pod:4896
17990 "This command counts the characters in a file, using the C<wc -c> external "
17995 #: ../src/guestfs-actions.pod:7405
17996 msgid "guestfs_wc_l"
18000 #: ../src/guestfs-actions.pod:7407
18004 " guestfs_wc_l (guestfs_h *g,\n"
18005 " const char *path);\n"
18010 #: ../src/guestfs-actions.pod:7411 ../fish/guestfish-actions.pod:4903
18012 "This command counts the lines in a file, using the C<wc -l> external "
18017 #: ../src/guestfs-actions.pod:7418
18018 msgid "guestfs_wc_w"
18022 #: ../src/guestfs-actions.pod:7420
18026 " guestfs_wc_w (guestfs_h *g,\n"
18027 " const char *path);\n"
18032 #: ../src/guestfs-actions.pod:7424 ../fish/guestfish-actions.pod:4910
18034 "This command counts the words in a file, using the C<wc -w> external "
18039 #: ../src/guestfs-actions.pod:7431
18040 msgid "guestfs_write"
18044 #: ../src/guestfs-actions.pod:7433
18048 " guestfs_write (guestfs_h *g,\n"
18049 " const char *path,\n"
18050 " const char *content,\n"
18051 " size_t content_size);\n"
18056 #: ../src/guestfs-actions.pod:7439 ../fish/guestfish-actions.pod:4917
18058 "This call creates a file called C<path>. The content of the file is the "
18059 "string C<content> (which can contain any 8 bit data)."
18063 #: ../src/guestfs-actions.pod:7449
18064 msgid "guestfs_write_file"
18068 #: ../src/guestfs-actions.pod:7451
18072 " guestfs_write_file (guestfs_h *g,\n"
18073 " const char *path,\n"
18074 " const char *content,\n"
18080 #: ../src/guestfs-actions.pod:7457 ../fish/guestfish-actions.pod:4927
18082 "This call creates a file called C<path>. The contents of the file is the "
18083 "string C<content> (which can contain any 8 bit data), with length C<size>."
18087 #: ../src/guestfs-actions.pod:7461 ../fish/guestfish-actions.pod:4931
18089 "As a special case, if C<size> is C<0> then the length is calculated using "
18090 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18094 #: ../src/guestfs-actions.pod:7465 ../fish/guestfish-actions.pod:4935
18096 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18097 "I<not> work, even if the length is specified."
18101 #: ../src/guestfs-actions.pod:7473 ../fish/guestfish-actions.pod:4941
18102 msgid "This function is deprecated. In new code, use the C<write> call instead."
18106 #: ../src/guestfs-actions.pod:7482
18107 msgid "guestfs_zegrep"
18111 #: ../src/guestfs-actions.pod:7484
18115 " guestfs_zegrep (guestfs_h *g,\n"
18116 " const char *regex,\n"
18117 " const char *path);\n"
18122 #: ../src/guestfs-actions.pod:7489 ../fish/guestfish-actions.pod:4952
18123 msgid "This calls the external C<zegrep> program and returns the matching lines."
18127 #: ../src/guestfs-actions.pod:7501
18128 msgid "guestfs_zegrepi"
18132 #: ../src/guestfs-actions.pod:7503
18136 " guestfs_zegrepi (guestfs_h *g,\n"
18137 " const char *regex,\n"
18138 " const char *path);\n"
18143 #: ../src/guestfs-actions.pod:7508 ../fish/guestfish-actions.pod:4962
18144 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
18148 #: ../src/guestfs-actions.pod:7520
18149 msgid "guestfs_zero"
18153 #: ../src/guestfs-actions.pod:7522
18157 " guestfs_zero (guestfs_h *g,\n"
18158 " const char *device);\n"
18163 #: ../src/guestfs-actions.pod:7526 ../fish/guestfish-actions.pod:4972
18164 msgid "This command writes zeroes over the first few blocks of C<device>."
18168 #: ../src/guestfs-actions.pod:7528 ../fish/guestfish-actions.pod:4974
18170 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18171 "securely wipe the device). It should be sufficient to remove any partition "
18172 "tables, filesystem superblocks and so on."
18176 #: ../src/guestfs-actions.pod:7532
18178 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
18179 "C<guestfs_is_zero_device>"
18183 #: ../src/guestfs-actions.pod:7544
18184 msgid "guestfs_zero_device"
18188 #: ../src/guestfs-actions.pod:7546
18192 " guestfs_zero_device (guestfs_h *g,\n"
18193 " const char *device);\n"
18198 #: ../src/guestfs-actions.pod:7550
18200 "This command writes zeroes over the entire C<device>. Compare with "
18201 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18205 #: ../src/guestfs-actions.pod:7564
18206 msgid "(Added in 1.3.1)"
18210 #: ../src/guestfs-actions.pod:7566
18211 msgid "guestfs_zerofree"
18215 #: ../src/guestfs-actions.pod:7568
18219 " guestfs_zerofree (guestfs_h *g,\n"
18220 " const char *device);\n"
18225 #: ../src/guestfs-actions.pod:7572 ../fish/guestfish-actions.pod:4996
18227 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18228 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18229 "possible to compress the filesystem more effectively."
18233 #: ../src/guestfs-actions.pod:7577 ../fish/guestfish-actions.pod:5001
18234 msgid "You should B<not> run this program if the filesystem is mounted."
18238 #: ../src/guestfs-actions.pod:7580 ../fish/guestfish-actions.pod:5004
18240 "It is possible that using this program can damage the filesystem or data on "
18245 #: ../src/guestfs-actions.pod:7587
18246 msgid "guestfs_zfgrep"
18250 #: ../src/guestfs-actions.pod:7589
18254 " guestfs_zfgrep (guestfs_h *g,\n"
18255 " const char *pattern,\n"
18256 " const char *path);\n"
18261 #: ../src/guestfs-actions.pod:7594 ../fish/guestfish-actions.pod:5011
18262 msgid "This calls the external C<zfgrep> program and returns the matching lines."
18266 #: ../src/guestfs-actions.pod:7606
18267 msgid "guestfs_zfgrepi"
18271 #: ../src/guestfs-actions.pod:7608
18275 " guestfs_zfgrepi (guestfs_h *g,\n"
18276 " const char *pattern,\n"
18277 " const char *path);\n"
18282 #: ../src/guestfs-actions.pod:7613 ../fish/guestfish-actions.pod:5021
18283 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
18287 #: ../src/guestfs-actions.pod:7625
18288 msgid "guestfs_zfile"
18292 #: ../src/guestfs-actions.pod:7627
18296 " guestfs_zfile (guestfs_h *g,\n"
18297 " const char *meth,\n"
18298 " const char *path);\n"
18303 #: ../src/guestfs-actions.pod:7632 ../fish/guestfish-actions.pod:5031
18304 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
18308 #: ../src/guestfs-actions.pod:7635 ../fish/guestfish-actions.pod:5034
18309 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18313 #: ../src/guestfs-actions.pod:7637
18315 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18320 #: ../src/guestfs-actions.pod:7643 ../fish/guestfish-actions.pod:5039
18321 msgid "This function is deprecated. In new code, use the C<file> call instead."
18325 #: ../src/guestfs-actions.pod:7652
18326 msgid "guestfs_zgrep"
18330 #: ../src/guestfs-actions.pod:7654
18334 " guestfs_zgrep (guestfs_h *g,\n"
18335 " const char *regex,\n"
18336 " const char *path);\n"
18341 #: ../src/guestfs-actions.pod:7659 ../fish/guestfish-actions.pod:5050
18342 msgid "This calls the external C<zgrep> program and returns the matching lines."
18346 #: ../src/guestfs-actions.pod:7671
18347 msgid "guestfs_zgrepi"
18351 #: ../src/guestfs-actions.pod:7673
18355 " guestfs_zgrepi (guestfs_h *g,\n"
18356 " const char *regex,\n"
18357 " const char *path);\n"
18362 #: ../src/guestfs-actions.pod:7678 ../fish/guestfish-actions.pod:5060
18363 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
18367 #: ../src/guestfs-availability.pod:3
18372 #: ../src/guestfs-availability.pod:5
18374 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
18375 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
18376 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
18377 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
18378 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
18382 #: ../src/guestfs-availability.pod:21
18387 #: ../src/guestfs-availability.pod:23
18389 "The following functions: L</guestfs_inotify_add_watch> "
18390 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
18391 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18395 #: ../src/guestfs-availability.pod:31
18396 msgid "B<linuxfsuuid>"
18400 #: ../src/guestfs-availability.pod:33
18402 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
18403 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18407 #: ../src/guestfs-availability.pod:40
18408 msgid "B<linuxmodules>"
18412 #: ../src/guestfs-availability.pod:42
18413 msgid "The following functions: L</guestfs_modprobe>"
18417 #: ../src/guestfs-availability.pod:45
18418 msgid "B<linuxxattrs>"
18422 #: ../src/guestfs-availability.pod:47
18424 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
18425 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
18426 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
18427 "L</guestfs_setxattr>"
18431 #: ../src/guestfs-availability.pod:58
18436 #: ../src/guestfs-availability.pod:60
18438 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
18439 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
18440 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18444 #: ../src/guestfs-availability.pod:69
18449 #: ../src/guestfs-availability.pod:71
18451 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
18452 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
18453 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
18454 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
18455 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
18456 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
18457 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
18458 "L</guestfs_vgs_full>"
18462 #: ../src/guestfs-availability.pod:94
18467 #: ../src/guestfs-availability.pod:96
18469 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
18470 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
18474 #: ../src/guestfs-availability.pod:102
18479 #: ../src/guestfs-availability.pod:104
18480 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18484 #: ../src/guestfs-availability.pod:107
18485 msgid "B<ntfsprogs>"
18489 #: ../src/guestfs-availability.pod:109
18490 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18494 #: ../src/guestfs-availability.pod:113
18495 msgid "B<realpath>"
18499 #: ../src/guestfs-availability.pod:115
18500 msgid "The following functions: L</guestfs_realpath>"
18504 #: ../src/guestfs-availability.pod:118
18509 #: ../src/guestfs-availability.pod:120
18511 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
18512 "L</guestfs_scrub_freespace>"
18516 #: ../src/guestfs-availability.pod:125
18521 #: ../src/guestfs-availability.pod:127
18522 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18526 #: ../src/guestfs-availability.pod:131
18531 #: ../src/guestfs-availability.pod:133
18532 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18536 #: ../src/guestfs-availability.pod:137
18537 msgid "B<zerofree>"
18541 #: ../src/guestfs-availability.pod:139
18542 msgid "The following functions: L</guestfs_zerofree>"
18546 #: ../src/guestfs-structs.pod:1
18547 msgid "guestfs_int_bool"
18551 #: ../src/guestfs-structs.pod:3
18554 " struct guestfs_int_bool {\n"
18562 #: ../src/guestfs-structs.pod:8
18565 " struct guestfs_int_bool_list {\n"
18566 " uint32_t len; /* Number of elements in list. */\n"
18567 " struct guestfs_int_bool *val; /* Elements. */\n"
18573 #: ../src/guestfs-structs.pod:13
18576 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18577 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18582 #: ../src/guestfs-structs.pod:16
18583 msgid "guestfs_lvm_pv"
18587 #: ../src/guestfs-structs.pod:18
18590 " struct guestfs_lvm_pv {\n"
18591 " char *pv_name;\n"
18592 " /* The next field is NOT nul-terminated, be careful when printing it: "
18594 " char pv_uuid[32];\n"
18596 " uint64_t pv_size;\n"
18597 " uint64_t dev_size;\n"
18598 " uint64_t pv_free;\n"
18599 " uint64_t pv_used;\n"
18600 " char *pv_attr;\n"
18601 " int64_t pv_pe_count;\n"
18602 " int64_t pv_pe_alloc_count;\n"
18603 " char *pv_tags;\n"
18604 " uint64_t pe_start;\n"
18605 " int64_t pv_mda_count;\n"
18606 " uint64_t pv_mda_free;\n"
18612 #: ../src/guestfs-structs.pod:36
18615 " struct guestfs_lvm_pv_list {\n"
18616 " uint32_t len; /* Number of elements in list. */\n"
18617 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18623 #: ../src/guestfs-structs.pod:41
18626 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18627 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18632 #: ../src/guestfs-structs.pod:44
18633 msgid "guestfs_lvm_vg"
18637 #: ../src/guestfs-structs.pod:46
18640 " struct guestfs_lvm_vg {\n"
18641 " char *vg_name;\n"
18642 " /* The next field is NOT nul-terminated, be careful when printing it: "
18644 " char vg_uuid[32];\n"
18646 " char *vg_attr;\n"
18647 " uint64_t vg_size;\n"
18648 " uint64_t vg_free;\n"
18649 " char *vg_sysid;\n"
18650 " uint64_t vg_extent_size;\n"
18651 " int64_t vg_extent_count;\n"
18652 " int64_t vg_free_count;\n"
18653 " int64_t max_lv;\n"
18654 " int64_t max_pv;\n"
18655 " int64_t pv_count;\n"
18656 " int64_t lv_count;\n"
18657 " int64_t snap_count;\n"
18658 " int64_t vg_seqno;\n"
18659 " char *vg_tags;\n"
18660 " int64_t vg_mda_count;\n"
18661 " uint64_t vg_mda_free;\n"
18667 #: ../src/guestfs-structs.pod:69
18670 " struct guestfs_lvm_vg_list {\n"
18671 " uint32_t len; /* Number of elements in list. */\n"
18672 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18678 #: ../src/guestfs-structs.pod:74
18681 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18682 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18687 #: ../src/guestfs-structs.pod:77
18688 msgid "guestfs_lvm_lv"
18692 #: ../src/guestfs-structs.pod:79
18695 " struct guestfs_lvm_lv {\n"
18696 " char *lv_name;\n"
18697 " /* The next field is NOT nul-terminated, be careful when printing it: "
18699 " char lv_uuid[32];\n"
18700 " char *lv_attr;\n"
18701 " int64_t lv_major;\n"
18702 " int64_t lv_minor;\n"
18703 " int64_t lv_kernel_major;\n"
18704 " int64_t lv_kernel_minor;\n"
18705 " uint64_t lv_size;\n"
18706 " int64_t seg_count;\n"
18708 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18709 " float snap_percent;\n"
18710 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18711 " float copy_percent;\n"
18712 " char *move_pv;\n"
18713 " char *lv_tags;\n"
18714 " char *mirror_log;\n"
18715 " char *modules;\n"
18721 #: ../src/guestfs-structs.pod:101
18724 " struct guestfs_lvm_lv_list {\n"
18725 " uint32_t len; /* Number of elements in list. */\n"
18726 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18732 #: ../src/guestfs-structs.pod:106
18735 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18736 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18741 #: ../src/guestfs-structs.pod:111
18744 " struct guestfs_stat {\n"
18748 " int64_t nlink;\n"
18753 " int64_t blksize;\n"
18754 " int64_t blocks;\n"
18755 " int64_t atime;\n"
18756 " int64_t mtime;\n"
18757 " int64_t ctime;\n"
18763 #: ../src/guestfs-structs.pod:127
18766 " struct guestfs_stat_list {\n"
18767 " uint32_t len; /* Number of elements in list. */\n"
18768 " struct guestfs_stat *val; /* Elements. */\n"
18774 #: ../src/guestfs-structs.pod:132
18777 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18778 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18783 #: ../src/guestfs-structs.pod:137
18786 " struct guestfs_statvfs {\n"
18787 " int64_t bsize;\n"
18788 " int64_t frsize;\n"
18789 " int64_t blocks;\n"
18790 " int64_t bfree;\n"
18791 " int64_t bavail;\n"
18792 " int64_t files;\n"
18793 " int64_t ffree;\n"
18794 " int64_t favail;\n"
18797 " int64_t namemax;\n"
18803 #: ../src/guestfs-structs.pod:151
18806 " struct guestfs_statvfs_list {\n"
18807 " uint32_t len; /* Number of elements in list. */\n"
18808 " struct guestfs_statvfs *val; /* Elements. */\n"
18814 #: ../src/guestfs-structs.pod:156
18817 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18818 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18823 #: ../src/guestfs-structs.pod:159
18824 msgid "guestfs_dirent"
18828 #: ../src/guestfs-structs.pod:161
18831 " struct guestfs_dirent {\n"
18840 #: ../src/guestfs-structs.pod:167
18843 " struct guestfs_dirent_list {\n"
18844 " uint32_t len; /* Number of elements in list. */\n"
18845 " struct guestfs_dirent *val; /* Elements. */\n"
18851 #: ../src/guestfs-structs.pod:172
18854 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18855 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18860 #: ../src/guestfs-structs.pod:177
18863 " struct guestfs_version {\n"
18864 " int64_t major;\n"
18865 " int64_t minor;\n"
18866 " int64_t release;\n"
18873 #: ../src/guestfs-structs.pod:184
18876 " struct guestfs_version_list {\n"
18877 " uint32_t len; /* Number of elements in list. */\n"
18878 " struct guestfs_version *val; /* Elements. */\n"
18884 #: ../src/guestfs-structs.pod:189
18887 " void guestfs_free_version (struct guestfs_free_version *);\n"
18888 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18893 #: ../src/guestfs-structs.pod:192
18894 msgid "guestfs_xattr"
18898 #: ../src/guestfs-structs.pod:194
18901 " struct guestfs_xattr {\n"
18902 " char *attrname;\n"
18903 " /* The next two fields describe a byte array. */\n"
18904 " uint32_t attrval_len;\n"
18905 " char *attrval;\n"
18911 #: ../src/guestfs-structs.pod:201
18914 " struct guestfs_xattr_list {\n"
18915 " uint32_t len; /* Number of elements in list. */\n"
18916 " struct guestfs_xattr *val; /* Elements. */\n"
18922 #: ../src/guestfs-structs.pod:206
18925 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18926 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18931 #: ../src/guestfs-structs.pod:209
18932 msgid "guestfs_inotify_event"
18936 #: ../src/guestfs-structs.pod:211
18939 " struct guestfs_inotify_event {\n"
18940 " int64_t in_wd;\n"
18941 " uint32_t in_mask;\n"
18942 " uint32_t in_cookie;\n"
18943 " char *in_name;\n"
18949 #: ../src/guestfs-structs.pod:218
18952 " struct guestfs_inotify_event_list {\n"
18953 " uint32_t len; /* Number of elements in list. */\n"
18954 " struct guestfs_inotify_event *val; /* Elements. */\n"
18960 #: ../src/guestfs-structs.pod:223
18963 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18964 " void guestfs_free_inotify_event_list (struct "
18965 "guestfs_free_inotify_event_list *);\n"
18970 #: ../src/guestfs-structs.pod:226
18971 msgid "guestfs_partition"
18975 #: ../src/guestfs-structs.pod:228
18978 " struct guestfs_partition {\n"
18979 " int32_t part_num;\n"
18980 " uint64_t part_start;\n"
18981 " uint64_t part_end;\n"
18982 " uint64_t part_size;\n"
18988 #: ../src/guestfs-structs.pod:235
18991 " struct guestfs_partition_list {\n"
18992 " uint32_t len; /* Number of elements in list. */\n"
18993 " struct guestfs_partition *val; /* Elements. */\n"
18999 #: ../src/guestfs-structs.pod:240
19002 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19003 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19008 #: ../src/guestfs-structs.pod:243
19009 msgid "guestfs_application"
19013 #: ../src/guestfs-structs.pod:245
19016 " struct guestfs_application {\n"
19017 " char *app_name;\n"
19018 " char *app_display_name;\n"
19019 " int32_t app_epoch;\n"
19020 " char *app_version;\n"
19021 " char *app_release;\n"
19022 " char *app_install_path;\n"
19023 " char *app_trans_path;\n"
19024 " char *app_publisher;\n"
19025 " char *app_url;\n"
19026 " char *app_source_package;\n"
19027 " char *app_summary;\n"
19028 " char *app_description;\n"
19034 #: ../src/guestfs-structs.pod:260
19037 " struct guestfs_application_list {\n"
19038 " uint32_t len; /* Number of elements in list. */\n"
19039 " struct guestfs_application *val; /* Elements. */\n"
19045 #: ../src/guestfs-structs.pod:265
19048 " void guestfs_free_application (struct guestfs_free_application *);\n"
19049 " void guestfs_free_application_list (struct guestfs_free_application_list "
19055 #: ../fish/guestfish.pod:5
19056 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19060 #: ../fish/guestfish.pod:9
19063 " guestfish [--options] [commands]\n"
19068 #: ../fish/guestfish.pod:11
19076 #: ../fish/guestfish.pod:13
19079 " guestfish [--ro|--rw] -a disk.img\n"
19084 #: ../fish/guestfish.pod:15
19087 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19092 #: ../fish/guestfish.pod:17
19095 " guestfish -d libvirt-domain\n"
19100 #: ../fish/guestfish.pod:19
19103 " guestfish [--ro|--rw] -a disk.img -i\n"
19108 #: ../fish/guestfish.pod:21
19111 " guestfish -d libvirt-domain -i\n"
19116 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19121 #: ../fish/guestfish.pod:25
19123 "Using guestfish in read/write mode on live virtual machines can be "
19124 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19125 "option to use guestfish safely if the disk image or virtual machine might be "
19130 #: ../fish/guestfish.pod:32
19132 "Guestfish is a shell and command-line tool for examining and modifying "
19133 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19134 "functionality of the guestfs API, see L<guestfs(3)>."
19138 #: ../fish/guestfish.pod:36
19140 "Guestfish gives you structured access to the libguestfs API, from shell "
19141 "scripts or the command line or interactively. If you want to rescue a "
19142 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19147 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949 ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
19152 #: ../fish/guestfish.pod:43
19153 msgid "As an interactive shell"
19157 #: ../fish/guestfish.pod:45
19165 #: ../fish/guestfish.pod:47
19168 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19169 " editing virtual machine filesystems.\n"
19174 #: ../fish/guestfish.pod:50
19177 " Type: 'help' for a list of commands\n"
19178 " 'man' to read the manual\n"
19179 " 'quit' to quit the shell\n"
19184 #: ../fish/guestfish.pod:54
19187 " ><fs> add-ro disk.img\n"
19189 " ><fs> list-filesystems\n"
19190 " /dev/sda1: ext4\n"
19191 " /dev/vg_guest/lv_root: ext4\n"
19192 " /dev/vg_guest/lv_swap: swap\n"
19193 " ><fs> mount /dev/vg_guest/lv_root /\n"
19194 " ><fs> cat /etc/fstab\n"
19196 " # Created by anaconda\n"
19203 #: ../fish/guestfish.pod:67
19204 msgid "From shell scripts"
19208 #: ../fish/guestfish.pod:69
19209 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19213 #: ../fish/guestfish.pod:71
19216 " guestfish <<_EOF_\n"
19219 " mount /dev/vg_guest/lv_root /\n"
19220 " write /etc/motd \"Welcome, new users\"\n"
19226 #: ../fish/guestfish.pod:78
19227 msgid "List the LVM logical volumes in a disk image:"
19231 #: ../fish/guestfish.pod:80
19234 " guestfish -a disk.img --ro <<_EOF_\n"
19242 #: ../fish/guestfish.pod:85
19243 msgid "List all the filesystems in a disk image:"
19247 #: ../fish/guestfish.pod:87
19250 " guestfish -a disk.img --ro <<_EOF_\n"
19252 " list-filesystems\n"
19258 #: ../fish/guestfish.pod:92
19259 msgid "On one command line"
19263 #: ../fish/guestfish.pod:94
19264 msgid "Update C</etc/resolv.conf> in a guest:"
19268 #: ../fish/guestfish.pod:96
19272 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19273 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19278 #: ../fish/guestfish.pod:100
19279 msgid "Edit C</boot/grub/grub.conf> interactively:"
19283 #: ../fish/guestfish.pod:102
19286 " guestfish --rw --add disk.img \\\n"
19287 " --mount /dev/vg_guest/lv_root \\\n"
19288 " --mount /dev/sda1:/boot \\\n"
19289 " edit /boot/grub/grub.conf\n"
19294 #: ../fish/guestfish.pod:107
19295 msgid "Mount disks automatically"
19299 #: ../fish/guestfish.pod:109
19301 "Use the I<-i> option to automatically mount the disks from a virtual "
19306 #: ../fish/guestfish.pod:112
19309 " guestfish --ro -a disk.img -i cat /etc/group\n"
19314 #: ../fish/guestfish.pod:114
19317 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19322 #: ../fish/guestfish.pod:116
19323 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19327 #: ../fish/guestfish.pod:118
19330 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19335 #: ../fish/guestfish.pod:120
19336 msgid "As a script interpreter"
19340 #: ../fish/guestfish.pod:122
19341 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19345 #: ../fish/guestfish.pod:124
19348 " #!/usr/bin/guestfish -f\n"
19349 " sparse test1.img 100M\n"
19351 " part-disk /dev/sda mbr\n"
19352 " mkfs ext2 /dev/sda1\n"
19357 #: ../fish/guestfish.pod:130
19358 msgid "Start with a prepared disk"
19362 #: ../fish/guestfish.pod:132
19364 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19365 "single ext2-formatted partition:"
19369 #: ../fish/guestfish.pod:135
19372 " guestfish -N fs\n"
19377 #: ../fish/guestfish.pod:137
19378 msgid "To list what is available do:"
19382 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
19385 " guestfish -N help | less\n"
19390 #: ../fish/guestfish.pod:141
19391 msgid "Remote control"
19395 #: ../fish/guestfish.pod:143
19398 " eval \"`guestfish --listen`\"\n"
19399 " guestfish --remote add-ro disk.img\n"
19400 " guestfish --remote run\n"
19401 " guestfish --remote lvs\n"
19406 #: ../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
19411 #: ../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
19416 #: ../fish/guestfish.pod:154
19417 msgid "Displays general help on options."
19421 #: ../fish/guestfish.pod:156
19426 #: ../fish/guestfish.pod:158
19427 msgid "B<--cmd-help>"
19431 #: ../fish/guestfish.pod:160
19432 msgid "Lists all available guestfish commands."
19436 #: ../fish/guestfish.pod:162
19441 #: ../fish/guestfish.pod:164
19442 msgid "B<--cmd-help cmd>"
19446 #: ../fish/guestfish.pod:166
19447 msgid "Displays detailed help on a single command C<cmd>."
19451 #: ../fish/guestfish.pod:168
19452 msgid "B<-a image>"
19456 #: ../fish/guestfish.pod:170
19457 msgid "B<--add image>"
19461 #: ../fish/guestfish.pod:172
19462 msgid "Add a block device or virtual machine image to the shell."
19466 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19468 "The format of the disk image is auto-detected. To override this and force a "
19469 "particular format use the I<--format=..> option."
19473 #: ../fish/guestfish.pod:177
19475 "Using this flag is mostly equivalent to using the C<add> command, with "
19476 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19477 "the I<--format=...> flag was given."
19481 #: ../fish/guestfish.pod:181
19486 #: ../fish/guestfish.pod:183
19487 msgid "B<--connect URI>"
19491 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19493 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19494 "URI to use. The default is to use the default libvirt connection."
19498 #: ../fish/guestfish.pod:189
19503 #: ../fish/guestfish.pod:191
19505 "If using the I<--listen> option and a csh-like shell, use this option. See "
19506 "section L</REMOTE CONTROL AND CSH> below."
19510 #: ../fish/guestfish.pod:194
19511 msgid "B<-d libvirt-domain>"
19515 #: ../fish/guestfish.pod:196
19516 msgid "B<--domain libvirt-domain>"
19520 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19522 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19523 "used, then any libvirt domain can be used. However in write mode, only "
19524 "libvirt domains which are shut down can be named here."
19528 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
19529 msgid "Domain UUIDs can be used instead of names."
19533 #: ../fish/guestfish.pod:204
19535 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19536 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19537 "if the I<--format:...> flag was given."
19541 #: ../fish/guestfish.pod:208
19546 #: ../fish/guestfish.pod:210
19547 msgid "B<--no-dest-paths>"
19551 #: ../fish/guestfish.pod:212
19553 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19554 "to hit the tab key to complete paths on the guest filesystem, but this "
19555 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19556 "allow this feature to be disabled."
19560 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19561 msgid "B<--echo-keys>"
19565 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
19567 "When prompting for keys and passphrases, guestfish normally turns echoing "
19568 "off so you cannot see what you are typing. If you are not worried about "
19569 "Tempest attacks and there is no one else in the room you can specify this "
19570 "flag to see what you are typing."
19574 #: ../fish/guestfish.pod:224
19579 #: ../fish/guestfish.pod:226
19580 msgid "B<--file file>"
19584 #: ../fish/guestfish.pod:228
19585 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19589 #: ../fish/guestfish.pod:231
19592 " #!/usr/bin/guestfish -f\n"
19597 #: ../fish/guestfish.pod:233
19598 msgid "B<--format=raw|qcow2|..>"
19602 #: ../fish/guestfish.pod:235
19603 msgid "B<--format>"
19607 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
19609 "The default for the I<-a> option is to auto-detect the format of the disk "
19610 "image. Using this forces the disk format for I<-a> options which follow on "
19611 "the command line. Using I<--format> with no argument switches back to "
19612 "auto-detection for subsequent I<-a> options."
19616 #: ../fish/guestfish.pod:244
19619 " guestfish --format=raw -a disk.img\n"
19624 #: ../fish/guestfish.pod:246
19625 msgid "forces raw format (no auto-detection) for C<disk.img>."
19629 #: ../fish/guestfish.pod:248
19632 " guestfish --format=raw -a disk.img --format -a another.img\n"
19637 #: ../fish/guestfish.pod:250
19639 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19640 "auto-detection for C<another.img>."
19644 #: ../fish/guestfish.pod:253
19646 "If you have untrusted raw-format guest disk images, you should use this "
19647 "option to specify the disk format. This avoids a possible security problem "
19648 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19652 #: ../fish/guestfish.pod:258
19657 #: ../fish/guestfish.pod:260
19658 msgid "B<--inspector>"
19662 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
19664 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19665 "system and mount filesystems as they would be mounted on the real virtual "
19670 #: ../fish/guestfish.pod:266
19671 msgid "Typical usage is either:"
19675 #: ../fish/guestfish.pod:268
19678 " guestfish -d myguest -i\n"
19683 #: ../fish/guestfish.pod:270
19684 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19688 #: ../fish/guestfish.pod:272
19691 " guestfish --ro -d myguest -i\n"
19696 #: ../fish/guestfish.pod:274
19697 msgid "(for active domains, readonly), or specify the block device directly:"
19701 #: ../fish/guestfish.pod:276
19704 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19709 #: ../fish/guestfish.pod:278
19711 "Note that the command line syntax changed slightly over older versions of "
19712 "guestfish. You can still use the old syntax:"
19716 #: ../fish/guestfish.pod:281
19719 " guestfish [--ro] -i disk.img\n"
19724 #: ../fish/guestfish.pod:283
19727 " guestfish [--ro] -i libvirt-domain\n"
19732 #: ../fish/guestfish.pod:285
19734 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19735 "then using other commands to mount the filesystems that were found."
19739 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
19740 msgid "B<--keys-from-stdin>"
19744 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
19746 "Read key or passphrase parameters from stdin. The default is to try to read "
19747 "passphrases from the user by opening C</dev/tty>."
19751 #: ../fish/guestfish.pod:294
19752 msgid "B<--listen>"
19756 #: ../fish/guestfish.pod:296
19758 "Fork into the background and listen for remote commands. See section "
19759 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19763 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
19768 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
19770 "Connect to a live virtual machine. (Experimental, see "
19771 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19775 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
19776 msgid "B<-m dev[:mountpoint[:options]]>"
19780 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
19781 msgid "B<--mount dev[:mountpoint[:options]]>"
19785 #: ../fish/guestfish.pod:308
19786 msgid "Mount the named partition or logical volume on the given mountpoint."
19790 #: ../fish/guestfish.pod:310
19791 msgid "If the mountpoint is omitted, it defaults to C</>."
19795 #: ../fish/guestfish.pod:312
19796 msgid "You have to mount something on C</> before most commands will work."
19800 #: ../fish/guestfish.pod:314
19802 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19807 #: ../fish/guestfish.pod:317
19809 "If you don't know what filesystems a disk image contains, you can either run "
19810 "guestfish without this option, then list the partitions, filesystems and LVs "
19811 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19812 "commands), or you can use the L<virt-filesystems(1)> program."
19816 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
19818 "The third (and rarely used) part of the mount parameter is the list of mount "
19819 "options used to mount the underlying filesystem. If this is not given, then "
19820 "the mount options are either the empty string or C<ro> (the latter if the "
19821 "I<--ro> flag is used). By specifying the mount options, you override this "
19822 "default choice. Probably the only time you would use this is to enable ACLs "
19823 "and/or extended attributes if the filesystem can support them:"
19827 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
19830 " -m /dev/sda1:/:acl,user_xattr\n"
19835 #: ../fish/guestfish.pod:333
19836 msgid "Using this flag is equivalent to using the C<mount-options> command."
19840 #: ../fish/guestfish.pod:335
19845 #: ../fish/guestfish.pod:337
19846 msgid "B<--no-sync>"
19850 #: ../fish/guestfish.pod:339
19852 "Disable autosync. This is enabled by default. See the discussion of "
19853 "autosync in the L<guestfs(3)> manpage."
19857 #: ../fish/guestfish.pod:342
19862 #: ../fish/guestfish.pod:344
19863 msgid "B<--new type>"
19867 #: ../fish/guestfish.pod:346
19872 #: ../fish/guestfish.pod:348
19874 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19875 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19876 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19881 #: ../fish/guestfish.pod:353
19882 msgid "B<--progress-bars>"
19886 #: ../fish/guestfish.pod:355
19887 msgid "Enable progress bars, even when guestfish is used non-interactively."
19891 #: ../fish/guestfish.pod:357
19893 "Progress bars are enabled by default when guestfish is used as an "
19894 "interactive shell."
19898 #: ../fish/guestfish.pod:360
19899 msgid "B<--no-progress-bars>"
19903 #: ../fish/guestfish.pod:362
19904 msgid "Disable progress bars."
19908 #: ../fish/guestfish.pod:364
19909 msgid "B<--remote[=pid]>"
19913 #: ../fish/guestfish.pod:366
19915 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19916 "CONTROL GUESTFISH OVER A SOCKET> below."
19920 #: ../fish/guestfish.pod:369
19925 #: ../fish/guestfish.pod:371
19930 #: ../fish/guestfish.pod:373
19932 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19933 "mounts are done read-only."
19937 #: ../fish/guestfish.pod:376
19939 "The option must always be used if the disk image or virtual machine might be "
19940 "running, and is generally recommended in cases where you don't need write "
19941 "access to the disk."
19945 #: ../fish/guestfish.pod:380
19947 "Note that prepared disk images created with I<-N> are not affected by this "
19948 "option. Also commands like C<add> are not affected - you have to specify "
19949 "the C<readonly:true> option explicitly if you need it."
19953 #: ../fish/guestfish.pod:384
19954 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19958 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
19959 msgid "B<--selinux>"
19963 #: ../fish/guestfish.pod:388
19964 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19968 #: ../fish/guestfish.pod:390
19973 #: ../fish/guestfish.pod:392
19974 msgid "B<--verbose>"
19978 #: ../fish/guestfish.pod:394
19980 "Enable very verbose messages. This is particularly useful if you find a "
19985 #: ../fish/guestfish.pod:397
19990 #: ../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
19991 msgid "B<--version>"
19995 #: ../fish/guestfish.pod:401
19996 msgid "Display the guestfish / libguestfs version number and exit."
20000 #: ../fish/guestfish.pod:403
20005 #: ../fish/guestfish.pod:405
20010 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
20012 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20013 "mounts are done read-write."
20017 #: ../fish/guestfish.pod:410
20018 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20022 #: ../fish/guestfish.pod:412
20027 #: ../fish/guestfish.pod:414
20028 msgid "Echo each command before executing it."
20032 #: ../fish/guestfish.pod:418
20033 msgid "COMMANDS ON COMMAND LINE"
20037 #: ../fish/guestfish.pod:420
20038 msgid "Any additional (non-option) arguments are treated as commands to execute."
20042 #: ../fish/guestfish.pod:423
20044 "Commands to execute should be separated by a colon (C<:>), where the colon "
20045 "is a separate parameter. Thus:"
20049 #: ../fish/guestfish.pod:426
20052 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20057 #: ../fish/guestfish.pod:428
20059 "If there are no additional arguments, then we enter a shell, either an "
20060 "interactive shell with a prompt (if the input is a terminal) or a "
20061 "non-interactive shell."
20065 #: ../fish/guestfish.pod:432
20067 "In either command line mode or non-interactive shell, the first command that "
20068 "gives an error causes the whole shell to exit. In interactive mode (with a "
20069 "prompt) if a command fails, you can continue to enter commands."
20073 #: ../fish/guestfish.pod:437
20074 msgid "USING launch (OR run)"
20078 #: ../fish/guestfish.pod:439
20080 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20081 "then launch it, then mount any disks you need, and finally issue "
20082 "actions/commands. So the general order of the day is:"
20086 #: ../fish/guestfish.pod:447
20087 msgid "add or -a/--add"
20091 #: ../fish/guestfish.pod:451
20092 msgid "launch (aka run)"
20096 #: ../fish/guestfish.pod:455
20097 msgid "mount or -m/--mount"
20101 #: ../fish/guestfish.pod:459
20102 msgid "any other commands"
20106 #: ../fish/guestfish.pod:463
20108 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20109 "guest before mounting or performing any other commands."
20113 #: ../fish/guestfish.pod:466
20115 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20116 "I<--new> options were given then C<run> is done automatically, simply "
20117 "because guestfish can't perform the action you asked for without doing this."
20121 #: ../fish/guestfish.pod:471
20122 msgid "OPENING DISKS FOR READ AND WRITE"
20126 #: ../fish/guestfish.pod:473
20128 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20129 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20130 "I<-i> and I<-m> open disk images read-only or for writing."
20134 #: ../fish/guestfish.pod:478
20136 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20137 "opening disk images supplied on the command line for write. To open a disk "
20138 "image read-only you have to do I<-a image --ro>."
20142 #: ../fish/guestfish.pod:482
20144 "This matters: If you accidentally open a live VM disk image writable then "
20145 "you will cause irreversible disk corruption."
20149 #: ../fish/guestfish.pod:485
20151 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20152 "images will be opened read-only. You will have to either specify "
20153 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20154 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20155 "access for disk images specified by those other command line options."
20159 #: ../fish/guestfish.pod:492
20161 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20162 "which does nothing (it is already the default). However it is highly "
20163 "recommended that you use this option to indicate that you need write access, "
20164 "and prepare your scripts for the day when this option will be required for "
20169 #: ../fish/guestfish.pod:498
20171 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20172 "other libguestfs program apart from guestfish and guestmount."
20176 #: ../fish/guestfish.pod:501
20181 #: ../fish/guestfish.pod:503
20183 "You can quote ordinary parameters using either single or double quotes. For "
20188 #: ../fish/guestfish.pod:506
20191 " add \"file with a space.img\"\n"
20196 #: ../fish/guestfish.pod:508
20199 " rm '/file name'\n"
20204 #: ../fish/guestfish.pod:510
20212 #: ../fish/guestfish.pod:512
20214 "A few commands require a list of strings to be passed. For these, use a "
20215 "whitespace-separated list, enclosed in quotes. Strings containing "
20216 "whitespace to be passed through must be enclosed in single quotes. A "
20217 "literal single quote must be escaped with a backslash."
20221 #: ../fish/guestfish.pod:517
20224 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20225 " command \"/bin/echo 'foo bar'\"\n"
20226 " command \"/bin/echo \\'foo\\'\"\n"
20231 #: ../fish/guestfish.pod:521
20232 msgid "OPTIONAL ARGUMENTS"
20236 #: ../fish/guestfish.pod:523
20238 "Some commands take optional arguments. These arguments appear in this "
20239 "documentation as C<[argname:..]>. You can use them as in these examples:"
20243 #: ../fish/guestfish.pod:527
20246 " add-drive-opts filename\n"
20251 #: ../fish/guestfish.pod:529
20254 " add-drive-opts filename readonly:true\n"
20259 #: ../fish/guestfish.pod:531
20262 " add-drive-opts filename format:qcow2 readonly:false\n"
20267 #: ../fish/guestfish.pod:533
20269 "Each optional argument can appear at most once. All optional arguments must "
20270 "appear after the required ones."
20274 #: ../fish/guestfish.pod:536
20279 #: ../fish/guestfish.pod:538
20280 msgid "This section applies to all commands which can take integers as parameters."
20284 #: ../fish/guestfish.pod:541
20285 msgid "SIZE SUFFIX"
20289 #: ../fish/guestfish.pod:543
20291 "When the command takes a parameter measured in bytes, you can use one of the "
20292 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20296 #: ../fish/guestfish.pod:549
20297 msgid "B<k> or B<K> or B<KiB>"
20301 #: ../fish/guestfish.pod:551
20302 msgid "The size in kilobytes (multiplied by 1024)."
20306 #: ../fish/guestfish.pod:553
20311 #: ../fish/guestfish.pod:555
20312 msgid "The size in SI 1000 byte units."
20316 #: ../fish/guestfish.pod:557
20317 msgid "B<M> or B<MiB>"
20321 #: ../fish/guestfish.pod:559
20322 msgid "The size in megabytes (multiplied by 1048576)."
20326 #: ../fish/guestfish.pod:561
20331 #: ../fish/guestfish.pod:563
20332 msgid "The size in SI 1000000 byte units."
20336 #: ../fish/guestfish.pod:565
20337 msgid "B<G> or B<GiB>"
20341 #: ../fish/guestfish.pod:567
20342 msgid "The size in gigabytes (multiplied by 2**30)."
20346 #: ../fish/guestfish.pod:569
20351 #: ../fish/guestfish.pod:571
20352 msgid "The size in SI 10**9 byte units."
20356 #: ../fish/guestfish.pod:573
20357 msgid "B<T> or B<TiB>"
20361 #: ../fish/guestfish.pod:575
20362 msgid "The size in terabytes (multiplied by 2**40)."
20366 #: ../fish/guestfish.pod:577
20371 #: ../fish/guestfish.pod:579
20372 msgid "The size in SI 10**12 byte units."
20376 #: ../fish/guestfish.pod:581
20377 msgid "B<P> or B<PiB>"
20381 #: ../fish/guestfish.pod:583
20382 msgid "The size in petabytes (multiplied by 2**50)."
20386 #: ../fish/guestfish.pod:585
20391 #: ../fish/guestfish.pod:587
20392 msgid "The size in SI 10**15 byte units."
20396 #: ../fish/guestfish.pod:589
20397 msgid "B<E> or B<EiB>"
20401 #: ../fish/guestfish.pod:591
20402 msgid "The size in exabytes (multiplied by 2**60)."
20406 #: ../fish/guestfish.pod:593
20411 #: ../fish/guestfish.pod:595
20412 msgid "The size in SI 10**18 byte units."
20416 #: ../fish/guestfish.pod:597
20417 msgid "B<Z> or B<ZiB>"
20421 #: ../fish/guestfish.pod:599
20422 msgid "The size in zettabytes (multiplied by 2**70)."
20426 #: ../fish/guestfish.pod:601
20431 #: ../fish/guestfish.pod:603
20432 msgid "The size in SI 10**21 byte units."
20436 #: ../fish/guestfish.pod:605
20437 msgid "B<Y> or B<YiB>"
20441 #: ../fish/guestfish.pod:607
20442 msgid "The size in yottabytes (multiplied by 2**80)."
20446 #: ../fish/guestfish.pod:609
20451 #: ../fish/guestfish.pod:611
20452 msgid "The size in SI 10**24 byte units."
20456 #: ../fish/guestfish.pod:617
20459 " truncate-size /file 1G\n"
20464 #: ../fish/guestfish.pod:619
20465 msgid "would truncate the file to 1 gigabyte."
20469 #: ../fish/guestfish.pod:621
20471 "Be careful because a few commands take sizes in kilobytes or megabytes "
20472 "(eg. the parameter to L</memsize> is specified in megabytes already). "
20473 "Adding a suffix will probably not do what you expect."
20477 #: ../fish/guestfish.pod:625
20478 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20482 #: ../fish/guestfish.pod:627
20484 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20485 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20489 #: ../fish/guestfish.pod:630
20492 " 1234 decimal number 1234\n"
20493 " 02322 octal number, equivalent to decimal 1234\n"
20494 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20499 #: ../fish/guestfish.pod:634
20501 "When using the C<chmod> command, you almost always want to specify an octal "
20502 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20503 "L<chmod(1)> program):"
20507 #: ../fish/guestfish.pod:638
20510 " chmod 0777 /public # OK\n"
20511 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20516 #: ../fish/guestfish.pod:641
20518 "Commands that return numbers usually print them in decimal, but some "
20519 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20520 "octal, preceeded by C<0>)."
20524 #: ../fish/guestfish.pod:645
20525 msgid "WILDCARDS AND GLOBBING"
20529 #: ../fish/guestfish.pod:647
20531 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20532 "(globbing) by default. So for example the following will not do what you "
20537 #: ../fish/guestfish.pod:651
20545 #: ../fish/guestfish.pod:653
20547 "Assuming you don't have a directory called literally C</home/*> then the "
20548 "above command will return an error."
20552 #: ../fish/guestfish.pod:656
20553 msgid "To perform wildcard expansion, use the C<glob> command."
20557 #: ../fish/guestfish.pod:658
20560 " glob rm-rf /home/*\n"
20565 #: ../fish/guestfish.pod:660
20567 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20568 "many times), equivalent to:"
20572 #: ../fish/guestfish.pod:663
20575 " rm-rf /home/jim\n"
20576 " rm-rf /home/joe\n"
20577 " rm-rf /home/mary\n"
20582 #: ../fish/guestfish.pod:667
20583 msgid "C<glob> only works on simple guest paths and not on device names."
20587 #: ../fish/guestfish.pod:669
20589 "If you have several parameters, each containing a wildcard, then glob will "
20590 "perform a Cartesian product."
20594 #: ../fish/guestfish.pod:672
20599 #: ../fish/guestfish.pod:674
20601 "Any line which starts with a I<#> character is treated as a comment and "
20602 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20603 "a command. For example:"
20607 #: ../fish/guestfish.pod:678
20610 " # this is a comment\n"
20611 " # this is a comment\n"
20612 " foo # NOT a comment\n"
20617 #: ../fish/guestfish.pod:682
20618 msgid "Blank lines are also ignored."
20622 #: ../fish/guestfish.pod:684
20623 msgid "RUNNING COMMANDS LOCALLY"
20627 #: ../fish/guestfish.pod:686
20629 "Any line which starts with a I<!> character is treated as a command sent to "
20630 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20634 #: ../fish/guestfish.pod:690
20638 " tgz-out /remote local/remote-data.tar.gz\n"
20643 #: ../fish/guestfish.pod:693
20645 "will create a directory C<local> on the host, and then export the contents "
20646 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20647 "(See C<tgz-out>)."
20651 #: ../fish/guestfish.pod:697
20653 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20654 "effect, due to the way that subprocesses work in Unix."
20658 #: ../fish/guestfish.pod:700
20659 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20663 #: ../fish/guestfish.pod:702
20665 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20666 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20667 "and executed as guestfish commands."
20671 #: ../fish/guestfish.pod:706
20673 "Thus you can use shell script to construct arbitrary guestfish commands "
20674 "which are then parsed by guestfish."
20678 #: ../fish/guestfish.pod:709
20680 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20681 "through C</foo.100>) using guestfish commands alone. However this is simple "
20682 "if we use a shell script to create the guestfish commands for us:"
20686 #: ../fish/guestfish.pod:714
20689 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20694 #: ../fish/guestfish.pod:716
20695 msgid "or with names like C</foo.001>:"
20699 #: ../fish/guestfish.pod:718
20702 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20707 #: ../fish/guestfish.pod:720
20709 "When using guestfish interactively it can be helpful to just run the shell "
20710 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20711 "ordinary I<!> local command), see what guestfish commands it would run, and "
20712 "when you are happy with those prepend the C<E<lt>> character to run the "
20713 "guestfish commands for real."
20717 #: ../fish/guestfish.pod:726
20722 #: ../fish/guestfish.pod:728
20724 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20725 "command (a guestfish command) to the second command (any host command). For "
20730 #: ../fish/guestfish.pod:732
20733 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20738 #: ../fish/guestfish.pod:734
20740 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20741 "program). The above command would list all accounts in the guest filesystem "
20742 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20746 #: ../fish/guestfish.pod:739
20749 " hexdump /bin/ls | head\n"
20750 " list-devices | tail -1\n"
20751 " tgz-out / - | tar ztf -\n"
20756 #: ../fish/guestfish.pod:743
20758 "The space before the pipe symbol is required, any space after the pipe "
20759 "symbol is optional. Everything after the pipe symbol is just passed "
20760 "straight to the host shell, so it can contain redirections, globs and "
20761 "anything else that makes sense on the host side."
20765 #: ../fish/guestfish.pod:748
20767 "To use a literal argument which begins with a pipe symbol, you have to quote "
20772 #: ../fish/guestfish.pod:751
20780 #: ../fish/guestfish.pod:753
20781 msgid "HOME DIRECTORIES"
20785 #: ../fish/guestfish.pod:755
20787 "If a parameter starts with the character C<~> then the tilde may be expanded "
20788 "as a home directory path (either C<~> for the current user's home directory, "
20789 "or C<~user> for another user)."
20793 #: ../fish/guestfish.pod:759
20795 "Note that home directory expansion happens for users known I<on the host>, "
20796 "not in the guest filesystem."
20800 #: ../fish/guestfish.pod:762
20802 "To use a literal argument which begins with a tilde, you have to quote it, "
20807 #: ../fish/guestfish.pod:765
20815 #: ../fish/guestfish.pod:769
20817 "Libguestfs has some support for Linux guests encrypted according to the "
20818 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20819 "disk encryption systems used by modern Linux guests. Currently only "
20820 "LVM-on-LUKS is supported."
20824 #: ../fish/guestfish.pod:774
20825 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20829 #: ../fish/guestfish.pod:776
20832 " ><fs> vfs-type /dev/sda2\n"
20838 #: ../fish/guestfish.pod:779
20840 "Then open those devices using L</luks-open>. This creates a device-mapper "
20841 "device called C</dev/mapper/luksdev>."
20845 #: ../fish/guestfish.pod:782
20848 " ><fs> luks-open /dev/sda2 luksdev\n"
20849 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20854 #: ../fish/guestfish.pod:785
20856 "Finally you have to tell LVM to scan for volume groups on the newly created "
20861 #: ../fish/guestfish.pod:788
20865 " vg-activate-all true\n"
20870 #: ../fish/guestfish.pod:791
20871 msgid "The logical volume(s) can now be mounted in the usual way."
20875 #: ../fish/guestfish.pod:793
20877 "Before closing a LUKS device you must unmount any logical volumes on it and "
20878 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20879 "one. Then you can close the mapper device:"
20883 #: ../fish/guestfish.pod:797
20886 " vg-activate false /dev/VG\n"
20887 " luks-close /dev/mapper/luksdev\n"
20892 #: ../fish/guestfish.pod:800
20893 msgid "WINDOWS PATHS"
20897 #: ../fish/guestfish.pod:802
20899 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20900 "letters and paths (with some limitations). The following commands are "
20905 #: ../fish/guestfish.pod:806
20908 " file /WINDOWS/system32/config/system.LOG\n"
20913 #: ../fish/guestfish.pod:808
20916 " file win:\\windows\\system32\\config\\system.log\n"
20921 #: ../fish/guestfish.pod:810
20924 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20929 #: ../fish/guestfish.pod:812
20931 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20932 "where the drive is mounted, prepending that to the path, changing all "
20933 "backslash characters to forward slash, then resolving the result using "
20934 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
20935 "then the parameter might be rewritten like this:"
20939 #: ../fish/guestfish.pod:818
20942 " win:e:\\foo\\bar => /e/FOO/bar\n"
20947 #: ../fish/guestfish.pod:820
20948 msgid "This only works in argument positions that expect a path."
20952 #: ../fish/guestfish.pod:822
20953 msgid "UPLOADING AND DOWNLOADING FILES"
20957 #: ../fish/guestfish.pod:824
20959 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20960 "others which upload from or download to a local file, you can use the "
20961 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20965 #: ../fish/guestfish.pod:828
20973 #: ../fish/guestfish.pod:830
20974 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20978 #: ../fish/guestfish.pod:833
20981 " tar-out /etc - | tar tf -\n"
20986 #: ../fish/guestfish.pod:835
20988 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20989 "command (see L</PIPES>)."
20993 #: ../fish/guestfish.pod:838
20995 "When using C<-> to read from stdin, the input is read up to the end of "
20996 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20997 "some arbitrary end marker:"
21001 #: ../fish/guestfish.pod:842
21004 " upload -<<END /foo\n"
21013 #: ../fish/guestfish.pod:848
21015 "Any string of characters can be used instead of C<END>. The end marker must "
21016 "appear on a line of its own, without any preceeding or following characters "
21017 "(not even spaces)."
21021 #: ../fish/guestfish.pod:852
21023 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21024 "upload local files (so-called \"FileIn\" parameters in the generator)."
21028 #: ../fish/guestfish.pod:855
21029 msgid "EXIT ON ERROR BEHAVIOUR"
21033 #: ../fish/guestfish.pod:857
21035 "By default, guestfish will ignore any errors when in interactive mode "
21036 "(ie. taking commands from a human over a tty), and will exit on the first "
21037 "error in non-interactive mode (scripts, commands given on the command line)."
21041 #: ../fish/guestfish.pod:862
21043 "If you prefix a command with a I<-> character, then that command will not "
21044 "cause guestfish to exit, even if that (one) command returns an error."
21048 #: ../fish/guestfish.pod:866
21049 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21053 #: ../fish/guestfish.pod:868
21055 "Guestfish can be remote-controlled over a socket. This is useful "
21056 "particularly in shell scripts where you want to make several different "
21057 "changes to a filesystem, but you don't want the overhead of starting up a "
21058 "guestfish process each time."
21062 #: ../fish/guestfish.pod:873
21063 msgid "Start a guestfish server process using:"
21067 #: ../fish/guestfish.pod:875
21070 " eval \"`guestfish --listen`\"\n"
21075 #: ../fish/guestfish.pod:877
21076 msgid "and then send it commands by doing:"
21080 #: ../fish/guestfish.pod:879
21083 " guestfish --remote cmd [...]\n"
21088 #: ../fish/guestfish.pod:881
21089 msgid "To cause the server to exit, send it the exit command:"
21093 #: ../fish/guestfish.pod:883
21096 " guestfish --remote exit\n"
21101 #: ../fish/guestfish.pod:885
21103 "Note that the server will normally exit if there is an error in a command. "
21104 "You can change this in the usual way. See section L</EXIT ON ERROR "
21109 #: ../fish/guestfish.pod:889
21110 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21114 #: ../fish/guestfish.pod:891
21116 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21117 "is how the I<--remote> option knows where to send the commands. You can "
21118 "have several guestfish listener processes running using:"
21122 #: ../fish/guestfish.pod:895
21125 " eval \"`guestfish --listen`\"\n"
21126 " pid1=$GUESTFISH_PID\n"
21127 " eval \"`guestfish --listen`\"\n"
21128 " pid2=$GUESTFISH_PID\n"
21130 " guestfish --remote=$pid1 cmd\n"
21131 " guestfish --remote=$pid2 cmd\n"
21136 #: ../fish/guestfish.pod:903
21137 msgid "REMOTE CONTROL AND CSH"
21141 #: ../fish/guestfish.pod:905
21143 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21148 #: ../fish/guestfish.pod:908
21151 " eval \"`guestfish --listen --csh`\"\n"
21156 #: ../fish/guestfish.pod:910
21157 msgid "REMOTE CONTROL DETAILS"
21161 #: ../fish/guestfish.pod:912
21163 "Remote control happens over a Unix domain socket called "
21164 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
21165 "of the process, and C<$PID> is the process ID of the server."
21169 #: ../fish/guestfish.pod:916
21170 msgid "Guestfish client and server versions must match exactly."
21174 #: ../fish/guestfish.pod:918
21175 msgid "PREPARED DISK IMAGES"
21179 #: ../fish/guestfish.pod:920
21181 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21182 "preformatted disk images that guestfish can make for you to save typing. "
21183 "This is particularly useful for testing purposes. This option is used "
21184 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21185 "can be mixed with I<-a>)."
21189 #: ../fish/guestfish.pod:926
21191 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21192 "the second and so on. Existing files in the current directory are "
21197 #: ../fish/guestfish.pod:930
21199 "The type briefly describes how the disk should be sized, partitioned, how "
21200 "filesystem(s) should be created, and how content should be added. "
21201 "Optionally the type can be followed by extra parameters, separated by C<:> "
21202 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
21203 "sparsely-allocated disk, containing a single partition, with the partition "
21204 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
21205 "on a 1GB disk instead."
21209 #: ../fish/guestfish.pod:938
21210 msgid "To list the available types and any extra parameters they take, run:"
21214 #: ../fish/guestfish.pod:942
21216 "Note that the prepared filesystem is not mounted. You would usually have to "
21217 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21221 #: ../fish/guestfish.pod:946
21223 "If any I<-N> or I<--new> options are given, the guest is automatically "
21228 #: ../fish/guestfish.pod:951
21229 msgid "Create a 100MB disk with an ext4-formatted partition:"
21233 #: ../fish/guestfish.pod:953
21236 " guestfish -N fs:ext4\n"
21241 #: ../fish/guestfish.pod:955
21242 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21246 #: ../fish/guestfish.pod:957
21249 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21254 #: ../fish/guestfish.pod:959
21255 msgid "Create a blank 200MB disk:"
21259 #: ../fish/guestfish.pod:961
21262 " guestfish -N disk:200M\n"
21267 #: ../fish/guestfish.pod:963
21268 msgid "PROGRESS BARS"
21272 #: ../fish/guestfish.pod:965
21274 "Some (not all) long-running commands send progress notification messages as "
21275 "they are running. Guestfish turns these messages into progress bars."
21279 #: ../fish/guestfish.pod:969
21281 "When a command that supports progress bars takes longer than two seconds to "
21282 "run, and if progress bars are enabled, then you will see one appearing below "
21287 #: ../fish/guestfish.pod:973
21290 " ><fs> copy-size /large-file /another-file 2048M\n"
21291 " / 10% [#####-----------------------------------------] 00:30\n"
21296 #: ../fish/guestfish.pod:976
21298 "The spinner on the left hand side moves round once for every progress "
21299 "notification received from the backend. This is a (reasonably) golden "
21300 "assurance that the command is \"doing something\" even if the progress bar "
21301 "is not moving, because the command is able to send the progress "
21302 "notifications. When the bar reaches 100% and the command finishes, the "
21303 "spinner disappears."
21307 #: ../fish/guestfish.pod:983
21309 "Progress bars are enabled by default when guestfish is used interactively. "
21310 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21311 "and you can disable them completely using I<--no-progress-bars>."
21315 #: ../fish/guestfish.pod:988
21316 msgid "GUESTFISH COMMANDS"
21320 #: ../fish/guestfish.pod:990
21322 "The commands in this section are guestfish convenience commands, in other "
21323 "words, they are not part of the L<guestfs(3)> API."
21327 #: ../fish/guestfish.pod:993
21332 #: ../fish/guestfish.pod:995
21341 #: ../fish/guestfish.pod:998
21342 msgid "Without any parameter, this provides general help."
21346 #: ../fish/guestfish.pod:1000
21347 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21351 #: ../fish/guestfish.pod:1002
21352 msgid "quit | exit"
21356 #: ../fish/guestfish.pod:1004
21357 msgid "This exits guestfish. You can also use C<^D> key."
21361 #: ../fish/guestfish.pod:1006
21362 msgid "@FISH_COMMANDS@"
21366 #: ../fish/guestfish.pod:1008
21371 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
21376 #: ../fish/guestfish.pod:1014
21378 "guestfish returns 0 if the commands completed without error, or 1 if there "
21383 #: ../fish/guestfish.pod:1021
21388 #: ../fish/guestfish.pod:1023
21390 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21395 #: ../fish/guestfish.pod:1026
21396 msgid "GUESTFISH_DISPLAY_IMAGE"
21400 #: ../fish/guestfish.pod:1028
21402 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
21403 "If not set, it uses L<display(1)>."
21407 #: ../fish/guestfish.pod:1031
21408 msgid "GUESTFISH_PID"
21412 #: ../fish/guestfish.pod:1033
21414 "Used with the I<--remote> option to specify the remote guestfish process to "
21415 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21419 #: ../fish/guestfish.pod:1037
21424 #: ../fish/guestfish.pod:1039
21426 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21427 "not specified, the external L<hexedit(1)> program is used."
21431 #: ../fish/guestfish.pod:1043
21436 #: ../fish/guestfish.pod:1045
21438 "If compiled with GNU readline support, various files in the home directory "
21439 "can be used. See L</FILES>."
21443 #: ../fish/guestfish.pod:1054
21445 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21446 "effect as using the B<-v> option."
21450 #: ../fish/guestfish.pod:1066
21452 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21453 "the discussion of paths in L<guestfs(3)>."
21457 #: ../fish/guestfish.pod:1077
21458 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21462 #: ../fish/guestfish.pod:1079
21467 #: ../fish/guestfish.pod:1081
21469 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21474 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
21479 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
21480 msgid "$HOME/.libguestfs-tools.rc"
21484 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
21485 msgid "/etc/libguestfs-tools.conf"
21489 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
21491 "This configuration file controls the default read-only or read-write mode "
21492 "(I<--ro> or I<--rw>)."
21496 #: ../fish/guestfish.pod:1108
21497 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21501 #: ../fish/guestfish.pod:1110
21502 msgid "$HOME/.guestfish"
21506 #: ../fish/guestfish.pod:1112
21508 "If compiled with GNU readline support, then the command history is saved in "
21513 #: ../fish/guestfish.pod:1115
21514 msgid "$HOME/.inputrc"
21518 #: ../fish/guestfish.pod:1117
21519 msgid "/etc/inputrc"
21523 #: ../fish/guestfish.pod:1119
21525 "If compiled with GNU readline support, then these files can be used to "
21526 "configure readline. For further information, please see "
21527 "L<readline(3)/INITIALIZATION FILE>."
21531 #: ../fish/guestfish.pod:1123
21532 msgid "To write rules which only apply to guestfish, use:"
21536 #: ../fish/guestfish.pod:1125
21546 #: ../fish/guestfish.pod:1129
21548 "Variables that you can set in inputrc that change the behaviour of guestfish "
21549 "in useful ways include:"
21553 #: ../fish/guestfish.pod:1134
21554 msgid "completion-ignore-case (default: on)"
21558 #: ../fish/guestfish.pod:1136
21560 "By default, guestfish will ignore case when tab-completing paths on the "
21565 #: ../fish/guestfish.pod:1139
21568 " set completion-ignore-case off\n"
21573 #: ../fish/guestfish.pod:1141
21574 msgid "to make guestfish case sensitive."
21578 #: ../fish/guestfish.pod:1145
21583 #: ../fish/guestfish.pod:1147
21584 msgid "test2.img (etc)"
21588 #: ../fish/guestfish.pod:1149
21590 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21591 "will be created in the file C<test1.img> in the current directory. The "
21592 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21593 "the same name will be overwritten."
21597 #: ../fish/guestfish.pod:1158
21599 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
21600 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
21601 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
21602 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21603 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21604 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>."
21608 #: ../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
21610 "This program is free software; you can redistribute it and/or modify it "
21611 "under the terms of the GNU General Public License as published by the Free "
21612 "Software Foundation; either version 2 of the License, or (at your option) "
21613 "any later version."
21617 #: ../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
21619 "This program is distributed in the hope that it will be useful, but WITHOUT "
21620 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21621 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21626 #: ../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
21628 "You should have received a copy of the GNU General Public License along with "
21629 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21630 "Ave, Cambridge, MA 02139, USA."
21634 #: ../fish/guestfish-actions.pod:1
21639 #: ../fish/guestfish-actions.pod:3
21642 " add-cdrom filename\n"
21647 #: ../fish/guestfish-actions.pod:15
21649 "This call checks for the existence of C<filename>. This stops you from "
21650 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21651 "and C<http:> URLs. To specify those, use the general L</config> call "
21656 #: ../fish/guestfish-actions.pod:22
21658 "If you just want to add an ISO file (often you use this as an efficient way "
21659 "to transfer large files into the guest), then you should probably use "
21660 "L</add-drive-ro> instead."
21664 #: ../fish/guestfish-actions.pod:35
21669 #: ../fish/guestfish-actions.pod:37
21674 #: ../fish/guestfish-actions.pod:39
21677 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
21683 #: ../fish/guestfish-actions.pod:41
21685 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21686 "It works by connecting to libvirt, requesting the domain and domain XML from "
21687 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21691 #: ../fish/guestfish-actions.pod:76
21693 "The other optional parameters are passed directly through to "
21694 "L</add-drive-opts>."
21698 #: ../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
21700 "This command has one or more optional arguments. See L</OPTIONAL "
21705 #: ../fish/guestfish-actions.pod:81
21710 #: ../fish/guestfish-actions.pod:83
21713 " add-drive filename\n"
21718 #: ../fish/guestfish-actions.pod:85
21720 "This function is the equivalent of calling L</add-drive-opts> with no "
21721 "optional parameters, so the disk is added writable, with the format being "
21722 "detected automatically."
21726 #: ../fish/guestfish-actions.pod:89
21728 "Automatic detection of the format opens you up to a potential security hole "
21729 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21730 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21731 "you should think about replacing calls to this function with calls to "
21732 "L</add-drive-opts>, and specifying the format."
21736 #: ../fish/guestfish-actions.pod:96
21737 msgid "add-drive-opts"
21741 #: ../fish/guestfish-actions.pod:98
21746 #: ../fish/guestfish-actions.pod:100
21749 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21754 #: ../fish/guestfish-actions.pod:127
21756 "This forces the image format. If you omit this (or use L</add-drive> or "
21757 "L</add-drive-ro>) then the format is automatically detected. Possible "
21758 "formats include C<raw> and C<qcow2>."
21762 #: ../fish/guestfish-actions.pod:138
21764 "This rarely-used option lets you emulate the behaviour of the deprecated "
21765 "L</add-drive-with-if> call (q.v.)"
21769 #: ../fish/guestfish-actions.pod:145
21770 msgid "add-drive-ro"
21774 #: ../fish/guestfish-actions.pod:147
21779 #: ../fish/guestfish-actions.pod:149
21782 " add-drive-ro filename\n"
21787 #: ../fish/guestfish-actions.pod:151
21789 "This function is the equivalent of calling L</add-drive-opts> with the "
21790 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21791 "is added read-only, with the format being detected automatically."
21795 #: ../fish/guestfish-actions.pod:156
21796 msgid "add-drive-ro-with-if"
21800 #: ../fish/guestfish-actions.pod:158
21803 " add-drive-ro-with-if filename iface\n"
21808 #: ../fish/guestfish-actions.pod:160
21810 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21811 "interface emulation to use at run time."
21815 #: ../fish/guestfish-actions.pod:170
21816 msgid "add-drive-with-if"
21820 #: ../fish/guestfish-actions.pod:172
21823 " add-drive-with-if filename iface\n"
21828 #: ../fish/guestfish-actions.pod:174
21830 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21831 "interface emulation to use at run time."
21835 #: ../fish/guestfish-actions.pod:184
21840 #: ../fish/guestfish-actions.pod:186
21843 " aug-clear augpath\n"
21848 #: ../fish/guestfish-actions.pod:191
21853 #: ../fish/guestfish-actions.pod:193
21861 #: ../fish/guestfish-actions.pod:195
21863 "Close the current Augeas handle and free up any resources used by it. After "
21864 "calling this, you have to call L</aug-init> again before you can use any "
21865 "other Augeas functions."
21869 #: ../fish/guestfish-actions.pod:200
21870 msgid "aug-defnode"
21874 #: ../fish/guestfish-actions.pod:202
21877 " aug-defnode name expr val\n"
21882 #: ../fish/guestfish-actions.pod:207
21884 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21885 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21886 "containing that single node."
21890 #: ../fish/guestfish-actions.pod:215
21895 #: ../fish/guestfish-actions.pod:217
21898 " aug-defvar name expr\n"
21903 #: ../fish/guestfish-actions.pod:226
21908 #: ../fish/guestfish-actions.pod:228
21911 " aug-get augpath\n"
21916 #: ../fish/guestfish-actions.pod:233
21921 #: ../fish/guestfish-actions.pod:235
21924 " aug-init root flags\n"
21929 #: ../fish/guestfish-actions.pod:241
21930 msgid "You must call this before using any other L</aug-*> commands."
21934 #: ../fish/guestfish-actions.pod:276
21935 msgid "Do not load the tree in L</aug-init>."
21939 #: ../fish/guestfish-actions.pod:280
21940 msgid "To close the handle, you can call L</aug-close>."
21944 #: ../fish/guestfish-actions.pod:284
21949 #: ../fish/guestfish-actions.pod:286
21952 " aug-insert augpath label true|false\n"
21957 #: ../fish/guestfish-actions.pod:296
21962 #: ../fish/guestfish-actions.pod:298
21970 #: ../fish/guestfish-actions.pod:305
21975 #: ../fish/guestfish-actions.pod:307
21978 " aug-ls augpath\n"
21983 #: ../fish/guestfish-actions.pod:309
21985 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21986 "resulting nodes into alphabetical order."
21990 #: ../fish/guestfish-actions.pod:312
21995 #: ../fish/guestfish-actions.pod:314
21998 " aug-match augpath\n"
22003 #: ../fish/guestfish-actions.pod:320
22008 #: ../fish/guestfish-actions.pod:322
22011 " aug-mv src dest\n"
22016 #: ../fish/guestfish-actions.pod:327
22021 #: ../fish/guestfish-actions.pod:329
22024 " aug-rm augpath\n"
22029 #: ../fish/guestfish-actions.pod:335
22034 #: ../fish/guestfish-actions.pod:337
22042 #: ../fish/guestfish-actions.pod:341
22044 "The flags which were passed to L</aug-init> affect exactly how files are "
22049 #: ../fish/guestfish-actions.pod:344
22054 #: ../fish/guestfish-actions.pod:346
22057 " aug-set augpath val\n"
22062 #: ../fish/guestfish-actions.pod:350
22064 "In the Augeas API, it is possible to clear a node by setting the value to "
22065 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22066 "this call. Instead you must use the L</aug-clear> call."
22070 #: ../fish/guestfish-actions.pod:355
22075 #: ../fish/guestfish-actions.pod:357
22078 " available 'groups ...'\n"
22083 #: ../fish/guestfish-actions.pod:363
22085 "The libguestfs groups, and the functions that those groups correspond to, "
22086 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22087 "runtime by calling L</available-all-groups>."
22091 #: ../fish/guestfish-actions.pod:387
22092 msgid "You must call L</launch> before calling this function."
22096 #: ../fish/guestfish-actions.pod:409
22098 "This call was added in version C<1.0.80>. In previous versions of "
22099 "libguestfs all you could do would be to speculatively execute a command to "
22100 "find out if the daemon implemented it. See also L</version>."
22104 #: ../fish/guestfish-actions.pod:416
22105 msgid "available-all-groups"
22109 #: ../fish/guestfish-actions.pod:418
22112 " available-all-groups\n"
22117 #: ../fish/guestfish-actions.pod:420
22119 "This command returns a list of all optional groups that this daemon knows "
22120 "about. Note this returns both supported and unsupported groups. To find "
22121 "out which ones the daemon can actually support you have to call "
22122 "L</available> on each member of the returned list."
22126 #: ../fish/guestfish-actions.pod:426
22127 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22131 #: ../fish/guestfish-actions.pod:428
22136 #: ../fish/guestfish-actions.pod:430
22139 " base64-in (base64file|-) filename\n"
22144 #: ../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
22145 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22149 #: ../fish/guestfish-actions.pod:437
22154 #: ../fish/guestfish-actions.pod:439
22157 " base64-out filename (base64file|-)\n"
22162 #: ../fish/guestfish-actions.pod:446
22163 msgid "blockdev-flushbufs"
22167 #: ../fish/guestfish-actions.pod:448
22170 " blockdev-flushbufs device\n"
22175 #: ../fish/guestfish-actions.pod:455
22176 msgid "blockdev-getbsz"
22180 #: ../fish/guestfish-actions.pod:457
22183 " blockdev-getbsz device\n"
22188 #: ../fish/guestfish-actions.pod:466
22189 msgid "blockdev-getro"
22193 #: ../fish/guestfish-actions.pod:468
22196 " blockdev-getro device\n"
22201 #: ../fish/guestfish-actions.pod:475
22202 msgid "blockdev-getsize64"
22206 #: ../fish/guestfish-actions.pod:477
22209 " blockdev-getsize64 device\n"
22214 #: ../fish/guestfish-actions.pod:481
22215 msgid "See also L</blockdev-getsz>."
22219 #: ../fish/guestfish-actions.pod:485
22220 msgid "blockdev-getss"
22224 #: ../fish/guestfish-actions.pod:487
22227 " blockdev-getss device\n"
22232 #: ../fish/guestfish-actions.pod:492
22233 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22237 #: ../fish/guestfish-actions.pod:497
22238 msgid "blockdev-getsz"
22242 #: ../fish/guestfish-actions.pod:499
22245 " blockdev-getsz device\n"
22250 #: ../fish/guestfish-actions.pod:504
22252 "See also L</blockdev-getss> for the real sector size of the device, and "
22253 "L</blockdev-getsize64> for the more useful I<size in bytes>."
22257 #: ../fish/guestfish-actions.pod:510
22258 msgid "blockdev-rereadpt"
22262 #: ../fish/guestfish-actions.pod:512
22265 " blockdev-rereadpt device\n"
22270 #: ../fish/guestfish-actions.pod:518
22271 msgid "blockdev-setbsz"
22275 #: ../fish/guestfish-actions.pod:520
22278 " blockdev-setbsz device blocksize\n"
22283 #: ../fish/guestfish-actions.pod:529
22284 msgid "blockdev-setro"
22288 #: ../fish/guestfish-actions.pod:531
22291 " blockdev-setro device\n"
22296 #: ../fish/guestfish-actions.pod:537
22297 msgid "blockdev-setrw"
22301 #: ../fish/guestfish-actions.pod:539
22304 " blockdev-setrw device\n"
22309 #: ../fish/guestfish-actions.pod:545
22310 msgid "case-sensitive-path"
22314 #: ../fish/guestfish-actions.pod:547
22317 " case-sensitive-path path\n"
22322 #: ../fish/guestfish-actions.pod:571
22324 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
22325 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22326 "how the directories were originally created under Windows)."
22330 #: ../fish/guestfish-actions.pod:579
22331 msgid "See also L</realpath>."
22335 #: ../fish/guestfish-actions.pod:581
22340 #: ../fish/guestfish-actions.pod:583
22348 #: ../fish/guestfish-actions.pod:587
22350 "Note that this function cannot correctly handle binary files (specifically, "
22351 "files containing C<\\0> character which is treated as end of string). For "
22352 "those you need to use the L</read-file> or L</download> functions which have "
22353 "a more complex interface."
22357 #: ../fish/guestfish-actions.pod:595
22362 #: ../fish/guestfish-actions.pod:597
22365 " checksum csumtype path\n"
22370 #: ../fish/guestfish-actions.pod:640
22371 msgid "To get the checksum for a device, use L</checksum-device>."
22375 #: ../fish/guestfish-actions.pod:642
22376 msgid "To get the checksums for many files, use L</checksums-out>."
22380 #: ../fish/guestfish-actions.pod:644
22381 msgid "checksum-device"
22385 #: ../fish/guestfish-actions.pod:646
22388 " checksum-device csumtype device\n"
22393 #: ../fish/guestfish-actions.pod:648
22395 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22396 "device named C<device>. For the types of checksums supported see the "
22397 "L</checksum> command."
22401 #: ../fish/guestfish-actions.pod:652
22402 msgid "checksums-out"
22406 #: ../fish/guestfish-actions.pod:654
22409 " checksums-out csumtype directory (sumsfile|-)\n"
22414 #: ../fish/guestfish-actions.pod:670
22419 #: ../fish/guestfish-actions.pod:672
22422 " chmod mode path\n"
22427 #: ../fish/guestfish-actions.pod:683
22432 #: ../fish/guestfish-actions.pod:685
22435 " chown owner group path\n"
22440 #: ../fish/guestfish-actions.pod:693
22445 #: ../fish/guestfish-actions.pod:695
22448 " command 'arguments ...'\n"
22453 #: ../fish/guestfish-actions.pod:702
22455 "The single parameter is an argv-style list of arguments. The first element "
22456 "is the name of the program to run. Subsequent elements are parameters. The "
22457 "list must be non-empty (ie. must contain a program name). Note that the "
22458 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22462 #: ../fish/guestfish-actions.pod:730
22463 msgid "command-lines"
22467 #: ../fish/guestfish-actions.pod:732
22470 " command-lines 'arguments ...'\n"
22475 #: ../fish/guestfish-actions.pod:734
22476 msgid "This is the same as L</command>, but splits the result into a list of lines."
22480 #: ../fish/guestfish-actions.pod:737
22481 msgid "See also: L</sh-lines>"
22485 #: ../fish/guestfish-actions.pod:742
22490 #: ../fish/guestfish-actions.pod:744
22493 " config qemuparam qemuvalue\n"
22498 #: ../fish/guestfish-actions.pod:755
22503 #: ../fish/guestfish-actions.pod:757
22506 " copy-size src dest size\n"
22511 #: ../fish/guestfish-actions.pod:765
22516 #: ../fish/guestfish-actions.pod:767
22524 #: ../fish/guestfish-actions.pod:772
22529 #: ../fish/guestfish-actions.pod:774
22537 #: ../fish/guestfish-actions.pod:779
22542 #: ../fish/guestfish-actions.pod:781
22550 #: ../fish/guestfish-actions.pod:788
22552 "If the destination is a device, it must be as large or larger than the "
22553 "source file or device, otherwise the copy will fail. This command cannot do "
22554 "partial copies (see L</copy-size>)."
22558 #: ../fish/guestfish-actions.pod:792
22563 #: ../fish/guestfish-actions.pod:794
22571 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
22573 "This command is mostly useful for interactive sessions. It is I<not> "
22574 "intended that you try to parse the output string. Use L</statvfs> from "
22579 #: ../fish/guestfish-actions.pod:802
22584 #: ../fish/guestfish-actions.pod:804
22592 #: ../fish/guestfish-actions.pod:813
22597 #: ../fish/guestfish-actions.pod:815
22605 #: ../fish/guestfish-actions.pod:821
22607 "Another way to get the same information is to enable verbose messages with "
22608 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22609 "before running the program."
22613 #: ../fish/guestfish-actions.pod:826
22618 #: ../fish/guestfish-actions.pod:828
22621 " download remotefilename (filename|-)\n"
22626 #: ../fish/guestfish-actions.pod:835
22627 msgid "See also L</upload>, L</cat>."
22631 #: ../fish/guestfish-actions.pod:839
22632 msgid "download-offset"
22636 #: ../fish/guestfish-actions.pod:841
22639 " download-offset remotefilename (filename|-) offset size\n"
22644 #: ../fish/guestfish-actions.pod:849
22646 "Note that there is no limit on the amount of data that can be downloaded "
22647 "with this call, unlike with L</pread>, and this call always reads the full "
22648 "amount unless an error occurs."
22652 #: ../fish/guestfish-actions.pod:854
22653 msgid "See also L</download>, L</pread>."
22657 #: ../fish/guestfish-actions.pod:858
22658 msgid "drop-caches"
22662 #: ../fish/guestfish-actions.pod:860
22665 " drop-caches whattodrop\n"
22670 #: ../fish/guestfish-actions.pod:872
22675 #: ../fish/guestfish-actions.pod:874
22683 #: ../fish/guestfish-actions.pod:886
22688 #: ../fish/guestfish-actions.pod:888
22691 " e2fsck-f device\n"
22696 #: ../fish/guestfish-actions.pod:894
22698 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22699 "should use L</fsck>."
22703 #: ../fish/guestfish-actions.pod:897
22704 msgid "echo-daemon"
22708 #: ../fish/guestfish-actions.pod:899
22711 " echo-daemon 'words ...'\n"
22716 #: ../fish/guestfish-actions.pod:906
22717 msgid "See also L</ping-daemon>."
22721 #: ../fish/guestfish-actions.pod:908
22726 #: ../fish/guestfish-actions.pod:910
22729 " egrep regex path\n"
22734 #: ../fish/guestfish-actions.pod:918
22739 #: ../fish/guestfish-actions.pod:920
22742 " egrepi regex path\n"
22747 #: ../fish/guestfish-actions.pod:928
22752 #: ../fish/guestfish-actions.pod:930
22755 " equal file1 file2\n"
22760 #: ../fish/guestfish-actions.pod:937
22765 #: ../fish/guestfish-actions.pod:939
22773 #: ../fish/guestfish-actions.pod:944
22774 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22778 #: ../fish/guestfish-actions.pod:946
22783 #: ../fish/guestfish-actions.pod:948
22786 " fallocate path len\n"
22791 #: ../fish/guestfish-actions.pod:965
22792 msgid "fallocate64"
22796 #: ../fish/guestfish-actions.pod:967
22799 " fallocate64 path len\n"
22804 #: ../fish/guestfish-actions.pod:973
22806 "Note that this call allocates disk blocks for the file. To create a sparse "
22807 "file use L</truncate-size> instead."
22811 #: ../fish/guestfish-actions.pod:976
22813 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22814 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22815 "maximum size of files created through that call to 1GB."
22819 #: ../fish/guestfish-actions.pod:985
22824 #: ../fish/guestfish-actions.pod:987
22827 " fgrep pattern path\n"
22832 #: ../fish/guestfish-actions.pod:995
22837 #: ../fish/guestfish-actions.pod:997
22840 " fgrepi pattern path\n"
22845 #: ../fish/guestfish-actions.pod:1005
22850 #: ../fish/guestfish-actions.pod:1007
22858 #: ../fish/guestfish-actions.pod:1023
22860 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
22861 "(etc), L</is-zero>."
22865 #: ../fish/guestfish-actions.pod:1026
22866 msgid "file-architecture"
22870 #: ../fish/guestfish-actions.pod:1028
22873 " file-architecture filename\n"
22878 #: ../fish/guestfish-actions.pod:1131
22883 #: ../fish/guestfish-actions.pod:1133
22891 #: ../fish/guestfish-actions.pod:1137
22893 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22894 "L</is-file> etc. To get the size of block devices, use "
22895 "L</blockdev-getsize64>."
22899 #: ../fish/guestfish-actions.pod:1141
22904 #: ../fish/guestfish-actions.pod:1143
22907 " fill c len path\n"
22912 #: ../fish/guestfish-actions.pod:1149
22914 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22915 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22916 "L</fill-pattern>."
22920 #: ../fish/guestfish-actions.pod:1154
22921 msgid "fill-pattern"
22925 #: ../fish/guestfish-actions.pod:1156
22928 " fill-pattern pattern len path\n"
22933 #: ../fish/guestfish-actions.pod:1158
22935 "This function is like L</fill> except that it creates a new file of length "
22936 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22937 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22942 #: ../fish/guestfish-actions.pod:1163
22947 #: ../fish/guestfish-actions.pod:1165
22950 " find directory\n"
22955 #: ../fish/guestfish-actions.pod:1179
22956 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22960 #: ../fish/guestfish-actions.pod:1192
22961 msgid "See also L</find0>."
22965 #: ../fish/guestfish-actions.pod:1197
22970 #: ../fish/guestfish-actions.pod:1199
22973 " find0 directory (files|-)\n"
22978 #: ../fish/guestfish-actions.pod:1205
22979 msgid "This command works the same way as L</find> with the following exceptions:"
22983 #: ../fish/guestfish-actions.pod:1232
22984 msgid "findfs-label"
22988 #: ../fish/guestfish-actions.pod:1234
22991 " findfs-label label\n"
22996 #: ../fish/guestfish-actions.pod:1240
22997 msgid "To find the label of a filesystem, use L</vfs-label>."
23001 #: ../fish/guestfish-actions.pod:1242
23002 msgid "findfs-uuid"
23006 #: ../fish/guestfish-actions.pod:1244
23009 " findfs-uuid uuid\n"
23014 #: ../fish/guestfish-actions.pod:1250
23015 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23019 #: ../fish/guestfish-actions.pod:1252
23024 #: ../fish/guestfish-actions.pod:1254
23027 " fsck fstype device\n"
23032 #: ../fish/guestfish-actions.pod:1284
23037 #: ../fish/guestfish-actions.pod:1286
23045 #: ../fish/guestfish-actions.pod:1293
23046 msgid "get-attach-method"
23050 #: ../fish/guestfish-actions.pod:1295
23053 " get-attach-method\n"
23058 #: ../fish/guestfish-actions.pod:1297
23059 msgid "Return the current attach method. See L</set-attach-method>."
23063 #: ../fish/guestfish-actions.pod:1299
23064 msgid "get-autosync"
23068 #: ../fish/guestfish-actions.pod:1301
23076 #: ../fish/guestfish-actions.pod:1305
23081 #: ../fish/guestfish-actions.pod:1307
23089 #: ../fish/guestfish-actions.pod:1311
23090 msgid "get-e2label"
23094 #: ../fish/guestfish-actions.pod:1313
23097 " get-e2label device\n"
23102 #: ../fish/guestfish-actions.pod:1325
23107 #: ../fish/guestfish-actions.pod:1327
23110 " get-e2uuid device\n"
23115 #: ../fish/guestfish-actions.pod:1339
23116 msgid "get-memsize"
23120 #: ../fish/guestfish-actions.pod:1341
23128 #: ../fish/guestfish-actions.pod:1346
23130 "If L</set-memsize> was not called on this handle, and if "
23131 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23132 "value for memsize."
23136 #: ../fish/guestfish-actions.pod:1353
23137 msgid "get-network"
23141 #: ../fish/guestfish-actions.pod:1355
23149 #: ../fish/guestfish-actions.pod:1359
23154 #: ../fish/guestfish-actions.pod:1361
23162 #: ../fish/guestfish-actions.pod:1368
23167 #: ../fish/guestfish-actions.pod:1370
23172 #: ../fish/guestfish-actions.pod:1372
23180 #: ../fish/guestfish-actions.pod:1379
23185 #: ../fish/guestfish-actions.pod:1381
23193 #: ../fish/guestfish-actions.pod:1388
23194 msgid "get-recovery-proc"
23198 #: ../fish/guestfish-actions.pod:1390
23201 " get-recovery-proc\n"
23206 #: ../fish/guestfish-actions.pod:1394
23207 msgid "get-selinux"
23211 #: ../fish/guestfish-actions.pod:1396
23219 #: ../fish/guestfish-actions.pod:1398
23221 "This returns the current setting of the selinux flag which is passed to the "
23222 "appliance at boot time. See L</set-selinux>."
23226 #: ../fish/guestfish-actions.pod:1404
23231 #: ../fish/guestfish-actions.pod:1406
23239 #: ../fish/guestfish-actions.pod:1413
23244 #: ../fish/guestfish-actions.pod:1415
23252 #: ../fish/guestfish-actions.pod:1419
23257 #: ../fish/guestfish-actions.pod:1421
23265 #: ../fish/guestfish-actions.pod:1423
23267 "Return the current umask. By default the umask is C<022> unless it has been "
23268 "set by calling L</umask>."
23272 #: ../fish/guestfish-actions.pod:1426
23273 msgid "get-verbose"
23277 #: ../fish/guestfish-actions.pod:1428
23285 #: ../fish/guestfish-actions.pod:1432
23290 #: ../fish/guestfish-actions.pod:1434
23298 #: ../fish/guestfish-actions.pod:1438
23299 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23303 #: ../fish/guestfish-actions.pod:1441
23308 #: ../fish/guestfish-actions.pod:1443
23311 " getxattr path name\n"
23316 #: ../fish/guestfish-actions.pod:1445
23318 "Get a single extended attribute from file C<path> named C<name>. This call "
23319 "follows symlinks. If you want to lookup an extended attribute for the "
23320 "symlink itself, use L</lgetxattr>."
23324 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2476
23326 "Normally it is better to get all extended attributes from a file in one go "
23327 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23328 "buggy and do not provide a way to list out attributes. For these "
23329 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23330 "attributes you want in advance and call this function."
23334 #: ../fish/guestfish-actions.pod:1459
23335 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23339 #: ../fish/guestfish-actions.pod:1461
23344 #: ../fish/guestfish-actions.pod:1463
23347 " getxattrs path\n"
23352 #: ../fish/guestfish-actions.pod:1471
23353 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23357 #: ../fish/guestfish-actions.pod:1473
23358 msgid "glob-expand"
23362 #: ../fish/guestfish-actions.pod:1475
23365 " glob-expand pattern\n"
23370 #: ../fish/guestfish-actions.pod:1488
23375 #: ../fish/guestfish-actions.pod:1490
23378 " grep regex path\n"
23383 #: ../fish/guestfish-actions.pod:1498
23388 #: ../fish/guestfish-actions.pod:1500
23391 " grepi regex path\n"
23396 #: ../fish/guestfish-actions.pod:1508
23397 msgid "grub-install"
23401 #: ../fish/guestfish-actions.pod:1510
23404 " grub-install root device\n"
23409 #: ../fish/guestfish-actions.pod:1526
23414 #: ../fish/guestfish-actions.pod:1528
23422 #: ../fish/guestfish-actions.pod:1536
23427 #: ../fish/guestfish-actions.pod:1538
23430 " head-n nrlines path\n"
23435 #: ../fish/guestfish-actions.pod:1551
23440 #: ../fish/guestfish-actions.pod:1553
23448 #: ../fish/guestfish-actions.pod:1561
23453 #: ../fish/guestfish-actions.pod:1563
23456 " initrd-cat initrdpath filename\n"
23461 #: ../fish/guestfish-actions.pod:1575
23462 msgid "See also L</initrd-list>."
23466 #: ../fish/guestfish-actions.pod:1580
23467 msgid "initrd-list"
23471 #: ../fish/guestfish-actions.pod:1582
23474 " initrd-list path\n"
23479 #: ../fish/guestfish-actions.pod:1594
23480 msgid "inotify-add-watch"
23484 #: ../fish/guestfish-actions.pod:1596
23487 " inotify-add-watch path mask\n"
23492 #: ../fish/guestfish-actions.pod:1608
23493 msgid "inotify-close"
23497 #: ../fish/guestfish-actions.pod:1610
23505 #: ../fish/guestfish-actions.pod:1616
23506 msgid "inotify-files"
23510 #: ../fish/guestfish-actions.pod:1618
23518 #: ../fish/guestfish-actions.pod:1620
23520 "This function is a helpful wrapper around L</inotify-read> which just "
23521 "returns a list of pathnames of objects that were touched. The returned "
23522 "pathnames are sorted and deduplicated."
23526 #: ../fish/guestfish-actions.pod:1624
23527 msgid "inotify-init"
23531 #: ../fish/guestfish-actions.pod:1626
23534 " inotify-init maxevents\n"
23539 #: ../fish/guestfish-actions.pod:1632
23541 "C<maxevents> is the maximum number of events which will be queued up between "
23542 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23543 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23544 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23545 "but records the fact that it threw them away by setting a flag "
23546 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23550 #: ../fish/guestfish-actions.pod:1642
23552 "Before any events are generated, you have to add some watches to the "
23553 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23554 "L</inotify-watch-all>."
23558 #: ../fish/guestfish-actions.pod:1648
23560 "Queued up events should be read periodically by calling L</inotify-read> (or "
23561 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23562 "If you don't read the events out often enough then you risk the internal "
23563 "queue overflowing."
23567 #: ../fish/guestfish-actions.pod:1655
23569 "The handle should be closed after use by calling L</inotify-close>. This "
23570 "also removes any watches automatically."
23574 #: ../fish/guestfish-actions.pod:1664
23575 msgid "inotify-read"
23579 #: ../fish/guestfish-actions.pod:1666
23587 #: ../fish/guestfish-actions.pod:1679
23588 msgid "inotify-rm-watch"
23592 #: ../fish/guestfish-actions.pod:1681
23595 " inotify-rm-watch wd\n"
23600 #: ../fish/guestfish-actions.pod:1683
23601 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23605 #: ../fish/guestfish-actions.pod:1686
23606 msgid "inspect-get-arch"
23610 #: ../fish/guestfish-actions.pod:1688
23613 " inspect-get-arch root\n"
23618 #: ../fish/guestfish-actions.pod:1690
23620 "This returns the architecture of the inspected operating system. The "
23621 "possible return values are listed under L</file-architecture>."
23625 #: ../fish/guestfish-actions.pod:1699
23626 msgid "inspect-get-distro"
23630 #: ../fish/guestfish-actions.pod:1701
23633 " inspect-get-distro root\n"
23638 #: ../fish/guestfish-actions.pod:1782
23639 msgid "inspect-get-drive-mappings"
23643 #: ../fish/guestfish-actions.pod:1784
23646 " inspect-get-drive-mappings root\n"
23651 #: ../fish/guestfish-actions.pod:1811
23653 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23654 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23658 #: ../fish/guestfish-actions.pod:1815
23659 msgid "inspect-get-filesystems"
23663 #: ../fish/guestfish-actions.pod:1817
23666 " inspect-get-filesystems root\n"
23671 #: ../fish/guestfish-actions.pod:1827
23673 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23674 "L</inspect-get-mountpoints>."
23678 #: ../fish/guestfish-actions.pod:1830
23679 msgid "inspect-get-format"
23683 #: ../fish/guestfish-actions.pod:1832
23686 " inspect-get-format root\n"
23691 #: ../fish/guestfish-actions.pod:1861
23692 msgid "inspect-get-hostname"
23696 #: ../fish/guestfish-actions.pod:1863
23699 " inspect-get-hostname root\n"
23704 #: ../fish/guestfish-actions.pod:1873
23705 msgid "inspect-get-icon"
23709 #: ../fish/guestfish-actions.pod:1875
23712 " inspect-get-icon root [favicon:..] [highquality:..]\n"
23717 #: ../fish/guestfish-actions.pod:1939
23718 msgid "inspect-get-major-version"
23722 #: ../fish/guestfish-actions.pod:1941
23725 " inspect-get-major-version root\n"
23730 #: ../fish/guestfish-actions.pod:1957
23731 msgid "inspect-get-minor-version"
23735 #: ../fish/guestfish-actions.pod:1959
23738 " inspect-get-minor-version root\n"
23743 #: ../fish/guestfish-actions.pod:1966
23745 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23746 "L</inspect-get-major-version>."
23750 #: ../fish/guestfish-actions.pod:1969
23751 msgid "inspect-get-mountpoints"
23755 #: ../fish/guestfish-actions.pod:1971
23758 " inspect-get-mountpoints root\n"
23763 #: ../fish/guestfish-actions.pod:1990
23765 "For operating systems like Windows which still use drive letters, this call "
23766 "will only return an entry for the first drive \"mounted on\" C</>. For "
23767 "information about the mapping of drive letters to partitions, see "
23768 "L</inspect-get-drive-mappings>."
23772 #: ../fish/guestfish-actions.pod:1996
23774 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23775 "L</inspect-get-filesystems>."
23779 #: ../fish/guestfish-actions.pod:1999
23780 msgid "inspect-get-package-format"
23784 #: ../fish/guestfish-actions.pod:2001
23787 " inspect-get-package-format root\n"
23792 #: ../fish/guestfish-actions.pod:2003
23794 "This function and L</inspect-get-package-management> return the package "
23795 "format and package management tool used by the inspected operating system. "
23796 "For example for Fedora these functions would return C<rpm> (package format) "
23797 "and C<yum> (package management)."
23801 #: ../fish/guestfish-actions.pod:2018
23802 msgid "inspect-get-package-management"
23806 #: ../fish/guestfish-actions.pod:2020
23809 " inspect-get-package-management root\n"
23814 #: ../fish/guestfish-actions.pod:2022
23816 "L</inspect-get-package-format> and this function return the package format "
23817 "and package management tool used by the inspected operating system. For "
23818 "example for Fedora these functions would return C<rpm> (package format) and "
23819 "C<yum> (package management)."
23823 #: ../fish/guestfish-actions.pod:2039
23824 msgid "inspect-get-product-name"
23828 #: ../fish/guestfish-actions.pod:2041
23831 " inspect-get-product-name root\n"
23836 #: ../fish/guestfish-actions.pod:2053
23837 msgid "inspect-get-product-variant"
23841 #: ../fish/guestfish-actions.pod:2055
23844 " inspect-get-product-variant root\n"
23849 #: ../fish/guestfish-actions.pod:2076
23851 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23852 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23856 #: ../fish/guestfish-actions.pod:2080
23857 msgid "inspect-get-roots"
23861 #: ../fish/guestfish-actions.pod:2082
23864 " inspect-get-roots\n"
23869 #: ../fish/guestfish-actions.pod:2084
23871 "This function is a convenient way to get the list of root devices, as "
23872 "returned from a previous call to L</inspect-os>, but without redoing the "
23873 "whole inspection process."
23877 #: ../fish/guestfish-actions.pod:2088
23879 "This returns an empty list if either no root devices were found or the "
23880 "caller has not called L</inspect-os>."
23884 #: ../fish/guestfish-actions.pod:2093
23885 msgid "inspect-get-type"
23889 #: ../fish/guestfish-actions.pod:2095
23892 " inspect-get-type root\n"
23897 #: ../fish/guestfish-actions.pod:2125
23898 msgid "inspect-get-windows-current-control-set"
23902 #: ../fish/guestfish-actions.pod:2127
23905 " inspect-get-windows-current-control-set root\n"
23910 #: ../fish/guestfish-actions.pod:2138
23911 msgid "inspect-get-windows-systemroot"
23915 #: ../fish/guestfish-actions.pod:2140
23918 " inspect-get-windows-systemroot root\n"
23923 #: ../fish/guestfish-actions.pod:2151
23924 msgid "inspect-is-live"
23928 #: ../fish/guestfish-actions.pod:2153
23931 " inspect-is-live root\n"
23936 #: ../fish/guestfish-actions.pod:2155
23938 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23939 "then this returns true if a live image was detected on the disk."
23943 #: ../fish/guestfish-actions.pod:2161
23944 msgid "inspect-is-multipart"
23948 #: ../fish/guestfish-actions.pod:2163
23951 " inspect-is-multipart root\n"
23956 #: ../fish/guestfish-actions.pod:2165
23958 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23959 "then this returns true if the disk is part of a set."
23963 #: ../fish/guestfish-actions.pod:2171
23964 msgid "inspect-is-netinst"
23968 #: ../fish/guestfish-actions.pod:2173
23971 " inspect-is-netinst root\n"
23976 #: ../fish/guestfish-actions.pod:2175
23978 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23979 "then this returns true if the disk is a network installer, ie. not a "
23980 "self-contained install CD but one which is likely to require network access "
23981 "to complete the install."
23985 #: ../fish/guestfish-actions.pod:2183
23986 msgid "inspect-list-applications"
23990 #: ../fish/guestfish-actions.pod:2185
23993 " inspect-list-applications root\n"
23998 #: ../fish/guestfish-actions.pod:2189
24000 "I<Note:> This call works differently from other parts of the inspection "
24001 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24002 "then mount up the disks, before calling this. Listing applications is a "
24003 "significantly more difficult operation which requires access to the full "
24004 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24005 "are just returning data cached in the libguestfs handle, this call actually "
24006 "reads parts of the mounted filesystems during the call."
24010 #: ../fish/guestfish-actions.pod:2279
24015 #: ../fish/guestfish-actions.pod:2281
24023 #: ../fish/guestfish-actions.pod:2296
24025 "You can pass the root string(s) returned to other L</inspect-get-*> "
24026 "functions in order to query further information about each operating system, "
24027 "such as the name and version."
24031 #: ../fish/guestfish-actions.pod:2301
24033 "This function uses other libguestfs features such as L</mount-ro> and "
24034 "L</umount-all> in order to mount and unmount filesystems and look at the "
24035 "contents. This should be called with no disks currently mounted. The "
24036 "function may also use Augeas, so any existing Augeas handle will be closed."
24040 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2511 ../fish/guestfish-actions.pod:2557
24041 msgid "See also L</list-filesystems>."
24045 #: ../fish/guestfish-actions.pod:2315
24046 msgid "is-blockdev"
24050 #: ../fish/guestfish-actions.pod:2317
24053 " is-blockdev path\n"
24058 #: ../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
24059 msgid "See also L</stat>."
24063 #: ../fish/guestfish-actions.pod:2324
24068 #: ../fish/guestfish-actions.pod:2326
24076 #: ../fish/guestfish-actions.pod:2333
24081 #: ../fish/guestfish-actions.pod:2335
24084 " is-chardev path\n"
24089 #: ../fish/guestfish-actions.pod:2342
24094 #: ../fish/guestfish-actions.pod:2344
24102 #: ../fish/guestfish-actions.pod:2351
24107 #: ../fish/guestfish-actions.pod:2353
24115 #: ../fish/guestfish-actions.pod:2361
24120 #: ../fish/guestfish-actions.pod:2363
24128 #: ../fish/guestfish-actions.pod:2370
24133 #: ../fish/guestfish-actions.pod:2372
24141 #: ../fish/guestfish-actions.pod:2380
24142 msgid "is-launching"
24146 #: ../fish/guestfish-actions.pod:2382
24154 #: ../fish/guestfish-actions.pod:2389
24159 #: ../fish/guestfish-actions.pod:2391
24167 #: ../fish/guestfish-actions.pod:2396
24172 #: ../fish/guestfish-actions.pod:2398
24180 #: ../fish/guestfish-actions.pod:2405
24185 #: ../fish/guestfish-actions.pod:2407
24188 " is-socket path\n"
24193 #: ../fish/guestfish-actions.pod:2414
24198 #: ../fish/guestfish-actions.pod:2416
24201 " is-symlink path\n"
24206 #: ../fish/guestfish-actions.pod:2423
24211 #: ../fish/guestfish-actions.pod:2425
24219 #: ../fish/guestfish-actions.pod:2430
24220 msgid "is-zero-device"
24224 #: ../fish/guestfish-actions.pod:2432
24227 " is-zero-device device\n"
24232 #: ../fish/guestfish-actions.pod:2438
24233 msgid "kill-subprocess"
24237 #: ../fish/guestfish-actions.pod:2440
24240 " kill-subprocess\n"
24245 #: ../fish/guestfish-actions.pod:2444
24250 #: ../fish/guestfish-actions.pod:2446
24255 #: ../fish/guestfish-actions.pod:2448
24263 #: ../fish/guestfish-actions.pod:2456
24268 #: ../fish/guestfish-actions.pod:2458
24271 " lchown owner group path\n"
24276 #: ../fish/guestfish-actions.pod:2460
24278 "Change the file owner to C<owner> and group to C<group>. This is like "
24279 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
24284 #: ../fish/guestfish-actions.pod:2468
24289 #: ../fish/guestfish-actions.pod:2470
24292 " lgetxattr path name\n"
24297 #: ../fish/guestfish-actions.pod:2486
24298 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24302 #: ../fish/guestfish-actions.pod:2488
24307 #: ../fish/guestfish-actions.pod:2490
24310 " lgetxattrs path\n"
24315 #: ../fish/guestfish-actions.pod:2492
24317 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24318 "it returns the extended attributes of the link itself."
24322 #: ../fish/guestfish-actions.pod:2496
24327 #: ../fish/guestfish-actions.pod:2498
24335 #: ../fish/guestfish-actions.pod:2503
24336 msgid "list-devices"
24340 #: ../fish/guestfish-actions.pod:2505
24348 #: ../fish/guestfish-actions.pod:2513
24349 msgid "list-filesystems"
24353 #: ../fish/guestfish-actions.pod:2515
24356 " list-filesystems\n"
24361 #: ../fish/guestfish-actions.pod:2534
24363 "This command runs other libguestfs commands, which might include L</mount> "
24364 "and L</umount>, and therefore you should use this soon after launch and only "
24365 "when nothing is mounted."
24369 #: ../fish/guestfish-actions.pod:2538
24371 "Not all of the filesystems returned will be mountable. In particular, swap "
24372 "partitions are returned in the list. Also this command does not check that "
24373 "each filesystem found is valid and mountable, and some filesystems might be "
24374 "mountable but require special options. Filesystems may not all belong to a "
24375 "single logical operating system (use L</inspect-os> to look for OSes)."
24379 #: ../fish/guestfish-actions.pod:2546
24380 msgid "list-partitions"
24384 #: ../fish/guestfish-actions.pod:2548
24387 " list-partitions\n"
24392 #: ../fish/guestfish-actions.pod:2554
24394 "This does not return logical volumes. For that you will need to call "
24399 #: ../fish/guestfish-actions.pod:2559
24404 #: ../fish/guestfish-actions.pod:2561
24412 #: ../fish/guestfish-actions.pod:2569
24417 #: ../fish/guestfish-actions.pod:2571
24420 " ln target linkname\n"
24425 #: ../fish/guestfish-actions.pod:2575
24430 #: ../fish/guestfish-actions.pod:2577
24433 " ln-f target linkname\n"
24438 #: ../fish/guestfish-actions.pod:2582
24443 #: ../fish/guestfish-actions.pod:2584
24446 " ln-s target linkname\n"
24451 #: ../fish/guestfish-actions.pod:2588
24456 #: ../fish/guestfish-actions.pod:2590
24459 " ln-sf target linkname\n"
24464 #: ../fish/guestfish-actions.pod:2595
24465 msgid "lremovexattr"
24469 #: ../fish/guestfish-actions.pod:2597
24472 " lremovexattr xattr path\n"
24477 #: ../fish/guestfish-actions.pod:2599
24479 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24480 "it removes an extended attribute of the link itself."
24484 #: ../fish/guestfish-actions.pod:2603
24489 #: ../fish/guestfish-actions.pod:2605
24497 #: ../fish/guestfish-actions.pod:2611
24499 "This command is mostly useful for interactive sessions. Programs should "
24500 "probably use L</readdir> instead."
24504 #: ../fish/guestfish-actions.pod:2614
24509 #: ../fish/guestfish-actions.pod:2616
24512 " lsetxattr xattr val vallen path\n"
24517 #: ../fish/guestfish-actions.pod:2618
24519 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24520 "sets an extended attribute of the link itself."
24524 #: ../fish/guestfish-actions.pod:2622
24529 #: ../fish/guestfish-actions.pod:2624
24537 #: ../fish/guestfish-actions.pod:2628
24539 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24540 "the link is stat-ed, not the file it refers to."
24544 #: ../fish/guestfish-actions.pod:2634
24549 #: ../fish/guestfish-actions.pod:2636
24552 " lstatlist path 'names ...'\n"
24557 #: ../fish/guestfish-actions.pod:2638
24559 "This call allows you to perform the L</lstat> operation on multiple files, "
24560 "where all files are in the directory C<path>. C<names> is the list of files "
24561 "from this directory."
24565 #: ../fish/guestfish-actions.pod:2647
24567 "This call is intended for programs that want to efficiently list a directory "
24568 "contents without making many round-trips. See also L</lxattrlist> for a "
24569 "similarly efficient call for getting extended attributes. Very long "
24570 "directory listings might cause the protocol message size to be exceeded, "
24571 "causing this call to fail. The caller must split up such requests into "
24572 "smaller groups of names."
24576 #: ../fish/guestfish-actions.pod:2655
24577 msgid "luks-add-key"
24581 #: ../fish/guestfish-actions.pod:2657
24584 " luks-add-key device keyslot\n"
24589 #: ../fish/guestfish-actions.pod:2664
24591 "Note that if C<keyslot> already contains a key, then this command will "
24592 "fail. You have to use L</luks-kill-slot> first to remove that key."
24596 #: ../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
24598 "This command has one or more key or passphrase parameters. Guestfish will "
24599 "prompt for these separately."
24603 #: ../fish/guestfish-actions.pod:2671
24608 #: ../fish/guestfish-actions.pod:2673
24611 " luks-close device\n"
24616 #: ../fish/guestfish-actions.pod:2675
24618 "This closes a LUKS device that was created earlier by L</luks-open> or "
24619 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
24620 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
24621 "underlying block device."
24625 #: ../fish/guestfish-actions.pod:2681
24626 msgid "luks-format"
24630 #: ../fish/guestfish-actions.pod:2683
24633 " luks-format device keyslot\n"
24638 #: ../fish/guestfish-actions.pod:2696
24639 msgid "luks-format-cipher"
24643 #: ../fish/guestfish-actions.pod:2698
24646 " luks-format-cipher device keyslot cipher\n"
24651 #: ../fish/guestfish-actions.pod:2700
24653 "This command is the same as L</luks-format> but it also allows you to set "
24654 "the C<cipher> used."
24658 #: ../fish/guestfish-actions.pod:2709
24659 msgid "luks-kill-slot"
24663 #: ../fish/guestfish-actions.pod:2711
24666 " luks-kill-slot device keyslot\n"
24671 #: ../fish/guestfish-actions.pod:2720
24676 #: ../fish/guestfish-actions.pod:2722
24679 " luks-open device mapname\n"
24684 #: ../fish/guestfish-actions.pod:2736
24686 "If this block device contains LVM volume groups, then calling L</vgscan> "
24687 "followed by L</vg-activate-all> will make them visible."
24691 #: ../fish/guestfish-actions.pod:2743
24692 msgid "luks-open-ro"
24696 #: ../fish/guestfish-actions.pod:2745
24699 " luks-open-ro device mapname\n"
24704 #: ../fish/guestfish-actions.pod:2747
24706 "This is the same as L</luks-open> except that a read-only mapping is "
24711 #: ../fish/guestfish-actions.pod:2753
24716 #: ../fish/guestfish-actions.pod:2755
24719 " lvcreate logvol volgroup mbytes\n"
24724 #: ../fish/guestfish-actions.pod:2760
24725 msgid "lvm-canonical-lv-name"
24729 #: ../fish/guestfish-actions.pod:2762
24732 " lvm-canonical-lv-name lvname\n"
24737 #: ../fish/guestfish-actions.pod:2771
24738 msgid "See also L</is-lv>."
24742 #: ../fish/guestfish-actions.pod:2773
24743 msgid "lvm-clear-filter"
24747 #: ../fish/guestfish-actions.pod:2775
24750 " lvm-clear-filter\n"
24755 #: ../fish/guestfish-actions.pod:2777
24757 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24762 #: ../fish/guestfish-actions.pod:2783
24763 msgid "lvm-remove-all"
24767 #: ../fish/guestfish-actions.pod:2785
24770 " lvm-remove-all\n"
24775 #: ../fish/guestfish-actions.pod:2793
24776 msgid "lvm-set-filter"
24780 #: ../fish/guestfish-actions.pod:2795
24783 " lvm-set-filter 'devices ...'\n"
24788 #: ../fish/guestfish-actions.pod:2820
24793 #: ../fish/guestfish-actions.pod:2822
24796 " lvremove device\n"
24801 #: ../fish/guestfish-actions.pod:2830
24806 #: ../fish/guestfish-actions.pod:2832
24809 " lvrename logvol newlogvol\n"
24814 #: ../fish/guestfish-actions.pod:2836
24819 #: ../fish/guestfish-actions.pod:2838
24822 " lvresize device mbytes\n"
24827 #: ../fish/guestfish-actions.pod:2844
24828 msgid "lvresize-free"
24832 #: ../fish/guestfish-actions.pod:2846
24835 " lvresize-free lv percent\n"
24840 #: ../fish/guestfish-actions.pod:2854
24845 #: ../fish/guestfish-actions.pod:2856
24853 #: ../fish/guestfish-actions.pod:2864
24854 msgid "See also L</lvs-full>, L</list-filesystems>."
24858 #: ../fish/guestfish-actions.pod:2866
24863 #: ../fish/guestfish-actions.pod:2868
24871 #: ../fish/guestfish-actions.pod:2873
24876 #: ../fish/guestfish-actions.pod:2875
24884 #: ../fish/guestfish-actions.pod:2879
24889 #: ../fish/guestfish-actions.pod:2881
24892 " lxattrlist path 'names ...'\n"
24897 #: ../fish/guestfish-actions.pod:2897
24899 "This call is intended for programs that want to efficiently list a directory "
24900 "contents without making many round-trips. See also L</lstatlist> for a "
24901 "similarly efficient call for getting standard stats. Very long directory "
24902 "listings might cause the protocol message size to be exceeded, causing this "
24903 "call to fail. The caller must split up such requests into smaller groups of "
24908 #: ../fish/guestfish-actions.pod:2905
24913 #: ../fish/guestfish-actions.pod:2907
24921 #: ../fish/guestfish-actions.pod:2911
24926 #: ../fish/guestfish-actions.pod:2913
24929 " mkdir-mode path mode\n"
24934 #: ../fish/guestfish-actions.pod:2922
24935 msgid "See also L</mkdir>, L</umask>"
24939 #: ../fish/guestfish-actions.pod:2924
24944 #: ../fish/guestfish-actions.pod:2926
24952 #: ../fish/guestfish-actions.pod:2931
24957 #: ../fish/guestfish-actions.pod:2933
24960 " mkdtemp template\n"
24965 #: ../fish/guestfish-actions.pod:2954
24970 #: ../fish/guestfish-actions.pod:2956
24973 " mke2fs-J fstype blocksize device journal\n"
24978 #: ../fish/guestfish-actions.pod:2964
24979 msgid "See also L</mke2journal>."
24983 #: ../fish/guestfish-actions.pod:2966
24988 #: ../fish/guestfish-actions.pod:2968
24991 " mke2fs-JL fstype blocksize device label\n"
24996 #: ../fish/guestfish-actions.pod:2973
24997 msgid "See also L</mke2journal-L>."
25001 #: ../fish/guestfish-actions.pod:2975
25006 #: ../fish/guestfish-actions.pod:2977
25009 " mke2fs-JU fstype blocksize device uuid\n"
25014 #: ../fish/guestfish-actions.pod:2982
25015 msgid "See also L</mke2journal-U>."
25019 #: ../fish/guestfish-actions.pod:2984
25020 msgid "mke2journal"
25024 #: ../fish/guestfish-actions.pod:2986
25027 " mke2journal blocksize device\n"
25032 #: ../fish/guestfish-actions.pod:2993
25033 msgid "mke2journal-L"
25037 #: ../fish/guestfish-actions.pod:2995
25040 " mke2journal-L blocksize label device\n"
25045 #: ../fish/guestfish-actions.pod:2999
25046 msgid "mke2journal-U"
25050 #: ../fish/guestfish-actions.pod:3001
25053 " mke2journal-U blocksize uuid device\n"
25058 #: ../fish/guestfish-actions.pod:3005
25063 #: ../fish/guestfish-actions.pod:3007
25066 " mkfifo mode path\n"
25071 #: ../fish/guestfish-actions.pod:3009
25073 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25074 "is just a convenient wrapper around L</mknod>."
25078 #: ../fish/guestfish-actions.pod:3015
25083 #: ../fish/guestfish-actions.pod:3017
25086 " mkfs fstype device\n"
25091 #: ../fish/guestfish-actions.pod:3023
25096 #: ../fish/guestfish-actions.pod:3025
25099 " mkfs-b fstype blocksize device\n"
25104 #: ../fish/guestfish-actions.pod:3027
25106 "This call is similar to L</mkfs>, but it allows you to control the block "
25107 "size of the resulting filesystem. Supported block sizes depend on the "
25108 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25112 #: ../fish/guestfish-actions.pod:3042
25117 #: ../fish/guestfish-actions.pod:3044
25120 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25125 #: ../fish/guestfish-actions.pod:3079
25126 msgid "mkmountpoint"
25130 #: ../fish/guestfish-actions.pod:3081
25133 " mkmountpoint exemptpath\n"
25138 #: ../fish/guestfish-actions.pod:3083
25140 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25141 "to create extra mountpoints before mounting the first filesystem."
25145 #: ../fish/guestfish-actions.pod:3107
25147 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25148 "unexpected errors if you try to mix these calls. It is safest to manually "
25149 "unmount filesystems and remove mountpoints after use."
25153 #: ../fish/guestfish-actions.pod:3111
25155 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25156 "for this to work for manual mountpoints, you must ensure that the innermost "
25157 "mountpoints have the longest pathnames, as in the example code above."
25161 #: ../fish/guestfish-actions.pod:3118
25163 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25164 "L</umount-all> to be called when the handle is closed which can also trigger "
25169 #: ../fish/guestfish-actions.pod:3122
25174 #: ../fish/guestfish-actions.pod:3124
25177 " mknod mode devmajor devminor path\n"
25182 #: ../fish/guestfish-actions.pod:3134
25184 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25185 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25186 "regular file). These constants are available in the standard Linux header "
25187 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25188 "wrappers around this command which bitwise OR in the appropriate constant "
25193 #: ../fish/guestfish-actions.pod:3144
25198 #: ../fish/guestfish-actions.pod:3146
25201 " mknod-b mode devmajor devminor path\n"
25206 #: ../fish/guestfish-actions.pod:3148
25208 "This call creates a block device node called C<path> with mode C<mode> and "
25209 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25210 "wrapper around L</mknod>."
25214 #: ../fish/guestfish-actions.pod:3154
25219 #: ../fish/guestfish-actions.pod:3156
25222 " mknod-c mode devmajor devminor path\n"
25227 #: ../fish/guestfish-actions.pod:3158
25229 "This call creates a char device node called C<path> with mode C<mode> and "
25230 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25231 "wrapper around L</mknod>."
25235 #: ../fish/guestfish-actions.pod:3164
25240 #: ../fish/guestfish-actions.pod:3166
25248 #: ../fish/guestfish-actions.pod:3170
25253 #: ../fish/guestfish-actions.pod:3172
25256 " mkswap-L label device\n"
25261 #: ../fish/guestfish-actions.pod:3180
25266 #: ../fish/guestfish-actions.pod:3182
25269 " mkswap-U uuid device\n"
25274 #: ../fish/guestfish-actions.pod:3186
25275 msgid "mkswap-file"
25279 #: ../fish/guestfish-actions.pod:3188
25282 " mkswap-file path\n"
25287 #: ../fish/guestfish-actions.pod:3192
25289 "This command just writes a swap file signature to an existing file. To "
25290 "create the file itself, use something like L</fallocate>."
25294 #: ../fish/guestfish-actions.pod:3195
25299 #: ../fish/guestfish-actions.pod:3197
25302 " modprobe modulename\n"
25307 #: ../fish/guestfish-actions.pod:3204
25312 #: ../fish/guestfish-actions.pod:3206
25315 " mount device mountpoint\n"
25320 #: ../fish/guestfish-actions.pod:3222
25322 "B<Important note:> When you use this call, the filesystem options C<sync> "
25323 "and C<noatime> are set implicitly. This was originally done because we "
25324 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25325 "very large negative performance impact and negligible effect on "
25326 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25327 "code that needs performance, and instead use L</mount-options> (use an empty "
25328 "string for the first parameter if you don't want any options)."
25332 #: ../fish/guestfish-actions.pod:3239
25337 #: ../fish/guestfish-actions.pod:3241
25340 " mount-9p mounttag mountpoint [options:..]\n"
25345 #: ../fish/guestfish-actions.pod:3252
25350 #: ../fish/guestfish-actions.pod:3254
25353 " mount-loop file mountpoint\n"
25358 #: ../fish/guestfish-actions.pod:3260
25359 msgid "mount-options"
25363 #: ../fish/guestfish-actions.pod:3262
25366 " mount-options options device mountpoint\n"
25371 #: ../fish/guestfish-actions.pod:3264
25373 "This is the same as the L</mount> command, but it allows you to set the "
25374 "mount options as for the L<mount(8)> I<-o> flag."
25378 #: ../fish/guestfish-actions.pod:3272
25383 #: ../fish/guestfish-actions.pod:3274
25386 " mount-ro device mountpoint\n"
25391 #: ../fish/guestfish-actions.pod:3276
25393 "This is the same as the L</mount> command, but it mounts the filesystem with "
25394 "the read-only (I<-o ro>) flag."
25398 #: ../fish/guestfish-actions.pod:3279
25403 #: ../fish/guestfish-actions.pod:3281
25406 " mount-vfs options vfstype device mountpoint\n"
25411 #: ../fish/guestfish-actions.pod:3283
25413 "This is the same as the L</mount> command, but it allows you to set both the "
25414 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25418 #: ../fish/guestfish-actions.pod:3287
25419 msgid "mountpoints"
25423 #: ../fish/guestfish-actions.pod:3289
25431 #: ../fish/guestfish-actions.pod:3291
25433 "This call is similar to L</mounts>. That call returns a list of devices. "
25434 "This one returns a hash table (map) of device name to directory where the "
25435 "device is mounted."
25439 #: ../fish/guestfish-actions.pod:3295
25444 #: ../fish/guestfish-actions.pod:3297
25452 #: ../fish/guestfish-actions.pod:3304
25453 msgid "See also: L</mountpoints>"
25457 #: ../fish/guestfish-actions.pod:3306
25462 #: ../fish/guestfish-actions.pod:3308
25470 #: ../fish/guestfish-actions.pod:3313
25471 msgid "ntfs-3g-probe"
25475 #: ../fish/guestfish-actions.pod:3315
25478 " ntfs-3g-probe true|false device\n"
25483 #: ../fish/guestfish-actions.pod:3329
25488 #: ../fish/guestfish-actions.pod:3331
25491 " ntfsresize device\n"
25496 #: ../fish/guestfish-actions.pod:3337
25497 msgid "ntfsresize-size"
25501 #: ../fish/guestfish-actions.pod:3339
25504 " ntfsresize-size device size\n"
25509 #: ../fish/guestfish-actions.pod:3341
25511 "This command is the same as L</ntfsresize> except that it allows you to "
25512 "specify the new size (in bytes) explicitly."
25516 #: ../fish/guestfish-actions.pod:3344
25521 #: ../fish/guestfish-actions.pod:3346
25524 " part-add device prlogex startsect endsect\n"
25529 #: ../fish/guestfish-actions.pod:3348
25531 "This command adds a partition to C<device>. If there is no partition table "
25532 "on the device, call L</part-init> first."
25536 #: ../fish/guestfish-actions.pod:3360
25538 "Creating a partition which covers the whole disk is not so easy. Use "
25539 "L</part-disk> to do that."
25543 #: ../fish/guestfish-actions.pod:3363
25548 #: ../fish/guestfish-actions.pod:3365
25551 " part-del device partnum\n"
25556 #: ../fish/guestfish-actions.pod:3373
25561 #: ../fish/guestfish-actions.pod:3375
25564 " part-disk device parttype\n"
25569 #: ../fish/guestfish-actions.pod:3377
25571 "This command is simply a combination of L</part-init> followed by "
25572 "L</part-add> to create a single primary partition covering the whole disk."
25576 #: ../fish/guestfish-actions.pod:3381
25578 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25579 "possible values are described in L</part-init>."
25583 #: ../fish/guestfish-actions.pod:3387
25584 msgid "part-get-bootable"
25588 #: ../fish/guestfish-actions.pod:3389
25591 " part-get-bootable device partnum\n"
25596 #: ../fish/guestfish-actions.pod:3394
25597 msgid "See also L</part-set-bootable>."
25601 #: ../fish/guestfish-actions.pod:3396
25602 msgid "part-get-mbr-id"
25606 #: ../fish/guestfish-actions.pod:3398
25609 " part-get-mbr-id device partnum\n"
25614 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3541
25616 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25617 "undefined results for other partition table types (see "
25618 "L</part-get-parttype>)."
25622 #: ../fish/guestfish-actions.pod:3407
25623 msgid "part-get-parttype"
25627 #: ../fish/guestfish-actions.pod:3409
25630 " part-get-parttype device\n"
25635 #: ../fish/guestfish-actions.pod:3414
25637 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25638 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25639 "possible, although unusual. See L</part-init> for a full list."
25643 #: ../fish/guestfish-actions.pod:3419
25648 #: ../fish/guestfish-actions.pod:3421
25651 " part-init device parttype\n"
25656 #: ../fish/guestfish-actions.pod:3427
25658 "Initially there are no partitions. Following this, you should call "
25659 "L</part-add> for each partition required."
25663 #: ../fish/guestfish-actions.pod:3490
25668 #: ../fish/guestfish-actions.pod:3492
25671 " part-list device\n"
25676 #: ../fish/guestfish-actions.pod:3507
25678 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25679 "the device's sector size, see L</blockdev-getss>."
25683 #: ../fish/guestfish-actions.pod:3520
25684 msgid "part-set-bootable"
25688 #: ../fish/guestfish-actions.pod:3522
25691 " part-set-bootable device partnum true|false\n"
25696 #: ../fish/guestfish-actions.pod:3531
25697 msgid "part-set-mbr-id"
25701 #: ../fish/guestfish-actions.pod:3533
25704 " part-set-mbr-id device partnum idbyte\n"
25709 #: ../fish/guestfish-actions.pod:3545
25710 msgid "part-set-name"
25714 #: ../fish/guestfish-actions.pod:3547
25717 " part-set-name device partnum name\n"
25722 #: ../fish/guestfish-actions.pod:3555
25723 msgid "part-to-dev"
25727 #: ../fish/guestfish-actions.pod:3557
25730 " part-to-dev partition\n"
25735 #: ../fish/guestfish-actions.pod:3563
25737 "The named partition must exist, for example as a string returned from "
25738 "L</list-partitions>."
25742 #: ../fish/guestfish-actions.pod:3566
25743 msgid "ping-daemon"
25747 #: ../fish/guestfish-actions.pod:3568
25755 #: ../fish/guestfish-actions.pod:3575
25760 #: ../fish/guestfish-actions.pod:3577
25763 " pread path count offset\n"
25768 #: ../fish/guestfish-actions.pod:3585
25769 msgid "See also L</pwrite>, L</pread-device>."
25773 #: ../fish/guestfish-actions.pod:3590
25774 msgid "pread-device"
25778 #: ../fish/guestfish-actions.pod:3592
25781 " pread-device device count offset\n"
25786 #: ../fish/guestfish-actions.pod:3600
25787 msgid "See also L</pread>."
25791 #: ../fish/guestfish-actions.pod:3605
25796 #: ../fish/guestfish-actions.pod:3607
25799 " pvcreate device\n"
25804 #: ../fish/guestfish-actions.pod:3613
25809 #: ../fish/guestfish-actions.pod:3615
25812 " pvremove device\n"
25817 #: ../fish/guestfish-actions.pod:3624
25822 #: ../fish/guestfish-actions.pod:3626
25825 " pvresize device\n"
25830 #: ../fish/guestfish-actions.pod:3631
25831 msgid "pvresize-size"
25835 #: ../fish/guestfish-actions.pod:3633
25838 " pvresize-size device size\n"
25843 #: ../fish/guestfish-actions.pod:3635
25845 "This command is the same as L</pvresize> except that it allows you to "
25846 "specify the new size (in bytes) explicitly."
25850 #: ../fish/guestfish-actions.pod:3638
25855 #: ../fish/guestfish-actions.pod:3640
25863 #: ../fish/guestfish-actions.pod:3648
25864 msgid "See also L</pvs-full>."
25868 #: ../fish/guestfish-actions.pod:3650
25873 #: ../fish/guestfish-actions.pod:3652
25881 #: ../fish/guestfish-actions.pod:3657
25886 #: ../fish/guestfish-actions.pod:3659
25894 #: ../fish/guestfish-actions.pod:3663
25899 #: ../fish/guestfish-actions.pod:3665
25902 " pwrite path content offset\n"
25907 #: ../fish/guestfish-actions.pod:3676
25908 msgid "See also L</pread>, L</pwrite-device>."
25912 #: ../fish/guestfish-actions.pod:3681
25913 msgid "pwrite-device"
25917 #: ../fish/guestfish-actions.pod:3683
25920 " pwrite-device device content offset\n"
25925 #: ../fish/guestfish-actions.pod:3693
25926 msgid "See also L</pwrite>."
25930 #: ../fish/guestfish-actions.pod:3698
25935 #: ../fish/guestfish-actions.pod:3700
25938 " read-file path\n"
25943 #: ../fish/guestfish-actions.pod:3705
25945 "Unlike L</cat>, this function can correctly handle files that contain "
25946 "embedded ASCII NUL characters. However unlike L</download>, this function "
25947 "is limited in the total size of file that can be handled."
25951 #: ../fish/guestfish-actions.pod:3713
25956 #: ../fish/guestfish-actions.pod:3715
25959 " read-lines path\n"
25964 #: ../fish/guestfish-actions.pod:3722
25966 "Note that this function cannot correctly handle binary files (specifically, "
25967 "files containing C<\\0> character which is treated as end of line). For "
25968 "those you need to use the L</read-file> function which has a more complex "
25973 #: ../fish/guestfish-actions.pod:3727
25978 #: ../fish/guestfish-actions.pod:3729
25986 #: ../fish/guestfish-actions.pod:3781
25988 "This function is primarily intended for use by programs. To get a simple "
25989 "list of names, use L</ls>. To get a printable directory for human "
25990 "consumption, use L</ll>."
25994 #: ../fish/guestfish-actions.pod:3785
25999 #: ../fish/guestfish-actions.pod:3787
26007 #: ../fish/guestfish-actions.pod:3791
26008 msgid "readlinklist"
26012 #: ../fish/guestfish-actions.pod:3793
26015 " readlinklist path 'names ...'\n"
26020 #: ../fish/guestfish-actions.pod:3817
26025 #: ../fish/guestfish-actions.pod:3819
26033 #: ../fish/guestfish-actions.pod:3824
26034 msgid "removexattr"
26038 #: ../fish/guestfish-actions.pod:3826
26041 " removexattr xattr path\n"
26046 #: ../fish/guestfish-actions.pod:3831
26047 msgid "See also: L</lremovexattr>, L<attr(5)>."
26051 #: ../fish/guestfish-actions.pod:3833
26056 #: ../fish/guestfish-actions.pod:3835
26059 " resize2fs device\n"
26064 #: ../fish/guestfish-actions.pod:3840
26066 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26067 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26068 "gives an error about this and sometimes not. In any case, it is always safe "
26069 "to call L</e2fsck-f> before calling this function."
26073 #: ../fish/guestfish-actions.pod:3846
26074 msgid "resize2fs-M"
26078 #: ../fish/guestfish-actions.pod:3848
26081 " resize2fs-M device\n"
26086 #: ../fish/guestfish-actions.pod:3850
26088 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26089 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26094 #: ../fish/guestfish-actions.pod:3854
26096 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26097 "and read the C<Block size> and C<Block count> values. These two numbers, "
26098 "multiplied together, give the resulting size of the minimal filesystem in "
26103 #: ../fish/guestfish-actions.pod:3859
26104 msgid "resize2fs-size"
26108 #: ../fish/guestfish-actions.pod:3861
26111 " resize2fs-size device size\n"
26116 #: ../fish/guestfish-actions.pod:3863
26118 "This command is the same as L</resize2fs> except that it allows you to "
26119 "specify the new size (in bytes) explicitly."
26123 #: ../fish/guestfish-actions.pod:3866
26128 #: ../fish/guestfish-actions.pod:3868
26136 #: ../fish/guestfish-actions.pod:3872
26141 #: ../fish/guestfish-actions.pod:3874
26149 #: ../fish/guestfish-actions.pod:3880
26154 #: ../fish/guestfish-actions.pod:3882
26162 #: ../fish/guestfish-actions.pod:3886
26163 msgid "rmmountpoint"
26167 #: ../fish/guestfish-actions.pod:3888
26170 " rmmountpoint exemptpath\n"
26175 #: ../fish/guestfish-actions.pod:3890
26177 "This calls removes a mountpoint that was previously created with "
26178 "L</mkmountpoint>. See L</mkmountpoint> for full details."
26182 #: ../fish/guestfish-actions.pod:3894
26183 msgid "scrub-device"
26187 #: ../fish/guestfish-actions.pod:3896
26190 " scrub-device device\n"
26195 #: ../fish/guestfish-actions.pod:3907
26200 #: ../fish/guestfish-actions.pod:3909
26203 " scrub-file file\n"
26208 #: ../fish/guestfish-actions.pod:3919
26209 msgid "scrub-freespace"
26213 #: ../fish/guestfish-actions.pod:3921
26216 " scrub-freespace dir\n"
26221 #: ../fish/guestfish-actions.pod:3923
26223 "This command creates the directory C<dir> and then fills it with files until "
26224 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26225 "deletes them. The intention is to scrub any free space on the partition "
26226 "containing C<dir>."
26230 #: ../fish/guestfish-actions.pod:3932
26235 #: ../fish/guestfish-actions.pod:3934
26240 #: ../fish/guestfish-actions.pod:3936
26243 " set-append append\n"
26248 #: ../fish/guestfish-actions.pod:3947
26249 msgid "set-attach-method"
26253 #: ../fish/guestfish-actions.pod:3949
26254 msgid "attach-method"
26258 #: ../fish/guestfish-actions.pod:3951
26261 " set-attach-method attachmethod\n"
26266 #: ../fish/guestfish-actions.pod:3973
26267 msgid "set-autosync"
26271 #: ../fish/guestfish-actions.pod:3975
26276 #: ../fish/guestfish-actions.pod:3977
26279 " set-autosync true|false\n"
26284 #: ../fish/guestfish-actions.pod:3987
26289 #: ../fish/guestfish-actions.pod:3989
26294 #: ../fish/guestfish-actions.pod:3991
26297 " set-direct true|false\n"
26302 #: ../fish/guestfish-actions.pod:3997
26304 "One consequence of this is that log messages aren't caught by the library "
26305 "and handled by L</set-log-message-callback>, but go straight to stdout."
26309 #: ../fish/guestfish-actions.pod:4006
26310 msgid "set-e2label"
26314 #: ../fish/guestfish-actions.pod:4008
26317 " set-e2label device label\n"
26322 #: ../fish/guestfish-actions.pod:4014
26324 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26325 "label on a filesystem."
26329 #: ../fish/guestfish-actions.pod:4017
26334 #: ../fish/guestfish-actions.pod:4019
26337 " set-e2uuid device uuid\n"
26342 #: ../fish/guestfish-actions.pod:4026
26344 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26345 "UUID of a filesystem."
26349 #: ../fish/guestfish-actions.pod:4029
26350 msgid "set-memsize"
26354 #: ../fish/guestfish-actions.pod:4031
26359 #: ../fish/guestfish-actions.pod:4033
26362 " set-memsize memsize\n"
26367 #: ../fish/guestfish-actions.pod:4035
26369 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26370 "This only has any effect if called before L</launch>."
26374 #: ../fish/guestfish-actions.pod:4046
26375 msgid "set-network"
26379 #: ../fish/guestfish-actions.pod:4048
26384 #: ../fish/guestfish-actions.pod:4050
26387 " set-network true|false\n"
26392 #: ../fish/guestfish-actions.pod:4058
26393 msgid "You must call this before calling L</launch>, otherwise it has no effect."
26397 #: ../fish/guestfish-actions.pod:4061
26402 #: ../fish/guestfish-actions.pod:4063
26407 #: ../fish/guestfish-actions.pod:4065
26410 " set-path searchpath\n"
26415 #: ../fish/guestfish-actions.pod:4074
26420 #: ../fish/guestfish-actions.pod:4076
26425 #: ../fish/guestfish-actions.pod:4078
26433 #: ../fish/guestfish-actions.pod:4098
26434 msgid "set-recovery-proc"
26438 #: ../fish/guestfish-actions.pod:4100
26439 msgid "recovery-proc"
26443 #: ../fish/guestfish-actions.pod:4102
26446 " set-recovery-proc true|false\n"
26451 #: ../fish/guestfish-actions.pod:4104
26453 "If this is called with the parameter C<false> then L</launch> does not "
26454 "create a recovery process. The purpose of the recovery process is to stop "
26455 "runaway qemu processes in the case where the main program aborts abruptly."
26459 #: ../fish/guestfish-actions.pod:4109
26461 "This only has any effect if called before L</launch>, and the default is "
26466 #: ../fish/guestfish-actions.pod:4118
26467 msgid "set-selinux"
26471 #: ../fish/guestfish-actions.pod:4120
26476 #: ../fish/guestfish-actions.pod:4122
26479 " set-selinux true|false\n"
26484 #: ../fish/guestfish-actions.pod:4133
26489 #: ../fish/guestfish-actions.pod:4135
26494 #: ../fish/guestfish-actions.pod:4137
26497 " set-trace true|false\n"
26502 #: ../fish/guestfish-actions.pod:4149
26504 "Trace messages are normally sent to C<stderr>, unless you register a "
26505 "callback to send them somewhere else (see L</set-event-callback>)."
26509 #: ../fish/guestfish-actions.pod:4153
26510 msgid "set-verbose"
26514 #: ../fish/guestfish-actions.pod:4155
26519 #: ../fish/guestfish-actions.pod:4157
26522 " set-verbose true|false\n"
26527 #: ../fish/guestfish-actions.pod:4164
26529 "Verbose messages are normally sent to C<stderr>, unless you register a "
26530 "callback to send them somewhere else (see L</set-event-callback>)."
26534 #: ../fish/guestfish-actions.pod:4168
26539 #: ../fish/guestfish-actions.pod:4170
26542 " setcon context\n"
26547 #: ../fish/guestfish-actions.pod:4177
26552 #: ../fish/guestfish-actions.pod:4179
26555 " setxattr xattr val vallen path\n"
26560 #: ../fish/guestfish-actions.pod:4185
26561 msgid "See also: L</lsetxattr>, L<attr(5)>."
26565 #: ../fish/guestfish-actions.pod:4187
26570 #: ../fish/guestfish-actions.pod:4189
26573 " sfdisk device cyls heads sectors 'lines ...'\n"
26578 #: ../fish/guestfish-actions.pod:4211
26579 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26583 #: ../fish/guestfish-actions.pod:4224
26588 #: ../fish/guestfish-actions.pod:4226
26591 " sfdiskM device 'lines ...'\n"
26596 #: ../fish/guestfish-actions.pod:4228
26598 "This is a simplified interface to the L</sfdisk> command, where partition "
26599 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26600 "you don't need to specify the cyls, heads and sectors parameters which were "
26601 "rarely if ever used anyway."
26605 #: ../fish/guestfish-actions.pod:4234
26606 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26610 #: ../fish/guestfish-actions.pod:4247
26615 #: ../fish/guestfish-actions.pod:4249
26618 " sfdisk-N device partnum cyls heads sectors line\n"
26623 #: ../fish/guestfish-actions.pod:4254
26625 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26626 "cyls/heads/sectors parameters."
26630 #: ../fish/guestfish-actions.pod:4257
26631 msgid "See also: L</part-add>"
26635 #: ../fish/guestfish-actions.pod:4269
26636 msgid "sfdisk-disk-geometry"
26640 #: ../fish/guestfish-actions.pod:4271
26643 " sfdisk-disk-geometry device\n"
26648 #: ../fish/guestfish-actions.pod:4273
26650 "This displays the disk geometry of C<device> read from the partition table. "
26651 "Especially in the case where the underlying block device has been resized, "
26652 "this can be different from the kernel's idea of the geometry (see "
26653 "L</sfdisk-kernel-geometry>)."
26657 #: ../fish/guestfish-actions.pod:4281
26658 msgid "sfdisk-kernel-geometry"
26662 #: ../fish/guestfish-actions.pod:4283
26665 " sfdisk-kernel-geometry device\n"
26670 #: ../fish/guestfish-actions.pod:4290
26675 #: ../fish/guestfish-actions.pod:4292
26678 " sfdisk-l device\n"
26683 #: ../fish/guestfish-actions.pod:4298
26684 msgid "See also: L</part-list>"
26688 #: ../fish/guestfish-actions.pod:4307
26693 #: ../fish/guestfish-actions.pod:4309
26701 #: ../fish/guestfish-actions.pod:4314
26702 msgid "This is like L</command>, but passes the command to:"
26706 #: ../fish/guestfish-actions.pod:4322
26707 msgid "All the provisos about L</command> apply to this call."
26711 #: ../fish/guestfish-actions.pod:4324
26716 #: ../fish/guestfish-actions.pod:4326
26719 " sh-lines command\n"
26724 #: ../fish/guestfish-actions.pod:4328
26725 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26729 #: ../fish/guestfish-actions.pod:4331
26730 msgid "See also: L</command-lines>"
26734 #: ../fish/guestfish-actions.pod:4333
26739 #: ../fish/guestfish-actions.pod:4335
26747 #: ../fish/guestfish-actions.pod:4339
26752 #: ../fish/guestfish-actions.pod:4341
26760 #: ../fish/guestfish-actions.pod:4347
26765 #: ../fish/guestfish-actions.pod:4349
26773 #: ../fish/guestfish-actions.pod:4357
26778 #: ../fish/guestfish-actions.pod:4359
26786 #: ../fish/guestfish-actions.pod:4367
26791 #: ../fish/guestfish-actions.pod:4369
26794 " strings-e encoding path\n"
26799 #: ../fish/guestfish-actions.pod:4371
26801 "This is like the L</strings> command, but allows you to specify the encoding "
26802 "of strings that are looked for in the source file C<path>."
26806 #: ../fish/guestfish-actions.pod:4381
26808 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26809 "ISO-8859-X (this is what L</strings> uses)."
26813 #: ../fish/guestfish-actions.pod:4413
26814 msgid "swapoff-device"
26818 #: ../fish/guestfish-actions.pod:4415
26821 " swapoff-device device\n"
26826 #: ../fish/guestfish-actions.pod:4417
26828 "This command disables the libguestfs appliance swap device or partition "
26829 "named C<device>. See L</swapon-device>."
26833 #: ../fish/guestfish-actions.pod:4421
26834 msgid "swapoff-file"
26838 #: ../fish/guestfish-actions.pod:4423
26841 " swapoff-file file\n"
26846 #: ../fish/guestfish-actions.pod:4427
26847 msgid "swapoff-label"
26851 #: ../fish/guestfish-actions.pod:4429
26854 " swapoff-label label\n"
26859 #: ../fish/guestfish-actions.pod:4434
26860 msgid "swapoff-uuid"
26864 #: ../fish/guestfish-actions.pod:4436
26867 " swapoff-uuid uuid\n"
26872 #: ../fish/guestfish-actions.pod:4441
26873 msgid "swapon-device"
26877 #: ../fish/guestfish-actions.pod:4443
26880 " swapon-device device\n"
26885 #: ../fish/guestfish-actions.pod:4445
26887 "This command enables the libguestfs appliance to use the swap device or "
26888 "partition named C<device>. The increased memory is made available for all "
26889 "commands, for example those run using L</command> or L</sh>."
26893 #: ../fish/guestfish-actions.pod:4457
26894 msgid "swapon-file"
26898 #: ../fish/guestfish-actions.pod:4459
26901 " swapon-file file\n"
26906 #: ../fish/guestfish-actions.pod:4461
26907 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26911 #: ../fish/guestfish-actions.pod:4464
26912 msgid "swapon-label"
26916 #: ../fish/guestfish-actions.pod:4466
26919 " swapon-label label\n"
26924 #: ../fish/guestfish-actions.pod:4468
26926 "This command enables swap to a labeled swap partition. See "
26927 "L</swapon-device> for other notes."
26931 #: ../fish/guestfish-actions.pod:4471
26932 msgid "swapon-uuid"
26936 #: ../fish/guestfish-actions.pod:4473
26939 " swapon-uuid uuid\n"
26944 #: ../fish/guestfish-actions.pod:4475
26946 "This command enables swap to a swap partition with the given UUID. See "
26947 "L</swapon-device> for other notes."
26951 #: ../fish/guestfish-actions.pod:4478
26956 #: ../fish/guestfish-actions.pod:4480
26964 #: ../fish/guestfish-actions.pod:4488
26969 #: ../fish/guestfish-actions.pod:4490
26977 #: ../fish/guestfish-actions.pod:4498
26982 #: ../fish/guestfish-actions.pod:4500
26985 " tail-n nrlines path\n"
26990 #: ../fish/guestfish-actions.pod:4513
26995 #: ../fish/guestfish-actions.pod:4515
26998 " tar-in (tarfile|-) directory\n"
27003 #: ../fish/guestfish-actions.pod:4520
27004 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27008 #: ../fish/guestfish-actions.pod:4525
27013 #: ../fish/guestfish-actions.pod:4527
27016 " tar-out directory (tarfile|-)\n"
27021 #: ../fish/guestfish-actions.pod:4532
27022 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27026 #: ../fish/guestfish-actions.pod:4537
27031 #: ../fish/guestfish-actions.pod:4539
27034 " tgz-in (tarball|-) directory\n"
27039 #: ../fish/guestfish-actions.pod:4544
27040 msgid "To upload an uncompressed tarball, use L</tar-in>."
27044 #: ../fish/guestfish-actions.pod:4548
27049 #: ../fish/guestfish-actions.pod:4550
27052 " tgz-out directory (tarball|-)\n"
27057 #: ../fish/guestfish-actions.pod:4555
27058 msgid "To download an uncompressed tarball, use L</tar-out>."
27062 #: ../fish/guestfish-actions.pod:4559
27067 #: ../fish/guestfish-actions.pod:4561
27075 #: ../fish/guestfish-actions.pod:4570
27080 #: ../fish/guestfish-actions.pod:4572
27088 #: ../fish/guestfish-actions.pod:4577
27089 msgid "truncate-size"
27093 #: ../fish/guestfish-actions.pod:4579
27096 " truncate-size path size\n"
27101 #: ../fish/guestfish-actions.pod:4584
27103 "If the current file size is less than C<size> then the file is extended to "
27104 "the required size with zero bytes. This creates a sparse file (ie. disk "
27105 "blocks are not allocated for the file until you write to it). To create a "
27106 "non-sparse file of zeroes, use L</fallocate64> instead."
27110 #: ../fish/guestfish-actions.pod:4590
27115 #: ../fish/guestfish-actions.pod:4592
27118 " tune2fs-l device\n"
27123 #: ../fish/guestfish-actions.pod:4602
27128 #: ../fish/guestfish-actions.pod:4604
27131 " txz-in (tarball|-) directory\n"
27136 #: ../fish/guestfish-actions.pod:4611
27141 #: ../fish/guestfish-actions.pod:4613
27144 " txz-out directory (tarball|-)\n"
27149 #: ../fish/guestfish-actions.pod:4620
27154 #: ../fish/guestfish-actions.pod:4622
27162 #: ../fish/guestfish-actions.pod:4636
27163 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27167 #: ../fish/guestfish-actions.pod:4641
27172 #: ../fish/guestfish-actions.pod:4643
27177 #: ../fish/guestfish-actions.pod:4645
27180 " umount pathordevice\n"
27185 #: ../fish/guestfish-actions.pod:4651
27190 #: ../fish/guestfish-actions.pod:4653
27191 msgid "unmount-all"
27195 #: ../fish/guestfish-actions.pod:4655
27203 #: ../fish/guestfish-actions.pod:4661
27208 #: ../fish/guestfish-actions.pod:4663
27211 " upload (filename|-) remotefilename\n"
27216 #: ../fish/guestfish-actions.pod:4670
27217 msgid "See also L</download>."
27221 #: ../fish/guestfish-actions.pod:4674
27222 msgid "upload-offset"
27226 #: ../fish/guestfish-actions.pod:4676
27229 " upload-offset (filename|-) remotefilename offset\n"
27234 #: ../fish/guestfish-actions.pod:4688
27236 "Note that there is no limit on the amount of data that can be uploaded with "
27237 "this call, unlike with L</pwrite>, and this call always writes the full "
27238 "amount unless an error occurs."
27242 #: ../fish/guestfish-actions.pod:4693
27243 msgid "See also L</upload>, L</pwrite>."
27247 #: ../fish/guestfish-actions.pod:4697
27252 #: ../fish/guestfish-actions.pod:4699
27255 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27260 #: ../fish/guestfish-actions.pod:4718
27265 #: ../fish/guestfish-actions.pod:4720
27273 #: ../fish/guestfish-actions.pod:4747
27275 "I<Note:> Don't use this call to test for availability of features. In "
27276 "enterprise distributions we backport features from later versions into "
27277 "earlier versions, making this an unreliable way to test for features. Use "
27278 "L</available> instead."
27282 #: ../fish/guestfish-actions.pod:4753
27287 #: ../fish/guestfish-actions.pod:4755
27290 " vfs-label device\n"
27295 #: ../fish/guestfish-actions.pod:4762
27296 msgid "To find a filesystem from the label, use L</findfs-label>."
27300 #: ../fish/guestfish-actions.pod:4764
27305 #: ../fish/guestfish-actions.pod:4766
27308 " vfs-type device\n"
27313 #: ../fish/guestfish-actions.pod:4776
27318 #: ../fish/guestfish-actions.pod:4778
27321 " vfs-uuid device\n"
27326 #: ../fish/guestfish-actions.pod:4785
27327 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27331 #: ../fish/guestfish-actions.pod:4787
27332 msgid "vg-activate"
27336 #: ../fish/guestfish-actions.pod:4789
27339 " vg-activate true|false 'volgroups ...'\n"
27344 #: ../fish/guestfish-actions.pod:4802
27345 msgid "vg-activate-all"
27349 #: ../fish/guestfish-actions.pod:4804
27352 " vg-activate-all true|false\n"
27357 #: ../fish/guestfish-actions.pod:4814
27362 #: ../fish/guestfish-actions.pod:4816
27365 " vgcreate volgroup 'physvols ...'\n"
27370 #: ../fish/guestfish-actions.pod:4821
27375 #: ../fish/guestfish-actions.pod:4823
27378 " vglvuuids vgname\n"
27383 #: ../fish/guestfish-actions.pod:4828
27385 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27386 "logical volumes and volume groups."
27390 #: ../fish/guestfish-actions.pod:4831
27391 msgid "See also L</vgpvuuids>."
27395 #: ../fish/guestfish-actions.pod:4833
27400 #: ../fish/guestfish-actions.pod:4835
27403 " vgpvuuids vgname\n"
27408 #: ../fish/guestfish-actions.pod:4840
27410 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27411 "physical volumes and volume groups."
27415 #: ../fish/guestfish-actions.pod:4843
27416 msgid "See also L</vglvuuids>."
27420 #: ../fish/guestfish-actions.pod:4845
27425 #: ../fish/guestfish-actions.pod:4847
27428 " vgremove vgname\n"
27433 #: ../fish/guestfish-actions.pod:4854
27438 #: ../fish/guestfish-actions.pod:4856
27441 " vgrename volgroup newvolgroup\n"
27446 #: ../fish/guestfish-actions.pod:4860
27451 #: ../fish/guestfish-actions.pod:4862
27459 #: ../fish/guestfish-actions.pod:4870
27460 msgid "See also L</vgs-full>."
27464 #: ../fish/guestfish-actions.pod:4872
27469 #: ../fish/guestfish-actions.pod:4874
27477 #: ../fish/guestfish-actions.pod:4879
27482 #: ../fish/guestfish-actions.pod:4881
27490 #: ../fish/guestfish-actions.pod:4886
27495 #: ../fish/guestfish-actions.pod:4888
27503 #: ../fish/guestfish-actions.pod:4892
27508 #: ../fish/guestfish-actions.pod:4894
27516 #: ../fish/guestfish-actions.pod:4899
27521 #: ../fish/guestfish-actions.pod:4901
27529 #: ../fish/guestfish-actions.pod:4906
27534 #: ../fish/guestfish-actions.pod:4908
27542 #: ../fish/guestfish-actions.pod:4913
27547 #: ../fish/guestfish-actions.pod:4915
27550 " write path content\n"
27555 #: ../fish/guestfish-actions.pod:4923
27560 #: ../fish/guestfish-actions.pod:4925
27563 " write-file path content size\n"
27568 #: ../fish/guestfish-actions.pod:4948
27573 #: ../fish/guestfish-actions.pod:4950
27576 " zegrep regex path\n"
27581 #: ../fish/guestfish-actions.pod:4958
27586 #: ../fish/guestfish-actions.pod:4960
27589 " zegrepi regex path\n"
27594 #: ../fish/guestfish-actions.pod:4968
27599 #: ../fish/guestfish-actions.pod:4970
27607 #: ../fish/guestfish-actions.pod:4978
27608 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
27612 #: ../fish/guestfish-actions.pod:4981
27613 msgid "zero-device"
27617 #: ../fish/guestfish-actions.pod:4983
27620 " zero-device device\n"
27625 #: ../fish/guestfish-actions.pod:4985
27627 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27628 "which just zeroes the first few blocks of a device."
27632 #: ../fish/guestfish-actions.pod:4992
27637 #: ../fish/guestfish-actions.pod:4994
27640 " zerofree device\n"
27645 #: ../fish/guestfish-actions.pod:5007
27650 #: ../fish/guestfish-actions.pod:5009
27653 " zfgrep pattern path\n"
27658 #: ../fish/guestfish-actions.pod:5017
27663 #: ../fish/guestfish-actions.pod:5019
27666 " zfgrepi pattern path\n"
27671 #: ../fish/guestfish-actions.pod:5027
27676 #: ../fish/guestfish-actions.pod:5029
27679 " zfile meth path\n"
27684 #: ../fish/guestfish-actions.pod:5036
27685 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
27689 #: ../fish/guestfish-actions.pod:5046
27694 #: ../fish/guestfish-actions.pod:5048
27697 " zgrep regex path\n"
27702 #: ../fish/guestfish-actions.pod:5056
27707 #: ../fish/guestfish-actions.pod:5058
27710 " zgrepi regex path\n"
27715 #: ../fish/guestfish-commands.pod:1
27720 #: ../fish/guestfish-commands.pod:3
27725 #: ../fish/guestfish-commands.pod:5
27728 " alloc filename size\n"
27733 #: ../fish/guestfish-commands.pod:7
27735 "This creates an empty (zeroed) file of the given size, and then adds so it "
27736 "can be further examined."
27740 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
27741 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27745 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
27746 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27750 #: ../fish/guestfish-commands.pod:14
27752 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27753 "image, see L</PREPARED DISK IMAGES>."
27757 #: ../fish/guestfish-commands.pod:17
27762 #: ../fish/guestfish-commands.pod:19
27765 " copy-in local [local ...] /remotedir\n"
27770 #: ../fish/guestfish-commands.pod:21
27772 "C<copy-in> copies local files or directories recursively into the disk "
27773 "image, placing them in the directory called C</remotedir> (which must "
27774 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27775 "other commands as necessary."
27779 #: ../fish/guestfish-commands.pod:26
27781 "Multiple local files and directories can be specified, but the last "
27782 "parameter must always be a remote directory. Wildcards cannot be used."
27786 #: ../fish/guestfish-commands.pod:30
27791 #: ../fish/guestfish-commands.pod:32
27794 " copy-out remote [remote ...] localdir\n"
27799 #: ../fish/guestfish-commands.pod:34
27801 "C<copy-out> copies remote files or directories recursively out of the disk "
27802 "image, placing them on the host disk in a local directory called C<localdir> "
27803 "(which must exist). This guestfish meta-command turns into a sequence of "
27804 "L</download>, L</tar-out> and other commands as necessary."
27808 #: ../fish/guestfish-commands.pod:40
27810 "Multiple remote files and directories can be specified, but the last "
27811 "parameter must always be a local directory. To download to the current "
27812 "directory, use C<.> as in:"
27816 #: ../fish/guestfish-commands.pod:44
27819 " copy-out /home .\n"
27824 #: ../fish/guestfish-commands.pod:46
27826 "Wildcards cannot be used in the ordinary command, but you can use them with "
27827 "the help of L</glob> like this:"
27831 #: ../fish/guestfish-commands.pod:49
27834 " glob copy-out /home/* .\n"
27839 #: ../fish/guestfish-commands.pod:51
27844 #: ../fish/guestfish-commands.pod:53
27847 " display filename\n"
27852 #: ../fish/guestfish-commands.pod:55
27854 "Use C<display> (a graphical display program) to display an image file. It "
27855 "downloads the file, and runs C<display> on it."
27859 #: ../fish/guestfish-commands.pod:58
27861 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
27862 "environment variable. For example to use the GNOME display program:"
27866 #: ../fish/guestfish-commands.pod:61
27869 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
27874 #: ../fish/guestfish-commands.pod:63
27875 msgid "See also L<display(1)>."
27879 #: ../fish/guestfish-commands.pod:65
27884 #: ../fish/guestfish-commands.pod:67
27887 " echo [params ...]\n"
27892 #: ../fish/guestfish-commands.pod:69
27893 msgid "This echos the parameters to the terminal."
27897 #: ../fish/guestfish-commands.pod:71
27902 #: ../fish/guestfish-commands.pod:73
27907 #: ../fish/guestfish-commands.pod:75
27912 #: ../fish/guestfish-commands.pod:77
27920 #: ../fish/guestfish-commands.pod:79
27922 "This is used to edit a file. It downloads the file, edits it locally using "
27923 "your editor, then uploads the result."
27927 #: ../fish/guestfish-commands.pod:82
27929 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27930 "or C<emacs> you will get those corresponding editors."
27934 #: ../fish/guestfish-commands.pod:86
27939 #: ../fish/guestfish-commands.pod:88
27942 " glob command args...\n"
27947 #: ../fish/guestfish-commands.pod:90
27949 "Expand wildcards in any paths in the args list, and run C<command> "
27950 "repeatedly on each matching path."
27954 #: ../fish/guestfish-commands.pod:93
27955 msgid "See L</WILDCARDS AND GLOBBING>."
27959 #: ../fish/guestfish-commands.pod:95
27964 #: ../fish/guestfish-commands.pod:97
27967 " hexedit <filename|device>\n"
27968 " hexedit <filename|device> <max>\n"
27969 " hexedit <filename|device> <start> <max>\n"
27974 #: ../fish/guestfish-commands.pod:101
27976 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27981 #: ../fish/guestfish-commands.pod:104
27983 "This command works by downloading potentially the whole file or device, "
27984 "editing it locally, then uploading it. If the file or device is large, you "
27985 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27986 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27987 "usual modifiers allowed such as C<1M> (1 megabyte)."
27991 #: ../fish/guestfish-commands.pod:111
27992 msgid "For example to edit the first few sectors of a disk you might do:"
27996 #: ../fish/guestfish-commands.pod:114
27999 " hexedit /dev/sda 1M\n"
28004 #: ../fish/guestfish-commands.pod:116
28006 "which would allow you to edit anywhere within the first megabyte of the "
28011 #: ../fish/guestfish-commands.pod:119
28012 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28016 #: ../fish/guestfish-commands.pod:121
28019 " hexedit /dev/sda1 0x400 0x400\n"
28024 #: ../fish/guestfish-commands.pod:123
28025 msgid "(assuming the superblock is in the standard location)."
28029 #: ../fish/guestfish-commands.pod:125
28031 "This command requires the external L<hexedit(1)> program. You can specify "
28032 "another program to use by setting the C<HEXEDITOR> environment variable."
28036 #: ../fish/guestfish-commands.pod:129
28037 msgid "See also L</hexdump>."
28041 #: ../fish/guestfish-commands.pod:131
28046 #: ../fish/guestfish-commands.pod:133
28054 #: ../fish/guestfish-commands.pod:135
28055 msgid "Change the local directory, ie. the current directory of guestfish itself."
28059 #: ../fish/guestfish-commands.pod:138
28060 msgid "Note that C<!cd> won't do what you might expect."
28064 #: ../fish/guestfish-commands.pod:140
28069 #: ../fish/guestfish-commands.pod:142
28074 #: ../fish/guestfish-commands.pod:144
28082 #: ../fish/guestfish-commands.pod:146
28083 msgid "Opens the manual page for guestfish."
28087 #: ../fish/guestfish-commands.pod:148
28092 #: ../fish/guestfish-commands.pod:150
28097 #: ../fish/guestfish-commands.pod:152
28105 #: ../fish/guestfish-commands.pod:154
28113 #: ../fish/guestfish-commands.pod:156
28114 msgid "This is used to view a file."
28118 #: ../fish/guestfish-commands.pod:158
28120 "The default viewer is C<$PAGER>. However if you use the alternate command "
28121 "C<less> you will get the C<less> command specifically."
28125 #: ../fish/guestfish-commands.pod:161
28130 #: ../fish/guestfish-commands.pod:163
28138 #: ../fish/guestfish-commands.pod:165
28140 "Close and reopen the libguestfs handle. It is not necessary to use this "
28141 "normally, because the handle is closed properly when guestfish exits. "
28142 "However this is occasionally useful for testing."
28146 #: ../fish/guestfish-commands.pod:169
28151 #: ../fish/guestfish-commands.pod:171
28154 " sparse filename size\n"
28159 #: ../fish/guestfish-commands.pod:173
28161 "This creates an empty sparse file of the given size, and then adds so it can "
28162 "be further examined."
28166 #: ../fish/guestfish-commands.pod:176
28168 "In all respects it works the same as the L</alloc> command, except that the "
28169 "image file is allocated sparsely, which means that disk blocks are not "
28170 "assigned to the file until they are needed. Sparse disk files only use "
28171 "space when written to, but they are slower and there is a danger you could "
28172 "run out of real disk space during a write operation."
28176 #: ../fish/guestfish-commands.pod:186
28181 #: ../fish/guestfish-commands.pod:188
28189 #: ../fish/guestfish-commands.pod:190
28191 "This command returns a list of the optional groups known to the daemon, and "
28192 "indicates which ones are supported by this build of the libguestfs "
28197 #: ../fish/guestfish-commands.pod:194
28198 msgid "See also L<guestfs(3)/AVAILABILITY>."
28202 #: ../fish/guestfish-commands.pod:196
28207 #: ../fish/guestfish-commands.pod:198
28210 " time command args...\n"
28215 #: ../fish/guestfish-commands.pod:200
28217 "Run the command as usual, but print the elapsed time afterwards. This can "
28218 "be useful for benchmarking operations."
28222 #: ../test-tool/libguestfs-test-tool.pod:5
28223 msgid "libguestfs-test-tool - End user tests for libguestfs"
28227 #: ../test-tool/libguestfs-test-tool.pod:9
28230 " libguestfs-test-tool [--options]\n"
28235 #: ../test-tool/libguestfs-test-tool.pod:13
28237 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28238 "and developers, to allow them to check basic libguestfs functionality is "
28239 "working. This is needed because libguestfs occasionally breaks for reasons "
28240 "beyond our control: usually because of changes in the underlying qemu or "
28241 "kernel packages, or the host environment."
28245 #: ../test-tool/libguestfs-test-tool.pod:20
28246 msgid "If you suspect a problem in libguestfs, then just run:"
28250 #: ../test-tool/libguestfs-test-tool.pod:22
28253 " libguestfs-test-tool\n"
28258 #: ../test-tool/libguestfs-test-tool.pod:24
28259 msgid "It will print lots of diagnostic messages."
28263 #: ../test-tool/libguestfs-test-tool.pod:26
28264 msgid "If it runs to completion successfully, you will see this near the end:"
28268 #: ../test-tool/libguestfs-test-tool.pod:28
28271 " ===== TEST FINISHED OK =====\n"
28276 #: ../test-tool/libguestfs-test-tool.pod:30
28277 msgid "and the test tool will exit with code 0."
28281 #: ../test-tool/libguestfs-test-tool.pod:32
28283 "If it fails (and/or exits with non-zero error code), please paste the "
28284 "B<complete, unedited> output of the test tool into a bug report. More "
28285 "information about reporting bugs can be found on the "
28286 "L<http://libguestfs.org/> website."
28290 #: ../test-tool/libguestfs-test-tool.pod:41
28295 #: ../test-tool/libguestfs-test-tool.pod:43
28296 msgid "Display short usage information and exit."
28300 #: ../test-tool/libguestfs-test-tool.pod:45
28301 msgid "I<--qemu qemu_binary>"
28305 #: ../test-tool/libguestfs-test-tool.pod:47
28307 "If you have downloaded another qemu binary, point this option at the full "
28308 "path of the binary to try it."
28312 #: ../test-tool/libguestfs-test-tool.pod:50
28313 msgid "I<--qemudir qemu_source_dir>"
28317 #: ../test-tool/libguestfs-test-tool.pod:52
28319 "If you have compiled qemu from source, point this option at the source "
28320 "directory to try it."
28324 #: ../test-tool/libguestfs-test-tool.pod:55
28325 msgid "I<--timeout N>"
28329 #: ../test-tool/libguestfs-test-tool.pod:57
28331 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28332 "does not usually need to be adjusted unless your machine is very slow."
28336 #: ../test-tool/libguestfs-test-tool.pod:63
28337 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28341 #: ../test-tool/libguestfs-test-tool.pod:65
28343 "If you have compiled another version of qemu from source and would like to "
28344 "try that, then you can use the I<--qemudir> option to point to the qemu "
28345 "source directory."
28349 #: ../test-tool/libguestfs-test-tool.pod:69
28351 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28352 "option to point to the binary."
28356 #: ../test-tool/libguestfs-test-tool.pod:72
28358 "When using an alternate qemu with libguestfs, usually you would need to "
28359 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
28360 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
28361 "when you use either of the I<--qemudir> or I<--qemu> options."
28365 #: ../test-tool/libguestfs-test-tool.pod:79
28367 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28368 "I<1> if there was an error."
28372 #: ../test-tool/libguestfs-test-tool.pod:84
28374 "For the full list of environment variables which may affect libguestfs, "
28375 "please see the L<guestfs(3)> manual page."
28379 #: ../test-tool/libguestfs-test-tool.pod:89
28380 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28384 #: ../fuse/guestmount.pod:5
28385 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28389 #: ../fuse/guestmount.pod:9
28392 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28397 #: ../fuse/guestmount.pod:11
28400 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28405 #: ../fuse/guestmount.pod:13
28408 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28413 #: ../fuse/guestmount.pod:17
28415 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28416 "machines. If you do this, you risk disk corruption in the VM."
28420 #: ../fuse/guestmount.pod:22
28422 "The guestmount program can be used to mount virtual machine filesystems and "
28423 "other disk images on the host. It uses libguestfs for access to the guest "
28424 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28425 "a mountable device."
28429 #: ../fuse/guestmount.pod:27
28431 "Along with other options, you have to give at least one device (I<-a> "
28432 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28433 "option) or use the I<-i> inspection option. How this works is better "
28434 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28439 #: ../fuse/guestmount.pod:33
28441 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28442 "by you, and the filesystem will not be visible to any other users unless you "
28443 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28444 "the filesystem, use the C<fusermount -u> command."
28448 #: ../fuse/guestmount.pod:41
28450 "For a typical Windows guest which has its main filesystem on the first "
28455 #: ../fuse/guestmount.pod:44
28458 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28463 #: ../fuse/guestmount.pod:46
28465 "For a typical Linux guest which has a /boot filesystem on the first "
28466 "partition, and the root filesystem on a logical volume:"
28470 #: ../fuse/guestmount.pod:49
28473 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28478 #: ../fuse/guestmount.pod:51
28479 msgid "To get libguestfs to detect guest mountpoints for you:"
28483 #: ../fuse/guestmount.pod:53
28486 " guestmount -a guest.img -i --ro /mnt\n"
28491 #: ../fuse/guestmount.pod:55
28492 msgid "For a libvirt guest called \"Guest\" you could do:"
28496 #: ../fuse/guestmount.pod:57
28499 " guestmount -d Guest -i --ro /mnt\n"
28504 #: ../fuse/guestmount.pod:59
28506 "If you don't know what filesystems are contained in a guest or disk image, "
28507 "use L<virt-filesystems(1)> first:"
28511 #: ../fuse/guestmount.pod:62
28514 " virt-filesystems MyGuest\n"
28519 #: ../fuse/guestmount.pod:64
28521 "If you want to trace the libguestfs calls but without excessive debugging "
28522 "information, we recommend:"
28526 #: ../fuse/guestmount.pod:67
28529 " guestmount [...] --trace /mnt\n"
28534 #: ../fuse/guestmount.pod:69
28535 msgid "If you want to debug the program, we recommend:"
28539 #: ../fuse/guestmount.pod:71
28542 " guestmount [...] --trace --verbose /mnt\n"
28547 #: ../fuse/guestmount.pod:73
28552 #: ../fuse/guestmount.pod:75
28553 msgid "Other users cannot see the filesystem by default"
28557 #: ../fuse/guestmount.pod:77
28559 "If you mount a filesystem as one user (eg. root), then other users will not "
28560 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28561 "option when mounting:"
28565 #: ../fuse/guestmount.pod:81
28568 " sudo guestmount [...] -o allow_other /mnt\n"
28573 #: ../fuse/guestmount.pod:87
28574 msgid "B<-a image> | B<--add image>"
28578 #: ../fuse/guestmount.pod:89
28579 msgid "Add a block device or virtual machine image."
28583 #: ../fuse/guestmount.pod:94
28584 msgid "B<-c URI> | B<--connect URI>"
28588 #: ../fuse/guestmount.pod:100
28589 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28593 #: ../fuse/guestmount.pod:108
28594 msgid "B<--dir-cache-timeout N>"
28598 #: ../fuse/guestmount.pod:110
28600 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28601 "seconds. The readdir cache [actually, there are several semi-independent "
28602 "caches] is populated after a readdir(2) call with the stat and extended "
28603 "attributes of the files in the directory, in anticipation that they will be "
28604 "requested soon after."
28608 #: ../fuse/guestmount.pod:116
28610 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28611 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28612 "requests, only cache existing ones."
28616 #: ../fuse/guestmount.pod:127
28617 msgid "B<--format=raw|qcow2|..> | B<--format>"
28621 #: ../fuse/guestmount.pod:134
28623 "If you have untrusted raw-format guest disk images, you should use this "
28624 "option to specify the disk format. This avoids a possible security problem "
28625 "with malicious guests (CVE-2010-3851). See also "
28626 "L<guestfs(3)/guestfs_add_drive_opts>."
28630 #: ../fuse/guestmount.pod:139
28631 msgid "B<--fuse-help>"
28635 #: ../fuse/guestmount.pod:141
28636 msgid "Display help on special FUSE options (see I<-o> below)."
28640 #: ../fuse/guestmount.pod:145
28641 msgid "Display brief help and exit."
28645 #: ../fuse/guestmount.pod:147
28646 msgid "B<-i> | B<--inspector>"
28650 #: ../fuse/guestmount.pod:167
28652 "Mount the named partition or logical volume on the given mountpoint B<in the "
28653 "guest> (this has nothing to do with mountpoints in the host)."
28657 #: ../fuse/guestmount.pod:170
28659 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28660 "something on C</>."
28664 #: ../fuse/guestmount.pod:183
28665 msgid "B<-n> | B<--no-sync>"
28669 #: ../fuse/guestmount.pod:185
28671 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28672 "unmounted. If you specify this option, then we don't attempt to sync the "
28673 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28677 #: ../fuse/guestmount.pod:190
28678 msgid "B<-o option> | B<--option option>"
28682 #: ../fuse/guestmount.pod:192
28683 msgid "Pass extra options to FUSE."
28687 #: ../fuse/guestmount.pod:194
28689 "To get a list of all the extra options supported by FUSE, use the command "
28690 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28691 "of them are a good idea."
28695 #: ../fuse/guestmount.pod:198
28698 " guestmount --fuse-help\n"
28703 #: ../fuse/guestmount.pod:200
28704 msgid "Some potentially useful FUSE options:"
28708 #: ../fuse/guestmount.pod:204
28709 msgid "B<-o allow_other>"
28713 #: ../fuse/guestmount.pod:206
28714 msgid "Allow other users to see the filesystem."
28718 #: ../fuse/guestmount.pod:208
28719 msgid "B<-o attr_timeout=N>"
28723 #: ../fuse/guestmount.pod:210
28724 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28728 #: ../fuse/guestmount.pod:212
28729 msgid "B<-o kernel_cache>"
28733 #: ../fuse/guestmount.pod:214
28735 "Allow the kernel to cache files (reduces the number of reads that have to go "
28736 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28737 "afford the extra memory usage."
28741 #: ../fuse/guestmount.pod:218
28742 msgid "B<-o uid=N> B<-o gid=N>"
28746 #: ../fuse/guestmount.pod:220
28748 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28749 "the chosen values."
28753 #: ../fuse/guestmount.pod:225
28754 msgid "B<-r> | B<--ro>"
28758 #: ../fuse/guestmount.pod:227
28760 "Add devices and mount everything read-only. Also disallow writes and make "
28761 "the disk appear read-only to FUSE."
28765 #: ../fuse/guestmount.pod:230
28767 "This is highly recommended if you are not going to edit the guest disk. If "
28768 "the guest is running and this option is I<not> supplied, then there is a "
28769 "strong risk of disk corruption in the guest. We try to prevent this from "
28770 "happening, but it is not always possible."
28774 #: ../fuse/guestmount.pod:235
28775 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28779 #: ../fuse/guestmount.pod:239
28780 msgid "Enable SELinux support for the guest."
28784 #: ../fuse/guestmount.pod:241
28785 msgid "B<-v> | B<--verbose>"
28789 #: ../fuse/guestmount.pod:243
28790 msgid "Enable verbose messages from underlying libguestfs."
28794 #: ../fuse/guestmount.pod:245
28795 msgid "B<-V> | B<--version>"
28799 #: ../fuse/guestmount.pod:247
28800 msgid "Display the program version and exit."
28804 #: ../fuse/guestmount.pod:249
28805 msgid "B<-w> | B<--rw>"
28809 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
28810 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28814 #: ../fuse/guestmount.pod:256
28815 msgid "B<-x> | B<--trace>"
28819 #: ../fuse/guestmount.pod:258
28820 msgid "Trace libguestfs calls and entry into each FUSE function."
28824 #: ../fuse/guestmount.pod:260
28825 msgid "This also stops the daemon from forking into the background."
28829 #: ../fuse/guestmount.pod:281
28831 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28832 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
28833 "L<http://fuse.sf.net/>."
28837 #: ../fuse/guestmount.pod:296
28838 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28842 #: ../tools/virt-win-reg.pl:37
28844 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
28849 #: ../tools/virt-win-reg.pl:41
28852 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28857 #: ../tools/virt-win-reg.pl:43
28860 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28865 #: ../tools/virt-win-reg.pl:45
28868 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28873 #: ../tools/virt-win-reg.pl:47
28876 " virt-win-reg --merge domname [input.reg ...]\n"
28881 #: ../tools/virt-win-reg.pl:49
28884 " virt-win-reg [--options] disk.img ... # instead of domname\n"
28889 #: ../tools/virt-win-reg.pl:53
28891 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
28892 "virtual machines. If you do this, you I<will> get irreversible disk "
28893 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
28894 "but doesn't catch all cases."
28898 #: ../tools/virt-win-reg.pl:58
28900 "Modifying the Windows Registry is an inherently risky operation. The format "
28901 "is deliberately obscure and undocumented, and Registry changes can leave the "
28902 "system unbootable. Therefore when using the I<--merge> option, make sure "
28903 "you have a reliable backup first."
28907 #: ../tools/virt-win-reg.pl:65
28909 "This program can export and merge Windows Registry entries from a Windows "
28914 #: ../tools/virt-win-reg.pl:68
28916 "The first parameter is the libvirt guest name or the raw disk image of a "
28921 #: ../tools/virt-win-reg.pl:71
28923 "If I<--merge> is I<not> specified, then the chosen registry key is "
28924 "displayed/exported (recursively). For example:"
28928 #: ../tools/virt-win-reg.pl:74
28931 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
28936 #: ../tools/virt-win-reg.pl:76
28937 msgid "You can also display single values from within registry keys, for example:"
28941 #: ../tools/virt-win-reg.pl:79
28944 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
28945 " $ virt-win-reg Windows7 $cvkey ProductName\n"
28946 " Windows 7 Enterprise\n"
28951 #: ../tools/virt-win-reg.pl:83
28953 "With I<--merge>, you can merge a textual regedit file into the Windows "
28958 #: ../tools/virt-win-reg.pl:86
28961 " $ virt-win-reg --merge Windows7 changes.reg\n"
28966 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
28971 #: ../tools/virt-win-reg.pl:90
28973 "This program is only meant for simple access to the registry. If you want "
28974 "to do complicated things with the registry, we suggest you download the "
28975 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
28976 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
28977 "L<hivexregedit(1)>."
28981 #: ../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
28982 msgid "Display brief help."
28986 #: ../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
28987 msgid "Display version number and exit."
28991 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
28996 #: ../tools/virt-win-reg.pl:122
28997 msgid "Enable debugging messages."
29001 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
29002 msgid "B<--connect URI> | B<-c URI>"
29006 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
29008 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29009 "to the default libvirt hypervisor."
29013 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
29015 "If you specify guest block devices directly, then libvirt is not used at "
29020 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
29021 msgid "B<--format> raw"
29025 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
29027 "Specify the format of disk images given on the command line. If this is "
29028 "omitted then the format is autodetected from the content of the disk image."
29032 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
29034 "If disk images are requested from libvirt, then this program asks libvirt "
29035 "for this information. In this case, the value of the format parameter is "
29040 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
29042 "If working with untrusted raw-format guest disk images, you should ensure "
29043 "the format is always specified."
29047 #: ../tools/virt-win-reg.pl:157
29052 #: ../tools/virt-win-reg.pl:159
29054 "In merge mode, this merges a textual regedit file into the Windows Registry "
29055 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29056 "displays or exports Registry entries instead."
29060 #: ../tools/virt-win-reg.pl:163
29062 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29063 "result in disk corruption. However exporting (without this flag) is always "
29068 #: ../tools/virt-win-reg.pl:171
29069 msgid "B<--encoding> UTF-16LE|ASCII"
29073 #: ../tools/virt-win-reg.pl:173
29075 "When merging (only), you may need to specify the encoding for strings to be "
29076 "used in the hive file. This is explained in detail in "
29077 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
29081 #: ../tools/virt-win-reg.pl:177
29083 "The default is to use UTF-16LE, which should work with recent versions of "
29088 #: ../tools/virt-win-reg.pl:184
29089 msgid "B<--unsafe-printable-strings>"
29093 #: ../tools/virt-win-reg.pl:186
29095 "When exporting (only), assume strings are UTF-16LE and print them as strings "
29096 "instead of hex sequences. Remove the final zero codepoint from strings if "
29101 #: ../tools/virt-win-reg.pl:190
29103 "This is unsafe and does not preserve the fidelity of strings in the original "
29104 "Registry for various reasons:"
29108 #: ../tools/virt-win-reg.pl:197
29110 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
29111 "other encodings will be corrupted by this transformation."
29115 #: ../tools/virt-win-reg.pl:202
29117 "Assumes that everything which has type 1 or 2 is really a string and that "
29118 "everything else is not a string, but the type field in real Registries is "
29123 #: ../tools/virt-win-reg.pl:208
29125 "Loses information about whether a zero codepoint followed the string in the "
29130 #: ../tools/virt-win-reg.pl:213
29132 "This all happens because the Registry itself contains no information about "
29133 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
29137 #: ../tools/virt-win-reg.pl:217
29139 "You should only use this option for quick hacking and debugging of the "
29140 "Registry contents, and I<never> use it if the output is going to be passed "
29141 "into another program or stored in another Registry."
29145 #: ../tools/virt-win-reg.pl:554
29146 msgid "SUPPORTED SYSTEMS"
29150 #: ../tools/virt-win-reg.pl:556
29152 "The program currently supports Windows NT-derived guests starting with "
29153 "Windows XP through to at least Windows 7."
29157 #: ../tools/virt-win-reg.pl:559
29158 msgid "The following Registry keys are supported:"
29162 #: ../tools/virt-win-reg.pl:563
29163 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
29167 #: ../tools/virt-win-reg.pl:565
29168 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
29172 #: ../tools/virt-win-reg.pl:567
29173 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
29177 #: ../tools/virt-win-reg.pl:569
29178 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
29182 #: ../tools/virt-win-reg.pl:571
29183 msgid "C<HKEY_USERS\\.DEFAULT>"
29187 #: ../tools/virt-win-reg.pl:573
29188 msgid "C<HKEY_USERS\\I<SID>>"
29192 #: ../tools/virt-win-reg.pl:575
29193 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
29197 #: ../tools/virt-win-reg.pl:577
29198 msgid "C<HKEY_USERS\\I<username>>"
29202 #: ../tools/virt-win-reg.pl:579
29203 msgid "where I<username> is a local user name (this is a libguestfs extension)."
29207 #: ../tools/virt-win-reg.pl:583
29209 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29214 #: ../tools/virt-win-reg.pl:586
29216 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
29217 "supported (there is no \"current user\")."
29221 #: ../tools/virt-win-reg.pl:589
29226 #: ../tools/virt-win-reg.pl:591
29228 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29229 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
29230 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
29231 "with Windows-style line endings, you may need to reencode the whole file "
29232 "before or after processing."
29236 #: ../tools/virt-win-reg.pl:597
29238 "To reencode a file from Windows format to Linux (before processing it with "
29239 "the I<--merge> option), you would do something like this:"
29243 #: ../tools/virt-win-reg.pl:600
29246 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29251 #: ../tools/virt-win-reg.pl:602
29253 "To go in the opposite direction, after exporting and before sending the file "
29254 "to a Windows user, do something like this:"
29258 #: ../tools/virt-win-reg.pl:605
29261 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29266 #: ../tools/virt-win-reg.pl:607
29267 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29271 #: ../tools/virt-win-reg.pl:609
29273 "If you are unsure about the current encoding, use the L<file(1)> command. "
29274 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
29275 "Windows-style (CRLF) line endings, like this:"
29279 #: ../tools/virt-win-reg.pl:613
29282 " $ file software.reg\n"
29283 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29284 " with CRLF line terminators\n"
29289 #: ../tools/virt-win-reg.pl:617
29290 msgid "This file would need conversion before you could I<--merge> it."
29294 #: ../tools/virt-win-reg.pl:619
29295 msgid "CurrentControlSet etc."
29299 #: ../tools/virt-win-reg.pl:621
29301 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29302 "Registry at the level of the hive file, and therefore you cannot modify "
29307 #: ../tools/virt-win-reg.pl:625
29309 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29310 "circumstances it might refer to another control set. The way to find out is "
29311 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29315 #: ../tools/virt-win-reg.pl:629
29318 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29319 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29320 " \"Current\"=dword:00000001\n"
29321 " \"Default\"=dword:00000001\n"
29322 " \"Failed\"=dword:00000000\n"
29323 " \"LastKnownGood\"=dword:00000002\n"
29328 #: ../tools/virt-win-reg.pl:636
29329 msgid "\"Current\" is the one which Windows will choose when it boots."
29333 #: ../tools/virt-win-reg.pl:638
29334 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
29338 #: ../tools/virt-win-reg.pl:641
29339 msgid "WINDOWS TIPS"
29343 #: ../tools/virt-win-reg.pl:643
29345 "Note that some of these tips modify the guest disk image. The guest I<must> "
29346 "be shut off, else you will get disk corruption."
29350 #: ../tools/virt-win-reg.pl:646
29351 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29355 #: ../tools/virt-win-reg.pl:648
29357 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29358 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29359 "is uploaded into C<C:\\>:"
29363 #: ../tools/virt-win-reg.pl:652
29366 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29371 #: ../tools/virt-win-reg.pl:654
29372 msgid "Prepare a regedit file containing the registry change:"
29376 #: ../tools/virt-win-reg.pl:656
29379 " cat > test.reg <<'EOF'\n"
29380 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29381 " \"Test\"=\"c:\\\\test.bat\"\n"
29387 #: ../tools/virt-win-reg.pl:661
29389 "In this example we use the key C<RunOnce> which means that the script will "
29390 "run precisely once when the first user logs in. If you want it to run every "
29391 "time a user logs in, replace C<RunOnce> with C<Run>."
29395 #: ../tools/virt-win-reg.pl:665
29396 msgid "Now update the registry:"
29400 #: ../tools/virt-win-reg.pl:667
29403 " virt-win-reg --merge WindowsGuest test.reg\n"
29408 #: ../tools/virt-win-reg.pl:669
29409 msgid "INSTALLING A SERVICE"
29413 #: ../tools/virt-win-reg.pl:671
29415 "This section assumes you are familiar with Windows services, and you either "
29416 "have a program which handles the Windows Service Control Protocol directly "
29417 "or you want to run any program using a service wrapper like SrvAny or the "
29422 #: ../tools/virt-win-reg.pl:676
29424 "First upload the program and optionally the service wrapper. In this case "
29425 "the test program is called C<test.exe> and we are using the RHSrvAny "
29430 #: ../tools/virt-win-reg.pl:680
29433 " guestfish -i -d WindowsGuest <<EOF\n"
29434 " upload rhsrvany.exe /rhsrvany.exe\n"
29435 " upload test.exe /test.exe\n"
29441 #: ../tools/virt-win-reg.pl:685
29443 "Prepare a regedit file containing the registry changes. In this example, "
29444 "the first registry change is needed for the service itself or the service "
29445 "wrapper (if used). The second registry change is only needed because I am "
29446 "using the RHSrvAny service wrapper."
29450 #: ../tools/virt-win-reg.pl:690
29453 " cat > service.reg <<'EOF'\n"
29454 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29455 " \"Type\"=dword:00000010\n"
29456 " \"Start\"=dword:00000002\n"
29457 " \"ErrorControl\"=dword:00000001\n"
29458 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29459 " \"DisplayName\"=\"RHSrvAny\"\n"
29460 " \"ObjectName\"=\"NetworkService\"\n"
29465 #: ../tools/virt-win-reg.pl:699
29468 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29469 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29470 " \"PWD\"=\"c:\\\\Temp\"\n"
29476 #: ../tools/virt-win-reg.pl:710
29478 "For use of C<ControlSet001> see the section above in this manual page. You "
29479 "may need to adjust this according to the control set that is in use by the "
29484 #: ../tools/virt-win-reg.pl:716
29486 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29487 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29488 "privileged account."
29492 #: ../tools/virt-win-reg.pl:722
29494 "For the meaning of the magic numbers, see this Microsoft KB article: "
29495 "L<http://support.microsoft.com/kb/103000>."
29499 #: ../tools/virt-win-reg.pl:727
29500 msgid "Update the registry:"
29504 #: ../tools/virt-win-reg.pl:729
29507 " virt-win-reg --merge WindowsGuest service.reg\n"
29512 #: ../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
29513 msgid "SHELL QUOTING"
29517 #: ../tools/virt-win-reg.pl:733
29519 "Be careful when passing parameters containing C<\\> (backslash) in the "
29520 "shell. Usually you will have to use 'single quotes' or double backslashes "
29521 "(but not both) to protect them from the shell."
29525 #: ../tools/virt-win-reg.pl:737
29526 msgid "Paths and value names are case-insensitive."
29530 #: ../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
29532 "Libvirt guest names can contain arbitrary characters, some of which have "
29533 "meaning to the shell such as C<#> and space. You may need to quote or "
29534 "escape these characters on the command line. See the shell manual page "
29535 "L<sh(1)> for details."
29539 #: ../tools/virt-win-reg.pl:746
29541 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29542 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29543 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29544 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29548 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
29550 "When reporting bugs, please enable debugging and capture the I<complete> "
29555 #: ../tools/virt-win-reg.pl:764
29558 " export LIBGUESTFS_DEBUG=1\n"
29559 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29564 #: ../tools/virt-win-reg.pl:767
29566 "Attach /tmp/virt-win-reg.log to a new bug report at "
29567 "L<https://bugzilla.redhat.com/>"
29571 #: ../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
29576 #: ../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
29577 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29581 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
29582 msgid "Copyright (C) 2010 Red Hat Inc."
29586 #: ../tools/virt-list-filesystems.pl:32
29587 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29591 #: ../tools/virt-list-filesystems.pl:36
29594 " virt-list-filesystems [--options] domname\n"
29599 #: ../tools/virt-list-filesystems.pl:38
29602 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29607 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29609 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29614 #: ../tools/virt-list-filesystems.pl:45
29616 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29617 "are contained in a virtual machine or disk image."
29621 #: ../tools/virt-list-filesystems.pl:49
29623 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29624 "functionality. For more complex cases you should look at the "
29625 "L<guestfish(1)> tool."
29629 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29630 msgid "B<-l> | B<--long>"
29634 #: ../tools/virt-list-filesystems.pl:108
29636 "With this option, C<virt-list-filesystems> displays the type of each "
29637 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29641 #: ../tools/virt-list-filesystems.pl:115
29642 msgid "B<-a> | B<--all>"
29646 #: ../tools/virt-list-filesystems.pl:117
29648 "Normally we only show mountable filesystems. If this option is given then "
29649 "swap devices are shown too."
29653 #: ../tools/virt-list-filesystems.pl:191
29655 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29656 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29657 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29661 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29662 msgid "Copyright (C) 2009 Red Hat Inc."
29666 #: ../tools/virt-tar.pl:33
29667 msgid "virt-tar - Extract or upload files to a virtual machine"
29671 #: ../tools/virt-tar.pl:37
29674 " virt-tar [--options] -x domname directory tarball\n"
29679 #: ../tools/virt-tar.pl:39
29682 " virt-tar [--options] -u domname tarball directory\n"
29687 #: ../tools/virt-tar.pl:41
29690 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29695 #: ../tools/virt-tar.pl:43
29698 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29703 #: ../tools/virt-tar.pl:47
29705 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29706 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29710 #: ../tools/virt-tar.pl:52
29711 msgid "Download C</home> from the VM into a local tarball:"
29715 #: ../tools/virt-tar.pl:54
29718 " virt-tar -x domname /home home.tar\n"
29723 #: ../tools/virt-tar.pl:56
29726 " virt-tar -zx domname /home home.tar.gz\n"
29731 #: ../tools/virt-tar.pl:58
29732 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29736 #: ../tools/virt-tar.pl:60
29739 " virt-tar -u domname uploadstuff.tar /tmp\n"
29744 #: ../tools/virt-tar.pl:62
29747 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29752 #: ../tools/virt-tar.pl:66
29754 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
29755 "virtual machines. If you do this, you risk disk corruption in the VM. "
29756 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29760 #: ../tools/virt-tar.pl:71
29762 "You can use I<-x> (extract) on live virtual machines, but you might get "
29763 "inconsistent results or errors if there is filesystem activity inside the "
29764 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29765 "work, but the only way to guarantee consistent results is if the virtual "
29766 "machine is shut down."
29770 #: ../tools/virt-tar.pl:79
29772 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29773 "parts of a guest filesystem. There are many possibilities: making backups, "
29774 "uploading data files, snooping on guest activity, fixing or customizing "
29779 #: ../tools/virt-tar.pl:84
29781 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29782 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29783 "should look at the L<guestfish(1)> tool."
29787 #: ../tools/virt-tar.pl:88
29789 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
29790 "its contents (recursively) from the virtual machine into a local tarball. "
29791 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
29792 "virtual machine. You cannot use these two options together."
29796 #: ../tools/virt-tar.pl:94
29798 "In addition, you may need to use the I<-z> (gZip) option to enable "
29799 "compression. When uploading, you have to specify I<-z> if the upload file "
29800 "is compressed because virt-tar won't detect this on its own."
29804 #: ../tools/virt-tar.pl:98
29806 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29807 "example it cannot do PKZip files or bzip2 compression. If you want that "
29808 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29809 "the L<libguestfs(3)> API)."
29813 #: ../tools/virt-tar.pl:156
29814 msgid "B<-x> | B<--extract> | B<--download>"
29818 #: ../tools/virt-tar.pl:158
29819 msgid "B<-u> | B<--upload>"
29823 #: ../tools/virt-tar.pl:160
29825 "Use I<-x> to extract (download) a directory from a virtual machine to a "
29830 #: ../tools/virt-tar.pl:163
29832 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
29833 "Please read the L</WARNING> section above before using this option."
29837 #: ../tools/virt-tar.pl:167
29838 msgid "You must specify exactly one of these options."
29842 #: ../tools/virt-tar.pl:173
29843 msgid "B<-z> | B<--gzip>"
29847 #: ../tools/virt-tar.pl:175
29848 msgid "Specify that the input or output tarball is gzip-compressed."
29852 #: ../tools/virt-tar.pl:288
29854 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29855 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29856 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29857 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29861 #: ../tools/virt-make-fs.pl:37
29862 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29866 #: ../tools/virt-make-fs.pl:41
29869 " virt-make-fs [--options] input.tar output.img\n"
29874 #: ../tools/virt-make-fs.pl:43
29877 " virt-make-fs [--options] input.tar.gz output.img\n"
29882 #: ../tools/virt-make-fs.pl:45
29885 " virt-make-fs [--options] directory output.img\n"
29890 #: ../tools/virt-make-fs.pl:49
29892 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29893 "archive or some files in a directory. It is similar to tools like "
29894 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29895 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29896 "useful if you want to attach these filesystems to existing virtual machines "
29897 "(eg. to import large amounts of read-only data to a VM)."
29901 #: ../tools/virt-make-fs.pl:57
29902 msgid "Basic usage is:"
29906 #: ../tools/virt-make-fs.pl:59
29909 " virt-make-fs input output\n"
29914 #: ../tools/virt-make-fs.pl:61
29916 "where C<input> is either a directory containing files that you want to add, "
29917 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29918 "C<output> is a disk image. The input type is detected automatically. The "
29919 "output disk image defaults to a raw ext2 image unless you specify extra "
29920 "flags (see L</OPTIONS> below)."
29924 #: ../tools/virt-make-fs.pl:67
29925 msgid "EXTRA SPACE"
29929 #: ../tools/virt-make-fs.pl:69
29931 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29932 "the files that it contains, but might have extra space. Depending on how "
29933 "you are going to use the output, you might think this extra space is wasted "
29934 "and want to minimize it, or you might want to leave space so that more files "
29935 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29936 "but you can use the I<--size> flag to leave space in the filesystem if you "
29941 #: ../tools/virt-make-fs.pl:77
29943 "An alternative way to leave extra space but not make the output image any "
29944 "bigger is to use an alternative disk image format (instead of the default "
29945 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
29946 "image format (check your hypervisor supports this before using it). This "
29947 "allows you to choose a large I<--size> but the extra space won't actually be "
29948 "allocated in the image until you try to store something in it."
29952 #: ../tools/virt-make-fs.pl:85
29954 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29955 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29956 "to build another image from scratch."
29960 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29965 #: ../tools/virt-make-fs.pl:91
29968 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29973 #: ../tools/virt-make-fs.pl:93
29974 msgid "FILESYSTEM TYPE"
29978 #: ../tools/virt-make-fs.pl:95
29980 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29981 "libguestfs supports can be used (but I<not> read-only formats like "
29982 "ISO9660). Here are some of the more common choices:"
29986 #: ../tools/virt-make-fs.pl:101
29991 #: ../tools/virt-make-fs.pl:103
29993 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29994 "you are not going to use the filesystem in a way that requires the journal, "
29995 "then this is just wasted overhead."
29999 #: ../tools/virt-make-fs.pl:107
30000 msgid "I<ntfs> or I<vfat>"
30004 #: ../tools/virt-make-fs.pl:109
30005 msgid "Useful if exporting data to a Windows guest."
30009 #: ../tools/virt-make-fs.pl:111
30011 "I<Note for vfat>: The tar archive or local directory must only contain files "
30012 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30013 "program running within libguestfs is unable to change the ownership of "
30014 "non-root files, since vfat itself does not support this."
30018 #: ../tools/virt-make-fs.pl:116
30023 #: ../tools/virt-make-fs.pl:118
30025 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30026 "total filesystem size."
30030 #: ../tools/virt-make-fs.pl:125
30033 " virt-make-fs --type=minix input minixfs.img\n"
30038 #: ../tools/virt-make-fs.pl:127
30039 msgid "TO PARTITION OR NOT TO PARTITION"
30043 #: ../tools/virt-make-fs.pl:129
30044 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30048 #: ../tools/virt-make-fs.pl:131
30050 "Adding a partition can make the disk image more compatible with certain "
30051 "virtualized operating systems which don't expect to see a filesystem "
30052 "directly located on a block device (Linux doesn't care and will happily "
30053 "handle both types)."
30057 #: ../tools/virt-make-fs.pl:136
30059 "On the other hand, if you have a partition table then the output image is no "
30060 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30061 "directly on a partitioned disk image. (However libguestfs tools such as "
30062 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30066 #: ../tools/virt-make-fs.pl:144
30067 msgid "Add an MBR partition:"
30071 #: ../tools/virt-make-fs.pl:146
30074 " virt-make-fs --partition -- input disk.img\n"
30079 #: ../tools/virt-make-fs.pl:148
30081 "If the output disk image could be terabyte-sized or larger, it's better to "
30082 "use an EFI/GPT-compatible partition table:"
30086 #: ../tools/virt-make-fs.pl:151
30089 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30094 #: ../tools/virt-make-fs.pl:179
30095 msgid "Enable debugging information."
30099 #: ../tools/virt-make-fs.pl:185
30100 msgid "B<--size=E<lt>NE<gt>>"
30104 #: ../tools/virt-make-fs.pl:187
30105 msgid "B<--size=+E<lt>NE<gt>>"
30109 #: ../tools/virt-make-fs.pl:189
30110 msgid "B<-s E<lt>NE<gt>>"
30114 #: ../tools/virt-make-fs.pl:191
30115 msgid "B<-s +E<lt>NE<gt>>"
30119 #: ../tools/virt-make-fs.pl:193
30120 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30124 #: ../tools/virt-make-fs.pl:196
30126 "If this option is I<not> given, then the output image will be just large "
30127 "enough to contain all the files, with not much wasted space."
30131 #: ../tools/virt-make-fs.pl:199
30133 "To choose a fixed size output disk, specify an absolute number followed by "
30134 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30135 "Petabytes or Exabytes. This must be large enough to contain all the input "
30136 "files, else you will get an error."
30140 #: ../tools/virt-make-fs.pl:204
30142 "To leave extra space, specify C<+> (plus sign) and a number followed by "
30143 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30144 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30145 "the input files, and (approximately) an extra 200 MB free space."
30149 #: ../tools/virt-make-fs.pl:210
30151 "Note that virt-make-fs estimates free space, and therefore will not produce "
30152 "filesystems containing precisely the free space requested. (It is much more "
30153 "expensive and time-consuming to produce a filesystem which has precisely the "
30154 "desired free space)."
30158 #: ../tools/virt-make-fs.pl:219
30159 msgid "B<--format=E<lt>fmtE<gt>>"
30163 #: ../tools/virt-make-fs.pl:221
30164 msgid "B<-F E<lt>fmtE<gt>>"
30168 #: ../tools/virt-make-fs.pl:223
30169 msgid "Choose the output disk image format."
30173 #: ../tools/virt-make-fs.pl:225
30174 msgid "The default is C<raw> (raw disk image)."
30178 #: ../tools/virt-make-fs.pl:227
30180 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30181 "that would really make sense here is C<qcow2>."
30185 #: ../tools/virt-make-fs.pl:234
30186 msgid "B<--type=E<lt>fsE<gt>>"
30190 #: ../tools/virt-make-fs.pl:236
30191 msgid "B<-t E<lt>fsE<gt>>"
30195 #: ../tools/virt-make-fs.pl:238
30196 msgid "Choose the output filesystem type."
30200 #: ../tools/virt-make-fs.pl:240
30201 msgid "The default is C<ext2>."
30205 #: ../tools/virt-make-fs.pl:242
30206 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30210 #: ../tools/virt-make-fs.pl:249
30211 msgid "B<--partition>"
30215 #: ../tools/virt-make-fs.pl:251
30216 msgid "B<--partition=E<lt>parttypeE<gt>>"
30220 #: ../tools/virt-make-fs.pl:253
30222 "If specified, this flag adds an MBR partition table to the output disk "
30227 #: ../tools/virt-make-fs.pl:256
30229 "You can change the partition table type, eg. I<--partition=gpt> for large "
30234 #: ../tools/virt-make-fs.pl:259
30236 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30237 "might consider the next parameter to be the partition type. For example:"
30241 #: ../tools/virt-make-fs.pl:263
30244 " virt-make-fs --partition input.tar ...\n"
30249 #: ../tools/virt-make-fs.pl:265
30251 "would cause virt-make-fs to think you wanted to use a partition type of "
30252 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30253 "dash) between options and the input file argument:"
30257 #: ../tools/virt-make-fs.pl:269
30260 " virt-make-fs --partition -- input.tar ...\n"
30265 #: ../tools/virt-make-fs.pl:541
30267 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30268 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30269 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30273 #: ../tools/virt-make-fs.pl:558
30276 " export LIBGUESTFS_DEBUG=1\n"
30277 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30282 #: ../tools/virt-make-fs.pl:561
30284 "Attach /tmp/virt-make-fs.log to a new bug report at "
30285 "L<https://bugzilla.redhat.com/>"
30289 #: ../tools/virt-list-partitions.pl:32
30290 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
30294 #: ../tools/virt-list-partitions.pl:36
30297 " virt-list-partitions [--options] domname\n"
30302 #: ../tools/virt-list-partitions.pl:38
30305 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30310 #: ../tools/virt-list-partitions.pl:45
30312 "C<virt-list-partitions> is a command line tool to list the partitions that "
30313 "are contained in a virtual machine or disk image. It is mainly useful as a "
30314 "first step to using L<virt-resize(1)>."
30318 #: ../tools/virt-list-partitions.pl:50
30320 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30321 "functionality. For more complex cases you should look at the "
30322 "L<guestfish(1)> tool."
30326 #: ../tools/virt-list-partitions.pl:107
30327 msgid "B<-h> | B<--human-readable>"
30331 #: ../tools/virt-list-partitions.pl:109
30332 msgid "Show sizes in human-readable form (eg. \"1G\")."
30336 #: ../tools/virt-list-partitions.pl:117
30338 "With this option, C<virt-list-partitions> displays the type and size of each "
30339 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30343 #: ../tools/virt-list-partitions.pl:124
30344 msgid "B<-t> | B<--total>"
30348 #: ../tools/virt-list-partitions.pl:126
30349 msgid "Display the total size of each block device (as a separate row or rows)."
30353 #: ../tools/virt-list-partitions.pl:259
30355 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
30356 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
30357 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30361 #: ../tools/virt-list-partitions.pl:275
30362 msgid "Copyright (C) 2009-2010 Red Hat Inc."