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.9.17\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-04-05 20:38+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-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
26 #: ../src/guestfs.pod:5
27 msgid "guestfs - Library for accessing and modifying virtual machine images"
31 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
36 #: ../src/guestfs.pod:9
39 " #include <guestfs.h>\n"
44 #: ../src/guestfs.pod:11
47 " guestfs_h *g = guestfs_create ();\n"
48 " guestfs_add_drive (g, \"guest.img\");\n"
49 " guestfs_launch (g);\n"
50 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
51 " guestfs_touch (g, \"/hello\");\n"
52 " guestfs_umount (g, \"/\");\n"
53 " guestfs_close (g);\n"
58 #: ../src/guestfs.pod:19
61 " cc prog.c -o prog -lguestfs\n"
63 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
68 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl: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 pipe C<fd> by doing:"
748 #: ../src/guestfs.pod:359
752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
753 " guestfs_tar_out (g, \"/\", devfd);\n"
758 #: ../src/guestfs.pod:363
759 msgid "LISTING FILES"
763 #: ../src/guestfs.pod:365
765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
766 "L<guestfish(1)>-equivalent command C<ll>)."
770 #: ../src/guestfs.pod:368
772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
773 "programs, as a flat list of strings."
777 #: ../src/guestfs.pod:371
779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
780 "directory, plus additional information about each one. It is more "
781 "equivalent to using the L<readdir(3)> call on a local filesystem."
785 #: ../src/guestfs.pod:375
787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
792 #: ../src/guestfs.pod:378
793 msgid "RUNNING COMMANDS"
797 #: ../src/guestfs.pod:380
799 "Although libguestfs is primarily an API for manipulating files inside guest "
800 "images, we also provide some limited facilities for running commands inside "
805 #: ../src/guestfs.pod:384
806 msgid "There are many limitations to this:"
810 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1088 ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101 ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136 ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166 ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178 ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669 ../src/guestfs.pod:1770 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779 ../src/guestfs.pod:1789 ../src/guestfs.pod:2023 ../src/guestfs.pod:2028 ../src/guestfs.pod:2034 ../src/guestfs.pod:2042 ../src/guestfs.pod:2396 ../src/guestfs.pod:2402 ../src/guestfs.pod:2407 ../src/guestfs.pod:2413 ../src/guestfs.pod:2878 ../src/guestfs.pod:2882 ../src/guestfs.pod:2886 ../src/guestfs.pod:2890 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608 ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620 ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628 ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859 ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868 ../fish/guestfish.pod:443 ../fish/guestfish.pod:447 ../fish/guestfish.pod:451 ../fish/guestfish.pod:455 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351 ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361 ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412 ../src/guestfs.pod:2441
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:1285 ../src/guestfs.pod:1416 ../src/guestfs.pod:2466
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:1422
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:765
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 are outside the scope of libguestfs. You have to use "
1279 "libguestfs to read the appropriate Windows Registry and configuration files, "
1280 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1281 "L<virt-inspector(1)>)."
1285 #: ../src/guestfs.pod:649
1287 "Replacing backslash characters with forward slash characters is also outside "
1288 "the scope of libguestfs, but something that you can easily do."
1292 #: ../src/guestfs.pod:652
1294 "Where we can help is in resolving the case insensitivity of paths. For "
1295 "this, call L</guestfs_case_sensitive_path>."
1299 #: ../src/guestfs.pod:655
1300 msgid "ACCESSING THE WINDOWS REGISTRY"
1304 #: ../src/guestfs.pod:657
1306 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1307 "files, through the library C<hivex> which is part of the libguestfs project "
1308 "although ships as a separate tarball. You have to locate and download the "
1309 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1310 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1311 "L<virt-win-reg(1)> for more help on this issue."
1315 #: ../src/guestfs.pod:665
1316 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1320 #: ../src/guestfs.pod:667
1322 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1323 "provide something which looks like a Linux symlink. The way it tries to do "
1324 "the rewriting is described here:"
1328 #: ../src/guestfs.pod:671
1329 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1333 #: ../src/guestfs.pod:673
1335 "The essential problem is that ntfs-3g simply does not have enough "
1336 "information to do a correct job. NTFS links can contain drive letters and "
1337 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1338 "It is almost certainly the case that libguestfs callers should ignore what "
1339 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1343 #: ../src/guestfs.pod:680
1345 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1346 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1347 "attribute, and read the raw reparse data from that (you can find the format "
1348 "documented in various places around the web)."
1352 #: ../src/guestfs.pod:685
1353 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1357 #: ../src/guestfs.pod:687
1359 "There are other useful extended attributes that can be read from ntfs-3g "
1360 "filesystems (using L</guestfs_getxattr>). See:"
1364 #: ../src/guestfs.pod:690
1365 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1369 #: ../src/guestfs.pod:692
1370 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1374 #: ../src/guestfs.pod:694
1376 "Although we don't want to discourage you from using the C API, we will "
1377 "mention here that the same API is also available in other languages."
1381 #: ../src/guestfs.pod:697
1383 "The API is broadly identical in all supported languages. This means that "
1384 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1385 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1386 "OCaml. In other words, a straightforward, predictable isomorphism between "
1391 #: ../src/guestfs.pod:703
1393 "Error messages are automatically transformed into exceptions if the language "
1398 #: ../src/guestfs.pod:706
1400 "We don't try to \"object orientify\" parts of the API in OO languages, "
1401 "although contributors are welcome to write higher level APIs above what we "
1402 "provide in their favourite languages if they wish."
1406 #: ../src/guestfs.pod:712
1411 #: ../src/guestfs.pod:714
1413 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1414 "identical to the C API. C++ classes and exceptions are not used."
1418 #: ../src/guestfs.pod:718
1423 #: ../src/guestfs.pod:720
1425 "The C# bindings are highly experimental. Please read the warnings at the "
1426 "top of C<csharp/Libguestfs.cs>."
1430 #: ../src/guestfs.pod:723
1435 #: ../src/guestfs.pod:725
1437 "This is the only language binding that is working but incomplete. Only "
1438 "calls which return simple integers have been bound in Haskell, and we are "
1439 "looking for help to complete this binding."
1443 #: ../src/guestfs.pod:729
1448 #: ../src/guestfs.pod:731
1450 "Full documentation is contained in the Javadoc which is distributed with "
1455 #: ../src/guestfs.pod:734
1460 #: ../src/guestfs.pod:736
1461 msgid "See L<guestfs-ocaml(3)>."
1465 #: ../src/guestfs.pod:738
1470 #: ../src/guestfs.pod:740
1471 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1475 #: ../src/guestfs.pod:742
1480 #: ../src/guestfs.pod:744
1482 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1483 "the php-libguestfs package for your distribution."
1487 #: ../src/guestfs.pod:747
1488 msgid "The PHP binding only works correctly on 64 bit machines."
1492 #: ../src/guestfs.pod:749
1497 #: ../src/guestfs.pod:751
1498 msgid "See L<guestfs-python(3)>."
1502 #: ../src/guestfs.pod:753
1507 #: ../src/guestfs.pod:755
1508 msgid "See L<guestfs-ruby(3)>."
1512 #: ../src/guestfs.pod:757
1513 msgid "B<shell scripts>"
1517 #: ../src/guestfs.pod:759
1518 msgid "See L<guestfish(1)>."
1522 #: ../src/guestfs.pod:763
1523 msgid "LIBGUESTFS GOTCHAS"
1527 #: ../src/guestfs.pod:765
1529 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1530 "system [...] that works in the way it is documented but is counterintuitive "
1531 "and almost invites mistakes.\""
1535 #: ../src/guestfs.pod:769
1537 "Since we developed libguestfs and the associated tools, there are several "
1538 "things we would have designed differently, but are now stuck with for "
1539 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1540 "release, you can expect these to change. Beware of them."
1544 #: ../src/guestfs.pod:777
1545 msgid "Autosync / forgetting to sync."
1549 #: ../src/guestfs.pod:779
1551 "When modifying a filesystem from C or another language, you B<must> unmount "
1552 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1553 "libguestfs handle. You can also call:"
1557 #: ../src/guestfs.pod:783
1560 " guestfs_set_autosync (g, 1);\n"
1565 #: ../src/guestfs.pod:785
1567 "to have the unmount/sync done automatically for you when the handle 'g' is "
1568 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1573 #: ../src/guestfs.pod:789
1575 "If you forget to do this, then it is entirely possible that your changes "
1576 "won't be written out, or will be partially written, or (very rarely) that "
1577 "you'll get disk corruption."
1581 #: ../src/guestfs.pod:793
1583 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1584 "guestfish scripts that forget to sync will work just fine, which can make "
1585 "this very puzzling if you are trying to debug a problem."
1589 #: ../src/guestfs.pod:797
1591 "Update: Autosync is enabled by default for all API users starting from "
1592 "libguestfs 1.5.24."
1596 #: ../src/guestfs.pod:800
1597 msgid "Mount option C<-o sync> should not be the default."
1601 #: ../src/guestfs.pod:802
1603 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1604 "However C<-o sync> does not add any reliability benefit, but does have a "
1605 "very large performance impact."
1609 #: ../src/guestfs.pod:806
1611 "The work around is to use L</guestfs_mount_options> and set the mount "
1612 "options that you actually want to use."
1616 #: ../src/guestfs.pod:809
1617 msgid "Read-only should be the default."
1621 #: ../src/guestfs.pod:811
1623 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1624 "specify I<--rw> if you want to make changes to the image."
1628 #: ../src/guestfs.pod:814
1629 msgid "This would reduce the potential to corrupt live VM images."
1633 #: ../src/guestfs.pod:816
1635 "Note that many filesystems change the disk when you just mount and unmount, "
1636 "even if you didn't perform any writes. You need to use "
1637 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1641 #: ../src/guestfs.pod:820
1642 msgid "guestfish command line is hard to use."
1646 #: ../src/guestfs.pod:822
1648 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1649 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1650 "exist, so it fails. In earlier versions of guestfish the error message was "
1651 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1652 "we should have used C<guestfish -c command> to run commands."
1656 #: ../src/guestfs.pod:829
1657 msgid "guestfish megabyte modifiers don't work right on all commands"
1661 #: ../src/guestfs.pod:831
1663 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1664 "other modifiers). What guestfish actually does is to multiply the number "
1665 "part by the modifier part and pass the result to the C API. However this "
1666 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1667 "expecting some other unit (eg. megabytes)."
1671 #: ../src/guestfs.pod:838
1672 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1676 #: ../src/guestfs.pod:840
1679 " lvcreate LV VG 100M\n"
1684 #: ../src/guestfs.pod:842
1686 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1687 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1688 "megabytes * megabytes) logical volume. The error message you get from this "
1689 "is also a little obscure."
1693 #: ../src/guestfs.pod:847
1695 "This could be fixed in the generator by specially marking parameters and "
1696 "return values which take bytes or other units."
1700 #: ../src/guestfs.pod:850
1701 msgid "Ambiguity between devices and paths"
1705 #: ../src/guestfs.pod:852
1707 "There is a subtle ambiguity in the API between a device name "
1708 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1709 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1713 #: ../src/guestfs.pod:857
1715 "In the current API we usually resolve this ambiguity by having two separate "
1716 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1717 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1718 "detecting if the path supplied begins with C</dev/>."
1722 #: ../src/guestfs.pod:863
1724 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1725 "make paths/devices into structured names. One way to do this would be to "
1726 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1727 "aspect of grub. Another way would be to use a structured type, equivalent "
1728 "to this OCaml type:"
1732 #: ../src/guestfs.pod:869
1735 " type path = Path of string | Device of int | Partition of int * int\n"
1740 #: ../src/guestfs.pod:871
1741 msgid "which would allow you to pass arguments like:"
1745 #: ../src/guestfs.pod:873
1748 " Path \"/foo/bar\"\n"
1749 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1750 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1751 " Path \"/dev/sdb2\" (* not a device *)\n"
1756 #: ../src/guestfs.pod:878
1758 "As you can see there are still problems to resolve even with this "
1759 "representation. Also consider how it might work in guestfish."
1763 #: ../src/guestfs.pod:883
1764 msgid "PROTOCOL LIMITS"
1768 #: ../src/guestfs.pod:885
1770 "Internally libguestfs uses a message-based protocol to pass API calls and "
1771 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1772 "plenty more detail about this). The maximum message size used by the "
1773 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1774 "aware of this limit. The API calls which may be affected are individually "
1775 "documented, with a link back to this section of the documentation."
1779 #: ../src/guestfs.pod:893
1781 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1782 "a simple string. Because this string is at some point internally encoded as "
1783 "a message, the maximum size that it can return is slightly under 4 MB. If "
1784 "the requested file is larger than this then you will get an error."
1788 #: ../src/guestfs.pod:899
1790 "In order to transfer large files into and out of the guest filesystem, you "
1791 "need to use particular calls that support this. The sections L</UPLOADING> "
1792 "and L</DOWNLOADING> document how to do this."
1796 #: ../src/guestfs.pod:903
1798 "You might also consider mounting the disk image using our FUSE filesystem "
1799 "support (L<guestmount(1)>)."
1803 #: ../src/guestfs.pod:906
1804 msgid "KEYS AND PASSPHRASES"
1808 #: ../src/guestfs.pod:908
1810 "Certain libguestfs calls take a parameter that contains sensitive key "
1811 "material, passed in as a C string."
1815 #: ../src/guestfs.pod:911
1817 "In the future we would hope to change the libguestfs implementation so that "
1818 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1819 "swap. However this is I<not> done at the moment, because of the complexity "
1820 "of such an implementation."
1824 #: ../src/guestfs.pod:916
1826 "Therefore you should be aware that any key parameter you pass to libguestfs "
1827 "might end up being written out to the swap partition. If this is a concern, "
1828 "scrub the swap partition or don't use libguestfs on encrypted devices."
1832 #: ../src/guestfs.pod:921
1833 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1837 #: ../src/guestfs.pod:923
1839 "All high-level libguestfs actions are synchronous. If you want to use "
1840 "libguestfs asynchronously then you must create a thread."
1844 #: ../src/guestfs.pod:926
1846 "Only use the handle from a single thread. Either use the handle exclusively "
1847 "from one thread, or provide your own mutex so that two threads cannot issue "
1848 "calls on the same handle at the same time."
1852 #: ../src/guestfs.pod:930
1854 "See the graphical program guestfs-browser for one possible architecture for "
1855 "multithreaded programs using libvirt and libguestfs."
1859 #: ../src/guestfs.pod:933
1864 #: ../src/guestfs.pod:935
1866 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1871 #: ../src/guestfs.pod:938
1873 "By default it looks for these in the directory C<$libdir/guestfs> "
1874 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1878 #: ../src/guestfs.pod:941
1880 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1881 "to change the directories that libguestfs will search in. The value is a "
1882 "colon-separated list of paths. The current directory is I<not> searched "
1883 "unless the path contains an empty element or C<.>. For example "
1884 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1885 "then C</usr/lib/guestfs>."
1889 #: ../src/guestfs.pod:948
1890 msgid "QEMU WRAPPERS"
1894 #: ../src/guestfs.pod:950
1896 "If you want to compile your own qemu, run qemu from a non-standard location, "
1897 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1902 #: ../src/guestfs.pod:954
1904 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1905 "last command in the shell script (so that qemu replaces the shell and "
1906 "becomes the direct child of the libguestfs-using program). If you don't do "
1907 "this, then the qemu process won't be cleaned up correctly."
1911 #: ../src/guestfs.pod:959
1913 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1918 #: ../src/guestfs.pod:962
1922 " qemudir=/home/rjones/d/qemu\n"
1923 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1929 #: ../src/guestfs.pod:966
1931 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1932 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1937 #: ../src/guestfs.pod:970
1940 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1945 #: ../src/guestfs.pod:972
1947 "Note that libguestfs also calls qemu with the -help and -version options in "
1948 "order to determine features."
1952 #: ../src/guestfs.pod:975
1953 msgid "ATTACHING TO RUNNING DAEMONS"
1957 #: ../src/guestfs.pod:977
1959 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
1960 "babies. Use with caution."
1964 #: ../src/guestfs.pod:980
1966 "I<Note (2):> This section explains how to attach to a running daemon from a "
1967 "low level perspective. For most users, simply using virt tools such as "
1968 "L<guestfish(1)> with the I<--live> option will \"just work\"."
1972 #: ../src/guestfs.pod:984
1973 msgid "Using guestfs_set_attach_method"
1977 #: ../src/guestfs.pod:986
1979 "By calling L</guestfs_set_attach_method> you can change how the library "
1980 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
1981 "L</ARCHITECTURE> for some background)."
1985 #: ../src/guestfs.pod:990
1987 "The normal attach method is C<appliance>, where a small appliance is created "
1988 "containing the daemon, and then the library connects to this."
1992 #: ../src/guestfs.pod:993
1994 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
1995 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
1996 "daemon over the Unix domain socket."
2000 #: ../src/guestfs.pod:997
2002 "The normal use for this is to connect to a running virtual machine that "
2003 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2004 "files inside the live virtual machine."
2008 #: ../src/guestfs.pod:1001
2009 msgid "Using guestfs_add_domain with live flag"
2013 #: ../src/guestfs.pod:1003
2015 "L</guestfs_add_domain> provides some help for getting the correct attach "
2016 "method. If you pass the C<live> option to this function, then (if the "
2017 "virtual machine is running) it will examine the libvirt XML looking for a "
2018 "virtio-serial channel to connect to:"
2022 #: ../src/guestfs.pod:1009
2029 " <channel type='unix'>\n"
2030 " <source mode='bind' path='/path/to/socket'/>\n"
2031 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2040 #: ../src/guestfs.pod:1021
2042 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2043 "method to C<unix:/path/to/socket>."
2047 #: ../src/guestfs.pod:1024
2049 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2050 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2051 "to attach to and modify live virtual machines."
2055 #: ../src/guestfs.pod:1028
2057 "The virtual machine needs to have been set up beforehand so that it has the "
2058 "virtio-serial channel and so that guestfsd is running inside it."
2062 #: ../src/guestfs.pod:1032
2063 msgid "ABI GUARANTEE"
2067 #: ../src/guestfs.pod:1034
2069 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2070 "actions as outlined in this section. Although we will deprecate some "
2071 "actions, for example if they get replaced by newer calls, we will keep the "
2072 "old actions forever. This allows you the developer to program in confidence "
2073 "against the libguestfs API."
2077 #: ../src/guestfs.pod:1040
2078 msgid "BLOCK DEVICE NAMING"
2082 #: ../src/guestfs.pod:1042
2084 "In the kernel there is now quite a profusion of schemata for naming block "
2085 "devices (in this context, by I<block device> I mean a physical or virtual "
2086 "hard drive). The original Linux IDE driver used names starting with "
2087 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
2088 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2089 "replacement for the old IDE driver (particularly for SATA devices) those "
2090 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2091 "machines with paravirtualized drivers. This has created several different "
2092 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2097 #: ../src/guestfs.pod:1054
2099 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2100 "Linux kernel to access block devices. We can run a variety of appliances "
2101 "based on a variety of Linux kernels."
2105 #: ../src/guestfs.pod:1058
2107 "This causes a problem for libguestfs because many API calls use device or "
2108 "partition names. Working scripts and the recipe (example) scripts that we "
2109 "make available over the internet could fail if the naming scheme changes."
2113 #: ../src/guestfs.pod:1063
2115 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2116 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2117 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2118 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2122 #: ../src/guestfs.pod:1069
2124 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2125 "L</guestfs_list_partitions> and similar calls return the true names of the "
2126 "devices and partitions as known to the appliance."
2130 #: ../src/guestfs.pod:1074
2131 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2135 #: ../src/guestfs.pod:1076
2137 "Usually this translation is transparent. However in some (very rare) cases "
2138 "you may need to know the exact algorithm. Such cases include where you use "
2139 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2140 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2145 #: ../src/guestfs.pod:1082
2147 "The algorithm is applied only to I<parameters> which are known to be either "
2148 "device or partition names. Return values from functions such as "
2149 "L</guestfs_list_devices> are never changed."
2153 #: ../src/guestfs.pod:1090
2154 msgid "Is the string a parameter which is a device or partition name?"
2158 #: ../src/guestfs.pod:1094
2159 msgid "Does the string begin with C</dev/sd>?"
2163 #: ../src/guestfs.pod:1098
2165 "Does the named device exist? If so, we use that device. However if I<not> "
2166 "then we continue with this algorithm."
2170 #: ../src/guestfs.pod:1103
2171 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2175 #: ../src/guestfs.pod:1105
2176 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2180 #: ../src/guestfs.pod:1107
2181 msgid "If that named device exists, use it. If not, continue."
2185 #: ../src/guestfs.pod:1111
2186 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2190 #: ../src/guestfs.pod:1113
2191 msgid "If that named device exists, use it. If not, return an error."
2195 #: ../src/guestfs.pod:1117
2196 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2200 #: ../src/guestfs.pod:1119
2202 "Although the standard naming scheme and automatic translation is useful for "
2203 "simple programs and guestfish scripts, for larger programs it is best not to "
2204 "rely on this mechanism."
2208 #: ../src/guestfs.pod:1123
2210 "Where possible for maximum future portability programs using libguestfs "
2211 "should use these future-proof techniques:"
2215 #: ../src/guestfs.pod:1130
2217 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2218 "device names, and then use those names directly."
2222 #: ../src/guestfs.pod:1133
2223 msgid "Since those device names exist by definition, they will never be translated."
2227 #: ../src/guestfs.pod:1138
2229 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2230 "filesystem labels."
2234 #: ../src/guestfs.pod:1143
2239 #: ../src/guestfs.pod:1145
2241 "This section discusses security implications of using libguestfs, "
2242 "particularly with untrusted or malicious guests or disk images."
2246 #: ../src/guestfs.pod:1148
2247 msgid "GENERAL SECURITY CONSIDERATIONS"
2251 #: ../src/guestfs.pod:1150
2253 "Be careful with any files or data that you download from a guest (by "
2254 "\"download\" we mean not just the L</guestfs_download> command but any "
2255 "command that reads files, filenames, directories or anything else from a "
2256 "disk image). An attacker could manipulate the data to fool your program "
2257 "into doing the wrong thing. Consider cases such as:"
2261 #: ../src/guestfs.pod:1160
2262 msgid "the data (file etc) not being present"
2266 #: ../src/guestfs.pod:1164
2267 msgid "being present but empty"
2271 #: ../src/guestfs.pod:1168
2272 msgid "being much larger than normal"
2276 #: ../src/guestfs.pod:1172
2277 msgid "containing arbitrary 8 bit data"
2281 #: ../src/guestfs.pod:1176
2282 msgid "being in an unexpected character encoding"
2286 #: ../src/guestfs.pod:1180
2287 msgid "containing homoglyphs."
2291 #: ../src/guestfs.pod:1184
2292 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2296 #: ../src/guestfs.pod:1186
2298 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2299 "(VFS) module can sometimes be escalated into exploits by deliberately "
2300 "creating a malicious, malformed filesystem. These exploits are very severe "
2301 "for two reasons. Firstly there are very many filesystem drivers in the "
2302 "kernel, and many of them are infrequently used and not much developer "
2303 "attention has been paid to the code. Linux userspace helps potential "
2304 "crackers by detecting the filesystem type and automatically choosing the "
2305 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2306 "the administrator. Secondly, a kernel-level exploit is like a local root "
2307 "exploit (worse in some ways), giving immediate and total access to the "
2308 "system right down to the hardware level."
2312 #: ../src/guestfs.pod:1199
2314 "That explains why you should never mount a filesystem from an untrusted "
2315 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2316 "inside a qemu virtual machine, usually running as a non-root user. The "
2317 "attacker would need to write a filesystem which first exploited the kernel, "
2318 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2319 "the libguestfs protocol, and finally to be as serious as the host kernel "
2320 "exploit it would need to escalate its privileges to root. This multi-step "
2321 "escalation, performed by a static piece of data, is thought to be extremely "
2322 "hard to do, although we never say 'never' about security issues."
2326 #: ../src/guestfs.pod:1210
2328 "In any case callers can reduce the attack surface by forcing the filesystem "
2329 "type when mounting (use L</guestfs_mount_vfs>)."
2333 #: ../src/guestfs.pod:1213
2334 msgid "PROTOCOL SECURITY"
2338 #: ../src/guestfs.pod:1215
2340 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2341 "defined upper message size. However a program that uses libguestfs must "
2342 "also take care - for example you can write a program that downloads a binary "
2343 "from a disk image and executes it locally, and no amount of protocol "
2344 "security will save you from the consequences."
2348 #: ../src/guestfs.pod:1221
2349 msgid "INSPECTION SECURITY"
2353 #: ../src/guestfs.pod:1223
2355 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2356 "directly from the guest, and these could contain any 8 bit data. Callers "
2357 "should be careful to escape these before printing them to a structured file "
2358 "(for example, use HTML escaping if creating a web page)."
2362 #: ../src/guestfs.pod:1229
2364 "Guest configuration may be altered in unusual ways by the administrator of "
2365 "the virtual machine, and may not reflect reality (particularly for untrusted "
2366 "or actively malicious guests). For example we parse the hostname from "
2367 "configuration files like C</etc/sysconfig/network> that we find in the "
2368 "guest, but the guest administrator can easily manipulate these files to "
2369 "provide the wrong hostname."
2373 #: ../src/guestfs.pod:1237
2375 "The inspection API parses guest configuration using two external libraries: "
2376 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2377 "designed to be robust in the face of malicious data, although denial of "
2378 "service attacks are still possible, for example with oversized configuration "
2383 #: ../src/guestfs.pod:1243
2384 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2388 #: ../src/guestfs.pod:1245
2390 "Be very cautious about running commands from the guest. By running a "
2391 "command in the guest, you are giving CPU time to a binary that you do not "
2392 "control, under the same user account as the library, albeit wrapped in qemu "
2393 "virtualization. More information and alternatives can be found in the "
2394 "section L</RUNNING COMMANDS>."
2398 #: ../src/guestfs.pod:1251
2399 msgid "CVE-2010-3851"
2403 #: ../src/guestfs.pod:1253
2404 msgid "https://bugzilla.redhat.com/642934"
2408 #: ../src/guestfs.pod:1255
2410 "This security bug concerns the automatic disk format detection that qemu "
2411 "does on disk images."
2415 #: ../src/guestfs.pod:1258
2417 "A raw disk image is just the raw bytes, there is no header. Other disk "
2418 "images like qcow2 contain a special header. Qemu deals with this by looking "
2419 "for one of the known headers, and if none is found then assuming the disk "
2420 "image must be raw."
2424 #: ../src/guestfs.pod:1263
2426 "This allows a guest which has been given a raw disk image to write some "
2427 "other header. At next boot (or when the disk image is accessed by "
2428 "libguestfs) qemu would do autodetection and think the disk image format was, "
2429 "say, qcow2 based on the header written by the guest."
2433 #: ../src/guestfs.pod:1268
2435 "This in itself would not be a problem, but qcow2 offers many features, one "
2436 "of which is to allow a disk image to refer to another image (called the "
2437 "\"backing disk\"). It does this by placing the path to the backing disk "
2438 "into the qcow2 header. This path is not validated and could point to any "
2439 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2440 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2441 "control of the attacker."
2445 #: ../src/guestfs.pod:1276
2446 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2450 #: ../src/guestfs.pod:1283
2451 msgid "You have enabled the network or have opened the disk in write mode."
2455 #: ../src/guestfs.pod:1287
2457 "You are also running untrusted code from the guest (see L</RUNNING "
2462 #: ../src/guestfs.pod:1292
2464 "The way to avoid this is to specify the expected disk format when adding "
2465 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2466 "should always do this if the disk is raw format, and it's a good idea for "
2471 #: ../src/guestfs.pod:1297
2473 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2474 "format is fetched from libvirt and passed through."
2478 #: ../src/guestfs.pod:1300
2480 "For libguestfs tools, use the I<--format> command line parameter as "
2485 #: ../src/guestfs.pod:1303
2486 msgid "CONNECTION MANAGEMENT"
2490 #: ../src/guestfs.pod:1305
2495 #: ../src/guestfs.pod:1307
2497 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2498 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2499 "handle and release all resources used."
2503 #: ../src/guestfs.pod:1311
2505 "For information on using multiple handles and threads, see the section "
2506 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2510 #: ../src/guestfs.pod:1314
2511 msgid "guestfs_create"
2515 #: ../src/guestfs.pod:1316
2518 " guestfs_h *guestfs_create (void);\n"
2523 #: ../src/guestfs.pod:1318
2524 msgid "Create a connection handle."
2528 #: ../src/guestfs.pod:1320
2530 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2531 "on the handle at least once."
2535 #: ../src/guestfs.pod:1323
2537 "This function returns a non-NULL pointer to a handle on success or NULL on "
2542 #: ../src/guestfs.pod:1326
2543 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2547 #: ../src/guestfs.pod:1328
2549 "You may also want to configure error handling for the handle. See L</ERROR "
2550 "HANDLING> section below."
2554 #: ../src/guestfs.pod:1331
2555 msgid "guestfs_close"
2559 #: ../src/guestfs.pod:1333
2562 " void guestfs_close (guestfs_h *g);\n"
2567 #: ../src/guestfs.pod:1335
2568 msgid "This closes the connection handle and frees up all resources used."
2572 #: ../src/guestfs.pod:1337
2573 msgid "ERROR HANDLING"
2577 #: ../src/guestfs.pod:1339
2579 "API functions can return errors. For example, almost all functions that "
2580 "return C<int> will return C<-1> to indicate an error."
2584 #: ../src/guestfs.pod:1342
2586 "Additional information is available for errors: an error message string and "
2587 "optionally an error number (errno) if the thing that failed was a system "
2592 #: ../src/guestfs.pod:1346
2594 "You can get at the additional information about the last error on the handle "
2595 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2596 "up an error handler with L</guestfs_set_error_handler>."
2600 #: ../src/guestfs.pod:1351
2602 "When the handle is created, a default error handler is installed which "
2603 "prints the error message string to C<stderr>. For small short-running "
2604 "command line programs it is sufficient to do:"
2608 #: ../src/guestfs.pod:1355
2611 " if (guestfs_launch (g) == -1)\n"
2612 " exit (EXIT_FAILURE);\n"
2617 #: ../src/guestfs.pod:1358
2619 "since the default error handler will ensure that an error message has been "
2620 "printed to C<stderr> before the program exits."
2624 #: ../src/guestfs.pod:1361
2626 "For other programs the caller will almost certainly want to install an "
2627 "alternate error handler or do error handling in-line like this:"
2631 #: ../src/guestfs.pod:1364
2634 " g = guestfs_create ();\n"
2639 #: ../src/guestfs.pod:1366
2642 " /* This disables the default behaviour of printing errors\n"
2644 " guestfs_set_error_handler (g, NULL, NULL);\n"
2649 #: ../src/guestfs.pod:1370
2652 " if (guestfs_launch (g) == -1) {\n"
2653 " /* Examine the error message and print it etc. */\n"
2654 " char *msg = guestfs_last_error (g);\n"
2655 " int errnum = guestfs_last_errno (g);\n"
2656 " fprintf (stderr, \"%s\\n\", msg);\n"
2663 #: ../src/guestfs.pod:1378
2665 "Out of memory errors are handled differently. The default action is to call "
2666 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2667 "L</guestfs_set_out_of_memory_handler>."
2671 #: ../src/guestfs.pod:1382
2673 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2674 "because there is no handle if this happens there is no way to get additional "
2675 "error information. However L</guestfs_create> is supposed to be a "
2676 "lightweight operation which can only fail because of insufficient memory (it "
2677 "returns NULL in this case)."
2681 #: ../src/guestfs.pod:1388
2682 msgid "guestfs_last_error"
2686 #: ../src/guestfs.pod:1390
2689 " const char *guestfs_last_error (guestfs_h *g);\n"
2694 #: ../src/guestfs.pod:1392
2696 "This returns the last error message that happened on C<g>. If there has not "
2697 "been an error since the handle was created, then this returns C<NULL>."
2701 #: ../src/guestfs.pod:1396
2703 "The lifetime of the returned string is until the next error occurs, or "
2704 "L</guestfs_close> is called."
2708 #: ../src/guestfs.pod:1399
2709 msgid "guestfs_last_errno"
2713 #: ../src/guestfs.pod:1401
2716 " int guestfs_last_errno (guestfs_h *g);\n"
2721 #: ../src/guestfs.pod:1403
2722 msgid "This returns the last error number (errno) that happened on C<g>."
2726 #: ../src/guestfs.pod:1405
2727 msgid "If successful, an errno integer not equal to zero is returned."
2731 #: ../src/guestfs.pod:1407
2732 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2736 #: ../src/guestfs.pod:1414
2737 msgid "There has not been any error on the handle."
2741 #: ../src/guestfs.pod:1418
2743 "There has been an error but the errno was meaningless. This corresponds to "
2744 "the case where the error did not come from a failed system call, but for "
2745 "some other reason."
2749 #: ../src/guestfs.pod:1424
2751 "There was an error from a failed system call, but for some reason the errno "
2752 "was not captured and returned. This usually indicates a bug in libguestfs."
2756 #: ../src/guestfs.pod:1430
2758 "Libguestfs tries to convert the errno from inside the applicance into a "
2759 "corresponding errno for the caller (not entirely trivial: the appliance "
2760 "might be running a completely different operating system from the library "
2761 "and error numbers are not standardized across Un*xen). If this could not be "
2762 "done, then the error is translated to C<EINVAL>. In practice this should "
2763 "only happen in very rare circumstances."
2767 #: ../src/guestfs.pod:1438
2768 msgid "guestfs_set_error_handler"
2772 #: ../src/guestfs.pod:1440
2775 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2777 " const char *msg);\n"
2778 " void guestfs_set_error_handler (guestfs_h *g,\n"
2779 " guestfs_error_handler_cb cb,\n"
2785 #: ../src/guestfs.pod:1447
2787 "The callback C<cb> will be called if there is an error. The parameters "
2788 "passed to the callback are an opaque data pointer and the error message "
2793 #: ../src/guestfs.pod:1451
2795 "C<errno> is not passed to the callback. To get that the callback must call "
2796 "L</guestfs_last_errno>."
2800 #: ../src/guestfs.pod:1454
2802 "Note that the message string C<msg> is freed as soon as the callback "
2803 "function returns, so if you want to stash it somewhere you must make your "
2808 #: ../src/guestfs.pod:1458
2809 msgid "The default handler prints messages on C<stderr>."
2813 #: ../src/guestfs.pod:1460
2814 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2818 #: ../src/guestfs.pod:1462
2819 msgid "guestfs_get_error_handler"
2823 #: ../src/guestfs.pod:1464
2826 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2827 " void **opaque_rtn);\n"
2832 #: ../src/guestfs.pod:1467
2833 msgid "Returns the current error handler callback."
2837 #: ../src/guestfs.pod:1469
2838 msgid "guestfs_set_out_of_memory_handler"
2842 #: ../src/guestfs.pod:1471
2845 " typedef void (*guestfs_abort_cb) (void);\n"
2846 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2847 " guestfs_abort_cb);\n"
2852 #: ../src/guestfs.pod:1475
2854 "The callback C<cb> will be called if there is an out of memory situation. "
2855 "I<Note this callback must not return>."
2859 #: ../src/guestfs.pod:1478
2860 msgid "The default is to call L<abort(3)>."
2864 #: ../src/guestfs.pod:1480
2865 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2869 #: ../src/guestfs.pod:1483
2870 msgid "guestfs_get_out_of_memory_handler"
2874 #: ../src/guestfs.pod:1485
2877 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2882 #: ../src/guestfs.pod:1487
2883 msgid "This returns the current out of memory handler."
2887 #: ../src/guestfs.pod:1489
2892 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:1003
2897 #: ../src/guestfs.pod:1493
2902 #: ../src/guestfs.pod:1495
2907 #: ../src/guestfs.pod:1497
2908 msgid "AVAILABILITY"
2912 #: ../src/guestfs.pod:1499
2913 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2917 #: ../src/guestfs.pod:1501
2919 "Using L</guestfs_available> you can test availability of the following "
2920 "groups of functions. This test queries the appliance to see if the "
2921 "appliance you are currently using supports the functionality."
2925 #: ../src/guestfs.pod:1506
2926 msgid "@AVAILABILITY@"
2930 #: ../src/guestfs.pod:1508
2931 msgid "GUESTFISH supported COMMAND"
2935 #: ../src/guestfs.pod:1510
2937 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2938 "prints out the available groups and whether they are supported by this build "
2939 "of libguestfs. Note however that you have to do C<run> first."
2943 #: ../src/guestfs.pod:1515
2944 msgid "SINGLE CALLS AT COMPILE TIME"
2948 #: ../src/guestfs.pod:1517
2950 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2951 "function, such as:"
2955 #: ../src/guestfs.pod:1520
2958 " #define LIBGUESTFS_HAVE_DD 1\n"
2963 #: ../src/guestfs.pod:1522
2964 msgid "if L</guestfs_dd> is available."
2968 #: ../src/guestfs.pod:1524
2970 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2971 "function is available at compile time, we recommended using build tools such "
2972 "as autoconf or cmake. For example in autotools you could use:"
2976 #: ../src/guestfs.pod:1529
2979 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2980 " AC_CHECK_FUNCS([guestfs_dd])\n"
2985 #: ../src/guestfs.pod:1532
2987 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2992 #: ../src/guestfs.pod:1535
2993 msgid "SINGLE CALLS AT RUN TIME"
2997 #: ../src/guestfs.pod:1537
2999 "Testing at compile time doesn't guarantee that a function really exists in "
3000 "the library. The reason is that you might be dynamically linked against a "
3001 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3002 "This situation unfortunately results in a segmentation fault, which is a "
3003 "shortcoming of the C dynamic linking system itself."
3007 #: ../src/guestfs.pod:1544
3009 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3010 "in this example program (note that you still need the compile time check as "
3015 #: ../src/guestfs.pod:1548
3018 " #include <stdio.h>\n"
3019 " #include <stdlib.h>\n"
3020 " #include <unistd.h>\n"
3021 " #include <dlfcn.h>\n"
3022 " #include <guestfs.h>\n"
3027 #: ../src/guestfs.pod:1554
3032 " #ifdef LIBGUESTFS_HAVE_DD\n"
3034 " int has_function;\n"
3039 #: ../src/guestfs.pod:1560
3042 " /* Test if the function guestfs_dd is really available. */\n"
3043 " dl = dlopen (NULL, RTLD_LAZY);\n"
3045 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3046 " exit (EXIT_FAILURE);\n"
3048 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3054 #: ../src/guestfs.pod:1569
3057 " if (!has_function)\n"
3058 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3060 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3061 " /* Now it's safe to call\n"
3062 " guestfs_dd (g, \"foo\", \"bar\");\n"
3066 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3073 #: ../src/guestfs.pod:1582
3075 "You may think the above is an awful lot of hassle, and it is. There are "
3076 "other ways outside of the C linking system to ensure that this kind of "
3077 "incompatibility never arises, such as using package versioning:"
3081 #: ../src/guestfs.pod:1587
3084 " Requires: libguestfs >= 1.0.80\n"
3089 #: ../src/guestfs.pod:1589
3090 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3094 #: ../src/guestfs.pod:1591
3096 "A recent feature of the API is the introduction of calls which take optional "
3097 "arguments. In C these are declared 3 ways. The main way is as a call which "
3098 "takes variable arguments (ie. C<...>), as in this example:"
3102 #: ../src/guestfs.pod:1596
3105 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3110 #: ../src/guestfs.pod:1598
3112 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3113 "call with no optional arguments specified:"
3117 #: ../src/guestfs.pod:1601
3120 " guestfs_add_drive_opts (g, filename, -1);\n"
3125 #: ../src/guestfs.pod:1603
3126 msgid "With a single optional argument:"
3130 #: ../src/guestfs.pod:1605
3133 " guestfs_add_drive_opts (g, filename,\n"
3134 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3140 #: ../src/guestfs.pod:1609
3145 #: ../src/guestfs.pod:1611
3148 " guestfs_add_drive_opts (g, filename,\n"
3149 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3150 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3156 #: ../src/guestfs.pod:1616
3158 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3163 #: ../src/guestfs.pod:1619
3164 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3168 #: ../src/guestfs.pod:1621
3170 "The second variant has the same name with the suffix C<_va>, which works the "
3171 "same way but takes a C<va_list>. See the C manual for details. For the "
3172 "example function, this is declared:"
3176 #: ../src/guestfs.pod:1625
3179 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3185 #: ../src/guestfs.pod:1628
3186 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3190 #: ../src/guestfs.pod:1630
3192 "The third variant is useful where you need to construct these calls. You "
3193 "pass in a structure where you fill in the optional fields. The structure "
3194 "has a bitmask as the first element which you must set to indicate which "
3195 "fields you have filled in. For our example function the structure and call "
3200 #: ../src/guestfs.pod:1636
3203 " struct guestfs_add_drive_opts_argv {\n"
3204 " uint64_t bitmask;\n"
3206 " const char *format;\n"
3209 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3210 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3215 #: ../src/guestfs.pod:1645
3216 msgid "You could call it like this:"
3220 #: ../src/guestfs.pod:1647
3223 " struct guestfs_add_drive_opts_argv optargs = {\n"
3224 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3225 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3227 " .format = \"qcow2\"\n"
3233 #: ../src/guestfs.pod:1654
3236 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3241 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3246 #: ../src/guestfs.pod:1662
3247 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3251 #: ../src/guestfs.pod:1667
3252 msgid "You do not need to fill in all fields of the structure."
3256 #: ../src/guestfs.pod:1671
3258 "There must be a one-to-one correspondence between fields of the structure "
3259 "that are filled in, and bits set in the bitmask."
3263 #: ../src/guestfs.pod:1676
3264 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3268 #: ../src/guestfs.pod:1678
3270 "In other languages, optional arguments are expressed in the way that is "
3271 "natural for that language. We refer you to the language-specific "
3272 "documentation for more details on that."
3276 #: ../src/guestfs.pod:1682
3277 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3281 #: ../src/guestfs.pod:1684
3282 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3286 #: ../src/guestfs.pod:1686
3288 "B<Note:> This section documents the generic event mechanism introduced in "
3289 "libguestfs 1.10, which you should use in new code if possible. The old "
3290 "functions C<guestfs_set_log_message_callback>, "
3291 "C<guestfs_set_subprocess_quit_callback>, "
3292 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3293 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3298 #: ../src/guestfs.pod:1694
3300 "Handles generate events when certain things happen, such as log messages "
3301 "being generated, progress messages during long-running operations, or the "
3302 "handle being closed. The API calls described below let you register a "
3303 "callback to be called when events happen. You can register multiple "
3304 "callbacks (for the same, different or overlapping sets of events), and "
3305 "individually remove callbacks. If callbacks are not removed, then they "
3306 "remain in force until the handle is closed."
3310 #: ../src/guestfs.pod:1702
3312 "In the current implementation, events are only generated synchronously: that "
3313 "means that events (and hence callbacks) can only happen while you are in the "
3314 "middle of making another libguestfs call. The callback is called in the "
3319 #: ../src/guestfs.pod:1707
3321 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3322 "unsigned integers, or a message buffer. Payloads are discussed later on."
3326 #: ../src/guestfs.pod:1711
3327 msgid "CLASSES OF EVENTS"
3331 #: ../src/guestfs.pod:1715
3332 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3336 #: ../src/guestfs.pod:1718
3338 "The callback function will be called while the handle is being closed "
3339 "(synchronously from L</guestfs_close>)."
3343 #: ../src/guestfs.pod:1721
3345 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3346 "handles that are open when the program exits. This means that this callback "
3347 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3348 "problems in higher-level languages (eg. if your HLL interpreter has already "
3349 "been cleaned up by the time this is called, and if your callback then jumps "
3350 "into some HLL function)."
3354 #: ../src/guestfs.pod:1728
3356 "If no callback is registered: the handle is closed without any callback "
3361 #: ../src/guestfs.pod:1731
3362 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3366 #: ../src/guestfs.pod:1734
3368 "The callback function will be called when the child process quits, either "
3369 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3370 "corresponds to a transition from any state to the CONFIG state)."
3374 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3375 msgid "If no callback is registered: the event is ignored."
3379 #: ../src/guestfs.pod:1740
3380 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3384 #: ../src/guestfs.pod:1743
3386 "The callback function will be called when the child process becomes ready "
3387 "first time after it has been launched. (This corresponds to a transition "
3388 "from LAUNCHING to the READY state)."
3392 #: ../src/guestfs.pod:1749
3393 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3397 #: ../src/guestfs.pod:1752
3399 "Some long-running operations can generate progress messages. If this "
3400 "callback is registered, then it will be called each time a progress message "
3401 "is generated (usually two seconds after the operation started, and three "
3402 "times per second thereafter until it completes, although the frequency may "
3403 "change in future versions)."
3407 #: ../src/guestfs.pod:1758
3409 "The callback receives in the payload four unsigned 64 bit numbers which are "
3410 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3414 #: ../src/guestfs.pod:1761
3416 "The units of C<total> are not defined, although for some operations C<total> "
3417 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3418 "or megabytes), and C<position> may be the portion which has been "
3423 #: ../src/guestfs.pod:1766
3424 msgid "The only defined and stable parts of the API are:"
3428 #: ../src/guestfs.pod:1772
3430 "The callback can display to the user some type of progress bar or indicator "
3431 "which shows the ratio of C<position>:C<total>."
3435 #: ../src/guestfs.pod:1777
3436 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3440 #: ../src/guestfs.pod:1781
3442 "If any progress notification is sent during a call, then a final progress "
3443 "notification is always sent when C<position> = C<total> (I<unless> the call "
3444 "fails with an error)."
3448 #: ../src/guestfs.pod:1785
3450 "This is to simplify caller code, so callers can easily set the progress "
3451 "indicator to \"100%\" at the end of the operation, without requiring special "
3452 "code to detect this case."
3456 #: ../src/guestfs.pod:1791
3458 "For some calls we are unable to estimate the progress of the call, but we "
3459 "can still generate progress messages to indicate activity. This is known as "
3460 "\"pulse mode\", and is directly supported by certain progress bar "
3461 "implementations (eg. GtkProgressBar)."
3465 #: ../src/guestfs.pod:1796
3467 "For these calls, zero or more progress messages are generated with "
3468 "C<position = 0> and C<total = 1>, followed by a final message with "
3469 "C<position = total = 1>."
3473 #: ../src/guestfs.pod:1800
3475 "As noted above, if the call fails with an error then the final message may "
3480 #: ../src/guestfs.pod:1805
3482 "The callback also receives the procedure number (C<proc_nr>) and serial "
3483 "number (C<serial>) of the call. These are only useful for debugging "
3484 "protocol issues, and the callback can normally ignore them. The callback "
3485 "may want to print these numbers in error messages or debugging messages."
3489 #: ../src/guestfs.pod:1811
3490 msgid "If no callback is registered: progress messages are discarded."
3494 #: ../src/guestfs.pod:1813
3495 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3499 #: ../src/guestfs.pod:1816
3501 "The callback function is called whenever a log message is generated by qemu, "
3502 "the appliance kernel, guestfsd (daemon), or utility programs."
3506 #: ../src/guestfs.pod:1819
3508 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
3509 "(L</guestfs_launch>) then additional debug messages are generated."
3513 #: ../src/guestfs.pod:1822 ../src/guestfs.pod:1836
3515 "If no callback is registered: the messages are discarded unless the verbose "
3516 "flag is set in which case they are sent to stderr. You can override the "
3517 "printing of verbose messages to stderr by setting up a callback."
3521 #: ../src/guestfs.pod:1827
3522 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3526 #: ../src/guestfs.pod:1830
3528 "The callback function is called whenever a log message is generated by the "
3529 "library part of libguestfs."
3533 #: ../src/guestfs.pod:1833
3535 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3536 "messages are generated."
3540 #: ../src/guestfs.pod:1841
3541 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3545 #: ../src/guestfs.pod:1844
3547 "The callback function is called whenever a trace message is generated. This "
3548 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3552 #: ../src/guestfs.pod:1847
3554 "If no callback is registered: the messages are sent to stderr. You can "
3555 "override the printing of trace messages to stderr by setting up a callback."
3559 #: ../src/guestfs.pod:1853
3560 msgid "guestfs_set_event_callback"
3564 #: ../src/guestfs.pod:1855
3567 " int guestfs_set_event_callback (guestfs_h *g,\n"
3568 " guestfs_event_callback cb,\n"
3569 " uint64_t event_bitmask,\n"
3576 #: ../src/guestfs.pod:1861
3578 "This function registers a callback (C<cb>) for all event classes in the "
3583 #: ../src/guestfs.pod:1864
3585 "For example, to register for all log message events, you could call this "
3586 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3587 "To register a single callback for all possible classes of events, use "
3588 "C<GUESTFS_EVENT_ALL>."
3592 #: ../src/guestfs.pod:1870
3593 msgid "C<flags> should always be passed as 0."
3597 #: ../src/guestfs.pod:1872
3599 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3600 "it for any purpose."
3604 #: ../src/guestfs.pod:1875
3606 "The return value is the event handle (an integer) which you can use to "
3607 "delete the callback (see below)."
3611 #: ../src/guestfs.pod:1878
3613 "If there is an error, this function returns C<-1>, and sets the error in the "
3614 "handle in the usual way (see L</guestfs_last_error> etc.)"
3618 #: ../src/guestfs.pod:1881
3620 "Callbacks remain in effect until they are deleted, or until the handle is "
3625 #: ../src/guestfs.pod:1884
3627 "In the case where multiple callbacks are registered for a particular event "
3628 "class, all of the callbacks are called. The order in which multiple "
3629 "callbacks are called is not defined."
3633 #: ../src/guestfs.pod:1888
3634 msgid "guestfs_delete_event_callback"
3638 #: ../src/guestfs.pod:1890
3641 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3646 #: ../src/guestfs.pod:1892
3648 "Delete a callback that was previously registered. C<event_handle> should be "
3649 "the integer that was returned by a previous call to "
3650 "C<guestfs_set_event_callback> on the same handle."
3654 #: ../src/guestfs.pod:1896
3655 msgid "guestfs_event_callback"
3659 #: ../src/guestfs.pod:1898
3662 " typedef void (*guestfs_event_callback) (\n"
3665 " uint64_t event,\n"
3666 " int event_handle,\n"
3668 " const char *buf, size_t buf_len,\n"
3669 " const uint64_t *array, size_t array_len);\n"
3674 #: ../src/guestfs.pod:1907
3675 msgid "This is the type of the event callback function that you have to provide."
3679 #: ../src/guestfs.pod:1910
3681 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3682 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3683 "handle, and C<flags> which in the current API you should ignore."
3687 #: ../src/guestfs.pod:1914
3689 "The remaining parameters contain the event payload (if any). Each event may "
3690 "contain a payload, which usually relates to the event class, but for future "
3691 "proofing your code should be written to handle any payload for any event "
3696 #: ../src/guestfs.pod:1919
3698 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3699 "there is no message buffer). Note that this message buffer can contain "
3700 "arbitrary 8 bit data, including NUL bytes."
3704 #: ../src/guestfs.pod:1923
3706 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3707 "moment this is only used for progress messages."
3711 #: ../src/guestfs.pod:1926
3712 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3716 #: ../src/guestfs.pod:1928
3718 "One motivation for the generic event API was to allow GUI programs to "
3719 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3720 "unconditionally to C<stderr>."
3724 #: ../src/guestfs.pod:1932
3726 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3727 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3728 "messages are not events; you must capture error messages separately)."
3732 #: ../src/guestfs.pod:1937
3734 "Programs have to set up a callback to capture the classes of events of "
3739 #: ../src/guestfs.pod:1940
3743 " guestfs_set_event_callback\n"
3744 " (g, message_callback,\n"
3745 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3746 " GUESTFS_EVENT_TRACE,\n"
3747 " 0, NULL) == -1)\n"
3748 " if (eh == -1) {\n"
3749 " // handle error in the usual way\n"
3755 #: ../src/guestfs.pod:1950
3757 "The callback can then direct messages to the appropriate place. In this "
3758 "example, messages are directed to syslog:"
3762 #: ../src/guestfs.pod:1953
3766 " message_callback (\n"
3769 " uint64_t event,\n"
3770 " int event_handle,\n"
3772 " const char *buf, size_t buf_len,\n"
3773 " const uint64_t *array, size_t array_len)\n"
3775 " const int priority = LOG_USER|LOG_INFO;\n"
3776 " if (buf_len > 0)\n"
3777 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3783 #: ../src/guestfs.pod:1968
3784 msgid "PRIVATE DATA AREA"
3788 #: ../src/guestfs.pod:1970
3790 "You can attach named pieces of private data to the libguestfs handle, fetch "
3791 "them by name, and walk over them, for the lifetime of the handle. This is "
3792 "called the private data area and is only available from the C API."
3796 #: ../src/guestfs.pod:1975
3797 msgid "To attach a named piece of data, use the following call:"
3801 #: ../src/guestfs.pod:1977
3804 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3809 #: ../src/guestfs.pod:1979
3811 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3812 "pointer (which can be C<NULL>). Any previous item with the same name is "
3817 #: ../src/guestfs.pod:1983
3819 "You can use any C<key> you want, but names beginning with an underscore "
3820 "character are reserved for internal libguestfs purposes (for implementing "
3821 "language bindings). It is recommended to prefix the name with some unique "
3822 "string to avoid collisions with other users."
3826 #: ../src/guestfs.pod:1988
3827 msgid "To retrieve the pointer, use:"
3831 #: ../src/guestfs.pod:1990
3834 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3839 #: ../src/guestfs.pod:1992
3841 "This function returns C<NULL> if either no data is found associated with "
3842 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3847 #: ../src/guestfs.pod:1996
3849 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3850 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3851 "all. In particular, libguestfs does I<not> try to free the data when the "
3852 "handle is closed. If the data must be freed, then the caller must either "
3853 "free it before calling L</guestfs_close> or must set up a close callback to "
3854 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3858 #: ../src/guestfs.pod:2003
3859 msgid "To walk over all entries, use these two functions:"
3863 #: ../src/guestfs.pod:2005
3866 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3871 #: ../src/guestfs.pod:2007
3874 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3879 #: ../src/guestfs.pod:2009
3881 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3882 "not have any particular meaning -- keys are not returned in any defined "
3883 "order). A pointer to the key is returned in C<*key_rtn> and the "
3884 "corresponding data pointer is returned from the function. C<NULL> is "
3885 "returned if there are no keys stored in the handle."
3889 #: ../src/guestfs.pod:2015
3891 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3892 "value of this function is also C<NULL> is there are no further entries to "
3897 #: ../src/guestfs.pod:2019
3898 msgid "Notes about walking over entries:"
3902 #: ../src/guestfs.pod:2025
3903 msgid "You must not call C<guestfs_set_private> while walking over the entries."
3907 #: ../src/guestfs.pod:2030
3909 "The handle maintains an internal iterator which is reset when you call "
3910 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3911 "call C<guestfs_set_private>."
3915 #: ../src/guestfs.pod:2036
3916 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3920 #: ../src/guestfs.pod:2038
3923 " guestfs_set_private (g, key, NULL);\n"
3928 #: ../src/guestfs.pod:2040
3929 msgid "then that C<key> is not returned when walking."
3933 #: ../src/guestfs.pod:2044
3935 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
3936 "C<guestfs_next_private> or C<guestfs_set_private>."
3940 #: ../src/guestfs.pod:2050
3942 "The following example code shows how to print all keys and data pointers "
3943 "that are associated with the handle C<g>:"
3947 #: ../src/guestfs.pod:2053
3950 " const char *key;\n"
3951 " void *data = guestfs_first_private (g, &key);\n"
3952 " while (data != NULL)\n"
3954 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3955 " data = guestfs_next_private (g, &key);\n"
3961 #: ../src/guestfs.pod:2061
3963 "More commonly you are only interested in keys that begin with an "
3964 "application-specific prefix C<foo_>. Modify the loop like so:"
3968 #: ../src/guestfs.pod:2064
3971 " const char *key;\n"
3972 " void *data = guestfs_first_private (g, &key);\n"
3973 " while (data != NULL)\n"
3975 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3976 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3977 " data = guestfs_next_private (g, &key);\n"
3983 #: ../src/guestfs.pod:2073
3985 "If you need to modify keys while walking, then you have to jump back to the "
3986 "beginning of the loop. For example, to delete all keys prefixed with "
3991 #: ../src/guestfs.pod:2077
3994 " const char *key;\n"
3997 " data = guestfs_first_private (g, &key);\n"
3998 " while (data != NULL)\n"
4000 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4002 " guestfs_set_private (g, key, NULL);\n"
4003 " /* note that 'key' pointer is now invalid, and so is\n"
4004 " the internal iterator */\n"
4007 " data = guestfs_next_private (g, &key);\n"
4013 #: ../src/guestfs.pod:2093
4015 "Note that the above loop is guaranteed to terminate because the keys are "
4016 "being deleted, but other manipulations of keys within the loop might not "
4017 "terminate unless you also maintain an indication of which keys have been "
4022 #: ../src/guestfs.pod:2098 ../src/guestfs.pod:2103
4027 #: ../src/guestfs.pod:2100
4029 "<!-- old anchor for the next section --> <a "
4030 "name=\"state_machine_and_low_level_event_api\"/>"
4034 #: ../src/guestfs.pod:2105
4035 msgid "ARCHITECTURE"
4039 #: ../src/guestfs.pod:2107
4041 "Internally, libguestfs is implemented by running an appliance (a special "
4042 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4043 "process of the main program."
4047 #: ../src/guestfs.pod:2111
4050 " ___________________\n"
4052 " | main program |\n"
4054 " | | child process / appliance\n"
4055 " | | __________________________\n"
4057 " +-------------------+ RPC | +-----------------+ |\n"
4058 " | libguestfs <--------------------> guestfsd | |\n"
4059 " | | | +-----------------+ |\n"
4060 " \\___________________/ | | Linux kernel | |\n"
4061 " | +--^--------------+ |\n"
4062 " \\_________|________________/\n"
4068 " \\______________/\n"
4073 #: ../src/guestfs.pod:2131
4075 "The library, linked to the main program, creates the child process and hence "
4076 "the appliance in the L</guestfs_launch> function."
4080 #: ../src/guestfs.pod:2134
4082 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4083 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4084 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4085 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4086 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4087 "attached to the qemu process which translates device access by the "
4088 "appliance's Linux kernel into accesses to the image."
4092 #: ../src/guestfs.pod:2143
4094 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4095 "Although the disk image you are attached to might also be used by some "
4096 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4097 "care if both libguestfs's qemu process and your virtual machine are trying "
4098 "to update the disk image at the same time, since these usually results in "
4099 "massive disk corruption)."
4103 #: ../src/guestfs.pod:2150
4104 msgid "STATE MACHINE"
4108 #: ../src/guestfs.pod:2152
4109 msgid "libguestfs uses a state machine to model the child process:"
4113 #: ../src/guestfs.pod:2154
4125 " / | \\ \\ guestfs_launch\n"
4126 " / | _\\__V______\n"
4128 " / | | LAUNCHING |\n"
4129 " / | \\___________/\n"
4131 " / | guestfs_launch\n"
4133 " ______ / __|____V\n"
4134 " / \\ ------> / \\\n"
4135 " | BUSY | | READY |\n"
4136 " \\______/ <------ \\________/\n"
4141 #: ../src/guestfs.pod:2176
4143 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4144 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4145 "(3) alternating between READY and BUSY as commands are issued to, and "
4146 "carried out by, the child process."
4150 #: ../src/guestfs.pod:2181
4152 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4153 "asynchronously at any time (eg. due to some internal error), and that causes "
4154 "the state to transition back to CONFIG."
4158 #: ../src/guestfs.pod:2185
4160 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4161 "issued when in the CONFIG state."
4165 #: ../src/guestfs.pod:2188
4167 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4168 "L</guestfs_launch> blocks until the child process is READY to accept "
4169 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4170 "moves the state from CONFIG to LAUNCHING while it is running."
4174 #: ../src/guestfs.pod:2194
4176 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4177 "state. These API calls block waiting for the command to be carried out "
4178 "(ie. the state to transition to BUSY and then back to READY). There are no "
4179 "non-blocking versions, and no way to issue more than one command per handle "
4184 #: ../src/guestfs.pod:2200
4186 "Finally, the child process sends asynchronous messages back to the main "
4187 "program, such as kernel log messages. You can register a callback to "
4188 "receive these messages."
4192 #: ../src/guestfs.pod:2204
4197 #: ../src/guestfs.pod:2206
4198 msgid "COMMUNICATION PROTOCOL"
4202 #: ../src/guestfs.pod:2208
4204 "Don't rely on using this protocol directly. This section documents how it "
4205 "currently works, but it may change at any time."
4209 #: ../src/guestfs.pod:2211
4211 "The protocol used to talk between the library and the daemon running inside "
4212 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4213 "1014, RFC 1832, RFC 4506)."
4217 #: ../src/guestfs.pod:2215
4219 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4220 "this file is automatically generated)."
4224 #: ../src/guestfs.pod:2218
4226 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4227 "and C<FileOut> parameters, which are handled with very simple request/reply "
4228 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4229 "parameters, which use the same request and reply messages, but they may also "
4230 "be followed by files sent using a chunked encoding."
4234 #: ../src/guestfs.pod:2225
4235 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4239 #: ../src/guestfs.pod:2227
4240 msgid "For ordinary functions, the request message is:"
4244 #: ../src/guestfs.pod:2229
4247 " total length (header + arguments,\n"
4248 " but not including the length word itself)\n"
4249 " struct guestfs_message_header (encoded as XDR)\n"
4250 " struct guestfs_<foo>_args (encoded as XDR)\n"
4255 #: ../src/guestfs.pod:2234
4257 "The total length field allows the daemon to allocate a fixed size buffer "
4258 "into which it slurps the rest of the message. As a result, the total length "
4259 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4260 "effective size of any request is limited to somewhere under this size."
4264 #: ../src/guestfs.pod:2240
4266 "Note also that many functions don't take any arguments, in which case the "
4267 "C<guestfs_I<foo>_args> is completely omitted."
4271 #: ../src/guestfs.pod:2243
4273 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4274 "receiver knows what type of args structure to expect, or none at all."
4278 #: ../src/guestfs.pod:2247
4280 "For functions that take optional arguments, the optional arguments are "
4281 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4282 "arguments. A bitmask in the header indicates which optional arguments are "
4283 "meaningful. The bitmask is also checked to see if it contains bits set "
4284 "which the daemon does not know about (eg. if more optional arguments were "
4285 "added in a later version of the library), and this causes the call to be "
4290 #: ../src/guestfs.pod:2255
4291 msgid "The reply message for ordinary functions is:"
4295 #: ../src/guestfs.pod:2257
4298 " total length (header + ret,\n"
4299 " but not including the length word itself)\n"
4300 " struct guestfs_message_header (encoded as XDR)\n"
4301 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4306 #: ../src/guestfs.pod:2262
4308 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4309 "functions that return no formal return values."
4313 #: ../src/guestfs.pod:2265
4314 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4318 #: ../src/guestfs.pod:2268
4320 "In the case of an error, a flag is set in the header, and the reply message "
4321 "is slightly changed:"
4325 #: ../src/guestfs.pod:2271
4328 " total length (header + error,\n"
4329 " but not including the length word itself)\n"
4330 " struct guestfs_message_header (encoded as XDR)\n"
4331 " struct guestfs_message_error (encoded as XDR)\n"
4336 #: ../src/guestfs.pod:2276
4338 "The C<guestfs_message_error> structure contains the error message as a "
4343 #: ../src/guestfs.pod:2279
4344 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4348 #: ../src/guestfs.pod:2281
4350 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4351 "The normal request message is sent (see above). However this is followed by "
4352 "a sequence of file chunks."
4356 #: ../src/guestfs.pod:2285
4359 " total length (header + arguments,\n"
4360 " but not including the length word itself,\n"
4361 " and not including the chunks)\n"
4362 " struct guestfs_message_header (encoded as XDR)\n"
4363 " struct guestfs_<foo>_args (encoded as XDR)\n"
4364 " sequence of chunks for FileIn param #0\n"
4365 " sequence of chunks for FileIn param #1 etc.\n"
4370 #: ../src/guestfs.pod:2293
4371 msgid "The \"sequence of chunks\" is:"
4375 #: ../src/guestfs.pod:2295
4378 " length of chunk (not including length word itself)\n"
4379 " struct guestfs_chunk (encoded as XDR)\n"
4380 " length of chunk\n"
4381 " struct guestfs_chunk (encoded as XDR)\n"
4383 " length of chunk\n"
4384 " struct guestfs_chunk (with data.data_len == 0)\n"
4389 #: ../src/guestfs.pod:2303
4391 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4392 "is set in the final chunk to indicate either successful completion or early "
4397 #: ../src/guestfs.pod:2307
4399 "At time of writing there are no functions that have more than one FileIn "
4400 "parameter. However this is (theoretically) supported, by sending the "
4401 "sequence of chunks for each FileIn parameter one after another (from left to "
4406 #: ../src/guestfs.pod:2312
4408 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4409 "transfer. The library does this by sending a chunk with a special flag set "
4410 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4411 "RPC, does I<not> send any reply, and goes back to reading the next request."
4415 #: ../src/guestfs.pod:2318
4417 "The daemon may also cancel. It does this by writing a special word "
4418 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4419 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4420 "cancel chunk). The special word is chosen so that even if cancellation "
4421 "happens right at the end of the transfer (after the library has finished "
4422 "writing and has started listening for the reply), the \"spurious\" cancel "
4423 "flag will not be confused with the reply message."
4427 #: ../src/guestfs.pod:2327
4429 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4430 "limit), and also files where the size is not known in advance (eg. from "
4431 "pipes or sockets). However the chunks are rather small "
4432 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4433 "to keep much in memory."
4437 #: ../src/guestfs.pod:2333
4438 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4442 #: ../src/guestfs.pod:2335
4444 "The protocol for FileOut parameters is exactly the same as for FileIn "
4445 "parameters, but with the roles of daemon and library reversed."
4449 #: ../src/guestfs.pod:2338
4452 " total length (header + ret,\n"
4453 " but not including the length word itself,\n"
4454 " and not including the chunks)\n"
4455 " struct guestfs_message_header (encoded as XDR)\n"
4456 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4457 " sequence of chunks for FileOut param #0\n"
4458 " sequence of chunks for FileOut param #1 etc.\n"
4463 #: ../src/guestfs.pod:2346
4464 msgid "INITIAL MESSAGE"
4468 #: ../src/guestfs.pod:2348
4470 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4471 "which indicates that the guest and daemon is alive. This is what "
4472 "L</guestfs_launch> waits for."
4476 #: ../src/guestfs.pod:2352
4477 msgid "PROGRESS NOTIFICATION MESSAGES"
4481 #: ../src/guestfs.pod:2354
4483 "The daemon may send progress notification messages at any time. These are "
4484 "distinguished by the normal length word being replaced by "
4485 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4489 #: ../src/guestfs.pod:2358
4491 "The library turns them into progress callbacks (see "
4492 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4497 #: ../src/guestfs.pod:2362
4499 "The daemon self-limits the frequency of progress messages it sends (see "
4500 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4505 #: ../src/guestfs.pod:2366
4506 msgid "LIBGUESTFS VERSION NUMBERS"
4510 #: ../src/guestfs.pod:2368
4512 "Since April 2010, libguestfs has started to make separate development and "
4513 "stable releases, along with corresponding branches in our git repository. "
4514 "These separate releases can be identified by version number:"
4518 #: ../src/guestfs.pod:2373
4521 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4522 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4528 " | `-------- sub-version\n"
4530 " `------ always '1' because we don't change the ABI\n"
4535 #: ../src/guestfs.pod:2384
4536 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4540 #: ../src/guestfs.pod:2386
4542 "As time passes we cherry pick fixes from the development branch and backport "
4543 "those into the stable branch, the effect being that the stable branch should "
4544 "get more stable and less buggy over time. So the stable releases are ideal "
4545 "for people who don't need new features but would just like the software to "
4550 #: ../src/guestfs.pod:2392
4551 msgid "Our criteria for backporting changes are:"
4555 #: ../src/guestfs.pod:2398
4557 "Documentation changes which don't affect any code are backported unless the "
4558 "documentation refers to a future feature which is not in stable."
4562 #: ../src/guestfs.pod:2404
4564 "Bug fixes which are not controversial, fix obvious problems, and have been "
4565 "well tested are backported."
4569 #: ../src/guestfs.pod:2409
4571 "Simple rearrangements of code which shouldn't affect how it works get "
4572 "backported. This is so that the code in the two branches doesn't get too "
4573 "far out of step, allowing us to backport future fixes more easily."
4577 #: ../src/guestfs.pod:2415
4579 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4580 "exceptional case: the new feature is required in order to implement an "
4581 "important bug fix."
4585 #: ../src/guestfs.pod:2421
4587 "A new stable branch starts when we think the new features in development are "
4588 "substantial and compelling enough over the current stable branch to warrant "
4589 "it. When that happens we create new stable and development versions 1.N.0 "
4590 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4591 "stable at this point, but by backporting fixes from development, that branch "
4592 "will stabilize over time."
4596 #: ../src/guestfs.pod:2429
4597 msgid "EXTENDING LIBGUESTFS"
4601 #: ../src/guestfs.pod:2431
4602 msgid "ADDING A NEW API ACTION"
4606 #: ../src/guestfs.pod:2433
4608 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4609 "documentation) are generated, and this makes it easy to extend the "
4614 #: ../src/guestfs.pod:2437
4615 msgid "To add a new API action there are two changes:"
4619 #: ../src/guestfs.pod:2443
4621 "You need to add a description of the call (name, parameters, return type, "
4622 "tests, documentation) to C<generator/generator_actions.ml>."
4626 #: ../src/guestfs.pod:2446
4628 "There are two sorts of API action, depending on whether the call goes "
4629 "through to the daemon in the appliance, or is serviced entirely by the "
4630 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4631 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4632 "an example of the latter, since a trace flag is maintained in the handle and "
4633 "all tracing is done on the library side."
4637 #: ../src/guestfs.pod:2454
4639 "Most new actions are of the first type, and get added to the "
4640 "C<daemon_functions> list. Each function has a unique procedure number used "
4641 "in the RPC protocol which is assigned to that action when we publish "
4642 "libguestfs and cannot be reused. Take the latest procedure number and "
4647 #: ../src/guestfs.pod:2460
4649 "For library-only actions of the second type, add to the "
4650 "C<non_daemon_functions> list. Since these functions are serviced by the "
4651 "library and do not travel over the RPC mechanism to the daemon, these "
4652 "functions do not need a procedure number, and so the procedure number is set "
4657 #: ../src/guestfs.pod:2468
4658 msgid "Implement the action (in C):"
4662 #: ../src/guestfs.pod:2470
4664 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4665 "C<daemon/> directory."
4669 #: ../src/guestfs.pod:2473
4671 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4672 "(note: double underscore) in the C<src/> directory."
4676 #: ../src/guestfs.pod:2476
4677 msgid "In either case, use another function as an example of what to do."
4681 #: ../src/guestfs.pod:2480
4682 msgid "After making these changes, use C<make> to compile."
4686 #: ../src/guestfs.pod:2482
4688 "Note that you don't need to implement the RPC, language bindings, manual "
4689 "pages or anything else. It's all automatically generated from the OCaml "
4694 #: ../src/guestfs.pod:2486
4695 msgid "ADDING TESTS FOR AN API ACTION"
4699 #: ../src/guestfs.pod:2488
4701 "You can supply zero or as many tests as you want per API call. The tests "
4702 "can either be added as part of the API description "
4703 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4704 "drop a script into C<regressions/>. Note that adding a script to "
4705 "C<regressions/> is slower, so if possible use the first method."
4709 #: ../src/guestfs.pod:2494
4711 "The following describes the test environment used when you add an API test "
4712 "in C<generator_actions.ml>."
4716 #: ../src/guestfs.pod:2497
4717 msgid "The test environment has 4 block devices:"
4721 #: ../src/guestfs.pod:2501
4722 msgid "C</dev/sda> 500MB"
4726 #: ../src/guestfs.pod:2503
4727 msgid "General block device for testing."
4731 #: ../src/guestfs.pod:2505
4732 msgid "C</dev/sdb> 50MB"
4736 #: ../src/guestfs.pod:2507
4738 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4743 #: ../src/guestfs.pod:2510
4744 msgid "C</dev/sdc> 10MB"
4748 #: ../src/guestfs.pod:2512
4749 msgid "Used in a few tests where two block devices are needed."
4753 #: ../src/guestfs.pod:2514
4758 #: ../src/guestfs.pod:2516
4759 msgid "ISO with fixed content (see C<images/test.iso>)."
4763 #: ../src/guestfs.pod:2520
4765 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4766 "appliance and block devices are reused between tests. So don't try testing "
4767 "L</guestfs_kill_subprocess> :-x"
4771 #: ../src/guestfs.pod:2524
4773 "Each test starts with an initial scenario, selected using one of the "
4774 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4775 "initialize the disks mentioned above in a particular way as documented in "
4776 "C<generator_types.ml>. You should not assume anything about the previous "
4777 "contents of other disks that are not initialized."
4781 #: ../src/guestfs.pod:2530
4783 "You can add a prerequisite clause to any individual test. This is a "
4784 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4785 "if testing a command which might not work on all variations of libguestfs "
4786 "builds. A test that has prerequisite of C<Always> means to run "
4791 #: ../src/guestfs.pod:2536
4793 "In addition, packagers can skip individual tests by setting environment "
4794 "variables before running C<make check>."
4798 #: ../src/guestfs.pod:2539
4801 " SKIP_TEST_<CMD>_<NUM>=1\n"
4806 #: ../src/guestfs.pod:2541
4807 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4811 #: ../src/guestfs.pod:2543
4816 #: ../src/guestfs.pod:2545
4819 " SKIP_TEST_<CMD>=1\n"
4824 #: ../src/guestfs.pod:2547
4825 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4829 #: ../src/guestfs.pod:2549
4830 msgid "Packagers can run only certain tests by setting for example:"
4834 #: ../src/guestfs.pod:2551
4837 " TEST_ONLY=\"vfs_type zerofree\"\n"
4842 #: ../src/guestfs.pod:2553
4844 "See C<capitests/tests.c> for more details of how these environment variables "
4849 #: ../src/guestfs.pod:2556
4850 msgid "DEBUGGING NEW API ACTIONS"
4854 #: ../src/guestfs.pod:2558
4855 msgid "Test new actions work before submitting them."
4859 #: ../src/guestfs.pod:2560
4860 msgid "You can use guestfish to try out new commands."
4864 #: ../src/guestfs.pod:2562
4866 "Debugging the daemon is a problem because it runs inside a minimal "
4867 "environment. However you can fprintf messages in the daemon to stderr, and "
4868 "they will show up if you use C<guestfish -v>."
4872 #: ../src/guestfs.pod:2566
4873 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4877 #: ../src/guestfs.pod:2568
4879 "Our C source code generally adheres to some basic code-formatting "
4880 "conventions. The existing code base is not totally consistent on this "
4881 "front, but we do prefer that contributed code be formatted similarly. In "
4882 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4883 "indentation level, and other than that, follow the K&R style."
4887 #: ../src/guestfs.pod:2574
4889 "If you use Emacs, add the following to one of one of your start-up files "
4890 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4894 #: ../src/guestfs.pod:2577
4897 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4898 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4899 " (add-hook 'find-file-hook\n"
4900 " '(lambda () (if (and buffer-file-name\n"
4901 " (string-match \"/libguestfs\\\\>\"\n"
4902 " (buffer-file-name))\n"
4903 " (not (string-equal mode-name \"Change Log\"))\n"
4904 " (not (string-equal mode-name \"Makefile\")))\n"
4905 " (setq indent-tabs-mode nil))))\n"
4910 #: ../src/guestfs.pod:2587
4913 " ;;; When editing C sources in libguestfs, use this style.\n"
4914 " (defun libguestfs-c-mode ()\n"
4915 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4917 " (c-set-style \"K&R\")\n"
4918 " (setq c-indent-level 2)\n"
4919 " (setq c-basic-offset 2))\n"
4920 " (add-hook 'c-mode-hook\n"
4921 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4922 " (buffer-file-name))\n"
4923 " (libguestfs-c-mode))))\n"
4928 #: ../src/guestfs.pod:2599
4929 msgid "Enable warnings when compiling (and fix any problems this finds):"
4933 #: ../src/guestfs.pod:2602
4936 " ./configure --enable-gcc-warnings\n"
4941 #: ../src/guestfs.pod:2604
4942 msgid "Useful targets are:"
4946 #: ../src/guestfs.pod:2606
4949 " make syntax-check # checks the syntax of the C code\n"
4950 " make check # runs the test suite\n"
4955 #: ../src/guestfs.pod:2609
4956 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4960 #: ../src/guestfs.pod:2611
4962 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4963 "which are used to do shell quoting."
4967 #: ../src/guestfs.pod:2616
4972 #: ../src/guestfs.pod:2618
4974 "Simple shell quoted string. Any spaces or other shell characters are "
4979 #: ../src/guestfs.pod:2621
4984 #: ../src/guestfs.pod:2623
4986 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4991 #: ../src/guestfs.pod:2628 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
4992 msgid "For example:"
4996 #: ../src/guestfs.pod:2630
4999 " asprintf (&cmd, \"cat %R\", path);\n"
5004 #: ../src/guestfs.pod:2632
5005 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5009 #: ../src/guestfs.pod:2634
5011 "I<Note:> Do I<not> use these when you are passing parameters to the "
5012 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
5013 "because they are not passed via the shell (instead, straight to exec). You "
5014 "probably want to use the C<sysroot_path()> function however."
5018 #: ../src/guestfs.pod:2640
5019 msgid "SUBMITTING YOUR NEW API ACTIONS"
5023 #: ../src/guestfs.pod:2642
5025 "Submit patches to the mailing list: "
5026 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5027 "L<rjones@redhat.com>."
5031 #: ../src/guestfs.pod:2646
5032 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5036 #: ../src/guestfs.pod:2648
5037 msgid "We support i18n (gettext anyhow) in the library."
5041 #: ../src/guestfs.pod:2650
5043 "However many messages come from the daemon, and we don't translate those at "
5044 "the moment. One reason is that the appliance generally has all locale files "
5045 "removed from it, because they take up a lot of space. So we'd have to readd "
5046 "some of those, as well as copying our PO files into the appliance."
5050 #: ../src/guestfs.pod:2656
5052 "Debugging messages are never translated, since they are intended for the "
5057 #: ../src/guestfs.pod:2659
5058 msgid "SOURCE CODE SUBDIRECTORIES"
5062 #: ../src/guestfs.pod:2663 ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3900
5063 msgid "C<appliance>"
5067 #: ../src/guestfs.pod:2665
5068 msgid "The libguestfs appliance, build scripts and so on."
5072 #: ../src/guestfs.pod:2667
5073 msgid "C<capitests>"
5077 #: ../src/guestfs.pod:2669
5078 msgid "Automated tests of the C API."
5082 #: ../src/guestfs.pod:2671
5087 #: ../src/guestfs.pod:2673
5089 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5094 #: ../src/guestfs.pod:2676
5099 #: ../src/guestfs.pod:2678
5100 msgid "Outside contributions, experimental parts."
5104 #: ../src/guestfs.pod:2680
5109 #: ../src/guestfs.pod:2682
5111 "The daemon that runs inside the libguestfs appliance and carries out "
5116 #: ../src/guestfs.pod:2685
5121 #: ../src/guestfs.pod:2687
5122 msgid "L<virt-df(1)> command and documentation."
5126 #: ../src/guestfs.pod:2689
5131 #: ../src/guestfs.pod:2691
5132 msgid "C API example code."
5136 #: ../src/guestfs.pod:2693
5141 #: ../src/guestfs.pod:2695
5143 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5144 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5145 "L<virt-tar-out(1)>."
5149 #: ../src/guestfs.pod:2699
5154 #: ../src/guestfs.pod:2701
5155 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5159 #: ../src/guestfs.pod:2703
5160 msgid "C<generator>"
5164 #: ../src/guestfs.pod:2705
5166 "The crucially important generator, used to automatically generate large "
5167 "amounts of boilerplate C code for things like RPC and bindings."
5171 #: ../src/guestfs.pod:2708
5176 #: ../src/guestfs.pod:2710
5177 msgid "Files used by the test suite."
5181 #: ../src/guestfs.pod:2712
5182 msgid "Some \"phony\" guest images which we test against."
5186 #: ../src/guestfs.pod:2714
5187 msgid "C<inspector>"
5191 #: ../src/guestfs.pod:2716
5192 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5196 #: ../src/guestfs.pod:2718
5201 #: ../src/guestfs.pod:2720
5202 msgid "Logo used on the website. The fish is called Arthur by the way."
5206 #: ../src/guestfs.pod:2722
5211 #: ../src/guestfs.pod:2724
5212 msgid "M4 macros used by autoconf."
5216 #: ../src/guestfs.pod:2726
5221 #: ../src/guestfs.pod:2728
5222 msgid "Translations of simple gettext strings."
5226 #: ../src/guestfs.pod:2730
5231 #: ../src/guestfs.pod:2732
5233 "The build infrastructure and PO files for translations of manpages and POD "
5234 "files. Eventually this will be combined with the C<po> directory, but that "
5235 "is rather complicated."
5239 #: ../src/guestfs.pod:2736
5240 msgid "C<regressions>"
5244 #: ../src/guestfs.pod:2738
5245 msgid "Regression tests."
5249 #: ../src/guestfs.pod:2740
5254 #: ../src/guestfs.pod:2742
5255 msgid "L<virt-rescue(1)> command and documentation."
5259 #: ../src/guestfs.pod:2744
5264 #: ../src/guestfs.pod:2746
5265 msgid "Source code to the C library."
5269 #: ../src/guestfs.pod:2748
5274 #: ../src/guestfs.pod:2750
5275 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5279 #: ../src/guestfs.pod:2752
5280 msgid "C<test-tool>"
5284 #: ../src/guestfs.pod:2754
5286 "Test tool for end users to test if their qemu/kernel combination will work "
5291 #: ../src/guestfs.pod:2757
5296 #: ../src/guestfs.pod:2759
5301 #: ../src/guestfs.pod:2761
5306 #: ../src/guestfs.pod:2763
5311 #: ../src/guestfs.pod:2765
5316 #: ../src/guestfs.pod:2767
5321 #: ../src/guestfs.pod:2769
5326 #: ../src/guestfs.pod:2771
5331 #: ../src/guestfs.pod:2773
5332 msgid "Language bindings."
5336 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1010 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:476
5337 msgid "ENVIRONMENT VARIABLES"
5341 #: ../src/guestfs.pod:2781 ../fish/guestfish.pod:1036
5342 msgid "LIBGUESTFS_APPEND"
5346 #: ../src/guestfs.pod:2783 ../fish/guestfish.pod:1038
5347 msgid "Pass additional options to the guest kernel."
5351 #: ../src/guestfs.pod:2785 ../fish/guestfish.pod:1040
5352 msgid "LIBGUESTFS_DEBUG"
5356 #: ../src/guestfs.pod:2787
5358 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5359 "effect as calling C<guestfs_set_verbose (g, 1)>."
5363 #: ../src/guestfs.pod:2790 ../fish/guestfish.pod:1045
5364 msgid "LIBGUESTFS_MEMSIZE"
5368 #: ../src/guestfs.pod:2792 ../fish/guestfish.pod:1047
5369 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5373 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1050
5376 " LIBGUESTFS_MEMSIZE=700\n"
5381 #: ../src/guestfs.pod:2797 ../fish/guestfish.pod:1052
5382 msgid "LIBGUESTFS_PATH"
5386 #: ../src/guestfs.pod:2799
5388 "Set the path that libguestfs uses to search for a supermin appliance. See "
5389 "the discussion of paths in section L</PATH> above."
5393 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1057
5394 msgid "LIBGUESTFS_QEMU"
5398 #: ../src/guestfs.pod:2804 ../fish/guestfish.pod:1059
5400 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5401 "which was found at compile time by the configure script is used."
5405 #: ../src/guestfs.pod:2808
5406 msgid "See also L</QEMU WRAPPERS> above."
5410 #: ../src/guestfs.pod:2810 ../fish/guestfish.pod:1063
5411 msgid "LIBGUESTFS_TRACE"
5415 #: ../src/guestfs.pod:2812
5417 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5418 "effect as calling C<guestfs_set_trace (g, 1)>."
5422 #: ../src/guestfs.pod:2815 ../fish/guestfish.pod:1072
5427 #: ../src/guestfs.pod:2817 ../fish/guestfish.pod:1074
5429 "Location of temporary directory, defaults to C</tmp> except for the cached "
5430 "supermin appliance which defaults to C</var/tmp>."
5434 #: ../src/guestfs.pod:2820 ../fish/guestfish.pod:1077
5436 "If libguestfs was compiled to use the supermin appliance then the real "
5437 "appliance is cached in this directory, shared between all handles belonging "
5438 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5439 "use in case C</var/tmp> is not large enough."
5443 #: ../src/guestfs.pod:2828 ../fish/guestfish.pod:1144 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:267 ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572 ../tools/virt-resize.pl:1489 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5448 #: ../src/guestfs.pod:2830
5450 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5451 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5452 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5453 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5454 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5455 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5456 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5457 "L<http://libguestfs.org/>."
5461 #: ../src/guestfs.pod:2857
5463 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5464 "L<lvm(8)>, L<disktype(1)>."
5468 #: ../src/guestfs.pod:2864 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
5473 #: ../src/guestfs.pod:2866
5474 msgid "To get a list of bugs against libguestfs use this link:"
5478 #: ../src/guestfs.pod:2868
5479 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5483 #: ../src/guestfs.pod:2870
5484 msgid "To report a new bug against libguestfs use this link:"
5488 #: ../src/guestfs.pod:2872
5489 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5493 #: ../src/guestfs.pod:2874
5494 msgid "When reporting a bug, please check:"
5498 #: ../src/guestfs.pod:2880
5499 msgid "That the bug hasn't been reported already."
5503 #: ../src/guestfs.pod:2884
5504 msgid "That you are testing a recent version."
5508 #: ../src/guestfs.pod:2888
5509 msgid "Describe the bug accurately, and give a way to reproduce it."
5513 #: ../src/guestfs.pod:2892
5515 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5520 #: ../src/guestfs.pod:2897 ../fish/guestfish.pod:1167 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:278
5525 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1169 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:280
5526 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5530 #: ../src/guestfs.pod:2901 ../fish/guestfish.pod:1171 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:282 ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602 ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5535 #: ../src/guestfs.pod:2903 ../fish/guestfish.pod:1173
5536 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5540 #: ../src/guestfs.pod:2906
5542 "This library is free software; you can redistribute it and/or modify it "
5543 "under the terms of the GNU Lesser General Public License as published by the "
5544 "Free Software Foundation; either version 2 of the License, or (at your "
5545 "option) any later version."
5549 #: ../src/guestfs.pod:2911
5551 "This library is distributed in the hope that it will be useful, but WITHOUT "
5552 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5553 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5558 #: ../src/guestfs.pod:2916
5560 "You should have received a copy of the GNU Lesser General Public License "
5561 "along with this library; if not, write to the Free Software Foundation, "
5562 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5566 #: ../src/guestfs-actions.pod:1
5567 msgid "guestfs_add_cdrom"
5571 #: ../src/guestfs-actions.pod:3
5575 " guestfs_add_cdrom (guestfs_h *g,\n"
5576 " const char *filename);\n"
5581 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5582 msgid "This function adds a virtual CD-ROM disk image to the guest."
5586 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5587 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5591 #: ../src/guestfs-actions.pod:17
5593 "This call checks for the existence of C<filename>. This stops you from "
5594 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5595 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5600 #: ../src/guestfs-actions.pod:24
5602 "If you just want to add an ISO file (often you use this as an efficient way "
5603 "to transfer large files into the guest), then you should probably use "
5604 "C<guestfs_add_drive_ro> instead."
5608 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134 ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232 ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301 ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436 ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541 ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641 ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670 ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787 ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996 ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098 ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169 ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1477 ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2266 ../src/guestfs-actions.pod:2410 ../src/guestfs-actions.pod:2471 ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3491 ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:3738 ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3963 ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4010 ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4062 ../src/guestfs-actions.pod:4075 ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4233 ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4381 ../src/guestfs-actions.pod:4396 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4474 ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:4597 ../src/guestfs-actions.pod:4616 ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4645 ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4673 ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4723 ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4758 ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:4875 ../src/guestfs-actions.pod:4889 ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5143 ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5183 ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:5281 ../src/guestfs-actions.pod:5298 ../src/guestfs-actions.pod:5311 ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652 ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5676 ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702 ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5772 ../src/guestfs-actions.pod:5791 ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5860 ../src/guestfs-actions.pod:5878 ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5937 ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6025 ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6102 ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6162 ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6477 ../src/guestfs-actions.pod:6490 ../src/guestfs-actions.pod:6503 ../src/guestfs-actions.pod:6516 ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6590 ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6623 ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6689 ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6739 ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6793 ../src/guestfs-actions.pod:6811 ../src/guestfs-actions.pod:6845 ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:7000 ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7087 ../src/guestfs-actions.pod:7100 ../src/guestfs-actions.pod:7145 ../src/guestfs-actions.pod:7178 ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7258 ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7343 ../src/guestfs-actions.pod:7372
5609 msgid "This function returns 0 on success or -1 on error."
5613 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
5615 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5620 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251 ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1448 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4421 ../src/guestfs-actions.pod:7266 ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175 ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319 ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:3000 ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4955
5622 "Deprecated functions will not be removed from the API, but the fact that "
5623 "they are deprecated indicates that there are problems with correct use of "
5628 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136 ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1916 ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2117 ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3473 ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:5839 ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:7180
5629 msgid "(Added in 0.3)"
5633 #: ../src/guestfs-actions.pod:41
5634 msgid "guestfs_add_domain"
5638 #: ../src/guestfs-actions.pod:43
5642 " guestfs_add_domain (guestfs_h *g,\n"
5643 " const char *dom,\n"
5649 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145 ../src/guestfs-actions.pod:4435
5651 "You may supply a list of optional arguments to this call. Use zero or more "
5652 "of the following pairs of parameters, and terminate the list with C<-1> on "
5653 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5657 #: ../src/guestfs-actions.pod:53
5660 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5661 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5662 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5663 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5668 #: ../src/guestfs-actions.pod:58
5670 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5671 "It works by connecting to libvirt, requesting the domain and domain XML from "
5672 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5677 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5679 "The number of disks added is returned. This operation is atomic: if an "
5680 "error is returned, then no disks are added."
5684 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5686 "This function does some minimal checks to make sure the libvirt domain is "
5687 "not running (unless C<readonly> is true). In a future version we will try "
5688 "to acquire the libvirt lock on each disk."
5692 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5694 "Disks must be accessible locally. This often means that adding disks from a "
5695 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5696 "unless those disks are accessible via the same device path locally too."
5700 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5702 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5703 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5704 "default libvirt URI (or one set through an environment variable, see the "
5705 "libvirt documentation for full details)."
5709 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5711 "The optional C<live> flag controls whether this call will try to connect to "
5712 "a running virtual machine C<guestfsd> process if it sees a suitable "
5713 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5714 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5715 "DAEMONS> for more information."
5719 #: ../src/guestfs-actions.pod:88
5721 "The other optional parameters are passed directly through to "
5722 "C<guestfs_add_drive_opts>."
5726 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344 ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687 ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315 ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1877 ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2026 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2104 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2772 ../src/guestfs-actions.pod:2793 ../src/guestfs-actions.pod:4861 ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5395 ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:6766 ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7204 ../src/guestfs-actions.pod:7217
5727 msgid "On error this function returns -1."
5731 #: ../src/guestfs-actions.pod:93
5732 msgid "(Added in 1.7.4)"
5736 #: ../src/guestfs-actions.pod:95
5737 msgid "guestfs_add_domain_va"
5741 #: ../src/guestfs-actions.pod:97
5745 " guestfs_add_domain_va (guestfs_h *g,\n"
5746 " const char *dom,\n"
5752 #: ../src/guestfs-actions.pod:102
5753 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5757 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219 ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4500
5758 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5762 #: ../src/guestfs-actions.pod:106
5763 msgid "guestfs_add_domain_argv"
5767 #: ../src/guestfs-actions.pod:108
5771 " guestfs_add_domain_argv (guestfs_h *g,\n"
5772 " const char *dom,\n"
5773 " const struct guestfs_add_domain_argv *optargs);\n"
5778 #: ../src/guestfs-actions.pod:113
5779 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5783 #: ../src/guestfs-actions.pod:117
5784 msgid "guestfs_add_drive"
5788 #: ../src/guestfs-actions.pod:119
5792 " guestfs_add_drive (guestfs_h *g,\n"
5793 " const char *filename);\n"
5798 #: ../src/guestfs-actions.pod:123
5800 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5801 "optional parameters, so the disk is added writable, with the format being "
5802 "detected automatically."
5806 #: ../src/guestfs-actions.pod:127
5808 "Automatic detection of the format opens you up to a potential security hole "
5809 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5810 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5811 "you should think about replacing calls to this function with calls to "
5812 "C<guestfs_add_drive_opts>, and specifying the format."
5816 #: ../src/guestfs-actions.pod:138
5817 msgid "guestfs_add_drive_opts"
5821 #: ../src/guestfs-actions.pod:140
5825 " guestfs_add_drive_opts (guestfs_h *g,\n"
5826 " const char *filename,\n"
5832 #: ../src/guestfs-actions.pod:150
5835 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5836 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5837 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5842 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
5844 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5845 "The first time you call this function, the disk appears as C</dev/sda>, the "
5846 "second time as C</dev/sdb>, and so on."
5850 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
5852 "You don't necessarily need to be root when using libguestfs. However you "
5853 "obviously do need sufficient permissions to access the filename for whatever "
5854 "operations you want to perform (ie. read access if you just want to read the "
5855 "image or write access if you want to modify the image)."
5859 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
5860 msgid "This call checks that C<filename> exists."
5864 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4446 ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3011
5865 msgid "The optional arguments are:"
5869 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
5874 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
5876 "If true then the image is treated as read-only. Writes are still allowed, "
5877 "but they are stored in a temporary snapshot overlay which is discarded at "
5878 "the end. The disk that you add is not modified."
5882 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
5887 #: ../src/guestfs-actions.pod:179
5889 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5890 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5891 "Possible formats include C<raw> and C<qcow2>."
5895 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
5897 "Automatic detection of the format opens you up to a potential security hole "
5898 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5899 "RHBZ#642934. Specifying the format closes this security hole."
5903 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
5908 #: ../src/guestfs-actions.pod:190
5910 "This rarely-used option lets you emulate the behaviour of the deprecated "
5911 "C<guestfs_add_drive_with_if> call (q.v.)"
5915 #: ../src/guestfs-actions.pod:197
5916 msgid "(Added in 1.5.23)"
5920 #: ../src/guestfs-actions.pod:199
5921 msgid "guestfs_add_drive_opts_va"
5925 #: ../src/guestfs-actions.pod:201
5929 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5930 " const char *filename,\n"
5936 #: ../src/guestfs-actions.pod:206
5937 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5941 #: ../src/guestfs-actions.pod:210
5942 msgid "guestfs_add_drive_opts_argv"
5946 #: ../src/guestfs-actions.pod:212
5950 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5951 " const char *filename,\n"
5952 " const struct guestfs_add_drive_opts_argv "
5958 #: ../src/guestfs-actions.pod:217
5959 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5963 #: ../src/guestfs-actions.pod:221
5964 msgid "guestfs_add_drive_ro"
5968 #: ../src/guestfs-actions.pod:223
5972 " guestfs_add_drive_ro (guestfs_h *g,\n"
5973 " const char *filename);\n"
5978 #: ../src/guestfs-actions.pod:227
5980 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5981 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5982 "disk is added read-only, with the format being detected automatically."
5986 #: ../src/guestfs-actions.pod:234
5987 msgid "(Added in 1.0.38)"
5991 #: ../src/guestfs-actions.pod:236
5992 msgid "guestfs_add_drive_ro_with_if"
5996 #: ../src/guestfs-actions.pod:238
6000 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6001 " const char *filename,\n"
6002 " const char *iface);\n"
6007 #: ../src/guestfs-actions.pod:243
6009 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6010 "QEMU interface emulation to use at run time."
6014 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:2356
6015 msgid "(Added in 1.0.84)"
6019 #: ../src/guestfs-actions.pod:257
6020 msgid "guestfs_add_drive_with_if"
6024 #: ../src/guestfs-actions.pod:259
6028 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6029 " const char *filename,\n"
6030 " const char *iface);\n"
6035 #: ../src/guestfs-actions.pod:264
6037 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6038 "QEMU interface emulation to use at run time."
6042 #: ../src/guestfs-actions.pod:278
6043 msgid "guestfs_aug_clear"
6047 #: ../src/guestfs-actions.pod:280
6051 " guestfs_aug_clear (guestfs_h *g,\n"
6052 " const char *augpath);\n"
6057 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6059 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6060 "L<augtool(1)> C<clear> command."
6064 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2106
6065 msgid "(Added in 1.3.4)"
6069 #: ../src/guestfs-actions.pod:291
6070 msgid "guestfs_aug_close"
6074 #: ../src/guestfs-actions.pod:293
6078 " guestfs_aug_close (guestfs_h *g);\n"
6083 #: ../src/guestfs-actions.pod:296
6085 "Close the current Augeas handle and free up any resources used by it. After "
6086 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6087 "any other Augeas functions."
6091 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328 ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438 ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483 ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511 ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543 ../src/guestfs-actions.pod:5472
6092 msgid "(Added in 0.7)"
6096 #: ../src/guestfs-actions.pod:305
6097 msgid "guestfs_aug_defnode"
6101 #: ../src/guestfs-actions.pod:307
6104 " struct guestfs_int_bool *\n"
6105 " guestfs_aug_defnode (guestfs_h *g,\n"
6106 " const char *name,\n"
6107 " const char *expr,\n"
6108 " const char *val);\n"
6113 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6114 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6118 #: ../src/guestfs-actions.pod:316
6120 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6121 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6122 "containing that single node."
6126 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6128 "On success this returns a pair containing the number of nodes in the "
6129 "nodeset, and a boolean flag if a node was created."
6133 #: ../src/guestfs-actions.pod:324
6135 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6136 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6140 #: ../src/guestfs-actions.pod:330
6141 msgid "guestfs_aug_defvar"
6145 #: ../src/guestfs-actions.pod:332
6149 " guestfs_aug_defvar (guestfs_h *g,\n"
6150 " const char *name,\n"
6151 " const char *expr);\n"
6156 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6158 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6159 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6163 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6165 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6166 "evaluates to something which is not a nodeset."
6170 #: ../src/guestfs-actions.pod:348
6171 msgid "guestfs_aug_get"
6175 #: ../src/guestfs-actions.pod:350
6179 " guestfs_aug_get (guestfs_h *g,\n"
6180 " const char *augpath);\n"
6185 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6187 "Look up the value associated with C<path>. If C<path> matches exactly one "
6188 "node, the C<value> is returned."
6192 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857 ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935 ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201 ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1354 ../src/guestfs-actions.pod:1545 ../src/guestfs-actions.pod:1657 ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1837 ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1938 ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2864 ../src/guestfs-actions.pod:2895 ../src/guestfs-actions.pod:2919 ../src/guestfs-actions.pod:2956 ../src/guestfs-actions.pod:3016 ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3060 ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4262 ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5370 ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:6209 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6242 ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6940 ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7429
6194 "This function returns a string, or NULL on error. I<The caller must free "
6195 "the returned string after use>."
6199 #: ../src/guestfs-actions.pod:362
6200 msgid "guestfs_aug_init"
6204 #: ../src/guestfs-actions.pod:364
6208 " guestfs_aug_init (guestfs_h *g,\n"
6209 " const char *root,\n"
6215 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6217 "Create a new Augeas handle for editing configuration files. If there was "
6218 "any previous Augeas handle associated with this guestfs session, then it is "
6223 #: ../src/guestfs-actions.pod:373
6224 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6228 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6229 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6233 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6235 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6236 "logical I<or> of the following integers:"
6240 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6241 msgid "C<AUG_SAVE_BACKUP> = 1"
6245 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6246 msgid "Keep the original file with a C<.augsave> extension."
6250 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6251 msgid "C<AUG_SAVE_NEWFILE> = 2"
6255 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6257 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6258 "original. Overrides C<AUG_SAVE_BACKUP>."
6262 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6263 msgid "C<AUG_TYPE_CHECK> = 4"
6267 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6268 msgid "Typecheck lenses (can be expensive)."
6272 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6273 msgid "C<AUG_NO_STDINC> = 8"
6277 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6278 msgid "Do not use standard load path for modules."
6282 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6283 msgid "C<AUG_SAVE_NOOP> = 16"
6287 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6288 msgid "Make save a no-op, just record what would have been changed."
6292 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6293 msgid "C<AUG_NO_LOAD> = 32"
6297 #: ../src/guestfs-actions.pod:408
6298 msgid "Do not load the tree in C<guestfs_aug_init>."
6302 #: ../src/guestfs-actions.pod:412
6303 msgid "To close the handle, you can call C<guestfs_aug_close>."
6307 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6308 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6312 #: ../src/guestfs-actions.pod:420
6313 msgid "guestfs_aug_insert"
6317 #: ../src/guestfs-actions.pod:422
6321 " guestfs_aug_insert (guestfs_h *g,\n"
6322 " const char *augpath,\n"
6323 " const char *label,\n"
6329 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6331 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6332 "or after C<path> (depending on the boolean flag C<before>)."
6336 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6338 "C<path> must match exactly one existing node in the tree, and C<label> must "
6339 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6343 #: ../src/guestfs-actions.pod:440
6344 msgid "guestfs_aug_load"
6348 #: ../src/guestfs-actions.pod:442
6352 " guestfs_aug_load (guestfs_h *g);\n"
6357 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6358 msgid "Load files into the tree."
6362 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6363 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6367 #: ../src/guestfs-actions.pod:454
6368 msgid "guestfs_aug_ls"
6372 #: ../src/guestfs-actions.pod:456
6376 " guestfs_aug_ls (guestfs_h *g,\n"
6377 " const char *augpath);\n"
6382 #: ../src/guestfs-actions.pod:460
6384 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6385 "sorting the resulting nodes into alphabetical order."
6389 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479 ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1369 ../src/guestfs-actions.pod:1388 ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1510 ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:2201 ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2236 ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2423 ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2973 ../src/guestfs-actions.pod:3262 ../src/guestfs-actions.pod:3552 ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3719 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:5582 ../src/guestfs-actions.pod:6282 ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6398 ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7070 ../src/guestfs-actions.pod:7117 ../src/guestfs-actions.pod:7282 ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7386 ../src/guestfs-actions.pod:7405 ../src/guestfs-actions.pod:7451 ../src/guestfs-actions.pod:7470
6391 "This function returns a NULL-terminated array of strings (like "
6392 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6393 "strings and the array after use>."
6397 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1426 ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4015 ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4235 ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4826 ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5678 ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6782 ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:7034 ../src/guestfs-actions.pod:7270
6398 msgid "(Added in 0.8)"
6402 #: ../src/guestfs-actions.pod:469
6403 msgid "guestfs_aug_match"
6407 #: ../src/guestfs-actions.pod:471
6411 " guestfs_aug_match (guestfs_h *g,\n"
6412 " const char *augpath);\n"
6417 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6419 "Returns a list of paths which match the path expression C<path>. The "
6420 "returned paths are sufficiently qualified so that they match exactly one "
6421 "node in the current tree."
6425 #: ../src/guestfs-actions.pod:485
6426 msgid "guestfs_aug_mv"
6430 #: ../src/guestfs-actions.pod:487
6434 " guestfs_aug_mv (guestfs_h *g,\n"
6435 " const char *src,\n"
6436 " const char *dest);\n"
6441 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6443 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6444 "C<dest> is overwritten if it exists."
6448 #: ../src/guestfs-actions.pod:499
6449 msgid "guestfs_aug_rm"
6453 #: ../src/guestfs-actions.pod:501
6457 " guestfs_aug_rm (guestfs_h *g,\n"
6458 " const char *augpath);\n"
6463 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6464 msgid "Remove C<path> and all of its children."
6468 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6469 msgid "On success this returns the number of entries which were removed."
6473 #: ../src/guestfs-actions.pod:513
6474 msgid "guestfs_aug_save"
6478 #: ../src/guestfs-actions.pod:515
6482 " guestfs_aug_save (guestfs_h *g);\n"
6487 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6488 msgid "This writes all pending changes to disk."
6492 #: ../src/guestfs-actions.pod:520
6494 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6499 #: ../src/guestfs-actions.pod:527
6500 msgid "guestfs_aug_set"
6504 #: ../src/guestfs-actions.pod:529
6508 " guestfs_aug_set (guestfs_h *g,\n"
6509 " const char *augpath,\n"
6510 " const char *val);\n"
6515 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6516 msgid "Set the value associated with C<path> to C<val>."
6520 #: ../src/guestfs-actions.pod:536
6522 "In the Augeas API, it is possible to clear a node by setting the value to "
6523 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6524 "this call. Instead you must use the C<guestfs_aug_clear> call."
6528 #: ../src/guestfs-actions.pod:545
6529 msgid "guestfs_available"
6533 #: ../src/guestfs-actions.pod:547
6537 " guestfs_available (guestfs_h *g,\n"
6538 " char *const *groups);\n"
6543 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6545 "This command is used to check the availability of some groups of "
6546 "functionality in the appliance, which not all builds of the libguestfs "
6547 "appliance will be able to provide."
6551 #: ../src/guestfs-actions.pod:555
6553 "The libguestfs groups, and the functions that those groups correspond to, "
6554 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6555 "runtime by calling C<guestfs_available_all_groups>."
6559 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6561 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6562 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6563 "and Augeas (configuration file editing) functions."
6567 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6568 msgid "The command returns no error if I<all> requested groups are available."
6572 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6574 "It fails with an error if one or more of the requested groups is unavailable "
6579 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6581 "If an unknown group name is included in the list of groups then an error is "
6586 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6591 #: ../src/guestfs-actions.pod:579
6592 msgid "You must call C<guestfs_launch> before calling this function."
6596 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6598 "The reason is because we don't know what groups are supported by the "
6599 "appliance/daemon until it is running and can be queried."
6603 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6605 "If a group of functions is available, this does not necessarily mean that "
6606 "they will work. You still have to check for errors when calling individual "
6607 "API functions even if they are available."
6611 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6613 "It is usually the job of distro packagers to build complete functionality "
6614 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6615 "with all requirements satisfied, will support everything."
6619 #: ../src/guestfs-actions.pod:601
6621 "This call was added in version C<1.0.80>. In previous versions of "
6622 "libguestfs all you could do would be to speculatively execute a command to "
6623 "find out if the daemon implemented it. See also C<guestfs_version>."
6627 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6628 msgid "(Added in 1.0.80)"
6632 #: ../src/guestfs-actions.pod:612
6633 msgid "guestfs_available_all_groups"
6637 #: ../src/guestfs-actions.pod:614
6641 " guestfs_available_all_groups (guestfs_h *g);\n"
6646 #: ../src/guestfs-actions.pod:617
6648 "This command returns a list of all optional groups that this daemon knows "
6649 "about. Note this returns both supported and unsupported groups. To find "
6650 "out which ones the daemon can actually support you have to call "
6651 "C<guestfs_available> on each member of the returned list."
6655 #: ../src/guestfs-actions.pod:623
6656 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6660 #: ../src/guestfs-actions.pod:629
6661 msgid "(Added in 1.3.15)"
6665 #: ../src/guestfs-actions.pod:631
6666 msgid "guestfs_base64_in"
6670 #: ../src/guestfs-actions.pod:633
6674 " guestfs_base64_in (guestfs_h *g,\n"
6675 " const char *base64file,\n"
6676 " const char *filename);\n"
6681 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6682 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6686 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6687 msgid "(Added in 1.3.5)"
6691 #: ../src/guestfs-actions.pod:645
6692 msgid "guestfs_base64_out"
6696 #: ../src/guestfs-actions.pod:647
6700 " guestfs_base64_out (guestfs_h *g,\n"
6701 " const char *filename,\n"
6702 " const char *base64file);\n"
6707 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
6709 "This command downloads the contents of C<filename>, writing it out to local "
6710 "file C<base64file> encoded as base64."
6714 #: ../src/guestfs-actions.pod:659
6715 msgid "guestfs_blockdev_flushbufs"
6719 #: ../src/guestfs-actions.pod:661
6723 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6724 " const char *device);\n"
6729 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
6730 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6734 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685 ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753 ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785 ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813 ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459 ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503 ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522 ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
6735 msgid "This uses the L<blockdev(8)> command."
6739 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689 ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720 ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757 ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789 ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
6740 msgid "(Added in 0.9.3)"
6744 #: ../src/guestfs-actions.pod:674
6745 msgid "guestfs_blockdev_getbsz"
6749 #: ../src/guestfs-actions.pod:676
6753 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6754 " const char *device);\n"
6759 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
6760 msgid "This returns the block size of a device."
6764 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782 ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
6766 "(Note this is different from both I<size in blocks> and I<filesystem block "
6771 #: ../src/guestfs-actions.pod:691
6772 msgid "guestfs_blockdev_getro"
6776 #: ../src/guestfs-actions.pod:693
6780 " guestfs_blockdev_getro (guestfs_h *g,\n"
6781 " const char *device);\n"
6786 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
6788 "Returns a boolean indicating if the block device is read-only (true if "
6789 "read-only, false if not)."
6793 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1409 ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1914 ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1997 ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2067 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2115 ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3279 ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:3308 ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3396 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3425 ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:4971
6794 msgid "This function returns a C truth value on success or -1 on error."
6798 #: ../src/guestfs-actions.pod:706
6799 msgid "guestfs_blockdev_getsize64"
6803 #: ../src/guestfs-actions.pod:708
6807 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6808 " const char *device);\n"
6813 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
6814 msgid "This returns the size of the device in bytes."
6818 #: ../src/guestfs-actions.pod:714
6819 msgid "See also C<guestfs_blockdev_getsz>."
6823 #: ../src/guestfs-actions.pod:722
6824 msgid "guestfs_blockdev_getss"
6828 #: ../src/guestfs-actions.pod:724
6832 " guestfs_blockdev_getss (guestfs_h *g,\n"
6833 " const char *device);\n"
6838 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
6840 "This returns the size of sectors on a block device. Usually 512, but can be "
6841 "larger for modern devices."
6845 #: ../src/guestfs-actions.pod:731
6847 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6852 #: ../src/guestfs-actions.pod:740
6853 msgid "guestfs_blockdev_getsz"
6857 #: ../src/guestfs-actions.pod:742
6861 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6862 " const char *device);\n"
6867 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
6869 "This returns the size of the device in units of 512-byte sectors (even if "
6870 "the sectorsize isn't 512 bytes ... weird)."
6874 #: ../src/guestfs-actions.pod:749
6876 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6877 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6881 #: ../src/guestfs-actions.pod:759
6882 msgid "guestfs_blockdev_rereadpt"
6886 #: ../src/guestfs-actions.pod:761
6890 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6891 " const char *device);\n"
6896 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
6897 msgid "Reread the partition table on C<device>."
6901 #: ../src/guestfs-actions.pod:773
6902 msgid "guestfs_blockdev_setbsz"
6906 #: ../src/guestfs-actions.pod:775
6910 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6911 " const char *device,\n"
6912 " int blocksize);\n"
6917 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
6918 msgid "This sets the block size of a device."
6922 #: ../src/guestfs-actions.pod:791
6923 msgid "guestfs_blockdev_setro"
6927 #: ../src/guestfs-actions.pod:793
6931 " guestfs_blockdev_setro (guestfs_h *g,\n"
6932 " const char *device);\n"
6937 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
6938 msgid "Sets the block device named C<device> to read-only."
6942 #: ../src/guestfs-actions.pod:805
6943 msgid "guestfs_blockdev_setrw"
6947 #: ../src/guestfs-actions.pod:807
6951 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6952 " const char *device);\n"
6957 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
6958 msgid "Sets the block device named C<device> to read-write."
6962 #: ../src/guestfs-actions.pod:819
6963 msgid "guestfs_case_sensitive_path"
6967 #: ../src/guestfs-actions.pod:821
6971 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6972 " const char *path);\n"
6977 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
6979 "This can be used to resolve case insensitive paths on a filesystem which is "
6980 "case sensitive. The use case is to resolve paths which you have read from "
6981 "Windows configuration files or the Windows Registry, to the true path."
6985 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
6987 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6988 "(and probably others), which is that although the underlying filesystem is "
6989 "case-insensitive, the driver exports the filesystem to Linux as "
6994 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
6996 "One consequence of this is that special directories such as C<c:\\windows> "
6997 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6998 "precise details of how they were created. In Windows itself this would not "
7003 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
7005 "Bug or feature? You decide: "
7006 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7010 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
7012 "This function resolves the true case of each element in the path and returns "
7013 "the case-sensitive path."
7017 #: ../src/guestfs-actions.pod:847
7019 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7020 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7021 "how the directories were originally created under Windows)."
7025 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7026 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7030 #: ../src/guestfs-actions.pod:855
7031 msgid "See also C<guestfs_realpath>."
7035 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6962
7036 msgid "(Added in 1.0.75)"
7040 #: ../src/guestfs-actions.pod:862
7045 #: ../src/guestfs-actions.pod:864
7049 " guestfs_cat (guestfs_h *g,\n"
7050 " const char *path);\n"
7055 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3659
7056 msgid "Return the contents of the file named C<path>."
7060 #: ../src/guestfs-actions.pod:870
7062 "Note that this function cannot correctly handle binary files (specifically, "
7063 "files containing C<\\0> character which is treated as end of string). For "
7064 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7065 "functions which have a more complex interface."
7069 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1373 ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:1495 ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1763 ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2353 ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5266 ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6347 ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:6572 ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7286 ../src/guestfs-actions.pod:7305 ../src/guestfs-actions.pod:7390 ../src/guestfs-actions.pod:7409 ../src/guestfs-actions.pod:7455 ../src/guestfs-actions.pod:7474 ../fish/guestfish-actions.pod:587 ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734 ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920 ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997 ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493 ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556 ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3529 ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3620 ../fish/guestfish-actions.pod:3637 ../fish/guestfish-actions.pod:3652 ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4324 ../fish/guestfish-actions.pod:4409 ../fish/guestfish-actions.pod:4424 ../fish/guestfish-actions.pod:4834 ../fish/guestfish-actions.pod:4852 ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:4879 ../fish/guestfish-actions.pod:4927 ../fish/guestfish-actions.pod:4937 ../fish/guestfish-actions.pod:4966 ../fish/guestfish-actions.pod:4976
7071 "Because of the message protocol, there is a transfer limit of somewhere "
7072 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7076 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3556 ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3635 ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5360 ../src/guestfs-actions.pod:7121 ../src/guestfs-actions.pod:7135
7077 msgid "(Added in 0.4)"
7081 #: ../src/guestfs-actions.pod:883
7082 msgid "guestfs_checksum"
7086 #: ../src/guestfs-actions.pod:885
7090 " guestfs_checksum (guestfs_h *g,\n"
7091 " const char *csumtype,\n"
7092 " const char *path);\n"
7097 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7098 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7102 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7104 "The type of checksum to compute is given by the C<csumtype> parameter which "
7105 "must have one of the following values:"
7109 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7114 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7116 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7121 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7126 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7127 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7131 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7136 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7137 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7141 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7146 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7147 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7151 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7156 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7157 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7161 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7166 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7167 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7171 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7176 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7177 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7181 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7182 msgid "The checksum is returned as a printable string."
7186 #: ../src/guestfs-actions.pod:931
7187 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7191 #: ../src/guestfs-actions.pod:933
7192 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7196 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:3295 ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:6818
7197 msgid "(Added in 1.0.2)"
7201 #: ../src/guestfs-actions.pod:940
7202 msgid "guestfs_checksum_device"
7206 #: ../src/guestfs-actions.pod:942
7210 " guestfs_checksum_device (guestfs_h *g,\n"
7211 " const char *csumtype,\n"
7212 " const char *device);\n"
7217 #: ../src/guestfs-actions.pod:947
7219 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7220 "device named C<device>. For the types of checksums supported see the "
7221 "C<guestfs_checksum> command."
7225 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4877 ../src/guestfs-actions.pod:4936 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:4991 ../src/guestfs-actions.pod:5167 ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:7147
7226 msgid "(Added in 1.3.2)"
7230 #: ../src/guestfs-actions.pod:956
7231 msgid "guestfs_checksums_out"
7235 #: ../src/guestfs-actions.pod:958
7239 " guestfs_checksums_out (guestfs_h *g,\n"
7240 " const char *csumtype,\n"
7241 " const char *directory,\n"
7242 " const char *sumsfile);\n"
7247 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7249 "This command computes the checksums of all regular files in C<directory> and "
7250 "then emits a list of those checksums to the local output file C<sumsfile>."
7254 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7256 "This can be used for verifying the integrity of a virtual machine. However "
7257 "to be properly secure you should pay attention to the output of the checksum "
7258 "command (it uses the ones from GNU coreutils). In particular when the "
7259 "filename is not printable, coreutils uses a special backslash syntax. For "
7260 "more information, see the GNU coreutils info file."
7264 #: ../src/guestfs-actions.pod:978
7265 msgid "(Added in 1.3.7)"
7269 #: ../src/guestfs-actions.pod:980
7270 msgid "guestfs_chmod"
7274 #: ../src/guestfs-actions.pod:982
7278 " guestfs_chmod (guestfs_h *g,\n"
7280 " const char *path);\n"
7285 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7287 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7292 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7294 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7295 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7300 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4379 ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4595 ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:676 ../fish/guestfish-actions.pod:2975 ../fish/guestfish-actions.pod:3104 ../fish/guestfish-actions.pod:3114 ../fish/guestfish-actions.pod:3124
7301 msgid "The mode actually set is affected by the umask."
7305 #: ../src/guestfs-actions.pod:1000
7306 msgid "guestfs_chown"
7310 #: ../src/guestfs-actions.pod:1002
7314 " guestfs_chown (guestfs_h *g,\n"
7317 " const char *path);\n"
7322 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7323 msgid "Change the file owner to C<owner> and group to C<group>."
7327 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3487 ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2433
7329 "Only numeric uid and gid are supported. If you want to use names, you will "
7330 "need to locate and parse the password file yourself (Augeas support makes "
7331 "this relatively easy)."
7335 #: ../src/guestfs-actions.pod:1018
7336 msgid "guestfs_command"
7340 #: ../src/guestfs-actions.pod:1020
7344 " guestfs_command (guestfs_h *g,\n"
7345 " char *const *arguments);\n"
7350 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7352 "This call runs a command from the guest filesystem. The filesystem must be "
7353 "mounted, and must contain a compatible operating system (ie. something "
7354 "Linux, with the same or compatible processor architecture)."
7358 #: ../src/guestfs-actions.pod:1029
7360 "The single parameter is an argv-style list of arguments. The first element "
7361 "is the name of the program to run. Subsequent elements are parameters. The "
7362 "list must be non-empty (ie. must contain a program name). Note that the "
7363 "command runs directly, and is I<not> invoked via the shell (see "
7368 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7369 msgid "The return value is anything printed to I<stdout> by the command."
7373 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7375 "If the command returns a non-zero exit status, then this function returns an "
7376 "error message. The error message string is the content of I<stderr> from "
7381 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7383 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7384 "C</bin>. If you require a program from another location, you should provide "
7385 "the full path in the first parameter."
7389 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7391 "Shared libraries and data files required by the program must be available on "
7392 "filesystems which are mounted in the correct places. It is the caller's "
7393 "responsibility to ensure all filesystems that are needed are mounted at the "
7398 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:1548
7399 msgid "(Added in 0.9.1)"
7403 #: ../src/guestfs-actions.pod:1062
7404 msgid "guestfs_command_lines"
7408 #: ../src/guestfs-actions.pod:1064
7412 " guestfs_command_lines (guestfs_h *g,\n"
7413 " char *const *arguments);\n"
7418 #: ../src/guestfs-actions.pod:1068
7420 "This is the same as C<guestfs_command>, but splits the result into a list of "
7425 #: ../src/guestfs-actions.pod:1071
7426 msgid "See also: C<guestfs_sh_lines>"
7430 #: ../src/guestfs-actions.pod:1082
7431 msgid "guestfs_config"
7435 #: ../src/guestfs-actions.pod:1084
7439 " guestfs_config (guestfs_h *g,\n"
7440 " const char *qemuparam,\n"
7441 " const char *qemuvalue);\n"
7446 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7448 "This can be used to add arbitrary qemu command line parameters of the form "
7449 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
7450 "setting some parameters which would interfere with parameters that we use."
7454 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7455 msgid "The first character of C<param> string must be a C<-> (dash)."
7459 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7460 msgid "C<value> can be NULL."
7464 #: ../src/guestfs-actions.pod:1102
7465 msgid "guestfs_copy_size"
7469 #: ../src/guestfs-actions.pod:1104
7473 " guestfs_copy_size (guestfs_h *g,\n"
7474 " const char *src,\n"
7475 " const char *dest,\n"
7481 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7483 "This command copies exactly C<size> bytes from one source device or file "
7484 "C<src> to another destination device or file C<dest>."
7488 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7490 "Note this will fail if the source is too short or if the destination is not "
7495 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1317 ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719 ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:7326 ../src/guestfs-actions.pod:7345
7497 "This long-running command can generate progress notification messages so "
7498 "that the caller can display a progress bar or indicator. To receive these "
7499 "messages, the caller must register a progress event callback. See "
7500 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7504 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4155 ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7160
7505 msgid "(Added in 1.0.87)"
7509 #: ../src/guestfs-actions.pod:1125
7514 #: ../src/guestfs-actions.pod:1127
7518 " guestfs_cp (guestfs_h *g,\n"
7519 " const char *src,\n"
7520 " const char *dest);\n"
7525 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7527 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7528 "destination filename or destination directory."
7532 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151 ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:4840 ../src/guestfs-actions.pod:5217
7533 msgid "(Added in 1.0.18)"
7537 #: ../src/guestfs-actions.pod:1139
7538 msgid "guestfs_cp_a"
7542 #: ../src/guestfs-actions.pod:1141
7546 " guestfs_cp_a (guestfs_h *g,\n"
7547 " const char *src,\n"
7548 " const char *dest);\n"
7553 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7555 "This copies a file or directory from C<src> to C<dest> recursively using the "
7560 #: ../src/guestfs-actions.pod:1153
7565 #: ../src/guestfs-actions.pod:1155
7569 " guestfs_dd (guestfs_h *g,\n"
7570 " const char *src,\n"
7571 " const char *dest);\n"
7576 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7578 "This command copies from one source device or file C<src> to another "
7579 "destination device or file C<dest>. Normally you would use this to copy to "
7580 "or from a device or partition, for example to duplicate a filesystem."
7584 #: ../src/guestfs-actions.pod:1165
7586 "If the destination is a device, it must be as large or larger than the "
7587 "source file or device, otherwise the copy will fail. This command cannot do "
7588 "partial copies (see C<guestfs_copy_size>)."
7592 #: ../src/guestfs-actions.pod:1173
7597 #: ../src/guestfs-actions.pod:1175
7601 " guestfs_df (guestfs_h *g);\n"
7606 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
7607 msgid "This command runs the C<df> command to report disk space used."
7611 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
7613 "This command is mostly useful for interactive sessions. It is I<not> "
7614 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7619 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204 ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:2286 ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2378 ../src/guestfs-actions.pod:4265 ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:6551 ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7206 ../src/guestfs-actions.pod:7219
7620 msgid "(Added in 1.0.54)"
7624 #: ../src/guestfs-actions.pod:1189
7625 msgid "guestfs_df_h"
7629 #: ../src/guestfs-actions.pod:1191
7633 " guestfs_df_h (guestfs_h *g);\n"
7638 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
7640 "This command runs the C<df -h> command to report disk space used in "
7641 "human-readable format."
7645 #: ../src/guestfs-actions.pod:1206
7646 msgid "guestfs_dmesg"
7650 #: ../src/guestfs-actions.pod:1208
7654 " guestfs_dmesg (guestfs_h *g);\n"
7659 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
7661 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7662 "This is sometimes useful for extended debugging of problems."
7666 #: ../src/guestfs-actions.pod:1215
7668 "Another way to get the same information is to enable verbose messages with "
7669 "C<guestfs_set_verbose> or by setting the environment variable "
7670 "C<LIBGUESTFS_DEBUG=1> before running the program."
7674 #: ../src/guestfs-actions.pod:1225
7675 msgid "guestfs_download"
7679 #: ../src/guestfs-actions.pod:1227
7683 " guestfs_download (guestfs_h *g,\n"
7684 " const char *remotefilename,\n"
7685 " const char *filename);\n"
7690 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
7692 "Download file C<remotefilename> and save it as C<filename> on the local "
7697 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4582
7698 msgid "C<filename> can also be a named pipe."
7702 #: ../src/guestfs-actions.pod:1237
7703 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7707 #: ../src/guestfs-actions.pod:1248
7708 msgid "guestfs_download_offset"
7712 #: ../src/guestfs-actions.pod:1250
7716 " guestfs_download_offset (guestfs_h *g,\n"
7717 " const char *remotefilename,\n"
7718 " const char *filename,\n"
7719 " int64_t offset,\n"
7725 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
7727 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7728 "region must be within the file or device)."
7732 #: ../src/guestfs-actions.pod:1263
7734 "Note that there is no limit on the amount of data that can be downloaded "
7735 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7736 "full amount unless an error occurs."
7740 #: ../src/guestfs-actions.pod:1268
7741 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7745 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6852
7746 msgid "(Added in 1.5.17)"
7750 #: ../src/guestfs-actions.pod:1279
7751 msgid "guestfs_drop_caches"
7755 #: ../src/guestfs-actions.pod:1281
7759 " guestfs_drop_caches (guestfs_h *g,\n"
7760 " int whattodrop);\n"
7765 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
7767 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7768 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7769 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7773 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
7774 msgid "Setting C<whattodrop> to 3 should drop everything."
7778 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
7780 "This automatically calls L<sync(2)> before the operation, so that the "
7781 "maximum guest memory is freed."
7785 #: ../src/guestfs-actions.pod:1299
7790 #: ../src/guestfs-actions.pod:1301
7794 " guestfs_du (guestfs_h *g,\n"
7795 " const char *path);\n"
7800 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
7802 "This command runs the C<du -s> command to estimate file space usage for "
7807 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
7809 "C<path> can be a file or a directory. If C<path> is a directory then the "
7810 "estimate includes the contents of the directory and all subdirectories "
7815 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
7816 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7820 #: ../src/guestfs-actions.pod:1324
7821 msgid "guestfs_e2fsck_f"
7825 #: ../src/guestfs-actions.pod:1326
7829 " guestfs_e2fsck_f (guestfs_h *g,\n"
7830 " const char *device);\n"
7835 #: ../src/guestfs-actions.pod:1330 ../fish/guestfish-actions.pod:885
7837 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7838 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7843 #: ../src/guestfs-actions.pod:1334
7845 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7846 "Normally you should use C<guestfs_fsck>."
7850 #: ../src/guestfs-actions.pod:1339
7851 msgid "(Added in 1.0.29)"
7855 #: ../src/guestfs-actions.pod:1341
7856 msgid "guestfs_echo_daemon"
7860 #: ../src/guestfs-actions.pod:1343
7864 " guestfs_echo_daemon (guestfs_h *g,\n"
7865 " char *const *words);\n"
7870 #: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:896
7872 "This command concatenates the list of C<words> passed with single spaces "
7873 "between them and returns the resulting string."
7877 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:899
7878 msgid "You can use this command to test the connection through to the daemon."
7882 #: ../src/guestfs-actions.pod:1352
7883 msgid "See also C<guestfs_ping_daemon>."
7887 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6051
7888 msgid "(Added in 1.0.69)"
7892 #: ../src/guestfs-actions.pod:1359
7893 msgid "guestfs_egrep"
7897 #: ../src/guestfs-actions.pod:1361
7901 " guestfs_egrep (guestfs_h *g,\n"
7902 " const char *regex,\n"
7903 " const char *path);\n"
7908 #: ../src/guestfs-actions.pod:1366 ../fish/guestfish-actions.pod:907
7909 msgid "This calls the external C<egrep> program and returns the matching lines."
7913 #: ../src/guestfs-actions.pod:1376 ../src/guestfs-actions.pod:1395 ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1498 ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2427 ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2495 ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3675 ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:4675 ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5600 ../src/guestfs-actions.pod:6419 ../src/guestfs-actions.pod:6431 ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6457 ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6492 ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:7289 ../src/guestfs-actions.pod:7308 ../src/guestfs-actions.pod:7393 ../src/guestfs-actions.pod:7412 ../src/guestfs-actions.pod:7458 ../src/guestfs-actions.pod:7477
7914 msgid "(Added in 1.0.66)"
7918 #: ../src/guestfs-actions.pod:1378
7919 msgid "guestfs_egrepi"
7923 #: ../src/guestfs-actions.pod:1380
7927 " guestfs_egrepi (guestfs_h *g,\n"
7928 " const char *regex,\n"
7929 " const char *path);\n"
7934 #: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:917
7935 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7939 #: ../src/guestfs-actions.pod:1397
7940 msgid "guestfs_equal"
7944 #: ../src/guestfs-actions.pod:1399
7948 " guestfs_equal (guestfs_h *g,\n"
7949 " const char *file1,\n"
7950 " const char *file2);\n"
7955 #: ../src/guestfs-actions.pod:1404 ../fish/guestfish-actions.pod:927
7957 "This compares the two files C<file1> and C<file2> and returns true if their "
7958 "content is exactly equal, or false otherwise."
7962 #: ../src/guestfs-actions.pod:1407 ../fish/guestfish-actions.pod:930
7963 msgid "The external L<cmp(1)> program is used for the comparison."
7967 #: ../src/guestfs-actions.pod:1413
7968 msgid "guestfs_exists"
7972 #: ../src/guestfs-actions.pod:1415
7976 " guestfs_exists (guestfs_h *g,\n"
7977 " const char *path);\n"
7982 #: ../src/guestfs-actions.pod:1419 ../fish/guestfish-actions.pod:936
7984 "This returns C<true> if and only if there is a file, directory (or anything) "
7985 "with the given C<path> name."
7989 #: ../src/guestfs-actions.pod:1422
7990 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7994 #: ../src/guestfs-actions.pod:1428
7995 msgid "guestfs_fallocate"
7999 #: ../src/guestfs-actions.pod:1430
8003 " guestfs_fallocate (guestfs_h *g,\n"
8004 " const char *path,\n"
8010 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1461 ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
8012 "This command preallocates a file (containing zero bytes) named C<path> of "
8013 "size C<len> bytes. If the file exists already, it is overwritten."
8017 #: ../src/guestfs-actions.pod:1439 ../fish/guestfish-actions.pod:949
8019 "Do not confuse this with the guestfish-specific C<alloc> command which "
8020 "allocates a file in the host and attaches it as a device."
8024 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:953
8026 "This function is deprecated. In new code, use the C<fallocate64> call "
8031 #: ../src/guestfs-actions.pod:1454
8032 msgid "guestfs_fallocate64"
8036 #: ../src/guestfs-actions.pod:1456
8040 " guestfs_fallocate64 (guestfs_h *g,\n"
8041 " const char *path,\n"
8047 #: ../src/guestfs-actions.pod:1465
8049 "Note that this call allocates disk blocks for the file. To create a sparse "
8050 "file use C<guestfs_truncate_size> instead."
8054 #: ../src/guestfs-actions.pod:1468
8056 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8057 "oversight it only allowed 30 bit lengths to be specified, effectively "
8058 "limiting the maximum size of files created through that call to 1GB."
8062 #: ../src/guestfs-actions.pod:1473 ../fish/guestfish-actions.pod:976
8064 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8065 "commands which create a file in the host and attach it as a device."
8069 #: ../src/guestfs-actions.pod:1479
8070 msgid "(Added in 1.3.17)"
8074 #: ../src/guestfs-actions.pod:1481
8075 msgid "guestfs_fgrep"
8079 #: ../src/guestfs-actions.pod:1483
8083 " guestfs_fgrep (guestfs_h *g,\n"
8084 " const char *pattern,\n"
8085 " const char *path);\n"
8090 #: ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:984
8091 msgid "This calls the external C<fgrep> program and returns the matching lines."
8095 #: ../src/guestfs-actions.pod:1500
8096 msgid "guestfs_fgrepi"
8100 #: ../src/guestfs-actions.pod:1502
8104 " guestfs_fgrepi (guestfs_h *g,\n"
8105 " const char *pattern,\n"
8106 " const char *path);\n"
8111 #: ../src/guestfs-actions.pod:1507 ../fish/guestfish-actions.pod:994
8112 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8116 #: ../src/guestfs-actions.pod:1519
8117 msgid "guestfs_file"
8121 #: ../src/guestfs-actions.pod:1521
8125 " guestfs_file (guestfs_h *g,\n"
8126 " const char *path);\n"
8131 #: ../src/guestfs-actions.pod:1525 ../fish/guestfish-actions.pod:1004
8133 "This call uses the standard L<file(1)> command to determine the type or "
8134 "contents of the file."
8138 #: ../src/guestfs-actions.pod:1528 ../fish/guestfish-actions.pod:1007
8140 "This call will also transparently look inside various types of compressed "
8145 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1010
8147 "The exact command which runs is C<file -zb path>. Note in particular that "
8148 "the filename is not prepended to the output (the C<-b> option)."
8152 #: ../src/guestfs-actions.pod:1535
8154 "This command can also be used on C</dev/> devices (and partitions, LV "
8155 "names). You can for example use this to determine if a device contains a "
8156 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8160 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8162 "If the C<path> does not begin with C</dev/> then this command only works for "
8163 "the content of regular files. For other file types (directory, symbolic "
8164 "link etc) it will just return the string C<directory> etc."
8168 #: ../src/guestfs-actions.pod:1550
8169 msgid "guestfs_file_architecture"
8173 #: ../src/guestfs-actions.pod:1552
8177 " guestfs_file_architecture (guestfs_h *g,\n"
8178 " const char *filename);\n"
8183 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1028
8185 "This detects the architecture of the binary C<filename>, and returns it if "
8190 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1031
8191 msgid "Currently defined architectures are:"
8195 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1035
8200 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8202 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8203 "irrespective of the precise processor requirements of the binary."
8207 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1040
8212 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8213 msgid "64 bit x86-64."
8217 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8222 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8223 msgid "32 bit SPARC."
8227 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8232 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8233 msgid "64 bit SPARC V9 and above."
8237 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8242 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8243 msgid "Intel Itanium."
8247 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8252 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8253 msgid "32 bit Power PC."
8257 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8262 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8263 msgid "64 bit Power PC."
8267 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1066
8268 msgid "Libguestfs may return other architecture strings in future."
8272 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8273 msgid "The function works on at least the following types of files:"
8277 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074
8278 msgid "many types of Un*x and Linux binary"
8282 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078
8283 msgid "many types of Un*x and Linux shared library"
8287 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082
8288 msgid "Windows Win32 and Win64 binaries"
8292 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086
8293 msgid "Windows Win32 and Win64 DLLs"
8297 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8298 msgid "Win32 binaries and DLLs return C<i386>."
8302 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8303 msgid "Win64 binaries and DLLs return C<x86_64>."
8307 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094
8308 msgid "Linux kernel modules"
8312 #: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098
8313 msgid "Linux new-style initrd images"
8317 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102
8318 msgid "some non-x86 Linux vmlinuz kernels"
8322 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106
8323 msgid "What it can't do currently:"
8327 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112
8328 msgid "static libraries (libfoo.a)"
8332 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116
8333 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8337 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120
8338 msgid "x86 Linux vmlinuz kernels"
8342 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8344 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8345 "compressed code, and are horribly hard to unpack. If you want to find the "
8346 "architecture of a kernel, use the architecture of the associated initrd or "
8347 "kernel module(s) instead."
8351 #: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531 ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3266 ../src/guestfs-actions.pod:3398
8352 msgid "(Added in 1.5.3)"
8356 #: ../src/guestfs-actions.pod:1662
8357 msgid "guestfs_filesize"
8361 #: ../src/guestfs-actions.pod:1664
8365 " guestfs_filesize (guestfs_h *g,\n"
8366 " const char *file);\n"
8371 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133
8372 msgid "This command returns the size of C<file> in bytes."
8376 #: ../src/guestfs-actions.pod:1670
8378 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8379 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8380 "devices, use C<guestfs_blockdev_getsize64>."
8384 #: ../src/guestfs-actions.pod:1676
8385 msgid "(Added in 1.0.82)"
8389 #: ../src/guestfs-actions.pod:1678
8390 msgid "guestfs_fill"
8394 #: ../src/guestfs-actions.pod:1680
8398 " guestfs_fill (guestfs_h *g,\n"
8401 " const char *path);\n"
8406 #: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143
8408 "This command creates a new file called C<path>. The initial content of the "
8409 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8414 #: ../src/guestfs-actions.pod:1690
8416 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8417 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8418 "bytes use C<guestfs_fill_pattern>."
8422 #: ../src/guestfs-actions.pod:1702
8423 msgid "(Added in 1.0.79)"
8427 #: ../src/guestfs-actions.pod:1704
8428 msgid "guestfs_fill_pattern"
8432 #: ../src/guestfs-actions.pod:1706
8436 " guestfs_fill_pattern (guestfs_h *g,\n"
8437 " const char *pattern,\n"
8439 " const char *path);\n"
8444 #: ../src/guestfs-actions.pod:1712
8446 "This function is like C<guestfs_fill> except that it creates a new file of "
8447 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8448 "pattern is truncated if necessary to ensure the length of the file is "
8449 "exactly C<len> bytes."
8453 #: ../src/guestfs-actions.pod:1724
8454 msgid "(Added in 1.3.12)"
8458 #: ../src/guestfs-actions.pod:1726
8459 msgid "guestfs_find"
8463 #: ../src/guestfs-actions.pod:1728
8467 " guestfs_find (guestfs_h *g,\n"
8468 " const char *directory);\n"
8473 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165
8475 "This command lists out all files and directories, recursively, starting at "
8476 "C<directory>. It is essentially equivalent to running the shell command "
8477 "C<find directory -print> but some post-processing happens on the output, "
8482 #: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170
8484 "This returns a list of strings I<without any prefix>. Thus if the directory "
8489 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173
8499 #: ../src/guestfs-actions.pod:1744
8500 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8504 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180
8515 #: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185
8516 msgid "If C<directory> is not a directory, then this command returns an error."
8520 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188
8521 msgid "The returned list is sorted."
8525 #: ../src/guestfs-actions.pod:1757
8526 msgid "See also C<guestfs_find0>."
8530 #: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:5635
8531 msgid "(Added in 1.0.27)"
8535 #: ../src/guestfs-actions.pod:1768
8536 msgid "guestfs_find0"
8540 #: ../src/guestfs-actions.pod:1770
8544 " guestfs_find0 (guestfs_h *g,\n"
8545 " const char *directory,\n"
8546 " const char *files);\n"
8551 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199
8553 "This command lists out all files and directories, recursively, starting at "
8554 "C<directory>, placing the resulting list in the external file called "
8559 #: ../src/guestfs-actions.pod:1779
8561 "This command works the same way as C<guestfs_find> with the following "
8566 #: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210
8567 msgid "The resulting list is written to an external file."
8571 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214
8573 "Items (filenames) in the result are separated by C<\\0> characters. See "
8574 "L<find(1)> option I<-print0>."
8578 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219
8579 msgid "This command is not limited in the number of names that it can return."
8583 #: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224
8584 msgid "The result list is not sorted."
8588 #: ../src/guestfs-actions.pod:1806
8589 msgid "(Added in 1.0.74)"
8593 #: ../src/guestfs-actions.pod:1808
8594 msgid "guestfs_findfs_label"
8598 #: ../src/guestfs-actions.pod:1810
8602 " guestfs_findfs_label (guestfs_h *g,\n"
8603 " const char *label);\n"
8608 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234
8610 "This command searches the filesystems and returns the one which has the "
8611 "given label. An error is returned if no such filesystem can be found."
8615 #: ../src/guestfs-actions.pod:1818
8616 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8620 #: ../src/guestfs-actions.pod:1825
8621 msgid "guestfs_findfs_uuid"
8625 #: ../src/guestfs-actions.pod:1827
8629 " guestfs_findfs_uuid (guestfs_h *g,\n"
8630 " const char *uuid);\n"
8635 #: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244
8637 "This command searches the filesystems and returns the one which has the "
8638 "given UUID. An error is returned if no such filesystem can be found."
8642 #: ../src/guestfs-actions.pod:1835
8643 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8647 #: ../src/guestfs-actions.pod:1842
8648 msgid "guestfs_fsck"
8652 #: ../src/guestfs-actions.pod:1844
8656 " guestfs_fsck (guestfs_h *g,\n"
8657 " const char *fstype,\n"
8658 " const char *device);\n"
8663 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254
8665 "This runs the filesystem checker (fsck) on C<device> which should have "
8666 "filesystem type C<fstype>."
8670 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257
8672 "The returned integer is the status. See L<fsck(8)> for the list of status "
8673 "codes from C<fsck>."
8677 #: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266
8678 msgid "Multiple status codes can be summed together."
8682 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270
8684 "A non-zero return code can mean \"success\", for example if errors have been "
8685 "corrected on the filesystem."
8689 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275
8690 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8694 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280
8695 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8699 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7331
8700 msgid "(Added in 1.0.16)"
8704 #: ../src/guestfs-actions.pod:1881
8705 msgid "guestfs_get_append"
8709 #: ../src/guestfs-actions.pod:1883
8713 " guestfs_get_append (guestfs_h *g);\n"
8718 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286
8720 "Return the additional kernel options which are added to the guest kernel "
8725 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289
8726 msgid "If C<NULL> then no options are added."
8730 #: ../src/guestfs-actions.pod:1891
8732 "This function returns a string which may be NULL. There is no way to return "
8733 "an error from this function. The string is owned by the guest handle and "
8734 "must I<not> be freed."
8738 #: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:6193 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:7002 ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7374
8739 msgid "(Added in 1.0.26)"
8743 #: ../src/guestfs-actions.pod:1897
8744 msgid "guestfs_get_attach_method"
8748 #: ../src/guestfs-actions.pod:1899
8752 " guestfs_get_attach_method (guestfs_h *g);\n"
8757 #: ../src/guestfs-actions.pod:1902
8758 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8762 #: ../src/guestfs-actions.pod:1907
8763 msgid "guestfs_get_autosync"
8767 #: ../src/guestfs-actions.pod:1909
8771 " guestfs_get_autosync (guestfs_h *g);\n"
8776 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301
8777 msgid "Get the autosync flag."
8781 #: ../src/guestfs-actions.pod:1918
8782 msgid "guestfs_get_direct"
8786 #: ../src/guestfs-actions.pod:1920
8790 " guestfs_get_direct (guestfs_h *g);\n"
8795 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307
8796 msgid "Return the direct appliance mode flag."
8800 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5862
8801 msgid "(Added in 1.0.72)"
8805 #: ../src/guestfs-actions.pod:1929
8806 msgid "guestfs_get_e2label"
8810 #: ../src/guestfs-actions.pod:1931
8814 " guestfs_get_e2label (guestfs_h *g,\n"
8815 " const char *device);\n"
8820 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313
8821 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8825 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316
8827 "This function is deprecated. In new code, use the C<vfs_label> call "
8832 #: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5899
8833 msgid "(Added in 1.0.15)"
8837 #: ../src/guestfs-actions.pod:1950
8838 msgid "guestfs_get_e2uuid"
8842 #: ../src/guestfs-actions.pod:1952
8846 " guestfs_get_e2uuid (guestfs_h *g,\n"
8847 " const char *device);\n"
8852 #: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327
8853 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8857 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330
8858 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
8862 #: ../src/guestfs-actions.pod:1971
8863 msgid "guestfs_get_memsize"
8867 #: ../src/guestfs-actions.pod:1973
8871 " guestfs_get_memsize (guestfs_h *g);\n"
8876 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341
8877 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8881 #: ../src/guestfs-actions.pod:1979
8883 "If C<guestfs_set_memsize> was not called on this handle, and if "
8884 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8885 "value for memsize."
8889 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:6022 ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399 ../fish/guestfish-actions.pod:3985 ../fish/guestfish-actions.pod:4072
8890 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8894 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4383 ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4660 ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5920 ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6768
8895 msgid "(Added in 1.0.55)"
8899 #: ../src/guestfs-actions.pod:1990
8900 msgid "guestfs_get_network"
8904 #: ../src/guestfs-actions.pod:1992
8908 " guestfs_get_network (guestfs_h *g);\n"
8913 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355
8914 msgid "This returns the enable network flag."
8918 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5939
8919 msgid "(Added in 1.5.4)"
8923 #: ../src/guestfs-actions.pod:2001
8924 msgid "guestfs_get_path"
8928 #: ../src/guestfs-actions.pod:2003
8932 " guestfs_get_path (guestfs_h *g);\n"
8937 #: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361
8938 msgid "Return the current search path."
8942 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
8944 "This is always non-NULL. If it wasn't set already, then this will return "
8949 #: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040
8951 "This function returns a string, or NULL on error. The string is owned by "
8952 "the guest handle and must I<not> be freed."
8956 #: ../src/guestfs-actions.pod:2016
8957 msgid "guestfs_get_pid"
8961 #: ../src/guestfs-actions.pod:2018
8965 " guestfs_get_pid (guestfs_h *g);\n"
8970 #: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372
8972 "Return the process ID of the qemu subprocess. If there is no qemu "
8973 "subprocess, then this will return an error."
8977 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375
8978 msgid "This is an internal call used for debugging and testing."
8982 #: ../src/guestfs-actions.pod:2028
8983 msgid "(Added in 1.0.56)"
8987 #: ../src/guestfs-actions.pod:2030
8988 msgid "guestfs_get_qemu"
8992 #: ../src/guestfs-actions.pod:2032
8996 " guestfs_get_qemu (guestfs_h *g);\n"
9001 #: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381
9002 msgid "Return the current qemu binary."
9006 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9008 "This is always non-NULL. If it wasn't set already, then this will return "
9009 "the default qemu binary name."
9013 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5984
9014 msgid "(Added in 1.0.6)"
9018 #: ../src/guestfs-actions.pod:2045
9019 msgid "guestfs_get_recovery_proc"
9023 #: ../src/guestfs-actions.pod:2047
9027 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9032 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
9033 msgid "Return the recovery process enabled flag."
9037 #: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:5243 ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:6008 ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:6691 ../src/guestfs-actions.pod:6883
9038 msgid "(Added in 1.0.77)"
9042 #: ../src/guestfs-actions.pod:2056
9043 msgid "guestfs_get_selinux"
9047 #: ../src/guestfs-actions.pod:2058
9051 " guestfs_get_selinux (guestfs_h *g);\n"
9056 #: ../src/guestfs-actions.pod:2061
9058 "This returns the current setting of the selinux flag which is passed to the "
9059 "appliance at boot time. See C<guestfs_set_selinux>."
9063 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6085
9064 msgid "(Added in 1.0.67)"
9068 #: ../src/guestfs-actions.pod:2071
9069 msgid "guestfs_get_state"
9073 #: ../src/guestfs-actions.pod:2073
9077 " guestfs_get_state (guestfs_h *g);\n"
9082 #: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406
9084 "This returns the current state as an opaque integer. This is only useful "
9085 "for printing debug and internal error messages."
9089 #: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:1409 ../fish/guestfish-actions.pod:2315 ../fish/guestfish-actions.pod:2333 ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2387
9090 msgid "For more information on states, see L<guestfs(3)>."
9094 #: ../src/guestfs-actions.pod:2085
9095 msgid "guestfs_get_trace"
9099 #: ../src/guestfs-actions.pod:2087
9103 " guestfs_get_trace (guestfs_h *g);\n"
9108 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
9109 msgid "Return the command trace flag."
9113 #: ../src/guestfs-actions.pod:2096
9114 msgid "guestfs_get_umask"
9118 #: ../src/guestfs-actions.pod:2098
9122 " guestfs_get_umask (guestfs_h *g);\n"
9127 #: ../src/guestfs-actions.pod:2101
9129 "Return the current umask. By default the umask is C<022> unless it has been "
9130 "set by calling C<guestfs_umask>."
9134 #: ../src/guestfs-actions.pod:2108
9135 msgid "guestfs_get_verbose"
9139 #: ../src/guestfs-actions.pod:2110
9143 " guestfs_get_verbose (guestfs_h *g);\n"
9148 #: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428
9149 msgid "This returns the verbose messages flag."
9153 #: ../src/guestfs-actions.pod:2119
9154 msgid "guestfs_getcon"
9158 #: ../src/guestfs-actions.pod:2121
9162 " guestfs_getcon (guestfs_h *g);\n"
9167 #: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434
9168 msgid "This gets the SELinux security context of the daemon."
9172 #: ../src/guestfs-actions.pod:2126
9173 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9177 #: ../src/guestfs-actions.pod:2134
9178 msgid "guestfs_getxattr"
9182 #: ../src/guestfs-actions.pod:2136
9186 " guestfs_getxattr (guestfs_h *g,\n"
9187 " const char *path,\n"
9188 " const char *name,\n"
9189 " size_t *size_r);\n"
9194 #: ../src/guestfs-actions.pod:2142
9196 "Get a single extended attribute from file C<path> named C<name>. This call "
9197 "follows symlinks. If you want to lookup an extended attribute for the "
9198 "symlink itself, use C<guestfs_lgetxattr>."
9202 #: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3507
9204 "Normally it is better to get all extended attributes from a file in one go "
9205 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9206 "implementations are buggy and do not provide a way to list out attributes. "
9207 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9208 "extended attributes you want in advance and call this function."
9212 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3514 ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2452
9214 "Extended attribute values are blobs of binary data. If there is no extended "
9215 "attribute named C<name>, this returns an error."
9219 #: ../src/guestfs-actions.pod:2156
9220 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9224 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349 ../src/guestfs-actions.pod:3519 ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5443
9226 "This function returns a buffer, or NULL on error. The size of the returned "
9227 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9232 #: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3523
9233 msgid "(Added in 1.7.24)"
9237 #: ../src/guestfs-actions.pod:2164
9238 msgid "guestfs_getxattrs"
9242 #: ../src/guestfs-actions.pod:2166
9245 " struct guestfs_xattr_list *\n"
9246 " guestfs_getxattrs (guestfs_h *g,\n"
9247 " const char *path);\n"
9252 #: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463
9253 msgid "This call lists the extended attributes of the file or directory C<path>."
9257 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466
9259 "At the system call level, this is a combination of the L<listxattr(2)> and "
9260 "L<getxattr(2)> calls."
9264 #: ../src/guestfs-actions.pod:2176
9265 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9269 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3535 ../src/guestfs-actions.pod:4186
9271 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9272 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9276 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3704 ../src/guestfs-actions.pod:3740 ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:6104 ../src/guestfs-actions.pod:7439
9277 msgid "(Added in 1.0.59)"
9281 #: ../src/guestfs-actions.pod:2184
9282 msgid "guestfs_glob_expand"
9286 #: ../src/guestfs-actions.pod:2186
9290 " guestfs_glob_expand (guestfs_h *g,\n"
9291 " const char *pattern);\n"
9296 #: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475
9298 "This command searches for all the pathnames matching C<pattern> according to "
9299 "the wildcard expansion rules used by the shell."
9303 #: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479
9304 msgid "If no paths match, then this returns an empty list (note: not an error)."
9308 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482
9310 "It is just a wrapper around the C L<glob(3)> function with flags "
9311 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9315 #: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6269 ../src/guestfs-actions.pod:6286
9316 msgid "(Added in 1.0.50)"
9320 #: ../src/guestfs-actions.pod:2207
9321 msgid "guestfs_grep"
9325 #: ../src/guestfs-actions.pod:2209
9329 " guestfs_grep (guestfs_h *g,\n"
9330 " const char *regex,\n"
9331 " const char *path);\n"
9336 #: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490
9337 msgid "This calls the external C<grep> program and returns the matching lines."
9341 #: ../src/guestfs-actions.pod:2226
9342 msgid "guestfs_grepi"
9346 #: ../src/guestfs-actions.pod:2228
9350 " guestfs_grepi (guestfs_h *g,\n"
9351 " const char *regex,\n"
9352 " const char *path);\n"
9357 #: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500
9358 msgid "This calls the external C<grep -i> program and returns the matching lines."
9362 #: ../src/guestfs-actions.pod:2245
9363 msgid "guestfs_grub_install"
9367 #: ../src/guestfs-actions.pod:2247
9371 " guestfs_grub_install (guestfs_h *g,\n"
9372 " const char *root,\n"
9373 " const char *device);\n"
9378 #: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510
9380 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9381 "the root directory being C<root>."
9385 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513
9387 "Note: If grub-install reports the error \"No suitable drive was found in the "
9388 "generated device map.\" it may be that you need to create a "
9389 "C</boot/grub/device.map> file first that contains the mapping between grub "
9390 "device names and Linux device names. It is usually sufficient to create a "
9395 #: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520
9403 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
9404 msgid "replacing C</dev/vda> with the name of the installation device."
9408 #: ../src/guestfs-actions.pod:2268
9409 msgid "(Added in 1.0.17)"
9413 #: ../src/guestfs-actions.pod:2270
9414 msgid "guestfs_head"
9418 #: ../src/guestfs-actions.pod:2272
9422 " guestfs_head (guestfs_h *g,\n"
9423 " const char *path);\n"
9428 #: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528
9430 "This command returns up to the first 10 lines of a file as a list of "
9435 #: ../src/guestfs-actions.pod:2288
9436 msgid "guestfs_head_n"
9440 #: ../src/guestfs-actions.pod:2290
9444 " guestfs_head_n (guestfs_h *g,\n"
9446 " const char *path);\n"
9451 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538
9453 "If the parameter C<nrlines> is a positive number, this returns the first "
9454 "C<nrlines> lines of the file C<path>."
9458 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541
9460 "If the parameter C<nrlines> is a negative number, this returns lines from "
9461 "the file C<path>, excluding the last C<nrlines> lines."
9465 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6566 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4422
9466 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9470 #: ../src/guestfs-actions.pod:2312
9471 msgid "guestfs_hexdump"
9475 #: ../src/guestfs-actions.pod:2314
9479 " guestfs_hexdump (guestfs_h *g,\n"
9480 " const char *path);\n"
9485 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553
9487 "This runs C<hexdump -C> on the given C<path>. The result is the "
9488 "human-readable, canonical hex dump of the file."
9492 #: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6350 ../src/guestfs-actions.pod:6405
9493 msgid "(Added in 1.0.22)"
9497 #: ../src/guestfs-actions.pod:2329
9498 msgid "guestfs_initrd_cat"
9502 #: ../src/guestfs-actions.pod:2331
9506 " guestfs_initrd_cat (guestfs_h *g,\n"
9507 " const char *initrdpath,\n"
9508 " const char *filename,\n"
9509 " size_t *size_r);\n"
9514 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563
9516 "This command unpacks the file C<filename> from the initrd file called "
9517 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9522 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567
9524 "For example, in guestfish you could use the following command to examine the "
9525 "boot script (usually called C</init>) contained in a Linux initrd or "
9530 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571
9533 " initrd-cat /boot/initrd-<version>.img init\n"
9538 #: ../src/guestfs-actions.pod:2347
9539 msgid "See also C<guestfs_initrd_list>."
9543 #: ../src/guestfs-actions.pod:2358
9544 msgid "guestfs_initrd_list"
9548 #: ../src/guestfs-actions.pod:2360
9552 " guestfs_initrd_list (guestfs_h *g,\n"
9553 " const char *path);\n"
9558 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582
9559 msgid "This command lists out files contained in an initrd."
9563 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
9565 "The files are listed without any initial C</> character. The files are "
9566 "listed in the order they appear (not necessarily alphabetical). Directory "
9567 "names are listed as separate items."
9571 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588
9573 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9574 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9579 #: ../src/guestfs-actions.pod:2380
9580 msgid "guestfs_inotify_add_watch"
9584 #: ../src/guestfs-actions.pod:2382
9588 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9589 " const char *path,\n"
9595 #: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596
9596 msgid "Watch C<path> for the events listed in C<mask>."
9600 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
9602 "Note that if C<path> is a directory then events within that directory are "
9603 "watched, but this does I<not> happen recursively (in subdirectories)."
9607 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602
9609 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9610 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9614 #: ../src/guestfs-actions.pod:2401
9615 msgid "guestfs_inotify_close"
9619 #: ../src/guestfs-actions.pod:2403
9623 " guestfs_inotify_close (guestfs_h *g);\n"
9628 #: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610
9630 "This closes the inotify handle which was previously opened by inotify_init. "
9631 "It removes all watches, throws away any pending events, and deallocates all "
9636 #: ../src/guestfs-actions.pod:2414
9637 msgid "guestfs_inotify_files"
9641 #: ../src/guestfs-actions.pod:2416
9645 " guestfs_inotify_files (guestfs_h *g);\n"
9650 #: ../src/guestfs-actions.pod:2419
9652 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9653 "returns a list of pathnames of objects that were touched. The returned "
9654 "pathnames are sorted and deduplicated."
9658 #: ../src/guestfs-actions.pod:2429
9659 msgid "guestfs_inotify_init"
9663 #: ../src/guestfs-actions.pod:2431
9667 " guestfs_inotify_init (guestfs_h *g,\n"
9668 " int maxevents);\n"
9673 #: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626
9675 "This command creates a new inotify handle. The inotify subsystem can be "
9676 "used to notify events which happen to objects in the guest filesystem."
9680 #: ../src/guestfs-actions.pod:2439
9682 "C<maxevents> is the maximum number of events which will be queued up between "
9683 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9684 "passed as C<0>, then the kernel (or previously set) default is used. For "
9685 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9686 "throws away events, but records the fact that it threw them away by setting "
9687 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9688 "C<guestfs_inotify_read>)."
9692 #: ../src/guestfs-actions.pod:2449
9694 "Before any events are generated, you have to add some watches to the "
9695 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9696 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9700 #: ../src/guestfs-actions.pod:2455
9702 "Queued up events should be read periodically by calling "
9703 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9704 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9705 "often enough then you risk the internal queue overflowing."
9709 #: ../src/guestfs-actions.pod:2462
9711 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9712 "This also removes any watches automatically."
9716 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657
9718 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9719 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9720 "that there is one global inotify handle per libguestfs instance."
9724 #: ../src/guestfs-actions.pod:2475
9725 msgid "guestfs_inotify_read"
9729 #: ../src/guestfs-actions.pod:2477
9732 " struct guestfs_inotify_event_list *\n"
9733 " guestfs_inotify_read (guestfs_h *g);\n"
9738 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666
9740 "Return the complete queue of events that have happened since the previous "
9745 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669
9746 msgid "If no events have happened, this returns an empty list."
9750 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
9752 "I<Note>: In order to make sure that all events have been read, you must call "
9753 "this function repeatedly until it returns an empty list. The reason is that "
9754 "the call will read events up to the maximum appliance-to-host message size "
9755 "and leave remaining events in the queue."
9759 #: ../src/guestfs-actions.pod:2491
9761 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9762 "there was an error. I<The caller must call "
9763 "C<guestfs_free_inotify_event_list> after use>."
9767 #: ../src/guestfs-actions.pod:2497
9768 msgid "guestfs_inotify_rm_watch"
9772 #: ../src/guestfs-actions.pod:2499
9776 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9782 #: ../src/guestfs-actions.pod:2503
9784 "Remove a previously defined inotify watch. See "
9785 "C<guestfs_inotify_add_watch>."
9789 #: ../src/guestfs-actions.pod:2510
9790 msgid "guestfs_inspect_get_arch"
9794 #: ../src/guestfs-actions.pod:2512
9798 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9799 " const char *root);\n"
9804 #: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539 ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2668 ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2733 ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906 ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3048 ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124
9806 "This function should only be called with a root device string as returned by "
9807 "C<guestfs_inspect_os>."
9811 #: ../src/guestfs-actions.pod:2519
9813 "This returns the architecture of the inspected operating system. The "
9814 "possible return values are listed under C<guestfs_file_architecture>."
9818 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695
9820 "If the architecture could not be determined, then the string C<unknown> is "
9825 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2742 ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2917 ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:3014 ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058 ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3095 ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:3258 ../fish/guestfish-actions.pod:1698 ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:1864 ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1900 ../fish/guestfish-actions.pod:1970 ../fish/guestfish-actions.pod:1994 ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2054 ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2105 ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2134 ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2162 ../fish/guestfish-actions.pod:2261 ../fish/guestfish-actions.pod:2295
9826 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9830 #: ../src/guestfs-actions.pod:2533
9831 msgid "guestfs_inspect_get_distro"
9835 #: ../src/guestfs-actions.pod:2535
9839 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9840 " const char *root);\n"
9845 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707
9846 msgid "This returns the distro (distribution) of the inspected operating system."
9850 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710
9851 msgid "Currently defined distros are:"
9855 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714
9856 msgid "\"archlinux\""
9860 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
9865 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
9870 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
9875 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
9880 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
9885 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
9890 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
9895 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
9896 msgid "\"linuxmint\""
9900 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
9905 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
9906 msgid "\"mandriva\""
9910 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
9915 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
9920 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
9925 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
9930 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
9935 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
9936 msgid "\"redhat-based\""
9940 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
9941 msgid "Some Red Hat-derived distro."
9945 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
9950 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
9951 msgid "Red Hat Enterprise Linux and some derivatives."
9955 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
9956 msgid "\"slackware\""
9960 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
9965 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
9970 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
9975 #: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:1762 ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:2080
9980 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
9981 msgid "The distro could not be determined."
9985 #: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2997 ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2072
9990 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
9992 "Windows does not have distributions. This string is returned if the OS type "
9997 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:1773 ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:2086
9999 "Future versions of libguestfs may return other strings here. The caller "
10000 "should be prepared to handle any string."
10004 #: ../src/guestfs-actions.pod:2618
10005 msgid "guestfs_inspect_get_drive_mappings"
10009 #: ../src/guestfs-actions.pod:2620
10013 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10014 " const char *root);\n"
10019 #: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785
10021 "This call is useful for Windows which uses a primitive system of assigning "
10022 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10023 "Windows Registry to find out how disks/partitions are mapped to drive "
10024 "letters, and returns a hash table as in the example below:"
10028 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1791
10031 " C => /dev/vda2\n"
10032 " E => /dev/vdb1\n"
10033 " F => /dev/vdc1\n"
10038 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
10040 "Note that keys are drive letters. For Windows, the key is case insensitive "
10041 "and just contains the drive letter, without the customary colon separator "
10046 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799
10048 "In future we may support other operating systems that also used drive "
10049 "letters, but the keys for those might not be case insensitive and might be "
10050 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10055 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804
10057 "For Windows guests, currently only hard drive mappings are returned. "
10058 "Removable disks (eg. DVD-ROMs) are ignored."
10062 #: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807
10064 "For guests that do not use drive mappings, or if the drive mappings could "
10065 "not be determined, this returns an empty hash table."
10069 #: ../src/guestfs-actions.pod:2652
10071 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10072 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10076 #: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:6707
10078 "This function returns a NULL-terminated array of strings, or NULL if there "
10079 "was an error. The array of strings will always have length C<2n+1>, where "
10080 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10081 "caller must free the strings and the array after use>."
10085 #: ../src/guestfs-actions.pod:2662
10086 msgid "guestfs_inspect_get_filesystems"
10090 #: ../src/guestfs-actions.pod:2664
10094 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10095 " const char *root);\n"
10100 #: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821
10102 "This returns a list of all the filesystems that we think are associated with "
10103 "this operating system. This includes the root filesystem, other ordinary "
10104 "filesystems, and non-mounted devices like swap partitions."
10108 #: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826
10110 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10111 "to be shared between operating systems."
10115 #: ../src/guestfs-actions.pod:2679
10117 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10118 "C<guestfs_inspect_get_mountpoints>."
10122 #: ../src/guestfs-actions.pod:2688
10123 msgid "guestfs_inspect_get_format"
10127 #: ../src/guestfs-actions.pod:2690
10131 " guestfs_inspect_get_format (guestfs_h *g,\n"
10132 " const char *root);\n"
10137 #: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1839
10139 "This returns the format of the inspected operating system. You can use it "
10140 "to detect install images, live CDs and similar."
10144 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1842
10145 msgid "Currently defined formats are:"
10149 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1846
10150 msgid "\"installed\""
10154 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1848
10155 msgid "This is an installed operating system."
10159 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850
10160 msgid "\"installer\""
10164 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
10166 "The disk image being inspected is not an installed operating system, but a "
10167 "I<bootable> install disk, live CD, or similar."
10171 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857
10172 msgid "The format of this disk image is not known."
10176 #: ../src/guestfs-actions.pod:2727
10177 msgid "guestfs_inspect_get_hostname"
10181 #: ../src/guestfs-actions.pod:2729
10185 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10186 " const char *root);\n"
10191 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1873
10193 "This function returns the hostname of the operating system as found by "
10194 "inspection of the guest's configuration files."
10198 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1876
10200 "If the hostname could not be determined, then the string C<unknown> is "
10205 #: ../src/guestfs-actions.pod:2747
10206 msgid "(Added in 1.7.9)"
10210 #: ../src/guestfs-actions.pod:2749
10211 msgid "guestfs_inspect_get_major_version"
10215 #: ../src/guestfs-actions.pod:2751
10219 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10220 " const char *root);\n"
10225 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1888
10226 msgid "This returns the major version number of the inspected operating system."
10230 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1891
10232 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10233 "popular public names used by the operating system. Notably the operating "
10234 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10235 "1). You can find out the real versions corresponding to releases of Windows "
10236 "by consulting Wikipedia or MSDN."
10240 #: ../src/guestfs-actions.pod:2768 ../src/guestfs-actions.pod:2788 ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1912
10241 msgid "If the version could not be determined, then C<0> is returned."
10245 #: ../src/guestfs-actions.pod:2776
10246 msgid "guestfs_inspect_get_minor_version"
10250 #: ../src/guestfs-actions.pod:2778
10254 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10255 " const char *root);\n"
10260 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1909
10261 msgid "This returns the minor version number of the inspected operating system."
10265 #: ../src/guestfs-actions.pod:2790
10267 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10268 "C<guestfs_inspect_get_major_version>."
10272 #: ../src/guestfs-actions.pod:2797
10273 msgid "guestfs_inspect_get_mountpoints"
10277 #: ../src/guestfs-actions.pod:2799
10281 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10282 " const char *root);\n"
10287 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1924
10289 "This returns a hash of where we think the filesystems associated with this "
10290 "operating system should be mounted. Callers should note that this is at "
10291 "best an educated guess made by reading configuration files such as "
10292 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10293 "are non-existent or not mountable and callers should be prepared to handle "
10294 "or ignore failures if they try to mount them."
10298 #: ../src/guestfs-actions.pod:2815 ../fish/guestfish-actions.pod:1933
10300 "Each element in the returned hashtable has a key which is the path of the "
10301 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10302 "mounted there (eg. C</dev/sda1>)."
10306 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938
10307 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10311 #: ../src/guestfs-actions.pod:2823
10313 "For operating systems like Windows which still use drive letters, this call "
10314 "will only return an entry for the first drive \"mounted on\" C</>. For "
10315 "information about the mapping of drive letters to partitions, see "
10316 "C<guestfs_inspect_get_drive_mappings>."
10320 #: ../src/guestfs-actions.pod:2829
10322 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10323 "C<guestfs_inspect_get_filesystems>."
10327 #: ../src/guestfs-actions.pod:2840
10328 msgid "guestfs_inspect_get_package_format"
10332 #: ../src/guestfs-actions.pod:2842
10336 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10337 " const char *root);\n"
10342 #: ../src/guestfs-actions.pod:2849
10344 "This function and C<guestfs_inspect_get_package_management> return the "
10345 "package format and package management tool used by the inspected operating "
10346 "system. For example for Fedora these functions would return C<rpm> (package "
10347 "format) and C<yum> (package management)."
10351 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1963
10353 "This returns the string C<unknown> if we could not determine the package "
10354 "format I<or> if the operating system does not have a real packaging system "
10359 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1967
10361 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10362 "Future versions of libguestfs may return other strings."
10366 #: ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2898
10367 msgid "(Added in 1.7.5)"
10371 #: ../src/guestfs-actions.pod:2869
10372 msgid "guestfs_inspect_get_package_management"
10376 #: ../src/guestfs-actions.pod:2871
10380 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10381 " const char *root);\n"
10386 #: ../src/guestfs-actions.pod:2878
10388 "C<guestfs_inspect_get_package_format> and this function return the package "
10389 "format and package management tool used by the inspected operating system. "
10390 "For example for Fedora these functions would return C<rpm> (package format) "
10391 "and C<yum> (package management)."
10395 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1985
10397 "This returns the string C<unknown> if we could not determine the package "
10398 "management tool I<or> if the operating system does not have a real packaging "
10399 "system (eg. Windows)."
10403 #: ../src/guestfs-actions.pod:2888 ../fish/guestfish-actions.pod:1989
10405 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10406 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10407 "libguestfs may return other strings."
10411 #: ../src/guestfs-actions.pod:2900
10412 msgid "guestfs_inspect_get_product_name"
10416 #: ../src/guestfs-actions.pod:2902
10420 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10421 " const char *root);\n"
10426 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2003
10428 "This returns the product name of the inspected operating system. The "
10429 "product name is generally some freeform string which can be displayed to the "
10430 "user, but should not be parsed by programs."
10434 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008
10436 "If the product name could not be determined, then the string C<unknown> is "
10441 #: ../src/guestfs-actions.pod:2924
10442 msgid "guestfs_inspect_get_product_variant"
10446 #: ../src/guestfs-actions.pod:2926
10450 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10451 " const char *root);\n"
10456 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2020
10457 msgid "This returns the product variant of the inspected operating system."
10461 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2023
10463 "For Windows guests, this returns the contents of the Registry key "
10464 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10465 "which is usually a string such as C<Client> or C<Server> (other values are "
10466 "possible). This can be used to distinguish consumer and enterprise versions "
10467 "of Windows that have the same version number (for example, Windows 7 and "
10468 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10469 "the latter is C<Server>)."
10473 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2032
10475 "For enterprise Linux guests, in future we intend this to return the product "
10476 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10477 "implemented at present."
10481 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2036
10483 "If the product variant could not be determined, then the string C<unknown> "
10488 #: ../src/guestfs-actions.pod:2952
10490 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10491 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10495 #: ../src/guestfs-actions.pod:2959
10496 msgid "guestfs_inspect_get_roots"
10500 #: ../src/guestfs-actions.pod:2961
10504 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10509 #: ../src/guestfs-actions.pod:2964
10511 "This function is a convenient way to get the list of root devices, as "
10512 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10513 "the whole inspection process."
10517 #: ../src/guestfs-actions.pod:2968
10519 "This returns an empty list if either no root devices were found or the "
10520 "caller has not called C<guestfs_inspect_os>."
10524 #: ../src/guestfs-actions.pod:2977
10525 msgid "(Added in 1.7.3)"
10529 #: ../src/guestfs-actions.pod:2979
10530 msgid "guestfs_inspect_get_type"
10534 #: ../src/guestfs-actions.pod:2981
10538 " guestfs_inspect_get_type (guestfs_h *g,\n"
10539 " const char *root);\n"
10544 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2063
10546 "This returns the type of the inspected operating system. Currently defined "
10551 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068
10556 #: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2070
10557 msgid "Any Linux-based operating system."
10561 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2074
10562 msgid "Any Microsoft Windows operating system."
10566 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076
10567 msgid "\"freebsd\""
10571 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
10576 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082
10577 msgid "The operating system type could not be determined."
10581 #: ../src/guestfs-actions.pod:3021
10582 msgid "guestfs_inspect_get_windows_current_control_set"
10586 #: ../src/guestfs-actions.pod:3023
10590 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
10591 " const char *root);\n"
10596 #: ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:2098
10598 "This returns the Windows CurrentControlSet of the inspected guest. The "
10599 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10603 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2101
10605 "This call assumes that the guest is Windows and that the Registry could be "
10606 "examined by inspection. If this is not the case then an error is returned."
10610 #: ../src/guestfs-actions.pod:3042
10611 msgid "guestfs_inspect_get_windows_systemroot"
10615 #: ../src/guestfs-actions.pod:3044
10619 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10620 " const char *root);\n"
10625 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2114
10627 "This returns the Windows systemroot of the inspected guest. The systemroot "
10628 "is a directory path such as C</WINDOWS>."
10632 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2117
10634 "This call assumes that the guest is Windows and that the systemroot could be "
10635 "determined by inspection. If this is not the case then an error is "
10640 #: ../src/guestfs-actions.pod:3063
10641 msgid "(Added in 1.5.25)"
10645 #: ../src/guestfs-actions.pod:3065
10646 msgid "guestfs_inspect_is_live"
10650 #: ../src/guestfs-actions.pod:3067
10654 " guestfs_inspect_is_live (guestfs_h *g,\n"
10655 " const char *root);\n"
10660 #: ../src/guestfs-actions.pod:3074
10662 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10663 "disk), then this returns true if a live image was detected on the disk."
10667 #: ../src/guestfs-actions.pod:3082
10668 msgid "guestfs_inspect_is_multipart"
10672 #: ../src/guestfs-actions.pod:3084
10676 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
10677 " const char *root);\n"
10682 #: ../src/guestfs-actions.pod:3091
10684 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10685 "disk), then this returns true if the disk is part of a set."
10689 #: ../src/guestfs-actions.pod:3099
10690 msgid "guestfs_inspect_is_netinst"
10694 #: ../src/guestfs-actions.pod:3101
10698 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
10699 " const char *root);\n"
10704 #: ../src/guestfs-actions.pod:3108
10706 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10707 "disk), then this returns true if the disk is a network installer, ie. not a "
10708 "self-contained install CD but one which is likely to require network access "
10709 "to complete the install."
10713 #: ../src/guestfs-actions.pod:3118
10714 msgid "guestfs_inspect_list_applications"
10718 #: ../src/guestfs-actions.pod:3120
10721 " struct guestfs_application_list *\n"
10722 " guestfs_inspect_list_applications (guestfs_h *g,\n"
10723 " const char *root);\n"
10728 #: ../src/guestfs-actions.pod:3127 ../fish/guestfish-actions.pod:2171
10729 msgid "Return the list of applications installed in the operating system."
10733 #: ../src/guestfs-actions.pod:3129
10735 "I<Note:> This call works differently from other parts of the inspection "
10736 "API. You have to call C<guestfs_inspect_os>, then "
10737 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
10738 "this. Listing applications is a significantly more difficult operation "
10739 "which requires access to the full filesystem. Also note that unlike the "
10740 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
10741 "the libguestfs handle, this call actually reads parts of the mounted "
10742 "filesystems during the call."
10746 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2183
10748 "This returns an empty list if the inspection code was not able to determine "
10749 "the list of applications."
10753 #: ../src/guestfs-actions.pod:3142 ../fish/guestfish-actions.pod:2186
10754 msgid "The application structure contains the following fields:"
10758 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2190
10759 msgid "C<app_name>"
10763 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2192
10765 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10766 "guests, this is the package name."
10770 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2195
10771 msgid "C<app_display_name>"
10775 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2197
10777 "The display name of the application, sometimes localized to the install "
10778 "language of the guest operating system."
10782 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
10784 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10785 "to display something can use C<app_name> instead."
10789 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2203
10790 msgid "C<app_epoch>"
10794 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
10796 "For package managers which use epochs, this contains the epoch of the "
10797 "package (an integer). If unavailable, this is returned as C<0>."
10801 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2208
10802 msgid "C<app_version>"
10806 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
10808 "The version string of the application or package. If unavailable this is "
10809 "returned as an empty string C<\"\">."
10813 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
10814 msgid "C<app_release>"
10818 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
10820 "The release string of the application or package, for package managers that "
10821 "use this. If unavailable this is returned as an empty string C<\"\">."
10825 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2219
10826 msgid "C<app_install_path>"
10830 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2221
10832 "The installation path of the application (on operating systems such as "
10833 "Windows which use installation paths). This path is in the format used by "
10834 "the guest operating system, it is not a libguestfs path."
10838 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2226
10839 msgid "If unavailable this is returned as an empty string C<\"\">."
10843 #: ../src/guestfs-actions.pod:3184 ../fish/guestfish-actions.pod:2228
10844 msgid "C<app_trans_path>"
10848 #: ../src/guestfs-actions.pod:3186 ../fish/guestfish-actions.pod:2230
10850 "The install path translated into a libguestfs path. If unavailable this is "
10851 "returned as an empty string C<\"\">."
10855 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2233
10856 msgid "C<app_publisher>"
10860 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2235
10862 "The name of the publisher of the application, for package managers that use "
10863 "this. If unavailable this is returned as an empty string C<\"\">."
10867 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2239
10872 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2241
10874 "The URL (eg. upstream URL) of the application. If unavailable this is "
10875 "returned as an empty string C<\"\">."
10879 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2244
10880 msgid "C<app_source_package>"
10884 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2246
10886 "For packaging systems which support this, the name of the source package. "
10887 "If unavailable this is returned as an empty string C<\"\">."
10891 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
10892 msgid "C<app_summary>"
10896 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
10898 "A short (usually one line) description of the application or package. If "
10899 "unavailable this is returned as an empty string C<\"\">."
10903 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
10904 msgid "C<app_description>"
10908 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
10910 "A longer description of the application or package. If unavailable this is "
10911 "returned as an empty string C<\"\">."
10915 #: ../src/guestfs-actions.pod:3219
10917 "This function returns a C<struct guestfs_application_list *>, or NULL if "
10918 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10923 #: ../src/guestfs-actions.pod:3223
10924 msgid "(Added in 1.7.8)"
10928 #: ../src/guestfs-actions.pod:3225
10929 msgid "guestfs_inspect_os"
10933 #: ../src/guestfs-actions.pod:3227
10937 " guestfs_inspect_os (guestfs_h *g);\n"
10942 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2267
10944 "This function uses other libguestfs functions and certain heuristics to "
10945 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10946 "for operating systems."
10950 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2271
10951 msgid "The list returned is empty if no operating systems were found."
10955 #: ../src/guestfs-actions.pod:3236 ../fish/guestfish-actions.pod:2273
10957 "If one operating system was found, then this returns a list with a single "
10958 "element, which is the name of the root filesystem of this operating system. "
10959 "It is also possible for this function to return a list containing more than "
10960 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10961 "element being the root filesystem of one of the operating systems."
10965 #: ../src/guestfs-actions.pod:3243
10967 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10968 "functions in order to query further information about each operating system, "
10969 "such as the name and version."
10973 #: ../src/guestfs-actions.pod:3248
10975 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10976 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10977 "the contents. This should be called with no disks currently mounted. The "
10978 "function may also use Augeas, so any existing Augeas handle will be closed."
10982 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2291
10984 "This function cannot decrypt encrypted disks. The caller must do that first "
10985 "(supplying the necessary keys) if the disk is encrypted."
10989 #: ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3612
10990 msgid "See also C<guestfs_list_filesystems>."
10994 #: ../src/guestfs-actions.pod:3268
10995 msgid "guestfs_is_blockdev"
10999 #: ../src/guestfs-actions.pod:3270
11003 " guestfs_is_blockdev (guestfs_h *g,\n"
11004 " const char *path);\n"
11009 #: ../src/guestfs-actions.pod:3274 ../fish/guestfish-actions.pod:2303
11011 "This returns C<true> if and only if there is a block device with the given "
11016 #: ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3351 ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3423 ../src/guestfs-actions.pod:3438
11017 msgid "See also C<guestfs_stat>."
11021 #: ../src/guestfs-actions.pod:3281 ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3355 ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3442
11022 msgid "(Added in 1.5.10)"
11026 #: ../src/guestfs-actions.pod:3283
11027 msgid "guestfs_is_busy"
11031 #: ../src/guestfs-actions.pod:3285
11035 " guestfs_is_busy (guestfs_h *g);\n"
11040 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2312
11042 "This returns true iff this handle is busy processing a command (in the "
11047 #: ../src/guestfs-actions.pod:3297
11048 msgid "guestfs_is_chardev"
11052 #: ../src/guestfs-actions.pod:3299
11056 " guestfs_is_chardev (guestfs_h *g,\n"
11057 " const char *path);\n"
11062 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2321
11064 "This returns C<true> if and only if there is a character device with the "
11065 "given C<path> name."
11069 #: ../src/guestfs-actions.pod:3312
11070 msgid "guestfs_is_config"
11074 #: ../src/guestfs-actions.pod:3314
11078 " guestfs_is_config (guestfs_h *g);\n"
11083 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2330
11085 "This returns true iff this handle is being configured (in the C<CONFIG> "
11090 #: ../src/guestfs-actions.pod:3326
11091 msgid "guestfs_is_dir"
11095 #: ../src/guestfs-actions.pod:3328
11099 " guestfs_is_dir (guestfs_h *g,\n"
11100 " const char *path);\n"
11105 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2339
11107 "This returns C<true> if and only if there is a directory with the given "
11108 "C<path> name. Note that it returns false for other objects like files."
11112 #: ../src/guestfs-actions.pod:3342
11113 msgid "guestfs_is_fifo"
11117 #: ../src/guestfs-actions.pod:3344
11121 " guestfs_is_fifo (guestfs_h *g,\n"
11122 " const char *path);\n"
11127 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2349
11129 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11130 "given C<path> name."
11134 #: ../src/guestfs-actions.pod:3357
11135 msgid "guestfs_is_file"
11139 #: ../src/guestfs-actions.pod:3359
11143 " guestfs_is_file (guestfs_h *g,\n"
11144 " const char *path);\n"
11149 #: ../src/guestfs-actions.pod:3363 ../fish/guestfish-actions.pod:2358
11151 "This returns C<true> if and only if there is a regular file with the given "
11152 "C<path> name. Note that it returns false for other objects like "
11157 #: ../src/guestfs-actions.pod:3373
11158 msgid "guestfs_is_launching"
11162 #: ../src/guestfs-actions.pod:3375
11166 " guestfs_is_launching (guestfs_h *g);\n"
11171 #: ../src/guestfs-actions.pod:3378 ../fish/guestfish-actions.pod:2368
11173 "This returns true iff this handle is launching the subprocess (in the "
11174 "C<LAUNCHING> state)."
11178 #: ../src/guestfs-actions.pod:3387
11179 msgid "guestfs_is_lv"
11183 #: ../src/guestfs-actions.pod:3389
11187 " guestfs_is_lv (guestfs_h *g,\n"
11188 " const char *device);\n"
11193 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2377
11195 "This command tests whether C<device> is a logical volume, and returns true "
11196 "iff this is the case."
11200 #: ../src/guestfs-actions.pod:3400
11201 msgid "guestfs_is_ready"
11205 #: ../src/guestfs-actions.pod:3402
11209 " guestfs_is_ready (guestfs_h *g);\n"
11214 #: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2384
11216 "This returns true iff this handle is ready to accept commands (in the "
11221 #: ../src/guestfs-actions.pod:3414
11222 msgid "guestfs_is_socket"
11226 #: ../src/guestfs-actions.pod:3416
11230 " guestfs_is_socket (guestfs_h *g,\n"
11231 " const char *path);\n"
11236 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2393
11238 "This returns C<true> if and only if there is a Unix domain socket with the "
11239 "given C<path> name."
11243 #: ../src/guestfs-actions.pod:3429
11244 msgid "guestfs_is_symlink"
11248 #: ../src/guestfs-actions.pod:3431
11252 " guestfs_is_symlink (guestfs_h *g,\n"
11253 " const char *path);\n"
11258 #: ../src/guestfs-actions.pod:3435 ../fish/guestfish-actions.pod:2402
11260 "This returns C<true> if and only if there is a symbolic link with the given "
11265 #: ../src/guestfs-actions.pod:3444
11266 msgid "guestfs_kill_subprocess"
11270 #: ../src/guestfs-actions.pod:3446
11274 " guestfs_kill_subprocess (guestfs_h *g);\n"
11279 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2411
11280 msgid "This kills the qemu subprocess. You should never need to call this."
11284 #: ../src/guestfs-actions.pod:3455
11285 msgid "guestfs_launch"
11289 #: ../src/guestfs-actions.pod:3457
11293 " guestfs_launch (guestfs_h *g);\n"
11298 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2419
11300 "Internally libguestfs is implemented by running a virtual machine using "
11305 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2422
11307 "You should call this after configuring the handle (eg. adding drives) but "
11308 "before performing any actions."
11312 #: ../src/guestfs-actions.pod:3475
11313 msgid "guestfs_lchown"
11317 #: ../src/guestfs-actions.pod:3477
11321 " guestfs_lchown (guestfs_h *g,\n"
11324 " const char *path);\n"
11329 #: ../src/guestfs-actions.pod:3483
11331 "Change the file owner to C<owner> and group to C<group>. This is like "
11332 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11333 "changed, not the target."
11337 #: ../src/guestfs-actions.pod:3495
11338 msgid "guestfs_lgetxattr"
11342 #: ../src/guestfs-actions.pod:3497
11346 " guestfs_lgetxattr (guestfs_h *g,\n"
11347 " const char *path,\n"
11348 " const char *name,\n"
11349 " size_t *size_r);\n"
11354 #: ../src/guestfs-actions.pod:3503 ../fish/guestfish-actions.pod:2441
11356 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11357 "is a symlink, then this call returns an extended attribute from the symlink."
11361 #: ../src/guestfs-actions.pod:3517
11362 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11366 #: ../src/guestfs-actions.pod:3525
11367 msgid "guestfs_lgetxattrs"
11371 #: ../src/guestfs-actions.pod:3527
11374 " struct guestfs_xattr_list *\n"
11375 " guestfs_lgetxattrs (guestfs_h *g,\n"
11376 " const char *path);\n"
11381 #: ../src/guestfs-actions.pod:3531
11383 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11384 "then it returns the extended attributes of the link itself."
11388 #: ../src/guestfs-actions.pod:3541
11389 msgid "guestfs_list_devices"
11393 #: ../src/guestfs-actions.pod:3543
11397 " guestfs_list_devices (guestfs_h *g);\n"
11402 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2469
11403 msgid "List all the block devices."
11407 #: ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:2471
11408 msgid "The full block device names are returned, eg. C</dev/sda>."
11412 #: ../src/guestfs-actions.pod:3558
11413 msgid "guestfs_list_filesystems"
11417 #: ../src/guestfs-actions.pod:3560
11421 " guestfs_list_filesystems (guestfs_h *g);\n"
11426 #: ../src/guestfs-actions.pod:3563 ../fish/guestfish-actions.pod:2479
11428 "This inspection command looks for filesystems on partitions, block devices "
11429 "and logical volumes, returning a list of devices containing filesystems and "
11434 #: ../src/guestfs-actions.pod:3567 ../fish/guestfish-actions.pod:2483
11436 "The return value is a hash, where the keys are the devices containing "
11437 "filesystems, and the values are the filesystem types. For example:"
11441 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2487
11444 " \"/dev/sda1\" => \"ntfs\"\n"
11445 " \"/dev/sda2\" => \"ext2\"\n"
11446 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11447 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11452 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2492
11454 "The value can have the special value \"unknown\", meaning the content of the "
11455 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11459 #: ../src/guestfs-actions.pod:3580
11461 "This command runs other libguestfs commands, which might include "
11462 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11463 "soon after launch and only when nothing is mounted."
11467 #: ../src/guestfs-actions.pod:3584
11469 "Not all of the filesystems returned will be mountable. In particular, swap "
11470 "partitions are returned in the list. Also this command does not check that "
11471 "each filesystem found is valid and mountable, and some filesystems might be "
11472 "mountable but require special options. Filesystems may not all belong to a "
11473 "single logical operating system (use C<guestfs_inspect_os> to look for "
11478 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:5203
11479 msgid "(Added in 1.5.15)"
11483 #: ../src/guestfs-actions.pod:3600
11484 msgid "guestfs_list_partitions"
11488 #: ../src/guestfs-actions.pod:3602
11492 " guestfs_list_partitions (guestfs_h *g);\n"
11497 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2512
11498 msgid "List all the partitions detected on all block devices."
11502 #: ../src/guestfs-actions.pod:3607 ../fish/guestfish-actions.pod:2514
11503 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11507 #: ../src/guestfs-actions.pod:3609
11509 "This does not return logical volumes. For that you will need to call "
11514 #: ../src/guestfs-actions.pod:3620
11519 #: ../src/guestfs-actions.pod:3622
11523 " guestfs_ll (guestfs_h *g,\n"
11524 " const char *directory);\n"
11529 #: ../src/guestfs-actions.pod:3626 ../fish/guestfish-actions.pod:2525
11531 "List the files in C<directory> (relative to the root directory, there is no "
11532 "cwd) in the format of 'ls -la'."
11536 #: ../src/guestfs-actions.pod:3629 ../fish/guestfish-actions.pod:2528
11538 "This command is mostly useful for interactive sessions. It is I<not> "
11539 "intended that you try to parse the output string."
11543 #: ../src/guestfs-actions.pod:3637
11548 #: ../src/guestfs-actions.pod:3639
11552 " guestfs_ln (guestfs_h *g,\n"
11553 " const char *target,\n"
11554 " const char *linkname);\n"
11559 #: ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:2535
11560 msgid "This command creates a hard link using the C<ln> command."
11564 #: ../src/guestfs-actions.pod:3650
11565 msgid "guestfs_ln_f"
11569 #: ../src/guestfs-actions.pod:3652
11573 " guestfs_ln_f (guestfs_h *g,\n"
11574 " const char *target,\n"
11575 " const char *linkname);\n"
11580 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2541
11582 "This command creates a hard link using the C<ln -f> command. The C<-f> "
11583 "option removes the link (C<linkname>) if it exists already."
11587 #: ../src/guestfs-actions.pod:3664
11588 msgid "guestfs_ln_s"
11592 #: ../src/guestfs-actions.pod:3666
11596 " guestfs_ln_s (guestfs_h *g,\n"
11597 " const char *target,\n"
11598 " const char *linkname);\n"
11603 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2548
11604 msgid "This command creates a symbolic link using the C<ln -s> command."
11608 #: ../src/guestfs-actions.pod:3677
11609 msgid "guestfs_ln_sf"
11613 #: ../src/guestfs-actions.pod:3679
11617 " guestfs_ln_sf (guestfs_h *g,\n"
11618 " const char *target,\n"
11619 " const char *linkname);\n"
11624 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2554
11626 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
11627 "option removes the link (C<linkname>) if it exists already."
11631 #: ../src/guestfs-actions.pod:3691
11632 msgid "guestfs_lremovexattr"
11636 #: ../src/guestfs-actions.pod:3693
11640 " guestfs_lremovexattr (guestfs_h *g,\n"
11641 " const char *xattr,\n"
11642 " const char *path);\n"
11647 #: ../src/guestfs-actions.pod:3698
11649 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
11650 "link, then it removes an extended attribute of the link itself."
11654 #: ../src/guestfs-actions.pod:3706
11659 #: ../src/guestfs-actions.pod:3708
11663 " guestfs_ls (guestfs_h *g,\n"
11664 " const char *directory);\n"
11669 #: ../src/guestfs-actions.pod:3712 ../fish/guestfish-actions.pod:2569
11671 "List the files in C<directory> (relative to the root directory, there is no "
11672 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11677 #: ../src/guestfs-actions.pod:3716
11679 "This command is mostly useful for interactive sessions. Programs should "
11680 "probably use C<guestfs_readdir> instead."
11684 #: ../src/guestfs-actions.pod:3725
11685 msgid "guestfs_lsetxattr"
11689 #: ../src/guestfs-actions.pod:3727
11693 " guestfs_lsetxattr (guestfs_h *g,\n"
11694 " const char *xattr,\n"
11695 " const char *val,\n"
11697 " const char *path);\n"
11702 #: ../src/guestfs-actions.pod:3734
11704 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
11705 "then it sets an extended attribute of the link itself."
11709 #: ../src/guestfs-actions.pod:3742
11710 msgid "guestfs_lstat"
11714 #: ../src/guestfs-actions.pod:3744
11717 " struct guestfs_stat *\n"
11718 " guestfs_lstat (guestfs_h *g,\n"
11719 " const char *path);\n"
11724 #: ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:6306 ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:4257
11725 msgid "Returns file information for the given C<path>."
11729 #: ../src/guestfs-actions.pod:3750
11731 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
11732 "link, then the link is stat-ed, not the file it refers to."
11736 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2594
11737 msgid "This is the same as the C<lstat(2)> system call."
11741 #: ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:6310
11743 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
11744 "error. I<The caller must call C<guestfs_free_stat> after use>."
11748 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6713
11749 msgid "(Added in 0.9.2)"
11753 #: ../src/guestfs-actions.pod:3762
11754 msgid "guestfs_lstatlist"
11758 #: ../src/guestfs-actions.pod:3764
11761 " struct guestfs_stat_list *\n"
11762 " guestfs_lstatlist (guestfs_h *g,\n"
11763 " const char *path,\n"
11764 " char *const *names);\n"
11769 #: ../src/guestfs-actions.pod:3769
11771 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
11772 "files, where all files are in the directory C<path>. C<names> is the list "
11773 "of files from this directory."
11777 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2604
11779 "On return you get a list of stat structs, with a one-to-one correspondence "
11780 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11781 "then the C<ino> field of that structure is set to C<-1>."
11785 #: ../src/guestfs-actions.pod:3778
11787 "This call is intended for programs that want to efficiently list a directory "
11788 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
11789 "for a similarly efficient call for getting extended attributes. Very long "
11790 "directory listings might cause the protocol message size to be exceeded, "
11791 "causing this call to fail. The caller must split up such requests into "
11792 "smaller groups of names."
11796 #: ../src/guestfs-actions.pod:3786
11798 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
11799 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
11803 #: ../src/guestfs-actions.pod:3792
11804 msgid "guestfs_luks_add_key"
11808 #: ../src/guestfs-actions.pod:3794
11812 " guestfs_luks_add_key (guestfs_h *g,\n"
11813 " const char *device,\n"
11814 " const char *key,\n"
11815 " const char *newkey,\n"
11821 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2621
11823 "This command adds a new key on LUKS device C<device>. C<key> is any "
11824 "existing key, and is used to access the device. C<newkey> is the new key to "
11825 "add. C<keyslot> is the key slot that will be replaced."
11829 #: ../src/guestfs-actions.pod:3806
11831 "Note that if C<keyslot> already contains a key, then this command will "
11832 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
11836 #: ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3946
11838 "This function takes a key or passphrase parameter which could contain "
11839 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
11844 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3856 ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3899
11845 msgid "(Added in 1.5.2)"
11849 #: ../src/guestfs-actions.pod:3818
11850 msgid "guestfs_luks_close"
11854 #: ../src/guestfs-actions.pod:3820
11858 " guestfs_luks_close (guestfs_h *g,\n"
11859 " const char *device);\n"
11864 #: ../src/guestfs-actions.pod:3824
11866 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
11867 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
11868 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
11869 "underlying block device."
11873 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3931 ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4048
11874 msgid "(Added in 1.5.1)"
11878 #: ../src/guestfs-actions.pod:3834
11879 msgid "guestfs_luks_format"
11883 #: ../src/guestfs-actions.pod:3836
11887 " guestfs_luks_format (guestfs_h *g,\n"
11888 " const char *device,\n"
11889 " const char *key,\n"
11895 #: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2647
11897 "This command erases existing data on C<device> and formats the device as a "
11898 "LUKS encrypted device. C<key> is the initial key, which is added to key "
11899 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
11903 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3872 ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4954 ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:6141 ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:2655 ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2752 ../fish/guestfish-actions.pod:3326 ../fish/guestfish-actions.pod:3846 ../fish/guestfish-actions.pod:4156 ../fish/guestfish-actions.pod:4172 ../fish/guestfish-actions.pod:4187 ../fish/guestfish-actions.pod:4902
11905 "B<This command is dangerous. Without careful use you can easily destroy all "
11910 #: ../src/guestfs-actions.pod:3858
11911 msgid "guestfs_luks_format_cipher"
11915 #: ../src/guestfs-actions.pod:3860
11919 " guestfs_luks_format_cipher (guestfs_h *g,\n"
11920 " const char *device,\n"
11921 " const char *key,\n"
11923 " const char *cipher);\n"
11928 #: ../src/guestfs-actions.pod:3867
11930 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11931 "set the C<cipher> used."
11935 #: ../src/guestfs-actions.pod:3881
11936 msgid "guestfs_luks_kill_slot"
11940 #: ../src/guestfs-actions.pod:3883
11944 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11945 " const char *device,\n"
11946 " const char *key,\n"
11952 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2675
11954 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11955 "device C<device>. C<key> must be one of the I<other> keys."
11959 #: ../src/guestfs-actions.pod:3901
11960 msgid "guestfs_luks_open"
11964 #: ../src/guestfs-actions.pod:3903
11968 " guestfs_luks_open (guestfs_h *g,\n"
11969 " const char *device,\n"
11970 " const char *key,\n"
11971 " const char *mapname);\n"
11976 #: ../src/guestfs-actions.pod:3909 ../fish/guestfish-actions.pod:2686
11978 "This command opens a block device which has been encrypted according to the "
11979 "Linux Unified Key Setup (LUKS) standard."
11983 #: ../src/guestfs-actions.pod:3912 ../fish/guestfish-actions.pod:2689
11984 msgid "C<device> is the encrypted block device or partition."
11988 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2691
11990 "The caller must supply one of the keys associated with the LUKS block "
11991 "device, in the C<key> parameter."
11995 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2694
11997 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11998 "writes to this block device are decrypted from and encrypted to the "
11999 "underlying C<device> respectively."
12003 #: ../src/guestfs-actions.pod:3921
12005 "If this block device contains LVM volume groups, then calling "
12006 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12011 #: ../src/guestfs-actions.pod:3933
12012 msgid "guestfs_luks_open_ro"
12016 #: ../src/guestfs-actions.pod:3935
12020 " guestfs_luks_open_ro (guestfs_h *g,\n"
12021 " const char *device,\n"
12022 " const char *key,\n"
12023 " const char *mapname);\n"
12028 #: ../src/guestfs-actions.pod:3941
12030 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12035 #: ../src/guestfs-actions.pod:3952
12036 msgid "guestfs_lvcreate"
12040 #: ../src/guestfs-actions.pod:3954
12044 " guestfs_lvcreate (guestfs_h *g,\n"
12045 " const char *logvol,\n"
12046 " const char *volgroup,\n"
12052 #: ../src/guestfs-actions.pod:3960 ../fish/guestfish-actions.pod:2719
12054 "This creates an LVM logical volume called C<logvol> on the volume group "
12055 "C<volgroup>, with C<size> megabytes."
12059 #: ../src/guestfs-actions.pod:3967
12060 msgid "guestfs_lvm_canonical_lv_name"
12064 #: ../src/guestfs-actions.pod:3969
12068 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12069 " const char *lvname);\n"
12074 #: ../src/guestfs-actions.pod:3973 ../fish/guestfish-actions.pod:2726
12076 "This converts alternative naming schemes for LVs that you might find to the "
12077 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12082 #: ../src/guestfs-actions.pod:3977 ../fish/guestfish-actions.pod:2730
12084 "This command returns an error if the C<lvname> parameter does not refer to a "
12089 #: ../src/guestfs-actions.pod:3980
12090 msgid "See also C<guestfs_is_lv>."
12094 #: ../src/guestfs-actions.pod:3985
12095 msgid "(Added in 1.5.24)"
12099 #: ../src/guestfs-actions.pod:3987
12100 msgid "guestfs_lvm_clear_filter"
12104 #: ../src/guestfs-actions.pod:3989
12108 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12113 #: ../src/guestfs-actions.pod:3992
12115 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12116 "see every block device."
12120 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2773
12121 msgid "This command also clears the LVM cache and performs a volume group scan."
12125 #: ../src/guestfs-actions.pod:4002
12126 msgid "guestfs_lvm_remove_all"
12130 #: ../src/guestfs-actions.pod:4004
12134 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12139 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2749
12141 "This command removes all LVM logical volumes, volume groups and physical "
12146 #: ../src/guestfs-actions.pod:4017
12147 msgid "guestfs_lvm_set_filter"
12151 #: ../src/guestfs-actions.pod:4019
12155 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12156 " char *const *devices);\n"
12161 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2759
12163 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12164 "block devices in the list C<devices>, and will ignore all other attached "
12169 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2763
12171 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12172 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12173 "there are two types of duplication possible: either cloned PVs/VGs which "
12174 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12175 "same name. In normal operation you cannot create this situation, but you "
12176 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12177 "inside the LVM metadata."
12181 #: ../src/guestfs-actions.pod:4040 ../fish/guestfish-actions.pod:2776
12182 msgid "You can filter whole block devices or individual partitions."
12186 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2778
12188 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12189 "filesystem), even if you are not filtering out that VG."
12193 #: ../src/guestfs-actions.pod:4050
12194 msgid "guestfs_lvremove"
12198 #: ../src/guestfs-actions.pod:4052
12202 " guestfs_lvremove (guestfs_h *g,\n"
12203 " const char *device);\n"
12208 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2786
12210 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12211 "LV, such as C</dev/VG/LV>."
12215 #: ../src/guestfs-actions.pod:4059 ../fish/guestfish-actions.pod:2789
12217 "You can also remove all LVs in a volume group by specifying the VG name, "
12222 #: ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:5300 ../src/guestfs-actions.pod:7089
12223 msgid "(Added in 1.0.13)"
12227 #: ../src/guestfs-actions.pod:4066
12228 msgid "guestfs_lvrename"
12232 #: ../src/guestfs-actions.pod:4068
12236 " guestfs_lvrename (guestfs_h *g,\n"
12237 " const char *logvol,\n"
12238 " const char *newlogvol);\n"
12243 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2796
12244 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12248 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:7102
12249 msgid "(Added in 1.0.83)"
12253 #: ../src/guestfs-actions.pod:4079
12254 msgid "guestfs_lvresize"
12258 #: ../src/guestfs-actions.pod:4081
12262 " guestfs_lvresize (guestfs_h *g,\n"
12263 " const char *device,\n"
12269 #: ../src/guestfs-actions.pod:4086 ../fish/guestfish-actions.pod:2802
12271 "This resizes (expands or shrinks) an existing LVM logical volume to "
12272 "C<mbytes>. When reducing, data in the reduced part is lost."
12276 #: ../src/guestfs-actions.pod:4094
12277 msgid "guestfs_lvresize_free"
12281 #: ../src/guestfs-actions.pod:4096
12285 " guestfs_lvresize_free (guestfs_h *g,\n"
12286 " const char *lv,\n"
12292 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2810
12294 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12295 "remaining free space in the volume group. Commonly you would call this with "
12296 "pc = 100 which expands the logical volume as much as possible, using all "
12297 "remaining free space in the volume group."
12301 #: ../src/guestfs-actions.pod:4109
12302 msgid "(Added in 1.3.3)"
12306 #: ../src/guestfs-actions.pod:4111
12307 msgid "guestfs_lvs"
12311 #: ../src/guestfs-actions.pod:4113
12315 " guestfs_lvs (guestfs_h *g);\n"
12320 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2820
12322 "List all the logical volumes detected. This is the equivalent of the "
12323 "L<lvs(8)> command."
12327 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2823
12329 "This returns a list of the logical volume device names "
12330 "(eg. C</dev/VolGroup00/LogVol00>)."
12334 #: ../src/guestfs-actions.pod:4122
12335 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12339 #: ../src/guestfs-actions.pod:4130
12340 msgid "guestfs_lvs_full"
12344 #: ../src/guestfs-actions.pod:4132
12347 " struct guestfs_lvm_lv_list *\n"
12348 " guestfs_lvs_full (guestfs_h *g);\n"
12353 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2832
12355 "List all the logical volumes detected. This is the equivalent of the "
12356 "L<lvs(8)> command. The \"full\" version includes all fields."
12360 #: ../src/guestfs-actions.pod:4138
12362 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12363 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12368 #: ../src/guestfs-actions.pod:4144
12369 msgid "guestfs_lvuuid"
12373 #: ../src/guestfs-actions.pod:4146
12377 " guestfs_lvuuid (guestfs_h *g,\n"
12378 " const char *device);\n"
12383 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2839
12384 msgid "This command returns the UUID of the LVM LV C<device>."
12388 #: ../src/guestfs-actions.pod:4157
12389 msgid "guestfs_lxattrlist"
12393 #: ../src/guestfs-actions.pod:4159
12396 " struct guestfs_xattr_list *\n"
12397 " guestfs_lxattrlist (guestfs_h *g,\n"
12398 " const char *path,\n"
12399 " char *const *names);\n"
12404 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2845
12406 "This call allows you to get the extended attributes of multiple files, where "
12407 "all files are in the directory C<path>. C<names> is the list of files from "
12412 #: ../src/guestfs-actions.pod:4168 ../fish/guestfish-actions.pod:2849
12414 "On return you get a flat list of xattr structs which must be interpreted "
12415 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12416 "C<attrval> in this struct is zero-length to indicate there was an error "
12417 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12418 "number (the number of following attributes for this file, which could be "
12419 "C<\"0\">). Then after the first xattr struct are the zero or more "
12420 "attributes for the first named file. This repeats for the second and "
12421 "subsequent files."
12425 #: ../src/guestfs-actions.pod:4178
12427 "This call is intended for programs that want to efficiently list a directory "
12428 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12429 "a similarly efficient call for getting standard stats. Very long directory "
12430 "listings might cause the protocol message size to be exceeded, causing this "
12431 "call to fail. The caller must split up such requests into smaller groups of "
12436 #: ../src/guestfs-actions.pod:4192
12437 msgid "guestfs_mkdir"
12441 #: ../src/guestfs-actions.pod:4194
12445 " guestfs_mkdir (guestfs_h *g,\n"
12446 " const char *path);\n"
12451 #: ../src/guestfs-actions.pod:4198 ../fish/guestfish-actions.pod:2871
12452 msgid "Create a directory named C<path>."
12456 #: ../src/guestfs-actions.pod:4204
12457 msgid "guestfs_mkdir_mode"
12461 #: ../src/guestfs-actions.pod:4206
12465 " guestfs_mkdir_mode (guestfs_h *g,\n"
12466 " const char *path,\n"
12472 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2877
12474 "This command creates a directory, setting the initial permissions of the "
12475 "directory to C<mode>."
12479 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2880
12481 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12482 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12487 #: ../src/guestfs-actions.pod:4218
12488 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12492 #: ../src/guestfs-actions.pod:4224
12493 msgid "guestfs_mkdir_p"
12497 #: ../src/guestfs-actions.pod:4226
12501 " guestfs_mkdir_p (guestfs_h *g,\n"
12502 " const char *path);\n"
12507 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2890
12509 "Create a directory named C<path>, creating any parent directories as "
12510 "necessary. This is like the C<mkdir -p> shell command."
12514 #: ../src/guestfs-actions.pod:4237
12515 msgid "guestfs_mkdtemp"
12519 #: ../src/guestfs-actions.pod:4239
12523 " guestfs_mkdtemp (guestfs_h *g,\n"
12524 " const char *template);\n"
12529 #: ../src/guestfs-actions.pod:4243 ../fish/guestfish-actions.pod:2897
12531 "This command creates a temporary directory. The C<template> parameter "
12532 "should be a full pathname for the temporary directory name with the final "
12533 "six characters being \"XXXXXX\"."
12537 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2902
12539 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12540 "being suitable for Windows filesystems."
12544 #: ../src/guestfs-actions.pod:4251 ../fish/guestfish-actions.pod:2905
12545 msgid "The name of the temporary directory that was created is returned."
12549 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2908
12550 msgid "The temporary directory is created with mode 0700 and is owned by root."
12554 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2911
12556 "The caller is responsible for deleting the temporary directory and its "
12557 "contents after use."
12561 #: ../src/guestfs-actions.pod:4260 ../fish/guestfish-actions.pod:2914
12562 msgid "See also: L<mkdtemp(3)>"
12566 #: ../src/guestfs-actions.pod:4267
12567 msgid "guestfs_mke2fs_J"
12571 #: ../src/guestfs-actions.pod:4269
12575 " guestfs_mke2fs_J (guestfs_h *g,\n"
12576 " const char *fstype,\n"
12577 " int blocksize,\n"
12578 " const char *device,\n"
12579 " const char *journal);\n"
12584 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2920
12586 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12587 "C<journal>. It is equivalent to the command:"
12591 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2924
12594 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
12599 #: ../src/guestfs-actions.pod:4282
12600 msgid "See also C<guestfs_mke2journal>."
12604 #: ../src/guestfs-actions.pod:4286 ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:4425 ../src/guestfs-actions.pod:4690
12605 msgid "(Added in 1.0.68)"
12609 #: ../src/guestfs-actions.pod:4288
12610 msgid "guestfs_mke2fs_JL"
12614 #: ../src/guestfs-actions.pod:4290
12618 " guestfs_mke2fs_JL (guestfs_h *g,\n"
12619 " const char *fstype,\n"
12620 " int blocksize,\n"
12621 " const char *device,\n"
12622 " const char *label);\n"
12627 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2932
12629 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12630 "the journal labeled C<label>."
12634 #: ../src/guestfs-actions.pod:4300
12635 msgid "See also C<guestfs_mke2journal_L>."
12639 #: ../src/guestfs-actions.pod:4306
12640 msgid "guestfs_mke2fs_JU"
12644 #: ../src/guestfs-actions.pod:4308
12648 " guestfs_mke2fs_JU (guestfs_h *g,\n"
12649 " const char *fstype,\n"
12650 " int blocksize,\n"
12651 " const char *device,\n"
12652 " const char *uuid);\n"
12657 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2941
12659 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12660 "the journal with UUID C<uuid>."
12664 #: ../src/guestfs-actions.pod:4318
12665 msgid "See also C<guestfs_mke2journal_U>."
12669 #: ../src/guestfs-actions.pod:4324
12670 msgid "guestfs_mke2journal"
12674 #: ../src/guestfs-actions.pod:4326
12678 " guestfs_mke2journal (guestfs_h *g,\n"
12679 " int blocksize,\n"
12680 " const char *device);\n"
12685 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2950
12687 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12692 #: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2953
12695 " mke2fs -O journal_dev -b blocksize device\n"
12700 #: ../src/guestfs-actions.pod:4340
12701 msgid "guestfs_mke2journal_L"
12705 #: ../src/guestfs-actions.pod:4342
12709 " guestfs_mke2journal_L (guestfs_h *g,\n"
12710 " int blocksize,\n"
12711 " const char *label,\n"
12712 " const char *device);\n"
12717 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2959
12718 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12722 #: ../src/guestfs-actions.pod:4354
12723 msgid "guestfs_mke2journal_U"
12727 #: ../src/guestfs-actions.pod:4356
12731 " guestfs_mke2journal_U (guestfs_h *g,\n"
12732 " int blocksize,\n"
12733 " const char *uuid,\n"
12734 " const char *device);\n"
12739 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2965
12740 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12744 #: ../src/guestfs-actions.pod:4368
12745 msgid "guestfs_mkfifo"
12749 #: ../src/guestfs-actions.pod:4370
12753 " guestfs_mkfifo (guestfs_h *g,\n"
12755 " const char *path);\n"
12760 #: ../src/guestfs-actions.pod:4375
12762 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12763 "is just a convenient wrapper around C<guestfs_mknod>."
12767 #: ../src/guestfs-actions.pod:4385
12768 msgid "guestfs_mkfs"
12772 #: ../src/guestfs-actions.pod:4387
12776 " guestfs_mkfs (guestfs_h *g,\n"
12777 " const char *fstype,\n"
12778 " const char *device);\n"
12783 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2981
12785 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12786 "volume). The filesystem type is C<fstype>, for example C<ext3>."
12790 #: ../src/guestfs-actions.pod:4400
12791 msgid "guestfs_mkfs_b"
12795 #: ../src/guestfs-actions.pod:4402
12799 " guestfs_mkfs_b (guestfs_h *g,\n"
12800 " const char *fstype,\n"
12801 " int blocksize,\n"
12802 " const char *device);\n"
12807 #: ../src/guestfs-actions.pod:4408
12809 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
12810 "block size of the resulting filesystem. Supported block sizes depend on the "
12811 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
12815 #: ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:2994 ../fish/guestfish-actions.pod:3021
12817 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
12822 #: ../src/guestfs-actions.pod:4418 ../fish/guestfish-actions.pod:2997
12824 "This function is deprecated. In new code, use the C<mkfs_opts> call "
12829 #: ../src/guestfs-actions.pod:4427
12830 msgid "guestfs_mkfs_opts"
12834 #: ../src/guestfs-actions.pod:4429
12838 " guestfs_mkfs_opts (guestfs_h *g,\n"
12839 " const char *fstype,\n"
12840 " const char *device,\n"
12846 #: ../src/guestfs-actions.pod:4440
12849 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
12850 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
12855 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:3008
12857 "This function creates a filesystem on C<device>. The filesystem type is "
12858 "C<fstype>, for example C<ext3>."
12862 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:3015
12863 msgid "C<blocksize>"
12867 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3017
12869 "The filesystem block size. Supported block sizes depend on the filesystem "
12870 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
12875 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:3024
12876 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
12880 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:3026
12881 msgid "C<features>"
12885 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:3028
12886 msgid "This passes the C<-O> parameter to the external mkfs program."
12890 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:3030
12892 "For certain filesystem types, this allows extra filesystem features to be "
12893 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
12897 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
12899 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
12904 #: ../src/guestfs-actions.pod:4476
12905 msgid "(Added in 1.7.19)"
12909 #: ../src/guestfs-actions.pod:4478
12910 msgid "guestfs_mkfs_opts_va"
12914 #: ../src/guestfs-actions.pod:4480
12918 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
12919 " const char *fstype,\n"
12920 " const char *device,\n"
12921 " va_list args);\n"
12926 #: ../src/guestfs-actions.pod:4486
12927 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
12931 #: ../src/guestfs-actions.pod:4490
12932 msgid "guestfs_mkfs_opts_argv"
12936 #: ../src/guestfs-actions.pod:4492
12940 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
12941 " const char *fstype,\n"
12942 " const char *device,\n"
12943 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12948 #: ../src/guestfs-actions.pod:4498
12949 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12953 #: ../src/guestfs-actions.pod:4502
12954 msgid "guestfs_mkmountpoint"
12958 #: ../src/guestfs-actions.pod:4504
12962 " guestfs_mkmountpoint (guestfs_h *g,\n"
12963 " const char *exemptpath);\n"
12968 #: ../src/guestfs-actions.pod:4508
12970 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12971 "that can be used to create extra mountpoints before mounting the first "
12976 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3049
12978 "These calls are I<only> necessary in some very limited circumstances, mainly "
12979 "the case where you want to mount a mix of unrelated and/or read-only "
12980 "filesystems together."
12984 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3053
12986 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12987 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12988 "inside that. You can unpack this as follows in guestfish:"
12992 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3058
12995 " add-ro Fedora-11-i686-Live.iso\n"
12997 " mkmountpoint /cd\n"
12998 " mkmountpoint /sqsh\n"
12999 " mkmountpoint /ext3fs\n"
13000 " mount /dev/sda /cd\n"
13001 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13002 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13007 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3067
13008 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13012 #: ../src/guestfs-actions.pod:4532
13014 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13015 "may get unexpected errors if you try to mix these calls. It is safest to "
13016 "manually unmount filesystems and remove mountpoints after use."
13020 #: ../src/guestfs-actions.pod:4536
13022 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13023 "first, so for this to work for manual mountpoints, you must ensure that the "
13024 "innermost mountpoints have the longest pathnames, as in the example code "
13029 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3078
13030 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13034 #: ../src/guestfs-actions.pod:4543
13036 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13037 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13038 "can also trigger these issues."
13042 #: ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4808 ../src/guestfs-actions.pod:5718
13043 msgid "(Added in 1.0.62)"
13047 #: ../src/guestfs-actions.pod:4551
13048 msgid "guestfs_mknod"
13052 #: ../src/guestfs-actions.pod:4553
13056 " guestfs_mknod (guestfs_h *g,\n"
13060 " const char *path);\n"
13065 #: ../src/guestfs-actions.pod:4560 ../fish/guestfish-actions.pod:3088
13067 "This call creates block or character special devices, or named pipes "
13072 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3091
13074 "The C<mode> parameter should be the mode, using the standard constants. "
13075 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13076 "used when creating block and character special devices."
13080 #: ../src/guestfs-actions.pod:4568
13082 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13083 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13084 "regular file). These constants are available in the standard Linux header "
13085 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13086 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13087 "the appropriate constant for you."
13091 #: ../src/guestfs-actions.pod:4582
13092 msgid "guestfs_mknod_b"
13096 #: ../src/guestfs-actions.pod:4584
13100 " guestfs_mknod_b (guestfs_h *g,\n"
13104 " const char *path);\n"
13109 #: ../src/guestfs-actions.pod:4591
13111 "This call creates a block device node called C<path> with mode C<mode> and "
13112 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13113 "wrapper around C<guestfs_mknod>."
13117 #: ../src/guestfs-actions.pod:4601
13118 msgid "guestfs_mknod_c"
13122 #: ../src/guestfs-actions.pod:4603
13126 " guestfs_mknod_c (guestfs_h *g,\n"
13130 " const char *path);\n"
13135 #: ../src/guestfs-actions.pod:4610
13137 "This call creates a char device node called C<path> with mode C<mode> and "
13138 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13139 "wrapper around C<guestfs_mknod>."
13143 #: ../src/guestfs-actions.pod:4620
13144 msgid "guestfs_mkswap"
13148 #: ../src/guestfs-actions.pod:4622
13152 " guestfs_mkswap (guestfs_h *g,\n"
13153 " const char *device);\n"
13158 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3130
13159 msgid "Create a swap partition on C<device>."
13163 #: ../src/guestfs-actions.pod:4632
13164 msgid "guestfs_mkswap_L"
13168 #: ../src/guestfs-actions.pod:4634
13172 " guestfs_mkswap_L (guestfs_h *g,\n"
13173 " const char *label,\n"
13174 " const char *device);\n"
13179 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3136
13180 msgid "Create a swap partition on C<device> with label C<label>."
13184 #: ../src/guestfs-actions.pod:4641 ../fish/guestfish-actions.pod:3138
13186 "Note that you cannot attach a swap label to a block device "
13187 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13188 "the kernel or swap tools."
13192 #: ../src/guestfs-actions.pod:4649
13193 msgid "guestfs_mkswap_U"
13197 #: ../src/guestfs-actions.pod:4651
13201 " guestfs_mkswap_U (guestfs_h *g,\n"
13202 " const char *uuid,\n"
13203 " const char *device);\n"
13208 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3146
13209 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13213 #: ../src/guestfs-actions.pod:4662
13214 msgid "guestfs_mkswap_file"
13218 #: ../src/guestfs-actions.pod:4664
13222 " guestfs_mkswap_file (guestfs_h *g,\n"
13223 " const char *path);\n"
13228 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3152
13229 msgid "Create a swap file."
13233 #: ../src/guestfs-actions.pod:4670
13235 "This command just writes a swap file signature to an existing file. To "
13236 "create the file itself, use something like C<guestfs_fallocate>."
13240 #: ../src/guestfs-actions.pod:4677
13241 msgid "guestfs_modprobe"
13245 #: ../src/guestfs-actions.pod:4679
13249 " guestfs_modprobe (guestfs_h *g,\n"
13250 " const char *modulename);\n"
13255 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3161
13256 msgid "This loads a kernel module in the appliance."
13260 #: ../src/guestfs-actions.pod:4685 ../fish/guestfish-actions.pod:3163
13262 "The kernel module must have been whitelisted when libguestfs was built (see "
13263 "C<appliance/kmod.whitelist.in> in the source)."
13267 #: ../src/guestfs-actions.pod:4692
13268 msgid "guestfs_mount"
13272 #: ../src/guestfs-actions.pod:4694
13276 " guestfs_mount (guestfs_h *g,\n"
13277 " const char *device,\n"
13278 " const char *mountpoint);\n"
13283 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3170
13285 "Mount a guest disk at a position in the filesystem. Block devices are named "
13286 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13287 "those block devices contain partitions, they will have the usual names "
13288 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13292 #: ../src/guestfs-actions.pod:4705 ../fish/guestfish-actions.pod:3176
13294 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13295 "mounted on C</> before others can be mounted. Other filesystems can only be "
13296 "mounted on directories which already exist."
13300 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3181
13302 "The mounted filesystem is writable, if we have sufficient permissions on the "
13303 "underlying device."
13307 #: ../src/guestfs-actions.pod:4713
13309 "B<Important note:> When you use this call, the filesystem options C<sync> "
13310 "and C<noatime> are set implicitly. This was originally done because we "
13311 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13312 "very large negative performance impact and negligible effect on "
13313 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13314 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13315 "(use an empty string for the first parameter if you don't want any options)."
13319 #: ../src/guestfs-actions.pod:4727
13320 msgid "guestfs_mount_loop"
13324 #: ../src/guestfs-actions.pod:4729
13328 " guestfs_mount_loop (guestfs_h *g,\n"
13329 " const char *file,\n"
13330 " const char *mountpoint);\n"
13335 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3198
13337 "This command lets you mount C<file> (a filesystem image in a file) on a "
13338 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13343 #: ../src/guestfs-actions.pod:4742
13344 msgid "guestfs_mount_options"
13348 #: ../src/guestfs-actions.pod:4744
13352 " guestfs_mount_options (guestfs_h *g,\n"
13353 " const char *options,\n"
13354 " const char *device,\n"
13355 " const char *mountpoint);\n"
13360 #: ../src/guestfs-actions.pod:4750
13362 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13363 "the mount options as for the L<mount(8)> I<-o> flag."
13367 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3210
13369 "If the C<options> parameter is an empty string, then no options are passed "
13370 "(all options default to whatever the filesystem uses)."
13374 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4791
13375 msgid "(Added in 1.0.10)"
13379 #: ../src/guestfs-actions.pod:4762
13380 msgid "guestfs_mount_ro"
13384 #: ../src/guestfs-actions.pod:4764
13388 " guestfs_mount_ro (guestfs_h *g,\n"
13389 " const char *device,\n"
13390 " const char *mountpoint);\n"
13395 #: ../src/guestfs-actions.pod:4769
13397 "This is the same as the C<guestfs_mount> command, but it mounts the "
13398 "filesystem with the read-only (I<-o ro>) flag."
13402 #: ../src/guestfs-actions.pod:4776
13403 msgid "guestfs_mount_vfs"
13407 #: ../src/guestfs-actions.pod:4778
13411 " guestfs_mount_vfs (guestfs_h *g,\n"
13412 " const char *options,\n"
13413 " const char *vfstype,\n"
13414 " const char *device,\n"
13415 " const char *mountpoint);\n"
13420 #: ../src/guestfs-actions.pod:4785
13422 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13423 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13428 #: ../src/guestfs-actions.pod:4793
13429 msgid "guestfs_mountpoints"
13433 #: ../src/guestfs-actions.pod:4795
13437 " guestfs_mountpoints (guestfs_h *g);\n"
13442 #: ../src/guestfs-actions.pod:4798
13444 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13445 "devices. This one returns a hash table (map) of device name to directory "
13446 "where the device is mounted."
13450 #: ../src/guestfs-actions.pod:4810
13451 msgid "guestfs_mounts"
13455 #: ../src/guestfs-actions.pod:4812
13459 " guestfs_mounts (guestfs_h *g);\n"
13464 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3241
13466 "This returns the list of currently mounted filesystems. It returns the list "
13467 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13471 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3244
13472 msgid "Some internal mounts are not shown."
13476 #: ../src/guestfs-actions.pod:4820
13477 msgid "See also: C<guestfs_mountpoints>"
13481 #: ../src/guestfs-actions.pod:4828
13486 #: ../src/guestfs-actions.pod:4830
13490 " guestfs_mv (guestfs_h *g,\n"
13491 " const char *src,\n"
13492 " const char *dest);\n"
13497 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3252
13499 "This moves a file from C<src> to C<dest> where C<dest> is either a "
13500 "destination filename or destination directory."
13504 #: ../src/guestfs-actions.pod:4842
13505 msgid "guestfs_ntfs_3g_probe"
13509 #: ../src/guestfs-actions.pod:4844
13513 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
13515 " const char *device);\n"
13520 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3259
13522 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
13523 "C<device> for mountability. (Not all NTFS volumes can be mounted "
13524 "read-write, and some cannot be mounted at all)."
13528 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3263
13530 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
13531 "can be mounted read-write. Set it to false if you want to test if the "
13532 "volume can be mounted read-only."
13536 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3267
13538 "The return value is an integer which C<0> if the operation would succeed, or "
13539 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
13543 #: ../src/guestfs-actions.pod:4863
13544 msgid "(Added in 1.0.43)"
13548 #: ../src/guestfs-actions.pod:4865
13549 msgid "guestfs_ntfsresize"
13553 #: ../src/guestfs-actions.pod:4867
13557 " guestfs_ntfsresize (guestfs_h *g,\n"
13558 " const char *device);\n"
13563 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3275
13565 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
13566 "size of the underlying device. See also L<ntfsresize(8)>."
13570 #: ../src/guestfs-actions.pod:4879
13571 msgid "guestfs_ntfsresize_size"
13575 #: ../src/guestfs-actions.pod:4881
13579 " guestfs_ntfsresize_size (guestfs_h *g,\n"
13580 " const char *device,\n"
13581 " int64_t size);\n"
13586 #: ../src/guestfs-actions.pod:4886
13588 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
13589 "to specify the new size (in bytes) explicitly."
13593 #: ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:7237
13594 msgid "(Added in 1.3.14)"
13598 #: ../src/guestfs-actions.pod:4893
13599 msgid "guestfs_part_add"
13603 #: ../src/guestfs-actions.pod:4895
13607 " guestfs_part_add (guestfs_h *g,\n"
13608 " const char *device,\n"
13609 " const char *prlogex,\n"
13610 " int64_t startsect,\n"
13611 " int64_t endsect);\n"
13616 #: ../src/guestfs-actions.pod:4902
13618 "This command adds a partition to C<device>. If there is no partition table "
13619 "on the device, call C<guestfs_part_init> first."
13623 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
13625 "The C<prlogex> parameter is the type of partition. Normally you should pass "
13626 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
13627 "C<logical>) and C<e> (or C<extended>) partition types."
13631 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3298
13633 "C<startsect> and C<endsect> are the start and end of the partition in "
13634 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
13635 "from the end of the disk (C<-1> is the last sector)."
13639 #: ../src/guestfs-actions.pod:4914
13641 "Creating a partition which covers the whole disk is not so easy. Use "
13642 "C<guestfs_part_disk> to do that."
13646 #: ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4957 ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5185
13647 msgid "(Added in 1.0.78)"
13651 #: ../src/guestfs-actions.pod:4921
13652 msgid "guestfs_part_del"
13656 #: ../src/guestfs-actions.pod:4923
13660 " guestfs_part_del (guestfs_h *g,\n"
13661 " const char *device,\n"
13667 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3309
13668 msgid "This command deletes the partition numbered C<partnum> on C<device>."
13672 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3311
13674 "Note that in the case of MBR partitioning, deleting an extended partition "
13675 "also deletes any logical partitions it contains."
13679 #: ../src/guestfs-actions.pod:4938
13680 msgid "guestfs_part_disk"
13684 #: ../src/guestfs-actions.pod:4940
13688 " guestfs_part_disk (guestfs_h *g,\n"
13689 " const char *device,\n"
13690 " const char *parttype);\n"
13695 #: ../src/guestfs-actions.pod:4945
13697 "This command is simply a combination of C<guestfs_part_init> followed by "
13698 "C<guestfs_part_add> to create a single primary partition covering the whole "
13703 #: ../src/guestfs-actions.pod:4949
13705 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
13706 "possible values are described in C<guestfs_part_init>."
13710 #: ../src/guestfs-actions.pod:4959
13711 msgid "guestfs_part_get_bootable"
13715 #: ../src/guestfs-actions.pod:4961
13719 " guestfs_part_get_bootable (guestfs_h *g,\n"
13720 " const char *device,\n"
13726 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3333
13728 "This command returns true if the partition C<partnum> on C<device> has the "
13729 "bootable flag set."
13733 #: ../src/guestfs-actions.pod:4969
13734 msgid "See also C<guestfs_part_set_bootable>."
13738 #: ../src/guestfs-actions.pod:4975
13739 msgid "guestfs_part_get_mbr_id"
13743 #: ../src/guestfs-actions.pod:4977
13747 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
13748 " const char *device,\n"
13754 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3342
13756 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13757 "partition C<partnum>."
13761 #: ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5161
13763 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
13764 "undefined results for other partition table types (see "
13765 "C<guestfs_part_get_parttype>)."
13769 #: ../src/guestfs-actions.pod:4993
13770 msgid "guestfs_part_get_parttype"
13774 #: ../src/guestfs-actions.pod:4995
13778 " guestfs_part_get_parttype (guestfs_h *g,\n"
13779 " const char *device);\n"
13784 #: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3353
13786 "This command examines the partition table on C<device> and returns the "
13787 "partition table type (format) being used."
13791 #: ../src/guestfs-actions.pod:5002
13793 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
13794 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
13795 "possible, although unusual. See C<guestfs_part_init> for a full list."
13799 #: ../src/guestfs-actions.pod:5012
13800 msgid "guestfs_part_init"
13804 #: ../src/guestfs-actions.pod:5014
13808 " guestfs_part_init (guestfs_h *g,\n"
13809 " const char *device,\n"
13810 " const char *parttype);\n"
13815 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3365
13817 "This creates an empty partition table on C<device> of one of the partition "
13818 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
13819 "(for large disks)."
13823 #: ../src/guestfs-actions.pod:5023
13825 "Initially there are no partitions. Following this, you should call "
13826 "C<guestfs_part_add> for each partition required."
13830 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3372
13831 msgid "Possible values for C<parttype> are:"
13835 #: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3376
13836 msgid "B<efi> | B<gpt>"
13840 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3378
13841 msgid "Intel EFI / GPT partition table."
13845 #: ../src/guestfs-actions.pod:5034 ../fish/guestfish-actions.pod:3380
13847 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
13848 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
13849 "the C<mbr> format."
13853 #: ../src/guestfs-actions.pod:5038 ../fish/guestfish-actions.pod:3384
13854 msgid "B<mbr> | B<msdos>"
13858 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3386
13860 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
13861 "Windows. This partition type will B<only> work for device sizes up to 2 "
13862 "TB. For large disks we recommend using C<gpt>."
13866 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3393
13867 msgid "Other partition table types that may work but are not supported include:"
13871 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
13876 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3400
13877 msgid "AIX disk labels."
13881 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
13882 msgid "B<amiga> | B<rdb>"
13886 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
13887 msgid "Amiga \"Rigid Disk Block\" format."
13891 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
13896 #: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3408
13897 msgid "BSD disk labels."
13901 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
13906 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
13907 msgid "DASD, used on IBM mainframes."
13911 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3414
13916 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3416
13917 msgid "MIPS/SGI volumes."
13921 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3418
13926 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3420
13927 msgid "Old Mac partition format. Modern Macs use C<gpt>."
13931 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3422
13936 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
13937 msgid "NEC PC-98 format, common in Japan apparently."
13941 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
13946 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
13947 msgid "Sun disk labels."
13951 #: ../src/guestfs-actions.pod:5090
13952 msgid "guestfs_part_list"
13956 #: ../src/guestfs-actions.pod:5092
13959 " struct guestfs_partition_list *\n"
13960 " guestfs_part_list (guestfs_h *g,\n"
13961 " const char *device);\n"
13966 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3436
13968 "This command parses the partition table on C<device> and returns the list of "
13969 "partitions found."
13973 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3439
13974 msgid "The fields in the returned structure are:"
13978 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3443
13979 msgid "B<part_num>"
13983 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3445
13984 msgid "Partition number, counting from 1."
13988 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3447
13989 msgid "B<part_start>"
13993 #: ../src/guestfs-actions.pod:5109
13995 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13996 "the device's sector size, see C<guestfs_blockdev_getss>."
14000 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3452
14001 msgid "B<part_end>"
14005 #: ../src/guestfs-actions.pod:5114 ../fish/guestfish-actions.pod:3454
14006 msgid "End of the partition in bytes."
14010 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3456
14011 msgid "B<part_size>"
14015 #: ../src/guestfs-actions.pod:5118 ../fish/guestfish-actions.pod:3458
14016 msgid "Size of the partition in bytes."
14020 #: ../src/guestfs-actions.pod:5122
14022 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14023 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14028 #: ../src/guestfs-actions.pod:5128
14029 msgid "guestfs_part_set_bootable"
14033 #: ../src/guestfs-actions.pod:5130
14037 " guestfs_part_set_bootable (guestfs_h *g,\n"
14038 " const char *device,\n"
14040 " int bootable);\n"
14045 #: ../src/guestfs-actions.pod:5136 ../fish/guestfish-actions.pod:3466
14047 "This sets the bootable flag on partition numbered C<partnum> on device "
14048 "C<device>. Note that partitions are numbered from 1."
14052 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3469
14054 "The bootable flag is used by some operating systems (notably Windows) to "
14055 "determine which partition to boot from. It is by no means universally "
14060 #: ../src/guestfs-actions.pod:5147
14061 msgid "guestfs_part_set_mbr_id"
14065 #: ../src/guestfs-actions.pod:5149
14069 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14070 " const char *device,\n"
14077 #: ../src/guestfs-actions.pod:5155 ../fish/guestfish-actions.pod:3477
14079 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14080 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14081 "documentation are in fact hexadecimal numbers, but usually documented "
14082 "without any leading \"0x\" which might be confusing."
14086 #: ../src/guestfs-actions.pod:5169
14087 msgid "guestfs_part_set_name"
14091 #: ../src/guestfs-actions.pod:5171
14095 " guestfs_part_set_name (guestfs_h *g,\n"
14096 " const char *device,\n"
14098 " const char *name);\n"
14103 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3491
14105 "This sets the partition name on partition numbered C<partnum> on device "
14106 "C<device>. Note that partitions are numbered from 1."
14110 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3494
14112 "The partition name can only be set on certain types of partition table. "
14113 "This works on C<gpt> but not on C<mbr> partitions."
14117 #: ../src/guestfs-actions.pod:5187
14118 msgid "guestfs_part_to_dev"
14122 #: ../src/guestfs-actions.pod:5189
14126 " guestfs_part_to_dev (guestfs_h *g,\n"
14127 " const char *partition);\n"
14132 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3501
14134 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14135 "partition number, returning the device name (eg. \"/dev/sdb\")."
14139 #: ../src/guestfs-actions.pod:5197
14141 "The named partition must exist, for example as a string returned from "
14142 "C<guestfs_list_partitions>."
14146 #: ../src/guestfs-actions.pod:5205
14147 msgid "guestfs_ping_daemon"
14151 #: ../src/guestfs-actions.pod:5207
14155 " guestfs_ping_daemon (guestfs_h *g);\n"
14160 #: ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3512
14162 "This is a test probe into the guestfs daemon running inside the qemu "
14163 "subprocess. Calling this function checks that the daemon responds to the "
14164 "ping message, without affecting the daemon or attached block device(s) in "
14169 #: ../src/guestfs-actions.pod:5219
14170 msgid "guestfs_pread"
14174 #: ../src/guestfs-actions.pod:5221
14178 " guestfs_pread (guestfs_h *g,\n"
14179 " const char *path,\n"
14181 " int64_t offset,\n"
14182 " size_t *size_r);\n"
14187 #: ../src/guestfs-actions.pod:5228 ../fish/guestfish-actions.pod:3521
14189 "This command lets you read part of a file. It reads C<count> bytes of the "
14190 "file, starting at C<offset>, from file C<path>."
14194 #: ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3524 ../fish/guestfish-actions.pod:3539
14196 "This may read fewer bytes than requested. For further details see the "
14197 "L<pread(2)> system call."
14201 #: ../src/guestfs-actions.pod:5234
14202 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14206 #: ../src/guestfs-actions.pod:5245
14207 msgid "guestfs_pread_device"
14211 #: ../src/guestfs-actions.pod:5247
14215 " guestfs_pread_device (guestfs_h *g,\n"
14216 " const char *device,\n"
14218 " int64_t offset,\n"
14219 " size_t *size_r);\n"
14224 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3536
14226 "This command lets you read part of a file. It reads C<count> bytes of "
14227 "C<device>, starting at C<offset>."
14231 #: ../src/guestfs-actions.pod:5260
14232 msgid "See also C<guestfs_pread>."
14236 #: ../src/guestfs-actions.pod:5269
14237 msgid "(Added in 1.5.21)"
14241 #: ../src/guestfs-actions.pod:5271
14242 msgid "guestfs_pvcreate"
14246 #: ../src/guestfs-actions.pod:5273
14250 " guestfs_pvcreate (guestfs_h *g,\n"
14251 " const char *device);\n"
14256 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3551
14258 "This creates an LVM physical volume on the named C<device>, where C<device> "
14259 "should usually be a partition name such as C</dev/sda1>."
14263 #: ../src/guestfs-actions.pod:5285
14264 msgid "guestfs_pvremove"
14268 #: ../src/guestfs-actions.pod:5287
14272 " guestfs_pvremove (guestfs_h *g,\n"
14273 " const char *device);\n"
14278 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3559
14280 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14285 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3562
14287 "The implementation uses the C<pvremove> command which refuses to wipe "
14288 "physical volumes that contain any volume groups, so you have to remove those "
14293 #: ../src/guestfs-actions.pod:5302
14294 msgid "guestfs_pvresize"
14298 #: ../src/guestfs-actions.pod:5304
14302 " guestfs_pvresize (guestfs_h *g,\n"
14303 " const char *device);\n"
14308 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3570
14310 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14311 "the new size of the underlying device."
14315 #: ../src/guestfs-actions.pod:5315
14316 msgid "guestfs_pvresize_size"
14320 #: ../src/guestfs-actions.pod:5317
14324 " guestfs_pvresize_size (guestfs_h *g,\n"
14325 " const char *device,\n"
14326 " int64_t size);\n"
14331 #: ../src/guestfs-actions.pod:5322
14333 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14334 "specify the new size (in bytes) explicitly."
14338 #: ../src/guestfs-actions.pod:5329
14339 msgid "guestfs_pvs"
14343 #: ../src/guestfs-actions.pod:5331
14347 " guestfs_pvs (guestfs_h *g);\n"
14352 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3584
14354 "List all the physical volumes detected. This is the equivalent of the "
14355 "L<pvs(8)> command."
14359 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3587
14361 "This returns a list of just the device names that contain PVs "
14362 "(eg. C</dev/sda2>)."
14366 #: ../src/guestfs-actions.pod:5340
14367 msgid "See also C<guestfs_pvs_full>."
14371 #: ../src/guestfs-actions.pod:5348
14372 msgid "guestfs_pvs_full"
14376 #: ../src/guestfs-actions.pod:5350
14379 " struct guestfs_lvm_pv_list *\n"
14380 " guestfs_pvs_full (guestfs_h *g);\n"
14385 #: ../src/guestfs-actions.pod:5353 ../fish/guestfish-actions.pod:3596
14387 "List all the physical volumes detected. This is the equivalent of the "
14388 "L<pvs(8)> command. The \"full\" version includes all fields."
14392 #: ../src/guestfs-actions.pod:5356
14394 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14395 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14400 #: ../src/guestfs-actions.pod:5362
14401 msgid "guestfs_pvuuid"
14405 #: ../src/guestfs-actions.pod:5364
14409 " guestfs_pvuuid (guestfs_h *g,\n"
14410 " const char *device);\n"
14415 #: ../src/guestfs-actions.pod:5368 ../fish/guestfish-actions.pod:3603
14416 msgid "This command returns the UUID of the LVM PV C<device>."
14420 #: ../src/guestfs-actions.pod:5375
14421 msgid "guestfs_pwrite"
14425 #: ../src/guestfs-actions.pod:5377
14429 " guestfs_pwrite (guestfs_h *g,\n"
14430 " const char *path,\n"
14431 " const char *content,\n"
14432 " size_t content_size,\n"
14433 " int64_t offset);\n"
14438 #: ../src/guestfs-actions.pod:5384 ../fish/guestfish-actions.pod:3609
14440 "This command writes to part of a file. It writes the data buffer C<content> "
14441 "to the file C<path> starting at offset C<offset>."
14445 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3612
14447 "This command implements the L<pwrite(2)> system call, and like that system "
14448 "call it may not write the full data requested. The return value is the "
14449 "number of bytes that were actually written to the file. This could even be "
14450 "0, although short writes are unlikely for regular files in ordinary "
14455 #: ../src/guestfs-actions.pod:5393
14456 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14460 #: ../src/guestfs-actions.pod:5402
14461 msgid "guestfs_pwrite_device"
14465 #: ../src/guestfs-actions.pod:5404
14469 " guestfs_pwrite_device (guestfs_h *g,\n"
14470 " const char *device,\n"
14471 " const char *content,\n"
14472 " size_t content_size,\n"
14473 " int64_t offset);\n"
14478 #: ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:3627
14480 "This command writes to part of a device. It writes the data buffer "
14481 "C<content> to C<device> starting at offset C<offset>."
14485 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
14487 "This command implements the L<pwrite(2)> system call, and like that system "
14488 "call it may not write the full data requested (although short writes to disk "
14489 "devices and partitions are probably impossible with standard Linux kernels)."
14493 #: ../src/guestfs-actions.pod:5419
14494 msgid "See also C<guestfs_pwrite>."
14498 #: ../src/guestfs-actions.pod:5426
14499 msgid "(Added in 1.5.20)"
14503 #: ../src/guestfs-actions.pod:5428
14504 msgid "guestfs_read_file"
14508 #: ../src/guestfs-actions.pod:5430
14512 " guestfs_read_file (guestfs_h *g,\n"
14513 " const char *path,\n"
14514 " size_t *size_r);\n"
14519 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3644
14520 msgid "This calls returns the contents of the file C<path> as a buffer."
14524 #: ../src/guestfs-actions.pod:5438
14526 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
14527 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
14528 "function is limited in the total size of file that can be handled."
14532 #: ../src/guestfs-actions.pod:5450
14533 msgid "(Added in 1.0.63)"
14537 #: ../src/guestfs-actions.pod:5452
14538 msgid "guestfs_read_lines"
14542 #: ../src/guestfs-actions.pod:5454
14546 " guestfs_read_lines (guestfs_h *g,\n"
14547 " const char *path);\n"
14552 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3661
14554 "The file contents are returned as a list of lines. Trailing C<LF> and "
14555 "C<CRLF> character sequences are I<not> returned."
14559 #: ../src/guestfs-actions.pod:5463
14561 "Note that this function cannot correctly handle binary files (specifically, "
14562 "files containing C<\\0> character which is treated as end of line). For "
14563 "those you need to use the C<guestfs_read_file> function which has a more "
14564 "complex interface."
14568 #: ../src/guestfs-actions.pod:5474
14569 msgid "guestfs_readdir"
14573 #: ../src/guestfs-actions.pod:5476
14576 " struct guestfs_dirent_list *\n"
14577 " guestfs_readdir (guestfs_h *g,\n"
14578 " const char *dir);\n"
14583 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3673
14584 msgid "This returns the list of directory entries in directory C<dir>."
14588 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3675
14590 "All entries in the directory are returned, including C<.> and C<..>. The "
14591 "entries are I<not> sorted, but returned in the same order as the underlying "
14596 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3679
14598 "Also this call returns basic file type information about each file. The "
14599 "C<ftyp> field will contain one of the following characters:"
14603 #: ../src/guestfs-actions.pod:5491 ../fish/guestfish-actions.pod:3684
14608 #: ../src/guestfs-actions.pod:5493 ../fish/guestfish-actions.pod:3686
14609 msgid "Block special"
14613 #: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3688
14618 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3690
14619 msgid "Char special"
14623 #: ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:3692
14628 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3694
14633 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3696
14638 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3698
14639 msgid "FIFO (named pipe)"
14643 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3700
14648 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3702
14649 msgid "Symbolic link"
14653 #: ../src/guestfs-actions.pod:5511 ../fish/guestfish-actions.pod:3704
14658 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3706
14659 msgid "Regular file"
14663 #: ../src/guestfs-actions.pod:5515 ../fish/guestfish-actions.pod:3708
14668 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
14673 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
14678 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
14679 msgid "Unknown file type"
14683 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
14688 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
14689 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
14693 #: ../src/guestfs-actions.pod:5530
14695 "This function is primarily intended for use by programs. To get a simple "
14696 "list of names, use C<guestfs_ls>. To get a printable directory for human "
14697 "consumption, use C<guestfs_ll>."
14701 #: ../src/guestfs-actions.pod:5534
14703 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
14704 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
14709 #: ../src/guestfs-actions.pod:5540
14710 msgid "guestfs_readlink"
14714 #: ../src/guestfs-actions.pod:5542
14718 " guestfs_readlink (guestfs_h *g,\n"
14719 " const char *path);\n"
14724 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3731
14725 msgid "This command reads the target of a symbolic link."
14729 #: ../src/guestfs-actions.pod:5553
14730 msgid "guestfs_readlinklist"
14734 #: ../src/guestfs-actions.pod:5555
14738 " guestfs_readlinklist (guestfs_h *g,\n"
14739 " const char *path,\n"
14740 " char *const *names);\n"
14745 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3737
14747 "This call allows you to do a C<readlink> operation on multiple files, where "
14748 "all files are in the directory C<path>. C<names> is the list of files from "
14753 #: ../src/guestfs-actions.pod:5564 ../fish/guestfish-actions.pod:3741
14755 "On return you get a list of strings, with a one-to-one correspondence to the "
14756 "C<names> list. Each string is the value of the symbolic link."
14760 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3745
14762 "If the C<readlink(2)> operation fails on any name, then the corresponding "
14763 "result string is the empty string C<\"\">. However the whole operation is "
14764 "completed even if there were C<readlink(2)> errors, and so you can call this "
14765 "function with names where you don't know if they are symbolic links already "
14766 "(albeit slightly less efficient)."
14770 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3752
14772 "This call is intended for programs that want to efficiently list a directory "
14773 "contents without making many round-trips. Very long directory listings "
14774 "might cause the protocol message size to be exceeded, causing this call to "
14775 "fail. The caller must split up such requests into smaller groups of names."
14779 #: ../src/guestfs-actions.pod:5588
14780 msgid "guestfs_realpath"
14784 #: ../src/guestfs-actions.pod:5590
14788 " guestfs_realpath (guestfs_h *g,\n"
14789 " const char *path);\n"
14794 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3763
14796 "Return the canonicalized absolute pathname of C<path>. The returned path "
14797 "has no C<.>, C<..> or symbolic link path elements."
14801 #: ../src/guestfs-actions.pod:5602
14802 msgid "guestfs_removexattr"
14806 #: ../src/guestfs-actions.pod:5604
14810 " guestfs_removexattr (guestfs_h *g,\n"
14811 " const char *xattr,\n"
14812 " const char *path);\n"
14817 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3770
14818 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
14822 #: ../src/guestfs-actions.pod:5612
14823 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
14827 #: ../src/guestfs-actions.pod:5618
14828 msgid "guestfs_resize2fs"
14832 #: ../src/guestfs-actions.pod:5620
14836 " guestfs_resize2fs (guestfs_h *g,\n"
14837 " const char *device);\n"
14842 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3779
14844 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
14845 "underlying device."
14849 #: ../src/guestfs-actions.pod:5627
14851 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
14852 "C<device> before calling this command. For unknown reasons C<resize2fs> "
14853 "sometimes gives an error about this and sometimes not. In any case, it is "
14854 "always safe to call C<guestfs_e2fsck_f> before calling this function."
14858 #: ../src/guestfs-actions.pod:5637
14859 msgid "guestfs_resize2fs_M"
14863 #: ../src/guestfs-actions.pod:5639
14867 " guestfs_resize2fs_M (guestfs_h *g,\n"
14868 " const char *device);\n"
14873 #: ../src/guestfs-actions.pod:5643
14875 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
14876 "resized to its minimum size. This works like the C<-M> option to the "
14877 "C<resize2fs> command."
14881 #: ../src/guestfs-actions.pod:5647
14883 "To get the resulting size of the filesystem you should call "
14884 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
14885 "These two numbers, multiplied together, give the resulting size of the "
14886 "minimal filesystem in bytes."
14890 #: ../src/guestfs-actions.pod:5654
14891 msgid "guestfs_resize2fs_size"
14895 #: ../src/guestfs-actions.pod:5656
14899 " guestfs_resize2fs_size (guestfs_h *g,\n"
14900 " const char *device,\n"
14901 " int64_t size);\n"
14906 #: ../src/guestfs-actions.pod:5661
14908 "This command is the same as C<guestfs_resize2fs> except that it allows you "
14909 "to specify the new size (in bytes) explicitly."
14913 #: ../src/guestfs-actions.pod:5668
14918 #: ../src/guestfs-actions.pod:5670
14922 " guestfs_rm (guestfs_h *g,\n"
14923 " const char *path);\n"
14928 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3812
14929 msgid "Remove the single file C<path>."
14933 #: ../src/guestfs-actions.pod:5680
14934 msgid "guestfs_rm_rf"
14938 #: ../src/guestfs-actions.pod:5682
14942 " guestfs_rm_rf (guestfs_h *g,\n"
14943 " const char *path);\n"
14948 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3818
14950 "Remove the file or directory C<path>, recursively removing the contents if "
14951 "its a directory. This is like the C<rm -rf> shell command."
14955 #: ../src/guestfs-actions.pod:5694
14956 msgid "guestfs_rmdir"
14960 #: ../src/guestfs-actions.pod:5696
14964 " guestfs_rmdir (guestfs_h *g,\n"
14965 " const char *path);\n"
14970 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3826
14971 msgid "Remove the single directory C<path>."
14975 #: ../src/guestfs-actions.pod:5706
14976 msgid "guestfs_rmmountpoint"
14980 #: ../src/guestfs-actions.pod:5708
14984 " guestfs_rmmountpoint (guestfs_h *g,\n"
14985 " const char *exemptpath);\n"
14990 #: ../src/guestfs-actions.pod:5712
14992 "This calls removes a mountpoint that was previously created with "
14993 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14997 #: ../src/guestfs-actions.pod:5720
14998 msgid "guestfs_scrub_device"
15002 #: ../src/guestfs-actions.pod:5722
15006 " guestfs_scrub_device (guestfs_h *g,\n"
15007 " const char *device);\n"
15012 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3840
15014 "This command writes patterns over C<device> to make data retrieval more "
15019 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3843 ../fish/guestfish-actions.pod:3858 ../fish/guestfish-actions.pod:3871
15021 "It is an interface to the L<scrub(1)> program. See that manual page for "
15026 #: ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:5774
15027 msgid "(Added in 1.0.52)"
15031 #: ../src/guestfs-actions.pod:5739
15032 msgid "guestfs_scrub_file"
15036 #: ../src/guestfs-actions.pod:5741
15040 " guestfs_scrub_file (guestfs_h *g,\n"
15041 " const char *file);\n"
15046 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3853
15048 "This command writes patterns over a file to make data retrieval more "
15053 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3856
15054 msgid "The file is I<removed> after scrubbing."
15058 #: ../src/guestfs-actions.pod:5757
15059 msgid "guestfs_scrub_freespace"
15063 #: ../src/guestfs-actions.pod:5759
15067 " guestfs_scrub_freespace (guestfs_h *g,\n"
15068 " const char *dir);\n"
15073 #: ../src/guestfs-actions.pod:5763
15075 "This command creates the directory C<dir> and then fills it with files until "
15076 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15077 "and deletes them. The intention is to scrub any free space on the partition "
15078 "containing C<dir>."
15082 #: ../src/guestfs-actions.pod:5776
15083 msgid "guestfs_set_append"
15087 #: ../src/guestfs-actions.pod:5778
15091 " guestfs_set_append (guestfs_h *g,\n"
15092 " const char *append);\n"
15097 #: ../src/guestfs-actions.pod:5782 ../fish/guestfish-actions.pod:3880
15099 "This function is used to add additional options to the guest kernel command "
15104 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3883
15106 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15107 "environment variable."
15111 #: ../src/guestfs-actions.pod:5788 ../fish/guestfish-actions.pod:3886
15113 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15114 "(libguestfs always adds a few of its own)."
15118 #: ../src/guestfs-actions.pod:5795
15119 msgid "guestfs_set_attach_method"
15123 #: ../src/guestfs-actions.pod:5797
15127 " guestfs_set_attach_method (guestfs_h *g,\n"
15128 " const char *attachmethod);\n"
15133 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3895
15135 "Set the method that libguestfs uses to connect to the back end guestfsd "
15136 "daemon. Possible methods are:"
15140 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3902
15142 "Launch an appliance and connect to it. This is the ordinary method and the "
15147 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3905
15148 msgid "C<unix:I<path>>"
15152 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3907
15153 msgid "Connect to the Unix domain socket I<path>."
15157 #: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3909
15159 "This method lets you connect to an existing daemon or (using virtio-serial) "
15160 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15161 "RUNNING DAEMONS>."
15165 #: ../src/guestfs-actions.pod:5823
15166 msgid "guestfs_set_autosync"
15170 #: ../src/guestfs-actions.pod:5825
15174 " guestfs_set_autosync (guestfs_h *g,\n"
15175 " int autosync);\n"
15180 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3921
15182 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15183 "effort attempt to make filesystems consistent and synchronized when the "
15184 "handle is closed (also if the program exits without closing handles)."
15188 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3926
15190 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15191 "disabled by default)."
15195 #: ../src/guestfs-actions.pod:5841
15196 msgid "guestfs_set_direct"
15200 #: ../src/guestfs-actions.pod:5843
15204 " guestfs_set_direct (guestfs_h *g,\n"
15210 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3935
15212 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15213 "passed directly through to the appliance once it is launched."
15217 #: ../src/guestfs-actions.pod:5851
15219 "One consequence of this is that log messages aren't caught by the library "
15220 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15225 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3943
15226 msgid "You probably don't want to use this unless you know what you are doing."
15230 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3946
15231 msgid "The default is disabled."
15235 #: ../src/guestfs-actions.pod:5864
15236 msgid "guestfs_set_e2label"
15240 #: ../src/guestfs-actions.pod:5866
15244 " guestfs_set_e2label (guestfs_h *g,\n"
15245 " const char *device,\n"
15246 " const char *label);\n"
15251 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3952
15253 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15254 "C<label>. Filesystem labels are limited to 16 characters."
15258 #: ../src/guestfs-actions.pod:5875
15260 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15261 "the existing label on a filesystem."
15265 #: ../src/guestfs-actions.pod:5882
15266 msgid "guestfs_set_e2uuid"
15270 #: ../src/guestfs-actions.pod:5884
15274 " guestfs_set_e2uuid (guestfs_h *g,\n"
15275 " const char *device,\n"
15276 " const char *uuid);\n"
15281 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3963
15283 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15284 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15285 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15289 #: ../src/guestfs-actions.pod:5894
15291 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15292 "the existing UUID of a filesystem."
15296 #: ../src/guestfs-actions.pod:5901
15297 msgid "guestfs_set_memsize"
15301 #: ../src/guestfs-actions.pod:5903
15305 " guestfs_set_memsize (guestfs_h *g,\n"
15311 #: ../src/guestfs-actions.pod:5907
15313 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15314 "This only has any effect if called before C<guestfs_launch>."
15318 #: ../src/guestfs-actions.pod:5911 ../fish/guestfish-actions.pod:3981
15320 "You can also change this by setting the environment variable "
15321 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15325 #: ../src/guestfs-actions.pod:5922
15326 msgid "guestfs_set_network"
15330 #: ../src/guestfs-actions.pod:5924
15334 " guestfs_set_network (guestfs_h *g,\n"
15340 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3994
15342 "If C<network> is true, then the network is enabled in the libguestfs "
15343 "appliance. The default is false."
15347 #: ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:3997
15349 "This affects whether commands are able to access the network (see "
15350 "L<guestfs(3)/RUNNING COMMANDS>)."
15354 #: ../src/guestfs-actions.pod:5934
15356 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15361 #: ../src/guestfs-actions.pod:5941
15362 msgid "guestfs_set_path"
15366 #: ../src/guestfs-actions.pod:5943
15370 " guestfs_set_path (guestfs_h *g,\n"
15371 " const char *searchpath);\n"
15376 #: ../src/guestfs-actions.pod:5947 ../fish/guestfish-actions.pod:4009
15377 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15381 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4011
15383 "The default is C<$libdir/guestfs> unless overridden by setting "
15384 "C<LIBGUESTFS_PATH> environment variable."
15388 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4014
15389 msgid "Setting C<path> to C<NULL> restores the default path."
15393 #: ../src/guestfs-actions.pod:5958
15394 msgid "guestfs_set_qemu"
15398 #: ../src/guestfs-actions.pod:5960
15402 " guestfs_set_qemu (guestfs_h *g,\n"
15403 " const char *qemu);\n"
15408 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:4022
15409 msgid "Set the qemu binary that we will use."
15413 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:4024
15414 msgid "The default is chosen when the library was compiled by the configure script."
15418 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4027
15420 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15425 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4030
15426 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15430 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4032
15432 "Note that you should call this function as early as possible after creating "
15433 "the handle. This is because some pre-launch operations depend on testing "
15434 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15435 "don't retest features, and so you might see inconsistent results. Using the "
15436 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15437 "the qemu binary at the same time as the handle is created."
15441 #: ../src/guestfs-actions.pod:5986
15442 msgid "guestfs_set_recovery_proc"
15446 #: ../src/guestfs-actions.pod:5988
15450 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15451 " int recoveryproc);\n"
15456 #: ../src/guestfs-actions.pod:5992
15458 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15459 "not create a recovery process. The purpose of the recovery process is to "
15460 "stop runaway qemu processes in the case where the main program aborts "
15465 #: ../src/guestfs-actions.pod:5997
15467 "This only has any effect if called before C<guestfs_launch>, and the default "
15472 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4054
15474 "About the only time when you would want to disable this is if the main "
15475 "process will fork itself into the background (\"daemonize\" itself). In "
15476 "this case the recovery process thinks that the main program has disappeared "
15477 "and so kills qemu, which is not very helpful."
15481 #: ../src/guestfs-actions.pod:6010
15482 msgid "guestfs_set_selinux"
15486 #: ../src/guestfs-actions.pod:6012
15490 " guestfs_set_selinux (guestfs_h *g,\n"
15496 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4066
15498 "This sets the selinux flag that is passed to the appliance at boot time. "
15499 "The default is C<selinux=0> (disabled)."
15503 #: ../src/guestfs-actions.pod:6019 ../fish/guestfish-actions.pod:4069
15505 "Note that if SELinux is enabled, it is always in Permissive mode "
15506 "(C<enforcing=0>)."
15510 #: ../src/guestfs-actions.pod:6029
15511 msgid "guestfs_set_trace"
15515 #: ../src/guestfs-actions.pod:6031
15519 " guestfs_set_trace (guestfs_h *g,\n"
15525 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4081
15527 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
15528 "return values are traced."
15532 #: ../src/guestfs-actions.pod:6038 ../fish/guestfish-actions.pod:4084
15534 "If you want to trace C API calls into libguestfs (and other libraries) then "
15535 "possibly a better way is to use the external ltrace(1) command."
15539 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4088
15541 "Command traces are disabled unless the environment variable "
15542 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
15546 #: ../src/guestfs-actions.pod:6045
15548 "Trace messages are normally sent to C<stderr>, unless you register a "
15549 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15553 #: ../src/guestfs-actions.pod:6053
15554 msgid "guestfs_set_verbose"
15558 #: ../src/guestfs-actions.pod:6055
15562 " guestfs_set_verbose (guestfs_h *g,\n"
15568 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4101
15569 msgid "If C<verbose> is true, this turns on verbose messages."
15573 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4103
15575 "Verbose messages are disabled unless the environment variable "
15576 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
15580 #: ../src/guestfs-actions.pod:6064
15582 "Verbose messages are normally sent to C<stderr>, unless you register a "
15583 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15587 #: ../src/guestfs-actions.pod:6072
15588 msgid "guestfs_setcon"
15592 #: ../src/guestfs-actions.pod:6074
15596 " guestfs_setcon (guestfs_h *g,\n"
15597 " const char *context);\n"
15602 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4114
15604 "This sets the SELinux security context of the daemon to the string "
15609 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4117
15610 msgid "See the documentation about SELINUX in L<guestfs(3)>."
15614 #: ../src/guestfs-actions.pod:6087
15615 msgid "guestfs_setxattr"
15619 #: ../src/guestfs-actions.pod:6089
15623 " guestfs_setxattr (guestfs_h *g,\n"
15624 " const char *xattr,\n"
15625 " const char *val,\n"
15627 " const char *path);\n"
15632 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4123
15634 "This call sets the extended attribute named C<xattr> of the file C<path> to "
15635 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
15639 #: ../src/guestfs-actions.pod:6100
15640 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
15644 #: ../src/guestfs-actions.pod:6106
15645 msgid "guestfs_sfdisk"
15649 #: ../src/guestfs-actions.pod:6108
15653 " guestfs_sfdisk (guestfs_h *g,\n"
15654 " const char *device,\n"
15658 " char *const *lines);\n"
15663 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4133
15665 "This is a direct interface to the L<sfdisk(8)> program for creating "
15666 "partitions on block devices."
15670 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4136
15671 msgid "C<device> should be a block device, for example C</dev/sda>."
15675 #: ../src/guestfs-actions.pod:6121 ../fish/guestfish-actions.pod:4138
15677 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
15678 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
15679 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
15680 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
15681 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
15682 "the kernel) cannot work out the right geometry and you will need to tell it."
15686 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4146
15688 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
15689 "refer to the L<sfdisk(8)> manpage."
15693 #: ../src/guestfs-actions.pod:6132 ../fish/guestfish-actions.pod:4149
15695 "To create a single partition occupying the whole disk, you would pass "
15696 "C<lines> as a single element list, when the single element being the string "
15701 #: ../src/guestfs-actions.pod:6136
15702 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
15706 #: ../src/guestfs-actions.pod:6146
15707 msgid "guestfs_sfdiskM"
15711 #: ../src/guestfs-actions.pod:6148
15715 " guestfs_sfdiskM (guestfs_h *g,\n"
15716 " const char *device,\n"
15717 " char *const *lines);\n"
15722 #: ../src/guestfs-actions.pod:6153
15724 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
15725 "partition sizes are specified in megabytes only (rounded to the nearest "
15726 "cylinder) and you don't need to specify the cyls, heads and sectors "
15727 "parameters which were rarely if ever used anyway."
15731 #: ../src/guestfs-actions.pod:6159
15733 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
15734 "C<guestfs_part_disk>"
15738 #: ../src/guestfs-actions.pod:6169
15739 msgid "guestfs_sfdisk_N"
15743 #: ../src/guestfs-actions.pod:6171
15747 " guestfs_sfdisk_N (guestfs_h *g,\n"
15748 " const char *device,\n"
15753 " const char *line);\n"
15758 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4179
15760 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15761 "(note: C<n> counts from 1)."
15765 #: ../src/guestfs-actions.pod:6183
15767 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
15768 "for the cyls/heads/sectors parameters."
15772 #: ../src/guestfs-actions.pod:6186
15773 msgid "See also: C<guestfs_part_add>"
15777 #: ../src/guestfs-actions.pod:6195
15778 msgid "guestfs_sfdisk_disk_geometry"
15782 #: ../src/guestfs-actions.pod:6197
15786 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
15787 " const char *device);\n"
15792 #: ../src/guestfs-actions.pod:6201
15794 "This displays the disk geometry of C<device> read from the partition table. "
15795 "Especially in the case where the underlying block device has been resized, "
15796 "this can be different from the kernel's idea of the geometry (see "
15797 "C<guestfs_sfdisk_kernel_geometry>)."
15801 #: ../src/guestfs-actions.pod:6206 ../src/guestfs-actions.pod:6222 ../fish/guestfish-actions.pod:4199 ../fish/guestfish-actions.pod:4208
15802 msgid "The result is in human-readable format, and not designed to be parsed."
15806 #: ../src/guestfs-actions.pod:6214
15807 msgid "guestfs_sfdisk_kernel_geometry"
15811 #: ../src/guestfs-actions.pod:6216
15815 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
15816 " const char *device);\n"
15821 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4206
15822 msgid "This displays the kernel's idea of the geometry of C<device>."
15826 #: ../src/guestfs-actions.pod:6230
15827 msgid "guestfs_sfdisk_l"
15831 #: ../src/guestfs-actions.pod:6232
15835 " guestfs_sfdisk_l (guestfs_h *g,\n"
15836 " const char *device);\n"
15841 #: ../src/guestfs-actions.pod:6236 ../fish/guestfish-actions.pod:4215
15843 "This displays the partition table on C<device>, in the human-readable output "
15844 "of the L<sfdisk(8)> command. It is not intended to be parsed."
15848 #: ../src/guestfs-actions.pod:6240
15849 msgid "See also: C<guestfs_part_list>"
15853 #: ../src/guestfs-actions.pod:6247
15858 #: ../src/guestfs-actions.pod:6249
15862 " guestfs_sh (guestfs_h *g,\n"
15863 " const char *command);\n"
15868 #: ../src/guestfs-actions.pod:6253 ../fish/guestfish-actions.pod:4225
15870 "This call runs a command from the guest filesystem via the guest's "
15875 #: ../src/guestfs-actions.pod:6256
15876 msgid "This is like C<guestfs_command>, but passes the command to:"
15880 #: ../src/guestfs-actions.pod:6258 ../fish/guestfish-actions.pod:4230
15883 " /bin/sh -c \"command\"\n"
15888 #: ../src/guestfs-actions.pod:6260 ../fish/guestfish-actions.pod:4232
15890 "Depending on the guest's shell, this usually results in wildcards being "
15891 "expanded, shell expressions being interpolated and so on."
15895 #: ../src/guestfs-actions.pod:6264
15896 msgid "All the provisos about C<guestfs_command> apply to this call."
15900 #: ../src/guestfs-actions.pod:6271
15901 msgid "guestfs_sh_lines"
15905 #: ../src/guestfs-actions.pod:6273
15909 " guestfs_sh_lines (guestfs_h *g,\n"
15910 " const char *command);\n"
15915 #: ../src/guestfs-actions.pod:6277
15917 "This is the same as C<guestfs_sh>, but splits the result into a list of "
15922 #: ../src/guestfs-actions.pod:6280
15923 msgid "See also: C<guestfs_command_lines>"
15927 #: ../src/guestfs-actions.pod:6288
15928 msgid "guestfs_sleep"
15932 #: ../src/guestfs-actions.pod:6290
15936 " guestfs_sleep (guestfs_h *g,\n"
15942 #: ../src/guestfs-actions.pod:6294 ../fish/guestfish-actions.pod:4251
15943 msgid "Sleep for C<secs> seconds."
15947 #: ../src/guestfs-actions.pod:6298
15948 msgid "(Added in 1.0.41)"
15952 #: ../src/guestfs-actions.pod:6300 ../src/guestfs-structs.pod:109
15953 msgid "guestfs_stat"
15957 #: ../src/guestfs-actions.pod:6302
15960 " struct guestfs_stat *\n"
15961 " guestfs_stat (guestfs_h *g,\n"
15962 " const char *path);\n"
15967 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4259
15968 msgid "This is the same as the C<stat(2)> system call."
15972 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-structs.pod:135
15973 msgid "guestfs_statvfs"
15977 #: ../src/guestfs-actions.pod:6318
15980 " struct guestfs_statvfs *\n"
15981 " guestfs_statvfs (guestfs_h *g,\n"
15982 " const char *path);\n"
15987 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4265
15989 "Returns file system statistics for any mounted file system. C<path> should "
15990 "be a file or directory in the mounted file system (typically it is the mount "
15991 "point itself, but it doesn't need to be)."
15995 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4269
15996 msgid "This is the same as the C<statvfs(2)> system call."
16000 #: ../src/guestfs-actions.pod:6328
16002 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16003 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16007 #: ../src/guestfs-actions.pod:6334
16008 msgid "guestfs_strings"
16012 #: ../src/guestfs-actions.pod:6336
16016 " guestfs_strings (guestfs_h *g,\n"
16017 " const char *path);\n"
16022 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4275
16024 "This runs the L<strings(1)> command on a file and returns the list of "
16025 "printable strings found."
16029 #: ../src/guestfs-actions.pod:6352
16030 msgid "guestfs_strings_e"
16034 #: ../src/guestfs-actions.pod:6354
16038 " guestfs_strings_e (guestfs_h *g,\n"
16039 " const char *encoding,\n"
16040 " const char *path);\n"
16045 #: ../src/guestfs-actions.pod:6359
16047 "This is like the C<guestfs_strings> command, but allows you to specify the "
16048 "encoding of strings that are looked for in the source file C<path>."
16052 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4289
16053 msgid "Allowed encodings are:"
16057 #: ../src/guestfs-actions.pod:6367 ../fish/guestfish-actions.pod:4293
16062 #: ../src/guestfs-actions.pod:6369
16064 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16065 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16069 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4298
16074 #: ../src/guestfs-actions.pod:6374 ../fish/guestfish-actions.pod:4300
16075 msgid "Single 8-bit-byte characters."
16079 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4302
16084 #: ../src/guestfs-actions.pod:6378 ../fish/guestfish-actions.pod:4304
16085 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16089 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4307
16090 msgid "l (lower case letter L)"
16094 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4309
16096 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16097 "examining binaries in Windows guests."
16101 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4312
16106 #: ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4314
16107 msgid "32-bit big endian such as UCS-4BE."
16111 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4316
16116 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4318
16117 msgid "32-bit little endian such as UCS-4LE."
16121 #: ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:4322
16122 msgid "The returned strings are transcoded to UTF-8."
16126 #: ../src/guestfs-actions.pod:6407
16127 msgid "guestfs_swapoff_device"
16131 #: ../src/guestfs-actions.pod:6409
16135 " guestfs_swapoff_device (guestfs_h *g,\n"
16136 " const char *device);\n"
16141 #: ../src/guestfs-actions.pod:6413
16143 "This command disables the libguestfs appliance swap device or partition "
16144 "named C<device>. See C<guestfs_swapon_device>."
16148 #: ../src/guestfs-actions.pod:6421
16149 msgid "guestfs_swapoff_file"
16153 #: ../src/guestfs-actions.pod:6423
16157 " guestfs_swapoff_file (guestfs_h *g,\n"
16158 " const char *file);\n"
16163 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4339
16164 msgid "This command disables the libguestfs appliance swap on file."
16168 #: ../src/guestfs-actions.pod:6433
16169 msgid "guestfs_swapoff_label"
16173 #: ../src/guestfs-actions.pod:6435
16177 " guestfs_swapoff_label (guestfs_h *g,\n"
16178 " const char *label);\n"
16183 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4345
16185 "This command disables the libguestfs appliance swap on labeled swap "
16190 #: ../src/guestfs-actions.pod:6446
16191 msgid "guestfs_swapoff_uuid"
16195 #: ../src/guestfs-actions.pod:6448
16199 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16200 " const char *uuid);\n"
16205 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4352
16207 "This command disables the libguestfs appliance swap partition with the given "
16212 #: ../src/guestfs-actions.pod:6459
16213 msgid "guestfs_swapon_device"
16217 #: ../src/guestfs-actions.pod:6461
16221 " guestfs_swapon_device (guestfs_h *g,\n"
16222 " const char *device);\n"
16227 #: ../src/guestfs-actions.pod:6465
16229 "This command enables the libguestfs appliance to use the swap device or "
16230 "partition named C<device>. The increased memory is made available for all "
16231 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16235 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4364
16237 "Note that you should not swap to existing guest swap partitions unless you "
16238 "know what you are doing. They may contain hibernation information, or other "
16239 "information that the guest doesn't want you to trash. You also risk leaking "
16240 "information about the host to the guest this way. Instead, attach a new "
16241 "host device to the guest and swap on that."
16245 #: ../src/guestfs-actions.pod:6481
16246 msgid "guestfs_swapon_file"
16250 #: ../src/guestfs-actions.pod:6483
16254 " guestfs_swapon_file (guestfs_h *g,\n"
16255 " const char *file);\n"
16260 #: ../src/guestfs-actions.pod:6487
16262 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16267 #: ../src/guestfs-actions.pod:6494
16268 msgid "guestfs_swapon_label"
16272 #: ../src/guestfs-actions.pod:6496
16276 " guestfs_swapon_label (guestfs_h *g,\n"
16277 " const char *label);\n"
16282 #: ../src/guestfs-actions.pod:6500
16284 "This command enables swap to a labeled swap partition. See "
16285 "C<guestfs_swapon_device> for other notes."
16289 #: ../src/guestfs-actions.pod:6507
16290 msgid "guestfs_swapon_uuid"
16294 #: ../src/guestfs-actions.pod:6509
16298 " guestfs_swapon_uuid (guestfs_h *g,\n"
16299 " const char *uuid);\n"
16304 #: ../src/guestfs-actions.pod:6513
16306 "This command enables swap to a swap partition with the given UUID. See "
16307 "C<guestfs_swapon_device> for other notes."
16311 #: ../src/guestfs-actions.pod:6520
16312 msgid "guestfs_sync"
16316 #: ../src/guestfs-actions.pod:6522
16320 " guestfs_sync (guestfs_h *g);\n"
16325 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4396
16327 "This syncs the disk, so that any writes are flushed through to the "
16328 "underlying disk image."
16332 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4399
16334 "You should always call this if you have modified a disk image, before "
16335 "closing the handle."
16339 #: ../src/guestfs-actions.pod:6535
16340 msgid "guestfs_tail"
16344 #: ../src/guestfs-actions.pod:6537
16348 " guestfs_tail (guestfs_h *g,\n"
16349 " const char *path);\n"
16354 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4406
16355 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16359 #: ../src/guestfs-actions.pod:6553
16360 msgid "guestfs_tail_n"
16364 #: ../src/guestfs-actions.pod:6555
16368 " guestfs_tail_n (guestfs_h *g,\n"
16370 " const char *path);\n"
16375 #: ../src/guestfs-actions.pod:6560 ../fish/guestfish-actions.pod:4416
16377 "If the parameter C<nrlines> is a positive number, this returns the last "
16378 "C<nrlines> lines of the file C<path>."
16382 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4419
16384 "If the parameter C<nrlines> is a negative number, this returns lines from "
16385 "the file C<path>, starting with the C<-nrlines>th line."
16389 #: ../src/guestfs-actions.pod:6577
16390 msgid "guestfs_tar_in"
16394 #: ../src/guestfs-actions.pod:6579
16398 " guestfs_tar_in (guestfs_h *g,\n"
16399 " const char *tarfile,\n"
16400 " const char *directory);\n"
16405 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4431
16407 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16408 "tar file) into C<directory>."
16412 #: ../src/guestfs-actions.pod:6587
16413 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16417 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6641
16418 msgid "(Added in 1.0.3)"
16422 #: ../src/guestfs-actions.pod:6594
16423 msgid "guestfs_tar_out"
16427 #: ../src/guestfs-actions.pod:6596
16431 " guestfs_tar_out (guestfs_h *g,\n"
16432 " const char *directory,\n"
16433 " const char *tarfile);\n"
16438 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4443
16440 "This command packs the contents of C<directory> and downloads it to local "
16445 #: ../src/guestfs-actions.pod:6604
16447 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16448 "C<guestfs_txz_out>."
16452 #: ../src/guestfs-actions.pod:6611
16453 msgid "guestfs_tgz_in"
16457 #: ../src/guestfs-actions.pod:6613
16461 " guestfs_tgz_in (guestfs_h *g,\n"
16462 " const char *tarball,\n"
16463 " const char *directory);\n"
16468 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4455
16470 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
16471 "tar file) into C<directory>."
16475 #: ../src/guestfs-actions.pod:6621
16476 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
16480 #: ../src/guestfs-actions.pod:6627
16481 msgid "guestfs_tgz_out"
16485 #: ../src/guestfs-actions.pod:6629
16489 " guestfs_tgz_out (guestfs_h *g,\n"
16490 " const char *directory,\n"
16491 " const char *tarball);\n"
16496 #: ../src/guestfs-actions.pod:6634 ../fish/guestfish-actions.pod:4466
16498 "This command packs the contents of C<directory> and downloads it to local "
16503 #: ../src/guestfs-actions.pod:6637
16504 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
16508 #: ../src/guestfs-actions.pod:6643
16509 msgid "guestfs_touch"
16513 #: ../src/guestfs-actions.pod:6645
16517 " guestfs_touch (guestfs_h *g,\n"
16518 " const char *path);\n"
16523 #: ../src/guestfs-actions.pod:6649 ../fish/guestfish-actions.pod:4477
16525 "Touch acts like the L<touch(1)> command. It can be used to update the "
16526 "timestamps on a file, or, if the file does not exist, to create a new "
16527 "zero-length file."
16531 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4481
16533 "This command only works on regular files, and will fail on other file types "
16534 "such as directories, symbolic links, block special etc."
16538 #: ../src/guestfs-actions.pod:6660
16539 msgid "guestfs_truncate"
16543 #: ../src/guestfs-actions.pod:6662
16547 " guestfs_truncate (guestfs_h *g,\n"
16548 " const char *path);\n"
16553 #: ../src/guestfs-actions.pod:6666 ../fish/guestfish-actions.pod:4488
16555 "This command truncates C<path> to a zero-length file. The file must exist "
16560 #: ../src/guestfs-actions.pod:6673
16561 msgid "guestfs_truncate_size"
16565 #: ../src/guestfs-actions.pod:6675
16569 " guestfs_truncate_size (guestfs_h *g,\n"
16570 " const char *path,\n"
16571 " int64_t size);\n"
16576 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4495
16578 "This command truncates C<path> to size C<size> bytes. The file must exist "
16583 #: ../src/guestfs-actions.pod:6683
16585 "If the current file size is less than C<size> then the file is extended to "
16586 "the required size with zero bytes. This creates a sparse file (ie. disk "
16587 "blocks are not allocated for the file until you write to it). To create a "
16588 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
16592 #: ../src/guestfs-actions.pod:6693
16593 msgid "guestfs_tune2fs_l"
16597 #: ../src/guestfs-actions.pod:6695
16601 " guestfs_tune2fs_l (guestfs_h *g,\n"
16602 " const char *device);\n"
16607 #: ../src/guestfs-actions.pod:6699 ../fish/guestfish-actions.pod:4508
16609 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
16614 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4511
16616 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
16617 "for more details. The list of fields returned isn't clearly defined, and "
16618 "depends on both the version of C<tune2fs> that libguestfs was built against, "
16619 "and the filesystem itself."
16623 #: ../src/guestfs-actions.pod:6715
16624 msgid "guestfs_txz_in"
16628 #: ../src/guestfs-actions.pod:6717
16632 " guestfs_txz_in (guestfs_h *g,\n"
16633 " const char *tarball,\n"
16634 " const char *directory);\n"
16639 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4520
16641 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
16642 "tar file) into C<directory>."
16646 #: ../src/guestfs-actions.pod:6729
16647 msgid "guestfs_txz_out"
16651 #: ../src/guestfs-actions.pod:6731
16655 " guestfs_txz_out (guestfs_h *g,\n"
16656 " const char *directory,\n"
16657 " const char *tarball);\n"
16662 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4529
16664 "This command packs the contents of C<directory> and downloads it to local "
16665 "file C<tarball> (as an xz compressed tar archive)."
16669 #: ../src/guestfs-actions.pod:6743
16670 msgid "guestfs_umask"
16674 #: ../src/guestfs-actions.pod:6745
16678 " guestfs_umask (guestfs_h *g,\n"
16684 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4538
16686 "This function sets the mask used for creating new files and device nodes to "
16691 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4541
16693 "Typical umask values would be C<022> which creates new files with "
16694 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
16695 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
16699 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4546
16701 "The default umask is C<022>. This is important because it means that "
16702 "directories and device nodes will be created with C<0644> or C<0755> mode "
16703 "even if you specify C<0777>."
16707 #: ../src/guestfs-actions.pod:6761
16709 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
16710 "C<guestfs_mkdir>."
16714 #: ../src/guestfs-actions.pod:6764 ../fish/guestfish-actions.pod:4553
16715 msgid "This call returns the previous umask."
16719 #: ../src/guestfs-actions.pod:6770
16720 msgid "guestfs_umount"
16724 #: ../src/guestfs-actions.pod:6772
16728 " guestfs_umount (guestfs_h *g,\n"
16729 " const char *pathordevice);\n"
16734 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4561
16736 "This unmounts the given filesystem. The filesystem may be specified either "
16737 "by its mountpoint (path) or the device which contains the filesystem."
16741 #: ../src/guestfs-actions.pod:6784
16742 msgid "guestfs_umount_all"
16746 #: ../src/guestfs-actions.pod:6786
16750 " guestfs_umount_all (guestfs_h *g);\n"
16755 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4571
16756 msgid "This unmounts all mounted filesystems."
16760 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4573
16761 msgid "Some internal mounts are not unmounted by this call."
16765 #: ../src/guestfs-actions.pod:6797
16766 msgid "guestfs_upload"
16770 #: ../src/guestfs-actions.pod:6799
16774 " guestfs_upload (guestfs_h *g,\n"
16775 " const char *filename,\n"
16776 " const char *remotefilename);\n"
16781 #: ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6828 ../fish/guestfish-actions.pod:4579 ../fish/guestfish-actions.pod:4592
16782 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
16786 #: ../src/guestfs-actions.pod:6809
16787 msgid "See also C<guestfs_download>."
16791 #: ../src/guestfs-actions.pod:6820
16792 msgid "guestfs_upload_offset"
16796 #: ../src/guestfs-actions.pod:6822
16800 " guestfs_upload_offset (guestfs_h *g,\n"
16801 " const char *filename,\n"
16802 " const char *remotefilename,\n"
16803 " int64_t offset);\n"
16808 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4595
16810 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
16811 "The intention is to overwrite parts of existing files or devices, although "
16812 "if a non-existant file is specified then it is created with a \"hole\" "
16813 "before C<offset>. The size of the data written is implicit in the size of "
16814 "the source C<filename>."
16818 #: ../src/guestfs-actions.pod:6838
16820 "Note that there is no limit on the amount of data that can be uploaded with "
16821 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
16822 "full amount unless an error occurs."
16826 #: ../src/guestfs-actions.pod:6843
16827 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
16831 #: ../src/guestfs-actions.pod:6854
16832 msgid "guestfs_utimens"
16836 #: ../src/guestfs-actions.pod:6856
16840 " guestfs_utimens (guestfs_h *g,\n"
16841 " const char *path,\n"
16842 " int64_t atsecs,\n"
16843 " int64_t atnsecs,\n"
16844 " int64_t mtsecs,\n"
16845 " int64_t mtnsecs);\n"
16850 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4615
16851 msgid "This command sets the timestamps of a file with nanosecond precision."
16855 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4618
16857 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
16862 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4621
16864 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
16865 "nanoseconds from the epoch."
16869 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4624
16871 "If the C<*nsecs> field contains the special value C<-1> then the "
16872 "corresponding timestamp is set to the current time. (The C<*secs> field is "
16873 "ignored in this case)."
16877 #: ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4628
16879 "If the C<*nsecs> field contains the special value C<-2> then the "
16880 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
16885 #: ../src/guestfs-actions.pod:6885 ../src/guestfs-structs.pod:175
16886 msgid "guestfs_version"
16890 #: ../src/guestfs-actions.pod:6887
16893 " struct guestfs_version *\n"
16894 " guestfs_version (guestfs_h *g);\n"
16899 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4636
16900 msgid "Return the libguestfs version number that the program is linked against."
16904 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4639
16906 "Note that because of dynamic linking this is not necessarily the version of "
16907 "libguestfs that you compiled against. You can compile the program, and then "
16908 "at runtime dynamically link against a completely different C<libguestfs.so> "
16913 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4644
16915 "This call was added in version C<1.0.58>. In previous versions of "
16916 "libguestfs there was no way to get the version number. From C code you can "
16917 "use dynamic linker functions to find out if this symbol exists (if it "
16918 "doesn't, then it's an earlier version)."
16922 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4650
16924 "The call returns a structure with four elements. The first three (C<major>, "
16925 "C<minor> and C<release>) are numbers and correspond to the usual version "
16926 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
16927 "but may be used for distro-specific information."
16931 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4656
16932 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
16936 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4659
16937 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
16941 #: ../src/guestfs-actions.pod:6915
16943 "I<Note:> Don't use this call to test for availability of features. In "
16944 "enterprise distributions we backport features from later versions into "
16945 "earlier versions, making this an unreliable way to test for features. Use "
16946 "C<guestfs_available> instead."
16950 #: ../src/guestfs-actions.pod:6921
16952 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
16953 "error. I<The caller must call C<guestfs_free_version> after use>."
16957 #: ../src/guestfs-actions.pod:6925
16958 msgid "(Added in 1.0.58)"
16962 #: ../src/guestfs-actions.pod:6927
16963 msgid "guestfs_vfs_label"
16967 #: ../src/guestfs-actions.pod:6929
16971 " guestfs_vfs_label (guestfs_h *g,\n"
16972 " const char *device);\n"
16977 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4671
16978 msgid "This returns the filesystem label of the filesystem on C<device>."
16982 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4674
16983 msgid "If the filesystem is unlabeled, this returns the empty string."
16987 #: ../src/guestfs-actions.pod:6938
16988 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
16992 #: ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6980
16993 msgid "(Added in 1.3.18)"
16997 #: ../src/guestfs-actions.pod:6945
16998 msgid "guestfs_vfs_type"
17002 #: ../src/guestfs-actions.pod:6947
17006 " guestfs_vfs_type (guestfs_h *g,\n"
17007 " const char *device);\n"
17012 #: ../src/guestfs-actions.pod:6951 ../fish/guestfish-actions.pod:4682
17014 "This command gets the filesystem type corresponding to the filesystem on "
17019 #: ../src/guestfs-actions.pod:6954 ../fish/guestfish-actions.pod:4685
17021 "For most filesystems, the result is the name of the Linux VFS module which "
17022 "would be used to mount this filesystem if you mounted it without specifying "
17023 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17027 #: ../src/guestfs-actions.pod:6964
17028 msgid "guestfs_vfs_uuid"
17032 #: ../src/guestfs-actions.pod:6966
17036 " guestfs_vfs_uuid (guestfs_h *g,\n"
17037 " const char *device);\n"
17042 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4694
17043 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17047 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4697
17048 msgid "If the filesystem does not have a UUID, this returns the empty string."
17052 #: ../src/guestfs-actions.pod:6975
17053 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17057 #: ../src/guestfs-actions.pod:6982
17058 msgid "guestfs_vg_activate"
17062 #: ../src/guestfs-actions.pod:6984
17066 " guestfs_vg_activate (guestfs_h *g,\n"
17068 " char *const *volgroups);\n"
17073 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4705
17075 "This command activates or (if C<activate> is false) deactivates all logical "
17076 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17077 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17078 "deactivated, then those devices disappear."
17082 #: ../src/guestfs-actions.pod:6995 ../fish/guestfish-actions.pod:4711
17083 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17087 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4713
17089 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17090 "activated or deactivated."
17094 #: ../src/guestfs-actions.pod:7004
17095 msgid "guestfs_vg_activate_all"
17099 #: ../src/guestfs-actions.pod:7006
17103 " guestfs_vg_activate_all (guestfs_h *g,\n"
17104 " int activate);\n"
17109 #: ../src/guestfs-actions.pod:7010 ../fish/guestfish-actions.pod:4720
17111 "This command activates or (if C<activate> is false) deactivates all logical "
17112 "volumes in all volume groups. If activated, then they are made known to the "
17113 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17114 "those devices disappear."
17118 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4726
17119 msgid "This command is the same as running C<vgchange -a y|n>"
17123 #: ../src/guestfs-actions.pod:7022
17124 msgid "guestfs_vgcreate"
17128 #: ../src/guestfs-actions.pod:7024
17132 " guestfs_vgcreate (guestfs_h *g,\n"
17133 " const char *volgroup,\n"
17134 " char *const *physvols);\n"
17139 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:4732
17141 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17142 "of physical volumes C<physvols>."
17146 #: ../src/guestfs-actions.pod:7036
17147 msgid "guestfs_vglvuuids"
17151 #: ../src/guestfs-actions.pod:7038
17155 " guestfs_vglvuuids (guestfs_h *g,\n"
17156 " const char *vgname);\n"
17161 #: ../src/guestfs-actions.pod:7042 ../fish/guestfish-actions.pod:4739
17163 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17164 "volumes created in this volume group."
17168 #: ../src/guestfs-actions.pod:7045
17170 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17171 "associate logical volumes and volume groups."
17175 #: ../src/guestfs-actions.pod:7048
17176 msgid "See also C<guestfs_vgpvuuids>."
17180 #: ../src/guestfs-actions.pod:7056
17181 msgid "guestfs_vgpvuuids"
17185 #: ../src/guestfs-actions.pod:7058
17189 " guestfs_vgpvuuids (guestfs_h *g,\n"
17190 " const char *vgname);\n"
17195 #: ../src/guestfs-actions.pod:7062 ../fish/guestfish-actions.pod:4751
17197 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17198 "volumes that this volume group resides on."
17202 #: ../src/guestfs-actions.pod:7065
17204 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17205 "associate physical volumes and volume groups."
17209 #: ../src/guestfs-actions.pod:7068
17210 msgid "See also C<guestfs_vglvuuids>."
17214 #: ../src/guestfs-actions.pod:7076
17215 msgid "guestfs_vgremove"
17219 #: ../src/guestfs-actions.pod:7078
17223 " guestfs_vgremove (guestfs_h *g,\n"
17224 " const char *vgname);\n"
17229 #: ../src/guestfs-actions.pod:7082 ../fish/guestfish-actions.pod:4763
17230 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17234 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4765
17235 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17239 #: ../src/guestfs-actions.pod:7091
17240 msgid "guestfs_vgrename"
17244 #: ../src/guestfs-actions.pod:7093
17248 " guestfs_vgrename (guestfs_h *g,\n"
17249 " const char *volgroup,\n"
17250 " const char *newvolgroup);\n"
17255 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4772
17256 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17260 #: ../src/guestfs-actions.pod:7104
17261 msgid "guestfs_vgs"
17265 #: ../src/guestfs-actions.pod:7106
17269 " guestfs_vgs (guestfs_h *g);\n"
17274 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4778
17276 "List all the volumes groups detected. This is the equivalent of the "
17277 "L<vgs(8)> command."
17281 #: ../src/guestfs-actions.pod:7112 ../fish/guestfish-actions.pod:4781
17283 "This returns a list of just the volume group names that were detected "
17284 "(eg. C<VolGroup00>)."
17288 #: ../src/guestfs-actions.pod:7115
17289 msgid "See also C<guestfs_vgs_full>."
17293 #: ../src/guestfs-actions.pod:7123
17294 msgid "guestfs_vgs_full"
17298 #: ../src/guestfs-actions.pod:7125
17301 " struct guestfs_lvm_vg_list *\n"
17302 " guestfs_vgs_full (guestfs_h *g);\n"
17307 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4790
17309 "List all the volumes groups detected. This is the equivalent of the "
17310 "L<vgs(8)> command. The \"full\" version includes all fields."
17314 #: ../src/guestfs-actions.pod:7131
17316 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17317 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17322 #: ../src/guestfs-actions.pod:7137
17323 msgid "guestfs_vgscan"
17327 #: ../src/guestfs-actions.pod:7139
17331 " guestfs_vgscan (guestfs_h *g);\n"
17336 #: ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:4797
17338 "This rescans all block devices and rebuilds the list of LVM physical "
17339 "volumes, volume groups and logical volumes."
17343 #: ../src/guestfs-actions.pod:7149
17344 msgid "guestfs_vguuid"
17348 #: ../src/guestfs-actions.pod:7151
17352 " guestfs_vguuid (guestfs_h *g,\n"
17353 " const char *vgname);\n"
17358 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:4804
17359 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17363 #: ../src/guestfs-actions.pod:7162
17364 msgid "guestfs_wait_ready"
17368 #: ../src/guestfs-actions.pod:7164
17372 " guestfs_wait_ready (guestfs_h *g);\n"
17377 #: ../src/guestfs-actions.pod:7167
17378 msgid "This function is a no op."
17382 #: ../src/guestfs-actions.pod:7169
17384 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17385 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17386 "is no longer necessary because C<guestfs_launch> now does the waiting."
17390 #: ../src/guestfs-actions.pod:7174
17392 "If you see any calls to this function in code then you can just remove them, "
17393 "unless you want to retain compatibility with older versions of the API."
17397 #: ../src/guestfs-actions.pod:7182
17398 msgid "guestfs_wc_c"
17402 #: ../src/guestfs-actions.pod:7184
17406 " guestfs_wc_c (guestfs_h *g,\n"
17407 " const char *path);\n"
17412 #: ../src/guestfs-actions.pod:7188 ../fish/guestfish-actions.pod:4810
17414 "This command counts the characters in a file, using the C<wc -c> external "
17419 #: ../src/guestfs-actions.pod:7195
17420 msgid "guestfs_wc_l"
17424 #: ../src/guestfs-actions.pod:7197
17428 " guestfs_wc_l (guestfs_h *g,\n"
17429 " const char *path);\n"
17434 #: ../src/guestfs-actions.pod:7201 ../fish/guestfish-actions.pod:4817
17436 "This command counts the lines in a file, using the C<wc -l> external "
17441 #: ../src/guestfs-actions.pod:7208
17442 msgid "guestfs_wc_w"
17446 #: ../src/guestfs-actions.pod:7210
17450 " guestfs_wc_w (guestfs_h *g,\n"
17451 " const char *path);\n"
17456 #: ../src/guestfs-actions.pod:7214 ../fish/guestfish-actions.pod:4824
17458 "This command counts the words in a file, using the C<wc -w> external "
17463 #: ../src/guestfs-actions.pod:7221
17464 msgid "guestfs_write"
17468 #: ../src/guestfs-actions.pod:7223
17472 " guestfs_write (guestfs_h *g,\n"
17473 " const char *path,\n"
17474 " const char *content,\n"
17475 " size_t content_size);\n"
17480 #: ../src/guestfs-actions.pod:7229 ../fish/guestfish-actions.pod:4831
17482 "This call creates a file called C<path>. The content of the file is the "
17483 "string C<content> (which can contain any 8 bit data)."
17487 #: ../src/guestfs-actions.pod:7239
17488 msgid "guestfs_write_file"
17492 #: ../src/guestfs-actions.pod:7241
17496 " guestfs_write_file (guestfs_h *g,\n"
17497 " const char *path,\n"
17498 " const char *content,\n"
17504 #: ../src/guestfs-actions.pod:7247 ../fish/guestfish-actions.pod:4841
17506 "This call creates a file called C<path>. The contents of the file is the "
17507 "string C<content> (which can contain any 8 bit data), with length C<size>."
17511 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4845
17513 "As a special case, if C<size> is C<0> then the length is calculated using "
17514 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
17518 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
17520 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
17521 "I<not> work, even if the length is specified."
17525 #: ../src/guestfs-actions.pod:7263 ../fish/guestfish-actions.pod:4855
17526 msgid "This function is deprecated. In new code, use the C<write> call instead."
17530 #: ../src/guestfs-actions.pod:7272
17531 msgid "guestfs_zegrep"
17535 #: ../src/guestfs-actions.pod:7274
17539 " guestfs_zegrep (guestfs_h *g,\n"
17540 " const char *regex,\n"
17541 " const char *path);\n"
17546 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4866
17547 msgid "This calls the external C<zegrep> program and returns the matching lines."
17551 #: ../src/guestfs-actions.pod:7291
17552 msgid "guestfs_zegrepi"
17556 #: ../src/guestfs-actions.pod:7293
17560 " guestfs_zegrepi (guestfs_h *g,\n"
17561 " const char *regex,\n"
17562 " const char *path);\n"
17567 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4876
17568 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
17572 #: ../src/guestfs-actions.pod:7310
17573 msgid "guestfs_zero"
17577 #: ../src/guestfs-actions.pod:7312
17581 " guestfs_zero (guestfs_h *g,\n"
17582 " const char *device);\n"
17587 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4886
17588 msgid "This command writes zeroes over the first few blocks of C<device>."
17592 #: ../src/guestfs-actions.pod:7318 ../fish/guestfish-actions.pod:4888
17594 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
17595 "securely wipe the device). It should be sufficient to remove any partition "
17596 "tables, filesystem superblocks and so on."
17600 #: ../src/guestfs-actions.pod:7322
17601 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
17605 #: ../src/guestfs-actions.pod:7333
17606 msgid "guestfs_zero_device"
17610 #: ../src/guestfs-actions.pod:7335
17614 " guestfs_zero_device (guestfs_h *g,\n"
17615 " const char *device);\n"
17620 #: ../src/guestfs-actions.pod:7339
17622 "This command writes zeroes over the entire C<device>. Compare with "
17623 "C<guestfs_zero> which just zeroes the first few blocks of a device."
17627 #: ../src/guestfs-actions.pod:7353
17628 msgid "(Added in 1.3.1)"
17632 #: ../src/guestfs-actions.pod:7355
17633 msgid "guestfs_zerofree"
17637 #: ../src/guestfs-actions.pod:7357
17641 " guestfs_zerofree (guestfs_h *g,\n"
17642 " const char *device);\n"
17647 #: ../src/guestfs-actions.pod:7361 ../fish/guestfish-actions.pod:4909
17649 "This runs the I<zerofree> program on C<device>. This program claims to zero "
17650 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
17651 "possible to compress the filesystem more effectively."
17655 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4914
17656 msgid "You should B<not> run this program if the filesystem is mounted."
17660 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4917
17662 "It is possible that using this program can damage the filesystem or data on "
17667 #: ../src/guestfs-actions.pod:7376
17668 msgid "guestfs_zfgrep"
17672 #: ../src/guestfs-actions.pod:7378
17676 " guestfs_zfgrep (guestfs_h *g,\n"
17677 " const char *pattern,\n"
17678 " const char *path);\n"
17683 #: ../src/guestfs-actions.pod:7383 ../fish/guestfish-actions.pod:4924
17684 msgid "This calls the external C<zfgrep> program and returns the matching lines."
17688 #: ../src/guestfs-actions.pod:7395
17689 msgid "guestfs_zfgrepi"
17693 #: ../src/guestfs-actions.pod:7397
17697 " guestfs_zfgrepi (guestfs_h *g,\n"
17698 " const char *pattern,\n"
17699 " const char *path);\n"
17704 #: ../src/guestfs-actions.pod:7402 ../fish/guestfish-actions.pod:4934
17705 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
17709 #: ../src/guestfs-actions.pod:7414
17710 msgid "guestfs_zfile"
17714 #: ../src/guestfs-actions.pod:7416
17718 " guestfs_zfile (guestfs_h *g,\n"
17719 " const char *meth,\n"
17720 " const char *path);\n"
17725 #: ../src/guestfs-actions.pod:7421 ../fish/guestfish-actions.pod:4944
17726 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
17730 #: ../src/guestfs-actions.pod:7424 ../fish/guestfish-actions.pod:4947
17731 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
17735 #: ../src/guestfs-actions.pod:7426
17737 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
17742 #: ../src/guestfs-actions.pod:7432 ../fish/guestfish-actions.pod:4952
17743 msgid "This function is deprecated. In new code, use the C<file> call instead."
17747 #: ../src/guestfs-actions.pod:7441
17748 msgid "guestfs_zgrep"
17752 #: ../src/guestfs-actions.pod:7443
17756 " guestfs_zgrep (guestfs_h *g,\n"
17757 " const char *regex,\n"
17758 " const char *path);\n"
17763 #: ../src/guestfs-actions.pod:7448 ../fish/guestfish-actions.pod:4963
17764 msgid "This calls the external C<zgrep> program and returns the matching lines."
17768 #: ../src/guestfs-actions.pod:7460
17769 msgid "guestfs_zgrepi"
17773 #: ../src/guestfs-actions.pod:7462
17777 " guestfs_zgrepi (guestfs_h *g,\n"
17778 " const char *regex,\n"
17779 " const char *path);\n"
17784 #: ../src/guestfs-actions.pod:7467 ../fish/guestfish-actions.pod:4973
17785 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
17789 #: ../src/guestfs-availability.pod:3
17794 #: ../src/guestfs-availability.pod:5
17796 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
17797 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
17798 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
17799 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
17800 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
17804 #: ../src/guestfs-availability.pod:21
17809 #: ../src/guestfs-availability.pod:23
17811 "The following functions: L</guestfs_inotify_add_watch> "
17812 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
17813 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
17817 #: ../src/guestfs-availability.pod:31
17818 msgid "B<linuxfsuuid>"
17822 #: ../src/guestfs-availability.pod:33
17824 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
17825 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
17829 #: ../src/guestfs-availability.pod:40
17830 msgid "B<linuxmodules>"
17834 #: ../src/guestfs-availability.pod:42
17835 msgid "The following functions: L</guestfs_modprobe>"
17839 #: ../src/guestfs-availability.pod:45
17840 msgid "B<linuxxattrs>"
17844 #: ../src/guestfs-availability.pod:47
17846 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
17847 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
17848 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
17849 "L</guestfs_setxattr>"
17853 #: ../src/guestfs-availability.pod:58
17858 #: ../src/guestfs-availability.pod:60
17860 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
17861 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
17862 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
17866 #: ../src/guestfs-availability.pod:69
17871 #: ../src/guestfs-availability.pod:71
17873 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
17874 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
17875 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
17876 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
17877 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
17878 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
17879 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
17880 "L</guestfs_vgs_full>"
17884 #: ../src/guestfs-availability.pod:94
17889 #: ../src/guestfs-availability.pod:96
17891 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
17892 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
17896 #: ../src/guestfs-availability.pod:102
17901 #: ../src/guestfs-availability.pod:104
17902 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
17906 #: ../src/guestfs-availability.pod:107
17907 msgid "B<ntfsprogs>"
17911 #: ../src/guestfs-availability.pod:109
17912 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
17916 #: ../src/guestfs-availability.pod:113
17917 msgid "B<realpath>"
17921 #: ../src/guestfs-availability.pod:115
17922 msgid "The following functions: L</guestfs_realpath>"
17926 #: ../src/guestfs-availability.pod:118
17931 #: ../src/guestfs-availability.pod:120
17933 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
17934 "L</guestfs_scrub_freespace>"
17938 #: ../src/guestfs-availability.pod:125
17943 #: ../src/guestfs-availability.pod:127
17944 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
17948 #: ../src/guestfs-availability.pod:131
17953 #: ../src/guestfs-availability.pod:133
17954 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
17958 #: ../src/guestfs-availability.pod:137
17959 msgid "B<zerofree>"
17963 #: ../src/guestfs-availability.pod:139
17964 msgid "The following functions: L</guestfs_zerofree>"
17968 #: ../src/guestfs-structs.pod:1
17969 msgid "guestfs_int_bool"
17973 #: ../src/guestfs-structs.pod:3
17976 " struct guestfs_int_bool {\n"
17984 #: ../src/guestfs-structs.pod:8
17987 " struct guestfs_int_bool_list {\n"
17988 " uint32_t len; /* Number of elements in list. */\n"
17989 " struct guestfs_int_bool *val; /* Elements. */\n"
17995 #: ../src/guestfs-structs.pod:13
17998 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
17999 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18004 #: ../src/guestfs-structs.pod:16
18005 msgid "guestfs_lvm_pv"
18009 #: ../src/guestfs-structs.pod:18
18012 " struct guestfs_lvm_pv {\n"
18013 " char *pv_name;\n"
18014 " /* The next field is NOT nul-terminated, be careful when printing it: "
18016 " char pv_uuid[32];\n"
18018 " uint64_t pv_size;\n"
18019 " uint64_t dev_size;\n"
18020 " uint64_t pv_free;\n"
18021 " uint64_t pv_used;\n"
18022 " char *pv_attr;\n"
18023 " int64_t pv_pe_count;\n"
18024 " int64_t pv_pe_alloc_count;\n"
18025 " char *pv_tags;\n"
18026 " uint64_t pe_start;\n"
18027 " int64_t pv_mda_count;\n"
18028 " uint64_t pv_mda_free;\n"
18034 #: ../src/guestfs-structs.pod:36
18037 " struct guestfs_lvm_pv_list {\n"
18038 " uint32_t len; /* Number of elements in list. */\n"
18039 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18045 #: ../src/guestfs-structs.pod:41
18048 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18049 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18054 #: ../src/guestfs-structs.pod:44
18055 msgid "guestfs_lvm_vg"
18059 #: ../src/guestfs-structs.pod:46
18062 " struct guestfs_lvm_vg {\n"
18063 " char *vg_name;\n"
18064 " /* The next field is NOT nul-terminated, be careful when printing it: "
18066 " char vg_uuid[32];\n"
18068 " char *vg_attr;\n"
18069 " uint64_t vg_size;\n"
18070 " uint64_t vg_free;\n"
18071 " char *vg_sysid;\n"
18072 " uint64_t vg_extent_size;\n"
18073 " int64_t vg_extent_count;\n"
18074 " int64_t vg_free_count;\n"
18075 " int64_t max_lv;\n"
18076 " int64_t max_pv;\n"
18077 " int64_t pv_count;\n"
18078 " int64_t lv_count;\n"
18079 " int64_t snap_count;\n"
18080 " int64_t vg_seqno;\n"
18081 " char *vg_tags;\n"
18082 " int64_t vg_mda_count;\n"
18083 " uint64_t vg_mda_free;\n"
18089 #: ../src/guestfs-structs.pod:69
18092 " struct guestfs_lvm_vg_list {\n"
18093 " uint32_t len; /* Number of elements in list. */\n"
18094 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18100 #: ../src/guestfs-structs.pod:74
18103 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18104 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18109 #: ../src/guestfs-structs.pod:77
18110 msgid "guestfs_lvm_lv"
18114 #: ../src/guestfs-structs.pod:79
18117 " struct guestfs_lvm_lv {\n"
18118 " char *lv_name;\n"
18119 " /* The next field is NOT nul-terminated, be careful when printing it: "
18121 " char lv_uuid[32];\n"
18122 " char *lv_attr;\n"
18123 " int64_t lv_major;\n"
18124 " int64_t lv_minor;\n"
18125 " int64_t lv_kernel_major;\n"
18126 " int64_t lv_kernel_minor;\n"
18127 " uint64_t lv_size;\n"
18128 " int64_t seg_count;\n"
18130 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18131 " float snap_percent;\n"
18132 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18133 " float copy_percent;\n"
18134 " char *move_pv;\n"
18135 " char *lv_tags;\n"
18136 " char *mirror_log;\n"
18137 " char *modules;\n"
18143 #: ../src/guestfs-structs.pod:101
18146 " struct guestfs_lvm_lv_list {\n"
18147 " uint32_t len; /* Number of elements in list. */\n"
18148 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18154 #: ../src/guestfs-structs.pod:106
18157 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18158 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18163 #: ../src/guestfs-structs.pod:111
18166 " struct guestfs_stat {\n"
18170 " int64_t nlink;\n"
18175 " int64_t blksize;\n"
18176 " int64_t blocks;\n"
18177 " int64_t atime;\n"
18178 " int64_t mtime;\n"
18179 " int64_t ctime;\n"
18185 #: ../src/guestfs-structs.pod:127
18188 " struct guestfs_stat_list {\n"
18189 " uint32_t len; /* Number of elements in list. */\n"
18190 " struct guestfs_stat *val; /* Elements. */\n"
18196 #: ../src/guestfs-structs.pod:132
18199 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18200 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18205 #: ../src/guestfs-structs.pod:137
18208 " struct guestfs_statvfs {\n"
18209 " int64_t bsize;\n"
18210 " int64_t frsize;\n"
18211 " int64_t blocks;\n"
18212 " int64_t bfree;\n"
18213 " int64_t bavail;\n"
18214 " int64_t files;\n"
18215 " int64_t ffree;\n"
18216 " int64_t favail;\n"
18219 " int64_t namemax;\n"
18225 #: ../src/guestfs-structs.pod:151
18228 " struct guestfs_statvfs_list {\n"
18229 " uint32_t len; /* Number of elements in list. */\n"
18230 " struct guestfs_statvfs *val; /* Elements. */\n"
18236 #: ../src/guestfs-structs.pod:156
18239 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18240 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18245 #: ../src/guestfs-structs.pod:159
18246 msgid "guestfs_dirent"
18250 #: ../src/guestfs-structs.pod:161
18253 " struct guestfs_dirent {\n"
18262 #: ../src/guestfs-structs.pod:167
18265 " struct guestfs_dirent_list {\n"
18266 " uint32_t len; /* Number of elements in list. */\n"
18267 " struct guestfs_dirent *val; /* Elements. */\n"
18273 #: ../src/guestfs-structs.pod:172
18276 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18277 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18282 #: ../src/guestfs-structs.pod:177
18285 " struct guestfs_version {\n"
18286 " int64_t major;\n"
18287 " int64_t minor;\n"
18288 " int64_t release;\n"
18295 #: ../src/guestfs-structs.pod:184
18298 " struct guestfs_version_list {\n"
18299 " uint32_t len; /* Number of elements in list. */\n"
18300 " struct guestfs_version *val; /* Elements. */\n"
18306 #: ../src/guestfs-structs.pod:189
18309 " void guestfs_free_version (struct guestfs_free_version *);\n"
18310 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18315 #: ../src/guestfs-structs.pod:192
18316 msgid "guestfs_xattr"
18320 #: ../src/guestfs-structs.pod:194
18323 " struct guestfs_xattr {\n"
18324 " char *attrname;\n"
18325 " /* The next two fields describe a byte array. */\n"
18326 " uint32_t attrval_len;\n"
18327 " char *attrval;\n"
18333 #: ../src/guestfs-structs.pod:201
18336 " struct guestfs_xattr_list {\n"
18337 " uint32_t len; /* Number of elements in list. */\n"
18338 " struct guestfs_xattr *val; /* Elements. */\n"
18344 #: ../src/guestfs-structs.pod:206
18347 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18348 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18353 #: ../src/guestfs-structs.pod:209
18354 msgid "guestfs_inotify_event"
18358 #: ../src/guestfs-structs.pod:211
18361 " struct guestfs_inotify_event {\n"
18362 " int64_t in_wd;\n"
18363 " uint32_t in_mask;\n"
18364 " uint32_t in_cookie;\n"
18365 " char *in_name;\n"
18371 #: ../src/guestfs-structs.pod:218
18374 " struct guestfs_inotify_event_list {\n"
18375 " uint32_t len; /* Number of elements in list. */\n"
18376 " struct guestfs_inotify_event *val; /* Elements. */\n"
18382 #: ../src/guestfs-structs.pod:223
18385 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18386 " void guestfs_free_inotify_event_list (struct "
18387 "guestfs_free_inotify_event_list *);\n"
18392 #: ../src/guestfs-structs.pod:226
18393 msgid "guestfs_partition"
18397 #: ../src/guestfs-structs.pod:228
18400 " struct guestfs_partition {\n"
18401 " int32_t part_num;\n"
18402 " uint64_t part_start;\n"
18403 " uint64_t part_end;\n"
18404 " uint64_t part_size;\n"
18410 #: ../src/guestfs-structs.pod:235
18413 " struct guestfs_partition_list {\n"
18414 " uint32_t len; /* Number of elements in list. */\n"
18415 " struct guestfs_partition *val; /* Elements. */\n"
18421 #: ../src/guestfs-structs.pod:240
18424 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18425 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18430 #: ../src/guestfs-structs.pod:243
18431 msgid "guestfs_application"
18435 #: ../src/guestfs-structs.pod:245
18438 " struct guestfs_application {\n"
18439 " char *app_name;\n"
18440 " char *app_display_name;\n"
18441 " int32_t app_epoch;\n"
18442 " char *app_version;\n"
18443 " char *app_release;\n"
18444 " char *app_install_path;\n"
18445 " char *app_trans_path;\n"
18446 " char *app_publisher;\n"
18447 " char *app_url;\n"
18448 " char *app_source_package;\n"
18449 " char *app_summary;\n"
18450 " char *app_description;\n"
18456 #: ../src/guestfs-structs.pod:260
18459 " struct guestfs_application_list {\n"
18460 " uint32_t len; /* Number of elements in list. */\n"
18461 " struct guestfs_application *val; /* Elements. */\n"
18467 #: ../src/guestfs-structs.pod:265
18470 " void guestfs_free_application (struct guestfs_free_application *);\n"
18471 " void guestfs_free_application_list (struct guestfs_free_application_list "
18477 #: ../fish/guestfish.pod:5
18478 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18482 #: ../fish/guestfish.pod:9
18485 " guestfish [--options] [commands]\n"
18490 #: ../fish/guestfish.pod:11
18498 #: ../fish/guestfish.pod:13
18501 " guestfish [--ro|--rw] -a disk.img\n"
18506 #: ../fish/guestfish.pod:15
18509 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18514 #: ../fish/guestfish.pod:17
18517 " guestfish -d libvirt-domain\n"
18522 #: ../fish/guestfish.pod:19
18525 " guestfish [--ro|--rw] -a disk.img -i\n"
18530 #: ../fish/guestfish.pod:21
18533 " guestfish -d libvirt-domain -i\n"
18538 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
18543 #: ../fish/guestfish.pod:25
18545 "Using guestfish in read/write mode on live virtual machines can be "
18546 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18547 "option to use guestfish safely if the disk image or virtual machine might be "
18552 #: ../fish/guestfish.pod:32
18554 "Guestfish is a shell and command-line tool for examining and modifying "
18555 "virtual machine filesystems. It uses libguestfs and exposes all of the "
18556 "functionality of the guestfs API, see L<guestfs(3)>."
18560 #: ../fish/guestfish.pod:36
18562 "Guestfish gives you structured access to the libguestfs API, from shell "
18563 "scripts or the command line or interactively. If you want to rescue a "
18564 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
18569 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:942 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
18574 #: ../fish/guestfish.pod:43
18575 msgid "As an interactive shell"
18579 #: ../fish/guestfish.pod:45
18587 #: ../fish/guestfish.pod:47
18590 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
18591 " editing virtual machine filesystems.\n"
18596 #: ../fish/guestfish.pod:50
18599 " Type: 'help' for a list of commands\n"
18600 " 'man' to read the manual\n"
18601 " 'quit' to quit the shell\n"
18606 #: ../fish/guestfish.pod:54
18609 " ><fs> add-ro disk.img\n"
18611 " ><fs> list-filesystems\n"
18612 " /dev/sda1: ext4\n"
18613 " /dev/vg_guest/lv_root: ext4\n"
18614 " /dev/vg_guest/lv_swap: swap\n"
18615 " ><fs> mount /dev/vg_guest/lv_root /\n"
18616 " ><fs> cat /etc/fstab\n"
18618 " # Created by anaconda\n"
18625 #: ../fish/guestfish.pod:67
18626 msgid "From shell scripts"
18630 #: ../fish/guestfish.pod:69
18631 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18635 #: ../fish/guestfish.pod:71
18638 " guestfish <<_EOF_\n"
18641 " mount /dev/vg_guest/lv_root /\n"
18642 " write /etc/motd \"Welcome, new users\"\n"
18648 #: ../fish/guestfish.pod:78
18649 msgid "List the LVM logical volumes in a disk image:"
18653 #: ../fish/guestfish.pod:80
18656 " guestfish -a disk.img --ro <<_EOF_\n"
18664 #: ../fish/guestfish.pod:85
18665 msgid "List all the filesystems in a disk image:"
18669 #: ../fish/guestfish.pod:87
18672 " guestfish -a disk.img --ro <<_EOF_\n"
18674 " list-filesystems\n"
18680 #: ../fish/guestfish.pod:92
18681 msgid "On one command line"
18685 #: ../fish/guestfish.pod:94
18686 msgid "Update C</etc/resolv.conf> in a guest:"
18690 #: ../fish/guestfish.pod:96
18694 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
18695 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
18700 #: ../fish/guestfish.pod:100
18701 msgid "Edit C</boot/grub/grub.conf> interactively:"
18705 #: ../fish/guestfish.pod:102
18708 " guestfish --rw --add disk.img \\\n"
18709 " --mount /dev/vg_guest/lv_root \\\n"
18710 " --mount /dev/sda1:/boot \\\n"
18711 " edit /boot/grub/grub.conf\n"
18716 #: ../fish/guestfish.pod:107
18717 msgid "Mount disks automatically"
18721 #: ../fish/guestfish.pod:109
18723 "Use the I<-i> option to automatically mount the disks from a virtual "
18728 #: ../fish/guestfish.pod:112
18731 " guestfish --ro -a disk.img -i cat /etc/group\n"
18736 #: ../fish/guestfish.pod:114
18739 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
18744 #: ../fish/guestfish.pod:116
18745 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
18749 #: ../fish/guestfish.pod:118
18752 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
18757 #: ../fish/guestfish.pod:120
18758 msgid "As a script interpreter"
18762 #: ../fish/guestfish.pod:122
18763 msgid "Create a 100MB disk containing an ext2-formatted partition:"
18767 #: ../fish/guestfish.pod:124
18770 " #!/usr/bin/guestfish -f\n"
18771 " sparse test1.img 100M\n"
18773 " part-disk /dev/sda mbr\n"
18774 " mkfs ext2 /dev/sda1\n"
18779 #: ../fish/guestfish.pod:130
18780 msgid "Start with a prepared disk"
18784 #: ../fish/guestfish.pod:132
18786 "An alternate way to create a 100MB disk called C<test1.img> containing a "
18787 "single ext2-formatted partition:"
18791 #: ../fish/guestfish.pod:135
18794 " guestfish -N fs\n"
18799 #: ../fish/guestfish.pod:137
18800 msgid "To list what is available do:"
18804 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:933
18807 " guestfish -N help | less\n"
18812 #: ../fish/guestfish.pod:141
18813 msgid "Remote control"
18817 #: ../fish/guestfish.pod:143
18820 " eval \"`guestfish --listen`\"\n"
18821 " guestfish --remote add-ro disk.img\n"
18822 " guestfish --remote run\n"
18823 " guestfish --remote lvs\n"
18828 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:81 ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
18833 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:89 ../tools/virt-win-reg.pl:104 ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
18838 #: ../fish/guestfish.pod:154
18839 msgid "Displays general help on options."
18843 #: ../fish/guestfish.pod:156
18848 #: ../fish/guestfish.pod:158
18849 msgid "B<--cmd-help>"
18853 #: ../fish/guestfish.pod:160
18854 msgid "Lists all available guestfish commands."
18858 #: ../fish/guestfish.pod:162
18863 #: ../fish/guestfish.pod:164
18864 msgid "B<--cmd-help cmd>"
18868 #: ../fish/guestfish.pod:166
18869 msgid "Displays detailed help on a single command C<cmd>."
18873 #: ../fish/guestfish.pod:168
18874 msgid "B<-a image>"
18878 #: ../fish/guestfish.pod:170
18879 msgid "B<--add image>"
18883 #: ../fish/guestfish.pod:172
18884 msgid "Add a block device or virtual machine image to the shell."
18888 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
18890 "The format of the disk image is auto-detected. To override this and force a "
18891 "particular format use the I<--format=..> option."
18895 #: ../fish/guestfish.pod:177
18897 "Using this flag is mostly equivalent to using the C<add> command, with "
18898 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
18899 "the I<--format:...> flag was given."
18903 #: ../fish/guestfish.pod:181
18908 #: ../fish/guestfish.pod:183
18909 msgid "B<--connect URI>"
18913 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
18915 "When used in conjunction with the I<-d> option, this specifies the libvirt "
18916 "URI to use. The default is to use the default libvirt connection."
18920 #: ../fish/guestfish.pod:189
18925 #: ../fish/guestfish.pod:191
18927 "If using the I<--listen> option and a csh-like shell, use this option. See "
18928 "section L</REMOTE CONTROL AND CSH> below."
18932 #: ../fish/guestfish.pod:194
18933 msgid "B<-d libvirt-domain>"
18937 #: ../fish/guestfish.pod:196
18938 msgid "B<--domain libvirt-domain>"
18942 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
18944 "Add disks from the named libvirt domain. If the I<--ro> option is also "
18945 "used, then any libvirt domain can be used. However in write mode, only "
18946 "libvirt domains which are shut down can be named here."
18950 #: ../fish/guestfish.pod:202
18952 "Using this flag is mostly equivalent to using the C<add-domain> command, "
18953 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
18954 "if the I<--format:...> flag was given."
18958 #: ../fish/guestfish.pod:206
18963 #: ../fish/guestfish.pod:208
18964 msgid "B<--no-dest-paths>"
18968 #: ../fish/guestfish.pod:210
18970 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
18971 "to hit the tab key to complete paths on the guest filesystem, but this "
18972 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
18973 "allow this feature to be disabled."
18977 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
18978 msgid "B<--echo-keys>"
18982 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
18984 "When prompting for keys and passphrases, guestfish normally turns echoing "
18985 "off so you cannot see what you are typing. If you are not worried about "
18986 "Tempest attacks and there is no one else in the room you can specify this "
18987 "flag to see what you are typing."
18991 #: ../fish/guestfish.pod:222
18996 #: ../fish/guestfish.pod:224
18997 msgid "B<--file file>"
19001 #: ../fish/guestfish.pod:226
19002 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19006 #: ../fish/guestfish.pod:229
19009 " #!/usr/bin/guestfish -f\n"
19014 #: ../fish/guestfish.pod:231
19015 msgid "B<--format=raw|qcow2|..>"
19019 #: ../fish/guestfish.pod:233
19020 msgid "B<--format>"
19024 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
19026 "The default for the I<-a> option is to auto-detect the format of the disk "
19027 "image. Using this forces the disk format for I<-a> options which follow on "
19028 "the command line. Using I<--format> with no argument switches back to "
19029 "auto-detection for subsequent I<-a> options."
19033 #: ../fish/guestfish.pod:242
19036 " guestfish --format=raw -a disk.img\n"
19041 #: ../fish/guestfish.pod:244
19042 msgid "forces raw format (no auto-detection) for C<disk.img>."
19046 #: ../fish/guestfish.pod:246
19049 " guestfish --format=raw -a disk.img --format -a another.img\n"
19054 #: ../fish/guestfish.pod:248
19056 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19057 "auto-detection for C<another.img>."
19061 #: ../fish/guestfish.pod:251
19063 "If you have untrusted raw-format guest disk images, you should use this "
19064 "option to specify the disk format. This avoids a possible security problem "
19065 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19069 #: ../fish/guestfish.pod:256
19074 #: ../fish/guestfish.pod:258
19075 msgid "B<--inspector>"
19079 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
19081 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19082 "system and mount filesystems as they would be mounted on the real virtual "
19087 #: ../fish/guestfish.pod:264
19088 msgid "Typical usage is either:"
19092 #: ../fish/guestfish.pod:266
19095 " guestfish -d myguest -i\n"
19100 #: ../fish/guestfish.pod:268
19101 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19105 #: ../fish/guestfish.pod:270
19108 " guestfish --ro -d myguest -i\n"
19113 #: ../fish/guestfish.pod:272
19114 msgid "(for active domains, readonly), or specify the block device directly:"
19118 #: ../fish/guestfish.pod:274
19121 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19126 #: ../fish/guestfish.pod:276
19128 "Note that the command line syntax changed slightly over older versions of "
19129 "guestfish. You can still use the old syntax:"
19133 #: ../fish/guestfish.pod:279
19136 " guestfish [--ro] -i disk.img\n"
19141 #: ../fish/guestfish.pod:281
19144 " guestfish [--ro] -i libvirt-domain\n"
19149 #: ../fish/guestfish.pod:283
19151 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19152 "then using other commands to mount the filesystems that were found."
19156 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19157 msgid "B<--keys-from-stdin>"
19161 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19163 "Read key or passphrase parameters from stdin. The default is to try to read "
19164 "passphrases from the user by opening C</dev/tty>."
19168 #: ../fish/guestfish.pod:292
19169 msgid "B<--listen>"
19173 #: ../fish/guestfish.pod:294
19175 "Fork into the background and listen for remote commands. See section "
19176 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19180 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19185 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19187 "Connect to a live virtual machine. (Experimental, see "
19188 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19192 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:151
19193 msgid "B<-m dev[:mountpoint[:options]]>"
19197 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19198 msgid "B<--mount dev[:mountpoint[:options]]>"
19202 #: ../fish/guestfish.pod:306
19203 msgid "Mount the named partition or logical volume on the given mountpoint."
19207 #: ../fish/guestfish.pod:308
19208 msgid "If the mountpoint is omitted, it defaults to C</>."
19212 #: ../fish/guestfish.pod:310
19213 msgid "You have to mount something on C</> before most commands will work."
19217 #: ../fish/guestfish.pod:312
19219 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19224 #: ../fish/guestfish.pod:315
19226 "If you don't know what filesystems a disk image contains, you can either run "
19227 "guestfish without this option, then list the partitions, filesystems and LVs "
19228 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19229 "commands), or you can use the L<virt-filesystems(1)> program."
19233 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:161
19235 "The third (and rarely used) part of the mount parameter is the list of mount "
19236 "options used to mount the underlying filesystem. If this is not given, then "
19237 "the mount options are either the empty string or C<ro> (the latter if the "
19238 "I<--ro> flag is used). By specifying the mount options, you override this "
19239 "default choice. Probably the only time you would use this is to enable ACLs "
19240 "and/or extended attributes if the filesystem can support them:"
19244 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:169
19247 " -m /dev/sda1:/:acl,user_xattr\n"
19252 #: ../fish/guestfish.pod:331
19253 msgid "Using this flag is equivalent to using the C<mount-options> command."
19257 #: ../fish/guestfish.pod:333
19262 #: ../fish/guestfish.pod:335
19263 msgid "B<--no-sync>"
19267 #: ../fish/guestfish.pod:337
19269 "Disable autosync. This is enabled by default. See the discussion of "
19270 "autosync in the L<guestfs(3)> manpage."
19274 #: ../fish/guestfish.pod:340
19279 #: ../fish/guestfish.pod:342
19280 msgid "B<--new type>"
19284 #: ../fish/guestfish.pod:344
19289 #: ../fish/guestfish.pod:346
19291 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19292 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19293 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19298 #: ../fish/guestfish.pod:351
19299 msgid "B<--progress-bars>"
19303 #: ../fish/guestfish.pod:353
19304 msgid "Enable progress bars, even when guestfish is used non-interactively."
19308 #: ../fish/guestfish.pod:355
19310 "Progress bars are enabled by default when guestfish is used as an "
19311 "interactive shell."
19315 #: ../fish/guestfish.pod:358
19316 msgid "B<--no-progress-bars>"
19320 #: ../fish/guestfish.pod:360
19321 msgid "Disable progress bars."
19325 #: ../fish/guestfish.pod:362
19326 msgid "B<--remote[=pid]>"
19330 #: ../fish/guestfish.pod:364
19332 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19333 "CONTROL GUESTFISH OVER A SOCKET> below."
19337 #: ../fish/guestfish.pod:367
19342 #: ../fish/guestfish.pod:369
19347 #: ../fish/guestfish.pod:371
19349 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19350 "mounts are done read-only."
19354 #: ../fish/guestfish.pod:374
19356 "The option must always be used if the disk image or virtual machine might be "
19357 "running, and is generally recommended in cases where you don't need write "
19358 "access to the disk."
19362 #: ../fish/guestfish.pod:378
19364 "Note that prepared disk images created with I<-N> are not affected by this "
19365 "option. Also commands like C<add> are not affected - you have to specify "
19366 "the C<readonly:true> option explicitly if you need it."
19370 #: ../fish/guestfish.pod:382
19371 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19375 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:225
19376 msgid "B<--selinux>"
19380 #: ../fish/guestfish.pod:386
19381 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19385 #: ../fish/guestfish.pod:388
19390 #: ../fish/guestfish.pod:390
19391 msgid "B<--verbose>"
19395 #: ../fish/guestfish.pod:392
19397 "Enable very verbose messages. This is particularly useful if you find a "
19402 #: ../fish/guestfish.pod:395
19407 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97 ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
19408 msgid "B<--version>"
19412 #: ../fish/guestfish.pod:399
19413 msgid "Display the guestfish / libguestfs version number and exit."
19417 #: ../fish/guestfish.pod:401
19422 #: ../fish/guestfish.pod:403
19427 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:239
19429 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19430 "mounts are done read-write."
19434 #: ../fish/guestfish.pod:408
19435 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19439 #: ../fish/guestfish.pod:410
19444 #: ../fish/guestfish.pod:412
19445 msgid "Echo each command before executing it."
19449 #: ../fish/guestfish.pod:416
19450 msgid "COMMANDS ON COMMAND LINE"
19454 #: ../fish/guestfish.pod:418
19455 msgid "Any additional (non-option) arguments are treated as commands to execute."
19459 #: ../fish/guestfish.pod:421
19461 "Commands to execute should be separated by a colon (C<:>), where the colon "
19462 "is a separate parameter. Thus:"
19466 #: ../fish/guestfish.pod:424
19469 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19474 #: ../fish/guestfish.pod:426
19476 "If there are no additional arguments, then we enter a shell, either an "
19477 "interactive shell with a prompt (if the input is a terminal) or a "
19478 "non-interactive shell."
19482 #: ../fish/guestfish.pod:430
19484 "In either command line mode or non-interactive shell, the first command that "
19485 "gives an error causes the whole shell to exit. In interactive mode (with a "
19486 "prompt) if a command fails, you can continue to enter commands."
19490 #: ../fish/guestfish.pod:435
19491 msgid "USING launch (OR run)"
19495 #: ../fish/guestfish.pod:437
19497 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19498 "then launch it, then mount any disks you need, and finally issue "
19499 "actions/commands. So the general order of the day is:"
19503 #: ../fish/guestfish.pod:445
19504 msgid "add or -a/--add"
19508 #: ../fish/guestfish.pod:449
19509 msgid "launch (aka run)"
19513 #: ../fish/guestfish.pod:453
19514 msgid "mount or -m/--mount"
19518 #: ../fish/guestfish.pod:457
19519 msgid "any other commands"
19523 #: ../fish/guestfish.pod:461
19525 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19526 "guest before mounting or performing any other commands."
19530 #: ../fish/guestfish.pod:464
19532 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19533 "I<--new> options were given then C<run> is done automatically, simply "
19534 "because guestfish can't perform the action you asked for without doing this."
19538 #: ../fish/guestfish.pod:469
19539 msgid "OPENING DISKS FOR READ AND WRITE"
19543 #: ../fish/guestfish.pod:471
19545 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
19546 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
19547 "I<-i> and I<-m> open disk images read-only or for writing."
19551 #: ../fish/guestfish.pod:476
19553 "In libguestfs E<le> 1.8, guestfish, guestmount and virt-rescue defaulted to "
19554 "opening disk images supplied on the command line for write. To open a disk "
19555 "image read-only you have to do I<-a image --ro>."
19559 #: ../fish/guestfish.pod:480
19561 "This matters: If you accidentally open a live VM disk image writable then "
19562 "you will cause irreversible disk corruption."
19566 #: ../fish/guestfish.pod:483
19568 "By libguestfs 1.10 we intend to change the default the other way. Disk "
19569 "images will be opened read-only. You will have to either specify "
19570 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
19571 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
19572 "access for disk images specified by those other command line options."
19576 #: ../fish/guestfish.pod:490
19578 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
19579 "which does nothing (it is already the default). However it is highly "
19580 "recommended that you use this option to indicate that you need write access, "
19581 "and prepare your scripts for the day when this option will be required for "
19586 #: ../fish/guestfish.pod:496
19588 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
19589 "other libguestfs program apart from guestfish and guestmount."
19593 #: ../fish/guestfish.pod:499
19598 #: ../fish/guestfish.pod:501
19600 "You can quote ordinary parameters using either single or double quotes. For "
19605 #: ../fish/guestfish.pod:504
19608 " add \"file with a space.img\"\n"
19613 #: ../fish/guestfish.pod:506
19616 " rm '/file name'\n"
19621 #: ../fish/guestfish.pod:508
19629 #: ../fish/guestfish.pod:510
19631 "A few commands require a list of strings to be passed. For these, use a "
19632 "whitespace-separated list, enclosed in quotes. Strings containing "
19633 "whitespace to be passed through must be enclosed in single quotes. A "
19634 "literal single quote must be escaped with a backslash."
19638 #: ../fish/guestfish.pod:515
19641 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
19642 " command \"/bin/echo 'foo bar'\"\n"
19643 " command \"/bin/echo \\'foo\\'\"\n"
19648 #: ../fish/guestfish.pod:519
19649 msgid "OPTIONAL ARGUMENTS"
19653 #: ../fish/guestfish.pod:521
19655 "Some commands take optional arguments. These arguments appear in this "
19656 "documentation as C<[argname:..]>. You can use them as in these examples:"
19660 #: ../fish/guestfish.pod:525
19663 " add-drive-opts filename\n"
19668 #: ../fish/guestfish.pod:527
19671 " add-drive-opts filename readonly:true\n"
19676 #: ../fish/guestfish.pod:529
19679 " add-drive-opts filename format:qcow2 readonly:false\n"
19684 #: ../fish/guestfish.pod:531
19686 "Each optional argument can appear at most once. All optional arguments must "
19687 "appear after the required ones."
19691 #: ../fish/guestfish.pod:534
19696 #: ../fish/guestfish.pod:536
19697 msgid "This section applies to all commands which can take integers as parameters."
19701 #: ../fish/guestfish.pod:539
19702 msgid "SIZE SUFFIX"
19706 #: ../fish/guestfish.pod:541
19708 "When the command takes a parameter measured in bytes, you can use one of the "
19709 "following suffixes to specify kilobytes, megabytes and larger sizes:"
19713 #: ../fish/guestfish.pod:547
19714 msgid "B<k> or B<K> or B<KiB>"
19718 #: ../fish/guestfish.pod:549
19719 msgid "The size in kilobytes (multiplied by 1024)."
19723 #: ../fish/guestfish.pod:551
19728 #: ../fish/guestfish.pod:553
19729 msgid "The size in SI 1000 byte units."
19733 #: ../fish/guestfish.pod:555
19734 msgid "B<M> or B<MiB>"
19738 #: ../fish/guestfish.pod:557
19739 msgid "The size in megabytes (multiplied by 1048576)."
19743 #: ../fish/guestfish.pod:559
19748 #: ../fish/guestfish.pod:561
19749 msgid "The size in SI 1000000 byte units."
19753 #: ../fish/guestfish.pod:563
19754 msgid "B<G> or B<GiB>"
19758 #: ../fish/guestfish.pod:565
19759 msgid "The size in gigabytes (multiplied by 2**30)."
19763 #: ../fish/guestfish.pod:567
19768 #: ../fish/guestfish.pod:569
19769 msgid "The size in SI 10**9 byte units."
19773 #: ../fish/guestfish.pod:571
19774 msgid "B<T> or B<TiB>"
19778 #: ../fish/guestfish.pod:573
19779 msgid "The size in terabytes (multiplied by 2**40)."
19783 #: ../fish/guestfish.pod:575
19788 #: ../fish/guestfish.pod:577
19789 msgid "The size in SI 10**12 byte units."
19793 #: ../fish/guestfish.pod:579
19794 msgid "B<P> or B<PiB>"
19798 #: ../fish/guestfish.pod:581
19799 msgid "The size in petabytes (multiplied by 2**50)."
19803 #: ../fish/guestfish.pod:583
19808 #: ../fish/guestfish.pod:585
19809 msgid "The size in SI 10**15 byte units."
19813 #: ../fish/guestfish.pod:587
19814 msgid "B<E> or B<EiB>"
19818 #: ../fish/guestfish.pod:589
19819 msgid "The size in exabytes (multiplied by 2**60)."
19823 #: ../fish/guestfish.pod:591
19828 #: ../fish/guestfish.pod:593
19829 msgid "The size in SI 10**18 byte units."
19833 #: ../fish/guestfish.pod:595
19834 msgid "B<Z> or B<ZiB>"
19838 #: ../fish/guestfish.pod:597
19839 msgid "The size in zettabytes (multiplied by 2**70)."
19843 #: ../fish/guestfish.pod:599
19848 #: ../fish/guestfish.pod:601
19849 msgid "The size in SI 10**21 byte units."
19853 #: ../fish/guestfish.pod:603
19854 msgid "B<Y> or B<YiB>"
19858 #: ../fish/guestfish.pod:605
19859 msgid "The size in yottabytes (multiplied by 2**80)."
19863 #: ../fish/guestfish.pod:607
19868 #: ../fish/guestfish.pod:609
19869 msgid "The size in SI 10**24 byte units."
19873 #: ../fish/guestfish.pod:615
19876 " truncate-size /file 1G\n"
19881 #: ../fish/guestfish.pod:617
19882 msgid "would truncate the file to 1 gigabyte."
19886 #: ../fish/guestfish.pod:619
19888 "Be careful because a few commands take sizes in kilobytes or megabytes "
19889 "(eg. the parameter to L</memsize> is specified in megabytes already). "
19890 "Adding a suffix will probably not do what you expect."
19894 #: ../fish/guestfish.pod:623
19895 msgid "OCTAL AND HEXADECIMAL NUMBERS"
19899 #: ../fish/guestfish.pod:625
19901 "For specifying the radix (base) use the C convention: C<0> to prefix an "
19902 "octal number or C<0x> to prefix a hexadecimal number. For example:"
19906 #: ../fish/guestfish.pod:628
19909 " 1234 decimal number 1234\n"
19910 " 02322 octal number, equivalent to decimal 1234\n"
19911 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
19916 #: ../fish/guestfish.pod:632
19918 "When using the C<chmod> command, you almost always want to specify an octal "
19919 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
19920 "L<chmod(1)> program):"
19924 #: ../fish/guestfish.pod:636
19927 " chmod 0777 /public # OK\n"
19928 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
19933 #: ../fish/guestfish.pod:639
19935 "Commands that return numbers usually print them in decimal, but some "
19936 "commands print numbers in other radices (eg. C<umask> prints the mode in "
19937 "octal, preceeded by C<0>)."
19941 #: ../fish/guestfish.pod:643
19942 msgid "WILDCARDS AND GLOBBING"
19946 #: ../fish/guestfish.pod:645
19948 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
19949 "(globbing) by default. So for example the following will not do what you "
19954 #: ../fish/guestfish.pod:649
19962 #: ../fish/guestfish.pod:651
19964 "Assuming you don't have a directory called literally C</home/*> then the "
19965 "above command will return an error."
19969 #: ../fish/guestfish.pod:654
19970 msgid "To perform wildcard expansion, use the C<glob> command."
19974 #: ../fish/guestfish.pod:656
19977 " glob rm-rf /home/*\n"
19982 #: ../fish/guestfish.pod:658
19984 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
19985 "many times), equivalent to:"
19989 #: ../fish/guestfish.pod:661
19992 " rm-rf /home/jim\n"
19993 " rm-rf /home/joe\n"
19994 " rm-rf /home/mary\n"
19999 #: ../fish/guestfish.pod:665
20000 msgid "C<glob> only works on simple guest paths and not on device names."
20004 #: ../fish/guestfish.pod:667
20006 "If you have several parameters, each containing a wildcard, then glob will "
20007 "perform a Cartesian product."
20011 #: ../fish/guestfish.pod:670
20016 #: ../fish/guestfish.pod:672
20018 "Any line which starts with a I<#> character is treated as a comment and "
20019 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20020 "a command. For example:"
20024 #: ../fish/guestfish.pod:676
20027 " # this is a comment\n"
20028 " # this is a comment\n"
20029 " foo # NOT a comment\n"
20034 #: ../fish/guestfish.pod:680
20035 msgid "Blank lines are also ignored."
20039 #: ../fish/guestfish.pod:682
20040 msgid "RUNNING COMMANDS LOCALLY"
20044 #: ../fish/guestfish.pod:684
20046 "Any line which starts with a I<!> character is treated as a command sent to "
20047 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20051 #: ../fish/guestfish.pod:688
20055 " tgz-out /remote local/remote-data.tar.gz\n"
20060 #: ../fish/guestfish.pod:691
20062 "will create a directory C<local> on the host, and then export the contents "
20063 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20064 "(See C<tgz-out>)."
20068 #: ../fish/guestfish.pod:695
20070 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20071 "effect, due to the way that subprocesses work in Unix."
20075 #: ../fish/guestfish.pod:698
20076 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20080 #: ../fish/guestfish.pod:700
20082 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20083 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20084 "and executed as guestfish commands."
20088 #: ../fish/guestfish.pod:704
20090 "Thus you can use shell script to construct arbitrary guestfish commands "
20091 "which are then parsed by guestfish."
20095 #: ../fish/guestfish.pod:707
20097 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20098 "through C</foo.100>) using guestfish commands alone. However this is simple "
20099 "if we use a shell script to create the guestfish commands for us:"
20103 #: ../fish/guestfish.pod:712
20106 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20111 #: ../fish/guestfish.pod:714
20112 msgid "or with names like C</foo.001>:"
20116 #: ../fish/guestfish.pod:716
20119 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20124 #: ../fish/guestfish.pod:718
20126 "When using guestfish interactively it can be helpful to just run the shell "
20127 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20128 "ordinary I<!> local command), see what guestfish commands it would run, and "
20129 "when you are happy with those prepend the C<E<lt>> character to run the "
20130 "guestfish commands for real."
20134 #: ../fish/guestfish.pod:724
20139 #: ../fish/guestfish.pod:726
20141 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20142 "command (a guestfish command) to the second command (any host command). For "
20147 #: ../fish/guestfish.pod:730
20150 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20155 #: ../fish/guestfish.pod:732
20157 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20158 "program). The above command would list all accounts in the guest filesystem "
20159 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20163 #: ../fish/guestfish.pod:737
20166 " hexdump /bin/ls | head\n"
20167 " list-devices | tail -1\n"
20168 " tgz-out / - | tar ztf -\n"
20173 #: ../fish/guestfish.pod:741
20175 "The space before the pipe symbol is required, any space after the pipe "
20176 "symbol is optional. Everything after the pipe symbol is just passed "
20177 "straight to the host shell, so it can contain redirections, globs and "
20178 "anything else that makes sense on the host side."
20182 #: ../fish/guestfish.pod:746
20184 "To use a literal argument which begins with a pipe symbol, you have to quote "
20189 #: ../fish/guestfish.pod:749
20197 #: ../fish/guestfish.pod:751
20198 msgid "HOME DIRECTORIES"
20202 #: ../fish/guestfish.pod:753
20204 "If a parameter starts with the character C<~> then the tilde may be expanded "
20205 "as a home directory path (either C<~> for the current user's home directory, "
20206 "or C<~user> for another user)."
20210 #: ../fish/guestfish.pod:757
20212 "Note that home directory expansion happens for users known I<on the host>, "
20213 "not in the guest filesystem."
20217 #: ../fish/guestfish.pod:760
20219 "To use a literal argument which begins with a tilde, you have to quote it, "
20224 #: ../fish/guestfish.pod:763
20232 #: ../fish/guestfish.pod:767
20234 "Libguestfs has some support for Linux guests encrypted according to the "
20235 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20236 "disk encryption systems used by modern Linux guests. Currently only "
20237 "LVM-on-LUKS is supported."
20241 #: ../fish/guestfish.pod:772
20242 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20246 #: ../fish/guestfish.pod:774
20249 " ><fs> vfs-type /dev/sda2\n"
20255 #: ../fish/guestfish.pod:777
20257 "Then open those devices using L</luks-open>. This creates a device-mapper "
20258 "device called C</dev/mapper/luksdev>."
20262 #: ../fish/guestfish.pod:780
20265 " ><fs> luks-open /dev/sda2 luksdev\n"
20266 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20271 #: ../fish/guestfish.pod:783
20273 "Finally you have to tell LVM to scan for volume groups on the newly created "
20278 #: ../fish/guestfish.pod:786
20282 " vg-activate-all true\n"
20287 #: ../fish/guestfish.pod:789
20288 msgid "The logical volume(s) can now be mounted in the usual way."
20292 #: ../fish/guestfish.pod:791
20294 "Before closing a LUKS device you must unmount any logical volumes on it and "
20295 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20296 "one. Then you can close the mapper device:"
20300 #: ../fish/guestfish.pod:795
20303 " vg-activate false /dev/VG\n"
20304 " luks-close /dev/mapper/luksdev\n"
20309 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
20310 msgid "WINDOWS PATHS"
20314 #: ../fish/guestfish.pod:800
20316 "If a path is prefixed with C<win:> then you can use Windows-style paths "
20317 "(with some limitations). The following commands are equivalent:"
20321 #: ../fish/guestfish.pod:803
20324 " file /WINDOWS/system32/config/system.LOG\n"
20329 #: ../fish/guestfish.pod:805
20332 " file win:/windows/system32/config/system.log\n"
20337 #: ../fish/guestfish.pod:807
20340 " file win:\\windows\\system32\\config\\system.log\n"
20345 #: ../fish/guestfish.pod:809
20348 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
20353 #: ../fish/guestfish.pod:811
20355 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
20356 "handles case insensitivity like Windows would. This only works in argument "
20357 "positions that expect a path."
20361 #: ../fish/guestfish.pod:815
20362 msgid "UPLOADING AND DOWNLOADING FILES"
20366 #: ../fish/guestfish.pod:817
20368 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20369 "others which upload from or download to a local file, you can use the "
20370 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20374 #: ../fish/guestfish.pod:821
20382 #: ../fish/guestfish.pod:823
20383 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20387 #: ../fish/guestfish.pod:826
20390 " tar-out /etc - | tar tf -\n"
20395 #: ../fish/guestfish.pod:828
20397 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20398 "command (see L</PIPES>)."
20402 #: ../fish/guestfish.pod:831
20404 "When using C<-> to read from stdin, the input is read up to the end of "
20405 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20406 "some arbitrary end marker:"
20410 #: ../fish/guestfish.pod:835
20413 " upload -<<END /foo\n"
20422 #: ../fish/guestfish.pod:841
20424 "Any string of characters can be used instead of C<END>. The end marker must "
20425 "appear on a line of its own, without any preceeding or following characters "
20426 "(not even spaces)."
20430 #: ../fish/guestfish.pod:845
20432 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20433 "upload local files (so-called \"FileIn\" parameters in the generator)."
20437 #: ../fish/guestfish.pod:848
20438 msgid "EXIT ON ERROR BEHAVIOUR"
20442 #: ../fish/guestfish.pod:850
20444 "By default, guestfish will ignore any errors when in interactive mode "
20445 "(ie. taking commands from a human over a tty), and will exit on the first "
20446 "error in non-interactive mode (scripts, commands given on the command line)."
20450 #: ../fish/guestfish.pod:855
20452 "If you prefix a command with a I<-> character, then that command will not "
20453 "cause guestfish to exit, even if that (one) command returns an error."
20457 #: ../fish/guestfish.pod:859
20458 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20462 #: ../fish/guestfish.pod:861
20464 "Guestfish can be remote-controlled over a socket. This is useful "
20465 "particularly in shell scripts where you want to make several different "
20466 "changes to a filesystem, but you don't want the overhead of starting up a "
20467 "guestfish process each time."
20471 #: ../fish/guestfish.pod:866
20472 msgid "Start a guestfish server process using:"
20476 #: ../fish/guestfish.pod:868
20479 " eval \"`guestfish --listen`\"\n"
20484 #: ../fish/guestfish.pod:870
20485 msgid "and then send it commands by doing:"
20489 #: ../fish/guestfish.pod:872
20492 " guestfish --remote cmd [...]\n"
20497 #: ../fish/guestfish.pod:874
20498 msgid "To cause the server to exit, send it the exit command:"
20502 #: ../fish/guestfish.pod:876
20505 " guestfish --remote exit\n"
20510 #: ../fish/guestfish.pod:878
20512 "Note that the server will normally exit if there is an error in a command. "
20513 "You can change this in the usual way. See section L</EXIT ON ERROR "
20518 #: ../fish/guestfish.pod:882
20519 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20523 #: ../fish/guestfish.pod:884
20525 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20526 "is how the I<--remote> option knows where to send the commands. You can "
20527 "have several guestfish listener processes running using:"
20531 #: ../fish/guestfish.pod:888
20534 " eval \"`guestfish --listen`\"\n"
20535 " pid1=$GUESTFISH_PID\n"
20536 " eval \"`guestfish --listen`\"\n"
20537 " pid2=$GUESTFISH_PID\n"
20539 " guestfish --remote=$pid1 cmd\n"
20540 " guestfish --remote=$pid2 cmd\n"
20545 #: ../fish/guestfish.pod:896
20546 msgid "REMOTE CONTROL AND CSH"
20550 #: ../fish/guestfish.pod:898
20552 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
20557 #: ../fish/guestfish.pod:901
20560 " eval \"`guestfish --listen --csh`\"\n"
20565 #: ../fish/guestfish.pod:903
20566 msgid "REMOTE CONTROL DETAILS"
20570 #: ../fish/guestfish.pod:905
20572 "Remote control happens over a Unix domain socket called "
20573 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
20574 "of the process, and C<$PID> is the process ID of the server."
20578 #: ../fish/guestfish.pod:909
20579 msgid "Guestfish client and server versions must match exactly."
20583 #: ../fish/guestfish.pod:911
20584 msgid "PREPARED DISK IMAGES"
20588 #: ../fish/guestfish.pod:913
20590 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
20591 "preformatted disk images that guestfish can make for you to save typing. "
20592 "This is particularly useful for testing purposes. This option is used "
20593 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
20594 "can be mixed with I<-a>)."
20598 #: ../fish/guestfish.pod:919
20600 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
20601 "the second and so on. Existing files in the current directory are "
20606 #: ../fish/guestfish.pod:923
20608 "The type briefly describes how the disk should be sized, partitioned, how "
20609 "filesystem(s) should be created, and how content should be added. "
20610 "Optionally the type can be followed by extra parameters, separated by C<:> "
20611 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
20612 "sparsely-allocated disk, containing a single partition, with the partition "
20613 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
20614 "on a 1GB disk instead."
20618 #: ../fish/guestfish.pod:931
20619 msgid "To list the available types and any extra parameters they take, run:"
20623 #: ../fish/guestfish.pod:935
20625 "Note that the prepared filesystem is not mounted. You would usually have to "
20626 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
20630 #: ../fish/guestfish.pod:939
20632 "If any I<-N> or I<--new> options are given, the guest is automatically "
20637 #: ../fish/guestfish.pod:944
20638 msgid "Create a 100MB disk with an ext4-formatted partition:"
20642 #: ../fish/guestfish.pod:946
20645 " guestfish -N fs:ext4\n"
20650 #: ../fish/guestfish.pod:948
20651 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
20655 #: ../fish/guestfish.pod:950
20658 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
20663 #: ../fish/guestfish.pod:952
20664 msgid "Create a blank 200MB disk:"
20668 #: ../fish/guestfish.pod:954
20671 " guestfish -N disk:200M\n"
20676 #: ../fish/guestfish.pod:956
20677 msgid "PROGRESS BARS"
20681 #: ../fish/guestfish.pod:958
20683 "Some (not all) long-running commands send progress notification messages as "
20684 "they are running. Guestfish turns these messages into progress bars."
20688 #: ../fish/guestfish.pod:962
20690 "When a command that supports progress bars takes longer than two seconds to "
20691 "run, and if progress bars are enabled, then you will see one appearing below "
20696 #: ../fish/guestfish.pod:966
20699 " ><fs> copy-size /large-file /another-file 2048M\n"
20700 " / 10% [#####-----------------------------------------] 00:30\n"
20705 #: ../fish/guestfish.pod:969
20707 "The spinner on the left hand side moves round once for every progress "
20708 "notification received from the backend. This is a (reasonably) golden "
20709 "assurance that the command is \"doing something\" even if the progress bar "
20710 "is not moving, because the command is able to send the progress "
20711 "notifications. When the bar reaches 100% and the command finishes, the "
20712 "spinner disappears."
20716 #: ../fish/guestfish.pod:976
20718 "Progress bars are enabled by default when guestfish is used interactively. "
20719 "You can enable them even for non-interactive modes using I<--progress-bars>, "
20720 "and you can disable them completely using I<--no-progress-bars>."
20724 #: ../fish/guestfish.pod:981
20725 msgid "GUESTFISH COMMANDS"
20729 #: ../fish/guestfish.pod:983
20731 "The commands in this section are guestfish convenience commands, in other "
20732 "words, they are not part of the L<guestfs(3)> API."
20736 #: ../fish/guestfish.pod:986
20741 #: ../fish/guestfish.pod:988
20750 #: ../fish/guestfish.pod:991
20751 msgid "Without any parameter, this provides general help."
20755 #: ../fish/guestfish.pod:993
20756 msgid "With a C<cmd> parameter, this displays detailed help for that command."
20760 #: ../fish/guestfish.pod:995
20761 msgid "quit | exit"
20765 #: ../fish/guestfish.pod:997
20766 msgid "This exits guestfish. You can also use C<^D> key."
20770 #: ../fish/guestfish.pod:999
20771 msgid "@FISH_COMMANDS@"
20775 #: ../fish/guestfish.pod:1001
20780 #: ../fish/guestfish.pod:1005 ../test-tool/libguestfs-test-tool.pod:83
20785 #: ../fish/guestfish.pod:1007
20787 "guestfish returns 0 if the commands completed without error, or 1 if there "
20792 #: ../fish/guestfish.pod:1014
20797 #: ../fish/guestfish.pod:1016
20799 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
20804 #: ../fish/guestfish.pod:1019
20805 msgid "GUESTFISH_PID"
20809 #: ../fish/guestfish.pod:1021
20811 "Used with the I<--remote> option to specify the remote guestfish process to "
20812 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
20816 #: ../fish/guestfish.pod:1025
20821 #: ../fish/guestfish.pod:1027
20823 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
20824 "not specified, the external L<hexedit(1)> program is used."
20828 #: ../fish/guestfish.pod:1031
20833 #: ../fish/guestfish.pod:1033
20835 "If compiled with GNU readline support, various files in the home directory "
20836 "can be used. See L</FILES>."
20840 #: ../fish/guestfish.pod:1042
20842 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
20843 "effect as using the B<-v> option."
20847 #: ../fish/guestfish.pod:1054
20849 "Set the path that guestfish uses to search for kernel and initrd.img. See "
20850 "the discussion of paths in L<guestfs(3)>."
20854 #: ../fish/guestfish.pod:1065
20855 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
20859 #: ../fish/guestfish.pod:1067
20864 #: ../fish/guestfish.pod:1069
20866 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
20871 #: ../fish/guestfish.pod:1085 ../test-tool/libguestfs-test-tool.pod:88 ../fuse/guestmount.pod:252
20876 #: ../fish/guestfish.pod:1089 ../fuse/guestmount.pod:256
20877 msgid "$HOME/.libguestfs-tools.rc"
20881 #: ../fish/guestfish.pod:1091 ../fuse/guestmount.pod:258
20882 msgid "/etc/libguestfs-tools.conf"
20886 #: ../fish/guestfish.pod:1093 ../fuse/guestmount.pod:260
20888 "This configuration file controls the default read-only or read-write mode "
20889 "(I<--ro> or I<--rw>)."
20893 #: ../fish/guestfish.pod:1096
20894 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
20898 #: ../fish/guestfish.pod:1098
20899 msgid "$HOME/.guestfish"
20903 #: ../fish/guestfish.pod:1100
20905 "If compiled with GNU readline support, then the command history is saved in "
20910 #: ../fish/guestfish.pod:1103
20911 msgid "$HOME/.inputrc"
20915 #: ../fish/guestfish.pod:1105
20916 msgid "/etc/inputrc"
20920 #: ../fish/guestfish.pod:1107
20922 "If compiled with GNU readline support, then these files can be used to "
20923 "configure readline. For further information, please see "
20924 "L<readline(3)/INITIALIZATION FILE>."
20928 #: ../fish/guestfish.pod:1111
20929 msgid "To write rules which only apply to guestfish, use:"
20933 #: ../fish/guestfish.pod:1113
20943 #: ../fish/guestfish.pod:1117
20945 "Variables that you can set in inputrc that change the behaviour of guestfish "
20946 "in useful ways include:"
20950 #: ../fish/guestfish.pod:1122
20951 msgid "completion-ignore-case (default: on)"
20955 #: ../fish/guestfish.pod:1124
20957 "By default, guestfish will ignore case when tab-completing paths on the "
20962 #: ../fish/guestfish.pod:1127
20965 " set completion-ignore-case off\n"
20970 #: ../fish/guestfish.pod:1129
20971 msgid "to make guestfish case sensitive."
20975 #: ../fish/guestfish.pod:1133
20980 #: ../fish/guestfish.pod:1135
20981 msgid "test2.img (etc)"
20985 #: ../fish/guestfish.pod:1137
20987 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
20988 "will be created in the file C<test1.img> in the current directory. The "
20989 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
20990 "the same name will be overwritten."
20994 #: ../fish/guestfish.pod:1146
20996 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
20997 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
20998 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
20999 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21000 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21001 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
21005 #: ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:287 ../tools/virt-edit.pl:518 ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1518 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
21007 "This program is free software; you can redistribute it and/or modify it "
21008 "under the terms of the GNU General Public License as published by the Free "
21009 "Software Foundation; either version 2 of the License, or (at your option) "
21010 "any later version."
21014 #: ../fish/guestfish.pod:1181 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:523 ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1523 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
21016 "This program is distributed in the hope that it will be useful, but WITHOUT "
21017 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21018 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21023 #: ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:528 ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1528 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
21025 "You should have received a copy of the GNU General Public License along with "
21026 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21027 "Ave, Cambridge, MA 02139, USA."
21031 #: ../fish/guestfish-actions.pod:1
21036 #: ../fish/guestfish-actions.pod:3
21039 " add-cdrom filename\n"
21044 #: ../fish/guestfish-actions.pod:15
21046 "This call checks for the existence of C<filename>. This stops you from "
21047 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21048 "and C<http:> URLs. To specify those, use the general L</config> call "
21053 #: ../fish/guestfish-actions.pod:22
21055 "If you just want to add an ISO file (often you use this as an efficient way "
21056 "to transfer large files into the guest), then you should probably use "
21057 "L</add-drive-ro> instead."
21061 #: ../fish/guestfish-actions.pod:35
21066 #: ../fish/guestfish-actions.pod:37
21071 #: ../fish/guestfish-actions.pod:39
21074 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21079 #: ../fish/guestfish-actions.pod:41
21081 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21082 "It works by connecting to libvirt, requesting the domain and domain XML from "
21083 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21087 #: ../fish/guestfish-actions.pod:71
21089 "The other optional parameters are passed directly through to "
21090 "L</add-drive-opts>."
21094 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138 ../fish/guestfish-actions.pod:3039
21096 "This command has one or more optional arguments. See L</OPTIONAL "
21101 #: ../fish/guestfish-actions.pod:76
21106 #: ../fish/guestfish-actions.pod:78
21109 " add-drive filename\n"
21114 #: ../fish/guestfish-actions.pod:80
21116 "This function is the equivalent of calling L</add-drive-opts> with no "
21117 "optional parameters, so the disk is added writable, with the format being "
21118 "detected automatically."
21122 #: ../fish/guestfish-actions.pod:84
21124 "Automatic detection of the format opens you up to a potential security hole "
21125 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21126 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21127 "you should think about replacing calls to this function with calls to "
21128 "L</add-drive-opts>, and specifying the format."
21132 #: ../fish/guestfish-actions.pod:91
21133 msgid "add-drive-opts"
21137 #: ../fish/guestfish-actions.pod:93
21142 #: ../fish/guestfish-actions.pod:95
21145 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21150 #: ../fish/guestfish-actions.pod:122
21152 "This forces the image format. If you omit this (or use L</add-drive> or "
21153 "L</add-drive-ro>) then the format is automatically detected. Possible "
21154 "formats include C<raw> and C<qcow2>."
21158 #: ../fish/guestfish-actions.pod:133
21160 "This rarely-used option lets you emulate the behaviour of the deprecated "
21161 "L</add-drive-with-if> call (q.v.)"
21165 #: ../fish/guestfish-actions.pod:140
21166 msgid "add-drive-ro"
21170 #: ../fish/guestfish-actions.pod:142
21175 #: ../fish/guestfish-actions.pod:144
21178 " add-drive-ro filename\n"
21183 #: ../fish/guestfish-actions.pod:146
21185 "This function is the equivalent of calling L</add-drive-opts> with the "
21186 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21187 "is added read-only, with the format being detected automatically."
21191 #: ../fish/guestfish-actions.pod:151
21192 msgid "add-drive-ro-with-if"
21196 #: ../fish/guestfish-actions.pod:153
21199 " add-drive-ro-with-if filename iface\n"
21204 #: ../fish/guestfish-actions.pod:155
21206 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21207 "interface emulation to use at run time."
21211 #: ../fish/guestfish-actions.pod:165
21212 msgid "add-drive-with-if"
21216 #: ../fish/guestfish-actions.pod:167
21219 " add-drive-with-if filename iface\n"
21224 #: ../fish/guestfish-actions.pod:169
21226 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21227 "interface emulation to use at run time."
21231 #: ../fish/guestfish-actions.pod:179
21236 #: ../fish/guestfish-actions.pod:181
21239 " aug-clear augpath\n"
21244 #: ../fish/guestfish-actions.pod:186
21249 #: ../fish/guestfish-actions.pod:188
21257 #: ../fish/guestfish-actions.pod:190
21259 "Close the current Augeas handle and free up any resources used by it. After "
21260 "calling this, you have to call L</aug-init> again before you can use any "
21261 "other Augeas functions."
21265 #: ../fish/guestfish-actions.pod:195
21266 msgid "aug-defnode"
21270 #: ../fish/guestfish-actions.pod:197
21273 " aug-defnode name expr val\n"
21278 #: ../fish/guestfish-actions.pod:202
21280 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21281 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21282 "containing that single node."
21286 #: ../fish/guestfish-actions.pod:210
21291 #: ../fish/guestfish-actions.pod:212
21294 " aug-defvar name expr\n"
21299 #: ../fish/guestfish-actions.pod:221
21304 #: ../fish/guestfish-actions.pod:223
21307 " aug-get augpath\n"
21312 #: ../fish/guestfish-actions.pod:228
21317 #: ../fish/guestfish-actions.pod:230
21320 " aug-init root flags\n"
21325 #: ../fish/guestfish-actions.pod:236
21326 msgid "You must call this before using any other L</aug-*> commands."
21330 #: ../fish/guestfish-actions.pod:271
21331 msgid "Do not load the tree in L</aug-init>."
21335 #: ../fish/guestfish-actions.pod:275
21336 msgid "To close the handle, you can call L</aug-close>."
21340 #: ../fish/guestfish-actions.pod:279
21345 #: ../fish/guestfish-actions.pod:281
21348 " aug-insert augpath label true|false\n"
21353 #: ../fish/guestfish-actions.pod:291
21358 #: ../fish/guestfish-actions.pod:293
21366 #: ../fish/guestfish-actions.pod:300
21371 #: ../fish/guestfish-actions.pod:302
21374 " aug-ls augpath\n"
21379 #: ../fish/guestfish-actions.pod:304
21381 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21382 "resulting nodes into alphabetical order."
21386 #: ../fish/guestfish-actions.pod:307
21391 #: ../fish/guestfish-actions.pod:309
21394 " aug-match augpath\n"
21399 #: ../fish/guestfish-actions.pod:315
21404 #: ../fish/guestfish-actions.pod:317
21407 " aug-mv src dest\n"
21412 #: ../fish/guestfish-actions.pod:322
21417 #: ../fish/guestfish-actions.pod:324
21420 " aug-rm augpath\n"
21425 #: ../fish/guestfish-actions.pod:330
21430 #: ../fish/guestfish-actions.pod:332
21438 #: ../fish/guestfish-actions.pod:336
21440 "The flags which were passed to L</aug-init> affect exactly how files are "
21445 #: ../fish/guestfish-actions.pod:339
21450 #: ../fish/guestfish-actions.pod:341
21453 " aug-set augpath val\n"
21458 #: ../fish/guestfish-actions.pod:345
21460 "In the Augeas API, it is possible to clear a node by setting the value to "
21461 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21462 "this call. Instead you must use the L</aug-clear> call."
21466 #: ../fish/guestfish-actions.pod:350
21471 #: ../fish/guestfish-actions.pod:352
21474 " available 'groups ...'\n"
21479 #: ../fish/guestfish-actions.pod:358
21481 "The libguestfs groups, and the functions that those groups correspond to, "
21482 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21483 "runtime by calling L</available-all-groups>."
21487 #: ../fish/guestfish-actions.pod:382
21488 msgid "You must call L</launch> before calling this function."
21492 #: ../fish/guestfish-actions.pod:404
21494 "This call was added in version C<1.0.80>. In previous versions of "
21495 "libguestfs all you could do would be to speculatively execute a command to "
21496 "find out if the daemon implemented it. See also L</version>."
21500 #: ../fish/guestfish-actions.pod:411
21501 msgid "available-all-groups"
21505 #: ../fish/guestfish-actions.pod:413
21508 " available-all-groups\n"
21513 #: ../fish/guestfish-actions.pod:415
21515 "This command returns a list of all optional groups that this daemon knows "
21516 "about. Note this returns both supported and unsupported groups. To find "
21517 "out which ones the daemon can actually support you have to call "
21518 "L</available> on each member of the returned list."
21522 #: ../fish/guestfish-actions.pod:421
21523 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
21527 #: ../fish/guestfish-actions.pod:423
21532 #: ../fish/guestfish-actions.pod:425
21535 " base64-in (base64file|-) filename\n"
21540 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439 ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832 ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228 ../fish/guestfish-actions.pod:4437 ../fish/guestfish-actions.pod:4449 ../fish/guestfish-actions.pod:4460 ../fish/guestfish-actions.pod:4471 ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4532 ../fish/guestfish-actions.pod:4586 ../fish/guestfish-actions.pod:4609
21541 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
21545 #: ../fish/guestfish-actions.pod:432
21550 #: ../fish/guestfish-actions.pod:434
21553 " base64-out filename (base64file|-)\n"
21558 #: ../fish/guestfish-actions.pod:441
21559 msgid "blockdev-flushbufs"
21563 #: ../fish/guestfish-actions.pod:443
21566 " blockdev-flushbufs device\n"
21571 #: ../fish/guestfish-actions.pod:450
21572 msgid "blockdev-getbsz"
21576 #: ../fish/guestfish-actions.pod:452
21579 " blockdev-getbsz device\n"
21584 #: ../fish/guestfish-actions.pod:461
21585 msgid "blockdev-getro"
21589 #: ../fish/guestfish-actions.pod:463
21592 " blockdev-getro device\n"
21597 #: ../fish/guestfish-actions.pod:470
21598 msgid "blockdev-getsize64"
21602 #: ../fish/guestfish-actions.pod:472
21605 " blockdev-getsize64 device\n"
21610 #: ../fish/guestfish-actions.pod:476
21611 msgid "See also L</blockdev-getsz>."
21615 #: ../fish/guestfish-actions.pod:480
21616 msgid "blockdev-getss"
21620 #: ../fish/guestfish-actions.pod:482
21623 " blockdev-getss device\n"
21628 #: ../fish/guestfish-actions.pod:487
21629 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
21633 #: ../fish/guestfish-actions.pod:492
21634 msgid "blockdev-getsz"
21638 #: ../fish/guestfish-actions.pod:494
21641 " blockdev-getsz device\n"
21646 #: ../fish/guestfish-actions.pod:499
21648 "See also L</blockdev-getss> for the real sector size of the device, and "
21649 "L</blockdev-getsize64> for the more useful I<size in bytes>."
21653 #: ../fish/guestfish-actions.pod:505
21654 msgid "blockdev-rereadpt"
21658 #: ../fish/guestfish-actions.pod:507
21661 " blockdev-rereadpt device\n"
21666 #: ../fish/guestfish-actions.pod:513
21667 msgid "blockdev-setbsz"
21671 #: ../fish/guestfish-actions.pod:515
21674 " blockdev-setbsz device blocksize\n"
21679 #: ../fish/guestfish-actions.pod:524
21680 msgid "blockdev-setro"
21684 #: ../fish/guestfish-actions.pod:526
21687 " blockdev-setro device\n"
21692 #: ../fish/guestfish-actions.pod:532
21693 msgid "blockdev-setrw"
21697 #: ../fish/guestfish-actions.pod:534
21700 " blockdev-setrw device\n"
21705 #: ../fish/guestfish-actions.pod:540
21706 msgid "case-sensitive-path"
21710 #: ../fish/guestfish-actions.pod:542
21713 " case-sensitive-path path\n"
21718 #: ../fish/guestfish-actions.pod:566
21720 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
21721 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
21722 "how the directories were originally created under Windows)."
21726 #: ../fish/guestfish-actions.pod:574
21727 msgid "See also L</realpath>."
21731 #: ../fish/guestfish-actions.pod:576
21736 #: ../fish/guestfish-actions.pod:578
21744 #: ../fish/guestfish-actions.pod:582
21746 "Note that this function cannot correctly handle binary files (specifically, "
21747 "files containing C<\\0> character which is treated as end of string). For "
21748 "those you need to use the L</read-file> or L</download> functions which have "
21749 "a more complex interface."
21753 #: ../fish/guestfish-actions.pod:590
21758 #: ../fish/guestfish-actions.pod:592
21761 " checksum csumtype path\n"
21766 #: ../fish/guestfish-actions.pod:635
21767 msgid "To get the checksum for a device, use L</checksum-device>."
21771 #: ../fish/guestfish-actions.pod:637
21772 msgid "To get the checksums for many files, use L</checksums-out>."
21776 #: ../fish/guestfish-actions.pod:639
21777 msgid "checksum-device"
21781 #: ../fish/guestfish-actions.pod:641
21784 " checksum-device csumtype device\n"
21789 #: ../fish/guestfish-actions.pod:643
21791 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
21792 "device named C<device>. For the types of checksums supported see the "
21793 "L</checksum> command."
21797 #: ../fish/guestfish-actions.pod:647
21798 msgid "checksums-out"
21802 #: ../fish/guestfish-actions.pod:649
21805 " checksums-out csumtype directory (sumsfile|-)\n"
21810 #: ../fish/guestfish-actions.pod:665
21815 #: ../fish/guestfish-actions.pod:667
21818 " chmod mode path\n"
21823 #: ../fish/guestfish-actions.pod:678
21828 #: ../fish/guestfish-actions.pod:680
21831 " chown owner group path\n"
21836 #: ../fish/guestfish-actions.pod:688
21841 #: ../fish/guestfish-actions.pod:690
21844 " command 'arguments ...'\n"
21849 #: ../fish/guestfish-actions.pod:697
21851 "The single parameter is an argv-style list of arguments. The first element "
21852 "is the name of the program to run. Subsequent elements are parameters. The "
21853 "list must be non-empty (ie. must contain a program name). Note that the "
21854 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
21858 #: ../fish/guestfish-actions.pod:725
21859 msgid "command-lines"
21863 #: ../fish/guestfish-actions.pod:727
21866 " command-lines 'arguments ...'\n"
21871 #: ../fish/guestfish-actions.pod:729
21872 msgid "This is the same as L</command>, but splits the result into a list of lines."
21876 #: ../fish/guestfish-actions.pod:732
21877 msgid "See also: L</sh-lines>"
21881 #: ../fish/guestfish-actions.pod:737
21886 #: ../fish/guestfish-actions.pod:739
21889 " config qemuparam qemuvalue\n"
21894 #: ../fish/guestfish-actions.pod:750
21899 #: ../fish/guestfish-actions.pod:752
21902 " copy-size src dest size\n"
21907 #: ../fish/guestfish-actions.pod:760
21912 #: ../fish/guestfish-actions.pod:762
21920 #: ../fish/guestfish-actions.pod:767
21925 #: ../fish/guestfish-actions.pod:769
21933 #: ../fish/guestfish-actions.pod:774
21938 #: ../fish/guestfish-actions.pod:776
21946 #: ../fish/guestfish-actions.pod:783
21948 "If the destination is a device, it must be as large or larger than the "
21949 "source file or device, otherwise the copy will fail. This command cannot do "
21950 "partial copies (see L</copy-size>)."
21954 #: ../fish/guestfish-actions.pod:787
21959 #: ../fish/guestfish-actions.pod:789
21967 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
21969 "This command is mostly useful for interactive sessions. It is I<not> "
21970 "intended that you try to parse the output string. Use L</statvfs> from "
21975 #: ../fish/guestfish-actions.pod:797
21980 #: ../fish/guestfish-actions.pod:799
21988 #: ../fish/guestfish-actions.pod:808
21993 #: ../fish/guestfish-actions.pod:810
22001 #: ../fish/guestfish-actions.pod:816
22003 "Another way to get the same information is to enable verbose messages with "
22004 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22005 "before running the program."
22009 #: ../fish/guestfish-actions.pod:821
22014 #: ../fish/guestfish-actions.pod:823
22017 " download remotefilename (filename|-)\n"
22022 #: ../fish/guestfish-actions.pod:830
22023 msgid "See also L</upload>, L</cat>."
22027 #: ../fish/guestfish-actions.pod:834
22028 msgid "download-offset"
22032 #: ../fish/guestfish-actions.pod:836
22035 " download-offset remotefilename (filename|-) offset size\n"
22040 #: ../fish/guestfish-actions.pod:844
22042 "Note that there is no limit on the amount of data that can be downloaded "
22043 "with this call, unlike with L</pread>, and this call always reads the full "
22044 "amount unless an error occurs."
22048 #: ../fish/guestfish-actions.pod:849
22049 msgid "See also L</download>, L</pread>."
22053 #: ../fish/guestfish-actions.pod:853
22054 msgid "drop-caches"
22058 #: ../fish/guestfish-actions.pod:855
22061 " drop-caches whattodrop\n"
22066 #: ../fish/guestfish-actions.pod:867
22071 #: ../fish/guestfish-actions.pod:869
22079 #: ../fish/guestfish-actions.pod:881
22084 #: ../fish/guestfish-actions.pod:883
22087 " e2fsck-f device\n"
22092 #: ../fish/guestfish-actions.pod:889
22094 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22095 "should use L</fsck>."
22099 #: ../fish/guestfish-actions.pod:892
22100 msgid "echo-daemon"
22104 #: ../fish/guestfish-actions.pod:894
22107 " echo-daemon 'words ...'\n"
22112 #: ../fish/guestfish-actions.pod:901
22113 msgid "See also L</ping-daemon>."
22117 #: ../fish/guestfish-actions.pod:903
22122 #: ../fish/guestfish-actions.pod:905
22125 " egrep regex path\n"
22130 #: ../fish/guestfish-actions.pod:913
22135 #: ../fish/guestfish-actions.pod:915
22138 " egrepi regex path\n"
22143 #: ../fish/guestfish-actions.pod:923
22148 #: ../fish/guestfish-actions.pod:925
22151 " equal file1 file2\n"
22156 #: ../fish/guestfish-actions.pod:932
22161 #: ../fish/guestfish-actions.pod:934
22169 #: ../fish/guestfish-actions.pod:939
22170 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22174 #: ../fish/guestfish-actions.pod:941
22179 #: ../fish/guestfish-actions.pod:943
22182 " fallocate path len\n"
22187 #: ../fish/guestfish-actions.pod:960
22188 msgid "fallocate64"
22192 #: ../fish/guestfish-actions.pod:962
22195 " fallocate64 path len\n"
22200 #: ../fish/guestfish-actions.pod:968
22202 "Note that this call allocates disk blocks for the file. To create a sparse "
22203 "file use L</truncate-size> instead."
22207 #: ../fish/guestfish-actions.pod:971
22209 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22210 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22211 "maximum size of files created through that call to 1GB."
22215 #: ../fish/guestfish-actions.pod:980
22220 #: ../fish/guestfish-actions.pod:982
22223 " fgrep pattern path\n"
22228 #: ../fish/guestfish-actions.pod:990
22233 #: ../fish/guestfish-actions.pod:992
22236 " fgrepi pattern path\n"
22241 #: ../fish/guestfish-actions.pod:1000
22246 #: ../fish/guestfish-actions.pod:1002
22254 #: ../fish/guestfish-actions.pod:1014
22256 "This command can also be used on C</dev/> devices (and partitions, LV "
22257 "names). You can for example use this to determine if a device contains a "
22258 "filesystem, although it's usually better to use L</vfs-type>."
22262 #: ../fish/guestfish-actions.pod:1024
22263 msgid "file-architecture"
22267 #: ../fish/guestfish-actions.pod:1026
22270 " file-architecture filename\n"
22275 #: ../fish/guestfish-actions.pod:1129
22280 #: ../fish/guestfish-actions.pod:1131
22288 #: ../fish/guestfish-actions.pod:1135
22290 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22291 "L</is-file> etc. To get the size of block devices, use "
22292 "L</blockdev-getsize64>."
22296 #: ../fish/guestfish-actions.pod:1139
22301 #: ../fish/guestfish-actions.pod:1141
22304 " fill c len path\n"
22309 #: ../fish/guestfish-actions.pod:1147
22311 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22312 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22313 "L</fill-pattern>."
22317 #: ../fish/guestfish-actions.pod:1152
22318 msgid "fill-pattern"
22322 #: ../fish/guestfish-actions.pod:1154
22325 " fill-pattern pattern len path\n"
22330 #: ../fish/guestfish-actions.pod:1156
22332 "This function is like L</fill> except that it creates a new file of length "
22333 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22334 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22339 #: ../fish/guestfish-actions.pod:1161
22344 #: ../fish/guestfish-actions.pod:1163
22347 " find directory\n"
22352 #: ../fish/guestfish-actions.pod:1177
22353 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22357 #: ../fish/guestfish-actions.pod:1190
22358 msgid "See also L</find0>."
22362 #: ../fish/guestfish-actions.pod:1195
22367 #: ../fish/guestfish-actions.pod:1197
22370 " find0 directory (files|-)\n"
22375 #: ../fish/guestfish-actions.pod:1203
22376 msgid "This command works the same way as L</find> with the following exceptions:"
22380 #: ../fish/guestfish-actions.pod:1230
22381 msgid "findfs-label"
22385 #: ../fish/guestfish-actions.pod:1232
22388 " findfs-label label\n"
22393 #: ../fish/guestfish-actions.pod:1238
22394 msgid "To find the label of a filesystem, use L</vfs-label>."
22398 #: ../fish/guestfish-actions.pod:1240
22399 msgid "findfs-uuid"
22403 #: ../fish/guestfish-actions.pod:1242
22406 " findfs-uuid uuid\n"
22411 #: ../fish/guestfish-actions.pod:1248
22412 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22416 #: ../fish/guestfish-actions.pod:1250
22421 #: ../fish/guestfish-actions.pod:1252
22424 " fsck fstype device\n"
22429 #: ../fish/guestfish-actions.pod:1282
22434 #: ../fish/guestfish-actions.pod:1284
22442 #: ../fish/guestfish-actions.pod:1291
22443 msgid "get-attach-method"
22447 #: ../fish/guestfish-actions.pod:1293
22450 " get-attach-method\n"
22455 #: ../fish/guestfish-actions.pod:1295
22456 msgid "Return the current attach method. See L</set-attach-method>."
22460 #: ../fish/guestfish-actions.pod:1297
22461 msgid "get-autosync"
22465 #: ../fish/guestfish-actions.pod:1299
22473 #: ../fish/guestfish-actions.pod:1303
22478 #: ../fish/guestfish-actions.pod:1305
22486 #: ../fish/guestfish-actions.pod:1309
22487 msgid "get-e2label"
22491 #: ../fish/guestfish-actions.pod:1311
22494 " get-e2label device\n"
22499 #: ../fish/guestfish-actions.pod:1323
22504 #: ../fish/guestfish-actions.pod:1325
22507 " get-e2uuid device\n"
22512 #: ../fish/guestfish-actions.pod:1337
22513 msgid "get-memsize"
22517 #: ../fish/guestfish-actions.pod:1339
22525 #: ../fish/guestfish-actions.pod:1344
22527 "If L</set-memsize> was not called on this handle, and if "
22528 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
22529 "value for memsize."
22533 #: ../fish/guestfish-actions.pod:1351
22534 msgid "get-network"
22538 #: ../fish/guestfish-actions.pod:1353
22546 #: ../fish/guestfish-actions.pod:1357
22551 #: ../fish/guestfish-actions.pod:1359
22559 #: ../fish/guestfish-actions.pod:1366
22564 #: ../fish/guestfish-actions.pod:1368
22569 #: ../fish/guestfish-actions.pod:1370
22577 #: ../fish/guestfish-actions.pod:1377
22582 #: ../fish/guestfish-actions.pod:1379
22590 #: ../fish/guestfish-actions.pod:1386
22591 msgid "get-recovery-proc"
22595 #: ../fish/guestfish-actions.pod:1388
22598 " get-recovery-proc\n"
22603 #: ../fish/guestfish-actions.pod:1392
22604 msgid "get-selinux"
22608 #: ../fish/guestfish-actions.pod:1394
22616 #: ../fish/guestfish-actions.pod:1396
22618 "This returns the current setting of the selinux flag which is passed to the "
22619 "appliance at boot time. See L</set-selinux>."
22623 #: ../fish/guestfish-actions.pod:1402
22628 #: ../fish/guestfish-actions.pod:1404
22636 #: ../fish/guestfish-actions.pod:1411
22641 #: ../fish/guestfish-actions.pod:1413
22649 #: ../fish/guestfish-actions.pod:1417
22654 #: ../fish/guestfish-actions.pod:1419
22662 #: ../fish/guestfish-actions.pod:1421
22664 "Return the current umask. By default the umask is C<022> unless it has been "
22665 "set by calling L</umask>."
22669 #: ../fish/guestfish-actions.pod:1424
22670 msgid "get-verbose"
22674 #: ../fish/guestfish-actions.pod:1426
22682 #: ../fish/guestfish-actions.pod:1430
22687 #: ../fish/guestfish-actions.pod:1432
22695 #: ../fish/guestfish-actions.pod:1436
22696 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
22700 #: ../fish/guestfish-actions.pod:1439
22705 #: ../fish/guestfish-actions.pod:1441
22708 " getxattr path name\n"
22713 #: ../fish/guestfish-actions.pod:1443
22715 "Get a single extended attribute from file C<path> named C<name>. This call "
22716 "follows symlinks. If you want to lookup an extended attribute for the "
22717 "symlink itself, use L</lgetxattr>."
22721 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2445
22723 "Normally it is better to get all extended attributes from a file in one go "
22724 "by calling L</getxattrs>. However some Linux filesystem implementations are "
22725 "buggy and do not provide a way to list out attributes. For these "
22726 "filesystems (notably ntfs-3g) you have to know the names of the extended "
22727 "attributes you want in advance and call this function."
22731 #: ../fish/guestfish-actions.pod:1457
22732 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
22736 #: ../fish/guestfish-actions.pod:1459
22741 #: ../fish/guestfish-actions.pod:1461
22744 " getxattrs path\n"
22749 #: ../fish/guestfish-actions.pod:1469
22750 msgid "See also: L</lgetxattrs>, L<attr(5)>."
22754 #: ../fish/guestfish-actions.pod:1471
22755 msgid "glob-expand"
22759 #: ../fish/guestfish-actions.pod:1473
22762 " glob-expand pattern\n"
22767 #: ../fish/guestfish-actions.pod:1486
22772 #: ../fish/guestfish-actions.pod:1488
22775 " grep regex path\n"
22780 #: ../fish/guestfish-actions.pod:1496
22785 #: ../fish/guestfish-actions.pod:1498
22788 " grepi regex path\n"
22793 #: ../fish/guestfish-actions.pod:1506
22794 msgid "grub-install"
22798 #: ../fish/guestfish-actions.pod:1508
22801 " grub-install root device\n"
22806 #: ../fish/guestfish-actions.pod:1524
22811 #: ../fish/guestfish-actions.pod:1526
22819 #: ../fish/guestfish-actions.pod:1534
22824 #: ../fish/guestfish-actions.pod:1536
22827 " head-n nrlines path\n"
22832 #: ../fish/guestfish-actions.pod:1549
22837 #: ../fish/guestfish-actions.pod:1551
22845 #: ../fish/guestfish-actions.pod:1559
22850 #: ../fish/guestfish-actions.pod:1561
22853 " initrd-cat initrdpath filename\n"
22858 #: ../fish/guestfish-actions.pod:1573
22859 msgid "See also L</initrd-list>."
22863 #: ../fish/guestfish-actions.pod:1578
22864 msgid "initrd-list"
22868 #: ../fish/guestfish-actions.pod:1580
22871 " initrd-list path\n"
22876 #: ../fish/guestfish-actions.pod:1592
22877 msgid "inotify-add-watch"
22881 #: ../fish/guestfish-actions.pod:1594
22884 " inotify-add-watch path mask\n"
22889 #: ../fish/guestfish-actions.pod:1606
22890 msgid "inotify-close"
22894 #: ../fish/guestfish-actions.pod:1608
22902 #: ../fish/guestfish-actions.pod:1614
22903 msgid "inotify-files"
22907 #: ../fish/guestfish-actions.pod:1616
22915 #: ../fish/guestfish-actions.pod:1618
22917 "This function is a helpful wrapper around L</inotify-read> which just "
22918 "returns a list of pathnames of objects that were touched. The returned "
22919 "pathnames are sorted and deduplicated."
22923 #: ../fish/guestfish-actions.pod:1622
22924 msgid "inotify-init"
22928 #: ../fish/guestfish-actions.pod:1624
22931 " inotify-init maxevents\n"
22936 #: ../fish/guestfish-actions.pod:1630
22938 "C<maxevents> is the maximum number of events which will be queued up between "
22939 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
22940 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
22941 "default was 16384 events. Beyond this limit, the kernel throws away events, "
22942 "but records the fact that it threw them away by setting a flag "
22943 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
22947 #: ../fish/guestfish-actions.pod:1640
22949 "Before any events are generated, you have to add some watches to the "
22950 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
22951 "L</inotify-watch-all>."
22955 #: ../fish/guestfish-actions.pod:1646
22957 "Queued up events should be read periodically by calling L</inotify-read> (or "
22958 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
22959 "If you don't read the events out often enough then you risk the internal "
22960 "queue overflowing."
22964 #: ../fish/guestfish-actions.pod:1653
22966 "The handle should be closed after use by calling L</inotify-close>. This "
22967 "also removes any watches automatically."
22971 #: ../fish/guestfish-actions.pod:1662
22972 msgid "inotify-read"
22976 #: ../fish/guestfish-actions.pod:1664
22984 #: ../fish/guestfish-actions.pod:1677
22985 msgid "inotify-rm-watch"
22989 #: ../fish/guestfish-actions.pod:1679
22992 " inotify-rm-watch wd\n"
22997 #: ../fish/guestfish-actions.pod:1681
22998 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23002 #: ../fish/guestfish-actions.pod:1684
23003 msgid "inspect-get-arch"
23007 #: ../fish/guestfish-actions.pod:1686
23010 " inspect-get-arch root\n"
23015 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1782 ../fish/guestfish-actions.pod:1818 ../fish/guestfish-actions.pod:1836 ../fish/guestfish-actions.pod:1870 ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1906 ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1976 ../fish/guestfish-actions.pod:2000 ../fish/guestfish-actions.pod:2017 ../fish/guestfish-actions.pod:2060 ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2111 ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2168
23017 "This function should only be called with a root device string as returned by "
23022 #: ../fish/guestfish-actions.pod:1691
23024 "This returns the architecture of the inspected operating system. The "
23025 "possible return values are listed under L</file-architecture>."
23029 #: ../fish/guestfish-actions.pod:1700
23030 msgid "inspect-get-distro"
23034 #: ../fish/guestfish-actions.pod:1702
23037 " inspect-get-distro root\n"
23042 #: ../fish/guestfish-actions.pod:1778
23043 msgid "inspect-get-drive-mappings"
23047 #: ../fish/guestfish-actions.pod:1780
23050 " inspect-get-drive-mappings root\n"
23055 #: ../fish/guestfish-actions.pod:1810
23057 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23058 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23062 #: ../fish/guestfish-actions.pod:1814
23063 msgid "inspect-get-filesystems"
23067 #: ../fish/guestfish-actions.pod:1816
23070 " inspect-get-filesystems root\n"
23075 #: ../fish/guestfish-actions.pod:1829
23077 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23078 "L</inspect-get-mountpoints>."
23082 #: ../fish/guestfish-actions.pod:1832
23083 msgid "inspect-get-format"
23087 #: ../fish/guestfish-actions.pod:1834
23090 " inspect-get-format root\n"
23095 #: ../fish/guestfish-actions.pod:1866
23096 msgid "inspect-get-hostname"
23100 #: ../fish/guestfish-actions.pod:1868
23103 " inspect-get-hostname root\n"
23108 #: ../fish/guestfish-actions.pod:1881
23109 msgid "inspect-get-major-version"
23113 #: ../fish/guestfish-actions.pod:1883
23116 " inspect-get-major-version root\n"
23121 #: ../fish/guestfish-actions.pod:1902
23122 msgid "inspect-get-minor-version"
23126 #: ../fish/guestfish-actions.pod:1904
23129 " inspect-get-minor-version root\n"
23134 #: ../fish/guestfish-actions.pod:1914
23136 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23137 "L</inspect-get-major-version>."
23141 #: ../fish/guestfish-actions.pod:1917
23142 msgid "inspect-get-mountpoints"
23146 #: ../fish/guestfish-actions.pod:1919
23149 " inspect-get-mountpoints root\n"
23154 #: ../fish/guestfish-actions.pod:1941
23156 "For operating systems like Windows which still use drive letters, this call "
23157 "will only return an entry for the first drive \"mounted on\" C</>. For "
23158 "information about the mapping of drive letters to partitions, see "
23159 "L</inspect-get-drive-mappings>."
23163 #: ../fish/guestfish-actions.pod:1947
23165 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23166 "L</inspect-get-filesystems>."
23170 #: ../fish/guestfish-actions.pod:1950
23171 msgid "inspect-get-package-format"
23175 #: ../fish/guestfish-actions.pod:1952
23178 " inspect-get-package-format root\n"
23183 #: ../fish/guestfish-actions.pod:1957
23185 "This function and L</inspect-get-package-management> return the package "
23186 "format and package management tool used by the inspected operating system. "
23187 "For example for Fedora these functions would return C<rpm> (package format) "
23188 "and C<yum> (package management)."
23192 #: ../fish/guestfish-actions.pod:1972
23193 msgid "inspect-get-package-management"
23197 #: ../fish/guestfish-actions.pod:1974
23200 " inspect-get-package-management root\n"
23205 #: ../fish/guestfish-actions.pod:1979
23207 "L</inspect-get-package-format> and this function return the package format "
23208 "and package management tool used by the inspected operating system. For "
23209 "example for Fedora these functions would return C<rpm> (package format) and "
23210 "C<yum> (package management)."
23214 #: ../fish/guestfish-actions.pod:1996
23215 msgid "inspect-get-product-name"
23219 #: ../fish/guestfish-actions.pod:1998
23222 " inspect-get-product-name root\n"
23227 #: ../fish/guestfish-actions.pod:2013
23228 msgid "inspect-get-product-variant"
23232 #: ../fish/guestfish-actions.pod:2015
23235 " inspect-get-product-variant root\n"
23240 #: ../fish/guestfish-actions.pod:2039
23242 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23243 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23247 #: ../fish/guestfish-actions.pod:2043
23248 msgid "inspect-get-roots"
23252 #: ../fish/guestfish-actions.pod:2045
23255 " inspect-get-roots\n"
23260 #: ../fish/guestfish-actions.pod:2047
23262 "This function is a convenient way to get the list of root devices, as "
23263 "returned from a previous call to L</inspect-os>, but without redoing the "
23264 "whole inspection process."
23268 #: ../fish/guestfish-actions.pod:2051
23270 "This returns an empty list if either no root devices were found or the "
23271 "caller has not called L</inspect-os>."
23275 #: ../fish/guestfish-actions.pod:2056
23276 msgid "inspect-get-type"
23280 #: ../fish/guestfish-actions.pod:2058
23283 " inspect-get-type root\n"
23288 #: ../fish/guestfish-actions.pod:2091
23289 msgid "inspect-get-windows-current-control-set"
23293 #: ../fish/guestfish-actions.pod:2093
23296 " inspect-get-windows-current-control-set root\n"
23301 #: ../fish/guestfish-actions.pod:2107
23302 msgid "inspect-get-windows-systemroot"
23306 #: ../fish/guestfish-actions.pod:2109
23309 " inspect-get-windows-systemroot root\n"
23314 #: ../fish/guestfish-actions.pod:2123
23315 msgid "inspect-is-live"
23319 #: ../fish/guestfish-actions.pod:2125
23322 " inspect-is-live root\n"
23327 #: ../fish/guestfish-actions.pod:2130
23329 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23330 "then this returns true if a live image was detected on the disk."
23334 #: ../fish/guestfish-actions.pod:2136
23335 msgid "inspect-is-multipart"
23339 #: ../fish/guestfish-actions.pod:2138
23342 " inspect-is-multipart root\n"
23347 #: ../fish/guestfish-actions.pod:2143
23349 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23350 "then this returns true if the disk is part of a set."
23354 #: ../fish/guestfish-actions.pod:2149
23355 msgid "inspect-is-netinst"
23359 #: ../fish/guestfish-actions.pod:2151
23362 " inspect-is-netinst root\n"
23367 #: ../fish/guestfish-actions.pod:2156
23369 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23370 "then this returns true if the disk is a network installer, ie. not a "
23371 "self-contained install CD but one which is likely to require network access "
23372 "to complete the install."
23376 #: ../fish/guestfish-actions.pod:2164
23377 msgid "inspect-list-applications"
23381 #: ../fish/guestfish-actions.pod:2166
23384 " inspect-list-applications root\n"
23389 #: ../fish/guestfish-actions.pod:2173
23391 "I<Note:> This call works differently from other parts of the inspection "
23392 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23393 "then mount up the disks, before calling this. Listing applications is a "
23394 "significantly more difficult operation which requires access to the full "
23395 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23396 "are just returning data cached in the libguestfs handle, this call actually "
23397 "reads parts of the mounted filesystems during the call."
23401 #: ../fish/guestfish-actions.pod:2263
23406 #: ../fish/guestfish-actions.pod:2265
23414 #: ../fish/guestfish-actions.pod:2280
23416 "You can pass the root string(s) returned to other L</inspect-get-*> "
23417 "functions in order to query further information about each operating system, "
23418 "such as the name and version."
23422 #: ../fish/guestfish-actions.pod:2285
23424 "This function uses other libguestfs features such as L</mount-ro> and "
23425 "L</umount-all> in order to mount and unmount filesystems and look at the "
23426 "contents. This should be called with no disks currently mounted. The "
23427 "function may also use Augeas, so any existing Augeas handle will be closed."
23431 #: ../fish/guestfish-actions.pod:2297 ../fish/guestfish-actions.pod:2473 ../fish/guestfish-actions.pod:2519
23432 msgid "See also L</list-filesystems>."
23436 #: ../fish/guestfish-actions.pod:2299
23437 msgid "is-blockdev"
23441 #: ../fish/guestfish-actions.pod:2301
23444 " is-blockdev path\n"
23449 #: ../fish/guestfish-actions.pod:2306 ../fish/guestfish-actions.pod:2324 ../fish/guestfish-actions.pod:2343 ../fish/guestfish-actions.pod:2352 ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2396 ../fish/guestfish-actions.pod:2405
23450 msgid "See also L</stat>."
23454 #: ../fish/guestfish-actions.pod:2308
23459 #: ../fish/guestfish-actions.pod:2310
23467 #: ../fish/guestfish-actions.pod:2317
23472 #: ../fish/guestfish-actions.pod:2319
23475 " is-chardev path\n"
23480 #: ../fish/guestfish-actions.pod:2326
23485 #: ../fish/guestfish-actions.pod:2328
23493 #: ../fish/guestfish-actions.pod:2335
23498 #: ../fish/guestfish-actions.pod:2337
23506 #: ../fish/guestfish-actions.pod:2345
23511 #: ../fish/guestfish-actions.pod:2347
23519 #: ../fish/guestfish-actions.pod:2354
23524 #: ../fish/guestfish-actions.pod:2356
23532 #: ../fish/guestfish-actions.pod:2364
23533 msgid "is-launching"
23537 #: ../fish/guestfish-actions.pod:2366
23545 #: ../fish/guestfish-actions.pod:2373
23550 #: ../fish/guestfish-actions.pod:2375
23558 #: ../fish/guestfish-actions.pod:2380
23563 #: ../fish/guestfish-actions.pod:2382
23571 #: ../fish/guestfish-actions.pod:2389
23576 #: ../fish/guestfish-actions.pod:2391
23579 " is-socket path\n"
23584 #: ../fish/guestfish-actions.pod:2398
23589 #: ../fish/guestfish-actions.pod:2400
23592 " is-symlink path\n"
23597 #: ../fish/guestfish-actions.pod:2407
23598 msgid "kill-subprocess"
23602 #: ../fish/guestfish-actions.pod:2409
23605 " kill-subprocess\n"
23610 #: ../fish/guestfish-actions.pod:2413
23615 #: ../fish/guestfish-actions.pod:2415
23620 #: ../fish/guestfish-actions.pod:2417
23628 #: ../fish/guestfish-actions.pod:2425
23633 #: ../fish/guestfish-actions.pod:2427
23636 " lchown owner group path\n"
23641 #: ../fish/guestfish-actions.pod:2429
23643 "Change the file owner to C<owner> and group to C<group>. This is like "
23644 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
23649 #: ../fish/guestfish-actions.pod:2437
23654 #: ../fish/guestfish-actions.pod:2439
23657 " lgetxattr path name\n"
23662 #: ../fish/guestfish-actions.pod:2455
23663 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
23667 #: ../fish/guestfish-actions.pod:2457
23672 #: ../fish/guestfish-actions.pod:2459
23675 " lgetxattrs path\n"
23680 #: ../fish/guestfish-actions.pod:2461
23682 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
23683 "it returns the extended attributes of the link itself."
23687 #: ../fish/guestfish-actions.pod:2465
23688 msgid "list-devices"
23692 #: ../fish/guestfish-actions.pod:2467
23700 #: ../fish/guestfish-actions.pod:2475
23701 msgid "list-filesystems"
23705 #: ../fish/guestfish-actions.pod:2477
23708 " list-filesystems\n"
23713 #: ../fish/guestfish-actions.pod:2496
23715 "This command runs other libguestfs commands, which might include L</mount> "
23716 "and L</umount>, and therefore you should use this soon after launch and only "
23717 "when nothing is mounted."
23721 #: ../fish/guestfish-actions.pod:2500
23723 "Not all of the filesystems returned will be mountable. In particular, swap "
23724 "partitions are returned in the list. Also this command does not check that "
23725 "each filesystem found is valid and mountable, and some filesystems might be "
23726 "mountable but require special options. Filesystems may not all belong to a "
23727 "single logical operating system (use L</inspect-os> to look for OSes)."
23731 #: ../fish/guestfish-actions.pod:2508
23732 msgid "list-partitions"
23736 #: ../fish/guestfish-actions.pod:2510
23739 " list-partitions\n"
23744 #: ../fish/guestfish-actions.pod:2516
23746 "This does not return logical volumes. For that you will need to call "
23751 #: ../fish/guestfish-actions.pod:2521
23756 #: ../fish/guestfish-actions.pod:2523
23764 #: ../fish/guestfish-actions.pod:2531
23769 #: ../fish/guestfish-actions.pod:2533
23772 " ln target linkname\n"
23777 #: ../fish/guestfish-actions.pod:2537
23782 #: ../fish/guestfish-actions.pod:2539
23785 " ln-f target linkname\n"
23790 #: ../fish/guestfish-actions.pod:2544
23795 #: ../fish/guestfish-actions.pod:2546
23798 " ln-s target linkname\n"
23803 #: ../fish/guestfish-actions.pod:2550
23808 #: ../fish/guestfish-actions.pod:2552
23811 " ln-sf target linkname\n"
23816 #: ../fish/guestfish-actions.pod:2557
23817 msgid "lremovexattr"
23821 #: ../fish/guestfish-actions.pod:2559
23824 " lremovexattr xattr path\n"
23829 #: ../fish/guestfish-actions.pod:2561
23831 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
23832 "it removes an extended attribute of the link itself."
23836 #: ../fish/guestfish-actions.pod:2565
23841 #: ../fish/guestfish-actions.pod:2567
23849 #: ../fish/guestfish-actions.pod:2573
23851 "This command is mostly useful for interactive sessions. Programs should "
23852 "probably use L</readdir> instead."
23856 #: ../fish/guestfish-actions.pod:2576
23861 #: ../fish/guestfish-actions.pod:2578
23864 " lsetxattr xattr val vallen path\n"
23869 #: ../fish/guestfish-actions.pod:2580
23871 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
23872 "sets an extended attribute of the link itself."
23876 #: ../fish/guestfish-actions.pod:2584
23881 #: ../fish/guestfish-actions.pod:2586
23889 #: ../fish/guestfish-actions.pod:2590
23891 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
23892 "the link is stat-ed, not the file it refers to."
23896 #: ../fish/guestfish-actions.pod:2596
23901 #: ../fish/guestfish-actions.pod:2598
23904 " lstatlist path 'names ...'\n"
23909 #: ../fish/guestfish-actions.pod:2600
23911 "This call allows you to perform the L</lstat> operation on multiple files, "
23912 "where all files are in the directory C<path>. C<names> is the list of files "
23913 "from this directory."
23917 #: ../fish/guestfish-actions.pod:2609
23919 "This call is intended for programs that want to efficiently list a directory "
23920 "contents without making many round-trips. See also L</lxattrlist> for a "
23921 "similarly efficient call for getting extended attributes. Very long "
23922 "directory listings might cause the protocol message size to be exceeded, "
23923 "causing this call to fail. The caller must split up such requests into "
23924 "smaller groups of names."
23928 #: ../fish/guestfish-actions.pod:2617
23929 msgid "luks-add-key"
23933 #: ../fish/guestfish-actions.pod:2619
23936 " luks-add-key device keyslot\n"
23941 #: ../fish/guestfish-actions.pod:2626
23943 "Note that if C<keyslot> already contains a key, then this command will "
23944 "fail. You have to use L</luks-kill-slot> first to remove that key."
23948 #: ../fish/guestfish-actions.pod:2630 ../fish/guestfish-actions.pod:2652 ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2679 ../fish/guestfish-actions.pod:2702 ../fish/guestfish-actions.pod:2712
23950 "This command has one or more key or passphrase parameters. Guestfish will "
23951 "prompt for these separately."
23955 #: ../fish/guestfish-actions.pod:2633
23960 #: ../fish/guestfish-actions.pod:2635
23963 " luks-close device\n"
23968 #: ../fish/guestfish-actions.pod:2637
23970 "This closes a LUKS device that was created earlier by L</luks-open> or "
23971 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
23972 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
23973 "underlying block device."
23977 #: ../fish/guestfish-actions.pod:2643
23978 msgid "luks-format"
23982 #: ../fish/guestfish-actions.pod:2645
23985 " luks-format device keyslot\n"
23990 #: ../fish/guestfish-actions.pod:2658
23991 msgid "luks-format-cipher"
23995 #: ../fish/guestfish-actions.pod:2660
23998 " luks-format-cipher device keyslot cipher\n"
24003 #: ../fish/guestfish-actions.pod:2662
24005 "This command is the same as L</luks-format> but it also allows you to set "
24006 "the C<cipher> used."
24010 #: ../fish/guestfish-actions.pod:2671
24011 msgid "luks-kill-slot"
24015 #: ../fish/guestfish-actions.pod:2673
24018 " luks-kill-slot device keyslot\n"
24023 #: ../fish/guestfish-actions.pod:2682
24028 #: ../fish/guestfish-actions.pod:2684
24031 " luks-open device mapname\n"
24036 #: ../fish/guestfish-actions.pod:2698
24038 "If this block device contains LVM volume groups, then calling L</vgscan> "
24039 "followed by L</vg-activate-all> will make them visible."
24043 #: ../fish/guestfish-actions.pod:2705
24044 msgid "luks-open-ro"
24048 #: ../fish/guestfish-actions.pod:2707
24051 " luks-open-ro device mapname\n"
24056 #: ../fish/guestfish-actions.pod:2709
24058 "This is the same as L</luks-open> except that a read-only mapping is "
24063 #: ../fish/guestfish-actions.pod:2715
24068 #: ../fish/guestfish-actions.pod:2717
24071 " lvcreate logvol volgroup mbytes\n"
24076 #: ../fish/guestfish-actions.pod:2722
24077 msgid "lvm-canonical-lv-name"
24081 #: ../fish/guestfish-actions.pod:2724
24084 " lvm-canonical-lv-name lvname\n"
24089 #: ../fish/guestfish-actions.pod:2733
24090 msgid "See also L</is-lv>."
24094 #: ../fish/guestfish-actions.pod:2735
24095 msgid "lvm-clear-filter"
24099 #: ../fish/guestfish-actions.pod:2737
24102 " lvm-clear-filter\n"
24107 #: ../fish/guestfish-actions.pod:2739
24109 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24114 #: ../fish/guestfish-actions.pod:2745
24115 msgid "lvm-remove-all"
24119 #: ../fish/guestfish-actions.pod:2747
24122 " lvm-remove-all\n"
24127 #: ../fish/guestfish-actions.pod:2755
24128 msgid "lvm-set-filter"
24132 #: ../fish/guestfish-actions.pod:2757
24135 " lvm-set-filter 'devices ...'\n"
24140 #: ../fish/guestfish-actions.pod:2782
24145 #: ../fish/guestfish-actions.pod:2784
24148 " lvremove device\n"
24153 #: ../fish/guestfish-actions.pod:2792
24158 #: ../fish/guestfish-actions.pod:2794
24161 " lvrename logvol newlogvol\n"
24166 #: ../fish/guestfish-actions.pod:2798
24171 #: ../fish/guestfish-actions.pod:2800
24174 " lvresize device mbytes\n"
24179 #: ../fish/guestfish-actions.pod:2806
24180 msgid "lvresize-free"
24184 #: ../fish/guestfish-actions.pod:2808
24187 " lvresize-free lv percent\n"
24192 #: ../fish/guestfish-actions.pod:2816
24197 #: ../fish/guestfish-actions.pod:2818
24205 #: ../fish/guestfish-actions.pod:2826
24206 msgid "See also L</lvs-full>, L</list-filesystems>."
24210 #: ../fish/guestfish-actions.pod:2828
24215 #: ../fish/guestfish-actions.pod:2830
24223 #: ../fish/guestfish-actions.pod:2835
24228 #: ../fish/guestfish-actions.pod:2837
24236 #: ../fish/guestfish-actions.pod:2841
24241 #: ../fish/guestfish-actions.pod:2843
24244 " lxattrlist path 'names ...'\n"
24249 #: ../fish/guestfish-actions.pod:2859
24251 "This call is intended for programs that want to efficiently list a directory "
24252 "contents without making many round-trips. See also L</lstatlist> for a "
24253 "similarly efficient call for getting standard stats. Very long directory "
24254 "listings might cause the protocol message size to be exceeded, causing this "
24255 "call to fail. The caller must split up such requests into smaller groups of "
24260 #: ../fish/guestfish-actions.pod:2867
24265 #: ../fish/guestfish-actions.pod:2869
24273 #: ../fish/guestfish-actions.pod:2873
24278 #: ../fish/guestfish-actions.pod:2875
24281 " mkdir-mode path mode\n"
24286 #: ../fish/guestfish-actions.pod:2884
24287 msgid "See also L</mkdir>, L</umask>"
24291 #: ../fish/guestfish-actions.pod:2886
24296 #: ../fish/guestfish-actions.pod:2888
24304 #: ../fish/guestfish-actions.pod:2893
24309 #: ../fish/guestfish-actions.pod:2895
24312 " mkdtemp template\n"
24317 #: ../fish/guestfish-actions.pod:2916
24322 #: ../fish/guestfish-actions.pod:2918
24325 " mke2fs-J fstype blocksize device journal\n"
24330 #: ../fish/guestfish-actions.pod:2926
24331 msgid "See also L</mke2journal>."
24335 #: ../fish/guestfish-actions.pod:2928
24340 #: ../fish/guestfish-actions.pod:2930
24343 " mke2fs-JL fstype blocksize device label\n"
24348 #: ../fish/guestfish-actions.pod:2935
24349 msgid "See also L</mke2journal-L>."
24353 #: ../fish/guestfish-actions.pod:2937
24358 #: ../fish/guestfish-actions.pod:2939
24361 " mke2fs-JU fstype blocksize device uuid\n"
24366 #: ../fish/guestfish-actions.pod:2944
24367 msgid "See also L</mke2journal-U>."
24371 #: ../fish/guestfish-actions.pod:2946
24372 msgid "mke2journal"
24376 #: ../fish/guestfish-actions.pod:2948
24379 " mke2journal blocksize device\n"
24384 #: ../fish/guestfish-actions.pod:2955
24385 msgid "mke2journal-L"
24389 #: ../fish/guestfish-actions.pod:2957
24392 " mke2journal-L blocksize label device\n"
24397 #: ../fish/guestfish-actions.pod:2961
24398 msgid "mke2journal-U"
24402 #: ../fish/guestfish-actions.pod:2963
24405 " mke2journal-U blocksize uuid device\n"
24410 #: ../fish/guestfish-actions.pod:2967
24415 #: ../fish/guestfish-actions.pod:2969
24418 " mkfifo mode path\n"
24423 #: ../fish/guestfish-actions.pod:2971
24425 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
24426 "is just a convenient wrapper around L</mknod>."
24430 #: ../fish/guestfish-actions.pod:2977
24435 #: ../fish/guestfish-actions.pod:2979
24438 " mkfs fstype device\n"
24443 #: ../fish/guestfish-actions.pod:2985
24448 #: ../fish/guestfish-actions.pod:2987
24451 " mkfs-b fstype blocksize device\n"
24456 #: ../fish/guestfish-actions.pod:2989
24458 "This call is similar to L</mkfs>, but it allows you to control the block "
24459 "size of the resulting filesystem. Supported block sizes depend on the "
24460 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
24464 #: ../fish/guestfish-actions.pod:3004
24469 #: ../fish/guestfish-actions.pod:3006
24472 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
24477 #: ../fish/guestfish-actions.pod:3041
24478 msgid "mkmountpoint"
24482 #: ../fish/guestfish-actions.pod:3043
24485 " mkmountpoint exemptpath\n"
24490 #: ../fish/guestfish-actions.pod:3045
24492 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
24493 "to create extra mountpoints before mounting the first filesystem."
24497 #: ../fish/guestfish-actions.pod:3069
24499 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
24500 "unexpected errors if you try to mix these calls. It is safest to manually "
24501 "unmount filesystems and remove mountpoints after use."
24505 #: ../fish/guestfish-actions.pod:3073
24507 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
24508 "for this to work for manual mountpoints, you must ensure that the innermost "
24509 "mountpoints have the longest pathnames, as in the example code above."
24513 #: ../fish/guestfish-actions.pod:3080
24515 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
24516 "L</umount-all> to be called when the handle is closed which can also trigger "
24521 #: ../fish/guestfish-actions.pod:3084
24526 #: ../fish/guestfish-actions.pod:3086
24529 " mknod mode devmajor devminor path\n"
24534 #: ../fish/guestfish-actions.pod:3096
24536 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
24537 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
24538 "regular file). These constants are available in the standard Linux header "
24539 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
24540 "wrappers around this command which bitwise OR in the appropriate constant "
24545 #: ../fish/guestfish-actions.pod:3106
24550 #: ../fish/guestfish-actions.pod:3108
24553 " mknod-b mode devmajor devminor path\n"
24558 #: ../fish/guestfish-actions.pod:3110
24560 "This call creates a block device node called C<path> with mode C<mode> and "
24561 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24562 "wrapper around L</mknod>."
24566 #: ../fish/guestfish-actions.pod:3116
24571 #: ../fish/guestfish-actions.pod:3118
24574 " mknod-c mode devmajor devminor path\n"
24579 #: ../fish/guestfish-actions.pod:3120
24581 "This call creates a char device node called C<path> with mode C<mode> and "
24582 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24583 "wrapper around L</mknod>."
24587 #: ../fish/guestfish-actions.pod:3126
24592 #: ../fish/guestfish-actions.pod:3128
24600 #: ../fish/guestfish-actions.pod:3132
24605 #: ../fish/guestfish-actions.pod:3134
24608 " mkswap-L label device\n"
24613 #: ../fish/guestfish-actions.pod:3142
24618 #: ../fish/guestfish-actions.pod:3144
24621 " mkswap-U uuid device\n"
24626 #: ../fish/guestfish-actions.pod:3148
24627 msgid "mkswap-file"
24631 #: ../fish/guestfish-actions.pod:3150
24634 " mkswap-file path\n"
24639 #: ../fish/guestfish-actions.pod:3154
24641 "This command just writes a swap file signature to an existing file. To "
24642 "create the file itself, use something like L</fallocate>."
24646 #: ../fish/guestfish-actions.pod:3157
24651 #: ../fish/guestfish-actions.pod:3159
24654 " modprobe modulename\n"
24659 #: ../fish/guestfish-actions.pod:3166
24664 #: ../fish/guestfish-actions.pod:3168
24667 " mount device mountpoint\n"
24672 #: ../fish/guestfish-actions.pod:3184
24674 "B<Important note:> When you use this call, the filesystem options C<sync> "
24675 "and C<noatime> are set implicitly. This was originally done because we "
24676 "thought it would improve reliability, but it turns out that I<-o sync> has a "
24677 "very large negative performance impact and negligible effect on "
24678 "reliability. Therefore we recommend that you avoid using L</mount> in any "
24679 "code that needs performance, and instead use L</mount-options> (use an empty "
24680 "string for the first parameter if you don't want any options)."
24684 #: ../fish/guestfish-actions.pod:3194
24689 #: ../fish/guestfish-actions.pod:3196
24692 " mount-loop file mountpoint\n"
24697 #: ../fish/guestfish-actions.pod:3202
24698 msgid "mount-options"
24702 #: ../fish/guestfish-actions.pod:3204
24705 " mount-options options device mountpoint\n"
24710 #: ../fish/guestfish-actions.pod:3206
24712 "This is the same as the L</mount> command, but it allows you to set the "
24713 "mount options as for the L<mount(8)> I<-o> flag."
24717 #: ../fish/guestfish-actions.pod:3214
24722 #: ../fish/guestfish-actions.pod:3216
24725 " mount-ro device mountpoint\n"
24730 #: ../fish/guestfish-actions.pod:3218
24732 "This is the same as the L</mount> command, but it mounts the filesystem with "
24733 "the read-only (I<-o ro>) flag."
24737 #: ../fish/guestfish-actions.pod:3221
24742 #: ../fish/guestfish-actions.pod:3223
24745 " mount-vfs options vfstype device mountpoint\n"
24750 #: ../fish/guestfish-actions.pod:3225
24752 "This is the same as the L</mount> command, but it allows you to set both the "
24753 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
24757 #: ../fish/guestfish-actions.pod:3229
24758 msgid "mountpoints"
24762 #: ../fish/guestfish-actions.pod:3231
24770 #: ../fish/guestfish-actions.pod:3233
24772 "This call is similar to L</mounts>. That call returns a list of devices. "
24773 "This one returns a hash table (map) of device name to directory where the "
24774 "device is mounted."
24778 #: ../fish/guestfish-actions.pod:3237
24783 #: ../fish/guestfish-actions.pod:3239
24791 #: ../fish/guestfish-actions.pod:3246
24792 msgid "See also: L</mountpoints>"
24796 #: ../fish/guestfish-actions.pod:3248
24801 #: ../fish/guestfish-actions.pod:3250
24809 #: ../fish/guestfish-actions.pod:3255
24810 msgid "ntfs-3g-probe"
24814 #: ../fish/guestfish-actions.pod:3257
24817 " ntfs-3g-probe true|false device\n"
24822 #: ../fish/guestfish-actions.pod:3271
24827 #: ../fish/guestfish-actions.pod:3273
24830 " ntfsresize device\n"
24835 #: ../fish/guestfish-actions.pod:3279
24836 msgid "ntfsresize-size"
24840 #: ../fish/guestfish-actions.pod:3281
24843 " ntfsresize-size device size\n"
24848 #: ../fish/guestfish-actions.pod:3283
24850 "This command is the same as L</ntfsresize> except that it allows you to "
24851 "specify the new size (in bytes) explicitly."
24855 #: ../fish/guestfish-actions.pod:3286
24860 #: ../fish/guestfish-actions.pod:3288
24863 " part-add device prlogex startsect endsect\n"
24868 #: ../fish/guestfish-actions.pod:3290
24870 "This command adds a partition to C<device>. If there is no partition table "
24871 "on the device, call L</part-init> first."
24875 #: ../fish/guestfish-actions.pod:3302
24877 "Creating a partition which covers the whole disk is not so easy. Use "
24878 "L</part-disk> to do that."
24882 #: ../fish/guestfish-actions.pod:3305
24887 #: ../fish/guestfish-actions.pod:3307
24890 " part-del device partnum\n"
24895 #: ../fish/guestfish-actions.pod:3315
24900 #: ../fish/guestfish-actions.pod:3317
24903 " part-disk device parttype\n"
24908 #: ../fish/guestfish-actions.pod:3319
24910 "This command is simply a combination of L</part-init> followed by "
24911 "L</part-add> to create a single primary partition covering the whole disk."
24915 #: ../fish/guestfish-actions.pod:3323
24917 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
24918 "possible values are described in L</part-init>."
24922 #: ../fish/guestfish-actions.pod:3329
24923 msgid "part-get-bootable"
24927 #: ../fish/guestfish-actions.pod:3331
24930 " part-get-bootable device partnum\n"
24935 #: ../fish/guestfish-actions.pod:3336
24936 msgid "See also L</part-set-bootable>."
24940 #: ../fish/guestfish-actions.pod:3338
24941 msgid "part-get-mbr-id"
24945 #: ../fish/guestfish-actions.pod:3340
24948 " part-get-mbr-id device partnum\n"
24953 #: ../fish/guestfish-actions.pod:3345 ../fish/guestfish-actions.pod:3483
24955 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
24956 "undefined results for other partition table types (see "
24957 "L</part-get-parttype>)."
24961 #: ../fish/guestfish-actions.pod:3349
24962 msgid "part-get-parttype"
24966 #: ../fish/guestfish-actions.pod:3351
24969 " part-get-parttype device\n"
24974 #: ../fish/guestfish-actions.pod:3356
24976 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
24977 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
24978 "possible, although unusual. See L</part-init> for a full list."
24982 #: ../fish/guestfish-actions.pod:3361
24987 #: ../fish/guestfish-actions.pod:3363
24990 " part-init device parttype\n"
24995 #: ../fish/guestfish-actions.pod:3369
24997 "Initially there are no partitions. Following this, you should call "
24998 "L</part-add> for each partition required."
25002 #: ../fish/guestfish-actions.pod:3432
25007 #: ../fish/guestfish-actions.pod:3434
25010 " part-list device\n"
25015 #: ../fish/guestfish-actions.pod:3449
25017 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25018 "the device's sector size, see L</blockdev-getss>."
25022 #: ../fish/guestfish-actions.pod:3462
25023 msgid "part-set-bootable"
25027 #: ../fish/guestfish-actions.pod:3464
25030 " part-set-bootable device partnum true|false\n"
25035 #: ../fish/guestfish-actions.pod:3473
25036 msgid "part-set-mbr-id"
25040 #: ../fish/guestfish-actions.pod:3475
25043 " part-set-mbr-id device partnum idbyte\n"
25048 #: ../fish/guestfish-actions.pod:3487
25049 msgid "part-set-name"
25053 #: ../fish/guestfish-actions.pod:3489
25056 " part-set-name device partnum name\n"
25061 #: ../fish/guestfish-actions.pod:3497
25062 msgid "part-to-dev"
25066 #: ../fish/guestfish-actions.pod:3499
25069 " part-to-dev partition\n"
25074 #: ../fish/guestfish-actions.pod:3505
25076 "The named partition must exist, for example as a string returned from "
25077 "L</list-partitions>."
25081 #: ../fish/guestfish-actions.pod:3508
25082 msgid "ping-daemon"
25086 #: ../fish/guestfish-actions.pod:3510
25094 #: ../fish/guestfish-actions.pod:3517
25099 #: ../fish/guestfish-actions.pod:3519
25102 " pread path count offset\n"
25107 #: ../fish/guestfish-actions.pod:3527
25108 msgid "See also L</pwrite>, L</pread-device>."
25112 #: ../fish/guestfish-actions.pod:3532
25113 msgid "pread-device"
25117 #: ../fish/guestfish-actions.pod:3534
25120 " pread-device device count offset\n"
25125 #: ../fish/guestfish-actions.pod:3542
25126 msgid "See also L</pread>."
25130 #: ../fish/guestfish-actions.pod:3547
25135 #: ../fish/guestfish-actions.pod:3549
25138 " pvcreate device\n"
25143 #: ../fish/guestfish-actions.pod:3555
25148 #: ../fish/guestfish-actions.pod:3557
25151 " pvremove device\n"
25156 #: ../fish/guestfish-actions.pod:3566
25161 #: ../fish/guestfish-actions.pod:3568
25164 " pvresize device\n"
25169 #: ../fish/guestfish-actions.pod:3573
25170 msgid "pvresize-size"
25174 #: ../fish/guestfish-actions.pod:3575
25177 " pvresize-size device size\n"
25182 #: ../fish/guestfish-actions.pod:3577
25184 "This command is the same as L</pvresize> except that it allows you to "
25185 "specify the new size (in bytes) explicitly."
25189 #: ../fish/guestfish-actions.pod:3580
25194 #: ../fish/guestfish-actions.pod:3582
25202 #: ../fish/guestfish-actions.pod:3590
25203 msgid "See also L</pvs-full>."
25207 #: ../fish/guestfish-actions.pod:3592
25212 #: ../fish/guestfish-actions.pod:3594
25220 #: ../fish/guestfish-actions.pod:3599
25225 #: ../fish/guestfish-actions.pod:3601
25233 #: ../fish/guestfish-actions.pod:3605
25238 #: ../fish/guestfish-actions.pod:3607
25241 " pwrite path content offset\n"
25246 #: ../fish/guestfish-actions.pod:3618
25247 msgid "See also L</pread>, L</pwrite-device>."
25251 #: ../fish/guestfish-actions.pod:3623
25252 msgid "pwrite-device"
25256 #: ../fish/guestfish-actions.pod:3625
25259 " pwrite-device device content offset\n"
25264 #: ../fish/guestfish-actions.pod:3635
25265 msgid "See also L</pwrite>."
25269 #: ../fish/guestfish-actions.pod:3640
25274 #: ../fish/guestfish-actions.pod:3642
25277 " read-file path\n"
25282 #: ../fish/guestfish-actions.pod:3647
25284 "Unlike L</cat>, this function can correctly handle files that contain "
25285 "embedded ASCII NUL characters. However unlike L</download>, this function "
25286 "is limited in the total size of file that can be handled."
25290 #: ../fish/guestfish-actions.pod:3655
25295 #: ../fish/guestfish-actions.pod:3657
25298 " read-lines path\n"
25303 #: ../fish/guestfish-actions.pod:3664
25305 "Note that this function cannot correctly handle binary files (specifically, "
25306 "files containing C<\\0> character which is treated as end of line). For "
25307 "those you need to use the L</read-file> function which has a more complex "
25312 #: ../fish/guestfish-actions.pod:3669
25317 #: ../fish/guestfish-actions.pod:3671
25325 #: ../fish/guestfish-actions.pod:3723
25327 "This function is primarily intended for use by programs. To get a simple "
25328 "list of names, use L</ls>. To get a printable directory for human "
25329 "consumption, use L</ll>."
25333 #: ../fish/guestfish-actions.pod:3727
25338 #: ../fish/guestfish-actions.pod:3729
25346 #: ../fish/guestfish-actions.pod:3733
25347 msgid "readlinklist"
25351 #: ../fish/guestfish-actions.pod:3735
25354 " readlinklist path 'names ...'\n"
25359 #: ../fish/guestfish-actions.pod:3759
25364 #: ../fish/guestfish-actions.pod:3761
25372 #: ../fish/guestfish-actions.pod:3766
25373 msgid "removexattr"
25377 #: ../fish/guestfish-actions.pod:3768
25380 " removexattr xattr path\n"
25385 #: ../fish/guestfish-actions.pod:3773
25386 msgid "See also: L</lremovexattr>, L<attr(5)>."
25390 #: ../fish/guestfish-actions.pod:3775
25395 #: ../fish/guestfish-actions.pod:3777
25398 " resize2fs device\n"
25403 #: ../fish/guestfish-actions.pod:3782
25405 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
25406 "before calling this command. For unknown reasons C<resize2fs> sometimes "
25407 "gives an error about this and sometimes not. In any case, it is always safe "
25408 "to call L</e2fsck-f> before calling this function."
25412 #: ../fish/guestfish-actions.pod:3788
25413 msgid "resize2fs-M"
25417 #: ../fish/guestfish-actions.pod:3790
25420 " resize2fs-M device\n"
25425 #: ../fish/guestfish-actions.pod:3792
25427 "This command is the same as L</resize2fs>, but the filesystem is resized to "
25428 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
25433 #: ../fish/guestfish-actions.pod:3796
25435 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
25436 "and read the C<Block size> and C<Block count> values. These two numbers, "
25437 "multiplied together, give the resulting size of the minimal filesystem in "
25442 #: ../fish/guestfish-actions.pod:3801
25443 msgid "resize2fs-size"
25447 #: ../fish/guestfish-actions.pod:3803
25450 " resize2fs-size device size\n"
25455 #: ../fish/guestfish-actions.pod:3805
25457 "This command is the same as L</resize2fs> except that it allows you to "
25458 "specify the new size (in bytes) explicitly."
25462 #: ../fish/guestfish-actions.pod:3808
25467 #: ../fish/guestfish-actions.pod:3810
25475 #: ../fish/guestfish-actions.pod:3814
25480 #: ../fish/guestfish-actions.pod:3816
25488 #: ../fish/guestfish-actions.pod:3822
25493 #: ../fish/guestfish-actions.pod:3824
25501 #: ../fish/guestfish-actions.pod:3828
25502 msgid "rmmountpoint"
25506 #: ../fish/guestfish-actions.pod:3830
25509 " rmmountpoint exemptpath\n"
25514 #: ../fish/guestfish-actions.pod:3832
25516 "This calls removes a mountpoint that was previously created with "
25517 "L</mkmountpoint>. See L</mkmountpoint> for full details."
25521 #: ../fish/guestfish-actions.pod:3836
25522 msgid "scrub-device"
25526 #: ../fish/guestfish-actions.pod:3838
25529 " scrub-device device\n"
25534 #: ../fish/guestfish-actions.pod:3849
25539 #: ../fish/guestfish-actions.pod:3851
25542 " scrub-file file\n"
25547 #: ../fish/guestfish-actions.pod:3861
25548 msgid "scrub-freespace"
25552 #: ../fish/guestfish-actions.pod:3863
25555 " scrub-freespace dir\n"
25560 #: ../fish/guestfish-actions.pod:3865
25562 "This command creates the directory C<dir> and then fills it with files until "
25563 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
25564 "deletes them. The intention is to scrub any free space on the partition "
25565 "containing C<dir>."
25569 #: ../fish/guestfish-actions.pod:3874
25574 #: ../fish/guestfish-actions.pod:3876
25579 #: ../fish/guestfish-actions.pod:3878
25582 " set-append append\n"
25587 #: ../fish/guestfish-actions.pod:3889
25588 msgid "set-attach-method"
25592 #: ../fish/guestfish-actions.pod:3891
25593 msgid "attach-method"
25597 #: ../fish/guestfish-actions.pod:3893
25600 " set-attach-method attachmethod\n"
25605 #: ../fish/guestfish-actions.pod:3915
25606 msgid "set-autosync"
25610 #: ../fish/guestfish-actions.pod:3917
25615 #: ../fish/guestfish-actions.pod:3919
25618 " set-autosync true|false\n"
25623 #: ../fish/guestfish-actions.pod:3929
25628 #: ../fish/guestfish-actions.pod:3931
25633 #: ../fish/guestfish-actions.pod:3933
25636 " set-direct true|false\n"
25641 #: ../fish/guestfish-actions.pod:3939
25643 "One consequence of this is that log messages aren't caught by the library "
25644 "and handled by L</set-log-message-callback>, but go straight to stdout."
25648 #: ../fish/guestfish-actions.pod:3948
25649 msgid "set-e2label"
25653 #: ../fish/guestfish-actions.pod:3950
25656 " set-e2label device label\n"
25661 #: ../fish/guestfish-actions.pod:3956
25663 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
25664 "label on a filesystem."
25668 #: ../fish/guestfish-actions.pod:3959
25673 #: ../fish/guestfish-actions.pod:3961
25676 " set-e2uuid device uuid\n"
25681 #: ../fish/guestfish-actions.pod:3968
25683 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
25684 "UUID of a filesystem."
25688 #: ../fish/guestfish-actions.pod:3971
25689 msgid "set-memsize"
25693 #: ../fish/guestfish-actions.pod:3973
25698 #: ../fish/guestfish-actions.pod:3975
25701 " set-memsize memsize\n"
25706 #: ../fish/guestfish-actions.pod:3977
25708 "This sets the memory size in megabytes allocated to the qemu subprocess. "
25709 "This only has any effect if called before L</launch>."
25713 #: ../fish/guestfish-actions.pod:3988
25714 msgid "set-network"
25718 #: ../fish/guestfish-actions.pod:3990
25723 #: ../fish/guestfish-actions.pod:3992
25726 " set-network true|false\n"
25731 #: ../fish/guestfish-actions.pod:4000
25732 msgid "You must call this before calling L</launch>, otherwise it has no effect."
25736 #: ../fish/guestfish-actions.pod:4003
25741 #: ../fish/guestfish-actions.pod:4005
25746 #: ../fish/guestfish-actions.pod:4007
25749 " set-path searchpath\n"
25754 #: ../fish/guestfish-actions.pod:4016
25759 #: ../fish/guestfish-actions.pod:4018
25764 #: ../fish/guestfish-actions.pod:4020
25772 #: ../fish/guestfish-actions.pod:4040
25773 msgid "set-recovery-proc"
25777 #: ../fish/guestfish-actions.pod:4042
25778 msgid "recovery-proc"
25782 #: ../fish/guestfish-actions.pod:4044
25785 " set-recovery-proc true|false\n"
25790 #: ../fish/guestfish-actions.pod:4046
25792 "If this is called with the parameter C<false> then L</launch> does not "
25793 "create a recovery process. The purpose of the recovery process is to stop "
25794 "runaway qemu processes in the case where the main program aborts abruptly."
25798 #: ../fish/guestfish-actions.pod:4051
25800 "This only has any effect if called before L</launch>, and the default is "
25805 #: ../fish/guestfish-actions.pod:4060
25806 msgid "set-selinux"
25810 #: ../fish/guestfish-actions.pod:4062
25815 #: ../fish/guestfish-actions.pod:4064
25818 " set-selinux true|false\n"
25823 #: ../fish/guestfish-actions.pod:4075
25828 #: ../fish/guestfish-actions.pod:4077
25833 #: ../fish/guestfish-actions.pod:4079
25836 " set-trace true|false\n"
25841 #: ../fish/guestfish-actions.pod:4091
25843 "Trace messages are normally sent to C<stderr>, unless you register a "
25844 "callback to send them somewhere else (see L</set-event-callback>)."
25848 #: ../fish/guestfish-actions.pod:4095
25849 msgid "set-verbose"
25853 #: ../fish/guestfish-actions.pod:4097
25858 #: ../fish/guestfish-actions.pod:4099
25861 " set-verbose true|false\n"
25866 #: ../fish/guestfish-actions.pod:4106
25868 "Verbose messages are normally sent to C<stderr>, unless you register a "
25869 "callback to send them somewhere else (see L</set-event-callback>)."
25873 #: ../fish/guestfish-actions.pod:4110
25878 #: ../fish/guestfish-actions.pod:4112
25881 " setcon context\n"
25886 #: ../fish/guestfish-actions.pod:4119
25891 #: ../fish/guestfish-actions.pod:4121
25894 " setxattr xattr val vallen path\n"
25899 #: ../fish/guestfish-actions.pod:4127
25900 msgid "See also: L</lsetxattr>, L<attr(5)>."
25904 #: ../fish/guestfish-actions.pod:4129
25909 #: ../fish/guestfish-actions.pod:4131
25912 " sfdisk device cyls heads sectors 'lines ...'\n"
25917 #: ../fish/guestfish-actions.pod:4153
25918 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
25922 #: ../fish/guestfish-actions.pod:4159
25927 #: ../fish/guestfish-actions.pod:4161
25930 " sfdiskM device 'lines ...'\n"
25935 #: ../fish/guestfish-actions.pod:4163
25937 "This is a simplified interface to the L</sfdisk> command, where partition "
25938 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
25939 "you don't need to specify the cyls, heads and sectors parameters which were "
25940 "rarely if ever used anyway."
25944 #: ../fish/guestfish-actions.pod:4169
25945 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
25949 #: ../fish/guestfish-actions.pod:4175
25954 #: ../fish/guestfish-actions.pod:4177
25957 " sfdisk-N device partnum cyls heads sectors line\n"
25962 #: ../fish/guestfish-actions.pod:4182
25964 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
25965 "cyls/heads/sectors parameters."
25969 #: ../fish/guestfish-actions.pod:4185
25970 msgid "See also: L</part-add>"
25974 #: ../fish/guestfish-actions.pod:4190
25975 msgid "sfdisk-disk-geometry"
25979 #: ../fish/guestfish-actions.pod:4192
25982 " sfdisk-disk-geometry device\n"
25987 #: ../fish/guestfish-actions.pod:4194
25989 "This displays the disk geometry of C<device> read from the partition table. "
25990 "Especially in the case where the underlying block device has been resized, "
25991 "this can be different from the kernel's idea of the geometry (see "
25992 "L</sfdisk-kernel-geometry>)."
25996 #: ../fish/guestfish-actions.pod:4202
25997 msgid "sfdisk-kernel-geometry"
26001 #: ../fish/guestfish-actions.pod:4204
26004 " sfdisk-kernel-geometry device\n"
26009 #: ../fish/guestfish-actions.pod:4211
26014 #: ../fish/guestfish-actions.pod:4213
26017 " sfdisk-l device\n"
26022 #: ../fish/guestfish-actions.pod:4219
26023 msgid "See also: L</part-list>"
26027 #: ../fish/guestfish-actions.pod:4221
26032 #: ../fish/guestfish-actions.pod:4223
26040 #: ../fish/guestfish-actions.pod:4228
26041 msgid "This is like L</command>, but passes the command to:"
26045 #: ../fish/guestfish-actions.pod:4236
26046 msgid "All the provisos about L</command> apply to this call."
26050 #: ../fish/guestfish-actions.pod:4238
26055 #: ../fish/guestfish-actions.pod:4240
26058 " sh-lines command\n"
26063 #: ../fish/guestfish-actions.pod:4242
26064 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26068 #: ../fish/guestfish-actions.pod:4245
26069 msgid "See also: L</command-lines>"
26073 #: ../fish/guestfish-actions.pod:4247
26078 #: ../fish/guestfish-actions.pod:4249
26086 #: ../fish/guestfish-actions.pod:4253
26091 #: ../fish/guestfish-actions.pod:4255
26099 #: ../fish/guestfish-actions.pod:4261
26104 #: ../fish/guestfish-actions.pod:4263
26112 #: ../fish/guestfish-actions.pod:4271
26117 #: ../fish/guestfish-actions.pod:4273
26125 #: ../fish/guestfish-actions.pod:4281
26130 #: ../fish/guestfish-actions.pod:4283
26133 " strings-e encoding path\n"
26138 #: ../fish/guestfish-actions.pod:4285
26140 "This is like the L</strings> command, but allows you to specify the encoding "
26141 "of strings that are looked for in the source file C<path>."
26145 #: ../fish/guestfish-actions.pod:4295
26147 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26148 "ISO-8859-X (this is what L</strings> uses)."
26152 #: ../fish/guestfish-actions.pod:4327
26153 msgid "swapoff-device"
26157 #: ../fish/guestfish-actions.pod:4329
26160 " swapoff-device device\n"
26165 #: ../fish/guestfish-actions.pod:4331
26167 "This command disables the libguestfs appliance swap device or partition "
26168 "named C<device>. See L</swapon-device>."
26172 #: ../fish/guestfish-actions.pod:4335
26173 msgid "swapoff-file"
26177 #: ../fish/guestfish-actions.pod:4337
26180 " swapoff-file file\n"
26185 #: ../fish/guestfish-actions.pod:4341
26186 msgid "swapoff-label"
26190 #: ../fish/guestfish-actions.pod:4343
26193 " swapoff-label label\n"
26198 #: ../fish/guestfish-actions.pod:4348
26199 msgid "swapoff-uuid"
26203 #: ../fish/guestfish-actions.pod:4350
26206 " swapoff-uuid uuid\n"
26211 #: ../fish/guestfish-actions.pod:4355
26212 msgid "swapon-device"
26216 #: ../fish/guestfish-actions.pod:4357
26219 " swapon-device device\n"
26224 #: ../fish/guestfish-actions.pod:4359
26226 "This command enables the libguestfs appliance to use the swap device or "
26227 "partition named C<device>. The increased memory is made available for all "
26228 "commands, for example those run using L</command> or L</sh>."
26232 #: ../fish/guestfish-actions.pod:4371
26233 msgid "swapon-file"
26237 #: ../fish/guestfish-actions.pod:4373
26240 " swapon-file file\n"
26245 #: ../fish/guestfish-actions.pod:4375
26246 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26250 #: ../fish/guestfish-actions.pod:4378
26251 msgid "swapon-label"
26255 #: ../fish/guestfish-actions.pod:4380
26258 " swapon-label label\n"
26263 #: ../fish/guestfish-actions.pod:4382
26265 "This command enables swap to a labeled swap partition. See "
26266 "L</swapon-device> for other notes."
26270 #: ../fish/guestfish-actions.pod:4385
26271 msgid "swapon-uuid"
26275 #: ../fish/guestfish-actions.pod:4387
26278 " swapon-uuid uuid\n"
26283 #: ../fish/guestfish-actions.pod:4389
26285 "This command enables swap to a swap partition with the given UUID. See "
26286 "L</swapon-device> for other notes."
26290 #: ../fish/guestfish-actions.pod:4392
26295 #: ../fish/guestfish-actions.pod:4394
26303 #: ../fish/guestfish-actions.pod:4402
26308 #: ../fish/guestfish-actions.pod:4404
26316 #: ../fish/guestfish-actions.pod:4412
26321 #: ../fish/guestfish-actions.pod:4414
26324 " tail-n nrlines path\n"
26329 #: ../fish/guestfish-actions.pod:4427
26334 #: ../fish/guestfish-actions.pod:4429
26337 " tar-in (tarfile|-) directory\n"
26342 #: ../fish/guestfish-actions.pod:4434
26343 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26347 #: ../fish/guestfish-actions.pod:4439
26352 #: ../fish/guestfish-actions.pod:4441
26355 " tar-out directory (tarfile|-)\n"
26360 #: ../fish/guestfish-actions.pod:4446
26361 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26365 #: ../fish/guestfish-actions.pod:4451
26370 #: ../fish/guestfish-actions.pod:4453
26373 " tgz-in (tarball|-) directory\n"
26378 #: ../fish/guestfish-actions.pod:4458
26379 msgid "To upload an uncompressed tarball, use L</tar-in>."
26383 #: ../fish/guestfish-actions.pod:4462
26388 #: ../fish/guestfish-actions.pod:4464
26391 " tgz-out directory (tarball|-)\n"
26396 #: ../fish/guestfish-actions.pod:4469
26397 msgid "To download an uncompressed tarball, use L</tar-out>."
26401 #: ../fish/guestfish-actions.pod:4473
26406 #: ../fish/guestfish-actions.pod:4475
26414 #: ../fish/guestfish-actions.pod:4484
26419 #: ../fish/guestfish-actions.pod:4486
26427 #: ../fish/guestfish-actions.pod:4491
26428 msgid "truncate-size"
26432 #: ../fish/guestfish-actions.pod:4493
26435 " truncate-size path size\n"
26440 #: ../fish/guestfish-actions.pod:4498
26442 "If the current file size is less than C<size> then the file is extended to "
26443 "the required size with zero bytes. This creates a sparse file (ie. disk "
26444 "blocks are not allocated for the file until you write to it). To create a "
26445 "non-sparse file of zeroes, use L</fallocate64> instead."
26449 #: ../fish/guestfish-actions.pod:4504
26454 #: ../fish/guestfish-actions.pod:4506
26457 " tune2fs-l device\n"
26462 #: ../fish/guestfish-actions.pod:4516
26467 #: ../fish/guestfish-actions.pod:4518
26470 " txz-in (tarball|-) directory\n"
26475 #: ../fish/guestfish-actions.pod:4525
26480 #: ../fish/guestfish-actions.pod:4527
26483 " txz-out directory (tarball|-)\n"
26488 #: ../fish/guestfish-actions.pod:4534
26493 #: ../fish/guestfish-actions.pod:4536
26501 #: ../fish/guestfish-actions.pod:4550
26502 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
26506 #: ../fish/guestfish-actions.pod:4555
26511 #: ../fish/guestfish-actions.pod:4557
26516 #: ../fish/guestfish-actions.pod:4559
26519 " umount pathordevice\n"
26524 #: ../fish/guestfish-actions.pod:4565
26529 #: ../fish/guestfish-actions.pod:4567
26530 msgid "unmount-all"
26534 #: ../fish/guestfish-actions.pod:4569
26542 #: ../fish/guestfish-actions.pod:4575
26547 #: ../fish/guestfish-actions.pod:4577
26550 " upload (filename|-) remotefilename\n"
26555 #: ../fish/guestfish-actions.pod:4584
26556 msgid "See also L</download>."
26560 #: ../fish/guestfish-actions.pod:4588
26561 msgid "upload-offset"
26565 #: ../fish/guestfish-actions.pod:4590
26568 " upload-offset (filename|-) remotefilename offset\n"
26573 #: ../fish/guestfish-actions.pod:4602
26575 "Note that there is no limit on the amount of data that can be uploaded with "
26576 "this call, unlike with L</pwrite>, and this call always writes the full "
26577 "amount unless an error occurs."
26581 #: ../fish/guestfish-actions.pod:4607
26582 msgid "See also L</upload>, L</pwrite>."
26586 #: ../fish/guestfish-actions.pod:4611
26591 #: ../fish/guestfish-actions.pod:4613
26594 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
26599 #: ../fish/guestfish-actions.pod:4632
26604 #: ../fish/guestfish-actions.pod:4634
26612 #: ../fish/guestfish-actions.pod:4661
26614 "I<Note:> Don't use this call to test for availability of features. In "
26615 "enterprise distributions we backport features from later versions into "
26616 "earlier versions, making this an unreliable way to test for features. Use "
26617 "L</available> instead."
26621 #: ../fish/guestfish-actions.pod:4667
26626 #: ../fish/guestfish-actions.pod:4669
26629 " vfs-label device\n"
26634 #: ../fish/guestfish-actions.pod:4676
26635 msgid "To find a filesystem from the label, use L</findfs-label>."
26639 #: ../fish/guestfish-actions.pod:4678
26644 #: ../fish/guestfish-actions.pod:4680
26647 " vfs-type device\n"
26652 #: ../fish/guestfish-actions.pod:4690
26657 #: ../fish/guestfish-actions.pod:4692
26660 " vfs-uuid device\n"
26665 #: ../fish/guestfish-actions.pod:4699
26666 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
26670 #: ../fish/guestfish-actions.pod:4701
26671 msgid "vg-activate"
26675 #: ../fish/guestfish-actions.pod:4703
26678 " vg-activate true|false 'volgroups ...'\n"
26683 #: ../fish/guestfish-actions.pod:4716
26684 msgid "vg-activate-all"
26688 #: ../fish/guestfish-actions.pod:4718
26691 " vg-activate-all true|false\n"
26696 #: ../fish/guestfish-actions.pod:4728
26701 #: ../fish/guestfish-actions.pod:4730
26704 " vgcreate volgroup 'physvols ...'\n"
26709 #: ../fish/guestfish-actions.pod:4735
26714 #: ../fish/guestfish-actions.pod:4737
26717 " vglvuuids vgname\n"
26722 #: ../fish/guestfish-actions.pod:4742
26724 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
26725 "logical volumes and volume groups."
26729 #: ../fish/guestfish-actions.pod:4745
26730 msgid "See also L</vgpvuuids>."
26734 #: ../fish/guestfish-actions.pod:4747
26739 #: ../fish/guestfish-actions.pod:4749
26742 " vgpvuuids vgname\n"
26747 #: ../fish/guestfish-actions.pod:4754
26749 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
26750 "physical volumes and volume groups."
26754 #: ../fish/guestfish-actions.pod:4757
26755 msgid "See also L</vglvuuids>."
26759 #: ../fish/guestfish-actions.pod:4759
26764 #: ../fish/guestfish-actions.pod:4761
26767 " vgremove vgname\n"
26772 #: ../fish/guestfish-actions.pod:4768
26777 #: ../fish/guestfish-actions.pod:4770
26780 " vgrename volgroup newvolgroup\n"
26785 #: ../fish/guestfish-actions.pod:4774
26790 #: ../fish/guestfish-actions.pod:4776
26798 #: ../fish/guestfish-actions.pod:4784
26799 msgid "See also L</vgs-full>."
26803 #: ../fish/guestfish-actions.pod:4786
26808 #: ../fish/guestfish-actions.pod:4788
26816 #: ../fish/guestfish-actions.pod:4793
26821 #: ../fish/guestfish-actions.pod:4795
26829 #: ../fish/guestfish-actions.pod:4800
26834 #: ../fish/guestfish-actions.pod:4802
26842 #: ../fish/guestfish-actions.pod:4806
26847 #: ../fish/guestfish-actions.pod:4808
26855 #: ../fish/guestfish-actions.pod:4813
26860 #: ../fish/guestfish-actions.pod:4815
26868 #: ../fish/guestfish-actions.pod:4820
26873 #: ../fish/guestfish-actions.pod:4822
26881 #: ../fish/guestfish-actions.pod:4827
26886 #: ../fish/guestfish-actions.pod:4829
26889 " write path content\n"
26894 #: ../fish/guestfish-actions.pod:4837
26899 #: ../fish/guestfish-actions.pod:4839
26902 " write-file path content size\n"
26907 #: ../fish/guestfish-actions.pod:4862
26912 #: ../fish/guestfish-actions.pod:4864
26915 " zegrep regex path\n"
26920 #: ../fish/guestfish-actions.pod:4872
26925 #: ../fish/guestfish-actions.pod:4874
26928 " zegrepi regex path\n"
26933 #: ../fish/guestfish-actions.pod:4882
26938 #: ../fish/guestfish-actions.pod:4884
26946 #: ../fish/guestfish-actions.pod:4892
26947 msgid "See also: L</zero-device>, L</scrub-device>."
26951 #: ../fish/guestfish-actions.pod:4894
26952 msgid "zero-device"
26956 #: ../fish/guestfish-actions.pod:4896
26959 " zero-device device\n"
26964 #: ../fish/guestfish-actions.pod:4898
26966 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
26967 "which just zeroes the first few blocks of a device."
26971 #: ../fish/guestfish-actions.pod:4905
26976 #: ../fish/guestfish-actions.pod:4907
26979 " zerofree device\n"
26984 #: ../fish/guestfish-actions.pod:4920
26989 #: ../fish/guestfish-actions.pod:4922
26992 " zfgrep pattern path\n"
26997 #: ../fish/guestfish-actions.pod:4930
27002 #: ../fish/guestfish-actions.pod:4932
27005 " zfgrepi pattern path\n"
27010 #: ../fish/guestfish-actions.pod:4940
27015 #: ../fish/guestfish-actions.pod:4942
27018 " zfile meth path\n"
27023 #: ../fish/guestfish-actions.pod:4949
27024 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
27028 #: ../fish/guestfish-actions.pod:4959
27033 #: ../fish/guestfish-actions.pod:4961
27036 " zgrep regex path\n"
27041 #: ../fish/guestfish-actions.pod:4969
27046 #: ../fish/guestfish-actions.pod:4971
27049 " zgrepi regex path\n"
27054 #: ../fish/guestfish-commands.pod:1
27059 #: ../fish/guestfish-commands.pod:3
27064 #: ../fish/guestfish-commands.pod:5
27067 " alloc filename size\n"
27072 #: ../fish/guestfish-commands.pod:7
27074 "This creates an empty (zeroed) file of the given size, and then adds so it "
27075 "can be further examined."
27079 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27080 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27084 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27085 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27089 #: ../fish/guestfish-commands.pod:14
27091 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27092 "image, see L</PREPARED DISK IMAGES>."
27096 #: ../fish/guestfish-commands.pod:17
27101 #: ../fish/guestfish-commands.pod:19
27104 " copy-in local [local ...] /remotedir\n"
27109 #: ../fish/guestfish-commands.pod:21
27111 "C<copy-in> copies local files or directories recursively into the disk "
27112 "image, placing them in the directory called C</remotedir> (which must "
27113 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27114 "other commands as necessary."
27118 #: ../fish/guestfish-commands.pod:26
27120 "Multiple local files and directories can be specified, but the last "
27121 "parameter must always be a remote directory. Wildcards cannot be used."
27125 #: ../fish/guestfish-commands.pod:30
27130 #: ../fish/guestfish-commands.pod:32
27133 " copy-out remote [remote ...] localdir\n"
27138 #: ../fish/guestfish-commands.pod:34
27140 "C<copy-out> copies remote files or directories recursively out of the disk "
27141 "image, placing them on the host disk in a local directory called C<localdir> "
27142 "(which must exist). This guestfish meta-command turns into a sequence of "
27143 "L</download>, L</tar-out> and other commands as necessary."
27147 #: ../fish/guestfish-commands.pod:40
27149 "Multiple remote files and directories can be specified, but the last "
27150 "parameter must always be a local directory. To download to the current "
27151 "directory, use C<.> as in:"
27155 #: ../fish/guestfish-commands.pod:44
27158 " copy-out /home .\n"
27163 #: ../fish/guestfish-commands.pod:46
27165 "Wildcards cannot be used in the ordinary command, but you can use them with "
27166 "the help of L</glob> like this:"
27170 #: ../fish/guestfish-commands.pod:49
27173 " glob copy-out /home/* .\n"
27178 #: ../fish/guestfish-commands.pod:51
27183 #: ../fish/guestfish-commands.pod:53
27186 " echo [params ...]\n"
27191 #: ../fish/guestfish-commands.pod:55
27192 msgid "This echos the parameters to the terminal."
27196 #: ../fish/guestfish-commands.pod:57
27201 #: ../fish/guestfish-commands.pod:59
27206 #: ../fish/guestfish-commands.pod:61
27211 #: ../fish/guestfish-commands.pod:63
27219 #: ../fish/guestfish-commands.pod:65
27221 "This is used to edit a file. It downloads the file, edits it locally using "
27222 "your editor, then uploads the result."
27226 #: ../fish/guestfish-commands.pod:68
27228 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27229 "or C<emacs> you will get those corresponding editors."
27233 #: ../fish/guestfish-commands.pod:72
27238 #: ../fish/guestfish-commands.pod:74
27241 " glob command args...\n"
27246 #: ../fish/guestfish-commands.pod:76
27248 "Expand wildcards in any paths in the args list, and run C<command> "
27249 "repeatedly on each matching path."
27253 #: ../fish/guestfish-commands.pod:79
27254 msgid "See L</WILDCARDS AND GLOBBING>."
27258 #: ../fish/guestfish-commands.pod:81
27263 #: ../fish/guestfish-commands.pod:83
27266 " hexedit <filename|device>\n"
27267 " hexedit <filename|device> <max>\n"
27268 " hexedit <filename|device> <start> <max>\n"
27273 #: ../fish/guestfish-commands.pod:87
27275 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27280 #: ../fish/guestfish-commands.pod:90
27282 "This command works by downloading potentially the whole file or device, "
27283 "editing it locally, then uploading it. If the file or device is large, you "
27284 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27285 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27286 "usual modifiers allowed such as C<1M> (1 megabyte)."
27290 #: ../fish/guestfish-commands.pod:97
27291 msgid "For example to edit the first few sectors of a disk you might do:"
27295 #: ../fish/guestfish-commands.pod:100
27298 " hexedit /dev/sda 1M\n"
27303 #: ../fish/guestfish-commands.pod:102
27305 "which would allow you to edit anywhere within the first megabyte of the "
27310 #: ../fish/guestfish-commands.pod:105
27311 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27315 #: ../fish/guestfish-commands.pod:107
27318 " hexedit /dev/sda1 0x400 0x400\n"
27323 #: ../fish/guestfish-commands.pod:109
27324 msgid "(assuming the superblock is in the standard location)."
27328 #: ../fish/guestfish-commands.pod:111
27330 "This command requires the external L<hexedit(1)> program. You can specify "
27331 "another program to use by setting the C<HEXEDITOR> environment variable."
27335 #: ../fish/guestfish-commands.pod:115
27336 msgid "See also L</hexdump>."
27340 #: ../fish/guestfish-commands.pod:117
27345 #: ../fish/guestfish-commands.pod:119
27353 #: ../fish/guestfish-commands.pod:121
27354 msgid "Change the local directory, ie. the current directory of guestfish itself."
27358 #: ../fish/guestfish-commands.pod:124
27359 msgid "Note that C<!cd> won't do what you might expect."
27363 #: ../fish/guestfish-commands.pod:126
27368 #: ../fish/guestfish-commands.pod:128
27373 #: ../fish/guestfish-commands.pod:130
27381 #: ../fish/guestfish-commands.pod:132
27382 msgid "Opens the manual page for guestfish."
27386 #: ../fish/guestfish-commands.pod:134
27391 #: ../fish/guestfish-commands.pod:136
27396 #: ../fish/guestfish-commands.pod:138
27404 #: ../fish/guestfish-commands.pod:140
27412 #: ../fish/guestfish-commands.pod:142
27413 msgid "This is used to view a file."
27417 #: ../fish/guestfish-commands.pod:144
27419 "The default viewer is C<$PAGER>. However if you use the alternate command "
27420 "C<less> you will get the C<less> command specifically."
27424 #: ../fish/guestfish-commands.pod:147
27429 #: ../fish/guestfish-commands.pod:149
27437 #: ../fish/guestfish-commands.pod:151
27439 "Close and reopen the libguestfs handle. It is not necessary to use this "
27440 "normally, because the handle is closed properly when guestfish exits. "
27441 "However this is occasionally useful for testing."
27445 #: ../fish/guestfish-commands.pod:155
27450 #: ../fish/guestfish-commands.pod:157
27453 " sparse filename size\n"
27458 #: ../fish/guestfish-commands.pod:159
27460 "This creates an empty sparse file of the given size, and then adds so it can "
27461 "be further examined."
27465 #: ../fish/guestfish-commands.pod:162
27467 "In all respects it works the same as the L</alloc> command, except that the "
27468 "image file is allocated sparsely, which means that disk blocks are not "
27469 "assigned to the file until they are needed. Sparse disk files only use "
27470 "space when written to, but they are slower and there is a danger you could "
27471 "run out of real disk space during a write operation."
27475 #: ../fish/guestfish-commands.pod:172
27480 #: ../fish/guestfish-commands.pod:174
27488 #: ../fish/guestfish-commands.pod:176
27490 "This command returns a list of the optional groups known to the daemon, and "
27491 "indicates which ones are supported by this build of the libguestfs "
27496 #: ../fish/guestfish-commands.pod:180
27497 msgid "See also L<guestfs(3)/AVAILABILITY>."
27501 #: ../fish/guestfish-commands.pod:182
27506 #: ../fish/guestfish-commands.pod:184
27509 " time command args...\n"
27514 #: ../fish/guestfish-commands.pod:186
27516 "Run the command as usual, but print the elapsed time afterwards. This can "
27517 "be useful for benchmarking operations."
27521 #: ../test-tool/libguestfs-test-tool.pod:5
27522 msgid "libguestfs-test-tool - End user tests for libguestfs"
27526 #: ../test-tool/libguestfs-test-tool.pod:9
27529 " libguestfs-test-tool [--options]\n"
27534 #: ../test-tool/libguestfs-test-tool.pod:13
27536 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
27537 "and developers, to allow them to check basic libguestfs functionality is "
27538 "working. This is needed because libguestfs occasionally breaks for reasons "
27539 "beyond our control: usually because of changes in the underlying qemu or "
27540 "kernel packages, or the host environment."
27544 #: ../test-tool/libguestfs-test-tool.pod:20
27545 msgid "If you suspect a problem in libguestfs, then just run:"
27549 #: ../test-tool/libguestfs-test-tool.pod:22
27552 " libguestfs-test-tool\n"
27557 #: ../test-tool/libguestfs-test-tool.pod:24
27558 msgid "It will print lots of diagnostic messages."
27562 #: ../test-tool/libguestfs-test-tool.pod:26
27563 msgid "If it runs to completion successfully, you will see this near the end:"
27567 #: ../test-tool/libguestfs-test-tool.pod:28
27570 " ===== TEST FINISHED OK =====\n"
27575 #: ../test-tool/libguestfs-test-tool.pod:30
27576 msgid "and the test tool will exit with code 0."
27580 #: ../test-tool/libguestfs-test-tool.pod:32
27582 "If it fails (and/or exits with non-zero error code), please paste the "
27583 "B<complete, unedited> output of the test tool into a bug report. More "
27584 "information about reporting bugs can be found on the "
27585 "L<http://libguestfs.org/> website."
27589 #: ../test-tool/libguestfs-test-tool.pod:41
27594 #: ../test-tool/libguestfs-test-tool.pod:43
27595 msgid "Display short usage information and exit."
27599 #: ../test-tool/libguestfs-test-tool.pod:45
27600 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
27604 #: ../test-tool/libguestfs-test-tool.pod:47
27606 "Pass an alternate name for the helper program. libguestfs-test-tool will "
27607 "normally look in the C<$libexec> directory that was configured when the tool "
27612 #: ../test-tool/libguestfs-test-tool.pod:51
27613 msgid "I<--qemu qemu_binary>"
27617 #: ../test-tool/libguestfs-test-tool.pod:53
27619 "If you have downloaded another qemu binary, point this option at the full "
27620 "path of the binary to try it."
27624 #: ../test-tool/libguestfs-test-tool.pod:56
27625 msgid "I<--qemudir qemu_source_dir>"
27629 #: ../test-tool/libguestfs-test-tool.pod:58
27631 "If you have compiled qemu from source, point this option at the source "
27632 "directory to try it."
27636 #: ../test-tool/libguestfs-test-tool.pod:61
27637 msgid "I<--timeout N>"
27641 #: ../test-tool/libguestfs-test-tool.pod:63
27643 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
27644 "does not usually need to be adjusted unless your machine is very slow."
27648 #: ../test-tool/libguestfs-test-tool.pod:69
27649 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
27653 #: ../test-tool/libguestfs-test-tool.pod:71
27655 "If you have compiled another version of qemu from source and would like to "
27656 "try that, then you can use the I<--qemudir> option to point to the qemu "
27657 "source directory."
27661 #: ../test-tool/libguestfs-test-tool.pod:75
27663 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
27664 "option to point to the binary."
27668 #: ../test-tool/libguestfs-test-tool.pod:78
27670 "When using an alternate qemu with libguestfs, usually you would need to "
27671 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
27672 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
27673 "when you use either of the I<--qemudir> or I<--qemu> options."
27677 #: ../test-tool/libguestfs-test-tool.pod:85
27679 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
27680 "I<1> if there was an error."
27684 #: ../test-tool/libguestfs-test-tool.pod:92
27685 msgid "/usr/libexec/libguestfs-test-tool-helper"
27689 #: ../test-tool/libguestfs-test-tool.pod:94
27691 "This helper program is run inside the appliance and provides additional "
27696 #: ../test-tool/libguestfs-test-tool.pod:97
27697 msgid "/usr/bin/mkisofs"
27701 #: ../test-tool/libguestfs-test-tool.pod:99
27703 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
27704 "which is used as part of the tests."
27708 #: ../test-tool/libguestfs-test-tool.pod:106
27710 "For the full list of environment variables which may affect libguestfs, "
27711 "please see the L<guestfs(3)> manual page."
27715 #: ../test-tool/libguestfs-test-tool.pod:111
27716 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
27720 #: ../test-tool/libguestfs-test-tool.pod:121
27721 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
27725 #: ../fuse/guestmount.pod:5
27726 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
27730 #: ../fuse/guestmount.pod:9
27733 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
27738 #: ../fuse/guestmount.pod:11
27741 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
27746 #: ../fuse/guestmount.pod:13
27749 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
27754 #: ../fuse/guestmount.pod:17
27756 "You must I<not> use C<guestmount> in read-write mode on live virtual "
27757 "machines. If you do this, you risk disk corruption in the VM."
27761 #: ../fuse/guestmount.pod:22
27763 "The guestmount program can be used to mount virtual machine filesystems and "
27764 "other disk images on the host. It uses libguestfs for access to the guest "
27765 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
27766 "a mountable device."
27770 #: ../fuse/guestmount.pod:27
27772 "Along with other options, you have to give at least one device (I<-a> "
27773 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
27774 "option) or use the I<-i> inspection option. How this works is better "
27775 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
27780 #: ../fuse/guestmount.pod:33
27782 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
27783 "by you, and the filesystem will not be visible to any other users unless you "
27784 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
27785 "the filesystem, use the C<fusermount -u> command."
27789 #: ../fuse/guestmount.pod:41
27791 "For a typical Windows guest which has its main filesystem on the first "
27796 #: ../fuse/guestmount.pod:44
27799 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
27804 #: ../fuse/guestmount.pod:46
27806 "For a typical Linux guest which has a /boot filesystem on the first "
27807 "partition, and the root filesystem on a logical volume:"
27811 #: ../fuse/guestmount.pod:49
27814 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
27819 #: ../fuse/guestmount.pod:51
27820 msgid "To get libguestfs to detect guest mountpoints for you:"
27824 #: ../fuse/guestmount.pod:53
27827 " guestmount -a guest.img -i --ro /mnt\n"
27832 #: ../fuse/guestmount.pod:55
27833 msgid "For a libvirt guest called \"Guest\" you could do:"
27837 #: ../fuse/guestmount.pod:57
27840 " guestmount -d Guest -i --ro /mnt\n"
27845 #: ../fuse/guestmount.pod:59
27847 "If you don't know what filesystems are contained in a guest or disk image, "
27848 "use L<virt-filesystems(1)> first:"
27852 #: ../fuse/guestmount.pod:62
27855 " virt-filesystems MyGuest\n"
27860 #: ../fuse/guestmount.pod:64
27862 "If you want to trace the libguestfs calls but without excessive debugging "
27863 "information, we recommend:"
27867 #: ../fuse/guestmount.pod:67
27870 " guestmount [...] --trace /mnt\n"
27875 #: ../fuse/guestmount.pod:69
27876 msgid "If you want to debug the program, we recommend:"
27880 #: ../fuse/guestmount.pod:71
27883 " guestmount [...] --trace --verbose /mnt\n"
27888 #: ../fuse/guestmount.pod:77
27889 msgid "B<-a image> | B<--add image>"
27893 #: ../fuse/guestmount.pod:79
27894 msgid "Add a block device or virtual machine image."
27898 #: ../fuse/guestmount.pod:84
27899 msgid "B<-c URI> | B<--connect URI>"
27903 #: ../fuse/guestmount.pod:90
27904 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
27908 #: ../fuse/guestmount.pod:96
27909 msgid "B<--dir-cache-timeout N>"
27913 #: ../fuse/guestmount.pod:98
27915 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
27916 "seconds. The readdir cache [actually, there are several semi-independent "
27917 "caches] is populated after a readdir(2) call with the stat and extended "
27918 "attributes of the files in the directory, in anticipation that they will be "
27919 "requested soon after."
27923 #: ../fuse/guestmount.pod:104
27925 "There is also a different attribute cache implemented by FUSE (see the FUSE "
27926 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
27927 "requests, only cache existing ones."
27931 #: ../fuse/guestmount.pod:115
27932 msgid "B<--format=raw|qcow2|..> | B<--format>"
27936 #: ../fuse/guestmount.pod:122
27938 "If you have untrusted raw-format guest disk images, you should use this "
27939 "option to specify the disk format. This avoids a possible security problem "
27940 "with malicious guests (CVE-2010-3851). See also "
27941 "L<guestfs(3)/guestfs_add_drive_opts>."
27945 #: ../fuse/guestmount.pod:127
27946 msgid "B<--fuse-help>"
27950 #: ../fuse/guestmount.pod:129
27951 msgid "Display help on special FUSE options (see I<-o> below)."
27955 #: ../fuse/guestmount.pod:133
27956 msgid "Display brief help and exit."
27960 #: ../fuse/guestmount.pod:135
27961 msgid "B<-i> | B<--inspector>"
27965 #: ../fuse/guestmount.pod:155
27967 "Mount the named partition or logical volume on the given mountpoint B<in the "
27968 "guest> (this has nothing to do with mountpoints in the host)."
27972 #: ../fuse/guestmount.pod:158
27974 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
27975 "something on C</>."
27979 #: ../fuse/guestmount.pod:171
27980 msgid "B<-n> | B<--no-sync>"
27984 #: ../fuse/guestmount.pod:173
27986 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
27987 "unmounted. If you specify this option, then we don't attempt to sync the "
27988 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
27992 #: ../fuse/guestmount.pod:178
27993 msgid "B<-o option> | B<--option option>"
27997 #: ../fuse/guestmount.pod:180
27998 msgid "Pass extra options to FUSE."
28002 #: ../fuse/guestmount.pod:182
28004 "To get a list of all the extra options supported by FUSE, use the command "
28005 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28006 "of them are a good idea."
28010 #: ../fuse/guestmount.pod:186
28013 " guestmount --fuse-help\n"
28018 #: ../fuse/guestmount.pod:188
28019 msgid "Some potentially useful FUSE options:"
28023 #: ../fuse/guestmount.pod:192
28024 msgid "B<-o allow_other>"
28028 #: ../fuse/guestmount.pod:194
28029 msgid "Allow other users to see the filesystem."
28033 #: ../fuse/guestmount.pod:196
28034 msgid "B<-o attr_timeout=N>"
28038 #: ../fuse/guestmount.pod:198
28039 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28043 #: ../fuse/guestmount.pod:200
28044 msgid "B<-o kernel_cache>"
28048 #: ../fuse/guestmount.pod:202
28050 "Allow the kernel to cache files (reduces the number of reads that have to go "
28051 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28052 "afford the extra memory usage."
28056 #: ../fuse/guestmount.pod:206
28057 msgid "B<-o uid=N> B<-o gid=N>"
28061 #: ../fuse/guestmount.pod:208
28063 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28064 "the chosen values."
28068 #: ../fuse/guestmount.pod:213
28069 msgid "B<-r> | B<--ro>"
28073 #: ../fuse/guestmount.pod:215
28075 "Add devices and mount everything read-only. Also disallow writes and make "
28076 "the disk appear read-only to FUSE."
28080 #: ../fuse/guestmount.pod:218
28082 "This is highly recommended if you are not going to edit the guest disk. If "
28083 "the guest is running and this option is I<not> supplied, then there is a "
28084 "strong risk of disk corruption in the guest. We try to prevent this from "
28085 "happening, but it is not always possible."
28089 #: ../fuse/guestmount.pod:223
28090 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28094 #: ../fuse/guestmount.pod:227
28095 msgid "Enable SELinux support for the guest."
28099 #: ../fuse/guestmount.pod:229
28100 msgid "B<-v> | B<--verbose>"
28104 #: ../fuse/guestmount.pod:231
28105 msgid "Enable verbose messages from underlying libguestfs."
28109 #: ../fuse/guestmount.pod:233
28110 msgid "B<-V> | B<--version>"
28114 #: ../fuse/guestmount.pod:235
28115 msgid "Display the program version and exit."
28119 #: ../fuse/guestmount.pod:237
28120 msgid "B<-w> | B<--rw>"
28124 #: ../fuse/guestmount.pod:242 ../fuse/guestmount.pod:263
28125 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28129 #: ../fuse/guestmount.pod:244
28130 msgid "B<-x> | B<--trace>"
28134 #: ../fuse/guestmount.pod:246
28135 msgid "Trace libguestfs calls and entry into each FUSE function."
28139 #: ../fuse/guestmount.pod:248
28140 msgid "This also stops the daemon from forking into the background."
28144 #: ../fuse/guestmount.pod:269
28146 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28147 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
28148 "L<http://fuse.sf.net/>."
28152 #: ../fuse/guestmount.pod:284
28153 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28157 #: ../tools/virt-edit.pl:34
28158 msgid "virt-edit - Edit a file in a virtual machine"
28162 #: ../tools/virt-edit.pl:38
28165 " virt-edit [--options] domname file\n"
28170 #: ../tools/virt-edit.pl:40
28173 " virt-edit [--options] disk.img [disk.img ...] file\n"
28178 #: ../tools/virt-edit.pl:42
28181 " virt-edit [domname|disk.img] file -e 'expr'\n"
28186 #: ../tools/virt-edit.pl:46
28188 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28189 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28190 "doing this, but doesn't catch all cases."
28194 #: ../tools/virt-edit.pl:52
28196 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28197 "the named virtual machine (or disk image)."
28201 #: ../tools/virt-edit.pl:55
28202 msgid "If you want to just view a file, use L<virt-cat(1)>."
28206 #: ../tools/virt-edit.pl:57
28208 "For more complex cases you should look at the L<guestfish(1)> tool (see "
28209 "L</USING GUESTFISH> below)."
28213 #: ../tools/virt-edit.pl:60
28215 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28216 "files. L<guestfish(1)> can do that and much more."
28220 #: ../tools/virt-edit.pl:65
28221 msgid "Edit the named files interactively:"
28225 #: ../tools/virt-edit.pl:67
28228 " virt-edit mydomain /boot/grub/grub.conf\n"
28233 #: ../tools/virt-edit.pl:69
28236 " virt-edit mydomain /etc/passwd\n"
28241 #: ../tools/virt-edit.pl:71
28242 msgid "For Windows guests, some Windows paths are understood:"
28246 #: ../tools/virt-edit.pl:73
28249 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
28254 #: ../tools/virt-edit.pl:75
28256 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28257 "below). To change the init default level to 5:"
28261 #: ../tools/virt-edit.pl:79
28264 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28269 #: ../tools/virt-edit.pl:91 ../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
28270 msgid "Display brief help."
28274 #: ../tools/virt-edit.pl:99 ../tools/virt-win-reg.pl:114 ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
28275 msgid "Display version number and exit."
28279 #: ../tools/virt-edit.pl:105
28280 msgid "B<--backup extension> | B<-b extension>"
28284 #: ../tools/virt-edit.pl:107
28286 "Create a backup of the original file I<in the guest disk image>. The backup "
28287 "has the original filename with C<extension> added."
28291 #: ../tools/virt-edit.pl:110
28293 "Usually the first character of C<extension> would be a dot C<.> so you would "
28298 #: ../tools/virt-edit.pl:113
28301 " virt-edit -b .orig [etc]\n"
28306 #: ../tools/virt-edit.pl:115
28307 msgid "By default, no backup file is made."
28311 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
28312 msgid "B<--connect URI> | B<-c URI>"
28316 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
28318 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28319 "to the default libvirt hypervisor."
28323 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
28325 "If you specify guest block devices directly, then libvirt is not used at "
28330 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140 ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
28331 msgid "B<--format> raw"
28335 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
28337 "Specify the format of disk images given on the command line. If this is "
28338 "omitted then the format is autodetected from the content of the disk image."
28342 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
28344 "If disk images are requested from libvirt, then this program asks libvirt "
28345 "for this information. In this case, the value of the format parameter is "
28350 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150 ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
28352 "If working with untrusted raw-format guest disk images, you should ensure "
28353 "the format is always specified."
28357 #: ../tools/virt-edit.pl:150
28358 msgid "B<--expr EXPR> | B<-e EXPR>"
28362 #: ../tools/virt-edit.pl:152
28364 "Instead of launching the external editor, non-interactively apply the Perl "
28365 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28370 #: ../tools/virt-edit.pl:156
28372 "Be careful to properly quote the expression to prevent it from being altered "
28377 #: ../tools/virt-edit.pl:280
28378 msgid "NON-INTERACTIVE EDITING"
28382 #: ../tools/virt-edit.pl:282
28384 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28385 "administrator can interactively edit the file."
28389 #: ../tools/virt-edit.pl:285
28391 "There are two ways also to use C<virt-edit> from scripts in order to make "
28392 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
28393 "like this, it's less error-prone to write scripts directly using the "
28394 "libguestfs API and Augeas for configuration file editing.)"
28398 #: ../tools/virt-edit.pl:291
28400 "The first method is to temporarily set C<$EDITOR> to any script or program "
28401 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
28402 "update C<tmpfile> in place however it likes."
28406 #: ../tools/virt-edit.pl:295
28408 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
28409 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
28410 "instances of C<foo> with C<bar> in a file:"
28414 #: ../tools/virt-edit.pl:299
28417 " virt-edit domname filename -e 's/foo/bar/'\n"
28422 #: ../tools/virt-edit.pl:301
28424 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
28425 "For example to delete root's password you could do:"
28429 #: ../tools/virt-edit.pl:304
28432 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
28437 #: ../tools/virt-edit.pl:306
28439 "What really happens is that the snippet is evaluated as a Perl expression "
28440 "for each line of the file. The line, including the final C<\\n>, is passed "
28441 "in C<$_> and the expression should update C<$_> or leave it unchanged."
28445 #: ../tools/virt-edit.pl:311
28447 "To delete a line, set C<$_> to the empty string. For example, to delete the "
28448 "C<apache> user account from the password file you can do:"
28452 #: ../tools/virt-edit.pl:314
28455 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
28460 #: ../tools/virt-edit.pl:316
28462 "To insert a line, prepend or append it to C<$_>. However appending lines to "
28463 "the end of the file is rather difficult this way since there is no concept "
28464 "of \"last line of the file\" - your expression just doesn't get called "
28465 "again. You might want to use the first method (setting C<$EDITOR>) if you "
28470 #: ../tools/virt-edit.pl:322
28472 "The variable C<$lineno> contains the current line number. As is "
28473 "traditional, the first line in the file is number C<1>."
28477 #: ../tools/virt-edit.pl:325
28479 "The return value from the expression is ignored, but the expression may call "
28480 "C<die> in order to abort the whole program, leaving the original file "
28485 #: ../tools/virt-edit.pl:329
28487 "Remember when matching the end of a line that C<$_> may contain the final "
28488 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
28489 "newline then neither of these. Thus to match or substitute some text at the "
28490 "end of a line, use this regular expression:"
28494 #: ../tools/virt-edit.pl:334
28497 " /some text(\\r?\\n)?$/\n"
28502 #: ../tools/virt-edit.pl:336
28504 "Alternately, use the perl C<chomp> function, being careful not to chomp "
28505 "C<$_> itself (since that would remove all newlines from the file):"
28509 #: ../tools/virt-edit.pl:340
28512 " my $m = $_; chomp $m; $m =~ /some text$/\n"
28517 #: ../tools/virt-edit.pl:344
28519 "C<virt-edit> has a limited ability to understand Windows drive letters and "
28520 "paths (eg. C<E:\\foo\\bar.txt>)."
28524 #: ../tools/virt-edit.pl:347
28525 msgid "If and only if the guest is running Windows then:"
28529 #: ../tools/virt-edit.pl:353
28531 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
28532 "to the correct filesystem."
28536 #: ../tools/virt-edit.pl:358
28538 "Any backslash (C<\\>) characters in the path are replaced with forward "
28539 "slashes so that libguestfs can process it."
28543 #: ../tools/virt-edit.pl:363
28545 "The path is resolved case insensitively to locate the file that should be "
28550 #: ../tools/virt-edit.pl:368
28551 msgid "There are some known shortcomings:"
28555 #: ../tools/virt-edit.pl:374
28556 msgid "Some NTFS symbolic links may not be followed correctly."
28560 #: ../tools/virt-edit.pl:378
28561 msgid "NTFS junction points that cross filesystems are not followed."
28565 #: ../tools/virt-edit.pl:435
28566 msgid "USING GUESTFISH"
28570 #: ../tools/virt-edit.pl:437
28572 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
28573 "C<virt-edit> doesn't work."
28577 #: ../tools/virt-edit.pl:440
28578 msgid "Using C<virt-edit> is approximately equivalent to doing:"
28582 #: ../tools/virt-edit.pl:442
28585 " guestfish --rw -i -d domname edit /file\n"
28590 #: ../tools/virt-edit.pl:444
28592 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
28593 "path to the file."
28597 #: ../tools/virt-edit.pl:447
28599 "The command above uses libguestfs's guest inspection feature and so does not "
28600 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
28601 "disk images that don't contain guests. To edit a file on a disk image "
28606 #: ../tools/virt-edit.pl:452
28609 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
28614 #: ../tools/virt-edit.pl:454
28616 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
28617 "the disk image to edit, and C</file> is the full path to the file."
28621 #: ../tools/virt-edit.pl:458
28623 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
28624 "C<write> or C<upload> instead:"
28628 #: ../tools/virt-edit.pl:461
28631 " guestfish --rw -i -d domname touch /newfile\n"
28636 #: ../tools/virt-edit.pl:463
28639 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
28644 #: ../tools/virt-edit.pl:465
28647 " guestfish --rw -i -d domname upload localfile /newfile\n"
28652 #: ../tools/virt-edit.pl:467
28653 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
28657 #: ../tools/virt-edit.pl:470
28660 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
28665 #: ../tools/virt-edit.pl:480
28670 #: ../tools/virt-edit.pl:482
28672 "If set, this string is used as the editor. It may contain arguments, "
28673 "eg. C<\"emacs -nw\">"
28677 #: ../tools/virt-edit.pl:485
28678 msgid "If not set, C<vi> is used."
28682 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559 ../tools/virt-resize.pl:1482 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
28683 msgid "SHELL QUOTING"
28687 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567 ../tools/virt-resize.pl:1484 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
28689 "Libvirt guest names can contain arbitrary characters, some of which have "
28690 "meaning to the shell such as C<#> and space. You may need to quote or "
28691 "escape these characters on the command line. See the shell manual page "
28692 "L<sh(1)> for details."
28696 #: ../tools/virt-edit.pl:498
28698 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
28699 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
28700 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
28704 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598 ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
28709 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
28710 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
28714 #: ../tools/virt-edit.pl:516
28715 msgid "Copyright (C) 2009-2011 Red Hat Inc."
28719 #: ../tools/virt-win-reg.pl:37
28721 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
28726 #: ../tools/virt-win-reg.pl:41
28729 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28734 #: ../tools/virt-win-reg.pl:43
28737 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28742 #: ../tools/virt-win-reg.pl:45
28745 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28750 #: ../tools/virt-win-reg.pl:47
28753 " virt-win-reg --merge domname [input.reg ...]\n"
28758 #: ../tools/virt-win-reg.pl:49
28761 " virt-win-reg [--options] disk.img ... # instead of domname\n"
28766 #: ../tools/virt-win-reg.pl:53
28768 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
28769 "virtual machines. If you do this, you I<will> get irreversible disk "
28770 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
28771 "but doesn't catch all cases."
28775 #: ../tools/virt-win-reg.pl:58
28777 "Modifying the Windows Registry is an inherently risky operation. The format "
28778 "is deliberately obscure and undocumented, and Registry changes can leave the "
28779 "system unbootable. Therefore when using the C<--merge> option, make sure "
28780 "you have a reliable backup first."
28784 #: ../tools/virt-win-reg.pl:65
28786 "This program can export and merge Windows Registry entries from a Windows "
28791 #: ../tools/virt-win-reg.pl:68
28793 "The first parameter is the libvirt guest name or the raw disk image of a "
28798 #: ../tools/virt-win-reg.pl:71
28800 "If C<--merge> is I<not> specified, then the chosen registry key is "
28801 "displayed/exported (recursively). For example:"
28805 #: ../tools/virt-win-reg.pl:74
28808 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
28813 #: ../tools/virt-win-reg.pl:76
28814 msgid "You can also display single values from within registry keys, for example:"
28818 #: ../tools/virt-win-reg.pl:79
28821 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
28822 " $ virt-win-reg Windows7 $cvkey ProductName\n"
28823 " Windows 7 Enterprise\n"
28828 #: ../tools/virt-win-reg.pl:83
28830 "With C<--merge>, you can merge a textual regedit file into the Windows "
28835 #: ../tools/virt-win-reg.pl:86
28838 " $ virt-win-reg --merge Windows7 changes.reg\n"
28843 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
28848 #: ../tools/virt-win-reg.pl:90
28850 "This program is only meant for simple access to the registry. If you want "
28851 "to do complicated things with the registry, we suggest you download the "
28852 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
28853 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
28854 "L<hivexregedit(1)>."
28858 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
28863 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
28864 msgid "Enable debugging messages."
28868 #: ../tools/virt-win-reg.pl:157
28873 #: ../tools/virt-win-reg.pl:159
28875 "In merge mode, this merges a textual regedit file into the Windows Registry "
28876 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
28877 "displays or exports Registry entries instead."
28881 #: ../tools/virt-win-reg.pl:163
28883 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
28884 "result in disk corruption. However exporting (without this flag) is always "
28889 #: ../tools/virt-win-reg.pl:171
28890 msgid "B<--encoding> UTF-16LE|ASCII"
28894 #: ../tools/virt-win-reg.pl:173
28896 "When merging (only), you may need to specify the encoding for strings to be "
28897 "used in the hive file. This is explained in detail in "
28898 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
28902 #: ../tools/virt-win-reg.pl:177
28904 "The default is to use UTF-16LE, which should work with recent versions of "
28909 #: ../tools/virt-win-reg.pl:402
28910 msgid "SUPPORTED SYSTEMS"
28914 #: ../tools/virt-win-reg.pl:404
28916 "The program currently supports Windows NT-derived guests starting with "
28917 "Windows XP through to at least Windows 7."
28921 #: ../tools/virt-win-reg.pl:407
28923 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
28924 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
28925 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
28929 #: ../tools/virt-win-reg.pl:411
28931 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
28936 #: ../tools/virt-win-reg.pl:414
28938 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
28943 #: ../tools/virt-win-reg.pl:417
28948 #: ../tools/virt-win-reg.pl:419
28950 "C<virt-win-reg> expects that regedit files have already been reencoded in "
28951 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
28952 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
28953 "with Windows-style line endings, you may need to reencode the whole file "
28954 "before or after processing."
28958 #: ../tools/virt-win-reg.pl:425
28960 "To reencode a file from Windows format to Linux (before processing it with "
28961 "the C<--merge> option), you would do something like this:"
28965 #: ../tools/virt-win-reg.pl:428
28968 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
28973 #: ../tools/virt-win-reg.pl:430
28975 "To go in the opposite direction, after exporting and before sending the file "
28976 "to a Windows user, do something like this:"
28980 #: ../tools/virt-win-reg.pl:433
28983 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
28988 #: ../tools/virt-win-reg.pl:435
28989 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
28993 #: ../tools/virt-win-reg.pl:437
28995 "If you are unsure about the current encoding, use the L<file(1)> command. "
28996 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
28997 "Windows-style (CRLF) line endings, like this:"
29001 #: ../tools/virt-win-reg.pl:441
29004 " $ file software.reg\n"
29005 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29006 " with CRLF line terminators\n"
29011 #: ../tools/virt-win-reg.pl:445
29012 msgid "This file would need conversion before you could C<--merge> it."
29016 #: ../tools/virt-win-reg.pl:447
29017 msgid "CurrentControlSet etc."
29021 #: ../tools/virt-win-reg.pl:449
29023 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29024 "Registry at the level of the hive file, and therefore you cannot modify "
29029 #: ../tools/virt-win-reg.pl:453
29031 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29032 "circumstances it might refer to another control set. The way to find out is "
29033 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29037 #: ../tools/virt-win-reg.pl:457
29040 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29041 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29042 " \"Current\"=dword:00000001\n"
29043 " \"Default\"=dword:00000001\n"
29044 " \"Failed\"=dword:00000000\n"
29045 " \"LastKnownGood\"=dword:00000002\n"
29050 #: ../tools/virt-win-reg.pl:464
29051 msgid "\"Current\" is the one which Windows will choose when it boots."
29055 #: ../tools/virt-win-reg.pl:466
29056 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
29060 #: ../tools/virt-win-reg.pl:469
29061 msgid "WINDOWS TIPS"
29065 #: ../tools/virt-win-reg.pl:471
29067 "Note that some of these tips modify the guest disk image. The guest I<must> "
29068 "be shut off, else you will get disk corruption."
29072 #: ../tools/virt-win-reg.pl:474
29073 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29077 #: ../tools/virt-win-reg.pl:476
29079 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29080 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29081 "is uploaded into C<C:\\>:"
29085 #: ../tools/virt-win-reg.pl:480
29088 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29093 #: ../tools/virt-win-reg.pl:482
29094 msgid "Prepare a regedit file containing the registry change:"
29098 #: ../tools/virt-win-reg.pl:484
29101 " cat > test.reg <<'EOF'\n"
29102 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29103 " \"Test\"=\"c:\\\\test.bat\"\n"
29109 #: ../tools/virt-win-reg.pl:489
29111 "In this example we use the key C<RunOnce> which means that the script will "
29112 "run precisely once when the first user logs in. If you want it to run every "
29113 "time a user logs in, replace C<RunOnce> with C<Run>."
29117 #: ../tools/virt-win-reg.pl:493
29118 msgid "Now update the registry:"
29122 #: ../tools/virt-win-reg.pl:495
29125 " virt-win-reg --merge WindowsGuest test.reg\n"
29130 #: ../tools/virt-win-reg.pl:497
29131 msgid "INSTALLING A SERVICE"
29135 #: ../tools/virt-win-reg.pl:499
29137 "This section assumes you are familiar with Windows services, and you either "
29138 "have a program which handles the Windows Service Control Protocol directly "
29139 "or you want to run any program using a service wrapper like SrvAny or the "
29144 #: ../tools/virt-win-reg.pl:504
29146 "First upload the program and optionally the service wrapper. In this case "
29147 "the test program is called C<test.exe> and we are using the RHSrvAny "
29152 #: ../tools/virt-win-reg.pl:508
29155 " guestfish -i -d WindowsGuest <<EOF\n"
29156 " upload rhsrvany.exe /rhsrvany.exe\n"
29157 " upload test.exe /test.exe\n"
29163 #: ../tools/virt-win-reg.pl:513
29165 "Prepare a regedit file containing the registry changes. In this example, "
29166 "the first registry change is needed for the service itself or the service "
29167 "wrapper (if used). The second registry change is only needed because I am "
29168 "using the RHSrvAny service wrapper."
29172 #: ../tools/virt-win-reg.pl:518
29175 " cat > service.reg <<'EOF'\n"
29176 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29177 " \"Type\"=dword:00000010\n"
29178 " \"Start\"=dword:00000002\n"
29179 " \"ErrorControl\"=dword:00000001\n"
29180 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29181 " \"DisplayName\"=\"RHSrvAny\"\n"
29182 " \"ObjectName\"=\"NetworkService\"\n"
29187 #: ../tools/virt-win-reg.pl:527
29190 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29191 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29192 " \"PWD\"=\"c:\\\\Temp\"\n"
29198 #: ../tools/virt-win-reg.pl:538
29200 "For use of C<ControlSet001> see the section above in this manual page. You "
29201 "may need to adjust this according to the control set that is in use by the "
29206 #: ../tools/virt-win-reg.pl:544
29208 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29209 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29210 "privileged account."
29214 #: ../tools/virt-win-reg.pl:550
29216 "For the meaning of the magic numbers, see this Microsoft KB article: "
29217 "L<http://support.microsoft.com/kb/103000>."
29221 #: ../tools/virt-win-reg.pl:555
29222 msgid "Update the registry:"
29226 #: ../tools/virt-win-reg.pl:557
29229 " virt-win-reg --merge WindowsGuest service.reg\n"
29234 #: ../tools/virt-win-reg.pl:561
29236 "Be careful when passing parameters containing C<\\> (backslash) in the "
29237 "shell. Usually you will have to use 'single quotes' or double backslashes "
29238 "(but not both) to protect them from the shell."
29242 #: ../tools/virt-win-reg.pl:565
29243 msgid "Paths and value names are case-insensitive."
29247 #: ../tools/virt-win-reg.pl:574
29249 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29250 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29251 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29252 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29256 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29258 "When reporting bugs, please enable debugging and capture the I<complete> "
29263 #: ../tools/virt-win-reg.pl:592
29266 " export LIBGUESTFS_DEBUG=1\n"
29267 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29272 #: ../tools/virt-win-reg.pl:595
29274 "Attach /tmp/virt-win-reg.log to a new bug report at "
29275 "L<https://bugzilla.redhat.com/>"
29279 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1516 ../tools/virt-make-fs.pl:570
29280 msgid "Copyright (C) 2010 Red Hat Inc."
29284 #: ../tools/virt-resize.pl:42
29285 msgid "virt-resize - Resize a virtual machine disk"
29289 #: ../tools/virt-resize.pl:46
29292 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
29293 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
29294 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
29299 #: ../tools/virt-resize.pl:52
29301 "Virt-resize is a tool which can resize a virtual machine disk, making it "
29302 "larger or smaller overall, and resizing or deleting any partitions contained "
29307 #: ../tools/virt-resize.pl:56
29309 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
29310 "not> be used on live virtual machines - for consistent results, shut the "
29311 "virtual machine down before resizing it."
29315 #: ../tools/virt-resize.pl:60
29317 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
29318 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
29322 #: ../tools/virt-resize.pl:66
29324 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
29325 "fill the extra 5GB of space."
29329 #: ../tools/virt-resize.pl:69
29332 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
29333 " virt-filesystems --long -h --all -a olddisk\n"
29334 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
29335 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
29340 #: ../tools/virt-resize.pl:74
29342 "As above, but make the /boot partition 200MB bigger, while giving the "
29343 "remaining space to /dev/sda2:"
29347 #: ../tools/virt-resize.pl:77
29350 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
29355 #: ../tools/virt-resize.pl:79
29356 msgid "As above, but the output format will be uncompressed qcow2:"
29360 #: ../tools/virt-resize.pl:81
29363 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
29364 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
29369 #: ../tools/virt-resize.pl:84
29370 msgid "DETAILED USAGE"
29374 #: ../tools/virt-resize.pl:86
29375 msgid "EXPANDING A VIRTUAL MACHINE DISK"
29379 #: ../tools/virt-resize.pl:90
29380 msgid "1. Shut down the virtual machine"
29384 #: ../tools/virt-resize.pl:92
29385 msgid "2. Locate input disk image"
29389 #: ../tools/virt-resize.pl:94
29391 "Locate the input disk image (ie. the file or device on the host containing "
29392 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
29393 "dumpxml> like this to find the disk image name:"
29397 #: ../tools/virt-resize.pl:98
29400 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
29401 " Found 1 nodes:\n"
29403 " <source dev=\"/dev/vg/lv_guest\" />\n"
29408 #: ../tools/virt-resize.pl:103
29409 msgid "3. Look at current sizing"
29413 #: ../tools/virt-resize.pl:105
29414 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
29418 #: ../tools/virt-resize.pl:108
29421 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
29422 " Name Type Size Parent\n"
29423 " /dev/sda1 partition 101M /dev/sda\n"
29424 " /dev/sda2 partition 7.9G /dev/sda\n"
29425 " /dev/sda device 8.0G -\n"
29430 #: ../tools/virt-resize.pl:114
29432 "(This example is a virtual machine with an 8 GB disk which we would like to "
29433 "expand up to 10 GB)."
29437 #: ../tools/virt-resize.pl:117
29438 msgid "4. Create output disk"
29442 #: ../tools/virt-resize.pl:119
29444 "Virt-resize cannot do in-place disk modifications. You have to have space "
29445 "to store the resized output disk."
29449 #: ../tools/virt-resize.pl:122
29450 msgid "To store the resized disk image in a file, create a file of a suitable size:"
29454 #: ../tools/virt-resize.pl:125
29457 " # rm -f outdisk\n"
29458 " # truncate -s 10G outdisk\n"
29463 #: ../tools/virt-resize.pl:128
29464 msgid "Or use L<lvcreate(1)> to create a logical volume:"
29468 #: ../tools/virt-resize.pl:130
29471 " # lvcreate -L 10G -n lv_name vg_name\n"
29476 #: ../tools/virt-resize.pl:132
29477 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
29481 #: ../tools/virt-resize.pl:134
29484 " # virsh pool-list\n"
29485 " # virsh vol-create-as poolname newvol 10G\n"
29490 #: ../tools/virt-resize.pl:137
29495 #: ../tools/virt-resize.pl:139
29497 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
29498 "file) and the output disk. The output disk is the one created in the "
29503 #: ../tools/virt-resize.pl:143
29506 " # virt-resize indisk outdisk\n"
29511 #: ../tools/virt-resize.pl:145
29513 "This command just copies disk image C<indisk> to disk image C<outdisk> "
29514 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
29515 "larger, then an extra, empty partition is created at the end of the disk "
29516 "covering the extra space. If C<outdisk> is smaller, then it will give an "
29521 #: ../tools/virt-resize.pl:151
29523 "More realistically you'd want to expand existing partitions in the disk "
29524 "image by passing extra options (for the full list see the L</OPTIONS> "
29529 #: ../tools/virt-resize.pl:155
29531 "L</--expand> is the most useful option. It expands the named partition "
29532 "within the disk to fill any extra space:"
29536 #: ../tools/virt-resize.pl:158
29539 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
29544 #: ../tools/virt-resize.pl:160
29546 "(In this case, an extra partition is I<not> created at the end of the disk, "
29547 "because there will be no unused space)."
29551 #: ../tools/virt-resize.pl:163
29553 "L</--resize> is the other commonly used option. The following would "
29554 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
29555 "rest of the available space:"
29559 #: ../tools/virt-resize.pl:167
29562 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
29563 " indisk outdisk\n"
29568 #: ../tools/virt-resize.pl:170
29570 "If the expanded partition in the image contains a filesystem or LVM PV, then "
29571 "if virt-resize knows how, it will resize the contents, the equivalent of "
29572 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
29573 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
29574 "filesystems, so you would have to online resize them after booting the "
29579 #: ../tools/virt-resize.pl:177
29580 msgid "Other options are covered below."
29584 #: ../tools/virt-resize.pl:179
29589 #: ../tools/virt-resize.pl:181
29590 msgid "Thoroughly test the new disk image I<before> discarding the old one."
29594 #: ../tools/virt-resize.pl:183
29595 msgid "If you are using libvirt, edit the XML to point at the new disk:"
29599 #: ../tools/virt-resize.pl:185
29602 " # virsh edit guestname\n"
29607 #: ../tools/virt-resize.pl:187
29609 "Change E<lt>source ...E<gt>, see "
29610 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
29614 #: ../tools/virt-resize.pl:190
29615 msgid "Then start up the domain with the new, resized disk:"
29619 #: ../tools/virt-resize.pl:192
29622 " # virsh start guestname\n"
29627 #: ../tools/virt-resize.pl:194
29629 "and check that it still works. See also the L</NOTES> section below for "
29630 "additional information."
29634 #: ../tools/virt-resize.pl:197
29635 msgid "7. Resize LVs etc inside the guest"
29639 #: ../tools/virt-resize.pl:199
29640 msgid "(This can also be done offline using L<guestfish(1)>)"
29644 #: ../tools/virt-resize.pl:201
29646 "Once the guest has booted you should see the new space available, at least "
29647 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
29648 "may need to resize LVs inside PVs, and also resize filesystem types that "
29649 "virt-resize does not know how to expand."
29653 #: ../tools/virt-resize.pl:208
29654 msgid "SHRINKING A VIRTUAL MACHINE DISK"
29658 #: ../tools/virt-resize.pl:210
29660 "Shrinking is somewhat more complex than expanding, and only an overview is "
29665 #: ../tools/virt-resize.pl:213
29667 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
29668 "filesystems). The user has to shrink content before passing the disk image "
29669 "to virt-resize, and virt-resize will check that the content has been shrunk "
29674 #: ../tools/virt-resize.pl:218
29675 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
29679 #: ../tools/virt-resize.pl:220
29681 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
29682 "steps 3 and 4 above to allocate a new disk image."
29686 #: ../tools/virt-resize.pl:223
29687 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
29691 #: ../tools/virt-resize.pl:226
29692 msgid "IGNORING OR DELETING PARTITIONS"
29696 #: ../tools/virt-resize.pl:228
29698 "virt-resize also gives a convenient way to ignore or delete partitions when "
29699 "copying from the input disk to the output disk. Ignoring a partition speeds "
29700 "up the copy where you don't care about the existing contents of a "
29701 "partition. Deleting a partition removes it completely, but note that it "
29702 "also renumbers any partitions after the one which is deleted, which can "
29703 "leave some guests unbootable."
29707 #: ../tools/virt-resize.pl:235
29708 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
29712 #: ../tools/virt-resize.pl:237
29714 "If the input disk is in qcow2 format, then you may prefer that the output is "
29715 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
29716 "the fly. The output format is simply determined by the format of the empty "
29717 "output container that you provide. Thus to create qcow2 output, use:"
29721 #: ../tools/virt-resize.pl:243
29724 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
29729 #: ../tools/virt-resize.pl:245
29730 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
29734 #: ../tools/virt-resize.pl:247
29735 msgid "Similarly, to get non-sparse raw output use:"
29739 #: ../tools/virt-resize.pl:249
29742 " fallocate -l size outdisk\n"
29747 #: ../tools/virt-resize.pl:251
29749 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
29750 "if=/dev/zero of=outdisk bs=1M count=..>)"
29754 #: ../tools/virt-resize.pl:264
29755 msgid "Display help."
29759 #: ../tools/virt-resize.pl:278
29760 msgid "B<--resize part=size>"
29764 #: ../tools/virt-resize.pl:280
29766 "Resize the named partition (expanding or shrinking it) so that it has the "
29771 #: ../tools/virt-resize.pl:283
29773 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
29774 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
29775 "Exabytes; or as a percentage of the current size; or as a relative number or "
29776 "percentage. For example:"
29780 #: ../tools/virt-resize.pl:288
29783 " --resize /dev/sda2=10G\n"
29788 #: ../tools/virt-resize.pl:290
29791 " --resize /dev/sda4=90%\n"
29796 #: ../tools/virt-resize.pl:292
29799 " --resize /dev/sda2=+1G\n"
29804 #: ../tools/virt-resize.pl:294
29807 " --resize /dev/sda2=-200M\n"
29812 #: ../tools/virt-resize.pl:296
29815 " --resize /dev/sda1=+128K\n"
29820 #: ../tools/virt-resize.pl:298
29823 " --resize /dev/sda1=+10%\n"
29828 #: ../tools/virt-resize.pl:300
29831 " --resize /dev/sda1=-10%\n"
29836 #: ../tools/virt-resize.pl:302
29838 "You can increase the size of any partition. Virt-resize will expand the "
29839 "direct content of the partition if it knows how (see C<--expand> below)."
29843 #: ../tools/virt-resize.pl:306
29845 "You can only I<decrease> the size of partitions that contain filesystems or "
29846 "PVs which have already been shrunk. Virt-resize will check this has been "
29847 "done before proceeding, or else will print an error (see also "
29848 "C<--resize-force>)."
29852 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
29853 msgid "You can give this option multiple times."
29857 #: ../tools/virt-resize.pl:317
29858 msgid "B<--resize-force part=size>"
29862 #: ../tools/virt-resize.pl:319
29864 "This is the same as C<--resize> except that it will let you decrease the "
29865 "size of any partition. Generally this means you will lose any data which "
29866 "was at the end of the partition you shrink, but you may not care about that "
29867 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
29868 "as a swap partition)."
29872 #: ../tools/virt-resize.pl:325
29873 msgid "See also the C<--ignore> option."
29877 #: ../tools/virt-resize.pl:331
29878 msgid "B<--expand part>"
29882 #: ../tools/virt-resize.pl:333
29884 "Expand the named partition so it uses up all extra space (space left over "
29885 "after any other resize changes that you request have been done)."
29889 #: ../tools/virt-resize.pl:336
29891 "If virt-resize knows how, it will expand the direct content of the "
29892 "partition. For example, if the partition is an LVM PV, it will expand the "
29893 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
29894 "content it doesn't know about alone."
29898 #: ../tools/virt-resize.pl:341
29899 msgid "Currently virt-resize can resize:"
29903 #: ../tools/virt-resize.pl:347
29905 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
29910 #: ../tools/virt-resize.pl:352
29912 "NTFS filesystems contained directly in a partition, if libguestfs was "
29913 "compiled with support for NTFS."
29917 #: ../tools/virt-resize.pl:355
29919 "The filesystem must have been shut down consistently last time it was used. "
29920 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
29921 "consistency check, so at the first boot after resizing Windows will check "
29926 #: ../tools/virt-resize.pl:362
29928 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
29929 "inside the PV, but see the C<--LV-expand> option. The user could also "
29930 "resize LVs as desired after boot."
29934 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
29935 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
29939 #: ../tools/virt-resize.pl:374
29940 msgid "B<--shrink part>"
29944 #: ../tools/virt-resize.pl:376
29946 "Shrink the named partition until the overall disk image fits in the "
29947 "destination. The named partition B<must> contain a filesystem or PV which "
29948 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
29949 "online tools). Virt-resize will check this and give an error if it has not "
29954 #: ../tools/virt-resize.pl:382
29956 "The amount by which the overall disk must be shrunk (after carrying out all "
29957 "other operations requested by the user) is called the \"deficit\". For "
29958 "example, a straight copy (assume no other operations) from a 5GB disk image "
29959 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
29960 "would give an error unless the user specified a partition to shrink and that "
29961 "partition had more than a gigabyte of free space."
29965 #: ../tools/virt-resize.pl:396
29966 msgid "B<--ignore part>"
29970 #: ../tools/virt-resize.pl:398
29972 "Ignore the named partition. Effectively this means the partition is "
29973 "allocated on the destination disk, but the content is not copied across from "
29974 "the source disk. The content of the partition will be blank (all zero "
29979 #: ../tools/virt-resize.pl:409
29980 msgid "B<--delete part>"
29984 #: ../tools/virt-resize.pl:411
29986 "Delete the named partition. It would be more accurate to describe this as "
29987 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
29988 "the original disk image is left intact."
29992 #: ../tools/virt-resize.pl:415
29994 "Note that when you delete a partition, then anything contained in the "
29995 "partition is also deleted. Furthermore, this causes any partitions that "
29996 "come after to be I<renumbered>, which can easily make your guest unbootable."
30000 #: ../tools/virt-resize.pl:426
30001 msgid "B<--LV-expand logvol>"
30005 #: ../tools/virt-resize.pl:428
30007 "This takes the logical volume and, as a final step, expands it to fill all "
30008 "the space available in its volume group. A typical usage, assuming a Linux "
30009 "guest with a single PV C</dev/sda2> and a root device called "
30010 "C</dev/vg_guest/lv_root> would be:"
30014 #: ../tools/virt-resize.pl:433
30017 " virt-resize indisk outdisk \\\n"
30018 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
30023 #: ../tools/virt-resize.pl:436
30025 "This would first expand the partition (and PV), and then expand the root "
30026 "device to fill the extra space in the PV."
30030 #: ../tools/virt-resize.pl:439
30032 "The contents of the LV are also resized if virt-resize knows how to do "
30033 "that. You can stop virt-resize from trying to expand the content by using "
30034 "the option C<--no-expand-content>."
30038 #: ../tools/virt-resize.pl:443
30039 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
30043 #: ../tools/virt-resize.pl:446
30045 "You can give this option multiple times, I<but> it doesn't make sense to do "
30046 "this unless the logical volumes you specify are all in different volume "
30051 #: ../tools/virt-resize.pl:454
30052 msgid "B<--no-copy-boot-loader>"
30056 #: ../tools/virt-resize.pl:456
30058 "By default, virt-resize copies over some sectors at the start of the disk "
30059 "(up to the beginning of the first partition). Commonly these sectors "
30060 "contain the Master Boot Record (MBR) and the boot loader, and are required "
30061 "in order for the guest to boot correctly."
30065 #: ../tools/virt-resize.pl:461
30067 "If you specify this flag, then this initial copy is not done. You may need "
30068 "to reinstall the boot loader in this case."
30072 #: ../tools/virt-resize.pl:469
30073 msgid "B<--no-extra-partition>"
30077 #: ../tools/virt-resize.pl:471
30079 "By default, virt-resize creates an extra partition if there is any extra, "
30080 "unused space after all resizing has happened. Use this option to prevent "
30081 "the extra partition from being created. If you do this then the extra space "
30082 "will be inaccessible until you run fdisk, parted, or some other partitioning "
30083 "tool in the guest."
30087 #: ../tools/virt-resize.pl:477
30089 "Note that if the surplus space is smaller than 10 MB, no extra partition "
30094 #: ../tools/virt-resize.pl:484
30095 msgid "B<--no-expand-content>"
30099 #: ../tools/virt-resize.pl:486
30101 "By default, virt-resize will try to expand the direct contents of "
30102 "partitions, if it knows how (see C<--expand> option above)."
30106 #: ../tools/virt-resize.pl:489
30108 "If you give the C<--no-expand-content> option then virt-resize will not "
30113 #: ../tools/virt-resize.pl:496
30114 msgid "B<-d> | B<--debug>"
30118 #: ../tools/virt-resize.pl:504
30119 msgid "B<-n> | B<--dryrun>"
30123 #: ../tools/virt-resize.pl:506
30124 msgid "Print a summary of what would be done, but don't do anything."
30128 #: ../tools/virt-resize.pl:512
30129 msgid "B<-q> | B<--quiet>"
30133 #: ../tools/virt-resize.pl:514
30134 msgid "Don't print the summary."
30138 #: ../tools/virt-resize.pl:522
30140 "Specify the format of the input disk image. If this flag is not given then "
30141 "it is auto-detected from the image itself."
30145 #: ../tools/virt-resize.pl:528
30147 "Note that this option I<does not> affect the output format. See L</QCOW2 "
30148 "AND NON-SPARSE RAW FORMATS>."
30152 #: ../tools/virt-resize.pl:535
30153 msgid "B<--output-format> raw"
30157 #: ../tools/virt-resize.pl:537
30159 "Specify the format of the output disk image. If this flag is not given then "
30160 "it is auto-detected from the image itself."
30164 #: ../tools/virt-resize.pl:543
30166 "Note that you still need to create the output disk with the right format. "
30167 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
30171 #: ../tools/virt-resize.pl:1425
30176 #: ../tools/virt-resize.pl:1427
30177 msgid "\"Partition 1 does not end on cylinder boundary.\""
30181 #: ../tools/virt-resize.pl:1429
30183 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
30184 "means the partitions will not be aligned to the ancient CHS geometry. "
30185 "However CHS geometry is meaningless for disks manufactured since the early "
30186 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
30187 "cylinders is not required by any modern operating system."
30191 #: ../tools/virt-resize.pl:1436
30192 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
30196 #: ../tools/virt-resize.pl:1438
30198 "In Windows Vista and later versions, Microsoft switched to using a separate "
30199 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
30200 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
30201 "the boot partition. Doing so seems to break the guest completely. However "
30202 "expanding the second partition (ie. C: drive) should work."
30206 #: ../tools/virt-resize.pl:1445
30208 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
30209 "NTFS partitions have been expanded. This is just a safety check and (unless "
30210 "it find errors) is nothing to worry about."
30214 #: ../tools/virt-resize.pl:1449
30215 msgid "GUEST BOOT STUCK AT \"GRUB\""
30219 #: ../tools/virt-resize.pl:1451
30221 "If a Linux guest does not boot after resizing, and the boot is stuck after "
30222 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
30223 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
30224 "although we think is to do with partition alignment."
30228 #: ../tools/virt-resize.pl:1456
30231 " guestfish -i -a newdisk\n"
30232 " ><fs> cat /boot/grub/device.map\n"
30233 " # check the contents of this file are sensible or\n"
30234 " # edit the file if necessary\n"
30235 " ><fs> grub-install / /dev/vda\n"
30241 #: ../tools/virt-resize.pl:1463
30243 "For more flexible guest reconfiguration, including if you need to specify "
30244 "other parameters to grub-install, use L<virt-rescue(1)>."
30248 #: ../tools/virt-resize.pl:1466
30249 msgid "ALTERNATIVE TOOLS"
30253 #: ../tools/virt-resize.pl:1468
30255 "There are several proprietary tools for resizing partitions. We won't "
30256 "mention any here."
30260 #: ../tools/virt-resize.pl:1471
30262 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
30263 "operations on disk images. They can resize and move partitions, but I don't "
30264 "think they can do anything with the contents, and they certainly don't "
30269 #: ../tools/virt-resize.pl:1476
30271 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
30272 "but at a much lower level. You will probably end up hand-calculating sector "
30273 "offsets, which is something that virt-resize was designed to avoid. If you "
30274 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
30279 #: ../tools/virt-resize.pl:1491
30281 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
30282 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
30283 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
30284 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
30285 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30289 #: ../tools/virt-list-filesystems.pl:32
30290 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30294 #: ../tools/virt-list-filesystems.pl:36
30297 " virt-list-filesystems [--options] domname\n"
30302 #: ../tools/virt-list-filesystems.pl:38
30305 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30310 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30312 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30317 #: ../tools/virt-list-filesystems.pl:45
30319 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30320 "are contained in a virtual machine or disk image."
30324 #: ../tools/virt-list-filesystems.pl:49
30326 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30327 "functionality. For more complex cases you should look at the "
30328 "L<guestfish(1)> tool."
30332 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30333 msgid "B<-l> | B<--long>"
30337 #: ../tools/virt-list-filesystems.pl:108
30339 "With this option, C<virt-list-filesystems> displays the type of each "
30340 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30344 #: ../tools/virt-list-filesystems.pl:115
30345 msgid "B<-a> | B<--all>"
30349 #: ../tools/virt-list-filesystems.pl:117
30351 "Normally we only show mountable filesystems. If this option is given then "
30352 "swap devices are shown too."
30356 #: ../tools/virt-list-filesystems.pl:191
30358 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
30359 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
30360 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30364 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30365 msgid "Copyright (C) 2009 Red Hat Inc."
30369 #: ../tools/virt-tar.pl:33
30370 msgid "virt-tar - Extract or upload files to a virtual machine"
30374 #: ../tools/virt-tar.pl:37
30377 " virt-tar [--options] -x domname directory tarball\n"
30382 #: ../tools/virt-tar.pl:39
30385 " virt-tar [--options] -u domname tarball directory\n"
30390 #: ../tools/virt-tar.pl:41
30393 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30398 #: ../tools/virt-tar.pl:43
30401 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30406 #: ../tools/virt-tar.pl:47
30408 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
30409 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
30413 #: ../tools/virt-tar.pl:52
30414 msgid "Download C</home> from the VM into a local tarball:"
30418 #: ../tools/virt-tar.pl:54
30421 " virt-tar -x domname /home home.tar\n"
30426 #: ../tools/virt-tar.pl:56
30429 " virt-tar -zx domname /home home.tar.gz\n"
30434 #: ../tools/virt-tar.pl:58
30435 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30439 #: ../tools/virt-tar.pl:60
30442 " virt-tar -u domname uploadstuff.tar /tmp\n"
30447 #: ../tools/virt-tar.pl:62
30450 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30455 #: ../tools/virt-tar.pl:66
30457 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
30458 "virtual machines. If you do this, you risk disk corruption in the VM. "
30459 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30463 #: ../tools/virt-tar.pl:71
30465 "You can use C<-x> (extract) on live virtual machines, but you might get "
30466 "inconsistent results or errors if there is filesystem activity inside the "
30467 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30468 "work, but the only way to guarantee consistent results is if the virtual "
30469 "machine is shut down."
30473 #: ../tools/virt-tar.pl:79
30475 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30476 "parts of a guest filesystem. There are many possibilities: making backups, "
30477 "uploading data files, snooping on guest activity, fixing or customizing "
30482 #: ../tools/virt-tar.pl:84
30484 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30485 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30486 "should look at the L<guestfish(1)> tool."
30490 #: ../tools/virt-tar.pl:88
30492 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
30493 "its contents (recursively) from the virtual machine into a local tarball. "
30494 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
30495 "virtual machine. You cannot use these two options together."
30499 #: ../tools/virt-tar.pl:94
30501 "In addition, you may need to use the C<-z> (gZip) option to enable "
30502 "compression. When uploading, you have to specify C<-z> if the upload file "
30503 "is compressed because virt-tar won't detect this on its own."
30507 #: ../tools/virt-tar.pl:98
30509 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30510 "example it cannot do PKZip files or bzip2 compression. If you want that "
30511 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30512 "the L<libguestfs(3)> API)."
30516 #: ../tools/virt-tar.pl:156
30517 msgid "B<-x> | B<--extract> | B<--download>"
30521 #: ../tools/virt-tar.pl:158
30522 msgid "B<-u> | B<--upload>"
30526 #: ../tools/virt-tar.pl:160
30528 "Use C<-x> to extract (download) a directory from a virtual machine to a "
30533 #: ../tools/virt-tar.pl:163
30535 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
30536 "Please read the L</WARNING> section above before using this option."
30540 #: ../tools/virt-tar.pl:167
30541 msgid "You must specify exactly one of these options."
30545 #: ../tools/virt-tar.pl:173
30546 msgid "B<-z> | B<--gzip>"
30550 #: ../tools/virt-tar.pl:175
30551 msgid "Specify that the input or output tarball is gzip-compressed."
30555 #: ../tools/virt-tar.pl:288
30557 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
30558 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
30559 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
30560 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30564 #: ../tools/virt-make-fs.pl:37
30565 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30569 #: ../tools/virt-make-fs.pl:41
30572 " virt-make-fs [--options] input.tar output.img\n"
30577 #: ../tools/virt-make-fs.pl:43
30580 " virt-make-fs [--options] input.tar.gz output.img\n"
30585 #: ../tools/virt-make-fs.pl:45
30588 " virt-make-fs [--options] directory output.img\n"
30593 #: ../tools/virt-make-fs.pl:49
30595 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30596 "archive or some files in a directory. It is similar to tools like "
30597 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
30598 "it can create common filesystem types like ext2/3 or NTFS, which can be "
30599 "useful if you want to attach these filesystems to existing virtual machines "
30600 "(eg. to import large amounts of read-only data to a VM)."
30604 #: ../tools/virt-make-fs.pl:57
30605 msgid "Basic usage is:"
30609 #: ../tools/virt-make-fs.pl:59
30612 " virt-make-fs input output\n"
30617 #: ../tools/virt-make-fs.pl:61
30619 "where C<input> is either a directory containing files that you want to add, "
30620 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30621 "C<output> is a disk image. The input type is detected automatically. The "
30622 "output disk image defaults to a raw ext2 image unless you specify extra "
30623 "flags (see L</OPTIONS> below)."
30627 #: ../tools/virt-make-fs.pl:67
30628 msgid "EXTRA SPACE"
30632 #: ../tools/virt-make-fs.pl:69
30634 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30635 "the files that it contains, but might have extra space. Depending on how "
30636 "you are going to use the output, you might think this extra space is wasted "
30637 "and want to minimize it, or you might want to leave space so that more files "
30638 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30639 "but you can use the C<--size> flag to leave space in the filesystem if you "
30644 #: ../tools/virt-make-fs.pl:77
30646 "An alternative way to leave extra space but not make the output image any "
30647 "bigger is to use an alternative disk image format (instead of the default "
30648 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
30649 "image format (check your hypervisor supports this before using it). This "
30650 "allows you to choose a large C<--size> but the extra space won't actually be "
30651 "allocated in the image until you try to store something in it."
30655 #: ../tools/virt-make-fs.pl:85
30657 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30658 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30659 "to build another image from scratch."
30663 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
30668 #: ../tools/virt-make-fs.pl:91
30671 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30676 #: ../tools/virt-make-fs.pl:93
30677 msgid "FILESYSTEM TYPE"
30681 #: ../tools/virt-make-fs.pl:95
30683 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30684 "libguestfs supports can be used (but I<not> read-only formats like "
30685 "ISO9660). Here are some of the more common choices:"
30689 #: ../tools/virt-make-fs.pl:101
30694 #: ../tools/virt-make-fs.pl:103
30696 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30697 "you are not going to use the filesystem in a way that requires the journal, "
30698 "then this is just wasted overhead."
30702 #: ../tools/virt-make-fs.pl:107
30703 msgid "I<ntfs> or I<vfat>"
30707 #: ../tools/virt-make-fs.pl:109
30708 msgid "Useful if exporting data to a Windows guest."
30712 #: ../tools/virt-make-fs.pl:111
30714 "I<Note for vfat>: The tar archive or local directory must only contain files "
30715 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30716 "program running within libguestfs is unable to change the ownership of "
30717 "non-root files, since vfat itself does not support this."
30721 #: ../tools/virt-make-fs.pl:116
30726 #: ../tools/virt-make-fs.pl:118
30728 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30729 "total filesystem size."
30733 #: ../tools/virt-make-fs.pl:125
30736 " virt-make-fs --type=minix input minixfs.img\n"
30741 #: ../tools/virt-make-fs.pl:127
30742 msgid "TO PARTITION OR NOT TO PARTITION"
30746 #: ../tools/virt-make-fs.pl:129
30747 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30751 #: ../tools/virt-make-fs.pl:131
30753 "Adding a partition can make the disk image more compatible with certain "
30754 "virtualized operating systems which don't expect to see a filesystem "
30755 "directly located on a block device (Linux doesn't care and will happily "
30756 "handle both types)."
30760 #: ../tools/virt-make-fs.pl:136
30762 "On the other hand, if you have a partition table then the output image is no "
30763 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30764 "directly on a partitioned disk image. (However libguestfs tools such as "
30765 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30769 #: ../tools/virt-make-fs.pl:144
30770 msgid "Add an MBR partition:"
30774 #: ../tools/virt-make-fs.pl:146
30777 " virt-make-fs --partition -- input disk.img\n"
30782 #: ../tools/virt-make-fs.pl:148
30784 "If the output disk image could be terabyte-sized or larger, it's better to "
30785 "use an EFI/GPT-compatible partition table:"
30789 #: ../tools/virt-make-fs.pl:151
30792 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30797 #: ../tools/virt-make-fs.pl:179
30798 msgid "Enable debugging information."
30802 #: ../tools/virt-make-fs.pl:185
30803 msgid "B<--size=E<lt>NE<gt>>"
30807 #: ../tools/virt-make-fs.pl:187
30808 msgid "B<--size=+E<lt>NE<gt>>"
30812 #: ../tools/virt-make-fs.pl:189
30813 msgid "B<-s E<lt>NE<gt>>"
30817 #: ../tools/virt-make-fs.pl:191
30818 msgid "B<-s +E<lt>NE<gt>>"
30822 #: ../tools/virt-make-fs.pl:193
30823 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
30827 #: ../tools/virt-make-fs.pl:196
30829 "If this option is I<not> given, then the output image will be just large "
30830 "enough to contain all the files, with not much wasted space."
30834 #: ../tools/virt-make-fs.pl:199
30836 "To choose a fixed size output disk, specify an absolute number followed by "
30837 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30838 "Petabytes or Exabytes. This must be large enough to contain all the input "
30839 "files, else you will get an error."
30843 #: ../tools/virt-make-fs.pl:204
30845 "To leave extra space, specify C<+> (plus sign) and a number followed by "
30846 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30847 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
30848 "the input files, and (approximately) an extra 200 MB free space."
30852 #: ../tools/virt-make-fs.pl:210
30854 "Note that virt-make-fs estimates free space, and therefore will not produce "
30855 "filesystems containing precisely the free space requested. (It is much more "
30856 "expensive and time-consuming to produce a filesystem which has precisely the "
30857 "desired free space)."
30861 #: ../tools/virt-make-fs.pl:219
30862 msgid "B<--format=E<lt>fmtE<gt>>"
30866 #: ../tools/virt-make-fs.pl:221
30867 msgid "B<-F E<lt>fmtE<gt>>"
30871 #: ../tools/virt-make-fs.pl:223
30872 msgid "Choose the output disk image format."
30876 #: ../tools/virt-make-fs.pl:225
30877 msgid "The default is C<raw> (raw disk image)."
30881 #: ../tools/virt-make-fs.pl:227
30883 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30884 "that would really make sense here is C<qcow2>."
30888 #: ../tools/virt-make-fs.pl:234
30889 msgid "B<--type=E<lt>fsE<gt>>"
30893 #: ../tools/virt-make-fs.pl:236
30894 msgid "B<-t E<lt>fsE<gt>>"
30898 #: ../tools/virt-make-fs.pl:238
30899 msgid "Choose the output filesystem type."
30903 #: ../tools/virt-make-fs.pl:240
30904 msgid "The default is C<ext2>."
30908 #: ../tools/virt-make-fs.pl:242
30909 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30913 #: ../tools/virt-make-fs.pl:249
30914 msgid "B<--partition>"
30918 #: ../tools/virt-make-fs.pl:251
30919 msgid "B<--partition=E<lt>parttypeE<gt>>"
30923 #: ../tools/virt-make-fs.pl:253
30925 "If specified, this flag adds an MBR partition table to the output disk "
30930 #: ../tools/virt-make-fs.pl:256
30932 "You can change the partition table type, eg. C<--partition=gpt> for large "
30937 #: ../tools/virt-make-fs.pl:259
30939 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
30940 "might consider the next parameter to be the partition type. For example:"
30944 #: ../tools/virt-make-fs.pl:263
30947 " virt-make-fs --partition input.tar ...\n"
30952 #: ../tools/virt-make-fs.pl:265
30954 "would cause virt-make-fs to think you wanted to use a partition type of "
30955 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
30956 "dash) between options and the input file argument:"
30960 #: ../tools/virt-make-fs.pl:269
30963 " virt-make-fs --partition -- input.tar ...\n"
30968 #: ../tools/virt-make-fs.pl:541
30970 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30971 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30972 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30976 #: ../tools/virt-make-fs.pl:558
30979 " export LIBGUESTFS_DEBUG=1\n"
30980 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30985 #: ../tools/virt-make-fs.pl:561
30987 "Attach /tmp/virt-make-fs.log to a new bug report at "
30988 "L<https://bugzilla.redhat.com/>"
30992 #: ../tools/virt-list-partitions.pl:32
30993 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
30997 #: ../tools/virt-list-partitions.pl:36
31000 " virt-list-partitions [--options] domname\n"
31005 #: ../tools/virt-list-partitions.pl:38
31008 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31013 #: ../tools/virt-list-partitions.pl:45
31015 "C<virt-list-partitions> is a command line tool to list the partitions that "
31016 "are contained in a virtual machine or disk image. It is mainly useful as a "
31017 "first step to using L<virt-resize(1)>."
31021 #: ../tools/virt-list-partitions.pl:50
31023 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31024 "functionality. For more complex cases you should look at the "
31025 "L<guestfish(1)> tool."
31029 #: ../tools/virt-list-partitions.pl:107
31030 msgid "B<-h> | B<--human-readable>"
31034 #: ../tools/virt-list-partitions.pl:109
31035 msgid "Show sizes in human-readable form (eg. \"1G\")."
31039 #: ../tools/virt-list-partitions.pl:117
31041 "With this option, C<virt-list-partitions> displays the type and size of each "
31042 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31046 #: ../tools/virt-list-partitions.pl:124
31047 msgid "B<-t> | B<--total>"
31051 #: ../tools/virt-list-partitions.pl:126
31052 msgid "Display the total size of each block device (as a separate row or rows)."
31056 #: ../tools/virt-list-partitions.pl:259
31058 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
31059 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
31060 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31064 #: ../tools/virt-list-partitions.pl:275
31065 msgid "Copyright (C) 2009-2010 Red Hat Inc."