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.17\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-07-14 14:07+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:1660 ../src/guestfs-actions.pod:1664 ../src/guestfs-actions.pod:1668 ../src/guestfs-actions.pod:1672 ../src/guestfs-actions.pod:1680 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1688 ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1702 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1844 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1853 ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1919 ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1928 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2874 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1099 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1127 ../fish/guestfish-actions.pod:1137 ../fish/guestfish-actions.pod:1141 ../fish/guestfish-actions.pod:1145 ../fish/guestfish-actions.pod:1235 ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1244 ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1291 ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1927 ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1941 ../fish/guestfish-actions.pod:1948 ../fish/guestfish-actions.pod:1955 ../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:1915 ../src/guestfs-actions.pod:2842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287 ../fish/guestfish-actions.pod:1923 ../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:6163 ../fish/guestfish-actions.pod:4066
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:858 ../src/guestfs-actions.pod:1039 ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1302 ../src/guestfs-actions.pod:1333 ../src/guestfs-actions.pod:1358 ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:1506 ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:2328 ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2533 ../src/guestfs-actions.pod:2568 ../src/guestfs-actions.pod:3608 ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:3851 ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3929 ../src/guestfs-actions.pod:4001 ../src/guestfs-actions.pod:4021 ../src/guestfs-actions.pod:4038 ../src/guestfs-actions.pod:4061 ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:4119 ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4240 ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4301 ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4414 ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4514 ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4575 ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4610 ../src/guestfs-actions.pod:4680 ../src/guestfs-actions.pod:4753 ../src/guestfs-actions.pod:4784 ../src/guestfs-actions.pod:4803 ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:4834 ../src/guestfs-actions.pod:4851 ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4879 ../src/guestfs-actions.pod:4894 ../src/guestfs-actions.pod:4929 ../src/guestfs-actions.pod:4962 ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:5101 ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5201 ../src/guestfs-actions.pod:5237 ../src/guestfs-actions.pod:5272 ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5441 ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5520 ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5570 ../src/guestfs-actions.pod:5636 ../src/guestfs-actions.pod:5653 ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:5680 ../src/guestfs-actions.pod:5969 ../src/guestfs-actions.pod:5988 ../src/guestfs-actions.pod:6007 ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6033 ../src/guestfs-actions.pod:6047 ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:6089 ../src/guestfs-actions.pod:6110 ../src/guestfs-actions.pod:6129 ../src/guestfs-actions.pod:6148 ../src/guestfs-actions.pod:6178 ../src/guestfs-actions.pod:6196 ../src/guestfs-actions.pod:6219 ../src/guestfs-actions.pod:6237 ../src/guestfs-actions.pod:6256 ../src/guestfs-actions.pod:6277 ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6313 ../src/guestfs-actions.pod:6341 ../src/guestfs-actions.pod:6365 ../src/guestfs-actions.pod:6384 ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6461 ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6561 ../src/guestfs-actions.pod:6683 ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6816 ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6864 ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:6890 ../src/guestfs-actions.pod:6903 ../src/guestfs-actions.pod:6918 ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:6994 ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7026 ../src/guestfs-actions.pod:7043 ../src/guestfs-actions.pod:7056 ../src/guestfs-actions.pod:7076 ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7126 ../src/guestfs-actions.pod:7167 ../src/guestfs-actions.pod:7180 ../src/guestfs-actions.pod:7198 ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7268 ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7468 ../src/guestfs-actions.pod:7481 ../src/guestfs-actions.pod:7526 ../src/guestfs-actions.pod:7559 ../src/guestfs-actions.pod:7620 ../src/guestfs-actions.pod:7646 ../src/guestfs-actions.pod:7713 ../src/guestfs-actions.pod:7732 ../src/guestfs-actions.pod:7761
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:1511 ../src/guestfs-actions.pod:2006 ../src/guestfs-actions.pod:2027 ../src/guestfs-actions.pod:4615 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5242 ../src/guestfs-actions.pod:6506 ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6569 ../src/guestfs-actions.pod:6628 ../src/guestfs-actions.pod:7564 ../src/guestfs-actions.pod:7654 ../src/guestfs-actions.pod:7824 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:1346 ../fish/guestfish-actions.pod:1360 ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3286 ../fish/guestfish-actions.pod:3400 ../fish/guestfish-actions.pod:3448 ../fish/guestfish-actions.pod:4328 ../fish/guestfish-actions.pod:4351 ../fish/guestfish-actions.pod:4373 ../fish/guestfish-actions.pod:4411 ../fish/guestfish-actions.pod:5046 ../fish/guestfish-actions.pod:5144
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:1163 ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3630 ../src/guestfs-actions.pod:4938 ../src/guestfs-actions.pod:6198 ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:7045 ../src/guestfs-actions.pod:7568
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:832 ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:4629 ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:5165
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:1378 ../src/guestfs-actions.pod:1734 ../src/guestfs-actions.pod:1937 ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2088 ../src/guestfs-actions.pod:2143 ../src/guestfs-actions.pod:2166 ../src/guestfs-actions.pod:2459 ../src/guestfs-actions.pod:2931 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:5124 ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:7153 ../src/guestfs-actions.pod:7579 ../src/guestfs-actions.pod:7592 ../src/guestfs-actions.pod:7605
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:869 ../src/guestfs-actions.pod:880 ../src/guestfs-actions.pod:2897 ../src/guestfs-actions.pod:2909 ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:4976 ../src/guestfs-actions.pod:4988 ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5225
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:4642 ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3090
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:2418
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:2168
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:5827
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:920 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1117 ../src/guestfs-actions.pod:1247 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:1605 ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:1880 ../src/guestfs-actions.pod:1897 ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2021 ../src/guestfs-actions.pod:2191 ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2587 ../src/guestfs-actions.pod:2677 ../src/guestfs-actions.pod:2781 ../src/guestfs-actions.pod:2800 ../src/guestfs-actions.pod:3014 ../src/guestfs-actions.pod:3042 ../src/guestfs-actions.pod:3063 ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3176 ../src/guestfs-actions.pod:3196 ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:4176 ../src/guestfs-actions.pod:4346 ../src/guestfs-actions.pod:4456 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5555 ../src/guestfs-actions.pod:5725 ../src/guestfs-actions.pod:5903 ../src/guestfs-actions.pod:5952 ../src/guestfs-actions.pod:6589 ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6622 ../src/guestfs-actions.pod:6653 ../src/guestfs-actions.pod:7327 ../src/guestfs-actions.pod:7346 ../src/guestfs-actions.pod:7364 ../src/guestfs-actions.pod:7538 ../src/guestfs-actions.pod:7818
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:1136 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1451 ../src/guestfs-actions.pod:1554 ../src/guestfs-actions.pod:1573 ../src/guestfs-actions.pod:1819 ../src/guestfs-actions.pod:2263 ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2341 ../src/guestfs-actions.pod:2365 ../src/guestfs-actions.pod:2436 ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:2742 ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3392 ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:3743 ../src/guestfs-actions.pod:3805 ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:4318 ../src/guestfs-actions.pod:5085 ../src/guestfs-actions.pod:5697 ../src/guestfs-actions.pod:5823 ../src/guestfs-actions.pod:5937 ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6730 ../src/guestfs-actions.pod:6785 ../src/guestfs-actions.pod:6931 ../src/guestfs-actions.pod:6955 ../src/guestfs-actions.pod:7431 ../src/guestfs-actions.pod:7451 ../src/guestfs-actions.pod:7498 ../src/guestfs-actions.pod:7670 ../src/guestfs-actions.pod:7689 ../src/guestfs-actions.pod:7775 ../src/guestfs-actions.pod:7794 ../src/guestfs-actions.pod:7840 ../src/guestfs-actions.pod:7859
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:1061 ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1489 ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3501 ../src/guestfs-actions.pod:4159 ../src/guestfs-actions.pod:4209 ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4592 ../src/guestfs-actions.pod:5089 ../src/guestfs-actions.pod:5638 ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6061 ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:7169 ../src/guestfs-actions.pod:7182 ../src/guestfs-actions.pod:7415 ../src/guestfs-actions.pod:7658
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:1234
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:1472 ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:1987 ../src/guestfs-actions.pod:2059 ../src/guestfs-actions.pod:2114 ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2177 ../src/guestfs-actions.pod:3213 ../src/guestfs-actions.pod:3229 ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:3423 ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3499 ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3570 ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:5326
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_btrfs_filesystem_resize"
7173 #: ../src/guestfs-actions.pod:827
7177 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
7178 " const char *mountpoint,\n"
7184 #: ../src/guestfs-actions.pod:837
7187 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
7192 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:549
7193 msgid "This command resizes a btrfs filesystem."
7197 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:551
7199 "Note that unlike other resize calls, the filesystem has to be mounted and "
7200 "the parameter is the mountpoint not the device (this is a requirement of "
7205 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5176 ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3411
7206 msgid "The optional parameters are:"
7210 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3415
7215 #: ../src/guestfs-actions.pod:851 ../fish/guestfish-actions.pod:561
7217 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
7218 "resized to the maximum size."
7222 #: ../src/guestfs-actions.pod:856 ../fish/guestfish-actions.pod:566
7223 msgid "See also L<btrfs(8)>."
7227 #: ../src/guestfs-actions.pod:860
7228 msgid "guestfs_btrfs_filesystem_resize_va"
7232 #: ../src/guestfs-actions.pod:862
7236 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
7237 " const char *mountpoint,\n"
7243 #: ../src/guestfs-actions.pod:867
7244 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
7248 #: ../src/guestfs-actions.pod:871
7249 msgid "guestfs_btrfs_filesystem_resize_argv"
7253 #: ../src/guestfs-actions.pod:873
7257 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
7258 " const char *mountpoint,\n"
7260 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
7265 #: ../src/guestfs-actions.pod:878
7266 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
7270 #: ../src/guestfs-actions.pod:882
7271 msgid "guestfs_case_sensitive_path"
7275 #: ../src/guestfs-actions.pod:884
7279 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7280 " const char *path);\n"
7285 #: ../src/guestfs-actions.pod:888 ../fish/guestfish-actions.pod:574
7287 "This can be used to resolve case insensitive paths on a filesystem which is "
7288 "case sensitive. The use case is to resolve paths which you have read from "
7289 "Windows configuration files or the Windows Registry, to the true path."
7293 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:579
7295 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7296 "(and probably others), which is that although the underlying filesystem is "
7297 "case-insensitive, the driver exports the filesystem to Linux as "
7302 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:584
7304 "One consequence of this is that special directories such as C<c:\\windows> "
7305 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7306 "precise details of how they were created. In Windows itself this would not "
7311 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:590
7313 "Bug or feature? You decide: "
7314 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7318 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:593
7320 "This function resolves the true case of each element in the path and returns "
7321 "the case-sensitive path."
7325 #: ../src/guestfs-actions.pod:910
7327 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7328 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7329 "how the directories were originally created under Windows)."
7333 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:601
7334 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7338 #: ../src/guestfs-actions.pod:918
7339 msgid "See also C<guestfs_realpath>."
7343 #: ../src/guestfs-actions.pod:923 ../src/guestfs-actions.pod:7349
7344 msgid "(Added in 1.0.75)"
7348 #: ../src/guestfs-actions.pod:925
7353 #: ../src/guestfs-actions.pod:927
7357 " guestfs_cat (guestfs_h *g,\n"
7358 " const char *path);\n"
7363 #: ../src/guestfs-actions.pod:931 ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3825
7364 msgid "Return the contents of the file named C<path>."
7368 #: ../src/guestfs-actions.pod:933
7370 "Note that this function cannot correctly handle binary files (specifically, "
7371 "files containing C<\\0> character which is treated as end of string). For "
7372 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7373 "functions which have a more complex interface."
7377 #: ../src/guestfs-actions.pod:941 ../src/guestfs-actions.pod:1120 ../src/guestfs-actions.pod:1140 ../src/guestfs-actions.pod:1436 ../src/guestfs-actions.pod:1455 ../src/guestfs-actions.pod:1558 ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2302 ../src/guestfs-actions.pod:2345 ../src/guestfs-actions.pod:2369 ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:5595 ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5778 ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:6734 ../src/guestfs-actions.pod:6789 ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:7622 ../src/guestfs-actions.pod:7648 ../src/guestfs-actions.pod:7674 ../src/guestfs-actions.pod:7693 ../src/guestfs-actions.pod:7779 ../src/guestfs-actions.pod:7798 ../src/guestfs-actions.pod:7844 ../src/guestfs-actions.pod:7863 ../fish/guestfish-actions.pod:617 ../fish/guestfish-actions.pod:752 ../fish/guestfish-actions.pod:764 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:1017 ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1520 ../fish/guestfish-actions.pod:1530 ../fish/guestfish-actions.pod:1558 ../fish/guestfish-actions.pod:1573 ../fish/guestfish-actions.pod:1583 ../fish/guestfish-actions.pod:1602 ../fish/guestfish-actions.pod:3695 ../fish/guestfish-actions.pod:3710 ../fish/guestfish-actions.pod:3786 ../fish/guestfish-actions.pod:3803 ../fish/guestfish-actions.pod:3818 ../fish/guestfish-actions.pod:4472 ../fish/guestfish-actions.pod:4518 ../fish/guestfish-actions.pod:4603 ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:5022 ../fish/guestfish-actions.pod:5040 ../fish/guestfish-actions.pod:5057 ../fish/guestfish-actions.pod:5067 ../fish/guestfish-actions.pod:5116 ../fish/guestfish-actions.pod:5126 ../fish/guestfish-actions.pod:5155 ../fish/guestfish-actions.pod:5165
7379 "Because of the message protocol, there is a transfer limit of somewhere "
7380 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7384 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3809 ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3914 ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:5715 ../src/guestfs-actions.pod:7502 ../src/guestfs-actions.pod:7516
7385 msgid "(Added in 0.4)"
7389 #: ../src/guestfs-actions.pod:946
7390 msgid "guestfs_checksum"
7394 #: ../src/guestfs-actions.pod:948
7398 " guestfs_checksum (guestfs_h *g,\n"
7399 " const char *csumtype,\n"
7400 " const char *path);\n"
7405 #: ../src/guestfs-actions.pod:953 ../fish/guestfish-actions.pod:624
7406 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7410 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:627
7412 "The type of checksum to compute is given by the C<csumtype> parameter which "
7413 "must have one of the following values:"
7417 #: ../src/guestfs-actions.pod:961 ../fish/guestfish-actions.pod:632
7422 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:634
7424 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7429 #: ../src/guestfs-actions.pod:966 ../fish/guestfish-actions.pod:637
7434 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:639
7435 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7439 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:641
7444 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:643
7445 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7449 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:645
7454 #: ../src/guestfs-actions.pod:976 ../fish/guestfish-actions.pod:647
7455 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7459 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:649
7464 #: ../src/guestfs-actions.pod:980 ../fish/guestfish-actions.pod:651
7465 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7469 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:653
7474 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:655
7475 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7479 #: ../src/guestfs-actions.pod:986 ../fish/guestfish-actions.pod:657
7484 #: ../src/guestfs-actions.pod:988 ../fish/guestfish-actions.pod:659
7485 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7489 #: ../src/guestfs-actions.pod:992 ../fish/guestfish-actions.pod:663
7490 msgid "The checksum is returned as a printable string."
7494 #: ../src/guestfs-actions.pod:994
7495 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7499 #: ../src/guestfs-actions.pod:996
7500 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7504 #: ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2145 ../src/guestfs-actions.pod:3425 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:7205
7505 msgid "(Added in 1.0.2)"
7509 #: ../src/guestfs-actions.pod:1003
7510 msgid "guestfs_checksum_device"
7514 #: ../src/guestfs-actions.pod:1005
7518 " guestfs_checksum_device (guestfs_h *g,\n"
7519 " const char *csumtype,\n"
7520 " const char *device);\n"
7525 #: ../src/guestfs-actions.pod:1010
7527 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7528 "device named C<device>. For the types of checksums supported see the "
7529 "C<guestfs_checksum> command."
7533 #: ../src/guestfs-actions.pod:1017 ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5328 ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7128 ../src/guestfs-actions.pod:7528
7534 msgid "(Added in 1.3.2)"
7538 #: ../src/guestfs-actions.pod:1019
7539 msgid "guestfs_checksums_out"
7543 #: ../src/guestfs-actions.pod:1021
7547 " guestfs_checksums_out (guestfs_h *g,\n"
7548 " const char *csumtype,\n"
7549 " const char *directory,\n"
7550 " const char *sumsfile);\n"
7555 #: ../src/guestfs-actions.pod:1027 ../fish/guestfish-actions.pod:681
7557 "This command computes the checksums of all regular files in C<directory> and "
7558 "then emits a list of those checksums to the local output file C<sumsfile>."
7562 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:685
7564 "This can be used for verifying the integrity of a virtual machine. However "
7565 "to be properly secure you should pay attention to the output of the checksum "
7566 "command (it uses the ones from GNU coreutils). In particular when the "
7567 "filename is not printable, coreutils uses a special backslash syntax. For "
7568 "more information, see the GNU coreutils info file."
7572 #: ../src/guestfs-actions.pod:1041
7573 msgid "(Added in 1.3.7)"
7577 #: ../src/guestfs-actions.pod:1043
7578 msgid "guestfs_chmod"
7582 #: ../src/guestfs-actions.pod:1045
7586 " guestfs_chmod (guestfs_h *g,\n"
7588 " const char *path);\n"
7593 #: ../src/guestfs-actions.pod:1050 ../fish/guestfish-actions.pod:699
7595 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7600 #: ../src/guestfs-actions.pod:1053 ../fish/guestfish-actions.pod:702
7602 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7603 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7608 #: ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:4573 ../src/guestfs-actions.pod:4782 ../src/guestfs-actions.pod:4801 ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:706 ../fish/guestfish-actions.pod:3054 ../fish/guestfish-actions.pod:3193 ../fish/guestfish-actions.pod:3203 ../fish/guestfish-actions.pod:3213
7609 msgid "The mode actually set is affected by the umask."
7613 #: ../src/guestfs-actions.pod:1063
7614 msgid "guestfs_chown"
7618 #: ../src/guestfs-actions.pod:1065
7622 " guestfs_chown (guestfs_h *g,\n"
7625 " const char *path);\n"
7630 #: ../src/guestfs-actions.pod:1071 ../fish/guestfish-actions.pod:712
7631 msgid "Change the file owner to C<owner> and group to C<group>."
7635 #: ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2489
7637 "Only numeric uid and gid are supported. If you want to use names, you will "
7638 "need to locate and parse the password file yourself (Augeas support makes "
7639 "this relatively easy)."
7643 #: ../src/guestfs-actions.pod:1081
7644 msgid "guestfs_command"
7648 #: ../src/guestfs-actions.pod:1083
7652 " guestfs_command (guestfs_h *g,\n"
7653 " char *const *arguments);\n"
7658 #: ../src/guestfs-actions.pod:1087 ../fish/guestfish-actions.pod:722
7660 "This call runs a command from the guest filesystem. The filesystem must be "
7661 "mounted, and must contain a compatible operating system (ie. something "
7662 "Linux, with the same or compatible processor architecture)."
7666 #: ../src/guestfs-actions.pod:1092
7668 "The single parameter is an argv-style list of arguments. The first element "
7669 "is the name of the program to run. Subsequent elements are parameters. The "
7670 "list must be non-empty (ie. must contain a program name). Note that the "
7671 "command runs directly, and is I<not> invoked via the shell (see "
7676 #: ../src/guestfs-actions.pod:1099 ../fish/guestfish-actions.pod:734
7677 msgid "The return value is anything printed to I<stdout> by the command."
7681 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:737
7683 "If the command returns a non-zero exit status, then this function returns an "
7684 "error message. The error message string is the content of I<stderr> from "
7689 #: ../src/guestfs-actions.pod:1106 ../fish/guestfish-actions.pod:741
7691 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7692 "C</bin>. If you require a program from another location, you should provide "
7693 "the full path in the first parameter."
7697 #: ../src/guestfs-actions.pod:1111 ../fish/guestfish-actions.pod:746
7699 "Shared libraries and data files required by the program must be available on "
7700 "filesystems which are mounted in the correct places. It is the caller's "
7701 "responsibility to ensure all filesystems that are needed are mounted at the "
7706 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1608
7707 msgid "(Added in 0.9.1)"
7711 #: ../src/guestfs-actions.pod:1125
7712 msgid "guestfs_command_lines"
7716 #: ../src/guestfs-actions.pod:1127
7720 " guestfs_command_lines (guestfs_h *g,\n"
7721 " char *const *arguments);\n"
7726 #: ../src/guestfs-actions.pod:1131
7728 "This is the same as C<guestfs_command>, but splits the result into a list of "
7733 #: ../src/guestfs-actions.pod:1134
7734 msgid "See also: C<guestfs_sh_lines>"
7738 #: ../src/guestfs-actions.pod:1145
7739 msgid "guestfs_config"
7743 #: ../src/guestfs-actions.pod:1147
7747 " guestfs_config (guestfs_h *g,\n"
7748 " const char *qemuparam,\n"
7749 " const char *qemuvalue);\n"
7754 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
7756 "This can be used to add arbitrary qemu command line parameters of the form "
7757 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7758 "setting some parameters which would interfere with parameters that we use."
7762 #: ../src/guestfs-actions.pod:1157 ../fish/guestfish-actions.pod:776
7763 msgid "The first character of C<param> string must be a C<-> (dash)."
7767 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:778
7768 msgid "C<value> can be NULL."
7772 #: ../src/guestfs-actions.pod:1165
7773 msgid "guestfs_copy_size"
7777 #: ../src/guestfs-actions.pod:1167
7781 " guestfs_copy_size (guestfs_h *g,\n"
7782 " const char *src,\n"
7783 " const char *dest,\n"
7789 #: ../src/guestfs-actions.pod:1173 ../fish/guestfish-actions.pod:784
7791 "This command copies exactly C<size> bytes from one source device or file "
7792 "C<src> to another destination device or file C<dest>."
7796 #: ../src/guestfs-actions.pod:1176 ../fish/guestfish-actions.pod:787
7798 "Note this will fail if the source is too short or if the destination is not "
7803 #: ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1304 ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1380 ../src/guestfs-actions.pod:1757 ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:7200 ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7715 ../src/guestfs-actions.pod:7734
7805 "This long-running command can generate progress notification messages so "
7806 "that the caller can display a progress bar or indicator. To receive these "
7807 "messages, the caller must register a progress event callback. See "
7808 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7812 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:7435 ../src/guestfs-actions.pod:7455 ../src/guestfs-actions.pod:7541
7813 msgid "(Added in 1.0.87)"
7817 #: ../src/guestfs-actions.pod:1188
7822 #: ../src/guestfs-actions.pod:1190
7826 " guestfs_cp (guestfs_h *g,\n"
7827 " const char *src,\n"
7828 " const char *dest);\n"
7833 #: ../src/guestfs-actions.pod:1195 ../fish/guestfish-actions.pod:794
7835 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7836 "destination filename or destination directory."
7840 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1286 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:5103 ../src/guestfs-actions.pod:5572
7841 msgid "(Added in 1.0.18)"
7845 #: ../src/guestfs-actions.pod:1202
7846 msgid "guestfs_cp_a"
7850 #: ../src/guestfs-actions.pod:1204
7854 " guestfs_cp_a (guestfs_h *g,\n"
7855 " const char *src,\n"
7856 " const char *dest);\n"
7861 #: ../src/guestfs-actions.pod:1209 ../fish/guestfish-actions.pod:801
7863 "This copies a file or directory from C<src> to C<dest> recursively using the "
7868 #: ../src/guestfs-actions.pod:1216
7873 #: ../src/guestfs-actions.pod:1218
7877 " guestfs_dd (guestfs_h *g,\n"
7878 " const char *src,\n"
7879 " const char *dest);\n"
7884 #: ../src/guestfs-actions.pod:1223 ../fish/guestfish-actions.pod:808
7886 "This command copies from one source device or file C<src> to another "
7887 "destination device or file C<dest>. Normally you would use this to copy to "
7888 "or from a device or partition, for example to duplicate a filesystem."
7892 #: ../src/guestfs-actions.pod:1228
7894 "If the destination is a device, it must be as large or larger than the "
7895 "source file or device, otherwise the copy will fail. This command cannot do "
7896 "partial copies (see C<guestfs_copy_size>)."
7900 #: ../src/guestfs-actions.pod:1236
7905 #: ../src/guestfs-actions.pod:1238
7909 " guestfs_df (guestfs_h *g);\n"
7914 #: ../src/guestfs-actions.pod:1241 ../fish/guestfish-actions.pod:821
7915 msgid "This command runs the C<df> command to report disk space used."
7919 #: ../src/guestfs-actions.pod:1243 ../src/guestfs-actions.pod:1260
7921 "This command is mostly useful for interactive sessions. It is I<not> "
7922 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7927 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267 ../src/guestfs-actions.pod:1385 ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:2372 ../src/guestfs-actions.pod:2440 ../src/guestfs-actions.pod:4459 ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:6938 ../src/guestfs-actions.pod:6962 ../src/guestfs-actions.pod:7581 ../src/guestfs-actions.pod:7594 ../src/guestfs-actions.pod:7607
7928 msgid "(Added in 1.0.54)"
7932 #: ../src/guestfs-actions.pod:1252
7933 msgid "guestfs_df_h"
7937 #: ../src/guestfs-actions.pod:1254
7941 " guestfs_df_h (guestfs_h *g);\n"
7946 #: ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:831
7948 "This command runs the C<df -h> command to report disk space used in "
7949 "human-readable format."
7953 #: ../src/guestfs-actions.pod:1269
7954 msgid "guestfs_dmesg"
7958 #: ../src/guestfs-actions.pod:1271
7962 " guestfs_dmesg (guestfs_h *g);\n"
7967 #: ../src/guestfs-actions.pod:1274 ../fish/guestfish-actions.pod:842
7969 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7970 "This is sometimes useful for extended debugging of problems."
7974 #: ../src/guestfs-actions.pod:1278
7976 "Another way to get the same information is to enable verbose messages with "
7977 "C<guestfs_set_verbose> or by setting the environment variable "
7978 "C<LIBGUESTFS_DEBUG=1> before running the program."
7982 #: ../src/guestfs-actions.pod:1288
7983 msgid "guestfs_download"
7987 #: ../src/guestfs-actions.pod:1290
7991 " guestfs_download (guestfs_h *g,\n"
7992 " const char *remotefilename,\n"
7993 " const char *filename);\n"
7998 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1320 ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
8000 "Download file C<remotefilename> and save it as C<filename> on the local "
8005 #: ../src/guestfs-actions.pod:1298 ../src/guestfs-actions.pod:7194 ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4776
8006 msgid "C<filename> can also be a named pipe."
8010 #: ../src/guestfs-actions.pod:1300
8011 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8015 #: ../src/guestfs-actions.pod:1311
8016 msgid "guestfs_download_offset"
8020 #: ../src/guestfs-actions.pod:1313
8024 " guestfs_download_offset (guestfs_h *g,\n"
8025 " const char *remotefilename,\n"
8026 " const char *filename,\n"
8027 " int64_t offset,\n"
8033 #: ../src/guestfs-actions.pod:1323 ../fish/guestfish-actions.pod:871
8035 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8036 "region must be within the file or device)."
8040 #: ../src/guestfs-actions.pod:1326
8042 "Note that there is no limit on the amount of data that can be downloaded "
8043 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8044 "full amount unless an error occurs."
8048 #: ../src/guestfs-actions.pod:1331
8049 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8053 #: ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:7239
8054 msgid "(Added in 1.5.17)"
8058 #: ../src/guestfs-actions.pod:1342
8059 msgid "guestfs_drop_caches"
8063 #: ../src/guestfs-actions.pod:1344
8067 " guestfs_drop_caches (guestfs_h *g,\n"
8068 " int whattodrop);\n"
8073 #: ../src/guestfs-actions.pod:1348 ../fish/guestfish-actions.pod:887
8075 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8076 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8077 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8081 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:892
8082 msgid "Setting C<whattodrop> to 3 should drop everything."
8086 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:894
8088 "This automatically calls L<sync(2)> before the operation, so that the "
8089 "maximum guest memory is freed."
8093 #: ../src/guestfs-actions.pod:1362
8098 #: ../src/guestfs-actions.pod:1364
8102 " guestfs_du (guestfs_h *g,\n"
8103 " const char *path);\n"
8108 #: ../src/guestfs-actions.pod:1368 ../fish/guestfish-actions.pod:901
8110 "This command runs the C<du -s> command to estimate file space usage for "
8115 #: ../src/guestfs-actions.pod:1371 ../fish/guestfish-actions.pod:904
8117 "C<path> can be a file or a directory. If C<path> is a directory then the "
8118 "estimate includes the contents of the directory and all subdirectories "
8123 #: ../src/guestfs-actions.pod:1375 ../fish/guestfish-actions.pod:908
8124 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8128 #: ../src/guestfs-actions.pod:1387
8129 msgid "guestfs_e2fsck_f"
8133 #: ../src/guestfs-actions.pod:1389
8137 " guestfs_e2fsck_f (guestfs_h *g,\n"
8138 " const char *device);\n"
8143 #: ../src/guestfs-actions.pod:1393 ../fish/guestfish-actions.pod:915
8145 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8146 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8151 #: ../src/guestfs-actions.pod:1397
8153 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8154 "Normally you should use C<guestfs_fsck>."
8158 #: ../src/guestfs-actions.pod:1402
8159 msgid "(Added in 1.0.29)"
8163 #: ../src/guestfs-actions.pod:1404
8164 msgid "guestfs_echo_daemon"
8168 #: ../src/guestfs-actions.pod:1406
8172 " guestfs_echo_daemon (guestfs_h *g,\n"
8173 " char *const *words);\n"
8178 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:926
8180 "This command concatenates the list of C<words> passed with single spaces "
8181 "between them and returns the resulting string."
8185 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:929
8186 msgid "You can use this command to test the connection through to the daemon."
8190 #: ../src/guestfs-actions.pod:1415
8191 msgid "See also C<guestfs_ping_daemon>."
8195 #: ../src/guestfs-actions.pod:1420 ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:6410
8196 msgid "(Added in 1.0.69)"
8200 #: ../src/guestfs-actions.pod:1422
8201 msgid "guestfs_egrep"
8205 #: ../src/guestfs-actions.pod:1424
8209 " guestfs_egrep (guestfs_h *g,\n"
8210 " const char *regex,\n"
8211 " const char *path);\n"
8216 #: ../src/guestfs-actions.pod:1429 ../fish/guestfish-actions.pod:937
8217 msgid "This calls the external C<egrep> program and returns the matching lines."
8221 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1515 ../src/guestfs-actions.pod:1561 ../src/guestfs-actions.pod:1580 ../src/guestfs-actions.pod:2286 ../src/guestfs-actions.pod:2305 ../src/guestfs-actions.pod:2461 ../src/guestfs-actions.pod:2474 ../src/guestfs-actions.pod:2489 ../src/guestfs-actions.pod:2535 ../src/guestfs-actions.pod:2557 ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:3839 ../src/guestfs-actions.pod:3853 ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:4881 ../src/guestfs-actions.pod:5906 ../src/guestfs-actions.pod:5955 ../src/guestfs-actions.pod:6806 ../src/guestfs-actions.pod:6818 ../src/guestfs-actions.pod:6831 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6866 ../src/guestfs-actions.pod:6879 ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6905 ../src/guestfs-actions.pod:7677 ../src/guestfs-actions.pod:7696 ../src/guestfs-actions.pod:7782 ../src/guestfs-actions.pod:7801 ../src/guestfs-actions.pod:7847 ../src/guestfs-actions.pod:7866
8222 msgid "(Added in 1.0.66)"
8226 #: ../src/guestfs-actions.pod:1441
8227 msgid "guestfs_egrepi"
8231 #: ../src/guestfs-actions.pod:1443
8235 " guestfs_egrepi (guestfs_h *g,\n"
8236 " const char *regex,\n"
8237 " const char *path);\n"
8242 #: ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:947
8243 msgid "This calls the external C<egrep -i> program and returns the matching lines."
8247 #: ../src/guestfs-actions.pod:1460
8248 msgid "guestfs_equal"
8252 #: ../src/guestfs-actions.pod:1462
8256 " guestfs_equal (guestfs_h *g,\n"
8257 " const char *file1,\n"
8258 " const char *file2);\n"
8263 #: ../src/guestfs-actions.pod:1467 ../fish/guestfish-actions.pod:957
8265 "This compares the two files C<file1> and C<file2> and returns true if their "
8266 "content is exactly equal, or false otherwise."
8270 #: ../src/guestfs-actions.pod:1470 ../fish/guestfish-actions.pod:960
8271 msgid "The external L<cmp(1)> program is used for the comparison."
8275 #: ../src/guestfs-actions.pod:1476
8276 msgid "guestfs_exists"
8280 #: ../src/guestfs-actions.pod:1478
8284 " guestfs_exists (guestfs_h *g,\n"
8285 " const char *path);\n"
8290 #: ../src/guestfs-actions.pod:1482 ../fish/guestfish-actions.pod:966
8292 "This returns C<true> if and only if there is a file, directory (or anything) "
8293 "with the given C<path> name."
8297 #: ../src/guestfs-actions.pod:1485
8298 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8302 #: ../src/guestfs-actions.pod:1491
8303 msgid "guestfs_fallocate"
8307 #: ../src/guestfs-actions.pod:1493
8311 " guestfs_fallocate (guestfs_h *g,\n"
8312 " const char *path,\n"
8318 #: ../src/guestfs-actions.pod:1498 ../src/guestfs-actions.pod:1524 ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
8320 "This command preallocates a file (containing zero bytes) named C<path> of "
8321 "size C<len> bytes. If the file exists already, it is overwritten."
8325 #: ../src/guestfs-actions.pod:1502 ../fish/guestfish-actions.pod:979
8327 "Do not confuse this with the guestfish-specific C<alloc> command which "
8328 "allocates a file in the host and attaches it as a device."
8332 #: ../src/guestfs-actions.pod:1508 ../fish/guestfish-actions.pod:983
8334 "This function is deprecated. In new code, use the C<fallocate64> call "
8339 #: ../src/guestfs-actions.pod:1517
8340 msgid "guestfs_fallocate64"
8344 #: ../src/guestfs-actions.pod:1519
8348 " guestfs_fallocate64 (guestfs_h *g,\n"
8349 " const char *path,\n"
8355 #: ../src/guestfs-actions.pod:1528
8357 "Note that this call allocates disk blocks for the file. To create a sparse "
8358 "file use C<guestfs_truncate_size> instead."
8362 #: ../src/guestfs-actions.pod:1531
8364 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8365 "oversight it only allowed 30 bit lengths to be specified, effectively "
8366 "limiting the maximum size of files created through that call to 1GB."
8370 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1006
8372 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8373 "commands which create a file in the host and attach it as a device."
8377 #: ../src/guestfs-actions.pod:1542
8378 msgid "(Added in 1.3.17)"
8382 #: ../src/guestfs-actions.pod:1544
8383 msgid "guestfs_fgrep"
8387 #: ../src/guestfs-actions.pod:1546
8391 " guestfs_fgrep (guestfs_h *g,\n"
8392 " const char *pattern,\n"
8393 " const char *path);\n"
8398 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1014
8399 msgid "This calls the external C<fgrep> program and returns the matching lines."
8403 #: ../src/guestfs-actions.pod:1563
8404 msgid "guestfs_fgrepi"
8408 #: ../src/guestfs-actions.pod:1565
8412 " guestfs_fgrepi (guestfs_h *g,\n"
8413 " const char *pattern,\n"
8414 " const char *path);\n"
8419 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1024
8420 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8424 #: ../src/guestfs-actions.pod:1582
8425 msgid "guestfs_file"
8429 #: ../src/guestfs-actions.pod:1584
8433 " guestfs_file (guestfs_h *g,\n"
8434 " const char *path);\n"
8439 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1034
8441 "This call uses the standard L<file(1)> command to determine the type or "
8442 "contents of the file."
8446 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1037
8448 "This call will also transparently look inside various types of compressed "
8453 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1040
8455 "The exact command which runs is C<file -zb path>. Note in particular that "
8456 "the filename is not prepended to the output (the I<-b> option)."
8460 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1044
8462 "The output depends on the output of the underlying L<file(1)> command and it "
8463 "can change in future in ways beyond our control. In other words, the output "
8464 "is not guaranteed by the ABI."
8468 #: ../src/guestfs-actions.pod:1602
8470 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8471 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8475 #: ../src/guestfs-actions.pod:1610
8476 msgid "guestfs_file_architecture"
8480 #: ../src/guestfs-actions.pod:1612
8484 " guestfs_file_architecture (guestfs_h *g,\n"
8485 " const char *filename);\n"
8490 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1055
8492 "This detects the architecture of the binary C<filename>, and returns it if "
8497 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1058
8498 msgid "Currently defined architectures are:"
8502 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1062
8507 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1064
8509 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8510 "irrespective of the precise processor requirements of the binary."
8514 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1067
8519 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1069
8520 msgid "64 bit x86-64."
8524 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1071
8529 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1073
8530 msgid "32 bit SPARC."
8534 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1075
8539 #: ../src/guestfs-actions.pod:1638 ../fish/guestfish-actions.pod:1077
8540 msgid "64 bit SPARC V9 and above."
8544 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1079
8549 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1081
8550 msgid "Intel Itanium."
8554 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1083
8559 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1085
8560 msgid "32 bit Power PC."
8564 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1087
8569 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1089
8570 msgid "64 bit Power PC."
8574 #: ../src/guestfs-actions.pod:1654 ../fish/guestfish-actions.pod:1093
8575 msgid "Libguestfs may return other architecture strings in future."
8579 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1095
8580 msgid "The function works on at least the following types of files:"
8584 #: ../src/guestfs-actions.pod:1662 ../fish/guestfish-actions.pod:1101
8585 msgid "many types of Un*x and Linux binary"
8589 #: ../src/guestfs-actions.pod:1666 ../fish/guestfish-actions.pod:1105
8590 msgid "many types of Un*x and Linux shared library"
8594 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1109
8595 msgid "Windows Win32 and Win64 binaries"
8599 #: ../src/guestfs-actions.pod:1674 ../fish/guestfish-actions.pod:1113
8600 msgid "Windows Win32 and Win64 DLLs"
8604 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1115
8605 msgid "Win32 binaries and DLLs return C<i386>."
8609 #: ../src/guestfs-actions.pod:1678 ../fish/guestfish-actions.pod:1117
8610 msgid "Win64 binaries and DLLs return C<x86_64>."
8614 #: ../src/guestfs-actions.pod:1682 ../fish/guestfish-actions.pod:1121
8615 msgid "Linux kernel modules"
8619 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1125
8620 msgid "Linux new-style initrd images"
8624 #: ../src/guestfs-actions.pod:1690 ../fish/guestfish-actions.pod:1129
8625 msgid "some non-x86 Linux vmlinuz kernels"
8629 #: ../src/guestfs-actions.pod:1694 ../fish/guestfish-actions.pod:1133
8630 msgid "What it can't do currently:"
8634 #: ../src/guestfs-actions.pod:1700 ../fish/guestfish-actions.pod:1139
8635 msgid "static libraries (libfoo.a)"
8639 #: ../src/guestfs-actions.pod:1704 ../fish/guestfish-actions.pod:1143
8640 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8644 #: ../src/guestfs-actions.pod:1708 ../fish/guestfish-actions.pod:1147
8645 msgid "x86 Linux vmlinuz kernels"
8649 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1149
8651 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8652 "compressed code, and are horribly hard to unpack. If you want to find the "
8653 "architecture of a kernel, use the architecture of the associated initrd or "
8654 "kernel module(s) instead."
8658 #: ../src/guestfs-actions.pod:1720 ../src/guestfs-actions.pod:1883 ../src/guestfs-actions.pod:1900 ../src/guestfs-actions.pod:2590 ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2933 ../src/guestfs-actions.pod:2951 ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3066 ../src/guestfs-actions.pod:3159 ../src/guestfs-actions.pod:3396 ../src/guestfs-actions.pod:3528
8659 msgid "(Added in 1.5.3)"
8663 #: ../src/guestfs-actions.pod:1722
8664 msgid "guestfs_filesize"
8668 #: ../src/guestfs-actions.pod:1724
8672 " guestfs_filesize (guestfs_h *g,\n"
8673 " const char *file);\n"
8678 #: ../src/guestfs-actions.pod:1728 ../fish/guestfish-actions.pod:1160
8679 msgid "This command returns the size of C<file> in bytes."
8683 #: ../src/guestfs-actions.pod:1730
8685 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8686 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8687 "devices, use C<guestfs_blockdev_getsize64>."
8691 #: ../src/guestfs-actions.pod:1736
8692 msgid "(Added in 1.0.82)"
8696 #: ../src/guestfs-actions.pod:1738
8697 msgid "guestfs_fill"
8701 #: ../src/guestfs-actions.pod:1740
8705 " guestfs_fill (guestfs_h *g,\n"
8708 " const char *path);\n"
8713 #: ../src/guestfs-actions.pod:1746 ../fish/guestfish-actions.pod:1170
8715 "This command creates a new file called C<path>. The initial content of the "
8716 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8721 #: ../src/guestfs-actions.pod:1750
8723 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8724 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8725 "bytes use C<guestfs_fill_pattern>."
8729 #: ../src/guestfs-actions.pod:1762
8730 msgid "(Added in 1.0.79)"
8734 #: ../src/guestfs-actions.pod:1764
8735 msgid "guestfs_fill_pattern"
8739 #: ../src/guestfs-actions.pod:1766
8743 " guestfs_fill_pattern (guestfs_h *g,\n"
8744 " const char *pattern,\n"
8746 " const char *path);\n"
8751 #: ../src/guestfs-actions.pod:1772
8753 "This function is like C<guestfs_fill> except that it creates a new file of "
8754 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8755 "pattern is truncated if necessary to ensure the length of the file is "
8756 "exactly C<len> bytes."
8760 #: ../src/guestfs-actions.pod:1784
8761 msgid "(Added in 1.3.12)"
8765 #: ../src/guestfs-actions.pod:1786
8766 msgid "guestfs_find"
8770 #: ../src/guestfs-actions.pod:1788
8774 " guestfs_find (guestfs_h *g,\n"
8775 " const char *directory);\n"
8780 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1192
8782 "This command lists out all files and directories, recursively, starting at "
8783 "C<directory>. It is essentially equivalent to running the shell command "
8784 "C<find directory -print> but some post-processing happens on the output, "
8789 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1197
8791 "This returns a list of strings I<without any prefix>. Thus if the directory "
8796 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1200
8806 #: ../src/guestfs-actions.pod:1804
8807 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8811 #: ../src/guestfs-actions.pod:1807 ../fish/guestfish-actions.pod:1207
8822 #: ../src/guestfs-actions.pod:1812 ../fish/guestfish-actions.pod:1212
8823 msgid "If C<directory> is not a directory, then this command returns an error."
8827 #: ../src/guestfs-actions.pod:1815 ../fish/guestfish-actions.pod:1215
8828 msgid "The returned list is sorted."
8832 #: ../src/guestfs-actions.pod:1817
8833 msgid "See also C<guestfs_find0>."
8837 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:4286 ../src/guestfs-actions.pod:5990
8838 msgid "(Added in 1.0.27)"
8842 #: ../src/guestfs-actions.pod:1828
8843 msgid "guestfs_find0"
8847 #: ../src/guestfs-actions.pod:1830
8851 " guestfs_find0 (guestfs_h *g,\n"
8852 " const char *directory,\n"
8853 " const char *files);\n"
8858 #: ../src/guestfs-actions.pod:1835 ../fish/guestfish-actions.pod:1226
8860 "This command lists out all files and directories, recursively, starting at "
8861 "C<directory>, placing the resulting list in the external file called "
8866 #: ../src/guestfs-actions.pod:1839
8868 "This command works the same way as C<guestfs_find> with the following "
8873 #: ../src/guestfs-actions.pod:1846 ../fish/guestfish-actions.pod:1237
8874 msgid "The resulting list is written to an external file."
8878 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1241
8880 "Items (filenames) in the result are separated by C<\\0> characters. See "
8881 "L<find(1)> option I<-print0>."
8885 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1246
8886 msgid "This command is not limited in the number of names that it can return."
8890 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1251
8891 msgid "The result list is not sorted."
8895 #: ../src/guestfs-actions.pod:1866
8896 msgid "(Added in 1.0.74)"
8900 #: ../src/guestfs-actions.pod:1868
8901 msgid "guestfs_findfs_label"
8905 #: ../src/guestfs-actions.pod:1870
8909 " guestfs_findfs_label (guestfs_h *g,\n"
8910 " const char *label);\n"
8915 #: ../src/guestfs-actions.pod:1874 ../fish/guestfish-actions.pod:1261
8917 "This command searches the filesystems and returns the one which has the "
8918 "given label. An error is returned if no such filesystem can be found."
8922 #: ../src/guestfs-actions.pod:1878
8923 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8927 #: ../src/guestfs-actions.pod:1885
8928 msgid "guestfs_findfs_uuid"
8932 #: ../src/guestfs-actions.pod:1887
8936 " guestfs_findfs_uuid (guestfs_h *g,\n"
8937 " const char *uuid);\n"
8942 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1271
8944 "This command searches the filesystems and returns the one which has the "
8945 "given UUID. An error is returned if no such filesystem can be found."
8949 #: ../src/guestfs-actions.pod:1895
8950 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8954 #: ../src/guestfs-actions.pod:1902
8955 msgid "guestfs_fsck"
8959 #: ../src/guestfs-actions.pod:1904
8963 " guestfs_fsck (guestfs_h *g,\n"
8964 " const char *fstype,\n"
8965 " const char *device);\n"
8970 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1281
8972 "This runs the filesystem checker (fsck) on C<device> which should have "
8973 "filesystem type C<fstype>."
8977 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1284
8979 "The returned integer is the status. See L<fsck(8)> for the list of status "
8980 "codes from C<fsck>."
8984 #: ../src/guestfs-actions.pod:1921 ../fish/guestfish-actions.pod:1293
8985 msgid "Multiple status codes can be summed together."
8989 #: ../src/guestfs-actions.pod:1925 ../fish/guestfish-actions.pod:1297
8991 "A non-zero return code can mean \"success\", for example if errors have been "
8992 "corrected on the filesystem."
8996 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1302
8997 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9001 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1307
9002 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9006 #: ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:7720
9007 msgid "(Added in 1.0.16)"
9011 #: ../src/guestfs-actions.pod:1941
9012 msgid "guestfs_get_append"
9016 #: ../src/guestfs-actions.pod:1943
9020 " guestfs_get_append (guestfs_h *g);\n"
9025 #: ../src/guestfs-actions.pod:1946 ../fish/guestfish-actions.pod:1313
9027 "Return the additional kernel options which are added to the guest kernel "
9032 #: ../src/guestfs-actions.pod:1949 ../fish/guestfish-actions.pod:1316
9033 msgid "If C<NULL> then no options are added."
9037 #: ../src/guestfs-actions.pod:1951
9039 "This function returns a string which may be NULL. There is no way to return "
9040 "an error from this function. The string is owned by the guest handle and "
9041 "must I<not> be freed."
9045 #: ../src/guestfs-actions.pod:1955 ../src/guestfs-actions.pod:5668 ../src/guestfs-actions.pod:6150 ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6608 ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:7386 ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7763
9046 msgid "(Added in 1.0.26)"
9050 #: ../src/guestfs-actions.pod:1957
9051 msgid "guestfs_get_attach_method"
9055 #: ../src/guestfs-actions.pod:1959
9059 " guestfs_get_attach_method (guestfs_h *g);\n"
9064 #: ../src/guestfs-actions.pod:1962
9065 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9069 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:6180
9070 msgid "(Added in 1.9.8)"
9074 #: ../src/guestfs-actions.pod:1969
9075 msgid "guestfs_get_autosync"
9079 #: ../src/guestfs-actions.pod:1971
9083 " guestfs_get_autosync (guestfs_h *g);\n"
9088 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1328
9089 msgid "Get the autosync flag."
9093 #: ../src/guestfs-actions.pod:1980
9094 msgid "guestfs_get_direct"
9098 #: ../src/guestfs-actions.pod:1982
9102 " guestfs_get_direct (guestfs_h *g);\n"
9107 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1334
9108 msgid "Return the direct appliance mode flag."
9112 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:6221
9113 msgid "(Added in 1.0.72)"
9117 #: ../src/guestfs-actions.pod:1991
9118 msgid "guestfs_get_e2label"
9122 #: ../src/guestfs-actions.pod:1993
9126 " guestfs_get_e2label (guestfs_h *g,\n"
9127 " const char *device);\n"
9132 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1340
9133 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9137 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1343
9139 "This function is deprecated. In new code, use the C<vfs_label> call "
9144 #: ../src/guestfs-actions.pod:2010 ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6258
9145 msgid "(Added in 1.0.15)"
9149 #: ../src/guestfs-actions.pod:2012
9150 msgid "guestfs_get_e2uuid"
9154 #: ../src/guestfs-actions.pod:2014
9158 " guestfs_get_e2uuid (guestfs_h *g,\n"
9159 " const char *device);\n"
9164 #: ../src/guestfs-actions.pod:2018 ../fish/guestfish-actions.pod:1354
9165 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9169 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1357
9170 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9174 #: ../src/guestfs-actions.pod:2033
9175 msgid "guestfs_get_memsize"
9179 #: ../src/guestfs-actions.pod:2035
9183 " guestfs_get_memsize (guestfs_h *g);\n"
9188 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1368
9189 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
9193 #: ../src/guestfs-actions.pod:2041
9195 "If C<guestfs_set_memsize> was not called on this handle, and if "
9196 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9197 "value for memsize."
9201 #: ../src/guestfs-actions.pod:2045 ../src/guestfs-actions.pod:2126 ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1426 ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4238
9202 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9206 #: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:4577 ../src/guestfs-actions.pod:4786 ../src/guestfs-actions.pod:4805 ../src/guestfs-actions.pod:4824 ../src/guestfs-actions.pod:4836 ../src/guestfs-actions.pod:4853 ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:5893 ../src/guestfs-actions.pod:6279 ../src/guestfs-actions.pod:6540 ../src/guestfs-actions.pod:7155
9207 msgid "(Added in 1.0.55)"
9211 #: ../src/guestfs-actions.pod:2052
9212 msgid "guestfs_get_network"
9216 #: ../src/guestfs-actions.pod:2054
9220 " guestfs_get_network (guestfs_h *g);\n"
9225 #: ../src/guestfs-actions.pod:2057 ../fish/guestfish-actions.pod:1382
9226 msgid "This returns the enable network flag."
9230 #: ../src/guestfs-actions.pod:2061 ../src/guestfs-actions.pod:6298
9231 msgid "(Added in 1.5.4)"
9235 #: ../src/guestfs-actions.pod:2063
9236 msgid "guestfs_get_path"
9240 #: ../src/guestfs-actions.pod:2065
9244 " guestfs_get_path (guestfs_h *g);\n"
9249 #: ../src/guestfs-actions.pod:2068 ../fish/guestfish-actions.pod:1388
9250 msgid "Return the current search path."
9254 #: ../src/guestfs-actions.pod:2070 ../fish/guestfish-actions.pod:1390
9256 "This is always non-NULL. If it wasn't set already, then this will return "
9261 #: ../src/guestfs-actions.pod:2073 ../src/guestfs-actions.pod:2102
9263 "This function returns a string, or NULL on error. The string is owned by "
9264 "the guest handle and must I<not> be freed."
9268 #: ../src/guestfs-actions.pod:2078
9269 msgid "guestfs_get_pid"
9273 #: ../src/guestfs-actions.pod:2080
9277 " guestfs_get_pid (guestfs_h *g);\n"
9282 #: ../src/guestfs-actions.pod:2083 ../fish/guestfish-actions.pod:1399
9284 "Return the process ID of the qemu subprocess. If there is no qemu "
9285 "subprocess, then this will return an error."
9289 #: ../src/guestfs-actions.pod:2086 ../fish/guestfish-actions.pod:1402
9290 msgid "This is an internal call used for debugging and testing."
9294 #: ../src/guestfs-actions.pod:2090
9295 msgid "(Added in 1.0.56)"
9299 #: ../src/guestfs-actions.pod:2092
9300 msgid "guestfs_get_qemu"
9304 #: ../src/guestfs-actions.pod:2094
9308 " guestfs_get_qemu (guestfs_h *g);\n"
9313 #: ../src/guestfs-actions.pod:2097 ../fish/guestfish-actions.pod:1408
9314 msgid "Return the current qemu binary."
9318 #: ../src/guestfs-actions.pod:2099 ../fish/guestfish-actions.pod:1410
9320 "This is always non-NULL. If it wasn't set already, then this will return "
9321 "the default qemu binary name."
9325 #: ../src/guestfs-actions.pod:2105 ../src/guestfs-actions.pod:6343
9326 msgid "(Added in 1.0.6)"
9330 #: ../src/guestfs-actions.pod:2107
9331 msgid "guestfs_get_recovery_proc"
9335 #: ../src/guestfs-actions.pod:2109
9339 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9344 #: ../src/guestfs-actions.pod:2112 ../fish/guestfish-actions.pod:1417
9345 msgid "Return the recovery process enabled flag."
9349 #: ../src/guestfs-actions.pod:2116 ../src/guestfs-actions.pod:3650 ../src/guestfs-actions.pod:3981 ../src/guestfs-actions.pod:4384 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:5598 ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:6367 ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7078 ../src/guestfs-actions.pod:7270
9350 msgid "(Added in 1.0.77)"
9354 #: ../src/guestfs-actions.pod:2118
9355 msgid "guestfs_get_selinux"
9359 #: ../src/guestfs-actions.pod:2120
9363 " guestfs_get_selinux (guestfs_h *g);\n"
9368 #: ../src/guestfs-actions.pod:2123
9370 "This returns the current setting of the selinux flag which is passed to the "
9371 "appliance at boot time. See C<guestfs_set_selinux>."
9375 #: ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:2194 ../src/guestfs-actions.pod:6386 ../src/guestfs-actions.pod:6444
9376 msgid "(Added in 1.0.67)"
9380 #: ../src/guestfs-actions.pod:2133
9381 msgid "guestfs_get_state"
9385 #: ../src/guestfs-actions.pod:2135
9389 " guestfs_get_state (guestfs_h *g);\n"
9394 #: ../src/guestfs-actions.pod:2138 ../fish/guestfish-actions.pod:1433
9396 "This returns the current state as an opaque integer. This is only useful "
9397 "for printing debug and internal error messages."
9401 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3421 ../src/guestfs-actions.pod:3450 ../src/guestfs-actions.pod:3511 ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:1436 ../fish/guestfish-actions.pod:2356 ../fish/guestfish-actions.pod:2374 ../fish/guestfish-actions.pod:2412 ../fish/guestfish-actions.pod:2428
9402 msgid "For more information on states, see L<guestfs(3)>."
9406 #: ../src/guestfs-actions.pod:2147
9407 msgid "guestfs_get_trace"
9411 #: ../src/guestfs-actions.pod:2149
9415 " guestfs_get_trace (guestfs_h *g);\n"
9420 #: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1442
9421 msgid "Return the command trace flag."
9425 #: ../src/guestfs-actions.pod:2158
9426 msgid "guestfs_get_umask"
9430 #: ../src/guestfs-actions.pod:2160
9434 " guestfs_get_umask (guestfs_h *g);\n"
9439 #: ../src/guestfs-actions.pod:2163
9441 "Return the current umask. By default the umask is C<022> unless it has been "
9442 "set by calling C<guestfs_umask>."
9446 #: ../src/guestfs-actions.pod:2170
9447 msgid "guestfs_get_verbose"
9451 #: ../src/guestfs-actions.pod:2172
9455 " guestfs_get_verbose (guestfs_h *g);\n"
9460 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1455
9461 msgid "This returns the verbose messages flag."
9465 #: ../src/guestfs-actions.pod:2181
9466 msgid "guestfs_getcon"
9470 #: ../src/guestfs-actions.pod:2183
9474 " guestfs_getcon (guestfs_h *g);\n"
9479 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1461
9480 msgid "This gets the SELinux security context of the daemon."
9484 #: ../src/guestfs-actions.pod:2188
9485 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9489 #: ../src/guestfs-actions.pod:2196
9490 msgid "guestfs_getxattr"
9494 #: ../src/guestfs-actions.pod:2198
9498 " guestfs_getxattr (guestfs_h *g,\n"
9499 " const char *path,\n"
9500 " const char *name,\n"
9501 " size_t *size_r);\n"
9506 #: ../src/guestfs-actions.pod:2204
9508 "Get a single extended attribute from file C<path> named C<name>. This call "
9509 "follows symlinks. If you want to lookup an extended attribute for the "
9510 "symlink itself, use C<guestfs_lgetxattr>."
9514 #: ../src/guestfs-actions.pod:2208 ../src/guestfs-actions.pod:3664
9516 "Normally it is better to get all extended attributes from a file in one go "
9517 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9518 "implementations are buggy and do not provide a way to list out attributes. "
9519 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9520 "extended attributes you want in advance and call this function."
9524 #: ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:1481 ../fish/guestfish-actions.pod:2508
9526 "Extended attribute values are blobs of binary data. If there is no extended "
9527 "attribute named C<name>, this returns an error."
9531 #: ../src/guestfs-actions.pod:2218
9532 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9536 #: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2411 ../src/guestfs-actions.pod:2881 ../src/guestfs-actions.pod:3676 ../src/guestfs-actions.pod:5591 ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:5798
9538 "This function returns a buffer, or NULL on error. The size of the returned "
9539 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9544 #: ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:3680
9545 msgid "(Added in 1.7.24)"
9549 #: ../src/guestfs-actions.pod:2226
9550 msgid "guestfs_getxattrs"
9554 #: ../src/guestfs-actions.pod:2228
9557 " struct guestfs_xattr_list *\n"
9558 " guestfs_getxattrs (guestfs_h *g,\n"
9559 " const char *path);\n"
9564 #: ../src/guestfs-actions.pod:2232 ../fish/guestfish-actions.pod:1490
9565 msgid "This call lists the extended attributes of the file or directory C<path>."
9569 #: ../src/guestfs-actions.pod:2235 ../fish/guestfish-actions.pod:1493
9571 "At the system call level, this is a combination of the L<listxattr(2)> and "
9572 "L<getxattr(2)> calls."
9576 #: ../src/guestfs-actions.pod:2238
9577 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9581 #: ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:3692 ../src/guestfs-actions.pod:4380
9583 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9584 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9588 #: ../src/guestfs-actions.pod:2244 ../src/guestfs-actions.pod:3696 ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3931 ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:6463 ../src/guestfs-actions.pod:7828
9589 msgid "(Added in 1.0.59)"
9593 #: ../src/guestfs-actions.pod:2246
9594 msgid "guestfs_glob_expand"
9598 #: ../src/guestfs-actions.pod:2248
9602 " guestfs_glob_expand (guestfs_h *g,\n"
9603 " const char *pattern);\n"
9608 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1502
9610 "This command searches for all the pathnames matching C<pattern> according to "
9611 "the wildcard expansion rules used by the shell."
9615 #: ../src/guestfs-actions.pod:2256 ../fish/guestfish-actions.pod:1506
9616 msgid "If no paths match, then this returns an empty list (note: not an error)."
9620 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1509
9622 "It is just a wrapper around the C L<glob(3)> function with flags "
9623 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9627 #: ../src/guestfs-actions.pod:2267 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6673
9628 msgid "(Added in 1.0.50)"
9632 #: ../src/guestfs-actions.pod:2269
9633 msgid "guestfs_grep"
9637 #: ../src/guestfs-actions.pod:2271
9641 " guestfs_grep (guestfs_h *g,\n"
9642 " const char *regex,\n"
9643 " const char *path);\n"
9648 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1517
9649 msgid "This calls the external C<grep> program and returns the matching lines."
9653 #: ../src/guestfs-actions.pod:2288
9654 msgid "guestfs_grepi"
9658 #: ../src/guestfs-actions.pod:2290
9662 " guestfs_grepi (guestfs_h *g,\n"
9663 " const char *regex,\n"
9664 " const char *path);\n"
9669 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1527
9670 msgid "This calls the external C<grep -i> program and returns the matching lines."
9674 #: ../src/guestfs-actions.pod:2307
9675 msgid "guestfs_grub_install"
9679 #: ../src/guestfs-actions.pod:2309
9683 " guestfs_grub_install (guestfs_h *g,\n"
9684 " const char *root,\n"
9685 " const char *device);\n"
9690 #: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1537
9692 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9693 "the root directory being C<root>."
9697 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1540
9699 "Note: If grub-install reports the error \"No suitable drive was found in the "
9700 "generated device map.\" it may be that you need to create a "
9701 "C</boot/grub/device.map> file first that contains the mapping between grub "
9702 "device names and Linux device names. It is usually sufficient to create a "
9707 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1547
9715 #: ../src/guestfs-actions.pod:2326 ../fish/guestfish-actions.pod:1549
9716 msgid "replacing C</dev/vda> with the name of the installation device."
9720 #: ../src/guestfs-actions.pod:2330
9721 msgid "(Added in 1.0.17)"
9725 #: ../src/guestfs-actions.pod:2332
9726 msgid "guestfs_head"
9730 #: ../src/guestfs-actions.pod:2334
9734 " guestfs_head (guestfs_h *g,\n"
9735 " const char *path);\n"
9740 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1555
9742 "This command returns up to the first 10 lines of a file as a list of "
9747 #: ../src/guestfs-actions.pod:2350
9748 msgid "guestfs_head_n"
9752 #: ../src/guestfs-actions.pod:2352
9756 " guestfs_head_n (guestfs_h *g,\n"
9758 " const char *path);\n"
9763 #: ../src/guestfs-actions.pod:2357 ../fish/guestfish-actions.pod:1565
9765 "If the parameter C<nrlines> is a positive number, this returns the first "
9766 "C<nrlines> lines of the file C<path>."
9770 #: ../src/guestfs-actions.pod:2360 ../fish/guestfish-actions.pod:1568
9772 "If the parameter C<nrlines> is a negative number, this returns lines from "
9773 "the file C<path>, excluding the last C<nrlines> lines."
9777 #: ../src/guestfs-actions.pod:2363 ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:1571 ../fish/guestfish-actions.pod:4616
9778 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9782 #: ../src/guestfs-actions.pod:2374
9783 msgid "guestfs_hexdump"
9787 #: ../src/guestfs-actions.pod:2376
9791 " guestfs_hexdump (guestfs_h *g,\n"
9792 " const char *path);\n"
9797 #: ../src/guestfs-actions.pod:2380 ../fish/guestfish-actions.pod:1580
9799 "This runs C<hexdump -C> on the given C<path>. The result is the "
9800 "human-readable, canonical hex dump of the file."
9804 #: ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:6737 ../src/guestfs-actions.pod:6792
9805 msgid "(Added in 1.0.22)"
9809 #: ../src/guestfs-actions.pod:2391
9810 msgid "guestfs_initrd_cat"
9814 #: ../src/guestfs-actions.pod:2393
9818 " guestfs_initrd_cat (guestfs_h *g,\n"
9819 " const char *initrdpath,\n"
9820 " const char *filename,\n"
9821 " size_t *size_r);\n"
9826 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1590
9828 "This command unpacks the file C<filename> from the initrd file called "
9829 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9834 #: ../src/guestfs-actions.pod:2403 ../fish/guestfish-actions.pod:1594
9836 "For example, in guestfish you could use the following command to examine the "
9837 "boot script (usually called C</init>) contained in a Linux initrd or "
9842 #: ../src/guestfs-actions.pod:2407 ../fish/guestfish-actions.pod:1598
9845 " initrd-cat /boot/initrd-<version>.img init\n"
9850 #: ../src/guestfs-actions.pod:2409
9851 msgid "See also C<guestfs_initrd_list>."
9855 #: ../src/guestfs-actions.pod:2420
9856 msgid "guestfs_initrd_list"
9860 #: ../src/guestfs-actions.pod:2422
9864 " guestfs_initrd_list (guestfs_h *g,\n"
9865 " const char *path);\n"
9870 #: ../src/guestfs-actions.pod:2426 ../fish/guestfish-actions.pod:1609
9871 msgid "This command lists out files contained in an initrd."
9875 #: ../src/guestfs-actions.pod:2428 ../fish/guestfish-actions.pod:1611
9877 "The files are listed without any initial C</> character. The files are "
9878 "listed in the order they appear (not necessarily alphabetical). Directory "
9879 "names are listed as separate items."
9883 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1615
9885 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9886 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9891 #: ../src/guestfs-actions.pod:2442
9892 msgid "guestfs_inotify_add_watch"
9896 #: ../src/guestfs-actions.pod:2444
9900 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9901 " const char *path,\n"
9907 #: ../src/guestfs-actions.pod:2449 ../fish/guestfish-actions.pod:1623
9908 msgid "Watch C<path> for the events listed in C<mask>."
9912 #: ../src/guestfs-actions.pod:2451 ../fish/guestfish-actions.pod:1625
9914 "Note that if C<path> is a directory then events within that directory are "
9915 "watched, but this does I<not> happen recursively (in subdirectories)."
9919 #: ../src/guestfs-actions.pod:2455 ../fish/guestfish-actions.pod:1629
9921 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9922 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9926 #: ../src/guestfs-actions.pod:2463
9927 msgid "guestfs_inotify_close"
9931 #: ../src/guestfs-actions.pod:2465
9935 " guestfs_inotify_close (guestfs_h *g);\n"
9940 #: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1637
9942 "This closes the inotify handle which was previously opened by inotify_init. "
9943 "It removes all watches, throws away any pending events, and deallocates all "
9948 #: ../src/guestfs-actions.pod:2476
9949 msgid "guestfs_inotify_files"
9953 #: ../src/guestfs-actions.pod:2478
9957 " guestfs_inotify_files (guestfs_h *g);\n"
9962 #: ../src/guestfs-actions.pod:2481
9964 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9965 "returns a list of pathnames of objects that were touched. The returned "
9966 "pathnames are sorted and deduplicated."
9970 #: ../src/guestfs-actions.pod:2491
9971 msgid "guestfs_inotify_init"
9975 #: ../src/guestfs-actions.pod:2493
9979 " guestfs_inotify_init (guestfs_h *g,\n"
9980 " int maxevents);\n"
9985 #: ../src/guestfs-actions.pod:2497 ../fish/guestfish-actions.pod:1653
9987 "This command creates a new inotify handle. The inotify subsystem can be "
9988 "used to notify events which happen to objects in the guest filesystem."
9992 #: ../src/guestfs-actions.pod:2501
9994 "C<maxevents> is the maximum number of events which will be queued up between "
9995 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9996 "passed as C<0>, then the kernel (or previously set) default is used. For "
9997 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9998 "throws away events, but records the fact that it threw them away by setting "
9999 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10000 "C<guestfs_inotify_read>)."
10004 #: ../src/guestfs-actions.pod:2511
10006 "Before any events are generated, you have to add some watches to the "
10007 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10008 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10012 #: ../src/guestfs-actions.pod:2517
10014 "Queued up events should be read periodically by calling "
10015 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10016 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10017 "often enough then you risk the internal queue overflowing."
10021 #: ../src/guestfs-actions.pod:2524
10023 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10024 "This also removes any watches automatically."
10028 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1684
10030 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10031 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10032 "that there is one global inotify handle per libguestfs instance."
10036 #: ../src/guestfs-actions.pod:2537
10037 msgid "guestfs_inotify_read"
10041 #: ../src/guestfs-actions.pod:2539
10044 " struct guestfs_inotify_event_list *\n"
10045 " guestfs_inotify_read (guestfs_h *g);\n"
10050 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1693
10052 "Return the complete queue of events that have happened since the previous "
10057 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1696
10058 msgid "If no events have happened, this returns an empty list."
10062 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1698
10064 "I<Note>: In order to make sure that all events have been read, you must call "
10065 "this function repeatedly until it returns an empty list. The reason is that "
10066 "the call will read events up to the maximum appliance-to-host message size "
10067 "and leave remaining events in the queue."
10071 #: ../src/guestfs-actions.pod:2553
10073 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10074 "there was an error. I<The caller must call "
10075 "C<guestfs_free_inotify_event_list> after use>."
10079 #: ../src/guestfs-actions.pod:2559
10080 msgid "guestfs_inotify_rm_watch"
10084 #: ../src/guestfs-actions.pod:2561
10088 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10094 #: ../src/guestfs-actions.pod:2565
10096 "Remove a previously defined inotify watch. See "
10097 "C<guestfs_inotify_add_watch>."
10101 #: ../src/guestfs-actions.pod:2572
10102 msgid "guestfs_inspect_get_arch"
10106 #: ../src/guestfs-actions.pod:2574
10110 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10111 " const char *root);\n"
10116 #: ../src/guestfs-actions.pod:2578
10118 "This returns the architecture of the inspected operating system. The "
10119 "possible return values are listed under C<guestfs_file_architecture>."
10123 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1719
10125 "If the architecture could not be determined, then the string C<unknown> is "
10130 #: ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2675 ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:2929 ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3040 ../src/guestfs-actions.pod:3061 ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:3227 ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3347 ../src/guestfs-actions.pod:3388 ../fish/guestfish-actions.pod:1722 ../fish/guestfish-actions.pod:1805 ../fish/guestfish-actions.pod:1884 ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1980 ../fish/guestfish-actions.pod:2041 ../fish/guestfish-actions.pod:2062 ../fish/guestfish-actions.pod:2076 ../fish/guestfish-actions.pod:2116 ../fish/guestfish-actions.pod:2148 ../fish/guestfish-actions.pod:2161 ../fish/guestfish-actions.pod:2174 ../fish/guestfish-actions.pod:2184 ../fish/guestfish-actions.pod:2194 ../fish/guestfish-actions.pod:2206 ../fish/guestfish-actions.pod:2302 ../fish/guestfish-actions.pod:2336
10131 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10135 #: ../src/guestfs-actions.pod:2592
10136 msgid "guestfs_inspect_get_distro"
10140 #: ../src/guestfs-actions.pod:2594
10144 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10145 " const char *root);\n"
10150 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1728
10151 msgid "This returns the distro (distribution) of the inspected operating system."
10155 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1731
10156 msgid "Currently defined distros are:"
10160 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1735
10161 msgid "\"archlinux\""
10165 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1737
10166 msgid "Arch Linux."
10170 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1739
10175 #: ../src/guestfs-actions.pod:2611 ../fish/guestfish-actions.pod:1741
10180 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1743
10185 #: ../src/guestfs-actions.pod:2615 ../fish/guestfish-actions.pod:1745
10190 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1747
10195 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1749
10200 #: ../src/guestfs-actions.pod:2621 ../fish/guestfish-actions.pod:1751
10205 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1753
10210 #: ../src/guestfs-actions.pod:2625 ../fish/guestfish-actions.pod:1755
10211 msgid "\"linuxmint\""
10215 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1757
10216 msgid "Linux Mint."
10220 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1759
10221 msgid "\"mandriva\""
10225 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1761
10230 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1763
10235 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1765
10240 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1767
10245 #: ../src/guestfs-actions.pod:2639 ../fish/guestfish-actions.pod:1769
10250 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1771
10251 msgid "\"redhat-based\""
10255 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1773
10256 msgid "Some Red Hat-derived distro."
10260 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1775
10265 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1777
10266 msgid "Red Hat Enterprise Linux."
10270 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1779
10271 msgid "\"scientificlinux\""
10275 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1781
10276 msgid "Scientific Linux."
10280 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1783
10281 msgid "\"slackware\""
10285 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1785
10290 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1787
10295 #: ../src/guestfs-actions.pod:2659 ../fish/guestfish-actions.pod:1789
10300 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:3145 ../fish/guestfish-actions.pod:1791 ../fish/guestfish-actions.pod:1875 ../fish/guestfish-actions.pod:2139
10301 msgid "\"unknown\""
10305 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:1793
10306 msgid "The distro could not be determined."
10310 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:3137 ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:2131
10311 msgid "\"windows\""
10315 #: ../src/guestfs-actions.pod:2667 ../fish/guestfish-actions.pod:1797
10317 "Windows does not have distributions. This string is returned if the OS type "
10322 #: ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:1802 ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:2145
10324 "Future versions of libguestfs may return other strings here. The caller "
10325 "should be prepared to handle any string."
10329 #: ../src/guestfs-actions.pod:2682
10330 msgid "guestfs_inspect_get_drive_mappings"
10334 #: ../src/guestfs-actions.pod:2684
10338 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10339 " const char *root);\n"
10344 #: ../src/guestfs-actions.pod:2688 ../fish/guestfish-actions.pod:1811
10346 "This call is useful for Windows which uses a primitive system of assigning "
10347 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10348 "Windows Registry to find out how disks/partitions are mapped to drive "
10349 "letters, and returns a hash table as in the example below:"
10353 #: ../src/guestfs-actions.pod:2694 ../fish/guestfish-actions.pod:1817
10356 " C => /dev/vda2\n"
10357 " E => /dev/vdb1\n"
10358 " F => /dev/vdc1\n"
10363 #: ../src/guestfs-actions.pod:2698 ../fish/guestfish-actions.pod:1821
10365 "Note that keys are drive letters. For Windows, the key is case insensitive "
10366 "and just contains the drive letter, without the customary colon separator "
10371 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1825
10373 "In future we may support other operating systems that also used drive "
10374 "letters, but the keys for those might not be case insensitive and might be "
10375 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10380 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1830
10382 "For Windows guests, currently only hard drive mappings are returned. "
10383 "Removable disks (eg. DVD-ROMs) are ignored."
10387 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1833
10389 "For guests that do not use drive mappings, or if the drive mappings could "
10390 "not be determined, this returns an empty hash table."
10394 #: ../src/guestfs-actions.pod:2713
10396 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10397 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10401 #: ../src/guestfs-actions.pod:2717 ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:5065 ../src/guestfs-actions.pod:7094
10403 "This function returns a NULL-terminated array of strings, or NULL if there "
10404 "was an error. The array of strings will always have length C<2n+1>, where "
10405 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10406 "caller must free the strings and the array after use>."
10410 #: ../src/guestfs-actions.pod:2723 ../src/guestfs-actions.pod:3179
10411 msgid "(Added in 1.9.17)"
10415 #: ../src/guestfs-actions.pod:2725
10416 msgid "guestfs_inspect_get_filesystems"
10420 #: ../src/guestfs-actions.pod:2727
10424 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10425 " const char *root);\n"
10430 #: ../src/guestfs-actions.pod:2731 ../fish/guestfish-actions.pod:1844
10432 "This returns a list of all the filesystems that we think are associated with "
10433 "this operating system. This includes the root filesystem, other ordinary "
10434 "filesystems, and non-mounted devices like swap partitions."
10438 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1849
10440 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10441 "to be shared between operating systems."
10445 #: ../src/guestfs-actions.pod:2739
10447 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10448 "C<guestfs_inspect_get_mountpoints>."
10452 #: ../src/guestfs-actions.pod:2748
10453 msgid "guestfs_inspect_get_format"
10457 #: ../src/guestfs-actions.pod:2750
10461 " guestfs_inspect_get_format (guestfs_h *g,\n"
10462 " const char *root);\n"
10467 #: ../src/guestfs-actions.pod:2754 ../fish/guestfish-actions.pod:1859
10469 "This returns the format of the inspected operating system. You can use it "
10470 "to detect install images, live CDs and similar."
10474 #: ../src/guestfs-actions.pod:2757 ../fish/guestfish-actions.pod:1862
10475 msgid "Currently defined formats are:"
10479 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1866
10480 msgid "\"installed\""
10484 #: ../src/guestfs-actions.pod:2763 ../fish/guestfish-actions.pod:1868
10485 msgid "This is an installed operating system."
10489 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1870
10490 msgid "\"installer\""
10494 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1872
10496 "The disk image being inspected is not an installed operating system, but a "
10497 "I<bootable> install disk, live CD, or similar."
10501 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1877
10502 msgid "The format of this disk image is not known."
10506 #: ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:3215 ../src/guestfs-actions.pod:3231 ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:6009
10507 msgid "(Added in 1.9.4)"
10511 #: ../src/guestfs-actions.pod:2786
10512 msgid "guestfs_inspect_get_hostname"
10516 #: ../src/guestfs-actions.pod:2788
10520 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10521 " const char *root);\n"
10526 #: ../src/guestfs-actions.pod:2792 ../fish/guestfish-actions.pod:1890
10528 "This function returns the hostname of the operating system as found by "
10529 "inspection of the guest's configuration files."
10533 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1893
10535 "If the hostname could not be determined, then the string C<unknown> is "
10540 #: ../src/guestfs-actions.pod:2803
10541 msgid "(Added in 1.7.9)"
10545 #: ../src/guestfs-actions.pod:2805
10546 msgid "guestfs_inspect_get_icon"
10550 #: ../src/guestfs-actions.pod:2807
10554 " guestfs_inspect_get_icon (guestfs_h *g,\n"
10555 " const char *root,\n"
10556 " size_t *size_r,\n"
10562 #: ../src/guestfs-actions.pod:2818
10565 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
10566 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
10571 #: ../src/guestfs-actions.pod:2821 ../fish/guestfish-actions.pod:1902
10573 "This function returns an icon corresponding to the inspected operating "
10574 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
10575 "to PNG if necessary)."
10579 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1906
10581 "If it was not possible to get an icon this function returns a zero-length "
10582 "(non-NULL) buffer. I<Callers must check for this case>."
10586 #: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1909
10588 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
10589 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
10590 "this file will be returned. You can disable favicons by passing the "
10591 "optional C<favicon> boolean as false (default is true)."
10595 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1915
10597 "If finding the favicon fails, then we look in other places in the guest for "
10602 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1918
10604 "If the optional C<highquality> boolean is true then only high quality icons "
10605 "are returned, which means only icons of high resolution with an alpha "
10606 "channel. The default (false) is to return any icon we can, even if it is of "
10607 "substandard quality."
10611 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1929
10613 "Unlike most other inspection API calls, the guest's disks must be mounted up "
10614 "before you call this, since it needs to read information from the guest "
10615 "filesystem during the call."
10619 #: ../src/guestfs-actions.pod:2854 ../fish/guestfish-actions.pod:1935
10621 "B<Security:> The icon data comes from the untrusted guest, and should be "
10622 "treated with caution. PNG files have been known to contain exploits. "
10623 "Ensure that libpng (or other relevant libraries) are fully up to date before "
10624 "trying to process or display the icon."
10628 #: ../src/guestfs-actions.pod:2862 ../fish/guestfish-actions.pod:1943
10630 "The PNG image returned can be any size. It might not be square. Libguestfs "
10631 "tries to return the largest, highest quality icon available. The "
10632 "application must scale the icon to the required size."
10636 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1950
10638 "Extracting icons from Windows guests requires the external C<wrestool> "
10639 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
10640 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
10641 "installed separately."
10645 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1957
10647 "Operating system icons are usually trademarks. Seek legal advice before "
10648 "using trademarks in applications."
10652 #: ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:4964
10653 msgid "(Added in 1.11.12)"
10657 #: ../src/guestfs-actions.pod:2887
10658 msgid "guestfs_inspect_get_icon_va"
10662 #: ../src/guestfs-actions.pod:2889
10666 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
10667 " const char *root,\n"
10668 " size_t *size_r,\n"
10669 " va_list args);\n"
10674 #: ../src/guestfs-actions.pod:2895
10675 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
10679 #: ../src/guestfs-actions.pod:2899
10680 msgid "guestfs_inspect_get_icon_argv"
10684 #: ../src/guestfs-actions.pod:2901
10688 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
10689 " const char *root,\n"
10690 " size_t *size_r,\n"
10691 " const struct guestfs_inspect_get_icon_argv "
10697 #: ../src/guestfs-actions.pod:2907
10698 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
10702 #: ../src/guestfs-actions.pod:2911
10703 msgid "guestfs_inspect_get_major_version"
10707 #: ../src/guestfs-actions.pod:2913
10711 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10712 " const char *root);\n"
10717 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:1968
10718 msgid "This returns the major version number of the inspected operating system."
10722 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:1971
10724 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10725 "popular public names used by the operating system. Notably the operating "
10726 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10727 "1). You can find out the real versions corresponding to releases of Windows "
10728 "by consulting Wikipedia or MSDN."
10732 #: ../src/guestfs-actions.pod:2927 ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:1989
10733 msgid "If the version could not be determined, then C<0> is returned."
10737 #: ../src/guestfs-actions.pod:2935
10738 msgid "guestfs_inspect_get_minor_version"
10742 #: ../src/guestfs-actions.pod:2937
10746 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10747 " const char *root);\n"
10752 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:1986
10753 msgid "This returns the minor version number of the inspected operating system."
10757 #: ../src/guestfs-actions.pod:2946
10759 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10760 "C<guestfs_inspect_get_major_version>."
10764 #: ../src/guestfs-actions.pod:2953
10765 msgid "guestfs_inspect_get_mountpoints"
10769 #: ../src/guestfs-actions.pod:2955
10773 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10774 " const char *root);\n"
10779 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:1998
10781 "This returns a hash of where we think the filesystems associated with this "
10782 "operating system should be mounted. Callers should note that this is at "
10783 "best an educated guess made by reading configuration files such as "
10784 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10785 "are non-existent or not mountable and callers should be prepared to handle "
10786 "or ignore failures if they try to mount them."
10790 #: ../src/guestfs-actions.pod:2968 ../fish/guestfish-actions.pod:2007
10792 "Each element in the returned hashtable has a key which is the path of the "
10793 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10794 "mounted there (eg. C</dev/sda1>)."
10798 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2012
10799 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10803 #: ../src/guestfs-actions.pod:2976
10805 "For operating systems like Windows which still use drive letters, this call "
10806 "will only return an entry for the first drive \"mounted on\" C</>. For "
10807 "information about the mapping of drive letters to partitions, see "
10808 "C<guestfs_inspect_get_drive_mappings>."
10812 #: ../src/guestfs-actions.pod:2982
10814 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10815 "C<guestfs_inspect_get_filesystems>."
10819 #: ../src/guestfs-actions.pod:2993
10820 msgid "guestfs_inspect_get_package_format"
10824 #: ../src/guestfs-actions.pod:2995
10828 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10829 " const char *root);\n"
10834 #: ../src/guestfs-actions.pod:2999
10836 "This function and C<guestfs_inspect_get_package_management> return the "
10837 "package format and package management tool used by the inspected operating "
10838 "system. For example for Fedora these functions would return C<rpm> (package "
10839 "format) and C<yum> (package management)."
10843 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2034
10845 "This returns the string C<unknown> if we could not determine the package "
10846 "format I<or> if the operating system does not have a real packaging system "
10851 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2038
10853 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10854 "Future versions of libguestfs may return other strings."
10858 #: ../src/guestfs-actions.pod:3017 ../src/guestfs-actions.pod:3045
10859 msgid "(Added in 1.7.5)"
10863 #: ../src/guestfs-actions.pod:3019
10864 msgid "guestfs_inspect_get_package_management"
10868 #: ../src/guestfs-actions.pod:3021
10872 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10873 " const char *root);\n"
10878 #: ../src/guestfs-actions.pod:3025
10880 "C<guestfs_inspect_get_package_format> and this function return the package "
10881 "format and package management tool used by the inspected operating system. "
10882 "For example for Fedora these functions would return C<rpm> (package format) "
10883 "and C<yum> (package management)."
10887 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2053
10889 "This returns the string C<unknown> if we could not determine the package "
10890 "management tool I<or> if the operating system does not have a real packaging "
10891 "system (eg. Windows)."
10895 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2057
10897 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10898 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10899 "libguestfs may return other strings."
10903 #: ../src/guestfs-actions.pod:3047
10904 msgid "guestfs_inspect_get_product_name"
10908 #: ../src/guestfs-actions.pod:3049
10912 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10913 " const char *root);\n"
10918 #: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2068
10920 "This returns the product name of the inspected operating system. The "
10921 "product name is generally some freeform string which can be displayed to the "
10922 "user, but should not be parsed by programs."
10926 #: ../src/guestfs-actions.pod:3058 ../fish/guestfish-actions.pod:2073
10928 "If the product name could not be determined, then the string C<unknown> is "
10933 #: ../src/guestfs-actions.pod:3068
10934 msgid "guestfs_inspect_get_product_variant"
10938 #: ../src/guestfs-actions.pod:3070
10942 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10943 " const char *root);\n"
10948 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2082
10949 msgid "This returns the product variant of the inspected operating system."
10953 #: ../src/guestfs-actions.pod:3077 ../fish/guestfish-actions.pod:2085
10955 "For Windows guests, this returns the contents of the Registry key "
10956 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10957 "which is usually a string such as C<Client> or C<Server> (other values are "
10958 "possible). This can be used to distinguish consumer and enterprise versions "
10959 "of Windows that have the same version number (for example, Windows 7 and "
10960 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10961 "the latter is C<Server>)."
10965 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2094
10967 "For enterprise Linux guests, in future we intend this to return the product "
10968 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10969 "implemented at present."
10973 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2098
10975 "If the product variant could not be determined, then the string C<unknown> "
10980 #: ../src/guestfs-actions.pod:3093
10982 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10983 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10987 #: ../src/guestfs-actions.pod:3100
10988 msgid "(Added in 1.9.13)"
10992 #: ../src/guestfs-actions.pod:3102
10993 msgid "guestfs_inspect_get_roots"
10997 #: ../src/guestfs-actions.pod:3104
11001 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11006 #: ../src/guestfs-actions.pod:3107
11008 "This function is a convenient way to get the list of root devices, as "
11009 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11010 "the whole inspection process."
11014 #: ../src/guestfs-actions.pod:3111
11016 "This returns an empty list if either no root devices were found or the "
11017 "caller has not called C<guestfs_inspect_os>."
11021 #: ../src/guestfs-actions.pod:3120
11022 msgid "(Added in 1.7.3)"
11026 #: ../src/guestfs-actions.pod:3122
11027 msgid "guestfs_inspect_get_type"
11031 #: ../src/guestfs-actions.pod:3124
11035 " guestfs_inspect_get_type (guestfs_h *g,\n"
11036 " const char *root);\n"
11041 #: ../src/guestfs-actions.pod:3128 ../fish/guestfish-actions.pod:2122
11043 "This returns the type of the inspected operating system. Currently defined "
11048 #: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2127
11053 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2129
11054 msgid "Any Linux-based operating system."
11058 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2133
11059 msgid "Any Microsoft Windows operating system."
11063 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2135
11064 msgid "\"freebsd\""
11068 #: ../src/guestfs-actions.pod:3143 ../fish/guestfish-actions.pod:2137
11073 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2141
11074 msgid "The operating system type could not be determined."
11078 #: ../src/guestfs-actions.pod:3161
11079 msgid "guestfs_inspect_get_windows_current_control_set"
11083 #: ../src/guestfs-actions.pod:3163
11087 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11088 " const char *root);\n"
11093 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2154
11095 "This returns the Windows CurrentControlSet of the inspected guest. The "
11096 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11100 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2157
11102 "This call assumes that the guest is Windows and that the Registry could be "
11103 "examined by inspection. If this is not the case then an error is returned."
11107 #: ../src/guestfs-actions.pod:3181
11108 msgid "guestfs_inspect_get_windows_systemroot"
11112 #: ../src/guestfs-actions.pod:3183
11116 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11117 " const char *root);\n"
11122 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2167
11124 "This returns the Windows systemroot of the inspected guest. The systemroot "
11125 "is a directory path such as C</WINDOWS>."
11129 #: ../src/guestfs-actions.pod:3190 ../fish/guestfish-actions.pod:2170
11131 "This call assumes that the guest is Windows and that the systemroot could be "
11132 "determined by inspection. If this is not the case then an error is "
11137 #: ../src/guestfs-actions.pod:3199
11138 msgid "(Added in 1.5.25)"
11142 #: ../src/guestfs-actions.pod:3201
11143 msgid "guestfs_inspect_is_live"
11147 #: ../src/guestfs-actions.pod:3203
11151 " guestfs_inspect_is_live (guestfs_h *g,\n"
11152 " const char *root);\n"
11157 #: ../src/guestfs-actions.pod:3207
11159 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11160 "disk), then this returns true if a live image was detected on the disk."
11164 #: ../src/guestfs-actions.pod:3217
11165 msgid "guestfs_inspect_is_multipart"
11169 #: ../src/guestfs-actions.pod:3219
11173 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11174 " const char *root);\n"
11179 #: ../src/guestfs-actions.pod:3223
11181 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11182 "disk), then this returns true if the disk is part of a set."
11186 #: ../src/guestfs-actions.pod:3233
11187 msgid "guestfs_inspect_is_netinst"
11191 #: ../src/guestfs-actions.pod:3235
11195 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11196 " const char *root);\n"
11201 #: ../src/guestfs-actions.pod:3239
11203 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11204 "disk), then this returns true if the disk is a network installer, ie. not a "
11205 "self-contained install CD but one which is likely to require network access "
11206 "to complete the install."
11210 #: ../src/guestfs-actions.pod:3251
11211 msgid "guestfs_inspect_list_applications"
11215 #: ../src/guestfs-actions.pod:3253
11218 " struct guestfs_application_list *\n"
11219 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11220 " const char *root);\n"
11225 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2212
11226 msgid "Return the list of applications installed in the operating system."
11230 #: ../src/guestfs-actions.pod:3259
11232 "I<Note:> This call works differently from other parts of the inspection "
11233 "API. You have to call C<guestfs_inspect_os>, then "
11234 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11235 "this. Listing applications is a significantly more difficult operation "
11236 "which requires access to the full filesystem. Also note that unlike the "
11237 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11238 "the libguestfs handle, this call actually reads parts of the mounted "
11239 "filesystems during the call."
11243 #: ../src/guestfs-actions.pod:3269 ../fish/guestfish-actions.pod:2224
11245 "This returns an empty list if the inspection code was not able to determine "
11246 "the list of applications."
11250 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2227
11251 msgid "The application structure contains the following fields:"
11255 #: ../src/guestfs-actions.pod:3276 ../fish/guestfish-actions.pod:2231
11256 msgid "C<app_name>"
11260 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2233
11262 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11263 "guests, this is the package name."
11267 #: ../src/guestfs-actions.pod:3281 ../fish/guestfish-actions.pod:2236
11268 msgid "C<app_display_name>"
11272 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2238
11274 "The display name of the application, sometimes localized to the install "
11275 "language of the guest operating system."
11279 #: ../src/guestfs-actions.pod:3286 ../fish/guestfish-actions.pod:2241
11281 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11282 "to display something can use C<app_name> instead."
11286 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2244
11287 msgid "C<app_epoch>"
11291 #: ../src/guestfs-actions.pod:3291 ../fish/guestfish-actions.pod:2246
11293 "For package managers which use epochs, this contains the epoch of the "
11294 "package (an integer). If unavailable, this is returned as C<0>."
11298 #: ../src/guestfs-actions.pod:3294 ../fish/guestfish-actions.pod:2249
11299 msgid "C<app_version>"
11303 #: ../src/guestfs-actions.pod:3296 ../fish/guestfish-actions.pod:2251
11305 "The version string of the application or package. If unavailable this is "
11306 "returned as an empty string C<\"\">."
11310 #: ../src/guestfs-actions.pod:3299 ../fish/guestfish-actions.pod:2254
11311 msgid "C<app_release>"
11315 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2256
11317 "The release string of the application or package, for package managers that "
11318 "use this. If unavailable this is returned as an empty string C<\"\">."
11322 #: ../src/guestfs-actions.pod:3305 ../fish/guestfish-actions.pod:2260
11323 msgid "C<app_install_path>"
11327 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2262
11329 "The installation path of the application (on operating systems such as "
11330 "Windows which use installation paths). This path is in the format used by "
11331 "the guest operating system, it is not a libguestfs path."
11335 #: ../src/guestfs-actions.pod:3312 ../fish/guestfish-actions.pod:2267
11336 msgid "If unavailable this is returned as an empty string C<\"\">."
11340 #: ../src/guestfs-actions.pod:3314 ../fish/guestfish-actions.pod:2269
11341 msgid "C<app_trans_path>"
11345 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2271
11347 "The install path translated into a libguestfs path. If unavailable this is "
11348 "returned as an empty string C<\"\">."
11352 #: ../src/guestfs-actions.pod:3319 ../fish/guestfish-actions.pod:2274
11353 msgid "C<app_publisher>"
11357 #: ../src/guestfs-actions.pod:3321 ../fish/guestfish-actions.pod:2276
11359 "The name of the publisher of the application, for package managers that use "
11360 "this. If unavailable this is returned as an empty string C<\"\">."
11364 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2280
11369 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2282
11371 "The URL (eg. upstream URL) of the application. If unavailable this is "
11372 "returned as an empty string C<\"\">."
11376 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2285
11377 msgid "C<app_source_package>"
11381 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2287
11383 "For packaging systems which support this, the name of the source package. "
11384 "If unavailable this is returned as an empty string C<\"\">."
11388 #: ../src/guestfs-actions.pod:3335 ../fish/guestfish-actions.pod:2290
11389 msgid "C<app_summary>"
11393 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2292
11395 "A short (usually one line) description of the application or package. If "
11396 "unavailable this is returned as an empty string C<\"\">."
11400 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2295
11401 msgid "C<app_description>"
11405 #: ../src/guestfs-actions.pod:3342 ../fish/guestfish-actions.pod:2297
11407 "A longer description of the application or package. If unavailable this is "
11408 "returned as an empty string C<\"\">."
11412 #: ../src/guestfs-actions.pod:3349
11414 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11415 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11420 #: ../src/guestfs-actions.pod:3353
11421 msgid "(Added in 1.7.8)"
11425 #: ../src/guestfs-actions.pod:3355
11426 msgid "guestfs_inspect_os"
11430 #: ../src/guestfs-actions.pod:3357
11434 " guestfs_inspect_os (guestfs_h *g);\n"
11439 #: ../src/guestfs-actions.pod:3360 ../fish/guestfish-actions.pod:2308
11441 "This function uses other libguestfs functions and certain heuristics to "
11442 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11443 "for operating systems."
11447 #: ../src/guestfs-actions.pod:3364 ../fish/guestfish-actions.pod:2312
11448 msgid "The list returned is empty if no operating systems were found."
11452 #: ../src/guestfs-actions.pod:3366 ../fish/guestfish-actions.pod:2314
11454 "If one operating system was found, then this returns a list with a single "
11455 "element, which is the name of the root filesystem of this operating system. "
11456 "It is also possible for this function to return a list containing more than "
11457 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11458 "element being the root filesystem of one of the operating systems."
11462 #: ../src/guestfs-actions.pod:3373
11464 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11465 "functions in order to query further information about each operating system, "
11466 "such as the name and version."
11470 #: ../src/guestfs-actions.pod:3378
11472 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11473 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11474 "the contents. This should be called with no disks currently mounted. The "
11475 "function may also use Augeas, so any existing Augeas handle will be closed."
11479 #: ../src/guestfs-actions.pod:3384 ../fish/guestfish-actions.pod:2332
11481 "This function cannot decrypt encrypted disks. The caller must do that first "
11482 "(supplying the necessary keys) if the disk is encrypted."
11486 #: ../src/guestfs-actions.pod:3390 ../src/guestfs-actions.pod:3721 ../src/guestfs-actions.pod:3803
11487 msgid "See also C<guestfs_list_filesystems>."
11491 #: ../src/guestfs-actions.pod:3398
11492 msgid "guestfs_is_blockdev"
11496 #: ../src/guestfs-actions.pod:3400
11500 " guestfs_is_blockdev (guestfs_h *g,\n"
11501 " const char *path);\n"
11506 #: ../src/guestfs-actions.pod:3404 ../fish/guestfish-actions.pod:2344
11508 "This returns C<true> if and only if there is a block device with the given "
11513 #: ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3497 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3568
11514 msgid "See also C<guestfs_stat>."
11518 #: ../src/guestfs-actions.pod:3411 ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3572
11519 msgid "(Added in 1.5.10)"
11523 #: ../src/guestfs-actions.pod:3413
11524 msgid "guestfs_is_busy"
11528 #: ../src/guestfs-actions.pod:3415
11532 " guestfs_is_busy (guestfs_h *g);\n"
11537 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:2353
11539 "This returns true iff this handle is busy processing a command (in the "
11544 #: ../src/guestfs-actions.pod:3427
11545 msgid "guestfs_is_chardev"
11549 #: ../src/guestfs-actions.pod:3429
11553 " guestfs_is_chardev (guestfs_h *g,\n"
11554 " const char *path);\n"
11559 #: ../src/guestfs-actions.pod:3433 ../fish/guestfish-actions.pod:2362
11561 "This returns C<true> if and only if there is a character device with the "
11562 "given C<path> name."
11566 #: ../src/guestfs-actions.pod:3442
11567 msgid "guestfs_is_config"
11571 #: ../src/guestfs-actions.pod:3444
11575 " guestfs_is_config (guestfs_h *g);\n"
11580 #: ../src/guestfs-actions.pod:3447 ../fish/guestfish-actions.pod:2371
11582 "This returns true iff this handle is being configured (in the C<CONFIG> "
11587 #: ../src/guestfs-actions.pod:3456
11588 msgid "guestfs_is_dir"
11592 #: ../src/guestfs-actions.pod:3458
11596 " guestfs_is_dir (guestfs_h *g,\n"
11597 " const char *path);\n"
11602 #: ../src/guestfs-actions.pod:3462 ../fish/guestfish-actions.pod:2380
11604 "This returns C<true> if and only if there is a directory with the given "
11605 "C<path> name. Note that it returns false for other objects like files."
11609 #: ../src/guestfs-actions.pod:3472
11610 msgid "guestfs_is_fifo"
11614 #: ../src/guestfs-actions.pod:3474
11618 " guestfs_is_fifo (guestfs_h *g,\n"
11619 " const char *path);\n"
11624 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2390
11626 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11627 "given C<path> name."
11631 #: ../src/guestfs-actions.pod:3487
11632 msgid "guestfs_is_file"
11636 #: ../src/guestfs-actions.pod:3489
11640 " guestfs_is_file (guestfs_h *g,\n"
11641 " const char *path);\n"
11646 #: ../src/guestfs-actions.pod:3493 ../fish/guestfish-actions.pod:2399
11648 "This returns C<true> if and only if there is a regular file with the given "
11649 "C<path> name. Note that it returns false for other objects like "
11654 #: ../src/guestfs-actions.pod:3503
11655 msgid "guestfs_is_launching"
11659 #: ../src/guestfs-actions.pod:3505
11663 " guestfs_is_launching (guestfs_h *g);\n"
11668 #: ../src/guestfs-actions.pod:3508 ../fish/guestfish-actions.pod:2409
11670 "This returns true iff this handle is launching the subprocess (in the "
11671 "C<LAUNCHING> state)."
11675 #: ../src/guestfs-actions.pod:3517
11676 msgid "guestfs_is_lv"
11680 #: ../src/guestfs-actions.pod:3519
11684 " guestfs_is_lv (guestfs_h *g,\n"
11685 " const char *device);\n"
11690 #: ../src/guestfs-actions.pod:3523 ../fish/guestfish-actions.pod:2418
11692 "This command tests whether C<device> is a logical volume, and returns true "
11693 "iff this is the case."
11697 #: ../src/guestfs-actions.pod:3530
11698 msgid "guestfs_is_ready"
11702 #: ../src/guestfs-actions.pod:3532
11706 " guestfs_is_ready (guestfs_h *g);\n"
11711 #: ../src/guestfs-actions.pod:3535 ../fish/guestfish-actions.pod:2425
11713 "This returns true iff this handle is ready to accept commands (in the "
11718 #: ../src/guestfs-actions.pod:3544
11719 msgid "guestfs_is_socket"
11723 #: ../src/guestfs-actions.pod:3546
11727 " guestfs_is_socket (guestfs_h *g,\n"
11728 " const char *path);\n"
11733 #: ../src/guestfs-actions.pod:3550 ../fish/guestfish-actions.pod:2434
11735 "This returns C<true> if and only if there is a Unix domain socket with the "
11736 "given C<path> name."
11740 #: ../src/guestfs-actions.pod:3559
11741 msgid "guestfs_is_symlink"
11745 #: ../src/guestfs-actions.pod:3561
11749 " guestfs_is_symlink (guestfs_h *g,\n"
11750 " const char *path);\n"
11755 #: ../src/guestfs-actions.pod:3565 ../fish/guestfish-actions.pod:2443
11757 "This returns C<true> if and only if there is a symbolic link with the given "
11762 #: ../src/guestfs-actions.pod:3574
11763 msgid "guestfs_is_zero"
11767 #: ../src/guestfs-actions.pod:3576
11771 " guestfs_is_zero (guestfs_h *g,\n"
11772 " const char *path);\n"
11777 #: ../src/guestfs-actions.pod:3580 ../fish/guestfish-actions.pod:2452
11779 "This returns true iff the file exists and the file is empty or it contains "
11784 #: ../src/guestfs-actions.pod:3585 ../src/guestfs-actions.pod:3599
11785 msgid "(Added in 1.11.8)"
11789 #: ../src/guestfs-actions.pod:3587
11790 msgid "guestfs_is_zero_device"
11794 #: ../src/guestfs-actions.pod:3589
11798 " guestfs_is_zero_device (guestfs_h *g,\n"
11799 " const char *device);\n"
11804 #: ../src/guestfs-actions.pod:3593 ../fish/guestfish-actions.pod:2459
11805 msgid "This returns true iff the device exists and contains all zero bytes."
11809 #: ../src/guestfs-actions.pod:3595 ../fish/guestfish-actions.pod:2461
11810 msgid "Note that for large devices this can take a long time to run."
11814 #: ../src/guestfs-actions.pod:3601
11815 msgid "guestfs_kill_subprocess"
11819 #: ../src/guestfs-actions.pod:3603
11823 " guestfs_kill_subprocess (guestfs_h *g);\n"
11828 #: ../src/guestfs-actions.pod:3606 ../fish/guestfish-actions.pod:2467
11829 msgid "This kills the qemu subprocess. You should never need to call this."
11833 #: ../src/guestfs-actions.pod:3612
11834 msgid "guestfs_launch"
11838 #: ../src/guestfs-actions.pod:3614
11842 " guestfs_launch (guestfs_h *g);\n"
11847 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2475
11849 "Internally libguestfs is implemented by running a virtual machine using "
11854 #: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2478
11856 "You should call this after configuring the handle (eg. adding drives) but "
11857 "before performing any actions."
11861 #: ../src/guestfs-actions.pod:3632
11862 msgid "guestfs_lchown"
11866 #: ../src/guestfs-actions.pod:3634
11870 " guestfs_lchown (guestfs_h *g,\n"
11873 " const char *path);\n"
11878 #: ../src/guestfs-actions.pod:3640
11880 "Change the file owner to C<owner> and group to C<group>. This is like "
11881 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11882 "changed, not the target."
11886 #: ../src/guestfs-actions.pod:3652
11887 msgid "guestfs_lgetxattr"
11891 #: ../src/guestfs-actions.pod:3654
11895 " guestfs_lgetxattr (guestfs_h *g,\n"
11896 " const char *path,\n"
11897 " const char *name,\n"
11898 " size_t *size_r);\n"
11903 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2497
11905 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11906 "is a symlink, then this call returns an extended attribute from the symlink."
11910 #: ../src/guestfs-actions.pod:3674
11911 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11915 #: ../src/guestfs-actions.pod:3682
11916 msgid "guestfs_lgetxattrs"
11920 #: ../src/guestfs-actions.pod:3684
11923 " struct guestfs_xattr_list *\n"
11924 " guestfs_lgetxattrs (guestfs_h *g,\n"
11925 " const char *path);\n"
11930 #: ../src/guestfs-actions.pod:3688
11932 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11933 "then it returns the extended attributes of the link itself."
11937 #: ../src/guestfs-actions.pod:3698
11938 msgid "guestfs_list_9p"
11942 #: ../src/guestfs-actions.pod:3700
11946 " guestfs_list_9p (guestfs_h *g);\n"
11951 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2525
11953 "List all 9p filesystems attached to the guest. A list of mount tags is "
11958 #: ../src/guestfs-actions.pod:3712
11959 msgid "guestfs_list_devices"
11963 #: ../src/guestfs-actions.pod:3714
11967 " guestfs_list_devices (guestfs_h *g);\n"
11972 #: ../src/guestfs-actions.pod:3717 ../fish/guestfish-actions.pod:2532
11973 msgid "List all the block devices."
11977 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2534
11978 msgid "The full block device names are returned, eg. C</dev/sda>."
11982 #: ../src/guestfs-actions.pod:3729
11983 msgid "guestfs_list_dm_devices"
11987 #: ../src/guestfs-actions.pod:3731
11991 " guestfs_list_dm_devices (guestfs_h *g);\n"
11996 #: ../src/guestfs-actions.pod:3734 ../fish/guestfish-actions.pod:2542
11997 msgid "List all device mapper devices."
12001 #: ../src/guestfs-actions.pod:3736
12003 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12004 "previous call to C<guestfs_luks_open>."
12008 #: ../src/guestfs-actions.pod:3739
12010 "Device mapper devices which correspond to logical volumes are I<not> "
12011 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
12016 #: ../src/guestfs-actions.pod:3747 ../src/guestfs-actions.pod:5203
12017 msgid "(Added in 1.11.15)"
12021 #: ../src/guestfs-actions.pod:3749
12022 msgid "guestfs_list_filesystems"
12026 #: ../src/guestfs-actions.pod:3751
12030 " guestfs_list_filesystems (guestfs_h *g);\n"
12035 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2555
12037 "This inspection command looks for filesystems on partitions, block devices "
12038 "and logical volumes, returning a list of devices containing filesystems and "
12043 #: ../src/guestfs-actions.pod:3758 ../fish/guestfish-actions.pod:2559
12045 "The return value is a hash, where the keys are the devices containing "
12046 "filesystems, and the values are the filesystem types. For example:"
12050 #: ../src/guestfs-actions.pod:3762 ../fish/guestfish-actions.pod:2563
12053 " \"/dev/sda1\" => \"ntfs\"\n"
12054 " \"/dev/sda2\" => \"ext2\"\n"
12055 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12056 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12061 #: ../src/guestfs-actions.pod:3767 ../fish/guestfish-actions.pod:2568
12063 "The value can have the special value \"unknown\", meaning the content of the "
12064 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12068 #: ../src/guestfs-actions.pod:3771
12070 "This command runs other libguestfs commands, which might include "
12071 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12072 "soon after launch and only when nothing is mounted."
12076 #: ../src/guestfs-actions.pod:3775
12078 "Not all of the filesystems returned will be mountable. In particular, swap "
12079 "partitions are returned in the list. Also this command does not check that "
12080 "each filesystem found is valid and mountable, and some filesystems might be "
12081 "mountable but require special options. Filesystems may not all belong to a "
12082 "single logical operating system (use C<guestfs_inspect_os> to look for "
12087 #: ../src/guestfs-actions.pod:3789 ../src/guestfs-actions.pod:5558
12088 msgid "(Added in 1.5.15)"
12092 #: ../src/guestfs-actions.pod:3791
12093 msgid "guestfs_list_partitions"
12097 #: ../src/guestfs-actions.pod:3793
12101 " guestfs_list_partitions (guestfs_h *g);\n"
12106 #: ../src/guestfs-actions.pod:3796 ../fish/guestfish-actions.pod:2588
12107 msgid "List all the partitions detected on all block devices."
12111 #: ../src/guestfs-actions.pod:3798 ../fish/guestfish-actions.pod:2590
12112 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12116 #: ../src/guestfs-actions.pod:3800
12118 "This does not return logical volumes. For that you will need to call "
12123 #: ../src/guestfs-actions.pod:3811
12128 #: ../src/guestfs-actions.pod:3813
12132 " guestfs_ll (guestfs_h *g,\n"
12133 " const char *directory);\n"
12138 #: ../src/guestfs-actions.pod:3817 ../fish/guestfish-actions.pod:2601
12140 "List the files in C<directory> (relative to the root directory, there is no "
12141 "cwd) in the format of 'ls -la'."
12145 #: ../src/guestfs-actions.pod:3820 ../fish/guestfish-actions.pod:2604
12147 "This command is mostly useful for interactive sessions. It is I<not> "
12148 "intended that you try to parse the output string."
12152 #: ../src/guestfs-actions.pod:3828
12157 #: ../src/guestfs-actions.pod:3830
12161 " guestfs_ln (guestfs_h *g,\n"
12162 " const char *target,\n"
12163 " const char *linkname);\n"
12168 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2611
12169 msgid "This command creates a hard link using the C<ln> command."
12173 #: ../src/guestfs-actions.pod:3841
12174 msgid "guestfs_ln_f"
12178 #: ../src/guestfs-actions.pod:3843
12182 " guestfs_ln_f (guestfs_h *g,\n"
12183 " const char *target,\n"
12184 " const char *linkname);\n"
12189 #: ../src/guestfs-actions.pod:3848 ../fish/guestfish-actions.pod:2617
12191 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12192 "option removes the link (C<linkname>) if it exists already."
12196 #: ../src/guestfs-actions.pod:3855
12197 msgid "guestfs_ln_s"
12201 #: ../src/guestfs-actions.pod:3857
12205 " guestfs_ln_s (guestfs_h *g,\n"
12206 " const char *target,\n"
12207 " const char *linkname);\n"
12212 #: ../src/guestfs-actions.pod:3862 ../fish/guestfish-actions.pod:2624
12213 msgid "This command creates a symbolic link using the C<ln -s> command."
12217 #: ../src/guestfs-actions.pod:3868
12218 msgid "guestfs_ln_sf"
12222 #: ../src/guestfs-actions.pod:3870
12226 " guestfs_ln_sf (guestfs_h *g,\n"
12227 " const char *target,\n"
12228 " const char *linkname);\n"
12233 #: ../src/guestfs-actions.pod:3875 ../fish/guestfish-actions.pod:2630
12235 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12236 "option removes the link (C<linkname>) if it exists already."
12240 #: ../src/guestfs-actions.pod:3882
12241 msgid "guestfs_lremovexattr"
12245 #: ../src/guestfs-actions.pod:3884
12249 " guestfs_lremovexattr (guestfs_h *g,\n"
12250 " const char *xattr,\n"
12251 " const char *path);\n"
12256 #: ../src/guestfs-actions.pod:3889
12258 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12259 "link, then it removes an extended attribute of the link itself."
12263 #: ../src/guestfs-actions.pod:3897
12268 #: ../src/guestfs-actions.pod:3899
12272 " guestfs_ls (guestfs_h *g,\n"
12273 " const char *directory);\n"
12278 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2645
12280 "List the files in C<directory> (relative to the root directory, there is no "
12281 "cwd). The '.' and '..' entries are not returned, but hidden files are "
12286 #: ../src/guestfs-actions.pod:3907
12288 "This command is mostly useful for interactive sessions. Programs should "
12289 "probably use C<guestfs_readdir> instead."
12293 #: ../src/guestfs-actions.pod:3916
12294 msgid "guestfs_lsetxattr"
12298 #: ../src/guestfs-actions.pod:3918
12302 " guestfs_lsetxattr (guestfs_h *g,\n"
12303 " const char *xattr,\n"
12304 " const char *val,\n"
12306 " const char *path);\n"
12311 #: ../src/guestfs-actions.pod:3925
12313 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12314 "then it sets an extended attribute of the link itself."
12318 #: ../src/guestfs-actions.pod:3933
12319 msgid "guestfs_lstat"
12323 #: ../src/guestfs-actions.pod:3935
12326 " struct guestfs_stat *\n"
12327 " guestfs_lstat (guestfs_h *g,\n"
12328 " const char *path);\n"
12333 #: ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:2664 ../fish/guestfish-actions.pod:4451
12334 msgid "Returns file information for the given C<path>."
12338 #: ../src/guestfs-actions.pod:3941
12340 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12341 "link, then the link is stat-ed, not the file it refers to."
12345 #: ../src/guestfs-actions.pod:3945 ../fish/guestfish-actions.pod:2670
12346 msgid "This is the same as the C<lstat(2)> system call."
12350 #: ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:6697
12352 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12353 "error. I<The caller must call C<guestfs_free_stat> after use>."
12357 #: ../src/guestfs-actions.pod:3951 ../src/guestfs-actions.pod:6701 ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:7100
12358 msgid "(Added in 0.9.2)"
12362 #: ../src/guestfs-actions.pod:3953
12363 msgid "guestfs_lstatlist"
12367 #: ../src/guestfs-actions.pod:3955
12370 " struct guestfs_stat_list *\n"
12371 " guestfs_lstatlist (guestfs_h *g,\n"
12372 " const char *path,\n"
12373 " char *const *names);\n"
12378 #: ../src/guestfs-actions.pod:3960
12380 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12381 "files, where all files are in the directory C<path>. C<names> is the list "
12382 "of files from this directory."
12386 #: ../src/guestfs-actions.pod:3964 ../fish/guestfish-actions.pod:2680
12388 "On return you get a list of stat structs, with a one-to-one correspondence "
12389 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12390 "then the C<ino> field of that structure is set to C<-1>."
12394 #: ../src/guestfs-actions.pod:3969
12396 "This call is intended for programs that want to efficiently list a directory "
12397 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12398 "for a similarly efficient call for getting extended attributes. Very long "
12399 "directory listings might cause the protocol message size to be exceeded, "
12400 "causing this call to fail. The caller must split up such requests into "
12401 "smaller groups of names."
12405 #: ../src/guestfs-actions.pod:3977
12407 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12408 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12412 #: ../src/guestfs-actions.pod:3983
12413 msgid "guestfs_luks_add_key"
12417 #: ../src/guestfs-actions.pod:3985
12421 " guestfs_luks_add_key (guestfs_h *g,\n"
12422 " const char *device,\n"
12423 " const char *key,\n"
12424 " const char *newkey,\n"
12430 #: ../src/guestfs-actions.pod:3992 ../fish/guestfish-actions.pod:2697
12432 "This command adds a new key on LUKS device C<device>. C<key> is any "
12433 "existing key, and is used to access the device. C<newkey> is the new key to "
12434 "add. C<keyslot> is the key slot that will be replaced."
12438 #: ../src/guestfs-actions.pod:3997
12440 "Note that if C<keyslot> already contains a key, then this command will "
12441 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12445 #: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4043 ../src/guestfs-actions.pod:4066 ../src/guestfs-actions.pod:4086 ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4140
12447 "This function takes a key or passphrase parameter which could contain "
12448 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12453 #: ../src/guestfs-actions.pod:4007 ../src/guestfs-actions.pod:4047 ../src/guestfs-actions.pod:4070 ../src/guestfs-actions.pod:4090
12454 msgid "(Added in 1.5.2)"
12458 #: ../src/guestfs-actions.pod:4009
12459 msgid "guestfs_luks_close"
12463 #: ../src/guestfs-actions.pod:4011
12467 " guestfs_luks_close (guestfs_h *g,\n"
12468 " const char *device);\n"
12473 #: ../src/guestfs-actions.pod:4015
12475 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12476 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12477 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12478 "underlying block device."
12482 #: ../src/guestfs-actions.pod:4023 ../src/guestfs-actions.pod:4125 ../src/guestfs-actions.pod:4144 ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4242
12483 msgid "(Added in 1.5.1)"
12487 #: ../src/guestfs-actions.pod:4025
12488 msgid "guestfs_luks_format"
12492 #: ../src/guestfs-actions.pod:4027
12496 " guestfs_luks_format (guestfs_h *g,\n"
12497 " const char *device,\n"
12498 " const char *key,\n"
12504 #: ../src/guestfs-actions.pod:4033 ../fish/guestfish-actions.pod:2723
12506 "This command erases existing data on C<device> and formats the device as a "
12507 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12508 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12512 #: ../src/guestfs-actions.pod:4040 ../src/guestfs-actions.pod:4063 ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6500 ../src/guestfs-actions.pod:6530 ../src/guestfs-actions.pod:6563 ../src/guestfs-actions.pod:7739 ../fish/guestfish-actions.pod:2731 ../fish/guestfish-actions.pod:2744 ../fish/guestfish-actions.pod:2831 ../fish/guestfish-actions.pod:3492 ../fish/guestfish-actions.pod:4012 ../fish/guestfish-actions.pod:4322 ../fish/guestfish-actions.pod:4345 ../fish/guestfish-actions.pod:4367 ../fish/guestfish-actions.pod:5091
12514 "B<This command is dangerous. Without careful use you can easily destroy all "
12519 #: ../src/guestfs-actions.pod:4049
12520 msgid "guestfs_luks_format_cipher"
12524 #: ../src/guestfs-actions.pod:4051
12528 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12529 " const char *device,\n"
12530 " const char *key,\n"
12532 " const char *cipher);\n"
12537 #: ../src/guestfs-actions.pod:4058
12539 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12540 "set the C<cipher> used."
12544 #: ../src/guestfs-actions.pod:4072
12545 msgid "guestfs_luks_kill_slot"
12549 #: ../src/guestfs-actions.pod:4074
12553 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12554 " const char *device,\n"
12555 " const char *key,\n"
12561 #: ../src/guestfs-actions.pod:4080 ../fish/guestfish-actions.pod:2751
12563 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12564 "device C<device>. C<key> must be one of the I<other> keys."
12568 #: ../src/guestfs-actions.pod:4092
12569 msgid "guestfs_luks_open"
12573 #: ../src/guestfs-actions.pod:4094
12577 " guestfs_luks_open (guestfs_h *g,\n"
12578 " const char *device,\n"
12579 " const char *key,\n"
12580 " const char *mapname);\n"
12585 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2762
12587 "This command opens a block device which has been encrypted according to the "
12588 "Linux Unified Key Setup (LUKS) standard."
12592 #: ../src/guestfs-actions.pod:4103 ../fish/guestfish-actions.pod:2765
12593 msgid "C<device> is the encrypted block device or partition."
12597 #: ../src/guestfs-actions.pod:4105 ../fish/guestfish-actions.pod:2767
12599 "The caller must supply one of the keys associated with the LUKS block "
12600 "device, in the C<key> parameter."
12604 #: ../src/guestfs-actions.pod:4108 ../fish/guestfish-actions.pod:2770
12606 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12607 "writes to this block device are decrypted from and encrypted to the "
12608 "underlying C<device> respectively."
12612 #: ../src/guestfs-actions.pod:4112
12614 "If this block device contains LVM volume groups, then calling "
12615 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12620 #: ../src/guestfs-actions.pod:4116
12621 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
12625 #: ../src/guestfs-actions.pod:4127
12626 msgid "guestfs_luks_open_ro"
12630 #: ../src/guestfs-actions.pod:4129
12634 " guestfs_luks_open_ro (guestfs_h *g,\n"
12635 " const char *device,\n"
12636 " const char *key,\n"
12637 " const char *mapname);\n"
12642 #: ../src/guestfs-actions.pod:4135
12644 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12649 #: ../src/guestfs-actions.pod:4146
12650 msgid "guestfs_lvcreate"
12654 #: ../src/guestfs-actions.pod:4148
12658 " guestfs_lvcreate (guestfs_h *g,\n"
12659 " const char *logvol,\n"
12660 " const char *volgroup,\n"
12666 #: ../src/guestfs-actions.pod:4154 ../fish/guestfish-actions.pod:2798
12668 "This creates an LVM logical volume called C<logvol> on the volume group "
12669 "C<volgroup>, with C<size> megabytes."
12673 #: ../src/guestfs-actions.pod:4161
12674 msgid "guestfs_lvm_canonical_lv_name"
12678 #: ../src/guestfs-actions.pod:4163
12682 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12683 " const char *lvname);\n"
12688 #: ../src/guestfs-actions.pod:4167 ../fish/guestfish-actions.pod:2805
12690 "This converts alternative naming schemes for LVs that you might find to the "
12691 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12696 #: ../src/guestfs-actions.pod:4171 ../fish/guestfish-actions.pod:2809
12698 "This command returns an error if the C<lvname> parameter does not refer to a "
12703 #: ../src/guestfs-actions.pod:4174
12704 msgid "See also C<guestfs_is_lv>."
12708 #: ../src/guestfs-actions.pod:4179
12709 msgid "(Added in 1.5.24)"
12713 #: ../src/guestfs-actions.pod:4181
12714 msgid "guestfs_lvm_clear_filter"
12718 #: ../src/guestfs-actions.pod:4183
12722 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12727 #: ../src/guestfs-actions.pod:4186
12729 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12730 "see every block device."
12734 #: ../src/guestfs-actions.pod:4189 ../src/guestfs-actions.pod:4231 ../fish/guestfish-actions.pod:2821 ../fish/guestfish-actions.pod:2852
12735 msgid "This command also clears the LVM cache and performs a volume group scan."
12739 #: ../src/guestfs-actions.pod:4196
12740 msgid "guestfs_lvm_remove_all"
12744 #: ../src/guestfs-actions.pod:4198
12748 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12753 #: ../src/guestfs-actions.pod:4201 ../fish/guestfish-actions.pod:2828
12755 "This command removes all LVM logical volumes, volume groups and physical "
12760 #: ../src/guestfs-actions.pod:4211
12761 msgid "guestfs_lvm_set_filter"
12765 #: ../src/guestfs-actions.pod:4213
12769 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12770 " char *const *devices);\n"
12775 #: ../src/guestfs-actions.pod:4217 ../fish/guestfish-actions.pod:2838
12777 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12778 "block devices in the list C<devices>, and will ignore all other attached "
12783 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2842
12785 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12786 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12787 "there are two types of duplication possible: either cloned PVs/VGs which "
12788 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12789 "same name. In normal operation you cannot create this situation, but you "
12790 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12791 "inside the LVM metadata."
12795 #: ../src/guestfs-actions.pod:4234 ../fish/guestfish-actions.pod:2855
12796 msgid "You can filter whole block devices or individual partitions."
12800 #: ../src/guestfs-actions.pod:4236 ../fish/guestfish-actions.pod:2857
12802 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12803 "filesystem), even if you are not filtering out that VG."
12807 #: ../src/guestfs-actions.pod:4244
12808 msgid "guestfs_lvremove"
12812 #: ../src/guestfs-actions.pod:4246
12816 " guestfs_lvremove (guestfs_h *g,\n"
12817 " const char *device);\n"
12822 #: ../src/guestfs-actions.pod:4250 ../fish/guestfish-actions.pod:2865
12824 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12825 "LV, such as C</dev/VG/LV>."
12829 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2868
12831 "You can also remove all LVs in a volume group by specifying the VG name, "
12836 #: ../src/guestfs-actions.pod:4258 ../src/guestfs-actions.pod:5655 ../src/guestfs-actions.pod:7470
12837 msgid "(Added in 1.0.13)"
12841 #: ../src/guestfs-actions.pod:4260
12842 msgid "guestfs_lvrename"
12846 #: ../src/guestfs-actions.pod:4262
12850 " guestfs_lvrename (guestfs_h *g,\n"
12851 " const char *logvol,\n"
12852 " const char *newlogvol);\n"
12857 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2875
12858 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12862 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:7483
12863 msgid "(Added in 1.0.83)"
12867 #: ../src/guestfs-actions.pod:4273
12868 msgid "guestfs_lvresize"
12872 #: ../src/guestfs-actions.pod:4275
12876 " guestfs_lvresize (guestfs_h *g,\n"
12877 " const char *device,\n"
12883 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2881
12885 "This resizes (expands or shrinks) an existing LVM logical volume to "
12886 "C<mbytes>. When reducing, data in the reduced part is lost."
12890 #: ../src/guestfs-actions.pod:4288
12891 msgid "guestfs_lvresize_free"
12895 #: ../src/guestfs-actions.pod:4290
12899 " guestfs_lvresize_free (guestfs_h *g,\n"
12900 " const char *lv,\n"
12906 #: ../src/guestfs-actions.pod:4295 ../fish/guestfish-actions.pod:2889
12908 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12909 "remaining free space in the volume group. Commonly you would call this with "
12910 "pc = 100 which expands the logical volume as much as possible, using all "
12911 "remaining free space in the volume group."
12915 #: ../src/guestfs-actions.pod:4303
12916 msgid "(Added in 1.3.3)"
12920 #: ../src/guestfs-actions.pod:4305
12921 msgid "guestfs_lvs"
12925 #: ../src/guestfs-actions.pod:4307
12929 " guestfs_lvs (guestfs_h *g);\n"
12934 #: ../src/guestfs-actions.pod:4310 ../fish/guestfish-actions.pod:2899
12936 "List all the logical volumes detected. This is the equivalent of the "
12937 "L<lvs(8)> command."
12941 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2902
12943 "This returns a list of the logical volume device names "
12944 "(eg. C</dev/VolGroup00/LogVol00>)."
12948 #: ../src/guestfs-actions.pod:4316
12949 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12953 #: ../src/guestfs-actions.pod:4324
12954 msgid "guestfs_lvs_full"
12958 #: ../src/guestfs-actions.pod:4326
12961 " struct guestfs_lvm_lv_list *\n"
12962 " guestfs_lvs_full (guestfs_h *g);\n"
12967 #: ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:2911
12969 "List all the logical volumes detected. This is the equivalent of the "
12970 "L<lvs(8)> command. The \"full\" version includes all fields."
12974 #: ../src/guestfs-actions.pod:4332
12976 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12977 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12982 #: ../src/guestfs-actions.pod:4338
12983 msgid "guestfs_lvuuid"
12987 #: ../src/guestfs-actions.pod:4340
12991 " guestfs_lvuuid (guestfs_h *g,\n"
12992 " const char *device);\n"
12997 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2918
12998 msgid "This command returns the UUID of the LVM LV C<device>."
13002 #: ../src/guestfs-actions.pod:4351
13003 msgid "guestfs_lxattrlist"
13007 #: ../src/guestfs-actions.pod:4353
13010 " struct guestfs_xattr_list *\n"
13011 " guestfs_lxattrlist (guestfs_h *g,\n"
13012 " const char *path,\n"
13013 " char *const *names);\n"
13018 #: ../src/guestfs-actions.pod:4358 ../fish/guestfish-actions.pod:2924
13020 "This call allows you to get the extended attributes of multiple files, where "
13021 "all files are in the directory C<path>. C<names> is the list of files from "
13026 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2928
13028 "On return you get a flat list of xattr structs which must be interpreted "
13029 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13030 "C<attrval> in this struct is zero-length to indicate there was an error "
13031 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13032 "number (the number of following attributes for this file, which could be "
13033 "C<\"0\">). Then after the first xattr struct are the zero or more "
13034 "attributes for the first named file. This repeats for the second and "
13035 "subsequent files."
13039 #: ../src/guestfs-actions.pod:4372
13041 "This call is intended for programs that want to efficiently list a directory "
13042 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13043 "a similarly efficient call for getting standard stats. Very long directory "
13044 "listings might cause the protocol message size to be exceeded, causing this "
13045 "call to fail. The caller must split up such requests into smaller groups of "
13050 #: ../src/guestfs-actions.pod:4386
13051 msgid "guestfs_mkdir"
13055 #: ../src/guestfs-actions.pod:4388
13059 " guestfs_mkdir (guestfs_h *g,\n"
13060 " const char *path);\n"
13065 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2950
13066 msgid "Create a directory named C<path>."
13070 #: ../src/guestfs-actions.pod:4398
13071 msgid "guestfs_mkdir_mode"
13075 #: ../src/guestfs-actions.pod:4400
13079 " guestfs_mkdir_mode (guestfs_h *g,\n"
13080 " const char *path,\n"
13086 #: ../src/guestfs-actions.pod:4405 ../fish/guestfish-actions.pod:2956
13088 "This command creates a directory, setting the initial permissions of the "
13089 "directory to C<mode>."
13093 #: ../src/guestfs-actions.pod:4408 ../fish/guestfish-actions.pod:2959
13095 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13096 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13101 #: ../src/guestfs-actions.pod:4412
13102 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13106 #: ../src/guestfs-actions.pod:4418
13107 msgid "guestfs_mkdir_p"
13111 #: ../src/guestfs-actions.pod:4420
13115 " guestfs_mkdir_p (guestfs_h *g,\n"
13116 " const char *path);\n"
13121 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:2969
13123 "Create a directory named C<path>, creating any parent directories as "
13124 "necessary. This is like the C<mkdir -p> shell command."
13128 #: ../src/guestfs-actions.pod:4431
13129 msgid "guestfs_mkdtemp"
13133 #: ../src/guestfs-actions.pod:4433
13137 " guestfs_mkdtemp (guestfs_h *g,\n"
13138 " const char *template);\n"
13143 #: ../src/guestfs-actions.pod:4437 ../fish/guestfish-actions.pod:2976
13145 "This command creates a temporary directory. The C<template> parameter "
13146 "should be a full pathname for the temporary directory name with the final "
13147 "six characters being \"XXXXXX\"."
13151 #: ../src/guestfs-actions.pod:4442 ../fish/guestfish-actions.pod:2981
13153 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13154 "being suitable for Windows filesystems."
13158 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2984
13159 msgid "The name of the temporary directory that was created is returned."
13163 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2987
13164 msgid "The temporary directory is created with mode 0700 and is owned by root."
13168 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:2990
13170 "The caller is responsible for deleting the temporary directory and its "
13171 "contents after use."
13175 #: ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:2993
13176 msgid "See also: L<mkdtemp(3)>"
13180 #: ../src/guestfs-actions.pod:4461
13181 msgid "guestfs_mke2fs_J"
13185 #: ../src/guestfs-actions.pod:4463
13189 " guestfs_mke2fs_J (guestfs_h *g,\n"
13190 " const char *fstype,\n"
13191 " int blocksize,\n"
13192 " const char *device,\n"
13193 " const char *journal);\n"
13198 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:2999
13200 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13201 "C<journal>. It is equivalent to the command:"
13205 #: ../src/guestfs-actions.pod:4474 ../fish/guestfish-actions.pod:3003
13208 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13213 #: ../src/guestfs-actions.pod:4476
13214 msgid "See also C<guestfs_mke2journal>."
13218 #: ../src/guestfs-actions.pod:4480 ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4516 ../src/guestfs-actions.pod:4532 ../src/guestfs-actions.pod:4546 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:4619 ../src/guestfs-actions.pod:4896
13219 msgid "(Added in 1.0.68)"
13223 #: ../src/guestfs-actions.pod:4482
13224 msgid "guestfs_mke2fs_JL"
13228 #: ../src/guestfs-actions.pod:4484
13232 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13233 " const char *fstype,\n"
13234 " int blocksize,\n"
13235 " const char *device,\n"
13236 " const char *label);\n"
13241 #: ../src/guestfs-actions.pod:4491 ../fish/guestfish-actions.pod:3011
13243 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13244 "the journal labeled C<label>."
13248 #: ../src/guestfs-actions.pod:4494
13249 msgid "See also C<guestfs_mke2journal_L>."
13253 #: ../src/guestfs-actions.pod:4500
13254 msgid "guestfs_mke2fs_JU"
13258 #: ../src/guestfs-actions.pod:4502
13262 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13263 " const char *fstype,\n"
13264 " int blocksize,\n"
13265 " const char *device,\n"
13266 " const char *uuid);\n"
13271 #: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:3020
13273 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13274 "the journal with UUID C<uuid>."
13278 #: ../src/guestfs-actions.pod:4512
13279 msgid "See also C<guestfs_mke2journal_U>."
13283 #: ../src/guestfs-actions.pod:4518
13284 msgid "guestfs_mke2journal"
13288 #: ../src/guestfs-actions.pod:4520
13292 " guestfs_mke2journal (guestfs_h *g,\n"
13293 " int blocksize,\n"
13294 " const char *device);\n"
13299 #: ../src/guestfs-actions.pod:4525 ../fish/guestfish-actions.pod:3029
13301 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13306 #: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3032
13309 " mke2fs -O journal_dev -b blocksize device\n"
13314 #: ../src/guestfs-actions.pod:4534
13315 msgid "guestfs_mke2journal_L"
13319 #: ../src/guestfs-actions.pod:4536
13323 " guestfs_mke2journal_L (guestfs_h *g,\n"
13324 " int blocksize,\n"
13325 " const char *label,\n"
13326 " const char *device);\n"
13331 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3038
13332 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13336 #: ../src/guestfs-actions.pod:4548
13337 msgid "guestfs_mke2journal_U"
13341 #: ../src/guestfs-actions.pod:4550
13345 " guestfs_mke2journal_U (guestfs_h *g,\n"
13346 " int blocksize,\n"
13347 " const char *uuid,\n"
13348 " const char *device);\n"
13353 #: ../src/guestfs-actions.pod:4556 ../fish/guestfish-actions.pod:3044
13354 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13358 #: ../src/guestfs-actions.pod:4562
13359 msgid "guestfs_mkfifo"
13363 #: ../src/guestfs-actions.pod:4564
13367 " guestfs_mkfifo (guestfs_h *g,\n"
13369 " const char *path);\n"
13374 #: ../src/guestfs-actions.pod:4569
13376 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13377 "is just a convenient wrapper around C<guestfs_mknod>."
13381 #: ../src/guestfs-actions.pod:4579
13382 msgid "guestfs_mkfs"
13386 #: ../src/guestfs-actions.pod:4581
13390 " guestfs_mkfs (guestfs_h *g,\n"
13391 " const char *fstype,\n"
13392 " const char *device);\n"
13397 #: ../src/guestfs-actions.pod:4586 ../fish/guestfish-actions.pod:3060
13399 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13400 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13404 #: ../src/guestfs-actions.pod:4594
13405 msgid "guestfs_mkfs_b"
13409 #: ../src/guestfs-actions.pod:4596
13413 " guestfs_mkfs_b (guestfs_h *g,\n"
13414 " const char *fstype,\n"
13415 " int blocksize,\n"
13416 " const char *device);\n"
13421 #: ../src/guestfs-actions.pod:4602
13423 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13424 "block size of the resulting filesystem. Supported block sizes depend on the "
13425 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13429 #: ../src/guestfs-actions.pod:4607 ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3073 ../fish/guestfish-actions.pod:3100
13431 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13436 #: ../src/guestfs-actions.pod:4612 ../fish/guestfish-actions.pod:3076
13438 "This function is deprecated. In new code, use the C<mkfs_opts> call "
13443 #: ../src/guestfs-actions.pod:4621
13444 msgid "guestfs_mkfs_opts"
13448 #: ../src/guestfs-actions.pod:4623
13452 " guestfs_mkfs_opts (guestfs_h *g,\n"
13453 " const char *fstype,\n"
13454 " const char *device,\n"
13460 #: ../src/guestfs-actions.pod:4634
13463 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13464 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13465 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
13466 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
13471 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3087
13473 "This function creates a filesystem on C<device>. The filesystem type is "
13474 "C<fstype>, for example C<ext3>."
13478 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3094
13479 msgid "C<blocksize>"
13483 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3096
13485 "The filesystem block size. Supported block sizes depend on the filesystem "
13486 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13491 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3103
13492 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13496 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3105
13497 msgid "C<features>"
13501 #: ../src/guestfs-actions.pod:4659 ../fish/guestfish-actions.pod:3107
13502 msgid "This passes the I<-O> parameter to the external mkfs program."
13506 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3109
13508 "For certain filesystem types, this allows extra filesystem features to be "
13509 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13513 #: ../src/guestfs-actions.pod:4665 ../fish/guestfish-actions.pod:3113
13515 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13520 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3116
13525 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3118
13527 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
13528 "sets the inode size (only for ext2/3/4 filesystems at present)."
13532 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3121
13533 msgid "C<sectorsize>"
13537 #: ../src/guestfs-actions.pod:4675 ../fish/guestfish-actions.pod:3123
13539 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
13540 "sets sector size for ufs filesystem."
13544 #: ../src/guestfs-actions.pod:4682
13545 msgid "(Added in 1.7.19)"
13549 #: ../src/guestfs-actions.pod:4684
13550 msgid "guestfs_mkfs_opts_va"
13554 #: ../src/guestfs-actions.pod:4686
13558 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13559 " const char *fstype,\n"
13560 " const char *device,\n"
13561 " va_list args);\n"
13566 #: ../src/guestfs-actions.pod:4692
13567 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13571 #: ../src/guestfs-actions.pod:4696
13572 msgid "guestfs_mkfs_opts_argv"
13576 #: ../src/guestfs-actions.pod:4698
13580 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13581 " const char *fstype,\n"
13582 " const char *device,\n"
13583 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13588 #: ../src/guestfs-actions.pod:4704
13589 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13593 #: ../src/guestfs-actions.pod:4708
13594 msgid "guestfs_mkmountpoint"
13598 #: ../src/guestfs-actions.pod:4710
13602 " guestfs_mkmountpoint (guestfs_h *g,\n"
13603 " const char *exemptpath);\n"
13608 #: ../src/guestfs-actions.pod:4714
13610 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13611 "that can be used to create extra mountpoints before mounting the first "
13616 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3138
13618 "These calls are I<only> necessary in some very limited circumstances, mainly "
13619 "the case where you want to mount a mix of unrelated and/or read-only "
13620 "filesystems together."
13624 #: ../src/guestfs-actions.pod:4722 ../fish/guestfish-actions.pod:3142
13626 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13627 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13628 "inside that. You can unpack this as follows in guestfish:"
13632 #: ../src/guestfs-actions.pod:4727 ../fish/guestfish-actions.pod:3147
13635 " add-ro Fedora-11-i686-Live.iso\n"
13637 " mkmountpoint /cd\n"
13638 " mkmountpoint /sqsh\n"
13639 " mkmountpoint /ext3fs\n"
13640 " mount /dev/sda /cd\n"
13641 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13642 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13647 #: ../src/guestfs-actions.pod:4736 ../fish/guestfish-actions.pod:3156
13648 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13652 #: ../src/guestfs-actions.pod:4738
13654 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13655 "may get unexpected errors if you try to mix these calls. It is safest to "
13656 "manually unmount filesystems and remove mountpoints after use."
13660 #: ../src/guestfs-actions.pod:4742
13662 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13663 "first, so for this to work for manual mountpoints, you must ensure that the "
13664 "innermost mountpoints have the longest pathnames, as in the example code "
13669 #: ../src/guestfs-actions.pod:4747 ../fish/guestfish-actions.pod:3167
13670 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13674 #: ../src/guestfs-actions.pod:4749
13676 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13677 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13678 "can also trigger these issues."
13682 #: ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:5071 ../src/guestfs-actions.pod:6075
13683 msgid "(Added in 1.0.62)"
13687 #: ../src/guestfs-actions.pod:4757
13688 msgid "guestfs_mknod"
13692 #: ../src/guestfs-actions.pod:4759
13696 " guestfs_mknod (guestfs_h *g,\n"
13700 " const char *path);\n"
13705 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3177
13707 "This call creates block or character special devices, or named pipes "
13712 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3180
13714 "The C<mode> parameter should be the mode, using the standard constants. "
13715 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13716 "used when creating block and character special devices."
13720 #: ../src/guestfs-actions.pod:4774
13722 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13723 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13724 "regular file). These constants are available in the standard Linux header "
13725 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13726 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13727 "the appropriate constant for you."
13731 #: ../src/guestfs-actions.pod:4788
13732 msgid "guestfs_mknod_b"
13736 #: ../src/guestfs-actions.pod:4790
13740 " guestfs_mknod_b (guestfs_h *g,\n"
13744 " const char *path);\n"
13749 #: ../src/guestfs-actions.pod:4797
13751 "This call creates a block device node called C<path> with mode C<mode> and "
13752 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13753 "wrapper around C<guestfs_mknod>."
13757 #: ../src/guestfs-actions.pod:4807
13758 msgid "guestfs_mknod_c"
13762 #: ../src/guestfs-actions.pod:4809
13766 " guestfs_mknod_c (guestfs_h *g,\n"
13770 " const char *path);\n"
13775 #: ../src/guestfs-actions.pod:4816
13777 "This call creates a char device node called C<path> with mode C<mode> and "
13778 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13779 "wrapper around C<guestfs_mknod>."
13783 #: ../src/guestfs-actions.pod:4826
13784 msgid "guestfs_mkswap"
13788 #: ../src/guestfs-actions.pod:4828
13792 " guestfs_mkswap (guestfs_h *g,\n"
13793 " const char *device);\n"
13798 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3219
13799 msgid "Create a swap partition on C<device>."
13803 #: ../src/guestfs-actions.pod:4838
13804 msgid "guestfs_mkswap_L"
13808 #: ../src/guestfs-actions.pod:4840
13812 " guestfs_mkswap_L (guestfs_h *g,\n"
13813 " const char *label,\n"
13814 " const char *device);\n"
13819 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3225
13820 msgid "Create a swap partition on C<device> with label C<label>."
13824 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3227
13826 "Note that you cannot attach a swap label to a block device "
13827 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13828 "the kernel or swap tools."
13832 #: ../src/guestfs-actions.pod:4855
13833 msgid "guestfs_mkswap_U"
13837 #: ../src/guestfs-actions.pod:4857
13841 " guestfs_mkswap_U (guestfs_h *g,\n"
13842 " const char *uuid,\n"
13843 " const char *device);\n"
13848 #: ../src/guestfs-actions.pod:4862 ../fish/guestfish-actions.pod:3235
13849 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13853 #: ../src/guestfs-actions.pod:4868
13854 msgid "guestfs_mkswap_file"
13858 #: ../src/guestfs-actions.pod:4870
13862 " guestfs_mkswap_file (guestfs_h *g,\n"
13863 " const char *path);\n"
13868 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3241
13869 msgid "Create a swap file."
13873 #: ../src/guestfs-actions.pod:4876
13875 "This command just writes a swap file signature to an existing file. To "
13876 "create the file itself, use something like C<guestfs_fallocate>."
13880 #: ../src/guestfs-actions.pod:4883
13881 msgid "guestfs_modprobe"
13885 #: ../src/guestfs-actions.pod:4885
13889 " guestfs_modprobe (guestfs_h *g,\n"
13890 " const char *modulename);\n"
13895 #: ../src/guestfs-actions.pod:4889 ../fish/guestfish-actions.pod:3250
13896 msgid "This loads a kernel module in the appliance."
13900 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3252
13902 "The kernel module must have been whitelisted when libguestfs was built (see "
13903 "C<appliance/kmod.whitelist.in> in the source)."
13907 #: ../src/guestfs-actions.pod:4898
13908 msgid "guestfs_mount"
13912 #: ../src/guestfs-actions.pod:4900
13916 " guestfs_mount (guestfs_h *g,\n"
13917 " const char *device,\n"
13918 " const char *mountpoint);\n"
13923 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3259
13925 "Mount a guest disk at a position in the filesystem. Block devices are named "
13926 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13927 "those block devices contain partitions, they will have the usual names "
13928 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13932 #: ../src/guestfs-actions.pod:4911 ../fish/guestfish-actions.pod:3265
13934 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13935 "mounted on C</> before others can be mounted. Other filesystems can only be "
13936 "mounted on directories which already exist."
13940 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3270
13942 "The mounted filesystem is writable, if we have sufficient permissions on the "
13943 "underlying device."
13947 #: ../src/guestfs-actions.pod:4919
13949 "B<Important note:> When you use this call, the filesystem options C<sync> "
13950 "and C<noatime> are set implicitly. This was originally done because we "
13951 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13952 "very large negative performance impact and negligible effect on "
13953 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13954 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13955 "(use an empty string for the first parameter if you don't want any options)."
13959 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3283
13961 "This function is deprecated. In new code, use the C<mount_options> call "
13966 #: ../src/guestfs-actions.pod:4940
13967 msgid "guestfs_mount_9p"
13971 #: ../src/guestfs-actions.pod:4942
13975 " guestfs_mount_9p (guestfs_h *g,\n"
13976 " const char *mounttag,\n"
13977 " const char *mountpoint,\n"
13983 #: ../src/guestfs-actions.pod:4953
13986 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
13991 #: ../src/guestfs-actions.pod:4955 ../fish/guestfish-actions.pod:3294
13993 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
13998 #: ../src/guestfs-actions.pod:4958 ../fish/guestfish-actions.pod:3297
14000 "If required, C<trans=virtio> will be automatically added to the options. "
14001 "Any other options required can be passed in the optional C<options> "
14006 #: ../src/guestfs-actions.pod:4966
14007 msgid "guestfs_mount_9p_va"
14011 #: ../src/guestfs-actions.pod:4968
14015 " guestfs_mount_9p_va (guestfs_h *g,\n"
14016 " const char *mounttag,\n"
14017 " const char *mountpoint,\n"
14018 " va_list args);\n"
14023 #: ../src/guestfs-actions.pod:4974
14024 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
14028 #: ../src/guestfs-actions.pod:4978
14029 msgid "guestfs_mount_9p_argv"
14033 #: ../src/guestfs-actions.pod:4980
14037 " guestfs_mount_9p_argv (guestfs_h *g,\n"
14038 " const char *mounttag,\n"
14039 " const char *mountpoint,\n"
14040 " const struct guestfs_mount_9p_argv *optargs);\n"
14045 #: ../src/guestfs-actions.pod:4986
14046 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
14050 #: ../src/guestfs-actions.pod:4990
14051 msgid "guestfs_mount_loop"
14055 #: ../src/guestfs-actions.pod:4992
14059 " guestfs_mount_loop (guestfs_h *g,\n"
14060 " const char *file,\n"
14061 " const char *mountpoint);\n"
14066 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3307
14068 "This command lets you mount C<file> (a filesystem image in a file) on a "
14069 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14074 #: ../src/guestfs-actions.pod:5005
14075 msgid "guestfs_mount_options"
14079 #: ../src/guestfs-actions.pod:5007
14083 " guestfs_mount_options (guestfs_h *g,\n"
14084 " const char *options,\n"
14085 " const char *device,\n"
14086 " const char *mountpoint);\n"
14091 #: ../src/guestfs-actions.pod:5013
14093 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14094 "the mount options as for the L<mount(8)> I<-o> flag."
14098 #: ../src/guestfs-actions.pod:5017 ../fish/guestfish-actions.pod:3319
14100 "If the C<options> parameter is an empty string, then no options are passed "
14101 "(all options default to whatever the filesystem uses)."
14105 #: ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5037 ../src/guestfs-actions.pod:5054
14106 msgid "(Added in 1.0.10)"
14110 #: ../src/guestfs-actions.pod:5025
14111 msgid "guestfs_mount_ro"
14115 #: ../src/guestfs-actions.pod:5027
14119 " guestfs_mount_ro (guestfs_h *g,\n"
14120 " const char *device,\n"
14121 " const char *mountpoint);\n"
14126 #: ../src/guestfs-actions.pod:5032
14128 "This is the same as the C<guestfs_mount> command, but it mounts the "
14129 "filesystem with the read-only (I<-o ro>) flag."
14133 #: ../src/guestfs-actions.pod:5039
14134 msgid "guestfs_mount_vfs"
14138 #: ../src/guestfs-actions.pod:5041
14142 " guestfs_mount_vfs (guestfs_h *g,\n"
14143 " const char *options,\n"
14144 " const char *vfstype,\n"
14145 " const char *device,\n"
14146 " const char *mountpoint);\n"
14151 #: ../src/guestfs-actions.pod:5048
14153 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14154 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
14159 #: ../src/guestfs-actions.pod:5056
14160 msgid "guestfs_mountpoints"
14164 #: ../src/guestfs-actions.pod:5058
14168 " guestfs_mountpoints (guestfs_h *g);\n"
14173 #: ../src/guestfs-actions.pod:5061
14175 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14176 "devices. This one returns a hash table (map) of device name to directory "
14177 "where the device is mounted."
14181 #: ../src/guestfs-actions.pod:5073
14182 msgid "guestfs_mounts"
14186 #: ../src/guestfs-actions.pod:5075
14190 " guestfs_mounts (guestfs_h *g);\n"
14195 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3350
14197 "This returns the list of currently mounted filesystems. It returns the list "
14198 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14202 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3353
14203 msgid "Some internal mounts are not shown."
14207 #: ../src/guestfs-actions.pod:5083
14208 msgid "See also: C<guestfs_mountpoints>"
14212 #: ../src/guestfs-actions.pod:5091
14217 #: ../src/guestfs-actions.pod:5093
14221 " guestfs_mv (guestfs_h *g,\n"
14222 " const char *src,\n"
14223 " const char *dest);\n"
14228 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3361
14230 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14231 "destination filename or destination directory."
14235 #: ../src/guestfs-actions.pod:5105
14236 msgid "guestfs_ntfs_3g_probe"
14240 #: ../src/guestfs-actions.pod:5107
14244 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14246 " const char *device);\n"
14251 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3368
14253 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14254 "C<device> for mountability. (Not all NTFS volumes can be mounted "
14255 "read-write, and some cannot be mounted at all)."
14259 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3372
14261 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14262 "can be mounted read-write. Set it to false if you want to test if the "
14263 "volume can be mounted read-only."
14267 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3376
14269 "The return value is an integer which C<0> if the operation would succeed, or "
14270 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14274 #: ../src/guestfs-actions.pod:5126
14275 msgid "(Added in 1.0.43)"
14279 #: ../src/guestfs-actions.pod:5128
14280 msgid "guestfs_ntfsresize"
14284 #: ../src/guestfs-actions.pod:5130
14288 " guestfs_ntfsresize (guestfs_h *g,\n"
14289 " const char *device);\n"
14294 #: ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5173 ../fish/guestfish-actions.pod:3384 ../fish/guestfish-actions.pod:3408
14296 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14297 "size of the underlying device."
14301 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3387
14303 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14304 "consistency check (for safety). You have to boot into Windows to perform "
14305 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14306 "resize filesystems which have been marked in this way. So in effect it is "
14307 "not possible to call ntfsresize multiple times on a single filesystem "
14308 "without booting into Windows between each resize."
14312 #: ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5199 ../fish/guestfish-actions.pod:3395 ../fish/guestfish-actions.pod:3434
14313 msgid "See also L<ntfsresize(8)>."
14317 #: ../src/guestfs-actions.pod:5149 ../src/guestfs-actions.pod:5239 ../fish/guestfish-actions.pod:3397 ../fish/guestfish-actions.pod:3445
14319 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
14324 #: ../src/guestfs-actions.pod:5158
14325 msgid "guestfs_ntfsresize_opts"
14329 #: ../src/guestfs-actions.pod:5160
14333 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
14334 " const char *device,\n"
14340 #: ../src/guestfs-actions.pod:5170
14343 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
14344 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
14349 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3417
14351 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
14352 "resized to fit the container (eg. partition)."
14356 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3420
14361 #: ../src/guestfs-actions.pod:5187 ../fish/guestfish-actions.pod:3422
14363 "If this option is true, then force the resize of the filesystem even if the "
14364 "filesystem is marked as requiring a consistency check."
14368 #: ../src/guestfs-actions.pod:5190
14370 "After the resize operation, the filesystem is always marked as requiring a "
14371 "consistency check (for safety). You have to boot into Windows to perform "
14372 "this check and clear this condition. If you I<don't> set the C<force> "
14373 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
14374 "times on a single filesystem without booting into Windows between each "
14379 #: ../src/guestfs-actions.pod:5205
14380 msgid "guestfs_ntfsresize_opts_va"
14384 #: ../src/guestfs-actions.pod:5207
14388 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
14389 " const char *device,\n"
14390 " va_list args);\n"
14395 #: ../src/guestfs-actions.pod:5212
14396 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
14400 #: ../src/guestfs-actions.pod:5216
14401 msgid "guestfs_ntfsresize_opts_argv"
14405 #: ../src/guestfs-actions.pod:5218
14409 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
14410 " const char *device,\n"
14411 " const struct guestfs_ntfsresize_opts_argv "
14417 #: ../src/guestfs-actions.pod:5223
14418 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
14422 #: ../src/guestfs-actions.pod:5227
14423 msgid "guestfs_ntfsresize_size"
14427 #: ../src/guestfs-actions.pod:5229
14431 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14432 " const char *device,\n"
14433 " int64_t size);\n"
14438 #: ../src/guestfs-actions.pod:5234
14440 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14441 "to specify the new size (in bytes) explicitly."
14445 #: ../src/guestfs-actions.pod:5246 ../src/guestfs-actions.pod:5682 ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:7625
14446 msgid "(Added in 1.3.14)"
14450 #: ../src/guestfs-actions.pod:5248
14451 msgid "guestfs_part_add"
14455 #: ../src/guestfs-actions.pod:5250
14459 " guestfs_part_add (guestfs_h *g,\n"
14460 " const char *device,\n"
14461 " const char *prlogex,\n"
14462 " int64_t startsect,\n"
14463 " int64_t endsect);\n"
14468 #: ../src/guestfs-actions.pod:5257
14470 "This command adds a partition to C<device>. If there is no partition table "
14471 "on the device, call C<guestfs_part_init> first."
14475 #: ../src/guestfs-actions.pod:5260 ../fish/guestfish-actions.pod:3459
14477 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14478 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14479 "C<logical>) and C<e> (or C<extended>) partition types."
14483 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3464
14485 "C<startsect> and C<endsect> are the start and end of the partition in "
14486 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14487 "from the end of the disk (C<-1> is the last sector)."
14491 #: ../src/guestfs-actions.pod:5269
14493 "Creating a partition which covers the whole disk is not so easy. Use "
14494 "C<guestfs_part_disk> to do that."
14498 #: ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5365 ../src/guestfs-actions.pod:5443 ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5540
14499 msgid "(Added in 1.0.78)"
14503 #: ../src/guestfs-actions.pod:5276
14504 msgid "guestfs_part_del"
14508 #: ../src/guestfs-actions.pod:5278
14512 " guestfs_part_del (guestfs_h *g,\n"
14513 " const char *device,\n"
14519 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3475
14520 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14524 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3477
14526 "Note that in the case of MBR partitioning, deleting an extended partition "
14527 "also deletes any logical partitions it contains."
14531 #: ../src/guestfs-actions.pod:5293
14532 msgid "guestfs_part_disk"
14536 #: ../src/guestfs-actions.pod:5295
14540 " guestfs_part_disk (guestfs_h *g,\n"
14541 " const char *device,\n"
14542 " const char *parttype);\n"
14547 #: ../src/guestfs-actions.pod:5300
14549 "This command is simply a combination of C<guestfs_part_init> followed by "
14550 "C<guestfs_part_add> to create a single primary partition covering the whole "
14555 #: ../src/guestfs-actions.pod:5304
14557 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14558 "possible values are described in C<guestfs_part_init>."
14562 #: ../src/guestfs-actions.pod:5314
14563 msgid "guestfs_part_get_bootable"
14567 #: ../src/guestfs-actions.pod:5316
14571 " guestfs_part_get_bootable (guestfs_h *g,\n"
14572 " const char *device,\n"
14578 #: ../src/guestfs-actions.pod:5321 ../fish/guestfish-actions.pod:3499
14580 "This command returns true if the partition C<partnum> on C<device> has the "
14581 "bootable flag set."
14585 #: ../src/guestfs-actions.pod:5324
14586 msgid "See also C<guestfs_part_set_bootable>."
14590 #: ../src/guestfs-actions.pod:5330
14591 msgid "guestfs_part_get_mbr_id"
14595 #: ../src/guestfs-actions.pod:5332
14599 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14600 " const char *device,\n"
14606 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3508
14608 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14609 "partition C<partnum>."
14613 #: ../src/guestfs-actions.pod:5340 ../src/guestfs-actions.pod:5516
14615 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14616 "undefined results for other partition table types (see "
14617 "C<guestfs_part_get_parttype>)."
14621 #: ../src/guestfs-actions.pod:5348
14622 msgid "guestfs_part_get_parttype"
14626 #: ../src/guestfs-actions.pod:5350
14630 " guestfs_part_get_parttype (guestfs_h *g,\n"
14631 " const char *device);\n"
14636 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3519
14638 "This command examines the partition table on C<device> and returns the "
14639 "partition table type (format) being used."
14643 #: ../src/guestfs-actions.pod:5357
14645 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14646 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14647 "possible, although unusual. See C<guestfs_part_init> for a full list."
14651 #: ../src/guestfs-actions.pod:5367
14652 msgid "guestfs_part_init"
14656 #: ../src/guestfs-actions.pod:5369
14660 " guestfs_part_init (guestfs_h *g,\n"
14661 " const char *device,\n"
14662 " const char *parttype);\n"
14667 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3531
14669 "This creates an empty partition table on C<device> of one of the partition "
14670 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14671 "(for large disks)."
14675 #: ../src/guestfs-actions.pod:5378
14677 "Initially there are no partitions. Following this, you should call "
14678 "C<guestfs_part_add> for each partition required."
14682 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3538
14683 msgid "Possible values for C<parttype> are:"
14687 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3542
14688 msgid "B<efi> | B<gpt>"
14692 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3544
14693 msgid "Intel EFI / GPT partition table."
14697 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3546
14699 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14700 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14701 "the C<mbr> format."
14705 #: ../src/guestfs-actions.pod:5393 ../fish/guestfish-actions.pod:3550
14706 msgid "B<mbr> | B<msdos>"
14710 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3552
14712 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14713 "Windows. This partition type will B<only> work for device sizes up to 2 "
14714 "TB. For large disks we recommend using C<gpt>."
14718 #: ../src/guestfs-actions.pod:5402 ../fish/guestfish-actions.pod:3559
14719 msgid "Other partition table types that may work but are not supported include:"
14723 #: ../src/guestfs-actions.pod:5407 ../fish/guestfish-actions.pod:3564
14728 #: ../src/guestfs-actions.pod:5409 ../fish/guestfish-actions.pod:3566
14729 msgid "AIX disk labels."
14733 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3568
14734 msgid "B<amiga> | B<rdb>"
14738 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3570
14739 msgid "Amiga \"Rigid Disk Block\" format."
14743 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3572
14748 #: ../src/guestfs-actions.pod:5417 ../fish/guestfish-actions.pod:3574
14749 msgid "BSD disk labels."
14753 #: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:3576
14758 #: ../src/guestfs-actions.pod:5421 ../fish/guestfish-actions.pod:3578
14759 msgid "DASD, used on IBM mainframes."
14763 #: ../src/guestfs-actions.pod:5423 ../fish/guestfish-actions.pod:3580
14768 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3582
14769 msgid "MIPS/SGI volumes."
14773 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3584
14778 #: ../src/guestfs-actions.pod:5429 ../fish/guestfish-actions.pod:3586
14779 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14783 #: ../src/guestfs-actions.pod:5431 ../fish/guestfish-actions.pod:3588
14788 #: ../src/guestfs-actions.pod:5433 ../fish/guestfish-actions.pod:3590
14789 msgid "NEC PC-98 format, common in Japan apparently."
14793 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3592
14798 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3594
14799 msgid "Sun disk labels."
14803 #: ../src/guestfs-actions.pod:5445
14804 msgid "guestfs_part_list"
14808 #: ../src/guestfs-actions.pod:5447
14811 " struct guestfs_partition_list *\n"
14812 " guestfs_part_list (guestfs_h *g,\n"
14813 " const char *device);\n"
14818 #: ../src/guestfs-actions.pod:5451 ../fish/guestfish-actions.pod:3602
14820 "This command parses the partition table on C<device> and returns the list of "
14821 "partitions found."
14825 #: ../src/guestfs-actions.pod:5454 ../fish/guestfish-actions.pod:3605
14826 msgid "The fields in the returned structure are:"
14830 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3609
14831 msgid "B<part_num>"
14835 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3611
14836 msgid "Partition number, counting from 1."
14840 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3613
14841 msgid "B<part_start>"
14845 #: ../src/guestfs-actions.pod:5464
14847 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14848 "the device's sector size, see C<guestfs_blockdev_getss>."
14852 #: ../src/guestfs-actions.pod:5467 ../fish/guestfish-actions.pod:3618
14853 msgid "B<part_end>"
14857 #: ../src/guestfs-actions.pod:5469 ../fish/guestfish-actions.pod:3620
14858 msgid "End of the partition in bytes."
14862 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3622
14863 msgid "B<part_size>"
14867 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3624
14868 msgid "Size of the partition in bytes."
14872 #: ../src/guestfs-actions.pod:5477
14874 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14875 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14880 #: ../src/guestfs-actions.pod:5483
14881 msgid "guestfs_part_set_bootable"
14885 #: ../src/guestfs-actions.pod:5485
14889 " guestfs_part_set_bootable (guestfs_h *g,\n"
14890 " const char *device,\n"
14892 " int bootable);\n"
14897 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3632
14899 "This sets the bootable flag on partition numbered C<partnum> on device "
14900 "C<device>. Note that partitions are numbered from 1."
14904 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3635
14906 "The bootable flag is used by some operating systems (notably Windows) to "
14907 "determine which partition to boot from. It is by no means universally "
14912 #: ../src/guestfs-actions.pod:5502
14913 msgid "guestfs_part_set_mbr_id"
14917 #: ../src/guestfs-actions.pod:5504
14921 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14922 " const char *device,\n"
14929 #: ../src/guestfs-actions.pod:5510 ../fish/guestfish-actions.pod:3643
14931 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14932 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14933 "documentation are in fact hexadecimal numbers, but usually documented "
14934 "without any leading \"0x\" which might be confusing."
14938 #: ../src/guestfs-actions.pod:5524
14939 msgid "guestfs_part_set_name"
14943 #: ../src/guestfs-actions.pod:5526
14947 " guestfs_part_set_name (guestfs_h *g,\n"
14948 " const char *device,\n"
14950 " const char *name);\n"
14955 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3657
14957 "This sets the partition name on partition numbered C<partnum> on device "
14958 "C<device>. Note that partitions are numbered from 1."
14962 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3660
14964 "The partition name can only be set on certain types of partition table. "
14965 "This works on C<gpt> but not on C<mbr> partitions."
14969 #: ../src/guestfs-actions.pod:5542
14970 msgid "guestfs_part_to_dev"
14974 #: ../src/guestfs-actions.pod:5544
14978 " guestfs_part_to_dev (guestfs_h *g,\n"
14979 " const char *partition);\n"
14984 #: ../src/guestfs-actions.pod:5548 ../fish/guestfish-actions.pod:3667
14986 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14987 "partition number, returning the device name (eg. \"/dev/sdb\")."
14991 #: ../src/guestfs-actions.pod:5552
14993 "The named partition must exist, for example as a string returned from "
14994 "C<guestfs_list_partitions>."
14998 #: ../src/guestfs-actions.pod:5560
14999 msgid "guestfs_ping_daemon"
15003 #: ../src/guestfs-actions.pod:5562
15007 " guestfs_ping_daemon (guestfs_h *g);\n"
15012 #: ../src/guestfs-actions.pod:5565 ../fish/guestfish-actions.pod:3678
15014 "This is a test probe into the guestfs daemon running inside the qemu "
15015 "subprocess. Calling this function checks that the daemon responds to the "
15016 "ping message, without affecting the daemon or attached block device(s) in "
15021 #: ../src/guestfs-actions.pod:5574
15022 msgid "guestfs_pread"
15026 #: ../src/guestfs-actions.pod:5576
15030 " guestfs_pread (guestfs_h *g,\n"
15031 " const char *path,\n"
15033 " int64_t offset,\n"
15034 " size_t *size_r);\n"
15039 #: ../src/guestfs-actions.pod:5583 ../fish/guestfish-actions.pod:3687
15041 "This command lets you read part of a file. It reads C<count> bytes of the "
15042 "file, starting at C<offset>, from file C<path>."
15046 #: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:5612 ../fish/guestfish-actions.pod:3690 ../fish/guestfish-actions.pod:3705
15048 "This may read fewer bytes than requested. For further details see the "
15049 "L<pread(2)> system call."
15053 #: ../src/guestfs-actions.pod:5589
15054 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15058 #: ../src/guestfs-actions.pod:5600
15059 msgid "guestfs_pread_device"
15063 #: ../src/guestfs-actions.pod:5602
15067 " guestfs_pread_device (guestfs_h *g,\n"
15068 " const char *device,\n"
15070 " int64_t offset,\n"
15071 " size_t *size_r);\n"
15076 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3702
15078 "This command lets you read part of a file. It reads C<count> bytes of "
15079 "C<device>, starting at C<offset>."
15083 #: ../src/guestfs-actions.pod:5615
15084 msgid "See also C<guestfs_pread>."
15088 #: ../src/guestfs-actions.pod:5624
15089 msgid "(Added in 1.5.21)"
15093 #: ../src/guestfs-actions.pod:5626
15094 msgid "guestfs_pvcreate"
15098 #: ../src/guestfs-actions.pod:5628
15102 " guestfs_pvcreate (guestfs_h *g,\n"
15103 " const char *device);\n"
15108 #: ../src/guestfs-actions.pod:5632 ../fish/guestfish-actions.pod:3717
15110 "This creates an LVM physical volume on the named C<device>, where C<device> "
15111 "should usually be a partition name such as C</dev/sda1>."
15115 #: ../src/guestfs-actions.pod:5640
15116 msgid "guestfs_pvremove"
15120 #: ../src/guestfs-actions.pod:5642
15124 " guestfs_pvremove (guestfs_h *g,\n"
15125 " const char *device);\n"
15130 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3725
15132 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15137 #: ../src/guestfs-actions.pod:5649 ../fish/guestfish-actions.pod:3728
15139 "The implementation uses the C<pvremove> command which refuses to wipe "
15140 "physical volumes that contain any volume groups, so you have to remove those "
15145 #: ../src/guestfs-actions.pod:5657
15146 msgid "guestfs_pvresize"
15150 #: ../src/guestfs-actions.pod:5659
15154 " guestfs_pvresize (guestfs_h *g,\n"
15155 " const char *device);\n"
15160 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3736
15162 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15163 "the new size of the underlying device."
15167 #: ../src/guestfs-actions.pod:5670
15168 msgid "guestfs_pvresize_size"
15172 #: ../src/guestfs-actions.pod:5672
15176 " guestfs_pvresize_size (guestfs_h *g,\n"
15177 " const char *device,\n"
15178 " int64_t size);\n"
15183 #: ../src/guestfs-actions.pod:5677
15185 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15186 "specify the new size (in bytes) explicitly."
15190 #: ../src/guestfs-actions.pod:5684
15191 msgid "guestfs_pvs"
15195 #: ../src/guestfs-actions.pod:5686
15199 " guestfs_pvs (guestfs_h *g);\n"
15204 #: ../src/guestfs-actions.pod:5689 ../fish/guestfish-actions.pod:3750
15206 "List all the physical volumes detected. This is the equivalent of the "
15207 "L<pvs(8)> command."
15211 #: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3753
15213 "This returns a list of just the device names that contain PVs "
15214 "(eg. C</dev/sda2>)."
15218 #: ../src/guestfs-actions.pod:5695
15219 msgid "See also C<guestfs_pvs_full>."
15223 #: ../src/guestfs-actions.pod:5703
15224 msgid "guestfs_pvs_full"
15228 #: ../src/guestfs-actions.pod:5705
15231 " struct guestfs_lvm_pv_list *\n"
15232 " guestfs_pvs_full (guestfs_h *g);\n"
15237 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3762
15239 "List all the physical volumes detected. This is the equivalent of the "
15240 "L<pvs(8)> command. The \"full\" version includes all fields."
15244 #: ../src/guestfs-actions.pod:5711
15246 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15247 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
15252 #: ../src/guestfs-actions.pod:5717
15253 msgid "guestfs_pvuuid"
15257 #: ../src/guestfs-actions.pod:5719
15261 " guestfs_pvuuid (guestfs_h *g,\n"
15262 " const char *device);\n"
15267 #: ../src/guestfs-actions.pod:5723 ../fish/guestfish-actions.pod:3769
15268 msgid "This command returns the UUID of the LVM PV C<device>."
15272 #: ../src/guestfs-actions.pod:5730
15273 msgid "guestfs_pwrite"
15277 #: ../src/guestfs-actions.pod:5732
15281 " guestfs_pwrite (guestfs_h *g,\n"
15282 " const char *path,\n"
15283 " const char *content,\n"
15284 " size_t content_size,\n"
15285 " int64_t offset);\n"
15290 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3775
15292 "This command writes to part of a file. It writes the data buffer C<content> "
15293 "to the file C<path> starting at offset C<offset>."
15297 #: ../src/guestfs-actions.pod:5742 ../fish/guestfish-actions.pod:3778
15299 "This command implements the L<pwrite(2)> system call, and like that system "
15300 "call it may not write the full data requested. The return value is the "
15301 "number of bytes that were actually written to the file. This could even be "
15302 "0, although short writes are unlikely for regular files in ordinary "
15307 #: ../src/guestfs-actions.pod:5748
15308 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15312 #: ../src/guestfs-actions.pod:5757
15313 msgid "guestfs_pwrite_device"
15317 #: ../src/guestfs-actions.pod:5759
15321 " guestfs_pwrite_device (guestfs_h *g,\n"
15322 " const char *device,\n"
15323 " const char *content,\n"
15324 " size_t content_size,\n"
15325 " int64_t offset);\n"
15330 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3793
15332 "This command writes to part of a device. It writes the data buffer "
15333 "C<content> to C<device> starting at offset C<offset>."
15337 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3796
15339 "This command implements the L<pwrite(2)> system call, and like that system "
15340 "call it may not write the full data requested (although short writes to disk "
15341 "devices and partitions are probably impossible with standard Linux kernels)."
15345 #: ../src/guestfs-actions.pod:5774
15346 msgid "See also C<guestfs_pwrite>."
15350 #: ../src/guestfs-actions.pod:5781
15351 msgid "(Added in 1.5.20)"
15355 #: ../src/guestfs-actions.pod:5783
15356 msgid "guestfs_read_file"
15360 #: ../src/guestfs-actions.pod:5785
15364 " guestfs_read_file (guestfs_h *g,\n"
15365 " const char *path,\n"
15366 " size_t *size_r);\n"
15371 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3810
15372 msgid "This calls returns the contents of the file C<path> as a buffer."
15376 #: ../src/guestfs-actions.pod:5793
15378 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15379 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15380 "function is limited in the total size of file that can be handled."
15384 #: ../src/guestfs-actions.pod:5805
15385 msgid "(Added in 1.0.63)"
15389 #: ../src/guestfs-actions.pod:5807
15390 msgid "guestfs_read_lines"
15394 #: ../src/guestfs-actions.pod:5809
15398 " guestfs_read_lines (guestfs_h *g,\n"
15399 " const char *path);\n"
15404 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3827
15406 "The file contents are returned as a list of lines. Trailing C<LF> and "
15407 "C<CRLF> character sequences are I<not> returned."
15411 #: ../src/guestfs-actions.pod:5818
15413 "Note that this function cannot correctly handle binary files (specifically, "
15414 "files containing C<\\0> character which is treated as end of line). For "
15415 "those you need to use the C<guestfs_read_file> function which has a more "
15416 "complex interface."
15420 #: ../src/guestfs-actions.pod:5829
15421 msgid "guestfs_readdir"
15425 #: ../src/guestfs-actions.pod:5831
15428 " struct guestfs_dirent_list *\n"
15429 " guestfs_readdir (guestfs_h *g,\n"
15430 " const char *dir);\n"
15435 #: ../src/guestfs-actions.pod:5835 ../fish/guestfish-actions.pod:3839
15436 msgid "This returns the list of directory entries in directory C<dir>."
15440 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3841
15442 "All entries in the directory are returned, including C<.> and C<..>. The "
15443 "entries are I<not> sorted, but returned in the same order as the underlying "
15448 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3845
15450 "Also this call returns basic file type information about each file. The "
15451 "C<ftyp> field will contain one of the following characters:"
15455 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3850
15460 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3852
15461 msgid "Block special"
15465 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3854
15470 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3856
15471 msgid "Char special"
15475 #: ../src/guestfs-actions.pod:5854 ../fish/guestfish-actions.pod:3858
15480 #: ../src/guestfs-actions.pod:5856 ../fish/guestfish-actions.pod:3860
15485 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3862
15490 #: ../src/guestfs-actions.pod:5860 ../fish/guestfish-actions.pod:3864
15491 msgid "FIFO (named pipe)"
15495 #: ../src/guestfs-actions.pod:5862 ../fish/guestfish-actions.pod:3866
15500 #: ../src/guestfs-actions.pod:5864 ../fish/guestfish-actions.pod:3868
15501 msgid "Symbolic link"
15505 #: ../src/guestfs-actions.pod:5866 ../fish/guestfish-actions.pod:3870
15510 #: ../src/guestfs-actions.pod:5868 ../fish/guestfish-actions.pod:3872
15511 msgid "Regular file"
15515 #: ../src/guestfs-actions.pod:5870 ../fish/guestfish-actions.pod:3874
15520 #: ../src/guestfs-actions.pod:5872 ../fish/guestfish-actions.pod:3876
15525 #: ../src/guestfs-actions.pod:5874 ../fish/guestfish-actions.pod:3878
15530 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3880
15531 msgid "Unknown file type"
15535 #: ../src/guestfs-actions.pod:5878 ../fish/guestfish-actions.pod:3882
15540 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3884
15541 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15545 #: ../src/guestfs-actions.pod:5885
15547 "This function is primarily intended for use by programs. To get a simple "
15548 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15549 "consumption, use C<guestfs_ll>."
15553 #: ../src/guestfs-actions.pod:5889
15555 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15556 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
15561 #: ../src/guestfs-actions.pod:5895
15562 msgid "guestfs_readlink"
15566 #: ../src/guestfs-actions.pod:5897
15570 " guestfs_readlink (guestfs_h *g,\n"
15571 " const char *path);\n"
15576 #: ../src/guestfs-actions.pod:5901 ../fish/guestfish-actions.pod:3897
15577 msgid "This command reads the target of a symbolic link."
15581 #: ../src/guestfs-actions.pod:5908
15582 msgid "guestfs_readlinklist"
15586 #: ../src/guestfs-actions.pod:5910
15590 " guestfs_readlinklist (guestfs_h *g,\n"
15591 " const char *path,\n"
15592 " char *const *names);\n"
15597 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3903
15599 "This call allows you to do a C<readlink> operation on multiple files, where "
15600 "all files are in the directory C<path>. C<names> is the list of files from "
15605 #: ../src/guestfs-actions.pod:5919 ../fish/guestfish-actions.pod:3907
15607 "On return you get a list of strings, with a one-to-one correspondence to the "
15608 "C<names> list. Each string is the value of the symbolic link."
15612 #: ../src/guestfs-actions.pod:5923 ../fish/guestfish-actions.pod:3911
15614 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15615 "result string is the empty string C<\"\">. However the whole operation is "
15616 "completed even if there were C<readlink(2)> errors, and so you can call this "
15617 "function with names where you don't know if they are symbolic links already "
15618 "(albeit slightly less efficient)."
15622 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3918
15624 "This call is intended for programs that want to efficiently list a directory "
15625 "contents without making many round-trips. Very long directory listings "
15626 "might cause the protocol message size to be exceeded, causing this call to "
15627 "fail. The caller must split up such requests into smaller groups of names."
15631 #: ../src/guestfs-actions.pod:5943
15632 msgid "guestfs_realpath"
15636 #: ../src/guestfs-actions.pod:5945
15640 " guestfs_realpath (guestfs_h *g,\n"
15641 " const char *path);\n"
15646 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:3929
15648 "Return the canonicalized absolute pathname of C<path>. The returned path "
15649 "has no C<.>, C<..> or symbolic link path elements."
15653 #: ../src/guestfs-actions.pod:5957
15654 msgid "guestfs_removexattr"
15658 #: ../src/guestfs-actions.pod:5959
15662 " guestfs_removexattr (guestfs_h *g,\n"
15663 " const char *xattr,\n"
15664 " const char *path);\n"
15669 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:3936
15670 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
15674 #: ../src/guestfs-actions.pod:5967
15675 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15679 #: ../src/guestfs-actions.pod:5973
15680 msgid "guestfs_resize2fs"
15684 #: ../src/guestfs-actions.pod:5975
15688 " guestfs_resize2fs (guestfs_h *g,\n"
15689 " const char *device);\n"
15694 #: ../src/guestfs-actions.pod:5979 ../fish/guestfish-actions.pod:3945
15696 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15697 "underlying device."
15701 #: ../src/guestfs-actions.pod:5982
15703 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15704 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15705 "sometimes gives an error about this and sometimes not. In any case, it is "
15706 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15710 #: ../src/guestfs-actions.pod:5992
15711 msgid "guestfs_resize2fs_M"
15715 #: ../src/guestfs-actions.pod:5994
15719 " guestfs_resize2fs_M (guestfs_h *g,\n"
15720 " const char *device);\n"
15725 #: ../src/guestfs-actions.pod:5998
15727 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15728 "resized to its minimum size. This works like the I<-M> option to the "
15729 "C<resize2fs> command."
15733 #: ../src/guestfs-actions.pod:6002
15735 "To get the resulting size of the filesystem you should call "
15736 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15737 "These two numbers, multiplied together, give the resulting size of the "
15738 "minimal filesystem in bytes."
15742 #: ../src/guestfs-actions.pod:6011
15743 msgid "guestfs_resize2fs_size"
15747 #: ../src/guestfs-actions.pod:6013
15751 " guestfs_resize2fs_size (guestfs_h *g,\n"
15752 " const char *device,\n"
15753 " int64_t size);\n"
15758 #: ../src/guestfs-actions.pod:6018
15760 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15761 "to specify the new size (in bytes) explicitly."
15765 #: ../src/guestfs-actions.pod:6025
15770 #: ../src/guestfs-actions.pod:6027
15774 " guestfs_rm (guestfs_h *g,\n"
15775 " const char *path);\n"
15780 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:3978
15781 msgid "Remove the single file C<path>."
15785 #: ../src/guestfs-actions.pod:6037
15786 msgid "guestfs_rm_rf"
15790 #: ../src/guestfs-actions.pod:6039
15794 " guestfs_rm_rf (guestfs_h *g,\n"
15795 " const char *path);\n"
15800 #: ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:3984
15802 "Remove the file or directory C<path>, recursively removing the contents if "
15803 "its a directory. This is like the C<rm -rf> shell command."
15807 #: ../src/guestfs-actions.pod:6051
15808 msgid "guestfs_rmdir"
15812 #: ../src/guestfs-actions.pod:6053
15816 " guestfs_rmdir (guestfs_h *g,\n"
15817 " const char *path);\n"
15822 #: ../src/guestfs-actions.pod:6057 ../fish/guestfish-actions.pod:3992
15823 msgid "Remove the single directory C<path>."
15827 #: ../src/guestfs-actions.pod:6063
15828 msgid "guestfs_rmmountpoint"
15832 #: ../src/guestfs-actions.pod:6065
15836 " guestfs_rmmountpoint (guestfs_h *g,\n"
15837 " const char *exemptpath);\n"
15842 #: ../src/guestfs-actions.pod:6069
15844 "This calls removes a mountpoint that was previously created with "
15845 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15849 #: ../src/guestfs-actions.pod:6077
15850 msgid "guestfs_scrub_device"
15854 #: ../src/guestfs-actions.pod:6079
15858 " guestfs_scrub_device (guestfs_h *g,\n"
15859 " const char *device);\n"
15864 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4006
15866 "This command writes patterns over C<device> to make data retrieval more "
15871 #: ../src/guestfs-actions.pod:6086 ../src/guestfs-actions.pod:6107 ../src/guestfs-actions.pod:6126 ../fish/guestfish-actions.pod:4009 ../fish/guestfish-actions.pod:4024 ../fish/guestfish-actions.pod:4037
15873 "It is an interface to the L<scrub(1)> program. See that manual page for "
15878 #: ../src/guestfs-actions.pod:6094 ../src/guestfs-actions.pod:6112 ../src/guestfs-actions.pod:6131
15879 msgid "(Added in 1.0.52)"
15883 #: ../src/guestfs-actions.pod:6096
15884 msgid "guestfs_scrub_file"
15888 #: ../src/guestfs-actions.pod:6098
15892 " guestfs_scrub_file (guestfs_h *g,\n"
15893 " const char *file);\n"
15898 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4019
15900 "This command writes patterns over a file to make data retrieval more "
15905 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4022
15906 msgid "The file is I<removed> after scrubbing."
15910 #: ../src/guestfs-actions.pod:6114
15911 msgid "guestfs_scrub_freespace"
15915 #: ../src/guestfs-actions.pod:6116
15919 " guestfs_scrub_freespace (guestfs_h *g,\n"
15920 " const char *dir);\n"
15925 #: ../src/guestfs-actions.pod:6120
15927 "This command creates the directory C<dir> and then fills it with files until "
15928 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15929 "and deletes them. The intention is to scrub any free space on the partition "
15930 "containing C<dir>."
15934 #: ../src/guestfs-actions.pod:6133
15935 msgid "guestfs_set_append"
15939 #: ../src/guestfs-actions.pod:6135
15943 " guestfs_set_append (guestfs_h *g,\n"
15944 " const char *append);\n"
15949 #: ../src/guestfs-actions.pod:6139 ../fish/guestfish-actions.pod:4046
15951 "This function is used to add additional options to the guest kernel command "
15956 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4049
15958 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15959 "environment variable."
15963 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4052
15965 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15966 "(libguestfs always adds a few of its own)."
15970 #: ../src/guestfs-actions.pod:6152
15971 msgid "guestfs_set_attach_method"
15975 #: ../src/guestfs-actions.pod:6154
15979 " guestfs_set_attach_method (guestfs_h *g,\n"
15980 " const char *attachmethod);\n"
15985 #: ../src/guestfs-actions.pod:6158 ../fish/guestfish-actions.pod:4061
15987 "Set the method that libguestfs uses to connect to the back end guestfsd "
15988 "daemon. Possible methods are:"
15992 #: ../src/guestfs-actions.pod:6165 ../fish/guestfish-actions.pod:4068
15994 "Launch an appliance and connect to it. This is the ordinary method and the "
15999 #: ../src/guestfs-actions.pod:6168 ../fish/guestfish-actions.pod:4071
16000 msgid "C<unix:I<path>>"
16004 #: ../src/guestfs-actions.pod:6170 ../fish/guestfish-actions.pod:4073
16005 msgid "Connect to the Unix domain socket I<path>."
16009 #: ../src/guestfs-actions.pod:6172 ../fish/guestfish-actions.pod:4075
16011 "This method lets you connect to an existing daemon or (using virtio-serial) "
16012 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16013 "RUNNING DAEMONS>."
16017 #: ../src/guestfs-actions.pod:6182
16018 msgid "guestfs_set_autosync"
16022 #: ../src/guestfs-actions.pod:6184
16026 " guestfs_set_autosync (guestfs_h *g,\n"
16027 " int autosync);\n"
16032 #: ../src/guestfs-actions.pod:6188 ../fish/guestfish-actions.pod:4087
16034 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16035 "effort attempt to make filesystems consistent and synchronized when the "
16036 "handle is closed (also if the program exits without closing handles)."
16040 #: ../src/guestfs-actions.pod:6193 ../fish/guestfish-actions.pod:4092
16042 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16043 "disabled by default)."
16047 #: ../src/guestfs-actions.pod:6200
16048 msgid "guestfs_set_direct"
16052 #: ../src/guestfs-actions.pod:6202
16056 " guestfs_set_direct (guestfs_h *g,\n"
16062 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4101
16064 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16065 "passed directly through to the appliance once it is launched."
16069 #: ../src/guestfs-actions.pod:6210
16071 "One consequence of this is that log messages aren't caught by the library "
16072 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16077 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4109
16078 msgid "You probably don't want to use this unless you know what you are doing."
16082 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4112
16083 msgid "The default is disabled."
16087 #: ../src/guestfs-actions.pod:6223
16088 msgid "guestfs_set_e2label"
16092 #: ../src/guestfs-actions.pod:6225
16096 " guestfs_set_e2label (guestfs_h *g,\n"
16097 " const char *device,\n"
16098 " const char *label);\n"
16103 #: ../src/guestfs-actions.pod:6230 ../fish/guestfish-actions.pod:4118
16105 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16106 "C<label>. Filesystem labels are limited to 16 characters."
16110 #: ../src/guestfs-actions.pod:6234
16112 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16113 "the existing label on a filesystem."
16117 #: ../src/guestfs-actions.pod:6241
16118 msgid "guestfs_set_e2uuid"
16122 #: ../src/guestfs-actions.pod:6243
16126 " guestfs_set_e2uuid (guestfs_h *g,\n"
16127 " const char *device,\n"
16128 " const char *uuid);\n"
16133 #: ../src/guestfs-actions.pod:6248 ../fish/guestfish-actions.pod:4129
16135 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16136 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16137 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16141 #: ../src/guestfs-actions.pod:6253
16143 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16144 "the existing UUID of a filesystem."
16148 #: ../src/guestfs-actions.pod:6260
16149 msgid "guestfs_set_memsize"
16153 #: ../src/guestfs-actions.pod:6262
16157 " guestfs_set_memsize (guestfs_h *g,\n"
16163 #: ../src/guestfs-actions.pod:6266
16165 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16166 "This only has any effect if called before C<guestfs_launch>."
16170 #: ../src/guestfs-actions.pod:6270 ../fish/guestfish-actions.pod:4147
16172 "You can also change this by setting the environment variable "
16173 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16177 #: ../src/guestfs-actions.pod:6281
16178 msgid "guestfs_set_network"
16182 #: ../src/guestfs-actions.pod:6283
16186 " guestfs_set_network (guestfs_h *g,\n"
16192 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4160
16194 "If C<network> is true, then the network is enabled in the libguestfs "
16195 "appliance. The default is false."
16199 #: ../src/guestfs-actions.pod:6290 ../fish/guestfish-actions.pod:4163
16201 "This affects whether commands are able to access the network (see "
16202 "L<guestfs(3)/RUNNING COMMANDS>)."
16206 #: ../src/guestfs-actions.pod:6293
16208 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16213 #: ../src/guestfs-actions.pod:6300
16214 msgid "guestfs_set_path"
16218 #: ../src/guestfs-actions.pod:6302
16222 " guestfs_set_path (guestfs_h *g,\n"
16223 " const char *searchpath);\n"
16228 #: ../src/guestfs-actions.pod:6306 ../fish/guestfish-actions.pod:4175
16229 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16233 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4177
16235 "The default is C<$libdir/guestfs> unless overridden by setting "
16236 "C<LIBGUESTFS_PATH> environment variable."
16240 #: ../src/guestfs-actions.pod:6311 ../fish/guestfish-actions.pod:4180
16241 msgid "Setting C<path> to C<NULL> restores the default path."
16245 #: ../src/guestfs-actions.pod:6317
16246 msgid "guestfs_set_qemu"
16250 #: ../src/guestfs-actions.pod:6319
16254 " guestfs_set_qemu (guestfs_h *g,\n"
16255 " const char *qemu);\n"
16260 #: ../src/guestfs-actions.pod:6323 ../fish/guestfish-actions.pod:4188
16261 msgid "Set the qemu binary that we will use."
16265 #: ../src/guestfs-actions.pod:6325 ../fish/guestfish-actions.pod:4190
16266 msgid "The default is chosen when the library was compiled by the configure script."
16270 #: ../src/guestfs-actions.pod:6328 ../fish/guestfish-actions.pod:4193
16272 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16277 #: ../src/guestfs-actions.pod:6331 ../fish/guestfish-actions.pod:4196
16278 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16282 #: ../src/guestfs-actions.pod:6333 ../fish/guestfish-actions.pod:4198
16284 "Note that you should call this function as early as possible after creating "
16285 "the handle. This is because some pre-launch operations depend on testing "
16286 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16287 "don't retest features, and so you might see inconsistent results. Using the "
16288 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16289 "the qemu binary at the same time as the handle is created."
16293 #: ../src/guestfs-actions.pod:6345
16294 msgid "guestfs_set_recovery_proc"
16298 #: ../src/guestfs-actions.pod:6347
16302 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16303 " int recoveryproc);\n"
16308 #: ../src/guestfs-actions.pod:6351
16310 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16311 "not create a recovery process. The purpose of the recovery process is to "
16312 "stop runaway qemu processes in the case where the main program aborts "
16317 #: ../src/guestfs-actions.pod:6356
16319 "This only has any effect if called before C<guestfs_launch>, and the default "
16324 #: ../src/guestfs-actions.pod:6359 ../fish/guestfish-actions.pod:4220
16326 "About the only time when you would want to disable this is if the main "
16327 "process will fork itself into the background (\"daemonize\" itself). In "
16328 "this case the recovery process thinks that the main program has disappeared "
16329 "and so kills qemu, which is not very helpful."
16333 #: ../src/guestfs-actions.pod:6369
16334 msgid "guestfs_set_selinux"
16338 #: ../src/guestfs-actions.pod:6371
16342 " guestfs_set_selinux (guestfs_h *g,\n"
16348 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4232
16350 "This sets the selinux flag that is passed to the appliance at boot time. "
16351 "The default is C<selinux=0> (disabled)."
16355 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4235
16357 "Note that if SELinux is enabled, it is always in Permissive mode "
16358 "(C<enforcing=0>)."
16362 #: ../src/guestfs-actions.pod:6388
16363 msgid "guestfs_set_trace"
16367 #: ../src/guestfs-actions.pod:6390
16371 " guestfs_set_trace (guestfs_h *g,\n"
16377 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4247
16379 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16380 "return values are traced."
16384 #: ../src/guestfs-actions.pod:6397 ../fish/guestfish-actions.pod:4250
16386 "If you want to trace C API calls into libguestfs (and other libraries) then "
16387 "possibly a better way is to use the external ltrace(1) command."
16391 #: ../src/guestfs-actions.pod:6401 ../fish/guestfish-actions.pod:4254
16393 "Command traces are disabled unless the environment variable "
16394 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16398 #: ../src/guestfs-actions.pod:6404
16400 "Trace messages are normally sent to C<stderr>, unless you register a "
16401 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16405 #: ../src/guestfs-actions.pod:6412
16406 msgid "guestfs_set_verbose"
16410 #: ../src/guestfs-actions.pod:6414
16414 " guestfs_set_verbose (guestfs_h *g,\n"
16420 #: ../src/guestfs-actions.pod:6418 ../fish/guestfish-actions.pod:4267
16421 msgid "If C<verbose> is true, this turns on verbose messages."
16425 #: ../src/guestfs-actions.pod:6420 ../fish/guestfish-actions.pod:4269
16427 "Verbose messages are disabled unless the environment variable "
16428 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16432 #: ../src/guestfs-actions.pod:6423
16434 "Verbose messages are normally sent to C<stderr>, unless you register a "
16435 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16439 #: ../src/guestfs-actions.pod:6431
16440 msgid "guestfs_setcon"
16444 #: ../src/guestfs-actions.pod:6433
16448 " guestfs_setcon (guestfs_h *g,\n"
16449 " const char *context);\n"
16454 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4280
16456 "This sets the SELinux security context of the daemon to the string "
16461 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4283
16462 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16466 #: ../src/guestfs-actions.pod:6446
16467 msgid "guestfs_setxattr"
16471 #: ../src/guestfs-actions.pod:6448
16475 " guestfs_setxattr (guestfs_h *g,\n"
16476 " const char *xattr,\n"
16477 " const char *val,\n"
16479 " const char *path);\n"
16484 #: ../src/guestfs-actions.pod:6455 ../fish/guestfish-actions.pod:4289
16486 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16487 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16491 #: ../src/guestfs-actions.pod:6459
16492 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16496 #: ../src/guestfs-actions.pod:6465
16497 msgid "guestfs_sfdisk"
16501 #: ../src/guestfs-actions.pod:6467
16505 " guestfs_sfdisk (guestfs_h *g,\n"
16506 " const char *device,\n"
16510 " char *const *lines);\n"
16515 #: ../src/guestfs-actions.pod:6475 ../fish/guestfish-actions.pod:4299
16517 "This is a direct interface to the L<sfdisk(8)> program for creating "
16518 "partitions on block devices."
16522 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4302
16523 msgid "C<device> should be a block device, for example C</dev/sda>."
16527 #: ../src/guestfs-actions.pod:6480 ../fish/guestfish-actions.pod:4304
16529 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16530 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
16531 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16532 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16533 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16534 "the kernel) cannot work out the right geometry and you will need to tell it."
16538 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4312
16540 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16541 "refer to the L<sfdisk(8)> manpage."
16545 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4315
16547 "To create a single partition occupying the whole disk, you would pass "
16548 "C<lines> as a single element list, when the single element being the string "
16553 #: ../src/guestfs-actions.pod:6495
16554 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16558 #: ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6566 ../fish/guestfish-actions.pod:4325 ../fish/guestfish-actions.pod:4348 ../fish/guestfish-actions.pod:4370
16559 msgid "This function is deprecated. In new code, use the C<part_add> call instead."
16563 #: ../src/guestfs-actions.pod:6512
16564 msgid "guestfs_sfdiskM"
16568 #: ../src/guestfs-actions.pod:6514
16572 " guestfs_sfdiskM (guestfs_h *g,\n"
16573 " const char *device,\n"
16574 " char *const *lines);\n"
16579 #: ../src/guestfs-actions.pod:6519
16581 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16582 "partition sizes are specified in megabytes only (rounded to the nearest "
16583 "cylinder) and you don't need to specify the cyls, heads and sectors "
16584 "parameters which were rarely if ever used anyway."
16588 #: ../src/guestfs-actions.pod:6525
16590 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16591 "C<guestfs_part_disk>"
16595 #: ../src/guestfs-actions.pod:6542
16596 msgid "guestfs_sfdisk_N"
16600 #: ../src/guestfs-actions.pod:6544
16604 " guestfs_sfdisk_N (guestfs_h *g,\n"
16605 " const char *device,\n"
16610 " const char *line);\n"
16615 #: ../src/guestfs-actions.pod:6553 ../fish/guestfish-actions.pod:4359
16617 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16618 "(note: C<n> counts from 1)."
16622 #: ../src/guestfs-actions.pod:6556
16624 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16625 "for the cyls/heads/sectors parameters."
16629 #: ../src/guestfs-actions.pod:6559
16630 msgid "See also: C<guestfs_part_add>"
16634 #: ../src/guestfs-actions.pod:6575
16635 msgid "guestfs_sfdisk_disk_geometry"
16639 #: ../src/guestfs-actions.pod:6577
16643 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16644 " const char *device);\n"
16649 #: ../src/guestfs-actions.pod:6581
16651 "This displays the disk geometry of C<device> read from the partition table. "
16652 "Especially in the case where the underlying block device has been resized, "
16653 "this can be different from the kernel's idea of the geometry (see "
16654 "C<guestfs_sfdisk_kernel_geometry>)."
16658 #: ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:6602 ../fish/guestfish-actions.pod:4386 ../fish/guestfish-actions.pod:4395
16659 msgid "The result is in human-readable format, and not designed to be parsed."
16663 #: ../src/guestfs-actions.pod:6594
16664 msgid "guestfs_sfdisk_kernel_geometry"
16668 #: ../src/guestfs-actions.pod:6596
16672 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16673 " const char *device);\n"
16678 #: ../src/guestfs-actions.pod:6600 ../fish/guestfish-actions.pod:4393
16679 msgid "This displays the kernel's idea of the geometry of C<device>."
16683 #: ../src/guestfs-actions.pod:6610
16684 msgid "guestfs_sfdisk_l"
16688 #: ../src/guestfs-actions.pod:6612
16692 " guestfs_sfdisk_l (guestfs_h *g,\n"
16693 " const char *device);\n"
16698 #: ../src/guestfs-actions.pod:6616 ../fish/guestfish-actions.pod:4402
16700 "This displays the partition table on C<device>, in the human-readable output "
16701 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16705 #: ../src/guestfs-actions.pod:6620
16706 msgid "See also: C<guestfs_part_list>"
16710 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4408
16712 "This function is deprecated. In new code, use the C<part_list> call "
16717 #: ../src/guestfs-actions.pod:6634
16722 #: ../src/guestfs-actions.pod:6636
16726 " guestfs_sh (guestfs_h *g,\n"
16727 " const char *command);\n"
16732 #: ../src/guestfs-actions.pod:6640 ../fish/guestfish-actions.pod:4419
16734 "This call runs a command from the guest filesystem via the guest's "
16739 #: ../src/guestfs-actions.pod:6643
16740 msgid "This is like C<guestfs_command>, but passes the command to:"
16744 #: ../src/guestfs-actions.pod:6645 ../fish/guestfish-actions.pod:4424
16747 " /bin/sh -c \"command\"\n"
16752 #: ../src/guestfs-actions.pod:6647 ../fish/guestfish-actions.pod:4426
16754 "Depending on the guest's shell, this usually results in wildcards being "
16755 "expanded, shell expressions being interpolated and so on."
16759 #: ../src/guestfs-actions.pod:6651
16760 msgid "All the provisos about C<guestfs_command> apply to this call."
16764 #: ../src/guestfs-actions.pod:6658
16765 msgid "guestfs_sh_lines"
16769 #: ../src/guestfs-actions.pod:6660
16773 " guestfs_sh_lines (guestfs_h *g,\n"
16774 " const char *command);\n"
16779 #: ../src/guestfs-actions.pod:6664
16781 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16786 #: ../src/guestfs-actions.pod:6667
16787 msgid "See also: C<guestfs_command_lines>"
16791 #: ../src/guestfs-actions.pod:6675
16792 msgid "guestfs_sleep"
16796 #: ../src/guestfs-actions.pod:6677
16800 " guestfs_sleep (guestfs_h *g,\n"
16806 #: ../src/guestfs-actions.pod:6681 ../fish/guestfish-actions.pod:4445
16807 msgid "Sleep for C<secs> seconds."
16811 #: ../src/guestfs-actions.pod:6685
16812 msgid "(Added in 1.0.41)"
16816 #: ../src/guestfs-actions.pod:6687 ../src/guestfs-structs.pod:109
16817 msgid "guestfs_stat"
16821 #: ../src/guestfs-actions.pod:6689
16824 " struct guestfs_stat *\n"
16825 " guestfs_stat (guestfs_h *g,\n"
16826 " const char *path);\n"
16831 #: ../src/guestfs-actions.pod:6695 ../fish/guestfish-actions.pod:4453
16832 msgid "This is the same as the C<stat(2)> system call."
16836 #: ../src/guestfs-actions.pod:6703 ../src/guestfs-structs.pod:135
16837 msgid "guestfs_statvfs"
16841 #: ../src/guestfs-actions.pod:6705
16844 " struct guestfs_statvfs *\n"
16845 " guestfs_statvfs (guestfs_h *g,\n"
16846 " const char *path);\n"
16851 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4459
16853 "Returns file system statistics for any mounted file system. C<path> should "
16854 "be a file or directory in the mounted file system (typically it is the mount "
16855 "point itself, but it doesn't need to be)."
16859 #: ../src/guestfs-actions.pod:6713 ../fish/guestfish-actions.pod:4463
16860 msgid "This is the same as the C<statvfs(2)> system call."
16864 #: ../src/guestfs-actions.pod:6715
16866 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16867 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16871 #: ../src/guestfs-actions.pod:6721
16872 msgid "guestfs_strings"
16876 #: ../src/guestfs-actions.pod:6723
16880 " guestfs_strings (guestfs_h *g,\n"
16881 " const char *path);\n"
16886 #: ../src/guestfs-actions.pod:6727 ../fish/guestfish-actions.pod:4469
16888 "This runs the L<strings(1)> command on a file and returns the list of "
16889 "printable strings found."
16893 #: ../src/guestfs-actions.pod:6739
16894 msgid "guestfs_strings_e"
16898 #: ../src/guestfs-actions.pod:6741
16902 " guestfs_strings_e (guestfs_h *g,\n"
16903 " const char *encoding,\n"
16904 " const char *path);\n"
16909 #: ../src/guestfs-actions.pod:6746
16911 "This is like the C<guestfs_strings> command, but allows you to specify the "
16912 "encoding of strings that are looked for in the source file C<path>."
16916 #: ../src/guestfs-actions.pod:6750 ../fish/guestfish-actions.pod:4483
16917 msgid "Allowed encodings are:"
16921 #: ../src/guestfs-actions.pod:6754 ../fish/guestfish-actions.pod:4487
16926 #: ../src/guestfs-actions.pod:6756
16928 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16929 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16933 #: ../src/guestfs-actions.pod:6759 ../fish/guestfish-actions.pod:4492
16938 #: ../src/guestfs-actions.pod:6761 ../fish/guestfish-actions.pod:4494
16939 msgid "Single 8-bit-byte characters."
16943 #: ../src/guestfs-actions.pod:6763 ../fish/guestfish-actions.pod:4496
16948 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4498
16949 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16953 #: ../src/guestfs-actions.pod:6768 ../fish/guestfish-actions.pod:4501
16954 msgid "l (lower case letter L)"
16958 #: ../src/guestfs-actions.pod:6770 ../fish/guestfish-actions.pod:4503
16960 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16961 "examining binaries in Windows guests."
16965 #: ../src/guestfs-actions.pod:6773 ../fish/guestfish-actions.pod:4506
16970 #: ../src/guestfs-actions.pod:6775 ../fish/guestfish-actions.pod:4508
16971 msgid "32-bit big endian such as UCS-4BE."
16975 #: ../src/guestfs-actions.pod:6777 ../fish/guestfish-actions.pod:4510
16980 #: ../src/guestfs-actions.pod:6779 ../fish/guestfish-actions.pod:4512
16981 msgid "32-bit little endian such as UCS-4LE."
16985 #: ../src/guestfs-actions.pod:6783 ../fish/guestfish-actions.pod:4516
16986 msgid "The returned strings are transcoded to UTF-8."
16990 #: ../src/guestfs-actions.pod:6794
16991 msgid "guestfs_swapoff_device"
16995 #: ../src/guestfs-actions.pod:6796
16999 " guestfs_swapoff_device (guestfs_h *g,\n"
17000 " const char *device);\n"
17005 #: ../src/guestfs-actions.pod:6800
17007 "This command disables the libguestfs appliance swap device or partition "
17008 "named C<device>. See C<guestfs_swapon_device>."
17012 #: ../src/guestfs-actions.pod:6808
17013 msgid "guestfs_swapoff_file"
17017 #: ../src/guestfs-actions.pod:6810
17021 " guestfs_swapoff_file (guestfs_h *g,\n"
17022 " const char *file);\n"
17027 #: ../src/guestfs-actions.pod:6814 ../fish/guestfish-actions.pod:4533
17028 msgid "This command disables the libguestfs appliance swap on file."
17032 #: ../src/guestfs-actions.pod:6820
17033 msgid "guestfs_swapoff_label"
17037 #: ../src/guestfs-actions.pod:6822
17041 " guestfs_swapoff_label (guestfs_h *g,\n"
17042 " const char *label);\n"
17047 #: ../src/guestfs-actions.pod:6826 ../fish/guestfish-actions.pod:4539
17049 "This command disables the libguestfs appliance swap on labeled swap "
17054 #: ../src/guestfs-actions.pod:6833
17055 msgid "guestfs_swapoff_uuid"
17059 #: ../src/guestfs-actions.pod:6835
17063 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17064 " const char *uuid);\n"
17069 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4546
17071 "This command disables the libguestfs appliance swap partition with the given "
17076 #: ../src/guestfs-actions.pod:6846
17077 msgid "guestfs_swapon_device"
17081 #: ../src/guestfs-actions.pod:6848
17085 " guestfs_swapon_device (guestfs_h *g,\n"
17086 " const char *device);\n"
17091 #: ../src/guestfs-actions.pod:6852
17093 "This command enables the libguestfs appliance to use the swap device or "
17094 "partition named C<device>. The increased memory is made available for all "
17095 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17099 #: ../src/guestfs-actions.pod:6857 ../fish/guestfish-actions.pod:4558
17101 "Note that you should not swap to existing guest swap partitions unless you "
17102 "know what you are doing. They may contain hibernation information, or other "
17103 "information that the guest doesn't want you to trash. You also risk leaking "
17104 "information about the host to the guest this way. Instead, attach a new "
17105 "host device to the guest and swap on that."
17109 #: ../src/guestfs-actions.pod:6868
17110 msgid "guestfs_swapon_file"
17114 #: ../src/guestfs-actions.pod:6870
17118 " guestfs_swapon_file (guestfs_h *g,\n"
17119 " const char *file);\n"
17124 #: ../src/guestfs-actions.pod:6874
17126 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17131 #: ../src/guestfs-actions.pod:6881
17132 msgid "guestfs_swapon_label"
17136 #: ../src/guestfs-actions.pod:6883
17140 " guestfs_swapon_label (guestfs_h *g,\n"
17141 " const char *label);\n"
17146 #: ../src/guestfs-actions.pod:6887
17148 "This command enables swap to a labeled swap partition. See "
17149 "C<guestfs_swapon_device> for other notes."
17153 #: ../src/guestfs-actions.pod:6894
17154 msgid "guestfs_swapon_uuid"
17158 #: ../src/guestfs-actions.pod:6896
17162 " guestfs_swapon_uuid (guestfs_h *g,\n"
17163 " const char *uuid);\n"
17168 #: ../src/guestfs-actions.pod:6900
17170 "This command enables swap to a swap partition with the given UUID. See "
17171 "C<guestfs_swapon_device> for other notes."
17175 #: ../src/guestfs-actions.pod:6907
17176 msgid "guestfs_sync"
17180 #: ../src/guestfs-actions.pod:6909
17184 " guestfs_sync (guestfs_h *g);\n"
17189 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4590
17191 "This syncs the disk, so that any writes are flushed through to the "
17192 "underlying disk image."
17196 #: ../src/guestfs-actions.pod:6915 ../fish/guestfish-actions.pod:4593
17198 "You should always call this if you have modified a disk image, before "
17199 "closing the handle."
17203 #: ../src/guestfs-actions.pod:6922
17204 msgid "guestfs_tail"
17208 #: ../src/guestfs-actions.pod:6924
17212 " guestfs_tail (guestfs_h *g,\n"
17213 " const char *path);\n"
17218 #: ../src/guestfs-actions.pod:6928 ../fish/guestfish-actions.pod:4600
17219 msgid "This command returns up to the last 10 lines of a file as a list of strings."
17223 #: ../src/guestfs-actions.pod:6940
17224 msgid "guestfs_tail_n"
17228 #: ../src/guestfs-actions.pod:6942
17232 " guestfs_tail_n (guestfs_h *g,\n"
17234 " const char *path);\n"
17239 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4610
17241 "If the parameter C<nrlines> is a positive number, this returns the last "
17242 "C<nrlines> lines of the file C<path>."
17246 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4613
17248 "If the parameter C<nrlines> is a negative number, this returns lines from "
17249 "the file C<path>, starting with the C<-nrlines>th line."
17253 #: ../src/guestfs-actions.pod:6964
17254 msgid "guestfs_tar_in"
17258 #: ../src/guestfs-actions.pod:6966
17262 " guestfs_tar_in (guestfs_h *g,\n"
17263 " const char *tarfile,\n"
17264 " const char *directory);\n"
17269 #: ../src/guestfs-actions.pod:6971 ../fish/guestfish-actions.pod:4625
17271 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17272 "tar file) into C<directory>."
17276 #: ../src/guestfs-actions.pod:6974
17277 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17281 #: ../src/guestfs-actions.pod:6979 ../src/guestfs-actions.pod:6996 ../src/guestfs-actions.pod:7012 ../src/guestfs-actions.pod:7028
17282 msgid "(Added in 1.0.3)"
17286 #: ../src/guestfs-actions.pod:6981
17287 msgid "guestfs_tar_out"
17291 #: ../src/guestfs-actions.pod:6983
17295 " guestfs_tar_out (guestfs_h *g,\n"
17296 " const char *directory,\n"
17297 " const char *tarfile);\n"
17302 #: ../src/guestfs-actions.pod:6988 ../fish/guestfish-actions.pod:4637
17304 "This command packs the contents of C<directory> and downloads it to local "
17309 #: ../src/guestfs-actions.pod:6991
17311 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17312 "C<guestfs_txz_out>."
17316 #: ../src/guestfs-actions.pod:6998
17317 msgid "guestfs_tgz_in"
17321 #: ../src/guestfs-actions.pod:7000
17325 " guestfs_tgz_in (guestfs_h *g,\n"
17326 " const char *tarball,\n"
17327 " const char *directory);\n"
17332 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4649
17334 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17335 "tar file) into C<directory>."
17339 #: ../src/guestfs-actions.pod:7008
17340 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17344 #: ../src/guestfs-actions.pod:7014
17345 msgid "guestfs_tgz_out"
17349 #: ../src/guestfs-actions.pod:7016
17353 " guestfs_tgz_out (guestfs_h *g,\n"
17354 " const char *directory,\n"
17355 " const char *tarball);\n"
17360 #: ../src/guestfs-actions.pod:7021 ../fish/guestfish-actions.pod:4660
17362 "This command packs the contents of C<directory> and downloads it to local "
17367 #: ../src/guestfs-actions.pod:7024
17368 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17372 #: ../src/guestfs-actions.pod:7030
17373 msgid "guestfs_touch"
17377 #: ../src/guestfs-actions.pod:7032
17381 " guestfs_touch (guestfs_h *g,\n"
17382 " const char *path);\n"
17387 #: ../src/guestfs-actions.pod:7036 ../fish/guestfish-actions.pod:4671
17389 "Touch acts like the L<touch(1)> command. It can be used to update the "
17390 "timestamps on a file, or, if the file does not exist, to create a new "
17391 "zero-length file."
17395 #: ../src/guestfs-actions.pod:7040 ../fish/guestfish-actions.pod:4675
17397 "This command only works on regular files, and will fail on other file types "
17398 "such as directories, symbolic links, block special etc."
17402 #: ../src/guestfs-actions.pod:7047
17403 msgid "guestfs_truncate"
17407 #: ../src/guestfs-actions.pod:7049
17411 " guestfs_truncate (guestfs_h *g,\n"
17412 " const char *path);\n"
17417 #: ../src/guestfs-actions.pod:7053 ../fish/guestfish-actions.pod:4682
17419 "This command truncates C<path> to a zero-length file. The file must exist "
17424 #: ../src/guestfs-actions.pod:7060
17425 msgid "guestfs_truncate_size"
17429 #: ../src/guestfs-actions.pod:7062
17433 " guestfs_truncate_size (guestfs_h *g,\n"
17434 " const char *path,\n"
17435 " int64_t size);\n"
17440 #: ../src/guestfs-actions.pod:7067 ../fish/guestfish-actions.pod:4689
17442 "This command truncates C<path> to size C<size> bytes. The file must exist "
17447 #: ../src/guestfs-actions.pod:7070
17449 "If the current file size is less than C<size> then the file is extended to "
17450 "the required size with zero bytes. This creates a sparse file (ie. disk "
17451 "blocks are not allocated for the file until you write to it). To create a "
17452 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17456 #: ../src/guestfs-actions.pod:7080
17457 msgid "guestfs_tune2fs_l"
17461 #: ../src/guestfs-actions.pod:7082
17465 " guestfs_tune2fs_l (guestfs_h *g,\n"
17466 " const char *device);\n"
17471 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4702
17473 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17478 #: ../src/guestfs-actions.pod:7089 ../fish/guestfish-actions.pod:4705
17480 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17481 "for more details. The list of fields returned isn't clearly defined, and "
17482 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17483 "and the filesystem itself."
17487 #: ../src/guestfs-actions.pod:7102
17488 msgid "guestfs_txz_in"
17492 #: ../src/guestfs-actions.pod:7104
17496 " guestfs_txz_in (guestfs_h *g,\n"
17497 " const char *tarball,\n"
17498 " const char *directory);\n"
17503 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4714
17505 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17506 "tar file) into C<directory>."
17510 #: ../src/guestfs-actions.pod:7116
17511 msgid "guestfs_txz_out"
17515 #: ../src/guestfs-actions.pod:7118
17519 " guestfs_txz_out (guestfs_h *g,\n"
17520 " const char *directory,\n"
17521 " const char *tarball);\n"
17526 #: ../src/guestfs-actions.pod:7123 ../fish/guestfish-actions.pod:4723
17528 "This command packs the contents of C<directory> and downloads it to local "
17529 "file C<tarball> (as an xz compressed tar archive)."
17533 #: ../src/guestfs-actions.pod:7130
17534 msgid "guestfs_umask"
17538 #: ../src/guestfs-actions.pod:7132
17542 " guestfs_umask (guestfs_h *g,\n"
17548 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4732
17550 "This function sets the mask used for creating new files and device nodes to "
17555 #: ../src/guestfs-actions.pod:7139 ../fish/guestfish-actions.pod:4735
17557 "Typical umask values would be C<022> which creates new files with "
17558 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17559 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17563 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:4740
17565 "The default umask is C<022>. This is important because it means that "
17566 "directories and device nodes will be created with C<0644> or C<0755> mode "
17567 "even if you specify C<0777>."
17571 #: ../src/guestfs-actions.pod:7148
17573 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17574 "C<guestfs_mkdir>."
17578 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4747
17579 msgid "This call returns the previous umask."
17583 #: ../src/guestfs-actions.pod:7157
17584 msgid "guestfs_umount"
17588 #: ../src/guestfs-actions.pod:7159
17592 " guestfs_umount (guestfs_h *g,\n"
17593 " const char *pathordevice);\n"
17598 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4755
17600 "This unmounts the given filesystem. The filesystem may be specified either "
17601 "by its mountpoint (path) or the device which contains the filesystem."
17605 #: ../src/guestfs-actions.pod:7171
17606 msgid "guestfs_umount_all"
17610 #: ../src/guestfs-actions.pod:7173
17614 " guestfs_umount_all (guestfs_h *g);\n"
17619 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4765
17620 msgid "This unmounts all mounted filesystems."
17624 #: ../src/guestfs-actions.pod:7178 ../fish/guestfish-actions.pod:4767
17625 msgid "Some internal mounts are not unmounted by this call."
17629 #: ../src/guestfs-actions.pod:7184
17630 msgid "guestfs_upload"
17634 #: ../src/guestfs-actions.pod:7186
17638 " guestfs_upload (guestfs_h *g,\n"
17639 " const char *filename,\n"
17640 " const char *remotefilename);\n"
17645 #: ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7215 ../fish/guestfish-actions.pod:4773 ../fish/guestfish-actions.pod:4786
17646 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17650 #: ../src/guestfs-actions.pod:7196
17651 msgid "See also C<guestfs_download>."
17655 #: ../src/guestfs-actions.pod:7207
17656 msgid "guestfs_upload_offset"
17660 #: ../src/guestfs-actions.pod:7209
17664 " guestfs_upload_offset (guestfs_h *g,\n"
17665 " const char *filename,\n"
17666 " const char *remotefilename,\n"
17667 " int64_t offset);\n"
17672 #: ../src/guestfs-actions.pod:7218 ../fish/guestfish-actions.pod:4789
17674 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17675 "The intention is to overwrite parts of existing files or devices, although "
17676 "if a non-existant file is specified then it is created with a \"hole\" "
17677 "before C<offset>. The size of the data written is implicit in the size of "
17678 "the source C<filename>."
17682 #: ../src/guestfs-actions.pod:7225
17684 "Note that there is no limit on the amount of data that can be uploaded with "
17685 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17686 "full amount unless an error occurs."
17690 #: ../src/guestfs-actions.pod:7230
17691 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17695 #: ../src/guestfs-actions.pod:7241
17696 msgid "guestfs_utimens"
17700 #: ../src/guestfs-actions.pod:7243
17704 " guestfs_utimens (guestfs_h *g,\n"
17705 " const char *path,\n"
17706 " int64_t atsecs,\n"
17707 " int64_t atnsecs,\n"
17708 " int64_t mtsecs,\n"
17709 " int64_t mtnsecs);\n"
17714 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4809
17715 msgid "This command sets the timestamps of a file with nanosecond precision."
17719 #: ../src/guestfs-actions.pod:7254 ../fish/guestfish-actions.pod:4812
17721 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17726 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4815
17728 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17729 "nanoseconds from the epoch."
17733 #: ../src/guestfs-actions.pod:7260 ../fish/guestfish-actions.pod:4818
17735 "If the C<*nsecs> field contains the special value C<-1> then the "
17736 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17737 "ignored in this case)."
17741 #: ../src/guestfs-actions.pod:7264 ../fish/guestfish-actions.pod:4822
17743 "If the C<*nsecs> field contains the special value C<-2> then the "
17744 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17749 #: ../src/guestfs-actions.pod:7272 ../src/guestfs-structs.pod:175
17750 msgid "guestfs_version"
17754 #: ../src/guestfs-actions.pod:7274
17757 " struct guestfs_version *\n"
17758 " guestfs_version (guestfs_h *g);\n"
17763 #: ../src/guestfs-actions.pod:7277 ../fish/guestfish-actions.pod:4830
17764 msgid "Return the libguestfs version number that the program is linked against."
17768 #: ../src/guestfs-actions.pod:7280 ../fish/guestfish-actions.pod:4833
17770 "Note that because of dynamic linking this is not necessarily the version of "
17771 "libguestfs that you compiled against. You can compile the program, and then "
17772 "at runtime dynamically link against a completely different C<libguestfs.so> "
17777 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4838
17779 "This call was added in version C<1.0.58>. In previous versions of "
17780 "libguestfs there was no way to get the version number. From C code you can "
17781 "use dynamic linker functions to find out if this symbol exists (if it "
17782 "doesn't, then it's an earlier version)."
17786 #: ../src/guestfs-actions.pod:7291 ../fish/guestfish-actions.pod:4844
17788 "The call returns a structure with four elements. The first three (C<major>, "
17789 "C<minor> and C<release>) are numbers and correspond to the usual version "
17790 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17791 "but may be used for distro-specific information."
17795 #: ../src/guestfs-actions.pod:7297 ../fish/guestfish-actions.pod:4850
17796 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
17800 #: ../src/guestfs-actions.pod:7300 ../fish/guestfish-actions.pod:4853
17801 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17805 #: ../src/guestfs-actions.pod:7302
17807 "I<Note:> Don't use this call to test for availability of features. In "
17808 "enterprise distributions we backport features from later versions into "
17809 "earlier versions, making this an unreliable way to test for features. Use "
17810 "C<guestfs_available> instead."
17814 #: ../src/guestfs-actions.pod:7308
17816 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17817 "error. I<The caller must call C<guestfs_free_version> after use>."
17821 #: ../src/guestfs-actions.pod:7312
17822 msgid "(Added in 1.0.58)"
17826 #: ../src/guestfs-actions.pod:7314
17827 msgid "guestfs_vfs_label"
17831 #: ../src/guestfs-actions.pod:7316
17835 " guestfs_vfs_label (guestfs_h *g,\n"
17836 " const char *device);\n"
17841 #: ../src/guestfs-actions.pod:7320 ../fish/guestfish-actions.pod:4865
17842 msgid "This returns the filesystem label of the filesystem on C<device>."
17846 #: ../src/guestfs-actions.pod:7323 ../fish/guestfish-actions.pod:4868
17847 msgid "If the filesystem is unlabeled, this returns the empty string."
17851 #: ../src/guestfs-actions.pod:7325
17852 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17856 #: ../src/guestfs-actions.pod:7330 ../src/guestfs-actions.pod:7367
17857 msgid "(Added in 1.3.18)"
17861 #: ../src/guestfs-actions.pod:7332
17862 msgid "guestfs_vfs_type"
17866 #: ../src/guestfs-actions.pod:7334
17870 " guestfs_vfs_type (guestfs_h *g,\n"
17871 " const char *device);\n"
17876 #: ../src/guestfs-actions.pod:7338 ../fish/guestfish-actions.pod:4876
17878 "This command gets the filesystem type corresponding to the filesystem on "
17883 #: ../src/guestfs-actions.pod:7341 ../fish/guestfish-actions.pod:4879
17885 "For most filesystems, the result is the name of the Linux VFS module which "
17886 "would be used to mount this filesystem if you mounted it without specifying "
17887 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17891 #: ../src/guestfs-actions.pod:7351
17892 msgid "guestfs_vfs_uuid"
17896 #: ../src/guestfs-actions.pod:7353
17900 " guestfs_vfs_uuid (guestfs_h *g,\n"
17901 " const char *device);\n"
17906 #: ../src/guestfs-actions.pod:7357 ../fish/guestfish-actions.pod:4888
17907 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17911 #: ../src/guestfs-actions.pod:7360 ../fish/guestfish-actions.pod:4891
17912 msgid "If the filesystem does not have a UUID, this returns the empty string."
17916 #: ../src/guestfs-actions.pod:7362
17917 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17921 #: ../src/guestfs-actions.pod:7369
17922 msgid "guestfs_vg_activate"
17926 #: ../src/guestfs-actions.pod:7371
17930 " guestfs_vg_activate (guestfs_h *g,\n"
17932 " char *const *volgroups);\n"
17937 #: ../src/guestfs-actions.pod:7376 ../fish/guestfish-actions.pod:4899
17939 "This command activates or (if C<activate> is false) deactivates all logical "
17940 "volumes in the listed volume groups C<volgroups>."
17944 #: ../src/guestfs-actions.pod:7379 ../fish/guestfish-actions.pod:4902
17945 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17949 #: ../src/guestfs-actions.pod:7381 ../fish/guestfish-actions.pod:4904
17951 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17952 "activated or deactivated."
17956 #: ../src/guestfs-actions.pod:7388
17957 msgid "guestfs_vg_activate_all"
17961 #: ../src/guestfs-actions.pod:7390
17965 " guestfs_vg_activate_all (guestfs_h *g,\n"
17966 " int activate);\n"
17971 #: ../src/guestfs-actions.pod:7394 ../fish/guestfish-actions.pod:4911
17973 "This command activates or (if C<activate> is false) deactivates all logical "
17974 "volumes in all volume groups."
17978 #: ../src/guestfs-actions.pod:7397 ../fish/guestfish-actions.pod:4914
17979 msgid "This command is the same as running C<vgchange -a y|n>"
17983 #: ../src/guestfs-actions.pod:7403
17984 msgid "guestfs_vgcreate"
17988 #: ../src/guestfs-actions.pod:7405
17992 " guestfs_vgcreate (guestfs_h *g,\n"
17993 " const char *volgroup,\n"
17994 " char *const *physvols);\n"
17999 #: ../src/guestfs-actions.pod:7410 ../fish/guestfish-actions.pod:4920
18001 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18002 "of physical volumes C<physvols>."
18006 #: ../src/guestfs-actions.pod:7417
18007 msgid "guestfs_vglvuuids"
18011 #: ../src/guestfs-actions.pod:7419
18015 " guestfs_vglvuuids (guestfs_h *g,\n"
18016 " const char *vgname);\n"
18021 #: ../src/guestfs-actions.pod:7423 ../fish/guestfish-actions.pod:4927
18023 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18024 "volumes created in this volume group."
18028 #: ../src/guestfs-actions.pod:7426
18030 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18031 "associate logical volumes and volume groups."
18035 #: ../src/guestfs-actions.pod:7429
18036 msgid "See also C<guestfs_vgpvuuids>."
18040 #: ../src/guestfs-actions.pod:7437
18041 msgid "guestfs_vgpvuuids"
18045 #: ../src/guestfs-actions.pod:7439
18049 " guestfs_vgpvuuids (guestfs_h *g,\n"
18050 " const char *vgname);\n"
18055 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:4939
18057 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18058 "volumes that this volume group resides on."
18062 #: ../src/guestfs-actions.pod:7446
18064 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18065 "associate physical volumes and volume groups."
18069 #: ../src/guestfs-actions.pod:7449
18070 msgid "See also C<guestfs_vglvuuids>."
18074 #: ../src/guestfs-actions.pod:7457
18075 msgid "guestfs_vgremove"
18079 #: ../src/guestfs-actions.pod:7459
18083 " guestfs_vgremove (guestfs_h *g,\n"
18084 " const char *vgname);\n"
18089 #: ../src/guestfs-actions.pod:7463 ../fish/guestfish-actions.pod:4951
18090 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18094 #: ../src/guestfs-actions.pod:7465 ../fish/guestfish-actions.pod:4953
18095 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
18099 #: ../src/guestfs-actions.pod:7472
18100 msgid "guestfs_vgrename"
18104 #: ../src/guestfs-actions.pod:7474
18108 " guestfs_vgrename (guestfs_h *g,\n"
18109 " const char *volgroup,\n"
18110 " const char *newvolgroup);\n"
18115 #: ../src/guestfs-actions.pod:7479 ../fish/guestfish-actions.pod:4960
18116 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18120 #: ../src/guestfs-actions.pod:7485
18121 msgid "guestfs_vgs"
18125 #: ../src/guestfs-actions.pod:7487
18129 " guestfs_vgs (guestfs_h *g);\n"
18134 #: ../src/guestfs-actions.pod:7490 ../fish/guestfish-actions.pod:4966
18136 "List all the volumes groups detected. This is the equivalent of the "
18137 "L<vgs(8)> command."
18141 #: ../src/guestfs-actions.pod:7493 ../fish/guestfish-actions.pod:4969
18143 "This returns a list of just the volume group names that were detected "
18144 "(eg. C<VolGroup00>)."
18148 #: ../src/guestfs-actions.pod:7496
18149 msgid "See also C<guestfs_vgs_full>."
18153 #: ../src/guestfs-actions.pod:7504
18154 msgid "guestfs_vgs_full"
18158 #: ../src/guestfs-actions.pod:7506
18161 " struct guestfs_lvm_vg_list *\n"
18162 " guestfs_vgs_full (guestfs_h *g);\n"
18167 #: ../src/guestfs-actions.pod:7509 ../fish/guestfish-actions.pod:4978
18169 "List all the volumes groups detected. This is the equivalent of the "
18170 "L<vgs(8)> command. The \"full\" version includes all fields."
18174 #: ../src/guestfs-actions.pod:7512
18176 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18177 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
18182 #: ../src/guestfs-actions.pod:7518
18183 msgid "guestfs_vgscan"
18187 #: ../src/guestfs-actions.pod:7520
18191 " guestfs_vgscan (guestfs_h *g);\n"
18196 #: ../src/guestfs-actions.pod:7523 ../fish/guestfish-actions.pod:4985
18198 "This rescans all block devices and rebuilds the list of LVM physical "
18199 "volumes, volume groups and logical volumes."
18203 #: ../src/guestfs-actions.pod:7530
18204 msgid "guestfs_vguuid"
18208 #: ../src/guestfs-actions.pod:7532
18212 " guestfs_vguuid (guestfs_h *g,\n"
18213 " const char *vgname);\n"
18218 #: ../src/guestfs-actions.pod:7536 ../fish/guestfish-actions.pod:4992
18219 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18223 #: ../src/guestfs-actions.pod:7543
18224 msgid "guestfs_wait_ready"
18228 #: ../src/guestfs-actions.pod:7545
18232 " guestfs_wait_ready (guestfs_h *g);\n"
18237 #: ../src/guestfs-actions.pod:7548
18238 msgid "This function is a no op."
18242 #: ../src/guestfs-actions.pod:7550
18244 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18245 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18246 "is no longer necessary because C<guestfs_launch> now does the waiting."
18250 #: ../src/guestfs-actions.pod:7555
18252 "If you see any calls to this function in code then you can just remove them, "
18253 "unless you want to retain compatibility with older versions of the API."
18257 #: ../src/guestfs-actions.pod:7561
18258 msgid "This function is deprecated. In new code, use the C<launch> call instead."
18262 #: ../src/guestfs-actions.pod:7570
18263 msgid "guestfs_wc_c"
18267 #: ../src/guestfs-actions.pod:7572
18271 " guestfs_wc_c (guestfs_h *g,\n"
18272 " const char *path);\n"
18277 #: ../src/guestfs-actions.pod:7576 ../fish/guestfish-actions.pod:4998
18279 "This command counts the characters in a file, using the C<wc -c> external "
18284 #: ../src/guestfs-actions.pod:7583
18285 msgid "guestfs_wc_l"
18289 #: ../src/guestfs-actions.pod:7585
18293 " guestfs_wc_l (guestfs_h *g,\n"
18294 " const char *path);\n"
18299 #: ../src/guestfs-actions.pod:7589 ../fish/guestfish-actions.pod:5005
18301 "This command counts the lines in a file, using the C<wc -l> external "
18306 #: ../src/guestfs-actions.pod:7596
18307 msgid "guestfs_wc_w"
18311 #: ../src/guestfs-actions.pod:7598
18315 " guestfs_wc_w (guestfs_h *g,\n"
18316 " const char *path);\n"
18321 #: ../src/guestfs-actions.pod:7602 ../fish/guestfish-actions.pod:5012
18323 "This command counts the words in a file, using the C<wc -w> external "
18328 #: ../src/guestfs-actions.pod:7609
18329 msgid "guestfs_write"
18333 #: ../src/guestfs-actions.pod:7611
18337 " guestfs_write (guestfs_h *g,\n"
18338 " const char *path,\n"
18339 " const char *content,\n"
18340 " size_t content_size);\n"
18345 #: ../src/guestfs-actions.pod:7617 ../fish/guestfish-actions.pod:5019
18347 "This call creates a file called C<path>. The content of the file is the "
18348 "string C<content> (which can contain any 8 bit data)."
18352 #: ../src/guestfs-actions.pod:7627
18353 msgid "guestfs_write_file"
18357 #: ../src/guestfs-actions.pod:7629
18361 " guestfs_write_file (guestfs_h *g,\n"
18362 " const char *path,\n"
18363 " const char *content,\n"
18369 #: ../src/guestfs-actions.pod:7635 ../fish/guestfish-actions.pod:5029
18371 "This call creates a file called C<path>. The contents of the file is the "
18372 "string C<content> (which can contain any 8 bit data), with length C<size>."
18376 #: ../src/guestfs-actions.pod:7639 ../fish/guestfish-actions.pod:5033
18378 "As a special case, if C<size> is C<0> then the length is calculated using "
18379 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18383 #: ../src/guestfs-actions.pod:7643 ../fish/guestfish-actions.pod:5037
18385 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18386 "I<not> work, even if the length is specified."
18390 #: ../src/guestfs-actions.pod:7651 ../fish/guestfish-actions.pod:5043
18391 msgid "This function is deprecated. In new code, use the C<write> call instead."
18395 #: ../src/guestfs-actions.pod:7660
18396 msgid "guestfs_zegrep"
18400 #: ../src/guestfs-actions.pod:7662
18404 " guestfs_zegrep (guestfs_h *g,\n"
18405 " const char *regex,\n"
18406 " const char *path);\n"
18411 #: ../src/guestfs-actions.pod:7667 ../fish/guestfish-actions.pod:5054
18412 msgid "This calls the external C<zegrep> program and returns the matching lines."
18416 #: ../src/guestfs-actions.pod:7679
18417 msgid "guestfs_zegrepi"
18421 #: ../src/guestfs-actions.pod:7681
18425 " guestfs_zegrepi (guestfs_h *g,\n"
18426 " const char *regex,\n"
18427 " const char *path);\n"
18432 #: ../src/guestfs-actions.pod:7686 ../fish/guestfish-actions.pod:5064
18433 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
18437 #: ../src/guestfs-actions.pod:7698
18438 msgid "guestfs_zero"
18442 #: ../src/guestfs-actions.pod:7700
18446 " guestfs_zero (guestfs_h *g,\n"
18447 " const char *device);\n"
18452 #: ../src/guestfs-actions.pod:7704 ../fish/guestfish-actions.pod:5074
18453 msgid "This command writes zeroes over the first few blocks of C<device>."
18457 #: ../src/guestfs-actions.pod:7706 ../fish/guestfish-actions.pod:5076
18459 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18460 "securely wipe the device). It should be sufficient to remove any partition "
18461 "tables, filesystem superblocks and so on."
18465 #: ../src/guestfs-actions.pod:7710
18467 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
18468 "C<guestfs_is_zero_device>"
18472 #: ../src/guestfs-actions.pod:7722
18473 msgid "guestfs_zero_device"
18477 #: ../src/guestfs-actions.pod:7724
18481 " guestfs_zero_device (guestfs_h *g,\n"
18482 " const char *device);\n"
18487 #: ../src/guestfs-actions.pod:7728
18489 "This command writes zeroes over the entire C<device>. Compare with "
18490 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18494 #: ../src/guestfs-actions.pod:7742
18495 msgid "(Added in 1.3.1)"
18499 #: ../src/guestfs-actions.pod:7744
18500 msgid "guestfs_zerofree"
18504 #: ../src/guestfs-actions.pod:7746
18508 " guestfs_zerofree (guestfs_h *g,\n"
18509 " const char *device);\n"
18514 #: ../src/guestfs-actions.pod:7750 ../fish/guestfish-actions.pod:5098
18516 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18517 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18518 "possible to compress the filesystem more effectively."
18522 #: ../src/guestfs-actions.pod:7755 ../fish/guestfish-actions.pod:5103
18523 msgid "You should B<not> run this program if the filesystem is mounted."
18527 #: ../src/guestfs-actions.pod:7758 ../fish/guestfish-actions.pod:5106
18529 "It is possible that using this program can damage the filesystem or data on "
18534 #: ../src/guestfs-actions.pod:7765
18535 msgid "guestfs_zfgrep"
18539 #: ../src/guestfs-actions.pod:7767
18543 " guestfs_zfgrep (guestfs_h *g,\n"
18544 " const char *pattern,\n"
18545 " const char *path);\n"
18550 #: ../src/guestfs-actions.pod:7772 ../fish/guestfish-actions.pod:5113
18551 msgid "This calls the external C<zfgrep> program and returns the matching lines."
18555 #: ../src/guestfs-actions.pod:7784
18556 msgid "guestfs_zfgrepi"
18560 #: ../src/guestfs-actions.pod:7786
18564 " guestfs_zfgrepi (guestfs_h *g,\n"
18565 " const char *pattern,\n"
18566 " const char *path);\n"
18571 #: ../src/guestfs-actions.pod:7791 ../fish/guestfish-actions.pod:5123
18572 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
18576 #: ../src/guestfs-actions.pod:7803
18577 msgid "guestfs_zfile"
18581 #: ../src/guestfs-actions.pod:7805
18585 " guestfs_zfile (guestfs_h *g,\n"
18586 " const char *meth,\n"
18587 " const char *path);\n"
18592 #: ../src/guestfs-actions.pod:7810 ../fish/guestfish-actions.pod:5133
18593 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
18597 #: ../src/guestfs-actions.pod:7813 ../fish/guestfish-actions.pod:5136
18598 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18602 #: ../src/guestfs-actions.pod:7815
18604 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18609 #: ../src/guestfs-actions.pod:7821 ../fish/guestfish-actions.pod:5141
18610 msgid "This function is deprecated. In new code, use the C<file> call instead."
18614 #: ../src/guestfs-actions.pod:7830
18615 msgid "guestfs_zgrep"
18619 #: ../src/guestfs-actions.pod:7832
18623 " guestfs_zgrep (guestfs_h *g,\n"
18624 " const char *regex,\n"
18625 " const char *path);\n"
18630 #: ../src/guestfs-actions.pod:7837 ../fish/guestfish-actions.pod:5152
18631 msgid "This calls the external C<zgrep> program and returns the matching lines."
18635 #: ../src/guestfs-actions.pod:7849
18636 msgid "guestfs_zgrepi"
18640 #: ../src/guestfs-actions.pod:7851
18644 " guestfs_zgrepi (guestfs_h *g,\n"
18645 " const char *regex,\n"
18646 " const char *path);\n"
18651 #: ../src/guestfs-actions.pod:7856 ../fish/guestfish-actions.pod:5162
18652 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
18656 #: ../src/guestfs-availability.pod:3
18661 #: ../src/guestfs-availability.pod:5
18663 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
18664 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
18665 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
18666 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
18667 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
18671 #: ../src/guestfs-availability.pod:21
18676 #: ../src/guestfs-availability.pod:23
18677 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
18681 #: ../src/guestfs-availability.pod:26
18686 #: ../src/guestfs-availability.pod:28
18688 "The following functions: L</guestfs_inotify_add_watch> "
18689 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
18690 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18694 #: ../src/guestfs-availability.pod:36
18695 msgid "B<linuxfsuuid>"
18699 #: ../src/guestfs-availability.pod:38
18701 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
18702 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18706 #: ../src/guestfs-availability.pod:45
18707 msgid "B<linuxmodules>"
18711 #: ../src/guestfs-availability.pod:47
18712 msgid "The following functions: L</guestfs_modprobe>"
18716 #: ../src/guestfs-availability.pod:50
18717 msgid "B<linuxxattrs>"
18721 #: ../src/guestfs-availability.pod:52
18723 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
18724 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
18725 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
18726 "L</guestfs_setxattr>"
18730 #: ../src/guestfs-availability.pod:63
18735 #: ../src/guestfs-availability.pod:65
18737 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
18738 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
18739 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18743 #: ../src/guestfs-availability.pod:74
18748 #: ../src/guestfs-availability.pod:76
18750 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
18751 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
18752 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
18753 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
18754 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
18755 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
18756 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
18757 "L</guestfs_vgs_full>"
18761 #: ../src/guestfs-availability.pod:99
18766 #: ../src/guestfs-availability.pod:101
18768 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
18769 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
18773 #: ../src/guestfs-availability.pod:107
18778 #: ../src/guestfs-availability.pod:109
18779 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18783 #: ../src/guestfs-availability.pod:112
18784 msgid "B<ntfsprogs>"
18788 #: ../src/guestfs-availability.pod:114
18790 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
18791 "L</guestfs_ntfsresize_size>"
18795 #: ../src/guestfs-availability.pod:119
18796 msgid "B<realpath>"
18800 #: ../src/guestfs-availability.pod:121
18801 msgid "The following functions: L</guestfs_realpath>"
18805 #: ../src/guestfs-availability.pod:124
18810 #: ../src/guestfs-availability.pod:126
18812 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
18813 "L</guestfs_scrub_freespace>"
18817 #: ../src/guestfs-availability.pod:131
18822 #: ../src/guestfs-availability.pod:133
18823 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18827 #: ../src/guestfs-availability.pod:137
18832 #: ../src/guestfs-availability.pod:139
18833 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18837 #: ../src/guestfs-availability.pod:143
18838 msgid "B<zerofree>"
18842 #: ../src/guestfs-availability.pod:145
18843 msgid "The following functions: L</guestfs_zerofree>"
18847 #: ../src/guestfs-structs.pod:1
18848 msgid "guestfs_int_bool"
18852 #: ../src/guestfs-structs.pod:3
18855 " struct guestfs_int_bool {\n"
18863 #: ../src/guestfs-structs.pod:8
18866 " struct guestfs_int_bool_list {\n"
18867 " uint32_t len; /* Number of elements in list. */\n"
18868 " struct guestfs_int_bool *val; /* Elements. */\n"
18874 #: ../src/guestfs-structs.pod:13
18877 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18878 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18883 #: ../src/guestfs-structs.pod:16
18884 msgid "guestfs_lvm_pv"
18888 #: ../src/guestfs-structs.pod:18
18891 " struct guestfs_lvm_pv {\n"
18892 " char *pv_name;\n"
18893 " /* The next field is NOT nul-terminated, be careful when printing it: "
18895 " char pv_uuid[32];\n"
18897 " uint64_t pv_size;\n"
18898 " uint64_t dev_size;\n"
18899 " uint64_t pv_free;\n"
18900 " uint64_t pv_used;\n"
18901 " char *pv_attr;\n"
18902 " int64_t pv_pe_count;\n"
18903 " int64_t pv_pe_alloc_count;\n"
18904 " char *pv_tags;\n"
18905 " uint64_t pe_start;\n"
18906 " int64_t pv_mda_count;\n"
18907 " uint64_t pv_mda_free;\n"
18913 #: ../src/guestfs-structs.pod:36
18916 " struct guestfs_lvm_pv_list {\n"
18917 " uint32_t len; /* Number of elements in list. */\n"
18918 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18924 #: ../src/guestfs-structs.pod:41
18927 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18928 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18933 #: ../src/guestfs-structs.pod:44
18934 msgid "guestfs_lvm_vg"
18938 #: ../src/guestfs-structs.pod:46
18941 " struct guestfs_lvm_vg {\n"
18942 " char *vg_name;\n"
18943 " /* The next field is NOT nul-terminated, be careful when printing it: "
18945 " char vg_uuid[32];\n"
18947 " char *vg_attr;\n"
18948 " uint64_t vg_size;\n"
18949 " uint64_t vg_free;\n"
18950 " char *vg_sysid;\n"
18951 " uint64_t vg_extent_size;\n"
18952 " int64_t vg_extent_count;\n"
18953 " int64_t vg_free_count;\n"
18954 " int64_t max_lv;\n"
18955 " int64_t max_pv;\n"
18956 " int64_t pv_count;\n"
18957 " int64_t lv_count;\n"
18958 " int64_t snap_count;\n"
18959 " int64_t vg_seqno;\n"
18960 " char *vg_tags;\n"
18961 " int64_t vg_mda_count;\n"
18962 " uint64_t vg_mda_free;\n"
18968 #: ../src/guestfs-structs.pod:69
18971 " struct guestfs_lvm_vg_list {\n"
18972 " uint32_t len; /* Number of elements in list. */\n"
18973 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18979 #: ../src/guestfs-structs.pod:74
18982 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18983 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18988 #: ../src/guestfs-structs.pod:77
18989 msgid "guestfs_lvm_lv"
18993 #: ../src/guestfs-structs.pod:79
18996 " struct guestfs_lvm_lv {\n"
18997 " char *lv_name;\n"
18998 " /* The next field is NOT nul-terminated, be careful when printing it: "
19000 " char lv_uuid[32];\n"
19001 " char *lv_attr;\n"
19002 " int64_t lv_major;\n"
19003 " int64_t lv_minor;\n"
19004 " int64_t lv_kernel_major;\n"
19005 " int64_t lv_kernel_minor;\n"
19006 " uint64_t lv_size;\n"
19007 " int64_t seg_count;\n"
19009 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19010 " float snap_percent;\n"
19011 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19012 " float copy_percent;\n"
19013 " char *move_pv;\n"
19014 " char *lv_tags;\n"
19015 " char *mirror_log;\n"
19016 " char *modules;\n"
19022 #: ../src/guestfs-structs.pod:101
19025 " struct guestfs_lvm_lv_list {\n"
19026 " uint32_t len; /* Number of elements in list. */\n"
19027 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19033 #: ../src/guestfs-structs.pod:106
19036 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19037 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19042 #: ../src/guestfs-structs.pod:111
19045 " struct guestfs_stat {\n"
19049 " int64_t nlink;\n"
19054 " int64_t blksize;\n"
19055 " int64_t blocks;\n"
19056 " int64_t atime;\n"
19057 " int64_t mtime;\n"
19058 " int64_t ctime;\n"
19064 #: ../src/guestfs-structs.pod:127
19067 " struct guestfs_stat_list {\n"
19068 " uint32_t len; /* Number of elements in list. */\n"
19069 " struct guestfs_stat *val; /* Elements. */\n"
19075 #: ../src/guestfs-structs.pod:132
19078 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19079 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19084 #: ../src/guestfs-structs.pod:137
19087 " struct guestfs_statvfs {\n"
19088 " int64_t bsize;\n"
19089 " int64_t frsize;\n"
19090 " int64_t blocks;\n"
19091 " int64_t bfree;\n"
19092 " int64_t bavail;\n"
19093 " int64_t files;\n"
19094 " int64_t ffree;\n"
19095 " int64_t favail;\n"
19098 " int64_t namemax;\n"
19104 #: ../src/guestfs-structs.pod:151
19107 " struct guestfs_statvfs_list {\n"
19108 " uint32_t len; /* Number of elements in list. */\n"
19109 " struct guestfs_statvfs *val; /* Elements. */\n"
19115 #: ../src/guestfs-structs.pod:156
19118 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19119 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19124 #: ../src/guestfs-structs.pod:159
19125 msgid "guestfs_dirent"
19129 #: ../src/guestfs-structs.pod:161
19132 " struct guestfs_dirent {\n"
19141 #: ../src/guestfs-structs.pod:167
19144 " struct guestfs_dirent_list {\n"
19145 " uint32_t len; /* Number of elements in list. */\n"
19146 " struct guestfs_dirent *val; /* Elements. */\n"
19152 #: ../src/guestfs-structs.pod:172
19155 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19156 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19161 #: ../src/guestfs-structs.pod:177
19164 " struct guestfs_version {\n"
19165 " int64_t major;\n"
19166 " int64_t minor;\n"
19167 " int64_t release;\n"
19174 #: ../src/guestfs-structs.pod:184
19177 " struct guestfs_version_list {\n"
19178 " uint32_t len; /* Number of elements in list. */\n"
19179 " struct guestfs_version *val; /* Elements. */\n"
19185 #: ../src/guestfs-structs.pod:189
19188 " void guestfs_free_version (struct guestfs_free_version *);\n"
19189 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19194 #: ../src/guestfs-structs.pod:192
19195 msgid "guestfs_xattr"
19199 #: ../src/guestfs-structs.pod:194
19202 " struct guestfs_xattr {\n"
19203 " char *attrname;\n"
19204 " /* The next two fields describe a byte array. */\n"
19205 " uint32_t attrval_len;\n"
19206 " char *attrval;\n"
19212 #: ../src/guestfs-structs.pod:201
19215 " struct guestfs_xattr_list {\n"
19216 " uint32_t len; /* Number of elements in list. */\n"
19217 " struct guestfs_xattr *val; /* Elements. */\n"
19223 #: ../src/guestfs-structs.pod:206
19226 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19227 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19232 #: ../src/guestfs-structs.pod:209
19233 msgid "guestfs_inotify_event"
19237 #: ../src/guestfs-structs.pod:211
19240 " struct guestfs_inotify_event {\n"
19241 " int64_t in_wd;\n"
19242 " uint32_t in_mask;\n"
19243 " uint32_t in_cookie;\n"
19244 " char *in_name;\n"
19250 #: ../src/guestfs-structs.pod:218
19253 " struct guestfs_inotify_event_list {\n"
19254 " uint32_t len; /* Number of elements in list. */\n"
19255 " struct guestfs_inotify_event *val; /* Elements. */\n"
19261 #: ../src/guestfs-structs.pod:223
19264 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19265 " void guestfs_free_inotify_event_list (struct "
19266 "guestfs_free_inotify_event_list *);\n"
19271 #: ../src/guestfs-structs.pod:226
19272 msgid "guestfs_partition"
19276 #: ../src/guestfs-structs.pod:228
19279 " struct guestfs_partition {\n"
19280 " int32_t part_num;\n"
19281 " uint64_t part_start;\n"
19282 " uint64_t part_end;\n"
19283 " uint64_t part_size;\n"
19289 #: ../src/guestfs-structs.pod:235
19292 " struct guestfs_partition_list {\n"
19293 " uint32_t len; /* Number of elements in list. */\n"
19294 " struct guestfs_partition *val; /* Elements. */\n"
19300 #: ../src/guestfs-structs.pod:240
19303 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19304 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19309 #: ../src/guestfs-structs.pod:243
19310 msgid "guestfs_application"
19314 #: ../src/guestfs-structs.pod:245
19317 " struct guestfs_application {\n"
19318 " char *app_name;\n"
19319 " char *app_display_name;\n"
19320 " int32_t app_epoch;\n"
19321 " char *app_version;\n"
19322 " char *app_release;\n"
19323 " char *app_install_path;\n"
19324 " char *app_trans_path;\n"
19325 " char *app_publisher;\n"
19326 " char *app_url;\n"
19327 " char *app_source_package;\n"
19328 " char *app_summary;\n"
19329 " char *app_description;\n"
19335 #: ../src/guestfs-structs.pod:260
19338 " struct guestfs_application_list {\n"
19339 " uint32_t len; /* Number of elements in list. */\n"
19340 " struct guestfs_application *val; /* Elements. */\n"
19346 #: ../src/guestfs-structs.pod:265
19349 " void guestfs_free_application (struct guestfs_free_application *);\n"
19350 " void guestfs_free_application_list (struct guestfs_free_application_list "
19356 #: ../fish/guestfish.pod:5
19357 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19361 #: ../fish/guestfish.pod:9
19364 " guestfish [--options] [commands]\n"
19369 #: ../fish/guestfish.pod:11
19377 #: ../fish/guestfish.pod:13
19380 " guestfish [--ro|--rw] -a disk.img\n"
19385 #: ../fish/guestfish.pod:15
19388 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19393 #: ../fish/guestfish.pod:17
19396 " guestfish -d libvirt-domain\n"
19401 #: ../fish/guestfish.pod:19
19404 " guestfish [--ro|--rw] -a disk.img -i\n"
19409 #: ../fish/guestfish.pod:21
19412 " guestfish -d libvirt-domain -i\n"
19417 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19422 #: ../fish/guestfish.pod:25
19424 "Using guestfish in read/write mode on live virtual machines can be "
19425 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19426 "option to use guestfish safely if the disk image or virtual machine might be "
19431 #: ../fish/guestfish.pod:32
19433 "Guestfish is a shell and command-line tool for examining and modifying "
19434 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19435 "functionality of the guestfs API, see L<guestfs(3)>."
19439 #: ../fish/guestfish.pod:36
19441 "Guestfish gives you structured access to the libguestfs API, from shell "
19442 "scripts or the command line or interactively. If you want to rescue a "
19443 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19448 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949 ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
19453 #: ../fish/guestfish.pod:43
19454 msgid "As an interactive shell"
19458 #: ../fish/guestfish.pod:45
19466 #: ../fish/guestfish.pod:47
19469 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19470 " editing virtual machine filesystems.\n"
19475 #: ../fish/guestfish.pod:50
19478 " Type: 'help' for a list of commands\n"
19479 " 'man' to read the manual\n"
19480 " 'quit' to quit the shell\n"
19485 #: ../fish/guestfish.pod:54
19488 " ><fs> add-ro disk.img\n"
19490 " ><fs> list-filesystems\n"
19491 " /dev/sda1: ext4\n"
19492 " /dev/vg_guest/lv_root: ext4\n"
19493 " /dev/vg_guest/lv_swap: swap\n"
19494 " ><fs> mount /dev/vg_guest/lv_root /\n"
19495 " ><fs> cat /etc/fstab\n"
19497 " # Created by anaconda\n"
19504 #: ../fish/guestfish.pod:67
19505 msgid "From shell scripts"
19509 #: ../fish/guestfish.pod:69
19510 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19514 #: ../fish/guestfish.pod:71
19517 " guestfish <<_EOF_\n"
19520 " mount /dev/vg_guest/lv_root /\n"
19521 " write /etc/motd \"Welcome, new users\"\n"
19527 #: ../fish/guestfish.pod:78
19528 msgid "List the LVM logical volumes in a disk image:"
19532 #: ../fish/guestfish.pod:80
19535 " guestfish -a disk.img --ro <<_EOF_\n"
19543 #: ../fish/guestfish.pod:85
19544 msgid "List all the filesystems in a disk image:"
19548 #: ../fish/guestfish.pod:87
19551 " guestfish -a disk.img --ro <<_EOF_\n"
19553 " list-filesystems\n"
19559 #: ../fish/guestfish.pod:92
19560 msgid "On one command line"
19564 #: ../fish/guestfish.pod:94
19565 msgid "Update C</etc/resolv.conf> in a guest:"
19569 #: ../fish/guestfish.pod:96
19573 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19574 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19579 #: ../fish/guestfish.pod:100
19580 msgid "Edit C</boot/grub/grub.conf> interactively:"
19584 #: ../fish/guestfish.pod:102
19587 " guestfish --rw --add disk.img \\\n"
19588 " --mount /dev/vg_guest/lv_root \\\n"
19589 " --mount /dev/sda1:/boot \\\n"
19590 " edit /boot/grub/grub.conf\n"
19595 #: ../fish/guestfish.pod:107
19596 msgid "Mount disks automatically"
19600 #: ../fish/guestfish.pod:109
19602 "Use the I<-i> option to automatically mount the disks from a virtual "
19607 #: ../fish/guestfish.pod:112
19610 " guestfish --ro -a disk.img -i cat /etc/group\n"
19615 #: ../fish/guestfish.pod:114
19618 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19623 #: ../fish/guestfish.pod:116
19624 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19628 #: ../fish/guestfish.pod:118
19631 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19636 #: ../fish/guestfish.pod:120
19637 msgid "As a script interpreter"
19641 #: ../fish/guestfish.pod:122
19642 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19646 #: ../fish/guestfish.pod:124
19649 " #!/usr/bin/guestfish -f\n"
19650 " sparse test1.img 100M\n"
19652 " part-disk /dev/sda mbr\n"
19653 " mkfs ext2 /dev/sda1\n"
19658 #: ../fish/guestfish.pod:130
19659 msgid "Start with a prepared disk"
19663 #: ../fish/guestfish.pod:132
19665 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19666 "single ext2-formatted partition:"
19670 #: ../fish/guestfish.pod:135
19673 " guestfish -N fs\n"
19678 #: ../fish/guestfish.pod:137
19679 msgid "To list what is available do:"
19683 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
19686 " guestfish -N help | less\n"
19691 #: ../fish/guestfish.pod:141
19692 msgid "Remote control"
19696 #: ../fish/guestfish.pod:143
19699 " eval \"`guestfish --listen`\"\n"
19700 " guestfish --remote add-ro disk.img\n"
19701 " guestfish --remote run\n"
19702 " guestfish --remote lvs\n"
19707 #: ../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
19712 #: ../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
19717 #: ../fish/guestfish.pod:154
19718 msgid "Displays general help on options."
19722 #: ../fish/guestfish.pod:156
19727 #: ../fish/guestfish.pod:158
19728 msgid "B<--cmd-help>"
19732 #: ../fish/guestfish.pod:160
19733 msgid "Lists all available guestfish commands."
19737 #: ../fish/guestfish.pod:162
19742 #: ../fish/guestfish.pod:164
19743 msgid "B<--cmd-help cmd>"
19747 #: ../fish/guestfish.pod:166
19748 msgid "Displays detailed help on a single command C<cmd>."
19752 #: ../fish/guestfish.pod:168
19753 msgid "B<-a image>"
19757 #: ../fish/guestfish.pod:170
19758 msgid "B<--add image>"
19762 #: ../fish/guestfish.pod:172
19763 msgid "Add a block device or virtual machine image to the shell."
19767 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19769 "The format of the disk image is auto-detected. To override this and force a "
19770 "particular format use the I<--format=..> option."
19774 #: ../fish/guestfish.pod:177
19776 "Using this flag is mostly equivalent to using the C<add> command, with "
19777 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19778 "the I<--format=...> flag was given."
19782 #: ../fish/guestfish.pod:181
19787 #: ../fish/guestfish.pod:183
19788 msgid "B<--connect URI>"
19792 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19794 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19795 "URI to use. The default is to use the default libvirt connection."
19799 #: ../fish/guestfish.pod:189
19804 #: ../fish/guestfish.pod:191
19806 "If using the I<--listen> option and a csh-like shell, use this option. See "
19807 "section L</REMOTE CONTROL AND CSH> below."
19811 #: ../fish/guestfish.pod:194
19812 msgid "B<-d libvirt-domain>"
19816 #: ../fish/guestfish.pod:196
19817 msgid "B<--domain libvirt-domain>"
19821 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19823 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19824 "used, then any libvirt domain can be used. However in write mode, only "
19825 "libvirt domains which are shut down can be named here."
19829 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
19830 msgid "Domain UUIDs can be used instead of names."
19834 #: ../fish/guestfish.pod:204
19836 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19837 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19838 "if the I<--format:...> flag was given."
19842 #: ../fish/guestfish.pod:208
19847 #: ../fish/guestfish.pod:210
19848 msgid "B<--no-dest-paths>"
19852 #: ../fish/guestfish.pod:212
19854 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19855 "to hit the tab key to complete paths on the guest filesystem, but this "
19856 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19857 "allow this feature to be disabled."
19861 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19862 msgid "B<--echo-keys>"
19866 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
19868 "When prompting for keys and passphrases, guestfish normally turns echoing "
19869 "off so you cannot see what you are typing. If you are not worried about "
19870 "Tempest attacks and there is no one else in the room you can specify this "
19871 "flag to see what you are typing."
19875 #: ../fish/guestfish.pod:224
19880 #: ../fish/guestfish.pod:226
19881 msgid "B<--file file>"
19885 #: ../fish/guestfish.pod:228
19886 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19890 #: ../fish/guestfish.pod:231
19893 " #!/usr/bin/guestfish -f\n"
19898 #: ../fish/guestfish.pod:233
19899 msgid "B<--format=raw|qcow2|..>"
19903 #: ../fish/guestfish.pod:235
19904 msgid "B<--format>"
19908 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
19910 "The default for the I<-a> option is to auto-detect the format of the disk "
19911 "image. Using this forces the disk format for I<-a> options which follow on "
19912 "the command line. Using I<--format> with no argument switches back to "
19913 "auto-detection for subsequent I<-a> options."
19917 #: ../fish/guestfish.pod:244
19920 " guestfish --format=raw -a disk.img\n"
19925 #: ../fish/guestfish.pod:246
19926 msgid "forces raw format (no auto-detection) for C<disk.img>."
19930 #: ../fish/guestfish.pod:248
19933 " guestfish --format=raw -a disk.img --format -a another.img\n"
19938 #: ../fish/guestfish.pod:250
19940 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19941 "auto-detection for C<another.img>."
19945 #: ../fish/guestfish.pod:253
19947 "If you have untrusted raw-format guest disk images, you should use this "
19948 "option to specify the disk format. This avoids a possible security problem "
19949 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19953 #: ../fish/guestfish.pod:258
19958 #: ../fish/guestfish.pod:260
19959 msgid "B<--inspector>"
19963 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
19965 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19966 "system and mount filesystems as they would be mounted on the real virtual "
19971 #: ../fish/guestfish.pod:266
19972 msgid "Typical usage is either:"
19976 #: ../fish/guestfish.pod:268
19979 " guestfish -d myguest -i\n"
19984 #: ../fish/guestfish.pod:270
19985 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19989 #: ../fish/guestfish.pod:272
19992 " guestfish --ro -d myguest -i\n"
19997 #: ../fish/guestfish.pod:274
19998 msgid "(for active domains, readonly), or specify the block device directly:"
20002 #: ../fish/guestfish.pod:276
20005 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
20010 #: ../fish/guestfish.pod:278
20012 "Note that the command line syntax changed slightly over older versions of "
20013 "guestfish. You can still use the old syntax:"
20017 #: ../fish/guestfish.pod:281
20020 " guestfish [--ro] -i disk.img\n"
20025 #: ../fish/guestfish.pod:283
20028 " guestfish [--ro] -i libvirt-domain\n"
20033 #: ../fish/guestfish.pod:285
20035 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20036 "then using other commands to mount the filesystems that were found."
20040 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20041 msgid "B<--keys-from-stdin>"
20045 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
20047 "Read key or passphrase parameters from stdin. The default is to try to read "
20048 "passphrases from the user by opening C</dev/tty>."
20052 #: ../fish/guestfish.pod:294
20053 msgid "B<--listen>"
20057 #: ../fish/guestfish.pod:296
20059 "Fork into the background and listen for remote commands. See section "
20060 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20064 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20069 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
20071 "Connect to a live virtual machine. (Experimental, see "
20072 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
20076 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20077 msgid "B<-m dev[:mountpoint[:options]]>"
20081 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
20082 msgid "B<--mount dev[:mountpoint[:options]]>"
20086 #: ../fish/guestfish.pod:308
20087 msgid "Mount the named partition or logical volume on the given mountpoint."
20091 #: ../fish/guestfish.pod:310
20092 msgid "If the mountpoint is omitted, it defaults to C</>."
20096 #: ../fish/guestfish.pod:312
20097 msgid "You have to mount something on C</> before most commands will work."
20101 #: ../fish/guestfish.pod:314
20103 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20108 #: ../fish/guestfish.pod:317
20110 "If you don't know what filesystems a disk image contains, you can either run "
20111 "guestfish without this option, then list the partitions, filesystems and LVs "
20112 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20113 "commands), or you can use the L<virt-filesystems(1)> program."
20117 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
20119 "The third (and rarely used) part of the mount parameter is the list of mount "
20120 "options used to mount the underlying filesystem. If this is not given, then "
20121 "the mount options are either the empty string or C<ro> (the latter if the "
20122 "I<--ro> flag is used). By specifying the mount options, you override this "
20123 "default choice. Probably the only time you would use this is to enable ACLs "
20124 "and/or extended attributes if the filesystem can support them:"
20128 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
20131 " -m /dev/sda1:/:acl,user_xattr\n"
20136 #: ../fish/guestfish.pod:333
20137 msgid "Using this flag is equivalent to using the C<mount-options> command."
20141 #: ../fish/guestfish.pod:335
20146 #: ../fish/guestfish.pod:337
20147 msgid "B<--no-sync>"
20151 #: ../fish/guestfish.pod:339
20153 "Disable autosync. This is enabled by default. See the discussion of "
20154 "autosync in the L<guestfs(3)> manpage."
20158 #: ../fish/guestfish.pod:342
20163 #: ../fish/guestfish.pod:344
20164 msgid "B<--new type>"
20168 #: ../fish/guestfish.pod:346
20173 #: ../fish/guestfish.pod:348
20175 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20176 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20177 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20182 #: ../fish/guestfish.pod:353
20183 msgid "B<--progress-bars>"
20187 #: ../fish/guestfish.pod:355
20188 msgid "Enable progress bars, even when guestfish is used non-interactively."
20192 #: ../fish/guestfish.pod:357
20194 "Progress bars are enabled by default when guestfish is used as an "
20195 "interactive shell."
20199 #: ../fish/guestfish.pod:360
20200 msgid "B<--no-progress-bars>"
20204 #: ../fish/guestfish.pod:362
20205 msgid "Disable progress bars."
20209 #: ../fish/guestfish.pod:364
20210 msgid "B<--remote[=pid]>"
20214 #: ../fish/guestfish.pod:366
20216 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20217 "CONTROL GUESTFISH OVER A SOCKET> below."
20221 #: ../fish/guestfish.pod:369
20226 #: ../fish/guestfish.pod:371
20231 #: ../fish/guestfish.pod:373
20233 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20234 "mounts are done read-only."
20238 #: ../fish/guestfish.pod:376
20240 "The option must always be used if the disk image or virtual machine might be "
20241 "running, and is generally recommended in cases where you don't need write "
20242 "access to the disk."
20246 #: ../fish/guestfish.pod:380
20248 "Note that prepared disk images created with I<-N> are not affected by this "
20249 "option. Also commands like C<add> are not affected - you have to specify "
20250 "the C<readonly:true> option explicitly if you need it."
20254 #: ../fish/guestfish.pod:384
20255 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20259 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
20260 msgid "B<--selinux>"
20264 #: ../fish/guestfish.pod:388
20265 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20269 #: ../fish/guestfish.pod:390
20274 #: ../fish/guestfish.pod:392
20275 msgid "B<--verbose>"
20279 #: ../fish/guestfish.pod:394
20281 "Enable very verbose messages. This is particularly useful if you find a "
20286 #: ../fish/guestfish.pod:397
20291 #: ../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
20292 msgid "B<--version>"
20296 #: ../fish/guestfish.pod:401
20297 msgid "Display the guestfish / libguestfs version number and exit."
20301 #: ../fish/guestfish.pod:403
20306 #: ../fish/guestfish.pod:405
20311 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
20313 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20314 "mounts are done read-write."
20318 #: ../fish/guestfish.pod:410
20319 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20323 #: ../fish/guestfish.pod:412
20328 #: ../fish/guestfish.pod:414
20329 msgid "Echo each command before executing it."
20333 #: ../fish/guestfish.pod:418
20334 msgid "COMMANDS ON COMMAND LINE"
20338 #: ../fish/guestfish.pod:420
20339 msgid "Any additional (non-option) arguments are treated as commands to execute."
20343 #: ../fish/guestfish.pod:423
20345 "Commands to execute should be separated by a colon (C<:>), where the colon "
20346 "is a separate parameter. Thus:"
20350 #: ../fish/guestfish.pod:426
20353 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20358 #: ../fish/guestfish.pod:428
20360 "If there are no additional arguments, then we enter a shell, either an "
20361 "interactive shell with a prompt (if the input is a terminal) or a "
20362 "non-interactive shell."
20366 #: ../fish/guestfish.pod:432
20368 "In either command line mode or non-interactive shell, the first command that "
20369 "gives an error causes the whole shell to exit. In interactive mode (with a "
20370 "prompt) if a command fails, you can continue to enter commands."
20374 #: ../fish/guestfish.pod:437
20375 msgid "USING launch (OR run)"
20379 #: ../fish/guestfish.pod:439
20381 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20382 "then launch it, then mount any disks you need, and finally issue "
20383 "actions/commands. So the general order of the day is:"
20387 #: ../fish/guestfish.pod:447
20388 msgid "add or -a/--add"
20392 #: ../fish/guestfish.pod:451
20393 msgid "launch (aka run)"
20397 #: ../fish/guestfish.pod:455
20398 msgid "mount or -m/--mount"
20402 #: ../fish/guestfish.pod:459
20403 msgid "any other commands"
20407 #: ../fish/guestfish.pod:463
20409 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20410 "guest before mounting or performing any other commands."
20414 #: ../fish/guestfish.pod:466
20416 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20417 "I<--new> options were given then C<run> is done automatically, simply "
20418 "because guestfish can't perform the action you asked for without doing this."
20422 #: ../fish/guestfish.pod:471
20423 msgid "OPENING DISKS FOR READ AND WRITE"
20427 #: ../fish/guestfish.pod:473
20429 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20430 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20431 "I<-i> and I<-m> open disk images read-only or for writing."
20435 #: ../fish/guestfish.pod:478
20437 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20438 "opening disk images supplied on the command line for write. To open a disk "
20439 "image read-only you have to do I<-a image --ro>."
20443 #: ../fish/guestfish.pod:482
20445 "This matters: If you accidentally open a live VM disk image writable then "
20446 "you will cause irreversible disk corruption."
20450 #: ../fish/guestfish.pod:485
20452 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20453 "images will be opened read-only. You will have to either specify "
20454 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20455 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20456 "access for disk images specified by those other command line options."
20460 #: ../fish/guestfish.pod:492
20462 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20463 "which does nothing (it is already the default). However it is highly "
20464 "recommended that you use this option to indicate that you need write access, "
20465 "and prepare your scripts for the day when this option will be required for "
20470 #: ../fish/guestfish.pod:498
20472 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20473 "other libguestfs program apart from guestfish and guestmount."
20477 #: ../fish/guestfish.pod:501
20482 #: ../fish/guestfish.pod:503
20484 "You can quote ordinary parameters using either single or double quotes. For "
20489 #: ../fish/guestfish.pod:506
20492 " add \"file with a space.img\"\n"
20497 #: ../fish/guestfish.pod:508
20500 " rm '/file name'\n"
20505 #: ../fish/guestfish.pod:510
20513 #: ../fish/guestfish.pod:512
20515 "A few commands require a list of strings to be passed. For these, use a "
20516 "whitespace-separated list, enclosed in quotes. Strings containing "
20517 "whitespace to be passed through must be enclosed in single quotes. A "
20518 "literal single quote must be escaped with a backslash."
20522 #: ../fish/guestfish.pod:517
20525 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20526 " command \"/bin/echo 'foo bar'\"\n"
20527 " command \"/bin/echo \\'foo\\'\"\n"
20532 #: ../fish/guestfish.pod:521
20533 msgid "OPTIONAL ARGUMENTS"
20537 #: ../fish/guestfish.pod:523
20539 "Some commands take optional arguments. These arguments appear in this "
20540 "documentation as C<[argname:..]>. You can use them as in these examples:"
20544 #: ../fish/guestfish.pod:527
20547 " add-drive-opts filename\n"
20552 #: ../fish/guestfish.pod:529
20555 " add-drive-opts filename readonly:true\n"
20560 #: ../fish/guestfish.pod:531
20563 " add-drive-opts filename format:qcow2 readonly:false\n"
20568 #: ../fish/guestfish.pod:533
20570 "Each optional argument can appear at most once. All optional arguments must "
20571 "appear after the required ones."
20575 #: ../fish/guestfish.pod:536
20580 #: ../fish/guestfish.pod:538
20581 msgid "This section applies to all commands which can take integers as parameters."
20585 #: ../fish/guestfish.pod:541
20586 msgid "SIZE SUFFIX"
20590 #: ../fish/guestfish.pod:543
20592 "When the command takes a parameter measured in bytes, you can use one of the "
20593 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20597 #: ../fish/guestfish.pod:549
20598 msgid "B<k> or B<K> or B<KiB>"
20602 #: ../fish/guestfish.pod:551
20603 msgid "The size in kilobytes (multiplied by 1024)."
20607 #: ../fish/guestfish.pod:553
20612 #: ../fish/guestfish.pod:555
20613 msgid "The size in SI 1000 byte units."
20617 #: ../fish/guestfish.pod:557
20618 msgid "B<M> or B<MiB>"
20622 #: ../fish/guestfish.pod:559
20623 msgid "The size in megabytes (multiplied by 1048576)."
20627 #: ../fish/guestfish.pod:561
20632 #: ../fish/guestfish.pod:563
20633 msgid "The size in SI 1000000 byte units."
20637 #: ../fish/guestfish.pod:565
20638 msgid "B<G> or B<GiB>"
20642 #: ../fish/guestfish.pod:567
20643 msgid "The size in gigabytes (multiplied by 2**30)."
20647 #: ../fish/guestfish.pod:569
20652 #: ../fish/guestfish.pod:571
20653 msgid "The size in SI 10**9 byte units."
20657 #: ../fish/guestfish.pod:573
20658 msgid "B<T> or B<TiB>"
20662 #: ../fish/guestfish.pod:575
20663 msgid "The size in terabytes (multiplied by 2**40)."
20667 #: ../fish/guestfish.pod:577
20672 #: ../fish/guestfish.pod:579
20673 msgid "The size in SI 10**12 byte units."
20677 #: ../fish/guestfish.pod:581
20678 msgid "B<P> or B<PiB>"
20682 #: ../fish/guestfish.pod:583
20683 msgid "The size in petabytes (multiplied by 2**50)."
20687 #: ../fish/guestfish.pod:585
20692 #: ../fish/guestfish.pod:587
20693 msgid "The size in SI 10**15 byte units."
20697 #: ../fish/guestfish.pod:589
20698 msgid "B<E> or B<EiB>"
20702 #: ../fish/guestfish.pod:591
20703 msgid "The size in exabytes (multiplied by 2**60)."
20707 #: ../fish/guestfish.pod:593
20712 #: ../fish/guestfish.pod:595
20713 msgid "The size in SI 10**18 byte units."
20717 #: ../fish/guestfish.pod:597
20718 msgid "B<Z> or B<ZiB>"
20722 #: ../fish/guestfish.pod:599
20723 msgid "The size in zettabytes (multiplied by 2**70)."
20727 #: ../fish/guestfish.pod:601
20732 #: ../fish/guestfish.pod:603
20733 msgid "The size in SI 10**21 byte units."
20737 #: ../fish/guestfish.pod:605
20738 msgid "B<Y> or B<YiB>"
20742 #: ../fish/guestfish.pod:607
20743 msgid "The size in yottabytes (multiplied by 2**80)."
20747 #: ../fish/guestfish.pod:609
20752 #: ../fish/guestfish.pod:611
20753 msgid "The size in SI 10**24 byte units."
20757 #: ../fish/guestfish.pod:617
20760 " truncate-size /file 1G\n"
20765 #: ../fish/guestfish.pod:619
20766 msgid "would truncate the file to 1 gigabyte."
20770 #: ../fish/guestfish.pod:621
20772 "Be careful because a few commands take sizes in kilobytes or megabytes "
20773 "(eg. the parameter to L</memsize> is specified in megabytes already). "
20774 "Adding a suffix will probably not do what you expect."
20778 #: ../fish/guestfish.pod:625
20779 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20783 #: ../fish/guestfish.pod:627
20785 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20786 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20790 #: ../fish/guestfish.pod:630
20793 " 1234 decimal number 1234\n"
20794 " 02322 octal number, equivalent to decimal 1234\n"
20795 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20800 #: ../fish/guestfish.pod:634
20802 "When using the C<chmod> command, you almost always want to specify an octal "
20803 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20804 "L<chmod(1)> program):"
20808 #: ../fish/guestfish.pod:638
20811 " chmod 0777 /public # OK\n"
20812 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20817 #: ../fish/guestfish.pod:641
20819 "Commands that return numbers usually print them in decimal, but some "
20820 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20821 "octal, preceeded by C<0>)."
20825 #: ../fish/guestfish.pod:645
20826 msgid "WILDCARDS AND GLOBBING"
20830 #: ../fish/guestfish.pod:647
20832 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20833 "(globbing) by default. So for example the following will not do what you "
20838 #: ../fish/guestfish.pod:651
20846 #: ../fish/guestfish.pod:653
20848 "Assuming you don't have a directory called literally C</home/*> then the "
20849 "above command will return an error."
20853 #: ../fish/guestfish.pod:656
20854 msgid "To perform wildcard expansion, use the C<glob> command."
20858 #: ../fish/guestfish.pod:658
20861 " glob rm-rf /home/*\n"
20866 #: ../fish/guestfish.pod:660
20868 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20869 "many times), equivalent to:"
20873 #: ../fish/guestfish.pod:663
20876 " rm-rf /home/jim\n"
20877 " rm-rf /home/joe\n"
20878 " rm-rf /home/mary\n"
20883 #: ../fish/guestfish.pod:667
20884 msgid "C<glob> only works on simple guest paths and not on device names."
20888 #: ../fish/guestfish.pod:669
20890 "If you have several parameters, each containing a wildcard, then glob will "
20891 "perform a Cartesian product."
20895 #: ../fish/guestfish.pod:672
20900 #: ../fish/guestfish.pod:674
20902 "Any line which starts with a I<#> character is treated as a comment and "
20903 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20904 "a command. For example:"
20908 #: ../fish/guestfish.pod:678
20911 " # this is a comment\n"
20912 " # this is a comment\n"
20913 " foo # NOT a comment\n"
20918 #: ../fish/guestfish.pod:682
20919 msgid "Blank lines are also ignored."
20923 #: ../fish/guestfish.pod:684
20924 msgid "RUNNING COMMANDS LOCALLY"
20928 #: ../fish/guestfish.pod:686
20930 "Any line which starts with a I<!> character is treated as a command sent to "
20931 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20935 #: ../fish/guestfish.pod:690
20939 " tgz-out /remote local/remote-data.tar.gz\n"
20944 #: ../fish/guestfish.pod:693
20946 "will create a directory C<local> on the host, and then export the contents "
20947 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20948 "(See C<tgz-out>)."
20952 #: ../fish/guestfish.pod:697
20954 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20955 "effect, due to the way that subprocesses work in Unix."
20959 #: ../fish/guestfish.pod:700
20960 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20964 #: ../fish/guestfish.pod:702
20966 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20967 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20968 "and executed as guestfish commands."
20972 #: ../fish/guestfish.pod:706
20974 "Thus you can use shell script to construct arbitrary guestfish commands "
20975 "which are then parsed by guestfish."
20979 #: ../fish/guestfish.pod:709
20981 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20982 "through C</foo.100>) using guestfish commands alone. However this is simple "
20983 "if we use a shell script to create the guestfish commands for us:"
20987 #: ../fish/guestfish.pod:714
20990 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20995 #: ../fish/guestfish.pod:716
20996 msgid "or with names like C</foo.001>:"
21000 #: ../fish/guestfish.pod:718
21003 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
21008 #: ../fish/guestfish.pod:720
21010 "When using guestfish interactively it can be helpful to just run the shell "
21011 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21012 "ordinary I<!> local command), see what guestfish commands it would run, and "
21013 "when you are happy with those prepend the C<E<lt>> character to run the "
21014 "guestfish commands for real."
21018 #: ../fish/guestfish.pod:726
21023 #: ../fish/guestfish.pod:728
21025 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21026 "command (a guestfish command) to the second command (any host command). For "
21031 #: ../fish/guestfish.pod:732
21034 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21039 #: ../fish/guestfish.pod:734
21041 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21042 "program). The above command would list all accounts in the guest filesystem "
21043 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21047 #: ../fish/guestfish.pod:739
21050 " hexdump /bin/ls | head\n"
21051 " list-devices | tail -1\n"
21052 " tgz-out / - | tar ztf -\n"
21057 #: ../fish/guestfish.pod:743
21059 "The space before the pipe symbol is required, any space after the pipe "
21060 "symbol is optional. Everything after the pipe symbol is just passed "
21061 "straight to the host shell, so it can contain redirections, globs and "
21062 "anything else that makes sense on the host side."
21066 #: ../fish/guestfish.pod:748
21068 "To use a literal argument which begins with a pipe symbol, you have to quote "
21073 #: ../fish/guestfish.pod:751
21081 #: ../fish/guestfish.pod:753
21082 msgid "HOME DIRECTORIES"
21086 #: ../fish/guestfish.pod:755
21088 "If a parameter starts with the character C<~> then the tilde may be expanded "
21089 "as a home directory path (either C<~> for the current user's home directory, "
21090 "or C<~user> for another user)."
21094 #: ../fish/guestfish.pod:759
21096 "Note that home directory expansion happens for users known I<on the host>, "
21097 "not in the guest filesystem."
21101 #: ../fish/guestfish.pod:762
21103 "To use a literal argument which begins with a tilde, you have to quote it, "
21108 #: ../fish/guestfish.pod:765
21116 #: ../fish/guestfish.pod:769
21118 "Libguestfs has some support for Linux guests encrypted according to the "
21119 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21120 "disk encryption systems used by modern Linux guests. Currently only "
21121 "LVM-on-LUKS is supported."
21125 #: ../fish/guestfish.pod:774
21126 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21130 #: ../fish/guestfish.pod:776
21133 " ><fs> vfs-type /dev/sda2\n"
21139 #: ../fish/guestfish.pod:779
21141 "Then open those devices using L</luks-open>. This creates a device-mapper "
21142 "device called C</dev/mapper/luksdev>."
21146 #: ../fish/guestfish.pod:782
21149 " ><fs> luks-open /dev/sda2 luksdev\n"
21150 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21155 #: ../fish/guestfish.pod:785
21157 "Finally you have to tell LVM to scan for volume groups on the newly created "
21162 #: ../fish/guestfish.pod:788
21166 " vg-activate-all true\n"
21171 #: ../fish/guestfish.pod:791
21172 msgid "The logical volume(s) can now be mounted in the usual way."
21176 #: ../fish/guestfish.pod:793
21178 "Before closing a LUKS device you must unmount any logical volumes on it and "
21179 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21180 "one. Then you can close the mapper device:"
21184 #: ../fish/guestfish.pod:797
21187 " vg-activate false /dev/VG\n"
21188 " luks-close /dev/mapper/luksdev\n"
21193 #: ../fish/guestfish.pod:800
21194 msgid "WINDOWS PATHS"
21198 #: ../fish/guestfish.pod:802
21200 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21201 "letters and paths (with some limitations). The following commands are "
21206 #: ../fish/guestfish.pod:806
21209 " file /WINDOWS/system32/config/system.LOG\n"
21214 #: ../fish/guestfish.pod:808
21217 " file win:\\windows\\system32\\config\\system.log\n"
21222 #: ../fish/guestfish.pod:810
21225 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21230 #: ../fish/guestfish.pod:812
21232 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21233 "where the drive is mounted, prepending that to the path, changing all "
21234 "backslash characters to forward slash, then resolving the result using "
21235 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
21236 "then the parameter might be rewritten like this:"
21240 #: ../fish/guestfish.pod:818
21243 " win:e:\\foo\\bar => /e/FOO/bar\n"
21248 #: ../fish/guestfish.pod:820
21249 msgid "This only works in argument positions that expect a path."
21253 #: ../fish/guestfish.pod:822
21254 msgid "UPLOADING AND DOWNLOADING FILES"
21258 #: ../fish/guestfish.pod:824
21260 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21261 "others which upload from or download to a local file, you can use the "
21262 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21266 #: ../fish/guestfish.pod:828
21274 #: ../fish/guestfish.pod:830
21275 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
21279 #: ../fish/guestfish.pod:833
21282 " tar-out /etc - | tar tf -\n"
21287 #: ../fish/guestfish.pod:835
21289 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21290 "command (see L</PIPES>)."
21294 #: ../fish/guestfish.pod:838
21296 "When using C<-> to read from stdin, the input is read up to the end of "
21297 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21298 "some arbitrary end marker:"
21302 #: ../fish/guestfish.pod:842
21305 " upload -<<END /foo\n"
21314 #: ../fish/guestfish.pod:848
21316 "Any string of characters can be used instead of C<END>. The end marker must "
21317 "appear on a line of its own, without any preceeding or following characters "
21318 "(not even spaces)."
21322 #: ../fish/guestfish.pod:852
21324 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21325 "upload local files (so-called \"FileIn\" parameters in the generator)."
21329 #: ../fish/guestfish.pod:855
21330 msgid "EXIT ON ERROR BEHAVIOUR"
21334 #: ../fish/guestfish.pod:857
21336 "By default, guestfish will ignore any errors when in interactive mode "
21337 "(ie. taking commands from a human over a tty), and will exit on the first "
21338 "error in non-interactive mode (scripts, commands given on the command line)."
21342 #: ../fish/guestfish.pod:862
21344 "If you prefix a command with a I<-> character, then that command will not "
21345 "cause guestfish to exit, even if that (one) command returns an error."
21349 #: ../fish/guestfish.pod:866
21350 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21354 #: ../fish/guestfish.pod:868
21356 "Guestfish can be remote-controlled over a socket. This is useful "
21357 "particularly in shell scripts where you want to make several different "
21358 "changes to a filesystem, but you don't want the overhead of starting up a "
21359 "guestfish process each time."
21363 #: ../fish/guestfish.pod:873
21364 msgid "Start a guestfish server process using:"
21368 #: ../fish/guestfish.pod:875
21371 " eval \"`guestfish --listen`\"\n"
21376 #: ../fish/guestfish.pod:877
21377 msgid "and then send it commands by doing:"
21381 #: ../fish/guestfish.pod:879
21384 " guestfish --remote cmd [...]\n"
21389 #: ../fish/guestfish.pod:881
21390 msgid "To cause the server to exit, send it the exit command:"
21394 #: ../fish/guestfish.pod:883
21397 " guestfish --remote exit\n"
21402 #: ../fish/guestfish.pod:885
21404 "Note that the server will normally exit if there is an error in a command. "
21405 "You can change this in the usual way. See section L</EXIT ON ERROR "
21410 #: ../fish/guestfish.pod:889
21411 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21415 #: ../fish/guestfish.pod:891
21417 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21418 "is how the I<--remote> option knows where to send the commands. You can "
21419 "have several guestfish listener processes running using:"
21423 #: ../fish/guestfish.pod:895
21426 " eval \"`guestfish --listen`\"\n"
21427 " pid1=$GUESTFISH_PID\n"
21428 " eval \"`guestfish --listen`\"\n"
21429 " pid2=$GUESTFISH_PID\n"
21431 " guestfish --remote=$pid1 cmd\n"
21432 " guestfish --remote=$pid2 cmd\n"
21437 #: ../fish/guestfish.pod:903
21438 msgid "REMOTE CONTROL AND CSH"
21442 #: ../fish/guestfish.pod:905
21444 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21449 #: ../fish/guestfish.pod:908
21452 " eval \"`guestfish --listen --csh`\"\n"
21457 #: ../fish/guestfish.pod:910
21458 msgid "REMOTE CONTROL DETAILS"
21462 #: ../fish/guestfish.pod:912
21464 "Remote control happens over a Unix domain socket called "
21465 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
21466 "of the process, and C<$PID> is the process ID of the server."
21470 #: ../fish/guestfish.pod:916
21471 msgid "Guestfish client and server versions must match exactly."
21475 #: ../fish/guestfish.pod:918
21476 msgid "PREPARED DISK IMAGES"
21480 #: ../fish/guestfish.pod:920
21482 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21483 "preformatted disk images that guestfish can make for you to save typing. "
21484 "This is particularly useful for testing purposes. This option is used "
21485 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21486 "can be mixed with I<-a>)."
21490 #: ../fish/guestfish.pod:926
21492 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21493 "the second and so on. Existing files in the current directory are "
21498 #: ../fish/guestfish.pod:930
21500 "The type briefly describes how the disk should be sized, partitioned, how "
21501 "filesystem(s) should be created, and how content should be added. "
21502 "Optionally the type can be followed by extra parameters, separated by C<:> "
21503 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
21504 "sparsely-allocated disk, containing a single partition, with the partition "
21505 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
21506 "on a 1GB disk instead."
21510 #: ../fish/guestfish.pod:938
21511 msgid "To list the available types and any extra parameters they take, run:"
21515 #: ../fish/guestfish.pod:942
21517 "Note that the prepared filesystem is not mounted. You would usually have to "
21518 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21522 #: ../fish/guestfish.pod:946
21524 "If any I<-N> or I<--new> options are given, the guest is automatically "
21529 #: ../fish/guestfish.pod:951
21530 msgid "Create a 100MB disk with an ext4-formatted partition:"
21534 #: ../fish/guestfish.pod:953
21537 " guestfish -N fs:ext4\n"
21542 #: ../fish/guestfish.pod:955
21543 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21547 #: ../fish/guestfish.pod:957
21550 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21555 #: ../fish/guestfish.pod:959
21556 msgid "Create a blank 200MB disk:"
21560 #: ../fish/guestfish.pod:961
21563 " guestfish -N disk:200M\n"
21568 #: ../fish/guestfish.pod:963
21569 msgid "PROGRESS BARS"
21573 #: ../fish/guestfish.pod:965
21575 "Some (not all) long-running commands send progress notification messages as "
21576 "they are running. Guestfish turns these messages into progress bars."
21580 #: ../fish/guestfish.pod:969
21582 "When a command that supports progress bars takes longer than two seconds to "
21583 "run, and if progress bars are enabled, then you will see one appearing below "
21588 #: ../fish/guestfish.pod:973
21591 " ><fs> copy-size /large-file /another-file 2048M\n"
21592 " / 10% [#####-----------------------------------------] 00:30\n"
21597 #: ../fish/guestfish.pod:976
21599 "The spinner on the left hand side moves round once for every progress "
21600 "notification received from the backend. This is a (reasonably) golden "
21601 "assurance that the command is \"doing something\" even if the progress bar "
21602 "is not moving, because the command is able to send the progress "
21603 "notifications. When the bar reaches 100% and the command finishes, the "
21604 "spinner disappears."
21608 #: ../fish/guestfish.pod:983
21610 "Progress bars are enabled by default when guestfish is used interactively. "
21611 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21612 "and you can disable them completely using I<--no-progress-bars>."
21616 #: ../fish/guestfish.pod:988
21617 msgid "GUESTFISH COMMANDS"
21621 #: ../fish/guestfish.pod:990
21623 "The commands in this section are guestfish convenience commands, in other "
21624 "words, they are not part of the L<guestfs(3)> API."
21628 #: ../fish/guestfish.pod:993
21633 #: ../fish/guestfish.pod:995
21642 #: ../fish/guestfish.pod:998
21643 msgid "Without any parameter, this provides general help."
21647 #: ../fish/guestfish.pod:1000
21648 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21652 #: ../fish/guestfish.pod:1002
21653 msgid "quit | exit"
21657 #: ../fish/guestfish.pod:1004
21658 msgid "This exits guestfish. You can also use C<^D> key."
21662 #: ../fish/guestfish.pod:1006
21663 msgid "@FISH_COMMANDS@"
21667 #: ../fish/guestfish.pod:1008
21672 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
21677 #: ../fish/guestfish.pod:1014
21679 "guestfish returns 0 if the commands completed without error, or 1 if there "
21684 #: ../fish/guestfish.pod:1021
21689 #: ../fish/guestfish.pod:1023
21691 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21696 #: ../fish/guestfish.pod:1026
21697 msgid "GUESTFISH_DISPLAY_IMAGE"
21701 #: ../fish/guestfish.pod:1028
21703 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
21704 "If not set, it uses L<display(1)>."
21708 #: ../fish/guestfish.pod:1031
21709 msgid "GUESTFISH_PID"
21713 #: ../fish/guestfish.pod:1033
21715 "Used with the I<--remote> option to specify the remote guestfish process to "
21716 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21720 #: ../fish/guestfish.pod:1037
21725 #: ../fish/guestfish.pod:1039
21727 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21728 "not specified, the external L<hexedit(1)> program is used."
21732 #: ../fish/guestfish.pod:1043
21737 #: ../fish/guestfish.pod:1045
21739 "If compiled with GNU readline support, various files in the home directory "
21740 "can be used. See L</FILES>."
21744 #: ../fish/guestfish.pod:1054
21746 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21747 "effect as using the B<-v> option."
21751 #: ../fish/guestfish.pod:1066
21753 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21754 "the discussion of paths in L<guestfs(3)>."
21758 #: ../fish/guestfish.pod:1077
21759 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21763 #: ../fish/guestfish.pod:1079
21768 #: ../fish/guestfish.pod:1081
21770 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21775 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
21780 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
21781 msgid "$HOME/.libguestfs-tools.rc"
21785 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
21786 msgid "/etc/libguestfs-tools.conf"
21790 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
21792 "This configuration file controls the default read-only or read-write mode "
21793 "(I<--ro> or I<--rw>)."
21797 #: ../fish/guestfish.pod:1108
21798 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21802 #: ../fish/guestfish.pod:1110
21803 msgid "$HOME/.guestfish"
21807 #: ../fish/guestfish.pod:1112
21809 "If compiled with GNU readline support, then the command history is saved in "
21814 #: ../fish/guestfish.pod:1115
21815 msgid "$HOME/.inputrc"
21819 #: ../fish/guestfish.pod:1117
21820 msgid "/etc/inputrc"
21824 #: ../fish/guestfish.pod:1119
21826 "If compiled with GNU readline support, then these files can be used to "
21827 "configure readline. For further information, please see "
21828 "L<readline(3)/INITIALIZATION FILE>."
21832 #: ../fish/guestfish.pod:1123
21833 msgid "To write rules which only apply to guestfish, use:"
21837 #: ../fish/guestfish.pod:1125
21847 #: ../fish/guestfish.pod:1129
21849 "Variables that you can set in inputrc that change the behaviour of guestfish "
21850 "in useful ways include:"
21854 #: ../fish/guestfish.pod:1134
21855 msgid "completion-ignore-case (default: on)"
21859 #: ../fish/guestfish.pod:1136
21861 "By default, guestfish will ignore case when tab-completing paths on the "
21866 #: ../fish/guestfish.pod:1139
21869 " set completion-ignore-case off\n"
21874 #: ../fish/guestfish.pod:1141
21875 msgid "to make guestfish case sensitive."
21879 #: ../fish/guestfish.pod:1145
21884 #: ../fish/guestfish.pod:1147
21885 msgid "test2.img (etc)"
21889 #: ../fish/guestfish.pod:1149
21891 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21892 "will be created in the file C<test1.img> in the current directory. The "
21893 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21894 "the same name will be overwritten."
21898 #: ../fish/guestfish.pod:1158
21900 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
21901 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
21902 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
21903 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21904 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21905 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>."
21909 #: ../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
21911 "This program is free software; you can redistribute it and/or modify it "
21912 "under the terms of the GNU General Public License as published by the Free "
21913 "Software Foundation; either version 2 of the License, or (at your option) "
21914 "any later version."
21918 #: ../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
21920 "This program is distributed in the hope that it will be useful, but WITHOUT "
21921 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21922 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21927 #: ../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
21929 "You should have received a copy of the GNU General Public License along with "
21930 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21931 "Ave, Cambridge, MA 02139, USA."
21935 #: ../fish/guestfish-actions.pod:1
21940 #: ../fish/guestfish-actions.pod:3
21943 " add-cdrom filename\n"
21948 #: ../fish/guestfish-actions.pod:15
21950 "This call checks for the existence of C<filename>. This stops you from "
21951 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21952 "and C<http:> URLs. To specify those, use the general L</config> call "
21957 #: ../fish/guestfish-actions.pod:22
21959 "If you just want to add an ISO file (often you use this as an efficient way "
21960 "to transfer large files into the guest), then you should probably use "
21961 "L</add-drive-ro> instead."
21965 #: ../fish/guestfish-actions.pod:35
21970 #: ../fish/guestfish-actions.pod:37
21975 #: ../fish/guestfish-actions.pod:39
21978 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
21984 #: ../fish/guestfish-actions.pod:41
21986 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21987 "It works by connecting to libvirt, requesting the domain and domain XML from "
21988 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21992 #: ../fish/guestfish-actions.pod:76
21994 "The other optional parameters are passed directly through to "
21995 "L</add-drive-opts>."
21999 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1962 ../fish/guestfish-actions.pod:3128 ../fish/guestfish-actions.pod:3301 ../fish/guestfish-actions.pod:3436
22001 "This command has one or more optional arguments. See L</OPTIONAL "
22006 #: ../fish/guestfish-actions.pod:81
22011 #: ../fish/guestfish-actions.pod:83
22014 " add-drive filename\n"
22019 #: ../fish/guestfish-actions.pod:85
22021 "This function is the equivalent of calling L</add-drive-opts> with no "
22022 "optional parameters, so the disk is added writable, with the format being "
22023 "detected automatically."
22027 #: ../fish/guestfish-actions.pod:89
22029 "Automatic detection of the format opens you up to a potential security hole "
22030 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22031 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22032 "you should think about replacing calls to this function with calls to "
22033 "L</add-drive-opts>, and specifying the format."
22037 #: ../fish/guestfish-actions.pod:96
22038 msgid "add-drive-opts"
22042 #: ../fish/guestfish-actions.pod:98
22047 #: ../fish/guestfish-actions.pod:100
22050 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22055 #: ../fish/guestfish-actions.pod:127
22057 "This forces the image format. If you omit this (or use L</add-drive> or "
22058 "L</add-drive-ro>) then the format is automatically detected. Possible "
22059 "formats include C<raw> and C<qcow2>."
22063 #: ../fish/guestfish-actions.pod:138
22065 "This rarely-used option lets you emulate the behaviour of the deprecated "
22066 "L</add-drive-with-if> call (q.v.)"
22070 #: ../fish/guestfish-actions.pod:145
22071 msgid "add-drive-ro"
22075 #: ../fish/guestfish-actions.pod:147
22080 #: ../fish/guestfish-actions.pod:149
22083 " add-drive-ro filename\n"
22088 #: ../fish/guestfish-actions.pod:151
22090 "This function is the equivalent of calling L</add-drive-opts> with the "
22091 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22092 "is added read-only, with the format being detected automatically."
22096 #: ../fish/guestfish-actions.pod:156
22097 msgid "add-drive-ro-with-if"
22101 #: ../fish/guestfish-actions.pod:158
22104 " add-drive-ro-with-if filename iface\n"
22109 #: ../fish/guestfish-actions.pod:160
22111 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22112 "interface emulation to use at run time."
22116 #: ../fish/guestfish-actions.pod:170
22117 msgid "add-drive-with-if"
22121 #: ../fish/guestfish-actions.pod:172
22124 " add-drive-with-if filename iface\n"
22129 #: ../fish/guestfish-actions.pod:174
22131 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22132 "interface emulation to use at run time."
22136 #: ../fish/guestfish-actions.pod:184
22141 #: ../fish/guestfish-actions.pod:186
22144 " aug-clear augpath\n"
22149 #: ../fish/guestfish-actions.pod:191
22154 #: ../fish/guestfish-actions.pod:193
22162 #: ../fish/guestfish-actions.pod:195
22164 "Close the current Augeas handle and free up any resources used by it. After "
22165 "calling this, you have to call L</aug-init> again before you can use any "
22166 "other Augeas functions."
22170 #: ../fish/guestfish-actions.pod:200
22171 msgid "aug-defnode"
22175 #: ../fish/guestfish-actions.pod:202
22178 " aug-defnode name expr val\n"
22183 #: ../fish/guestfish-actions.pod:207
22185 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22186 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22187 "containing that single node."
22191 #: ../fish/guestfish-actions.pod:215
22196 #: ../fish/guestfish-actions.pod:217
22199 " aug-defvar name expr\n"
22204 #: ../fish/guestfish-actions.pod:226
22209 #: ../fish/guestfish-actions.pod:228
22212 " aug-get augpath\n"
22217 #: ../fish/guestfish-actions.pod:233
22222 #: ../fish/guestfish-actions.pod:235
22225 " aug-init root flags\n"
22230 #: ../fish/guestfish-actions.pod:241
22231 msgid "You must call this before using any other L</aug-*> commands."
22235 #: ../fish/guestfish-actions.pod:276
22236 msgid "Do not load the tree in L</aug-init>."
22240 #: ../fish/guestfish-actions.pod:280
22241 msgid "To close the handle, you can call L</aug-close>."
22245 #: ../fish/guestfish-actions.pod:284
22250 #: ../fish/guestfish-actions.pod:286
22253 " aug-insert augpath label true|false\n"
22258 #: ../fish/guestfish-actions.pod:296
22263 #: ../fish/guestfish-actions.pod:298
22271 #: ../fish/guestfish-actions.pod:305
22276 #: ../fish/guestfish-actions.pod:307
22279 " aug-ls augpath\n"
22284 #: ../fish/guestfish-actions.pod:309
22286 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22287 "resulting nodes into alphabetical order."
22291 #: ../fish/guestfish-actions.pod:312
22296 #: ../fish/guestfish-actions.pod:314
22299 " aug-match augpath\n"
22304 #: ../fish/guestfish-actions.pod:320
22309 #: ../fish/guestfish-actions.pod:322
22312 " aug-mv src dest\n"
22317 #: ../fish/guestfish-actions.pod:327
22322 #: ../fish/guestfish-actions.pod:329
22325 " aug-rm augpath\n"
22330 #: ../fish/guestfish-actions.pod:335
22335 #: ../fish/guestfish-actions.pod:337
22343 #: ../fish/guestfish-actions.pod:341
22345 "The flags which were passed to L</aug-init> affect exactly how files are "
22350 #: ../fish/guestfish-actions.pod:344
22355 #: ../fish/guestfish-actions.pod:346
22358 " aug-set augpath val\n"
22363 #: ../fish/guestfish-actions.pod:350
22365 "In the Augeas API, it is possible to clear a node by setting the value to "
22366 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22367 "this call. Instead you must use the L</aug-clear> call."
22371 #: ../fish/guestfish-actions.pod:355
22376 #: ../fish/guestfish-actions.pod:357
22379 " available 'groups ...'\n"
22384 #: ../fish/guestfish-actions.pod:363
22386 "The libguestfs groups, and the functions that those groups correspond to, "
22387 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22388 "runtime by calling L</available-all-groups>."
22392 #: ../fish/guestfish-actions.pod:387
22393 msgid "You must call L</launch> before calling this function."
22397 #: ../fish/guestfish-actions.pod:409
22399 "This call was added in version C<1.0.80>. In previous versions of "
22400 "libguestfs all you could do would be to speculatively execute a command to "
22401 "find out if the daemon implemented it. See also L</version>."
22405 #: ../fish/guestfish-actions.pod:416
22406 msgid "available-all-groups"
22410 #: ../fish/guestfish-actions.pod:418
22413 " available-all-groups\n"
22418 #: ../fish/guestfish-actions.pod:420
22420 "This command returns a list of all optional groups that this daemon knows "
22421 "about. Note this returns both supported and unsupported groups. To find "
22422 "out which ones the daemon can actually support you have to call "
22423 "L</available> on each member of the returned list."
22427 #: ../fish/guestfish-actions.pod:426
22428 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22432 #: ../fish/guestfish-actions.pod:428
22437 #: ../fish/guestfish-actions.pod:430
22440 " base64-in (base64file|-) filename\n"
22445 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444 ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862 ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255 ../fish/guestfish-actions.pod:4631 ../fish/guestfish-actions.pod:4643 ../fish/guestfish-actions.pod:4654 ../fish/guestfish-actions.pod:4665 ../fish/guestfish-actions.pod:4717 ../fish/guestfish-actions.pod:4726 ../fish/guestfish-actions.pod:4780 ../fish/guestfish-actions.pod:4803
22446 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22450 #: ../fish/guestfish-actions.pod:437
22455 #: ../fish/guestfish-actions.pod:439
22458 " base64-out filename (base64file|-)\n"
22463 #: ../fish/guestfish-actions.pod:446
22464 msgid "blockdev-flushbufs"
22468 #: ../fish/guestfish-actions.pod:448
22471 " blockdev-flushbufs device\n"
22476 #: ../fish/guestfish-actions.pod:455
22477 msgid "blockdev-getbsz"
22481 #: ../fish/guestfish-actions.pod:457
22484 " blockdev-getbsz device\n"
22489 #: ../fish/guestfish-actions.pod:466
22490 msgid "blockdev-getro"
22494 #: ../fish/guestfish-actions.pod:468
22497 " blockdev-getro device\n"
22502 #: ../fish/guestfish-actions.pod:475
22503 msgid "blockdev-getsize64"
22507 #: ../fish/guestfish-actions.pod:477
22510 " blockdev-getsize64 device\n"
22515 #: ../fish/guestfish-actions.pod:481
22516 msgid "See also L</blockdev-getsz>."
22520 #: ../fish/guestfish-actions.pod:485
22521 msgid "blockdev-getss"
22525 #: ../fish/guestfish-actions.pod:487
22528 " blockdev-getss device\n"
22533 #: ../fish/guestfish-actions.pod:492
22534 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22538 #: ../fish/guestfish-actions.pod:497
22539 msgid "blockdev-getsz"
22543 #: ../fish/guestfish-actions.pod:499
22546 " blockdev-getsz device\n"
22551 #: ../fish/guestfish-actions.pod:504
22553 "See also L</blockdev-getss> for the real sector size of the device, and "
22554 "L</blockdev-getsize64> for the more useful I<size in bytes>."
22558 #: ../fish/guestfish-actions.pod:510
22559 msgid "blockdev-rereadpt"
22563 #: ../fish/guestfish-actions.pod:512
22566 " blockdev-rereadpt device\n"
22571 #: ../fish/guestfish-actions.pod:518
22572 msgid "blockdev-setbsz"
22576 #: ../fish/guestfish-actions.pod:520
22579 " blockdev-setbsz device blocksize\n"
22584 #: ../fish/guestfish-actions.pod:529
22585 msgid "blockdev-setro"
22589 #: ../fish/guestfish-actions.pod:531
22592 " blockdev-setro device\n"
22597 #: ../fish/guestfish-actions.pod:537
22598 msgid "blockdev-setrw"
22602 #: ../fish/guestfish-actions.pod:539
22605 " blockdev-setrw device\n"
22610 #: ../fish/guestfish-actions.pod:545
22611 msgid "btrfs-filesystem-resize"
22615 #: ../fish/guestfish-actions.pod:547
22618 " btrfs-filesystem-resize mountpoint [size:..]\n"
22623 #: ../fish/guestfish-actions.pod:570
22624 msgid "case-sensitive-path"
22628 #: ../fish/guestfish-actions.pod:572
22631 " case-sensitive-path path\n"
22636 #: ../fish/guestfish-actions.pod:596
22638 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
22639 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22640 "how the directories were originally created under Windows)."
22644 #: ../fish/guestfish-actions.pod:604
22645 msgid "See also L</realpath>."
22649 #: ../fish/guestfish-actions.pod:606
22654 #: ../fish/guestfish-actions.pod:608
22662 #: ../fish/guestfish-actions.pod:612
22664 "Note that this function cannot correctly handle binary files (specifically, "
22665 "files containing C<\\0> character which is treated as end of string). For "
22666 "those you need to use the L</read-file> or L</download> functions which have "
22667 "a more complex interface."
22671 #: ../fish/guestfish-actions.pod:620
22676 #: ../fish/guestfish-actions.pod:622
22679 " checksum csumtype path\n"
22684 #: ../fish/guestfish-actions.pod:665
22685 msgid "To get the checksum for a device, use L</checksum-device>."
22689 #: ../fish/guestfish-actions.pod:667
22690 msgid "To get the checksums for many files, use L</checksums-out>."
22694 #: ../fish/guestfish-actions.pod:669
22695 msgid "checksum-device"
22699 #: ../fish/guestfish-actions.pod:671
22702 " checksum-device csumtype device\n"
22707 #: ../fish/guestfish-actions.pod:673
22709 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22710 "device named C<device>. For the types of checksums supported see the "
22711 "L</checksum> command."
22715 #: ../fish/guestfish-actions.pod:677
22716 msgid "checksums-out"
22720 #: ../fish/guestfish-actions.pod:679
22723 " checksums-out csumtype directory (sumsfile|-)\n"
22728 #: ../fish/guestfish-actions.pod:695
22733 #: ../fish/guestfish-actions.pod:697
22736 " chmod mode path\n"
22741 #: ../fish/guestfish-actions.pod:708
22746 #: ../fish/guestfish-actions.pod:710
22749 " chown owner group path\n"
22754 #: ../fish/guestfish-actions.pod:718
22759 #: ../fish/guestfish-actions.pod:720
22762 " command 'arguments ...'\n"
22767 #: ../fish/guestfish-actions.pod:727
22769 "The single parameter is an argv-style list of arguments. The first element "
22770 "is the name of the program to run. Subsequent elements are parameters. The "
22771 "list must be non-empty (ie. must contain a program name). Note that the "
22772 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22776 #: ../fish/guestfish-actions.pod:755
22777 msgid "command-lines"
22781 #: ../fish/guestfish-actions.pod:757
22784 " command-lines 'arguments ...'\n"
22789 #: ../fish/guestfish-actions.pod:759
22790 msgid "This is the same as L</command>, but splits the result into a list of lines."
22794 #: ../fish/guestfish-actions.pod:762
22795 msgid "See also: L</sh-lines>"
22799 #: ../fish/guestfish-actions.pod:767
22804 #: ../fish/guestfish-actions.pod:769
22807 " config qemuparam qemuvalue\n"
22812 #: ../fish/guestfish-actions.pod:780
22817 #: ../fish/guestfish-actions.pod:782
22820 " copy-size src dest size\n"
22825 #: ../fish/guestfish-actions.pod:790
22830 #: ../fish/guestfish-actions.pod:792
22838 #: ../fish/guestfish-actions.pod:797
22843 #: ../fish/guestfish-actions.pod:799
22851 #: ../fish/guestfish-actions.pod:804
22856 #: ../fish/guestfish-actions.pod:806
22864 #: ../fish/guestfish-actions.pod:813
22866 "If the destination is a device, it must be as large or larger than the "
22867 "source file or device, otherwise the copy will fail. This command cannot do "
22868 "partial copies (see L</copy-size>)."
22872 #: ../fish/guestfish-actions.pod:817
22877 #: ../fish/guestfish-actions.pod:819
22885 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
22887 "This command is mostly useful for interactive sessions. It is I<not> "
22888 "intended that you try to parse the output string. Use L</statvfs> from "
22893 #: ../fish/guestfish-actions.pod:827
22898 #: ../fish/guestfish-actions.pod:829
22906 #: ../fish/guestfish-actions.pod:838
22911 #: ../fish/guestfish-actions.pod:840
22919 #: ../fish/guestfish-actions.pod:846
22921 "Another way to get the same information is to enable verbose messages with "
22922 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22923 "before running the program."
22927 #: ../fish/guestfish-actions.pod:851
22932 #: ../fish/guestfish-actions.pod:853
22935 " download remotefilename (filename|-)\n"
22940 #: ../fish/guestfish-actions.pod:860
22941 msgid "See also L</upload>, L</cat>."
22945 #: ../fish/guestfish-actions.pod:864
22946 msgid "download-offset"
22950 #: ../fish/guestfish-actions.pod:866
22953 " download-offset remotefilename (filename|-) offset size\n"
22958 #: ../fish/guestfish-actions.pod:874
22960 "Note that there is no limit on the amount of data that can be downloaded "
22961 "with this call, unlike with L</pread>, and this call always reads the full "
22962 "amount unless an error occurs."
22966 #: ../fish/guestfish-actions.pod:879
22967 msgid "See also L</download>, L</pread>."
22971 #: ../fish/guestfish-actions.pod:883
22972 msgid "drop-caches"
22976 #: ../fish/guestfish-actions.pod:885
22979 " drop-caches whattodrop\n"
22984 #: ../fish/guestfish-actions.pod:897
22989 #: ../fish/guestfish-actions.pod:899
22997 #: ../fish/guestfish-actions.pod:911
23002 #: ../fish/guestfish-actions.pod:913
23005 " e2fsck-f device\n"
23010 #: ../fish/guestfish-actions.pod:919
23012 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23013 "should use L</fsck>."
23017 #: ../fish/guestfish-actions.pod:922
23018 msgid "echo-daemon"
23022 #: ../fish/guestfish-actions.pod:924
23025 " echo-daemon 'words ...'\n"
23030 #: ../fish/guestfish-actions.pod:931
23031 msgid "See also L</ping-daemon>."
23035 #: ../fish/guestfish-actions.pod:933
23040 #: ../fish/guestfish-actions.pod:935
23043 " egrep regex path\n"
23048 #: ../fish/guestfish-actions.pod:943
23053 #: ../fish/guestfish-actions.pod:945
23056 " egrepi regex path\n"
23061 #: ../fish/guestfish-actions.pod:953
23066 #: ../fish/guestfish-actions.pod:955
23069 " equal file1 file2\n"
23074 #: ../fish/guestfish-actions.pod:962
23079 #: ../fish/guestfish-actions.pod:964
23087 #: ../fish/guestfish-actions.pod:969
23088 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23092 #: ../fish/guestfish-actions.pod:971
23097 #: ../fish/guestfish-actions.pod:973
23100 " fallocate path len\n"
23105 #: ../fish/guestfish-actions.pod:990
23106 msgid "fallocate64"
23110 #: ../fish/guestfish-actions.pod:992
23113 " fallocate64 path len\n"
23118 #: ../fish/guestfish-actions.pod:998
23120 "Note that this call allocates disk blocks for the file. To create a sparse "
23121 "file use L</truncate-size> instead."
23125 #: ../fish/guestfish-actions.pod:1001
23127 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23128 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23129 "maximum size of files created through that call to 1GB."
23133 #: ../fish/guestfish-actions.pod:1010
23138 #: ../fish/guestfish-actions.pod:1012
23141 " fgrep pattern path\n"
23146 #: ../fish/guestfish-actions.pod:1020
23151 #: ../fish/guestfish-actions.pod:1022
23154 " fgrepi pattern path\n"
23159 #: ../fish/guestfish-actions.pod:1030
23164 #: ../fish/guestfish-actions.pod:1032
23172 #: ../fish/guestfish-actions.pod:1048
23174 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23175 "(etc), L</is-zero>."
23179 #: ../fish/guestfish-actions.pod:1051
23180 msgid "file-architecture"
23184 #: ../fish/guestfish-actions.pod:1053
23187 " file-architecture filename\n"
23192 #: ../fish/guestfish-actions.pod:1156
23197 #: ../fish/guestfish-actions.pod:1158
23205 #: ../fish/guestfish-actions.pod:1162
23207 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
23208 "L</is-file> etc. To get the size of block devices, use "
23209 "L</blockdev-getsize64>."
23213 #: ../fish/guestfish-actions.pod:1166
23218 #: ../fish/guestfish-actions.pod:1168
23221 " fill c len path\n"
23226 #: ../fish/guestfish-actions.pod:1174
23228 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23229 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23230 "L</fill-pattern>."
23234 #: ../fish/guestfish-actions.pod:1179
23235 msgid "fill-pattern"
23239 #: ../fish/guestfish-actions.pod:1181
23242 " fill-pattern pattern len path\n"
23247 #: ../fish/guestfish-actions.pod:1183
23249 "This function is like L</fill> except that it creates a new file of length "
23250 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23251 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23256 #: ../fish/guestfish-actions.pod:1188
23261 #: ../fish/guestfish-actions.pod:1190
23264 " find directory\n"
23269 #: ../fish/guestfish-actions.pod:1204
23270 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23274 #: ../fish/guestfish-actions.pod:1217
23275 msgid "See also L</find0>."
23279 #: ../fish/guestfish-actions.pod:1222
23284 #: ../fish/guestfish-actions.pod:1224
23287 " find0 directory (files|-)\n"
23292 #: ../fish/guestfish-actions.pod:1230
23293 msgid "This command works the same way as L</find> with the following exceptions:"
23297 #: ../fish/guestfish-actions.pod:1257
23298 msgid "findfs-label"
23302 #: ../fish/guestfish-actions.pod:1259
23305 " findfs-label label\n"
23310 #: ../fish/guestfish-actions.pod:1265
23311 msgid "To find the label of a filesystem, use L</vfs-label>."
23315 #: ../fish/guestfish-actions.pod:1267
23316 msgid "findfs-uuid"
23320 #: ../fish/guestfish-actions.pod:1269
23323 " findfs-uuid uuid\n"
23328 #: ../fish/guestfish-actions.pod:1275
23329 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23333 #: ../fish/guestfish-actions.pod:1277
23338 #: ../fish/guestfish-actions.pod:1279
23341 " fsck fstype device\n"
23346 #: ../fish/guestfish-actions.pod:1309
23351 #: ../fish/guestfish-actions.pod:1311
23359 #: ../fish/guestfish-actions.pod:1318
23360 msgid "get-attach-method"
23364 #: ../fish/guestfish-actions.pod:1320
23367 " get-attach-method\n"
23372 #: ../fish/guestfish-actions.pod:1322
23373 msgid "Return the current attach method. See L</set-attach-method>."
23377 #: ../fish/guestfish-actions.pod:1324
23378 msgid "get-autosync"
23382 #: ../fish/guestfish-actions.pod:1326
23390 #: ../fish/guestfish-actions.pod:1330
23395 #: ../fish/guestfish-actions.pod:1332
23403 #: ../fish/guestfish-actions.pod:1336
23404 msgid "get-e2label"
23408 #: ../fish/guestfish-actions.pod:1338
23411 " get-e2label device\n"
23416 #: ../fish/guestfish-actions.pod:1350
23421 #: ../fish/guestfish-actions.pod:1352
23424 " get-e2uuid device\n"
23429 #: ../fish/guestfish-actions.pod:1364
23430 msgid "get-memsize"
23434 #: ../fish/guestfish-actions.pod:1366
23442 #: ../fish/guestfish-actions.pod:1371
23444 "If L</set-memsize> was not called on this handle, and if "
23445 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23446 "value for memsize."
23450 #: ../fish/guestfish-actions.pod:1378
23451 msgid "get-network"
23455 #: ../fish/guestfish-actions.pod:1380
23463 #: ../fish/guestfish-actions.pod:1384
23468 #: ../fish/guestfish-actions.pod:1386
23476 #: ../fish/guestfish-actions.pod:1393
23481 #: ../fish/guestfish-actions.pod:1395
23486 #: ../fish/guestfish-actions.pod:1397
23494 #: ../fish/guestfish-actions.pod:1404
23499 #: ../fish/guestfish-actions.pod:1406
23507 #: ../fish/guestfish-actions.pod:1413
23508 msgid "get-recovery-proc"
23512 #: ../fish/guestfish-actions.pod:1415
23515 " get-recovery-proc\n"
23520 #: ../fish/guestfish-actions.pod:1419
23521 msgid "get-selinux"
23525 #: ../fish/guestfish-actions.pod:1421
23533 #: ../fish/guestfish-actions.pod:1423
23535 "This returns the current setting of the selinux flag which is passed to the "
23536 "appliance at boot time. See L</set-selinux>."
23540 #: ../fish/guestfish-actions.pod:1429
23545 #: ../fish/guestfish-actions.pod:1431
23553 #: ../fish/guestfish-actions.pod:1438
23558 #: ../fish/guestfish-actions.pod:1440
23566 #: ../fish/guestfish-actions.pod:1444
23571 #: ../fish/guestfish-actions.pod:1446
23579 #: ../fish/guestfish-actions.pod:1448
23581 "Return the current umask. By default the umask is C<022> unless it has been "
23582 "set by calling L</umask>."
23586 #: ../fish/guestfish-actions.pod:1451
23587 msgid "get-verbose"
23591 #: ../fish/guestfish-actions.pod:1453
23599 #: ../fish/guestfish-actions.pod:1457
23604 #: ../fish/guestfish-actions.pod:1459
23612 #: ../fish/guestfish-actions.pod:1463
23613 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23617 #: ../fish/guestfish-actions.pod:1466
23622 #: ../fish/guestfish-actions.pod:1468
23625 " getxattr path name\n"
23630 #: ../fish/guestfish-actions.pod:1470
23632 "Get a single extended attribute from file C<path> named C<name>. This call "
23633 "follows symlinks. If you want to lookup an extended attribute for the "
23634 "symlink itself, use L</lgetxattr>."
23638 #: ../fish/guestfish-actions.pod:1474 ../fish/guestfish-actions.pod:2501
23640 "Normally it is better to get all extended attributes from a file in one go "
23641 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23642 "buggy and do not provide a way to list out attributes. For these "
23643 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23644 "attributes you want in advance and call this function."
23648 #: ../fish/guestfish-actions.pod:1484
23649 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23653 #: ../fish/guestfish-actions.pod:1486
23658 #: ../fish/guestfish-actions.pod:1488
23661 " getxattrs path\n"
23666 #: ../fish/guestfish-actions.pod:1496
23667 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23671 #: ../fish/guestfish-actions.pod:1498
23672 msgid "glob-expand"
23676 #: ../fish/guestfish-actions.pod:1500
23679 " glob-expand pattern\n"
23684 #: ../fish/guestfish-actions.pod:1513
23689 #: ../fish/guestfish-actions.pod:1515
23692 " grep regex path\n"
23697 #: ../fish/guestfish-actions.pod:1523
23702 #: ../fish/guestfish-actions.pod:1525
23705 " grepi regex path\n"
23710 #: ../fish/guestfish-actions.pod:1533
23711 msgid "grub-install"
23715 #: ../fish/guestfish-actions.pod:1535
23718 " grub-install root device\n"
23723 #: ../fish/guestfish-actions.pod:1551
23728 #: ../fish/guestfish-actions.pod:1553
23736 #: ../fish/guestfish-actions.pod:1561
23741 #: ../fish/guestfish-actions.pod:1563
23744 " head-n nrlines path\n"
23749 #: ../fish/guestfish-actions.pod:1576
23754 #: ../fish/guestfish-actions.pod:1578
23762 #: ../fish/guestfish-actions.pod:1586
23767 #: ../fish/guestfish-actions.pod:1588
23770 " initrd-cat initrdpath filename\n"
23775 #: ../fish/guestfish-actions.pod:1600
23776 msgid "See also L</initrd-list>."
23780 #: ../fish/guestfish-actions.pod:1605
23781 msgid "initrd-list"
23785 #: ../fish/guestfish-actions.pod:1607
23788 " initrd-list path\n"
23793 #: ../fish/guestfish-actions.pod:1619
23794 msgid "inotify-add-watch"
23798 #: ../fish/guestfish-actions.pod:1621
23801 " inotify-add-watch path mask\n"
23806 #: ../fish/guestfish-actions.pod:1633
23807 msgid "inotify-close"
23811 #: ../fish/guestfish-actions.pod:1635
23819 #: ../fish/guestfish-actions.pod:1641
23820 msgid "inotify-files"
23824 #: ../fish/guestfish-actions.pod:1643
23832 #: ../fish/guestfish-actions.pod:1645
23834 "This function is a helpful wrapper around L</inotify-read> which just "
23835 "returns a list of pathnames of objects that were touched. The returned "
23836 "pathnames are sorted and deduplicated."
23840 #: ../fish/guestfish-actions.pod:1649
23841 msgid "inotify-init"
23845 #: ../fish/guestfish-actions.pod:1651
23848 " inotify-init maxevents\n"
23853 #: ../fish/guestfish-actions.pod:1657
23855 "C<maxevents> is the maximum number of events which will be queued up between "
23856 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23857 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23858 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23859 "but records the fact that it threw them away by setting a flag "
23860 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23864 #: ../fish/guestfish-actions.pod:1667
23866 "Before any events are generated, you have to add some watches to the "
23867 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23868 "L</inotify-watch-all>."
23872 #: ../fish/guestfish-actions.pod:1673
23874 "Queued up events should be read periodically by calling L</inotify-read> (or "
23875 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23876 "If you don't read the events out often enough then you risk the internal "
23877 "queue overflowing."
23881 #: ../fish/guestfish-actions.pod:1680
23883 "The handle should be closed after use by calling L</inotify-close>. This "
23884 "also removes any watches automatically."
23888 #: ../fish/guestfish-actions.pod:1689
23889 msgid "inotify-read"
23893 #: ../fish/guestfish-actions.pod:1691
23901 #: ../fish/guestfish-actions.pod:1704
23902 msgid "inotify-rm-watch"
23906 #: ../fish/guestfish-actions.pod:1706
23909 " inotify-rm-watch wd\n"
23914 #: ../fish/guestfish-actions.pod:1708
23915 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23919 #: ../fish/guestfish-actions.pod:1711
23920 msgid "inspect-get-arch"
23924 #: ../fish/guestfish-actions.pod:1713
23927 " inspect-get-arch root\n"
23932 #: ../fish/guestfish-actions.pod:1715
23934 "This returns the architecture of the inspected operating system. The "
23935 "possible return values are listed under L</file-architecture>."
23939 #: ../fish/guestfish-actions.pod:1724
23940 msgid "inspect-get-distro"
23944 #: ../fish/guestfish-actions.pod:1726
23947 " inspect-get-distro root\n"
23952 #: ../fish/guestfish-actions.pod:1807
23953 msgid "inspect-get-drive-mappings"
23957 #: ../fish/guestfish-actions.pod:1809
23960 " inspect-get-drive-mappings root\n"
23965 #: ../fish/guestfish-actions.pod:1836
23967 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23968 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23972 #: ../fish/guestfish-actions.pod:1840
23973 msgid "inspect-get-filesystems"
23977 #: ../fish/guestfish-actions.pod:1842
23980 " inspect-get-filesystems root\n"
23985 #: ../fish/guestfish-actions.pod:1852
23987 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23988 "L</inspect-get-mountpoints>."
23992 #: ../fish/guestfish-actions.pod:1855
23993 msgid "inspect-get-format"
23997 #: ../fish/guestfish-actions.pod:1857
24000 " inspect-get-format root\n"
24005 #: ../fish/guestfish-actions.pod:1886
24006 msgid "inspect-get-hostname"
24010 #: ../fish/guestfish-actions.pod:1888
24013 " inspect-get-hostname root\n"
24018 #: ../fish/guestfish-actions.pod:1898
24019 msgid "inspect-get-icon"
24023 #: ../fish/guestfish-actions.pod:1900
24026 " inspect-get-icon root [favicon:..] [highquality:..]\n"
24031 #: ../fish/guestfish-actions.pod:1964
24032 msgid "inspect-get-major-version"
24036 #: ../fish/guestfish-actions.pod:1966
24039 " inspect-get-major-version root\n"
24044 #: ../fish/guestfish-actions.pod:1982
24045 msgid "inspect-get-minor-version"
24049 #: ../fish/guestfish-actions.pod:1984
24052 " inspect-get-minor-version root\n"
24057 #: ../fish/guestfish-actions.pod:1991
24059 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24060 "L</inspect-get-major-version>."
24064 #: ../fish/guestfish-actions.pod:1994
24065 msgid "inspect-get-mountpoints"
24069 #: ../fish/guestfish-actions.pod:1996
24072 " inspect-get-mountpoints root\n"
24077 #: ../fish/guestfish-actions.pod:2015
24079 "For operating systems like Windows which still use drive letters, this call "
24080 "will only return an entry for the first drive \"mounted on\" C</>. For "
24081 "information about the mapping of drive letters to partitions, see "
24082 "L</inspect-get-drive-mappings>."
24086 #: ../fish/guestfish-actions.pod:2021
24088 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24089 "L</inspect-get-filesystems>."
24093 #: ../fish/guestfish-actions.pod:2024
24094 msgid "inspect-get-package-format"
24098 #: ../fish/guestfish-actions.pod:2026
24101 " inspect-get-package-format root\n"
24106 #: ../fish/guestfish-actions.pod:2028
24108 "This function and L</inspect-get-package-management> return the package "
24109 "format and package management tool used by the inspected operating system. "
24110 "For example for Fedora these functions would return C<rpm> (package format) "
24111 "and C<yum> (package management)."
24115 #: ../fish/guestfish-actions.pod:2043
24116 msgid "inspect-get-package-management"
24120 #: ../fish/guestfish-actions.pod:2045
24123 " inspect-get-package-management root\n"
24128 #: ../fish/guestfish-actions.pod:2047
24130 "L</inspect-get-package-format> and this function return the package format "
24131 "and package management tool used by the inspected operating system. For "
24132 "example for Fedora these functions would return C<rpm> (package format) and "
24133 "C<yum> (package management)."
24137 #: ../fish/guestfish-actions.pod:2064
24138 msgid "inspect-get-product-name"
24142 #: ../fish/guestfish-actions.pod:2066
24145 " inspect-get-product-name root\n"
24150 #: ../fish/guestfish-actions.pod:2078
24151 msgid "inspect-get-product-variant"
24155 #: ../fish/guestfish-actions.pod:2080
24158 " inspect-get-product-variant root\n"
24163 #: ../fish/guestfish-actions.pod:2101
24165 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24166 "L</inspect-get-product-name>, L</inspect-get-major-version>."
24170 #: ../fish/guestfish-actions.pod:2105
24171 msgid "inspect-get-roots"
24175 #: ../fish/guestfish-actions.pod:2107
24178 " inspect-get-roots\n"
24183 #: ../fish/guestfish-actions.pod:2109
24185 "This function is a convenient way to get the list of root devices, as "
24186 "returned from a previous call to L</inspect-os>, but without redoing the "
24187 "whole inspection process."
24191 #: ../fish/guestfish-actions.pod:2113
24193 "This returns an empty list if either no root devices were found or the "
24194 "caller has not called L</inspect-os>."
24198 #: ../fish/guestfish-actions.pod:2118
24199 msgid "inspect-get-type"
24203 #: ../fish/guestfish-actions.pod:2120
24206 " inspect-get-type root\n"
24211 #: ../fish/guestfish-actions.pod:2150
24212 msgid "inspect-get-windows-current-control-set"
24216 #: ../fish/guestfish-actions.pod:2152
24219 " inspect-get-windows-current-control-set root\n"
24224 #: ../fish/guestfish-actions.pod:2163
24225 msgid "inspect-get-windows-systemroot"
24229 #: ../fish/guestfish-actions.pod:2165
24232 " inspect-get-windows-systemroot root\n"
24237 #: ../fish/guestfish-actions.pod:2176
24238 msgid "inspect-is-live"
24242 #: ../fish/guestfish-actions.pod:2178
24245 " inspect-is-live root\n"
24250 #: ../fish/guestfish-actions.pod:2180
24252 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24253 "then this returns true if a live image was detected on the disk."
24257 #: ../fish/guestfish-actions.pod:2186
24258 msgid "inspect-is-multipart"
24262 #: ../fish/guestfish-actions.pod:2188
24265 " inspect-is-multipart root\n"
24270 #: ../fish/guestfish-actions.pod:2190
24272 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24273 "then this returns true if the disk is part of a set."
24277 #: ../fish/guestfish-actions.pod:2196
24278 msgid "inspect-is-netinst"
24282 #: ../fish/guestfish-actions.pod:2198
24285 " inspect-is-netinst root\n"
24290 #: ../fish/guestfish-actions.pod:2200
24292 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24293 "then this returns true if the disk is a network installer, ie. not a "
24294 "self-contained install CD but one which is likely to require network access "
24295 "to complete the install."
24299 #: ../fish/guestfish-actions.pod:2208
24300 msgid "inspect-list-applications"
24304 #: ../fish/guestfish-actions.pod:2210
24307 " inspect-list-applications root\n"
24312 #: ../fish/guestfish-actions.pod:2214
24314 "I<Note:> This call works differently from other parts of the inspection "
24315 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24316 "then mount up the disks, before calling this. Listing applications is a "
24317 "significantly more difficult operation which requires access to the full "
24318 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24319 "are just returning data cached in the libguestfs handle, this call actually "
24320 "reads parts of the mounted filesystems during the call."
24324 #: ../fish/guestfish-actions.pod:2304
24329 #: ../fish/guestfish-actions.pod:2306
24337 #: ../fish/guestfish-actions.pod:2321
24339 "You can pass the root string(s) returned to other L</inspect-get-*> "
24340 "functions in order to query further information about each operating system, "
24341 "such as the name and version."
24345 #: ../fish/guestfish-actions.pod:2326
24347 "This function uses other libguestfs features such as L</mount-ro> and "
24348 "L</umount-all> in order to mount and unmount filesystems and look at the "
24349 "contents. This should be called with no disks currently mounted. The "
24350 "function may also use Augeas, so any existing Augeas handle will be closed."
24354 #: ../fish/guestfish-actions.pod:2338 ../fish/guestfish-actions.pod:2536 ../fish/guestfish-actions.pod:2595
24355 msgid "See also L</list-filesystems>."
24359 #: ../fish/guestfish-actions.pod:2340
24360 msgid "is-blockdev"
24364 #: ../fish/guestfish-actions.pod:2342
24367 " is-blockdev path\n"
24372 #: ../fish/guestfish-actions.pod:2347 ../fish/guestfish-actions.pod:2365 ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2393 ../fish/guestfish-actions.pod:2403 ../fish/guestfish-actions.pod:2437 ../fish/guestfish-actions.pod:2446
24373 msgid "See also L</stat>."
24377 #: ../fish/guestfish-actions.pod:2349
24382 #: ../fish/guestfish-actions.pod:2351
24390 #: ../fish/guestfish-actions.pod:2358
24395 #: ../fish/guestfish-actions.pod:2360
24398 " is-chardev path\n"
24403 #: ../fish/guestfish-actions.pod:2367
24408 #: ../fish/guestfish-actions.pod:2369
24416 #: ../fish/guestfish-actions.pod:2376
24421 #: ../fish/guestfish-actions.pod:2378
24429 #: ../fish/guestfish-actions.pod:2386
24434 #: ../fish/guestfish-actions.pod:2388
24442 #: ../fish/guestfish-actions.pod:2395
24447 #: ../fish/guestfish-actions.pod:2397
24455 #: ../fish/guestfish-actions.pod:2405
24456 msgid "is-launching"
24460 #: ../fish/guestfish-actions.pod:2407
24468 #: ../fish/guestfish-actions.pod:2414
24473 #: ../fish/guestfish-actions.pod:2416
24481 #: ../fish/guestfish-actions.pod:2421
24486 #: ../fish/guestfish-actions.pod:2423
24494 #: ../fish/guestfish-actions.pod:2430
24499 #: ../fish/guestfish-actions.pod:2432
24502 " is-socket path\n"
24507 #: ../fish/guestfish-actions.pod:2439
24512 #: ../fish/guestfish-actions.pod:2441
24515 " is-symlink path\n"
24520 #: ../fish/guestfish-actions.pod:2448
24525 #: ../fish/guestfish-actions.pod:2450
24533 #: ../fish/guestfish-actions.pod:2455
24534 msgid "is-zero-device"
24538 #: ../fish/guestfish-actions.pod:2457
24541 " is-zero-device device\n"
24546 #: ../fish/guestfish-actions.pod:2463
24547 msgid "kill-subprocess"
24551 #: ../fish/guestfish-actions.pod:2465
24554 " kill-subprocess\n"
24559 #: ../fish/guestfish-actions.pod:2469
24564 #: ../fish/guestfish-actions.pod:2471
24569 #: ../fish/guestfish-actions.pod:2473
24577 #: ../fish/guestfish-actions.pod:2481
24582 #: ../fish/guestfish-actions.pod:2483
24585 " lchown owner group path\n"
24590 #: ../fish/guestfish-actions.pod:2485
24592 "Change the file owner to C<owner> and group to C<group>. This is like "
24593 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
24598 #: ../fish/guestfish-actions.pod:2493
24603 #: ../fish/guestfish-actions.pod:2495
24606 " lgetxattr path name\n"
24611 #: ../fish/guestfish-actions.pod:2511
24612 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24616 #: ../fish/guestfish-actions.pod:2513
24621 #: ../fish/guestfish-actions.pod:2515
24624 " lgetxattrs path\n"
24629 #: ../fish/guestfish-actions.pod:2517
24631 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24632 "it returns the extended attributes of the link itself."
24636 #: ../fish/guestfish-actions.pod:2521
24641 #: ../fish/guestfish-actions.pod:2523
24649 #: ../fish/guestfish-actions.pod:2528
24650 msgid "list-devices"
24654 #: ../fish/guestfish-actions.pod:2530
24662 #: ../fish/guestfish-actions.pod:2538
24663 msgid "list-dm-devices"
24667 #: ../fish/guestfish-actions.pod:2540
24670 " list-dm-devices\n"
24675 #: ../fish/guestfish-actions.pod:2544
24677 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
24678 "previous call to L</luks-open>."
24682 #: ../fish/guestfish-actions.pod:2547
24684 "Device mapper devices which correspond to logical volumes are I<not> "
24685 "returned in this list. Call L</lvs> if you want to list logical volumes."
24689 #: ../fish/guestfish-actions.pod:2551
24690 msgid "list-filesystems"
24694 #: ../fish/guestfish-actions.pod:2553
24697 " list-filesystems\n"
24702 #: ../fish/guestfish-actions.pod:2572
24704 "This command runs other libguestfs commands, which might include L</mount> "
24705 "and L</umount>, and therefore you should use this soon after launch and only "
24706 "when nothing is mounted."
24710 #: ../fish/guestfish-actions.pod:2576
24712 "Not all of the filesystems returned will be mountable. In particular, swap "
24713 "partitions are returned in the list. Also this command does not check that "
24714 "each filesystem found is valid and mountable, and some filesystems might be "
24715 "mountable but require special options. Filesystems may not all belong to a "
24716 "single logical operating system (use L</inspect-os> to look for OSes)."
24720 #: ../fish/guestfish-actions.pod:2584
24721 msgid "list-partitions"
24725 #: ../fish/guestfish-actions.pod:2586
24728 " list-partitions\n"
24733 #: ../fish/guestfish-actions.pod:2592
24735 "This does not return logical volumes. For that you will need to call "
24740 #: ../fish/guestfish-actions.pod:2597
24745 #: ../fish/guestfish-actions.pod:2599
24753 #: ../fish/guestfish-actions.pod:2607
24758 #: ../fish/guestfish-actions.pod:2609
24761 " ln target linkname\n"
24766 #: ../fish/guestfish-actions.pod:2613
24771 #: ../fish/guestfish-actions.pod:2615
24774 " ln-f target linkname\n"
24779 #: ../fish/guestfish-actions.pod:2620
24784 #: ../fish/guestfish-actions.pod:2622
24787 " ln-s target linkname\n"
24792 #: ../fish/guestfish-actions.pod:2626
24797 #: ../fish/guestfish-actions.pod:2628
24800 " ln-sf target linkname\n"
24805 #: ../fish/guestfish-actions.pod:2633
24806 msgid "lremovexattr"
24810 #: ../fish/guestfish-actions.pod:2635
24813 " lremovexattr xattr path\n"
24818 #: ../fish/guestfish-actions.pod:2637
24820 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24821 "it removes an extended attribute of the link itself."
24825 #: ../fish/guestfish-actions.pod:2641
24830 #: ../fish/guestfish-actions.pod:2643
24838 #: ../fish/guestfish-actions.pod:2649
24840 "This command is mostly useful for interactive sessions. Programs should "
24841 "probably use L</readdir> instead."
24845 #: ../fish/guestfish-actions.pod:2652
24850 #: ../fish/guestfish-actions.pod:2654
24853 " lsetxattr xattr val vallen path\n"
24858 #: ../fish/guestfish-actions.pod:2656
24860 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24861 "sets an extended attribute of the link itself."
24865 #: ../fish/guestfish-actions.pod:2660
24870 #: ../fish/guestfish-actions.pod:2662
24878 #: ../fish/guestfish-actions.pod:2666
24880 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24881 "the link is stat-ed, not the file it refers to."
24885 #: ../fish/guestfish-actions.pod:2672
24890 #: ../fish/guestfish-actions.pod:2674
24893 " lstatlist path 'names ...'\n"
24898 #: ../fish/guestfish-actions.pod:2676
24900 "This call allows you to perform the L</lstat> operation on multiple files, "
24901 "where all files are in the directory C<path>. C<names> is the list of files "
24902 "from this directory."
24906 #: ../fish/guestfish-actions.pod:2685
24908 "This call is intended for programs that want to efficiently list a directory "
24909 "contents without making many round-trips. See also L</lxattrlist> for a "
24910 "similarly efficient call for getting extended attributes. Very long "
24911 "directory listings might cause the protocol message size to be exceeded, "
24912 "causing this call to fail. The caller must split up such requests into "
24913 "smaller groups of names."
24917 #: ../fish/guestfish-actions.pod:2693
24918 msgid "luks-add-key"
24922 #: ../fish/guestfish-actions.pod:2695
24925 " luks-add-key device keyslot\n"
24930 #: ../fish/guestfish-actions.pod:2702
24932 "Note that if C<keyslot> already contains a key, then this command will "
24933 "fail. You have to use L</luks-kill-slot> first to remove that key."
24937 #: ../fish/guestfish-actions.pod:2706 ../fish/guestfish-actions.pod:2728 ../fish/guestfish-actions.pod:2741 ../fish/guestfish-actions.pod:2755 ../fish/guestfish-actions.pod:2781 ../fish/guestfish-actions.pod:2791
24939 "This command has one or more key or passphrase parameters. Guestfish will "
24940 "prompt for these separately."
24944 #: ../fish/guestfish-actions.pod:2709
24949 #: ../fish/guestfish-actions.pod:2711
24952 " luks-close device\n"
24957 #: ../fish/guestfish-actions.pod:2713
24959 "This closes a LUKS device that was created earlier by L</luks-open> or "
24960 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
24961 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
24962 "underlying block device."
24966 #: ../fish/guestfish-actions.pod:2719
24967 msgid "luks-format"
24971 #: ../fish/guestfish-actions.pod:2721
24974 " luks-format device keyslot\n"
24979 #: ../fish/guestfish-actions.pod:2734
24980 msgid "luks-format-cipher"
24984 #: ../fish/guestfish-actions.pod:2736
24987 " luks-format-cipher device keyslot cipher\n"
24992 #: ../fish/guestfish-actions.pod:2738
24994 "This command is the same as L</luks-format> but it also allows you to set "
24995 "the C<cipher> used."
24999 #: ../fish/guestfish-actions.pod:2747
25000 msgid "luks-kill-slot"
25004 #: ../fish/guestfish-actions.pod:2749
25007 " luks-kill-slot device keyslot\n"
25012 #: ../fish/guestfish-actions.pod:2758
25017 #: ../fish/guestfish-actions.pod:2760
25020 " luks-open device mapname\n"
25025 #: ../fish/guestfish-actions.pod:2774
25027 "If this block device contains LVM volume groups, then calling L</vgscan> "
25028 "followed by L</vg-activate-all> will make them visible."
25032 #: ../fish/guestfish-actions.pod:2778
25033 msgid "Use L</list-dm-devices> to list all device mapper devices."
25037 #: ../fish/guestfish-actions.pod:2784
25038 msgid "luks-open-ro"
25042 #: ../fish/guestfish-actions.pod:2786
25045 " luks-open-ro device mapname\n"
25050 #: ../fish/guestfish-actions.pod:2788
25052 "This is the same as L</luks-open> except that a read-only mapping is "
25057 #: ../fish/guestfish-actions.pod:2794
25062 #: ../fish/guestfish-actions.pod:2796
25065 " lvcreate logvol volgroup mbytes\n"
25070 #: ../fish/guestfish-actions.pod:2801
25071 msgid "lvm-canonical-lv-name"
25075 #: ../fish/guestfish-actions.pod:2803
25078 " lvm-canonical-lv-name lvname\n"
25083 #: ../fish/guestfish-actions.pod:2812
25084 msgid "See also L</is-lv>."
25088 #: ../fish/guestfish-actions.pod:2814
25089 msgid "lvm-clear-filter"
25093 #: ../fish/guestfish-actions.pod:2816
25096 " lvm-clear-filter\n"
25101 #: ../fish/guestfish-actions.pod:2818
25103 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
25108 #: ../fish/guestfish-actions.pod:2824
25109 msgid "lvm-remove-all"
25113 #: ../fish/guestfish-actions.pod:2826
25116 " lvm-remove-all\n"
25121 #: ../fish/guestfish-actions.pod:2834
25122 msgid "lvm-set-filter"
25126 #: ../fish/guestfish-actions.pod:2836
25129 " lvm-set-filter 'devices ...'\n"
25134 #: ../fish/guestfish-actions.pod:2861
25139 #: ../fish/guestfish-actions.pod:2863
25142 " lvremove device\n"
25147 #: ../fish/guestfish-actions.pod:2871
25152 #: ../fish/guestfish-actions.pod:2873
25155 " lvrename logvol newlogvol\n"
25160 #: ../fish/guestfish-actions.pod:2877
25165 #: ../fish/guestfish-actions.pod:2879
25168 " lvresize device mbytes\n"
25173 #: ../fish/guestfish-actions.pod:2885
25174 msgid "lvresize-free"
25178 #: ../fish/guestfish-actions.pod:2887
25181 " lvresize-free lv percent\n"
25186 #: ../fish/guestfish-actions.pod:2895
25191 #: ../fish/guestfish-actions.pod:2897
25199 #: ../fish/guestfish-actions.pod:2905
25200 msgid "See also L</lvs-full>, L</list-filesystems>."
25204 #: ../fish/guestfish-actions.pod:2907
25209 #: ../fish/guestfish-actions.pod:2909
25217 #: ../fish/guestfish-actions.pod:2914
25222 #: ../fish/guestfish-actions.pod:2916
25230 #: ../fish/guestfish-actions.pod:2920
25235 #: ../fish/guestfish-actions.pod:2922
25238 " lxattrlist path 'names ...'\n"
25243 #: ../fish/guestfish-actions.pod:2938
25245 "This call is intended for programs that want to efficiently list a directory "
25246 "contents without making many round-trips. See also L</lstatlist> for a "
25247 "similarly efficient call for getting standard stats. Very long directory "
25248 "listings might cause the protocol message size to be exceeded, causing this "
25249 "call to fail. The caller must split up such requests into smaller groups of "
25254 #: ../fish/guestfish-actions.pod:2946
25259 #: ../fish/guestfish-actions.pod:2948
25267 #: ../fish/guestfish-actions.pod:2952
25272 #: ../fish/guestfish-actions.pod:2954
25275 " mkdir-mode path mode\n"
25280 #: ../fish/guestfish-actions.pod:2963
25281 msgid "See also L</mkdir>, L</umask>"
25285 #: ../fish/guestfish-actions.pod:2965
25290 #: ../fish/guestfish-actions.pod:2967
25298 #: ../fish/guestfish-actions.pod:2972
25303 #: ../fish/guestfish-actions.pod:2974
25306 " mkdtemp template\n"
25311 #: ../fish/guestfish-actions.pod:2995
25316 #: ../fish/guestfish-actions.pod:2997
25319 " mke2fs-J fstype blocksize device journal\n"
25324 #: ../fish/guestfish-actions.pod:3005
25325 msgid "See also L</mke2journal>."
25329 #: ../fish/guestfish-actions.pod:3007
25334 #: ../fish/guestfish-actions.pod:3009
25337 " mke2fs-JL fstype blocksize device label\n"
25342 #: ../fish/guestfish-actions.pod:3014
25343 msgid "See also L</mke2journal-L>."
25347 #: ../fish/guestfish-actions.pod:3016
25352 #: ../fish/guestfish-actions.pod:3018
25355 " mke2fs-JU fstype blocksize device uuid\n"
25360 #: ../fish/guestfish-actions.pod:3023
25361 msgid "See also L</mke2journal-U>."
25365 #: ../fish/guestfish-actions.pod:3025
25366 msgid "mke2journal"
25370 #: ../fish/guestfish-actions.pod:3027
25373 " mke2journal blocksize device\n"
25378 #: ../fish/guestfish-actions.pod:3034
25379 msgid "mke2journal-L"
25383 #: ../fish/guestfish-actions.pod:3036
25386 " mke2journal-L blocksize label device\n"
25391 #: ../fish/guestfish-actions.pod:3040
25392 msgid "mke2journal-U"
25396 #: ../fish/guestfish-actions.pod:3042
25399 " mke2journal-U blocksize uuid device\n"
25404 #: ../fish/guestfish-actions.pod:3046
25409 #: ../fish/guestfish-actions.pod:3048
25412 " mkfifo mode path\n"
25417 #: ../fish/guestfish-actions.pod:3050
25419 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25420 "is just a convenient wrapper around L</mknod>."
25424 #: ../fish/guestfish-actions.pod:3056
25429 #: ../fish/guestfish-actions.pod:3058
25432 " mkfs fstype device\n"
25437 #: ../fish/guestfish-actions.pod:3064
25442 #: ../fish/guestfish-actions.pod:3066
25445 " mkfs-b fstype blocksize device\n"
25450 #: ../fish/guestfish-actions.pod:3068
25452 "This call is similar to L</mkfs>, but it allows you to control the block "
25453 "size of the resulting filesystem. Supported block sizes depend on the "
25454 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25458 #: ../fish/guestfish-actions.pod:3083
25463 #: ../fish/guestfish-actions.pod:3085
25466 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
25467 "[sectorsize:..]\n"
25472 #: ../fish/guestfish-actions.pod:3130
25473 msgid "mkmountpoint"
25477 #: ../fish/guestfish-actions.pod:3132
25480 " mkmountpoint exemptpath\n"
25485 #: ../fish/guestfish-actions.pod:3134
25487 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25488 "to create extra mountpoints before mounting the first filesystem."
25492 #: ../fish/guestfish-actions.pod:3158
25494 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25495 "unexpected errors if you try to mix these calls. It is safest to manually "
25496 "unmount filesystems and remove mountpoints after use."
25500 #: ../fish/guestfish-actions.pod:3162
25502 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25503 "for this to work for manual mountpoints, you must ensure that the innermost "
25504 "mountpoints have the longest pathnames, as in the example code above."
25508 #: ../fish/guestfish-actions.pod:3169
25510 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25511 "L</umount-all> to be called when the handle is closed which can also trigger "
25516 #: ../fish/guestfish-actions.pod:3173
25521 #: ../fish/guestfish-actions.pod:3175
25524 " mknod mode devmajor devminor path\n"
25529 #: ../fish/guestfish-actions.pod:3185
25531 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25532 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25533 "regular file). These constants are available in the standard Linux header "
25534 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25535 "wrappers around this command which bitwise OR in the appropriate constant "
25540 #: ../fish/guestfish-actions.pod:3195
25545 #: ../fish/guestfish-actions.pod:3197
25548 " mknod-b mode devmajor devminor path\n"
25553 #: ../fish/guestfish-actions.pod:3199
25555 "This call creates a block device node called C<path> with mode C<mode> and "
25556 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25557 "wrapper around L</mknod>."
25561 #: ../fish/guestfish-actions.pod:3205
25566 #: ../fish/guestfish-actions.pod:3207
25569 " mknod-c mode devmajor devminor path\n"
25574 #: ../fish/guestfish-actions.pod:3209
25576 "This call creates a char device node called C<path> with mode C<mode> and "
25577 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25578 "wrapper around L</mknod>."
25582 #: ../fish/guestfish-actions.pod:3215
25587 #: ../fish/guestfish-actions.pod:3217
25595 #: ../fish/guestfish-actions.pod:3221
25600 #: ../fish/guestfish-actions.pod:3223
25603 " mkswap-L label device\n"
25608 #: ../fish/guestfish-actions.pod:3231
25613 #: ../fish/guestfish-actions.pod:3233
25616 " mkswap-U uuid device\n"
25621 #: ../fish/guestfish-actions.pod:3237
25622 msgid "mkswap-file"
25626 #: ../fish/guestfish-actions.pod:3239
25629 " mkswap-file path\n"
25634 #: ../fish/guestfish-actions.pod:3243
25636 "This command just writes a swap file signature to an existing file. To "
25637 "create the file itself, use something like L</fallocate>."
25641 #: ../fish/guestfish-actions.pod:3246
25646 #: ../fish/guestfish-actions.pod:3248
25649 " modprobe modulename\n"
25654 #: ../fish/guestfish-actions.pod:3255
25659 #: ../fish/guestfish-actions.pod:3257
25662 " mount device mountpoint\n"
25667 #: ../fish/guestfish-actions.pod:3273
25669 "B<Important note:> When you use this call, the filesystem options C<sync> "
25670 "and C<noatime> are set implicitly. This was originally done because we "
25671 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25672 "very large negative performance impact and negligible effect on "
25673 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25674 "code that needs performance, and instead use L</mount-options> (use an empty "
25675 "string for the first parameter if you don't want any options)."
25679 #: ../fish/guestfish-actions.pod:3290
25684 #: ../fish/guestfish-actions.pod:3292
25687 " mount-9p mounttag mountpoint [options:..]\n"
25692 #: ../fish/guestfish-actions.pod:3303
25697 #: ../fish/guestfish-actions.pod:3305
25700 " mount-loop file mountpoint\n"
25705 #: ../fish/guestfish-actions.pod:3311
25706 msgid "mount-options"
25710 #: ../fish/guestfish-actions.pod:3313
25713 " mount-options options device mountpoint\n"
25718 #: ../fish/guestfish-actions.pod:3315
25720 "This is the same as the L</mount> command, but it allows you to set the "
25721 "mount options as for the L<mount(8)> I<-o> flag."
25725 #: ../fish/guestfish-actions.pod:3323
25730 #: ../fish/guestfish-actions.pod:3325
25733 " mount-ro device mountpoint\n"
25738 #: ../fish/guestfish-actions.pod:3327
25740 "This is the same as the L</mount> command, but it mounts the filesystem with "
25741 "the read-only (I<-o ro>) flag."
25745 #: ../fish/guestfish-actions.pod:3330
25750 #: ../fish/guestfish-actions.pod:3332
25753 " mount-vfs options vfstype device mountpoint\n"
25758 #: ../fish/guestfish-actions.pod:3334
25760 "This is the same as the L</mount> command, but it allows you to set both the "
25761 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25765 #: ../fish/guestfish-actions.pod:3338
25766 msgid "mountpoints"
25770 #: ../fish/guestfish-actions.pod:3340
25778 #: ../fish/guestfish-actions.pod:3342
25780 "This call is similar to L</mounts>. That call returns a list of devices. "
25781 "This one returns a hash table (map) of device name to directory where the "
25782 "device is mounted."
25786 #: ../fish/guestfish-actions.pod:3346
25791 #: ../fish/guestfish-actions.pod:3348
25799 #: ../fish/guestfish-actions.pod:3355
25800 msgid "See also: L</mountpoints>"
25804 #: ../fish/guestfish-actions.pod:3357
25809 #: ../fish/guestfish-actions.pod:3359
25817 #: ../fish/guestfish-actions.pod:3364
25818 msgid "ntfs-3g-probe"
25822 #: ../fish/guestfish-actions.pod:3366
25825 " ntfs-3g-probe true|false device\n"
25830 #: ../fish/guestfish-actions.pod:3380
25835 #: ../fish/guestfish-actions.pod:3382
25838 " ntfsresize device\n"
25843 #: ../fish/guestfish-actions.pod:3404
25844 msgid "ntfsresize-opts"
25848 #: ../fish/guestfish-actions.pod:3406
25851 " ntfsresize-opts device [size:..] [force:..]\n"
25856 #: ../fish/guestfish-actions.pod:3425
25858 "After the resize operation, the filesystem is always marked as requiring a "
25859 "consistency check (for safety). You have to boot into Windows to perform "
25860 "this check and clear this condition. If you I<don't> set the C<force> "
25861 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
25862 "a single filesystem without booting into Windows between each resize."
25866 #: ../fish/guestfish-actions.pod:3438
25867 msgid "ntfsresize-size"
25871 #: ../fish/guestfish-actions.pod:3440
25874 " ntfsresize-size device size\n"
25879 #: ../fish/guestfish-actions.pod:3442
25881 "This command is the same as L</ntfsresize> except that it allows you to "
25882 "specify the new size (in bytes) explicitly."
25886 #: ../fish/guestfish-actions.pod:3452
25891 #: ../fish/guestfish-actions.pod:3454
25894 " part-add device prlogex startsect endsect\n"
25899 #: ../fish/guestfish-actions.pod:3456
25901 "This command adds a partition to C<device>. If there is no partition table "
25902 "on the device, call L</part-init> first."
25906 #: ../fish/guestfish-actions.pod:3468
25908 "Creating a partition which covers the whole disk is not so easy. Use "
25909 "L</part-disk> to do that."
25913 #: ../fish/guestfish-actions.pod:3471
25918 #: ../fish/guestfish-actions.pod:3473
25921 " part-del device partnum\n"
25926 #: ../fish/guestfish-actions.pod:3481
25931 #: ../fish/guestfish-actions.pod:3483
25934 " part-disk device parttype\n"
25939 #: ../fish/guestfish-actions.pod:3485
25941 "This command is simply a combination of L</part-init> followed by "
25942 "L</part-add> to create a single primary partition covering the whole disk."
25946 #: ../fish/guestfish-actions.pod:3489
25948 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25949 "possible values are described in L</part-init>."
25953 #: ../fish/guestfish-actions.pod:3495
25954 msgid "part-get-bootable"
25958 #: ../fish/guestfish-actions.pod:3497
25961 " part-get-bootable device partnum\n"
25966 #: ../fish/guestfish-actions.pod:3502
25967 msgid "See also L</part-set-bootable>."
25971 #: ../fish/guestfish-actions.pod:3504
25972 msgid "part-get-mbr-id"
25976 #: ../fish/guestfish-actions.pod:3506
25979 " part-get-mbr-id device partnum\n"
25984 #: ../fish/guestfish-actions.pod:3511 ../fish/guestfish-actions.pod:3649
25986 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25987 "undefined results for other partition table types (see "
25988 "L</part-get-parttype>)."
25992 #: ../fish/guestfish-actions.pod:3515
25993 msgid "part-get-parttype"
25997 #: ../fish/guestfish-actions.pod:3517
26000 " part-get-parttype device\n"
26005 #: ../fish/guestfish-actions.pod:3522
26007 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26008 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26009 "possible, although unusual. See L</part-init> for a full list."
26013 #: ../fish/guestfish-actions.pod:3527
26018 #: ../fish/guestfish-actions.pod:3529
26021 " part-init device parttype\n"
26026 #: ../fish/guestfish-actions.pod:3535
26028 "Initially there are no partitions. Following this, you should call "
26029 "L</part-add> for each partition required."
26033 #: ../fish/guestfish-actions.pod:3598
26038 #: ../fish/guestfish-actions.pod:3600
26041 " part-list device\n"
26046 #: ../fish/guestfish-actions.pod:3615
26048 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26049 "the device's sector size, see L</blockdev-getss>."
26053 #: ../fish/guestfish-actions.pod:3628
26054 msgid "part-set-bootable"
26058 #: ../fish/guestfish-actions.pod:3630
26061 " part-set-bootable device partnum true|false\n"
26066 #: ../fish/guestfish-actions.pod:3639
26067 msgid "part-set-mbr-id"
26071 #: ../fish/guestfish-actions.pod:3641
26074 " part-set-mbr-id device partnum idbyte\n"
26079 #: ../fish/guestfish-actions.pod:3653
26080 msgid "part-set-name"
26084 #: ../fish/guestfish-actions.pod:3655
26087 " part-set-name device partnum name\n"
26092 #: ../fish/guestfish-actions.pod:3663
26093 msgid "part-to-dev"
26097 #: ../fish/guestfish-actions.pod:3665
26100 " part-to-dev partition\n"
26105 #: ../fish/guestfish-actions.pod:3671
26107 "The named partition must exist, for example as a string returned from "
26108 "L</list-partitions>."
26112 #: ../fish/guestfish-actions.pod:3674
26113 msgid "ping-daemon"
26117 #: ../fish/guestfish-actions.pod:3676
26125 #: ../fish/guestfish-actions.pod:3683
26130 #: ../fish/guestfish-actions.pod:3685
26133 " pread path count offset\n"
26138 #: ../fish/guestfish-actions.pod:3693
26139 msgid "See also L</pwrite>, L</pread-device>."
26143 #: ../fish/guestfish-actions.pod:3698
26144 msgid "pread-device"
26148 #: ../fish/guestfish-actions.pod:3700
26151 " pread-device device count offset\n"
26156 #: ../fish/guestfish-actions.pod:3708
26157 msgid "See also L</pread>."
26161 #: ../fish/guestfish-actions.pod:3713
26166 #: ../fish/guestfish-actions.pod:3715
26169 " pvcreate device\n"
26174 #: ../fish/guestfish-actions.pod:3721
26179 #: ../fish/guestfish-actions.pod:3723
26182 " pvremove device\n"
26187 #: ../fish/guestfish-actions.pod:3732
26192 #: ../fish/guestfish-actions.pod:3734
26195 " pvresize device\n"
26200 #: ../fish/guestfish-actions.pod:3739
26201 msgid "pvresize-size"
26205 #: ../fish/guestfish-actions.pod:3741
26208 " pvresize-size device size\n"
26213 #: ../fish/guestfish-actions.pod:3743
26215 "This command is the same as L</pvresize> except that it allows you to "
26216 "specify the new size (in bytes) explicitly."
26220 #: ../fish/guestfish-actions.pod:3746
26225 #: ../fish/guestfish-actions.pod:3748
26233 #: ../fish/guestfish-actions.pod:3756
26234 msgid "See also L</pvs-full>."
26238 #: ../fish/guestfish-actions.pod:3758
26243 #: ../fish/guestfish-actions.pod:3760
26251 #: ../fish/guestfish-actions.pod:3765
26256 #: ../fish/guestfish-actions.pod:3767
26264 #: ../fish/guestfish-actions.pod:3771
26269 #: ../fish/guestfish-actions.pod:3773
26272 " pwrite path content offset\n"
26277 #: ../fish/guestfish-actions.pod:3784
26278 msgid "See also L</pread>, L</pwrite-device>."
26282 #: ../fish/guestfish-actions.pod:3789
26283 msgid "pwrite-device"
26287 #: ../fish/guestfish-actions.pod:3791
26290 " pwrite-device device content offset\n"
26295 #: ../fish/guestfish-actions.pod:3801
26296 msgid "See also L</pwrite>."
26300 #: ../fish/guestfish-actions.pod:3806
26305 #: ../fish/guestfish-actions.pod:3808
26308 " read-file path\n"
26313 #: ../fish/guestfish-actions.pod:3813
26315 "Unlike L</cat>, this function can correctly handle files that contain "
26316 "embedded ASCII NUL characters. However unlike L</download>, this function "
26317 "is limited in the total size of file that can be handled."
26321 #: ../fish/guestfish-actions.pod:3821
26326 #: ../fish/guestfish-actions.pod:3823
26329 " read-lines path\n"
26334 #: ../fish/guestfish-actions.pod:3830
26336 "Note that this function cannot correctly handle binary files (specifically, "
26337 "files containing C<\\0> character which is treated as end of line). For "
26338 "those you need to use the L</read-file> function which has a more complex "
26343 #: ../fish/guestfish-actions.pod:3835
26348 #: ../fish/guestfish-actions.pod:3837
26356 #: ../fish/guestfish-actions.pod:3889
26358 "This function is primarily intended for use by programs. To get a simple "
26359 "list of names, use L</ls>. To get a printable directory for human "
26360 "consumption, use L</ll>."
26364 #: ../fish/guestfish-actions.pod:3893
26369 #: ../fish/guestfish-actions.pod:3895
26377 #: ../fish/guestfish-actions.pod:3899
26378 msgid "readlinklist"
26382 #: ../fish/guestfish-actions.pod:3901
26385 " readlinklist path 'names ...'\n"
26390 #: ../fish/guestfish-actions.pod:3925
26395 #: ../fish/guestfish-actions.pod:3927
26403 #: ../fish/guestfish-actions.pod:3932
26404 msgid "removexattr"
26408 #: ../fish/guestfish-actions.pod:3934
26411 " removexattr xattr path\n"
26416 #: ../fish/guestfish-actions.pod:3939
26417 msgid "See also: L</lremovexattr>, L<attr(5)>."
26421 #: ../fish/guestfish-actions.pod:3941
26426 #: ../fish/guestfish-actions.pod:3943
26429 " resize2fs device\n"
26434 #: ../fish/guestfish-actions.pod:3948
26436 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26437 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26438 "gives an error about this and sometimes not. In any case, it is always safe "
26439 "to call L</e2fsck-f> before calling this function."
26443 #: ../fish/guestfish-actions.pod:3954
26444 msgid "resize2fs-M"
26448 #: ../fish/guestfish-actions.pod:3956
26451 " resize2fs-M device\n"
26456 #: ../fish/guestfish-actions.pod:3958
26458 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26459 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26464 #: ../fish/guestfish-actions.pod:3962
26466 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26467 "and read the C<Block size> and C<Block count> values. These two numbers, "
26468 "multiplied together, give the resulting size of the minimal filesystem in "
26473 #: ../fish/guestfish-actions.pod:3967
26474 msgid "resize2fs-size"
26478 #: ../fish/guestfish-actions.pod:3969
26481 " resize2fs-size device size\n"
26486 #: ../fish/guestfish-actions.pod:3971
26488 "This command is the same as L</resize2fs> except that it allows you to "
26489 "specify the new size (in bytes) explicitly."
26493 #: ../fish/guestfish-actions.pod:3974
26498 #: ../fish/guestfish-actions.pod:3976
26506 #: ../fish/guestfish-actions.pod:3980
26511 #: ../fish/guestfish-actions.pod:3982
26519 #: ../fish/guestfish-actions.pod:3988
26524 #: ../fish/guestfish-actions.pod:3990
26532 #: ../fish/guestfish-actions.pod:3994
26533 msgid "rmmountpoint"
26537 #: ../fish/guestfish-actions.pod:3996
26540 " rmmountpoint exemptpath\n"
26545 #: ../fish/guestfish-actions.pod:3998
26547 "This calls removes a mountpoint that was previously created with "
26548 "L</mkmountpoint>. See L</mkmountpoint> for full details."
26552 #: ../fish/guestfish-actions.pod:4002
26553 msgid "scrub-device"
26557 #: ../fish/guestfish-actions.pod:4004
26560 " scrub-device device\n"
26565 #: ../fish/guestfish-actions.pod:4015
26570 #: ../fish/guestfish-actions.pod:4017
26573 " scrub-file file\n"
26578 #: ../fish/guestfish-actions.pod:4027
26579 msgid "scrub-freespace"
26583 #: ../fish/guestfish-actions.pod:4029
26586 " scrub-freespace dir\n"
26591 #: ../fish/guestfish-actions.pod:4031
26593 "This command creates the directory C<dir> and then fills it with files until "
26594 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26595 "deletes them. The intention is to scrub any free space on the partition "
26596 "containing C<dir>."
26600 #: ../fish/guestfish-actions.pod:4040
26605 #: ../fish/guestfish-actions.pod:4042
26610 #: ../fish/guestfish-actions.pod:4044
26613 " set-append append\n"
26618 #: ../fish/guestfish-actions.pod:4055
26619 msgid "set-attach-method"
26623 #: ../fish/guestfish-actions.pod:4057
26624 msgid "attach-method"
26628 #: ../fish/guestfish-actions.pod:4059
26631 " set-attach-method attachmethod\n"
26636 #: ../fish/guestfish-actions.pod:4081
26637 msgid "set-autosync"
26641 #: ../fish/guestfish-actions.pod:4083
26646 #: ../fish/guestfish-actions.pod:4085
26649 " set-autosync true|false\n"
26654 #: ../fish/guestfish-actions.pod:4095
26659 #: ../fish/guestfish-actions.pod:4097
26664 #: ../fish/guestfish-actions.pod:4099
26667 " set-direct true|false\n"
26672 #: ../fish/guestfish-actions.pod:4105
26674 "One consequence of this is that log messages aren't caught by the library "
26675 "and handled by L</set-log-message-callback>, but go straight to stdout."
26679 #: ../fish/guestfish-actions.pod:4114
26680 msgid "set-e2label"
26684 #: ../fish/guestfish-actions.pod:4116
26687 " set-e2label device label\n"
26692 #: ../fish/guestfish-actions.pod:4122
26694 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26695 "label on a filesystem."
26699 #: ../fish/guestfish-actions.pod:4125
26704 #: ../fish/guestfish-actions.pod:4127
26707 " set-e2uuid device uuid\n"
26712 #: ../fish/guestfish-actions.pod:4134
26714 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26715 "UUID of a filesystem."
26719 #: ../fish/guestfish-actions.pod:4137
26720 msgid "set-memsize"
26724 #: ../fish/guestfish-actions.pod:4139
26729 #: ../fish/guestfish-actions.pod:4141
26732 " set-memsize memsize\n"
26737 #: ../fish/guestfish-actions.pod:4143
26739 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26740 "This only has any effect if called before L</launch>."
26744 #: ../fish/guestfish-actions.pod:4154
26745 msgid "set-network"
26749 #: ../fish/guestfish-actions.pod:4156
26754 #: ../fish/guestfish-actions.pod:4158
26757 " set-network true|false\n"
26762 #: ../fish/guestfish-actions.pod:4166
26763 msgid "You must call this before calling L</launch>, otherwise it has no effect."
26767 #: ../fish/guestfish-actions.pod:4169
26772 #: ../fish/guestfish-actions.pod:4171
26777 #: ../fish/guestfish-actions.pod:4173
26780 " set-path searchpath\n"
26785 #: ../fish/guestfish-actions.pod:4182
26790 #: ../fish/guestfish-actions.pod:4184
26795 #: ../fish/guestfish-actions.pod:4186
26803 #: ../fish/guestfish-actions.pod:4206
26804 msgid "set-recovery-proc"
26808 #: ../fish/guestfish-actions.pod:4208
26809 msgid "recovery-proc"
26813 #: ../fish/guestfish-actions.pod:4210
26816 " set-recovery-proc true|false\n"
26821 #: ../fish/guestfish-actions.pod:4212
26823 "If this is called with the parameter C<false> then L</launch> does not "
26824 "create a recovery process. The purpose of the recovery process is to stop "
26825 "runaway qemu processes in the case where the main program aborts abruptly."
26829 #: ../fish/guestfish-actions.pod:4217
26831 "This only has any effect if called before L</launch>, and the default is "
26836 #: ../fish/guestfish-actions.pod:4226
26837 msgid "set-selinux"
26841 #: ../fish/guestfish-actions.pod:4228
26846 #: ../fish/guestfish-actions.pod:4230
26849 " set-selinux true|false\n"
26854 #: ../fish/guestfish-actions.pod:4241
26859 #: ../fish/guestfish-actions.pod:4243
26864 #: ../fish/guestfish-actions.pod:4245
26867 " set-trace true|false\n"
26872 #: ../fish/guestfish-actions.pod:4257
26874 "Trace messages are normally sent to C<stderr>, unless you register a "
26875 "callback to send them somewhere else (see L</set-event-callback>)."
26879 #: ../fish/guestfish-actions.pod:4261
26880 msgid "set-verbose"
26884 #: ../fish/guestfish-actions.pod:4263
26889 #: ../fish/guestfish-actions.pod:4265
26892 " set-verbose true|false\n"
26897 #: ../fish/guestfish-actions.pod:4272
26899 "Verbose messages are normally sent to C<stderr>, unless you register a "
26900 "callback to send them somewhere else (see L</set-event-callback>)."
26904 #: ../fish/guestfish-actions.pod:4276
26909 #: ../fish/guestfish-actions.pod:4278
26912 " setcon context\n"
26917 #: ../fish/guestfish-actions.pod:4285
26922 #: ../fish/guestfish-actions.pod:4287
26925 " setxattr xattr val vallen path\n"
26930 #: ../fish/guestfish-actions.pod:4293
26931 msgid "See also: L</lsetxattr>, L<attr(5)>."
26935 #: ../fish/guestfish-actions.pod:4295
26940 #: ../fish/guestfish-actions.pod:4297
26943 " sfdisk device cyls heads sectors 'lines ...'\n"
26948 #: ../fish/guestfish-actions.pod:4319
26949 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26953 #: ../fish/guestfish-actions.pod:4332
26958 #: ../fish/guestfish-actions.pod:4334
26961 " sfdiskM device 'lines ...'\n"
26966 #: ../fish/guestfish-actions.pod:4336
26968 "This is a simplified interface to the L</sfdisk> command, where partition "
26969 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26970 "you don't need to specify the cyls, heads and sectors parameters which were "
26971 "rarely if ever used anyway."
26975 #: ../fish/guestfish-actions.pod:4342
26976 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26980 #: ../fish/guestfish-actions.pod:4355
26985 #: ../fish/guestfish-actions.pod:4357
26988 " sfdisk-N device partnum cyls heads sectors line\n"
26993 #: ../fish/guestfish-actions.pod:4362
26995 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26996 "cyls/heads/sectors parameters."
27000 #: ../fish/guestfish-actions.pod:4365
27001 msgid "See also: L</part-add>"
27005 #: ../fish/guestfish-actions.pod:4377
27006 msgid "sfdisk-disk-geometry"
27010 #: ../fish/guestfish-actions.pod:4379
27013 " sfdisk-disk-geometry device\n"
27018 #: ../fish/guestfish-actions.pod:4381
27020 "This displays the disk geometry of C<device> read from the partition table. "
27021 "Especially in the case where the underlying block device has been resized, "
27022 "this can be different from the kernel's idea of the geometry (see "
27023 "L</sfdisk-kernel-geometry>)."
27027 #: ../fish/guestfish-actions.pod:4389
27028 msgid "sfdisk-kernel-geometry"
27032 #: ../fish/guestfish-actions.pod:4391
27035 " sfdisk-kernel-geometry device\n"
27040 #: ../fish/guestfish-actions.pod:4398
27045 #: ../fish/guestfish-actions.pod:4400
27048 " sfdisk-l device\n"
27053 #: ../fish/guestfish-actions.pod:4406
27054 msgid "See also: L</part-list>"
27058 #: ../fish/guestfish-actions.pod:4415
27063 #: ../fish/guestfish-actions.pod:4417
27071 #: ../fish/guestfish-actions.pod:4422
27072 msgid "This is like L</command>, but passes the command to:"
27076 #: ../fish/guestfish-actions.pod:4430
27077 msgid "All the provisos about L</command> apply to this call."
27081 #: ../fish/guestfish-actions.pod:4432
27086 #: ../fish/guestfish-actions.pod:4434
27089 " sh-lines command\n"
27094 #: ../fish/guestfish-actions.pod:4436
27095 msgid "This is the same as L</sh>, but splits the result into a list of lines."
27099 #: ../fish/guestfish-actions.pod:4439
27100 msgid "See also: L</command-lines>"
27104 #: ../fish/guestfish-actions.pod:4441
27109 #: ../fish/guestfish-actions.pod:4443
27117 #: ../fish/guestfish-actions.pod:4447
27122 #: ../fish/guestfish-actions.pod:4449
27130 #: ../fish/guestfish-actions.pod:4455
27135 #: ../fish/guestfish-actions.pod:4457
27143 #: ../fish/guestfish-actions.pod:4465
27148 #: ../fish/guestfish-actions.pod:4467
27156 #: ../fish/guestfish-actions.pod:4475
27161 #: ../fish/guestfish-actions.pod:4477
27164 " strings-e encoding path\n"
27169 #: ../fish/guestfish-actions.pod:4479
27171 "This is like the L</strings> command, but allows you to specify the encoding "
27172 "of strings that are looked for in the source file C<path>."
27176 #: ../fish/guestfish-actions.pod:4489
27178 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
27179 "ISO-8859-X (this is what L</strings> uses)."
27183 #: ../fish/guestfish-actions.pod:4521
27184 msgid "swapoff-device"
27188 #: ../fish/guestfish-actions.pod:4523
27191 " swapoff-device device\n"
27196 #: ../fish/guestfish-actions.pod:4525
27198 "This command disables the libguestfs appliance swap device or partition "
27199 "named C<device>. See L</swapon-device>."
27203 #: ../fish/guestfish-actions.pod:4529
27204 msgid "swapoff-file"
27208 #: ../fish/guestfish-actions.pod:4531
27211 " swapoff-file file\n"
27216 #: ../fish/guestfish-actions.pod:4535
27217 msgid "swapoff-label"
27221 #: ../fish/guestfish-actions.pod:4537
27224 " swapoff-label label\n"
27229 #: ../fish/guestfish-actions.pod:4542
27230 msgid "swapoff-uuid"
27234 #: ../fish/guestfish-actions.pod:4544
27237 " swapoff-uuid uuid\n"
27242 #: ../fish/guestfish-actions.pod:4549
27243 msgid "swapon-device"
27247 #: ../fish/guestfish-actions.pod:4551
27250 " swapon-device device\n"
27255 #: ../fish/guestfish-actions.pod:4553
27257 "This command enables the libguestfs appliance to use the swap device or "
27258 "partition named C<device>. The increased memory is made available for all "
27259 "commands, for example those run using L</command> or L</sh>."
27263 #: ../fish/guestfish-actions.pod:4565
27264 msgid "swapon-file"
27268 #: ../fish/guestfish-actions.pod:4567
27271 " swapon-file file\n"
27276 #: ../fish/guestfish-actions.pod:4569
27277 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
27281 #: ../fish/guestfish-actions.pod:4572
27282 msgid "swapon-label"
27286 #: ../fish/guestfish-actions.pod:4574
27289 " swapon-label label\n"
27294 #: ../fish/guestfish-actions.pod:4576
27296 "This command enables swap to a labeled swap partition. See "
27297 "L</swapon-device> for other notes."
27301 #: ../fish/guestfish-actions.pod:4579
27302 msgid "swapon-uuid"
27306 #: ../fish/guestfish-actions.pod:4581
27309 " swapon-uuid uuid\n"
27314 #: ../fish/guestfish-actions.pod:4583
27316 "This command enables swap to a swap partition with the given UUID. See "
27317 "L</swapon-device> for other notes."
27321 #: ../fish/guestfish-actions.pod:4586
27326 #: ../fish/guestfish-actions.pod:4588
27334 #: ../fish/guestfish-actions.pod:4596
27339 #: ../fish/guestfish-actions.pod:4598
27347 #: ../fish/guestfish-actions.pod:4606
27352 #: ../fish/guestfish-actions.pod:4608
27355 " tail-n nrlines path\n"
27360 #: ../fish/guestfish-actions.pod:4621
27365 #: ../fish/guestfish-actions.pod:4623
27368 " tar-in (tarfile|-) directory\n"
27373 #: ../fish/guestfish-actions.pod:4628
27374 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27378 #: ../fish/guestfish-actions.pod:4633
27383 #: ../fish/guestfish-actions.pod:4635
27386 " tar-out directory (tarfile|-)\n"
27391 #: ../fish/guestfish-actions.pod:4640
27392 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27396 #: ../fish/guestfish-actions.pod:4645
27401 #: ../fish/guestfish-actions.pod:4647
27404 " tgz-in (tarball|-) directory\n"
27409 #: ../fish/guestfish-actions.pod:4652
27410 msgid "To upload an uncompressed tarball, use L</tar-in>."
27414 #: ../fish/guestfish-actions.pod:4656
27419 #: ../fish/guestfish-actions.pod:4658
27422 " tgz-out directory (tarball|-)\n"
27427 #: ../fish/guestfish-actions.pod:4663
27428 msgid "To download an uncompressed tarball, use L</tar-out>."
27432 #: ../fish/guestfish-actions.pod:4667
27437 #: ../fish/guestfish-actions.pod:4669
27445 #: ../fish/guestfish-actions.pod:4678
27450 #: ../fish/guestfish-actions.pod:4680
27458 #: ../fish/guestfish-actions.pod:4685
27459 msgid "truncate-size"
27463 #: ../fish/guestfish-actions.pod:4687
27466 " truncate-size path size\n"
27471 #: ../fish/guestfish-actions.pod:4692
27473 "If the current file size is less than C<size> then the file is extended to "
27474 "the required size with zero bytes. This creates a sparse file (ie. disk "
27475 "blocks are not allocated for the file until you write to it). To create a "
27476 "non-sparse file of zeroes, use L</fallocate64> instead."
27480 #: ../fish/guestfish-actions.pod:4698
27485 #: ../fish/guestfish-actions.pod:4700
27488 " tune2fs-l device\n"
27493 #: ../fish/guestfish-actions.pod:4710
27498 #: ../fish/guestfish-actions.pod:4712
27501 " txz-in (tarball|-) directory\n"
27506 #: ../fish/guestfish-actions.pod:4719
27511 #: ../fish/guestfish-actions.pod:4721
27514 " txz-out directory (tarball|-)\n"
27519 #: ../fish/guestfish-actions.pod:4728
27524 #: ../fish/guestfish-actions.pod:4730
27532 #: ../fish/guestfish-actions.pod:4744
27533 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27537 #: ../fish/guestfish-actions.pod:4749
27542 #: ../fish/guestfish-actions.pod:4751
27547 #: ../fish/guestfish-actions.pod:4753
27550 " umount pathordevice\n"
27555 #: ../fish/guestfish-actions.pod:4759
27560 #: ../fish/guestfish-actions.pod:4761
27561 msgid "unmount-all"
27565 #: ../fish/guestfish-actions.pod:4763
27573 #: ../fish/guestfish-actions.pod:4769
27578 #: ../fish/guestfish-actions.pod:4771
27581 " upload (filename|-) remotefilename\n"
27586 #: ../fish/guestfish-actions.pod:4778
27587 msgid "See also L</download>."
27591 #: ../fish/guestfish-actions.pod:4782
27592 msgid "upload-offset"
27596 #: ../fish/guestfish-actions.pod:4784
27599 " upload-offset (filename|-) remotefilename offset\n"
27604 #: ../fish/guestfish-actions.pod:4796
27606 "Note that there is no limit on the amount of data that can be uploaded with "
27607 "this call, unlike with L</pwrite>, and this call always writes the full "
27608 "amount unless an error occurs."
27612 #: ../fish/guestfish-actions.pod:4801
27613 msgid "See also L</upload>, L</pwrite>."
27617 #: ../fish/guestfish-actions.pod:4805
27622 #: ../fish/guestfish-actions.pod:4807
27625 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27630 #: ../fish/guestfish-actions.pod:4826
27635 #: ../fish/guestfish-actions.pod:4828
27643 #: ../fish/guestfish-actions.pod:4855
27645 "I<Note:> Don't use this call to test for availability of features. In "
27646 "enterprise distributions we backport features from later versions into "
27647 "earlier versions, making this an unreliable way to test for features. Use "
27648 "L</available> instead."
27652 #: ../fish/guestfish-actions.pod:4861
27657 #: ../fish/guestfish-actions.pod:4863
27660 " vfs-label device\n"
27665 #: ../fish/guestfish-actions.pod:4870
27666 msgid "To find a filesystem from the label, use L</findfs-label>."
27670 #: ../fish/guestfish-actions.pod:4872
27675 #: ../fish/guestfish-actions.pod:4874
27678 " vfs-type device\n"
27683 #: ../fish/guestfish-actions.pod:4884
27688 #: ../fish/guestfish-actions.pod:4886
27691 " vfs-uuid device\n"
27696 #: ../fish/guestfish-actions.pod:4893
27697 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27701 #: ../fish/guestfish-actions.pod:4895
27702 msgid "vg-activate"
27706 #: ../fish/guestfish-actions.pod:4897
27709 " vg-activate true|false 'volgroups ...'\n"
27714 #: ../fish/guestfish-actions.pod:4907
27715 msgid "vg-activate-all"
27719 #: ../fish/guestfish-actions.pod:4909
27722 " vg-activate-all true|false\n"
27727 #: ../fish/guestfish-actions.pod:4916
27732 #: ../fish/guestfish-actions.pod:4918
27735 " vgcreate volgroup 'physvols ...'\n"
27740 #: ../fish/guestfish-actions.pod:4923
27745 #: ../fish/guestfish-actions.pod:4925
27748 " vglvuuids vgname\n"
27753 #: ../fish/guestfish-actions.pod:4930
27755 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27756 "logical volumes and volume groups."
27760 #: ../fish/guestfish-actions.pod:4933
27761 msgid "See also L</vgpvuuids>."
27765 #: ../fish/guestfish-actions.pod:4935
27770 #: ../fish/guestfish-actions.pod:4937
27773 " vgpvuuids vgname\n"
27778 #: ../fish/guestfish-actions.pod:4942
27780 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27781 "physical volumes and volume groups."
27785 #: ../fish/guestfish-actions.pod:4945
27786 msgid "See also L</vglvuuids>."
27790 #: ../fish/guestfish-actions.pod:4947
27795 #: ../fish/guestfish-actions.pod:4949
27798 " vgremove vgname\n"
27803 #: ../fish/guestfish-actions.pod:4956
27808 #: ../fish/guestfish-actions.pod:4958
27811 " vgrename volgroup newvolgroup\n"
27816 #: ../fish/guestfish-actions.pod:4962
27821 #: ../fish/guestfish-actions.pod:4964
27829 #: ../fish/guestfish-actions.pod:4972
27830 msgid "See also L</vgs-full>."
27834 #: ../fish/guestfish-actions.pod:4974
27839 #: ../fish/guestfish-actions.pod:4976
27847 #: ../fish/guestfish-actions.pod:4981
27852 #: ../fish/guestfish-actions.pod:4983
27860 #: ../fish/guestfish-actions.pod:4988
27865 #: ../fish/guestfish-actions.pod:4990
27873 #: ../fish/guestfish-actions.pod:4994
27878 #: ../fish/guestfish-actions.pod:4996
27886 #: ../fish/guestfish-actions.pod:5001
27891 #: ../fish/guestfish-actions.pod:5003
27899 #: ../fish/guestfish-actions.pod:5008
27904 #: ../fish/guestfish-actions.pod:5010
27912 #: ../fish/guestfish-actions.pod:5015
27917 #: ../fish/guestfish-actions.pod:5017
27920 " write path content\n"
27925 #: ../fish/guestfish-actions.pod:5025
27930 #: ../fish/guestfish-actions.pod:5027
27933 " write-file path content size\n"
27938 #: ../fish/guestfish-actions.pod:5050
27943 #: ../fish/guestfish-actions.pod:5052
27946 " zegrep regex path\n"
27951 #: ../fish/guestfish-actions.pod:5060
27956 #: ../fish/guestfish-actions.pod:5062
27959 " zegrepi regex path\n"
27964 #: ../fish/guestfish-actions.pod:5070
27969 #: ../fish/guestfish-actions.pod:5072
27977 #: ../fish/guestfish-actions.pod:5080
27978 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
27982 #: ../fish/guestfish-actions.pod:5083
27983 msgid "zero-device"
27987 #: ../fish/guestfish-actions.pod:5085
27990 " zero-device device\n"
27995 #: ../fish/guestfish-actions.pod:5087
27997 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27998 "which just zeroes the first few blocks of a device."
28002 #: ../fish/guestfish-actions.pod:5094
28007 #: ../fish/guestfish-actions.pod:5096
28010 " zerofree device\n"
28015 #: ../fish/guestfish-actions.pod:5109
28020 #: ../fish/guestfish-actions.pod:5111
28023 " zfgrep pattern path\n"
28028 #: ../fish/guestfish-actions.pod:5119
28033 #: ../fish/guestfish-actions.pod:5121
28036 " zfgrepi pattern path\n"
28041 #: ../fish/guestfish-actions.pod:5129
28046 #: ../fish/guestfish-actions.pod:5131
28049 " zfile meth path\n"
28054 #: ../fish/guestfish-actions.pod:5138
28055 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
28059 #: ../fish/guestfish-actions.pod:5148
28064 #: ../fish/guestfish-actions.pod:5150
28067 " zgrep regex path\n"
28072 #: ../fish/guestfish-actions.pod:5158
28077 #: ../fish/guestfish-actions.pod:5160
28080 " zgrepi regex path\n"
28085 #: ../fish/guestfish-commands.pod:1
28090 #: ../fish/guestfish-commands.pod:3
28095 #: ../fish/guestfish-commands.pod:5
28098 " alloc filename size\n"
28103 #: ../fish/guestfish-commands.pod:7
28105 "This creates an empty (zeroed) file of the given size, and then adds so it "
28106 "can be further examined."
28110 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
28111 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
28115 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
28116 msgid "Size can be specified using standard suffixes, eg. C<1M>."
28120 #: ../fish/guestfish-commands.pod:14
28122 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
28123 "image, see L</PREPARED DISK IMAGES>."
28127 #: ../fish/guestfish-commands.pod:17
28132 #: ../fish/guestfish-commands.pod:19
28135 " copy-in local [local ...] /remotedir\n"
28140 #: ../fish/guestfish-commands.pod:21
28142 "C<copy-in> copies local files or directories recursively into the disk "
28143 "image, placing them in the directory called C</remotedir> (which must "
28144 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
28145 "other commands as necessary."
28149 #: ../fish/guestfish-commands.pod:26
28151 "Multiple local files and directories can be specified, but the last "
28152 "parameter must always be a remote directory. Wildcards cannot be used."
28156 #: ../fish/guestfish-commands.pod:30
28161 #: ../fish/guestfish-commands.pod:32
28164 " copy-out remote [remote ...] localdir\n"
28169 #: ../fish/guestfish-commands.pod:34
28171 "C<copy-out> copies remote files or directories recursively out of the disk "
28172 "image, placing them on the host disk in a local directory called C<localdir> "
28173 "(which must exist). This guestfish meta-command turns into a sequence of "
28174 "L</download>, L</tar-out> and other commands as necessary."
28178 #: ../fish/guestfish-commands.pod:40
28180 "Multiple remote files and directories can be specified, but the last "
28181 "parameter must always be a local directory. To download to the current "
28182 "directory, use C<.> as in:"
28186 #: ../fish/guestfish-commands.pod:44
28189 " copy-out /home .\n"
28194 #: ../fish/guestfish-commands.pod:46
28196 "Wildcards cannot be used in the ordinary command, but you can use them with "
28197 "the help of L</glob> like this:"
28201 #: ../fish/guestfish-commands.pod:49
28204 " glob copy-out /home/* .\n"
28209 #: ../fish/guestfish-commands.pod:51
28214 #: ../fish/guestfish-commands.pod:53
28217 " display filename\n"
28222 #: ../fish/guestfish-commands.pod:55
28224 "Use C<display> (a graphical display program) to display an image file. It "
28225 "downloads the file, and runs C<display> on it."
28229 #: ../fish/guestfish-commands.pod:58
28231 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
28232 "environment variable. For example to use the GNOME display program:"
28236 #: ../fish/guestfish-commands.pod:61
28239 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
28244 #: ../fish/guestfish-commands.pod:63
28245 msgid "See also L<display(1)>."
28249 #: ../fish/guestfish-commands.pod:65
28254 #: ../fish/guestfish-commands.pod:67
28257 " echo [params ...]\n"
28262 #: ../fish/guestfish-commands.pod:69
28263 msgid "This echos the parameters to the terminal."
28267 #: ../fish/guestfish-commands.pod:71
28272 #: ../fish/guestfish-commands.pod:73
28277 #: ../fish/guestfish-commands.pod:75
28282 #: ../fish/guestfish-commands.pod:77
28290 #: ../fish/guestfish-commands.pod:79
28292 "This is used to edit a file. It downloads the file, edits it locally using "
28293 "your editor, then uploads the result."
28297 #: ../fish/guestfish-commands.pod:82
28299 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28300 "or C<emacs> you will get those corresponding editors."
28304 #: ../fish/guestfish-commands.pod:86
28309 #: ../fish/guestfish-commands.pod:88
28312 " glob command args...\n"
28317 #: ../fish/guestfish-commands.pod:90
28319 "Expand wildcards in any paths in the args list, and run C<command> "
28320 "repeatedly on each matching path."
28324 #: ../fish/guestfish-commands.pod:93
28325 msgid "See L</WILDCARDS AND GLOBBING>."
28329 #: ../fish/guestfish-commands.pod:95
28334 #: ../fish/guestfish-commands.pod:97
28337 " hexedit <filename|device>\n"
28338 " hexedit <filename|device> <max>\n"
28339 " hexedit <filename|device> <start> <max>\n"
28344 #: ../fish/guestfish-commands.pod:101
28346 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28351 #: ../fish/guestfish-commands.pod:104
28353 "This command works by downloading potentially the whole file or device, "
28354 "editing it locally, then uploading it. If the file or device is large, you "
28355 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28356 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28357 "usual modifiers allowed such as C<1M> (1 megabyte)."
28361 #: ../fish/guestfish-commands.pod:111
28362 msgid "For example to edit the first few sectors of a disk you might do:"
28366 #: ../fish/guestfish-commands.pod:114
28369 " hexedit /dev/sda 1M\n"
28374 #: ../fish/guestfish-commands.pod:116
28376 "which would allow you to edit anywhere within the first megabyte of the "
28381 #: ../fish/guestfish-commands.pod:119
28382 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28386 #: ../fish/guestfish-commands.pod:121
28389 " hexedit /dev/sda1 0x400 0x400\n"
28394 #: ../fish/guestfish-commands.pod:123
28395 msgid "(assuming the superblock is in the standard location)."
28399 #: ../fish/guestfish-commands.pod:125
28401 "This command requires the external L<hexedit(1)> program. You can specify "
28402 "another program to use by setting the C<HEXEDITOR> environment variable."
28406 #: ../fish/guestfish-commands.pod:129
28407 msgid "See also L</hexdump>."
28411 #: ../fish/guestfish-commands.pod:131
28416 #: ../fish/guestfish-commands.pod:133
28424 #: ../fish/guestfish-commands.pod:135
28425 msgid "Change the local directory, ie. the current directory of guestfish itself."
28429 #: ../fish/guestfish-commands.pod:138
28430 msgid "Note that C<!cd> won't do what you might expect."
28434 #: ../fish/guestfish-commands.pod:140
28439 #: ../fish/guestfish-commands.pod:142
28444 #: ../fish/guestfish-commands.pod:144
28452 #: ../fish/guestfish-commands.pod:146
28453 msgid "Opens the manual page for guestfish."
28457 #: ../fish/guestfish-commands.pod:148
28462 #: ../fish/guestfish-commands.pod:150
28467 #: ../fish/guestfish-commands.pod:152
28475 #: ../fish/guestfish-commands.pod:154
28483 #: ../fish/guestfish-commands.pod:156
28484 msgid "This is used to view a file."
28488 #: ../fish/guestfish-commands.pod:158
28490 "The default viewer is C<$PAGER>. However if you use the alternate command "
28491 "C<less> you will get the C<less> command specifically."
28495 #: ../fish/guestfish-commands.pod:161
28500 #: ../fish/guestfish-commands.pod:163
28508 #: ../fish/guestfish-commands.pod:165
28510 "Close and reopen the libguestfs handle. It is not necessary to use this "
28511 "normally, because the handle is closed properly when guestfish exits. "
28512 "However this is occasionally useful for testing."
28516 #: ../fish/guestfish-commands.pod:169
28521 #: ../fish/guestfish-commands.pod:171
28524 " sparse filename size\n"
28529 #: ../fish/guestfish-commands.pod:173
28531 "This creates an empty sparse file of the given size, and then adds so it can "
28532 "be further examined."
28536 #: ../fish/guestfish-commands.pod:176
28538 "In all respects it works the same as the L</alloc> command, except that the "
28539 "image file is allocated sparsely, which means that disk blocks are not "
28540 "assigned to the file until they are needed. Sparse disk files only use "
28541 "space when written to, but they are slower and there is a danger you could "
28542 "run out of real disk space during a write operation."
28546 #: ../fish/guestfish-commands.pod:186
28551 #: ../fish/guestfish-commands.pod:188
28559 #: ../fish/guestfish-commands.pod:190
28561 "This command returns a list of the optional groups known to the daemon, and "
28562 "indicates which ones are supported by this build of the libguestfs "
28567 #: ../fish/guestfish-commands.pod:194
28568 msgid "See also L<guestfs(3)/AVAILABILITY>."
28572 #: ../fish/guestfish-commands.pod:196
28577 #: ../fish/guestfish-commands.pod:198
28580 " time command args...\n"
28585 #: ../fish/guestfish-commands.pod:200
28587 "Run the command as usual, but print the elapsed time afterwards. This can "
28588 "be useful for benchmarking operations."
28592 #: ../test-tool/libguestfs-test-tool.pod:5
28593 msgid "libguestfs-test-tool - End user tests for libguestfs"
28597 #: ../test-tool/libguestfs-test-tool.pod:9
28600 " libguestfs-test-tool [--options]\n"
28605 #: ../test-tool/libguestfs-test-tool.pod:13
28607 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28608 "and developers, to allow them to check basic libguestfs functionality is "
28609 "working. This is needed because libguestfs occasionally breaks for reasons "
28610 "beyond our control: usually because of changes in the underlying qemu or "
28611 "kernel packages, or the host environment."
28615 #: ../test-tool/libguestfs-test-tool.pod:20
28616 msgid "If you suspect a problem in libguestfs, then just run:"
28620 #: ../test-tool/libguestfs-test-tool.pod:22
28623 " libguestfs-test-tool\n"
28628 #: ../test-tool/libguestfs-test-tool.pod:24
28629 msgid "It will print lots of diagnostic messages."
28633 #: ../test-tool/libguestfs-test-tool.pod:26
28634 msgid "If it runs to completion successfully, you will see this near the end:"
28638 #: ../test-tool/libguestfs-test-tool.pod:28
28641 " ===== TEST FINISHED OK =====\n"
28646 #: ../test-tool/libguestfs-test-tool.pod:30
28647 msgid "and the test tool will exit with code 0."
28651 #: ../test-tool/libguestfs-test-tool.pod:32
28653 "If it fails (and/or exits with non-zero error code), please paste the "
28654 "B<complete, unedited> output of the test tool into a bug report. More "
28655 "information about reporting bugs can be found on the "
28656 "L<http://libguestfs.org/> website."
28660 #: ../test-tool/libguestfs-test-tool.pod:41
28665 #: ../test-tool/libguestfs-test-tool.pod:43
28666 msgid "Display short usage information and exit."
28670 #: ../test-tool/libguestfs-test-tool.pod:45
28671 msgid "I<--qemu qemu_binary>"
28675 #: ../test-tool/libguestfs-test-tool.pod:47
28677 "If you have downloaded another qemu binary, point this option at the full "
28678 "path of the binary to try it."
28682 #: ../test-tool/libguestfs-test-tool.pod:50
28683 msgid "I<--qemudir qemu_source_dir>"
28687 #: ../test-tool/libguestfs-test-tool.pod:52
28689 "If you have compiled qemu from source, point this option at the source "
28690 "directory to try it."
28694 #: ../test-tool/libguestfs-test-tool.pod:55
28695 msgid "I<--timeout N>"
28699 #: ../test-tool/libguestfs-test-tool.pod:57
28701 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28702 "does not usually need to be adjusted unless your machine is very slow."
28706 #: ../test-tool/libguestfs-test-tool.pod:63
28707 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28711 #: ../test-tool/libguestfs-test-tool.pod:65
28713 "If you have compiled another version of qemu from source and would like to "
28714 "try that, then you can use the I<--qemudir> option to point to the qemu "
28715 "source directory."
28719 #: ../test-tool/libguestfs-test-tool.pod:69
28721 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28722 "option to point to the binary."
28726 #: ../test-tool/libguestfs-test-tool.pod:72
28728 "When using an alternate qemu with libguestfs, usually you would need to "
28729 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
28730 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
28731 "when you use either of the I<--qemudir> or I<--qemu> options."
28735 #: ../test-tool/libguestfs-test-tool.pod:79
28737 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28738 "I<1> if there was an error."
28742 #: ../test-tool/libguestfs-test-tool.pod:84
28744 "For the full list of environment variables which may affect libguestfs, "
28745 "please see the L<guestfs(3)> manual page."
28749 #: ../test-tool/libguestfs-test-tool.pod:89
28750 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28754 #: ../fuse/guestmount.pod:5
28755 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28759 #: ../fuse/guestmount.pod:9
28762 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28767 #: ../fuse/guestmount.pod:11
28770 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28775 #: ../fuse/guestmount.pod:13
28778 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28783 #: ../fuse/guestmount.pod:17
28785 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28786 "machines. If you do this, you risk disk corruption in the VM."
28790 #: ../fuse/guestmount.pod:22
28792 "The guestmount program can be used to mount virtual machine filesystems and "
28793 "other disk images on the host. It uses libguestfs for access to the guest "
28794 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28795 "a mountable device."
28799 #: ../fuse/guestmount.pod:27
28801 "Along with other options, you have to give at least one device (I<-a> "
28802 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28803 "option) or use the I<-i> inspection option. How this works is better "
28804 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28809 #: ../fuse/guestmount.pod:33
28811 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28812 "by you, and the filesystem will not be visible to any other users unless you "
28813 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28814 "the filesystem, use the C<fusermount -u> command."
28818 #: ../fuse/guestmount.pod:41
28820 "For a typical Windows guest which has its main filesystem on the first "
28825 #: ../fuse/guestmount.pod:44
28828 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28833 #: ../fuse/guestmount.pod:46
28835 "For a typical Linux guest which has a /boot filesystem on the first "
28836 "partition, and the root filesystem on a logical volume:"
28840 #: ../fuse/guestmount.pod:49
28843 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28848 #: ../fuse/guestmount.pod:51
28849 msgid "To get libguestfs to detect guest mountpoints for you:"
28853 #: ../fuse/guestmount.pod:53
28856 " guestmount -a guest.img -i --ro /mnt\n"
28861 #: ../fuse/guestmount.pod:55
28862 msgid "For a libvirt guest called \"Guest\" you could do:"
28866 #: ../fuse/guestmount.pod:57
28869 " guestmount -d Guest -i --ro /mnt\n"
28874 #: ../fuse/guestmount.pod:59
28876 "If you don't know what filesystems are contained in a guest or disk image, "
28877 "use L<virt-filesystems(1)> first:"
28881 #: ../fuse/guestmount.pod:62
28884 " virt-filesystems MyGuest\n"
28889 #: ../fuse/guestmount.pod:64
28891 "If you want to trace the libguestfs calls but without excessive debugging "
28892 "information, we recommend:"
28896 #: ../fuse/guestmount.pod:67
28899 " guestmount [...] --trace /mnt\n"
28904 #: ../fuse/guestmount.pod:69
28905 msgid "If you want to debug the program, we recommend:"
28909 #: ../fuse/guestmount.pod:71
28912 " guestmount [...] --trace --verbose /mnt\n"
28917 #: ../fuse/guestmount.pod:73
28922 #: ../fuse/guestmount.pod:75
28923 msgid "Other users cannot see the filesystem by default"
28927 #: ../fuse/guestmount.pod:77
28929 "If you mount a filesystem as one user (eg. root), then other users will not "
28930 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28931 "option when mounting:"
28935 #: ../fuse/guestmount.pod:81
28938 " sudo guestmount [...] -o allow_other /mnt\n"
28943 #: ../fuse/guestmount.pod:87
28944 msgid "B<-a image> | B<--add image>"
28948 #: ../fuse/guestmount.pod:89
28949 msgid "Add a block device or virtual machine image."
28953 #: ../fuse/guestmount.pod:94
28954 msgid "B<-c URI> | B<--connect URI>"
28958 #: ../fuse/guestmount.pod:100
28959 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28963 #: ../fuse/guestmount.pod:108
28964 msgid "B<--dir-cache-timeout N>"
28968 #: ../fuse/guestmount.pod:110
28970 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28971 "seconds. The readdir cache [actually, there are several semi-independent "
28972 "caches] is populated after a readdir(2) call with the stat and extended "
28973 "attributes of the files in the directory, in anticipation that they will be "
28974 "requested soon after."
28978 #: ../fuse/guestmount.pod:116
28980 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28981 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28982 "requests, only cache existing ones."
28986 #: ../fuse/guestmount.pod:127
28987 msgid "B<--format=raw|qcow2|..> | B<--format>"
28991 #: ../fuse/guestmount.pod:134
28993 "If you have untrusted raw-format guest disk images, you should use this "
28994 "option to specify the disk format. This avoids a possible security problem "
28995 "with malicious guests (CVE-2010-3851). See also "
28996 "L<guestfs(3)/guestfs_add_drive_opts>."
29000 #: ../fuse/guestmount.pod:139
29001 msgid "B<--fuse-help>"
29005 #: ../fuse/guestmount.pod:141
29006 msgid "Display help on special FUSE options (see I<-o> below)."
29010 #: ../fuse/guestmount.pod:145
29011 msgid "Display brief help and exit."
29015 #: ../fuse/guestmount.pod:147
29016 msgid "B<-i> | B<--inspector>"
29020 #: ../fuse/guestmount.pod:167
29022 "Mount the named partition or logical volume on the given mountpoint B<in the "
29023 "guest> (this has nothing to do with mountpoints in the host)."
29027 #: ../fuse/guestmount.pod:170
29029 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
29030 "something on C</>."
29034 #: ../fuse/guestmount.pod:183
29035 msgid "B<-n> | B<--no-sync>"
29039 #: ../fuse/guestmount.pod:185
29041 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
29042 "unmounted. If you specify this option, then we don't attempt to sync the "
29043 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
29047 #: ../fuse/guestmount.pod:190
29048 msgid "B<-o option> | B<--option option>"
29052 #: ../fuse/guestmount.pod:192
29053 msgid "Pass extra options to FUSE."
29057 #: ../fuse/guestmount.pod:194
29059 "To get a list of all the extra options supported by FUSE, use the command "
29060 "below. Note that only the FUSE I<-o> options can be passed, and only some "
29061 "of them are a good idea."
29065 #: ../fuse/guestmount.pod:198
29068 " guestmount --fuse-help\n"
29073 #: ../fuse/guestmount.pod:200
29074 msgid "Some potentially useful FUSE options:"
29078 #: ../fuse/guestmount.pod:204
29079 msgid "B<-o allow_other>"
29083 #: ../fuse/guestmount.pod:206
29084 msgid "Allow other users to see the filesystem."
29088 #: ../fuse/guestmount.pod:208
29089 msgid "B<-o attr_timeout=N>"
29093 #: ../fuse/guestmount.pod:210
29094 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
29098 #: ../fuse/guestmount.pod:212
29099 msgid "B<-o kernel_cache>"
29103 #: ../fuse/guestmount.pod:214
29105 "Allow the kernel to cache files (reduces the number of reads that have to go "
29106 "through the L<guestfs(3)> API). This is generally a good idea if you can "
29107 "afford the extra memory usage."
29111 #: ../fuse/guestmount.pod:218
29112 msgid "B<-o uid=N> B<-o gid=N>"
29116 #: ../fuse/guestmount.pod:220
29118 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
29119 "the chosen values."
29123 #: ../fuse/guestmount.pod:225
29124 msgid "B<-r> | B<--ro>"
29128 #: ../fuse/guestmount.pod:227
29130 "Add devices and mount everything read-only. Also disallow writes and make "
29131 "the disk appear read-only to FUSE."
29135 #: ../fuse/guestmount.pod:230
29137 "This is highly recommended if you are not going to edit the guest disk. If "
29138 "the guest is running and this option is I<not> supplied, then there is a "
29139 "strong risk of disk corruption in the guest. We try to prevent this from "
29140 "happening, but it is not always possible."
29144 #: ../fuse/guestmount.pod:235
29145 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29149 #: ../fuse/guestmount.pod:239
29150 msgid "Enable SELinux support for the guest."
29154 #: ../fuse/guestmount.pod:241
29155 msgid "B<-v> | B<--verbose>"
29159 #: ../fuse/guestmount.pod:243
29160 msgid "Enable verbose messages from underlying libguestfs."
29164 #: ../fuse/guestmount.pod:245
29165 msgid "B<-V> | B<--version>"
29169 #: ../fuse/guestmount.pod:247
29170 msgid "Display the program version and exit."
29174 #: ../fuse/guestmount.pod:249
29175 msgid "B<-w> | B<--rw>"
29179 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
29180 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29184 #: ../fuse/guestmount.pod:256
29185 msgid "B<-x> | B<--trace>"
29189 #: ../fuse/guestmount.pod:258
29190 msgid "Trace libguestfs calls and entry into each FUSE function."
29194 #: ../fuse/guestmount.pod:260
29195 msgid "This also stops the daemon from forking into the background."
29199 #: ../fuse/guestmount.pod:281
29201 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29202 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
29203 "L<http://fuse.sf.net/>."
29207 #: ../fuse/guestmount.pod:296
29208 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
29212 #: ../tools/virt-win-reg.pl:37
29214 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
29219 #: ../tools/virt-win-reg.pl:41
29222 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29227 #: ../tools/virt-win-reg.pl:43
29230 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29235 #: ../tools/virt-win-reg.pl:45
29238 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29243 #: ../tools/virt-win-reg.pl:47
29246 " virt-win-reg --merge domname [input.reg ...]\n"
29251 #: ../tools/virt-win-reg.pl:49
29254 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29259 #: ../tools/virt-win-reg.pl:53
29261 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29262 "virtual machines. If you do this, you I<will> get irreversible disk "
29263 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29264 "but doesn't catch all cases."
29268 #: ../tools/virt-win-reg.pl:58
29270 "Modifying the Windows Registry is an inherently risky operation. The format "
29271 "is deliberately obscure and undocumented, and Registry changes can leave the "
29272 "system unbootable. Therefore when using the I<--merge> option, make sure "
29273 "you have a reliable backup first."
29277 #: ../tools/virt-win-reg.pl:65
29279 "This program can export and merge Windows Registry entries from a Windows "
29284 #: ../tools/virt-win-reg.pl:68
29286 "The first parameter is the libvirt guest name or the raw disk image of a "
29291 #: ../tools/virt-win-reg.pl:71
29293 "If I<--merge> is I<not> specified, then the chosen registry key is "
29294 "displayed/exported (recursively). For example:"
29298 #: ../tools/virt-win-reg.pl:74
29301 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29306 #: ../tools/virt-win-reg.pl:76
29307 msgid "You can also display single values from within registry keys, for example:"
29311 #: ../tools/virt-win-reg.pl:79
29314 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29315 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29316 " Windows 7 Enterprise\n"
29321 #: ../tools/virt-win-reg.pl:83
29323 "With I<--merge>, you can merge a textual regedit file into the Windows "
29328 #: ../tools/virt-win-reg.pl:86
29331 " $ virt-win-reg --merge Windows7 changes.reg\n"
29336 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29341 #: ../tools/virt-win-reg.pl:90
29343 "This program is only meant for simple access to the registry. If you want "
29344 "to do complicated things with the registry, we suggest you download the "
29345 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29346 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29347 "L<hivexregedit(1)>."
29351 #: ../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
29352 msgid "Display brief help."
29356 #: ../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
29357 msgid "Display version number and exit."
29361 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29366 #: ../tools/virt-win-reg.pl:122
29367 msgid "Enable debugging messages."
29371 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
29372 msgid "B<--connect URI> | B<-c URI>"
29376 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
29378 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29379 "to the default libvirt hypervisor."
29383 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
29385 "If you specify guest block devices directly, then libvirt is not used at "
29390 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
29391 msgid "B<--format> raw"
29395 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
29397 "Specify the format of disk images given on the command line. If this is "
29398 "omitted then the format is autodetected from the content of the disk image."
29402 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
29404 "If disk images are requested from libvirt, then this program asks libvirt "
29405 "for this information. In this case, the value of the format parameter is "
29410 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
29412 "If working with untrusted raw-format guest disk images, you should ensure "
29413 "the format is always specified."
29417 #: ../tools/virt-win-reg.pl:157
29422 #: ../tools/virt-win-reg.pl:159
29424 "In merge mode, this merges a textual regedit file into the Windows Registry "
29425 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29426 "displays or exports Registry entries instead."
29430 #: ../tools/virt-win-reg.pl:163
29432 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29433 "result in disk corruption. However exporting (without this flag) is always "
29438 #: ../tools/virt-win-reg.pl:171
29439 msgid "B<--encoding> UTF-16LE|ASCII"
29443 #: ../tools/virt-win-reg.pl:173
29445 "When merging (only), you may need to specify the encoding for strings to be "
29446 "used in the hive file. This is explained in detail in "
29447 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
29451 #: ../tools/virt-win-reg.pl:177
29453 "The default is to use UTF-16LE, which should work with recent versions of "
29458 #: ../tools/virt-win-reg.pl:184
29459 msgid "B<--unsafe-printable-strings>"
29463 #: ../tools/virt-win-reg.pl:186
29465 "When exporting (only), assume strings are UTF-16LE and print them as strings "
29466 "instead of hex sequences. Remove the final zero codepoint from strings if "
29471 #: ../tools/virt-win-reg.pl:190
29473 "This is unsafe and does not preserve the fidelity of strings in the original "
29474 "Registry for various reasons:"
29478 #: ../tools/virt-win-reg.pl:197
29480 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
29481 "other encodings will be corrupted by this transformation."
29485 #: ../tools/virt-win-reg.pl:202
29487 "Assumes that everything which has type 1 or 2 is really a string and that "
29488 "everything else is not a string, but the type field in real Registries is "
29493 #: ../tools/virt-win-reg.pl:208
29495 "Loses information about whether a zero codepoint followed the string in the "
29500 #: ../tools/virt-win-reg.pl:213
29502 "This all happens because the Registry itself contains no information about "
29503 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
29507 #: ../tools/virt-win-reg.pl:217
29509 "You should only use this option for quick hacking and debugging of the "
29510 "Registry contents, and I<never> use it if the output is going to be passed "
29511 "into another program or stored in another Registry."
29515 #: ../tools/virt-win-reg.pl:554
29516 msgid "SUPPORTED SYSTEMS"
29520 #: ../tools/virt-win-reg.pl:556
29522 "The program currently supports Windows NT-derived guests starting with "
29523 "Windows XP through to at least Windows 7."
29527 #: ../tools/virt-win-reg.pl:559
29528 msgid "The following Registry keys are supported:"
29532 #: ../tools/virt-win-reg.pl:563
29533 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
29537 #: ../tools/virt-win-reg.pl:565
29538 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
29542 #: ../tools/virt-win-reg.pl:567
29543 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
29547 #: ../tools/virt-win-reg.pl:569
29548 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
29552 #: ../tools/virt-win-reg.pl:571
29553 msgid "C<HKEY_USERS\\.DEFAULT>"
29557 #: ../tools/virt-win-reg.pl:573
29558 msgid "C<HKEY_USERS\\I<SID>>"
29562 #: ../tools/virt-win-reg.pl:575
29563 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
29567 #: ../tools/virt-win-reg.pl:577
29568 msgid "C<HKEY_USERS\\I<username>>"
29572 #: ../tools/virt-win-reg.pl:579
29573 msgid "where I<username> is a local user name (this is a libguestfs extension)."
29577 #: ../tools/virt-win-reg.pl:583
29579 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29584 #: ../tools/virt-win-reg.pl:586
29586 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
29587 "supported (there is no \"current user\")."
29591 #: ../tools/virt-win-reg.pl:589
29596 #: ../tools/virt-win-reg.pl:591
29598 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29599 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
29600 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
29601 "with Windows-style line endings, you may need to reencode the whole file "
29602 "before or after processing."
29606 #: ../tools/virt-win-reg.pl:597
29608 "To reencode a file from Windows format to Linux (before processing it with "
29609 "the I<--merge> option), you would do something like this:"
29613 #: ../tools/virt-win-reg.pl:600
29616 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29621 #: ../tools/virt-win-reg.pl:602
29623 "To go in the opposite direction, after exporting and before sending the file "
29624 "to a Windows user, do something like this:"
29628 #: ../tools/virt-win-reg.pl:605
29631 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29636 #: ../tools/virt-win-reg.pl:607
29637 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29641 #: ../tools/virt-win-reg.pl:609
29643 "If you are unsure about the current encoding, use the L<file(1)> command. "
29644 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
29645 "Windows-style (CRLF) line endings, like this:"
29649 #: ../tools/virt-win-reg.pl:613
29652 " $ file software.reg\n"
29653 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29654 " with CRLF line terminators\n"
29659 #: ../tools/virt-win-reg.pl:617
29660 msgid "This file would need conversion before you could I<--merge> it."
29664 #: ../tools/virt-win-reg.pl:619
29665 msgid "CurrentControlSet etc."
29669 #: ../tools/virt-win-reg.pl:621
29671 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29672 "Registry at the level of the hive file, and therefore you cannot modify "
29677 #: ../tools/virt-win-reg.pl:625
29679 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29680 "circumstances it might refer to another control set. The way to find out is "
29681 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29685 #: ../tools/virt-win-reg.pl:629
29688 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29689 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29690 " \"Current\"=dword:00000001\n"
29691 " \"Default\"=dword:00000001\n"
29692 " \"Failed\"=dword:00000000\n"
29693 " \"LastKnownGood\"=dword:00000002\n"
29698 #: ../tools/virt-win-reg.pl:636
29699 msgid "\"Current\" is the one which Windows will choose when it boots."
29703 #: ../tools/virt-win-reg.pl:638
29704 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
29708 #: ../tools/virt-win-reg.pl:641
29709 msgid "WINDOWS TIPS"
29713 #: ../tools/virt-win-reg.pl:643
29715 "Note that some of these tips modify the guest disk image. The guest I<must> "
29716 "be shut off, else you will get disk corruption."
29720 #: ../tools/virt-win-reg.pl:646
29721 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29725 #: ../tools/virt-win-reg.pl:648
29727 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29728 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29729 "is uploaded into C<C:\\>:"
29733 #: ../tools/virt-win-reg.pl:652
29736 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29741 #: ../tools/virt-win-reg.pl:654
29742 msgid "Prepare a regedit file containing the registry change:"
29746 #: ../tools/virt-win-reg.pl:656
29749 " cat > test.reg <<'EOF'\n"
29750 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29751 " \"Test\"=\"c:\\\\test.bat\"\n"
29757 #: ../tools/virt-win-reg.pl:661
29759 "In this example we use the key C<RunOnce> which means that the script will "
29760 "run precisely once when the first user logs in. If you want it to run every "
29761 "time a user logs in, replace C<RunOnce> with C<Run>."
29765 #: ../tools/virt-win-reg.pl:665
29766 msgid "Now update the registry:"
29770 #: ../tools/virt-win-reg.pl:667
29773 " virt-win-reg --merge WindowsGuest test.reg\n"
29778 #: ../tools/virt-win-reg.pl:669
29779 msgid "INSTALLING A SERVICE"
29783 #: ../tools/virt-win-reg.pl:671
29785 "This section assumes you are familiar with Windows services, and you either "
29786 "have a program which handles the Windows Service Control Protocol directly "
29787 "or you want to run any program using a service wrapper like SrvAny or the "
29792 #: ../tools/virt-win-reg.pl:676
29794 "First upload the program and optionally the service wrapper. In this case "
29795 "the test program is called C<test.exe> and we are using the RHSrvAny "
29800 #: ../tools/virt-win-reg.pl:680
29803 " guestfish -i -d WindowsGuest <<EOF\n"
29804 " upload rhsrvany.exe /rhsrvany.exe\n"
29805 " upload test.exe /test.exe\n"
29811 #: ../tools/virt-win-reg.pl:685
29813 "Prepare a regedit file containing the registry changes. In this example, "
29814 "the first registry change is needed for the service itself or the service "
29815 "wrapper (if used). The second registry change is only needed because I am "
29816 "using the RHSrvAny service wrapper."
29820 #: ../tools/virt-win-reg.pl:690
29823 " cat > service.reg <<'EOF'\n"
29824 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29825 " \"Type\"=dword:00000010\n"
29826 " \"Start\"=dword:00000002\n"
29827 " \"ErrorControl\"=dword:00000001\n"
29828 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29829 " \"DisplayName\"=\"RHSrvAny\"\n"
29830 " \"ObjectName\"=\"NetworkService\"\n"
29835 #: ../tools/virt-win-reg.pl:699
29838 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29839 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29840 " \"PWD\"=\"c:\\\\Temp\"\n"
29846 #: ../tools/virt-win-reg.pl:710
29848 "For use of C<ControlSet001> see the section above in this manual page. You "
29849 "may need to adjust this according to the control set that is in use by the "
29854 #: ../tools/virt-win-reg.pl:716
29856 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29857 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29858 "privileged account."
29862 #: ../tools/virt-win-reg.pl:722
29864 "For the meaning of the magic numbers, see this Microsoft KB article: "
29865 "L<http://support.microsoft.com/kb/103000>."
29869 #: ../tools/virt-win-reg.pl:727
29870 msgid "Update the registry:"
29874 #: ../tools/virt-win-reg.pl:729
29877 " virt-win-reg --merge WindowsGuest service.reg\n"
29882 #: ../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
29883 msgid "SHELL QUOTING"
29887 #: ../tools/virt-win-reg.pl:733
29889 "Be careful when passing parameters containing C<\\> (backslash) in the "
29890 "shell. Usually you will have to use 'single quotes' or double backslashes "
29891 "(but not both) to protect them from the shell."
29895 #: ../tools/virt-win-reg.pl:737
29896 msgid "Paths and value names are case-insensitive."
29900 #: ../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
29902 "Libvirt guest names can contain arbitrary characters, some of which have "
29903 "meaning to the shell such as C<#> and space. You may need to quote or "
29904 "escape these characters on the command line. See the shell manual page "
29905 "L<sh(1)> for details."
29909 #: ../tools/virt-win-reg.pl:746
29911 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29912 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29913 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29914 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29918 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
29920 "When reporting bugs, please enable debugging and capture the I<complete> "
29925 #: ../tools/virt-win-reg.pl:764
29928 " export LIBGUESTFS_DEBUG=1\n"
29929 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29934 #: ../tools/virt-win-reg.pl:767
29936 "Attach /tmp/virt-win-reg.log to a new bug report at "
29937 "L<https://bugzilla.redhat.com/>"
29941 #: ../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
29946 #: ../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
29947 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29951 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
29952 msgid "Copyright (C) 2010 Red Hat Inc."
29956 #: ../tools/virt-list-filesystems.pl:32
29957 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29961 #: ../tools/virt-list-filesystems.pl:36
29964 " virt-list-filesystems [--options] domname\n"
29969 #: ../tools/virt-list-filesystems.pl:38
29972 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29977 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29979 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29984 #: ../tools/virt-list-filesystems.pl:45
29986 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29987 "are contained in a virtual machine or disk image."
29991 #: ../tools/virt-list-filesystems.pl:49
29993 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29994 "functionality. For more complex cases you should look at the "
29995 "L<guestfish(1)> tool."
29999 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30000 msgid "B<-l> | B<--long>"
30004 #: ../tools/virt-list-filesystems.pl:108
30006 "With this option, C<virt-list-filesystems> displays the type of each "
30007 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30011 #: ../tools/virt-list-filesystems.pl:115
30012 msgid "B<-a> | B<--all>"
30016 #: ../tools/virt-list-filesystems.pl:117
30018 "Normally we only show mountable filesystems. If this option is given then "
30019 "swap devices are shown too."
30023 #: ../tools/virt-list-filesystems.pl:191
30025 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
30026 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
30027 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30031 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30032 msgid "Copyright (C) 2009 Red Hat Inc."
30036 #: ../tools/virt-tar.pl:33
30037 msgid "virt-tar - Extract or upload files to a virtual machine"
30041 #: ../tools/virt-tar.pl:37
30044 " virt-tar [--options] -x domname directory tarball\n"
30049 #: ../tools/virt-tar.pl:39
30052 " virt-tar [--options] -u domname tarball directory\n"
30057 #: ../tools/virt-tar.pl:41
30060 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30065 #: ../tools/virt-tar.pl:43
30068 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30073 #: ../tools/virt-tar.pl:47
30075 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
30076 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
30080 #: ../tools/virt-tar.pl:52
30081 msgid "Download C</home> from the VM into a local tarball:"
30085 #: ../tools/virt-tar.pl:54
30088 " virt-tar -x domname /home home.tar\n"
30093 #: ../tools/virt-tar.pl:56
30096 " virt-tar -zx domname /home home.tar.gz\n"
30101 #: ../tools/virt-tar.pl:58
30102 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30106 #: ../tools/virt-tar.pl:60
30109 " virt-tar -u domname uploadstuff.tar /tmp\n"
30114 #: ../tools/virt-tar.pl:62
30117 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30122 #: ../tools/virt-tar.pl:66
30124 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30125 "virtual machines. If you do this, you risk disk corruption in the VM. "
30126 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30130 #: ../tools/virt-tar.pl:71
30132 "You can use I<-x> (extract) on live virtual machines, but you might get "
30133 "inconsistent results or errors if there is filesystem activity inside the "
30134 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30135 "work, but the only way to guarantee consistent results is if the virtual "
30136 "machine is shut down."
30140 #: ../tools/virt-tar.pl:79
30142 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30143 "parts of a guest filesystem. There are many possibilities: making backups, "
30144 "uploading data files, snooping on guest activity, fixing or customizing "
30149 #: ../tools/virt-tar.pl:84
30151 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30152 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30153 "should look at the L<guestfish(1)> tool."
30157 #: ../tools/virt-tar.pl:88
30159 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30160 "its contents (recursively) from the virtual machine into a local tarball. "
30161 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30162 "virtual machine. You cannot use these two options together."
30166 #: ../tools/virt-tar.pl:94
30168 "In addition, you may need to use the I<-z> (gZip) option to enable "
30169 "compression. When uploading, you have to specify I<-z> if the upload file "
30170 "is compressed because virt-tar won't detect this on its own."
30174 #: ../tools/virt-tar.pl:98
30176 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30177 "example it cannot do PKZip files or bzip2 compression. If you want that "
30178 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30179 "the L<libguestfs(3)> API)."
30183 #: ../tools/virt-tar.pl:156
30184 msgid "B<-x> | B<--extract> | B<--download>"
30188 #: ../tools/virt-tar.pl:158
30189 msgid "B<-u> | B<--upload>"
30193 #: ../tools/virt-tar.pl:160
30195 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30200 #: ../tools/virt-tar.pl:163
30202 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30203 "Please read the L</WARNING> section above before using this option."
30207 #: ../tools/virt-tar.pl:167
30208 msgid "You must specify exactly one of these options."
30212 #: ../tools/virt-tar.pl:173
30213 msgid "B<-z> | B<--gzip>"
30217 #: ../tools/virt-tar.pl:175
30218 msgid "Specify that the input or output tarball is gzip-compressed."
30222 #: ../tools/virt-tar.pl:288
30224 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
30225 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
30226 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
30227 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30231 #: ../tools/virt-make-fs.pl:37
30232 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30236 #: ../tools/virt-make-fs.pl:41
30239 " virt-make-fs [--options] input.tar output.img\n"
30244 #: ../tools/virt-make-fs.pl:43
30247 " virt-make-fs [--options] input.tar.gz output.img\n"
30252 #: ../tools/virt-make-fs.pl:45
30255 " virt-make-fs [--options] directory output.img\n"
30260 #: ../tools/virt-make-fs.pl:49
30262 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30263 "archive or some files in a directory. It is similar to tools like "
30264 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
30265 "it can create common filesystem types like ext2/3 or NTFS, which can be "
30266 "useful if you want to attach these filesystems to existing virtual machines "
30267 "(eg. to import large amounts of read-only data to a VM)."
30271 #: ../tools/virt-make-fs.pl:57
30272 msgid "Basic usage is:"
30276 #: ../tools/virt-make-fs.pl:59
30279 " virt-make-fs input output\n"
30284 #: ../tools/virt-make-fs.pl:61
30286 "where C<input> is either a directory containing files that you want to add, "
30287 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30288 "C<output> is a disk image. The input type is detected automatically. The "
30289 "output disk image defaults to a raw ext2 image unless you specify extra "
30290 "flags (see L</OPTIONS> below)."
30294 #: ../tools/virt-make-fs.pl:67
30295 msgid "EXTRA SPACE"
30299 #: ../tools/virt-make-fs.pl:69
30301 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30302 "the files that it contains, but might have extra space. Depending on how "
30303 "you are going to use the output, you might think this extra space is wasted "
30304 "and want to minimize it, or you might want to leave space so that more files "
30305 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30306 "but you can use the I<--size> flag to leave space in the filesystem if you "
30311 #: ../tools/virt-make-fs.pl:77
30313 "An alternative way to leave extra space but not make the output image any "
30314 "bigger is to use an alternative disk image format (instead of the default "
30315 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30316 "image format (check your hypervisor supports this before using it). This "
30317 "allows you to choose a large I<--size> but the extra space won't actually be "
30318 "allocated in the image until you try to store something in it."
30322 #: ../tools/virt-make-fs.pl:85
30324 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30325 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30326 "to build another image from scratch."
30330 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
30335 #: ../tools/virt-make-fs.pl:91
30338 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30343 #: ../tools/virt-make-fs.pl:93
30344 msgid "FILESYSTEM TYPE"
30348 #: ../tools/virt-make-fs.pl:95
30350 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30351 "libguestfs supports can be used (but I<not> read-only formats like "
30352 "ISO9660). Here are some of the more common choices:"
30356 #: ../tools/virt-make-fs.pl:101
30361 #: ../tools/virt-make-fs.pl:103
30363 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30364 "you are not going to use the filesystem in a way that requires the journal, "
30365 "then this is just wasted overhead."
30369 #: ../tools/virt-make-fs.pl:107
30370 msgid "I<ntfs> or I<vfat>"
30374 #: ../tools/virt-make-fs.pl:109
30375 msgid "Useful if exporting data to a Windows guest."
30379 #: ../tools/virt-make-fs.pl:111
30381 "I<Note for vfat>: The tar archive or local directory must only contain files "
30382 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30383 "program running within libguestfs is unable to change the ownership of "
30384 "non-root files, since vfat itself does not support this."
30388 #: ../tools/virt-make-fs.pl:116
30393 #: ../tools/virt-make-fs.pl:118
30395 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30396 "total filesystem size."
30400 #: ../tools/virt-make-fs.pl:125
30403 " virt-make-fs --type=minix input minixfs.img\n"
30408 #: ../tools/virt-make-fs.pl:127
30409 msgid "TO PARTITION OR NOT TO PARTITION"
30413 #: ../tools/virt-make-fs.pl:129
30414 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30418 #: ../tools/virt-make-fs.pl:131
30420 "Adding a partition can make the disk image more compatible with certain "
30421 "virtualized operating systems which don't expect to see a filesystem "
30422 "directly located on a block device (Linux doesn't care and will happily "
30423 "handle both types)."
30427 #: ../tools/virt-make-fs.pl:136
30429 "On the other hand, if you have a partition table then the output image is no "
30430 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30431 "directly on a partitioned disk image. (However libguestfs tools such as "
30432 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30436 #: ../tools/virt-make-fs.pl:144
30437 msgid "Add an MBR partition:"
30441 #: ../tools/virt-make-fs.pl:146
30444 " virt-make-fs --partition -- input disk.img\n"
30449 #: ../tools/virt-make-fs.pl:148
30451 "If the output disk image could be terabyte-sized or larger, it's better to "
30452 "use an EFI/GPT-compatible partition table:"
30456 #: ../tools/virt-make-fs.pl:151
30459 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30464 #: ../tools/virt-make-fs.pl:179
30465 msgid "Enable debugging information."
30469 #: ../tools/virt-make-fs.pl:185
30470 msgid "B<--size=E<lt>NE<gt>>"
30474 #: ../tools/virt-make-fs.pl:187
30475 msgid "B<--size=+E<lt>NE<gt>>"
30479 #: ../tools/virt-make-fs.pl:189
30480 msgid "B<-s E<lt>NE<gt>>"
30484 #: ../tools/virt-make-fs.pl:191
30485 msgid "B<-s +E<lt>NE<gt>>"
30489 #: ../tools/virt-make-fs.pl:193
30490 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30494 #: ../tools/virt-make-fs.pl:196
30496 "If this option is I<not> given, then the output image will be just large "
30497 "enough to contain all the files, with not much wasted space."
30501 #: ../tools/virt-make-fs.pl:199
30503 "To choose a fixed size output disk, specify an absolute number followed by "
30504 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30505 "Petabytes or Exabytes. This must be large enough to contain all the input "
30506 "files, else you will get an error."
30510 #: ../tools/virt-make-fs.pl:204
30512 "To leave extra space, specify C<+> (plus sign) and a number followed by "
30513 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30514 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30515 "the input files, and (approximately) an extra 200 MB free space."
30519 #: ../tools/virt-make-fs.pl:210
30521 "Note that virt-make-fs estimates free space, and therefore will not produce "
30522 "filesystems containing precisely the free space requested. (It is much more "
30523 "expensive and time-consuming to produce a filesystem which has precisely the "
30524 "desired free space)."
30528 #: ../tools/virt-make-fs.pl:219
30529 msgid "B<--format=E<lt>fmtE<gt>>"
30533 #: ../tools/virt-make-fs.pl:221
30534 msgid "B<-F E<lt>fmtE<gt>>"
30538 #: ../tools/virt-make-fs.pl:223
30539 msgid "Choose the output disk image format."
30543 #: ../tools/virt-make-fs.pl:225
30544 msgid "The default is C<raw> (raw disk image)."
30548 #: ../tools/virt-make-fs.pl:227
30550 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30551 "that would really make sense here is C<qcow2>."
30555 #: ../tools/virt-make-fs.pl:234
30556 msgid "B<--type=E<lt>fsE<gt>>"
30560 #: ../tools/virt-make-fs.pl:236
30561 msgid "B<-t E<lt>fsE<gt>>"
30565 #: ../tools/virt-make-fs.pl:238
30566 msgid "Choose the output filesystem type."
30570 #: ../tools/virt-make-fs.pl:240
30571 msgid "The default is C<ext2>."
30575 #: ../tools/virt-make-fs.pl:242
30576 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30580 #: ../tools/virt-make-fs.pl:249
30581 msgid "B<--partition>"
30585 #: ../tools/virt-make-fs.pl:251
30586 msgid "B<--partition=E<lt>parttypeE<gt>>"
30590 #: ../tools/virt-make-fs.pl:253
30592 "If specified, this flag adds an MBR partition table to the output disk "
30597 #: ../tools/virt-make-fs.pl:256
30599 "You can change the partition table type, eg. I<--partition=gpt> for large "
30604 #: ../tools/virt-make-fs.pl:259
30606 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30607 "might consider the next parameter to be the partition type. For example:"
30611 #: ../tools/virt-make-fs.pl:263
30614 " virt-make-fs --partition input.tar ...\n"
30619 #: ../tools/virt-make-fs.pl:265
30621 "would cause virt-make-fs to think you wanted to use a partition type of "
30622 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30623 "dash) between options and the input file argument:"
30627 #: ../tools/virt-make-fs.pl:269
30630 " virt-make-fs --partition -- input.tar ...\n"
30635 #: ../tools/virt-make-fs.pl:541
30637 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30638 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30639 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30643 #: ../tools/virt-make-fs.pl:558
30646 " export LIBGUESTFS_DEBUG=1\n"
30647 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30652 #: ../tools/virt-make-fs.pl:561
30654 "Attach /tmp/virt-make-fs.log to a new bug report at "
30655 "L<https://bugzilla.redhat.com/>"
30659 #: ../tools/virt-list-partitions.pl:32
30660 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
30664 #: ../tools/virt-list-partitions.pl:36
30667 " virt-list-partitions [--options] domname\n"
30672 #: ../tools/virt-list-partitions.pl:38
30675 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30680 #: ../tools/virt-list-partitions.pl:45
30682 "C<virt-list-partitions> is a command line tool to list the partitions that "
30683 "are contained in a virtual machine or disk image. It is mainly useful as a "
30684 "first step to using L<virt-resize(1)>."
30688 #: ../tools/virt-list-partitions.pl:50
30690 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30691 "functionality. For more complex cases you should look at the "
30692 "L<guestfish(1)> tool."
30696 #: ../tools/virt-list-partitions.pl:107
30697 msgid "B<-h> | B<--human-readable>"
30701 #: ../tools/virt-list-partitions.pl:109
30702 msgid "Show sizes in human-readable form (eg. \"1G\")."
30706 #: ../tools/virt-list-partitions.pl:117
30708 "With this option, C<virt-list-partitions> displays the type and size of each "
30709 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30713 #: ../tools/virt-list-partitions.pl:124
30714 msgid "B<-t> | B<--total>"
30718 #: ../tools/virt-list-partitions.pl:126
30719 msgid "Display the total size of each block device (as a separate row or rows)."
30723 #: ../tools/virt-list-partitions.pl:259
30725 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
30726 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
30727 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30731 #: ../tools/virt-list-partitions.pl:275
30732 msgid "Copyright (C) 2009-2010 Red Hat Inc."