1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: libguestfs 1.11.9\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-06-04 22:42+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
26 #: ../src/guestfs.pod:5
27 msgid "guestfs - Library for accessing and modifying virtual machine images"
31 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
36 #: ../src/guestfs.pod:9
39 " #include <guestfs.h>\n"
44 #: ../src/guestfs.pod:11
47 " guestfs_h *g = guestfs_create ();\n"
48 " guestfs_add_drive (g, \"guest.img\");\n"
49 " guestfs_launch (g);\n"
50 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
51 " guestfs_touch (g, \"/hello\");\n"
52 " guestfs_umount (g, \"/\");\n"
53 " guestfs_close (g);\n"
58 #: ../src/guestfs.pod:19
61 " cc prog.c -o prog -lguestfs\n"
63 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
68 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
73 #: ../src/guestfs.pod:25
75 "Libguestfs is a library for accessing and modifying guest disk images. "
76 "Amongst the things this is good for: making batch configuration changes to "
77 "guests, getting disk used/free statistics (see also: virt-df), migrating "
78 "between virtualization systems (see also: virt-p2v), performing partial "
79 "backups, performing partial guest clones, cloning guests and changing "
80 "registry/UUID/hostname info, and much else besides."
84 #: ../src/guestfs.pod:33
86 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
87 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
88 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
93 #: ../src/guestfs.pod:38
95 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
96 "what filesystem is in each LV, etc.). It can also run commands in the "
97 "context of the guest. Also you can access filesystems over FUSE."
101 #: ../src/guestfs.pod:43
103 "Libguestfs is a library that can be linked with C and C++ management "
104 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
105 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
110 #: ../src/guestfs.pod:48
112 "You don't need to be root to use libguestfs, although obviously you do need "
113 "enough permissions to access the disk images."
117 #: ../src/guestfs.pod:51
119 "Libguestfs is a large API because it can do many things. For a gentle "
120 "introduction, please read the L</API OVERVIEW> section next."
124 #: ../src/guestfs.pod:54
126 "There are also some example programs in the L<guestfs-examples(3)> manual "
131 #: ../src/guestfs.pod:57
136 #: ../src/guestfs.pod:59
138 "This section provides a gentler overview of the libguestfs API. We also try "
139 "to group API calls together, where that may not be obvious from reading "
140 "about the individual calls in the main section of this manual."
144 #: ../src/guestfs.pod:64
149 #: ../src/guestfs.pod:66
151 "Before you can use libguestfs calls, you have to create a handle. Then you "
152 "must add at least one disk image to the handle, followed by launching the "
153 "handle, then performing whatever operations you want, and finally closing "
154 "the handle. By convention we use the single letter C<g> for the name of the "
155 "handle variable, although of course you can use any name you want."
159 #: ../src/guestfs.pod:73
160 msgid "The general structure of all libguestfs-using programs looks like this:"
164 #: ../src/guestfs.pod:76
167 " guestfs_h *g = guestfs_create ();\n"
172 #: ../src/guestfs.pod:78
175 " /* Call guestfs_add_drive additional times if there are\n"
176 " * multiple disk images.\n"
178 " guestfs_add_drive (g, \"guest.img\");\n"
183 #: ../src/guestfs.pod:83
186 " /* Most manipulation calls won't work until you've launched\n"
187 " * the handle 'g'. You have to do this _after_ adding drives\n"
188 " * and _before_ other commands.\n"
190 " guestfs_launch (g);\n"
195 #: ../src/guestfs.pod:89
198 " /* Now you can examine what partitions, LVs etc are available.\n"
200 " char **partitions = guestfs_list_partitions (g);\n"
201 " char **logvols = guestfs_lvs (g);\n"
206 #: ../src/guestfs.pod:94
209 " /* To access a filesystem in the image, you must mount it.\n"
211 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
216 #: ../src/guestfs.pod:98
219 " /* Now you can perform filesystem actions on the guest\n"
222 " guestfs_touch (g, \"/hello\");\n"
227 #: ../src/guestfs.pod:103
230 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
231 " * it is done automatically when you close the handle. See\n"
232 " * discussion of autosync in this page.\n"
234 " guestfs_sync (g);\n"
239 #: ../src/guestfs.pod:109
242 " /* Close the handle 'g'. */\n"
243 " guestfs_close (g);\n"
248 #: ../src/guestfs.pod:112
250 "The code above doesn't include any error checking. In real code you should "
251 "check return values carefully for errors. In general all functions that "
252 "return integers return C<-1> on error, and all functions that return "
253 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
254 "how to handle errors, and consult the documentation for each function call "
255 "below to see precisely how they return error indications. See "
256 "L<guestfs-examples(3)> for fully worked examples."
260 #: ../src/guestfs.pod:121
265 #: ../src/guestfs.pod:123
267 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
268 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
269 "actual block device, or simply an empty file of zeroes that you have created "
270 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
275 #: ../src/guestfs.pod:129
277 "The call you should use in modern code for adding drives is "
278 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
279 "specifying that the format is raw, do:"
283 #: ../src/guestfs.pod:133
286 " guestfs_add_drive_opts (g, filename,\n"
287 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
293 #: ../src/guestfs.pod:137
294 msgid "You can add a disk read-only using:"
298 #: ../src/guestfs.pod:139
301 " guestfs_add_drive_opts (g, filename,\n"
302 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
303 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
309 #: ../src/guestfs.pod:144
311 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
312 "libguestfs won't modify the file."
316 #: ../src/guestfs.pod:147
318 "Be extremely cautious if the disk image is in use, eg. if it is being used "
319 "by a virtual machine. Adding it read-write will almost certainly cause disk "
320 "corruption, but adding it read-only is safe."
324 #: ../src/guestfs.pod:151
326 "You must add at least one disk image, and you may add multiple disk images. "
327 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
328 "first one you added), C</dev/sdb> (for the second one you added), etc."
332 #: ../src/guestfs.pod:156
334 "Once L</guestfs_launch> has been called you cannot add any more images. You "
335 "can call L</guestfs_list_devices> to get a list of the device names, in the "
336 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
340 #: ../src/guestfs.pod:161
345 #: ../src/guestfs.pod:163
347 "Before you can read or write files, create directories and so on in a disk "
348 "image that contains filesystems, you have to mount those filesystems using "
349 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
350 "a disk image contains (for example) one partition with a filesystem on that "
351 "partition, then you can mount it directly:"
355 #: ../src/guestfs.pod:170
358 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
363 #: ../src/guestfs.pod:172
365 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
366 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
367 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
368 "that these are libguestfs virtual devices, and are nothing to do with host "
373 #: ../src/guestfs.pod:178
375 "If you are given a disk image and you don't know what it contains then you "
376 "have to find out. Libguestfs can do that too: use "
377 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
378 "and LVs, and either try mounting each to see what is mountable, or else "
379 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
380 "filesystems, use L</guestfs_list_filesystems>."
384 #: ../src/guestfs.pod:186
386 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
387 "L</INSPECTION> below). But you might find it easier to look at higher level "
388 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
392 #: ../src/guestfs.pod:191
394 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
395 "several other variations of the C<guestfs_mount_*> call."
399 #: ../src/guestfs.pod:194
400 msgid "FILESYSTEM ACCESS AND MODIFICATION"
404 #: ../src/guestfs.pod:196
406 "The majority of the libguestfs API consists of fairly low-level calls for "
407 "accessing and modifying the files, directories, symlinks etc on mounted "
408 "filesystems. There are over a hundred such calls which you can find listed "
409 "in detail below in this man page, and we don't even pretend to cover them "
410 "all in this overview."
414 #: ../src/guestfs.pod:202
416 "Specify filenames as full paths, starting with C<\"/\"> and including the "
421 #: ../src/guestfs.pod:205
423 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
424 "the file called C<\"etc/passwd\"> then you could do:"
428 #: ../src/guestfs.pod:208
431 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
436 #: ../src/guestfs.pod:210
438 "This would return C<data> as a newly allocated buffer containing the full "
439 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
440 "or C<NULL> if there was an error."
444 #: ../src/guestfs.pod:214
446 "As another example, to create a top-level directory on that filesystem "
447 "called C<\"var\"> you would do:"
451 #: ../src/guestfs.pod:217
454 " guestfs_mkdir (g, \"/var\");\n"
459 #: ../src/guestfs.pod:219
460 msgid "To create a symlink you could do:"
464 #: ../src/guestfs.pod:221
467 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
468 " \"/etc/rc3.d/S30portmap\");\n"
473 #: ../src/guestfs.pod:224
475 "Libguestfs will reject attempts to use relative paths and there is no "
476 "concept of a current working directory."
480 #: ../src/guestfs.pod:227
482 "Libguestfs can return errors in many situations: for example if the "
483 "filesystem isn't writable, or if a file or directory that you requested "
484 "doesn't exist. If you are using the C API (documented here) you have to "
485 "check for those error conditions after each call. (Other language bindings "
486 "turn these errors into exceptions)."
490 #: ../src/guestfs.pod:233
492 "File writes are affected by the per-handle umask, set by calling "
493 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
497 #: ../src/guestfs.pod:236
502 #: ../src/guestfs.pod:238
504 "Libguestfs contains API calls to read, create and modify partition tables on "
509 #: ../src/guestfs.pod:241
511 "In the common case where you want to create a single partition covering the "
512 "whole disk, you should use the L</guestfs_part_disk> call:"
516 #: ../src/guestfs.pod:245
519 " const char *parttype = \"mbr\";\n"
520 " if (disk_is_larger_than_2TB)\n"
521 " parttype = \"gpt\";\n"
522 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
527 #: ../src/guestfs.pod:250
529 "Obviously this effectively wipes anything that was on that disk image "
534 #: ../src/guestfs.pod:253
539 #: ../src/guestfs.pod:255
541 "Libguestfs provides access to a large part of the LVM2 API, such as "
542 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
543 "unless you familiarize yourself with the concepts of physical volumes, "
544 "volume groups and logical volumes."
548 #: ../src/guestfs.pod:260
550 "This author strongly recommends reading the LVM HOWTO, online at "
551 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
555 #: ../src/guestfs.pod:263
560 #: ../src/guestfs.pod:265
562 "Use L</guestfs_cat> to download small, text only files. This call is "
563 "limited to files which are less than 2 MB and which cannot contain any ASCII "
564 "NUL (C<\\0>) characters. However the API is very simple to use."
568 #: ../src/guestfs.pod:269
570 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
571 "bit data, since it returns a (pointer, size) pair. However it is still "
572 "limited to \"small\" files, less than 2 MB."
576 #: ../src/guestfs.pod:273
578 "L</guestfs_download> can be used to download any file, with no limits on "
579 "content or size (even files larger than 4 GB)."
583 #: ../src/guestfs.pod:276
584 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
588 #: ../src/guestfs.pod:279
593 #: ../src/guestfs.pod:281
595 "It's often the case that you want to write a file or files to the disk "
600 #: ../src/guestfs.pod:284
602 "To write a small file with fixed content, use L</guestfs_write>. To create "
603 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
604 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
605 "variety of other functions for creating test files, for example "
606 "L</guestfs_fill> and L</guestfs_fill_pattern>."
610 #: ../src/guestfs.pod:290
612 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
613 "file content or size (even files larger than 4 GB)."
617 #: ../src/guestfs.pod:293
618 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
622 #: ../src/guestfs.pod:295
624 "However the fastest way to upload I<large numbers of arbitrary files> is to "
625 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
626 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
627 "the drive in a predictable way (eg. adding it last after all other drives) "
628 "then you can get the device name from L</guestfs_list_devices> and mount it "
629 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
630 "sometimes non-portable between kernel versions, and they don't support "
631 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
632 "using a label or UUID, use an ISO image instead."
636 #: ../src/guestfs.pod:306
641 #: ../src/guestfs.pod:308
643 "There are various different commands for copying between files and devices "
644 "and in and out of the guest filesystem. These are summarised in the table "
649 #: ../src/guestfs.pod:314
650 msgid "B<file> to B<file>"
654 #: ../src/guestfs.pod:316
656 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
657 "directories recursively."
661 #: ../src/guestfs.pod:319
662 msgid "B<file or device> to B<file or device>"
666 #: ../src/guestfs.pod:321
668 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
669 "devices in the guest."
673 #: ../src/guestfs.pod:324
674 msgid "Example: duplicate the contents of an LV:"
678 #: ../src/guestfs.pod:326
681 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
686 #: ../src/guestfs.pod:328
688 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
689 "(C</dev/VG/Original>). To copy less than the whole source device, use "
690 "L</guestfs_copy_size>."
694 #: ../src/guestfs.pod:332
695 msgid "B<file on the host> to B<file or device>"
699 #: ../src/guestfs.pod:334
700 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
704 #: ../src/guestfs.pod:336
705 msgid "B<file or device> to B<file on the host>"
709 #: ../src/guestfs.pod:338
710 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
714 #: ../src/guestfs.pod:342
715 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
719 #: ../src/guestfs.pod:344
721 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
722 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
723 "appears you can only upload and download to files. However many Un*x-like "
724 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
725 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
726 "stderr, and arbitrary file descriptor N."
730 #: ../src/guestfs.pod:352
731 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
735 #: ../src/guestfs.pod:355
738 " guestfs_download (g, filename, \"/dev/stdout\");\n"
743 #: ../src/guestfs.pod:357
744 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
748 #: ../src/guestfs.pod:359
752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
753 " guestfs_tar_out (g, \"/\", devfd);\n"
758 #: ../src/guestfs.pod:363
759 msgid "LISTING FILES"
763 #: ../src/guestfs.pod:365
765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
766 "L<guestfish(1)>-equivalent command C<ll>)."
770 #: ../src/guestfs.pod:368
772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
773 "programs, as a flat list of strings."
777 #: ../src/guestfs.pod:371
779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
780 "directory, plus additional information about each one. It is more "
781 "equivalent to using the L<readdir(3)> call on a local filesystem."
785 #: ../src/guestfs.pod:375
787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
792 #: ../src/guestfs.pod:378
793 msgid "RUNNING COMMANDS"
797 #: ../src/guestfs.pod:380
799 "Although libguestfs is primarily an API for manipulating files inside guest "
800 "images, we also provide some limited facilities for running commands inside "
805 #: ../src/guestfs.pod:384
806 msgid "There are many limitations to this:"
810 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064 ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763 ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013 ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381 ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398 ../src/guestfs.pod:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975 ../src/guestfs.pod:2979 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1645 ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1796 ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:1862 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1871 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1074 ../fish/guestfish-actions.pod:1078 ../fish/guestfish-actions.pod:1082 ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116 ../fish/guestfish-actions.pod:1120 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1275 ../tools/virt-win-reg.pl:195 ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206 ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714 ../tools/virt-win-reg.pl:720
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395 ../src/guestfs.pod:2426
941 #: ../src/guestfs.pod:471
942 msgid "Before launching, do:"
946 #: ../src/guestfs.pod:473
949 " guestfs_set_selinux (g, 1);\n"
954 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399 ../src/guestfs.pod:2451
959 #: ../src/guestfs.pod:477
961 "After mounting the guest's filesystem(s), load the policy. This is best "
962 "done by running the L<load_policy(8)> command in the guest itself:"
966 #: ../src/guestfs.pod:481
969 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
974 #: ../src/guestfs.pod:483
976 "(Older versions of C<load_policy> require you to specify the name of the "
981 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
986 #: ../src/guestfs.pod:488
988 "Optionally, set the security context for the API. The correct security "
989 "context to use can only be known by inspecting the guest. As an example:"
993 #: ../src/guestfs.pod:492
996 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1001 #: ../src/guestfs.pod:496
1002 msgid "This will work for running commands and editing existing files."
1006 #: ../src/guestfs.pod:498
1008 "When new files are created, you may need to label them explicitly, for "
1009 "example by running the external command C<restorecon pathname>."
1013 #: ../src/guestfs.pod:502
1018 #: ../src/guestfs.pod:504
1020 "Certain calls are affected by the current file mode creation mask (the "
1021 "\"umask\"). In particular ones which create files or directories, such as "
1022 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1023 "either the default mode that the file is created with or modifies the mode "
1028 #: ../src/guestfs.pod:510
1030 "The default umask is C<022>, so files are created with modes such as C<0644> "
1031 "and directories with C<0755>."
1035 #: ../src/guestfs.pod:513
1037 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1038 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
1039 "L</guestfs_chmod> after creating each file or directory."
1043 #: ../src/guestfs.pod:517
1044 msgid "For more information about umask, see L<umask(2)>."
1048 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:767
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems, an install CD or a live CD. (These APIs used to "
1112 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1113 "version 1.5.3 the most frequently used part of this library has been "
1114 "rewritten in C and moved into the core code)."
1118 #: ../src/guestfs.pod:559
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:562
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:571
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:577
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:584
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:588
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:591
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:595
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:599
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:603
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:612
1213 msgid "INSPECTING INSTALL DISKS"
1217 #: ../src/guestfs.pod:614
1219 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1224 #: ../src/guestfs.pod:617
1226 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1227 "system, which currently can be C<installed> (a regular operating system) or "
1228 "C<installer> (some sort of install disk)."
1232 #: ../src/guestfs.pod:621
1234 "Further information is available about the operating system that can be "
1235 "installed using the regular inspection APIs like "
1236 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1241 #: ../src/guestfs.pod:626
1243 "Some additional information specific to installer disks is also available "
1244 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1245 "L</guestfs_inspect_is_multipart> calls."
1249 #: ../src/guestfs.pod:631
1250 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1254 #: ../src/guestfs.pod:633
1256 "Libguestfs can mount NTFS partitions. It does this using the "
1257 "L<http://www.ntfs-3g.org/> driver."
1261 #: ../src/guestfs.pod:636
1262 msgid "DRIVE LETTERS AND PATHS"
1266 #: ../src/guestfs.pod:638
1268 "DOS and Windows still use drive letters, and the filesystems are always "
1269 "treated as case insensitive by Windows itself, and therefore you might find "
1270 "a Windows configuration file referring to a path like "
1271 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1272 "that directory might be referred to as C</WINDOWS/System32>."
1276 #: ../src/guestfs.pod:644
1278 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1279 "L</guestfs_inspect_get_drive_mappings>)"
1283 #: ../src/guestfs.pod:647
1285 "Dealing with separator characters (backslash vs forward slash) is outside "
1286 "the scope of libguestfs, but usually a simple character replacement will "
1291 #: ../src/guestfs.pod:651
1293 "To resolve the case insensitivity of paths, call "
1294 "L</guestfs_case_sensitive_path>."
1298 #: ../src/guestfs.pod:654
1299 msgid "ACCESSING THE WINDOWS REGISTRY"
1303 #: ../src/guestfs.pod:656
1305 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1306 "files, through the library C<hivex> which is part of the libguestfs project "
1307 "although ships as a separate tarball. You have to locate and download the "
1308 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1309 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1310 "L<virt-win-reg(1)> for more help on this issue."
1314 #: ../src/guestfs.pod:664
1315 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1319 #: ../src/guestfs.pod:666
1321 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1322 "provide something which looks like a Linux symlink. The way it tries to do "
1323 "the rewriting is described here:"
1327 #: ../src/guestfs.pod:670
1328 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1332 #: ../src/guestfs.pod:672
1334 "The essential problem is that ntfs-3g simply does not have enough "
1335 "information to do a correct job. NTFS links can contain drive letters and "
1336 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1337 "It is almost certainly the case that libguestfs callers should ignore what "
1338 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1342 #: ../src/guestfs.pod:679
1344 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1345 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1346 "attribute, and read the raw reparse data from that (you can find the format "
1347 "documented in various places around the web)."
1351 #: ../src/guestfs.pod:684
1352 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1356 #: ../src/guestfs.pod:686
1358 "There are other useful extended attributes that can be read from ntfs-3g "
1359 "filesystems (using L</guestfs_getxattr>). See:"
1363 #: ../src/guestfs.pod:689
1364 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1368 #: ../src/guestfs.pod:691
1369 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1373 #: ../src/guestfs.pod:693
1375 "Although we don't want to discourage you from using the C API, we will "
1376 "mention here that the same API is also available in other languages."
1380 #: ../src/guestfs.pod:696
1382 "The API is broadly identical in all supported languages. This means that "
1383 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1384 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1385 "OCaml. In other words, a straightforward, predictable isomorphism between "
1390 #: ../src/guestfs.pod:702
1392 "Error messages are automatically transformed into exceptions if the language "
1397 #: ../src/guestfs.pod:705
1399 "We don't try to \"object orientify\" parts of the API in OO languages, "
1400 "although contributors are welcome to write higher level APIs above what we "
1401 "provide in their favourite languages if they wish."
1405 #: ../src/guestfs.pod:711
1410 #: ../src/guestfs.pod:713
1412 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1413 "identical to the C API. C++ classes and exceptions are not used."
1417 #: ../src/guestfs.pod:717
1422 #: ../src/guestfs.pod:719
1424 "The C# bindings are highly experimental. Please read the warnings at the "
1425 "top of C<csharp/Libguestfs.cs>."
1429 #: ../src/guestfs.pod:722
1434 #: ../src/guestfs.pod:724
1436 "This is the only language binding that is working but incomplete. Only "
1437 "calls which return simple integers have been bound in Haskell, and we are "
1438 "looking for help to complete this binding."
1442 #: ../src/guestfs.pod:728
1447 #: ../src/guestfs.pod:730
1449 "Full documentation is contained in the Javadoc which is distributed with "
1454 #: ../src/guestfs.pod:733
1459 #: ../src/guestfs.pod:735
1460 msgid "See L<guestfs-ocaml(3)>."
1464 #: ../src/guestfs.pod:737
1469 #: ../src/guestfs.pod:739
1470 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1474 #: ../src/guestfs.pod:741
1479 #: ../src/guestfs.pod:743
1481 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1482 "the php-libguestfs package for your distribution."
1486 #: ../src/guestfs.pod:746
1487 msgid "The PHP binding only works correctly on 64 bit machines."
1491 #: ../src/guestfs.pod:748
1496 #: ../src/guestfs.pod:750
1497 msgid "See L<guestfs-python(3)>."
1501 #: ../src/guestfs.pod:752
1506 #: ../src/guestfs.pod:754
1507 msgid "See L<guestfs-ruby(3)>."
1511 #: ../src/guestfs.pod:756
1512 msgid "B<shell scripts>"
1516 #: ../src/guestfs.pod:758
1517 msgid "See L<guestfish(1)>."
1521 #: ../src/guestfs.pod:762
1522 msgid "LIBGUESTFS GOTCHAS"
1526 #: ../src/guestfs.pod:764
1528 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1529 "system [...] that works in the way it is documented but is counterintuitive "
1530 "and almost invites mistakes.\""
1534 #: ../src/guestfs.pod:768
1536 "Since we developed libguestfs and the associated tools, there are several "
1537 "things we would have designed differently, but are now stuck with for "
1538 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1539 "release, you can expect these to change. Beware of them."
1543 #: ../src/guestfs.pod:776
1544 msgid "Autosync / forgetting to sync."
1548 #: ../src/guestfs.pod:778
1550 "I<Update:> Autosync is enabled by default for all API users starting from "
1551 "libguestfs 1.5.24. This section only applies to older versions."
1555 #: ../src/guestfs.pod:781
1557 "When modifying a filesystem from C or another language, you B<must> unmount "
1558 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1559 "libguestfs handle. You can also call:"
1563 #: ../src/guestfs.pod:785
1566 " guestfs_set_autosync (g, 1);\n"
1571 #: ../src/guestfs.pod:787
1573 "to have the unmount/sync done automatically for you when the handle 'g' is "
1574 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1579 #: ../src/guestfs.pod:791
1581 "If you forget to do this, then it is entirely possible that your changes "
1582 "won't be written out, or will be partially written, or (very rarely) that "
1583 "you'll get disk corruption."
1587 #: ../src/guestfs.pod:795
1589 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1590 "guestfish scripts that forget to sync will work just fine, which can make "
1591 "this very puzzling if you are trying to debug a problem."
1595 #: ../src/guestfs.pod:799
1596 msgid "Mount option C<-o sync> should not be the default."
1600 #: ../src/guestfs.pod:801
1602 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1603 "However C<-o sync> does not add any reliability benefit, but does have a "
1604 "very large performance impact."
1608 #: ../src/guestfs.pod:805
1610 "The work around is to use L</guestfs_mount_options> and set the mount "
1611 "options that you actually want to use."
1615 #: ../src/guestfs.pod:808
1616 msgid "Read-only should be the default."
1620 #: ../src/guestfs.pod:810
1622 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1623 "specify I<--rw> if you want to make changes to the image."
1627 #: ../src/guestfs.pod:813
1628 msgid "This would reduce the potential to corrupt live VM images."
1632 #: ../src/guestfs.pod:815
1634 "Note that many filesystems change the disk when you just mount and unmount, "
1635 "even if you didn't perform any writes. You need to use "
1636 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1640 #: ../src/guestfs.pod:819
1641 msgid "guestfish command line is hard to use."
1645 #: ../src/guestfs.pod:821
1647 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1648 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1649 "exist, so it fails. In earlier versions of guestfish the error message was "
1650 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1651 "we should have used C<guestfish -c command> to run commands."
1655 #: ../src/guestfs.pod:828
1656 msgid "guestfish megabyte modifiers don't work right on all commands"
1660 #: ../src/guestfs.pod:830
1662 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1663 "other modifiers). What guestfish actually does is to multiply the number "
1664 "part by the modifier part and pass the result to the C API. However this "
1665 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1666 "expecting some other unit (eg. megabytes)."
1670 #: ../src/guestfs.pod:837
1671 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1675 #: ../src/guestfs.pod:839
1678 " lvcreate LV VG 100M\n"
1683 #: ../src/guestfs.pod:841
1685 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1686 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1687 "megabytes * megabytes) logical volume. The error message you get from this "
1688 "is also a little obscure."
1692 #: ../src/guestfs.pod:846
1694 "This could be fixed in the generator by specially marking parameters and "
1695 "return values which take bytes or other units."
1699 #: ../src/guestfs.pod:849
1700 msgid "Ambiguity between devices and paths"
1704 #: ../src/guestfs.pod:851
1706 "There is a subtle ambiguity in the API between a device name "
1707 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1708 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1712 #: ../src/guestfs.pod:856
1714 "In the current API we usually resolve this ambiguity by having two separate "
1715 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1716 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1717 "detecting if the path supplied begins with C</dev/>."
1721 #: ../src/guestfs.pod:862
1723 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1724 "make paths/devices into structured names. One way to do this would be to "
1725 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1726 "aspect of grub. Another way would be to use a structured type, equivalent "
1727 "to this OCaml type:"
1731 #: ../src/guestfs.pod:868
1734 " type path = Path of string | Device of int | Partition of int * int\n"
1739 #: ../src/guestfs.pod:870
1740 msgid "which would allow you to pass arguments like:"
1744 #: ../src/guestfs.pod:872
1747 " Path \"/foo/bar\"\n"
1748 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1749 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1750 " Path \"/dev/sdb2\" (* not a device *)\n"
1755 #: ../src/guestfs.pod:877
1757 "As you can see there are still problems to resolve even with this "
1758 "representation. Also consider how it might work in guestfish."
1762 #: ../src/guestfs.pod:882
1763 msgid "KEYS AND PASSPHRASES"
1767 #: ../src/guestfs.pod:884
1769 "Certain libguestfs calls take a parameter that contains sensitive key "
1770 "material, passed in as a C string."
1774 #: ../src/guestfs.pod:887
1776 "In the future we would hope to change the libguestfs implementation so that "
1777 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1778 "swap. However this is I<not> done at the moment, because of the complexity "
1779 "of such an implementation."
1783 #: ../src/guestfs.pod:892
1785 "Therefore you should be aware that any key parameter you pass to libguestfs "
1786 "might end up being written out to the swap partition. If this is a concern, "
1787 "scrub the swap partition or don't use libguestfs on encrypted devices."
1791 #: ../src/guestfs.pod:897
1792 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1796 #: ../src/guestfs.pod:899
1798 "All high-level libguestfs actions are synchronous. If you want to use "
1799 "libguestfs asynchronously then you must create a thread."
1803 #: ../src/guestfs.pod:902
1805 "Only use the handle from a single thread. Either use the handle exclusively "
1806 "from one thread, or provide your own mutex so that two threads cannot issue "
1807 "calls on the same handle at the same time."
1811 #: ../src/guestfs.pod:906
1813 "See the graphical program guestfs-browser for one possible architecture for "
1814 "multithreaded programs using libvirt and libguestfs."
1818 #: ../src/guestfs.pod:909
1823 #: ../src/guestfs.pod:911
1825 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1830 #: ../src/guestfs.pod:914
1832 "By default it looks for these in the directory C<$libdir/guestfs> "
1833 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1837 #: ../src/guestfs.pod:917
1839 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1840 "to change the directories that libguestfs will search in. The value is a "
1841 "colon-separated list of paths. The current directory is I<not> searched "
1842 "unless the path contains an empty element or C<.>. For example "
1843 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1844 "then C</usr/lib/guestfs>."
1848 #: ../src/guestfs.pod:924
1849 msgid "QEMU WRAPPERS"
1853 #: ../src/guestfs.pod:926
1855 "If you want to compile your own qemu, run qemu from a non-standard location, "
1856 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1861 #: ../src/guestfs.pod:930
1863 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1864 "last command in the shell script (so that qemu replaces the shell and "
1865 "becomes the direct child of the libguestfs-using program). If you don't do "
1866 "this, then the qemu process won't be cleaned up correctly."
1870 #: ../src/guestfs.pod:935
1872 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1877 #: ../src/guestfs.pod:938
1881 " qemudir=/home/rjones/d/qemu\n"
1882 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1888 #: ../src/guestfs.pod:942
1890 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1891 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1896 #: ../src/guestfs.pod:946
1899 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1904 #: ../src/guestfs.pod:948
1906 "Note that libguestfs also calls qemu with the -help and -version options in "
1907 "order to determine features."
1911 #: ../src/guestfs.pod:951
1912 msgid "ATTACHING TO RUNNING DAEMONS"
1916 #: ../src/guestfs.pod:953
1918 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
1919 "babies. Use with caution."
1923 #: ../src/guestfs.pod:956
1925 "I<Note (2):> This section explains how to attach to a running daemon from a "
1926 "low level perspective. For most users, simply using virt tools such as "
1927 "L<guestfish(1)> with the I<--live> option will \"just work\"."
1931 #: ../src/guestfs.pod:960
1932 msgid "Using guestfs_set_attach_method"
1936 #: ../src/guestfs.pod:962
1938 "By calling L</guestfs_set_attach_method> you can change how the library "
1939 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
1940 "L</ARCHITECTURE> for some background)."
1944 #: ../src/guestfs.pod:966
1946 "The normal attach method is C<appliance>, where a small appliance is created "
1947 "containing the daemon, and then the library connects to this."
1951 #: ../src/guestfs.pod:969
1953 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
1954 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
1955 "daemon over the Unix domain socket."
1959 #: ../src/guestfs.pod:973
1961 "The normal use for this is to connect to a running virtual machine that "
1962 "contains a C<guestfsd> daemon, and send commands so you can read and write "
1963 "files inside the live virtual machine."
1967 #: ../src/guestfs.pod:977
1968 msgid "Using guestfs_add_domain with live flag"
1972 #: ../src/guestfs.pod:979
1974 "L</guestfs_add_domain> provides some help for getting the correct attach "
1975 "method. If you pass the C<live> option to this function, then (if the "
1976 "virtual machine is running) it will examine the libvirt XML looking for a "
1977 "virtio-serial channel to connect to:"
1981 #: ../src/guestfs.pod:985
1988 " <channel type='unix'>\n"
1989 " <source mode='bind' path='/path/to/socket'/>\n"
1990 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
1999 #: ../src/guestfs.pod:997
2001 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2002 "method to C<unix:/path/to/socket>."
2006 #: ../src/guestfs.pod:1000
2008 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2009 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2010 "to attach to and modify live virtual machines."
2014 #: ../src/guestfs.pod:1004
2016 "The virtual machine needs to have been set up beforehand so that it has the "
2017 "virtio-serial channel and so that guestfsd is running inside it."
2021 #: ../src/guestfs.pod:1008
2022 msgid "ABI GUARANTEE"
2026 #: ../src/guestfs.pod:1010
2028 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2029 "actions as outlined in this section. Although we will deprecate some "
2030 "actions, for example if they get replaced by newer calls, we will keep the "
2031 "old actions forever. This allows you the developer to program in confidence "
2032 "against the libguestfs API."
2036 #: ../src/guestfs.pod:1016
2037 msgid "BLOCK DEVICE NAMING"
2041 #: ../src/guestfs.pod:1018
2043 "In the kernel there is now quite a profusion of schemata for naming block "
2044 "devices (in this context, by I<block device> I mean a physical or virtual "
2045 "hard drive). The original Linux IDE driver used names starting with "
2046 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
2047 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2048 "replacement for the old IDE driver (particularly for SATA devices) those "
2049 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2050 "machines with paravirtualized drivers. This has created several different "
2051 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2056 #: ../src/guestfs.pod:1030
2058 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2059 "Linux kernel to access block devices. We can run a variety of appliances "
2060 "based on a variety of Linux kernels."
2064 #: ../src/guestfs.pod:1034
2066 "This causes a problem for libguestfs because many API calls use device or "
2067 "partition names. Working scripts and the recipe (example) scripts that we "
2068 "make available over the internet could fail if the naming scheme changes."
2072 #: ../src/guestfs.pod:1039
2074 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2075 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2076 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2077 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2081 #: ../src/guestfs.pod:1045
2083 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2084 "L</guestfs_list_partitions> and similar calls return the true names of the "
2085 "devices and partitions as known to the appliance."
2089 #: ../src/guestfs.pod:1050
2090 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2094 #: ../src/guestfs.pod:1052
2096 "Usually this translation is transparent. However in some (very rare) cases "
2097 "you may need to know the exact algorithm. Such cases include where you use "
2098 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2099 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2104 #: ../src/guestfs.pod:1058
2106 "The algorithm is applied only to I<parameters> which are known to be either "
2107 "device or partition names. Return values from functions such as "
2108 "L</guestfs_list_devices> are never changed."
2112 #: ../src/guestfs.pod:1066
2113 msgid "Is the string a parameter which is a device or partition name?"
2117 #: ../src/guestfs.pod:1070
2118 msgid "Does the string begin with C</dev/sd>?"
2122 #: ../src/guestfs.pod:1074
2124 "Does the named device exist? If so, we use that device. However if I<not> "
2125 "then we continue with this algorithm."
2129 #: ../src/guestfs.pod:1079
2130 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2134 #: ../src/guestfs.pod:1081
2135 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2139 #: ../src/guestfs.pod:1083
2140 msgid "If that named device exists, use it. If not, continue."
2144 #: ../src/guestfs.pod:1087
2145 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2149 #: ../src/guestfs.pod:1089
2150 msgid "If that named device exists, use it. If not, return an error."
2154 #: ../src/guestfs.pod:1093
2155 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2159 #: ../src/guestfs.pod:1095
2161 "Although the standard naming scheme and automatic translation is useful for "
2162 "simple programs and guestfish scripts, for larger programs it is best not to "
2163 "rely on this mechanism."
2167 #: ../src/guestfs.pod:1099
2169 "Where possible for maximum future portability programs using libguestfs "
2170 "should use these future-proof techniques:"
2174 #: ../src/guestfs.pod:1106
2176 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2177 "device names, and then use those names directly."
2181 #: ../src/guestfs.pod:1109
2182 msgid "Since those device names exist by definition, they will never be translated."
2186 #: ../src/guestfs.pod:1114
2188 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2189 "filesystem labels."
2193 #: ../src/guestfs.pod:1119
2198 #: ../src/guestfs.pod:1121
2200 "This section discusses security implications of using libguestfs, "
2201 "particularly with untrusted or malicious guests or disk images."
2205 #: ../src/guestfs.pod:1124
2206 msgid "GENERAL SECURITY CONSIDERATIONS"
2210 #: ../src/guestfs.pod:1126
2212 "Be careful with any files or data that you download from a guest (by "
2213 "\"download\" we mean not just the L</guestfs_download> command but any "
2214 "command that reads files, filenames, directories or anything else from a "
2215 "disk image). An attacker could manipulate the data to fool your program "
2216 "into doing the wrong thing. Consider cases such as:"
2220 #: ../src/guestfs.pod:1136
2221 msgid "the data (file etc) not being present"
2225 #: ../src/guestfs.pod:1140
2226 msgid "being present but empty"
2230 #: ../src/guestfs.pod:1144
2231 msgid "being much larger than normal"
2235 #: ../src/guestfs.pod:1148
2236 msgid "containing arbitrary 8 bit data"
2240 #: ../src/guestfs.pod:1152
2241 msgid "being in an unexpected character encoding"
2245 #: ../src/guestfs.pod:1156
2246 msgid "containing homoglyphs."
2250 #: ../src/guestfs.pod:1160
2251 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2255 #: ../src/guestfs.pod:1162
2257 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2258 "(VFS) module can sometimes be escalated into exploits by deliberately "
2259 "creating a malicious, malformed filesystem. These exploits are very severe "
2260 "for two reasons. Firstly there are very many filesystem drivers in the "
2261 "kernel, and many of them are infrequently used and not much developer "
2262 "attention has been paid to the code. Linux userspace helps potential "
2263 "crackers by detecting the filesystem type and automatically choosing the "
2264 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2265 "the administrator. Secondly, a kernel-level exploit is like a local root "
2266 "exploit (worse in some ways), giving immediate and total access to the "
2267 "system right down to the hardware level."
2271 #: ../src/guestfs.pod:1175
2273 "That explains why you should never mount a filesystem from an untrusted "
2274 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2275 "inside a qemu virtual machine, usually running as a non-root user. The "
2276 "attacker would need to write a filesystem which first exploited the kernel, "
2277 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2278 "the libguestfs protocol, and finally to be as serious as the host kernel "
2279 "exploit it would need to escalate its privileges to root. This multi-step "
2280 "escalation, performed by a static piece of data, is thought to be extremely "
2281 "hard to do, although we never say 'never' about security issues."
2285 #: ../src/guestfs.pod:1186
2287 "In any case callers can reduce the attack surface by forcing the filesystem "
2288 "type when mounting (use L</guestfs_mount_vfs>)."
2292 #: ../src/guestfs.pod:1189
2293 msgid "PROTOCOL SECURITY"
2297 #: ../src/guestfs.pod:1191
2299 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2300 "defined upper message size. However a program that uses libguestfs must "
2301 "also take care - for example you can write a program that downloads a binary "
2302 "from a disk image and executes it locally, and no amount of protocol "
2303 "security will save you from the consequences."
2307 #: ../src/guestfs.pod:1197
2308 msgid "INSPECTION SECURITY"
2312 #: ../src/guestfs.pod:1199
2314 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2315 "directly from the guest, and these could contain any 8 bit data. Callers "
2316 "should be careful to escape these before printing them to a structured file "
2317 "(for example, use HTML escaping if creating a web page)."
2321 #: ../src/guestfs.pod:1205
2323 "Guest configuration may be altered in unusual ways by the administrator of "
2324 "the virtual machine, and may not reflect reality (particularly for untrusted "
2325 "or actively malicious guests). For example we parse the hostname from "
2326 "configuration files like C</etc/sysconfig/network> that we find in the "
2327 "guest, but the guest administrator can easily manipulate these files to "
2328 "provide the wrong hostname."
2332 #: ../src/guestfs.pod:1213
2334 "The inspection API parses guest configuration using two external libraries: "
2335 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2336 "designed to be robust in the face of malicious data, although denial of "
2337 "service attacks are still possible, for example with oversized configuration "
2342 #: ../src/guestfs.pod:1219
2343 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2347 #: ../src/guestfs.pod:1221
2349 "Be very cautious about running commands from the guest. By running a "
2350 "command in the guest, you are giving CPU time to a binary that you do not "
2351 "control, under the same user account as the library, albeit wrapped in qemu "
2352 "virtualization. More information and alternatives can be found in the "
2353 "section L</RUNNING COMMANDS>."
2357 #: ../src/guestfs.pod:1227
2358 msgid "CVE-2010-3851"
2362 #: ../src/guestfs.pod:1229
2363 msgid "https://bugzilla.redhat.com/642934"
2367 #: ../src/guestfs.pod:1231
2369 "This security bug concerns the automatic disk format detection that qemu "
2370 "does on disk images."
2374 #: ../src/guestfs.pod:1234
2376 "A raw disk image is just the raw bytes, there is no header. Other disk "
2377 "images like qcow2 contain a special header. Qemu deals with this by looking "
2378 "for one of the known headers, and if none is found then assuming the disk "
2379 "image must be raw."
2383 #: ../src/guestfs.pod:1239
2385 "This allows a guest which has been given a raw disk image to write some "
2386 "other header. At next boot (or when the disk image is accessed by "
2387 "libguestfs) qemu would do autodetection and think the disk image format was, "
2388 "say, qcow2 based on the header written by the guest."
2392 #: ../src/guestfs.pod:1244
2394 "This in itself would not be a problem, but qcow2 offers many features, one "
2395 "of which is to allow a disk image to refer to another image (called the "
2396 "\"backing disk\"). It does this by placing the path to the backing disk "
2397 "into the qcow2 header. This path is not validated and could point to any "
2398 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2399 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2400 "control of the attacker."
2404 #: ../src/guestfs.pod:1252
2405 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2409 #: ../src/guestfs.pod:1259
2410 msgid "You have enabled the network or have opened the disk in write mode."
2414 #: ../src/guestfs.pod:1263
2416 "You are also running untrusted code from the guest (see L</RUNNING "
2421 #: ../src/guestfs.pod:1268
2423 "The way to avoid this is to specify the expected disk format when adding "
2424 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2425 "should always do this if the disk is raw format, and it's a good idea for "
2430 #: ../src/guestfs.pod:1273
2432 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2433 "format is fetched from libvirt and passed through."
2437 #: ../src/guestfs.pod:1276
2439 "For libguestfs tools, use the I<--format> command line parameter as "
2444 #: ../src/guestfs.pod:1279
2445 msgid "CONNECTION MANAGEMENT"
2449 #: ../src/guestfs.pod:1281
2454 #: ../src/guestfs.pod:1283
2456 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2457 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2458 "handle and release all resources used."
2462 #: ../src/guestfs.pod:1287
2464 "For information on using multiple handles and threads, see the section "
2465 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2469 #: ../src/guestfs.pod:1290
2470 msgid "guestfs_create"
2474 #: ../src/guestfs.pod:1292
2477 " guestfs_h *guestfs_create (void);\n"
2482 #: ../src/guestfs.pod:1294
2483 msgid "Create a connection handle."
2487 #: ../src/guestfs.pod:1296
2489 "On success this returns a non-NULL pointer to a handle. On error it returns "
2494 #: ../src/guestfs.pod:1299
2496 "You have to \"configure\" the handle after creating it. This includes "
2497 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2498 "handle at least once."
2502 #: ../src/guestfs.pod:1303
2503 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2507 #: ../src/guestfs.pod:1305
2509 "You may also want to configure error handling for the handle. See the "
2510 "L</ERROR HANDLING> section below."
2514 #: ../src/guestfs.pod:1308
2515 msgid "guestfs_close"
2519 #: ../src/guestfs.pod:1310
2522 " void guestfs_close (guestfs_h *g);\n"
2527 #: ../src/guestfs.pod:1312
2528 msgid "This closes the connection handle and frees up all resources used."
2532 #: ../src/guestfs.pod:1314
2534 "If autosync was set on the handle and the handle was launched, then this "
2535 "implicitly calls various functions to unmount filesystems and sync the "
2536 "disk. See L</guestfs_set_autosync> for more details."
2540 #: ../src/guestfs.pod:1318
2541 msgid "If a close callback was set on the handle, then it is called."
2545 #: ../src/guestfs.pod:1320
2546 msgid "ERROR HANDLING"
2550 #: ../src/guestfs.pod:1322
2552 "API functions can return errors. For example, almost all functions that "
2553 "return C<int> will return C<-1> to indicate an error."
2557 #: ../src/guestfs.pod:1325
2559 "Additional information is available for errors: an error message string and "
2560 "optionally an error number (errno) if the thing that failed was a system "
2565 #: ../src/guestfs.pod:1329
2567 "You can get at the additional information about the last error on the handle "
2568 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2569 "up an error handler with L</guestfs_set_error_handler>."
2573 #: ../src/guestfs.pod:1334
2575 "When the handle is created, a default error handler is installed which "
2576 "prints the error message string to C<stderr>. For small short-running "
2577 "command line programs it is sufficient to do:"
2581 #: ../src/guestfs.pod:1338
2584 " if (guestfs_launch (g) == -1)\n"
2585 " exit (EXIT_FAILURE);\n"
2590 #: ../src/guestfs.pod:1341
2592 "since the default error handler will ensure that an error message has been "
2593 "printed to C<stderr> before the program exits."
2597 #: ../src/guestfs.pod:1344
2599 "For other programs the caller will almost certainly want to install an "
2600 "alternate error handler or do error handling in-line like this:"
2604 #: ../src/guestfs.pod:1347
2607 " g = guestfs_create ();\n"
2612 #: ../src/guestfs.pod:1349
2615 " /* This disables the default behaviour of printing errors\n"
2617 " guestfs_set_error_handler (g, NULL, NULL);\n"
2622 #: ../src/guestfs.pod:1353
2625 " if (guestfs_launch (g) == -1) {\n"
2626 " /* Examine the error message and print it etc. */\n"
2627 " char *msg = guestfs_last_error (g);\n"
2628 " int errnum = guestfs_last_errno (g);\n"
2629 " fprintf (stderr, \"%s\\n\", msg);\n"
2636 #: ../src/guestfs.pod:1361
2638 "Out of memory errors are handled differently. The default action is to call "
2639 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2640 "L</guestfs_set_out_of_memory_handler>."
2644 #: ../src/guestfs.pod:1365
2646 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2647 "because there is no handle if this happens there is no way to get additional "
2648 "error information. However L</guestfs_create> is supposed to be a "
2649 "lightweight operation which can only fail because of insufficient memory (it "
2650 "returns NULL in this case)."
2654 #: ../src/guestfs.pod:1371
2655 msgid "guestfs_last_error"
2659 #: ../src/guestfs.pod:1373
2662 " const char *guestfs_last_error (guestfs_h *g);\n"
2667 #: ../src/guestfs.pod:1375
2669 "This returns the last error message that happened on C<g>. If there has not "
2670 "been an error since the handle was created, then this returns C<NULL>."
2674 #: ../src/guestfs.pod:1379
2676 "The lifetime of the returned string is until the next error occurs, or "
2677 "L</guestfs_close> is called."
2681 #: ../src/guestfs.pod:1382
2682 msgid "guestfs_last_errno"
2686 #: ../src/guestfs.pod:1384
2689 " int guestfs_last_errno (guestfs_h *g);\n"
2694 #: ../src/guestfs.pod:1386
2695 msgid "This returns the last error number (errno) that happened on C<g>."
2699 #: ../src/guestfs.pod:1388
2700 msgid "If successful, an errno integer not equal to zero is returned."
2704 #: ../src/guestfs.pod:1390
2705 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2709 #: ../src/guestfs.pod:1397
2710 msgid "There has not been any error on the handle."
2714 #: ../src/guestfs.pod:1401
2716 "There has been an error but the errno was meaningless. This corresponds to "
2717 "the case where the error did not come from a failed system call, but for "
2718 "some other reason."
2722 #: ../src/guestfs.pod:1407
2724 "There was an error from a failed system call, but for some reason the errno "
2725 "was not captured and returned. This usually indicates a bug in libguestfs."
2729 #: ../src/guestfs.pod:1413
2731 "Libguestfs tries to convert the errno from inside the applicance into a "
2732 "corresponding errno for the caller (not entirely trivial: the appliance "
2733 "might be running a completely different operating system from the library "
2734 "and error numbers are not standardized across Un*xen). If this could not be "
2735 "done, then the error is translated to C<EINVAL>. In practice this should "
2736 "only happen in very rare circumstances."
2740 #: ../src/guestfs.pod:1421
2741 msgid "guestfs_set_error_handler"
2745 #: ../src/guestfs.pod:1423
2748 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2750 " const char *msg);\n"
2751 " void guestfs_set_error_handler (guestfs_h *g,\n"
2752 " guestfs_error_handler_cb cb,\n"
2758 #: ../src/guestfs.pod:1430
2760 "The callback C<cb> will be called if there is an error. The parameters "
2761 "passed to the callback are an opaque data pointer and the error message "
2766 #: ../src/guestfs.pod:1434
2768 "C<errno> is not passed to the callback. To get that the callback must call "
2769 "L</guestfs_last_errno>."
2773 #: ../src/guestfs.pod:1437
2775 "Note that the message string C<msg> is freed as soon as the callback "
2776 "function returns, so if you want to stash it somewhere you must make your "
2781 #: ../src/guestfs.pod:1441
2782 msgid "The default handler prints messages on C<stderr>."
2786 #: ../src/guestfs.pod:1443
2787 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2791 #: ../src/guestfs.pod:1445
2792 msgid "guestfs_get_error_handler"
2796 #: ../src/guestfs.pod:1447
2799 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2800 " void **opaque_rtn);\n"
2805 #: ../src/guestfs.pod:1450
2806 msgid "Returns the current error handler callback."
2810 #: ../src/guestfs.pod:1452
2811 msgid "guestfs_set_out_of_memory_handler"
2815 #: ../src/guestfs.pod:1454
2818 " typedef void (*guestfs_abort_cb) (void);\n"
2819 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2820 " guestfs_abort_cb);\n"
2825 #: ../src/guestfs.pod:1458
2827 "The callback C<cb> will be called if there is an out of memory situation. "
2828 "I<Note this callback must not return>."
2832 #: ../src/guestfs.pod:1461
2833 msgid "The default is to call L<abort(3)>."
2837 #: ../src/guestfs.pod:1463
2838 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2842 #: ../src/guestfs.pod:1466
2843 msgid "guestfs_get_out_of_memory_handler"
2847 #: ../src/guestfs.pod:1468
2850 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2855 #: ../src/guestfs.pod:1470
2856 msgid "This returns the current out of memory handler."
2860 #: ../src/guestfs.pod:1472
2865 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
2870 #: ../src/guestfs.pod:1476
2875 #: ../src/guestfs.pod:1478
2880 #: ../src/guestfs.pod:1480
2881 msgid "AVAILABILITY"
2885 #: ../src/guestfs.pod:1482
2886 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2890 #: ../src/guestfs.pod:1484
2892 "Using L</guestfs_available> you can test availability of the following "
2893 "groups of functions. This test queries the appliance to see if the "
2894 "appliance you are currently using supports the functionality."
2898 #: ../src/guestfs.pod:1489
2899 msgid "@AVAILABILITY@"
2903 #: ../src/guestfs.pod:1491
2904 msgid "GUESTFISH supported COMMAND"
2908 #: ../src/guestfs.pod:1493
2910 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2911 "prints out the available groups and whether they are supported by this build "
2912 "of libguestfs. Note however that you have to do C<run> first."
2916 #: ../src/guestfs.pod:1498
2917 msgid "SINGLE CALLS AT COMPILE TIME"
2921 #: ../src/guestfs.pod:1500
2923 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2924 "function, such as:"
2928 #: ../src/guestfs.pod:1503
2931 " #define LIBGUESTFS_HAVE_DD 1\n"
2936 #: ../src/guestfs.pod:1505
2937 msgid "if L</guestfs_dd> is available."
2941 #: ../src/guestfs.pod:1507
2943 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2944 "function is available at compile time, we recommended using build tools such "
2945 "as autoconf or cmake. For example in autotools you could use:"
2949 #: ../src/guestfs.pod:1512
2952 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2953 " AC_CHECK_FUNCS([guestfs_dd])\n"
2958 #: ../src/guestfs.pod:1515
2960 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2965 #: ../src/guestfs.pod:1518
2966 msgid "SINGLE CALLS AT RUN TIME"
2970 #: ../src/guestfs.pod:1520
2972 "Testing at compile time doesn't guarantee that a function really exists in "
2973 "the library. The reason is that you might be dynamically linked against a "
2974 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2975 "This situation unfortunately results in a segmentation fault, which is a "
2976 "shortcoming of the C dynamic linking system itself."
2980 #: ../src/guestfs.pod:1527
2982 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2983 "in this example program (note that you still need the compile time check as "
2988 #: ../src/guestfs.pod:1531
2991 " #include <stdio.h>\n"
2992 " #include <stdlib.h>\n"
2993 " #include <unistd.h>\n"
2994 " #include <dlfcn.h>\n"
2995 " #include <guestfs.h>\n"
3000 #: ../src/guestfs.pod:1537
3005 " #ifdef LIBGUESTFS_HAVE_DD\n"
3007 " int has_function;\n"
3012 #: ../src/guestfs.pod:1543
3015 " /* Test if the function guestfs_dd is really available. */\n"
3016 " dl = dlopen (NULL, RTLD_LAZY);\n"
3018 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3019 " exit (EXIT_FAILURE);\n"
3021 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3027 #: ../src/guestfs.pod:1552
3030 " if (!has_function)\n"
3031 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3033 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3034 " /* Now it's safe to call\n"
3035 " guestfs_dd (g, \"foo\", \"bar\");\n"
3039 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3046 #: ../src/guestfs.pod:1565
3048 "You may think the above is an awful lot of hassle, and it is. There are "
3049 "other ways outside of the C linking system to ensure that this kind of "
3050 "incompatibility never arises, such as using package versioning:"
3054 #: ../src/guestfs.pod:1570
3057 " Requires: libguestfs >= 1.0.80\n"
3062 #: ../src/guestfs.pod:1572
3063 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3067 #: ../src/guestfs.pod:1574
3069 "A recent feature of the API is the introduction of calls which take optional "
3070 "arguments. In C these are declared 3 ways. The main way is as a call which "
3071 "takes variable arguments (ie. C<...>), as in this example:"
3075 #: ../src/guestfs.pod:1579
3078 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3083 #: ../src/guestfs.pod:1581
3085 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3086 "call with no optional arguments specified:"
3090 #: ../src/guestfs.pod:1584
3093 " guestfs_add_drive_opts (g, filename, -1);\n"
3098 #: ../src/guestfs.pod:1586
3099 msgid "With a single optional argument:"
3103 #: ../src/guestfs.pod:1588
3106 " guestfs_add_drive_opts (g, filename,\n"
3107 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3113 #: ../src/guestfs.pod:1592
3118 #: ../src/guestfs.pod:1594
3121 " guestfs_add_drive_opts (g, filename,\n"
3122 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3123 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3129 #: ../src/guestfs.pod:1599
3131 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3136 #: ../src/guestfs.pod:1602
3137 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3141 #: ../src/guestfs.pod:1604
3143 "The second variant has the same name with the suffix C<_va>, which works the "
3144 "same way but takes a C<va_list>. See the C manual for details. For the "
3145 "example function, this is declared:"
3149 #: ../src/guestfs.pod:1608
3152 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3158 #: ../src/guestfs.pod:1611
3159 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3163 #: ../src/guestfs.pod:1613
3165 "The third variant is useful where you need to construct these calls. You "
3166 "pass in a structure where you fill in the optional fields. The structure "
3167 "has a bitmask as the first element which you must set to indicate which "
3168 "fields you have filled in. For our example function the structure and call "
3173 #: ../src/guestfs.pod:1619
3176 " struct guestfs_add_drive_opts_argv {\n"
3177 " uint64_t bitmask;\n"
3179 " const char *format;\n"
3182 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3183 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3188 #: ../src/guestfs.pod:1628
3189 msgid "You could call it like this:"
3193 #: ../src/guestfs.pod:1630
3196 " struct guestfs_add_drive_opts_argv optargs = {\n"
3197 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3198 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3200 " .format = \"qcow2\"\n"
3206 #: ../src/guestfs.pod:1637
3209 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3214 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262 ../tools/virt-win-reg.pl:704
3219 #: ../src/guestfs.pod:1645
3220 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3224 #: ../src/guestfs.pod:1650
3225 msgid "You do not need to fill in all fields of the structure."
3229 #: ../src/guestfs.pod:1654
3231 "There must be a one-to-one correspondence between fields of the structure "
3232 "that are filled in, and bits set in the bitmask."
3236 #: ../src/guestfs.pod:1659
3237 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3241 #: ../src/guestfs.pod:1661
3243 "In other languages, optional arguments are expressed in the way that is "
3244 "natural for that language. We refer you to the language-specific "
3245 "documentation for more details on that."
3249 #: ../src/guestfs.pod:1665
3250 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3254 #: ../src/guestfs.pod:1667
3255 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3259 #: ../src/guestfs.pod:1669
3261 "B<Note:> This section documents the generic event mechanism introduced in "
3262 "libguestfs 1.10, which you should use in new code if possible. The old "
3263 "functions C<guestfs_set_log_message_callback>, "
3264 "C<guestfs_set_subprocess_quit_callback>, "
3265 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3266 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3267 "page. Because of the ABI guarantee, the old functions continue to work."
3271 #: ../src/guestfs.pod:1678
3273 "Handles generate events when certain things happen, such as log messages "
3274 "being generated, progress messages during long-running operations, or the "
3275 "handle being closed. The API calls described below let you register a "
3276 "callback to be called when events happen. You can register multiple "
3277 "callbacks (for the same, different or overlapping sets of events), and "
3278 "individually remove callbacks. If callbacks are not removed, then they "
3279 "remain in force until the handle is closed."
3283 #: ../src/guestfs.pod:1686
3285 "In the current implementation, events are only generated synchronously: that "
3286 "means that events (and hence callbacks) can only happen while you are in the "
3287 "middle of making another libguestfs call. The callback is called in the "
3292 #: ../src/guestfs.pod:1691
3294 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3295 "unsigned integers, or a message buffer. Payloads are discussed later on."
3299 #: ../src/guestfs.pod:1695
3300 msgid "CLASSES OF EVENTS"
3304 #: ../src/guestfs.pod:1699
3305 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3309 #: ../src/guestfs.pod:1702
3311 "The callback function will be called while the handle is being closed "
3312 "(synchronously from L</guestfs_close>)."
3316 #: ../src/guestfs.pod:1705
3318 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3319 "handles that are open when the program exits. This means that this callback "
3320 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3321 "problems in higher-level languages (eg. if your HLL interpreter has already "
3322 "been cleaned up by the time this is called, and if your callback then jumps "
3323 "into some HLL function)."
3327 #: ../src/guestfs.pod:1712
3329 "If no callback is registered: the handle is closed without any callback "
3334 #: ../src/guestfs.pod:1715
3335 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3339 #: ../src/guestfs.pod:1718
3341 "The callback function will be called when the child process quits, either "
3342 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3343 "corresponds to a transition from any state to the CONFIG state)."
3347 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3348 msgid "If no callback is registered: the event is ignored."
3352 #: ../src/guestfs.pod:1724
3353 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3357 #: ../src/guestfs.pod:1727
3359 "The callback function will be called when the child process becomes ready "
3360 "first time after it has been launched. (This corresponds to a transition "
3361 "from LAUNCHING to the READY state)."
3365 #: ../src/guestfs.pod:1733
3366 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3370 #: ../src/guestfs.pod:1736
3372 "Some long-running operations can generate progress messages. If this "
3373 "callback is registered, then it will be called each time a progress message "
3374 "is generated (usually two seconds after the operation started, and three "
3375 "times per second thereafter until it completes, although the frequency may "
3376 "change in future versions)."
3380 #: ../src/guestfs.pod:1742
3382 "The callback receives in the payload four unsigned 64 bit numbers which are "
3383 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3387 #: ../src/guestfs.pod:1745
3389 "The units of C<total> are not defined, although for some operations C<total> "
3390 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3391 "or megabytes), and C<position> may be the portion which has been "
3396 #: ../src/guestfs.pod:1750
3397 msgid "The only defined and stable parts of the API are:"
3401 #: ../src/guestfs.pod:1756
3403 "The callback can display to the user some type of progress bar or indicator "
3404 "which shows the ratio of C<position>:C<total>."
3408 #: ../src/guestfs.pod:1761
3409 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3413 #: ../src/guestfs.pod:1765
3415 "If any progress notification is sent during a call, then a final progress "
3416 "notification is always sent when C<position> = C<total> (I<unless> the call "
3417 "fails with an error)."
3421 #: ../src/guestfs.pod:1769
3423 "This is to simplify caller code, so callers can easily set the progress "
3424 "indicator to \"100%\" at the end of the operation, without requiring special "
3425 "code to detect this case."
3429 #: ../src/guestfs.pod:1775
3431 "For some calls we are unable to estimate the progress of the call, but we "
3432 "can still generate progress messages to indicate activity. This is known as "
3433 "\"pulse mode\", and is directly supported by certain progress bar "
3434 "implementations (eg. GtkProgressBar)."
3438 #: ../src/guestfs.pod:1780
3440 "For these calls, zero or more progress messages are generated with "
3441 "C<position = 0> and C<total = 1>, followed by a final message with "
3442 "C<position = total = 1>."
3446 #: ../src/guestfs.pod:1784
3448 "As noted above, if the call fails with an error then the final message may "
3453 #: ../src/guestfs.pod:1789
3455 "The callback also receives the procedure number (C<proc_nr>) and serial "
3456 "number (C<serial>) of the call. These are only useful for debugging "
3457 "protocol issues, and the callback can normally ignore them. The callback "
3458 "may want to print these numbers in error messages or debugging messages."
3462 #: ../src/guestfs.pod:1795
3463 msgid "If no callback is registered: progress messages are discarded."
3467 #: ../src/guestfs.pod:1797
3468 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3472 #: ../src/guestfs.pod:1800
3474 "The callback function is called whenever a log message is generated by qemu, "
3475 "the appliance kernel, guestfsd (daemon), or utility programs."
3479 #: ../src/guestfs.pod:1803
3481 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
3482 "(L</guestfs_launch>) then additional debug messages are generated."
3486 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3488 "If no callback is registered: the messages are discarded unless the verbose "
3489 "flag is set in which case they are sent to stderr. You can override the "
3490 "printing of verbose messages to stderr by setting up a callback."
3494 #: ../src/guestfs.pod:1811
3495 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3499 #: ../src/guestfs.pod:1814
3501 "The callback function is called whenever a log message is generated by the "
3502 "library part of libguestfs."
3506 #: ../src/guestfs.pod:1817
3508 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3509 "messages are generated."
3513 #: ../src/guestfs.pod:1825
3514 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3518 #: ../src/guestfs.pod:1828
3520 "The callback function is called whenever a trace message is generated. This "
3521 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3525 #: ../src/guestfs.pod:1831
3527 "If no callback is registered: the messages are sent to stderr. You can "
3528 "override the printing of trace messages to stderr by setting up a callback."
3532 #: ../src/guestfs.pod:1837
3533 msgid "guestfs_set_event_callback"
3537 #: ../src/guestfs.pod:1839
3540 " int guestfs_set_event_callback (guestfs_h *g,\n"
3541 " guestfs_event_callback cb,\n"
3542 " uint64_t event_bitmask,\n"
3549 #: ../src/guestfs.pod:1845
3551 "This function registers a callback (C<cb>) for all event classes in the "
3556 #: ../src/guestfs.pod:1848
3558 "For example, to register for all log message events, you could call this "
3559 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3560 "To register a single callback for all possible classes of events, use "
3561 "C<GUESTFS_EVENT_ALL>."
3565 #: ../src/guestfs.pod:1854
3566 msgid "C<flags> should always be passed as 0."
3570 #: ../src/guestfs.pod:1856
3572 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3573 "it for any purpose."
3577 #: ../src/guestfs.pod:1859
3579 "The return value is the event handle (an integer) which you can use to "
3580 "delete the callback (see below)."
3584 #: ../src/guestfs.pod:1862
3586 "If there is an error, this function returns C<-1>, and sets the error in the "
3587 "handle in the usual way (see L</guestfs_last_error> etc.)"
3591 #: ../src/guestfs.pod:1865
3593 "Callbacks remain in effect until they are deleted, or until the handle is "
3598 #: ../src/guestfs.pod:1868
3600 "In the case where multiple callbacks are registered for a particular event "
3601 "class, all of the callbacks are called. The order in which multiple "
3602 "callbacks are called is not defined."
3606 #: ../src/guestfs.pod:1872
3607 msgid "guestfs_delete_event_callback"
3611 #: ../src/guestfs.pod:1874
3614 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3619 #: ../src/guestfs.pod:1876
3621 "Delete a callback that was previously registered. C<event_handle> should be "
3622 "the integer that was returned by a previous call to "
3623 "C<guestfs_set_event_callback> on the same handle."
3627 #: ../src/guestfs.pod:1880
3628 msgid "guestfs_event_callback"
3632 #: ../src/guestfs.pod:1882
3635 " typedef void (*guestfs_event_callback) (\n"
3638 " uint64_t event,\n"
3639 " int event_handle,\n"
3641 " const char *buf, size_t buf_len,\n"
3642 " const uint64_t *array, size_t array_len);\n"
3647 #: ../src/guestfs.pod:1891
3648 msgid "This is the type of the event callback function that you have to provide."
3652 #: ../src/guestfs.pod:1894
3654 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3655 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3656 "handle, and C<flags> which in the current API you should ignore."
3660 #: ../src/guestfs.pod:1898
3662 "The remaining parameters contain the event payload (if any). Each event may "
3663 "contain a payload, which usually relates to the event class, but for future "
3664 "proofing your code should be written to handle any payload for any event "
3669 #: ../src/guestfs.pod:1903
3671 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3672 "there is no message buffer). Note that this message buffer can contain "
3673 "arbitrary 8 bit data, including NUL bytes."
3677 #: ../src/guestfs.pod:1907
3679 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3680 "moment this is only used for progress messages."
3684 #: ../src/guestfs.pod:1910
3685 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3689 #: ../src/guestfs.pod:1912
3691 "One motivation for the generic event API was to allow GUI programs to "
3692 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3693 "unconditionally to C<stderr>."
3697 #: ../src/guestfs.pod:1916
3699 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3700 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3701 "messages are not events; you must capture error messages separately)."
3705 #: ../src/guestfs.pod:1921
3707 "Programs have to set up a callback to capture the classes of events of "
3712 #: ../src/guestfs.pod:1924
3716 " guestfs_set_event_callback\n"
3717 " (g, message_callback,\n"
3718 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3719 " GUESTFS_EVENT_TRACE,\n"
3720 " 0, NULL) == -1)\n"
3721 " if (eh == -1) {\n"
3722 " // handle error in the usual way\n"
3728 #: ../src/guestfs.pod:1934
3730 "The callback can then direct messages to the appropriate place. In this "
3731 "example, messages are directed to syslog:"
3735 #: ../src/guestfs.pod:1937
3739 " message_callback (\n"
3742 " uint64_t event,\n"
3743 " int event_handle,\n"
3745 " const char *buf, size_t buf_len,\n"
3746 " const uint64_t *array, size_t array_len)\n"
3748 " const int priority = LOG_USER|LOG_INFO;\n"
3749 " if (buf_len > 0)\n"
3750 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3756 #: ../src/guestfs.pod:1952
3757 msgid "PRIVATE DATA AREA"
3761 #: ../src/guestfs.pod:1954
3763 "You can attach named pieces of private data to the libguestfs handle, fetch "
3764 "them by name, and walk over them, for the lifetime of the handle. This is "
3765 "called the private data area and is only available from the C API."
3769 #: ../src/guestfs.pod:1959
3770 msgid "To attach a named piece of data, use the following call:"
3774 #: ../src/guestfs.pod:1961
3777 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3782 #: ../src/guestfs.pod:1963
3784 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3785 "pointer (which can be C<NULL>). Any previous item with the same key is "
3790 #: ../src/guestfs.pod:1967
3792 "You can use any C<key> you want, but your key should I<not> start with an "
3793 "underscore character. Keys beginning with an underscore character are "
3794 "reserved for internal libguestfs purposes (eg. for implementing language "
3795 "bindings). It is recommended that you prefix the key with some unique "
3796 "string to avoid collisions with other users."
3800 #: ../src/guestfs.pod:1973
3801 msgid "To retrieve the pointer, use:"
3805 #: ../src/guestfs.pod:1975
3808 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3813 #: ../src/guestfs.pod:1977
3815 "This function returns C<NULL> if either no data is found associated with "
3816 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3821 #: ../src/guestfs.pod:1981
3823 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3824 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3825 "all. In particular, libguestfs does I<not> try to free the data when the "
3826 "handle is closed. If the data must be freed, then the caller must either "
3827 "free it before calling L</guestfs_close> or must set up a close callback to "
3828 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3832 #: ../src/guestfs.pod:1988
3833 msgid "To walk over all entries, use these two functions:"
3837 #: ../src/guestfs.pod:1990
3840 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3845 #: ../src/guestfs.pod:1992
3848 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3853 #: ../src/guestfs.pod:1994
3855 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3856 "not have any particular meaning -- keys are not returned in any defined "
3857 "order). A pointer to the key is returned in C<*key_rtn> and the "
3858 "corresponding data pointer is returned from the function. C<NULL> is "
3859 "returned if there are no keys stored in the handle."
3863 #: ../src/guestfs.pod:2000
3865 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3866 "value of this function is also C<NULL> is there are no further entries to "
3871 #: ../src/guestfs.pod:2004
3872 msgid "Notes about walking over entries:"
3876 #: ../src/guestfs.pod:2010
3877 msgid "You must not call C<guestfs_set_private> while walking over the entries."
3881 #: ../src/guestfs.pod:2015
3883 "The handle maintains an internal iterator which is reset when you call "
3884 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3885 "call C<guestfs_set_private>."
3889 #: ../src/guestfs.pod:2021
3890 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3894 #: ../src/guestfs.pod:2023
3897 " guestfs_set_private (g, key, NULL);\n"
3902 #: ../src/guestfs.pod:2025
3903 msgid "then that C<key> is not returned when walking."
3907 #: ../src/guestfs.pod:2029
3909 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
3910 "C<guestfs_next_private> or C<guestfs_set_private>."
3914 #: ../src/guestfs.pod:2035
3916 "The following example code shows how to print all keys and data pointers "
3917 "that are associated with the handle C<g>:"
3921 #: ../src/guestfs.pod:2038
3924 " const char *key;\n"
3925 " void *data = guestfs_first_private (g, &key);\n"
3926 " while (data != NULL)\n"
3928 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3929 " data = guestfs_next_private (g, &key);\n"
3935 #: ../src/guestfs.pod:2046
3937 "More commonly you are only interested in keys that begin with an "
3938 "application-specific prefix C<foo_>. Modify the loop like so:"
3942 #: ../src/guestfs.pod:2049
3945 " const char *key;\n"
3946 " void *data = guestfs_first_private (g, &key);\n"
3947 " while (data != NULL)\n"
3949 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3950 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3951 " data = guestfs_next_private (g, &key);\n"
3957 #: ../src/guestfs.pod:2058
3959 "If you need to modify keys while walking, then you have to jump back to the "
3960 "beginning of the loop. For example, to delete all keys prefixed with "
3965 #: ../src/guestfs.pod:2062
3968 " const char *key;\n"
3971 " data = guestfs_first_private (g, &key);\n"
3972 " while (data != NULL)\n"
3974 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3976 " guestfs_set_private (g, key, NULL);\n"
3977 " /* note that 'key' pointer is now invalid, and so is\n"
3978 " the internal iterator */\n"
3981 " data = guestfs_next_private (g, &key);\n"
3987 #: ../src/guestfs.pod:2078
3989 "Note that the above loop is guaranteed to terminate because the keys are "
3990 "being deleted, but other manipulations of keys within the loop might not "
3991 "terminate unless you also maintain an indication of which keys have been "
3996 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4001 #: ../src/guestfs.pod:2085
4003 "<!-- old anchor for the next section --> <a "
4004 "name=\"state_machine_and_low_level_event_api\"/>"
4008 #: ../src/guestfs.pod:2090
4009 msgid "ARCHITECTURE"
4013 #: ../src/guestfs.pod:2092
4015 "Internally, libguestfs is implemented by running an appliance (a special "
4016 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4017 "process of the main program."
4021 #: ../src/guestfs.pod:2096
4024 " ___________________\n"
4026 " | main program |\n"
4028 " | | child process / appliance\n"
4029 " | | __________________________\n"
4031 " +-------------------+ RPC | +-----------------+ |\n"
4032 " | libguestfs <--------------------> guestfsd | |\n"
4033 " | | | +-----------------+ |\n"
4034 " \\___________________/ | | Linux kernel | |\n"
4035 " | +--^--------------+ |\n"
4036 " \\_________|________________/\n"
4042 " \\______________/\n"
4047 #: ../src/guestfs.pod:2116
4049 "The library, linked to the main program, creates the child process and hence "
4050 "the appliance in the L</guestfs_launch> function."
4054 #: ../src/guestfs.pod:2119
4056 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4057 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4058 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4059 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4060 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4061 "attached to the qemu process which translates device access by the "
4062 "appliance's Linux kernel into accesses to the image."
4066 #: ../src/guestfs.pod:2128
4068 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4069 "Although the disk image you are attached to might also be used by some "
4070 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4071 "care if both libguestfs's qemu process and your virtual machine are trying "
4072 "to update the disk image at the same time, since these usually results in "
4073 "massive disk corruption)."
4077 #: ../src/guestfs.pod:2135
4078 msgid "STATE MACHINE"
4082 #: ../src/guestfs.pod:2137
4083 msgid "libguestfs uses a state machine to model the child process:"
4087 #: ../src/guestfs.pod:2139
4099 " / | \\ \\ guestfs_launch\n"
4100 " / | _\\__V______\n"
4102 " / | | LAUNCHING |\n"
4103 " / | \\___________/\n"
4105 " / | guestfs_launch\n"
4107 " ______ / __|____V\n"
4108 " / \\ ------> / \\\n"
4109 " | BUSY | | READY |\n"
4110 " \\______/ <------ \\________/\n"
4115 #: ../src/guestfs.pod:2161
4117 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4118 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4119 "(3) alternating between READY and BUSY as commands are issued to, and "
4120 "carried out by, the child process."
4124 #: ../src/guestfs.pod:2166
4126 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4127 "asynchronously at any time (eg. due to some internal error), and that causes "
4128 "the state to transition back to CONFIG."
4132 #: ../src/guestfs.pod:2170
4134 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4135 "issued when in the CONFIG state."
4139 #: ../src/guestfs.pod:2173
4141 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4142 "L</guestfs_launch> blocks until the child process is READY to accept "
4143 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4144 "moves the state from CONFIG to LAUNCHING while it is running."
4148 #: ../src/guestfs.pod:2179
4150 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4151 "state. These API calls block waiting for the command to be carried out "
4152 "(ie. the state to transition to BUSY and then back to READY). There are no "
4153 "non-blocking versions, and no way to issue more than one command per handle "
4158 #: ../src/guestfs.pod:2185
4160 "Finally, the child process sends asynchronous messages back to the main "
4161 "program, such as kernel log messages. You can register a callback to "
4162 "receive these messages."
4166 #: ../src/guestfs.pod:2189
4171 #: ../src/guestfs.pod:2191
4172 msgid "COMMUNICATION PROTOCOL"
4176 #: ../src/guestfs.pod:2193
4178 "Don't rely on using this protocol directly. This section documents how it "
4179 "currently works, but it may change at any time."
4183 #: ../src/guestfs.pod:2196
4185 "The protocol used to talk between the library and the daemon running inside "
4186 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4187 "1014, RFC 1832, RFC 4506)."
4191 #: ../src/guestfs.pod:2200
4193 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4194 "this file is automatically generated)."
4198 #: ../src/guestfs.pod:2203
4200 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4201 "and C<FileOut> parameters, which are handled with very simple request/reply "
4202 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4203 "parameters, which use the same request and reply messages, but they may also "
4204 "be followed by files sent using a chunked encoding."
4208 #: ../src/guestfs.pod:2210
4209 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4213 #: ../src/guestfs.pod:2212
4214 msgid "For ordinary functions, the request message is:"
4218 #: ../src/guestfs.pod:2214
4221 " total length (header + arguments,\n"
4222 " but not including the length word itself)\n"
4223 " struct guestfs_message_header (encoded as XDR)\n"
4224 " struct guestfs_<foo>_args (encoded as XDR)\n"
4229 #: ../src/guestfs.pod:2219
4231 "The total length field allows the daemon to allocate a fixed size buffer "
4232 "into which it slurps the rest of the message. As a result, the total length "
4233 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4234 "effective size of any request is limited to somewhere under this size."
4238 #: ../src/guestfs.pod:2225
4240 "Note also that many functions don't take any arguments, in which case the "
4241 "C<guestfs_I<foo>_args> is completely omitted."
4245 #: ../src/guestfs.pod:2228
4247 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4248 "receiver knows what type of args structure to expect, or none at all."
4252 #: ../src/guestfs.pod:2232
4254 "For functions that take optional arguments, the optional arguments are "
4255 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4256 "arguments. A bitmask in the header indicates which optional arguments are "
4257 "meaningful. The bitmask is also checked to see if it contains bits set "
4258 "which the daemon does not know about (eg. if more optional arguments were "
4259 "added in a later version of the library), and this causes the call to be "
4264 #: ../src/guestfs.pod:2240
4265 msgid "The reply message for ordinary functions is:"
4269 #: ../src/guestfs.pod:2242
4272 " total length (header + ret,\n"
4273 " but not including the length word itself)\n"
4274 " struct guestfs_message_header (encoded as XDR)\n"
4275 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4280 #: ../src/guestfs.pod:2247
4282 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4283 "functions that return no formal return values."
4287 #: ../src/guestfs.pod:2250
4288 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4292 #: ../src/guestfs.pod:2253
4294 "In the case of an error, a flag is set in the header, and the reply message "
4295 "is slightly changed:"
4299 #: ../src/guestfs.pod:2256
4302 " total length (header + error,\n"
4303 " but not including the length word itself)\n"
4304 " struct guestfs_message_header (encoded as XDR)\n"
4305 " struct guestfs_message_error (encoded as XDR)\n"
4310 #: ../src/guestfs.pod:2261
4312 "The C<guestfs_message_error> structure contains the error message as a "
4317 #: ../src/guestfs.pod:2264
4318 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4322 #: ../src/guestfs.pod:2266
4324 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4325 "The normal request message is sent (see above). However this is followed by "
4326 "a sequence of file chunks."
4330 #: ../src/guestfs.pod:2270
4333 " total length (header + arguments,\n"
4334 " but not including the length word itself,\n"
4335 " and not including the chunks)\n"
4336 " struct guestfs_message_header (encoded as XDR)\n"
4337 " struct guestfs_<foo>_args (encoded as XDR)\n"
4338 " sequence of chunks for FileIn param #0\n"
4339 " sequence of chunks for FileIn param #1 etc.\n"
4344 #: ../src/guestfs.pod:2278
4345 msgid "The \"sequence of chunks\" is:"
4349 #: ../src/guestfs.pod:2280
4352 " length of chunk (not including length word itself)\n"
4353 " struct guestfs_chunk (encoded as XDR)\n"
4354 " length of chunk\n"
4355 " struct guestfs_chunk (encoded as XDR)\n"
4357 " length of chunk\n"
4358 " struct guestfs_chunk (with data.data_len == 0)\n"
4363 #: ../src/guestfs.pod:2288
4365 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4366 "is set in the final chunk to indicate either successful completion or early "
4371 #: ../src/guestfs.pod:2292
4373 "At time of writing there are no functions that have more than one FileIn "
4374 "parameter. However this is (theoretically) supported, by sending the "
4375 "sequence of chunks for each FileIn parameter one after another (from left to "
4380 #: ../src/guestfs.pod:2297
4382 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4383 "transfer. The library does this by sending a chunk with a special flag set "
4384 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4385 "RPC, does I<not> send any reply, and goes back to reading the next request."
4389 #: ../src/guestfs.pod:2303
4391 "The daemon may also cancel. It does this by writing a special word "
4392 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4393 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4394 "cancel chunk). The special word is chosen so that even if cancellation "
4395 "happens right at the end of the transfer (after the library has finished "
4396 "writing and has started listening for the reply), the \"spurious\" cancel "
4397 "flag will not be confused with the reply message."
4401 #: ../src/guestfs.pod:2312
4403 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4404 "limit), and also files where the size is not known in advance (eg. from "
4405 "pipes or sockets). However the chunks are rather small "
4406 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4407 "to keep much in memory."
4411 #: ../src/guestfs.pod:2318
4412 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4416 #: ../src/guestfs.pod:2320
4418 "The protocol for FileOut parameters is exactly the same as for FileIn "
4419 "parameters, but with the roles of daemon and library reversed."
4423 #: ../src/guestfs.pod:2323
4426 " total length (header + ret,\n"
4427 " but not including the length word itself,\n"
4428 " and not including the chunks)\n"
4429 " struct guestfs_message_header (encoded as XDR)\n"
4430 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4431 " sequence of chunks for FileOut param #0\n"
4432 " sequence of chunks for FileOut param #1 etc.\n"
4437 #: ../src/guestfs.pod:2331
4438 msgid "INITIAL MESSAGE"
4442 #: ../src/guestfs.pod:2333
4444 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4445 "which indicates that the guest and daemon is alive. This is what "
4446 "L</guestfs_launch> waits for."
4450 #: ../src/guestfs.pod:2337
4451 msgid "PROGRESS NOTIFICATION MESSAGES"
4455 #: ../src/guestfs.pod:2339
4457 "The daemon may send progress notification messages at any time. These are "
4458 "distinguished by the normal length word being replaced by "
4459 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4463 #: ../src/guestfs.pod:2343
4465 "The library turns them into progress callbacks (see "
4466 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4471 #: ../src/guestfs.pod:2347
4473 "The daemon self-limits the frequency of progress messages it sends (see "
4474 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4479 #: ../src/guestfs.pod:2351
4480 msgid "LIBGUESTFS VERSION NUMBERS"
4484 #: ../src/guestfs.pod:2353
4486 "Since April 2010, libguestfs has started to make separate development and "
4487 "stable releases, along with corresponding branches in our git repository. "
4488 "These separate releases can be identified by version number:"
4492 #: ../src/guestfs.pod:2358
4495 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4496 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4502 " | `-------- sub-version\n"
4504 " `------ always '1' because we don't change the ABI\n"
4509 #: ../src/guestfs.pod:2369
4510 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4514 #: ../src/guestfs.pod:2371
4516 "As time passes we cherry pick fixes from the development branch and backport "
4517 "those into the stable branch, the effect being that the stable branch should "
4518 "get more stable and less buggy over time. So the stable releases are ideal "
4519 "for people who don't need new features but would just like the software to "
4524 #: ../src/guestfs.pod:2377
4525 msgid "Our criteria for backporting changes are:"
4529 #: ../src/guestfs.pod:2383
4531 "Documentation changes which don't affect any code are backported unless the "
4532 "documentation refers to a future feature which is not in stable."
4536 #: ../src/guestfs.pod:2389
4538 "Bug fixes which are not controversial, fix obvious problems, and have been "
4539 "well tested are backported."
4543 #: ../src/guestfs.pod:2394
4545 "Simple rearrangements of code which shouldn't affect how it works get "
4546 "backported. This is so that the code in the two branches doesn't get too "
4547 "far out of step, allowing us to backport future fixes more easily."
4551 #: ../src/guestfs.pod:2400
4553 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4554 "exceptional case: the new feature is required in order to implement an "
4555 "important bug fix."
4559 #: ../src/guestfs.pod:2406
4561 "A new stable branch starts when we think the new features in development are "
4562 "substantial and compelling enough over the current stable branch to warrant "
4563 "it. When that happens we create new stable and development versions 1.N.0 "
4564 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4565 "stable at this point, but by backporting fixes from development, that branch "
4566 "will stabilize over time."
4570 #: ../src/guestfs.pod:2414
4571 msgid "EXTENDING LIBGUESTFS"
4575 #: ../src/guestfs.pod:2416
4576 msgid "ADDING A NEW API ACTION"
4580 #: ../src/guestfs.pod:2418
4582 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4583 "documentation) are generated, and this makes it easy to extend the "
4588 #: ../src/guestfs.pod:2422
4589 msgid "To add a new API action there are two changes:"
4593 #: ../src/guestfs.pod:2428
4595 "You need to add a description of the call (name, parameters, return type, "
4596 "tests, documentation) to C<generator/generator_actions.ml>."
4600 #: ../src/guestfs.pod:2431
4602 "There are two sorts of API action, depending on whether the call goes "
4603 "through to the daemon in the appliance, or is serviced entirely by the "
4604 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4605 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4606 "an example of the latter, since a trace flag is maintained in the handle and "
4607 "all tracing is done on the library side."
4611 #: ../src/guestfs.pod:2439
4613 "Most new actions are of the first type, and get added to the "
4614 "C<daemon_functions> list. Each function has a unique procedure number used "
4615 "in the RPC protocol which is assigned to that action when we publish "
4616 "libguestfs and cannot be reused. Take the latest procedure number and "
4621 #: ../src/guestfs.pod:2445
4623 "For library-only actions of the second type, add to the "
4624 "C<non_daemon_functions> list. Since these functions are serviced by the "
4625 "library and do not travel over the RPC mechanism to the daemon, these "
4626 "functions do not need a procedure number, and so the procedure number is set "
4631 #: ../src/guestfs.pod:2453
4632 msgid "Implement the action (in C):"
4636 #: ../src/guestfs.pod:2455
4638 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4639 "C<daemon/> directory."
4643 #: ../src/guestfs.pod:2458
4645 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4646 "(note: double underscore) in the C<src/> directory."
4650 #: ../src/guestfs.pod:2461
4651 msgid "In either case, use another function as an example of what to do."
4655 #: ../src/guestfs.pod:2465
4656 msgid "After making these changes, use C<make> to compile."
4660 #: ../src/guestfs.pod:2467
4662 "Note that you don't need to implement the RPC, language bindings, manual "
4663 "pages or anything else. It's all automatically generated from the OCaml "
4668 #: ../src/guestfs.pod:2471
4669 msgid "ADDING TESTS FOR AN API ACTION"
4673 #: ../src/guestfs.pod:2473
4675 "You can supply zero or as many tests as you want per API call. The tests "
4676 "can either be added as part of the API description "
4677 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4678 "drop a script into C<regressions/>. Note that adding a script to "
4679 "C<regressions/> is slower, so if possible use the first method."
4683 #: ../src/guestfs.pod:2479
4685 "The following describes the test environment used when you add an API test "
4686 "in C<generator_actions.ml>."
4690 #: ../src/guestfs.pod:2482
4691 msgid "The test environment has 4 block devices:"
4695 #: ../src/guestfs.pod:2486
4696 msgid "C</dev/sda> 500MB"
4700 #: ../src/guestfs.pod:2488
4701 msgid "General block device for testing."
4705 #: ../src/guestfs.pod:2490
4706 msgid "C</dev/sdb> 50MB"
4710 #: ../src/guestfs.pod:2492
4712 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4717 #: ../src/guestfs.pod:2495
4718 msgid "C</dev/sdc> 10MB"
4722 #: ../src/guestfs.pod:2497
4723 msgid "Used in a few tests where two block devices are needed."
4727 #: ../src/guestfs.pod:2499
4732 #: ../src/guestfs.pod:2501
4733 msgid "ISO with fixed content (see C<images/test.iso>)."
4737 #: ../src/guestfs.pod:2505
4739 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4740 "appliance and block devices are reused between tests. So don't try testing "
4741 "L</guestfs_kill_subprocess> :-x"
4745 #: ../src/guestfs.pod:2509
4747 "Each test starts with an initial scenario, selected using one of the "
4748 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4749 "initialize the disks mentioned above in a particular way as documented in "
4750 "C<generator_types.ml>. You should not assume anything about the previous "
4751 "contents of other disks that are not initialized."
4755 #: ../src/guestfs.pod:2515
4757 "You can add a prerequisite clause to any individual test. This is a "
4758 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4759 "if testing a command which might not work on all variations of libguestfs "
4760 "builds. A test that has prerequisite of C<Always> means to run "
4765 #: ../src/guestfs.pod:2521
4767 "In addition, packagers can skip individual tests by setting environment "
4768 "variables before running C<make check>."
4772 #: ../src/guestfs.pod:2524
4775 " SKIP_TEST_<CMD>_<NUM>=1\n"
4780 #: ../src/guestfs.pod:2526
4781 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4785 #: ../src/guestfs.pod:2528
4790 #: ../src/guestfs.pod:2530
4793 " SKIP_TEST_<CMD>=1\n"
4798 #: ../src/guestfs.pod:2532
4799 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4803 #: ../src/guestfs.pod:2534
4804 msgid "Packagers can run only certain tests by setting for example:"
4808 #: ../src/guestfs.pod:2536
4811 " TEST_ONLY=\"vfs_type zerofree\"\n"
4816 #: ../src/guestfs.pod:2538
4818 "See C<capitests/tests.c> for more details of how these environment variables "
4823 #: ../src/guestfs.pod:2541
4824 msgid "DEBUGGING NEW API ACTIONS"
4828 #: ../src/guestfs.pod:2543
4829 msgid "Test new actions work before submitting them."
4833 #: ../src/guestfs.pod:2545
4834 msgid "You can use guestfish to try out new commands."
4838 #: ../src/guestfs.pod:2547
4840 "Debugging the daemon is a problem because it runs inside a minimal "
4841 "environment. However you can fprintf messages in the daemon to stderr, and "
4842 "they will show up if you use C<guestfish -v>."
4846 #: ../src/guestfs.pod:2551
4847 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4851 #: ../src/guestfs.pod:2553
4853 "Our C source code generally adheres to some basic code-formatting "
4854 "conventions. The existing code base is not totally consistent on this "
4855 "front, but we do prefer that contributed code be formatted similarly. In "
4856 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4857 "indentation level, and other than that, follow the K&R style."
4861 #: ../src/guestfs.pod:2559
4863 "If you use Emacs, add the following to one of one of your start-up files "
4864 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4868 #: ../src/guestfs.pod:2562
4871 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4872 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4873 " (add-hook 'find-file-hook\n"
4874 " '(lambda () (if (and buffer-file-name\n"
4875 " (string-match \"/libguestfs\\\\>\"\n"
4876 " (buffer-file-name))\n"
4877 " (not (string-equal mode-name \"Change Log\"))\n"
4878 " (not (string-equal mode-name \"Makefile\")))\n"
4879 " (setq indent-tabs-mode nil))))\n"
4884 #: ../src/guestfs.pod:2572
4887 " ;;; When editing C sources in libguestfs, use this style.\n"
4888 " (defun libguestfs-c-mode ()\n"
4889 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4891 " (c-set-style \"K&R\")\n"
4892 " (setq c-indent-level 2)\n"
4893 " (setq c-basic-offset 2))\n"
4894 " (add-hook 'c-mode-hook\n"
4895 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4896 " (buffer-file-name))\n"
4897 " (libguestfs-c-mode))))\n"
4902 #: ../src/guestfs.pod:2584
4903 msgid "Enable warnings when compiling (and fix any problems this finds):"
4907 #: ../src/guestfs.pod:2587
4910 " ./configure --enable-gcc-warnings\n"
4915 #: ../src/guestfs.pod:2589
4916 msgid "Useful targets are:"
4920 #: ../src/guestfs.pod:2591
4923 " make syntax-check # checks the syntax of the C code\n"
4924 " make check # runs the test suite\n"
4929 #: ../src/guestfs.pod:2594
4930 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4934 #: ../src/guestfs.pod:2596
4936 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4937 "which are used to do shell quoting."
4941 #: ../src/guestfs.pod:2601
4946 #: ../src/guestfs.pod:2603
4948 "Simple shell quoted string. Any spaces or other shell characters are "
4953 #: ../src/guestfs.pod:2606
4958 #: ../src/guestfs.pod:2608
4960 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4965 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
4966 msgid "For example:"
4970 #: ../src/guestfs.pod:2615
4973 " asprintf (&cmd, \"cat %R\", path);\n"
4978 #: ../src/guestfs.pod:2617
4979 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4983 #: ../src/guestfs.pod:2619
4985 "I<Note:> Do I<not> use these when you are passing parameters to the "
4986 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4987 "because they are not passed via the shell (instead, straight to exec). You "
4988 "probably want to use the C<sysroot_path()> function however."
4992 #: ../src/guestfs.pod:2625
4993 msgid "SUBMITTING YOUR NEW API ACTIONS"
4997 #: ../src/guestfs.pod:2627
4999 "Submit patches to the mailing list: "
5000 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5001 "L<rjones@redhat.com>."
5005 #: ../src/guestfs.pod:2631
5006 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5010 #: ../src/guestfs.pod:2633
5011 msgid "We support i18n (gettext anyhow) in the library."
5015 #: ../src/guestfs.pod:2635
5017 "However many messages come from the daemon, and we don't translate those at "
5018 "the moment. One reason is that the appliance generally has all locale files "
5019 "removed from it, because they take up a lot of space. So we'd have to readd "
5020 "some of those, as well as copying our PO files into the appliance."
5024 #: ../src/guestfs.pod:2641
5026 "Debugging messages are never translated, since they are intended for the "
5031 #: ../src/guestfs.pod:2644
5032 msgid "SOURCE CODE SUBDIRECTORIES"
5036 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3932
5037 msgid "C<appliance>"
5041 #: ../src/guestfs.pod:2650
5042 msgid "The libguestfs appliance, build scripts and so on."
5046 #: ../src/guestfs.pod:2652
5047 msgid "C<capitests>"
5051 #: ../src/guestfs.pod:2654
5052 msgid "Automated tests of the C API."
5056 #: ../src/guestfs.pod:2656
5061 #: ../src/guestfs.pod:2658
5063 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5068 #: ../src/guestfs.pod:2661
5073 #: ../src/guestfs.pod:2663
5074 msgid "Outside contributions, experimental parts."
5078 #: ../src/guestfs.pod:2665
5083 #: ../src/guestfs.pod:2667
5085 "The daemon that runs inside the libguestfs appliance and carries out "
5090 #: ../src/guestfs.pod:2670
5095 #: ../src/guestfs.pod:2672
5096 msgid "L<virt-df(1)> command and documentation."
5100 #: ../src/guestfs.pod:2674
5105 #: ../src/guestfs.pod:2676
5106 msgid "L<virt-edit(1)> command and documentation."
5110 #: ../src/guestfs.pod:2678
5115 #: ../src/guestfs.pod:2680
5116 msgid "C API example code."
5120 #: ../src/guestfs.pod:2682
5125 #: ../src/guestfs.pod:2684
5127 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5128 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5129 "L<virt-tar-out(1)>."
5133 #: ../src/guestfs.pod:2688
5138 #: ../src/guestfs.pod:2690
5139 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5143 #: ../src/guestfs.pod:2692
5144 msgid "C<generator>"
5148 #: ../src/guestfs.pod:2694
5150 "The crucially important generator, used to automatically generate large "
5151 "amounts of boilerplate C code for things like RPC and bindings."
5155 #: ../src/guestfs.pod:2697
5160 #: ../src/guestfs.pod:2699
5161 msgid "Files used by the test suite."
5165 #: ../src/guestfs.pod:2701
5166 msgid "Some \"phony\" guest images which we test against."
5170 #: ../src/guestfs.pod:2703
5171 msgid "C<inspector>"
5175 #: ../src/guestfs.pod:2705
5176 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5180 #: ../src/guestfs.pod:2707
5185 #: ../src/guestfs.pod:2709
5186 msgid "Logo used on the website. The fish is called Arthur by the way."
5190 #: ../src/guestfs.pod:2711
5195 #: ../src/guestfs.pod:2713
5196 msgid "M4 macros used by autoconf."
5200 #: ../src/guestfs.pod:2715
5205 #: ../src/guestfs.pod:2717
5206 msgid "Translations of simple gettext strings."
5210 #: ../src/guestfs.pod:2719
5215 #: ../src/guestfs.pod:2721
5217 "The build infrastructure and PO files for translations of manpages and POD "
5218 "files. Eventually this will be combined with the C<po> directory, but that "
5219 "is rather complicated."
5223 #: ../src/guestfs.pod:2725
5224 msgid "C<regressions>"
5228 #: ../src/guestfs.pod:2727
5229 msgid "Regression tests."
5233 #: ../src/guestfs.pod:2729
5238 #: ../src/guestfs.pod:2731
5239 msgid "L<virt-rescue(1)> command and documentation."
5243 #: ../src/guestfs.pod:2733
5248 #: ../src/guestfs.pod:2735
5249 msgid "Source code to the C library."
5253 #: ../src/guestfs.pod:2737
5258 #: ../src/guestfs.pod:2739
5259 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5263 #: ../src/guestfs.pod:2741
5264 msgid "C<test-tool>"
5268 #: ../src/guestfs.pod:2743
5270 "Test tool for end users to test if their qemu/kernel combination will work "
5275 #: ../src/guestfs.pod:2746
5280 #: ../src/guestfs.pod:2748
5285 #: ../src/guestfs.pod:2750
5290 #: ../src/guestfs.pod:2752
5295 #: ../src/guestfs.pod:2754
5300 #: ../src/guestfs.pod:2756
5305 #: ../src/guestfs.pod:2758
5310 #: ../src/guestfs.pod:2760
5315 #: ../src/guestfs.pod:2762
5316 msgid "Language bindings."
5320 #: ../src/guestfs.pod:2766
5325 #: ../src/guestfs.pod:2768
5326 msgid "PROTOCOL LIMITS"
5330 #: ../src/guestfs.pod:2770
5332 "Internally libguestfs uses a message-based protocol to pass API calls and "
5333 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5334 "plenty more detail about this). The maximum message size used by the "
5335 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5336 "aware of this limit. The API calls which may be affected are individually "
5337 "documented, with a link back to this section of the documentation."
5341 #: ../src/guestfs.pod:2778
5343 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5344 "a simple string. Because this string is at some point internally encoded as "
5345 "a message, the maximum size that it can return is slightly under 4 MB. If "
5346 "the requested file is larger than this then you will get an error."
5350 #: ../src/guestfs.pod:2784
5352 "In order to transfer large files into and out of the guest filesystem, you "
5353 "need to use particular calls that support this. The sections L</UPLOADING> "
5354 "and L</DOWNLOADING> document how to do this."
5358 #: ../src/guestfs.pod:2788
5360 "You might also consider mounting the disk image using our FUSE filesystem "
5361 "support (L<guestmount(1)>)."
5365 #: ../src/guestfs.pod:2791
5366 msgid "MAXIMUM NUMBER OF DISKS"
5370 #: ../src/guestfs.pod:2793
5371 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5375 #: ../src/guestfs.pod:2796
5377 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5378 "slots. However febootstrap only understands disks with names C</dev/vda> "
5379 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5384 #: ../src/guestfs.pod:2801
5386 "We are working to substantially raise this limit in future versions but it "
5387 "requires complex changes to qemu."
5391 #: ../src/guestfs.pod:2804
5393 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5394 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5395 "requires changes to qemu."
5399 #: ../src/guestfs.pod:2808
5400 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5404 #: ../src/guestfs.pod:2810
5405 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5409 #: ../src/guestfs.pod:2812
5411 "This is because it reserves 4 bits for the minor device number (thus "
5412 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5416 #: ../src/guestfs.pod:2815
5418 "If you attach a disk with more than 15 partitions, the extra partitions are "
5419 "ignored by libguestfs."
5423 #: ../src/guestfs.pod:2818
5424 msgid "MAXIMUM SIZE OF A DISK"
5428 #: ../src/guestfs.pod:2820
5429 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5433 #: ../src/guestfs.pod:2822
5435 "We have tested block devices up to 1 exabyte (2**60 or "
5436 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5441 #: ../src/guestfs.pod:2826
5443 "Although libguestfs probably does not impose any limit, the underlying host "
5444 "storage will. If you store disk images on a host ext4 filesystem, then the "
5445 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5446 "TB). If you store disk images as host logical volumes then you are limited "
5447 "by the maximum size of an LV."
5451 #: ../src/guestfs.pod:2832
5453 "For the hugest disk image files, we recommend using XFS on the host for "
5458 #: ../src/guestfs.pod:2835
5459 msgid "MAXIMUM SIZE OF A PARTITION"
5463 #: ../src/guestfs.pod:2837
5465 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5466 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5467 "address a partition located beyond 2 TB on the disk."
5471 #: ../src/guestfs.pod:2841
5473 "It is recommended that you use GPT partitions on disks which are larger than "
5474 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5475 "which are theoretically larger than the largest disk we could support."
5479 #: ../src/guestfs.pod:2846
5480 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5484 #: ../src/guestfs.pod:2848
5486 "This depends on the filesystem type. libguestfs itself does not impose any "
5487 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5488 "what these limits are."
5492 #: ../src/guestfs.pod:2852
5493 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5497 #: ../src/guestfs.pod:2854
5499 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5500 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5501 "uploads and downloads."
5505 #: ../src/guestfs.pod:2858
5506 msgid "INSPECTION LIMITS"
5510 #: ../src/guestfs.pod:2860
5512 "The inspection code has several arbitrary limits on things like the size of "
5513 "Windows Registry hive it will read, and the length of product name. These "
5514 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5515 "memory and disk space on the host, and should not be reached in practice. "
5516 "See the source code for more information."
5520 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1017 ../test-tool/libguestfs-test-tool.pod:82
5521 msgid "ENVIRONMENT VARIABLES"
5525 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1043
5526 msgid "LIBGUESTFS_APPEND"
5530 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1045
5531 msgid "Pass additional options to the guest kernel."
5535 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1047
5536 msgid "LIBGUESTFS_DEBUG"
5540 #: ../src/guestfs.pod:2876
5542 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5543 "effect as calling C<guestfs_set_verbose (g, 1)>."
5547 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1052
5548 msgid "LIBGUESTFS_MEMSIZE"
5552 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1054
5553 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5557 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1057
5560 " LIBGUESTFS_MEMSIZE=700\n"
5565 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1059
5566 msgid "LIBGUESTFS_PATH"
5570 #: ../src/guestfs.pod:2888
5572 "Set the path that libguestfs uses to search for a supermin appliance. See "
5573 "the discussion of paths in section L</PATH> above."
5577 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1064
5578 msgid "LIBGUESTFS_QEMU"
5582 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1066
5584 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5585 "which was found at compile time by the configure script is used."
5589 #: ../src/guestfs.pod:2897
5590 msgid "See also L</QEMU WRAPPERS> above."
5594 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1070
5595 msgid "LIBGUESTFS_TRACE"
5599 #: ../src/guestfs.pod:2901
5601 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5602 "effect as calling C<guestfs_set_trace (g, 1)>."
5606 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1079
5611 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1081
5613 "Location of temporary directory, defaults to C</tmp> except for the cached "
5614 "supermin appliance which defaults to C</var/tmp>."
5618 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1084
5620 "If libguestfs was compiled to use the supermin appliance then the real "
5621 "appliance is cached in this directory, shared between all handles belonging "
5622 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5623 "use in case C</var/tmp> is not large enough."
5627 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1151 ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279 ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5632 #: ../src/guestfs.pod:2919
5634 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5635 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5636 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5637 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5638 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5639 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5640 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5641 "L<http://libguestfs.org/>."
5645 #: ../src/guestfs.pod:2946
5647 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5648 "L<lvm(8)>, L<disktype(1)>."
5652 #: ../src/guestfs.pod:2953 ../tools/virt-win-reg.pl:759 ../tools/virt-make-fs.pl:553
5657 #: ../src/guestfs.pod:2955
5658 msgid "To get a list of bugs against libguestfs use this link:"
5662 #: ../src/guestfs.pod:2957
5663 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5667 #: ../src/guestfs.pod:2959
5668 msgid "To report a new bug against libguestfs use this link:"
5672 #: ../src/guestfs.pod:2961
5673 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5677 #: ../src/guestfs.pod:2963
5678 msgid "When reporting a bug, please check:"
5682 #: ../src/guestfs.pod:2969
5683 msgid "That the bug hasn't been reported already."
5687 #: ../src/guestfs.pod:2973
5688 msgid "That you are testing a recent version."
5692 #: ../src/guestfs.pod:2977
5693 msgid "Describe the bug accurately, and give a way to reproduce it."
5697 #: ../src/guestfs.pod:2981
5699 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5704 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1174 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5709 #: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5710 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5714 #: ../src/guestfs.pod:2990 ../fish/guestfish.pod:1178 ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294 ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5719 #: ../src/guestfs.pod:2992 ../fish/guestfish.pod:1180 ../test-tool/libguestfs-test-tool.pod:99
5720 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5724 #: ../src/guestfs.pod:2995
5726 "This library is free software; you can redistribute it and/or modify it "
5727 "under the terms of the GNU Lesser General Public License as published by the "
5728 "Free Software Foundation; either version 2 of the License, or (at your "
5729 "option) any later version."
5733 #: ../src/guestfs.pod:3000
5735 "This library is distributed in the hope that it will be useful, but WITHOUT "
5736 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5737 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5742 #: ../src/guestfs.pod:3005
5744 "You should have received a copy of the GNU Lesser General Public License "
5745 "along with this library; if not, write to the Free Software Foundation, "
5746 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5750 #: ../src/guestfs-actions.pod:1
5751 msgid "guestfs_add_cdrom"
5755 #: ../src/guestfs-actions.pod:3
5759 " guestfs_add_cdrom (guestfs_h *g,\n"
5760 " const char *filename);\n"
5765 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5766 msgid "This function adds a virtual CD-ROM disk image to the guest."
5770 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5771 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5775 #: ../src/guestfs-actions.pod:17
5777 "This call checks for the existence of C<filename>. This stops you from "
5778 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5779 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5784 #: ../src/guestfs-actions.pod:24
5786 "If you just want to add an ISO file (often you use this as an efficient way "
5787 "to transfer large files into the guest), then you should probably use "
5788 "C<guestfs_add_drive_ro> instead."
5792 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307 ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547 ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821 ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104 ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175 ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276 ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343 ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483 ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1720 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:2269 ../src/guestfs-actions.pod:2413 ../src/guestfs-actions.pod:2474 ../src/guestfs-actions.pod:2509 ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:3500 ../src/guestfs-actions.pod:3525 ../src/guestfs-actions.pod:3680 ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3721 ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3881 ../src/guestfs-actions.pod:3904 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3959 ../src/guestfs-actions.pod:3978 ../src/guestfs-actions.pod:3997 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4044 ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4096 ../src/guestfs-actions.pod:4109 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4141 ../src/guestfs-actions.pod:4234 ../src/guestfs-actions.pod:4254 ../src/guestfs-actions.pod:4267 ../src/guestfs-actions.pod:4318 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4370 ../src/guestfs-actions.pod:4384 ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4450 ../src/guestfs-actions.pod:4508 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4612 ../src/guestfs-actions.pod:4631 ../src/guestfs-actions.pod:4650 ../src/guestfs-actions.pod:4662 ../src/guestfs-actions.pod:4679 ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4707 ../src/guestfs-actions.pod:4722 ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:4813 ../src/guestfs-actions.pod:4830 ../src/guestfs-actions.pod:4879 ../src/guestfs-actions.pod:4916 ../src/guestfs-actions.pod:4930 ../src/guestfs-actions.pod:4958 ../src/guestfs-actions.pod:4975 ../src/guestfs-actions.pod:4993 ../src/guestfs-actions.pod:5127 ../src/guestfs-actions.pod:5184 ../src/guestfs-actions.pod:5206 ../src/guestfs-actions.pod:5224 ../src/guestfs-actions.pod:5256 ../src/guestfs-actions.pod:5322 ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:5366 ../src/guestfs-actions.pod:5655 ../src/guestfs-actions.pod:5674 ../src/guestfs-actions.pod:5693 ../src/guestfs-actions.pod:5705 ../src/guestfs-actions.pod:5717 ../src/guestfs-actions.pod:5731 ../src/guestfs-actions.pod:5743 ../src/guestfs-actions.pod:5757 ../src/guestfs-actions.pod:5773 ../src/guestfs-actions.pod:5794 ../src/guestfs-actions.pod:5813 ../src/guestfs-actions.pod:5832 ../src/guestfs-actions.pod:5862 ../src/guestfs-actions.pod:5878 ../src/guestfs-actions.pod:5901 ../src/guestfs-actions.pod:5919 ../src/guestfs-actions.pod:5938 ../src/guestfs-actions.pod:5959 ../src/guestfs-actions.pod:5978 ../src/guestfs-actions.pod:5995 ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:6047 ../src/guestfs-actions.pod:6066 ../src/guestfs-actions.pod:6090 ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6124 ../src/guestfs-actions.pod:6143 ../src/guestfs-actions.pod:6180 ../src/guestfs-actions.pod:6210 ../src/guestfs-actions.pod:6243 ../src/guestfs-actions.pod:6365 ../src/guestfs-actions.pod:6486 ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6524 ../src/guestfs-actions.pod:6546 ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6572 ../src/guestfs-actions.pod:6585 ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6659 ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6692 ../src/guestfs-actions.pod:6708 ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6738 ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6808 ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:6862 ../src/guestfs-actions.pod:6880 ../src/guestfs-actions.pod:6914 ../src/guestfs-actions.pod:6950 ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7087 ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7156 ../src/guestfs-actions.pod:7169 ../src/guestfs-actions.pod:7214 ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7308 ../src/guestfs-actions.pod:7334 ../src/guestfs-actions.pod:7401 ../src/guestfs-actions.pod:7420 ../src/guestfs-actions.pod:7449
5793 msgid "This function returns 0 on success or -1 on error."
5797 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
5799 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5804 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:1947 ../src/guestfs-actions.pod:1968 ../src/guestfs-actions.pod:4455 ../src/guestfs-actions.pod:4762 ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6218 ../src/guestfs-actions.pod:6251 ../src/guestfs-actions.pod:6310 ../src/guestfs-actions.pod:7252 ../src/guestfs-actions.pod:7342 ../src/guestfs-actions.pod:7512 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3025 ../fish/guestfish-actions.pod:3222 ../fish/guestfish-actions.pod:4194 ../fish/guestfish-actions.pod:4217 ../fish/guestfish-actions.pod:4239 ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4918 ../fish/guestfish-actions.pod:5016
5806 "Deprecated functions will not be removed from the API, but the fact that "
5807 "they are deprecated indicates that there are problems with correct use of "
5812 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1919 ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2120 ../src/guestfs-actions.pod:3487 ../src/guestfs-actions.pod:3507 ../src/guestfs-actions.pod:4766 ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5997 ../src/guestfs-actions.pod:6111 ../src/guestfs-actions.pod:6602 ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:7256
5813 msgid "(Added in 0.3)"
5817 #: ../src/guestfs-actions.pod:41
5818 msgid "guestfs_add_domain"
5822 #: ../src/guestfs-actions.pod:43
5826 " guestfs_add_domain (guestfs_h *g,\n"
5827 " const char *dom,\n"
5833 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:4469
5835 "You may supply a list of optional arguments to this call. Use zero or more "
5836 "of the following pairs of parameters, and terminate the list with C<-1> on "
5837 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5841 #: ../src/guestfs-actions.pod:53
5844 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5845 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5846 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5847 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5848 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
5853 #: ../src/guestfs-actions.pod:59
5855 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5856 "It works by connecting to libvirt, requesting the domain and domain XML from "
5857 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5862 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
5864 "The number of disks added is returned. This operation is atomic: if an "
5865 "error is returned, then no disks are added."
5869 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
5871 "This function does some minimal checks to make sure the libvirt domain is "
5872 "not running (unless C<readonly> is true). In a future version we will try "
5873 "to acquire the libvirt lock on each disk."
5877 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
5879 "Disks must be accessible locally. This often means that adding disks from a "
5880 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5881 "unless those disks are accessible via the same device path locally too."
5885 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
5887 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5888 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5889 "default libvirt URI (or one set through an environment variable, see the "
5890 "libvirt documentation for full details)."
5894 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
5896 "The optional C<live> flag controls whether this call will try to connect to "
5897 "a running virtual machine C<guestfsd> process if it sees a suitable "
5898 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5899 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5900 "DAEMONS> for more information."
5904 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
5906 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5907 "passed instead of the domain name. The C<dom> string is treated as a UUID "
5908 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
5913 #: ../src/guestfs-actions.pod:94
5915 "The other optional parameters are passed directly through to "
5916 "C<guestfs_add_drive_opts>."
5920 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321 ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:1880 ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2084 ../src/guestfs-actions.pod:2107 ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:2783 ../src/guestfs-actions.pod:2804 ../src/guestfs-actions.pod:4902 ../src/guestfs-actions.pod:5030 ../src/guestfs-actions.pod:5436 ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:6835 ../src/guestfs-actions.pod:7267 ../src/guestfs-actions.pod:7280 ../src/guestfs-actions.pod:7293
5921 msgid "On error this function returns -1."
5925 #: ../src/guestfs-actions.pod:99
5926 msgid "(Added in 1.7.4)"
5930 #: ../src/guestfs-actions.pod:101
5931 msgid "guestfs_add_domain_va"
5935 #: ../src/guestfs-actions.pod:103
5939 " guestfs_add_domain_va (guestfs_h *g,\n"
5940 " const char *dom,\n"
5946 #: ../src/guestfs-actions.pod:108
5947 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5951 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:4522 ../src/guestfs-actions.pod:4534
5952 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5956 #: ../src/guestfs-actions.pod:112
5957 msgid "guestfs_add_domain_argv"
5961 #: ../src/guestfs-actions.pod:114
5965 " guestfs_add_domain_argv (guestfs_h *g,\n"
5966 " const char *dom,\n"
5967 " const struct guestfs_add_domain_argv *optargs);\n"
5972 #: ../src/guestfs-actions.pod:119
5973 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5977 #: ../src/guestfs-actions.pod:123
5978 msgid "guestfs_add_drive"
5982 #: ../src/guestfs-actions.pod:125
5986 " guestfs_add_drive (guestfs_h *g,\n"
5987 " const char *filename);\n"
5992 #: ../src/guestfs-actions.pod:129
5994 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5995 "optional parameters, so the disk is added writable, with the format being "
5996 "detected automatically."
6000 #: ../src/guestfs-actions.pod:133
6002 "Automatic detection of the format opens you up to a potential security hole "
6003 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6004 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6005 "you should think about replacing calls to this function with calls to "
6006 "C<guestfs_add_drive_opts>, and specifying the format."
6010 #: ../src/guestfs-actions.pod:144
6011 msgid "guestfs_add_drive_opts"
6015 #: ../src/guestfs-actions.pod:146
6019 " guestfs_add_drive_opts (guestfs_h *g,\n"
6020 " const char *filename,\n"
6026 #: ../src/guestfs-actions.pod:156
6029 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6030 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6031 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6036 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6038 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6039 "The first time you call this function, the disk appears as C</dev/sda>, the "
6040 "second time as C</dev/sdb>, and so on."
6044 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6046 "You don't necessarily need to be root when using libguestfs. However you "
6047 "obviously do need sufficient permissions to access the filename for whatever "
6048 "operations you want to perform (ie. read access if you just want to read the "
6049 "image or write access if you want to modify the image)."
6053 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6054 msgid "This call checks that C<filename> exists."
6058 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4480 ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3036
6059 msgid "The optional arguments are:"
6063 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6068 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6070 "If true then the image is treated as read-only. Writes are still allowed, "
6071 "but they are stored in a temporary snapshot overlay which is discarded at "
6072 "the end. The disk that you add is not modified."
6076 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6081 #: ../src/guestfs-actions.pod:185
6083 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6084 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6085 "Possible formats include C<raw> and C<qcow2>."
6089 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6091 "Automatic detection of the format opens you up to a potential security hole "
6092 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6093 "RHBZ#642934. Specifying the format closes this security hole."
6097 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6102 #: ../src/guestfs-actions.pod:196
6104 "This rarely-used option lets you emulate the behaviour of the deprecated "
6105 "C<guestfs_add_drive_with_if> call (q.v.)"
6109 #: ../src/guestfs-actions.pod:203
6110 msgid "(Added in 1.5.23)"
6114 #: ../src/guestfs-actions.pod:205
6115 msgid "guestfs_add_drive_opts_va"
6119 #: ../src/guestfs-actions.pod:207
6123 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6124 " const char *filename,\n"
6130 #: ../src/guestfs-actions.pod:212
6131 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6135 #: ../src/guestfs-actions.pod:216
6136 msgid "guestfs_add_drive_opts_argv"
6140 #: ../src/guestfs-actions.pod:218
6144 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6145 " const char *filename,\n"
6146 " const struct guestfs_add_drive_opts_argv "
6152 #: ../src/guestfs-actions.pod:223
6153 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6157 #: ../src/guestfs-actions.pod:227
6158 msgid "guestfs_add_drive_ro"
6162 #: ../src/guestfs-actions.pod:229
6166 " guestfs_add_drive_ro (guestfs_h *g,\n"
6167 " const char *filename);\n"
6172 #: ../src/guestfs-actions.pod:233
6174 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6175 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6176 "disk is added read-only, with the format being detected automatically."
6180 #: ../src/guestfs-actions.pod:240
6181 msgid "(Added in 1.0.38)"
6185 #: ../src/guestfs-actions.pod:242
6186 msgid "guestfs_add_drive_ro_with_if"
6190 #: ../src/guestfs-actions.pod:244
6194 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6195 " const char *filename,\n"
6196 " const char *iface);\n"
6201 #: ../src/guestfs-actions.pod:249
6203 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6204 "QEMU interface emulation to use at run time."
6208 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2359
6209 msgid "(Added in 1.0.84)"
6213 #: ../src/guestfs-actions.pod:263
6214 msgid "guestfs_add_drive_with_if"
6218 #: ../src/guestfs-actions.pod:265
6222 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6223 " const char *filename,\n"
6224 " const char *iface);\n"
6229 #: ../src/guestfs-actions.pod:270
6231 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6232 "QEMU interface emulation to use at run time."
6236 #: ../src/guestfs-actions.pod:284
6237 msgid "guestfs_aug_clear"
6241 #: ../src/guestfs-actions.pod:286
6245 " guestfs_aug_clear (guestfs_h *g,\n"
6246 " const char *augpath);\n"
6251 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6253 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6254 "L<augtool(1)> C<clear> command."
6258 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2109
6259 msgid "(Added in 1.3.4)"
6263 #: ../src/guestfs-actions.pod:297
6264 msgid "guestfs_aug_close"
6268 #: ../src/guestfs-actions.pod:299
6272 " guestfs_aug_close (guestfs_h *g);\n"
6277 #: ../src/guestfs-actions.pod:302
6279 "Close the current Augeas handle and free up any resources used by it. After "
6280 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6281 "any other Augeas functions."
6285 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366 ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:5513
6286 msgid "(Added in 0.7)"
6290 #: ../src/guestfs-actions.pod:311
6291 msgid "guestfs_aug_defnode"
6295 #: ../src/guestfs-actions.pod:313
6298 " struct guestfs_int_bool *\n"
6299 " guestfs_aug_defnode (guestfs_h *g,\n"
6300 " const char *name,\n"
6301 " const char *expr,\n"
6302 " const char *val);\n"
6307 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6308 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6312 #: ../src/guestfs-actions.pod:322
6314 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6315 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6316 "containing that single node."
6320 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6322 "On success this returns a pair containing the number of nodes in the "
6323 "nodeset, and a boolean flag if a node was created."
6327 #: ../src/guestfs-actions.pod:330
6329 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6330 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6334 #: ../src/guestfs-actions.pod:336
6335 msgid "guestfs_aug_defvar"
6339 #: ../src/guestfs-actions.pod:338
6343 " guestfs_aug_defvar (guestfs_h *g,\n"
6344 " const char *name,\n"
6345 " const char *expr);\n"
6350 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6352 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6353 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6357 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6359 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6360 "evaluates to something which is not a nodeset."
6364 #: ../src/guestfs-actions.pod:354
6365 msgid "guestfs_aug_get"
6369 #: ../src/guestfs-actions.pod:356
6373 " guestfs_aug_get (guestfs_h *g,\n"
6374 " const char *augpath);\n"
6379 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6381 "Look up the value associated with C<path>. If C<path> matches exactly one "
6382 "node, the C<value> is returned."
6386 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941 ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207 ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1548 ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2531 ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906 ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2967 ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3050 ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4186 ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5241 ../src/guestfs-actions.pod:5411 ../src/guestfs-actions.pod:5589 ../src/guestfs-actions.pod:5638 ../src/guestfs-actions.pod:6271 ../src/guestfs-actions.pod:6287 ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6335 ../src/guestfs-actions.pod:7009 ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7046 ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7506
6388 "This function returns a string, or NULL on error. I<The caller must free "
6389 "the returned string after use>."
6393 #: ../src/guestfs-actions.pod:368
6394 msgid "guestfs_aug_init"
6398 #: ../src/guestfs-actions.pod:370
6402 " guestfs_aug_init (guestfs_h *g,\n"
6403 " const char *root,\n"
6409 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6411 "Create a new Augeas handle for editing configuration files. If there was "
6412 "any previous Augeas handle associated with this guestfs session, then it is "
6417 #: ../src/guestfs-actions.pod:379
6418 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6422 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6423 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6427 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6429 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6430 "logical I<or> of the following integers:"
6434 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6435 msgid "C<AUG_SAVE_BACKUP> = 1"
6439 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6440 msgid "Keep the original file with a C<.augsave> extension."
6444 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6445 msgid "C<AUG_SAVE_NEWFILE> = 2"
6449 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6451 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6452 "original. Overrides C<AUG_SAVE_BACKUP>."
6456 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6457 msgid "C<AUG_TYPE_CHECK> = 4"
6461 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6462 msgid "Typecheck lenses (can be expensive)."
6466 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6467 msgid "C<AUG_NO_STDINC> = 8"
6471 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6472 msgid "Do not use standard load path for modules."
6476 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6477 msgid "C<AUG_SAVE_NOOP> = 16"
6481 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6482 msgid "Make save a no-op, just record what would have been changed."
6486 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6487 msgid "C<AUG_NO_LOAD> = 32"
6491 #: ../src/guestfs-actions.pod:414
6492 msgid "Do not load the tree in C<guestfs_aug_init>."
6496 #: ../src/guestfs-actions.pod:418
6497 msgid "To close the handle, you can call C<guestfs_aug_close>."
6501 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6502 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6506 #: ../src/guestfs-actions.pod:426
6507 msgid "guestfs_aug_insert"
6511 #: ../src/guestfs-actions.pod:428
6515 " guestfs_aug_insert (guestfs_h *g,\n"
6516 " const char *augpath,\n"
6517 " const char *label,\n"
6523 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6525 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6526 "or after C<path> (depending on the boolean flag C<before>)."
6530 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6532 "C<path> must match exactly one existing node in the tree, and C<label> must "
6533 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6537 #: ../src/guestfs-actions.pod:446
6538 msgid "guestfs_aug_load"
6542 #: ../src/guestfs-actions.pod:448
6546 " guestfs_aug_load (guestfs_h *g);\n"
6551 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6552 msgid "Load files into the tree."
6556 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6557 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6561 #: ../src/guestfs-actions.pod:460
6562 msgid "guestfs_aug_ls"
6566 #: ../src/guestfs-actions.pod:462
6570 " guestfs_aug_ls (guestfs_h *g,\n"
6571 " const char *augpath);\n"
6576 #: ../src/guestfs-actions.pod:466
6578 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6579 "sorting the resulting nodes into alphabetical order."
6583 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485 ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516 ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2204 ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2239 ../src/guestfs-actions.pod:2282 ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:2377 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2984 ../src/guestfs-actions.pod:3273 ../src/guestfs-actions.pod:3586 ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:4158 ../src/guestfs-actions.pod:4863 ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5509 ../src/guestfs-actions.pod:5623 ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6412 ../src/guestfs-actions.pod:6467 ../src/guestfs-actions.pod:6613 ../src/guestfs-actions.pod:6637 ../src/guestfs-actions.pod:7119 ../src/guestfs-actions.pod:7139 ../src/guestfs-actions.pod:7186 ../src/guestfs-actions.pod:7358 ../src/guestfs-actions.pod:7377 ../src/guestfs-actions.pod:7463 ../src/guestfs-actions.pod:7482 ../src/guestfs-actions.pod:7528 ../src/guestfs-actions.pod:7547
6585 "This function returns a NULL-terminated array of strings (like "
6586 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6587 "strings and the array after use>."
6591 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:3351 ../src/guestfs-actions.pod:3382 ../src/guestfs-actions.pod:3999 ../src/guestfs-actions.pod:4049 ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4432 ../src/guestfs-actions.pod:4867 ../src/guestfs-actions.pod:5324 ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:5733 ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6851 ../src/guestfs-actions.pod:6864 ../src/guestfs-actions.pod:7103 ../src/guestfs-actions.pod:7346
6592 msgid "(Added in 0.8)"
6596 #: ../src/guestfs-actions.pod:475
6597 msgid "guestfs_aug_match"
6601 #: ../src/guestfs-actions.pod:477
6605 " guestfs_aug_match (guestfs_h *g,\n"
6606 " const char *augpath);\n"
6611 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6613 "Returns a list of paths which match the path expression C<path>. The "
6614 "returned paths are sufficiently qualified so that they match exactly one "
6615 "node in the current tree."
6619 #: ../src/guestfs-actions.pod:491
6620 msgid "guestfs_aug_mv"
6624 #: ../src/guestfs-actions.pod:493
6628 " guestfs_aug_mv (guestfs_h *g,\n"
6629 " const char *src,\n"
6630 " const char *dest);\n"
6635 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6637 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6638 "C<dest> is overwritten if it exists."
6642 #: ../src/guestfs-actions.pod:505
6643 msgid "guestfs_aug_rm"
6647 #: ../src/guestfs-actions.pod:507
6651 " guestfs_aug_rm (guestfs_h *g,\n"
6652 " const char *augpath);\n"
6657 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6658 msgid "Remove C<path> and all of its children."
6662 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
6663 msgid "On success this returns the number of entries which were removed."
6667 #: ../src/guestfs-actions.pod:519
6668 msgid "guestfs_aug_save"
6672 #: ../src/guestfs-actions.pod:521
6676 " guestfs_aug_save (guestfs_h *g);\n"
6681 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
6682 msgid "This writes all pending changes to disk."
6686 #: ../src/guestfs-actions.pod:526
6688 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6693 #: ../src/guestfs-actions.pod:533
6694 msgid "guestfs_aug_set"
6698 #: ../src/guestfs-actions.pod:535
6702 " guestfs_aug_set (guestfs_h *g,\n"
6703 " const char *augpath,\n"
6704 " const char *val);\n"
6709 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
6710 msgid "Set the value associated with C<path> to C<val>."
6714 #: ../src/guestfs-actions.pod:542
6716 "In the Augeas API, it is possible to clear a node by setting the value to "
6717 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6718 "this call. Instead you must use the C<guestfs_aug_clear> call."
6722 #: ../src/guestfs-actions.pod:551
6723 msgid "guestfs_available"
6727 #: ../src/guestfs-actions.pod:553
6731 " guestfs_available (guestfs_h *g,\n"
6732 " char *const *groups);\n"
6737 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
6739 "This command is used to check the availability of some groups of "
6740 "functionality in the appliance, which not all builds of the libguestfs "
6741 "appliance will be able to provide."
6745 #: ../src/guestfs-actions.pod:561
6747 "The libguestfs groups, and the functions that those groups correspond to, "
6748 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6749 "runtime by calling C<guestfs_available_all_groups>."
6753 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
6755 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6756 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6757 "and Augeas (configuration file editing) functions."
6761 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
6762 msgid "The command returns no error if I<all> requested groups are available."
6766 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
6768 "It fails with an error if one or more of the requested groups is unavailable "
6773 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
6775 "If an unknown group name is included in the list of groups then an error is "
6780 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
6785 #: ../src/guestfs-actions.pod:585
6786 msgid "You must call C<guestfs_launch> before calling this function."
6790 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
6792 "The reason is because we don't know what groups are supported by the "
6793 "appliance/daemon until it is running and can be queried."
6797 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
6799 "If a group of functions is available, this does not necessarily mean that "
6800 "they will work. You still have to check for errors when calling individual "
6801 "API functions even if they are available."
6805 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
6807 "It is usually the job of distro packagers to build complete functionality "
6808 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6809 "with all requirements satisfied, will support everything."
6813 #: ../src/guestfs-actions.pod:607
6815 "This call was added in version C<1.0.80>. In previous versions of "
6816 "libguestfs all you could do would be to speculatively execute a command to "
6817 "find out if the daemon implemented it. See also C<guestfs_version>."
6821 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
6822 msgid "(Added in 1.0.80)"
6826 #: ../src/guestfs-actions.pod:618
6827 msgid "guestfs_available_all_groups"
6831 #: ../src/guestfs-actions.pod:620
6835 " guestfs_available_all_groups (guestfs_h *g);\n"
6840 #: ../src/guestfs-actions.pod:623
6842 "This command returns a list of all optional groups that this daemon knows "
6843 "about. Note this returns both supported and unsupported groups. To find "
6844 "out which ones the daemon can actually support you have to call "
6845 "C<guestfs_available> on each member of the returned list."
6849 #: ../src/guestfs-actions.pod:629
6850 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6854 #: ../src/guestfs-actions.pod:635
6855 msgid "(Added in 1.3.15)"
6859 #: ../src/guestfs-actions.pod:637
6860 msgid "guestfs_base64_in"
6864 #: ../src/guestfs-actions.pod:639
6868 " guestfs_base64_in (guestfs_h *g,\n"
6869 " const char *base64file,\n"
6870 " const char *filename);\n"
6875 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
6876 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6880 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
6881 msgid "(Added in 1.3.5)"
6885 #: ../src/guestfs-actions.pod:651
6886 msgid "guestfs_base64_out"
6890 #: ../src/guestfs-actions.pod:653
6894 " guestfs_base64_out (guestfs_h *g,\n"
6895 " const char *filename,\n"
6896 " const char *base64file);\n"
6901 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
6903 "This command downloads the contents of C<filename>, writing it out to local "
6904 "file C<base64file> encoded as base64."
6908 #: ../src/guestfs-actions.pod:665
6909 msgid "guestfs_blockdev_flushbufs"
6913 #: ../src/guestfs-actions.pod:667
6917 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6918 " const char *device);\n"
6923 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
6924 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6928 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722 ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819 ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464 ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508 ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527 ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
6929 msgid "This uses the L<blockdev(8)> command."
6933 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
6934 msgid "(Added in 0.9.3)"
6938 #: ../src/guestfs-actions.pod:680
6939 msgid "guestfs_blockdev_getbsz"
6943 #: ../src/guestfs-actions.pod:682
6947 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6948 " const char *device);\n"
6953 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
6954 msgid "This returns the block size of a device."
6958 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788 ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
6960 "(Note this is different from both I<size in blocks> and I<filesystem block "
6965 #: ../src/guestfs-actions.pod:697
6966 msgid "guestfs_blockdev_getro"
6970 #: ../src/guestfs-actions.pod:699
6974 " guestfs_blockdev_getro (guestfs_h *g,\n"
6975 " const char *device);\n"
6980 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
6982 "Returns a boolean indicating if the block device is read-only (true if "
6983 "read-only, false if not)."
6987 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1928 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2070 ../src/guestfs-actions.pod:2095 ../src/guestfs-actions.pod:2118 ../src/guestfs-actions.pod:3091 ../src/guestfs-actions.pod:3108 ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3290 ../src/guestfs-actions.pod:3304 ../src/guestfs-actions.pod:3319 ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3349 ../src/guestfs-actions.pod:3364 ../src/guestfs-actions.pod:3380 ../src/guestfs-actions.pod:3394 ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3421 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3464 ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:5012
6988 msgid "This function returns a C truth value on success or -1 on error."
6992 #: ../src/guestfs-actions.pod:712
6993 msgid "guestfs_blockdev_getsize64"
6997 #: ../src/guestfs-actions.pod:714
7001 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7002 " const char *device);\n"
7007 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7008 msgid "This returns the size of the device in bytes."
7012 #: ../src/guestfs-actions.pod:720
7013 msgid "See also C<guestfs_blockdev_getsz>."
7017 #: ../src/guestfs-actions.pod:728
7018 msgid "guestfs_blockdev_getss"
7022 #: ../src/guestfs-actions.pod:730
7026 " guestfs_blockdev_getss (guestfs_h *g,\n"
7027 " const char *device);\n"
7032 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7034 "This returns the size of sectors on a block device. Usually 512, but can be "
7035 "larger for modern devices."
7039 #: ../src/guestfs-actions.pod:737
7041 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7046 #: ../src/guestfs-actions.pod:746
7047 msgid "guestfs_blockdev_getsz"
7051 #: ../src/guestfs-actions.pod:748
7055 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7056 " const char *device);\n"
7061 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7063 "This returns the size of the device in units of 512-byte sectors (even if "
7064 "the sectorsize isn't 512 bytes ... weird)."
7068 #: ../src/guestfs-actions.pod:755
7070 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7071 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7075 #: ../src/guestfs-actions.pod:765
7076 msgid "guestfs_blockdev_rereadpt"
7080 #: ../src/guestfs-actions.pod:767
7084 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7085 " const char *device);\n"
7090 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7091 msgid "Reread the partition table on C<device>."
7095 #: ../src/guestfs-actions.pod:779
7096 msgid "guestfs_blockdev_setbsz"
7100 #: ../src/guestfs-actions.pod:781
7104 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7105 " const char *device,\n"
7106 " int blocksize);\n"
7111 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7112 msgid "This sets the block size of a device."
7116 #: ../src/guestfs-actions.pod:797
7117 msgid "guestfs_blockdev_setro"
7121 #: ../src/guestfs-actions.pod:799
7125 " guestfs_blockdev_setro (guestfs_h *g,\n"
7126 " const char *device);\n"
7131 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7132 msgid "Sets the block device named C<device> to read-only."
7136 #: ../src/guestfs-actions.pod:811
7137 msgid "guestfs_blockdev_setrw"
7141 #: ../src/guestfs-actions.pod:813
7145 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7146 " const char *device);\n"
7151 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7152 msgid "Sets the block device named C<device> to read-write."
7156 #: ../src/guestfs-actions.pod:825
7157 msgid "guestfs_case_sensitive_path"
7161 #: ../src/guestfs-actions.pod:827
7165 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7166 " const char *path);\n"
7171 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
7173 "This can be used to resolve case insensitive paths on a filesystem which is "
7174 "case sensitive. The use case is to resolve paths which you have read from "
7175 "Windows configuration files or the Windows Registry, to the true path."
7179 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
7181 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7182 "(and probably others), which is that although the underlying filesystem is "
7183 "case-insensitive, the driver exports the filesystem to Linux as "
7188 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
7190 "One consequence of this is that special directories such as C<c:\\windows> "
7191 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7192 "precise details of how they were created. In Windows itself this would not "
7197 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
7199 "Bug or feature? You decide: "
7200 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7204 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
7206 "This function resolves the true case of each element in the path and returns "
7207 "the case-sensitive path."
7211 #: ../src/guestfs-actions.pod:853
7213 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7214 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7215 "how the directories were originally created under Windows)."
7219 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
7220 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7224 #: ../src/guestfs-actions.pod:861
7225 msgid "See also C<guestfs_realpath>."
7229 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7031
7230 msgid "(Added in 1.0.75)"
7234 #: ../src/guestfs-actions.pod:868
7239 #: ../src/guestfs-actions.pod:870
7243 " guestfs_cat (guestfs_h *g,\n"
7244 " const char *path);\n"
7249 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5499 ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3691
7250 msgid "Return the contents of the file named C<path>."
7254 #: ../src/guestfs-actions.pod:876
7256 "Note that this function cannot correctly handle binary files (specifically, "
7257 "files containing C<\\0> character which is treated as end of string). For "
7258 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7259 "functions which have a more complex interface."
7263 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063 ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2286 ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:5281 ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5438 ../src/guestfs-actions.pod:5464 ../src/guestfs-actions.pod:5488 ../src/guestfs-actions.pod:6416 ../src/guestfs-actions.pod:6471 ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:7310 ../src/guestfs-actions.pod:7336 ../src/guestfs-actions.pod:7362 ../src/guestfs-actions.pod:7381 ../src/guestfs-actions.pod:7467 ../src/guestfs-actions.pod:7486 ../src/guestfs-actions.pod:7532 ../src/guestfs-actions.pod:7551 ../fish/guestfish-actions.pod:592 ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739 ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925 ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002 ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495 ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558 ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3561 ../fish/guestfish-actions.pod:3576 ../fish/guestfish-actions.pod:3652 ../fish/guestfish-actions.pod:3669 ../fish/guestfish-actions.pod:3684 ../fish/guestfish-actions.pod:4338 ../fish/guestfish-actions.pod:4384 ../fish/guestfish-actions.pod:4469 ../fish/guestfish-actions.pod:4484 ../fish/guestfish-actions.pod:4894 ../fish/guestfish-actions.pod:4912 ../fish/guestfish-actions.pod:4929 ../fish/guestfish-actions.pod:4939 ../fish/guestfish-actions.pod:4988 ../fish/guestfish-actions.pod:4998 ../fish/guestfish-actions.pod:5027 ../fish/guestfish-actions.pod:5037
7265 "Because of the message protocol, there is a transfer limit of somewhere "
7266 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7270 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3590 ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:3669 ../src/guestfs-actions.pod:3757 ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4176 ../src/guestfs-actions.pod:5387 ../src/guestfs-actions.pod:5401 ../src/guestfs-actions.pod:7190 ../src/guestfs-actions.pod:7204
7271 msgid "(Added in 0.4)"
7275 #: ../src/guestfs-actions.pod:889
7276 msgid "guestfs_checksum"
7280 #: ../src/guestfs-actions.pod:891
7284 " guestfs_checksum (guestfs_h *g,\n"
7285 " const char *csumtype,\n"
7286 " const char *path);\n"
7291 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
7292 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7296 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
7298 "The type of checksum to compute is given by the C<csumtype> parameter which "
7299 "must have one of the following values:"
7303 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
7308 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
7310 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7315 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
7320 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
7321 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7325 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
7330 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
7331 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7335 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
7340 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
7341 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7345 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
7350 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
7351 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7355 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
7360 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
7361 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7365 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
7370 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
7371 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7375 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
7376 msgid "The checksum is returned as a printable string."
7380 #: ../src/guestfs-actions.pod:937
7381 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7385 #: ../src/guestfs-actions.pod:939
7386 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7390 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:2086 ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3396 ../src/guestfs-actions.pod:3423 ../src/guestfs-actions.pod:6887
7391 msgid "(Added in 1.0.2)"
7395 #: ../src/guestfs-actions.pod:946
7396 msgid "guestfs_checksum_device"
7400 #: ../src/guestfs-actions.pod:948
7404 " guestfs_checksum_device (guestfs_h *g,\n"
7405 " const char *csumtype,\n"
7406 " const char *device);\n"
7411 #: ../src/guestfs-actions.pod:953
7413 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7414 "device named C<device>. For the types of checksums supported see the "
7415 "C<guestfs_checksum> command."
7419 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:4918 ../src/guestfs-actions.pod:4977 ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5032 ../src/guestfs-actions.pod:5208 ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6810 ../src/guestfs-actions.pod:7216
7420 msgid "(Added in 1.3.2)"
7424 #: ../src/guestfs-actions.pod:962
7425 msgid "guestfs_checksums_out"
7429 #: ../src/guestfs-actions.pod:964
7433 " guestfs_checksums_out (guestfs_h *g,\n"
7434 " const char *csumtype,\n"
7435 " const char *directory,\n"
7436 " const char *sumsfile);\n"
7441 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
7443 "This command computes the checksums of all regular files in C<directory> and "
7444 "then emits a list of those checksums to the local output file C<sumsfile>."
7448 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
7450 "This can be used for verifying the integrity of a virtual machine. However "
7451 "to be properly secure you should pay attention to the output of the checksum "
7452 "command (it uses the ones from GNU coreutils). In particular when the "
7453 "filename is not printable, coreutils uses a special backslash syntax. For "
7454 "more information, see the GNU coreutils info file."
7458 #: ../src/guestfs-actions.pod:984
7459 msgid "(Added in 1.3.7)"
7463 #: ../src/guestfs-actions.pod:986
7464 msgid "guestfs_chmod"
7468 #: ../src/guestfs-actions.pod:988
7472 " guestfs_chmod (guestfs_h *g,\n"
7474 " const char *path);\n"
7479 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
7481 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7486 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
7488 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7489 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7494 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4610 ../src/guestfs-actions.pod:4629 ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:681 ../fish/guestfish-actions.pod:3000 ../fish/guestfish-actions.pod:3129 ../fish/guestfish-actions.pod:3139 ../fish/guestfish-actions.pod:3149
7495 msgid "The mode actually set is affected by the umask."
7499 #: ../src/guestfs-actions.pod:1006
7500 msgid "guestfs_chown"
7504 #: ../src/guestfs-actions.pod:1008
7508 " guestfs_chown (guestfs_h *g,\n"
7511 " const char *path);\n"
7516 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
7517 msgid "Change the file owner to C<owner> and group to C<group>."
7521 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3521 ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2458
7523 "Only numeric uid and gid are supported. If you want to use names, you will "
7524 "need to locate and parse the password file yourself (Augeas support makes "
7525 "this relatively easy)."
7529 #: ../src/guestfs-actions.pod:1024
7530 msgid "guestfs_command"
7534 #: ../src/guestfs-actions.pod:1026
7538 " guestfs_command (guestfs_h *g,\n"
7539 " char *const *arguments);\n"
7544 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
7546 "This call runs a command from the guest filesystem. The filesystem must be "
7547 "mounted, and must contain a compatible operating system (ie. something "
7548 "Linux, with the same or compatible processor architecture)."
7552 #: ../src/guestfs-actions.pod:1035
7554 "The single parameter is an argv-style list of arguments. The first element "
7555 "is the name of the program to run. Subsequent elements are parameters. The "
7556 "list must be non-empty (ie. must contain a program name). Note that the "
7557 "command runs directly, and is I<not> invoked via the shell (see "
7562 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
7563 msgid "The return value is anything printed to I<stdout> by the command."
7567 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
7569 "If the command returns a non-zero exit status, then this function returns an "
7570 "error message. The error message string is the content of I<stderr> from "
7575 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
7577 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7578 "C</bin>. If you require a program from another location, you should provide "
7579 "the full path in the first parameter."
7583 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
7585 "Shared libraries and data files required by the program must be available on "
7586 "filesystems which are mounted in the correct places. It is the caller's "
7587 "responsibility to ensure all filesystems that are needed are mounted at the "
7592 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1551
7593 msgid "(Added in 0.9.1)"
7597 #: ../src/guestfs-actions.pod:1068
7598 msgid "guestfs_command_lines"
7602 #: ../src/guestfs-actions.pod:1070
7606 " guestfs_command_lines (guestfs_h *g,\n"
7607 " char *const *arguments);\n"
7612 #: ../src/guestfs-actions.pod:1074
7614 "This is the same as C<guestfs_command>, but splits the result into a list of "
7619 #: ../src/guestfs-actions.pod:1077
7620 msgid "See also: C<guestfs_sh_lines>"
7624 #: ../src/guestfs-actions.pod:1088
7625 msgid "guestfs_config"
7629 #: ../src/guestfs-actions.pod:1090
7633 " guestfs_config (guestfs_h *g,\n"
7634 " const char *qemuparam,\n"
7635 " const char *qemuvalue);\n"
7640 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
7642 "This can be used to add arbitrary qemu command line parameters of the form "
7643 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7644 "setting some parameters which would interfere with parameters that we use."
7648 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
7649 msgid "The first character of C<param> string must be a C<-> (dash)."
7653 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
7654 msgid "C<value> can be NULL."
7658 #: ../src/guestfs-actions.pod:1108
7659 msgid "guestfs_copy_size"
7663 #: ../src/guestfs-actions.pod:1110
7667 " guestfs_copy_size (guestfs_h *g,\n"
7668 " const char *src,\n"
7669 " const char *dest,\n"
7675 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
7677 "This command copies exactly C<size> bytes from one source device or file "
7678 "C<src> to another destination device or file C<dest>."
7682 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
7684 "Note this will fail if the source is too short or if the destination is not "
7689 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247 ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323 ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:3502 ../src/guestfs-actions.pod:6882 ../src/guestfs-actions.pod:6916 ../src/guestfs-actions.pod:7403 ../src/guestfs-actions.pod:7422
7691 "This long-running command can generate progress notification messages so "
7692 "that the caller can display a progress bar or indicator. To receive these "
7693 "messages, the caller must register a progress event callback. See "
7694 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7698 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4189 ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:7123 ../src/guestfs-actions.pod:7143 ../src/guestfs-actions.pod:7229
7699 msgid "(Added in 1.0.87)"
7703 #: ../src/guestfs-actions.pod:1131
7708 #: ../src/guestfs-actions.pod:1133
7712 " guestfs_cp (guestfs_h *g,\n"
7713 " const char *src,\n"
7714 " const char *dest);\n"
7719 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
7721 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7722 "destination filename or destination directory."
7726 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157 ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303 ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:4881 ../src/guestfs-actions.pod:5258
7727 msgid "(Added in 1.0.18)"
7731 #: ../src/guestfs-actions.pod:1145
7732 msgid "guestfs_cp_a"
7736 #: ../src/guestfs-actions.pod:1147
7740 " guestfs_cp_a (guestfs_h *g,\n"
7741 " const char *src,\n"
7742 " const char *dest);\n"
7747 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
7749 "This copies a file or directory from C<src> to C<dest> recursively using the "
7754 #: ../src/guestfs-actions.pod:1159
7759 #: ../src/guestfs-actions.pod:1161
7763 " guestfs_dd (guestfs_h *g,\n"
7764 " const char *src,\n"
7765 " const char *dest);\n"
7770 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
7772 "This command copies from one source device or file C<src> to another "
7773 "destination device or file C<dest>. Normally you would use this to copy to "
7774 "or from a device or partition, for example to duplicate a filesystem."
7778 #: ../src/guestfs-actions.pod:1171
7780 "If the destination is a device, it must be as large or larger than the "
7781 "source file or device, otherwise the copy will fail. This command cannot do "
7782 "partial copies (see C<guestfs_copy_size>)."
7786 #: ../src/guestfs-actions.pod:1179
7791 #: ../src/guestfs-actions.pod:1181
7795 " guestfs_df (guestfs_h *g);\n"
7800 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
7801 msgid "This command runs the C<df> command to report disk space used."
7805 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
7807 "This command is mostly useful for interactive sessions. It is I<not> "
7808 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7813 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210 ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2289 ../src/guestfs-actions.pod:2313 ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:4299 ../src/guestfs-actions.pod:4781 ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6644 ../src/guestfs-actions.pod:7269 ../src/guestfs-actions.pod:7282 ../src/guestfs-actions.pod:7295
7814 msgid "(Added in 1.0.54)"
7818 #: ../src/guestfs-actions.pod:1195
7819 msgid "guestfs_df_h"
7823 #: ../src/guestfs-actions.pod:1197
7827 " guestfs_df_h (guestfs_h *g);\n"
7832 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
7834 "This command runs the C<df -h> command to report disk space used in "
7835 "human-readable format."
7839 #: ../src/guestfs-actions.pod:1212
7840 msgid "guestfs_dmesg"
7844 #: ../src/guestfs-actions.pod:1214
7848 " guestfs_dmesg (guestfs_h *g);\n"
7853 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
7855 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7856 "This is sometimes useful for extended debugging of problems."
7860 #: ../src/guestfs-actions.pod:1221
7862 "Another way to get the same information is to enable verbose messages with "
7863 "C<guestfs_set_verbose> or by setting the environment variable "
7864 "C<LIBGUESTFS_DEBUG=1> before running the program."
7868 #: ../src/guestfs-actions.pod:1231
7869 msgid "guestfs_download"
7873 #: ../src/guestfs-actions.pod:1233
7877 " guestfs_download (guestfs_h *g,\n"
7878 " const char *remotefilename,\n"
7879 " const char *filename);\n"
7884 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263 ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
7886 "Download file C<remotefilename> and save it as C<filename> on the local "
7891 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:6876 ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4642
7892 msgid "C<filename> can also be a named pipe."
7896 #: ../src/guestfs-actions.pod:1243
7897 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7901 #: ../src/guestfs-actions.pod:1254
7902 msgid "guestfs_download_offset"
7906 #: ../src/guestfs-actions.pod:1256
7910 " guestfs_download_offset (guestfs_h *g,\n"
7911 " const char *remotefilename,\n"
7912 " const char *filename,\n"
7913 " int64_t offset,\n"
7919 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
7921 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7922 "region must be within the file or device)."
7926 #: ../src/guestfs-actions.pod:1269
7928 "Note that there is no limit on the amount of data that can be downloaded "
7929 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7930 "full amount unless an error occurs."
7934 #: ../src/guestfs-actions.pod:1274
7935 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7939 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:6921
7940 msgid "(Added in 1.5.17)"
7944 #: ../src/guestfs-actions.pod:1285
7945 msgid "guestfs_drop_caches"
7949 #: ../src/guestfs-actions.pod:1287
7953 " guestfs_drop_caches (guestfs_h *g,\n"
7954 " int whattodrop);\n"
7959 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
7961 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7962 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7963 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7967 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
7968 msgid "Setting C<whattodrop> to 3 should drop everything."
7972 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
7974 "This automatically calls L<sync(2)> before the operation, so that the "
7975 "maximum guest memory is freed."
7979 #: ../src/guestfs-actions.pod:1305
7984 #: ../src/guestfs-actions.pod:1307
7988 " guestfs_du (guestfs_h *g,\n"
7989 " const char *path);\n"
7994 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
7996 "This command runs the C<du -s> command to estimate file space usage for "
8001 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
8003 "C<path> can be a file or a directory. If C<path> is a directory then the "
8004 "estimate includes the contents of the directory and all subdirectories "
8009 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
8010 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8014 #: ../src/guestfs-actions.pod:1330
8015 msgid "guestfs_e2fsck_f"
8019 #: ../src/guestfs-actions.pod:1332
8023 " guestfs_e2fsck_f (guestfs_h *g,\n"
8024 " const char *device);\n"
8029 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
8031 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8032 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8037 #: ../src/guestfs-actions.pod:1340
8039 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8040 "Normally you should use C<guestfs_fsck>."
8044 #: ../src/guestfs-actions.pod:1345
8045 msgid "(Added in 1.0.29)"
8049 #: ../src/guestfs-actions.pod:1347
8050 msgid "guestfs_echo_daemon"
8054 #: ../src/guestfs-actions.pod:1349
8058 " guestfs_echo_daemon (guestfs_h *g,\n"
8059 " char *const *words);\n"
8064 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
8066 "This command concatenates the list of C<words> passed with single spaces "
8067 "between them and returns the resulting string."
8071 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
8072 msgid "You can use this command to test the connection through to the daemon."
8076 #: ../src/guestfs-actions.pod:1358
8077 msgid "See also C<guestfs_ping_daemon>."
8081 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2097 ../src/guestfs-actions.pod:6092
8082 msgid "(Added in 1.0.69)"
8086 #: ../src/guestfs-actions.pod:1365
8087 msgid "guestfs_egrep"
8091 #: ../src/guestfs-actions.pod:1367
8095 " guestfs_egrep (guestfs_h *g,\n"
8096 " const char *regex,\n"
8097 " const char *path);\n"
8102 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
8103 msgid "This calls the external C<egrep> program and returns the matching lines."
8107 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401 ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2227 ../src/guestfs-actions.pod:2246 ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:2430 ../src/guestfs-actions.pod:2476 ../src/guestfs-actions.pod:2498 ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:3682 ../src/guestfs-actions.pod:3696 ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:4709 ../src/guestfs-actions.pod:5592 ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:6488 ../src/guestfs-actions.pod:6500 ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:6561 ../src/guestfs-actions.pod:6574 ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:7365 ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7470 ../src/guestfs-actions.pod:7489 ../src/guestfs-actions.pod:7535 ../src/guestfs-actions.pod:7554
8108 msgid "(Added in 1.0.66)"
8112 #: ../src/guestfs-actions.pod:1384
8113 msgid "guestfs_egrepi"
8117 #: ../src/guestfs-actions.pod:1386
8121 " guestfs_egrepi (guestfs_h *g,\n"
8122 " const char *regex,\n"
8123 " const char *path);\n"
8128 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
8129 msgid "This calls the external C<egrep -i> program and returns the matching lines."
8133 #: ../src/guestfs-actions.pod:1403
8134 msgid "guestfs_equal"
8138 #: ../src/guestfs-actions.pod:1405
8142 " guestfs_equal (guestfs_h *g,\n"
8143 " const char *file1,\n"
8144 " const char *file2);\n"
8149 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
8151 "This compares the two files C<file1> and C<file2> and returns true if their "
8152 "content is exactly equal, or false otherwise."
8156 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
8157 msgid "The external L<cmp(1)> program is used for the comparison."
8161 #: ../src/guestfs-actions.pod:1419
8162 msgid "guestfs_exists"
8166 #: ../src/guestfs-actions.pod:1421
8170 " guestfs_exists (guestfs_h *g,\n"
8171 " const char *path);\n"
8176 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
8178 "This returns C<true> if and only if there is a file, directory (or anything) "
8179 "with the given C<path> name."
8183 #: ../src/guestfs-actions.pod:1428
8184 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8188 #: ../src/guestfs-actions.pod:1434
8189 msgid "guestfs_fallocate"
8193 #: ../src/guestfs-actions.pod:1436
8197 " guestfs_fallocate (guestfs_h *g,\n"
8198 " const char *path,\n"
8204 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467 ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8206 "This command preallocates a file (containing zero bytes) named C<path> of "
8207 "size C<len> bytes. If the file exists already, it is overwritten."
8211 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
8213 "Do not confuse this with the guestfish-specific C<alloc> command which "
8214 "allocates a file in the host and attaches it as a device."
8218 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
8220 "This function is deprecated. In new code, use the C<fallocate64> call "
8225 #: ../src/guestfs-actions.pod:1460
8226 msgid "guestfs_fallocate64"
8230 #: ../src/guestfs-actions.pod:1462
8234 " guestfs_fallocate64 (guestfs_h *g,\n"
8235 " const char *path,\n"
8241 #: ../src/guestfs-actions.pod:1471
8243 "Note that this call allocates disk blocks for the file. To create a sparse "
8244 "file use C<guestfs_truncate_size> instead."
8248 #: ../src/guestfs-actions.pod:1474
8250 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8251 "oversight it only allowed 30 bit lengths to be specified, effectively "
8252 "limiting the maximum size of files created through that call to 1GB."
8256 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
8258 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8259 "commands which create a file in the host and attach it as a device."
8263 #: ../src/guestfs-actions.pod:1485
8264 msgid "(Added in 1.3.17)"
8268 #: ../src/guestfs-actions.pod:1487
8269 msgid "guestfs_fgrep"
8273 #: ../src/guestfs-actions.pod:1489
8277 " guestfs_fgrep (guestfs_h *g,\n"
8278 " const char *pattern,\n"
8279 " const char *path);\n"
8284 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
8285 msgid "This calls the external C<fgrep> program and returns the matching lines."
8289 #: ../src/guestfs-actions.pod:1506
8290 msgid "guestfs_fgrepi"
8294 #: ../src/guestfs-actions.pod:1508
8298 " guestfs_fgrepi (guestfs_h *g,\n"
8299 " const char *pattern,\n"
8300 " const char *path);\n"
8305 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
8306 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8310 #: ../src/guestfs-actions.pod:1525
8311 msgid "guestfs_file"
8315 #: ../src/guestfs-actions.pod:1527
8319 " guestfs_file (guestfs_h *g,\n"
8320 " const char *path);\n"
8325 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
8327 "This call uses the standard L<file(1)> command to determine the type or "
8328 "contents of the file."
8332 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
8334 "This call will also transparently look inside various types of compressed "
8339 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
8341 "The exact command which runs is C<file -zb path>. Note in particular that "
8342 "the filename is not prepended to the output (the I<-b> option)."
8346 #: ../src/guestfs-actions.pod:1541 ../fish/guestfish-actions.pod:1019
8348 "The output depends on the output of the underlying L<file(1)> command and it "
8349 "can change in future in ways beyond our control. In other words, the output "
8350 "is not guaranteed by the ABI."
8354 #: ../src/guestfs-actions.pod:1545
8356 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8357 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8361 #: ../src/guestfs-actions.pod:1553
8362 msgid "guestfs_file_architecture"
8366 #: ../src/guestfs-actions.pod:1555
8370 " guestfs_file_architecture (guestfs_h *g,\n"
8371 " const char *filename);\n"
8376 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1030
8378 "This detects the architecture of the binary C<filename>, and returns it if "
8383 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
8384 msgid "Currently defined architectures are:"
8388 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1037
8393 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1039
8395 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8396 "irrespective of the precise processor requirements of the binary."
8400 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
8405 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1044
8406 msgid "64 bit x86-64."
8410 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1046
8415 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1048
8416 msgid "32 bit SPARC."
8420 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1050
8425 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1052
8426 msgid "64 bit SPARC V9 and above."
8430 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1054
8435 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1056
8436 msgid "Intel Itanium."
8440 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1058
8445 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1060
8446 msgid "32 bit Power PC."
8450 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1062
8455 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1064
8456 msgid "64 bit Power PC."
8460 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1068
8461 msgid "Libguestfs may return other architecture strings in future."
8465 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1070
8466 msgid "The function works on at least the following types of files:"
8470 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1076
8471 msgid "many types of Un*x and Linux binary"
8475 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1080
8476 msgid "many types of Un*x and Linux shared library"
8480 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1084
8481 msgid "Windows Win32 and Win64 binaries"
8485 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1088
8486 msgid "Windows Win32 and Win64 DLLs"
8490 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1090
8491 msgid "Win32 binaries and DLLs return C<i386>."
8495 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1092
8496 msgid "Win64 binaries and DLLs return C<x86_64>."
8500 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1096
8501 msgid "Linux kernel modules"
8505 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1100
8506 msgid "Linux new-style initrd images"
8510 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1104
8511 msgid "some non-x86 Linux vmlinuz kernels"
8515 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1108
8516 msgid "What it can't do currently:"
8520 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1114
8521 msgid "static libraries (libfoo.a)"
8525 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1118
8526 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8530 #: ../src/guestfs-actions.pod:1651 ../fish/guestfish-actions.pod:1122
8531 msgid "x86 Linux vmlinuz kernels"
8535 #: ../src/guestfs-actions.pod:1653 ../fish/guestfish-actions.pod:1124
8537 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8538 "compressed code, and are horribly hard to unpack. If you want to find the "
8539 "architecture of a kernel, use the architecture of the associated initrd or "
8540 "kernel module(s) instead."
8544 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2534 ../src/guestfs-actions.pod:2627 ../src/guestfs-actions.pod:2697 ../src/guestfs-actions.pod:2785 ../src/guestfs-actions.pod:2806 ../src/guestfs-actions.pod:2849 ../src/guestfs-actions.pod:2933 ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3409
8545 msgid "(Added in 1.5.3)"
8549 #: ../src/guestfs-actions.pod:1665
8550 msgid "guestfs_filesize"
8554 #: ../src/guestfs-actions.pod:1667
8558 " guestfs_filesize (guestfs_h *g,\n"
8559 " const char *file);\n"
8564 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1135
8565 msgid "This command returns the size of C<file> in bytes."
8569 #: ../src/guestfs-actions.pod:1673
8571 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8572 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8573 "devices, use C<guestfs_blockdev_getsize64>."
8577 #: ../src/guestfs-actions.pod:1679
8578 msgid "(Added in 1.0.82)"
8582 #: ../src/guestfs-actions.pod:1681
8583 msgid "guestfs_fill"
8587 #: ../src/guestfs-actions.pod:1683
8591 " guestfs_fill (guestfs_h *g,\n"
8594 " const char *path);\n"
8599 #: ../src/guestfs-actions.pod:1689 ../fish/guestfish-actions.pod:1145
8601 "This command creates a new file called C<path>. The initial content of the "
8602 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8607 #: ../src/guestfs-actions.pod:1693
8609 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8610 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8611 "bytes use C<guestfs_fill_pattern>."
8615 #: ../src/guestfs-actions.pod:1705
8616 msgid "(Added in 1.0.79)"
8620 #: ../src/guestfs-actions.pod:1707
8621 msgid "guestfs_fill_pattern"
8625 #: ../src/guestfs-actions.pod:1709
8629 " guestfs_fill_pattern (guestfs_h *g,\n"
8630 " const char *pattern,\n"
8632 " const char *path);\n"
8637 #: ../src/guestfs-actions.pod:1715
8639 "This function is like C<guestfs_fill> except that it creates a new file of "
8640 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8641 "pattern is truncated if necessary to ensure the length of the file is "
8642 "exactly C<len> bytes."
8646 #: ../src/guestfs-actions.pod:1727
8647 msgid "(Added in 1.3.12)"
8651 #: ../src/guestfs-actions.pod:1729
8652 msgid "guestfs_find"
8656 #: ../src/guestfs-actions.pod:1731
8660 " guestfs_find (guestfs_h *g,\n"
8661 " const char *directory);\n"
8666 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1167
8668 "This command lists out all files and directories, recursively, starting at "
8669 "C<directory>. It is essentially equivalent to running the shell command "
8670 "C<find directory -print> but some post-processing happens on the output, "
8675 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1172
8677 "This returns a list of strings I<without any prefix>. Thus if the directory "
8682 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
8692 #: ../src/guestfs-actions.pod:1747
8693 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8697 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1182
8708 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1187
8709 msgid "If C<directory> is not a directory, then this command returns an error."
8713 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
8714 msgid "The returned list is sorted."
8718 #: ../src/guestfs-actions.pod:1760
8719 msgid "See also C<guestfs_find0>."
8723 #: ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:4126 ../src/guestfs-actions.pod:5676
8724 msgid "(Added in 1.0.27)"
8728 #: ../src/guestfs-actions.pod:1771
8729 msgid "guestfs_find0"
8733 #: ../src/guestfs-actions.pod:1773
8737 " guestfs_find0 (guestfs_h *g,\n"
8738 " const char *directory,\n"
8739 " const char *files);\n"
8744 #: ../src/guestfs-actions.pod:1778 ../fish/guestfish-actions.pod:1201
8746 "This command lists out all files and directories, recursively, starting at "
8747 "C<directory>, placing the resulting list in the external file called "
8752 #: ../src/guestfs-actions.pod:1782
8754 "This command works the same way as C<guestfs_find> with the following "
8759 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1212
8760 msgid "The resulting list is written to an external file."
8764 #: ../src/guestfs-actions.pod:1793 ../fish/guestfish-actions.pod:1216
8766 "Items (filenames) in the result are separated by C<\\0> characters. See "
8767 "L<find(1)> option I<-print0>."
8771 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1221
8772 msgid "This command is not limited in the number of names that it can return."
8776 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1226
8777 msgid "The result list is not sorted."
8781 #: ../src/guestfs-actions.pod:1809
8782 msgid "(Added in 1.0.74)"
8786 #: ../src/guestfs-actions.pod:1811
8787 msgid "guestfs_findfs_label"
8791 #: ../src/guestfs-actions.pod:1813
8795 " guestfs_findfs_label (guestfs_h *g,\n"
8796 " const char *label);\n"
8801 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1236
8803 "This command searches the filesystems and returns the one which has the "
8804 "given label. An error is returned if no such filesystem can be found."
8808 #: ../src/guestfs-actions.pod:1821
8809 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8813 #: ../src/guestfs-actions.pod:1828
8814 msgid "guestfs_findfs_uuid"
8818 #: ../src/guestfs-actions.pod:1830
8822 " guestfs_findfs_uuid (guestfs_h *g,\n"
8823 " const char *uuid);\n"
8828 #: ../src/guestfs-actions.pod:1834 ../fish/guestfish-actions.pod:1246
8830 "This command searches the filesystems and returns the one which has the "
8831 "given UUID. An error is returned if no such filesystem can be found."
8835 #: ../src/guestfs-actions.pod:1838
8836 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8840 #: ../src/guestfs-actions.pod:1845
8841 msgid "guestfs_fsck"
8845 #: ../src/guestfs-actions.pod:1847
8849 " guestfs_fsck (guestfs_h *g,\n"
8850 " const char *fstype,\n"
8851 " const char *device);\n"
8856 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1256
8858 "This runs the filesystem checker (fsck) on C<device> which should have "
8859 "filesystem type C<fstype>."
8863 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
8865 "The returned integer is the status. See L<fsck(8)> for the list of status "
8866 "codes from C<fsck>."
8870 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1268
8871 msgid "Multiple status codes can be summed together."
8875 #: ../src/guestfs-actions.pod:1868 ../fish/guestfish-actions.pod:1272
8877 "A non-zero return code can mean \"success\", for example if errors have been "
8878 "corrected on the filesystem."
8882 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1277
8883 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8887 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1282
8888 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8892 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:7408
8893 msgid "(Added in 1.0.16)"
8897 #: ../src/guestfs-actions.pod:1884
8898 msgid "guestfs_get_append"
8902 #: ../src/guestfs-actions.pod:1886
8906 " guestfs_get_append (guestfs_h *g);\n"
8911 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
8913 "Return the additional kernel options which are added to the guest kernel "
8918 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
8919 msgid "If C<NULL> then no options are added."
8923 #: ../src/guestfs-actions.pod:1894
8925 "This function returns a string which may be NULL. There is no way to return "
8926 "an error from this function. The string is owned by the guest handle and "
8927 "must I<not> be freed."
8931 #: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:5354 ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:6255 ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6290 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:7071 ../src/guestfs-actions.pod:7089 ../src/guestfs-actions.pod:7451
8932 msgid "(Added in 1.0.26)"
8936 #: ../src/guestfs-actions.pod:1900
8937 msgid "guestfs_get_attach_method"
8941 #: ../src/guestfs-actions.pod:1902
8945 " guestfs_get_attach_method (guestfs_h *g);\n"
8950 #: ../src/guestfs-actions.pod:1905
8951 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8955 #: ../src/guestfs-actions.pod:1910
8956 msgid "guestfs_get_autosync"
8960 #: ../src/guestfs-actions.pod:1912
8964 " guestfs_get_autosync (guestfs_h *g);\n"
8969 #: ../src/guestfs-actions.pod:1915 ../fish/guestfish-actions.pod:1303
8970 msgid "Get the autosync flag."
8974 #: ../src/guestfs-actions.pod:1921
8975 msgid "guestfs_get_direct"
8979 #: ../src/guestfs-actions.pod:1923
8983 " guestfs_get_direct (guestfs_h *g);\n"
8988 #: ../src/guestfs-actions.pod:1926 ../fish/guestfish-actions.pod:1309
8989 msgid "Return the direct appliance mode flag."
8993 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:5903
8994 msgid "(Added in 1.0.72)"
8998 #: ../src/guestfs-actions.pod:1932
8999 msgid "guestfs_get_e2label"
9003 #: ../src/guestfs-actions.pod:1934
9007 " guestfs_get_e2label (guestfs_h *g,\n"
9008 " const char *device);\n"
9013 #: ../src/guestfs-actions.pod:1938 ../fish/guestfish-actions.pod:1315
9014 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9018 #: ../src/guestfs-actions.pod:1944 ../fish/guestfish-actions.pod:1318
9020 "This function is deprecated. In new code, use the C<vfs_label> call "
9025 #: ../src/guestfs-actions.pod:1951 ../src/guestfs-actions.pod:1972 ../src/guestfs-actions.pod:5921 ../src/guestfs-actions.pod:5940
9026 msgid "(Added in 1.0.15)"
9030 #: ../src/guestfs-actions.pod:1953
9031 msgid "guestfs_get_e2uuid"
9035 #: ../src/guestfs-actions.pod:1955
9039 " guestfs_get_e2uuid (guestfs_h *g,\n"
9040 " const char *device);\n"
9045 #: ../src/guestfs-actions.pod:1959 ../fish/guestfish-actions.pod:1329
9046 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9050 #: ../src/guestfs-actions.pod:1965 ../fish/guestfish-actions.pod:1332
9051 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9055 #: ../src/guestfs-actions.pod:1974
9056 msgid "guestfs_get_memsize"
9060 #: ../src/guestfs-actions.pod:1976
9064 " guestfs_get_memsize (guestfs_h *g);\n"
9069 #: ../src/guestfs-actions.pod:1979 ../fish/guestfish-actions.pod:1343
9070 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
9074 #: ../src/guestfs-actions.pod:1982
9076 "If C<guestfs_set_memsize> was not called on this handle, and if "
9077 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9078 "value for memsize."
9082 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2067 ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6063 ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401 ../fish/guestfish-actions.pod:4017 ../fish/guestfish-actions.pod:4104
9083 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9087 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:4417 ../src/guestfs-actions.pod:4614 ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4664 ../src/guestfs-actions.pod:4681 ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:5579 ../src/guestfs-actions.pod:5961 ../src/guestfs-actions.pod:6222 ../src/guestfs-actions.pod:6837
9088 msgid "(Added in 1.0.55)"
9092 #: ../src/guestfs-actions.pod:1993
9093 msgid "guestfs_get_network"
9097 #: ../src/guestfs-actions.pod:1995
9101 " guestfs_get_network (guestfs_h *g);\n"
9106 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1357
9107 msgid "This returns the enable network flag."
9111 #: ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:5980
9112 msgid "(Added in 1.5.4)"
9116 #: ../src/guestfs-actions.pod:2004
9117 msgid "guestfs_get_path"
9121 #: ../src/guestfs-actions.pod:2006
9125 " guestfs_get_path (guestfs_h *g);\n"
9130 #: ../src/guestfs-actions.pod:2009 ../fish/guestfish-actions.pod:1363
9131 msgid "Return the current search path."
9135 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1365
9137 "This is always non-NULL. If it wasn't set already, then this will return "
9142 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2043
9144 "This function returns a string, or NULL on error. The string is owned by "
9145 "the guest handle and must I<not> be freed."
9149 #: ../src/guestfs-actions.pod:2019
9150 msgid "guestfs_get_pid"
9154 #: ../src/guestfs-actions.pod:2021
9158 " guestfs_get_pid (guestfs_h *g);\n"
9163 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1374
9165 "Return the process ID of the qemu subprocess. If there is no qemu "
9166 "subprocess, then this will return an error."
9170 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
9171 msgid "This is an internal call used for debugging and testing."
9175 #: ../src/guestfs-actions.pod:2031
9176 msgid "(Added in 1.0.56)"
9180 #: ../src/guestfs-actions.pod:2033
9181 msgid "guestfs_get_qemu"
9185 #: ../src/guestfs-actions.pod:2035
9189 " guestfs_get_qemu (guestfs_h *g);\n"
9194 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1383
9195 msgid "Return the current qemu binary."
9199 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1385
9201 "This is always non-NULL. If it wasn't set already, then this will return "
9202 "the default qemu binary name."
9206 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:6025
9207 msgid "(Added in 1.0.6)"
9211 #: ../src/guestfs-actions.pod:2048
9212 msgid "guestfs_get_recovery_proc"
9216 #: ../src/guestfs-actions.pod:2050
9220 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9225 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1392
9226 msgid "Return the recovery process enabled flag."
9230 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:4224 ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:5284 ../src/guestfs-actions.pod:5627 ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6740 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:6952
9231 msgid "(Added in 1.0.77)"
9235 #: ../src/guestfs-actions.pod:2059
9236 msgid "guestfs_get_selinux"
9240 #: ../src/guestfs-actions.pod:2061
9244 " guestfs_get_selinux (guestfs_h *g);\n"
9249 #: ../src/guestfs-actions.pod:2064
9251 "This returns the current setting of the selinux flag which is passed to the "
9252 "appliance at boot time. See C<guestfs_set_selinux>."
9256 #: ../src/guestfs-actions.pod:2072 ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6126
9257 msgid "(Added in 1.0.67)"
9261 #: ../src/guestfs-actions.pod:2074
9262 msgid "guestfs_get_state"
9266 #: ../src/guestfs-actions.pod:2076
9270 " guestfs_get_state (guestfs_h *g);\n"
9275 #: ../src/guestfs-actions.pod:2079 ../fish/guestfish-actions.pod:1408
9277 "This returns the current state as an opaque integer. This is only useful "
9278 "for printing debug and internal error messages."
9282 #: ../src/guestfs-actions.pod:2082 ../src/guestfs-actions.pod:3302 ../src/guestfs-actions.pod:3331 ../src/guestfs-actions.pod:3392 ../src/guestfs-actions.pod:3419 ../fish/guestfish-actions.pod:1411 ../fish/guestfish-actions.pod:2325 ../fish/guestfish-actions.pod:2343 ../fish/guestfish-actions.pod:2381 ../fish/guestfish-actions.pod:2397
9283 msgid "For more information on states, see L<guestfs(3)>."
9287 #: ../src/guestfs-actions.pod:2088
9288 msgid "guestfs_get_trace"
9292 #: ../src/guestfs-actions.pod:2090
9296 " guestfs_get_trace (guestfs_h *g);\n"
9301 #: ../src/guestfs-actions.pod:2093 ../fish/guestfish-actions.pod:1417
9302 msgid "Return the command trace flag."
9306 #: ../src/guestfs-actions.pod:2099
9307 msgid "guestfs_get_umask"
9311 #: ../src/guestfs-actions.pod:2101
9315 " guestfs_get_umask (guestfs_h *g);\n"
9320 #: ../src/guestfs-actions.pod:2104
9322 "Return the current umask. By default the umask is C<022> unless it has been "
9323 "set by calling C<guestfs_umask>."
9327 #: ../src/guestfs-actions.pod:2111
9328 msgid "guestfs_get_verbose"
9332 #: ../src/guestfs-actions.pod:2113
9336 " guestfs_get_verbose (guestfs_h *g);\n"
9341 #: ../src/guestfs-actions.pod:2116 ../fish/guestfish-actions.pod:1430
9342 msgid "This returns the verbose messages flag."
9346 #: ../src/guestfs-actions.pod:2122
9347 msgid "guestfs_getcon"
9351 #: ../src/guestfs-actions.pod:2124
9355 " guestfs_getcon (guestfs_h *g);\n"
9360 #: ../src/guestfs-actions.pod:2127 ../fish/guestfish-actions.pod:1436
9361 msgid "This gets the SELinux security context of the daemon."
9365 #: ../src/guestfs-actions.pod:2129
9366 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9370 #: ../src/guestfs-actions.pod:2137
9371 msgid "guestfs_getxattr"
9375 #: ../src/guestfs-actions.pod:2139
9379 " guestfs_getxattr (guestfs_h *g,\n"
9380 " const char *path,\n"
9381 " const char *name,\n"
9382 " size_t *size_r);\n"
9387 #: ../src/guestfs-actions.pod:2145
9389 "Get a single extended attribute from file C<path> named C<name>. This call "
9390 "follows symlinks. If you want to lookup an extended attribute for the "
9391 "symlink itself, use C<guestfs_lgetxattr>."
9395 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:3541
9397 "Normally it is better to get all extended attributes from a file in one go "
9398 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9399 "implementations are buggy and do not provide a way to list out attributes. "
9400 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9401 "extended attributes you want in advance and call this function."
9405 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2477
9407 "Extended attribute values are blobs of binary data. If there is no extended "
9408 "attribute named C<name>, this returns an error."
9412 #: ../src/guestfs-actions.pod:2159
9413 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9417 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2352 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:5277 ../src/guestfs-actions.pod:5303 ../src/guestfs-actions.pod:5484
9419 "This function returns a buffer, or NULL on error. The size of the returned "
9420 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9425 #: ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:3557
9426 msgid "(Added in 1.7.24)"
9430 #: ../src/guestfs-actions.pod:2167
9431 msgid "guestfs_getxattrs"
9435 #: ../src/guestfs-actions.pod:2169
9438 " struct guestfs_xattr_list *\n"
9439 " guestfs_getxattrs (guestfs_h *g,\n"
9440 " const char *path);\n"
9445 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1465
9446 msgid "This call lists the extended attributes of the file or directory C<path>."
9450 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1468
9452 "At the system call level, this is a combination of the L<listxattr(2)> and "
9453 "L<getxattr(2)> calls."
9457 #: ../src/guestfs-actions.pod:2179
9458 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9462 #: ../src/guestfs-actions.pod:2181 ../src/guestfs-actions.pod:3569 ../src/guestfs-actions.pod:4220
9464 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9465 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9469 #: ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3738 ../src/guestfs-actions.pod:3774 ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:6145 ../src/guestfs-actions.pod:7516
9470 msgid "(Added in 1.0.59)"
9474 #: ../src/guestfs-actions.pod:2187
9475 msgid "guestfs_glob_expand"
9479 #: ../src/guestfs-actions.pod:2189
9483 " guestfs_glob_expand (guestfs_h *g,\n"
9484 " const char *pattern);\n"
9489 #: ../src/guestfs-actions.pod:2193 ../fish/guestfish-actions.pod:1477
9491 "This command searches for all the pathnames matching C<pattern> according to "
9492 "the wildcard expansion rules used by the shell."
9496 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1481
9497 msgid "If no paths match, then this returns an empty list (note: not an error)."
9501 #: ../src/guestfs-actions.pod:2200 ../fish/guestfish-actions.pod:1484
9503 "It is just a wrapper around the C L<glob(3)> function with flags "
9504 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9508 #: ../src/guestfs-actions.pod:2208 ../src/guestfs-actions.pod:6338 ../src/guestfs-actions.pod:6355
9509 msgid "(Added in 1.0.50)"
9513 #: ../src/guestfs-actions.pod:2210
9514 msgid "guestfs_grep"
9518 #: ../src/guestfs-actions.pod:2212
9522 " guestfs_grep (guestfs_h *g,\n"
9523 " const char *regex,\n"
9524 " const char *path);\n"
9529 #: ../src/guestfs-actions.pod:2217 ../fish/guestfish-actions.pod:1492
9530 msgid "This calls the external C<grep> program and returns the matching lines."
9534 #: ../src/guestfs-actions.pod:2229
9535 msgid "guestfs_grepi"
9539 #: ../src/guestfs-actions.pod:2231
9543 " guestfs_grepi (guestfs_h *g,\n"
9544 " const char *regex,\n"
9545 " const char *path);\n"
9550 #: ../src/guestfs-actions.pod:2236 ../fish/guestfish-actions.pod:1502
9551 msgid "This calls the external C<grep -i> program and returns the matching lines."
9555 #: ../src/guestfs-actions.pod:2248
9556 msgid "guestfs_grub_install"
9560 #: ../src/guestfs-actions.pod:2250
9564 " guestfs_grub_install (guestfs_h *g,\n"
9565 " const char *root,\n"
9566 " const char *device);\n"
9571 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1512
9573 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9574 "the root directory being C<root>."
9578 #: ../src/guestfs-actions.pod:2258 ../fish/guestfish-actions.pod:1515
9580 "Note: If grub-install reports the error \"No suitable drive was found in the "
9581 "generated device map.\" it may be that you need to create a "
9582 "C</boot/grub/device.map> file first that contains the mapping between grub "
9583 "device names and Linux device names. It is usually sufficient to create a "
9588 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
9596 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1524
9597 msgid "replacing C</dev/vda> with the name of the installation device."
9601 #: ../src/guestfs-actions.pod:2271
9602 msgid "(Added in 1.0.17)"
9606 #: ../src/guestfs-actions.pod:2273
9607 msgid "guestfs_head"
9611 #: ../src/guestfs-actions.pod:2275
9615 " guestfs_head (guestfs_h *g,\n"
9616 " const char *path);\n"
9621 #: ../src/guestfs-actions.pod:2279 ../fish/guestfish-actions.pod:1530
9623 "This command returns up to the first 10 lines of a file as a list of "
9628 #: ../src/guestfs-actions.pod:2291
9629 msgid "guestfs_head_n"
9633 #: ../src/guestfs-actions.pod:2293
9637 " guestfs_head_n (guestfs_h *g,\n"
9639 " const char *path);\n"
9644 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1540
9646 "If the parameter C<nrlines> is a positive number, this returns the first "
9647 "C<nrlines> lines of the file C<path>."
9651 #: ../src/guestfs-actions.pod:2301 ../fish/guestfish-actions.pod:1543
9653 "If the parameter C<nrlines> is a negative number, this returns lines from "
9654 "the file C<path>, excluding the last C<nrlines> lines."
9658 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6635 ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4482
9659 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9663 #: ../src/guestfs-actions.pod:2315
9664 msgid "guestfs_hexdump"
9668 #: ../src/guestfs-actions.pod:2317
9672 " guestfs_hexdump (guestfs_h *g,\n"
9673 " const char *path);\n"
9678 #: ../src/guestfs-actions.pod:2321 ../fish/guestfish-actions.pod:1555
9680 "This runs C<hexdump -C> on the given C<path>. The result is the "
9681 "human-readable, canonical hex dump of the file."
9685 #: ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:6419 ../src/guestfs-actions.pod:6474
9686 msgid "(Added in 1.0.22)"
9690 #: ../src/guestfs-actions.pod:2332
9691 msgid "guestfs_initrd_cat"
9695 #: ../src/guestfs-actions.pod:2334
9699 " guestfs_initrd_cat (guestfs_h *g,\n"
9700 " const char *initrdpath,\n"
9701 " const char *filename,\n"
9702 " size_t *size_r);\n"
9707 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1565
9709 "This command unpacks the file C<filename> from the initrd file called "
9710 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9715 #: ../src/guestfs-actions.pod:2344 ../fish/guestfish-actions.pod:1569
9717 "For example, in guestfish you could use the following command to examine the "
9718 "boot script (usually called C</init>) contained in a Linux initrd or "
9723 #: ../src/guestfs-actions.pod:2348 ../fish/guestfish-actions.pod:1573
9726 " initrd-cat /boot/initrd-<version>.img init\n"
9731 #: ../src/guestfs-actions.pod:2350
9732 msgid "See also C<guestfs_initrd_list>."
9736 #: ../src/guestfs-actions.pod:2361
9737 msgid "guestfs_initrd_list"
9741 #: ../src/guestfs-actions.pod:2363
9745 " guestfs_initrd_list (guestfs_h *g,\n"
9746 " const char *path);\n"
9751 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1584
9752 msgid "This command lists out files contained in an initrd."
9756 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1586
9758 "The files are listed without any initial C</> character. The files are "
9759 "listed in the order they appear (not necessarily alphabetical). Directory "
9760 "names are listed as separate items."
9764 #: ../src/guestfs-actions.pod:2373 ../fish/guestfish-actions.pod:1590
9766 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9767 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9772 #: ../src/guestfs-actions.pod:2383
9773 msgid "guestfs_inotify_add_watch"
9777 #: ../src/guestfs-actions.pod:2385
9781 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9782 " const char *path,\n"
9788 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1598
9789 msgid "Watch C<path> for the events listed in C<mask>."
9793 #: ../src/guestfs-actions.pod:2392 ../fish/guestfish-actions.pod:1600
9795 "Note that if C<path> is a directory then events within that directory are "
9796 "watched, but this does I<not> happen recursively (in subdirectories)."
9800 #: ../src/guestfs-actions.pod:2396 ../fish/guestfish-actions.pod:1604
9802 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9803 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9807 #: ../src/guestfs-actions.pod:2404
9808 msgid "guestfs_inotify_close"
9812 #: ../src/guestfs-actions.pod:2406
9816 " guestfs_inotify_close (guestfs_h *g);\n"
9821 #: ../src/guestfs-actions.pod:2409 ../fish/guestfish-actions.pod:1612
9823 "This closes the inotify handle which was previously opened by inotify_init. "
9824 "It removes all watches, throws away any pending events, and deallocates all "
9829 #: ../src/guestfs-actions.pod:2417
9830 msgid "guestfs_inotify_files"
9834 #: ../src/guestfs-actions.pod:2419
9838 " guestfs_inotify_files (guestfs_h *g);\n"
9843 #: ../src/guestfs-actions.pod:2422
9845 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9846 "returns a list of pathnames of objects that were touched. The returned "
9847 "pathnames are sorted and deduplicated."
9851 #: ../src/guestfs-actions.pod:2432
9852 msgid "guestfs_inotify_init"
9856 #: ../src/guestfs-actions.pod:2434
9860 " guestfs_inotify_init (guestfs_h *g,\n"
9861 " int maxevents);\n"
9866 #: ../src/guestfs-actions.pod:2438 ../fish/guestfish-actions.pod:1628
9868 "This command creates a new inotify handle. The inotify subsystem can be "
9869 "used to notify events which happen to objects in the guest filesystem."
9873 #: ../src/guestfs-actions.pod:2442
9875 "C<maxevents> is the maximum number of events which will be queued up between "
9876 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9877 "passed as C<0>, then the kernel (or previously set) default is used. For "
9878 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9879 "throws away events, but records the fact that it threw them away by setting "
9880 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9881 "C<guestfs_inotify_read>)."
9885 #: ../src/guestfs-actions.pod:2452
9887 "Before any events are generated, you have to add some watches to the "
9888 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9889 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9893 #: ../src/guestfs-actions.pod:2458
9895 "Queued up events should be read periodically by calling "
9896 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9897 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9898 "often enough then you risk the internal queue overflowing."
9902 #: ../src/guestfs-actions.pod:2465
9904 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9905 "This also removes any watches automatically."
9909 #: ../src/guestfs-actions.pod:2469 ../fish/guestfish-actions.pod:1659
9911 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9912 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9913 "that there is one global inotify handle per libguestfs instance."
9917 #: ../src/guestfs-actions.pod:2478
9918 msgid "guestfs_inotify_read"
9922 #: ../src/guestfs-actions.pod:2480
9925 " struct guestfs_inotify_event_list *\n"
9926 " guestfs_inotify_read (guestfs_h *g);\n"
9931 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1668
9933 "Return the complete queue of events that have happened since the previous "
9938 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1671
9939 msgid "If no events have happened, this returns an empty list."
9943 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1673
9945 "I<Note>: In order to make sure that all events have been read, you must call "
9946 "this function repeatedly until it returns an empty list. The reason is that "
9947 "the call will read events up to the maximum appliance-to-host message size "
9948 "and leave remaining events in the queue."
9952 #: ../src/guestfs-actions.pod:2494
9954 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9955 "there was an error. I<The caller must call "
9956 "C<guestfs_free_inotify_event_list> after use>."
9960 #: ../src/guestfs-actions.pod:2500
9961 msgid "guestfs_inotify_rm_watch"
9965 #: ../src/guestfs-actions.pod:2502
9969 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9975 #: ../src/guestfs-actions.pod:2506
9977 "Remove a previously defined inotify watch. See "
9978 "C<guestfs_inotify_add_watch>."
9982 #: ../src/guestfs-actions.pod:2513
9983 msgid "guestfs_inspect_get_arch"
9987 #: ../src/guestfs-actions.pod:2515
9991 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9992 " const char *root);\n"
9997 #: ../src/guestfs-actions.pod:2519 ../src/guestfs-actions.pod:2542 ../src/guestfs-actions.pod:2635 ../src/guestfs-actions.pod:2679 ../src/guestfs-actions.pod:2705 ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2766 ../src/guestfs-actions.pod:2793 ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:2857 ../src/guestfs-actions.pod:2886 ../src/guestfs-actions.pod:2917 ../src/guestfs-actions.pod:2941 ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3038 ../src/guestfs-actions.pod:3059 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3099 ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3135
9999 "This function should only be called with a root device string as returned by "
10000 "C<guestfs_inspect_os>."
10004 #: ../src/guestfs-actions.pod:2522
10006 "This returns the architecture of the inspected operating system. The "
10007 "possible return values are listed under C<guestfs_file_architecture>."
10011 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1697
10013 "If the architecture could not be determined, then the string C<unknown> is "
10018 #: ../src/guestfs-actions.pod:2529 ../src/guestfs-actions.pod:2622 ../src/guestfs-actions.pod:2733 ../src/guestfs-actions.pod:2753 ../src/guestfs-actions.pod:2781 ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2904 ../src/guestfs-actions.pod:2928 ../src/guestfs-actions.pod:2982 ../src/guestfs-actions.pod:3025 ../src/guestfs-actions.pod:3048 ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:3089 ../src/guestfs-actions.pod:3106 ../src/guestfs-actions.pod:3125 ../src/guestfs-actions.pod:3228 ../src/guestfs-actions.pod:3269 ../fish/guestfish-actions.pod:1700 ../fish/guestfish-actions.pod:1786 ../fish/guestfish-actions.pod:1874 ../fish/guestfish-actions.pod:1889 ../fish/guestfish-actions.pod:1910 ../fish/guestfish-actions.pod:1980 ../fish/guestfish-actions.pod:2004 ../fish/guestfish-actions.pod:2021 ../fish/guestfish-actions.pod:2064 ../fish/guestfish-actions.pod:2099 ../fish/guestfish-actions.pod:2115 ../fish/guestfish-actions.pod:2131 ../fish/guestfish-actions.pod:2144 ../fish/guestfish-actions.pod:2157 ../fish/guestfish-actions.pod:2172 ../fish/guestfish-actions.pod:2271 ../fish/guestfish-actions.pod:2305
10019 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10023 #: ../src/guestfs-actions.pod:2536
10024 msgid "guestfs_inspect_get_distro"
10028 #: ../src/guestfs-actions.pod:2538
10032 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10033 " const char *root);\n"
10038 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1709
10039 msgid "This returns the distro (distribution) of the inspected operating system."
10043 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1712
10044 msgid "Currently defined distros are:"
10048 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1716
10049 msgid "\"archlinux\""
10053 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1718
10054 msgid "Arch Linux."
10058 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1720
10063 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1722
10068 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1724
10073 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1726
10078 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1728
10083 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1730
10088 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1732
10093 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1734
10098 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1736
10099 msgid "\"linuxmint\""
10103 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1738
10104 msgid "Linux Mint."
10108 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1740
10109 msgid "\"mandriva\""
10113 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1742
10118 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1744
10123 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1746
10128 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1748
10133 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1750
10138 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1752
10139 msgid "\"redhat-based\""
10143 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1754
10144 msgid "Some Red Hat-derived distro."
10148 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1756
10153 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1758
10154 msgid "Red Hat Enterprise Linux."
10158 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1760
10159 msgid "\"scientificlinux\""
10163 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1762
10164 msgid "Scientific Linux."
10168 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1764
10169 msgid "\"slackware\""
10173 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1766
10178 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1768
10183 #: ../src/guestfs-actions.pod:2606 ../fish/guestfish-actions.pod:1770
10188 #: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:1772 ../fish/guestfish-actions.pod:1865 ../fish/guestfish-actions.pod:2090
10189 msgid "\"unknown\""
10193 #: ../src/guestfs-actions.pod:2610 ../fish/guestfish-actions.pod:1774
10194 msgid "The distro could not be determined."
10198 #: ../src/guestfs-actions.pod:2612 ../src/guestfs-actions.pod:3008 ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:2082
10199 msgid "\"windows\""
10203 #: ../src/guestfs-actions.pod:2614 ../fish/guestfish-actions.pod:1778
10205 "Windows does not have distributions. This string is returned if the OS type "
10210 #: ../src/guestfs-actions.pod:2619 ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:3022 ../fish/guestfish-actions.pod:1783 ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:2096
10212 "Future versions of libguestfs may return other strings here. The caller "
10213 "should be prepared to handle any string."
10217 #: ../src/guestfs-actions.pod:2629
10218 msgid "guestfs_inspect_get_drive_mappings"
10222 #: ../src/guestfs-actions.pod:2631
10226 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10227 " const char *root);\n"
10232 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1795
10234 "This call is useful for Windows which uses a primitive system of assigning "
10235 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10236 "Windows Registry to find out how disks/partitions are mapped to drive "
10237 "letters, and returns a hash table as in the example below:"
10241 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1801
10244 " C => /dev/vda2\n"
10245 " E => /dev/vdb1\n"
10246 " F => /dev/vdc1\n"
10251 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1805
10253 "Note that keys are drive letters. For Windows, the key is case insensitive "
10254 "and just contains the drive letter, without the customary colon separator "
10259 #: ../src/guestfs-actions.pod:2652 ../fish/guestfish-actions.pod:1809
10261 "In future we may support other operating systems that also used drive "
10262 "letters, but the keys for those might not be case insensitive and might be "
10263 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10268 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1814
10270 "For Windows guests, currently only hard drive mappings are returned. "
10271 "Removable disks (eg. DVD-ROMs) are ignored."
10275 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1817
10277 "For guests that do not use drive mappings, or if the drive mappings could "
10278 "not be determined, this returns an empty hash table."
10282 #: ../src/guestfs-actions.pod:2663
10284 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10285 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10289 #: ../src/guestfs-actions.pod:2667 ../src/guestfs-actions.pod:2843 ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:4843 ../src/guestfs-actions.pod:6776
10291 "This function returns a NULL-terminated array of strings, or NULL if there "
10292 "was an error. The array of strings will always have length C<2n+1>, where "
10293 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10294 "caller must free the strings and the array after use>."
10298 #: ../src/guestfs-actions.pod:2673
10299 msgid "guestfs_inspect_get_filesystems"
10303 #: ../src/guestfs-actions.pod:2675
10307 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10308 " const char *root);\n"
10313 #: ../src/guestfs-actions.pod:2682 ../fish/guestfish-actions.pod:1831
10315 "This returns a list of all the filesystems that we think are associated with "
10316 "this operating system. This includes the root filesystem, other ordinary "
10317 "filesystems, and non-mounted devices like swap partitions."
10321 #: ../src/guestfs-actions.pod:2687 ../fish/guestfish-actions.pod:1836
10323 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10324 "to be shared between operating systems."
10328 #: ../src/guestfs-actions.pod:2690
10330 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10331 "C<guestfs_inspect_get_mountpoints>."
10335 #: ../src/guestfs-actions.pod:2699
10336 msgid "guestfs_inspect_get_format"
10340 #: ../src/guestfs-actions.pod:2701
10344 " guestfs_inspect_get_format (guestfs_h *g,\n"
10345 " const char *root);\n"
10350 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1849
10352 "This returns the format of the inspected operating system. You can use it "
10353 "to detect install images, live CDs and similar."
10357 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
10358 msgid "Currently defined formats are:"
10362 #: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1856
10363 msgid "\"installed\""
10367 #: ../src/guestfs-actions.pod:2717 ../fish/guestfish-actions.pod:1858
10368 msgid "This is an installed operating system."
10372 #: ../src/guestfs-actions.pod:2719 ../fish/guestfish-actions.pod:1860
10373 msgid "\"installer\""
10377 #: ../src/guestfs-actions.pod:2721 ../fish/guestfish-actions.pod:1862
10379 "The disk image being inspected is not an installed operating system, but a "
10380 "I<bootable> install disk, live CD, or similar."
10384 #: ../src/guestfs-actions.pod:2726 ../fish/guestfish-actions.pod:1867
10385 msgid "The format of this disk image is not known."
10389 #: ../src/guestfs-actions.pod:2738
10390 msgid "guestfs_inspect_get_hostname"
10394 #: ../src/guestfs-actions.pod:2740
10398 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10399 " const char *root);\n"
10404 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1883
10406 "This function returns the hostname of the operating system as found by "
10407 "inspection of the guest's configuration files."
10411 #: ../src/guestfs-actions.pod:2750 ../fish/guestfish-actions.pod:1886
10413 "If the hostname could not be determined, then the string C<unknown> is "
10418 #: ../src/guestfs-actions.pod:2758
10419 msgid "(Added in 1.7.9)"
10423 #: ../src/guestfs-actions.pod:2760
10424 msgid "guestfs_inspect_get_major_version"
10428 #: ../src/guestfs-actions.pod:2762
10432 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10433 " const char *root);\n"
10438 #: ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1898
10439 msgid "This returns the major version number of the inspected operating system."
10443 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1901
10445 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10446 "popular public names used by the operating system. Notably the operating "
10447 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10448 "1). You can find out the real versions corresponding to releases of Windows "
10449 "by consulting Wikipedia or MSDN."
10453 #: ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1922
10454 msgid "If the version could not be determined, then C<0> is returned."
10458 #: ../src/guestfs-actions.pod:2787
10459 msgid "guestfs_inspect_get_minor_version"
10463 #: ../src/guestfs-actions.pod:2789
10467 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10468 " const char *root);\n"
10473 #: ../src/guestfs-actions.pod:2796 ../fish/guestfish-actions.pod:1919
10474 msgid "This returns the minor version number of the inspected operating system."
10478 #: ../src/guestfs-actions.pod:2801
10480 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10481 "C<guestfs_inspect_get_major_version>."
10485 #: ../src/guestfs-actions.pod:2808
10486 msgid "guestfs_inspect_get_mountpoints"
10490 #: ../src/guestfs-actions.pod:2810
10494 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10495 " const char *root);\n"
10500 #: ../src/guestfs-actions.pod:2817 ../fish/guestfish-actions.pod:1934
10502 "This returns a hash of where we think the filesystems associated with this "
10503 "operating system should be mounted. Callers should note that this is at "
10504 "best an educated guess made by reading configuration files such as "
10505 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10506 "are non-existent or not mountable and callers should be prepared to handle "
10507 "or ignore failures if they try to mount them."
10511 #: ../src/guestfs-actions.pod:2826 ../fish/guestfish-actions.pod:1943
10513 "Each element in the returned hashtable has a key which is the path of the "
10514 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10515 "mounted there (eg. C</dev/sda1>)."
10519 #: ../src/guestfs-actions.pod:2831 ../fish/guestfish-actions.pod:1948
10520 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10524 #: ../src/guestfs-actions.pod:2834
10526 "For operating systems like Windows which still use drive letters, this call "
10527 "will only return an entry for the first drive \"mounted on\" C</>. For "
10528 "information about the mapping of drive letters to partitions, see "
10529 "C<guestfs_inspect_get_drive_mappings>."
10533 #: ../src/guestfs-actions.pod:2840
10535 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10536 "C<guestfs_inspect_get_filesystems>."
10540 #: ../src/guestfs-actions.pod:2851
10541 msgid "guestfs_inspect_get_package_format"
10545 #: ../src/guestfs-actions.pod:2853
10549 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10550 " const char *root);\n"
10555 #: ../src/guestfs-actions.pod:2860
10557 "This function and C<guestfs_inspect_get_package_management> return the "
10558 "package format and package management tool used by the inspected operating "
10559 "system. For example for Fedora these functions would return C<rpm> (package "
10560 "format) and C<yum> (package management)."
10564 #: ../src/guestfs-actions.pod:2866 ../fish/guestfish-actions.pod:1973
10566 "This returns the string C<unknown> if we could not determine the package "
10567 "format I<or> if the operating system does not have a real packaging system "
10572 #: ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:1977
10574 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10575 "Future versions of libguestfs may return other strings."
10579 #: ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:2909
10580 msgid "(Added in 1.7.5)"
10584 #: ../src/guestfs-actions.pod:2880
10585 msgid "guestfs_inspect_get_package_management"
10589 #: ../src/guestfs-actions.pod:2882
10593 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10594 " const char *root);\n"
10599 #: ../src/guestfs-actions.pod:2889
10601 "C<guestfs_inspect_get_package_format> and this function return the package "
10602 "format and package management tool used by the inspected operating system. "
10603 "For example for Fedora these functions would return C<rpm> (package format) "
10604 "and C<yum> (package management)."
10608 #: ../src/guestfs-actions.pod:2895 ../fish/guestfish-actions.pod:1995
10610 "This returns the string C<unknown> if we could not determine the package "
10611 "management tool I<or> if the operating system does not have a real packaging "
10612 "system (eg. Windows)."
10616 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1999
10618 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10619 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10620 "libguestfs may return other strings."
10624 #: ../src/guestfs-actions.pod:2911
10625 msgid "guestfs_inspect_get_product_name"
10629 #: ../src/guestfs-actions.pod:2913
10633 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10634 " const char *root);\n"
10639 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2013
10641 "This returns the product name of the inspected operating system. The "
10642 "product name is generally some freeform string which can be displayed to the "
10643 "user, but should not be parsed by programs."
10647 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2018
10649 "If the product name could not be determined, then the string C<unknown> is "
10654 #: ../src/guestfs-actions.pod:2935
10655 msgid "guestfs_inspect_get_product_variant"
10659 #: ../src/guestfs-actions.pod:2937
10663 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10664 " const char *root);\n"
10669 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2030
10670 msgid "This returns the product variant of the inspected operating system."
10674 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2033
10676 "For Windows guests, this returns the contents of the Registry key "
10677 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10678 "which is usually a string such as C<Client> or C<Server> (other values are "
10679 "possible). This can be used to distinguish consumer and enterprise versions "
10680 "of Windows that have the same version number (for example, Windows 7 and "
10681 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10682 "the latter is C<Server>)."
10686 #: ../src/guestfs-actions.pod:2956 ../fish/guestfish-actions.pod:2042
10688 "For enterprise Linux guests, in future we intend this to return the product "
10689 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10690 "implemented at present."
10694 #: ../src/guestfs-actions.pod:2960 ../fish/guestfish-actions.pod:2046
10696 "If the product variant could not be determined, then the string C<unknown> "
10701 #: ../src/guestfs-actions.pod:2963
10703 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10704 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10708 #: ../src/guestfs-actions.pod:2970
10709 msgid "guestfs_inspect_get_roots"
10713 #: ../src/guestfs-actions.pod:2972
10717 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10722 #: ../src/guestfs-actions.pod:2975
10724 "This function is a convenient way to get the list of root devices, as "
10725 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10726 "the whole inspection process."
10730 #: ../src/guestfs-actions.pod:2979
10732 "This returns an empty list if either no root devices were found or the "
10733 "caller has not called C<guestfs_inspect_os>."
10737 #: ../src/guestfs-actions.pod:2988
10738 msgid "(Added in 1.7.3)"
10742 #: ../src/guestfs-actions.pod:2990
10743 msgid "guestfs_inspect_get_type"
10747 #: ../src/guestfs-actions.pod:2992
10751 " guestfs_inspect_get_type (guestfs_h *g,\n"
10752 " const char *root);\n"
10757 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2073
10759 "This returns the type of the inspected operating system. Currently defined "
10764 #: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2078
10769 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2080
10770 msgid "Any Linux-based operating system."
10774 #: ../src/guestfs-actions.pod:3010 ../fish/guestfish-actions.pod:2084
10775 msgid "Any Microsoft Windows operating system."
10779 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2086
10780 msgid "\"freebsd\""
10784 #: ../src/guestfs-actions.pod:3014 ../fish/guestfish-actions.pod:2088
10789 #: ../src/guestfs-actions.pod:3018 ../fish/guestfish-actions.pod:2092
10790 msgid "The operating system type could not be determined."
10794 #: ../src/guestfs-actions.pod:3032
10795 msgid "guestfs_inspect_get_windows_current_control_set"
10799 #: ../src/guestfs-actions.pod:3034
10803 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
10804 " const char *root);\n"
10809 #: ../src/guestfs-actions.pod:3041 ../fish/guestfish-actions.pod:2108
10811 "This returns the Windows CurrentControlSet of the inspected guest. The "
10812 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10816 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2111
10818 "This call assumes that the guest is Windows and that the Registry could be "
10819 "examined by inspection. If this is not the case then an error is returned."
10823 #: ../src/guestfs-actions.pod:3053
10824 msgid "guestfs_inspect_get_windows_systemroot"
10828 #: ../src/guestfs-actions.pod:3055
10832 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10833 " const char *root);\n"
10838 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2124
10840 "This returns the Windows systemroot of the inspected guest. The systemroot "
10841 "is a directory path such as C</WINDOWS>."
10845 #: ../src/guestfs-actions.pod:3065 ../fish/guestfish-actions.pod:2127
10847 "This call assumes that the guest is Windows and that the systemroot could be "
10848 "determined by inspection. If this is not the case then an error is "
10853 #: ../src/guestfs-actions.pod:3074
10854 msgid "(Added in 1.5.25)"
10858 #: ../src/guestfs-actions.pod:3076
10859 msgid "guestfs_inspect_is_live"
10863 #: ../src/guestfs-actions.pod:3078
10867 " guestfs_inspect_is_live (guestfs_h *g,\n"
10868 " const char *root);\n"
10873 #: ../src/guestfs-actions.pod:3085
10875 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10876 "disk), then this returns true if a live image was detected on the disk."
10880 #: ../src/guestfs-actions.pod:3093
10881 msgid "guestfs_inspect_is_multipart"
10885 #: ../src/guestfs-actions.pod:3095
10889 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
10890 " const char *root);\n"
10895 #: ../src/guestfs-actions.pod:3102
10897 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10898 "disk), then this returns true if the disk is part of a set."
10902 #: ../src/guestfs-actions.pod:3110
10903 msgid "guestfs_inspect_is_netinst"
10907 #: ../src/guestfs-actions.pod:3112
10911 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
10912 " const char *root);\n"
10917 #: ../src/guestfs-actions.pod:3119
10919 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10920 "disk), then this returns true if the disk is a network installer, ie. not a "
10921 "self-contained install CD but one which is likely to require network access "
10922 "to complete the install."
10926 #: ../src/guestfs-actions.pod:3129
10927 msgid "guestfs_inspect_list_applications"
10931 #: ../src/guestfs-actions.pod:3131
10934 " struct guestfs_application_list *\n"
10935 " guestfs_inspect_list_applications (guestfs_h *g,\n"
10936 " const char *root);\n"
10941 #: ../src/guestfs-actions.pod:3138 ../fish/guestfish-actions.pod:2181
10942 msgid "Return the list of applications installed in the operating system."
10946 #: ../src/guestfs-actions.pod:3140
10948 "I<Note:> This call works differently from other parts of the inspection "
10949 "API. You have to call C<guestfs_inspect_os>, then "
10950 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
10951 "this. Listing applications is a significantly more difficult operation "
10952 "which requires access to the full filesystem. Also note that unlike the "
10953 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
10954 "the libguestfs handle, this call actually reads parts of the mounted "
10955 "filesystems during the call."
10959 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2193
10961 "This returns an empty list if the inspection code was not able to determine "
10962 "the list of applications."
10966 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2196
10967 msgid "The application structure contains the following fields:"
10971 #: ../src/guestfs-actions.pod:3157 ../fish/guestfish-actions.pod:2200
10972 msgid "C<app_name>"
10976 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2202
10978 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10979 "guests, this is the package name."
10983 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:2205
10984 msgid "C<app_display_name>"
10988 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2207
10990 "The display name of the application, sometimes localized to the install "
10991 "language of the guest operating system."
10995 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2210
10997 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10998 "to display something can use C<app_name> instead."
11002 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2213
11003 msgid "C<app_epoch>"
11007 #: ../src/guestfs-actions.pod:3172 ../fish/guestfish-actions.pod:2215
11009 "For package managers which use epochs, this contains the epoch of the "
11010 "package (an integer). If unavailable, this is returned as C<0>."
11014 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2218
11015 msgid "C<app_version>"
11019 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2220
11021 "The version string of the application or package. If unavailable this is "
11022 "returned as an empty string C<\"\">."
11026 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2223
11027 msgid "C<app_release>"
11031 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2225
11033 "The release string of the application or package, for package managers that "
11034 "use this. If unavailable this is returned as an empty string C<\"\">."
11038 #: ../src/guestfs-actions.pod:3186 ../fish/guestfish-actions.pod:2229
11039 msgid "C<app_install_path>"
11043 #: ../src/guestfs-actions.pod:3188 ../fish/guestfish-actions.pod:2231
11045 "The installation path of the application (on operating systems such as "
11046 "Windows which use installation paths). This path is in the format used by "
11047 "the guest operating system, it is not a libguestfs path."
11051 #: ../src/guestfs-actions.pod:3193 ../fish/guestfish-actions.pod:2236
11052 msgid "If unavailable this is returned as an empty string C<\"\">."
11056 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2238
11057 msgid "C<app_trans_path>"
11061 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2240
11063 "The install path translated into a libguestfs path. If unavailable this is "
11064 "returned as an empty string C<\"\">."
11068 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2243
11069 msgid "C<app_publisher>"
11073 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2245
11075 "The name of the publisher of the application, for package managers that use "
11076 "this. If unavailable this is returned as an empty string C<\"\">."
11080 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2249
11085 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2251
11087 "The URL (eg. upstream URL) of the application. If unavailable this is "
11088 "returned as an empty string C<\"\">."
11092 #: ../src/guestfs-actions.pod:3211 ../fish/guestfish-actions.pod:2254
11093 msgid "C<app_source_package>"
11097 #: ../src/guestfs-actions.pod:3213 ../fish/guestfish-actions.pod:2256
11099 "For packaging systems which support this, the name of the source package. "
11100 "If unavailable this is returned as an empty string C<\"\">."
11104 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2259
11105 msgid "C<app_summary>"
11109 #: ../src/guestfs-actions.pod:3218 ../fish/guestfish-actions.pod:2261
11111 "A short (usually one line) description of the application or package. If "
11112 "unavailable this is returned as an empty string C<\"\">."
11116 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2264
11117 msgid "C<app_description>"
11121 #: ../src/guestfs-actions.pod:3223 ../fish/guestfish-actions.pod:2266
11123 "A longer description of the application or package. If unavailable this is "
11124 "returned as an empty string C<\"\">."
11128 #: ../src/guestfs-actions.pod:3230
11130 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11131 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11136 #: ../src/guestfs-actions.pod:3234
11137 msgid "(Added in 1.7.8)"
11141 #: ../src/guestfs-actions.pod:3236
11142 msgid "guestfs_inspect_os"
11146 #: ../src/guestfs-actions.pod:3238
11150 " guestfs_inspect_os (guestfs_h *g);\n"
11155 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2277
11157 "This function uses other libguestfs functions and certain heuristics to "
11158 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11159 "for operating systems."
11163 #: ../src/guestfs-actions.pod:3245 ../fish/guestfish-actions.pod:2281
11164 msgid "The list returned is empty if no operating systems were found."
11168 #: ../src/guestfs-actions.pod:3247 ../fish/guestfish-actions.pod:2283
11170 "If one operating system was found, then this returns a list with a single "
11171 "element, which is the name of the root filesystem of this operating system. "
11172 "It is also possible for this function to return a list containing more than "
11173 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11174 "element being the root filesystem of one of the operating systems."
11178 #: ../src/guestfs-actions.pod:3254
11180 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11181 "functions in order to query further information about each operating system, "
11182 "such as the name and version."
11186 #: ../src/guestfs-actions.pod:3259
11188 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11189 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11190 "the contents. This should be called with no disks currently mounted. The "
11191 "function may also use Augeas, so any existing Augeas handle will be closed."
11195 #: ../src/guestfs-actions.pod:3265 ../fish/guestfish-actions.pod:2301
11197 "This function cannot decrypt encrypted disks. The caller must do that first "
11198 "(supplying the necessary keys) if the disk is encrypted."
11202 #: ../src/guestfs-actions.pod:3271 ../src/guestfs-actions.pod:3584 ../src/guestfs-actions.pod:3646
11203 msgid "See also C<guestfs_list_filesystems>."
11207 #: ../src/guestfs-actions.pod:3279
11208 msgid "guestfs_is_blockdev"
11212 #: ../src/guestfs-actions.pod:3281
11216 " guestfs_is_blockdev (guestfs_h *g,\n"
11217 " const char *path);\n"
11222 #: ../src/guestfs-actions.pod:3285 ../fish/guestfish-actions.pod:2313
11224 "This returns C<true> if and only if there is a block device with the given "
11229 #: ../src/guestfs-actions.pod:3288 ../src/guestfs-actions.pod:3317 ../src/guestfs-actions.pod:3347 ../src/guestfs-actions.pod:3362 ../src/guestfs-actions.pod:3378 ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3449
11230 msgid "See also C<guestfs_stat>."
11234 #: ../src/guestfs-actions.pod:3292 ../src/guestfs-actions.pod:3321 ../src/guestfs-actions.pod:3366 ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3453
11235 msgid "(Added in 1.5.10)"
11239 #: ../src/guestfs-actions.pod:3294
11240 msgid "guestfs_is_busy"
11244 #: ../src/guestfs-actions.pod:3296
11248 " guestfs_is_busy (guestfs_h *g);\n"
11253 #: ../src/guestfs-actions.pod:3299 ../fish/guestfish-actions.pod:2322
11255 "This returns true iff this handle is busy processing a command (in the "
11260 #: ../src/guestfs-actions.pod:3308
11261 msgid "guestfs_is_chardev"
11265 #: ../src/guestfs-actions.pod:3310
11269 " guestfs_is_chardev (guestfs_h *g,\n"
11270 " const char *path);\n"
11275 #: ../src/guestfs-actions.pod:3314 ../fish/guestfish-actions.pod:2331
11277 "This returns C<true> if and only if there is a character device with the "
11278 "given C<path> name."
11282 #: ../src/guestfs-actions.pod:3323
11283 msgid "guestfs_is_config"
11287 #: ../src/guestfs-actions.pod:3325
11291 " guestfs_is_config (guestfs_h *g);\n"
11296 #: ../src/guestfs-actions.pod:3328 ../fish/guestfish-actions.pod:2340
11298 "This returns true iff this handle is being configured (in the C<CONFIG> "
11303 #: ../src/guestfs-actions.pod:3337
11304 msgid "guestfs_is_dir"
11308 #: ../src/guestfs-actions.pod:3339
11312 " guestfs_is_dir (guestfs_h *g,\n"
11313 " const char *path);\n"
11318 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2349
11320 "This returns C<true> if and only if there is a directory with the given "
11321 "C<path> name. Note that it returns false for other objects like files."
11325 #: ../src/guestfs-actions.pod:3353
11326 msgid "guestfs_is_fifo"
11330 #: ../src/guestfs-actions.pod:3355
11334 " guestfs_is_fifo (guestfs_h *g,\n"
11335 " const char *path);\n"
11340 #: ../src/guestfs-actions.pod:3359 ../fish/guestfish-actions.pod:2359
11342 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11343 "given C<path> name."
11347 #: ../src/guestfs-actions.pod:3368
11348 msgid "guestfs_is_file"
11352 #: ../src/guestfs-actions.pod:3370
11356 " guestfs_is_file (guestfs_h *g,\n"
11357 " const char *path);\n"
11362 #: ../src/guestfs-actions.pod:3374 ../fish/guestfish-actions.pod:2368
11364 "This returns C<true> if and only if there is a regular file with the given "
11365 "C<path> name. Note that it returns false for other objects like "
11370 #: ../src/guestfs-actions.pod:3384
11371 msgid "guestfs_is_launching"
11375 #: ../src/guestfs-actions.pod:3386
11379 " guestfs_is_launching (guestfs_h *g);\n"
11384 #: ../src/guestfs-actions.pod:3389 ../fish/guestfish-actions.pod:2378
11386 "This returns true iff this handle is launching the subprocess (in the "
11387 "C<LAUNCHING> state)."
11391 #: ../src/guestfs-actions.pod:3398
11392 msgid "guestfs_is_lv"
11396 #: ../src/guestfs-actions.pod:3400
11400 " guestfs_is_lv (guestfs_h *g,\n"
11401 " const char *device);\n"
11406 #: ../src/guestfs-actions.pod:3404 ../fish/guestfish-actions.pod:2387
11408 "This command tests whether C<device> is a logical volume, and returns true "
11409 "iff this is the case."
11413 #: ../src/guestfs-actions.pod:3411
11414 msgid "guestfs_is_ready"
11418 #: ../src/guestfs-actions.pod:3413
11422 " guestfs_is_ready (guestfs_h *g);\n"
11427 #: ../src/guestfs-actions.pod:3416 ../fish/guestfish-actions.pod:2394
11429 "This returns true iff this handle is ready to accept commands (in the "
11434 #: ../src/guestfs-actions.pod:3425
11435 msgid "guestfs_is_socket"
11439 #: ../src/guestfs-actions.pod:3427
11443 " guestfs_is_socket (guestfs_h *g,\n"
11444 " const char *path);\n"
11449 #: ../src/guestfs-actions.pod:3431 ../fish/guestfish-actions.pod:2403
11451 "This returns C<true> if and only if there is a Unix domain socket with the "
11452 "given C<path> name."
11456 #: ../src/guestfs-actions.pod:3440
11457 msgid "guestfs_is_symlink"
11461 #: ../src/guestfs-actions.pod:3442
11465 " guestfs_is_symlink (guestfs_h *g,\n"
11466 " const char *path);\n"
11471 #: ../src/guestfs-actions.pod:3446 ../fish/guestfish-actions.pod:2412
11473 "This returns C<true> if and only if there is a symbolic link with the given "
11478 #: ../src/guestfs-actions.pod:3455
11479 msgid "guestfs_is_zero"
11483 #: ../src/guestfs-actions.pod:3457
11487 " guestfs_is_zero (guestfs_h *g,\n"
11488 " const char *path);\n"
11493 #: ../src/guestfs-actions.pod:3461 ../fish/guestfish-actions.pod:2421
11495 "This returns true iff the file exists and the file is empty or it contains "
11500 #: ../src/guestfs-actions.pod:3466
11501 msgid "guestfs_is_zero_device"
11505 #: ../src/guestfs-actions.pod:3468
11509 " guestfs_is_zero_device (guestfs_h *g,\n"
11510 " const char *device);\n"
11515 #: ../src/guestfs-actions.pod:3472 ../fish/guestfish-actions.pod:2428
11516 msgid "This returns true iff the device exists and contains all zero bytes."
11520 #: ../src/guestfs-actions.pod:3474 ../fish/guestfish-actions.pod:2430
11521 msgid "Note that for large devices this can take a long time to run."
11525 #: ../src/guestfs-actions.pod:3478
11526 msgid "guestfs_kill_subprocess"
11530 #: ../src/guestfs-actions.pod:3480
11534 " guestfs_kill_subprocess (guestfs_h *g);\n"
11539 #: ../src/guestfs-actions.pod:3483 ../fish/guestfish-actions.pod:2436
11540 msgid "This kills the qemu subprocess. You should never need to call this."
11544 #: ../src/guestfs-actions.pod:3489
11545 msgid "guestfs_launch"
11549 #: ../src/guestfs-actions.pod:3491
11553 " guestfs_launch (guestfs_h *g);\n"
11558 #: ../src/guestfs-actions.pod:3494 ../fish/guestfish-actions.pod:2444
11560 "Internally libguestfs is implemented by running a virtual machine using "
11565 #: ../src/guestfs-actions.pod:3497 ../fish/guestfish-actions.pod:2447
11567 "You should call this after configuring the handle (eg. adding drives) but "
11568 "before performing any actions."
11572 #: ../src/guestfs-actions.pod:3509
11573 msgid "guestfs_lchown"
11577 #: ../src/guestfs-actions.pod:3511
11581 " guestfs_lchown (guestfs_h *g,\n"
11584 " const char *path);\n"
11589 #: ../src/guestfs-actions.pod:3517
11591 "Change the file owner to C<owner> and group to C<group>. This is like "
11592 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11593 "changed, not the target."
11597 #: ../src/guestfs-actions.pod:3529
11598 msgid "guestfs_lgetxattr"
11602 #: ../src/guestfs-actions.pod:3531
11606 " guestfs_lgetxattr (guestfs_h *g,\n"
11607 " const char *path,\n"
11608 " const char *name,\n"
11609 " size_t *size_r);\n"
11614 #: ../src/guestfs-actions.pod:3537 ../fish/guestfish-actions.pod:2466
11616 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11617 "is a symlink, then this call returns an extended attribute from the symlink."
11621 #: ../src/guestfs-actions.pod:3551
11622 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11626 #: ../src/guestfs-actions.pod:3559
11627 msgid "guestfs_lgetxattrs"
11631 #: ../src/guestfs-actions.pod:3561
11634 " struct guestfs_xattr_list *\n"
11635 " guestfs_lgetxattrs (guestfs_h *g,\n"
11636 " const char *path);\n"
11641 #: ../src/guestfs-actions.pod:3565
11643 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11644 "then it returns the extended attributes of the link itself."
11648 #: ../src/guestfs-actions.pod:3575
11649 msgid "guestfs_list_devices"
11653 #: ../src/guestfs-actions.pod:3577
11657 " guestfs_list_devices (guestfs_h *g);\n"
11662 #: ../src/guestfs-actions.pod:3580 ../fish/guestfish-actions.pod:2494
11663 msgid "List all the block devices."
11667 #: ../src/guestfs-actions.pod:3582 ../fish/guestfish-actions.pod:2496
11668 msgid "The full block device names are returned, eg. C</dev/sda>."
11672 #: ../src/guestfs-actions.pod:3592
11673 msgid "guestfs_list_filesystems"
11677 #: ../src/guestfs-actions.pod:3594
11681 " guestfs_list_filesystems (guestfs_h *g);\n"
11686 #: ../src/guestfs-actions.pod:3597 ../fish/guestfish-actions.pod:2504
11688 "This inspection command looks for filesystems on partitions, block devices "
11689 "and logical volumes, returning a list of devices containing filesystems and "
11694 #: ../src/guestfs-actions.pod:3601 ../fish/guestfish-actions.pod:2508
11696 "The return value is a hash, where the keys are the devices containing "
11697 "filesystems, and the values are the filesystem types. For example:"
11701 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2512
11704 " \"/dev/sda1\" => \"ntfs\"\n"
11705 " \"/dev/sda2\" => \"ext2\"\n"
11706 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11707 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11712 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2517
11714 "The value can have the special value \"unknown\", meaning the content of the "
11715 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11719 #: ../src/guestfs-actions.pod:3614
11721 "This command runs other libguestfs commands, which might include "
11722 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11723 "soon after launch and only when nothing is mounted."
11727 #: ../src/guestfs-actions.pod:3618
11729 "Not all of the filesystems returned will be mountable. In particular, swap "
11730 "partitions are returned in the list. Also this command does not check that "
11731 "each filesystem found is valid and mountable, and some filesystems might be "
11732 "mountable but require special options. Filesystems may not all belong to a "
11733 "single logical operating system (use C<guestfs_inspect_os> to look for "
11738 #: ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:5244
11739 msgid "(Added in 1.5.15)"
11743 #: ../src/guestfs-actions.pod:3634
11744 msgid "guestfs_list_partitions"
11748 #: ../src/guestfs-actions.pod:3636
11752 " guestfs_list_partitions (guestfs_h *g);\n"
11757 #: ../src/guestfs-actions.pod:3639 ../fish/guestfish-actions.pod:2537
11758 msgid "List all the partitions detected on all block devices."
11762 #: ../src/guestfs-actions.pod:3641 ../fish/guestfish-actions.pod:2539
11763 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11767 #: ../src/guestfs-actions.pod:3643
11769 "This does not return logical volumes. For that you will need to call "
11774 #: ../src/guestfs-actions.pod:3654
11779 #: ../src/guestfs-actions.pod:3656
11783 " guestfs_ll (guestfs_h *g,\n"
11784 " const char *directory);\n"
11789 #: ../src/guestfs-actions.pod:3660 ../fish/guestfish-actions.pod:2550
11791 "List the files in C<directory> (relative to the root directory, there is no "
11792 "cwd) in the format of 'ls -la'."
11796 #: ../src/guestfs-actions.pod:3663 ../fish/guestfish-actions.pod:2553
11798 "This command is mostly useful for interactive sessions. It is I<not> "
11799 "intended that you try to parse the output string."
11803 #: ../src/guestfs-actions.pod:3671
11808 #: ../src/guestfs-actions.pod:3673
11812 " guestfs_ln (guestfs_h *g,\n"
11813 " const char *target,\n"
11814 " const char *linkname);\n"
11819 #: ../src/guestfs-actions.pod:3678 ../fish/guestfish-actions.pod:2560
11820 msgid "This command creates a hard link using the C<ln> command."
11824 #: ../src/guestfs-actions.pod:3684
11825 msgid "guestfs_ln_f"
11829 #: ../src/guestfs-actions.pod:3686
11833 " guestfs_ln_f (guestfs_h *g,\n"
11834 " const char *target,\n"
11835 " const char *linkname);\n"
11840 #: ../src/guestfs-actions.pod:3691 ../fish/guestfish-actions.pod:2566
11842 "This command creates a hard link using the C<ln -f> command. The I<-f> "
11843 "option removes the link (C<linkname>) if it exists already."
11847 #: ../src/guestfs-actions.pod:3698
11848 msgid "guestfs_ln_s"
11852 #: ../src/guestfs-actions.pod:3700
11856 " guestfs_ln_s (guestfs_h *g,\n"
11857 " const char *target,\n"
11858 " const char *linkname);\n"
11863 #: ../src/guestfs-actions.pod:3705 ../fish/guestfish-actions.pod:2573
11864 msgid "This command creates a symbolic link using the C<ln -s> command."
11868 #: ../src/guestfs-actions.pod:3711
11869 msgid "guestfs_ln_sf"
11873 #: ../src/guestfs-actions.pod:3713
11877 " guestfs_ln_sf (guestfs_h *g,\n"
11878 " const char *target,\n"
11879 " const char *linkname);\n"
11884 #: ../src/guestfs-actions.pod:3718 ../fish/guestfish-actions.pod:2579
11886 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
11887 "option removes the link (C<linkname>) if it exists already."
11891 #: ../src/guestfs-actions.pod:3725
11892 msgid "guestfs_lremovexattr"
11896 #: ../src/guestfs-actions.pod:3727
11900 " guestfs_lremovexattr (guestfs_h *g,\n"
11901 " const char *xattr,\n"
11902 " const char *path);\n"
11907 #: ../src/guestfs-actions.pod:3732
11909 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
11910 "link, then it removes an extended attribute of the link itself."
11914 #: ../src/guestfs-actions.pod:3740
11919 #: ../src/guestfs-actions.pod:3742
11923 " guestfs_ls (guestfs_h *g,\n"
11924 " const char *directory);\n"
11929 #: ../src/guestfs-actions.pod:3746 ../fish/guestfish-actions.pod:2594
11931 "List the files in C<directory> (relative to the root directory, there is no "
11932 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11937 #: ../src/guestfs-actions.pod:3750
11939 "This command is mostly useful for interactive sessions. Programs should "
11940 "probably use C<guestfs_readdir> instead."
11944 #: ../src/guestfs-actions.pod:3759
11945 msgid "guestfs_lsetxattr"
11949 #: ../src/guestfs-actions.pod:3761
11953 " guestfs_lsetxattr (guestfs_h *g,\n"
11954 " const char *xattr,\n"
11955 " const char *val,\n"
11957 " const char *path);\n"
11962 #: ../src/guestfs-actions.pod:3768
11964 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
11965 "then it sets an extended attribute of the link itself."
11969 #: ../src/guestfs-actions.pod:3776
11970 msgid "guestfs_lstat"
11974 #: ../src/guestfs-actions.pod:3778
11977 " struct guestfs_stat *\n"
11978 " guestfs_lstat (guestfs_h *g,\n"
11979 " const char *path);\n"
11984 #: ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:2613 ../fish/guestfish-actions.pod:4317
11985 msgid "Returns file information for the given C<path>."
11989 #: ../src/guestfs-actions.pod:3784
11991 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
11992 "link, then the link is stat-ed, not the file it refers to."
11996 #: ../src/guestfs-actions.pod:3788 ../fish/guestfish-actions.pod:2619
11997 msgid "This is the same as the C<lstat(2)> system call."
12001 #: ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:6379
12003 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12004 "error. I<The caller must call C<guestfs_free_stat> after use>."
12008 #: ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:6383 ../src/guestfs-actions.pod:6401 ../src/guestfs-actions.pod:6782
12009 msgid "(Added in 0.9.2)"
12013 #: ../src/guestfs-actions.pod:3796
12014 msgid "guestfs_lstatlist"
12018 #: ../src/guestfs-actions.pod:3798
12021 " struct guestfs_stat_list *\n"
12022 " guestfs_lstatlist (guestfs_h *g,\n"
12023 " const char *path,\n"
12024 " char *const *names);\n"
12029 #: ../src/guestfs-actions.pod:3803
12031 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12032 "files, where all files are in the directory C<path>. C<names> is the list "
12033 "of files from this directory."
12037 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2629
12039 "On return you get a list of stat structs, with a one-to-one correspondence "
12040 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12041 "then the C<ino> field of that structure is set to C<-1>."
12045 #: ../src/guestfs-actions.pod:3812
12047 "This call is intended for programs that want to efficiently list a directory "
12048 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12049 "for a similarly efficient call for getting extended attributes. Very long "
12050 "directory listings might cause the protocol message size to be exceeded, "
12051 "causing this call to fail. The caller must split up such requests into "
12052 "smaller groups of names."
12056 #: ../src/guestfs-actions.pod:3820
12058 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12059 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12063 #: ../src/guestfs-actions.pod:3826
12064 msgid "guestfs_luks_add_key"
12068 #: ../src/guestfs-actions.pod:3828
12072 " guestfs_luks_add_key (guestfs_h *g,\n"
12073 " const char *device,\n"
12074 " const char *key,\n"
12075 " const char *newkey,\n"
12081 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2646
12083 "This command adds a new key on LUKS device C<device>. C<key> is any "
12084 "existing key, and is used to access the device. C<newkey> is the new key to "
12085 "add. C<keyslot> is the key slot that will be replaced."
12089 #: ../src/guestfs-actions.pod:3840
12091 "Note that if C<keyslot> already contains a key, then this command will "
12092 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12096 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:3886 ../src/guestfs-actions.pod:3909 ../src/guestfs-actions.pod:3929 ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3980
12098 "This function takes a key or passphrase parameter which could contain "
12099 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12104 #: ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:3890 ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:3933
12105 msgid "(Added in 1.5.2)"
12109 #: ../src/guestfs-actions.pod:3852
12110 msgid "guestfs_luks_close"
12114 #: ../src/guestfs-actions.pod:3854
12118 " guestfs_luks_close (guestfs_h *g,\n"
12119 " const char *device);\n"
12124 #: ../src/guestfs-actions.pod:3858
12126 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12127 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12128 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12129 "underlying block device."
12133 #: ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:3984 ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4082
12134 msgid "(Added in 1.5.1)"
12138 #: ../src/guestfs-actions.pod:3868
12139 msgid "guestfs_luks_format"
12143 #: ../src/guestfs-actions.pod:3870
12147 " guestfs_luks_format (guestfs_h *g,\n"
12148 " const char *device,\n"
12149 " const char *key,\n"
12155 #: ../src/guestfs-actions.pod:3876 ../fish/guestfish-actions.pod:2672
12157 "This command erases existing data on C<device> and formats the device as a "
12158 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12159 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12163 #: ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4995 ../src/guestfs-actions.pod:5775 ../src/guestfs-actions.pod:6182 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:7427 ../fish/guestfish-actions.pod:2680 ../fish/guestfish-actions.pod:2693 ../fish/guestfish-actions.pod:2777 ../fish/guestfish-actions.pod:3358 ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4188 ../fish/guestfish-actions.pod:4211 ../fish/guestfish-actions.pod:4233 ../fish/guestfish-actions.pod:4963
12165 "B<This command is dangerous. Without careful use you can easily destroy all "
12170 #: ../src/guestfs-actions.pod:3892
12171 msgid "guestfs_luks_format_cipher"
12175 #: ../src/guestfs-actions.pod:3894
12179 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12180 " const char *device,\n"
12181 " const char *key,\n"
12183 " const char *cipher);\n"
12188 #: ../src/guestfs-actions.pod:3901
12190 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12191 "set the C<cipher> used."
12195 #: ../src/guestfs-actions.pod:3915
12196 msgid "guestfs_luks_kill_slot"
12200 #: ../src/guestfs-actions.pod:3917
12204 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12205 " const char *device,\n"
12206 " const char *key,\n"
12212 #: ../src/guestfs-actions.pod:3923 ../fish/guestfish-actions.pod:2700
12214 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12215 "device C<device>. C<key> must be one of the I<other> keys."
12219 #: ../src/guestfs-actions.pod:3935
12220 msgid "guestfs_luks_open"
12224 #: ../src/guestfs-actions.pod:3937
12228 " guestfs_luks_open (guestfs_h *g,\n"
12229 " const char *device,\n"
12230 " const char *key,\n"
12231 " const char *mapname);\n"
12236 #: ../src/guestfs-actions.pod:3943 ../fish/guestfish-actions.pod:2711
12238 "This command opens a block device which has been encrypted according to the "
12239 "Linux Unified Key Setup (LUKS) standard."
12243 #: ../src/guestfs-actions.pod:3946 ../fish/guestfish-actions.pod:2714
12244 msgid "C<device> is the encrypted block device or partition."
12248 #: ../src/guestfs-actions.pod:3948 ../fish/guestfish-actions.pod:2716
12250 "The caller must supply one of the keys associated with the LUKS block "
12251 "device, in the C<key> parameter."
12255 #: ../src/guestfs-actions.pod:3951 ../fish/guestfish-actions.pod:2719
12257 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12258 "writes to this block device are decrypted from and encrypted to the "
12259 "underlying C<device> respectively."
12263 #: ../src/guestfs-actions.pod:3955
12265 "If this block device contains LVM volume groups, then calling "
12266 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12271 #: ../src/guestfs-actions.pod:3967
12272 msgid "guestfs_luks_open_ro"
12276 #: ../src/guestfs-actions.pod:3969
12280 " guestfs_luks_open_ro (guestfs_h *g,\n"
12281 " const char *device,\n"
12282 " const char *key,\n"
12283 " const char *mapname);\n"
12288 #: ../src/guestfs-actions.pod:3975
12290 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12295 #: ../src/guestfs-actions.pod:3986
12296 msgid "guestfs_lvcreate"
12300 #: ../src/guestfs-actions.pod:3988
12304 " guestfs_lvcreate (guestfs_h *g,\n"
12305 " const char *logvol,\n"
12306 " const char *volgroup,\n"
12312 #: ../src/guestfs-actions.pod:3994 ../fish/guestfish-actions.pod:2744
12314 "This creates an LVM logical volume called C<logvol> on the volume group "
12315 "C<volgroup>, with C<size> megabytes."
12319 #: ../src/guestfs-actions.pod:4001
12320 msgid "guestfs_lvm_canonical_lv_name"
12324 #: ../src/guestfs-actions.pod:4003
12328 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12329 " const char *lvname);\n"
12334 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2751
12336 "This converts alternative naming schemes for LVs that you might find to the "
12337 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12342 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2755
12344 "This command returns an error if the C<lvname> parameter does not refer to a "
12349 #: ../src/guestfs-actions.pod:4014
12350 msgid "See also C<guestfs_is_lv>."
12354 #: ../src/guestfs-actions.pod:4019
12355 msgid "(Added in 1.5.24)"
12359 #: ../src/guestfs-actions.pod:4021
12360 msgid "guestfs_lvm_clear_filter"
12364 #: ../src/guestfs-actions.pod:4023
12368 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12373 #: ../src/guestfs-actions.pod:4026
12375 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12376 "see every block device."
12380 #: ../src/guestfs-actions.pod:4029 ../src/guestfs-actions.pod:4071 ../fish/guestfish-actions.pod:2767 ../fish/guestfish-actions.pod:2798
12381 msgid "This command also clears the LVM cache and performs a volume group scan."
12385 #: ../src/guestfs-actions.pod:4036
12386 msgid "guestfs_lvm_remove_all"
12390 #: ../src/guestfs-actions.pod:4038
12394 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12399 #: ../src/guestfs-actions.pod:4041 ../fish/guestfish-actions.pod:2774
12401 "This command removes all LVM logical volumes, volume groups and physical "
12406 #: ../src/guestfs-actions.pod:4051
12407 msgid "guestfs_lvm_set_filter"
12411 #: ../src/guestfs-actions.pod:4053
12415 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12416 " char *const *devices);\n"
12421 #: ../src/guestfs-actions.pod:4057 ../fish/guestfish-actions.pod:2784
12423 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12424 "block devices in the list C<devices>, and will ignore all other attached "
12429 #: ../src/guestfs-actions.pod:4061 ../fish/guestfish-actions.pod:2788
12431 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12432 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12433 "there are two types of duplication possible: either cloned PVs/VGs which "
12434 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12435 "same name. In normal operation you cannot create this situation, but you "
12436 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12437 "inside the LVM metadata."
12441 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:2801
12442 msgid "You can filter whole block devices or individual partitions."
12446 #: ../src/guestfs-actions.pod:4076 ../fish/guestfish-actions.pod:2803
12448 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12449 "filesystem), even if you are not filtering out that VG."
12453 #: ../src/guestfs-actions.pod:4084
12454 msgid "guestfs_lvremove"
12458 #: ../src/guestfs-actions.pod:4086
12462 " guestfs_lvremove (guestfs_h *g,\n"
12463 " const char *device);\n"
12468 #: ../src/guestfs-actions.pod:4090 ../fish/guestfish-actions.pod:2811
12470 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12471 "LV, such as C</dev/VG/LV>."
12475 #: ../src/guestfs-actions.pod:4093 ../fish/guestfish-actions.pod:2814
12477 "You can also remove all LVs in a volume group by specifying the VG name, "
12482 #: ../src/guestfs-actions.pod:4098 ../src/guestfs-actions.pod:5341 ../src/guestfs-actions.pod:7158
12483 msgid "(Added in 1.0.13)"
12487 #: ../src/guestfs-actions.pod:4100
12488 msgid "guestfs_lvrename"
12492 #: ../src/guestfs-actions.pod:4102
12496 " guestfs_lvrename (guestfs_h *g,\n"
12497 " const char *logvol,\n"
12498 " const char *newlogvol);\n"
12503 #: ../src/guestfs-actions.pod:4107 ../fish/guestfish-actions.pod:2821
12504 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12508 #: ../src/guestfs-actions.pod:4111 ../src/guestfs-actions.pod:7171
12509 msgid "(Added in 1.0.83)"
12513 #: ../src/guestfs-actions.pod:4113
12514 msgid "guestfs_lvresize"
12518 #: ../src/guestfs-actions.pod:4115
12522 " guestfs_lvresize (guestfs_h *g,\n"
12523 " const char *device,\n"
12529 #: ../src/guestfs-actions.pod:4120 ../fish/guestfish-actions.pod:2827
12531 "This resizes (expands or shrinks) an existing LVM logical volume to "
12532 "C<mbytes>. When reducing, data in the reduced part is lost."
12536 #: ../src/guestfs-actions.pod:4128
12537 msgid "guestfs_lvresize_free"
12541 #: ../src/guestfs-actions.pod:4130
12545 " guestfs_lvresize_free (guestfs_h *g,\n"
12546 " const char *lv,\n"
12552 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2835
12554 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12555 "remaining free space in the volume group. Commonly you would call this with "
12556 "pc = 100 which expands the logical volume as much as possible, using all "
12557 "remaining free space in the volume group."
12561 #: ../src/guestfs-actions.pod:4143
12562 msgid "(Added in 1.3.3)"
12566 #: ../src/guestfs-actions.pod:4145
12567 msgid "guestfs_lvs"
12571 #: ../src/guestfs-actions.pod:4147
12575 " guestfs_lvs (guestfs_h *g);\n"
12580 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2845
12582 "List all the logical volumes detected. This is the equivalent of the "
12583 "L<lvs(8)> command."
12587 #: ../src/guestfs-actions.pod:4153 ../fish/guestfish-actions.pod:2848
12589 "This returns a list of the logical volume device names "
12590 "(eg. C</dev/VolGroup00/LogVol00>)."
12594 #: ../src/guestfs-actions.pod:4156
12595 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12599 #: ../src/guestfs-actions.pod:4164
12600 msgid "guestfs_lvs_full"
12604 #: ../src/guestfs-actions.pod:4166
12607 " struct guestfs_lvm_lv_list *\n"
12608 " guestfs_lvs_full (guestfs_h *g);\n"
12613 #: ../src/guestfs-actions.pod:4169 ../fish/guestfish-actions.pod:2857
12615 "List all the logical volumes detected. This is the equivalent of the "
12616 "L<lvs(8)> command. The \"full\" version includes all fields."
12620 #: ../src/guestfs-actions.pod:4172
12622 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12623 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12628 #: ../src/guestfs-actions.pod:4178
12629 msgid "guestfs_lvuuid"
12633 #: ../src/guestfs-actions.pod:4180
12637 " guestfs_lvuuid (guestfs_h *g,\n"
12638 " const char *device);\n"
12643 #: ../src/guestfs-actions.pod:4184 ../fish/guestfish-actions.pod:2864
12644 msgid "This command returns the UUID of the LVM LV C<device>."
12648 #: ../src/guestfs-actions.pod:4191
12649 msgid "guestfs_lxattrlist"
12653 #: ../src/guestfs-actions.pod:4193
12656 " struct guestfs_xattr_list *\n"
12657 " guestfs_lxattrlist (guestfs_h *g,\n"
12658 " const char *path,\n"
12659 " char *const *names);\n"
12664 #: ../src/guestfs-actions.pod:4198 ../fish/guestfish-actions.pod:2870
12666 "This call allows you to get the extended attributes of multiple files, where "
12667 "all files are in the directory C<path>. C<names> is the list of files from "
12672 #: ../src/guestfs-actions.pod:4202 ../fish/guestfish-actions.pod:2874
12674 "On return you get a flat list of xattr structs which must be interpreted "
12675 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12676 "C<attrval> in this struct is zero-length to indicate there was an error "
12677 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12678 "number (the number of following attributes for this file, which could be "
12679 "C<\"0\">). Then after the first xattr struct are the zero or more "
12680 "attributes for the first named file. This repeats for the second and "
12681 "subsequent files."
12685 #: ../src/guestfs-actions.pod:4212
12687 "This call is intended for programs that want to efficiently list a directory "
12688 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12689 "a similarly efficient call for getting standard stats. Very long directory "
12690 "listings might cause the protocol message size to be exceeded, causing this "
12691 "call to fail. The caller must split up such requests into smaller groups of "
12696 #: ../src/guestfs-actions.pod:4226
12697 msgid "guestfs_mkdir"
12701 #: ../src/guestfs-actions.pod:4228
12705 " guestfs_mkdir (guestfs_h *g,\n"
12706 " const char *path);\n"
12711 #: ../src/guestfs-actions.pod:4232 ../fish/guestfish-actions.pod:2896
12712 msgid "Create a directory named C<path>."
12716 #: ../src/guestfs-actions.pod:4238
12717 msgid "guestfs_mkdir_mode"
12721 #: ../src/guestfs-actions.pod:4240
12725 " guestfs_mkdir_mode (guestfs_h *g,\n"
12726 " const char *path,\n"
12732 #: ../src/guestfs-actions.pod:4245 ../fish/guestfish-actions.pod:2902
12734 "This command creates a directory, setting the initial permissions of the "
12735 "directory to C<mode>."
12739 #: ../src/guestfs-actions.pod:4248 ../fish/guestfish-actions.pod:2905
12741 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12742 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12747 #: ../src/guestfs-actions.pod:4252
12748 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12752 #: ../src/guestfs-actions.pod:4258
12753 msgid "guestfs_mkdir_p"
12757 #: ../src/guestfs-actions.pod:4260
12761 " guestfs_mkdir_p (guestfs_h *g,\n"
12762 " const char *path);\n"
12767 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2915
12769 "Create a directory named C<path>, creating any parent directories as "
12770 "necessary. This is like the C<mkdir -p> shell command."
12774 #: ../src/guestfs-actions.pod:4271
12775 msgid "guestfs_mkdtemp"
12779 #: ../src/guestfs-actions.pod:4273
12783 " guestfs_mkdtemp (guestfs_h *g,\n"
12784 " const char *template);\n"
12789 #: ../src/guestfs-actions.pod:4277 ../fish/guestfish-actions.pod:2922
12791 "This command creates a temporary directory. The C<template> parameter "
12792 "should be a full pathname for the temporary directory name with the final "
12793 "six characters being \"XXXXXX\"."
12797 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2927
12799 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12800 "being suitable for Windows filesystems."
12804 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2930
12805 msgid "The name of the temporary directory that was created is returned."
12809 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2933
12810 msgid "The temporary directory is created with mode 0700 and is owned by root."
12814 #: ../src/guestfs-actions.pod:4291 ../fish/guestfish-actions.pod:2936
12816 "The caller is responsible for deleting the temporary directory and its "
12817 "contents after use."
12821 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2939
12822 msgid "See also: L<mkdtemp(3)>"
12826 #: ../src/guestfs-actions.pod:4301
12827 msgid "guestfs_mke2fs_J"
12831 #: ../src/guestfs-actions.pod:4303
12835 " guestfs_mke2fs_J (guestfs_h *g,\n"
12836 " const char *fstype,\n"
12837 " int blocksize,\n"
12838 " const char *device,\n"
12839 " const char *journal);\n"
12844 #: ../src/guestfs-actions.pod:4310 ../fish/guestfish-actions.pod:2945
12846 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12847 "C<journal>. It is equivalent to the command:"
12851 #: ../src/guestfs-actions.pod:4314 ../fish/guestfish-actions.pod:2949
12854 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
12859 #: ../src/guestfs-actions.pod:4316
12860 msgid "See also C<guestfs_mke2journal>."
12864 #: ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4356 ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4459 ../src/guestfs-actions.pod:4724
12865 msgid "(Added in 1.0.68)"
12869 #: ../src/guestfs-actions.pod:4322
12870 msgid "guestfs_mke2fs_JL"
12874 #: ../src/guestfs-actions.pod:4324
12878 " guestfs_mke2fs_JL (guestfs_h *g,\n"
12879 " const char *fstype,\n"
12880 " int blocksize,\n"
12881 " const char *device,\n"
12882 " const char *label);\n"
12887 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2957
12889 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12890 "the journal labeled C<label>."
12894 #: ../src/guestfs-actions.pod:4334
12895 msgid "See also C<guestfs_mke2journal_L>."
12899 #: ../src/guestfs-actions.pod:4340
12900 msgid "guestfs_mke2fs_JU"
12904 #: ../src/guestfs-actions.pod:4342
12908 " guestfs_mke2fs_JU (guestfs_h *g,\n"
12909 " const char *fstype,\n"
12910 " int blocksize,\n"
12911 " const char *device,\n"
12912 " const char *uuid);\n"
12917 #: ../src/guestfs-actions.pod:4349 ../fish/guestfish-actions.pod:2966
12919 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12920 "the journal with UUID C<uuid>."
12924 #: ../src/guestfs-actions.pod:4352
12925 msgid "See also C<guestfs_mke2journal_U>."
12929 #: ../src/guestfs-actions.pod:4358
12930 msgid "guestfs_mke2journal"
12934 #: ../src/guestfs-actions.pod:4360
12938 " guestfs_mke2journal (guestfs_h *g,\n"
12939 " int blocksize,\n"
12940 " const char *device);\n"
12945 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:2975
12947 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12952 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2978
12955 " mke2fs -O journal_dev -b blocksize device\n"
12960 #: ../src/guestfs-actions.pod:4374
12961 msgid "guestfs_mke2journal_L"
12965 #: ../src/guestfs-actions.pod:4376
12969 " guestfs_mke2journal_L (guestfs_h *g,\n"
12970 " int blocksize,\n"
12971 " const char *label,\n"
12972 " const char *device);\n"
12977 #: ../src/guestfs-actions.pod:4382 ../fish/guestfish-actions.pod:2984
12978 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12982 #: ../src/guestfs-actions.pod:4388
12983 msgid "guestfs_mke2journal_U"
12987 #: ../src/guestfs-actions.pod:4390
12991 " guestfs_mke2journal_U (guestfs_h *g,\n"
12992 " int blocksize,\n"
12993 " const char *uuid,\n"
12994 " const char *device);\n"
12999 #: ../src/guestfs-actions.pod:4396 ../fish/guestfish-actions.pod:2990
13000 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13004 #: ../src/guestfs-actions.pod:4402
13005 msgid "guestfs_mkfifo"
13009 #: ../src/guestfs-actions.pod:4404
13013 " guestfs_mkfifo (guestfs_h *g,\n"
13015 " const char *path);\n"
13020 #: ../src/guestfs-actions.pod:4409
13022 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13023 "is just a convenient wrapper around C<guestfs_mknod>."
13027 #: ../src/guestfs-actions.pod:4419
13028 msgid "guestfs_mkfs"
13032 #: ../src/guestfs-actions.pod:4421
13036 " guestfs_mkfs (guestfs_h *g,\n"
13037 " const char *fstype,\n"
13038 " const char *device);\n"
13043 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:3006
13045 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13046 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13050 #: ../src/guestfs-actions.pod:4434
13051 msgid "guestfs_mkfs_b"
13055 #: ../src/guestfs-actions.pod:4436
13059 " guestfs_mkfs_b (guestfs_h *g,\n"
13060 " const char *fstype,\n"
13061 " int blocksize,\n"
13062 " const char *device);\n"
13067 #: ../src/guestfs-actions.pod:4442
13069 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13070 "block size of the resulting filesystem. Supported block sizes depend on the "
13071 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13075 #: ../src/guestfs-actions.pod:4447 ../src/guestfs-actions.pod:4490 ../fish/guestfish-actions.pod:3019 ../fish/guestfish-actions.pod:3046
13077 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13082 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3022
13084 "This function is deprecated. In new code, use the C<mkfs_opts> call "
13089 #: ../src/guestfs-actions.pod:4461
13090 msgid "guestfs_mkfs_opts"
13094 #: ../src/guestfs-actions.pod:4463
13098 " guestfs_mkfs_opts (guestfs_h *g,\n"
13099 " const char *fstype,\n"
13100 " const char *device,\n"
13106 #: ../src/guestfs-actions.pod:4474
13109 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13110 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13115 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3033
13117 "This function creates a filesystem on C<device>. The filesystem type is "
13118 "C<fstype>, for example C<ext3>."
13122 #: ../src/guestfs-actions.pod:4484 ../fish/guestfish-actions.pod:3040
13123 msgid "C<blocksize>"
13127 #: ../src/guestfs-actions.pod:4486 ../fish/guestfish-actions.pod:3042
13129 "The filesystem block size. Supported block sizes depend on the filesystem "
13130 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13135 #: ../src/guestfs-actions.pod:4493 ../fish/guestfish-actions.pod:3049
13136 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13140 #: ../src/guestfs-actions.pod:4495 ../fish/guestfish-actions.pod:3051
13141 msgid "C<features>"
13145 #: ../src/guestfs-actions.pod:4497 ../fish/guestfish-actions.pod:3053
13146 msgid "This passes the I<-O> parameter to the external mkfs program."
13150 #: ../src/guestfs-actions.pod:4499 ../fish/guestfish-actions.pod:3055
13152 "For certain filesystem types, this allows extra filesystem features to be "
13153 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13157 #: ../src/guestfs-actions.pod:4503 ../fish/guestfish-actions.pod:3059
13159 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13164 #: ../src/guestfs-actions.pod:4510
13165 msgid "(Added in 1.7.19)"
13169 #: ../src/guestfs-actions.pod:4512
13170 msgid "guestfs_mkfs_opts_va"
13174 #: ../src/guestfs-actions.pod:4514
13178 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13179 " const char *fstype,\n"
13180 " const char *device,\n"
13181 " va_list args);\n"
13186 #: ../src/guestfs-actions.pod:4520
13187 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13191 #: ../src/guestfs-actions.pod:4524
13192 msgid "guestfs_mkfs_opts_argv"
13196 #: ../src/guestfs-actions.pod:4526
13200 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13201 " const char *fstype,\n"
13202 " const char *device,\n"
13203 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13208 #: ../src/guestfs-actions.pod:4532
13209 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13213 #: ../src/guestfs-actions.pod:4536
13214 msgid "guestfs_mkmountpoint"
13218 #: ../src/guestfs-actions.pod:4538
13222 " guestfs_mkmountpoint (guestfs_h *g,\n"
13223 " const char *exemptpath);\n"
13228 #: ../src/guestfs-actions.pod:4542
13230 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13231 "that can be used to create extra mountpoints before mounting the first "
13236 #: ../src/guestfs-actions.pod:4546 ../fish/guestfish-actions.pod:3074
13238 "These calls are I<only> necessary in some very limited circumstances, mainly "
13239 "the case where you want to mount a mix of unrelated and/or read-only "
13240 "filesystems together."
13244 #: ../src/guestfs-actions.pod:4550 ../fish/guestfish-actions.pod:3078
13246 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13247 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13248 "inside that. You can unpack this as follows in guestfish:"
13252 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3083
13255 " add-ro Fedora-11-i686-Live.iso\n"
13257 " mkmountpoint /cd\n"
13258 " mkmountpoint /sqsh\n"
13259 " mkmountpoint /ext3fs\n"
13260 " mount /dev/sda /cd\n"
13261 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13262 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13267 #: ../src/guestfs-actions.pod:4564 ../fish/guestfish-actions.pod:3092
13268 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13272 #: ../src/guestfs-actions.pod:4566
13274 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13275 "may get unexpected errors if you try to mix these calls. It is safest to "
13276 "manually unmount filesystems and remove mountpoints after use."
13280 #: ../src/guestfs-actions.pod:4570
13282 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13283 "first, so for this to work for manual mountpoints, you must ensure that the "
13284 "innermost mountpoints have the longest pathnames, as in the example code "
13289 #: ../src/guestfs-actions.pod:4575 ../fish/guestfish-actions.pod:3103
13290 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13294 #: ../src/guestfs-actions.pod:4577
13296 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13297 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13298 "can also trigger these issues."
13302 #: ../src/guestfs-actions.pod:4583 ../src/guestfs-actions.pod:4849 ../src/guestfs-actions.pod:5759
13303 msgid "(Added in 1.0.62)"
13307 #: ../src/guestfs-actions.pod:4585
13308 msgid "guestfs_mknod"
13312 #: ../src/guestfs-actions.pod:4587
13316 " guestfs_mknod (guestfs_h *g,\n"
13320 " const char *path);\n"
13325 #: ../src/guestfs-actions.pod:4594 ../fish/guestfish-actions.pod:3113
13327 "This call creates block or character special devices, or named pipes "
13332 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3116
13334 "The C<mode> parameter should be the mode, using the standard constants. "
13335 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13336 "used when creating block and character special devices."
13340 #: ../src/guestfs-actions.pod:4602
13342 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13343 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13344 "regular file). These constants are available in the standard Linux header "
13345 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13346 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13347 "the appropriate constant for you."
13351 #: ../src/guestfs-actions.pod:4616
13352 msgid "guestfs_mknod_b"
13356 #: ../src/guestfs-actions.pod:4618
13360 " guestfs_mknod_b (guestfs_h *g,\n"
13364 " const char *path);\n"
13369 #: ../src/guestfs-actions.pod:4625
13371 "This call creates a block device node called C<path> with mode C<mode> and "
13372 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13373 "wrapper around C<guestfs_mknod>."
13377 #: ../src/guestfs-actions.pod:4635
13378 msgid "guestfs_mknod_c"
13382 #: ../src/guestfs-actions.pod:4637
13386 " guestfs_mknod_c (guestfs_h *g,\n"
13390 " const char *path);\n"
13395 #: ../src/guestfs-actions.pod:4644
13397 "This call creates a char device node called C<path> with mode C<mode> and "
13398 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13399 "wrapper around C<guestfs_mknod>."
13403 #: ../src/guestfs-actions.pod:4654
13404 msgid "guestfs_mkswap"
13408 #: ../src/guestfs-actions.pod:4656
13412 " guestfs_mkswap (guestfs_h *g,\n"
13413 " const char *device);\n"
13418 #: ../src/guestfs-actions.pod:4660 ../fish/guestfish-actions.pod:3155
13419 msgid "Create a swap partition on C<device>."
13423 #: ../src/guestfs-actions.pod:4666
13424 msgid "guestfs_mkswap_L"
13428 #: ../src/guestfs-actions.pod:4668
13432 " guestfs_mkswap_L (guestfs_h *g,\n"
13433 " const char *label,\n"
13434 " const char *device);\n"
13439 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3161
13440 msgid "Create a swap partition on C<device> with label C<label>."
13444 #: ../src/guestfs-actions.pod:4675 ../fish/guestfish-actions.pod:3163
13446 "Note that you cannot attach a swap label to a block device "
13447 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13448 "the kernel or swap tools."
13452 #: ../src/guestfs-actions.pod:4683
13453 msgid "guestfs_mkswap_U"
13457 #: ../src/guestfs-actions.pod:4685
13461 " guestfs_mkswap_U (guestfs_h *g,\n"
13462 " const char *uuid,\n"
13463 " const char *device);\n"
13468 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3171
13469 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13473 #: ../src/guestfs-actions.pod:4696
13474 msgid "guestfs_mkswap_file"
13478 #: ../src/guestfs-actions.pod:4698
13482 " guestfs_mkswap_file (guestfs_h *g,\n"
13483 " const char *path);\n"
13488 #: ../src/guestfs-actions.pod:4702 ../fish/guestfish-actions.pod:3177
13489 msgid "Create a swap file."
13493 #: ../src/guestfs-actions.pod:4704
13495 "This command just writes a swap file signature to an existing file. To "
13496 "create the file itself, use something like C<guestfs_fallocate>."
13500 #: ../src/guestfs-actions.pod:4711
13501 msgid "guestfs_modprobe"
13505 #: ../src/guestfs-actions.pod:4713
13509 " guestfs_modprobe (guestfs_h *g,\n"
13510 " const char *modulename);\n"
13515 #: ../src/guestfs-actions.pod:4717 ../fish/guestfish-actions.pod:3186
13516 msgid "This loads a kernel module in the appliance."
13520 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3188
13522 "The kernel module must have been whitelisted when libguestfs was built (see "
13523 "C<appliance/kmod.whitelist.in> in the source)."
13527 #: ../src/guestfs-actions.pod:4726
13528 msgid "guestfs_mount"
13532 #: ../src/guestfs-actions.pod:4728
13536 " guestfs_mount (guestfs_h *g,\n"
13537 " const char *device,\n"
13538 " const char *mountpoint);\n"
13543 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3195
13545 "Mount a guest disk at a position in the filesystem. Block devices are named "
13546 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13547 "those block devices contain partitions, they will have the usual names "
13548 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13552 #: ../src/guestfs-actions.pod:4739 ../fish/guestfish-actions.pod:3201
13554 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13555 "mounted on C</> before others can be mounted. Other filesystems can only be "
13556 "mounted on directories which already exist."
13560 #: ../src/guestfs-actions.pod:4744 ../fish/guestfish-actions.pod:3206
13562 "The mounted filesystem is writable, if we have sufficient permissions on the "
13563 "underlying device."
13567 #: ../src/guestfs-actions.pod:4747
13569 "B<Important note:> When you use this call, the filesystem options C<sync> "
13570 "and C<noatime> are set implicitly. This was originally done because we "
13571 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13572 "very large negative performance impact and negligible effect on "
13573 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13574 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13575 "(use an empty string for the first parameter if you don't want any options)."
13579 #: ../src/guestfs-actions.pod:4759 ../fish/guestfish-actions.pod:3219
13581 "This function is deprecated. In new code, use the C<mount_options> call "
13586 #: ../src/guestfs-actions.pod:4768
13587 msgid "guestfs_mount_loop"
13591 #: ../src/guestfs-actions.pod:4770
13595 " guestfs_mount_loop (guestfs_h *g,\n"
13596 " const char *file,\n"
13597 " const char *mountpoint);\n"
13602 #: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3230
13604 "This command lets you mount C<file> (a filesystem image in a file) on a "
13605 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13610 #: ../src/guestfs-actions.pod:4783
13611 msgid "guestfs_mount_options"
13615 #: ../src/guestfs-actions.pod:4785
13619 " guestfs_mount_options (guestfs_h *g,\n"
13620 " const char *options,\n"
13621 " const char *device,\n"
13622 " const char *mountpoint);\n"
13627 #: ../src/guestfs-actions.pod:4791
13629 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13630 "the mount options as for the L<mount(8)> I<-o> flag."
13634 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3242
13636 "If the C<options> parameter is an empty string, then no options are passed "
13637 "(all options default to whatever the filesystem uses)."
13641 #: ../src/guestfs-actions.pod:4801 ../src/guestfs-actions.pod:4815 ../src/guestfs-actions.pod:4832
13642 msgid "(Added in 1.0.10)"
13646 #: ../src/guestfs-actions.pod:4803
13647 msgid "guestfs_mount_ro"
13651 #: ../src/guestfs-actions.pod:4805
13655 " guestfs_mount_ro (guestfs_h *g,\n"
13656 " const char *device,\n"
13657 " const char *mountpoint);\n"
13662 #: ../src/guestfs-actions.pod:4810
13664 "This is the same as the C<guestfs_mount> command, but it mounts the "
13665 "filesystem with the read-only (I<-o ro>) flag."
13669 #: ../src/guestfs-actions.pod:4817
13670 msgid "guestfs_mount_vfs"
13674 #: ../src/guestfs-actions.pod:4819
13678 " guestfs_mount_vfs (guestfs_h *g,\n"
13679 " const char *options,\n"
13680 " const char *vfstype,\n"
13681 " const char *device,\n"
13682 " const char *mountpoint);\n"
13687 #: ../src/guestfs-actions.pod:4826
13689 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13690 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13695 #: ../src/guestfs-actions.pod:4834
13696 msgid "guestfs_mountpoints"
13700 #: ../src/guestfs-actions.pod:4836
13704 " guestfs_mountpoints (guestfs_h *g);\n"
13709 #: ../src/guestfs-actions.pod:4839
13711 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13712 "devices. This one returns a hash table (map) of device name to directory "
13713 "where the device is mounted."
13717 #: ../src/guestfs-actions.pod:4851
13718 msgid "guestfs_mounts"
13722 #: ../src/guestfs-actions.pod:4853
13726 " guestfs_mounts (guestfs_h *g);\n"
13731 #: ../src/guestfs-actions.pod:4856 ../fish/guestfish-actions.pod:3273
13733 "This returns the list of currently mounted filesystems. It returns the list "
13734 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13738 #: ../src/guestfs-actions.pod:4859 ../fish/guestfish-actions.pod:3276
13739 msgid "Some internal mounts are not shown."
13743 #: ../src/guestfs-actions.pod:4861
13744 msgid "See also: C<guestfs_mountpoints>"
13748 #: ../src/guestfs-actions.pod:4869
13753 #: ../src/guestfs-actions.pod:4871
13757 " guestfs_mv (guestfs_h *g,\n"
13758 " const char *src,\n"
13759 " const char *dest);\n"
13764 #: ../src/guestfs-actions.pod:4876 ../fish/guestfish-actions.pod:3284
13766 "This moves a file from C<src> to C<dest> where C<dest> is either a "
13767 "destination filename or destination directory."
13771 #: ../src/guestfs-actions.pod:4883
13772 msgid "guestfs_ntfs_3g_probe"
13776 #: ../src/guestfs-actions.pod:4885
13780 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
13782 " const char *device);\n"
13787 #: ../src/guestfs-actions.pod:4890 ../fish/guestfish-actions.pod:3291
13789 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
13790 "C<device> for mountability. (Not all NTFS volumes can be mounted "
13791 "read-write, and some cannot be mounted at all)."
13795 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3295
13797 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
13798 "can be mounted read-write. Set it to false if you want to test if the "
13799 "volume can be mounted read-only."
13803 #: ../src/guestfs-actions.pod:4898 ../fish/guestfish-actions.pod:3299
13805 "The return value is an integer which C<0> if the operation would succeed, or "
13806 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
13810 #: ../src/guestfs-actions.pod:4904
13811 msgid "(Added in 1.0.43)"
13815 #: ../src/guestfs-actions.pod:4906
13816 msgid "guestfs_ntfsresize"
13820 #: ../src/guestfs-actions.pod:4908
13824 " guestfs_ntfsresize (guestfs_h *g,\n"
13825 " const char *device);\n"
13830 #: ../src/guestfs-actions.pod:4912 ../fish/guestfish-actions.pod:3307
13832 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
13833 "size of the underlying device. See also L<ntfsresize(8)>."
13837 #: ../src/guestfs-actions.pod:4920
13838 msgid "guestfs_ntfsresize_size"
13842 #: ../src/guestfs-actions.pod:4922
13846 " guestfs_ntfsresize_size (guestfs_h *g,\n"
13847 " const char *device,\n"
13848 " int64_t size);\n"
13853 #: ../src/guestfs-actions.pod:4927
13855 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
13856 "to specify the new size (in bytes) explicitly."
13860 #: ../src/guestfs-actions.pod:4932 ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:5441 ../src/guestfs-actions.pod:5707 ../src/guestfs-actions.pod:7313
13861 msgid "(Added in 1.3.14)"
13865 #: ../src/guestfs-actions.pod:4934
13866 msgid "guestfs_part_add"
13870 #: ../src/guestfs-actions.pod:4936
13874 " guestfs_part_add (guestfs_h *g,\n"
13875 " const char *device,\n"
13876 " const char *prlogex,\n"
13877 " int64_t startsect,\n"
13878 " int64_t endsect);\n"
13883 #: ../src/guestfs-actions.pod:4943
13885 "This command adds a partition to C<device>. If there is no partition table "
13886 "on the device, call C<guestfs_part_init> first."
13890 #: ../src/guestfs-actions.pod:4946 ../fish/guestfish-actions.pod:3325
13892 "The C<prlogex> parameter is the type of partition. Normally you should pass "
13893 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
13894 "C<logical>) and C<e> (or C<extended>) partition types."
13898 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3330
13900 "C<startsect> and C<endsect> are the start and end of the partition in "
13901 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
13902 "from the end of the disk (C<-1> is the last sector)."
13906 #: ../src/guestfs-actions.pod:4955
13908 "Creating a partition which covers the whole disk is not so easy. Use "
13909 "C<guestfs_part_disk> to do that."
13913 #: ../src/guestfs-actions.pod:4960 ../src/guestfs-actions.pod:4998 ../src/guestfs-actions.pod:5051 ../src/guestfs-actions.pod:5129 ../src/guestfs-actions.pod:5167 ../src/guestfs-actions.pod:5186 ../src/guestfs-actions.pod:5226
13914 msgid "(Added in 1.0.78)"
13918 #: ../src/guestfs-actions.pod:4962
13919 msgid "guestfs_part_del"
13923 #: ../src/guestfs-actions.pod:4964
13927 " guestfs_part_del (guestfs_h *g,\n"
13928 " const char *device,\n"
13934 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3341
13935 msgid "This command deletes the partition numbered C<partnum> on C<device>."
13939 #: ../src/guestfs-actions.pod:4971 ../fish/guestfish-actions.pod:3343
13941 "Note that in the case of MBR partitioning, deleting an extended partition "
13942 "also deletes any logical partitions it contains."
13946 #: ../src/guestfs-actions.pod:4979
13947 msgid "guestfs_part_disk"
13951 #: ../src/guestfs-actions.pod:4981
13955 " guestfs_part_disk (guestfs_h *g,\n"
13956 " const char *device,\n"
13957 " const char *parttype);\n"
13962 #: ../src/guestfs-actions.pod:4986
13964 "This command is simply a combination of C<guestfs_part_init> followed by "
13965 "C<guestfs_part_add> to create a single primary partition covering the whole "
13970 #: ../src/guestfs-actions.pod:4990
13972 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
13973 "possible values are described in C<guestfs_part_init>."
13977 #: ../src/guestfs-actions.pod:5000
13978 msgid "guestfs_part_get_bootable"
13982 #: ../src/guestfs-actions.pod:5002
13986 " guestfs_part_get_bootable (guestfs_h *g,\n"
13987 " const char *device,\n"
13993 #: ../src/guestfs-actions.pod:5007 ../fish/guestfish-actions.pod:3365
13995 "This command returns true if the partition C<partnum> on C<device> has the "
13996 "bootable flag set."
14000 #: ../src/guestfs-actions.pod:5010
14001 msgid "See also C<guestfs_part_set_bootable>."
14005 #: ../src/guestfs-actions.pod:5016
14006 msgid "guestfs_part_get_mbr_id"
14010 #: ../src/guestfs-actions.pod:5018
14014 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14015 " const char *device,\n"
14021 #: ../src/guestfs-actions.pod:5023 ../fish/guestfish-actions.pod:3374
14023 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14024 "partition C<partnum>."
14028 #: ../src/guestfs-actions.pod:5026 ../src/guestfs-actions.pod:5202
14030 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14031 "undefined results for other partition table types (see "
14032 "C<guestfs_part_get_parttype>)."
14036 #: ../src/guestfs-actions.pod:5034
14037 msgid "guestfs_part_get_parttype"
14041 #: ../src/guestfs-actions.pod:5036
14045 " guestfs_part_get_parttype (guestfs_h *g,\n"
14046 " const char *device);\n"
14051 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3385
14053 "This command examines the partition table on C<device> and returns the "
14054 "partition table type (format) being used."
14058 #: ../src/guestfs-actions.pod:5043
14060 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14061 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14062 "possible, although unusual. See C<guestfs_part_init> for a full list."
14066 #: ../src/guestfs-actions.pod:5053
14067 msgid "guestfs_part_init"
14071 #: ../src/guestfs-actions.pod:5055
14075 " guestfs_part_init (guestfs_h *g,\n"
14076 " const char *device,\n"
14077 " const char *parttype);\n"
14082 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3397
14084 "This creates an empty partition table on C<device> of one of the partition "
14085 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14086 "(for large disks)."
14090 #: ../src/guestfs-actions.pod:5064
14092 "Initially there are no partitions. Following this, you should call "
14093 "C<guestfs_part_add> for each partition required."
14097 #: ../src/guestfs-actions.pod:5067 ../fish/guestfish-actions.pod:3404
14098 msgid "Possible values for C<parttype> are:"
14102 #: ../src/guestfs-actions.pod:5071 ../fish/guestfish-actions.pod:3408
14103 msgid "B<efi> | B<gpt>"
14107 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3410
14108 msgid "Intel EFI / GPT partition table."
14112 #: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3412
14114 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14115 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14116 "the C<mbr> format."
14120 #: ../src/guestfs-actions.pod:5079 ../fish/guestfish-actions.pod:3416
14121 msgid "B<mbr> | B<msdos>"
14125 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3418
14127 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14128 "Windows. This partition type will B<only> work for device sizes up to 2 "
14129 "TB. For large disks we recommend using C<gpt>."
14133 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3425
14134 msgid "Other partition table types that may work but are not supported include:"
14138 #: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3430
14143 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3432
14144 msgid "AIX disk labels."
14148 #: ../src/guestfs-actions.pod:5097 ../fish/guestfish-actions.pod:3434
14149 msgid "B<amiga> | B<rdb>"
14153 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3436
14154 msgid "Amiga \"Rigid Disk Block\" format."
14158 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3438
14163 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3440
14164 msgid "BSD disk labels."
14168 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3442
14173 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3444
14174 msgid "DASD, used on IBM mainframes."
14178 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3446
14183 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3448
14184 msgid "MIPS/SGI volumes."
14188 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3450
14193 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3452
14194 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14198 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3454
14203 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3456
14204 msgid "NEC PC-98 format, common in Japan apparently."
14208 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3458
14213 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3460
14214 msgid "Sun disk labels."
14218 #: ../src/guestfs-actions.pod:5131
14219 msgid "guestfs_part_list"
14223 #: ../src/guestfs-actions.pod:5133
14226 " struct guestfs_partition_list *\n"
14227 " guestfs_part_list (guestfs_h *g,\n"
14228 " const char *device);\n"
14233 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3468
14235 "This command parses the partition table on C<device> and returns the list of "
14236 "partitions found."
14240 #: ../src/guestfs-actions.pod:5140 ../fish/guestfish-actions.pod:3471
14241 msgid "The fields in the returned structure are:"
14245 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3475
14246 msgid "B<part_num>"
14250 #: ../src/guestfs-actions.pod:5146 ../fish/guestfish-actions.pod:3477
14251 msgid "Partition number, counting from 1."
14255 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3479
14256 msgid "B<part_start>"
14260 #: ../src/guestfs-actions.pod:5150
14262 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14263 "the device's sector size, see C<guestfs_blockdev_getss>."
14267 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3484
14268 msgid "B<part_end>"
14272 #: ../src/guestfs-actions.pod:5155 ../fish/guestfish-actions.pod:3486
14273 msgid "End of the partition in bytes."
14277 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3488
14278 msgid "B<part_size>"
14282 #: ../src/guestfs-actions.pod:5159 ../fish/guestfish-actions.pod:3490
14283 msgid "Size of the partition in bytes."
14287 #: ../src/guestfs-actions.pod:5163
14289 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14290 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14295 #: ../src/guestfs-actions.pod:5169
14296 msgid "guestfs_part_set_bootable"
14300 #: ../src/guestfs-actions.pod:5171
14304 " guestfs_part_set_bootable (guestfs_h *g,\n"
14305 " const char *device,\n"
14307 " int bootable);\n"
14312 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3498
14314 "This sets the bootable flag on partition numbered C<partnum> on device "
14315 "C<device>. Note that partitions are numbered from 1."
14319 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3501
14321 "The bootable flag is used by some operating systems (notably Windows) to "
14322 "determine which partition to boot from. It is by no means universally "
14327 #: ../src/guestfs-actions.pod:5188
14328 msgid "guestfs_part_set_mbr_id"
14332 #: ../src/guestfs-actions.pod:5190
14336 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14337 " const char *device,\n"
14344 #: ../src/guestfs-actions.pod:5196 ../fish/guestfish-actions.pod:3509
14346 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14347 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14348 "documentation are in fact hexadecimal numbers, but usually documented "
14349 "without any leading \"0x\" which might be confusing."
14353 #: ../src/guestfs-actions.pod:5210
14354 msgid "guestfs_part_set_name"
14358 #: ../src/guestfs-actions.pod:5212
14362 " guestfs_part_set_name (guestfs_h *g,\n"
14363 " const char *device,\n"
14365 " const char *name);\n"
14370 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3523
14372 "This sets the partition name on partition numbered C<partnum> on device "
14373 "C<device>. Note that partitions are numbered from 1."
14377 #: ../src/guestfs-actions.pod:5221 ../fish/guestfish-actions.pod:3526
14379 "The partition name can only be set on certain types of partition table. "
14380 "This works on C<gpt> but not on C<mbr> partitions."
14384 #: ../src/guestfs-actions.pod:5228
14385 msgid "guestfs_part_to_dev"
14389 #: ../src/guestfs-actions.pod:5230
14393 " guestfs_part_to_dev (guestfs_h *g,\n"
14394 " const char *partition);\n"
14399 #: ../src/guestfs-actions.pod:5234 ../fish/guestfish-actions.pod:3533
14401 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14402 "partition number, returning the device name (eg. \"/dev/sdb\")."
14406 #: ../src/guestfs-actions.pod:5238
14408 "The named partition must exist, for example as a string returned from "
14409 "C<guestfs_list_partitions>."
14413 #: ../src/guestfs-actions.pod:5246
14414 msgid "guestfs_ping_daemon"
14418 #: ../src/guestfs-actions.pod:5248
14422 " guestfs_ping_daemon (guestfs_h *g);\n"
14427 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3544
14429 "This is a test probe into the guestfs daemon running inside the qemu "
14430 "subprocess. Calling this function checks that the daemon responds to the "
14431 "ping message, without affecting the daemon or attached block device(s) in "
14436 #: ../src/guestfs-actions.pod:5260
14437 msgid "guestfs_pread"
14441 #: ../src/guestfs-actions.pod:5262
14445 " guestfs_pread (guestfs_h *g,\n"
14446 " const char *path,\n"
14448 " int64_t offset,\n"
14449 " size_t *size_r);\n"
14454 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:3553
14456 "This command lets you read part of a file. It reads C<count> bytes of the "
14457 "file, starting at C<offset>, from file C<path>."
14461 #: ../src/guestfs-actions.pod:5272 ../src/guestfs-actions.pod:5298 ../fish/guestfish-actions.pod:3556 ../fish/guestfish-actions.pod:3571
14463 "This may read fewer bytes than requested. For further details see the "
14464 "L<pread(2)> system call."
14468 #: ../src/guestfs-actions.pod:5275
14469 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14473 #: ../src/guestfs-actions.pod:5286
14474 msgid "guestfs_pread_device"
14478 #: ../src/guestfs-actions.pod:5288
14482 " guestfs_pread_device (guestfs_h *g,\n"
14483 " const char *device,\n"
14485 " int64_t offset,\n"
14486 " size_t *size_r);\n"
14491 #: ../src/guestfs-actions.pod:5295 ../fish/guestfish-actions.pod:3568
14493 "This command lets you read part of a file. It reads C<count> bytes of "
14494 "C<device>, starting at C<offset>."
14498 #: ../src/guestfs-actions.pod:5301
14499 msgid "See also C<guestfs_pread>."
14503 #: ../src/guestfs-actions.pod:5310
14504 msgid "(Added in 1.5.21)"
14508 #: ../src/guestfs-actions.pod:5312
14509 msgid "guestfs_pvcreate"
14513 #: ../src/guestfs-actions.pod:5314
14517 " guestfs_pvcreate (guestfs_h *g,\n"
14518 " const char *device);\n"
14523 #: ../src/guestfs-actions.pod:5318 ../fish/guestfish-actions.pod:3583
14525 "This creates an LVM physical volume on the named C<device>, where C<device> "
14526 "should usually be a partition name such as C</dev/sda1>."
14530 #: ../src/guestfs-actions.pod:5326
14531 msgid "guestfs_pvremove"
14535 #: ../src/guestfs-actions.pod:5328
14539 " guestfs_pvremove (guestfs_h *g,\n"
14540 " const char *device);\n"
14545 #: ../src/guestfs-actions.pod:5332 ../fish/guestfish-actions.pod:3591
14547 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14552 #: ../src/guestfs-actions.pod:5335 ../fish/guestfish-actions.pod:3594
14554 "The implementation uses the C<pvremove> command which refuses to wipe "
14555 "physical volumes that contain any volume groups, so you have to remove those "
14560 #: ../src/guestfs-actions.pod:5343
14561 msgid "guestfs_pvresize"
14565 #: ../src/guestfs-actions.pod:5345
14569 " guestfs_pvresize (guestfs_h *g,\n"
14570 " const char *device);\n"
14575 #: ../src/guestfs-actions.pod:5349 ../fish/guestfish-actions.pod:3602
14577 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14578 "the new size of the underlying device."
14582 #: ../src/guestfs-actions.pod:5356
14583 msgid "guestfs_pvresize_size"
14587 #: ../src/guestfs-actions.pod:5358
14591 " guestfs_pvresize_size (guestfs_h *g,\n"
14592 " const char *device,\n"
14593 " int64_t size);\n"
14598 #: ../src/guestfs-actions.pod:5363
14600 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14601 "specify the new size (in bytes) explicitly."
14605 #: ../src/guestfs-actions.pod:5370
14606 msgid "guestfs_pvs"
14610 #: ../src/guestfs-actions.pod:5372
14614 " guestfs_pvs (guestfs_h *g);\n"
14619 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3616
14621 "List all the physical volumes detected. This is the equivalent of the "
14622 "L<pvs(8)> command."
14626 #: ../src/guestfs-actions.pod:5378 ../fish/guestfish-actions.pod:3619
14628 "This returns a list of just the device names that contain PVs "
14629 "(eg. C</dev/sda2>)."
14633 #: ../src/guestfs-actions.pod:5381
14634 msgid "See also C<guestfs_pvs_full>."
14638 #: ../src/guestfs-actions.pod:5389
14639 msgid "guestfs_pvs_full"
14643 #: ../src/guestfs-actions.pod:5391
14646 " struct guestfs_lvm_pv_list *\n"
14647 " guestfs_pvs_full (guestfs_h *g);\n"
14652 #: ../src/guestfs-actions.pod:5394 ../fish/guestfish-actions.pod:3628
14654 "List all the physical volumes detected. This is the equivalent of the "
14655 "L<pvs(8)> command. The \"full\" version includes all fields."
14659 #: ../src/guestfs-actions.pod:5397
14661 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14662 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14667 #: ../src/guestfs-actions.pod:5403
14668 msgid "guestfs_pvuuid"
14672 #: ../src/guestfs-actions.pod:5405
14676 " guestfs_pvuuid (guestfs_h *g,\n"
14677 " const char *device);\n"
14682 #: ../src/guestfs-actions.pod:5409 ../fish/guestfish-actions.pod:3635
14683 msgid "This command returns the UUID of the LVM PV C<device>."
14687 #: ../src/guestfs-actions.pod:5416
14688 msgid "guestfs_pwrite"
14692 #: ../src/guestfs-actions.pod:5418
14696 " guestfs_pwrite (guestfs_h *g,\n"
14697 " const char *path,\n"
14698 " const char *content,\n"
14699 " size_t content_size,\n"
14700 " int64_t offset);\n"
14705 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3641
14707 "This command writes to part of a file. It writes the data buffer C<content> "
14708 "to the file C<path> starting at offset C<offset>."
14712 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3644
14714 "This command implements the L<pwrite(2)> system call, and like that system "
14715 "call it may not write the full data requested. The return value is the "
14716 "number of bytes that were actually written to the file. This could even be "
14717 "0, although short writes are unlikely for regular files in ordinary "
14722 #: ../src/guestfs-actions.pod:5434
14723 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14727 #: ../src/guestfs-actions.pod:5443
14728 msgid "guestfs_pwrite_device"
14732 #: ../src/guestfs-actions.pod:5445
14736 " guestfs_pwrite_device (guestfs_h *g,\n"
14737 " const char *device,\n"
14738 " const char *content,\n"
14739 " size_t content_size,\n"
14740 " int64_t offset);\n"
14745 #: ../src/guestfs-actions.pod:5452 ../fish/guestfish-actions.pod:3659
14747 "This command writes to part of a device. It writes the data buffer "
14748 "C<content> to C<device> starting at offset C<offset>."
14752 #: ../src/guestfs-actions.pod:5455 ../fish/guestfish-actions.pod:3662
14754 "This command implements the L<pwrite(2)> system call, and like that system "
14755 "call it may not write the full data requested (although short writes to disk "
14756 "devices and partitions are probably impossible with standard Linux kernels)."
14760 #: ../src/guestfs-actions.pod:5460
14761 msgid "See also C<guestfs_pwrite>."
14765 #: ../src/guestfs-actions.pod:5467
14766 msgid "(Added in 1.5.20)"
14770 #: ../src/guestfs-actions.pod:5469
14771 msgid "guestfs_read_file"
14775 #: ../src/guestfs-actions.pod:5471
14779 " guestfs_read_file (guestfs_h *g,\n"
14780 " const char *path,\n"
14781 " size_t *size_r);\n"
14786 #: ../src/guestfs-actions.pod:5476 ../fish/guestfish-actions.pod:3676
14787 msgid "This calls returns the contents of the file C<path> as a buffer."
14791 #: ../src/guestfs-actions.pod:5479
14793 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
14794 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
14795 "function is limited in the total size of file that can be handled."
14799 #: ../src/guestfs-actions.pod:5491
14800 msgid "(Added in 1.0.63)"
14804 #: ../src/guestfs-actions.pod:5493
14805 msgid "guestfs_read_lines"
14809 #: ../src/guestfs-actions.pod:5495
14813 " guestfs_read_lines (guestfs_h *g,\n"
14814 " const char *path);\n"
14819 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3693
14821 "The file contents are returned as a list of lines. Trailing C<LF> and "
14822 "C<CRLF> character sequences are I<not> returned."
14826 #: ../src/guestfs-actions.pod:5504
14828 "Note that this function cannot correctly handle binary files (specifically, "
14829 "files containing C<\\0> character which is treated as end of line). For "
14830 "those you need to use the C<guestfs_read_file> function which has a more "
14831 "complex interface."
14835 #: ../src/guestfs-actions.pod:5515
14836 msgid "guestfs_readdir"
14840 #: ../src/guestfs-actions.pod:5517
14843 " struct guestfs_dirent_list *\n"
14844 " guestfs_readdir (guestfs_h *g,\n"
14845 " const char *dir);\n"
14850 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3705
14851 msgid "This returns the list of directory entries in directory C<dir>."
14855 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3707
14857 "All entries in the directory are returned, including C<.> and C<..>. The "
14858 "entries are I<not> sorted, but returned in the same order as the underlying "
14863 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3711
14865 "Also this call returns basic file type information about each file. The "
14866 "C<ftyp> field will contain one of the following characters:"
14870 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3716
14875 #: ../src/guestfs-actions.pod:5534 ../fish/guestfish-actions.pod:3718
14876 msgid "Block special"
14880 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3720
14885 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3722
14886 msgid "Char special"
14890 #: ../src/guestfs-actions.pod:5540 ../fish/guestfish-actions.pod:3724
14895 #: ../src/guestfs-actions.pod:5542 ../fish/guestfish-actions.pod:3726
14900 #: ../src/guestfs-actions.pod:5544 ../fish/guestfish-actions.pod:3728
14905 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3730
14906 msgid "FIFO (named pipe)"
14910 #: ../src/guestfs-actions.pod:5548 ../fish/guestfish-actions.pod:3732
14915 #: ../src/guestfs-actions.pod:5550 ../fish/guestfish-actions.pod:3734
14916 msgid "Symbolic link"
14920 #: ../src/guestfs-actions.pod:5552 ../fish/guestfish-actions.pod:3736
14925 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3738
14926 msgid "Regular file"
14930 #: ../src/guestfs-actions.pod:5556 ../fish/guestfish-actions.pod:3740
14935 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3742
14940 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3744
14945 #: ../src/guestfs-actions.pod:5562 ../fish/guestfish-actions.pod:3746
14946 msgid "Unknown file type"
14950 #: ../src/guestfs-actions.pod:5564 ../fish/guestfish-actions.pod:3748
14955 #: ../src/guestfs-actions.pod:5566 ../fish/guestfish-actions.pod:3750
14956 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
14960 #: ../src/guestfs-actions.pod:5571
14962 "This function is primarily intended for use by programs. To get a simple "
14963 "list of names, use C<guestfs_ls>. To get a printable directory for human "
14964 "consumption, use C<guestfs_ll>."
14968 #: ../src/guestfs-actions.pod:5575
14970 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
14971 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
14976 #: ../src/guestfs-actions.pod:5581
14977 msgid "guestfs_readlink"
14981 #: ../src/guestfs-actions.pod:5583
14985 " guestfs_readlink (guestfs_h *g,\n"
14986 " const char *path);\n"
14991 #: ../src/guestfs-actions.pod:5587 ../fish/guestfish-actions.pod:3763
14992 msgid "This command reads the target of a symbolic link."
14996 #: ../src/guestfs-actions.pod:5594
14997 msgid "guestfs_readlinklist"
15001 #: ../src/guestfs-actions.pod:5596
15005 " guestfs_readlinklist (guestfs_h *g,\n"
15006 " const char *path,\n"
15007 " char *const *names);\n"
15012 #: ../src/guestfs-actions.pod:5601 ../fish/guestfish-actions.pod:3769
15014 "This call allows you to do a C<readlink> operation on multiple files, where "
15015 "all files are in the directory C<path>. C<names> is the list of files from "
15020 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:3773
15022 "On return you get a list of strings, with a one-to-one correspondence to the "
15023 "C<names> list. Each string is the value of the symbolic link."
15027 #: ../src/guestfs-actions.pod:5609 ../fish/guestfish-actions.pod:3777
15029 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15030 "result string is the empty string C<\"\">. However the whole operation is "
15031 "completed even if there were C<readlink(2)> errors, and so you can call this "
15032 "function with names where you don't know if they are symbolic links already "
15033 "(albeit slightly less efficient)."
15037 #: ../src/guestfs-actions.pod:5616 ../fish/guestfish-actions.pod:3784
15039 "This call is intended for programs that want to efficiently list a directory "
15040 "contents without making many round-trips. Very long directory listings "
15041 "might cause the protocol message size to be exceeded, causing this call to "
15042 "fail. The caller must split up such requests into smaller groups of names."
15046 #: ../src/guestfs-actions.pod:5629
15047 msgid "guestfs_realpath"
15051 #: ../src/guestfs-actions.pod:5631
15055 " guestfs_realpath (guestfs_h *g,\n"
15056 " const char *path);\n"
15061 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3795
15063 "Return the canonicalized absolute pathname of C<path>. The returned path "
15064 "has no C<.>, C<..> or symbolic link path elements."
15068 #: ../src/guestfs-actions.pod:5643
15069 msgid "guestfs_removexattr"
15073 #: ../src/guestfs-actions.pod:5645
15077 " guestfs_removexattr (guestfs_h *g,\n"
15078 " const char *xattr,\n"
15079 " const char *path);\n"
15084 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3802
15085 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
15089 #: ../src/guestfs-actions.pod:5653
15090 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15094 #: ../src/guestfs-actions.pod:5659
15095 msgid "guestfs_resize2fs"
15099 #: ../src/guestfs-actions.pod:5661
15103 " guestfs_resize2fs (guestfs_h *g,\n"
15104 " const char *device);\n"
15109 #: ../src/guestfs-actions.pod:5665 ../fish/guestfish-actions.pod:3811
15111 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15112 "underlying device."
15116 #: ../src/guestfs-actions.pod:5668
15118 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15119 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15120 "sometimes gives an error about this and sometimes not. In any case, it is "
15121 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15125 #: ../src/guestfs-actions.pod:5678
15126 msgid "guestfs_resize2fs_M"
15130 #: ../src/guestfs-actions.pod:5680
15134 " guestfs_resize2fs_M (guestfs_h *g,\n"
15135 " const char *device);\n"
15140 #: ../src/guestfs-actions.pod:5684
15142 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15143 "resized to its minimum size. This works like the I<-M> option to the "
15144 "C<resize2fs> command."
15148 #: ../src/guestfs-actions.pod:5688
15150 "To get the resulting size of the filesystem you should call "
15151 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15152 "These two numbers, multiplied together, give the resulting size of the "
15153 "minimal filesystem in bytes."
15157 #: ../src/guestfs-actions.pod:5695
15158 msgid "guestfs_resize2fs_size"
15162 #: ../src/guestfs-actions.pod:5697
15166 " guestfs_resize2fs_size (guestfs_h *g,\n"
15167 " const char *device,\n"
15168 " int64_t size);\n"
15173 #: ../src/guestfs-actions.pod:5702
15175 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15176 "to specify the new size (in bytes) explicitly."
15180 #: ../src/guestfs-actions.pod:5709
15185 #: ../src/guestfs-actions.pod:5711
15189 " guestfs_rm (guestfs_h *g,\n"
15190 " const char *path);\n"
15195 #: ../src/guestfs-actions.pod:5715 ../fish/guestfish-actions.pod:3844
15196 msgid "Remove the single file C<path>."
15200 #: ../src/guestfs-actions.pod:5721
15201 msgid "guestfs_rm_rf"
15205 #: ../src/guestfs-actions.pod:5723
15209 " guestfs_rm_rf (guestfs_h *g,\n"
15210 " const char *path);\n"
15215 #: ../src/guestfs-actions.pod:5727 ../fish/guestfish-actions.pod:3850
15217 "Remove the file or directory C<path>, recursively removing the contents if "
15218 "its a directory. This is like the C<rm -rf> shell command."
15222 #: ../src/guestfs-actions.pod:5735
15223 msgid "guestfs_rmdir"
15227 #: ../src/guestfs-actions.pod:5737
15231 " guestfs_rmdir (guestfs_h *g,\n"
15232 " const char *path);\n"
15237 #: ../src/guestfs-actions.pod:5741 ../fish/guestfish-actions.pod:3858
15238 msgid "Remove the single directory C<path>."
15242 #: ../src/guestfs-actions.pod:5747
15243 msgid "guestfs_rmmountpoint"
15247 #: ../src/guestfs-actions.pod:5749
15251 " guestfs_rmmountpoint (guestfs_h *g,\n"
15252 " const char *exemptpath);\n"
15257 #: ../src/guestfs-actions.pod:5753
15259 "This calls removes a mountpoint that was previously created with "
15260 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15264 #: ../src/guestfs-actions.pod:5761
15265 msgid "guestfs_scrub_device"
15269 #: ../src/guestfs-actions.pod:5763
15273 " guestfs_scrub_device (guestfs_h *g,\n"
15274 " const char *device);\n"
15279 #: ../src/guestfs-actions.pod:5767 ../fish/guestfish-actions.pod:3872
15281 "This command writes patterns over C<device> to make data retrieval more "
15286 #: ../src/guestfs-actions.pod:5770 ../src/guestfs-actions.pod:5791 ../src/guestfs-actions.pod:5810 ../fish/guestfish-actions.pod:3875 ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3903
15288 "It is an interface to the L<scrub(1)> program. See that manual page for "
15293 #: ../src/guestfs-actions.pod:5778 ../src/guestfs-actions.pod:5796 ../src/guestfs-actions.pod:5815
15294 msgid "(Added in 1.0.52)"
15298 #: ../src/guestfs-actions.pod:5780
15299 msgid "guestfs_scrub_file"
15303 #: ../src/guestfs-actions.pod:5782
15307 " guestfs_scrub_file (guestfs_h *g,\n"
15308 " const char *file);\n"
15313 #: ../src/guestfs-actions.pod:5786 ../fish/guestfish-actions.pod:3885
15315 "This command writes patterns over a file to make data retrieval more "
15320 #: ../src/guestfs-actions.pod:5789 ../fish/guestfish-actions.pod:3888
15321 msgid "The file is I<removed> after scrubbing."
15325 #: ../src/guestfs-actions.pod:5798
15326 msgid "guestfs_scrub_freespace"
15330 #: ../src/guestfs-actions.pod:5800
15334 " guestfs_scrub_freespace (guestfs_h *g,\n"
15335 " const char *dir);\n"
15340 #: ../src/guestfs-actions.pod:5804
15342 "This command creates the directory C<dir> and then fills it with files until "
15343 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15344 "and deletes them. The intention is to scrub any free space on the partition "
15345 "containing C<dir>."
15349 #: ../src/guestfs-actions.pod:5817
15350 msgid "guestfs_set_append"
15354 #: ../src/guestfs-actions.pod:5819
15358 " guestfs_set_append (guestfs_h *g,\n"
15359 " const char *append);\n"
15364 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3912
15366 "This function is used to add additional options to the guest kernel command "
15371 #: ../src/guestfs-actions.pod:5826 ../fish/guestfish-actions.pod:3915
15373 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15374 "environment variable."
15378 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3918
15380 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15381 "(libguestfs always adds a few of its own)."
15385 #: ../src/guestfs-actions.pod:5836
15386 msgid "guestfs_set_attach_method"
15390 #: ../src/guestfs-actions.pod:5838
15394 " guestfs_set_attach_method (guestfs_h *g,\n"
15395 " const char *attachmethod);\n"
15400 #: ../src/guestfs-actions.pod:5842 ../fish/guestfish-actions.pod:3927
15402 "Set the method that libguestfs uses to connect to the back end guestfsd "
15403 "daemon. Possible methods are:"
15407 #: ../src/guestfs-actions.pod:5849 ../fish/guestfish-actions.pod:3934
15409 "Launch an appliance and connect to it. This is the ordinary method and the "
15414 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3937
15415 msgid "C<unix:I<path>>"
15419 #: ../src/guestfs-actions.pod:5854 ../fish/guestfish-actions.pod:3939
15420 msgid "Connect to the Unix domain socket I<path>."
15424 #: ../src/guestfs-actions.pod:5856 ../fish/guestfish-actions.pod:3941
15426 "This method lets you connect to an existing daemon or (using virtio-serial) "
15427 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15428 "RUNNING DAEMONS>."
15432 #: ../src/guestfs-actions.pod:5864
15433 msgid "guestfs_set_autosync"
15437 #: ../src/guestfs-actions.pod:5866
15441 " guestfs_set_autosync (guestfs_h *g,\n"
15442 " int autosync);\n"
15447 #: ../src/guestfs-actions.pod:5870 ../fish/guestfish-actions.pod:3953
15449 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15450 "effort attempt to make filesystems consistent and synchronized when the "
15451 "handle is closed (also if the program exits without closing handles)."
15455 #: ../src/guestfs-actions.pod:5875 ../fish/guestfish-actions.pod:3958
15457 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15458 "disabled by default)."
15462 #: ../src/guestfs-actions.pod:5882
15463 msgid "guestfs_set_direct"
15467 #: ../src/guestfs-actions.pod:5884
15471 " guestfs_set_direct (guestfs_h *g,\n"
15477 #: ../src/guestfs-actions.pod:5888 ../fish/guestfish-actions.pod:3967
15479 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15480 "passed directly through to the appliance once it is launched."
15484 #: ../src/guestfs-actions.pod:5892
15486 "One consequence of this is that log messages aren't caught by the library "
15487 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15492 #: ../src/guestfs-actions.pod:5896 ../fish/guestfish-actions.pod:3975
15493 msgid "You probably don't want to use this unless you know what you are doing."
15497 #: ../src/guestfs-actions.pod:5899 ../fish/guestfish-actions.pod:3978
15498 msgid "The default is disabled."
15502 #: ../src/guestfs-actions.pod:5905
15503 msgid "guestfs_set_e2label"
15507 #: ../src/guestfs-actions.pod:5907
15511 " guestfs_set_e2label (guestfs_h *g,\n"
15512 " const char *device,\n"
15513 " const char *label);\n"
15518 #: ../src/guestfs-actions.pod:5912 ../fish/guestfish-actions.pod:3984
15520 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15521 "C<label>. Filesystem labels are limited to 16 characters."
15525 #: ../src/guestfs-actions.pod:5916
15527 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15528 "the existing label on a filesystem."
15532 #: ../src/guestfs-actions.pod:5923
15533 msgid "guestfs_set_e2uuid"
15537 #: ../src/guestfs-actions.pod:5925
15541 " guestfs_set_e2uuid (guestfs_h *g,\n"
15542 " const char *device,\n"
15543 " const char *uuid);\n"
15548 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3995
15550 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15551 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15552 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15556 #: ../src/guestfs-actions.pod:5935
15558 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15559 "the existing UUID of a filesystem."
15563 #: ../src/guestfs-actions.pod:5942
15564 msgid "guestfs_set_memsize"
15568 #: ../src/guestfs-actions.pod:5944
15572 " guestfs_set_memsize (guestfs_h *g,\n"
15578 #: ../src/guestfs-actions.pod:5948
15580 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15581 "This only has any effect if called before C<guestfs_launch>."
15585 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4013
15587 "You can also change this by setting the environment variable "
15588 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15592 #: ../src/guestfs-actions.pod:5963
15593 msgid "guestfs_set_network"
15597 #: ../src/guestfs-actions.pod:5965
15601 " guestfs_set_network (guestfs_h *g,\n"
15607 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4026
15609 "If C<network> is true, then the network is enabled in the libguestfs "
15610 "appliance. The default is false."
15614 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4029
15616 "This affects whether commands are able to access the network (see "
15617 "L<guestfs(3)/RUNNING COMMANDS>)."
15621 #: ../src/guestfs-actions.pod:5975
15623 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15628 #: ../src/guestfs-actions.pod:5982
15629 msgid "guestfs_set_path"
15633 #: ../src/guestfs-actions.pod:5984
15637 " guestfs_set_path (guestfs_h *g,\n"
15638 " const char *searchpath);\n"
15643 #: ../src/guestfs-actions.pod:5988 ../fish/guestfish-actions.pod:4041
15644 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15648 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4043
15650 "The default is C<$libdir/guestfs> unless overridden by setting "
15651 "C<LIBGUESTFS_PATH> environment variable."
15655 #: ../src/guestfs-actions.pod:5993 ../fish/guestfish-actions.pod:4046
15656 msgid "Setting C<path> to C<NULL> restores the default path."
15660 #: ../src/guestfs-actions.pod:5999
15661 msgid "guestfs_set_qemu"
15665 #: ../src/guestfs-actions.pod:6001
15669 " guestfs_set_qemu (guestfs_h *g,\n"
15670 " const char *qemu);\n"
15675 #: ../src/guestfs-actions.pod:6005 ../fish/guestfish-actions.pod:4054
15676 msgid "Set the qemu binary that we will use."
15680 #: ../src/guestfs-actions.pod:6007 ../fish/guestfish-actions.pod:4056
15681 msgid "The default is chosen when the library was compiled by the configure script."
15685 #: ../src/guestfs-actions.pod:6010 ../fish/guestfish-actions.pod:4059
15687 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15692 #: ../src/guestfs-actions.pod:6013 ../fish/guestfish-actions.pod:4062
15693 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15697 #: ../src/guestfs-actions.pod:6015 ../fish/guestfish-actions.pod:4064
15699 "Note that you should call this function as early as possible after creating "
15700 "the handle. This is because some pre-launch operations depend on testing "
15701 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15702 "don't retest features, and so you might see inconsistent results. Using the "
15703 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15704 "the qemu binary at the same time as the handle is created."
15708 #: ../src/guestfs-actions.pod:6027
15709 msgid "guestfs_set_recovery_proc"
15713 #: ../src/guestfs-actions.pod:6029
15717 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15718 " int recoveryproc);\n"
15723 #: ../src/guestfs-actions.pod:6033
15725 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15726 "not create a recovery process. The purpose of the recovery process is to "
15727 "stop runaway qemu processes in the case where the main program aborts "
15732 #: ../src/guestfs-actions.pod:6038
15734 "This only has any effect if called before C<guestfs_launch>, and the default "
15739 #: ../src/guestfs-actions.pod:6041 ../fish/guestfish-actions.pod:4086
15741 "About the only time when you would want to disable this is if the main "
15742 "process will fork itself into the background (\"daemonize\" itself). In "
15743 "this case the recovery process thinks that the main program has disappeared "
15744 "and so kills qemu, which is not very helpful."
15748 #: ../src/guestfs-actions.pod:6051
15749 msgid "guestfs_set_selinux"
15753 #: ../src/guestfs-actions.pod:6053
15757 " guestfs_set_selinux (guestfs_h *g,\n"
15763 #: ../src/guestfs-actions.pod:6057 ../fish/guestfish-actions.pod:4098
15765 "This sets the selinux flag that is passed to the appliance at boot time. "
15766 "The default is C<selinux=0> (disabled)."
15770 #: ../src/guestfs-actions.pod:6060 ../fish/guestfish-actions.pod:4101
15772 "Note that if SELinux is enabled, it is always in Permissive mode "
15773 "(C<enforcing=0>)."
15777 #: ../src/guestfs-actions.pod:6070
15778 msgid "guestfs_set_trace"
15782 #: ../src/guestfs-actions.pod:6072
15786 " guestfs_set_trace (guestfs_h *g,\n"
15792 #: ../src/guestfs-actions.pod:6076 ../fish/guestfish-actions.pod:4113
15794 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
15795 "return values are traced."
15799 #: ../src/guestfs-actions.pod:6079 ../fish/guestfish-actions.pod:4116
15801 "If you want to trace C API calls into libguestfs (and other libraries) then "
15802 "possibly a better way is to use the external ltrace(1) command."
15806 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4120
15808 "Command traces are disabled unless the environment variable "
15809 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
15813 #: ../src/guestfs-actions.pod:6086
15815 "Trace messages are normally sent to C<stderr>, unless you register a "
15816 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15820 #: ../src/guestfs-actions.pod:6094
15821 msgid "guestfs_set_verbose"
15825 #: ../src/guestfs-actions.pod:6096
15829 " guestfs_set_verbose (guestfs_h *g,\n"
15835 #: ../src/guestfs-actions.pod:6100 ../fish/guestfish-actions.pod:4133
15836 msgid "If C<verbose> is true, this turns on verbose messages."
15840 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4135
15842 "Verbose messages are disabled unless the environment variable "
15843 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
15847 #: ../src/guestfs-actions.pod:6105
15849 "Verbose messages are normally sent to C<stderr>, unless you register a "
15850 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15854 #: ../src/guestfs-actions.pod:6113
15855 msgid "guestfs_setcon"
15859 #: ../src/guestfs-actions.pod:6115
15863 " guestfs_setcon (guestfs_h *g,\n"
15864 " const char *context);\n"
15869 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4146
15871 "This sets the SELinux security context of the daemon to the string "
15876 #: ../src/guestfs-actions.pod:6122 ../fish/guestfish-actions.pod:4149
15877 msgid "See the documentation about SELINUX in L<guestfs(3)>."
15881 #: ../src/guestfs-actions.pod:6128
15882 msgid "guestfs_setxattr"
15886 #: ../src/guestfs-actions.pod:6130
15890 " guestfs_setxattr (guestfs_h *g,\n"
15891 " const char *xattr,\n"
15892 " const char *val,\n"
15894 " const char *path);\n"
15899 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4155
15901 "This call sets the extended attribute named C<xattr> of the file C<path> to "
15902 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
15906 #: ../src/guestfs-actions.pod:6141
15907 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
15911 #: ../src/guestfs-actions.pod:6147
15912 msgid "guestfs_sfdisk"
15916 #: ../src/guestfs-actions.pod:6149
15920 " guestfs_sfdisk (guestfs_h *g,\n"
15921 " const char *device,\n"
15925 " char *const *lines);\n"
15930 #: ../src/guestfs-actions.pod:6157 ../fish/guestfish-actions.pod:4165
15932 "This is a direct interface to the L<sfdisk(8)> program for creating "
15933 "partitions on block devices."
15937 #: ../src/guestfs-actions.pod:6160 ../fish/guestfish-actions.pod:4168
15938 msgid "C<device> should be a block device, for example C</dev/sda>."
15942 #: ../src/guestfs-actions.pod:6162 ../fish/guestfish-actions.pod:4170
15944 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
15945 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
15946 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
15947 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
15948 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
15949 "the kernel) cannot work out the right geometry and you will need to tell it."
15953 #: ../src/guestfs-actions.pod:6170 ../fish/guestfish-actions.pod:4178
15955 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
15956 "refer to the L<sfdisk(8)> manpage."
15960 #: ../src/guestfs-actions.pod:6173 ../fish/guestfish-actions.pod:4181
15962 "To create a single partition occupying the whole disk, you would pass "
15963 "C<lines> as a single element list, when the single element being the string "
15968 #: ../src/guestfs-actions.pod:6177
15969 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
15973 #: ../src/guestfs-actions.pod:6185 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6248 ../fish/guestfish-actions.pod:4191 ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4236
15974 msgid "This function is deprecated. In new code, use the C<part_add> call instead."
15978 #: ../src/guestfs-actions.pod:6194
15979 msgid "guestfs_sfdiskM"
15983 #: ../src/guestfs-actions.pod:6196
15987 " guestfs_sfdiskM (guestfs_h *g,\n"
15988 " const char *device,\n"
15989 " char *const *lines);\n"
15994 #: ../src/guestfs-actions.pod:6201
15996 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
15997 "partition sizes are specified in megabytes only (rounded to the nearest "
15998 "cylinder) and you don't need to specify the cyls, heads and sectors "
15999 "parameters which were rarely if ever used anyway."
16003 #: ../src/guestfs-actions.pod:6207
16005 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16006 "C<guestfs_part_disk>"
16010 #: ../src/guestfs-actions.pod:6224
16011 msgid "guestfs_sfdisk_N"
16015 #: ../src/guestfs-actions.pod:6226
16019 " guestfs_sfdisk_N (guestfs_h *g,\n"
16020 " const char *device,\n"
16025 " const char *line);\n"
16030 #: ../src/guestfs-actions.pod:6235 ../fish/guestfish-actions.pod:4225
16032 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16033 "(note: C<n> counts from 1)."
16037 #: ../src/guestfs-actions.pod:6238
16039 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16040 "for the cyls/heads/sectors parameters."
16044 #: ../src/guestfs-actions.pod:6241
16045 msgid "See also: C<guestfs_part_add>"
16049 #: ../src/guestfs-actions.pod:6257
16050 msgid "guestfs_sfdisk_disk_geometry"
16054 #: ../src/guestfs-actions.pod:6259
16058 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16059 " const char *device);\n"
16064 #: ../src/guestfs-actions.pod:6263
16066 "This displays the disk geometry of C<device> read from the partition table. "
16067 "Especially in the case where the underlying block device has been resized, "
16068 "this can be different from the kernel's idea of the geometry (see "
16069 "C<guestfs_sfdisk_kernel_geometry>)."
16073 #: ../src/guestfs-actions.pod:6268 ../src/guestfs-actions.pod:6284 ../fish/guestfish-actions.pod:4252 ../fish/guestfish-actions.pod:4261
16074 msgid "The result is in human-readable format, and not designed to be parsed."
16078 #: ../src/guestfs-actions.pod:6276
16079 msgid "guestfs_sfdisk_kernel_geometry"
16083 #: ../src/guestfs-actions.pod:6278
16087 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16088 " const char *device);\n"
16093 #: ../src/guestfs-actions.pod:6282 ../fish/guestfish-actions.pod:4259
16094 msgid "This displays the kernel's idea of the geometry of C<device>."
16098 #: ../src/guestfs-actions.pod:6292
16099 msgid "guestfs_sfdisk_l"
16103 #: ../src/guestfs-actions.pod:6294
16107 " guestfs_sfdisk_l (guestfs_h *g,\n"
16108 " const char *device);\n"
16113 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4268
16115 "This displays the partition table on C<device>, in the human-readable output "
16116 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16120 #: ../src/guestfs-actions.pod:6302
16121 msgid "See also: C<guestfs_part_list>"
16125 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4274
16127 "This function is deprecated. In new code, use the C<part_list> call "
16132 #: ../src/guestfs-actions.pod:6316
16137 #: ../src/guestfs-actions.pod:6318
16141 " guestfs_sh (guestfs_h *g,\n"
16142 " const char *command);\n"
16147 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4285
16149 "This call runs a command from the guest filesystem via the guest's "
16154 #: ../src/guestfs-actions.pod:6325
16155 msgid "This is like C<guestfs_command>, but passes the command to:"
16159 #: ../src/guestfs-actions.pod:6327 ../fish/guestfish-actions.pod:4290
16162 " /bin/sh -c \"command\"\n"
16167 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4292
16169 "Depending on the guest's shell, this usually results in wildcards being "
16170 "expanded, shell expressions being interpolated and so on."
16174 #: ../src/guestfs-actions.pod:6333
16175 msgid "All the provisos about C<guestfs_command> apply to this call."
16179 #: ../src/guestfs-actions.pod:6340
16180 msgid "guestfs_sh_lines"
16184 #: ../src/guestfs-actions.pod:6342
16188 " guestfs_sh_lines (guestfs_h *g,\n"
16189 " const char *command);\n"
16194 #: ../src/guestfs-actions.pod:6346
16196 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16201 #: ../src/guestfs-actions.pod:6349
16202 msgid "See also: C<guestfs_command_lines>"
16206 #: ../src/guestfs-actions.pod:6357
16207 msgid "guestfs_sleep"
16211 #: ../src/guestfs-actions.pod:6359
16215 " guestfs_sleep (guestfs_h *g,\n"
16221 #: ../src/guestfs-actions.pod:6363 ../fish/guestfish-actions.pod:4311
16222 msgid "Sleep for C<secs> seconds."
16226 #: ../src/guestfs-actions.pod:6367
16227 msgid "(Added in 1.0.41)"
16231 #: ../src/guestfs-actions.pod:6369 ../src/guestfs-structs.pod:109
16232 msgid "guestfs_stat"
16236 #: ../src/guestfs-actions.pod:6371
16239 " struct guestfs_stat *\n"
16240 " guestfs_stat (guestfs_h *g,\n"
16241 " const char *path);\n"
16246 #: ../src/guestfs-actions.pod:6377 ../fish/guestfish-actions.pod:4319
16247 msgid "This is the same as the C<stat(2)> system call."
16251 #: ../src/guestfs-actions.pod:6385 ../src/guestfs-structs.pod:135
16252 msgid "guestfs_statvfs"
16256 #: ../src/guestfs-actions.pod:6387
16259 " struct guestfs_statvfs *\n"
16260 " guestfs_statvfs (guestfs_h *g,\n"
16261 " const char *path);\n"
16266 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4325
16268 "Returns file system statistics for any mounted file system. C<path> should "
16269 "be a file or directory in the mounted file system (typically it is the mount "
16270 "point itself, but it doesn't need to be)."
16274 #: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4329
16275 msgid "This is the same as the C<statvfs(2)> system call."
16279 #: ../src/guestfs-actions.pod:6397
16281 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16282 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16286 #: ../src/guestfs-actions.pod:6403
16287 msgid "guestfs_strings"
16291 #: ../src/guestfs-actions.pod:6405
16295 " guestfs_strings (guestfs_h *g,\n"
16296 " const char *path);\n"
16301 #: ../src/guestfs-actions.pod:6409 ../fish/guestfish-actions.pod:4335
16303 "This runs the L<strings(1)> command on a file and returns the list of "
16304 "printable strings found."
16308 #: ../src/guestfs-actions.pod:6421
16309 msgid "guestfs_strings_e"
16313 #: ../src/guestfs-actions.pod:6423
16317 " guestfs_strings_e (guestfs_h *g,\n"
16318 " const char *encoding,\n"
16319 " const char *path);\n"
16324 #: ../src/guestfs-actions.pod:6428
16326 "This is like the C<guestfs_strings> command, but allows you to specify the "
16327 "encoding of strings that are looked for in the source file C<path>."
16331 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4349
16332 msgid "Allowed encodings are:"
16336 #: ../src/guestfs-actions.pod:6436 ../fish/guestfish-actions.pod:4353
16341 #: ../src/guestfs-actions.pod:6438
16343 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16344 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16348 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4358
16353 #: ../src/guestfs-actions.pod:6443 ../fish/guestfish-actions.pod:4360
16354 msgid "Single 8-bit-byte characters."
16358 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4362
16363 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4364
16364 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16368 #: ../src/guestfs-actions.pod:6450 ../fish/guestfish-actions.pod:4367
16369 msgid "l (lower case letter L)"
16373 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4369
16375 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16376 "examining binaries in Windows guests."
16380 #: ../src/guestfs-actions.pod:6455 ../fish/guestfish-actions.pod:4372
16385 #: ../src/guestfs-actions.pod:6457 ../fish/guestfish-actions.pod:4374
16386 msgid "32-bit big endian such as UCS-4BE."
16390 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4376
16395 #: ../src/guestfs-actions.pod:6461 ../fish/guestfish-actions.pod:4378
16396 msgid "32-bit little endian such as UCS-4LE."
16400 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4382
16401 msgid "The returned strings are transcoded to UTF-8."
16405 #: ../src/guestfs-actions.pod:6476
16406 msgid "guestfs_swapoff_device"
16410 #: ../src/guestfs-actions.pod:6478
16414 " guestfs_swapoff_device (guestfs_h *g,\n"
16415 " const char *device);\n"
16420 #: ../src/guestfs-actions.pod:6482
16422 "This command disables the libguestfs appliance swap device or partition "
16423 "named C<device>. See C<guestfs_swapon_device>."
16427 #: ../src/guestfs-actions.pod:6490
16428 msgid "guestfs_swapoff_file"
16432 #: ../src/guestfs-actions.pod:6492
16436 " guestfs_swapoff_file (guestfs_h *g,\n"
16437 " const char *file);\n"
16442 #: ../src/guestfs-actions.pod:6496 ../fish/guestfish-actions.pod:4399
16443 msgid "This command disables the libguestfs appliance swap on file."
16447 #: ../src/guestfs-actions.pod:6502
16448 msgid "guestfs_swapoff_label"
16452 #: ../src/guestfs-actions.pod:6504
16456 " guestfs_swapoff_label (guestfs_h *g,\n"
16457 " const char *label);\n"
16462 #: ../src/guestfs-actions.pod:6508 ../fish/guestfish-actions.pod:4405
16464 "This command disables the libguestfs appliance swap on labeled swap "
16469 #: ../src/guestfs-actions.pod:6515
16470 msgid "guestfs_swapoff_uuid"
16474 #: ../src/guestfs-actions.pod:6517
16478 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16479 " const char *uuid);\n"
16484 #: ../src/guestfs-actions.pod:6521 ../fish/guestfish-actions.pod:4412
16486 "This command disables the libguestfs appliance swap partition with the given "
16491 #: ../src/guestfs-actions.pod:6528
16492 msgid "guestfs_swapon_device"
16496 #: ../src/guestfs-actions.pod:6530
16500 " guestfs_swapon_device (guestfs_h *g,\n"
16501 " const char *device);\n"
16506 #: ../src/guestfs-actions.pod:6534
16508 "This command enables the libguestfs appliance to use the swap device or "
16509 "partition named C<device>. The increased memory is made available for all "
16510 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16514 #: ../src/guestfs-actions.pod:6539 ../fish/guestfish-actions.pod:4424
16516 "Note that you should not swap to existing guest swap partitions unless you "
16517 "know what you are doing. They may contain hibernation information, or other "
16518 "information that the guest doesn't want you to trash. You also risk leaking "
16519 "information about the host to the guest this way. Instead, attach a new "
16520 "host device to the guest and swap on that."
16524 #: ../src/guestfs-actions.pod:6550
16525 msgid "guestfs_swapon_file"
16529 #: ../src/guestfs-actions.pod:6552
16533 " guestfs_swapon_file (guestfs_h *g,\n"
16534 " const char *file);\n"
16539 #: ../src/guestfs-actions.pod:6556
16541 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16546 #: ../src/guestfs-actions.pod:6563
16547 msgid "guestfs_swapon_label"
16551 #: ../src/guestfs-actions.pod:6565
16555 " guestfs_swapon_label (guestfs_h *g,\n"
16556 " const char *label);\n"
16561 #: ../src/guestfs-actions.pod:6569
16563 "This command enables swap to a labeled swap partition. See "
16564 "C<guestfs_swapon_device> for other notes."
16568 #: ../src/guestfs-actions.pod:6576
16569 msgid "guestfs_swapon_uuid"
16573 #: ../src/guestfs-actions.pod:6578
16577 " guestfs_swapon_uuid (guestfs_h *g,\n"
16578 " const char *uuid);\n"
16583 #: ../src/guestfs-actions.pod:6582
16585 "This command enables swap to a swap partition with the given UUID. See "
16586 "C<guestfs_swapon_device> for other notes."
16590 #: ../src/guestfs-actions.pod:6589
16591 msgid "guestfs_sync"
16595 #: ../src/guestfs-actions.pod:6591
16599 " guestfs_sync (guestfs_h *g);\n"
16604 #: ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4456
16606 "This syncs the disk, so that any writes are flushed through to the "
16607 "underlying disk image."
16611 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4459
16613 "You should always call this if you have modified a disk image, before "
16614 "closing the handle."
16618 #: ../src/guestfs-actions.pod:6604
16619 msgid "guestfs_tail"
16623 #: ../src/guestfs-actions.pod:6606
16627 " guestfs_tail (guestfs_h *g,\n"
16628 " const char *path);\n"
16633 #: ../src/guestfs-actions.pod:6610 ../fish/guestfish-actions.pod:4466
16634 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16638 #: ../src/guestfs-actions.pod:6622
16639 msgid "guestfs_tail_n"
16643 #: ../src/guestfs-actions.pod:6624
16647 " guestfs_tail_n (guestfs_h *g,\n"
16649 " const char *path);\n"
16654 #: ../src/guestfs-actions.pod:6629 ../fish/guestfish-actions.pod:4476
16656 "If the parameter C<nrlines> is a positive number, this returns the last "
16657 "C<nrlines> lines of the file C<path>."
16661 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4479
16663 "If the parameter C<nrlines> is a negative number, this returns lines from "
16664 "the file C<path>, starting with the C<-nrlines>th line."
16668 #: ../src/guestfs-actions.pod:6646
16669 msgid "guestfs_tar_in"
16673 #: ../src/guestfs-actions.pod:6648
16677 " guestfs_tar_in (guestfs_h *g,\n"
16678 " const char *tarfile,\n"
16679 " const char *directory);\n"
16684 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4491
16686 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16687 "tar file) into C<directory>."
16691 #: ../src/guestfs-actions.pod:6656
16692 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16696 #: ../src/guestfs-actions.pod:6661 ../src/guestfs-actions.pod:6678 ../src/guestfs-actions.pod:6694 ../src/guestfs-actions.pod:6710
16697 msgid "(Added in 1.0.3)"
16701 #: ../src/guestfs-actions.pod:6663
16702 msgid "guestfs_tar_out"
16706 #: ../src/guestfs-actions.pod:6665
16710 " guestfs_tar_out (guestfs_h *g,\n"
16711 " const char *directory,\n"
16712 " const char *tarfile);\n"
16717 #: ../src/guestfs-actions.pod:6670 ../fish/guestfish-actions.pod:4503
16719 "This command packs the contents of C<directory> and downloads it to local "
16724 #: ../src/guestfs-actions.pod:6673
16726 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16727 "C<guestfs_txz_out>."
16731 #: ../src/guestfs-actions.pod:6680
16732 msgid "guestfs_tgz_in"
16736 #: ../src/guestfs-actions.pod:6682
16740 " guestfs_tgz_in (guestfs_h *g,\n"
16741 " const char *tarball,\n"
16742 " const char *directory);\n"
16747 #: ../src/guestfs-actions.pod:6687 ../fish/guestfish-actions.pod:4515
16749 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
16750 "tar file) into C<directory>."
16754 #: ../src/guestfs-actions.pod:6690
16755 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
16759 #: ../src/guestfs-actions.pod:6696
16760 msgid "guestfs_tgz_out"
16764 #: ../src/guestfs-actions.pod:6698
16768 " guestfs_tgz_out (guestfs_h *g,\n"
16769 " const char *directory,\n"
16770 " const char *tarball);\n"
16775 #: ../src/guestfs-actions.pod:6703 ../fish/guestfish-actions.pod:4526
16777 "This command packs the contents of C<directory> and downloads it to local "
16782 #: ../src/guestfs-actions.pod:6706
16783 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
16787 #: ../src/guestfs-actions.pod:6712
16788 msgid "guestfs_touch"
16792 #: ../src/guestfs-actions.pod:6714
16796 " guestfs_touch (guestfs_h *g,\n"
16797 " const char *path);\n"
16802 #: ../src/guestfs-actions.pod:6718 ../fish/guestfish-actions.pod:4537
16804 "Touch acts like the L<touch(1)> command. It can be used to update the "
16805 "timestamps on a file, or, if the file does not exist, to create a new "
16806 "zero-length file."
16810 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4541
16812 "This command only works on regular files, and will fail on other file types "
16813 "such as directories, symbolic links, block special etc."
16817 #: ../src/guestfs-actions.pod:6729
16818 msgid "guestfs_truncate"
16822 #: ../src/guestfs-actions.pod:6731
16826 " guestfs_truncate (guestfs_h *g,\n"
16827 " const char *path);\n"
16832 #: ../src/guestfs-actions.pod:6735 ../fish/guestfish-actions.pod:4548
16834 "This command truncates C<path> to a zero-length file. The file must exist "
16839 #: ../src/guestfs-actions.pod:6742
16840 msgid "guestfs_truncate_size"
16844 #: ../src/guestfs-actions.pod:6744
16848 " guestfs_truncate_size (guestfs_h *g,\n"
16849 " const char *path,\n"
16850 " int64_t size);\n"
16855 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4555
16857 "This command truncates C<path> to size C<size> bytes. The file must exist "
16862 #: ../src/guestfs-actions.pod:6752
16864 "If the current file size is less than C<size> then the file is extended to "
16865 "the required size with zero bytes. This creates a sparse file (ie. disk "
16866 "blocks are not allocated for the file until you write to it). To create a "
16867 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
16871 #: ../src/guestfs-actions.pod:6762
16872 msgid "guestfs_tune2fs_l"
16876 #: ../src/guestfs-actions.pod:6764
16880 " guestfs_tune2fs_l (guestfs_h *g,\n"
16881 " const char *device);\n"
16886 #: ../src/guestfs-actions.pod:6768 ../fish/guestfish-actions.pod:4568
16888 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
16893 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4571
16895 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
16896 "for more details. The list of fields returned isn't clearly defined, and "
16897 "depends on both the version of C<tune2fs> that libguestfs was built against, "
16898 "and the filesystem itself."
16902 #: ../src/guestfs-actions.pod:6784
16903 msgid "guestfs_txz_in"
16907 #: ../src/guestfs-actions.pod:6786
16911 " guestfs_txz_in (guestfs_h *g,\n"
16912 " const char *tarball,\n"
16913 " const char *directory);\n"
16918 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4580
16920 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
16921 "tar file) into C<directory>."
16925 #: ../src/guestfs-actions.pod:6798
16926 msgid "guestfs_txz_out"
16930 #: ../src/guestfs-actions.pod:6800
16934 " guestfs_txz_out (guestfs_h *g,\n"
16935 " const char *directory,\n"
16936 " const char *tarball);\n"
16941 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4589
16943 "This command packs the contents of C<directory> and downloads it to local "
16944 "file C<tarball> (as an xz compressed tar archive)."
16948 #: ../src/guestfs-actions.pod:6812
16949 msgid "guestfs_umask"
16953 #: ../src/guestfs-actions.pod:6814
16957 " guestfs_umask (guestfs_h *g,\n"
16963 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4598
16965 "This function sets the mask used for creating new files and device nodes to "
16970 #: ../src/guestfs-actions.pod:6821 ../fish/guestfish-actions.pod:4601
16972 "Typical umask values would be C<022> which creates new files with "
16973 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
16974 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
16978 #: ../src/guestfs-actions.pod:6826 ../fish/guestfish-actions.pod:4606
16980 "The default umask is C<022>. This is important because it means that "
16981 "directories and device nodes will be created with C<0644> or C<0755> mode "
16982 "even if you specify C<0777>."
16986 #: ../src/guestfs-actions.pod:6830
16988 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
16989 "C<guestfs_mkdir>."
16993 #: ../src/guestfs-actions.pod:6833 ../fish/guestfish-actions.pod:4613
16994 msgid "This call returns the previous umask."
16998 #: ../src/guestfs-actions.pod:6839
16999 msgid "guestfs_umount"
17003 #: ../src/guestfs-actions.pod:6841
17007 " guestfs_umount (guestfs_h *g,\n"
17008 " const char *pathordevice);\n"
17013 #: ../src/guestfs-actions.pod:6845 ../fish/guestfish-actions.pod:4621
17015 "This unmounts the given filesystem. The filesystem may be specified either "
17016 "by its mountpoint (path) or the device which contains the filesystem."
17020 #: ../src/guestfs-actions.pod:6853
17021 msgid "guestfs_umount_all"
17025 #: ../src/guestfs-actions.pod:6855
17029 " guestfs_umount_all (guestfs_h *g);\n"
17034 #: ../src/guestfs-actions.pod:6858 ../fish/guestfish-actions.pod:4631
17035 msgid "This unmounts all mounted filesystems."
17039 #: ../src/guestfs-actions.pod:6860 ../fish/guestfish-actions.pod:4633
17040 msgid "Some internal mounts are not unmounted by this call."
17044 #: ../src/guestfs-actions.pod:6866
17045 msgid "guestfs_upload"
17049 #: ../src/guestfs-actions.pod:6868
17053 " guestfs_upload (guestfs_h *g,\n"
17054 " const char *filename,\n"
17055 " const char *remotefilename);\n"
17060 #: ../src/guestfs-actions.pod:6873 ../src/guestfs-actions.pod:6897 ../fish/guestfish-actions.pod:4639 ../fish/guestfish-actions.pod:4652
17061 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17065 #: ../src/guestfs-actions.pod:6878
17066 msgid "See also C<guestfs_download>."
17070 #: ../src/guestfs-actions.pod:6889
17071 msgid "guestfs_upload_offset"
17075 #: ../src/guestfs-actions.pod:6891
17079 " guestfs_upload_offset (guestfs_h *g,\n"
17080 " const char *filename,\n"
17081 " const char *remotefilename,\n"
17082 " int64_t offset);\n"
17087 #: ../src/guestfs-actions.pod:6900 ../fish/guestfish-actions.pod:4655
17089 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17090 "The intention is to overwrite parts of existing files or devices, although "
17091 "if a non-existant file is specified then it is created with a \"hole\" "
17092 "before C<offset>. The size of the data written is implicit in the size of "
17093 "the source C<filename>."
17097 #: ../src/guestfs-actions.pod:6907
17099 "Note that there is no limit on the amount of data that can be uploaded with "
17100 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17101 "full amount unless an error occurs."
17105 #: ../src/guestfs-actions.pod:6912
17106 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17110 #: ../src/guestfs-actions.pod:6923
17111 msgid "guestfs_utimens"
17115 #: ../src/guestfs-actions.pod:6925
17119 " guestfs_utimens (guestfs_h *g,\n"
17120 " const char *path,\n"
17121 " int64_t atsecs,\n"
17122 " int64_t atnsecs,\n"
17123 " int64_t mtsecs,\n"
17124 " int64_t mtnsecs);\n"
17129 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4675
17130 msgid "This command sets the timestamps of a file with nanosecond precision."
17134 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4678
17136 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17141 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4681
17143 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17144 "nanoseconds from the epoch."
17148 #: ../src/guestfs-actions.pod:6942 ../fish/guestfish-actions.pod:4684
17150 "If the C<*nsecs> field contains the special value C<-1> then the "
17151 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17152 "ignored in this case)."
17156 #: ../src/guestfs-actions.pod:6946 ../fish/guestfish-actions.pod:4688
17158 "If the C<*nsecs> field contains the special value C<-2> then the "
17159 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17164 #: ../src/guestfs-actions.pod:6954 ../src/guestfs-structs.pod:175
17165 msgid "guestfs_version"
17169 #: ../src/guestfs-actions.pod:6956
17172 " struct guestfs_version *\n"
17173 " guestfs_version (guestfs_h *g);\n"
17178 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4696
17179 msgid "Return the libguestfs version number that the program is linked against."
17183 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4699
17185 "Note that because of dynamic linking this is not necessarily the version of "
17186 "libguestfs that you compiled against. You can compile the program, and then "
17187 "at runtime dynamically link against a completely different C<libguestfs.so> "
17192 #: ../src/guestfs-actions.pod:6967 ../fish/guestfish-actions.pod:4704
17194 "This call was added in version C<1.0.58>. In previous versions of "
17195 "libguestfs there was no way to get the version number. From C code you can "
17196 "use dynamic linker functions to find out if this symbol exists (if it "
17197 "doesn't, then it's an earlier version)."
17201 #: ../src/guestfs-actions.pod:6973 ../fish/guestfish-actions.pod:4710
17203 "The call returns a structure with four elements. The first three (C<major>, "
17204 "C<minor> and C<release>) are numbers and correspond to the usual version "
17205 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17206 "but may be used for distro-specific information."
17210 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4716
17211 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
17215 #: ../src/guestfs-actions.pod:6982 ../fish/guestfish-actions.pod:4719
17216 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17220 #: ../src/guestfs-actions.pod:6984
17222 "I<Note:> Don't use this call to test for availability of features. In "
17223 "enterprise distributions we backport features from later versions into "
17224 "earlier versions, making this an unreliable way to test for features. Use "
17225 "C<guestfs_available> instead."
17229 #: ../src/guestfs-actions.pod:6990
17231 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17232 "error. I<The caller must call C<guestfs_free_version> after use>."
17236 #: ../src/guestfs-actions.pod:6994
17237 msgid "(Added in 1.0.58)"
17241 #: ../src/guestfs-actions.pod:6996
17242 msgid "guestfs_vfs_label"
17246 #: ../src/guestfs-actions.pod:6998
17250 " guestfs_vfs_label (guestfs_h *g,\n"
17251 " const char *device);\n"
17256 #: ../src/guestfs-actions.pod:7002 ../fish/guestfish-actions.pod:4731
17257 msgid "This returns the filesystem label of the filesystem on C<device>."
17261 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4734
17262 msgid "If the filesystem is unlabeled, this returns the empty string."
17266 #: ../src/guestfs-actions.pod:7007
17267 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17271 #: ../src/guestfs-actions.pod:7012 ../src/guestfs-actions.pod:7049
17272 msgid "(Added in 1.3.18)"
17276 #: ../src/guestfs-actions.pod:7014
17277 msgid "guestfs_vfs_type"
17281 #: ../src/guestfs-actions.pod:7016
17285 " guestfs_vfs_type (guestfs_h *g,\n"
17286 " const char *device);\n"
17291 #: ../src/guestfs-actions.pod:7020 ../fish/guestfish-actions.pod:4742
17293 "This command gets the filesystem type corresponding to the filesystem on "
17298 #: ../src/guestfs-actions.pod:7023 ../fish/guestfish-actions.pod:4745
17300 "For most filesystems, the result is the name of the Linux VFS module which "
17301 "would be used to mount this filesystem if you mounted it without specifying "
17302 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17306 #: ../src/guestfs-actions.pod:7033
17307 msgid "guestfs_vfs_uuid"
17311 #: ../src/guestfs-actions.pod:7035
17315 " guestfs_vfs_uuid (guestfs_h *g,\n"
17316 " const char *device);\n"
17321 #: ../src/guestfs-actions.pod:7039 ../fish/guestfish-actions.pod:4754
17322 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17326 #: ../src/guestfs-actions.pod:7042 ../fish/guestfish-actions.pod:4757
17327 msgid "If the filesystem does not have a UUID, this returns the empty string."
17331 #: ../src/guestfs-actions.pod:7044
17332 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17336 #: ../src/guestfs-actions.pod:7051
17337 msgid "guestfs_vg_activate"
17341 #: ../src/guestfs-actions.pod:7053
17345 " guestfs_vg_activate (guestfs_h *g,\n"
17347 " char *const *volgroups);\n"
17352 #: ../src/guestfs-actions.pod:7058 ../fish/guestfish-actions.pod:4765
17354 "This command activates or (if C<activate> is false) deactivates all logical "
17355 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17356 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17357 "deactivated, then those devices disappear."
17361 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4771
17362 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17366 #: ../src/guestfs-actions.pod:7066 ../fish/guestfish-actions.pod:4773
17368 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17369 "activated or deactivated."
17373 #: ../src/guestfs-actions.pod:7073
17374 msgid "guestfs_vg_activate_all"
17378 #: ../src/guestfs-actions.pod:7075
17382 " guestfs_vg_activate_all (guestfs_h *g,\n"
17383 " int activate);\n"
17388 #: ../src/guestfs-actions.pod:7079 ../fish/guestfish-actions.pod:4780
17390 "This command activates or (if C<activate> is false) deactivates all logical "
17391 "volumes in all volume groups. If activated, then they are made known to the "
17392 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17393 "those devices disappear."
17397 #: ../src/guestfs-actions.pod:7085 ../fish/guestfish-actions.pod:4786
17398 msgid "This command is the same as running C<vgchange -a y|n>"
17402 #: ../src/guestfs-actions.pod:7091
17403 msgid "guestfs_vgcreate"
17407 #: ../src/guestfs-actions.pod:7093
17411 " guestfs_vgcreate (guestfs_h *g,\n"
17412 " const char *volgroup,\n"
17413 " char *const *physvols);\n"
17418 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4792
17420 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17421 "of physical volumes C<physvols>."
17425 #: ../src/guestfs-actions.pod:7105
17426 msgid "guestfs_vglvuuids"
17430 #: ../src/guestfs-actions.pod:7107
17434 " guestfs_vglvuuids (guestfs_h *g,\n"
17435 " const char *vgname);\n"
17440 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4799
17442 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17443 "volumes created in this volume group."
17447 #: ../src/guestfs-actions.pod:7114
17449 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17450 "associate logical volumes and volume groups."
17454 #: ../src/guestfs-actions.pod:7117
17455 msgid "See also C<guestfs_vgpvuuids>."
17459 #: ../src/guestfs-actions.pod:7125
17460 msgid "guestfs_vgpvuuids"
17464 #: ../src/guestfs-actions.pod:7127
17468 " guestfs_vgpvuuids (guestfs_h *g,\n"
17469 " const char *vgname);\n"
17474 #: ../src/guestfs-actions.pod:7131 ../fish/guestfish-actions.pod:4811
17476 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17477 "volumes that this volume group resides on."
17481 #: ../src/guestfs-actions.pod:7134
17483 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17484 "associate physical volumes and volume groups."
17488 #: ../src/guestfs-actions.pod:7137
17489 msgid "See also C<guestfs_vglvuuids>."
17493 #: ../src/guestfs-actions.pod:7145
17494 msgid "guestfs_vgremove"
17498 #: ../src/guestfs-actions.pod:7147
17502 " guestfs_vgremove (guestfs_h *g,\n"
17503 " const char *vgname);\n"
17508 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4823
17509 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17513 #: ../src/guestfs-actions.pod:7153 ../fish/guestfish-actions.pod:4825
17514 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17518 #: ../src/guestfs-actions.pod:7160
17519 msgid "guestfs_vgrename"
17523 #: ../src/guestfs-actions.pod:7162
17527 " guestfs_vgrename (guestfs_h *g,\n"
17528 " const char *volgroup,\n"
17529 " const char *newvolgroup);\n"
17534 #: ../src/guestfs-actions.pod:7167 ../fish/guestfish-actions.pod:4832
17535 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17539 #: ../src/guestfs-actions.pod:7173
17540 msgid "guestfs_vgs"
17544 #: ../src/guestfs-actions.pod:7175
17548 " guestfs_vgs (guestfs_h *g);\n"
17553 #: ../src/guestfs-actions.pod:7178 ../fish/guestfish-actions.pod:4838
17555 "List all the volumes groups detected. This is the equivalent of the "
17556 "L<vgs(8)> command."
17560 #: ../src/guestfs-actions.pod:7181 ../fish/guestfish-actions.pod:4841
17562 "This returns a list of just the volume group names that were detected "
17563 "(eg. C<VolGroup00>)."
17567 #: ../src/guestfs-actions.pod:7184
17568 msgid "See also C<guestfs_vgs_full>."
17572 #: ../src/guestfs-actions.pod:7192
17573 msgid "guestfs_vgs_full"
17577 #: ../src/guestfs-actions.pod:7194
17580 " struct guestfs_lvm_vg_list *\n"
17581 " guestfs_vgs_full (guestfs_h *g);\n"
17586 #: ../src/guestfs-actions.pod:7197 ../fish/guestfish-actions.pod:4850
17588 "List all the volumes groups detected. This is the equivalent of the "
17589 "L<vgs(8)> command. The \"full\" version includes all fields."
17593 #: ../src/guestfs-actions.pod:7200
17595 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17596 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17601 #: ../src/guestfs-actions.pod:7206
17602 msgid "guestfs_vgscan"
17606 #: ../src/guestfs-actions.pod:7208
17610 " guestfs_vgscan (guestfs_h *g);\n"
17615 #: ../src/guestfs-actions.pod:7211 ../fish/guestfish-actions.pod:4857
17617 "This rescans all block devices and rebuilds the list of LVM physical "
17618 "volumes, volume groups and logical volumes."
17622 #: ../src/guestfs-actions.pod:7218
17623 msgid "guestfs_vguuid"
17627 #: ../src/guestfs-actions.pod:7220
17631 " guestfs_vguuid (guestfs_h *g,\n"
17632 " const char *vgname);\n"
17637 #: ../src/guestfs-actions.pod:7224 ../fish/guestfish-actions.pod:4864
17638 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17642 #: ../src/guestfs-actions.pod:7231
17643 msgid "guestfs_wait_ready"
17647 #: ../src/guestfs-actions.pod:7233
17651 " guestfs_wait_ready (guestfs_h *g);\n"
17656 #: ../src/guestfs-actions.pod:7236
17657 msgid "This function is a no op."
17661 #: ../src/guestfs-actions.pod:7238
17663 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17664 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17665 "is no longer necessary because C<guestfs_launch> now does the waiting."
17669 #: ../src/guestfs-actions.pod:7243
17671 "If you see any calls to this function in code then you can just remove them, "
17672 "unless you want to retain compatibility with older versions of the API."
17676 #: ../src/guestfs-actions.pod:7249
17677 msgid "This function is deprecated. In new code, use the C<launch> call instead."
17681 #: ../src/guestfs-actions.pod:7258
17682 msgid "guestfs_wc_c"
17686 #: ../src/guestfs-actions.pod:7260
17690 " guestfs_wc_c (guestfs_h *g,\n"
17691 " const char *path);\n"
17696 #: ../src/guestfs-actions.pod:7264 ../fish/guestfish-actions.pod:4870
17698 "This command counts the characters in a file, using the C<wc -c> external "
17703 #: ../src/guestfs-actions.pod:7271
17704 msgid "guestfs_wc_l"
17708 #: ../src/guestfs-actions.pod:7273
17712 " guestfs_wc_l (guestfs_h *g,\n"
17713 " const char *path);\n"
17718 #: ../src/guestfs-actions.pod:7277 ../fish/guestfish-actions.pod:4877
17720 "This command counts the lines in a file, using the C<wc -l> external "
17725 #: ../src/guestfs-actions.pod:7284
17726 msgid "guestfs_wc_w"
17730 #: ../src/guestfs-actions.pod:7286
17734 " guestfs_wc_w (guestfs_h *g,\n"
17735 " const char *path);\n"
17740 #: ../src/guestfs-actions.pod:7290 ../fish/guestfish-actions.pod:4884
17742 "This command counts the words in a file, using the C<wc -w> external "
17747 #: ../src/guestfs-actions.pod:7297
17748 msgid "guestfs_write"
17752 #: ../src/guestfs-actions.pod:7299
17756 " guestfs_write (guestfs_h *g,\n"
17757 " const char *path,\n"
17758 " const char *content,\n"
17759 " size_t content_size);\n"
17764 #: ../src/guestfs-actions.pod:7305 ../fish/guestfish-actions.pod:4891
17766 "This call creates a file called C<path>. The content of the file is the "
17767 "string C<content> (which can contain any 8 bit data)."
17771 #: ../src/guestfs-actions.pod:7315
17772 msgid "guestfs_write_file"
17776 #: ../src/guestfs-actions.pod:7317
17780 " guestfs_write_file (guestfs_h *g,\n"
17781 " const char *path,\n"
17782 " const char *content,\n"
17788 #: ../src/guestfs-actions.pod:7323 ../fish/guestfish-actions.pod:4901
17790 "This call creates a file called C<path>. The contents of the file is the "
17791 "string C<content> (which can contain any 8 bit data), with length C<size>."
17795 #: ../src/guestfs-actions.pod:7327 ../fish/guestfish-actions.pod:4905
17797 "As a special case, if C<size> is C<0> then the length is calculated using "
17798 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
17802 #: ../src/guestfs-actions.pod:7331 ../fish/guestfish-actions.pod:4909
17804 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
17805 "I<not> work, even if the length is specified."
17809 #: ../src/guestfs-actions.pod:7339 ../fish/guestfish-actions.pod:4915
17810 msgid "This function is deprecated. In new code, use the C<write> call instead."
17814 #: ../src/guestfs-actions.pod:7348
17815 msgid "guestfs_zegrep"
17819 #: ../src/guestfs-actions.pod:7350
17823 " guestfs_zegrep (guestfs_h *g,\n"
17824 " const char *regex,\n"
17825 " const char *path);\n"
17830 #: ../src/guestfs-actions.pod:7355 ../fish/guestfish-actions.pod:4926
17831 msgid "This calls the external C<zegrep> program and returns the matching lines."
17835 #: ../src/guestfs-actions.pod:7367
17836 msgid "guestfs_zegrepi"
17840 #: ../src/guestfs-actions.pod:7369
17844 " guestfs_zegrepi (guestfs_h *g,\n"
17845 " const char *regex,\n"
17846 " const char *path);\n"
17851 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4936
17852 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
17856 #: ../src/guestfs-actions.pod:7386
17857 msgid "guestfs_zero"
17861 #: ../src/guestfs-actions.pod:7388
17865 " guestfs_zero (guestfs_h *g,\n"
17866 " const char *device);\n"
17871 #: ../src/guestfs-actions.pod:7392 ../fish/guestfish-actions.pod:4946
17872 msgid "This command writes zeroes over the first few blocks of C<device>."
17876 #: ../src/guestfs-actions.pod:7394 ../fish/guestfish-actions.pod:4948
17878 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
17879 "securely wipe the device). It should be sufficient to remove any partition "
17880 "tables, filesystem superblocks and so on."
17884 #: ../src/guestfs-actions.pod:7398
17886 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
17887 "C<guestfs_is_zero_device>"
17891 #: ../src/guestfs-actions.pod:7410
17892 msgid "guestfs_zero_device"
17896 #: ../src/guestfs-actions.pod:7412
17900 " guestfs_zero_device (guestfs_h *g,\n"
17901 " const char *device);\n"
17906 #: ../src/guestfs-actions.pod:7416
17908 "This command writes zeroes over the entire C<device>. Compare with "
17909 "C<guestfs_zero> which just zeroes the first few blocks of a device."
17913 #: ../src/guestfs-actions.pod:7430
17914 msgid "(Added in 1.3.1)"
17918 #: ../src/guestfs-actions.pod:7432
17919 msgid "guestfs_zerofree"
17923 #: ../src/guestfs-actions.pod:7434
17927 " guestfs_zerofree (guestfs_h *g,\n"
17928 " const char *device);\n"
17933 #: ../src/guestfs-actions.pod:7438 ../fish/guestfish-actions.pod:4970
17935 "This runs the I<zerofree> program on C<device>. This program claims to zero "
17936 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
17937 "possible to compress the filesystem more effectively."
17941 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:4975
17942 msgid "You should B<not> run this program if the filesystem is mounted."
17946 #: ../src/guestfs-actions.pod:7446 ../fish/guestfish-actions.pod:4978
17948 "It is possible that using this program can damage the filesystem or data on "
17953 #: ../src/guestfs-actions.pod:7453
17954 msgid "guestfs_zfgrep"
17958 #: ../src/guestfs-actions.pod:7455
17962 " guestfs_zfgrep (guestfs_h *g,\n"
17963 " const char *pattern,\n"
17964 " const char *path);\n"
17969 #: ../src/guestfs-actions.pod:7460 ../fish/guestfish-actions.pod:4985
17970 msgid "This calls the external C<zfgrep> program and returns the matching lines."
17974 #: ../src/guestfs-actions.pod:7472
17975 msgid "guestfs_zfgrepi"
17979 #: ../src/guestfs-actions.pod:7474
17983 " guestfs_zfgrepi (guestfs_h *g,\n"
17984 " const char *pattern,\n"
17985 " const char *path);\n"
17990 #: ../src/guestfs-actions.pod:7479 ../fish/guestfish-actions.pod:4995
17991 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
17995 #: ../src/guestfs-actions.pod:7491
17996 msgid "guestfs_zfile"
18000 #: ../src/guestfs-actions.pod:7493
18004 " guestfs_zfile (guestfs_h *g,\n"
18005 " const char *meth,\n"
18006 " const char *path);\n"
18011 #: ../src/guestfs-actions.pod:7498 ../fish/guestfish-actions.pod:5005
18012 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
18016 #: ../src/guestfs-actions.pod:7501 ../fish/guestfish-actions.pod:5008
18017 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18021 #: ../src/guestfs-actions.pod:7503
18023 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18028 #: ../src/guestfs-actions.pod:7509 ../fish/guestfish-actions.pod:5013
18029 msgid "This function is deprecated. In new code, use the C<file> call instead."
18033 #: ../src/guestfs-actions.pod:7518
18034 msgid "guestfs_zgrep"
18038 #: ../src/guestfs-actions.pod:7520
18042 " guestfs_zgrep (guestfs_h *g,\n"
18043 " const char *regex,\n"
18044 " const char *path);\n"
18049 #: ../src/guestfs-actions.pod:7525 ../fish/guestfish-actions.pod:5024
18050 msgid "This calls the external C<zgrep> program and returns the matching lines."
18054 #: ../src/guestfs-actions.pod:7537
18055 msgid "guestfs_zgrepi"
18059 #: ../src/guestfs-actions.pod:7539
18063 " guestfs_zgrepi (guestfs_h *g,\n"
18064 " const char *regex,\n"
18065 " const char *path);\n"
18070 #: ../src/guestfs-actions.pod:7544 ../fish/guestfish-actions.pod:5034
18071 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
18075 #: ../src/guestfs-availability.pod:3
18080 #: ../src/guestfs-availability.pod:5
18082 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
18083 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
18084 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
18085 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
18086 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
18090 #: ../src/guestfs-availability.pod:21
18095 #: ../src/guestfs-availability.pod:23
18097 "The following functions: L</guestfs_inotify_add_watch> "
18098 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
18099 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18103 #: ../src/guestfs-availability.pod:31
18104 msgid "B<linuxfsuuid>"
18108 #: ../src/guestfs-availability.pod:33
18110 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
18111 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18115 #: ../src/guestfs-availability.pod:40
18116 msgid "B<linuxmodules>"
18120 #: ../src/guestfs-availability.pod:42
18121 msgid "The following functions: L</guestfs_modprobe>"
18125 #: ../src/guestfs-availability.pod:45
18126 msgid "B<linuxxattrs>"
18130 #: ../src/guestfs-availability.pod:47
18132 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
18133 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
18134 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
18135 "L</guestfs_setxattr>"
18139 #: ../src/guestfs-availability.pod:58
18144 #: ../src/guestfs-availability.pod:60
18146 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
18147 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
18148 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18152 #: ../src/guestfs-availability.pod:69
18157 #: ../src/guestfs-availability.pod:71
18159 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
18160 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
18161 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
18162 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
18163 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
18164 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
18165 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
18166 "L</guestfs_vgs_full>"
18170 #: ../src/guestfs-availability.pod:94
18175 #: ../src/guestfs-availability.pod:96
18177 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
18178 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
18182 #: ../src/guestfs-availability.pod:102
18187 #: ../src/guestfs-availability.pod:104
18188 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18192 #: ../src/guestfs-availability.pod:107
18193 msgid "B<ntfsprogs>"
18197 #: ../src/guestfs-availability.pod:109
18198 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18202 #: ../src/guestfs-availability.pod:113
18203 msgid "B<realpath>"
18207 #: ../src/guestfs-availability.pod:115
18208 msgid "The following functions: L</guestfs_realpath>"
18212 #: ../src/guestfs-availability.pod:118
18217 #: ../src/guestfs-availability.pod:120
18219 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
18220 "L</guestfs_scrub_freespace>"
18224 #: ../src/guestfs-availability.pod:125
18229 #: ../src/guestfs-availability.pod:127
18230 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18234 #: ../src/guestfs-availability.pod:131
18239 #: ../src/guestfs-availability.pod:133
18240 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18244 #: ../src/guestfs-availability.pod:137
18245 msgid "B<zerofree>"
18249 #: ../src/guestfs-availability.pod:139
18250 msgid "The following functions: L</guestfs_zerofree>"
18254 #: ../src/guestfs-structs.pod:1
18255 msgid "guestfs_int_bool"
18259 #: ../src/guestfs-structs.pod:3
18262 " struct guestfs_int_bool {\n"
18270 #: ../src/guestfs-structs.pod:8
18273 " struct guestfs_int_bool_list {\n"
18274 " uint32_t len; /* Number of elements in list. */\n"
18275 " struct guestfs_int_bool *val; /* Elements. */\n"
18281 #: ../src/guestfs-structs.pod:13
18284 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18285 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18290 #: ../src/guestfs-structs.pod:16
18291 msgid "guestfs_lvm_pv"
18295 #: ../src/guestfs-structs.pod:18
18298 " struct guestfs_lvm_pv {\n"
18299 " char *pv_name;\n"
18300 " /* The next field is NOT nul-terminated, be careful when printing it: "
18302 " char pv_uuid[32];\n"
18304 " uint64_t pv_size;\n"
18305 " uint64_t dev_size;\n"
18306 " uint64_t pv_free;\n"
18307 " uint64_t pv_used;\n"
18308 " char *pv_attr;\n"
18309 " int64_t pv_pe_count;\n"
18310 " int64_t pv_pe_alloc_count;\n"
18311 " char *pv_tags;\n"
18312 " uint64_t pe_start;\n"
18313 " int64_t pv_mda_count;\n"
18314 " uint64_t pv_mda_free;\n"
18320 #: ../src/guestfs-structs.pod:36
18323 " struct guestfs_lvm_pv_list {\n"
18324 " uint32_t len; /* Number of elements in list. */\n"
18325 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18331 #: ../src/guestfs-structs.pod:41
18334 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18335 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18340 #: ../src/guestfs-structs.pod:44
18341 msgid "guestfs_lvm_vg"
18345 #: ../src/guestfs-structs.pod:46
18348 " struct guestfs_lvm_vg {\n"
18349 " char *vg_name;\n"
18350 " /* The next field is NOT nul-terminated, be careful when printing it: "
18352 " char vg_uuid[32];\n"
18354 " char *vg_attr;\n"
18355 " uint64_t vg_size;\n"
18356 " uint64_t vg_free;\n"
18357 " char *vg_sysid;\n"
18358 " uint64_t vg_extent_size;\n"
18359 " int64_t vg_extent_count;\n"
18360 " int64_t vg_free_count;\n"
18361 " int64_t max_lv;\n"
18362 " int64_t max_pv;\n"
18363 " int64_t pv_count;\n"
18364 " int64_t lv_count;\n"
18365 " int64_t snap_count;\n"
18366 " int64_t vg_seqno;\n"
18367 " char *vg_tags;\n"
18368 " int64_t vg_mda_count;\n"
18369 " uint64_t vg_mda_free;\n"
18375 #: ../src/guestfs-structs.pod:69
18378 " struct guestfs_lvm_vg_list {\n"
18379 " uint32_t len; /* Number of elements in list. */\n"
18380 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18386 #: ../src/guestfs-structs.pod:74
18389 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18390 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18395 #: ../src/guestfs-structs.pod:77
18396 msgid "guestfs_lvm_lv"
18400 #: ../src/guestfs-structs.pod:79
18403 " struct guestfs_lvm_lv {\n"
18404 " char *lv_name;\n"
18405 " /* The next field is NOT nul-terminated, be careful when printing it: "
18407 " char lv_uuid[32];\n"
18408 " char *lv_attr;\n"
18409 " int64_t lv_major;\n"
18410 " int64_t lv_minor;\n"
18411 " int64_t lv_kernel_major;\n"
18412 " int64_t lv_kernel_minor;\n"
18413 " uint64_t lv_size;\n"
18414 " int64_t seg_count;\n"
18416 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18417 " float snap_percent;\n"
18418 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18419 " float copy_percent;\n"
18420 " char *move_pv;\n"
18421 " char *lv_tags;\n"
18422 " char *mirror_log;\n"
18423 " char *modules;\n"
18429 #: ../src/guestfs-structs.pod:101
18432 " struct guestfs_lvm_lv_list {\n"
18433 " uint32_t len; /* Number of elements in list. */\n"
18434 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18440 #: ../src/guestfs-structs.pod:106
18443 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18444 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18449 #: ../src/guestfs-structs.pod:111
18452 " struct guestfs_stat {\n"
18456 " int64_t nlink;\n"
18461 " int64_t blksize;\n"
18462 " int64_t blocks;\n"
18463 " int64_t atime;\n"
18464 " int64_t mtime;\n"
18465 " int64_t ctime;\n"
18471 #: ../src/guestfs-structs.pod:127
18474 " struct guestfs_stat_list {\n"
18475 " uint32_t len; /* Number of elements in list. */\n"
18476 " struct guestfs_stat *val; /* Elements. */\n"
18482 #: ../src/guestfs-structs.pod:132
18485 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18486 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18491 #: ../src/guestfs-structs.pod:137
18494 " struct guestfs_statvfs {\n"
18495 " int64_t bsize;\n"
18496 " int64_t frsize;\n"
18497 " int64_t blocks;\n"
18498 " int64_t bfree;\n"
18499 " int64_t bavail;\n"
18500 " int64_t files;\n"
18501 " int64_t ffree;\n"
18502 " int64_t favail;\n"
18505 " int64_t namemax;\n"
18511 #: ../src/guestfs-structs.pod:151
18514 " struct guestfs_statvfs_list {\n"
18515 " uint32_t len; /* Number of elements in list. */\n"
18516 " struct guestfs_statvfs *val; /* Elements. */\n"
18522 #: ../src/guestfs-structs.pod:156
18525 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18526 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18531 #: ../src/guestfs-structs.pod:159
18532 msgid "guestfs_dirent"
18536 #: ../src/guestfs-structs.pod:161
18539 " struct guestfs_dirent {\n"
18548 #: ../src/guestfs-structs.pod:167
18551 " struct guestfs_dirent_list {\n"
18552 " uint32_t len; /* Number of elements in list. */\n"
18553 " struct guestfs_dirent *val; /* Elements. */\n"
18559 #: ../src/guestfs-structs.pod:172
18562 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18563 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18568 #: ../src/guestfs-structs.pod:177
18571 " struct guestfs_version {\n"
18572 " int64_t major;\n"
18573 " int64_t minor;\n"
18574 " int64_t release;\n"
18581 #: ../src/guestfs-structs.pod:184
18584 " struct guestfs_version_list {\n"
18585 " uint32_t len; /* Number of elements in list. */\n"
18586 " struct guestfs_version *val; /* Elements. */\n"
18592 #: ../src/guestfs-structs.pod:189
18595 " void guestfs_free_version (struct guestfs_free_version *);\n"
18596 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18601 #: ../src/guestfs-structs.pod:192
18602 msgid "guestfs_xattr"
18606 #: ../src/guestfs-structs.pod:194
18609 " struct guestfs_xattr {\n"
18610 " char *attrname;\n"
18611 " /* The next two fields describe a byte array. */\n"
18612 " uint32_t attrval_len;\n"
18613 " char *attrval;\n"
18619 #: ../src/guestfs-structs.pod:201
18622 " struct guestfs_xattr_list {\n"
18623 " uint32_t len; /* Number of elements in list. */\n"
18624 " struct guestfs_xattr *val; /* Elements. */\n"
18630 #: ../src/guestfs-structs.pod:206
18633 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18634 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18639 #: ../src/guestfs-structs.pod:209
18640 msgid "guestfs_inotify_event"
18644 #: ../src/guestfs-structs.pod:211
18647 " struct guestfs_inotify_event {\n"
18648 " int64_t in_wd;\n"
18649 " uint32_t in_mask;\n"
18650 " uint32_t in_cookie;\n"
18651 " char *in_name;\n"
18657 #: ../src/guestfs-structs.pod:218
18660 " struct guestfs_inotify_event_list {\n"
18661 " uint32_t len; /* Number of elements in list. */\n"
18662 " struct guestfs_inotify_event *val; /* Elements. */\n"
18668 #: ../src/guestfs-structs.pod:223
18671 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18672 " void guestfs_free_inotify_event_list (struct "
18673 "guestfs_free_inotify_event_list *);\n"
18678 #: ../src/guestfs-structs.pod:226
18679 msgid "guestfs_partition"
18683 #: ../src/guestfs-structs.pod:228
18686 " struct guestfs_partition {\n"
18687 " int32_t part_num;\n"
18688 " uint64_t part_start;\n"
18689 " uint64_t part_end;\n"
18690 " uint64_t part_size;\n"
18696 #: ../src/guestfs-structs.pod:235
18699 " struct guestfs_partition_list {\n"
18700 " uint32_t len; /* Number of elements in list. */\n"
18701 " struct guestfs_partition *val; /* Elements. */\n"
18707 #: ../src/guestfs-structs.pod:240
18710 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18711 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18716 #: ../src/guestfs-structs.pod:243
18717 msgid "guestfs_application"
18721 #: ../src/guestfs-structs.pod:245
18724 " struct guestfs_application {\n"
18725 " char *app_name;\n"
18726 " char *app_display_name;\n"
18727 " int32_t app_epoch;\n"
18728 " char *app_version;\n"
18729 " char *app_release;\n"
18730 " char *app_install_path;\n"
18731 " char *app_trans_path;\n"
18732 " char *app_publisher;\n"
18733 " char *app_url;\n"
18734 " char *app_source_package;\n"
18735 " char *app_summary;\n"
18736 " char *app_description;\n"
18742 #: ../src/guestfs-structs.pod:260
18745 " struct guestfs_application_list {\n"
18746 " uint32_t len; /* Number of elements in list. */\n"
18747 " struct guestfs_application *val; /* Elements. */\n"
18753 #: ../src/guestfs-structs.pod:265
18756 " void guestfs_free_application (struct guestfs_free_application *);\n"
18757 " void guestfs_free_application_list (struct guestfs_free_application_list "
18763 #: ../fish/guestfish.pod:5
18764 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18768 #: ../fish/guestfish.pod:9
18771 " guestfish [--options] [commands]\n"
18776 #: ../fish/guestfish.pod:11
18784 #: ../fish/guestfish.pod:13
18787 " guestfish [--ro|--rw] -a disk.img\n"
18792 #: ../fish/guestfish.pod:15
18795 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18800 #: ../fish/guestfish.pod:17
18803 " guestfish -d libvirt-domain\n"
18808 #: ../fish/guestfish.pod:19
18811 " guestfish [--ro|--rw] -a disk.img -i\n"
18816 #: ../fish/guestfish.pod:21
18819 " guestfish -d libvirt-domain -i\n"
18824 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
18829 #: ../fish/guestfish.pod:25
18831 "Using guestfish in read/write mode on live virtual machines can be "
18832 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18833 "option to use guestfish safely if the disk image or virtual machine might be "
18838 #: ../fish/guestfish.pod:32
18840 "Guestfish is a shell and command-line tool for examining and modifying "
18841 "virtual machine filesystems. It uses libguestfs and exposes all of the "
18842 "functionality of the guestfs API, see L<guestfs(3)>."
18846 #: ../fish/guestfish.pod:36
18848 "Guestfish gives you structured access to the libguestfs API, from shell "
18849 "scripts or the command line or interactively. If you want to rescue a "
18850 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
18855 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949 ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
18860 #: ../fish/guestfish.pod:43
18861 msgid "As an interactive shell"
18865 #: ../fish/guestfish.pod:45
18873 #: ../fish/guestfish.pod:47
18876 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
18877 " editing virtual machine filesystems.\n"
18882 #: ../fish/guestfish.pod:50
18885 " Type: 'help' for a list of commands\n"
18886 " 'man' to read the manual\n"
18887 " 'quit' to quit the shell\n"
18892 #: ../fish/guestfish.pod:54
18895 " ><fs> add-ro disk.img\n"
18897 " ><fs> list-filesystems\n"
18898 " /dev/sda1: ext4\n"
18899 " /dev/vg_guest/lv_root: ext4\n"
18900 " /dev/vg_guest/lv_swap: swap\n"
18901 " ><fs> mount /dev/vg_guest/lv_root /\n"
18902 " ><fs> cat /etc/fstab\n"
18904 " # Created by anaconda\n"
18911 #: ../fish/guestfish.pod:67
18912 msgid "From shell scripts"
18916 #: ../fish/guestfish.pod:69
18917 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18921 #: ../fish/guestfish.pod:71
18924 " guestfish <<_EOF_\n"
18927 " mount /dev/vg_guest/lv_root /\n"
18928 " write /etc/motd \"Welcome, new users\"\n"
18934 #: ../fish/guestfish.pod:78
18935 msgid "List the LVM logical volumes in a disk image:"
18939 #: ../fish/guestfish.pod:80
18942 " guestfish -a disk.img --ro <<_EOF_\n"
18950 #: ../fish/guestfish.pod:85
18951 msgid "List all the filesystems in a disk image:"
18955 #: ../fish/guestfish.pod:87
18958 " guestfish -a disk.img --ro <<_EOF_\n"
18960 " list-filesystems\n"
18966 #: ../fish/guestfish.pod:92
18967 msgid "On one command line"
18971 #: ../fish/guestfish.pod:94
18972 msgid "Update C</etc/resolv.conf> in a guest:"
18976 #: ../fish/guestfish.pod:96
18980 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
18981 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
18986 #: ../fish/guestfish.pod:100
18987 msgid "Edit C</boot/grub/grub.conf> interactively:"
18991 #: ../fish/guestfish.pod:102
18994 " guestfish --rw --add disk.img \\\n"
18995 " --mount /dev/vg_guest/lv_root \\\n"
18996 " --mount /dev/sda1:/boot \\\n"
18997 " edit /boot/grub/grub.conf\n"
19002 #: ../fish/guestfish.pod:107
19003 msgid "Mount disks automatically"
19007 #: ../fish/guestfish.pod:109
19009 "Use the I<-i> option to automatically mount the disks from a virtual "
19014 #: ../fish/guestfish.pod:112
19017 " guestfish --ro -a disk.img -i cat /etc/group\n"
19022 #: ../fish/guestfish.pod:114
19025 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19030 #: ../fish/guestfish.pod:116
19031 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19035 #: ../fish/guestfish.pod:118
19038 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19043 #: ../fish/guestfish.pod:120
19044 msgid "As a script interpreter"
19048 #: ../fish/guestfish.pod:122
19049 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19053 #: ../fish/guestfish.pod:124
19056 " #!/usr/bin/guestfish -f\n"
19057 " sparse test1.img 100M\n"
19059 " part-disk /dev/sda mbr\n"
19060 " mkfs ext2 /dev/sda1\n"
19065 #: ../fish/guestfish.pod:130
19066 msgid "Start with a prepared disk"
19070 #: ../fish/guestfish.pod:132
19072 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19073 "single ext2-formatted partition:"
19077 #: ../fish/guestfish.pod:135
19080 " guestfish -N fs\n"
19085 #: ../fish/guestfish.pod:137
19086 msgid "To list what is available do:"
19090 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
19093 " guestfish -N help | less\n"
19098 #: ../fish/guestfish.pod:141
19099 msgid "Remote control"
19103 #: ../fish/guestfish.pod:143
19106 " eval \"`guestfish --listen`\"\n"
19107 " guestfish --remote add-ro disk.img\n"
19108 " guestfish --remote run\n"
19109 " guestfish --remote lvs\n"
19114 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
19119 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143 ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19124 #: ../fish/guestfish.pod:154
19125 msgid "Displays general help on options."
19129 #: ../fish/guestfish.pod:156
19134 #: ../fish/guestfish.pod:158
19135 msgid "B<--cmd-help>"
19139 #: ../fish/guestfish.pod:160
19140 msgid "Lists all available guestfish commands."
19144 #: ../fish/guestfish.pod:162
19149 #: ../fish/guestfish.pod:164
19150 msgid "B<--cmd-help cmd>"
19154 #: ../fish/guestfish.pod:166
19155 msgid "Displays detailed help on a single command C<cmd>."
19159 #: ../fish/guestfish.pod:168
19160 msgid "B<-a image>"
19164 #: ../fish/guestfish.pod:170
19165 msgid "B<--add image>"
19169 #: ../fish/guestfish.pod:172
19170 msgid "Add a block device or virtual machine image to the shell."
19174 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19176 "The format of the disk image is auto-detected. To override this and force a "
19177 "particular format use the I<--format=..> option."
19181 #: ../fish/guestfish.pod:177
19183 "Using this flag is mostly equivalent to using the C<add> command, with "
19184 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19185 "the I<--format=...> flag was given."
19189 #: ../fish/guestfish.pod:181
19194 #: ../fish/guestfish.pod:183
19195 msgid "B<--connect URI>"
19199 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19201 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19202 "URI to use. The default is to use the default libvirt connection."
19206 #: ../fish/guestfish.pod:189
19211 #: ../fish/guestfish.pod:191
19213 "If using the I<--listen> option and a csh-like shell, use this option. See "
19214 "section L</REMOTE CONTROL AND CSH> below."
19218 #: ../fish/guestfish.pod:194
19219 msgid "B<-d libvirt-domain>"
19223 #: ../fish/guestfish.pod:196
19224 msgid "B<--domain libvirt-domain>"
19228 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19230 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19231 "used, then any libvirt domain can be used. However in write mode, only "
19232 "libvirt domains which are shut down can be named here."
19236 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
19237 msgid "Domain UUIDs can be used instead of names."
19241 #: ../fish/guestfish.pod:204
19243 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19244 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19245 "if the I<--format:...> flag was given."
19249 #: ../fish/guestfish.pod:208
19254 #: ../fish/guestfish.pod:210
19255 msgid "B<--no-dest-paths>"
19259 #: ../fish/guestfish.pod:212
19261 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19262 "to hit the tab key to complete paths on the guest filesystem, but this "
19263 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19264 "allow this feature to be disabled."
19268 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19269 msgid "B<--echo-keys>"
19273 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
19275 "When prompting for keys and passphrases, guestfish normally turns echoing "
19276 "off so you cannot see what you are typing. If you are not worried about "
19277 "Tempest attacks and there is no one else in the room you can specify this "
19278 "flag to see what you are typing."
19282 #: ../fish/guestfish.pod:224
19287 #: ../fish/guestfish.pod:226
19288 msgid "B<--file file>"
19292 #: ../fish/guestfish.pod:228
19293 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19297 #: ../fish/guestfish.pod:231
19300 " #!/usr/bin/guestfish -f\n"
19305 #: ../fish/guestfish.pod:233
19306 msgid "B<--format=raw|qcow2|..>"
19310 #: ../fish/guestfish.pod:235
19311 msgid "B<--format>"
19315 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
19317 "The default for the I<-a> option is to auto-detect the format of the disk "
19318 "image. Using this forces the disk format for I<-a> options which follow on "
19319 "the command line. Using I<--format> with no argument switches back to "
19320 "auto-detection for subsequent I<-a> options."
19324 #: ../fish/guestfish.pod:244
19327 " guestfish --format=raw -a disk.img\n"
19332 #: ../fish/guestfish.pod:246
19333 msgid "forces raw format (no auto-detection) for C<disk.img>."
19337 #: ../fish/guestfish.pod:248
19340 " guestfish --format=raw -a disk.img --format -a another.img\n"
19345 #: ../fish/guestfish.pod:250
19347 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19348 "auto-detection for C<another.img>."
19352 #: ../fish/guestfish.pod:253
19354 "If you have untrusted raw-format guest disk images, you should use this "
19355 "option to specify the disk format. This avoids a possible security problem "
19356 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19360 #: ../fish/guestfish.pod:258
19365 #: ../fish/guestfish.pod:260
19366 msgid "B<--inspector>"
19370 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
19372 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19373 "system and mount filesystems as they would be mounted on the real virtual "
19378 #: ../fish/guestfish.pod:266
19379 msgid "Typical usage is either:"
19383 #: ../fish/guestfish.pod:268
19386 " guestfish -d myguest -i\n"
19391 #: ../fish/guestfish.pod:270
19392 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19396 #: ../fish/guestfish.pod:272
19399 " guestfish --ro -d myguest -i\n"
19404 #: ../fish/guestfish.pod:274
19405 msgid "(for active domains, readonly), or specify the block device directly:"
19409 #: ../fish/guestfish.pod:276
19412 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19417 #: ../fish/guestfish.pod:278
19419 "Note that the command line syntax changed slightly over older versions of "
19420 "guestfish. You can still use the old syntax:"
19424 #: ../fish/guestfish.pod:281
19427 " guestfish [--ro] -i disk.img\n"
19432 #: ../fish/guestfish.pod:283
19435 " guestfish [--ro] -i libvirt-domain\n"
19440 #: ../fish/guestfish.pod:285
19442 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19443 "then using other commands to mount the filesystems that were found."
19447 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
19448 msgid "B<--keys-from-stdin>"
19452 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
19454 "Read key or passphrase parameters from stdin. The default is to try to read "
19455 "passphrases from the user by opening C</dev/tty>."
19459 #: ../fish/guestfish.pod:294
19460 msgid "B<--listen>"
19464 #: ../fish/guestfish.pod:296
19466 "Fork into the background and listen for remote commands. See section "
19467 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19471 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
19476 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
19478 "Connect to a live virtual machine. (Experimental, see "
19479 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19483 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
19484 msgid "B<-m dev[:mountpoint[:options]]>"
19488 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
19489 msgid "B<--mount dev[:mountpoint[:options]]>"
19493 #: ../fish/guestfish.pod:308
19494 msgid "Mount the named partition or logical volume on the given mountpoint."
19498 #: ../fish/guestfish.pod:310
19499 msgid "If the mountpoint is omitted, it defaults to C</>."
19503 #: ../fish/guestfish.pod:312
19504 msgid "You have to mount something on C</> before most commands will work."
19508 #: ../fish/guestfish.pod:314
19510 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19515 #: ../fish/guestfish.pod:317
19517 "If you don't know what filesystems a disk image contains, you can either run "
19518 "guestfish without this option, then list the partitions, filesystems and LVs "
19519 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19520 "commands), or you can use the L<virt-filesystems(1)> program."
19524 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
19526 "The third (and rarely used) part of the mount parameter is the list of mount "
19527 "options used to mount the underlying filesystem. If this is not given, then "
19528 "the mount options are either the empty string or C<ro> (the latter if the "
19529 "I<--ro> flag is used). By specifying the mount options, you override this "
19530 "default choice. Probably the only time you would use this is to enable ACLs "
19531 "and/or extended attributes if the filesystem can support them:"
19535 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
19538 " -m /dev/sda1:/:acl,user_xattr\n"
19543 #: ../fish/guestfish.pod:333
19544 msgid "Using this flag is equivalent to using the C<mount-options> command."
19548 #: ../fish/guestfish.pod:335
19553 #: ../fish/guestfish.pod:337
19554 msgid "B<--no-sync>"
19558 #: ../fish/guestfish.pod:339
19560 "Disable autosync. This is enabled by default. See the discussion of "
19561 "autosync in the L<guestfs(3)> manpage."
19565 #: ../fish/guestfish.pod:342
19570 #: ../fish/guestfish.pod:344
19571 msgid "B<--new type>"
19575 #: ../fish/guestfish.pod:346
19580 #: ../fish/guestfish.pod:348
19582 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19583 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19584 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19589 #: ../fish/guestfish.pod:353
19590 msgid "B<--progress-bars>"
19594 #: ../fish/guestfish.pod:355
19595 msgid "Enable progress bars, even when guestfish is used non-interactively."
19599 #: ../fish/guestfish.pod:357
19601 "Progress bars are enabled by default when guestfish is used as an "
19602 "interactive shell."
19606 #: ../fish/guestfish.pod:360
19607 msgid "B<--no-progress-bars>"
19611 #: ../fish/guestfish.pod:362
19612 msgid "Disable progress bars."
19616 #: ../fish/guestfish.pod:364
19617 msgid "B<--remote[=pid]>"
19621 #: ../fish/guestfish.pod:366
19623 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19624 "CONTROL GUESTFISH OVER A SOCKET> below."
19628 #: ../fish/guestfish.pod:369
19633 #: ../fish/guestfish.pod:371
19638 #: ../fish/guestfish.pod:373
19640 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19641 "mounts are done read-only."
19645 #: ../fish/guestfish.pod:376
19647 "The option must always be used if the disk image or virtual machine might be "
19648 "running, and is generally recommended in cases where you don't need write "
19649 "access to the disk."
19653 #: ../fish/guestfish.pod:380
19655 "Note that prepared disk images created with I<-N> are not affected by this "
19656 "option. Also commands like C<add> are not affected - you have to specify "
19657 "the C<readonly:true> option explicitly if you need it."
19661 #: ../fish/guestfish.pod:384
19662 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19666 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
19667 msgid "B<--selinux>"
19671 #: ../fish/guestfish.pod:388
19672 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19676 #: ../fish/guestfish.pod:390
19681 #: ../fish/guestfish.pod:392
19682 msgid "B<--verbose>"
19686 #: ../fish/guestfish.pod:394
19688 "Enable very verbose messages. This is particularly useful if you find a "
19693 #: ../fish/guestfish.pod:397
19698 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
19699 msgid "B<--version>"
19703 #: ../fish/guestfish.pod:401
19704 msgid "Display the guestfish / libguestfs version number and exit."
19708 #: ../fish/guestfish.pod:403
19713 #: ../fish/guestfish.pod:405
19718 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
19720 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19721 "mounts are done read-write."
19725 #: ../fish/guestfish.pod:410
19726 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19730 #: ../fish/guestfish.pod:412
19735 #: ../fish/guestfish.pod:414
19736 msgid "Echo each command before executing it."
19740 #: ../fish/guestfish.pod:418
19741 msgid "COMMANDS ON COMMAND LINE"
19745 #: ../fish/guestfish.pod:420
19746 msgid "Any additional (non-option) arguments are treated as commands to execute."
19750 #: ../fish/guestfish.pod:423
19752 "Commands to execute should be separated by a colon (C<:>), where the colon "
19753 "is a separate parameter. Thus:"
19757 #: ../fish/guestfish.pod:426
19760 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19765 #: ../fish/guestfish.pod:428
19767 "If there are no additional arguments, then we enter a shell, either an "
19768 "interactive shell with a prompt (if the input is a terminal) or a "
19769 "non-interactive shell."
19773 #: ../fish/guestfish.pod:432
19775 "In either command line mode or non-interactive shell, the first command that "
19776 "gives an error causes the whole shell to exit. In interactive mode (with a "
19777 "prompt) if a command fails, you can continue to enter commands."
19781 #: ../fish/guestfish.pod:437
19782 msgid "USING launch (OR run)"
19786 #: ../fish/guestfish.pod:439
19788 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19789 "then launch it, then mount any disks you need, and finally issue "
19790 "actions/commands. So the general order of the day is:"
19794 #: ../fish/guestfish.pod:447
19795 msgid "add or -a/--add"
19799 #: ../fish/guestfish.pod:451
19800 msgid "launch (aka run)"
19804 #: ../fish/guestfish.pod:455
19805 msgid "mount or -m/--mount"
19809 #: ../fish/guestfish.pod:459
19810 msgid "any other commands"
19814 #: ../fish/guestfish.pod:463
19816 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19817 "guest before mounting or performing any other commands."
19821 #: ../fish/guestfish.pod:466
19823 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19824 "I<--new> options were given then C<run> is done automatically, simply "
19825 "because guestfish can't perform the action you asked for without doing this."
19829 #: ../fish/guestfish.pod:471
19830 msgid "OPENING DISKS FOR READ AND WRITE"
19834 #: ../fish/guestfish.pod:473
19836 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
19837 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
19838 "I<-i> and I<-m> open disk images read-only or for writing."
19842 #: ../fish/guestfish.pod:478
19844 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
19845 "opening disk images supplied on the command line for write. To open a disk "
19846 "image read-only you have to do I<-a image --ro>."
19850 #: ../fish/guestfish.pod:482
19852 "This matters: If you accidentally open a live VM disk image writable then "
19853 "you will cause irreversible disk corruption."
19857 #: ../fish/guestfish.pod:485
19859 "By libguestfs 1.12 we intend to change the default the other way. Disk "
19860 "images will be opened read-only. You will have to either specify "
19861 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
19862 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
19863 "access for disk images specified by those other command line options."
19867 #: ../fish/guestfish.pod:492
19869 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
19870 "which does nothing (it is already the default). However it is highly "
19871 "recommended that you use this option to indicate that you need write access, "
19872 "and prepare your scripts for the day when this option will be required for "
19877 #: ../fish/guestfish.pod:498
19879 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
19880 "other libguestfs program apart from guestfish and guestmount."
19884 #: ../fish/guestfish.pod:501
19889 #: ../fish/guestfish.pod:503
19891 "You can quote ordinary parameters using either single or double quotes. For "
19896 #: ../fish/guestfish.pod:506
19899 " add \"file with a space.img\"\n"
19904 #: ../fish/guestfish.pod:508
19907 " rm '/file name'\n"
19912 #: ../fish/guestfish.pod:510
19920 #: ../fish/guestfish.pod:512
19922 "A few commands require a list of strings to be passed. For these, use a "
19923 "whitespace-separated list, enclosed in quotes. Strings containing "
19924 "whitespace to be passed through must be enclosed in single quotes. A "
19925 "literal single quote must be escaped with a backslash."
19929 #: ../fish/guestfish.pod:517
19932 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
19933 " command \"/bin/echo 'foo bar'\"\n"
19934 " command \"/bin/echo \\'foo\\'\"\n"
19939 #: ../fish/guestfish.pod:521
19940 msgid "OPTIONAL ARGUMENTS"
19944 #: ../fish/guestfish.pod:523
19946 "Some commands take optional arguments. These arguments appear in this "
19947 "documentation as C<[argname:..]>. You can use them as in these examples:"
19951 #: ../fish/guestfish.pod:527
19954 " add-drive-opts filename\n"
19959 #: ../fish/guestfish.pod:529
19962 " add-drive-opts filename readonly:true\n"
19967 #: ../fish/guestfish.pod:531
19970 " add-drive-opts filename format:qcow2 readonly:false\n"
19975 #: ../fish/guestfish.pod:533
19977 "Each optional argument can appear at most once. All optional arguments must "
19978 "appear after the required ones."
19982 #: ../fish/guestfish.pod:536
19987 #: ../fish/guestfish.pod:538
19988 msgid "This section applies to all commands which can take integers as parameters."
19992 #: ../fish/guestfish.pod:541
19993 msgid "SIZE SUFFIX"
19997 #: ../fish/guestfish.pod:543
19999 "When the command takes a parameter measured in bytes, you can use one of the "
20000 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20004 #: ../fish/guestfish.pod:549
20005 msgid "B<k> or B<K> or B<KiB>"
20009 #: ../fish/guestfish.pod:551
20010 msgid "The size in kilobytes (multiplied by 1024)."
20014 #: ../fish/guestfish.pod:553
20019 #: ../fish/guestfish.pod:555
20020 msgid "The size in SI 1000 byte units."
20024 #: ../fish/guestfish.pod:557
20025 msgid "B<M> or B<MiB>"
20029 #: ../fish/guestfish.pod:559
20030 msgid "The size in megabytes (multiplied by 1048576)."
20034 #: ../fish/guestfish.pod:561
20039 #: ../fish/guestfish.pod:563
20040 msgid "The size in SI 1000000 byte units."
20044 #: ../fish/guestfish.pod:565
20045 msgid "B<G> or B<GiB>"
20049 #: ../fish/guestfish.pod:567
20050 msgid "The size in gigabytes (multiplied by 2**30)."
20054 #: ../fish/guestfish.pod:569
20059 #: ../fish/guestfish.pod:571
20060 msgid "The size in SI 10**9 byte units."
20064 #: ../fish/guestfish.pod:573
20065 msgid "B<T> or B<TiB>"
20069 #: ../fish/guestfish.pod:575
20070 msgid "The size in terabytes (multiplied by 2**40)."
20074 #: ../fish/guestfish.pod:577
20079 #: ../fish/guestfish.pod:579
20080 msgid "The size in SI 10**12 byte units."
20084 #: ../fish/guestfish.pod:581
20085 msgid "B<P> or B<PiB>"
20089 #: ../fish/guestfish.pod:583
20090 msgid "The size in petabytes (multiplied by 2**50)."
20094 #: ../fish/guestfish.pod:585
20099 #: ../fish/guestfish.pod:587
20100 msgid "The size in SI 10**15 byte units."
20104 #: ../fish/guestfish.pod:589
20105 msgid "B<E> or B<EiB>"
20109 #: ../fish/guestfish.pod:591
20110 msgid "The size in exabytes (multiplied by 2**60)."
20114 #: ../fish/guestfish.pod:593
20119 #: ../fish/guestfish.pod:595
20120 msgid "The size in SI 10**18 byte units."
20124 #: ../fish/guestfish.pod:597
20125 msgid "B<Z> or B<ZiB>"
20129 #: ../fish/guestfish.pod:599
20130 msgid "The size in zettabytes (multiplied by 2**70)."
20134 #: ../fish/guestfish.pod:601
20139 #: ../fish/guestfish.pod:603
20140 msgid "The size in SI 10**21 byte units."
20144 #: ../fish/guestfish.pod:605
20145 msgid "B<Y> or B<YiB>"
20149 #: ../fish/guestfish.pod:607
20150 msgid "The size in yottabytes (multiplied by 2**80)."
20154 #: ../fish/guestfish.pod:609
20159 #: ../fish/guestfish.pod:611
20160 msgid "The size in SI 10**24 byte units."
20164 #: ../fish/guestfish.pod:617
20167 " truncate-size /file 1G\n"
20172 #: ../fish/guestfish.pod:619
20173 msgid "would truncate the file to 1 gigabyte."
20177 #: ../fish/guestfish.pod:621
20179 "Be careful because a few commands take sizes in kilobytes or megabytes "
20180 "(eg. the parameter to L</memsize> is specified in megabytes already). "
20181 "Adding a suffix will probably not do what you expect."
20185 #: ../fish/guestfish.pod:625
20186 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20190 #: ../fish/guestfish.pod:627
20192 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20193 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20197 #: ../fish/guestfish.pod:630
20200 " 1234 decimal number 1234\n"
20201 " 02322 octal number, equivalent to decimal 1234\n"
20202 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20207 #: ../fish/guestfish.pod:634
20209 "When using the C<chmod> command, you almost always want to specify an octal "
20210 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20211 "L<chmod(1)> program):"
20215 #: ../fish/guestfish.pod:638
20218 " chmod 0777 /public # OK\n"
20219 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20224 #: ../fish/guestfish.pod:641
20226 "Commands that return numbers usually print them in decimal, but some "
20227 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20228 "octal, preceeded by C<0>)."
20232 #: ../fish/guestfish.pod:645
20233 msgid "WILDCARDS AND GLOBBING"
20237 #: ../fish/guestfish.pod:647
20239 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20240 "(globbing) by default. So for example the following will not do what you "
20245 #: ../fish/guestfish.pod:651
20253 #: ../fish/guestfish.pod:653
20255 "Assuming you don't have a directory called literally C</home/*> then the "
20256 "above command will return an error."
20260 #: ../fish/guestfish.pod:656
20261 msgid "To perform wildcard expansion, use the C<glob> command."
20265 #: ../fish/guestfish.pod:658
20268 " glob rm-rf /home/*\n"
20273 #: ../fish/guestfish.pod:660
20275 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20276 "many times), equivalent to:"
20280 #: ../fish/guestfish.pod:663
20283 " rm-rf /home/jim\n"
20284 " rm-rf /home/joe\n"
20285 " rm-rf /home/mary\n"
20290 #: ../fish/guestfish.pod:667
20291 msgid "C<glob> only works on simple guest paths and not on device names."
20295 #: ../fish/guestfish.pod:669
20297 "If you have several parameters, each containing a wildcard, then glob will "
20298 "perform a Cartesian product."
20302 #: ../fish/guestfish.pod:672
20307 #: ../fish/guestfish.pod:674
20309 "Any line which starts with a I<#> character is treated as a comment and "
20310 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20311 "a command. For example:"
20315 #: ../fish/guestfish.pod:678
20318 " # this is a comment\n"
20319 " # this is a comment\n"
20320 " foo # NOT a comment\n"
20325 #: ../fish/guestfish.pod:682
20326 msgid "Blank lines are also ignored."
20330 #: ../fish/guestfish.pod:684
20331 msgid "RUNNING COMMANDS LOCALLY"
20335 #: ../fish/guestfish.pod:686
20337 "Any line which starts with a I<!> character is treated as a command sent to "
20338 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20342 #: ../fish/guestfish.pod:690
20346 " tgz-out /remote local/remote-data.tar.gz\n"
20351 #: ../fish/guestfish.pod:693
20353 "will create a directory C<local> on the host, and then export the contents "
20354 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20355 "(See C<tgz-out>)."
20359 #: ../fish/guestfish.pod:697
20361 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20362 "effect, due to the way that subprocesses work in Unix."
20366 #: ../fish/guestfish.pod:700
20367 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20371 #: ../fish/guestfish.pod:702
20373 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20374 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20375 "and executed as guestfish commands."
20379 #: ../fish/guestfish.pod:706
20381 "Thus you can use shell script to construct arbitrary guestfish commands "
20382 "which are then parsed by guestfish."
20386 #: ../fish/guestfish.pod:709
20388 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20389 "through C</foo.100>) using guestfish commands alone. However this is simple "
20390 "if we use a shell script to create the guestfish commands for us:"
20394 #: ../fish/guestfish.pod:714
20397 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20402 #: ../fish/guestfish.pod:716
20403 msgid "or with names like C</foo.001>:"
20407 #: ../fish/guestfish.pod:718
20410 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20415 #: ../fish/guestfish.pod:720
20417 "When using guestfish interactively it can be helpful to just run the shell "
20418 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20419 "ordinary I<!> local command), see what guestfish commands it would run, and "
20420 "when you are happy with those prepend the C<E<lt>> character to run the "
20421 "guestfish commands for real."
20425 #: ../fish/guestfish.pod:726
20430 #: ../fish/guestfish.pod:728
20432 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20433 "command (a guestfish command) to the second command (any host command). For "
20438 #: ../fish/guestfish.pod:732
20441 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20446 #: ../fish/guestfish.pod:734
20448 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20449 "program). The above command would list all accounts in the guest filesystem "
20450 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20454 #: ../fish/guestfish.pod:739
20457 " hexdump /bin/ls | head\n"
20458 " list-devices | tail -1\n"
20459 " tgz-out / - | tar ztf -\n"
20464 #: ../fish/guestfish.pod:743
20466 "The space before the pipe symbol is required, any space after the pipe "
20467 "symbol is optional. Everything after the pipe symbol is just passed "
20468 "straight to the host shell, so it can contain redirections, globs and "
20469 "anything else that makes sense on the host side."
20473 #: ../fish/guestfish.pod:748
20475 "To use a literal argument which begins with a pipe symbol, you have to quote "
20480 #: ../fish/guestfish.pod:751
20488 #: ../fish/guestfish.pod:753
20489 msgid "HOME DIRECTORIES"
20493 #: ../fish/guestfish.pod:755
20495 "If a parameter starts with the character C<~> then the tilde may be expanded "
20496 "as a home directory path (either C<~> for the current user's home directory, "
20497 "or C<~user> for another user)."
20501 #: ../fish/guestfish.pod:759
20503 "Note that home directory expansion happens for users known I<on the host>, "
20504 "not in the guest filesystem."
20508 #: ../fish/guestfish.pod:762
20510 "To use a literal argument which begins with a tilde, you have to quote it, "
20515 #: ../fish/guestfish.pod:765
20523 #: ../fish/guestfish.pod:769
20525 "Libguestfs has some support for Linux guests encrypted according to the "
20526 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20527 "disk encryption systems used by modern Linux guests. Currently only "
20528 "LVM-on-LUKS is supported."
20532 #: ../fish/guestfish.pod:774
20533 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20537 #: ../fish/guestfish.pod:776
20540 " ><fs> vfs-type /dev/sda2\n"
20546 #: ../fish/guestfish.pod:779
20548 "Then open those devices using L</luks-open>. This creates a device-mapper "
20549 "device called C</dev/mapper/luksdev>."
20553 #: ../fish/guestfish.pod:782
20556 " ><fs> luks-open /dev/sda2 luksdev\n"
20557 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20562 #: ../fish/guestfish.pod:785
20564 "Finally you have to tell LVM to scan for volume groups on the newly created "
20569 #: ../fish/guestfish.pod:788
20573 " vg-activate-all true\n"
20578 #: ../fish/guestfish.pod:791
20579 msgid "The logical volume(s) can now be mounted in the usual way."
20583 #: ../fish/guestfish.pod:793
20585 "Before closing a LUKS device you must unmount any logical volumes on it and "
20586 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20587 "one. Then you can close the mapper device:"
20591 #: ../fish/guestfish.pod:797
20594 " vg-activate false /dev/VG\n"
20595 " luks-close /dev/mapper/luksdev\n"
20600 #: ../fish/guestfish.pod:800
20601 msgid "WINDOWS PATHS"
20605 #: ../fish/guestfish.pod:802
20607 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20608 "letters and paths (with some limitations). The following commands are "
20613 #: ../fish/guestfish.pod:806
20616 " file /WINDOWS/system32/config/system.LOG\n"
20621 #: ../fish/guestfish.pod:808
20624 " file win:\\windows\\system32\\config\\system.log\n"
20629 #: ../fish/guestfish.pod:810
20632 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20637 #: ../fish/guestfish.pod:812
20639 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20640 "where the drive is mounted, prepending that to the path, changing all "
20641 "backslash characters to forward slash, then resolving the result using "
20642 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
20643 "then the parameter might be rewritten like this:"
20647 #: ../fish/guestfish.pod:818
20650 " win:e:\\foo\\bar => /e/FOO/bar\n"
20655 #: ../fish/guestfish.pod:820
20656 msgid "This only works in argument positions that expect a path."
20660 #: ../fish/guestfish.pod:822
20661 msgid "UPLOADING AND DOWNLOADING FILES"
20665 #: ../fish/guestfish.pod:824
20667 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20668 "others which upload from or download to a local file, you can use the "
20669 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20673 #: ../fish/guestfish.pod:828
20681 #: ../fish/guestfish.pod:830
20682 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20686 #: ../fish/guestfish.pod:833
20689 " tar-out /etc - | tar tf -\n"
20694 #: ../fish/guestfish.pod:835
20696 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20697 "command (see L</PIPES>)."
20701 #: ../fish/guestfish.pod:838
20703 "When using C<-> to read from stdin, the input is read up to the end of "
20704 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20705 "some arbitrary end marker:"
20709 #: ../fish/guestfish.pod:842
20712 " upload -<<END /foo\n"
20721 #: ../fish/guestfish.pod:848
20723 "Any string of characters can be used instead of C<END>. The end marker must "
20724 "appear on a line of its own, without any preceeding or following characters "
20725 "(not even spaces)."
20729 #: ../fish/guestfish.pod:852
20731 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20732 "upload local files (so-called \"FileIn\" parameters in the generator)."
20736 #: ../fish/guestfish.pod:855
20737 msgid "EXIT ON ERROR BEHAVIOUR"
20741 #: ../fish/guestfish.pod:857
20743 "By default, guestfish will ignore any errors when in interactive mode "
20744 "(ie. taking commands from a human over a tty), and will exit on the first "
20745 "error in non-interactive mode (scripts, commands given on the command line)."
20749 #: ../fish/guestfish.pod:862
20751 "If you prefix a command with a I<-> character, then that command will not "
20752 "cause guestfish to exit, even if that (one) command returns an error."
20756 #: ../fish/guestfish.pod:866
20757 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20761 #: ../fish/guestfish.pod:868
20763 "Guestfish can be remote-controlled over a socket. This is useful "
20764 "particularly in shell scripts where you want to make several different "
20765 "changes to a filesystem, but you don't want the overhead of starting up a "
20766 "guestfish process each time."
20770 #: ../fish/guestfish.pod:873
20771 msgid "Start a guestfish server process using:"
20775 #: ../fish/guestfish.pod:875
20778 " eval \"`guestfish --listen`\"\n"
20783 #: ../fish/guestfish.pod:877
20784 msgid "and then send it commands by doing:"
20788 #: ../fish/guestfish.pod:879
20791 " guestfish --remote cmd [...]\n"
20796 #: ../fish/guestfish.pod:881
20797 msgid "To cause the server to exit, send it the exit command:"
20801 #: ../fish/guestfish.pod:883
20804 " guestfish --remote exit\n"
20809 #: ../fish/guestfish.pod:885
20811 "Note that the server will normally exit if there is an error in a command. "
20812 "You can change this in the usual way. See section L</EXIT ON ERROR "
20817 #: ../fish/guestfish.pod:889
20818 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20822 #: ../fish/guestfish.pod:891
20824 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20825 "is how the I<--remote> option knows where to send the commands. You can "
20826 "have several guestfish listener processes running using:"
20830 #: ../fish/guestfish.pod:895
20833 " eval \"`guestfish --listen`\"\n"
20834 " pid1=$GUESTFISH_PID\n"
20835 " eval \"`guestfish --listen`\"\n"
20836 " pid2=$GUESTFISH_PID\n"
20838 " guestfish --remote=$pid1 cmd\n"
20839 " guestfish --remote=$pid2 cmd\n"
20844 #: ../fish/guestfish.pod:903
20845 msgid "REMOTE CONTROL AND CSH"
20849 #: ../fish/guestfish.pod:905
20851 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
20856 #: ../fish/guestfish.pod:908
20859 " eval \"`guestfish --listen --csh`\"\n"
20864 #: ../fish/guestfish.pod:910
20865 msgid "REMOTE CONTROL DETAILS"
20869 #: ../fish/guestfish.pod:912
20871 "Remote control happens over a Unix domain socket called "
20872 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
20873 "of the process, and C<$PID> is the process ID of the server."
20877 #: ../fish/guestfish.pod:916
20878 msgid "Guestfish client and server versions must match exactly."
20882 #: ../fish/guestfish.pod:918
20883 msgid "PREPARED DISK IMAGES"
20887 #: ../fish/guestfish.pod:920
20889 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
20890 "preformatted disk images that guestfish can make for you to save typing. "
20891 "This is particularly useful for testing purposes. This option is used "
20892 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
20893 "can be mixed with I<-a>)."
20897 #: ../fish/guestfish.pod:926
20899 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
20900 "the second and so on. Existing files in the current directory are "
20905 #: ../fish/guestfish.pod:930
20907 "The type briefly describes how the disk should be sized, partitioned, how "
20908 "filesystem(s) should be created, and how content should be added. "
20909 "Optionally the type can be followed by extra parameters, separated by C<:> "
20910 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
20911 "sparsely-allocated disk, containing a single partition, with the partition "
20912 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
20913 "on a 1GB disk instead."
20917 #: ../fish/guestfish.pod:938
20918 msgid "To list the available types and any extra parameters they take, run:"
20922 #: ../fish/guestfish.pod:942
20924 "Note that the prepared filesystem is not mounted. You would usually have to "
20925 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
20929 #: ../fish/guestfish.pod:946
20931 "If any I<-N> or I<--new> options are given, the guest is automatically "
20936 #: ../fish/guestfish.pod:951
20937 msgid "Create a 100MB disk with an ext4-formatted partition:"
20941 #: ../fish/guestfish.pod:953
20944 " guestfish -N fs:ext4\n"
20949 #: ../fish/guestfish.pod:955
20950 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
20954 #: ../fish/guestfish.pod:957
20957 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
20962 #: ../fish/guestfish.pod:959
20963 msgid "Create a blank 200MB disk:"
20967 #: ../fish/guestfish.pod:961
20970 " guestfish -N disk:200M\n"
20975 #: ../fish/guestfish.pod:963
20976 msgid "PROGRESS BARS"
20980 #: ../fish/guestfish.pod:965
20982 "Some (not all) long-running commands send progress notification messages as "
20983 "they are running. Guestfish turns these messages into progress bars."
20987 #: ../fish/guestfish.pod:969
20989 "When a command that supports progress bars takes longer than two seconds to "
20990 "run, and if progress bars are enabled, then you will see one appearing below "
20995 #: ../fish/guestfish.pod:973
20998 " ><fs> copy-size /large-file /another-file 2048M\n"
20999 " / 10% [#####-----------------------------------------] 00:30\n"
21004 #: ../fish/guestfish.pod:976
21006 "The spinner on the left hand side moves round once for every progress "
21007 "notification received from the backend. This is a (reasonably) golden "
21008 "assurance that the command is \"doing something\" even if the progress bar "
21009 "is not moving, because the command is able to send the progress "
21010 "notifications. When the bar reaches 100% and the command finishes, the "
21011 "spinner disappears."
21015 #: ../fish/guestfish.pod:983
21017 "Progress bars are enabled by default when guestfish is used interactively. "
21018 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21019 "and you can disable them completely using I<--no-progress-bars>."
21023 #: ../fish/guestfish.pod:988
21024 msgid "GUESTFISH COMMANDS"
21028 #: ../fish/guestfish.pod:990
21030 "The commands in this section are guestfish convenience commands, in other "
21031 "words, they are not part of the L<guestfs(3)> API."
21035 #: ../fish/guestfish.pod:993
21040 #: ../fish/guestfish.pod:995
21049 #: ../fish/guestfish.pod:998
21050 msgid "Without any parameter, this provides general help."
21054 #: ../fish/guestfish.pod:1000
21055 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21059 #: ../fish/guestfish.pod:1002
21060 msgid "quit | exit"
21064 #: ../fish/guestfish.pod:1004
21065 msgid "This exits guestfish. You can also use C<^D> key."
21069 #: ../fish/guestfish.pod:1006
21070 msgid "@FISH_COMMANDS@"
21074 #: ../fish/guestfish.pod:1008
21079 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
21084 #: ../fish/guestfish.pod:1014
21086 "guestfish returns 0 if the commands completed without error, or 1 if there "
21091 #: ../fish/guestfish.pod:1021
21096 #: ../fish/guestfish.pod:1023
21098 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21103 #: ../fish/guestfish.pod:1026
21104 msgid "GUESTFISH_PID"
21108 #: ../fish/guestfish.pod:1028
21110 "Used with the I<--remote> option to specify the remote guestfish process to "
21111 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21115 #: ../fish/guestfish.pod:1032
21120 #: ../fish/guestfish.pod:1034
21122 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21123 "not specified, the external L<hexedit(1)> program is used."
21127 #: ../fish/guestfish.pod:1038
21132 #: ../fish/guestfish.pod:1040
21134 "If compiled with GNU readline support, various files in the home directory "
21135 "can be used. See L</FILES>."
21139 #: ../fish/guestfish.pod:1049
21141 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21142 "effect as using the B<-v> option."
21146 #: ../fish/guestfish.pod:1061
21148 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21149 "the discussion of paths in L<guestfs(3)>."
21153 #: ../fish/guestfish.pod:1072
21154 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21158 #: ../fish/guestfish.pod:1074
21163 #: ../fish/guestfish.pod:1076
21165 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21170 #: ../fish/guestfish.pod:1092 ../fuse/guestmount.pod:264
21175 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:268
21176 msgid "$HOME/.libguestfs-tools.rc"
21180 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:270
21181 msgid "/etc/libguestfs-tools.conf"
21185 #: ../fish/guestfish.pod:1100 ../fuse/guestmount.pod:272
21187 "This configuration file controls the default read-only or read-write mode "
21188 "(I<--ro> or I<--rw>)."
21192 #: ../fish/guestfish.pod:1103
21193 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21197 #: ../fish/guestfish.pod:1105
21198 msgid "$HOME/.guestfish"
21202 #: ../fish/guestfish.pod:1107
21204 "If compiled with GNU readline support, then the command history is saved in "
21209 #: ../fish/guestfish.pod:1110
21210 msgid "$HOME/.inputrc"
21214 #: ../fish/guestfish.pod:1112
21215 msgid "/etc/inputrc"
21219 #: ../fish/guestfish.pod:1114
21221 "If compiled with GNU readline support, then these files can be used to "
21222 "configure readline. For further information, please see "
21223 "L<readline(3)/INITIALIZATION FILE>."
21227 #: ../fish/guestfish.pod:1118
21228 msgid "To write rules which only apply to guestfish, use:"
21232 #: ../fish/guestfish.pod:1120
21242 #: ../fish/guestfish.pod:1124
21244 "Variables that you can set in inputrc that change the behaviour of guestfish "
21245 "in useful ways include:"
21249 #: ../fish/guestfish.pod:1129
21250 msgid "completion-ignore-case (default: on)"
21254 #: ../fish/guestfish.pod:1131
21256 "By default, guestfish will ignore case when tab-completing paths on the "
21261 #: ../fish/guestfish.pod:1134
21264 " set completion-ignore-case off\n"
21269 #: ../fish/guestfish.pod:1136
21270 msgid "to make guestfish case sensitive."
21274 #: ../fish/guestfish.pod:1140
21279 #: ../fish/guestfish.pod:1142
21280 msgid "test2.img (etc)"
21284 #: ../fish/guestfish.pod:1144
21286 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21287 "will be created in the file C<test1.img> in the current directory. The "
21288 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21289 "the same name will be overwritten."
21293 #: ../fish/guestfish.pod:1153
21295 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
21296 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
21297 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
21298 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21299 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21300 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
21304 #: ../fish/guestfish.pod:1183 ../test-tool/libguestfs-test-tool.pod:102 ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
21306 "This program is free software; you can redistribute it and/or modify it "
21307 "under the terms of the GNU General Public License as published by the Free "
21308 "Software Foundation; either version 2 of the License, or (at your option) "
21309 "any later version."
21313 #: ../fish/guestfish.pod:1188 ../test-tool/libguestfs-test-tool.pod:107 ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
21315 "This program is distributed in the hope that it will be useful, but WITHOUT "
21316 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21317 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21322 #: ../fish/guestfish.pod:1193 ../test-tool/libguestfs-test-tool.pod:112 ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
21324 "You should have received a copy of the GNU General Public License along with "
21325 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21326 "Ave, Cambridge, MA 02139, USA."
21330 #: ../fish/guestfish-actions.pod:1
21335 #: ../fish/guestfish-actions.pod:3
21338 " add-cdrom filename\n"
21343 #: ../fish/guestfish-actions.pod:15
21345 "This call checks for the existence of C<filename>. This stops you from "
21346 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21347 "and C<http:> URLs. To specify those, use the general L</config> call "
21352 #: ../fish/guestfish-actions.pod:22
21354 "If you just want to add an ISO file (often you use this as an efficient way "
21355 "to transfer large files into the guest), then you should probably use "
21356 "L</add-drive-ro> instead."
21360 #: ../fish/guestfish-actions.pod:35
21365 #: ../fish/guestfish-actions.pod:37
21370 #: ../fish/guestfish-actions.pod:39
21373 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
21379 #: ../fish/guestfish-actions.pod:41
21381 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21382 "It works by connecting to libvirt, requesting the domain and domain XML from "
21383 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21387 #: ../fish/guestfish-actions.pod:76
21389 "The other optional parameters are passed directly through to "
21390 "L</add-drive-opts>."
21394 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:3064
21396 "This command has one or more optional arguments. See L</OPTIONAL "
21401 #: ../fish/guestfish-actions.pod:81
21406 #: ../fish/guestfish-actions.pod:83
21409 " add-drive filename\n"
21414 #: ../fish/guestfish-actions.pod:85
21416 "This function is the equivalent of calling L</add-drive-opts> with no "
21417 "optional parameters, so the disk is added writable, with the format being "
21418 "detected automatically."
21422 #: ../fish/guestfish-actions.pod:89
21424 "Automatic detection of the format opens you up to a potential security hole "
21425 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21426 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21427 "you should think about replacing calls to this function with calls to "
21428 "L</add-drive-opts>, and specifying the format."
21432 #: ../fish/guestfish-actions.pod:96
21433 msgid "add-drive-opts"
21437 #: ../fish/guestfish-actions.pod:98
21442 #: ../fish/guestfish-actions.pod:100
21445 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21450 #: ../fish/guestfish-actions.pod:127
21452 "This forces the image format. If you omit this (or use L</add-drive> or "
21453 "L</add-drive-ro>) then the format is automatically detected. Possible "
21454 "formats include C<raw> and C<qcow2>."
21458 #: ../fish/guestfish-actions.pod:138
21460 "This rarely-used option lets you emulate the behaviour of the deprecated "
21461 "L</add-drive-with-if> call (q.v.)"
21465 #: ../fish/guestfish-actions.pod:145
21466 msgid "add-drive-ro"
21470 #: ../fish/guestfish-actions.pod:147
21475 #: ../fish/guestfish-actions.pod:149
21478 " add-drive-ro filename\n"
21483 #: ../fish/guestfish-actions.pod:151
21485 "This function is the equivalent of calling L</add-drive-opts> with the "
21486 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21487 "is added read-only, with the format being detected automatically."
21491 #: ../fish/guestfish-actions.pod:156
21492 msgid "add-drive-ro-with-if"
21496 #: ../fish/guestfish-actions.pod:158
21499 " add-drive-ro-with-if filename iface\n"
21504 #: ../fish/guestfish-actions.pod:160
21506 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21507 "interface emulation to use at run time."
21511 #: ../fish/guestfish-actions.pod:170
21512 msgid "add-drive-with-if"
21516 #: ../fish/guestfish-actions.pod:172
21519 " add-drive-with-if filename iface\n"
21524 #: ../fish/guestfish-actions.pod:174
21526 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21527 "interface emulation to use at run time."
21531 #: ../fish/guestfish-actions.pod:184
21536 #: ../fish/guestfish-actions.pod:186
21539 " aug-clear augpath\n"
21544 #: ../fish/guestfish-actions.pod:191
21549 #: ../fish/guestfish-actions.pod:193
21557 #: ../fish/guestfish-actions.pod:195
21559 "Close the current Augeas handle and free up any resources used by it. After "
21560 "calling this, you have to call L</aug-init> again before you can use any "
21561 "other Augeas functions."
21565 #: ../fish/guestfish-actions.pod:200
21566 msgid "aug-defnode"
21570 #: ../fish/guestfish-actions.pod:202
21573 " aug-defnode name expr val\n"
21578 #: ../fish/guestfish-actions.pod:207
21580 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21581 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21582 "containing that single node."
21586 #: ../fish/guestfish-actions.pod:215
21591 #: ../fish/guestfish-actions.pod:217
21594 " aug-defvar name expr\n"
21599 #: ../fish/guestfish-actions.pod:226
21604 #: ../fish/guestfish-actions.pod:228
21607 " aug-get augpath\n"
21612 #: ../fish/guestfish-actions.pod:233
21617 #: ../fish/guestfish-actions.pod:235
21620 " aug-init root flags\n"
21625 #: ../fish/guestfish-actions.pod:241
21626 msgid "You must call this before using any other L</aug-*> commands."
21630 #: ../fish/guestfish-actions.pod:276
21631 msgid "Do not load the tree in L</aug-init>."
21635 #: ../fish/guestfish-actions.pod:280
21636 msgid "To close the handle, you can call L</aug-close>."
21640 #: ../fish/guestfish-actions.pod:284
21645 #: ../fish/guestfish-actions.pod:286
21648 " aug-insert augpath label true|false\n"
21653 #: ../fish/guestfish-actions.pod:296
21658 #: ../fish/guestfish-actions.pod:298
21666 #: ../fish/guestfish-actions.pod:305
21671 #: ../fish/guestfish-actions.pod:307
21674 " aug-ls augpath\n"
21679 #: ../fish/guestfish-actions.pod:309
21681 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21682 "resulting nodes into alphabetical order."
21686 #: ../fish/guestfish-actions.pod:312
21691 #: ../fish/guestfish-actions.pod:314
21694 " aug-match augpath\n"
21699 #: ../fish/guestfish-actions.pod:320
21704 #: ../fish/guestfish-actions.pod:322
21707 " aug-mv src dest\n"
21712 #: ../fish/guestfish-actions.pod:327
21717 #: ../fish/guestfish-actions.pod:329
21720 " aug-rm augpath\n"
21725 #: ../fish/guestfish-actions.pod:335
21730 #: ../fish/guestfish-actions.pod:337
21738 #: ../fish/guestfish-actions.pod:341
21740 "The flags which were passed to L</aug-init> affect exactly how files are "
21745 #: ../fish/guestfish-actions.pod:344
21750 #: ../fish/guestfish-actions.pod:346
21753 " aug-set augpath val\n"
21758 #: ../fish/guestfish-actions.pod:350
21760 "In the Augeas API, it is possible to clear a node by setting the value to "
21761 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21762 "this call. Instead you must use the L</aug-clear> call."
21766 #: ../fish/guestfish-actions.pod:355
21771 #: ../fish/guestfish-actions.pod:357
21774 " available 'groups ...'\n"
21779 #: ../fish/guestfish-actions.pod:363
21781 "The libguestfs groups, and the functions that those groups correspond to, "
21782 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21783 "runtime by calling L</available-all-groups>."
21787 #: ../fish/guestfish-actions.pod:387
21788 msgid "You must call L</launch> before calling this function."
21792 #: ../fish/guestfish-actions.pod:409
21794 "This call was added in version C<1.0.80>. In previous versions of "
21795 "libguestfs all you could do would be to speculatively execute a command to "
21796 "find out if the daemon implemented it. See also L</version>."
21800 #: ../fish/guestfish-actions.pod:416
21801 msgid "available-all-groups"
21805 #: ../fish/guestfish-actions.pod:418
21808 " available-all-groups\n"
21813 #: ../fish/guestfish-actions.pod:420
21815 "This command returns a list of all optional groups that this daemon knows "
21816 "about. Note this returns both supported and unsupported groups. To find "
21817 "out which ones the daemon can actually support you have to call "
21818 "L</available> on each member of the returned list."
21822 #: ../fish/guestfish-actions.pod:426
21823 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
21827 #: ../fish/guestfish-actions.pod:428
21832 #: ../fish/guestfish-actions.pod:430
21835 " base64-in (base64file|-) filename\n"
21840 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444 ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837 ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230 ../fish/guestfish-actions.pod:4497 ../fish/guestfish-actions.pod:4509 ../fish/guestfish-actions.pod:4520 ../fish/guestfish-actions.pod:4531 ../fish/guestfish-actions.pod:4583 ../fish/guestfish-actions.pod:4592 ../fish/guestfish-actions.pod:4646 ../fish/guestfish-actions.pod:4669
21841 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
21845 #: ../fish/guestfish-actions.pod:437
21850 #: ../fish/guestfish-actions.pod:439
21853 " base64-out filename (base64file|-)\n"
21858 #: ../fish/guestfish-actions.pod:446
21859 msgid "blockdev-flushbufs"
21863 #: ../fish/guestfish-actions.pod:448
21866 " blockdev-flushbufs device\n"
21871 #: ../fish/guestfish-actions.pod:455
21872 msgid "blockdev-getbsz"
21876 #: ../fish/guestfish-actions.pod:457
21879 " blockdev-getbsz device\n"
21884 #: ../fish/guestfish-actions.pod:466
21885 msgid "blockdev-getro"
21889 #: ../fish/guestfish-actions.pod:468
21892 " blockdev-getro device\n"
21897 #: ../fish/guestfish-actions.pod:475
21898 msgid "blockdev-getsize64"
21902 #: ../fish/guestfish-actions.pod:477
21905 " blockdev-getsize64 device\n"
21910 #: ../fish/guestfish-actions.pod:481
21911 msgid "See also L</blockdev-getsz>."
21915 #: ../fish/guestfish-actions.pod:485
21916 msgid "blockdev-getss"
21920 #: ../fish/guestfish-actions.pod:487
21923 " blockdev-getss device\n"
21928 #: ../fish/guestfish-actions.pod:492
21929 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
21933 #: ../fish/guestfish-actions.pod:497
21934 msgid "blockdev-getsz"
21938 #: ../fish/guestfish-actions.pod:499
21941 " blockdev-getsz device\n"
21946 #: ../fish/guestfish-actions.pod:504
21948 "See also L</blockdev-getss> for the real sector size of the device, and "
21949 "L</blockdev-getsize64> for the more useful I<size in bytes>."
21953 #: ../fish/guestfish-actions.pod:510
21954 msgid "blockdev-rereadpt"
21958 #: ../fish/guestfish-actions.pod:512
21961 " blockdev-rereadpt device\n"
21966 #: ../fish/guestfish-actions.pod:518
21967 msgid "blockdev-setbsz"
21971 #: ../fish/guestfish-actions.pod:520
21974 " blockdev-setbsz device blocksize\n"
21979 #: ../fish/guestfish-actions.pod:529
21980 msgid "blockdev-setro"
21984 #: ../fish/guestfish-actions.pod:531
21987 " blockdev-setro device\n"
21992 #: ../fish/guestfish-actions.pod:537
21993 msgid "blockdev-setrw"
21997 #: ../fish/guestfish-actions.pod:539
22000 " blockdev-setrw device\n"
22005 #: ../fish/guestfish-actions.pod:545
22006 msgid "case-sensitive-path"
22010 #: ../fish/guestfish-actions.pod:547
22013 " case-sensitive-path path\n"
22018 #: ../fish/guestfish-actions.pod:571
22020 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
22021 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22022 "how the directories were originally created under Windows)."
22026 #: ../fish/guestfish-actions.pod:579
22027 msgid "See also L</realpath>."
22031 #: ../fish/guestfish-actions.pod:581
22036 #: ../fish/guestfish-actions.pod:583
22044 #: ../fish/guestfish-actions.pod:587
22046 "Note that this function cannot correctly handle binary files (specifically, "
22047 "files containing C<\\0> character which is treated as end of string). For "
22048 "those you need to use the L</read-file> or L</download> functions which have "
22049 "a more complex interface."
22053 #: ../fish/guestfish-actions.pod:595
22058 #: ../fish/guestfish-actions.pod:597
22061 " checksum csumtype path\n"
22066 #: ../fish/guestfish-actions.pod:640
22067 msgid "To get the checksum for a device, use L</checksum-device>."
22071 #: ../fish/guestfish-actions.pod:642
22072 msgid "To get the checksums for many files, use L</checksums-out>."
22076 #: ../fish/guestfish-actions.pod:644
22077 msgid "checksum-device"
22081 #: ../fish/guestfish-actions.pod:646
22084 " checksum-device csumtype device\n"
22089 #: ../fish/guestfish-actions.pod:648
22091 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22092 "device named C<device>. For the types of checksums supported see the "
22093 "L</checksum> command."
22097 #: ../fish/guestfish-actions.pod:652
22098 msgid "checksums-out"
22102 #: ../fish/guestfish-actions.pod:654
22105 " checksums-out csumtype directory (sumsfile|-)\n"
22110 #: ../fish/guestfish-actions.pod:670
22115 #: ../fish/guestfish-actions.pod:672
22118 " chmod mode path\n"
22123 #: ../fish/guestfish-actions.pod:683
22128 #: ../fish/guestfish-actions.pod:685
22131 " chown owner group path\n"
22136 #: ../fish/guestfish-actions.pod:693
22141 #: ../fish/guestfish-actions.pod:695
22144 " command 'arguments ...'\n"
22149 #: ../fish/guestfish-actions.pod:702
22151 "The single parameter is an argv-style list of arguments. The first element "
22152 "is the name of the program to run. Subsequent elements are parameters. The "
22153 "list must be non-empty (ie. must contain a program name). Note that the "
22154 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22158 #: ../fish/guestfish-actions.pod:730
22159 msgid "command-lines"
22163 #: ../fish/guestfish-actions.pod:732
22166 " command-lines 'arguments ...'\n"
22171 #: ../fish/guestfish-actions.pod:734
22172 msgid "This is the same as L</command>, but splits the result into a list of lines."
22176 #: ../fish/guestfish-actions.pod:737
22177 msgid "See also: L</sh-lines>"
22181 #: ../fish/guestfish-actions.pod:742
22186 #: ../fish/guestfish-actions.pod:744
22189 " config qemuparam qemuvalue\n"
22194 #: ../fish/guestfish-actions.pod:755
22199 #: ../fish/guestfish-actions.pod:757
22202 " copy-size src dest size\n"
22207 #: ../fish/guestfish-actions.pod:765
22212 #: ../fish/guestfish-actions.pod:767
22220 #: ../fish/guestfish-actions.pod:772
22225 #: ../fish/guestfish-actions.pod:774
22233 #: ../fish/guestfish-actions.pod:779
22238 #: ../fish/guestfish-actions.pod:781
22246 #: ../fish/guestfish-actions.pod:788
22248 "If the destination is a device, it must be as large or larger than the "
22249 "source file or device, otherwise the copy will fail. This command cannot do "
22250 "partial copies (see L</copy-size>)."
22254 #: ../fish/guestfish-actions.pod:792
22259 #: ../fish/guestfish-actions.pod:794
22267 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
22269 "This command is mostly useful for interactive sessions. It is I<not> "
22270 "intended that you try to parse the output string. Use L</statvfs> from "
22275 #: ../fish/guestfish-actions.pod:802
22280 #: ../fish/guestfish-actions.pod:804
22288 #: ../fish/guestfish-actions.pod:813
22293 #: ../fish/guestfish-actions.pod:815
22301 #: ../fish/guestfish-actions.pod:821
22303 "Another way to get the same information is to enable verbose messages with "
22304 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22305 "before running the program."
22309 #: ../fish/guestfish-actions.pod:826
22314 #: ../fish/guestfish-actions.pod:828
22317 " download remotefilename (filename|-)\n"
22322 #: ../fish/guestfish-actions.pod:835
22323 msgid "See also L</upload>, L</cat>."
22327 #: ../fish/guestfish-actions.pod:839
22328 msgid "download-offset"
22332 #: ../fish/guestfish-actions.pod:841
22335 " download-offset remotefilename (filename|-) offset size\n"
22340 #: ../fish/guestfish-actions.pod:849
22342 "Note that there is no limit on the amount of data that can be downloaded "
22343 "with this call, unlike with L</pread>, and this call always reads the full "
22344 "amount unless an error occurs."
22348 #: ../fish/guestfish-actions.pod:854
22349 msgid "See also L</download>, L</pread>."
22353 #: ../fish/guestfish-actions.pod:858
22354 msgid "drop-caches"
22358 #: ../fish/guestfish-actions.pod:860
22361 " drop-caches whattodrop\n"
22366 #: ../fish/guestfish-actions.pod:872
22371 #: ../fish/guestfish-actions.pod:874
22379 #: ../fish/guestfish-actions.pod:886
22384 #: ../fish/guestfish-actions.pod:888
22387 " e2fsck-f device\n"
22392 #: ../fish/guestfish-actions.pod:894
22394 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22395 "should use L</fsck>."
22399 #: ../fish/guestfish-actions.pod:897
22400 msgid "echo-daemon"
22404 #: ../fish/guestfish-actions.pod:899
22407 " echo-daemon 'words ...'\n"
22412 #: ../fish/guestfish-actions.pod:906
22413 msgid "See also L</ping-daemon>."
22417 #: ../fish/guestfish-actions.pod:908
22422 #: ../fish/guestfish-actions.pod:910
22425 " egrep regex path\n"
22430 #: ../fish/guestfish-actions.pod:918
22435 #: ../fish/guestfish-actions.pod:920
22438 " egrepi regex path\n"
22443 #: ../fish/guestfish-actions.pod:928
22448 #: ../fish/guestfish-actions.pod:930
22451 " equal file1 file2\n"
22456 #: ../fish/guestfish-actions.pod:937
22461 #: ../fish/guestfish-actions.pod:939
22469 #: ../fish/guestfish-actions.pod:944
22470 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22474 #: ../fish/guestfish-actions.pod:946
22479 #: ../fish/guestfish-actions.pod:948
22482 " fallocate path len\n"
22487 #: ../fish/guestfish-actions.pod:965
22488 msgid "fallocate64"
22492 #: ../fish/guestfish-actions.pod:967
22495 " fallocate64 path len\n"
22500 #: ../fish/guestfish-actions.pod:973
22502 "Note that this call allocates disk blocks for the file. To create a sparse "
22503 "file use L</truncate-size> instead."
22507 #: ../fish/guestfish-actions.pod:976
22509 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22510 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22511 "maximum size of files created through that call to 1GB."
22515 #: ../fish/guestfish-actions.pod:985
22520 #: ../fish/guestfish-actions.pod:987
22523 " fgrep pattern path\n"
22528 #: ../fish/guestfish-actions.pod:995
22533 #: ../fish/guestfish-actions.pod:997
22536 " fgrepi pattern path\n"
22541 #: ../fish/guestfish-actions.pod:1005
22546 #: ../fish/guestfish-actions.pod:1007
22554 #: ../fish/guestfish-actions.pod:1023
22556 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
22557 "(etc), L</is-zero>."
22561 #: ../fish/guestfish-actions.pod:1026
22562 msgid "file-architecture"
22566 #: ../fish/guestfish-actions.pod:1028
22569 " file-architecture filename\n"
22574 #: ../fish/guestfish-actions.pod:1131
22579 #: ../fish/guestfish-actions.pod:1133
22587 #: ../fish/guestfish-actions.pod:1137
22589 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22590 "L</is-file> etc. To get the size of block devices, use "
22591 "L</blockdev-getsize64>."
22595 #: ../fish/guestfish-actions.pod:1141
22600 #: ../fish/guestfish-actions.pod:1143
22603 " fill c len path\n"
22608 #: ../fish/guestfish-actions.pod:1149
22610 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22611 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22612 "L</fill-pattern>."
22616 #: ../fish/guestfish-actions.pod:1154
22617 msgid "fill-pattern"
22621 #: ../fish/guestfish-actions.pod:1156
22624 " fill-pattern pattern len path\n"
22629 #: ../fish/guestfish-actions.pod:1158
22631 "This function is like L</fill> except that it creates a new file of length "
22632 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22633 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22638 #: ../fish/guestfish-actions.pod:1163
22643 #: ../fish/guestfish-actions.pod:1165
22646 " find directory\n"
22651 #: ../fish/guestfish-actions.pod:1179
22652 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22656 #: ../fish/guestfish-actions.pod:1192
22657 msgid "See also L</find0>."
22661 #: ../fish/guestfish-actions.pod:1197
22666 #: ../fish/guestfish-actions.pod:1199
22669 " find0 directory (files|-)\n"
22674 #: ../fish/guestfish-actions.pod:1205
22675 msgid "This command works the same way as L</find> with the following exceptions:"
22679 #: ../fish/guestfish-actions.pod:1232
22680 msgid "findfs-label"
22684 #: ../fish/guestfish-actions.pod:1234
22687 " findfs-label label\n"
22692 #: ../fish/guestfish-actions.pod:1240
22693 msgid "To find the label of a filesystem, use L</vfs-label>."
22697 #: ../fish/guestfish-actions.pod:1242
22698 msgid "findfs-uuid"
22702 #: ../fish/guestfish-actions.pod:1244
22705 " findfs-uuid uuid\n"
22710 #: ../fish/guestfish-actions.pod:1250
22711 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22715 #: ../fish/guestfish-actions.pod:1252
22720 #: ../fish/guestfish-actions.pod:1254
22723 " fsck fstype device\n"
22728 #: ../fish/guestfish-actions.pod:1284
22733 #: ../fish/guestfish-actions.pod:1286
22741 #: ../fish/guestfish-actions.pod:1293
22742 msgid "get-attach-method"
22746 #: ../fish/guestfish-actions.pod:1295
22749 " get-attach-method\n"
22754 #: ../fish/guestfish-actions.pod:1297
22755 msgid "Return the current attach method. See L</set-attach-method>."
22759 #: ../fish/guestfish-actions.pod:1299
22760 msgid "get-autosync"
22764 #: ../fish/guestfish-actions.pod:1301
22772 #: ../fish/guestfish-actions.pod:1305
22777 #: ../fish/guestfish-actions.pod:1307
22785 #: ../fish/guestfish-actions.pod:1311
22786 msgid "get-e2label"
22790 #: ../fish/guestfish-actions.pod:1313
22793 " get-e2label device\n"
22798 #: ../fish/guestfish-actions.pod:1325
22803 #: ../fish/guestfish-actions.pod:1327
22806 " get-e2uuid device\n"
22811 #: ../fish/guestfish-actions.pod:1339
22812 msgid "get-memsize"
22816 #: ../fish/guestfish-actions.pod:1341
22824 #: ../fish/guestfish-actions.pod:1346
22826 "If L</set-memsize> was not called on this handle, and if "
22827 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
22828 "value for memsize."
22832 #: ../fish/guestfish-actions.pod:1353
22833 msgid "get-network"
22837 #: ../fish/guestfish-actions.pod:1355
22845 #: ../fish/guestfish-actions.pod:1359
22850 #: ../fish/guestfish-actions.pod:1361
22858 #: ../fish/guestfish-actions.pod:1368
22863 #: ../fish/guestfish-actions.pod:1370
22868 #: ../fish/guestfish-actions.pod:1372
22876 #: ../fish/guestfish-actions.pod:1379
22881 #: ../fish/guestfish-actions.pod:1381
22889 #: ../fish/guestfish-actions.pod:1388
22890 msgid "get-recovery-proc"
22894 #: ../fish/guestfish-actions.pod:1390
22897 " get-recovery-proc\n"
22902 #: ../fish/guestfish-actions.pod:1394
22903 msgid "get-selinux"
22907 #: ../fish/guestfish-actions.pod:1396
22915 #: ../fish/guestfish-actions.pod:1398
22917 "This returns the current setting of the selinux flag which is passed to the "
22918 "appliance at boot time. See L</set-selinux>."
22922 #: ../fish/guestfish-actions.pod:1404
22927 #: ../fish/guestfish-actions.pod:1406
22935 #: ../fish/guestfish-actions.pod:1413
22940 #: ../fish/guestfish-actions.pod:1415
22948 #: ../fish/guestfish-actions.pod:1419
22953 #: ../fish/guestfish-actions.pod:1421
22961 #: ../fish/guestfish-actions.pod:1423
22963 "Return the current umask. By default the umask is C<022> unless it has been "
22964 "set by calling L</umask>."
22968 #: ../fish/guestfish-actions.pod:1426
22969 msgid "get-verbose"
22973 #: ../fish/guestfish-actions.pod:1428
22981 #: ../fish/guestfish-actions.pod:1432
22986 #: ../fish/guestfish-actions.pod:1434
22994 #: ../fish/guestfish-actions.pod:1438
22995 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
22999 #: ../fish/guestfish-actions.pod:1441
23004 #: ../fish/guestfish-actions.pod:1443
23007 " getxattr path name\n"
23012 #: ../fish/guestfish-actions.pod:1445
23014 "Get a single extended attribute from file C<path> named C<name>. This call "
23015 "follows symlinks. If you want to lookup an extended attribute for the "
23016 "symlink itself, use L</lgetxattr>."
23020 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2470
23022 "Normally it is better to get all extended attributes from a file in one go "
23023 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23024 "buggy and do not provide a way to list out attributes. For these "
23025 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23026 "attributes you want in advance and call this function."
23030 #: ../fish/guestfish-actions.pod:1459
23031 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23035 #: ../fish/guestfish-actions.pod:1461
23040 #: ../fish/guestfish-actions.pod:1463
23043 " getxattrs path\n"
23048 #: ../fish/guestfish-actions.pod:1471
23049 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23053 #: ../fish/guestfish-actions.pod:1473
23054 msgid "glob-expand"
23058 #: ../fish/guestfish-actions.pod:1475
23061 " glob-expand pattern\n"
23066 #: ../fish/guestfish-actions.pod:1488
23071 #: ../fish/guestfish-actions.pod:1490
23074 " grep regex path\n"
23079 #: ../fish/guestfish-actions.pod:1498
23084 #: ../fish/guestfish-actions.pod:1500
23087 " grepi regex path\n"
23092 #: ../fish/guestfish-actions.pod:1508
23093 msgid "grub-install"
23097 #: ../fish/guestfish-actions.pod:1510
23100 " grub-install root device\n"
23105 #: ../fish/guestfish-actions.pod:1526
23110 #: ../fish/guestfish-actions.pod:1528
23118 #: ../fish/guestfish-actions.pod:1536
23123 #: ../fish/guestfish-actions.pod:1538
23126 " head-n nrlines path\n"
23131 #: ../fish/guestfish-actions.pod:1551
23136 #: ../fish/guestfish-actions.pod:1553
23144 #: ../fish/guestfish-actions.pod:1561
23149 #: ../fish/guestfish-actions.pod:1563
23152 " initrd-cat initrdpath filename\n"
23157 #: ../fish/guestfish-actions.pod:1575
23158 msgid "See also L</initrd-list>."
23162 #: ../fish/guestfish-actions.pod:1580
23163 msgid "initrd-list"
23167 #: ../fish/guestfish-actions.pod:1582
23170 " initrd-list path\n"
23175 #: ../fish/guestfish-actions.pod:1594
23176 msgid "inotify-add-watch"
23180 #: ../fish/guestfish-actions.pod:1596
23183 " inotify-add-watch path mask\n"
23188 #: ../fish/guestfish-actions.pod:1608
23189 msgid "inotify-close"
23193 #: ../fish/guestfish-actions.pod:1610
23201 #: ../fish/guestfish-actions.pod:1616
23202 msgid "inotify-files"
23206 #: ../fish/guestfish-actions.pod:1618
23214 #: ../fish/guestfish-actions.pod:1620
23216 "This function is a helpful wrapper around L</inotify-read> which just "
23217 "returns a list of pathnames of objects that were touched. The returned "
23218 "pathnames are sorted and deduplicated."
23222 #: ../fish/guestfish-actions.pod:1624
23223 msgid "inotify-init"
23227 #: ../fish/guestfish-actions.pod:1626
23230 " inotify-init maxevents\n"
23235 #: ../fish/guestfish-actions.pod:1632
23237 "C<maxevents> is the maximum number of events which will be queued up between "
23238 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23239 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23240 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23241 "but records the fact that it threw them away by setting a flag "
23242 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23246 #: ../fish/guestfish-actions.pod:1642
23248 "Before any events are generated, you have to add some watches to the "
23249 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23250 "L</inotify-watch-all>."
23254 #: ../fish/guestfish-actions.pod:1648
23256 "Queued up events should be read periodically by calling L</inotify-read> (or "
23257 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23258 "If you don't read the events out often enough then you risk the internal "
23259 "queue overflowing."
23263 #: ../fish/guestfish-actions.pod:1655
23265 "The handle should be closed after use by calling L</inotify-close>. This "
23266 "also removes any watches automatically."
23270 #: ../fish/guestfish-actions.pod:1664
23271 msgid "inotify-read"
23275 #: ../fish/guestfish-actions.pod:1666
23283 #: ../fish/guestfish-actions.pod:1679
23284 msgid "inotify-rm-watch"
23288 #: ../fish/guestfish-actions.pod:1681
23291 " inotify-rm-watch wd\n"
23296 #: ../fish/guestfish-actions.pod:1683
23297 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23301 #: ../fish/guestfish-actions.pod:1686
23302 msgid "inspect-get-arch"
23306 #: ../fish/guestfish-actions.pod:1688
23309 " inspect-get-arch root\n"
23314 #: ../fish/guestfish-actions.pod:1690 ../fish/guestfish-actions.pod:1706 ../fish/guestfish-actions.pod:1792 ../fish/guestfish-actions.pod:1828 ../fish/guestfish-actions.pod:1846 ../fish/guestfish-actions.pod:1880 ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1916 ../fish/guestfish-actions.pod:1931 ../fish/guestfish-actions.pod:1964 ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2010 ../fish/guestfish-actions.pod:2027 ../fish/guestfish-actions.pod:2070 ../fish/guestfish-actions.pod:2105 ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2137 ../fish/guestfish-actions.pod:2150 ../fish/guestfish-actions.pod:2163 ../fish/guestfish-actions.pod:2178
23316 "This function should only be called with a root device string as returned by "
23321 #: ../fish/guestfish-actions.pod:1693
23323 "This returns the architecture of the inspected operating system. The "
23324 "possible return values are listed under L</file-architecture>."
23328 #: ../fish/guestfish-actions.pod:1702
23329 msgid "inspect-get-distro"
23333 #: ../fish/guestfish-actions.pod:1704
23336 " inspect-get-distro root\n"
23341 #: ../fish/guestfish-actions.pod:1788
23342 msgid "inspect-get-drive-mappings"
23346 #: ../fish/guestfish-actions.pod:1790
23349 " inspect-get-drive-mappings root\n"
23354 #: ../fish/guestfish-actions.pod:1820
23356 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23357 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23361 #: ../fish/guestfish-actions.pod:1824
23362 msgid "inspect-get-filesystems"
23366 #: ../fish/guestfish-actions.pod:1826
23369 " inspect-get-filesystems root\n"
23374 #: ../fish/guestfish-actions.pod:1839
23376 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23377 "L</inspect-get-mountpoints>."
23381 #: ../fish/guestfish-actions.pod:1842
23382 msgid "inspect-get-format"
23386 #: ../fish/guestfish-actions.pod:1844
23389 " inspect-get-format root\n"
23394 #: ../fish/guestfish-actions.pod:1876
23395 msgid "inspect-get-hostname"
23399 #: ../fish/guestfish-actions.pod:1878
23402 " inspect-get-hostname root\n"
23407 #: ../fish/guestfish-actions.pod:1891
23408 msgid "inspect-get-major-version"
23412 #: ../fish/guestfish-actions.pod:1893
23415 " inspect-get-major-version root\n"
23420 #: ../fish/guestfish-actions.pod:1912
23421 msgid "inspect-get-minor-version"
23425 #: ../fish/guestfish-actions.pod:1914
23428 " inspect-get-minor-version root\n"
23433 #: ../fish/guestfish-actions.pod:1924
23435 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23436 "L</inspect-get-major-version>."
23440 #: ../fish/guestfish-actions.pod:1927
23441 msgid "inspect-get-mountpoints"
23445 #: ../fish/guestfish-actions.pod:1929
23448 " inspect-get-mountpoints root\n"
23453 #: ../fish/guestfish-actions.pod:1951
23455 "For operating systems like Windows which still use drive letters, this call "
23456 "will only return an entry for the first drive \"mounted on\" C</>. For "
23457 "information about the mapping of drive letters to partitions, see "
23458 "L</inspect-get-drive-mappings>."
23462 #: ../fish/guestfish-actions.pod:1957
23464 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23465 "L</inspect-get-filesystems>."
23469 #: ../fish/guestfish-actions.pod:1960
23470 msgid "inspect-get-package-format"
23474 #: ../fish/guestfish-actions.pod:1962
23477 " inspect-get-package-format root\n"
23482 #: ../fish/guestfish-actions.pod:1967
23484 "This function and L</inspect-get-package-management> return the package "
23485 "format and package management tool used by the inspected operating system. "
23486 "For example for Fedora these functions would return C<rpm> (package format) "
23487 "and C<yum> (package management)."
23491 #: ../fish/guestfish-actions.pod:1982
23492 msgid "inspect-get-package-management"
23496 #: ../fish/guestfish-actions.pod:1984
23499 " inspect-get-package-management root\n"
23504 #: ../fish/guestfish-actions.pod:1989
23506 "L</inspect-get-package-format> and this function return the package format "
23507 "and package management tool used by the inspected operating system. For "
23508 "example for Fedora these functions would return C<rpm> (package format) and "
23509 "C<yum> (package management)."
23513 #: ../fish/guestfish-actions.pod:2006
23514 msgid "inspect-get-product-name"
23518 #: ../fish/guestfish-actions.pod:2008
23521 " inspect-get-product-name root\n"
23526 #: ../fish/guestfish-actions.pod:2023
23527 msgid "inspect-get-product-variant"
23531 #: ../fish/guestfish-actions.pod:2025
23534 " inspect-get-product-variant root\n"
23539 #: ../fish/guestfish-actions.pod:2049
23541 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23542 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23546 #: ../fish/guestfish-actions.pod:2053
23547 msgid "inspect-get-roots"
23551 #: ../fish/guestfish-actions.pod:2055
23554 " inspect-get-roots\n"
23559 #: ../fish/guestfish-actions.pod:2057
23561 "This function is a convenient way to get the list of root devices, as "
23562 "returned from a previous call to L</inspect-os>, but without redoing the "
23563 "whole inspection process."
23567 #: ../fish/guestfish-actions.pod:2061
23569 "This returns an empty list if either no root devices were found or the "
23570 "caller has not called L</inspect-os>."
23574 #: ../fish/guestfish-actions.pod:2066
23575 msgid "inspect-get-type"
23579 #: ../fish/guestfish-actions.pod:2068
23582 " inspect-get-type root\n"
23587 #: ../fish/guestfish-actions.pod:2101
23588 msgid "inspect-get-windows-current-control-set"
23592 #: ../fish/guestfish-actions.pod:2103
23595 " inspect-get-windows-current-control-set root\n"
23600 #: ../fish/guestfish-actions.pod:2117
23601 msgid "inspect-get-windows-systemroot"
23605 #: ../fish/guestfish-actions.pod:2119
23608 " inspect-get-windows-systemroot root\n"
23613 #: ../fish/guestfish-actions.pod:2133
23614 msgid "inspect-is-live"
23618 #: ../fish/guestfish-actions.pod:2135
23621 " inspect-is-live root\n"
23626 #: ../fish/guestfish-actions.pod:2140
23628 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23629 "then this returns true if a live image was detected on the disk."
23633 #: ../fish/guestfish-actions.pod:2146
23634 msgid "inspect-is-multipart"
23638 #: ../fish/guestfish-actions.pod:2148
23641 " inspect-is-multipart root\n"
23646 #: ../fish/guestfish-actions.pod:2153
23648 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23649 "then this returns true if the disk is part of a set."
23653 #: ../fish/guestfish-actions.pod:2159
23654 msgid "inspect-is-netinst"
23658 #: ../fish/guestfish-actions.pod:2161
23661 " inspect-is-netinst root\n"
23666 #: ../fish/guestfish-actions.pod:2166
23668 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23669 "then this returns true if the disk is a network installer, ie. not a "
23670 "self-contained install CD but one which is likely to require network access "
23671 "to complete the install."
23675 #: ../fish/guestfish-actions.pod:2174
23676 msgid "inspect-list-applications"
23680 #: ../fish/guestfish-actions.pod:2176
23683 " inspect-list-applications root\n"
23688 #: ../fish/guestfish-actions.pod:2183
23690 "I<Note:> This call works differently from other parts of the inspection "
23691 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23692 "then mount up the disks, before calling this. Listing applications is a "
23693 "significantly more difficult operation which requires access to the full "
23694 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23695 "are just returning data cached in the libguestfs handle, this call actually "
23696 "reads parts of the mounted filesystems during the call."
23700 #: ../fish/guestfish-actions.pod:2273
23705 #: ../fish/guestfish-actions.pod:2275
23713 #: ../fish/guestfish-actions.pod:2290
23715 "You can pass the root string(s) returned to other L</inspect-get-*> "
23716 "functions in order to query further information about each operating system, "
23717 "such as the name and version."
23721 #: ../fish/guestfish-actions.pod:2295
23723 "This function uses other libguestfs features such as L</mount-ro> and "
23724 "L</umount-all> in order to mount and unmount filesystems and look at the "
23725 "contents. This should be called with no disks currently mounted. The "
23726 "function may also use Augeas, so any existing Augeas handle will be closed."
23730 #: ../fish/guestfish-actions.pod:2307 ../fish/guestfish-actions.pod:2498 ../fish/guestfish-actions.pod:2544
23731 msgid "See also L</list-filesystems>."
23735 #: ../fish/guestfish-actions.pod:2309
23736 msgid "is-blockdev"
23740 #: ../fish/guestfish-actions.pod:2311
23743 " is-blockdev path\n"
23748 #: ../fish/guestfish-actions.pod:2316 ../fish/guestfish-actions.pod:2334 ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2372 ../fish/guestfish-actions.pod:2406 ../fish/guestfish-actions.pod:2415
23749 msgid "See also L</stat>."
23753 #: ../fish/guestfish-actions.pod:2318
23758 #: ../fish/guestfish-actions.pod:2320
23766 #: ../fish/guestfish-actions.pod:2327
23771 #: ../fish/guestfish-actions.pod:2329
23774 " is-chardev path\n"
23779 #: ../fish/guestfish-actions.pod:2336
23784 #: ../fish/guestfish-actions.pod:2338
23792 #: ../fish/guestfish-actions.pod:2345
23797 #: ../fish/guestfish-actions.pod:2347
23805 #: ../fish/guestfish-actions.pod:2355
23810 #: ../fish/guestfish-actions.pod:2357
23818 #: ../fish/guestfish-actions.pod:2364
23823 #: ../fish/guestfish-actions.pod:2366
23831 #: ../fish/guestfish-actions.pod:2374
23832 msgid "is-launching"
23836 #: ../fish/guestfish-actions.pod:2376
23844 #: ../fish/guestfish-actions.pod:2383
23849 #: ../fish/guestfish-actions.pod:2385
23857 #: ../fish/guestfish-actions.pod:2390
23862 #: ../fish/guestfish-actions.pod:2392
23870 #: ../fish/guestfish-actions.pod:2399
23875 #: ../fish/guestfish-actions.pod:2401
23878 " is-socket path\n"
23883 #: ../fish/guestfish-actions.pod:2408
23888 #: ../fish/guestfish-actions.pod:2410
23891 " is-symlink path\n"
23896 #: ../fish/guestfish-actions.pod:2417
23901 #: ../fish/guestfish-actions.pod:2419
23909 #: ../fish/guestfish-actions.pod:2424
23910 msgid "is-zero-device"
23914 #: ../fish/guestfish-actions.pod:2426
23917 " is-zero-device device\n"
23922 #: ../fish/guestfish-actions.pod:2432
23923 msgid "kill-subprocess"
23927 #: ../fish/guestfish-actions.pod:2434
23930 " kill-subprocess\n"
23935 #: ../fish/guestfish-actions.pod:2438
23940 #: ../fish/guestfish-actions.pod:2440
23945 #: ../fish/guestfish-actions.pod:2442
23953 #: ../fish/guestfish-actions.pod:2450
23958 #: ../fish/guestfish-actions.pod:2452
23961 " lchown owner group path\n"
23966 #: ../fish/guestfish-actions.pod:2454
23968 "Change the file owner to C<owner> and group to C<group>. This is like "
23969 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
23974 #: ../fish/guestfish-actions.pod:2462
23979 #: ../fish/guestfish-actions.pod:2464
23982 " lgetxattr path name\n"
23987 #: ../fish/guestfish-actions.pod:2480
23988 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
23992 #: ../fish/guestfish-actions.pod:2482
23997 #: ../fish/guestfish-actions.pod:2484
24000 " lgetxattrs path\n"
24005 #: ../fish/guestfish-actions.pod:2486
24007 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24008 "it returns the extended attributes of the link itself."
24012 #: ../fish/guestfish-actions.pod:2490
24013 msgid "list-devices"
24017 #: ../fish/guestfish-actions.pod:2492
24025 #: ../fish/guestfish-actions.pod:2500
24026 msgid "list-filesystems"
24030 #: ../fish/guestfish-actions.pod:2502
24033 " list-filesystems\n"
24038 #: ../fish/guestfish-actions.pod:2521
24040 "This command runs other libguestfs commands, which might include L</mount> "
24041 "and L</umount>, and therefore you should use this soon after launch and only "
24042 "when nothing is mounted."
24046 #: ../fish/guestfish-actions.pod:2525
24048 "Not all of the filesystems returned will be mountable. In particular, swap "
24049 "partitions are returned in the list. Also this command does not check that "
24050 "each filesystem found is valid and mountable, and some filesystems might be "
24051 "mountable but require special options. Filesystems may not all belong to a "
24052 "single logical operating system (use L</inspect-os> to look for OSes)."
24056 #: ../fish/guestfish-actions.pod:2533
24057 msgid "list-partitions"
24061 #: ../fish/guestfish-actions.pod:2535
24064 " list-partitions\n"
24069 #: ../fish/guestfish-actions.pod:2541
24071 "This does not return logical volumes. For that you will need to call "
24076 #: ../fish/guestfish-actions.pod:2546
24081 #: ../fish/guestfish-actions.pod:2548
24089 #: ../fish/guestfish-actions.pod:2556
24094 #: ../fish/guestfish-actions.pod:2558
24097 " ln target linkname\n"
24102 #: ../fish/guestfish-actions.pod:2562
24107 #: ../fish/guestfish-actions.pod:2564
24110 " ln-f target linkname\n"
24115 #: ../fish/guestfish-actions.pod:2569
24120 #: ../fish/guestfish-actions.pod:2571
24123 " ln-s target linkname\n"
24128 #: ../fish/guestfish-actions.pod:2575
24133 #: ../fish/guestfish-actions.pod:2577
24136 " ln-sf target linkname\n"
24141 #: ../fish/guestfish-actions.pod:2582
24142 msgid "lremovexattr"
24146 #: ../fish/guestfish-actions.pod:2584
24149 " lremovexattr xattr path\n"
24154 #: ../fish/guestfish-actions.pod:2586
24156 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24157 "it removes an extended attribute of the link itself."
24161 #: ../fish/guestfish-actions.pod:2590
24166 #: ../fish/guestfish-actions.pod:2592
24174 #: ../fish/guestfish-actions.pod:2598
24176 "This command is mostly useful for interactive sessions. Programs should "
24177 "probably use L</readdir> instead."
24181 #: ../fish/guestfish-actions.pod:2601
24186 #: ../fish/guestfish-actions.pod:2603
24189 " lsetxattr xattr val vallen path\n"
24194 #: ../fish/guestfish-actions.pod:2605
24196 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24197 "sets an extended attribute of the link itself."
24201 #: ../fish/guestfish-actions.pod:2609
24206 #: ../fish/guestfish-actions.pod:2611
24214 #: ../fish/guestfish-actions.pod:2615
24216 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24217 "the link is stat-ed, not the file it refers to."
24221 #: ../fish/guestfish-actions.pod:2621
24226 #: ../fish/guestfish-actions.pod:2623
24229 " lstatlist path 'names ...'\n"
24234 #: ../fish/guestfish-actions.pod:2625
24236 "This call allows you to perform the L</lstat> operation on multiple files, "
24237 "where all files are in the directory C<path>. C<names> is the list of files "
24238 "from this directory."
24242 #: ../fish/guestfish-actions.pod:2634
24244 "This call is intended for programs that want to efficiently list a directory "
24245 "contents without making many round-trips. See also L</lxattrlist> for a "
24246 "similarly efficient call for getting extended attributes. Very long "
24247 "directory listings might cause the protocol message size to be exceeded, "
24248 "causing this call to fail. The caller must split up such requests into "
24249 "smaller groups of names."
24253 #: ../fish/guestfish-actions.pod:2642
24254 msgid "luks-add-key"
24258 #: ../fish/guestfish-actions.pod:2644
24261 " luks-add-key device keyslot\n"
24266 #: ../fish/guestfish-actions.pod:2651
24268 "Note that if C<keyslot> already contains a key, then this command will "
24269 "fail. You have to use L</luks-kill-slot> first to remove that key."
24273 #: ../fish/guestfish-actions.pod:2655 ../fish/guestfish-actions.pod:2677 ../fish/guestfish-actions.pod:2690 ../fish/guestfish-actions.pod:2704 ../fish/guestfish-actions.pod:2727 ../fish/guestfish-actions.pod:2737
24275 "This command has one or more key or passphrase parameters. Guestfish will "
24276 "prompt for these separately."
24280 #: ../fish/guestfish-actions.pod:2658
24285 #: ../fish/guestfish-actions.pod:2660
24288 " luks-close device\n"
24293 #: ../fish/guestfish-actions.pod:2662
24295 "This closes a LUKS device that was created earlier by L</luks-open> or "
24296 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
24297 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
24298 "underlying block device."
24302 #: ../fish/guestfish-actions.pod:2668
24303 msgid "luks-format"
24307 #: ../fish/guestfish-actions.pod:2670
24310 " luks-format device keyslot\n"
24315 #: ../fish/guestfish-actions.pod:2683
24316 msgid "luks-format-cipher"
24320 #: ../fish/guestfish-actions.pod:2685
24323 " luks-format-cipher device keyslot cipher\n"
24328 #: ../fish/guestfish-actions.pod:2687
24330 "This command is the same as L</luks-format> but it also allows you to set "
24331 "the C<cipher> used."
24335 #: ../fish/guestfish-actions.pod:2696
24336 msgid "luks-kill-slot"
24340 #: ../fish/guestfish-actions.pod:2698
24343 " luks-kill-slot device keyslot\n"
24348 #: ../fish/guestfish-actions.pod:2707
24353 #: ../fish/guestfish-actions.pod:2709
24356 " luks-open device mapname\n"
24361 #: ../fish/guestfish-actions.pod:2723
24363 "If this block device contains LVM volume groups, then calling L</vgscan> "
24364 "followed by L</vg-activate-all> will make them visible."
24368 #: ../fish/guestfish-actions.pod:2730
24369 msgid "luks-open-ro"
24373 #: ../fish/guestfish-actions.pod:2732
24376 " luks-open-ro device mapname\n"
24381 #: ../fish/guestfish-actions.pod:2734
24383 "This is the same as L</luks-open> except that a read-only mapping is "
24388 #: ../fish/guestfish-actions.pod:2740
24393 #: ../fish/guestfish-actions.pod:2742
24396 " lvcreate logvol volgroup mbytes\n"
24401 #: ../fish/guestfish-actions.pod:2747
24402 msgid "lvm-canonical-lv-name"
24406 #: ../fish/guestfish-actions.pod:2749
24409 " lvm-canonical-lv-name lvname\n"
24414 #: ../fish/guestfish-actions.pod:2758
24415 msgid "See also L</is-lv>."
24419 #: ../fish/guestfish-actions.pod:2760
24420 msgid "lvm-clear-filter"
24424 #: ../fish/guestfish-actions.pod:2762
24427 " lvm-clear-filter\n"
24432 #: ../fish/guestfish-actions.pod:2764
24434 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24439 #: ../fish/guestfish-actions.pod:2770
24440 msgid "lvm-remove-all"
24444 #: ../fish/guestfish-actions.pod:2772
24447 " lvm-remove-all\n"
24452 #: ../fish/guestfish-actions.pod:2780
24453 msgid "lvm-set-filter"
24457 #: ../fish/guestfish-actions.pod:2782
24460 " lvm-set-filter 'devices ...'\n"
24465 #: ../fish/guestfish-actions.pod:2807
24470 #: ../fish/guestfish-actions.pod:2809
24473 " lvremove device\n"
24478 #: ../fish/guestfish-actions.pod:2817
24483 #: ../fish/guestfish-actions.pod:2819
24486 " lvrename logvol newlogvol\n"
24491 #: ../fish/guestfish-actions.pod:2823
24496 #: ../fish/guestfish-actions.pod:2825
24499 " lvresize device mbytes\n"
24504 #: ../fish/guestfish-actions.pod:2831
24505 msgid "lvresize-free"
24509 #: ../fish/guestfish-actions.pod:2833
24512 " lvresize-free lv percent\n"
24517 #: ../fish/guestfish-actions.pod:2841
24522 #: ../fish/guestfish-actions.pod:2843
24530 #: ../fish/guestfish-actions.pod:2851
24531 msgid "See also L</lvs-full>, L</list-filesystems>."
24535 #: ../fish/guestfish-actions.pod:2853
24540 #: ../fish/guestfish-actions.pod:2855
24548 #: ../fish/guestfish-actions.pod:2860
24553 #: ../fish/guestfish-actions.pod:2862
24561 #: ../fish/guestfish-actions.pod:2866
24566 #: ../fish/guestfish-actions.pod:2868
24569 " lxattrlist path 'names ...'\n"
24574 #: ../fish/guestfish-actions.pod:2884
24576 "This call is intended for programs that want to efficiently list a directory "
24577 "contents without making many round-trips. See also L</lstatlist> for a "
24578 "similarly efficient call for getting standard stats. Very long directory "
24579 "listings might cause the protocol message size to be exceeded, causing this "
24580 "call to fail. The caller must split up such requests into smaller groups of "
24585 #: ../fish/guestfish-actions.pod:2892
24590 #: ../fish/guestfish-actions.pod:2894
24598 #: ../fish/guestfish-actions.pod:2898
24603 #: ../fish/guestfish-actions.pod:2900
24606 " mkdir-mode path mode\n"
24611 #: ../fish/guestfish-actions.pod:2909
24612 msgid "See also L</mkdir>, L</umask>"
24616 #: ../fish/guestfish-actions.pod:2911
24621 #: ../fish/guestfish-actions.pod:2913
24629 #: ../fish/guestfish-actions.pod:2918
24634 #: ../fish/guestfish-actions.pod:2920
24637 " mkdtemp template\n"
24642 #: ../fish/guestfish-actions.pod:2941
24647 #: ../fish/guestfish-actions.pod:2943
24650 " mke2fs-J fstype blocksize device journal\n"
24655 #: ../fish/guestfish-actions.pod:2951
24656 msgid "See also L</mke2journal>."
24660 #: ../fish/guestfish-actions.pod:2953
24665 #: ../fish/guestfish-actions.pod:2955
24668 " mke2fs-JL fstype blocksize device label\n"
24673 #: ../fish/guestfish-actions.pod:2960
24674 msgid "See also L</mke2journal-L>."
24678 #: ../fish/guestfish-actions.pod:2962
24683 #: ../fish/guestfish-actions.pod:2964
24686 " mke2fs-JU fstype blocksize device uuid\n"
24691 #: ../fish/guestfish-actions.pod:2969
24692 msgid "See also L</mke2journal-U>."
24696 #: ../fish/guestfish-actions.pod:2971
24697 msgid "mke2journal"
24701 #: ../fish/guestfish-actions.pod:2973
24704 " mke2journal blocksize device\n"
24709 #: ../fish/guestfish-actions.pod:2980
24710 msgid "mke2journal-L"
24714 #: ../fish/guestfish-actions.pod:2982
24717 " mke2journal-L blocksize label device\n"
24722 #: ../fish/guestfish-actions.pod:2986
24723 msgid "mke2journal-U"
24727 #: ../fish/guestfish-actions.pod:2988
24730 " mke2journal-U blocksize uuid device\n"
24735 #: ../fish/guestfish-actions.pod:2992
24740 #: ../fish/guestfish-actions.pod:2994
24743 " mkfifo mode path\n"
24748 #: ../fish/guestfish-actions.pod:2996
24750 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
24751 "is just a convenient wrapper around L</mknod>."
24755 #: ../fish/guestfish-actions.pod:3002
24760 #: ../fish/guestfish-actions.pod:3004
24763 " mkfs fstype device\n"
24768 #: ../fish/guestfish-actions.pod:3010
24773 #: ../fish/guestfish-actions.pod:3012
24776 " mkfs-b fstype blocksize device\n"
24781 #: ../fish/guestfish-actions.pod:3014
24783 "This call is similar to L</mkfs>, but it allows you to control the block "
24784 "size of the resulting filesystem. Supported block sizes depend on the "
24785 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
24789 #: ../fish/guestfish-actions.pod:3029
24794 #: ../fish/guestfish-actions.pod:3031
24797 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
24802 #: ../fish/guestfish-actions.pod:3066
24803 msgid "mkmountpoint"
24807 #: ../fish/guestfish-actions.pod:3068
24810 " mkmountpoint exemptpath\n"
24815 #: ../fish/guestfish-actions.pod:3070
24817 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
24818 "to create extra mountpoints before mounting the first filesystem."
24822 #: ../fish/guestfish-actions.pod:3094
24824 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
24825 "unexpected errors if you try to mix these calls. It is safest to manually "
24826 "unmount filesystems and remove mountpoints after use."
24830 #: ../fish/guestfish-actions.pod:3098
24832 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
24833 "for this to work for manual mountpoints, you must ensure that the innermost "
24834 "mountpoints have the longest pathnames, as in the example code above."
24838 #: ../fish/guestfish-actions.pod:3105
24840 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
24841 "L</umount-all> to be called when the handle is closed which can also trigger "
24846 #: ../fish/guestfish-actions.pod:3109
24851 #: ../fish/guestfish-actions.pod:3111
24854 " mknod mode devmajor devminor path\n"
24859 #: ../fish/guestfish-actions.pod:3121
24861 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
24862 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
24863 "regular file). These constants are available in the standard Linux header "
24864 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
24865 "wrappers around this command which bitwise OR in the appropriate constant "
24870 #: ../fish/guestfish-actions.pod:3131
24875 #: ../fish/guestfish-actions.pod:3133
24878 " mknod-b mode devmajor devminor path\n"
24883 #: ../fish/guestfish-actions.pod:3135
24885 "This call creates a block device node called C<path> with mode C<mode> and "
24886 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24887 "wrapper around L</mknod>."
24891 #: ../fish/guestfish-actions.pod:3141
24896 #: ../fish/guestfish-actions.pod:3143
24899 " mknod-c mode devmajor devminor path\n"
24904 #: ../fish/guestfish-actions.pod:3145
24906 "This call creates a char device node called C<path> with mode C<mode> and "
24907 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24908 "wrapper around L</mknod>."
24912 #: ../fish/guestfish-actions.pod:3151
24917 #: ../fish/guestfish-actions.pod:3153
24925 #: ../fish/guestfish-actions.pod:3157
24930 #: ../fish/guestfish-actions.pod:3159
24933 " mkswap-L label device\n"
24938 #: ../fish/guestfish-actions.pod:3167
24943 #: ../fish/guestfish-actions.pod:3169
24946 " mkswap-U uuid device\n"
24951 #: ../fish/guestfish-actions.pod:3173
24952 msgid "mkswap-file"
24956 #: ../fish/guestfish-actions.pod:3175
24959 " mkswap-file path\n"
24964 #: ../fish/guestfish-actions.pod:3179
24966 "This command just writes a swap file signature to an existing file. To "
24967 "create the file itself, use something like L</fallocate>."
24971 #: ../fish/guestfish-actions.pod:3182
24976 #: ../fish/guestfish-actions.pod:3184
24979 " modprobe modulename\n"
24984 #: ../fish/guestfish-actions.pod:3191
24989 #: ../fish/guestfish-actions.pod:3193
24992 " mount device mountpoint\n"
24997 #: ../fish/guestfish-actions.pod:3209
24999 "B<Important note:> When you use this call, the filesystem options C<sync> "
25000 "and C<noatime> are set implicitly. This was originally done because we "
25001 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25002 "very large negative performance impact and negligible effect on "
25003 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25004 "code that needs performance, and instead use L</mount-options> (use an empty "
25005 "string for the first parameter if you don't want any options)."
25009 #: ../fish/guestfish-actions.pod:3226
25014 #: ../fish/guestfish-actions.pod:3228
25017 " mount-loop file mountpoint\n"
25022 #: ../fish/guestfish-actions.pod:3234
25023 msgid "mount-options"
25027 #: ../fish/guestfish-actions.pod:3236
25030 " mount-options options device mountpoint\n"
25035 #: ../fish/guestfish-actions.pod:3238
25037 "This is the same as the L</mount> command, but it allows you to set the "
25038 "mount options as for the L<mount(8)> I<-o> flag."
25042 #: ../fish/guestfish-actions.pod:3246
25047 #: ../fish/guestfish-actions.pod:3248
25050 " mount-ro device mountpoint\n"
25055 #: ../fish/guestfish-actions.pod:3250
25057 "This is the same as the L</mount> command, but it mounts the filesystem with "
25058 "the read-only (I<-o ro>) flag."
25062 #: ../fish/guestfish-actions.pod:3253
25067 #: ../fish/guestfish-actions.pod:3255
25070 " mount-vfs options vfstype device mountpoint\n"
25075 #: ../fish/guestfish-actions.pod:3257
25077 "This is the same as the L</mount> command, but it allows you to set both the "
25078 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25082 #: ../fish/guestfish-actions.pod:3261
25083 msgid "mountpoints"
25087 #: ../fish/guestfish-actions.pod:3263
25095 #: ../fish/guestfish-actions.pod:3265
25097 "This call is similar to L</mounts>. That call returns a list of devices. "
25098 "This one returns a hash table (map) of device name to directory where the "
25099 "device is mounted."
25103 #: ../fish/guestfish-actions.pod:3269
25108 #: ../fish/guestfish-actions.pod:3271
25116 #: ../fish/guestfish-actions.pod:3278
25117 msgid "See also: L</mountpoints>"
25121 #: ../fish/guestfish-actions.pod:3280
25126 #: ../fish/guestfish-actions.pod:3282
25134 #: ../fish/guestfish-actions.pod:3287
25135 msgid "ntfs-3g-probe"
25139 #: ../fish/guestfish-actions.pod:3289
25142 " ntfs-3g-probe true|false device\n"
25147 #: ../fish/guestfish-actions.pod:3303
25152 #: ../fish/guestfish-actions.pod:3305
25155 " ntfsresize device\n"
25160 #: ../fish/guestfish-actions.pod:3311
25161 msgid "ntfsresize-size"
25165 #: ../fish/guestfish-actions.pod:3313
25168 " ntfsresize-size device size\n"
25173 #: ../fish/guestfish-actions.pod:3315
25175 "This command is the same as L</ntfsresize> except that it allows you to "
25176 "specify the new size (in bytes) explicitly."
25180 #: ../fish/guestfish-actions.pod:3318
25185 #: ../fish/guestfish-actions.pod:3320
25188 " part-add device prlogex startsect endsect\n"
25193 #: ../fish/guestfish-actions.pod:3322
25195 "This command adds a partition to C<device>. If there is no partition table "
25196 "on the device, call L</part-init> first."
25200 #: ../fish/guestfish-actions.pod:3334
25202 "Creating a partition which covers the whole disk is not so easy. Use "
25203 "L</part-disk> to do that."
25207 #: ../fish/guestfish-actions.pod:3337
25212 #: ../fish/guestfish-actions.pod:3339
25215 " part-del device partnum\n"
25220 #: ../fish/guestfish-actions.pod:3347
25225 #: ../fish/guestfish-actions.pod:3349
25228 " part-disk device parttype\n"
25233 #: ../fish/guestfish-actions.pod:3351
25235 "This command is simply a combination of L</part-init> followed by "
25236 "L</part-add> to create a single primary partition covering the whole disk."
25240 #: ../fish/guestfish-actions.pod:3355
25242 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25243 "possible values are described in L</part-init>."
25247 #: ../fish/guestfish-actions.pod:3361
25248 msgid "part-get-bootable"
25252 #: ../fish/guestfish-actions.pod:3363
25255 " part-get-bootable device partnum\n"
25260 #: ../fish/guestfish-actions.pod:3368
25261 msgid "See also L</part-set-bootable>."
25265 #: ../fish/guestfish-actions.pod:3370
25266 msgid "part-get-mbr-id"
25270 #: ../fish/guestfish-actions.pod:3372
25273 " part-get-mbr-id device partnum\n"
25278 #: ../fish/guestfish-actions.pod:3377 ../fish/guestfish-actions.pod:3515
25280 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25281 "undefined results for other partition table types (see "
25282 "L</part-get-parttype>)."
25286 #: ../fish/guestfish-actions.pod:3381
25287 msgid "part-get-parttype"
25291 #: ../fish/guestfish-actions.pod:3383
25294 " part-get-parttype device\n"
25299 #: ../fish/guestfish-actions.pod:3388
25301 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25302 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25303 "possible, although unusual. See L</part-init> for a full list."
25307 #: ../fish/guestfish-actions.pod:3393
25312 #: ../fish/guestfish-actions.pod:3395
25315 " part-init device parttype\n"
25320 #: ../fish/guestfish-actions.pod:3401
25322 "Initially there are no partitions. Following this, you should call "
25323 "L</part-add> for each partition required."
25327 #: ../fish/guestfish-actions.pod:3464
25332 #: ../fish/guestfish-actions.pod:3466
25335 " part-list device\n"
25340 #: ../fish/guestfish-actions.pod:3481
25342 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25343 "the device's sector size, see L</blockdev-getss>."
25347 #: ../fish/guestfish-actions.pod:3494
25348 msgid "part-set-bootable"
25352 #: ../fish/guestfish-actions.pod:3496
25355 " part-set-bootable device partnum true|false\n"
25360 #: ../fish/guestfish-actions.pod:3505
25361 msgid "part-set-mbr-id"
25365 #: ../fish/guestfish-actions.pod:3507
25368 " part-set-mbr-id device partnum idbyte\n"
25373 #: ../fish/guestfish-actions.pod:3519
25374 msgid "part-set-name"
25378 #: ../fish/guestfish-actions.pod:3521
25381 " part-set-name device partnum name\n"
25386 #: ../fish/guestfish-actions.pod:3529
25387 msgid "part-to-dev"
25391 #: ../fish/guestfish-actions.pod:3531
25394 " part-to-dev partition\n"
25399 #: ../fish/guestfish-actions.pod:3537
25401 "The named partition must exist, for example as a string returned from "
25402 "L</list-partitions>."
25406 #: ../fish/guestfish-actions.pod:3540
25407 msgid "ping-daemon"
25411 #: ../fish/guestfish-actions.pod:3542
25419 #: ../fish/guestfish-actions.pod:3549
25424 #: ../fish/guestfish-actions.pod:3551
25427 " pread path count offset\n"
25432 #: ../fish/guestfish-actions.pod:3559
25433 msgid "See also L</pwrite>, L</pread-device>."
25437 #: ../fish/guestfish-actions.pod:3564
25438 msgid "pread-device"
25442 #: ../fish/guestfish-actions.pod:3566
25445 " pread-device device count offset\n"
25450 #: ../fish/guestfish-actions.pod:3574
25451 msgid "See also L</pread>."
25455 #: ../fish/guestfish-actions.pod:3579
25460 #: ../fish/guestfish-actions.pod:3581
25463 " pvcreate device\n"
25468 #: ../fish/guestfish-actions.pod:3587
25473 #: ../fish/guestfish-actions.pod:3589
25476 " pvremove device\n"
25481 #: ../fish/guestfish-actions.pod:3598
25486 #: ../fish/guestfish-actions.pod:3600
25489 " pvresize device\n"
25494 #: ../fish/guestfish-actions.pod:3605
25495 msgid "pvresize-size"
25499 #: ../fish/guestfish-actions.pod:3607
25502 " pvresize-size device size\n"
25507 #: ../fish/guestfish-actions.pod:3609
25509 "This command is the same as L</pvresize> except that it allows you to "
25510 "specify the new size (in bytes) explicitly."
25514 #: ../fish/guestfish-actions.pod:3612
25519 #: ../fish/guestfish-actions.pod:3614
25527 #: ../fish/guestfish-actions.pod:3622
25528 msgid "See also L</pvs-full>."
25532 #: ../fish/guestfish-actions.pod:3624
25537 #: ../fish/guestfish-actions.pod:3626
25545 #: ../fish/guestfish-actions.pod:3631
25550 #: ../fish/guestfish-actions.pod:3633
25558 #: ../fish/guestfish-actions.pod:3637
25563 #: ../fish/guestfish-actions.pod:3639
25566 " pwrite path content offset\n"
25571 #: ../fish/guestfish-actions.pod:3650
25572 msgid "See also L</pread>, L</pwrite-device>."
25576 #: ../fish/guestfish-actions.pod:3655
25577 msgid "pwrite-device"
25581 #: ../fish/guestfish-actions.pod:3657
25584 " pwrite-device device content offset\n"
25589 #: ../fish/guestfish-actions.pod:3667
25590 msgid "See also L</pwrite>."
25594 #: ../fish/guestfish-actions.pod:3672
25599 #: ../fish/guestfish-actions.pod:3674
25602 " read-file path\n"
25607 #: ../fish/guestfish-actions.pod:3679
25609 "Unlike L</cat>, this function can correctly handle files that contain "
25610 "embedded ASCII NUL characters. However unlike L</download>, this function "
25611 "is limited in the total size of file that can be handled."
25615 #: ../fish/guestfish-actions.pod:3687
25620 #: ../fish/guestfish-actions.pod:3689
25623 " read-lines path\n"
25628 #: ../fish/guestfish-actions.pod:3696
25630 "Note that this function cannot correctly handle binary files (specifically, "
25631 "files containing C<\\0> character which is treated as end of line). For "
25632 "those you need to use the L</read-file> function which has a more complex "
25637 #: ../fish/guestfish-actions.pod:3701
25642 #: ../fish/guestfish-actions.pod:3703
25650 #: ../fish/guestfish-actions.pod:3755
25652 "This function is primarily intended for use by programs. To get a simple "
25653 "list of names, use L</ls>. To get a printable directory for human "
25654 "consumption, use L</ll>."
25658 #: ../fish/guestfish-actions.pod:3759
25663 #: ../fish/guestfish-actions.pod:3761
25671 #: ../fish/guestfish-actions.pod:3765
25672 msgid "readlinklist"
25676 #: ../fish/guestfish-actions.pod:3767
25679 " readlinklist path 'names ...'\n"
25684 #: ../fish/guestfish-actions.pod:3791
25689 #: ../fish/guestfish-actions.pod:3793
25697 #: ../fish/guestfish-actions.pod:3798
25698 msgid "removexattr"
25702 #: ../fish/guestfish-actions.pod:3800
25705 " removexattr xattr path\n"
25710 #: ../fish/guestfish-actions.pod:3805
25711 msgid "See also: L</lremovexattr>, L<attr(5)>."
25715 #: ../fish/guestfish-actions.pod:3807
25720 #: ../fish/guestfish-actions.pod:3809
25723 " resize2fs device\n"
25728 #: ../fish/guestfish-actions.pod:3814
25730 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
25731 "before calling this command. For unknown reasons C<resize2fs> sometimes "
25732 "gives an error about this and sometimes not. In any case, it is always safe "
25733 "to call L</e2fsck-f> before calling this function."
25737 #: ../fish/guestfish-actions.pod:3820
25738 msgid "resize2fs-M"
25742 #: ../fish/guestfish-actions.pod:3822
25745 " resize2fs-M device\n"
25750 #: ../fish/guestfish-actions.pod:3824
25752 "This command is the same as L</resize2fs>, but the filesystem is resized to "
25753 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
25758 #: ../fish/guestfish-actions.pod:3828
25760 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
25761 "and read the C<Block size> and C<Block count> values. These two numbers, "
25762 "multiplied together, give the resulting size of the minimal filesystem in "
25767 #: ../fish/guestfish-actions.pod:3833
25768 msgid "resize2fs-size"
25772 #: ../fish/guestfish-actions.pod:3835
25775 " resize2fs-size device size\n"
25780 #: ../fish/guestfish-actions.pod:3837
25782 "This command is the same as L</resize2fs> except that it allows you to "
25783 "specify the new size (in bytes) explicitly."
25787 #: ../fish/guestfish-actions.pod:3840
25792 #: ../fish/guestfish-actions.pod:3842
25800 #: ../fish/guestfish-actions.pod:3846
25805 #: ../fish/guestfish-actions.pod:3848
25813 #: ../fish/guestfish-actions.pod:3854
25818 #: ../fish/guestfish-actions.pod:3856
25826 #: ../fish/guestfish-actions.pod:3860
25827 msgid "rmmountpoint"
25831 #: ../fish/guestfish-actions.pod:3862
25834 " rmmountpoint exemptpath\n"
25839 #: ../fish/guestfish-actions.pod:3864
25841 "This calls removes a mountpoint that was previously created with "
25842 "L</mkmountpoint>. See L</mkmountpoint> for full details."
25846 #: ../fish/guestfish-actions.pod:3868
25847 msgid "scrub-device"
25851 #: ../fish/guestfish-actions.pod:3870
25854 " scrub-device device\n"
25859 #: ../fish/guestfish-actions.pod:3881
25864 #: ../fish/guestfish-actions.pod:3883
25867 " scrub-file file\n"
25872 #: ../fish/guestfish-actions.pod:3893
25873 msgid "scrub-freespace"
25877 #: ../fish/guestfish-actions.pod:3895
25880 " scrub-freespace dir\n"
25885 #: ../fish/guestfish-actions.pod:3897
25887 "This command creates the directory C<dir> and then fills it with files until "
25888 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
25889 "deletes them. The intention is to scrub any free space on the partition "
25890 "containing C<dir>."
25894 #: ../fish/guestfish-actions.pod:3906
25899 #: ../fish/guestfish-actions.pod:3908
25904 #: ../fish/guestfish-actions.pod:3910
25907 " set-append append\n"
25912 #: ../fish/guestfish-actions.pod:3921
25913 msgid "set-attach-method"
25917 #: ../fish/guestfish-actions.pod:3923
25918 msgid "attach-method"
25922 #: ../fish/guestfish-actions.pod:3925
25925 " set-attach-method attachmethod\n"
25930 #: ../fish/guestfish-actions.pod:3947
25931 msgid "set-autosync"
25935 #: ../fish/guestfish-actions.pod:3949
25940 #: ../fish/guestfish-actions.pod:3951
25943 " set-autosync true|false\n"
25948 #: ../fish/guestfish-actions.pod:3961
25953 #: ../fish/guestfish-actions.pod:3963
25958 #: ../fish/guestfish-actions.pod:3965
25961 " set-direct true|false\n"
25966 #: ../fish/guestfish-actions.pod:3971
25968 "One consequence of this is that log messages aren't caught by the library "
25969 "and handled by L</set-log-message-callback>, but go straight to stdout."
25973 #: ../fish/guestfish-actions.pod:3980
25974 msgid "set-e2label"
25978 #: ../fish/guestfish-actions.pod:3982
25981 " set-e2label device label\n"
25986 #: ../fish/guestfish-actions.pod:3988
25988 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
25989 "label on a filesystem."
25993 #: ../fish/guestfish-actions.pod:3991
25998 #: ../fish/guestfish-actions.pod:3993
26001 " set-e2uuid device uuid\n"
26006 #: ../fish/guestfish-actions.pod:4000
26008 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26009 "UUID of a filesystem."
26013 #: ../fish/guestfish-actions.pod:4003
26014 msgid "set-memsize"
26018 #: ../fish/guestfish-actions.pod:4005
26023 #: ../fish/guestfish-actions.pod:4007
26026 " set-memsize memsize\n"
26031 #: ../fish/guestfish-actions.pod:4009
26033 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26034 "This only has any effect if called before L</launch>."
26038 #: ../fish/guestfish-actions.pod:4020
26039 msgid "set-network"
26043 #: ../fish/guestfish-actions.pod:4022
26048 #: ../fish/guestfish-actions.pod:4024
26051 " set-network true|false\n"
26056 #: ../fish/guestfish-actions.pod:4032
26057 msgid "You must call this before calling L</launch>, otherwise it has no effect."
26061 #: ../fish/guestfish-actions.pod:4035
26066 #: ../fish/guestfish-actions.pod:4037
26071 #: ../fish/guestfish-actions.pod:4039
26074 " set-path searchpath\n"
26079 #: ../fish/guestfish-actions.pod:4048
26084 #: ../fish/guestfish-actions.pod:4050
26089 #: ../fish/guestfish-actions.pod:4052
26097 #: ../fish/guestfish-actions.pod:4072
26098 msgid "set-recovery-proc"
26102 #: ../fish/guestfish-actions.pod:4074
26103 msgid "recovery-proc"
26107 #: ../fish/guestfish-actions.pod:4076
26110 " set-recovery-proc true|false\n"
26115 #: ../fish/guestfish-actions.pod:4078
26117 "If this is called with the parameter C<false> then L</launch> does not "
26118 "create a recovery process. The purpose of the recovery process is to stop "
26119 "runaway qemu processes in the case where the main program aborts abruptly."
26123 #: ../fish/guestfish-actions.pod:4083
26125 "This only has any effect if called before L</launch>, and the default is "
26130 #: ../fish/guestfish-actions.pod:4092
26131 msgid "set-selinux"
26135 #: ../fish/guestfish-actions.pod:4094
26140 #: ../fish/guestfish-actions.pod:4096
26143 " set-selinux true|false\n"
26148 #: ../fish/guestfish-actions.pod:4107
26153 #: ../fish/guestfish-actions.pod:4109
26158 #: ../fish/guestfish-actions.pod:4111
26161 " set-trace true|false\n"
26166 #: ../fish/guestfish-actions.pod:4123
26168 "Trace messages are normally sent to C<stderr>, unless you register a "
26169 "callback to send them somewhere else (see L</set-event-callback>)."
26173 #: ../fish/guestfish-actions.pod:4127
26174 msgid "set-verbose"
26178 #: ../fish/guestfish-actions.pod:4129
26183 #: ../fish/guestfish-actions.pod:4131
26186 " set-verbose true|false\n"
26191 #: ../fish/guestfish-actions.pod:4138
26193 "Verbose messages are normally sent to C<stderr>, unless you register a "
26194 "callback to send them somewhere else (see L</set-event-callback>)."
26198 #: ../fish/guestfish-actions.pod:4142
26203 #: ../fish/guestfish-actions.pod:4144
26206 " setcon context\n"
26211 #: ../fish/guestfish-actions.pod:4151
26216 #: ../fish/guestfish-actions.pod:4153
26219 " setxattr xattr val vallen path\n"
26224 #: ../fish/guestfish-actions.pod:4159
26225 msgid "See also: L</lsetxattr>, L<attr(5)>."
26229 #: ../fish/guestfish-actions.pod:4161
26234 #: ../fish/guestfish-actions.pod:4163
26237 " sfdisk device cyls heads sectors 'lines ...'\n"
26242 #: ../fish/guestfish-actions.pod:4185
26243 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26247 #: ../fish/guestfish-actions.pod:4198
26252 #: ../fish/guestfish-actions.pod:4200
26255 " sfdiskM device 'lines ...'\n"
26260 #: ../fish/guestfish-actions.pod:4202
26262 "This is a simplified interface to the L</sfdisk> command, where partition "
26263 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26264 "you don't need to specify the cyls, heads and sectors parameters which were "
26265 "rarely if ever used anyway."
26269 #: ../fish/guestfish-actions.pod:4208
26270 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26274 #: ../fish/guestfish-actions.pod:4221
26279 #: ../fish/guestfish-actions.pod:4223
26282 " sfdisk-N device partnum cyls heads sectors line\n"
26287 #: ../fish/guestfish-actions.pod:4228
26289 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26290 "cyls/heads/sectors parameters."
26294 #: ../fish/guestfish-actions.pod:4231
26295 msgid "See also: L</part-add>"
26299 #: ../fish/guestfish-actions.pod:4243
26300 msgid "sfdisk-disk-geometry"
26304 #: ../fish/guestfish-actions.pod:4245
26307 " sfdisk-disk-geometry device\n"
26312 #: ../fish/guestfish-actions.pod:4247
26314 "This displays the disk geometry of C<device> read from the partition table. "
26315 "Especially in the case where the underlying block device has been resized, "
26316 "this can be different from the kernel's idea of the geometry (see "
26317 "L</sfdisk-kernel-geometry>)."
26321 #: ../fish/guestfish-actions.pod:4255
26322 msgid "sfdisk-kernel-geometry"
26326 #: ../fish/guestfish-actions.pod:4257
26329 " sfdisk-kernel-geometry device\n"
26334 #: ../fish/guestfish-actions.pod:4264
26339 #: ../fish/guestfish-actions.pod:4266
26342 " sfdisk-l device\n"
26347 #: ../fish/guestfish-actions.pod:4272
26348 msgid "See also: L</part-list>"
26352 #: ../fish/guestfish-actions.pod:4281
26357 #: ../fish/guestfish-actions.pod:4283
26365 #: ../fish/guestfish-actions.pod:4288
26366 msgid "This is like L</command>, but passes the command to:"
26370 #: ../fish/guestfish-actions.pod:4296
26371 msgid "All the provisos about L</command> apply to this call."
26375 #: ../fish/guestfish-actions.pod:4298
26380 #: ../fish/guestfish-actions.pod:4300
26383 " sh-lines command\n"
26388 #: ../fish/guestfish-actions.pod:4302
26389 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26393 #: ../fish/guestfish-actions.pod:4305
26394 msgid "See also: L</command-lines>"
26398 #: ../fish/guestfish-actions.pod:4307
26403 #: ../fish/guestfish-actions.pod:4309
26411 #: ../fish/guestfish-actions.pod:4313
26416 #: ../fish/guestfish-actions.pod:4315
26424 #: ../fish/guestfish-actions.pod:4321
26429 #: ../fish/guestfish-actions.pod:4323
26437 #: ../fish/guestfish-actions.pod:4331
26442 #: ../fish/guestfish-actions.pod:4333
26450 #: ../fish/guestfish-actions.pod:4341
26455 #: ../fish/guestfish-actions.pod:4343
26458 " strings-e encoding path\n"
26463 #: ../fish/guestfish-actions.pod:4345
26465 "This is like the L</strings> command, but allows you to specify the encoding "
26466 "of strings that are looked for in the source file C<path>."
26470 #: ../fish/guestfish-actions.pod:4355
26472 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26473 "ISO-8859-X (this is what L</strings> uses)."
26477 #: ../fish/guestfish-actions.pod:4387
26478 msgid "swapoff-device"
26482 #: ../fish/guestfish-actions.pod:4389
26485 " swapoff-device device\n"
26490 #: ../fish/guestfish-actions.pod:4391
26492 "This command disables the libguestfs appliance swap device or partition "
26493 "named C<device>. See L</swapon-device>."
26497 #: ../fish/guestfish-actions.pod:4395
26498 msgid "swapoff-file"
26502 #: ../fish/guestfish-actions.pod:4397
26505 " swapoff-file file\n"
26510 #: ../fish/guestfish-actions.pod:4401
26511 msgid "swapoff-label"
26515 #: ../fish/guestfish-actions.pod:4403
26518 " swapoff-label label\n"
26523 #: ../fish/guestfish-actions.pod:4408
26524 msgid "swapoff-uuid"
26528 #: ../fish/guestfish-actions.pod:4410
26531 " swapoff-uuid uuid\n"
26536 #: ../fish/guestfish-actions.pod:4415
26537 msgid "swapon-device"
26541 #: ../fish/guestfish-actions.pod:4417
26544 " swapon-device device\n"
26549 #: ../fish/guestfish-actions.pod:4419
26551 "This command enables the libguestfs appliance to use the swap device or "
26552 "partition named C<device>. The increased memory is made available for all "
26553 "commands, for example those run using L</command> or L</sh>."
26557 #: ../fish/guestfish-actions.pod:4431
26558 msgid "swapon-file"
26562 #: ../fish/guestfish-actions.pod:4433
26565 " swapon-file file\n"
26570 #: ../fish/guestfish-actions.pod:4435
26571 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26575 #: ../fish/guestfish-actions.pod:4438
26576 msgid "swapon-label"
26580 #: ../fish/guestfish-actions.pod:4440
26583 " swapon-label label\n"
26588 #: ../fish/guestfish-actions.pod:4442
26590 "This command enables swap to a labeled swap partition. See "
26591 "L</swapon-device> for other notes."
26595 #: ../fish/guestfish-actions.pod:4445
26596 msgid "swapon-uuid"
26600 #: ../fish/guestfish-actions.pod:4447
26603 " swapon-uuid uuid\n"
26608 #: ../fish/guestfish-actions.pod:4449
26610 "This command enables swap to a swap partition with the given UUID. See "
26611 "L</swapon-device> for other notes."
26615 #: ../fish/guestfish-actions.pod:4452
26620 #: ../fish/guestfish-actions.pod:4454
26628 #: ../fish/guestfish-actions.pod:4462
26633 #: ../fish/guestfish-actions.pod:4464
26641 #: ../fish/guestfish-actions.pod:4472
26646 #: ../fish/guestfish-actions.pod:4474
26649 " tail-n nrlines path\n"
26654 #: ../fish/guestfish-actions.pod:4487
26659 #: ../fish/guestfish-actions.pod:4489
26662 " tar-in (tarfile|-) directory\n"
26667 #: ../fish/guestfish-actions.pod:4494
26668 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26672 #: ../fish/guestfish-actions.pod:4499
26677 #: ../fish/guestfish-actions.pod:4501
26680 " tar-out directory (tarfile|-)\n"
26685 #: ../fish/guestfish-actions.pod:4506
26686 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26690 #: ../fish/guestfish-actions.pod:4511
26695 #: ../fish/guestfish-actions.pod:4513
26698 " tgz-in (tarball|-) directory\n"
26703 #: ../fish/guestfish-actions.pod:4518
26704 msgid "To upload an uncompressed tarball, use L</tar-in>."
26708 #: ../fish/guestfish-actions.pod:4522
26713 #: ../fish/guestfish-actions.pod:4524
26716 " tgz-out directory (tarball|-)\n"
26721 #: ../fish/guestfish-actions.pod:4529
26722 msgid "To download an uncompressed tarball, use L</tar-out>."
26726 #: ../fish/guestfish-actions.pod:4533
26731 #: ../fish/guestfish-actions.pod:4535
26739 #: ../fish/guestfish-actions.pod:4544
26744 #: ../fish/guestfish-actions.pod:4546
26752 #: ../fish/guestfish-actions.pod:4551
26753 msgid "truncate-size"
26757 #: ../fish/guestfish-actions.pod:4553
26760 " truncate-size path size\n"
26765 #: ../fish/guestfish-actions.pod:4558
26767 "If the current file size is less than C<size> then the file is extended to "
26768 "the required size with zero bytes. This creates a sparse file (ie. disk "
26769 "blocks are not allocated for the file until you write to it). To create a "
26770 "non-sparse file of zeroes, use L</fallocate64> instead."
26774 #: ../fish/guestfish-actions.pod:4564
26779 #: ../fish/guestfish-actions.pod:4566
26782 " tune2fs-l device\n"
26787 #: ../fish/guestfish-actions.pod:4576
26792 #: ../fish/guestfish-actions.pod:4578
26795 " txz-in (tarball|-) directory\n"
26800 #: ../fish/guestfish-actions.pod:4585
26805 #: ../fish/guestfish-actions.pod:4587
26808 " txz-out directory (tarball|-)\n"
26813 #: ../fish/guestfish-actions.pod:4594
26818 #: ../fish/guestfish-actions.pod:4596
26826 #: ../fish/guestfish-actions.pod:4610
26827 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
26831 #: ../fish/guestfish-actions.pod:4615
26836 #: ../fish/guestfish-actions.pod:4617
26841 #: ../fish/guestfish-actions.pod:4619
26844 " umount pathordevice\n"
26849 #: ../fish/guestfish-actions.pod:4625
26854 #: ../fish/guestfish-actions.pod:4627
26855 msgid "unmount-all"
26859 #: ../fish/guestfish-actions.pod:4629
26867 #: ../fish/guestfish-actions.pod:4635
26872 #: ../fish/guestfish-actions.pod:4637
26875 " upload (filename|-) remotefilename\n"
26880 #: ../fish/guestfish-actions.pod:4644
26881 msgid "See also L</download>."
26885 #: ../fish/guestfish-actions.pod:4648
26886 msgid "upload-offset"
26890 #: ../fish/guestfish-actions.pod:4650
26893 " upload-offset (filename|-) remotefilename offset\n"
26898 #: ../fish/guestfish-actions.pod:4662
26900 "Note that there is no limit on the amount of data that can be uploaded with "
26901 "this call, unlike with L</pwrite>, and this call always writes the full "
26902 "amount unless an error occurs."
26906 #: ../fish/guestfish-actions.pod:4667
26907 msgid "See also L</upload>, L</pwrite>."
26911 #: ../fish/guestfish-actions.pod:4671
26916 #: ../fish/guestfish-actions.pod:4673
26919 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
26924 #: ../fish/guestfish-actions.pod:4692
26929 #: ../fish/guestfish-actions.pod:4694
26937 #: ../fish/guestfish-actions.pod:4721
26939 "I<Note:> Don't use this call to test for availability of features. In "
26940 "enterprise distributions we backport features from later versions into "
26941 "earlier versions, making this an unreliable way to test for features. Use "
26942 "L</available> instead."
26946 #: ../fish/guestfish-actions.pod:4727
26951 #: ../fish/guestfish-actions.pod:4729
26954 " vfs-label device\n"
26959 #: ../fish/guestfish-actions.pod:4736
26960 msgid "To find a filesystem from the label, use L</findfs-label>."
26964 #: ../fish/guestfish-actions.pod:4738
26969 #: ../fish/guestfish-actions.pod:4740
26972 " vfs-type device\n"
26977 #: ../fish/guestfish-actions.pod:4750
26982 #: ../fish/guestfish-actions.pod:4752
26985 " vfs-uuid device\n"
26990 #: ../fish/guestfish-actions.pod:4759
26991 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
26995 #: ../fish/guestfish-actions.pod:4761
26996 msgid "vg-activate"
27000 #: ../fish/guestfish-actions.pod:4763
27003 " vg-activate true|false 'volgroups ...'\n"
27008 #: ../fish/guestfish-actions.pod:4776
27009 msgid "vg-activate-all"
27013 #: ../fish/guestfish-actions.pod:4778
27016 " vg-activate-all true|false\n"
27021 #: ../fish/guestfish-actions.pod:4788
27026 #: ../fish/guestfish-actions.pod:4790
27029 " vgcreate volgroup 'physvols ...'\n"
27034 #: ../fish/guestfish-actions.pod:4795
27039 #: ../fish/guestfish-actions.pod:4797
27042 " vglvuuids vgname\n"
27047 #: ../fish/guestfish-actions.pod:4802
27049 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27050 "logical volumes and volume groups."
27054 #: ../fish/guestfish-actions.pod:4805
27055 msgid "See also L</vgpvuuids>."
27059 #: ../fish/guestfish-actions.pod:4807
27064 #: ../fish/guestfish-actions.pod:4809
27067 " vgpvuuids vgname\n"
27072 #: ../fish/guestfish-actions.pod:4814
27074 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27075 "physical volumes and volume groups."
27079 #: ../fish/guestfish-actions.pod:4817
27080 msgid "See also L</vglvuuids>."
27084 #: ../fish/guestfish-actions.pod:4819
27089 #: ../fish/guestfish-actions.pod:4821
27092 " vgremove vgname\n"
27097 #: ../fish/guestfish-actions.pod:4828
27102 #: ../fish/guestfish-actions.pod:4830
27105 " vgrename volgroup newvolgroup\n"
27110 #: ../fish/guestfish-actions.pod:4834
27115 #: ../fish/guestfish-actions.pod:4836
27123 #: ../fish/guestfish-actions.pod:4844
27124 msgid "See also L</vgs-full>."
27128 #: ../fish/guestfish-actions.pod:4846
27133 #: ../fish/guestfish-actions.pod:4848
27141 #: ../fish/guestfish-actions.pod:4853
27146 #: ../fish/guestfish-actions.pod:4855
27154 #: ../fish/guestfish-actions.pod:4860
27159 #: ../fish/guestfish-actions.pod:4862
27167 #: ../fish/guestfish-actions.pod:4866
27172 #: ../fish/guestfish-actions.pod:4868
27180 #: ../fish/guestfish-actions.pod:4873
27185 #: ../fish/guestfish-actions.pod:4875
27193 #: ../fish/guestfish-actions.pod:4880
27198 #: ../fish/guestfish-actions.pod:4882
27206 #: ../fish/guestfish-actions.pod:4887
27211 #: ../fish/guestfish-actions.pod:4889
27214 " write path content\n"
27219 #: ../fish/guestfish-actions.pod:4897
27224 #: ../fish/guestfish-actions.pod:4899
27227 " write-file path content size\n"
27232 #: ../fish/guestfish-actions.pod:4922
27237 #: ../fish/guestfish-actions.pod:4924
27240 " zegrep regex path\n"
27245 #: ../fish/guestfish-actions.pod:4932
27250 #: ../fish/guestfish-actions.pod:4934
27253 " zegrepi regex path\n"
27258 #: ../fish/guestfish-actions.pod:4942
27263 #: ../fish/guestfish-actions.pod:4944
27271 #: ../fish/guestfish-actions.pod:4952
27272 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
27276 #: ../fish/guestfish-actions.pod:4955
27277 msgid "zero-device"
27281 #: ../fish/guestfish-actions.pod:4957
27284 " zero-device device\n"
27289 #: ../fish/guestfish-actions.pod:4959
27291 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27292 "which just zeroes the first few blocks of a device."
27296 #: ../fish/guestfish-actions.pod:4966
27301 #: ../fish/guestfish-actions.pod:4968
27304 " zerofree device\n"
27309 #: ../fish/guestfish-actions.pod:4981
27314 #: ../fish/guestfish-actions.pod:4983
27317 " zfgrep pattern path\n"
27322 #: ../fish/guestfish-actions.pod:4991
27327 #: ../fish/guestfish-actions.pod:4993
27330 " zfgrepi pattern path\n"
27335 #: ../fish/guestfish-actions.pod:5001
27340 #: ../fish/guestfish-actions.pod:5003
27343 " zfile meth path\n"
27348 #: ../fish/guestfish-actions.pod:5010
27349 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
27353 #: ../fish/guestfish-actions.pod:5020
27358 #: ../fish/guestfish-actions.pod:5022
27361 " zgrep regex path\n"
27366 #: ../fish/guestfish-actions.pod:5030
27371 #: ../fish/guestfish-actions.pod:5032
27374 " zgrepi regex path\n"
27379 #: ../fish/guestfish-commands.pod:1
27384 #: ../fish/guestfish-commands.pod:3
27389 #: ../fish/guestfish-commands.pod:5
27392 " alloc filename size\n"
27397 #: ../fish/guestfish-commands.pod:7
27399 "This creates an empty (zeroed) file of the given size, and then adds so it "
27400 "can be further examined."
27404 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27405 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27409 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27410 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27414 #: ../fish/guestfish-commands.pod:14
27416 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27417 "image, see L</PREPARED DISK IMAGES>."
27421 #: ../fish/guestfish-commands.pod:17
27426 #: ../fish/guestfish-commands.pod:19
27429 " copy-in local [local ...] /remotedir\n"
27434 #: ../fish/guestfish-commands.pod:21
27436 "C<copy-in> copies local files or directories recursively into the disk "
27437 "image, placing them in the directory called C</remotedir> (which must "
27438 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27439 "other commands as necessary."
27443 #: ../fish/guestfish-commands.pod:26
27445 "Multiple local files and directories can be specified, but the last "
27446 "parameter must always be a remote directory. Wildcards cannot be used."
27450 #: ../fish/guestfish-commands.pod:30
27455 #: ../fish/guestfish-commands.pod:32
27458 " copy-out remote [remote ...] localdir\n"
27463 #: ../fish/guestfish-commands.pod:34
27465 "C<copy-out> copies remote files or directories recursively out of the disk "
27466 "image, placing them on the host disk in a local directory called C<localdir> "
27467 "(which must exist). This guestfish meta-command turns into a sequence of "
27468 "L</download>, L</tar-out> and other commands as necessary."
27472 #: ../fish/guestfish-commands.pod:40
27474 "Multiple remote files and directories can be specified, but the last "
27475 "parameter must always be a local directory. To download to the current "
27476 "directory, use C<.> as in:"
27480 #: ../fish/guestfish-commands.pod:44
27483 " copy-out /home .\n"
27488 #: ../fish/guestfish-commands.pod:46
27490 "Wildcards cannot be used in the ordinary command, but you can use them with "
27491 "the help of L</glob> like this:"
27495 #: ../fish/guestfish-commands.pod:49
27498 " glob copy-out /home/* .\n"
27503 #: ../fish/guestfish-commands.pod:51
27508 #: ../fish/guestfish-commands.pod:53
27511 " echo [params ...]\n"
27516 #: ../fish/guestfish-commands.pod:55
27517 msgid "This echos the parameters to the terminal."
27521 #: ../fish/guestfish-commands.pod:57
27526 #: ../fish/guestfish-commands.pod:59
27531 #: ../fish/guestfish-commands.pod:61
27536 #: ../fish/guestfish-commands.pod:63
27544 #: ../fish/guestfish-commands.pod:65
27546 "This is used to edit a file. It downloads the file, edits it locally using "
27547 "your editor, then uploads the result."
27551 #: ../fish/guestfish-commands.pod:68
27553 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27554 "or C<emacs> you will get those corresponding editors."
27558 #: ../fish/guestfish-commands.pod:72
27563 #: ../fish/guestfish-commands.pod:74
27566 " glob command args...\n"
27571 #: ../fish/guestfish-commands.pod:76
27573 "Expand wildcards in any paths in the args list, and run C<command> "
27574 "repeatedly on each matching path."
27578 #: ../fish/guestfish-commands.pod:79
27579 msgid "See L</WILDCARDS AND GLOBBING>."
27583 #: ../fish/guestfish-commands.pod:81
27588 #: ../fish/guestfish-commands.pod:83
27591 " hexedit <filename|device>\n"
27592 " hexedit <filename|device> <max>\n"
27593 " hexedit <filename|device> <start> <max>\n"
27598 #: ../fish/guestfish-commands.pod:87
27600 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27605 #: ../fish/guestfish-commands.pod:90
27607 "This command works by downloading potentially the whole file or device, "
27608 "editing it locally, then uploading it. If the file or device is large, you "
27609 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27610 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27611 "usual modifiers allowed such as C<1M> (1 megabyte)."
27615 #: ../fish/guestfish-commands.pod:97
27616 msgid "For example to edit the first few sectors of a disk you might do:"
27620 #: ../fish/guestfish-commands.pod:100
27623 " hexedit /dev/sda 1M\n"
27628 #: ../fish/guestfish-commands.pod:102
27630 "which would allow you to edit anywhere within the first megabyte of the "
27635 #: ../fish/guestfish-commands.pod:105
27636 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27640 #: ../fish/guestfish-commands.pod:107
27643 " hexedit /dev/sda1 0x400 0x400\n"
27648 #: ../fish/guestfish-commands.pod:109
27649 msgid "(assuming the superblock is in the standard location)."
27653 #: ../fish/guestfish-commands.pod:111
27655 "This command requires the external L<hexedit(1)> program. You can specify "
27656 "another program to use by setting the C<HEXEDITOR> environment variable."
27660 #: ../fish/guestfish-commands.pod:115
27661 msgid "See also L</hexdump>."
27665 #: ../fish/guestfish-commands.pod:117
27670 #: ../fish/guestfish-commands.pod:119
27678 #: ../fish/guestfish-commands.pod:121
27679 msgid "Change the local directory, ie. the current directory of guestfish itself."
27683 #: ../fish/guestfish-commands.pod:124
27684 msgid "Note that C<!cd> won't do what you might expect."
27688 #: ../fish/guestfish-commands.pod:126
27693 #: ../fish/guestfish-commands.pod:128
27698 #: ../fish/guestfish-commands.pod:130
27706 #: ../fish/guestfish-commands.pod:132
27707 msgid "Opens the manual page for guestfish."
27711 #: ../fish/guestfish-commands.pod:134
27716 #: ../fish/guestfish-commands.pod:136
27721 #: ../fish/guestfish-commands.pod:138
27729 #: ../fish/guestfish-commands.pod:140
27737 #: ../fish/guestfish-commands.pod:142
27738 msgid "This is used to view a file."
27742 #: ../fish/guestfish-commands.pod:144
27744 "The default viewer is C<$PAGER>. However if you use the alternate command "
27745 "C<less> you will get the C<less> command specifically."
27749 #: ../fish/guestfish-commands.pod:147
27754 #: ../fish/guestfish-commands.pod:149
27762 #: ../fish/guestfish-commands.pod:151
27764 "Close and reopen the libguestfs handle. It is not necessary to use this "
27765 "normally, because the handle is closed properly when guestfish exits. "
27766 "However this is occasionally useful for testing."
27770 #: ../fish/guestfish-commands.pod:155
27775 #: ../fish/guestfish-commands.pod:157
27778 " sparse filename size\n"
27783 #: ../fish/guestfish-commands.pod:159
27785 "This creates an empty sparse file of the given size, and then adds so it can "
27786 "be further examined."
27790 #: ../fish/guestfish-commands.pod:162
27792 "In all respects it works the same as the L</alloc> command, except that the "
27793 "image file is allocated sparsely, which means that disk blocks are not "
27794 "assigned to the file until they are needed. Sparse disk files only use "
27795 "space when written to, but they are slower and there is a danger you could "
27796 "run out of real disk space during a write operation."
27800 #: ../fish/guestfish-commands.pod:172
27805 #: ../fish/guestfish-commands.pod:174
27813 #: ../fish/guestfish-commands.pod:176
27815 "This command returns a list of the optional groups known to the daemon, and "
27816 "indicates which ones are supported by this build of the libguestfs "
27821 #: ../fish/guestfish-commands.pod:180
27822 msgid "See also L<guestfs(3)/AVAILABILITY>."
27826 #: ../fish/guestfish-commands.pod:182
27831 #: ../fish/guestfish-commands.pod:184
27834 " time command args...\n"
27839 #: ../fish/guestfish-commands.pod:186
27841 "Run the command as usual, but print the elapsed time afterwards. This can "
27842 "be useful for benchmarking operations."
27846 #: ../test-tool/libguestfs-test-tool.pod:5
27847 msgid "libguestfs-test-tool - End user tests for libguestfs"
27851 #: ../test-tool/libguestfs-test-tool.pod:9
27854 " libguestfs-test-tool [--options]\n"
27859 #: ../test-tool/libguestfs-test-tool.pod:13
27861 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
27862 "and developers, to allow them to check basic libguestfs functionality is "
27863 "working. This is needed because libguestfs occasionally breaks for reasons "
27864 "beyond our control: usually because of changes in the underlying qemu or "
27865 "kernel packages, or the host environment."
27869 #: ../test-tool/libguestfs-test-tool.pod:20
27870 msgid "If you suspect a problem in libguestfs, then just run:"
27874 #: ../test-tool/libguestfs-test-tool.pod:22
27877 " libguestfs-test-tool\n"
27882 #: ../test-tool/libguestfs-test-tool.pod:24
27883 msgid "It will print lots of diagnostic messages."
27887 #: ../test-tool/libguestfs-test-tool.pod:26
27888 msgid "If it runs to completion successfully, you will see this near the end:"
27892 #: ../test-tool/libguestfs-test-tool.pod:28
27895 " ===== TEST FINISHED OK =====\n"
27900 #: ../test-tool/libguestfs-test-tool.pod:30
27901 msgid "and the test tool will exit with code 0."
27905 #: ../test-tool/libguestfs-test-tool.pod:32
27907 "If it fails (and/or exits with non-zero error code), please paste the "
27908 "B<complete, unedited> output of the test tool into a bug report. More "
27909 "information about reporting bugs can be found on the "
27910 "L<http://libguestfs.org/> website."
27914 #: ../test-tool/libguestfs-test-tool.pod:41
27919 #: ../test-tool/libguestfs-test-tool.pod:43
27920 msgid "Display short usage information and exit."
27924 #: ../test-tool/libguestfs-test-tool.pod:45
27925 msgid "I<--qemu qemu_binary>"
27929 #: ../test-tool/libguestfs-test-tool.pod:47
27931 "If you have downloaded another qemu binary, point this option at the full "
27932 "path of the binary to try it."
27936 #: ../test-tool/libguestfs-test-tool.pod:50
27937 msgid "I<--qemudir qemu_source_dir>"
27941 #: ../test-tool/libguestfs-test-tool.pod:52
27943 "If you have compiled qemu from source, point this option at the source "
27944 "directory to try it."
27948 #: ../test-tool/libguestfs-test-tool.pod:55
27949 msgid "I<--timeout N>"
27953 #: ../test-tool/libguestfs-test-tool.pod:57
27955 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
27956 "does not usually need to be adjusted unless your machine is very slow."
27960 #: ../test-tool/libguestfs-test-tool.pod:63
27961 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
27965 #: ../test-tool/libguestfs-test-tool.pod:65
27967 "If you have compiled another version of qemu from source and would like to "
27968 "try that, then you can use the I<--qemudir> option to point to the qemu "
27969 "source directory."
27973 #: ../test-tool/libguestfs-test-tool.pod:69
27975 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
27976 "option to point to the binary."
27980 #: ../test-tool/libguestfs-test-tool.pod:72
27982 "When using an alternate qemu with libguestfs, usually you would need to "
27983 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
27984 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
27985 "when you use either of the I<--qemudir> or I<--qemu> options."
27989 #: ../test-tool/libguestfs-test-tool.pod:79
27991 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
27992 "I<1> if there was an error."
27996 #: ../test-tool/libguestfs-test-tool.pod:84
27998 "For the full list of environment variables which may affect libguestfs, "
27999 "please see the L<guestfs(3)> manual page."
28003 #: ../test-tool/libguestfs-test-tool.pod:89
28004 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28008 #: ../fuse/guestmount.pod:5
28009 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28013 #: ../fuse/guestmount.pod:9
28016 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28021 #: ../fuse/guestmount.pod:11
28024 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28029 #: ../fuse/guestmount.pod:13
28032 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28037 #: ../fuse/guestmount.pod:17
28039 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28040 "machines. If you do this, you risk disk corruption in the VM."
28044 #: ../fuse/guestmount.pod:22
28046 "The guestmount program can be used to mount virtual machine filesystems and "
28047 "other disk images on the host. It uses libguestfs for access to the guest "
28048 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28049 "a mountable device."
28053 #: ../fuse/guestmount.pod:27
28055 "Along with other options, you have to give at least one device (I<-a> "
28056 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28057 "option) or use the I<-i> inspection option. How this works is better "
28058 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28063 #: ../fuse/guestmount.pod:33
28065 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28066 "by you, and the filesystem will not be visible to any other users unless you "
28067 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28068 "the filesystem, use the C<fusermount -u> command."
28072 #: ../fuse/guestmount.pod:41
28074 "For a typical Windows guest which has its main filesystem on the first "
28079 #: ../fuse/guestmount.pod:44
28082 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28087 #: ../fuse/guestmount.pod:46
28089 "For a typical Linux guest which has a /boot filesystem on the first "
28090 "partition, and the root filesystem on a logical volume:"
28094 #: ../fuse/guestmount.pod:49
28097 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28102 #: ../fuse/guestmount.pod:51
28103 msgid "To get libguestfs to detect guest mountpoints for you:"
28107 #: ../fuse/guestmount.pod:53
28110 " guestmount -a guest.img -i --ro /mnt\n"
28115 #: ../fuse/guestmount.pod:55
28116 msgid "For a libvirt guest called \"Guest\" you could do:"
28120 #: ../fuse/guestmount.pod:57
28123 " guestmount -d Guest -i --ro /mnt\n"
28128 #: ../fuse/guestmount.pod:59
28130 "If you don't know what filesystems are contained in a guest or disk image, "
28131 "use L<virt-filesystems(1)> first:"
28135 #: ../fuse/guestmount.pod:62
28138 " virt-filesystems MyGuest\n"
28143 #: ../fuse/guestmount.pod:64
28145 "If you want to trace the libguestfs calls but without excessive debugging "
28146 "information, we recommend:"
28150 #: ../fuse/guestmount.pod:67
28153 " guestmount [...] --trace /mnt\n"
28158 #: ../fuse/guestmount.pod:69
28159 msgid "If you want to debug the program, we recommend:"
28163 #: ../fuse/guestmount.pod:71
28166 " guestmount [...] --trace --verbose /mnt\n"
28171 #: ../fuse/guestmount.pod:73
28176 #: ../fuse/guestmount.pod:75
28177 msgid "Other users cannot see the filesystem by default"
28181 #: ../fuse/guestmount.pod:77
28183 "If you mount a filesystem as one user (eg. root), then other users will not "
28184 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28185 "option when mounting:"
28189 #: ../fuse/guestmount.pod:81
28192 " sudo guestmount [...] -o allow_other /mnt\n"
28197 #: ../fuse/guestmount.pod:87
28198 msgid "B<-a image> | B<--add image>"
28202 #: ../fuse/guestmount.pod:89
28203 msgid "Add a block device or virtual machine image."
28207 #: ../fuse/guestmount.pod:94
28208 msgid "B<-c URI> | B<--connect URI>"
28212 #: ../fuse/guestmount.pod:100
28213 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28217 #: ../fuse/guestmount.pod:108
28218 msgid "B<--dir-cache-timeout N>"
28222 #: ../fuse/guestmount.pod:110
28224 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28225 "seconds. The readdir cache [actually, there are several semi-independent "
28226 "caches] is populated after a readdir(2) call with the stat and extended "
28227 "attributes of the files in the directory, in anticipation that they will be "
28228 "requested soon after."
28232 #: ../fuse/guestmount.pod:116
28234 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28235 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28236 "requests, only cache existing ones."
28240 #: ../fuse/guestmount.pod:127
28241 msgid "B<--format=raw|qcow2|..> | B<--format>"
28245 #: ../fuse/guestmount.pod:134
28247 "If you have untrusted raw-format guest disk images, you should use this "
28248 "option to specify the disk format. This avoids a possible security problem "
28249 "with malicious guests (CVE-2010-3851). See also "
28250 "L<guestfs(3)/guestfs_add_drive_opts>."
28254 #: ../fuse/guestmount.pod:139
28255 msgid "B<--fuse-help>"
28259 #: ../fuse/guestmount.pod:141
28260 msgid "Display help on special FUSE options (see I<-o> below)."
28264 #: ../fuse/guestmount.pod:145
28265 msgid "Display brief help and exit."
28269 #: ../fuse/guestmount.pod:147
28270 msgid "B<-i> | B<--inspector>"
28274 #: ../fuse/guestmount.pod:167
28276 "Mount the named partition or logical volume on the given mountpoint B<in the "
28277 "guest> (this has nothing to do with mountpoints in the host)."
28281 #: ../fuse/guestmount.pod:170
28283 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28284 "something on C</>."
28288 #: ../fuse/guestmount.pod:183
28289 msgid "B<-n> | B<--no-sync>"
28293 #: ../fuse/guestmount.pod:185
28295 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28296 "unmounted. If you specify this option, then we don't attempt to sync the "
28297 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28301 #: ../fuse/guestmount.pod:190
28302 msgid "B<-o option> | B<--option option>"
28306 #: ../fuse/guestmount.pod:192
28307 msgid "Pass extra options to FUSE."
28311 #: ../fuse/guestmount.pod:194
28313 "To get a list of all the extra options supported by FUSE, use the command "
28314 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28315 "of them are a good idea."
28319 #: ../fuse/guestmount.pod:198
28322 " guestmount --fuse-help\n"
28327 #: ../fuse/guestmount.pod:200
28328 msgid "Some potentially useful FUSE options:"
28332 #: ../fuse/guestmount.pod:204
28333 msgid "B<-o allow_other>"
28337 #: ../fuse/guestmount.pod:206
28338 msgid "Allow other users to see the filesystem."
28342 #: ../fuse/guestmount.pod:208
28343 msgid "B<-o attr_timeout=N>"
28347 #: ../fuse/guestmount.pod:210
28348 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28352 #: ../fuse/guestmount.pod:212
28353 msgid "B<-o kernel_cache>"
28357 #: ../fuse/guestmount.pod:214
28359 "Allow the kernel to cache files (reduces the number of reads that have to go "
28360 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28361 "afford the extra memory usage."
28365 #: ../fuse/guestmount.pod:218
28366 msgid "B<-o uid=N> B<-o gid=N>"
28370 #: ../fuse/guestmount.pod:220
28372 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28373 "the chosen values."
28377 #: ../fuse/guestmount.pod:225
28378 msgid "B<-r> | B<--ro>"
28382 #: ../fuse/guestmount.pod:227
28384 "Add devices and mount everything read-only. Also disallow writes and make "
28385 "the disk appear read-only to FUSE."
28389 #: ../fuse/guestmount.pod:230
28391 "This is highly recommended if you are not going to edit the guest disk. If "
28392 "the guest is running and this option is I<not> supplied, then there is a "
28393 "strong risk of disk corruption in the guest. We try to prevent this from "
28394 "happening, but it is not always possible."
28398 #: ../fuse/guestmount.pod:235
28399 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28403 #: ../fuse/guestmount.pod:239
28404 msgid "Enable SELinux support for the guest."
28408 #: ../fuse/guestmount.pod:241
28409 msgid "B<-v> | B<--verbose>"
28413 #: ../fuse/guestmount.pod:243
28414 msgid "Enable verbose messages from underlying libguestfs."
28418 #: ../fuse/guestmount.pod:245
28419 msgid "B<-V> | B<--version>"
28423 #: ../fuse/guestmount.pod:247
28424 msgid "Display the program version and exit."
28428 #: ../fuse/guestmount.pod:249
28429 msgid "B<-w> | B<--rw>"
28433 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
28434 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28438 #: ../fuse/guestmount.pod:256
28439 msgid "B<-x> | B<--trace>"
28443 #: ../fuse/guestmount.pod:258
28444 msgid "Trace libguestfs calls and entry into each FUSE function."
28448 #: ../fuse/guestmount.pod:260
28449 msgid "This also stops the daemon from forking into the background."
28453 #: ../fuse/guestmount.pod:281
28455 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28456 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
28457 "L<http://fuse.sf.net/>."
28461 #: ../fuse/guestmount.pod:296
28462 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28466 #: ../tools/virt-win-reg.pl:37
28468 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
28473 #: ../tools/virt-win-reg.pl:41
28476 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28481 #: ../tools/virt-win-reg.pl:43
28484 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28489 #: ../tools/virt-win-reg.pl:45
28492 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28497 #: ../tools/virt-win-reg.pl:47
28500 " virt-win-reg --merge domname [input.reg ...]\n"
28505 #: ../tools/virt-win-reg.pl:49
28508 " virt-win-reg [--options] disk.img ... # instead of domname\n"
28513 #: ../tools/virt-win-reg.pl:53
28515 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
28516 "virtual machines. If you do this, you I<will> get irreversible disk "
28517 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
28518 "but doesn't catch all cases."
28522 #: ../tools/virt-win-reg.pl:58
28524 "Modifying the Windows Registry is an inherently risky operation. The format "
28525 "is deliberately obscure and undocumented, and Registry changes can leave the "
28526 "system unbootable. Therefore when using the I<--merge> option, make sure "
28527 "you have a reliable backup first."
28531 #: ../tools/virt-win-reg.pl:65
28533 "This program can export and merge Windows Registry entries from a Windows "
28538 #: ../tools/virt-win-reg.pl:68
28540 "The first parameter is the libvirt guest name or the raw disk image of a "
28545 #: ../tools/virt-win-reg.pl:71
28547 "If I<--merge> is I<not> specified, then the chosen registry key is "
28548 "displayed/exported (recursively). For example:"
28552 #: ../tools/virt-win-reg.pl:74
28555 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
28560 #: ../tools/virt-win-reg.pl:76
28561 msgid "You can also display single values from within registry keys, for example:"
28565 #: ../tools/virt-win-reg.pl:79
28568 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
28569 " $ virt-win-reg Windows7 $cvkey ProductName\n"
28570 " Windows 7 Enterprise\n"
28575 #: ../tools/virt-win-reg.pl:83
28577 "With I<--merge>, you can merge a textual regedit file into the Windows "
28582 #: ../tools/virt-win-reg.pl:86
28585 " $ virt-win-reg --merge Windows7 changes.reg\n"
28590 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
28595 #: ../tools/virt-win-reg.pl:90
28597 "This program is only meant for simple access to the registry. If you want "
28598 "to do complicated things with the registry, we suggest you download the "
28599 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
28600 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
28601 "L<hivexregedit(1)>."
28605 #: ../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
28606 msgid "Display brief help."
28610 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
28611 msgid "Display version number and exit."
28615 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
28620 #: ../tools/virt-win-reg.pl:122
28621 msgid "Enable debugging messages."
28625 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
28626 msgid "B<--connect URI> | B<-c URI>"
28630 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
28632 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28633 "to the default libvirt hypervisor."
28637 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
28639 "If you specify guest block devices directly, then libvirt is not used at "
28644 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
28645 msgid "B<--format> raw"
28649 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
28651 "Specify the format of disk images given on the command line. If this is "
28652 "omitted then the format is autodetected from the content of the disk image."
28656 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
28658 "If disk images are requested from libvirt, then this program asks libvirt "
28659 "for this information. In this case, the value of the format parameter is "
28664 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
28666 "If working with untrusted raw-format guest disk images, you should ensure "
28667 "the format is always specified."
28671 #: ../tools/virt-win-reg.pl:157
28676 #: ../tools/virt-win-reg.pl:159
28678 "In merge mode, this merges a textual regedit file into the Windows Registry "
28679 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
28680 "displays or exports Registry entries instead."
28684 #: ../tools/virt-win-reg.pl:163
28686 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
28687 "result in disk corruption. However exporting (without this flag) is always "
28692 #: ../tools/virt-win-reg.pl:171
28693 msgid "B<--encoding> UTF-16LE|ASCII"
28697 #: ../tools/virt-win-reg.pl:173
28699 "When merging (only), you may need to specify the encoding for strings to be "
28700 "used in the hive file. This is explained in detail in "
28701 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
28705 #: ../tools/virt-win-reg.pl:177
28707 "The default is to use UTF-16LE, which should work with recent versions of "
28712 #: ../tools/virt-win-reg.pl:184
28713 msgid "B<--unsafe-printable-strings>"
28717 #: ../tools/virt-win-reg.pl:186
28719 "When exporting (only), assume strings are UTF-16LE and print them as strings "
28720 "instead of hex sequences. Remove the final zero codepoint from strings if "
28725 #: ../tools/virt-win-reg.pl:190
28727 "This is unsafe and does not preserve the fidelity of strings in the original "
28728 "Registry for various reasons:"
28732 #: ../tools/virt-win-reg.pl:197
28734 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
28735 "other encodings will be corrupted by this transformation."
28739 #: ../tools/virt-win-reg.pl:202
28741 "Assumes that everything which has type 1 or 2 is really a string and that "
28742 "everything else is not a string, but the type field in real Registries is "
28747 #: ../tools/virt-win-reg.pl:208
28749 "Loses information about whether a zero codepoint followed the string in the "
28754 #: ../tools/virt-win-reg.pl:213
28756 "This all happens because the Registry itself contains no information about "
28757 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
28761 #: ../tools/virt-win-reg.pl:217
28763 "You should only use this option for quick hacking and debugging of the "
28764 "Registry contents, and I<never> use it if the output is going to be passed "
28765 "into another program or stored in another Registry."
28769 #: ../tools/virt-win-reg.pl:554
28770 msgid "SUPPORTED SYSTEMS"
28774 #: ../tools/virt-win-reg.pl:556
28776 "The program currently supports Windows NT-derived guests starting with "
28777 "Windows XP through to at least Windows 7."
28781 #: ../tools/virt-win-reg.pl:559
28782 msgid "The following Registry keys are supported:"
28786 #: ../tools/virt-win-reg.pl:563
28787 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
28791 #: ../tools/virt-win-reg.pl:565
28792 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
28796 #: ../tools/virt-win-reg.pl:567
28797 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
28801 #: ../tools/virt-win-reg.pl:569
28802 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
28806 #: ../tools/virt-win-reg.pl:571
28807 msgid "C<HKEY_USERS\\.DEFAULT>"
28811 #: ../tools/virt-win-reg.pl:573
28812 msgid "C<HKEY_USERS\\I<SID>>"
28816 #: ../tools/virt-win-reg.pl:575
28817 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
28821 #: ../tools/virt-win-reg.pl:577
28822 msgid "C<HKEY_USERS\\I<username>>"
28826 #: ../tools/virt-win-reg.pl:579
28827 msgid "where I<username> is a local user name (this is a libguestfs extension)."
28831 #: ../tools/virt-win-reg.pl:583
28833 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
28838 #: ../tools/virt-win-reg.pl:586
28840 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
28841 "supported (there is no \"current user\")."
28845 #: ../tools/virt-win-reg.pl:589
28850 #: ../tools/virt-win-reg.pl:591
28852 "C<virt-win-reg> expects that regedit files have already been reencoded in "
28853 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
28854 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
28855 "with Windows-style line endings, you may need to reencode the whole file "
28856 "before or after processing."
28860 #: ../tools/virt-win-reg.pl:597
28862 "To reencode a file from Windows format to Linux (before processing it with "
28863 "the I<--merge> option), you would do something like this:"
28867 #: ../tools/virt-win-reg.pl:600
28870 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
28875 #: ../tools/virt-win-reg.pl:602
28877 "To go in the opposite direction, after exporting and before sending the file "
28878 "to a Windows user, do something like this:"
28882 #: ../tools/virt-win-reg.pl:605
28885 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
28890 #: ../tools/virt-win-reg.pl:607
28891 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
28895 #: ../tools/virt-win-reg.pl:609
28897 "If you are unsure about the current encoding, use the L<file(1)> command. "
28898 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
28899 "Windows-style (CRLF) line endings, like this:"
28903 #: ../tools/virt-win-reg.pl:613
28906 " $ file software.reg\n"
28907 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
28908 " with CRLF line terminators\n"
28913 #: ../tools/virt-win-reg.pl:617
28914 msgid "This file would need conversion before you could I<--merge> it."
28918 #: ../tools/virt-win-reg.pl:619
28919 msgid "CurrentControlSet etc."
28923 #: ../tools/virt-win-reg.pl:621
28925 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
28926 "Registry at the level of the hive file, and therefore you cannot modify "
28931 #: ../tools/virt-win-reg.pl:625
28933 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
28934 "circumstances it might refer to another control set. The way to find out is "
28935 "to look at the C<HKLM\\SYSTEM\\Select> key:"
28939 #: ../tools/virt-win-reg.pl:629
28942 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
28943 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
28944 " \"Current\"=dword:00000001\n"
28945 " \"Default\"=dword:00000001\n"
28946 " \"Failed\"=dword:00000000\n"
28947 " \"LastKnownGood\"=dword:00000002\n"
28952 #: ../tools/virt-win-reg.pl:636
28953 msgid "\"Current\" is the one which Windows will choose when it boots."
28957 #: ../tools/virt-win-reg.pl:638
28958 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
28962 #: ../tools/virt-win-reg.pl:641
28963 msgid "WINDOWS TIPS"
28967 #: ../tools/virt-win-reg.pl:643
28969 "Note that some of these tips modify the guest disk image. The guest I<must> "
28970 "be shut off, else you will get disk corruption."
28974 #: ../tools/virt-win-reg.pl:646
28975 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
28979 #: ../tools/virt-win-reg.pl:648
28981 "Prepare a DOS batch script, VBScript or executable. Upload this using "
28982 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
28983 "is uploaded into C<C:\\>:"
28987 #: ../tools/virt-win-reg.pl:652
28990 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
28995 #: ../tools/virt-win-reg.pl:654
28996 msgid "Prepare a regedit file containing the registry change:"
29000 #: ../tools/virt-win-reg.pl:656
29003 " cat > test.reg <<'EOF'\n"
29004 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29005 " \"Test\"=\"c:\\\\test.bat\"\n"
29011 #: ../tools/virt-win-reg.pl:661
29013 "In this example we use the key C<RunOnce> which means that the script will "
29014 "run precisely once when the first user logs in. If you want it to run every "
29015 "time a user logs in, replace C<RunOnce> with C<Run>."
29019 #: ../tools/virt-win-reg.pl:665
29020 msgid "Now update the registry:"
29024 #: ../tools/virt-win-reg.pl:667
29027 " virt-win-reg --merge WindowsGuest test.reg\n"
29032 #: ../tools/virt-win-reg.pl:669
29033 msgid "INSTALLING A SERVICE"
29037 #: ../tools/virt-win-reg.pl:671
29039 "This section assumes you are familiar with Windows services, and you either "
29040 "have a program which handles the Windows Service Control Protocol directly "
29041 "or you want to run any program using a service wrapper like SrvAny or the "
29046 #: ../tools/virt-win-reg.pl:676
29048 "First upload the program and optionally the service wrapper. In this case "
29049 "the test program is called C<test.exe> and we are using the RHSrvAny "
29054 #: ../tools/virt-win-reg.pl:680
29057 " guestfish -i -d WindowsGuest <<EOF\n"
29058 " upload rhsrvany.exe /rhsrvany.exe\n"
29059 " upload test.exe /test.exe\n"
29065 #: ../tools/virt-win-reg.pl:685
29067 "Prepare a regedit file containing the registry changes. In this example, "
29068 "the first registry change is needed for the service itself or the service "
29069 "wrapper (if used). The second registry change is only needed because I am "
29070 "using the RHSrvAny service wrapper."
29074 #: ../tools/virt-win-reg.pl:690
29077 " cat > service.reg <<'EOF'\n"
29078 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29079 " \"Type\"=dword:00000010\n"
29080 " \"Start\"=dword:00000002\n"
29081 " \"ErrorControl\"=dword:00000001\n"
29082 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29083 " \"DisplayName\"=\"RHSrvAny\"\n"
29084 " \"ObjectName\"=\"NetworkService\"\n"
29089 #: ../tools/virt-win-reg.pl:699
29092 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29093 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29094 " \"PWD\"=\"c:\\\\Temp\"\n"
29100 #: ../tools/virt-win-reg.pl:710
29102 "For use of C<ControlSet001> see the section above in this manual page. You "
29103 "may need to adjust this according to the control set that is in use by the "
29108 #: ../tools/virt-win-reg.pl:716
29110 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29111 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29112 "privileged account."
29116 #: ../tools/virt-win-reg.pl:722
29118 "For the meaning of the magic numbers, see this Microsoft KB article: "
29119 "L<http://support.microsoft.com/kb/103000>."
29123 #: ../tools/virt-win-reg.pl:727
29124 msgid "Update the registry:"
29128 #: ../tools/virt-win-reg.pl:729
29131 " virt-win-reg --merge WindowsGuest service.reg\n"
29136 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29137 msgid "SHELL QUOTING"
29141 #: ../tools/virt-win-reg.pl:733
29143 "Be careful when passing parameters containing C<\\> (backslash) in the "
29144 "shell. Usually you will have to use 'single quotes' or double backslashes "
29145 "(but not both) to protect them from the shell."
29149 #: ../tools/virt-win-reg.pl:737
29150 msgid "Paths and value names are case-insensitive."
29154 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29156 "Libvirt guest names can contain arbitrary characters, some of which have "
29157 "meaning to the shell such as C<#> and space. You may need to quote or "
29158 "escape these characters on the command line. See the shell manual page "
29159 "L<sh(1)> for details."
29163 #: ../tools/virt-win-reg.pl:746
29165 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29166 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29167 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29168 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29172 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
29174 "When reporting bugs, please enable debugging and capture the I<complete> "
29179 #: ../tools/virt-win-reg.pl:764
29182 " export LIBGUESTFS_DEBUG=1\n"
29183 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29188 #: ../tools/virt-win-reg.pl:767
29190 "Attach /tmp/virt-win-reg.log to a new bug report at "
29191 "L<https://bugzilla.redhat.com/>"
29195 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29200 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29201 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29205 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
29206 msgid "Copyright (C) 2010 Red Hat Inc."
29210 #: ../tools/virt-list-filesystems.pl:32
29211 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29215 #: ../tools/virt-list-filesystems.pl:36
29218 " virt-list-filesystems [--options] domname\n"
29223 #: ../tools/virt-list-filesystems.pl:38
29226 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29231 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29233 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29238 #: ../tools/virt-list-filesystems.pl:45
29240 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29241 "are contained in a virtual machine or disk image."
29245 #: ../tools/virt-list-filesystems.pl:49
29247 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29248 "functionality. For more complex cases you should look at the "
29249 "L<guestfish(1)> tool."
29253 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29254 msgid "B<-l> | B<--long>"
29258 #: ../tools/virt-list-filesystems.pl:108
29260 "With this option, C<virt-list-filesystems> displays the type of each "
29261 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29265 #: ../tools/virt-list-filesystems.pl:115
29266 msgid "B<-a> | B<--all>"
29270 #: ../tools/virt-list-filesystems.pl:117
29272 "Normally we only show mountable filesystems. If this option is given then "
29273 "swap devices are shown too."
29277 #: ../tools/virt-list-filesystems.pl:191
29279 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29280 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29281 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29285 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29286 msgid "Copyright (C) 2009 Red Hat Inc."
29290 #: ../tools/virt-tar.pl:33
29291 msgid "virt-tar - Extract or upload files to a virtual machine"
29295 #: ../tools/virt-tar.pl:37
29298 " virt-tar [--options] -x domname directory tarball\n"
29303 #: ../tools/virt-tar.pl:39
29306 " virt-tar [--options] -u domname tarball directory\n"
29311 #: ../tools/virt-tar.pl:41
29314 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29319 #: ../tools/virt-tar.pl:43
29322 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29327 #: ../tools/virt-tar.pl:47
29329 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29330 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29334 #: ../tools/virt-tar.pl:52
29335 msgid "Download C</home> from the VM into a local tarball:"
29339 #: ../tools/virt-tar.pl:54
29342 " virt-tar -x domname /home home.tar\n"
29347 #: ../tools/virt-tar.pl:56
29350 " virt-tar -zx domname /home home.tar.gz\n"
29355 #: ../tools/virt-tar.pl:58
29356 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29360 #: ../tools/virt-tar.pl:60
29363 " virt-tar -u domname uploadstuff.tar /tmp\n"
29368 #: ../tools/virt-tar.pl:62
29371 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29376 #: ../tools/virt-tar.pl:66
29378 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
29379 "virtual machines. If you do this, you risk disk corruption in the VM. "
29380 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29384 #: ../tools/virt-tar.pl:71
29386 "You can use I<-x> (extract) on live virtual machines, but you might get "
29387 "inconsistent results or errors if there is filesystem activity inside the "
29388 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29389 "work, but the only way to guarantee consistent results is if the virtual "
29390 "machine is shut down."
29394 #: ../tools/virt-tar.pl:79
29396 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29397 "parts of a guest filesystem. There are many possibilities: making backups, "
29398 "uploading data files, snooping on guest activity, fixing or customizing "
29403 #: ../tools/virt-tar.pl:84
29405 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29406 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29407 "should look at the L<guestfish(1)> tool."
29411 #: ../tools/virt-tar.pl:88
29413 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
29414 "its contents (recursively) from the virtual machine into a local tarball. "
29415 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
29416 "virtual machine. You cannot use these two options together."
29420 #: ../tools/virt-tar.pl:94
29422 "In addition, you may need to use the I<-z> (gZip) option to enable "
29423 "compression. When uploading, you have to specify I<-z> if the upload file "
29424 "is compressed because virt-tar won't detect this on its own."
29428 #: ../tools/virt-tar.pl:98
29430 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29431 "example it cannot do PKZip files or bzip2 compression. If you want that "
29432 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29433 "the L<libguestfs(3)> API)."
29437 #: ../tools/virt-tar.pl:156
29438 msgid "B<-x> | B<--extract> | B<--download>"
29442 #: ../tools/virt-tar.pl:158
29443 msgid "B<-u> | B<--upload>"
29447 #: ../tools/virt-tar.pl:160
29449 "Use I<-x> to extract (download) a directory from a virtual machine to a "
29454 #: ../tools/virt-tar.pl:163
29456 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
29457 "Please read the L</WARNING> section above before using this option."
29461 #: ../tools/virt-tar.pl:167
29462 msgid "You must specify exactly one of these options."
29466 #: ../tools/virt-tar.pl:173
29467 msgid "B<-z> | B<--gzip>"
29471 #: ../tools/virt-tar.pl:175
29472 msgid "Specify that the input or output tarball is gzip-compressed."
29476 #: ../tools/virt-tar.pl:288
29478 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29479 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29480 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29481 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29485 #: ../tools/virt-make-fs.pl:37
29486 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29490 #: ../tools/virt-make-fs.pl:41
29493 " virt-make-fs [--options] input.tar output.img\n"
29498 #: ../tools/virt-make-fs.pl:43
29501 " virt-make-fs [--options] input.tar.gz output.img\n"
29506 #: ../tools/virt-make-fs.pl:45
29509 " virt-make-fs [--options] directory output.img\n"
29514 #: ../tools/virt-make-fs.pl:49
29516 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29517 "archive or some files in a directory. It is similar to tools like "
29518 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29519 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29520 "useful if you want to attach these filesystems to existing virtual machines "
29521 "(eg. to import large amounts of read-only data to a VM)."
29525 #: ../tools/virt-make-fs.pl:57
29526 msgid "Basic usage is:"
29530 #: ../tools/virt-make-fs.pl:59
29533 " virt-make-fs input output\n"
29538 #: ../tools/virt-make-fs.pl:61
29540 "where C<input> is either a directory containing files that you want to add, "
29541 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29542 "C<output> is a disk image. The input type is detected automatically. The "
29543 "output disk image defaults to a raw ext2 image unless you specify extra "
29544 "flags (see L</OPTIONS> below)."
29548 #: ../tools/virt-make-fs.pl:67
29549 msgid "EXTRA SPACE"
29553 #: ../tools/virt-make-fs.pl:69
29555 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29556 "the files that it contains, but might have extra space. Depending on how "
29557 "you are going to use the output, you might think this extra space is wasted "
29558 "and want to minimize it, or you might want to leave space so that more files "
29559 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29560 "but you can use the I<--size> flag to leave space in the filesystem if you "
29565 #: ../tools/virt-make-fs.pl:77
29567 "An alternative way to leave extra space but not make the output image any "
29568 "bigger is to use an alternative disk image format (instead of the default "
29569 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
29570 "image format (check your hypervisor supports this before using it). This "
29571 "allows you to choose a large I<--size> but the extra space won't actually be "
29572 "allocated in the image until you try to store something in it."
29576 #: ../tools/virt-make-fs.pl:85
29578 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29579 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29580 "to build another image from scratch."
29584 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29589 #: ../tools/virt-make-fs.pl:91
29592 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29597 #: ../tools/virt-make-fs.pl:93
29598 msgid "FILESYSTEM TYPE"
29602 #: ../tools/virt-make-fs.pl:95
29604 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29605 "libguestfs supports can be used (but I<not> read-only formats like "
29606 "ISO9660). Here are some of the more common choices:"
29610 #: ../tools/virt-make-fs.pl:101
29615 #: ../tools/virt-make-fs.pl:103
29617 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29618 "you are not going to use the filesystem in a way that requires the journal, "
29619 "then this is just wasted overhead."
29623 #: ../tools/virt-make-fs.pl:107
29624 msgid "I<ntfs> or I<vfat>"
29628 #: ../tools/virt-make-fs.pl:109
29629 msgid "Useful if exporting data to a Windows guest."
29633 #: ../tools/virt-make-fs.pl:111
29635 "I<Note for vfat>: The tar archive or local directory must only contain files "
29636 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29637 "program running within libguestfs is unable to change the ownership of "
29638 "non-root files, since vfat itself does not support this."
29642 #: ../tools/virt-make-fs.pl:116
29647 #: ../tools/virt-make-fs.pl:118
29649 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29650 "total filesystem size."
29654 #: ../tools/virt-make-fs.pl:125
29657 " virt-make-fs --type=minix input minixfs.img\n"
29662 #: ../tools/virt-make-fs.pl:127
29663 msgid "TO PARTITION OR NOT TO PARTITION"
29667 #: ../tools/virt-make-fs.pl:129
29668 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29672 #: ../tools/virt-make-fs.pl:131
29674 "Adding a partition can make the disk image more compatible with certain "
29675 "virtualized operating systems which don't expect to see a filesystem "
29676 "directly located on a block device (Linux doesn't care and will happily "
29677 "handle both types)."
29681 #: ../tools/virt-make-fs.pl:136
29683 "On the other hand, if you have a partition table then the output image is no "
29684 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29685 "directly on a partitioned disk image. (However libguestfs tools such as "
29686 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29690 #: ../tools/virt-make-fs.pl:144
29691 msgid "Add an MBR partition:"
29695 #: ../tools/virt-make-fs.pl:146
29698 " virt-make-fs --partition -- input disk.img\n"
29703 #: ../tools/virt-make-fs.pl:148
29705 "If the output disk image could be terabyte-sized or larger, it's better to "
29706 "use an EFI/GPT-compatible partition table:"
29710 #: ../tools/virt-make-fs.pl:151
29713 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29718 #: ../tools/virt-make-fs.pl:179
29719 msgid "Enable debugging information."
29723 #: ../tools/virt-make-fs.pl:185
29724 msgid "B<--size=E<lt>NE<gt>>"
29728 #: ../tools/virt-make-fs.pl:187
29729 msgid "B<--size=+E<lt>NE<gt>>"
29733 #: ../tools/virt-make-fs.pl:189
29734 msgid "B<-s E<lt>NE<gt>>"
29738 #: ../tools/virt-make-fs.pl:191
29739 msgid "B<-s +E<lt>NE<gt>>"
29743 #: ../tools/virt-make-fs.pl:193
29744 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
29748 #: ../tools/virt-make-fs.pl:196
29750 "If this option is I<not> given, then the output image will be just large "
29751 "enough to contain all the files, with not much wasted space."
29755 #: ../tools/virt-make-fs.pl:199
29757 "To choose a fixed size output disk, specify an absolute number followed by "
29758 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29759 "Petabytes or Exabytes. This must be large enough to contain all the input "
29760 "files, else you will get an error."
29764 #: ../tools/virt-make-fs.pl:204
29766 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29767 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29768 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
29769 "the input files, and (approximately) an extra 200 MB free space."
29773 #: ../tools/virt-make-fs.pl:210
29775 "Note that virt-make-fs estimates free space, and therefore will not produce "
29776 "filesystems containing precisely the free space requested. (It is much more "
29777 "expensive and time-consuming to produce a filesystem which has precisely the "
29778 "desired free space)."
29782 #: ../tools/virt-make-fs.pl:219
29783 msgid "B<--format=E<lt>fmtE<gt>>"
29787 #: ../tools/virt-make-fs.pl:221
29788 msgid "B<-F E<lt>fmtE<gt>>"
29792 #: ../tools/virt-make-fs.pl:223
29793 msgid "Choose the output disk image format."
29797 #: ../tools/virt-make-fs.pl:225
29798 msgid "The default is C<raw> (raw disk image)."
29802 #: ../tools/virt-make-fs.pl:227
29804 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29805 "that would really make sense here is C<qcow2>."
29809 #: ../tools/virt-make-fs.pl:234
29810 msgid "B<--type=E<lt>fsE<gt>>"
29814 #: ../tools/virt-make-fs.pl:236
29815 msgid "B<-t E<lt>fsE<gt>>"
29819 #: ../tools/virt-make-fs.pl:238
29820 msgid "Choose the output filesystem type."
29824 #: ../tools/virt-make-fs.pl:240
29825 msgid "The default is C<ext2>."
29829 #: ../tools/virt-make-fs.pl:242
29830 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29834 #: ../tools/virt-make-fs.pl:249
29835 msgid "B<--partition>"
29839 #: ../tools/virt-make-fs.pl:251
29840 msgid "B<--partition=E<lt>parttypeE<gt>>"
29844 #: ../tools/virt-make-fs.pl:253
29846 "If specified, this flag adds an MBR partition table to the output disk "
29851 #: ../tools/virt-make-fs.pl:256
29853 "You can change the partition table type, eg. I<--partition=gpt> for large "
29858 #: ../tools/virt-make-fs.pl:259
29860 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
29861 "might consider the next parameter to be the partition type. For example:"
29865 #: ../tools/virt-make-fs.pl:263
29868 " virt-make-fs --partition input.tar ...\n"
29873 #: ../tools/virt-make-fs.pl:265
29875 "would cause virt-make-fs to think you wanted to use a partition type of "
29876 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
29877 "dash) between options and the input file argument:"
29881 #: ../tools/virt-make-fs.pl:269
29884 " virt-make-fs --partition -- input.tar ...\n"
29889 #: ../tools/virt-make-fs.pl:541
29891 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
29892 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29893 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29897 #: ../tools/virt-make-fs.pl:558
29900 " export LIBGUESTFS_DEBUG=1\n"
29901 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29906 #: ../tools/virt-make-fs.pl:561
29908 "Attach /tmp/virt-make-fs.log to a new bug report at "
29909 "L<https://bugzilla.redhat.com/>"
29913 #: ../tools/virt-list-partitions.pl:32
29914 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29918 #: ../tools/virt-list-partitions.pl:36
29921 " virt-list-partitions [--options] domname\n"
29926 #: ../tools/virt-list-partitions.pl:38
29929 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29934 #: ../tools/virt-list-partitions.pl:45
29936 "C<virt-list-partitions> is a command line tool to list the partitions that "
29937 "are contained in a virtual machine or disk image. It is mainly useful as a "
29938 "first step to using L<virt-resize(1)>."
29942 #: ../tools/virt-list-partitions.pl:50
29944 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29945 "functionality. For more complex cases you should look at the "
29946 "L<guestfish(1)> tool."
29950 #: ../tools/virt-list-partitions.pl:107
29951 msgid "B<-h> | B<--human-readable>"
29955 #: ../tools/virt-list-partitions.pl:109
29956 msgid "Show sizes in human-readable form (eg. \"1G\")."
29960 #: ../tools/virt-list-partitions.pl:117
29962 "With this option, C<virt-list-partitions> displays the type and size of each "
29963 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29967 #: ../tools/virt-list-partitions.pl:124
29968 msgid "B<-t> | B<--total>"
29972 #: ../tools/virt-list-partitions.pl:126
29973 msgid "Display the total size of each block device (as a separate row or rows)."
29977 #: ../tools/virt-list-partitions.pl:259
29979 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29980 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29981 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29985 #: ../tools/virt-list-partitions.pl:275
29986 msgid "Copyright (C) 2009-2010 Red Hat Inc."