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.10.8\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-08-17 13:55+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
26 #: ../src/guestfs.pod:5
27 msgid "guestfs - Library for accessing and modifying virtual machine images"
31 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
36 #: ../src/guestfs.pod:9
39 " #include <guestfs.h>\n"
44 #: ../src/guestfs.pod:11
47 " guestfs_h *g = guestfs_create ();\n"
48 " guestfs_add_drive (g, \"guest.img\");\n"
49 " guestfs_launch (g);\n"
50 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
51 " guestfs_touch (g, \"/hello\");\n"
52 " guestfs_umount (g, \"/\");\n"
53 " guestfs_close (g);\n"
58 #: ../src/guestfs.pod:19
61 " cc prog.c -o prog -lguestfs\n"
63 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
68 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-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:1753 ../src/guestfs.pod:1758 ../src/guestfs.pod:1762 ../src/guestfs.pod:1772 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012 ../src/guestfs.pod:2018 ../src/guestfs.pod:2026 ../src/guestfs.pod:2380 ../src/guestfs.pod:2386 ../src/guestfs.pod:2391 ../src/guestfs.pod:2397 ../src/guestfs.pod:2968 ../src/guestfs.pod:2972 ../src/guestfs.pod:2976 ../src/guestfs.pod:2980 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:582 ../src/guestfs-actions.pod:590 ../src/guestfs-actions.pod:597 ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:1602 ../src/guestfs-actions.pod:1606 ../src/guestfs-actions.pod:1610 ../src/guestfs-actions.pod:1614 ../src/guestfs-actions.pod:1622 ../src/guestfs-actions.pod:1626 ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1640 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1648 ../src/guestfs-actions.pod:1786 ../src/guestfs-actions.pod:1790 ../src/guestfs-actions.pod:1795 ../src/guestfs-actions.pod:1800 ../src/guestfs-actions.pod:1861 ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:1870 ../fish/guestfish.pod:443 ../fish/guestfish.pod:447 ../fish/guestfish.pod:451 ../fish/guestfish.pod:455 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod: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-edit.pl:351 ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361 ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548
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:2425
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:2450
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:765
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems, an install CD or a live CD. (These APIs used to "
1112 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1113 "version 1.5.3 the most frequently used part of this library has been "
1114 "rewritten in C and moved into the core code)."
1118 #: ../src/guestfs.pod:559
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:562
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:571
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:577
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:584
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:588
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:591
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:595
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:599
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:603
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:612
1213 msgid "INSPECTING INSTALL DISKS"
1217 #: ../src/guestfs.pod:614
1219 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1224 #: ../src/guestfs.pod:617
1226 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1227 "system, which currently can be C<installed> (a regular operating system) or "
1228 "C<installer> (some sort of install disk)."
1232 #: ../src/guestfs.pod:621
1234 "Further information is available about the operating system that can be "
1235 "installed using the regular inspection APIs like "
1236 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1241 #: ../src/guestfs.pod:626
1243 "Some additional information specific to installer disks is also available "
1244 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1245 "L</guestfs_inspect_is_multipart> calls."
1249 #: ../src/guestfs.pod:631
1250 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1254 #: ../src/guestfs.pod:633
1256 "Libguestfs can mount NTFS partitions. It does this using the "
1257 "L<http://www.ntfs-3g.org/> driver."
1261 #: ../src/guestfs.pod:636
1262 msgid "DRIVE LETTERS AND PATHS"
1266 #: ../src/guestfs.pod:638
1268 "DOS and Windows still use drive letters, and the filesystems are always "
1269 "treated as case insensitive by Windows itself, and therefore you might find "
1270 "a Windows configuration file referring to a path like "
1271 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1272 "that directory might be referred to as C</WINDOWS/System32>."
1276 #: ../src/guestfs.pod:644
1278 "Drive letter mappings 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 " void 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:1019
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:1857 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262 ../tools/virt-win-reg.pl:532
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 "
3271 #: ../src/guestfs.pod:1677
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:1685
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:1690
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:1694
3300 msgid "CLASSES OF EVENTS"
3304 #: ../src/guestfs.pod:1698
3305 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3309 #: ../src/guestfs.pod:1701
3311 "The callback function will be called while the handle is being closed "
3312 "(synchronously from L</guestfs_close>)."
3316 #: ../src/guestfs.pod:1704
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:1711
3329 "If no callback is registered: the handle is closed without any callback "
3334 #: ../src/guestfs.pod:1714
3335 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3339 #: ../src/guestfs.pod:1717
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:1721 ../src/guestfs.pod:1730
3348 msgid "If no callback is registered: the event is ignored."
3352 #: ../src/guestfs.pod:1723
3353 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3357 #: ../src/guestfs.pod:1726
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:1732
3366 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3370 #: ../src/guestfs.pod:1735
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:1741
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:1744
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:1749
3397 msgid "The only defined and stable parts of the API are:"
3401 #: ../src/guestfs.pod:1755
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:1760
3409 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3413 #: ../src/guestfs.pod:1764
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:1768
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:1774
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:1779
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:1783
3448 "As noted above, if the call fails with an error then the final message may "
3453 #: ../src/guestfs.pod:1788
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:1794
3463 msgid "If no callback is registered: progress messages are discarded."
3467 #: ../src/guestfs.pod:1796
3468 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3472 #: ../src/guestfs.pod:1799
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:1802
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:1805 ../src/guestfs.pod:1819
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:1810
3495 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3499 #: ../src/guestfs.pod:1813
3501 "The callback function is called whenever a log message is generated by the "
3502 "library part of libguestfs."
3506 #: ../src/guestfs.pod:1816
3508 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3509 "messages are generated."
3513 #: ../src/guestfs.pod:1824
3514 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3518 #: ../src/guestfs.pod:1827
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:1830
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:1836
3533 msgid "guestfs_set_event_callback"
3537 #: ../src/guestfs.pod:1838
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:1844
3551 "This function registers a callback (C<cb>) for all event classes in the "
3556 #: ../src/guestfs.pod:1847
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:1853
3566 msgid "C<flags> should always be passed as 0."
3570 #: ../src/guestfs.pod:1855
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:1858
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:1861
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:1864
3593 "Callbacks remain in effect until they are deleted, or until the handle is "
3598 #: ../src/guestfs.pod:1867
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:1871
3607 msgid "guestfs_delete_event_callback"
3611 #: ../src/guestfs.pod:1873
3614 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3619 #: ../src/guestfs.pod:1875
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:1879
3628 msgid "guestfs_event_callback"
3632 #: ../src/guestfs.pod:1881
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:1890
3648 msgid "This is the type of the event callback function that you have to provide."
3652 #: ../src/guestfs.pod:1893
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:1897
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:1902
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:1906
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:1909
3685 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3689 #: ../src/guestfs.pod:1911
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:1915
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:1920
3707 "Programs have to set up a callback to capture the classes of events of "
3712 #: ../src/guestfs.pod:1923
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:1933
3730 "The callback can then direct messages to the appropriate place. In this "
3731 "example, messages are directed to syslog:"
3735 #: ../src/guestfs.pod:1936
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:1951
3757 msgid "PRIVATE DATA AREA"
3761 #: ../src/guestfs.pod:1953
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:1958
3770 msgid "To attach a named piece of data, use the following call:"
3774 #: ../src/guestfs.pod:1960
3777 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3782 #: ../src/guestfs.pod:1962
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:1966
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:1972
3801 msgid "To retrieve the pointer, use:"
3805 #: ../src/guestfs.pod:1974
3808 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3813 #: ../src/guestfs.pod:1976
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:1980
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:1987
3833 msgid "To walk over all entries, use these two functions:"
3837 #: ../src/guestfs.pod:1989
3840 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3845 #: ../src/guestfs.pod:1991
3848 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3853 #: ../src/guestfs.pod:1993
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:1999
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:2003
3872 msgid "Notes about walking over entries:"
3876 #: ../src/guestfs.pod:2009
3877 msgid "You must not call C<guestfs_set_private> while walking over the entries."
3881 #: ../src/guestfs.pod:2014
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:2020
3890 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3894 #: ../src/guestfs.pod:2022
3897 " guestfs_set_private (g, key, NULL);\n"
3902 #: ../src/guestfs.pod:2024
3903 msgid "then that C<key> is not returned when walking."
3907 #: ../src/guestfs.pod:2028
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:2034
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:2037
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:2045
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:2048
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:2057
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:2061
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:2077
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:2082 ../src/guestfs.pod:2087
4001 #: ../src/guestfs.pod:2084
4003 "<!-- old anchor for the next section --> <a "
4004 "name=\"state_machine_and_low_level_event_api\"/>"
4008 #: ../src/guestfs.pod:2089
4009 msgid "ARCHITECTURE"
4013 #: ../src/guestfs.pod:2091
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:2095
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:2115
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:2118
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:2127
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:2134
4078 msgid "STATE MACHINE"
4082 #: ../src/guestfs.pod:2136
4083 msgid "libguestfs uses a state machine to model the child process:"
4087 #: ../src/guestfs.pod:2138
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:2160
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:2165
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:2169
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:2172
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:2178
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:2184
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:2188
4171 #: ../src/guestfs.pod:2190
4172 msgid "COMMUNICATION PROTOCOL"
4176 #: ../src/guestfs.pod:2192
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:2195
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:2199
4193 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4194 "this file is automatically generated)."
4198 #: ../src/guestfs.pod:2202
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:2209
4209 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4213 #: ../src/guestfs.pod:2211
4214 msgid "For ordinary functions, the request message is:"
4218 #: ../src/guestfs.pod:2213
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:2218
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:2224
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:2227
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:2231
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:2239
4265 msgid "The reply message for ordinary functions is:"
4269 #: ../src/guestfs.pod:2241
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:2246
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:2249
4288 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4292 #: ../src/guestfs.pod:2252
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:2255
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:2260
4312 "The C<guestfs_message_error> structure contains the error message as a "
4317 #: ../src/guestfs.pod:2263
4318 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4322 #: ../src/guestfs.pod:2265
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:2269
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:2277
4345 msgid "The \"sequence of chunks\" is:"
4349 #: ../src/guestfs.pod:2279
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:2287
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:2291
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:2296
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:2302
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:2311
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:2317
4412 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4416 #: ../src/guestfs.pod:2319
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:2322
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:2330
4438 msgid "INITIAL MESSAGE"
4442 #: ../src/guestfs.pod:2332
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:2336
4451 msgid "PROGRESS NOTIFICATION MESSAGES"
4455 #: ../src/guestfs.pod:2338
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:2342
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:2346
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:2350
4480 msgid "LIBGUESTFS VERSION NUMBERS"
4484 #: ../src/guestfs.pod:2352
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:2357
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:2368
4510 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4514 #: ../src/guestfs.pod:2370
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:2376
4525 msgid "Our criteria for backporting changes are:"
4529 #: ../src/guestfs.pod:2382
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:2388
4538 "Bug fixes which are not controversial, fix obvious problems, and have been "
4539 "well tested are backported."
4543 #: ../src/guestfs.pod:2393
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:2399
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:2405
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:2413
4571 msgid "EXTENDING LIBGUESTFS"
4575 #: ../src/guestfs.pod:2415
4576 msgid "ADDING A NEW API ACTION"
4580 #: ../src/guestfs.pod:2417
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:2421
4589 msgid "To add a new API action there are two changes:"
4593 #: ../src/guestfs.pod:2427
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:2430
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:2438
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:2444
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:2452
4632 msgid "Implement the action (in C):"
4636 #: ../src/guestfs.pod:2454
4638 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4639 "C<daemon/> directory."
4643 #: ../src/guestfs.pod:2457
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:2460
4651 msgid "In either case, use another function as an example of what to do."
4655 #: ../src/guestfs.pod:2464
4656 msgid "After making these changes, use C<make> to compile."
4660 #: ../src/guestfs.pod:2466
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:2470
4669 msgid "ADDING TESTS FOR AN API ACTION"
4673 #: ../src/guestfs.pod:2472
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:2478
4685 "The following describes the test environment used when you add an API test "
4686 "in C<generator_actions.ml>."
4690 #: ../src/guestfs.pod:2481
4691 msgid "The test environment has 4 block devices:"
4695 #: ../src/guestfs.pod:2485
4696 msgid "C</dev/sda> 500MB"
4700 #: ../src/guestfs.pod:2487
4701 msgid "General block device for testing."
4705 #: ../src/guestfs.pod:2489
4706 msgid "C</dev/sdb> 50MB"
4710 #: ../src/guestfs.pod:2491
4712 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4717 #: ../src/guestfs.pod:2494
4718 msgid "C</dev/sdc> 10MB"
4722 #: ../src/guestfs.pod:2496
4723 msgid "Used in a few tests where two block devices are needed."
4727 #: ../src/guestfs.pod:2498
4732 #: ../src/guestfs.pod:2500
4733 msgid "ISO with fixed content (see C<images/test.iso>)."
4737 #: ../src/guestfs.pod:2504
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:2508
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:2514
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:2520
4767 "In addition, packagers can skip individual tests by setting environment "
4768 "variables before running C<make check>."
4772 #: ../src/guestfs.pod:2523
4775 " SKIP_TEST_<CMD>_<NUM>=1\n"
4780 #: ../src/guestfs.pod:2525
4781 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4785 #: ../src/guestfs.pod:2527
4790 #: ../src/guestfs.pod:2529
4793 " SKIP_TEST_<CMD>=1\n"
4798 #: ../src/guestfs.pod:2531
4799 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4803 #: ../src/guestfs.pod:2533
4804 msgid "Packagers can run only certain tests by setting for example:"
4808 #: ../src/guestfs.pod:2535
4811 " TEST_ONLY=\"vfs_type zerofree\"\n"
4816 #: ../src/guestfs.pod:2537
4818 "See C<capitests/tests.c> for more details of how these environment variables "
4823 #: ../src/guestfs.pod:2540
4824 msgid "DEBUGGING NEW API ACTIONS"
4828 #: ../src/guestfs.pod:2542
4829 msgid "Test new actions work before submitting them."
4833 #: ../src/guestfs.pod:2544
4834 msgid "You can use guestfish to try out new commands."
4838 #: ../src/guestfs.pod:2546
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:2550
4847 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4851 #: ../src/guestfs.pod:2552
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:2558
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:2561
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:2571
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:2583
4903 msgid "Enable warnings when compiling (and fix any problems this finds):"
4907 #: ../src/guestfs.pod:2586
4910 " ./configure --enable-gcc-warnings\n"
4915 #: ../src/guestfs.pod:2588
4916 msgid "Useful targets are:"
4920 #: ../src/guestfs.pod:2590
4923 " make syntax-check # checks the syntax of the C code\n"
4924 " make check # runs the test suite\n"
4929 #: ../src/guestfs.pod:2593
4930 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4934 #: ../src/guestfs.pod:2595
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:2600
4946 #: ../src/guestfs.pod:2602
4948 "Simple shell quoted string. Any spaces or other shell characters are "
4953 #: ../src/guestfs.pod:2605
4958 #: ../src/guestfs.pod:2607
4960 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4965 #: ../src/guestfs.pod:2612 ../fish/guestfish.pod:240 ../fish/guestfish.pod:613
4966 msgid "For example:"
4970 #: ../src/guestfs.pod:2614
4973 " asprintf (&cmd, \"cat %R\", path);\n"
4978 #: ../src/guestfs.pod:2616
4979 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4983 #: ../src/guestfs.pod:2618
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:2624
4993 msgid "SUBMITTING YOUR NEW API ACTIONS"
4997 #: ../src/guestfs.pod:2626
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:2630
5006 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5010 #: ../src/guestfs.pod:2632
5011 msgid "We support i18n (gettext anyhow) in the library."
5015 #: ../src/guestfs.pod:2634
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:2640
5026 "Debugging messages are never translated, since they are intended for the "
5031 #: ../src/guestfs.pod:2643
5032 msgid "SOURCE CODE SUBDIRECTORIES"
5036 #: ../src/guestfs.pod:2647 ../src/guestfs-actions.pod:5832 ../fish/guestfish-actions.pod:3926
5037 msgid "C<appliance>"
5041 #: ../src/guestfs.pod:2649
5042 msgid "The libguestfs appliance, build scripts and so on."
5046 #: ../src/guestfs.pod:2651
5047 msgid "C<capitests>"
5051 #: ../src/guestfs.pod:2653
5052 msgid "Automated tests of the C API."
5056 #: ../src/guestfs.pod:2655
5061 #: ../src/guestfs.pod:2657
5063 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5068 #: ../src/guestfs.pod:2660
5073 #: ../src/guestfs.pod:2662
5075 "Safety and liveness tests of components that libguestfs depends upon (not of "
5076 "libguestfs itself). Mainly this is for qemu and the kernel."
5080 #: ../src/guestfs.pod:2665
5085 #: ../src/guestfs.pod:2667
5086 msgid "Outside contributions, experimental parts."
5090 #: ../src/guestfs.pod:2669
5095 #: ../src/guestfs.pod:2671
5097 "The daemon that runs inside the libguestfs appliance and carries out "
5102 #: ../src/guestfs.pod:2674
5107 #: ../src/guestfs.pod:2676
5108 msgid "L<virt-df(1)> command and documentation."
5112 #: ../src/guestfs.pod:2678
5117 #: ../src/guestfs.pod:2680
5118 msgid "C API example code."
5122 #: ../src/guestfs.pod:2682
5127 #: ../src/guestfs.pod:2684
5129 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5130 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5131 "L<virt-tar-out(1)>."
5135 #: ../src/guestfs.pod:2688
5140 #: ../src/guestfs.pod:2690
5141 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5145 #: ../src/guestfs.pod:2692
5146 msgid "C<generator>"
5150 #: ../src/guestfs.pod:2694
5152 "The crucially important generator, used to automatically generate large "
5153 "amounts of boilerplate C code for things like RPC and bindings."
5157 #: ../src/guestfs.pod:2697
5162 #: ../src/guestfs.pod:2699
5163 msgid "Files used by the test suite."
5167 #: ../src/guestfs.pod:2701
5168 msgid "Some \"phony\" guest images which we test against."
5172 #: ../src/guestfs.pod:2703
5173 msgid "C<inspector>"
5177 #: ../src/guestfs.pod:2705
5178 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5182 #: ../src/guestfs.pod:2707
5187 #: ../src/guestfs.pod:2709
5188 msgid "Logo used on the website. The fish is called Arthur by the way."
5192 #: ../src/guestfs.pod:2711
5197 #: ../src/guestfs.pod:2713
5198 msgid "M4 macros used by autoconf."
5202 #: ../src/guestfs.pod:2715
5207 #: ../src/guestfs.pod:2717
5208 msgid "Translations of simple gettext strings."
5212 #: ../src/guestfs.pod:2719
5217 #: ../src/guestfs.pod:2721
5219 "The build infrastructure and PO files for translations of manpages and POD "
5220 "files. Eventually this will be combined with the C<po> directory, but that "
5221 "is rather complicated."
5225 #: ../src/guestfs.pod:2725
5226 msgid "C<regressions>"
5230 #: ../src/guestfs.pod:2727
5231 msgid "Regression tests."
5235 #: ../src/guestfs.pod:2729
5240 #: ../src/guestfs.pod:2731
5241 msgid "L<virt-rescue(1)> command and documentation."
5245 #: ../src/guestfs.pod:2733
5250 #: ../src/guestfs.pod:2735
5251 msgid "Source code to the C library."
5255 #: ../src/guestfs.pod:2737
5260 #: ../src/guestfs.pod:2739
5261 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5265 #: ../src/guestfs.pod:2741
5266 msgid "C<test-tool>"
5270 #: ../src/guestfs.pod:2743
5272 "Test tool for end users to test if their qemu/kernel combination will work "
5277 #: ../src/guestfs.pod:2746
5282 #: ../src/guestfs.pod:2748
5287 #: ../src/guestfs.pod:2750
5292 #: ../src/guestfs.pod:2752
5297 #: ../src/guestfs.pod:2754
5302 #: ../src/guestfs.pod:2756
5307 #: ../src/guestfs.pod:2758
5312 #: ../src/guestfs.pod:2760
5317 #: ../src/guestfs.pod:2762
5318 msgid "Language bindings."
5322 #: ../src/guestfs.pod:2766
5327 #: ../src/guestfs.pod:2768
5328 msgid "PROTOCOL LIMITS"
5332 #: ../src/guestfs.pod:2770
5334 "Internally libguestfs uses a message-based protocol to pass API calls and "
5335 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5336 "plenty more detail about this). The maximum message size used by the "
5337 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5338 "aware of this limit. The API calls which may be affected are individually "
5339 "documented, with a link back to this section of the documentation."
5343 #: ../src/guestfs.pod:2778
5345 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5346 "a simple string. Because this string is at some point internally encoded as "
5347 "a message, the maximum size that it can return is slightly under 4 MB. If "
5348 "the requested file is larger than this then you will get an error."
5352 #: ../src/guestfs.pod:2784
5354 "In order to transfer large files into and out of the guest filesystem, you "
5355 "need to use particular calls that support this. The sections L</UPLOADING> "
5356 "and L</DOWNLOADING> document how to do this."
5360 #: ../src/guestfs.pod:2788
5362 "You might also consider mounting the disk image using our FUSE filesystem "
5363 "support (L<guestmount(1)>)."
5367 #: ../src/guestfs.pod:2791
5368 msgid "MAXIMUM NUMBER OF DISKS"
5372 #: ../src/guestfs.pod:2793
5373 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5377 #: ../src/guestfs.pod:2796
5379 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5380 "slots. However febootstrap only understands disks with names C</dev/vda> "
5381 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5386 #: ../src/guestfs.pod:2801
5388 "We are working to substantially raise this limit in future versions but it "
5389 "requires complex changes to qemu."
5393 #: ../src/guestfs.pod:2804
5395 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5396 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5397 "requires changes to qemu."
5401 #: ../src/guestfs.pod:2808
5402 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5406 #: ../src/guestfs.pod:2810
5407 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5411 #: ../src/guestfs.pod:2812
5413 "This is because it reserves 4 bits for the minor device number (thus "
5414 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5418 #: ../src/guestfs.pod:2815
5420 "If you attach a disk with more than 15 partitions, the extra partitions are "
5421 "ignored by libguestfs."
5425 #: ../src/guestfs.pod:2818
5426 msgid "MAXIMUM SIZE OF A DISK"
5430 #: ../src/guestfs.pod:2820
5431 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5435 #: ../src/guestfs.pod:2822
5437 "We have tested block devices up to 1 exabyte (2**60 or "
5438 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5443 #: ../src/guestfs.pod:2826
5445 "Although libguestfs probably does not impose any limit, the underlying host "
5446 "storage will. If you store disk images on a host ext4 filesystem, then the "
5447 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5448 "TB). If you store disk images as host logical volumes then you are limited "
5449 "by the maximum size of an LV."
5453 #: ../src/guestfs.pod:2832
5455 "For the hugest disk image files, we recommend using XFS on the host for "
5460 #: ../src/guestfs.pod:2835
5461 msgid "MAXIMUM SIZE OF A PARTITION"
5465 #: ../src/guestfs.pod:2837
5467 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5468 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5469 "address a partition located beyond 2 TB on the disk."
5473 #: ../src/guestfs.pod:2841
5475 "It is recommended that you use GPT partitions on disks which are larger than "
5476 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5477 "which are theoretically larger than the largest disk we could support."
5481 #: ../src/guestfs.pod:2846
5482 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5486 #: ../src/guestfs.pod:2848
5488 "This depends on the filesystem type. libguestfs itself does not impose any "
5489 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5490 "what these limits are."
5494 #: ../src/guestfs.pod:2852
5495 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5499 #: ../src/guestfs.pod:2854
5501 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5502 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5503 "uploads and downloads."
5507 #: ../src/guestfs.pod:2858
5508 msgid "INSPECTION LIMITS"
5512 #: ../src/guestfs.pod:2860
5514 "The inspection code has several arbitrary limits on things like the size of "
5515 "Windows Registry hive it will read, and the length of product name. These "
5516 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5517 "memory and disk space on the host, and should not be reached in practice. "
5518 "See the source code for more information."
5522 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1026 ../test-tool/libguestfs-test-tool.pod:82 ../tools/virt-edit.pl:476
5523 msgid "ENVIRONMENT VARIABLES"
5527 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1052
5528 msgid "LIBGUESTFS_APPEND"
5532 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1054
5533 msgid "Pass additional options to the guest kernel."
5537 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1056
5538 msgid "LIBGUESTFS_DEBUG"
5542 #: ../src/guestfs.pod:2876
5544 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5545 "effect as calling C<guestfs_set_verbose (g, 1)>."
5549 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1061
5550 msgid "LIBGUESTFS_MEMSIZE"
5554 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1063
5555 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5559 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1066
5562 " LIBGUESTFS_MEMSIZE=700\n"
5567 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1068
5568 msgid "LIBGUESTFS_PATH"
5572 #: ../src/guestfs.pod:2888
5574 "Set the path that libguestfs uses to search for a supermin appliance. See "
5575 "the discussion of paths in section L</PATH> above."
5579 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1073
5580 msgid "LIBGUESTFS_QEMU"
5584 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1075
5586 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5587 "which was found at compile time by the configure script is used."
5591 #: ../src/guestfs.pod:2897
5592 msgid "See also L</QEMU WRAPPERS> above."
5596 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1079
5597 msgid "LIBGUESTFS_TRACE"
5601 #: ../src/guestfs.pod:2901
5603 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5604 "effect as calling C<guestfs_set_trace (g, 1)>."
5608 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1088
5613 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1090
5615 "Location of temporary directory, defaults to C</tmp> except for the cached "
5616 "supermin appliance which defaults to C</var/tmp>."
5620 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1093
5622 "If libguestfs was compiled to use the supermin appliance then the real "
5623 "appliance is cached in this directory, shared between all handles belonging "
5624 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5625 "use in case C</var/tmp> is not large enough."
5629 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1160 ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:277 ../tools/virt-edit.pl:496 ../tools/virt-win-reg.pl:572 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5634 #: ../src/guestfs.pod:2919
5636 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
5637 "L<guestfs-python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, "
5638 "L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, "
5639 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
5640 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
5641 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
5642 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
5643 "L<hivex(3)>, L<http://libguestfs.org/>."
5647 #: ../src/guestfs.pod:2947
5649 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5650 "L<lvm(8)>, L<disktype(1)>."
5654 #: ../src/guestfs.pod:2954 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
5659 #: ../src/guestfs.pod:2956
5660 msgid "To get a list of bugs against libguestfs use this link:"
5664 #: ../src/guestfs.pod:2958
5665 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5669 #: ../src/guestfs.pod:2960
5670 msgid "To report a new bug against libguestfs use this link:"
5674 #: ../src/guestfs.pod:2962
5675 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5679 #: ../src/guestfs.pod:2964
5680 msgid "When reporting a bug, please check:"
5684 #: ../src/guestfs.pod:2970
5685 msgid "That the bug hasn't been reported already."
5689 #: ../src/guestfs.pod:2974
5690 msgid "That you are testing a recent version."
5694 #: ../src/guestfs.pod:2978
5695 msgid "Describe the bug accurately, and give a way to reproduce it."
5699 #: ../src/guestfs.pod:2982
5701 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5706 #: ../src/guestfs.pod:2987 ../fish/guestfish.pod:1183 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:288
5711 #: ../src/guestfs.pod:2989 ../fish/guestfish.pod:1185 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:290
5712 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5716 #: ../src/guestfs.pod:2991 ../fish/guestfish.pod:1187 ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:292 ../tools/virt-edit.pl:514 ../tools/virt-win-reg.pl:602 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5721 #: ../src/guestfs.pod:2993 ../fish/guestfish.pod:1189 ../test-tool/libguestfs-test-tool.pod:99
5722 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5726 #: ../src/guestfs.pod:2996
5728 "This library is free software; you can redistribute it and/or modify it "
5729 "under the terms of the GNU Lesser General Public License as published by the "
5730 "Free Software Foundation; either version 2 of the License, or (at your "
5731 "option) any later version."
5735 #: ../src/guestfs.pod:3001
5737 "This library is distributed in the hope that it will be useful, but WITHOUT "
5738 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5739 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5744 #: ../src/guestfs.pod:3006
5746 "You should have received a copy of the GNU Lesser General Public License "
5747 "along with this library; if not, write to the Free Software Foundation, "
5748 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5752 #: ../src/guestfs-actions.pod:1
5753 msgid "guestfs_add_cdrom"
5757 #: ../src/guestfs-actions.pod:3
5761 " guestfs_add_cdrom (guestfs_h *g,\n"
5762 " const char *filename);\n"
5767 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5768 msgid "This function adds a virtual CD-ROM disk image to the guest."
5772 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5773 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5777 #: ../src/guestfs-actions.pod:17
5779 "This call checks for the existence of C<filename>. This stops you from "
5780 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5781 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5786 #: ../src/guestfs-actions.pod:24
5788 "If you just want to add an ISO file (often you use this as an efficient way "
5789 "to transfer large files into the guest), then you should probably use "
5790 "C<guestfs_add_drive_ro> instead."
5794 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134 ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232 ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301 ../src/guestfs-actions.pod:421 ../src/guestfs-actions.pod:441 ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:500 ../src/guestfs-actions.pod:528 ../src/guestfs-actions.pod:546 ../src/guestfs-actions.pod:613 ../src/guestfs-actions.pod:646 ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:675 ../src/guestfs-actions.pod:774 ../src/guestfs-actions.pod:792 ../src/guestfs-actions.pod:806 ../src/guestfs-actions.pod:820 ../src/guestfs-actions.pod:981 ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:1103 ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1140 ../src/guestfs-actions.pod:1154 ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1244 ../src/guestfs-actions.pod:1275 ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1448 ../src/guestfs-actions.pod:1482 ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1719 ../src/guestfs-actions.pod:1806 ../src/guestfs-actions.pod:2268 ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:3501 ../src/guestfs-actions.pod:3656 ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3683 ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3840 ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:3903 ../src/guestfs-actions.pod:3935 ../src/guestfs-actions.pod:3954 ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4117 ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4243 ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4312 ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4346 ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4391 ../src/guestfs-actions.pod:4406 ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4484 ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4607 ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4638 ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:4683 ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:4733 ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4775 ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:4806 ../src/guestfs-actions.pod:4855 ../src/guestfs-actions.pod:4901 ../src/guestfs-actions.pod:4915 ../src/guestfs-actions.pod:4943 ../src/guestfs-actions.pod:4960 ../src/guestfs-actions.pod:4978 ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:5169 ../src/guestfs-actions.pod:5191 ../src/guestfs-actions.pod:5209 ../src/guestfs-actions.pod:5241 ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5324 ../src/guestfs-actions.pod:5337 ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5640 ../src/guestfs-actions.pod:5659 ../src/guestfs-actions.pod:5678 ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5702 ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5779 ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5817 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5863 ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:5904 ../src/guestfs-actions.pod:5923 ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:6008 ../src/guestfs-actions.pod:6032 ../src/guestfs-actions.pod:6051 ../src/guestfs-actions.pod:6075 ../src/guestfs-actions.pod:6094 ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6165 ../src/guestfs-actions.pod:6195 ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6350 ../src/guestfs-actions.pod:6471 ../src/guestfs-actions.pod:6483 ../src/guestfs-actions.pod:6496 ../src/guestfs-actions.pod:6509 ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6570 ../src/guestfs-actions.pod:6585 ../src/guestfs-actions.pod:6644 ../src/guestfs-actions.pod:6661 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6693 ../src/guestfs-actions.pod:6710 ../src/guestfs-actions.pod:6723 ../src/guestfs-actions.pod:6743 ../src/guestfs-actions.pod:6779 ../src/guestfs-actions.pod:6793 ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:6865 ../src/guestfs-actions.pod:6899 ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7072 ../src/guestfs-actions.pod:7086 ../src/guestfs-actions.pod:7141 ../src/guestfs-actions.pod:7154 ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7293 ../src/guestfs-actions.pod:7319 ../src/guestfs-actions.pod:7385 ../src/guestfs-actions.pod:7404 ../src/guestfs-actions.pod:7433
5795 msgid "This function returns 0 on success or -1 on error."
5799 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:269
5801 "This function is deprecated. In new code, use the "
5802 "L</guestfs_add_drive_opts> call instead."
5806 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251 ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1453 ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:6173 ../src/guestfs-actions.pod:6203 ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6295 ../src/guestfs-actions.pod:7237 ../src/guestfs-actions.pod:7327 ../src/guestfs-actions.pod:7496 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175 ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3010 ../fish/guestfish-actions.pod:3207 ../fish/guestfish-actions.pod:4188 ../fish/guestfish-actions.pod:4211 ../fish/guestfish-actions.pod:4233 ../fish/guestfish-actions.pod:4271 ../fish/guestfish-actions.pod:4912 ../fish/guestfish-actions.pod:5009
5808 "Deprecated functions will not be removed from the API, but the fact that "
5809 "they are deprecated indicates that there are problems with correct use of "
5814 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136 ../src/guestfs-actions.pod:1105 ../src/guestfs-actions.pod:1918 ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2119 ../src/guestfs-actions.pod:3463 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:5865 ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6096 ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:7241
5815 msgid "(Added in 0.3)"
5819 #: ../src/guestfs-actions.pod:41
5820 msgid "guestfs_add_domain"
5824 #: ../src/guestfs-actions.pod:43
5828 " guestfs_add_domain (guestfs_h *g,\n"
5829 " const char *dom,\n"
5835 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145 ../src/guestfs-actions.pod:4445
5837 "You may supply a list of optional arguments to this call. Use zero or more "
5838 "of the following pairs of parameters, and terminate the list with C<-1> on "
5839 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5843 #: ../src/guestfs-actions.pod:53
5846 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5847 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5848 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5849 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5854 #: ../src/guestfs-actions.pod:58
5856 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5857 "It works by connecting to libvirt, requesting the domain and domain XML from "
5858 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5863 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5865 "The number of disks added is returned. This operation is atomic: if an "
5866 "error is returned, then no disks are added."
5870 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5872 "This function does some minimal checks to make sure the libvirt domain is "
5873 "not running (unless C<readonly> is true). In a future version we will try "
5874 "to acquire the libvirt lock on each disk."
5878 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5880 "Disks must be accessible locally. This often means that adding disks from a "
5881 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5882 "unless those disks are accessible via the same device path locally too."
5886 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5888 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5889 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5890 "default libvirt URI (or one set through an environment variable, see the "
5891 "libvirt documentation for full details)."
5895 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5897 "The optional C<live> flag controls whether this call will try to connect to "
5898 "a running virtual machine C<guestfsd> process if it sees a suitable "
5899 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5900 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5901 "DAEMONS> for more information."
5905 #: ../src/guestfs-actions.pod:88
5907 "The other optional parameters are passed directly through to "
5908 "C<guestfs_add_drive_opts>."
5912 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344 ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:723 ../src/guestfs-actions.pod:741 ../src/guestfs-actions.pod:760 ../src/guestfs-actions.pod:1320 ../src/guestfs-actions.pod:1676 ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2028 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:4878 ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:6820 ../src/guestfs-actions.pod:7252 ../src/guestfs-actions.pod:7265 ../src/guestfs-actions.pod:7278
5913 msgid "On error this function returns -1."
5917 #: ../src/guestfs-actions.pod:93
5918 msgid "(Added in 1.7.4)"
5922 #: ../src/guestfs-actions.pod:95
5923 msgid "guestfs_add_domain_va"
5927 #: ../src/guestfs-actions.pod:97
5931 " guestfs_add_domain_va (guestfs_h *g,\n"
5932 " const char *dom,\n"
5938 #: ../src/guestfs-actions.pod:102
5939 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5943 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219 ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4510
5944 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5948 #: ../src/guestfs-actions.pod:106
5949 msgid "guestfs_add_domain_argv"
5953 #: ../src/guestfs-actions.pod:108
5957 " guestfs_add_domain_argv (guestfs_h *g,\n"
5958 " const char *dom,\n"
5959 " const struct guestfs_add_domain_argv *optargs);\n"
5964 #: ../src/guestfs-actions.pod:113
5965 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5969 #: ../src/guestfs-actions.pod:117
5970 msgid "guestfs_add_drive"
5974 #: ../src/guestfs-actions.pod:119
5978 " guestfs_add_drive (guestfs_h *g,\n"
5979 " const char *filename);\n"
5984 #: ../src/guestfs-actions.pod:123
5986 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5987 "optional parameters, so the disk is added writable, with the format being "
5988 "detected automatically."
5992 #: ../src/guestfs-actions.pod:127
5994 "Automatic detection of the format opens you up to a potential security hole "
5995 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5996 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5997 "you should think about replacing calls to this function with calls to "
5998 "C<guestfs_add_drive_opts>, and specifying the format."
6002 #: ../src/guestfs-actions.pod:138
6003 msgid "guestfs_add_drive_opts"
6007 #: ../src/guestfs-actions.pod:140
6011 " guestfs_add_drive_opts (guestfs_h *g,\n"
6012 " const char *filename,\n"
6018 #: ../src/guestfs-actions.pod:150
6021 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6022 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6023 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6028 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
6030 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6031 "The first time you call this function, the disk appears as C</dev/sda>, the "
6032 "second time as C</dev/sdb>, and so on."
6036 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
6038 "You don't necessarily need to be root when using libguestfs. However you "
6039 "obviously do need sufficient permissions to access the filename for whatever "
6040 "operations you want to perform (ie. read access if you just want to read the "
6041 "image or write access if you want to modify the image)."
6045 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
6046 msgid "This call checks that C<filename> exists."
6050 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:3021
6051 msgid "The optional arguments are:"
6055 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
6060 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
6062 "If true then the image is treated as read-only. Writes are still allowed, "
6063 "but they are stored in a temporary snapshot overlay which is discarded at "
6064 "the end. The disk that you add is not modified."
6068 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
6073 #: ../src/guestfs-actions.pod:179
6075 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6076 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6077 "Possible formats include C<raw> and C<qcow2>."
6081 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
6083 "Automatic detection of the format opens you up to a potential security hole "
6084 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6085 "RHBZ#642934. Specifying the format closes this security hole."
6089 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
6094 #: ../src/guestfs-actions.pod:190
6096 "This rarely-used option lets you emulate the behaviour of the deprecated "
6097 "C<guestfs_add_drive_with_if> call (q.v.)"
6101 #: ../src/guestfs-actions.pod:197
6102 msgid "(Added in 1.5.23)"
6106 #: ../src/guestfs-actions.pod:199
6107 msgid "guestfs_add_drive_opts_va"
6111 #: ../src/guestfs-actions.pod:201
6115 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6116 " const char *filename,\n"
6122 #: ../src/guestfs-actions.pod:206
6123 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6127 #: ../src/guestfs-actions.pod:210
6128 msgid "guestfs_add_drive_opts_argv"
6132 #: ../src/guestfs-actions.pod:212
6136 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6137 " const char *filename,\n"
6138 " const struct guestfs_add_drive_opts_argv "
6144 #: ../src/guestfs-actions.pod:217
6145 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6149 #: ../src/guestfs-actions.pod:221
6150 msgid "guestfs_add_drive_ro"
6154 #: ../src/guestfs-actions.pod:223
6158 " guestfs_add_drive_ro (guestfs_h *g,\n"
6159 " const char *filename);\n"
6164 #: ../src/guestfs-actions.pod:227
6166 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6167 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6168 "disk is added read-only, with the format being detected automatically."
6172 #: ../src/guestfs-actions.pod:234
6173 msgid "(Added in 1.0.38)"
6177 #: ../src/guestfs-actions.pod:236
6178 msgid "guestfs_add_drive_ro_with_if"
6182 #: ../src/guestfs-actions.pod:238
6186 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6187 " const char *filename,\n"
6188 " const char *iface);\n"
6193 #: ../src/guestfs-actions.pod:243
6195 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6196 "QEMU interface emulation to use at run time."
6200 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:2358
6201 msgid "(Added in 1.0.84)"
6205 #: ../src/guestfs-actions.pod:257
6206 msgid "guestfs_add_drive_with_if"
6210 #: ../src/guestfs-actions.pod:259
6214 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6215 " const char *filename,\n"
6216 " const char *iface);\n"
6221 #: ../src/guestfs-actions.pod:264
6223 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6224 "QEMU interface emulation to use at run time."
6228 #: ../src/guestfs-actions.pod:278
6229 msgid "guestfs_aug_clear"
6233 #: ../src/guestfs-actions.pod:280
6237 " guestfs_aug_clear (guestfs_h *g,\n"
6238 " const char *augpath);\n"
6243 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6245 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6246 "L<augtool(1)> C<clear> command."
6250 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2108
6251 msgid "(Added in 1.3.4)"
6255 #: ../src/guestfs-actions.pod:291
6256 msgid "guestfs_aug_close"
6260 #: ../src/guestfs-actions.pod:293
6264 " guestfs_aug_close (guestfs_h *g);\n"
6269 #: ../src/guestfs-actions.pod:296
6271 "Close the current Augeas handle and free up any resources used by it. After "
6272 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6273 "any other Augeas functions."
6277 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328 ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:423 ../src/guestfs-actions.pod:443 ../src/guestfs-actions.pod:457 ../src/guestfs-actions.pod:488 ../src/guestfs-actions.pod:502 ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:530 ../src/guestfs-actions.pod:548 ../src/guestfs-actions.pod:5498
6278 msgid "(Added in 0.7)"
6282 #: ../src/guestfs-actions.pod:305
6283 msgid "guestfs_aug_defnode"
6287 #: ../src/guestfs-actions.pod:307
6290 " struct guestfs_int_bool *\n"
6291 " guestfs_aug_defnode (guestfs_h *g,\n"
6292 " const char *name,\n"
6293 " const char *expr,\n"
6294 " const char *val);\n"
6299 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6300 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6304 #: ../src/guestfs-actions.pod:316
6306 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6307 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6308 "containing that single node."
6312 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6314 "On success this returns a pair containing the number of nodes in the "
6315 "nodeset, and a boolean flag if a node was created."
6319 #: ../src/guestfs-actions.pod:324
6321 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6322 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6326 #: ../src/guestfs-actions.pod:330
6327 msgid "guestfs_aug_defvar"
6331 #: ../src/guestfs-actions.pod:332
6335 " guestfs_aug_defvar (guestfs_h *g,\n"
6336 " const char *name,\n"
6337 " const char *expr);\n"
6342 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6344 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6345 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6349 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6351 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6352 "evaluates to something which is not a nodeset."
6356 #: ../src/guestfs-actions.pod:348
6357 msgid "guestfs_aug_get"
6361 #: ../src/guestfs-actions.pod:350
6365 " guestfs_aug_get (guestfs_h *g,\n"
6366 " const char *augpath);\n"
6371 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6373 "Look up the value associated with C<path>. If C<path> matches exactly one "
6374 "node, the C<value> is returned."
6378 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:862 ../src/guestfs-actions.pod:880 ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:956 ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:1189 ../src/guestfs-actions.pod:1206 ../src/guestfs-actions.pod:1225 ../src/guestfs-actions.pod:1359 ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1659 ../src/guestfs-actions.pod:1822 ../src/guestfs-actions.pod:1839 ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:1940 ../src/guestfs-actions.pod:1961 ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2530 ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2734 ../src/guestfs-actions.pod:2754 ../src/guestfs-actions.pod:2874 ../src/guestfs-actions.pod:2905 ../src/guestfs-actions.pod:2929 ../src/guestfs-actions.pod:2966 ../src/guestfs-actions.pod:3026 ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3070 ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4272 ../src/guestfs-actions.pod:5033 ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5396 ../src/guestfs-actions.pod:5574 ../src/guestfs-actions.pod:5623 ../src/guestfs-actions.pod:6256 ../src/guestfs-actions.pod:6272 ../src/guestfs-actions.pod:6289 ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6994 ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7031 ../src/guestfs-actions.pod:7211 ../src/guestfs-actions.pod:7490
6380 "This function returns a string, or NULL on error. I<The caller must free "
6381 "the returned string after use>."
6385 #: ../src/guestfs-actions.pod:362
6386 msgid "guestfs_aug_init"
6390 #: ../src/guestfs-actions.pod:364
6394 " guestfs_aug_init (guestfs_h *g,\n"
6395 " const char *root,\n"
6401 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6403 "Create a new Augeas handle for editing configuration files. If there was "
6404 "any previous Augeas handle associated with this guestfs session, then it is "
6409 #: ../src/guestfs-actions.pod:373
6410 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6414 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6415 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6419 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6421 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6422 "logical I<or> of the following integers:"
6426 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6427 msgid "C<AUG_SAVE_BACKUP> = 1"
6431 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6432 msgid "Keep the original file with a C<.augsave> extension."
6436 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6437 msgid "C<AUG_SAVE_NEWFILE> = 2"
6441 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6443 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6444 "original. Overrides C<AUG_SAVE_BACKUP>."
6448 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6449 msgid "C<AUG_TYPE_CHECK> = 4"
6453 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6454 msgid "Typecheck lenses."
6458 #: ../src/guestfs-actions.pod:398
6460 "This option is only useful when debugging Augeas lenses. Use of this option "
6461 "may require additional memory for the libguestfs appliance. You may need to "
6462 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
6463 "C<guestfs_set_memsize>."
6467 #: ../src/guestfs-actions.pod:403 ../fish/guestfish-actions.pod:266
6468 msgid "C<AUG_NO_STDINC> = 8"
6472 #: ../src/guestfs-actions.pod:405 ../fish/guestfish-actions.pod:268
6473 msgid "Do not use standard load path for modules."
6477 #: ../src/guestfs-actions.pod:407 ../fish/guestfish-actions.pod:270
6478 msgid "C<AUG_SAVE_NOOP> = 16"
6482 #: ../src/guestfs-actions.pod:409 ../fish/guestfish-actions.pod:272
6483 msgid "Make save a no-op, just record what would have been changed."
6487 #: ../src/guestfs-actions.pod:411 ../fish/guestfish-actions.pod:274
6488 msgid "C<AUG_NO_LOAD> = 32"
6492 #: ../src/guestfs-actions.pod:413
6493 msgid "Do not load the tree in C<guestfs_aug_init>."
6497 #: ../src/guestfs-actions.pod:417
6498 msgid "To close the handle, you can call C<guestfs_aug_close>."
6502 #: ../src/guestfs-actions.pod:419 ../fish/guestfish-actions.pod:282
6503 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6507 #: ../src/guestfs-actions.pod:425
6508 msgid "guestfs_aug_insert"
6512 #: ../src/guestfs-actions.pod:427
6516 " guestfs_aug_insert (guestfs_h *g,\n"
6517 " const char *augpath,\n"
6518 " const char *label,\n"
6524 #: ../src/guestfs-actions.pod:433 ../fish/guestfish-actions.pod:288
6526 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6527 "or after C<path> (depending on the boolean flag C<before>)."
6531 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:292
6533 "C<path> must match exactly one existing node in the tree, and C<label> must "
6534 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6538 #: ../src/guestfs-actions.pod:445
6539 msgid "guestfs_aug_load"
6543 #: ../src/guestfs-actions.pod:447
6547 " guestfs_aug_load (guestfs_h *g);\n"
6552 #: ../src/guestfs-actions.pod:450 ../fish/guestfish-actions.pod:300
6553 msgid "Load files into the tree."
6557 #: ../src/guestfs-actions.pod:452 ../fish/guestfish-actions.pod:302
6558 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6562 #: ../src/guestfs-actions.pod:459
6563 msgid "guestfs_aug_ls"
6567 #: ../src/guestfs-actions.pod:461
6571 " guestfs_aug_ls (guestfs_h *g,\n"
6572 " const char *augpath);\n"
6577 #: ../src/guestfs-actions.pod:465
6579 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6580 "sorting the resulting nodes into alphabetical order."
6584 #: ../src/guestfs-actions.pod:468 ../src/guestfs-actions.pod:484 ../src/guestfs-actions.pod:630 ../src/guestfs-actions.pod:1078 ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1393 ../src/guestfs-actions.pod:1496 ../src/guestfs-actions.pod:1515 ../src/guestfs-actions.pod:1761 ../src/guestfs-actions.pod:2203 ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2281 ../src/guestfs-actions.pod:2305 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2425 ../src/guestfs-actions.pod:2692 ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:3272 ../src/guestfs-actions.pod:3562 ../src/guestfs-actions.pod:3624 ../src/guestfs-actions.pod:3729 ../src/guestfs-actions.pod:4134 ../src/guestfs-actions.pod:4839 ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:5494 ../src/guestfs-actions.pod:5608 ../src/guestfs-actions.pod:6336 ../src/guestfs-actions.pod:6397 ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:6598 ../src/guestfs-actions.pod:6622 ../src/guestfs-actions.pod:7104 ../src/guestfs-actions.pod:7124 ../src/guestfs-actions.pod:7171 ../src/guestfs-actions.pod:7343 ../src/guestfs-actions.pod:7362 ../src/guestfs-actions.pod:7447 ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7512 ../src/guestfs-actions.pod:7531
6586 "This function returns a NULL-terminated array of strings (like "
6587 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6588 "strings and the array after use>."
6592 #: ../src/guestfs-actions.pod:472 ../src/guestfs-actions.pod:1003 ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1431 ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3975 ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4212 ../src/guestfs-actions.pod:4245 ../src/guestfs-actions.pod:4408 ../src/guestfs-actions.pod:4843 ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5718 ../src/guestfs-actions.pod:5730 ../src/guestfs-actions.pod:6177 ../src/guestfs-actions.pod:6836 ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:7088 ../src/guestfs-actions.pod:7331
6593 msgid "(Added in 0.8)"
6597 #: ../src/guestfs-actions.pod:474
6598 msgid "guestfs_aug_match"
6602 #: ../src/guestfs-actions.pod:476
6606 " guestfs_aug_match (guestfs_h *g,\n"
6607 " const char *augpath);\n"
6612 #: ../src/guestfs-actions.pod:480 ../fish/guestfish-actions.pod:316
6614 "Returns a list of paths which match the path expression C<path>. The "
6615 "returned paths are sufficiently qualified so that they match exactly one "
6616 "node in the current tree."
6620 #: ../src/guestfs-actions.pod:490
6621 msgid "guestfs_aug_mv"
6625 #: ../src/guestfs-actions.pod:492
6629 " guestfs_aug_mv (guestfs_h *g,\n"
6630 " const char *src,\n"
6631 " const char *dest);\n"
6636 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:324
6638 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6639 "C<dest> is overwritten if it exists."
6643 #: ../src/guestfs-actions.pod:504
6644 msgid "guestfs_aug_rm"
6648 #: ../src/guestfs-actions.pod:506
6652 " guestfs_aug_rm (guestfs_h *g,\n"
6653 " const char *augpath);\n"
6658 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:331
6659 msgid "Remove C<path> and all of its children."
6663 #: ../src/guestfs-actions.pod:512 ../fish/guestfish-actions.pod:333
6664 msgid "On success this returns the number of entries which were removed."
6668 #: ../src/guestfs-actions.pod:518
6669 msgid "guestfs_aug_save"
6673 #: ../src/guestfs-actions.pod:520
6677 " guestfs_aug_save (guestfs_h *g);\n"
6682 #: ../src/guestfs-actions.pod:523 ../fish/guestfish-actions.pod:339
6683 msgid "This writes all pending changes to disk."
6687 #: ../src/guestfs-actions.pod:525
6689 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6694 #: ../src/guestfs-actions.pod:532
6695 msgid "guestfs_aug_set"
6699 #: ../src/guestfs-actions.pod:534
6703 " guestfs_aug_set (guestfs_h *g,\n"
6704 " const char *augpath,\n"
6705 " const char *val);\n"
6710 #: ../src/guestfs-actions.pod:539 ../fish/guestfish-actions.pod:348
6711 msgid "Set the value associated with C<path> to C<val>."
6715 #: ../src/guestfs-actions.pod:541
6717 "In the Augeas API, it is possible to clear a node by setting the value to "
6718 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6719 "this call. Instead you must use the C<guestfs_aug_clear> call."
6723 #: ../src/guestfs-actions.pod:550
6724 msgid "guestfs_available"
6728 #: ../src/guestfs-actions.pod:552
6732 " guestfs_available (guestfs_h *g,\n"
6733 " char *const *groups);\n"
6738 #: ../src/guestfs-actions.pod:556 ../fish/guestfish-actions.pod:359
6740 "This command is used to check the availability of some groups of "
6741 "functionality in the appliance, which not all builds of the libguestfs "
6742 "appliance will be able to provide."
6746 #: ../src/guestfs-actions.pod:560
6748 "The libguestfs groups, and the functions that those groups correspond to, "
6749 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6750 "runtime by calling C<guestfs_available_all_groups>."
6754 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6756 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6757 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6758 "and Augeas (configuration file editing) functions."
6762 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6763 msgid "The command returns no error if I<all> requested groups are available."
6767 #: ../src/guestfs-actions.pod:572 ../fish/guestfish-actions.pod:375
6769 "It fails with an error if one or more of the requested groups is unavailable "
6774 #: ../src/guestfs-actions.pod:575 ../fish/guestfish-actions.pod:378
6776 "If an unknown group name is included in the list of groups then an error is "
6781 #: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:381
6786 #: ../src/guestfs-actions.pod:584
6787 msgid "You must call C<guestfs_launch> before calling this function."
6791 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:389
6793 "The reason is because we don't know what groups are supported by the "
6794 "appliance/daemon until it is running and can be queried."
6798 #: ../src/guestfs-actions.pod:592 ../fish/guestfish-actions.pod:395
6800 "If a group of functions is available, this does not necessarily mean that "
6801 "they will work. You still have to check for errors when calling individual "
6802 "API functions even if they are available."
6806 #: ../src/guestfs-actions.pod:599 ../fish/guestfish-actions.pod:402
6808 "It is usually the job of distro packagers to build complete functionality "
6809 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6810 "with all requirements satisfied, will support everything."
6814 #: ../src/guestfs-actions.pod:606
6816 "This call was added in version C<1.0.80>. In previous versions of "
6817 "libguestfs all you could do would be to speculatively execute a command to "
6818 "find out if the daemon implemented it. See also C<guestfs_version>."
6822 #: ../src/guestfs-actions.pod:615 ../src/guestfs-actions.pod:1176
6823 msgid "(Added in 1.0.80)"
6827 #: ../src/guestfs-actions.pod:617
6828 msgid "guestfs_available_all_groups"
6832 #: ../src/guestfs-actions.pod:619
6836 " guestfs_available_all_groups (guestfs_h *g);\n"
6841 #: ../src/guestfs-actions.pod:622
6843 "This command returns a list of all optional groups that this daemon knows "
6844 "about. Note this returns both supported and unsupported groups. To find "
6845 "out which ones the daemon can actually support you have to call "
6846 "C<guestfs_available> on each member of the returned list."
6850 #: ../src/guestfs-actions.pod:628
6851 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6855 #: ../src/guestfs-actions.pod:634
6856 msgid "(Added in 1.3.15)"
6860 #: ../src/guestfs-actions.pod:636
6861 msgid "guestfs_base64_in"
6865 #: ../src/guestfs-actions.pod:638
6869 " guestfs_base64_in (guestfs_h *g,\n"
6870 " const char *base64file,\n"
6871 " const char *filename);\n"
6876 #: ../src/guestfs-actions.pod:643 ../fish/guestfish-actions.pod:432
6877 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6881 #: ../src/guestfs-actions.pod:648 ../src/guestfs-actions.pod:662
6882 msgid "(Added in 1.3.5)"
6886 #: ../src/guestfs-actions.pod:650
6887 msgid "guestfs_base64_out"
6891 #: ../src/guestfs-actions.pod:652
6895 " guestfs_base64_out (guestfs_h *g,\n"
6896 " const char *filename,\n"
6897 " const char *base64file);\n"
6902 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:441
6904 "This command downloads the contents of C<filename>, writing it out to local "
6905 "file C<base64file> encoded as base64."
6909 #: ../src/guestfs-actions.pod:664
6910 msgid "guestfs_blockdev_flushbufs"
6914 #: ../src/guestfs-actions.pod:666
6918 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6919 " const char *device);\n"
6924 #: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:450
6925 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6929 #: ../src/guestfs-actions.pod:673 ../src/guestfs-actions.pod:690 ../src/guestfs-actions.pod:705 ../src/guestfs-actions.pod:721 ../src/guestfs-actions.pod:739 ../src/guestfs-actions.pod:758 ../src/guestfs-actions.pod:772 ../src/guestfs-actions.pod:790 ../src/guestfs-actions.pod:804 ../src/guestfs-actions.pod:818 ../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
6930 msgid "This uses the L<blockdev(8)> command."
6934 #: ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:709 ../src/guestfs-actions.pod:725 ../src/guestfs-actions.pod:743 ../src/guestfs-actions.pod:762 ../src/guestfs-actions.pod:776 ../src/guestfs-actions.pod:794 ../src/guestfs-actions.pod:808 ../src/guestfs-actions.pod:822
6935 msgid "(Added in 0.9.3)"
6939 #: ../src/guestfs-actions.pod:679
6940 msgid "guestfs_blockdev_getbsz"
6944 #: ../src/guestfs-actions.pod:681
6948 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6949 " const char *device);\n"
6954 #: ../src/guestfs-actions.pod:685 ../fish/guestfish-actions.pod:459
6955 msgid "This returns the block size of a device."
6959 #: ../src/guestfs-actions.pod:687 ../src/guestfs-actions.pod:787 ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
6961 "(Note this is different from both I<size in blocks> and I<filesystem block "
6966 #: ../src/guestfs-actions.pod:696
6967 msgid "guestfs_blockdev_getro"
6971 #: ../src/guestfs-actions.pod:698
6975 " guestfs_blockdev_getro (guestfs_h *g,\n"
6976 " const char *device);\n"
6981 #: ../src/guestfs-actions.pod:702 ../fish/guestfish-actions.pod:470
6983 "Returns a boolean indicating if the block device is read-only (true if "
6984 "read-only, false if not)."
6988 #: ../src/guestfs-actions.pod:707 ../src/guestfs-actions.pod:1414 ../src/guestfs-actions.pod:1429 ../src/guestfs-actions.pod:1916 ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:2117 ../src/guestfs-actions.pod:3090 ../src/guestfs-actions.pod:3107 ../src/guestfs-actions.pod:3126 ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:3303 ../src/guestfs-actions.pod:3318 ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3363 ../src/guestfs-actions.pod:3379 ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3435 ../src/guestfs-actions.pod:3450 ../src/guestfs-actions.pod:4997
6989 msgid "This function returns a C truth value on success or -1 on error."
6993 #: ../src/guestfs-actions.pod:711
6994 msgid "guestfs_blockdev_getsize64"
6998 #: ../src/guestfs-actions.pod:713
7002 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7003 " const char *device);\n"
7008 #: ../src/guestfs-actions.pod:717 ../fish/guestfish-actions.pod:479
7009 msgid "This returns the size of the device in bytes."
7013 #: ../src/guestfs-actions.pod:719
7014 msgid "See also C<guestfs_blockdev_getsz>."
7018 #: ../src/guestfs-actions.pod:727
7019 msgid "guestfs_blockdev_getss"
7023 #: ../src/guestfs-actions.pod:729
7027 " guestfs_blockdev_getss (guestfs_h *g,\n"
7028 " const char *device);\n"
7033 #: ../src/guestfs-actions.pod:733 ../fish/guestfish-actions.pod:489
7035 "This returns the size of sectors on a block device. Usually 512, but can be "
7036 "larger for modern devices."
7040 #: ../src/guestfs-actions.pod:736
7042 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7047 #: ../src/guestfs-actions.pod:745
7048 msgid "guestfs_blockdev_getsz"
7052 #: ../src/guestfs-actions.pod:747
7056 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7057 " const char *device);\n"
7062 #: ../src/guestfs-actions.pod:751 ../fish/guestfish-actions.pod:501
7064 "This returns the size of the device in units of 512-byte sectors (even if "
7065 "the sectorsize isn't 512 bytes ... weird)."
7069 #: ../src/guestfs-actions.pod:754
7071 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7072 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7076 #: ../src/guestfs-actions.pod:764
7077 msgid "guestfs_blockdev_rereadpt"
7081 #: ../src/guestfs-actions.pod:766
7085 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7086 " const char *device);\n"
7091 #: ../src/guestfs-actions.pod:770 ../fish/guestfish-actions.pod:514
7092 msgid "Reread the partition table on C<device>."
7096 #: ../src/guestfs-actions.pod:778
7097 msgid "guestfs_blockdev_setbsz"
7101 #: ../src/guestfs-actions.pod:780
7105 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7106 " const char *device,\n"
7107 " int blocksize);\n"
7112 #: ../src/guestfs-actions.pod:785 ../fish/guestfish-actions.pod:522
7113 msgid "This sets the block size of a device."
7117 #: ../src/guestfs-actions.pod:796
7118 msgid "guestfs_blockdev_setro"
7122 #: ../src/guestfs-actions.pod:798
7126 " guestfs_blockdev_setro (guestfs_h *g,\n"
7127 " const char *device);\n"
7132 #: ../src/guestfs-actions.pod:802 ../fish/guestfish-actions.pod:533
7133 msgid "Sets the block device named C<device> to read-only."
7137 #: ../src/guestfs-actions.pod:810
7138 msgid "guestfs_blockdev_setrw"
7142 #: ../src/guestfs-actions.pod:812
7146 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7147 " const char *device);\n"
7152 #: ../src/guestfs-actions.pod:816 ../fish/guestfish-actions.pod:541
7153 msgid "Sets the block device named C<device> to read-write."
7157 #: ../src/guestfs-actions.pod:824
7158 msgid "guestfs_case_sensitive_path"
7162 #: ../src/guestfs-actions.pod:826
7166 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7167 " const char *path);\n"
7172 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
7174 "This can be used to resolve case insensitive paths on a filesystem which is "
7175 "case sensitive. The use case is to resolve paths which you have read from "
7176 "Windows configuration files or the Windows Registry, to the true path."
7180 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
7182 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7183 "(and probably others), which is that although the underlying filesystem is "
7184 "case-insensitive, the driver exports the filesystem to Linux as "
7189 #: ../src/guestfs-actions.pod:840 ../fish/guestfish-actions.pod:559
7191 "One consequence of this is that special directories such as C<c:\\windows> "
7192 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7193 "precise details of how they were created. In Windows itself this would not "
7198 #: ../src/guestfs-actions.pod:846 ../fish/guestfish-actions.pod:565
7200 "Bug or feature? You decide: "
7201 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7205 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:568
7207 "This function resolves the true case of each element in the path and returns "
7208 "the case-sensitive path."
7212 #: ../src/guestfs-actions.pod:852
7214 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7215 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7216 "how the directories were originally created under Windows)."
7220 #: ../src/guestfs-actions.pod:857 ../fish/guestfish-actions.pod:576
7221 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7225 #: ../src/guestfs-actions.pod:860
7226 msgid "See also C<guestfs_realpath>."
7230 #: ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:7016
7231 msgid "(Added in 1.0.75)"
7235 #: ../src/guestfs-actions.pod:867
7240 #: ../src/guestfs-actions.pod:869
7244 " guestfs_cat (guestfs_h *g,\n"
7245 " const char *path);\n"
7250 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3685
7251 msgid "Return the contents of the file named C<path>."
7255 #: ../src/guestfs-actions.pod:875
7257 "Note that this function cannot correctly handle binary files (specifically, "
7258 "files containing C<\\0> character which is treated as end of string). For "
7259 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7260 "functions which have a more complex interface."
7264 #: ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:1062 ../src/guestfs-actions.pod:1082 ../src/guestfs-actions.pod:1378 ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1500 ../src/guestfs-actions.pod:1519 ../src/guestfs-actions.pod:1765 ../src/guestfs-actions.pod:2223 ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:2309 ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2355 ../src/guestfs-actions.pod:5266 ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:6401 ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6602 ../src/guestfs-actions.pod:6626 ../src/guestfs-actions.pod:7295 ../src/guestfs-actions.pod:7321 ../src/guestfs-actions.pod:7347 ../src/guestfs-actions.pod:7366 ../src/guestfs-actions.pod:7451 ../src/guestfs-actions.pod:7470 ../src/guestfs-actions.pod:7516 ../src/guestfs-actions.pod:7535 ../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:3555 ../fish/guestfish-actions.pod:3570 ../fish/guestfish-actions.pod:3646 ../fish/guestfish-actions.pod:3663 ../fish/guestfish-actions.pod:3678 ../fish/guestfish-actions.pod:4332 ../fish/guestfish-actions.pod:4378 ../fish/guestfish-actions.pod:4463 ../fish/guestfish-actions.pod:4478 ../fish/guestfish-actions.pod:4888 ../fish/guestfish-actions.pod:4906 ../fish/guestfish-actions.pod:4923 ../fish/guestfish-actions.pod:4933 ../fish/guestfish-actions.pod:4981 ../fish/guestfish-actions.pod:4991 ../fish/guestfish-actions.pod:5020 ../fish/guestfish-actions.pod:5030
7266 "Because of the message protocol, there is a transfer limit of somewhere "
7267 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7271 #: ../src/guestfs-actions.pod:886 ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3645 ../src/guestfs-actions.pod:3733 ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:5372 ../src/guestfs-actions.pod:5386 ../src/guestfs-actions.pod:7175 ../src/guestfs-actions.pod:7189
7272 msgid "(Added in 0.4)"
7276 #: ../src/guestfs-actions.pod:888
7277 msgid "guestfs_checksum"
7281 #: ../src/guestfs-actions.pod:890
7285 " guestfs_checksum (guestfs_h *g,\n"
7286 " const char *csumtype,\n"
7287 " const char *path);\n"
7292 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:599
7293 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7297 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7299 "The type of checksum to compute is given by the C<csumtype> parameter which "
7300 "must have one of the following values:"
7304 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7309 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7311 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7316 #: ../src/guestfs-actions.pod:908 ../fish/guestfish-actions.pod:612
7321 #: ../src/guestfs-actions.pod:910 ../fish/guestfish-actions.pod:614
7322 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7326 #: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:616
7331 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:618
7332 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7336 #: ../src/guestfs-actions.pod:916 ../fish/guestfish-actions.pod:620
7341 #: ../src/guestfs-actions.pod:918 ../fish/guestfish-actions.pod:622
7342 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7346 #: ../src/guestfs-actions.pod:920 ../fish/guestfish-actions.pod:624
7351 #: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:626
7352 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7356 #: ../src/guestfs-actions.pod:924 ../fish/guestfish-actions.pod:628
7361 #: ../src/guestfs-actions.pod:926 ../fish/guestfish-actions.pod:630
7362 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7366 #: ../src/guestfs-actions.pod:928 ../fish/guestfish-actions.pod:632
7371 #: ../src/guestfs-actions.pod:930 ../fish/guestfish-actions.pod:634
7372 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7376 #: ../src/guestfs-actions.pod:934 ../fish/guestfish-actions.pod:638
7377 msgid "The checksum is returned as a printable string."
7381 #: ../src/guestfs-actions.pod:936
7382 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7386 #: ../src/guestfs-actions.pod:938
7387 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7391 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1251 ../src/guestfs-actions.pod:2085 ../src/guestfs-actions.pod:3305 ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:6872
7392 msgid "(Added in 1.0.2)"
7396 #: ../src/guestfs-actions.pod:945
7397 msgid "guestfs_checksum_device"
7401 #: ../src/guestfs-actions.pod:947
7405 " guestfs_checksum_device (guestfs_h *g,\n"
7406 " const char *csumtype,\n"
7407 " const char *device);\n"
7412 #: ../src/guestfs-actions.pod:952
7414 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7415 "device named C<device>. For the types of checksums supported see the "
7416 "C<guestfs_checksum> command."
7420 #: ../src/guestfs-actions.pod:959 ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4962 ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5193 ../src/guestfs-actions.pod:6781 ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:7201
7421 msgid "(Added in 1.3.2)"
7425 #: ../src/guestfs-actions.pod:961
7426 msgid "guestfs_checksums_out"
7430 #: ../src/guestfs-actions.pod:963
7434 " guestfs_checksums_out (guestfs_h *g,\n"
7435 " const char *csumtype,\n"
7436 " const char *directory,\n"
7437 " const char *sumsfile);\n"
7442 #: ../src/guestfs-actions.pod:969 ../fish/guestfish-actions.pod:656
7444 "This command computes the checksums of all regular files in C<directory> and "
7445 "then emits a list of those checksums to the local output file C<sumsfile>."
7449 #: ../src/guestfs-actions.pod:973 ../fish/guestfish-actions.pod:660
7451 "This can be used for verifying the integrity of a virtual machine. However "
7452 "to be properly secure you should pay attention to the output of the checksum "
7453 "command (it uses the ones from GNU coreutils). In particular when the "
7454 "filename is not printable, coreutils uses a special backslash syntax. For "
7455 "more information, see the GNU coreutils info file."
7459 #: ../src/guestfs-actions.pod:983
7460 msgid "(Added in 1.3.7)"
7464 #: ../src/guestfs-actions.pod:985
7465 msgid "guestfs_chmod"
7469 #: ../src/guestfs-actions.pod:987
7473 " guestfs_chmod (guestfs_h *g,\n"
7475 " const char *path);\n"
7480 #: ../src/guestfs-actions.pod:992 ../fish/guestfish-actions.pod:674
7482 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7487 #: ../src/guestfs-actions.pod:995 ../fish/guestfish-actions.pod:677
7489 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7490 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7495 #: ../src/guestfs-actions.pod:999 ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4624 ../fish/guestfish-actions.pod:681 ../fish/guestfish-actions.pod:2985 ../fish/guestfish-actions.pod:3114 ../fish/guestfish-actions.pod:3124 ../fish/guestfish-actions.pod:3134
7496 msgid "The mode actually set is affected by the umask."
7500 #: ../src/guestfs-actions.pod:1005
7501 msgid "guestfs_chown"
7505 #: ../src/guestfs-actions.pod:1007
7509 " guestfs_chown (guestfs_h *g,\n"
7512 " const char *path);\n"
7517 #: ../src/guestfs-actions.pod:1013 ../fish/guestfish-actions.pod:687
7518 msgid "Change the file owner to C<owner> and group to C<group>."
7522 #: ../src/guestfs-actions.pod:1015 ../src/guestfs-actions.pod:3497 ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2443
7524 "Only numeric uid and gid are supported. If you want to use names, you will "
7525 "need to locate and parse the password file yourself (Augeas support makes "
7526 "this relatively easy)."
7530 #: ../src/guestfs-actions.pod:1023
7531 msgid "guestfs_command"
7535 #: ../src/guestfs-actions.pod:1025
7539 " guestfs_command (guestfs_h *g,\n"
7540 " char *const *arguments);\n"
7545 #: ../src/guestfs-actions.pod:1029 ../fish/guestfish-actions.pod:697
7547 "This call runs a command from the guest filesystem. The filesystem must be "
7548 "mounted, and must contain a compatible operating system (ie. something "
7549 "Linux, with the same or compatible processor architecture)."
7553 #: ../src/guestfs-actions.pod:1034
7555 "The single parameter is an argv-style list of arguments. The first element "
7556 "is the name of the program to run. Subsequent elements are parameters. The "
7557 "list must be non-empty (ie. must contain a program name). Note that the "
7558 "command runs directly, and is I<not> invoked via the shell (see "
7563 #: ../src/guestfs-actions.pod:1041 ../fish/guestfish-actions.pod:709
7564 msgid "The return value is anything printed to I<stdout> by the command."
7568 #: ../src/guestfs-actions.pod:1044 ../fish/guestfish-actions.pod:712
7570 "If the command returns a non-zero exit status, then this function returns an "
7571 "error message. The error message string is the content of I<stderr> from "
7576 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7578 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7579 "C</bin>. If you require a program from another location, you should provide "
7580 "the full path in the first parameter."
7584 #: ../src/guestfs-actions.pod:1053 ../fish/guestfish-actions.pod:721
7586 "Shared libraries and data files required by the program must be available on "
7587 "filesystems which are mounted in the correct places. It is the caller's "
7588 "responsibility to ensure all filesystems that are needed are mounted at the "
7593 #: ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1085 ../src/guestfs-actions.pod:1550
7594 msgid "(Added in 0.9.1)"
7598 #: ../src/guestfs-actions.pod:1067
7599 msgid "guestfs_command_lines"
7603 #: ../src/guestfs-actions.pod:1069
7607 " guestfs_command_lines (guestfs_h *g,\n"
7608 " char *const *arguments);\n"
7613 #: ../src/guestfs-actions.pod:1073
7615 "This is the same as C<guestfs_command>, but splits the result into a list of "
7620 #: ../src/guestfs-actions.pod:1076
7621 msgid "See also: C<guestfs_sh_lines>"
7625 #: ../src/guestfs-actions.pod:1087
7626 msgid "guestfs_config"
7630 #: ../src/guestfs-actions.pod:1089
7634 " guestfs_config (guestfs_h *g,\n"
7635 " const char *qemuparam,\n"
7636 " const char *qemuvalue);\n"
7641 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7643 "This can be used to add arbitrary qemu command line parameters of the form "
7644 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7645 "setting some parameters which would interfere with parameters that we use."
7649 #: ../src/guestfs-actions.pod:1099 ../fish/guestfish-actions.pod:751
7650 msgid "The first character of C<param> string must be a C<-> (dash)."
7654 #: ../src/guestfs-actions.pod:1101 ../fish/guestfish-actions.pod:753
7655 msgid "C<value> can be NULL."
7659 #: ../src/guestfs-actions.pod:1107
7660 msgid "guestfs_copy_size"
7664 #: ../src/guestfs-actions.pod:1109
7668 " guestfs_copy_size (guestfs_h *g,\n"
7669 " const char *src,\n"
7670 " const char *dest,\n"
7676 #: ../src/guestfs-actions.pod:1115 ../fish/guestfish-actions.pod:759
7678 "This command copies exactly C<size> bytes from one source device or file "
7679 "C<src> to another destination device or file C<dest>."
7683 #: ../src/guestfs-actions.pod:1118 ../fish/guestfish-actions.pod:762
7685 "Note this will fail if the source is too short or if the destination is not "
7690 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:1246 ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:1322 ../src/guestfs-actions.pod:1699 ../src/guestfs-actions.pod:1721 ../src/guestfs-actions.pod:3478 ../src/guestfs-actions.pod:6867 ../src/guestfs-actions.pod:6901 ../src/guestfs-actions.pod:7387 ../src/guestfs-actions.pod:7406
7692 "This long-running command can generate progress notification messages so "
7693 "that the caller can display a progress bar or indicator. To receive these "
7694 "messages, the caller must register a progress event callback. See "
7695 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7699 #: ../src/guestfs-actions.pod:1128 ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7128 ../src/guestfs-actions.pod:7214
7700 msgid "(Added in 1.0.87)"
7704 #: ../src/guestfs-actions.pod:1130
7709 #: ../src/guestfs-actions.pod:1132
7713 " guestfs_cp (guestfs_h *g,\n"
7714 " const char *src,\n"
7715 " const char *dest);\n"
7720 #: ../src/guestfs-actions.pod:1137 ../fish/guestfish-actions.pod:769
7722 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7723 "destination filename or destination directory."
7727 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1156 ../src/guestfs-actions.pod:1228 ../src/guestfs-actions.pod:1302 ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:5243
7728 msgid "(Added in 1.0.18)"
7732 #: ../src/guestfs-actions.pod:1144
7733 msgid "guestfs_cp_a"
7737 #: ../src/guestfs-actions.pod:1146
7741 " guestfs_cp_a (guestfs_h *g,\n"
7742 " const char *src,\n"
7743 " const char *dest);\n"
7748 #: ../src/guestfs-actions.pod:1151 ../fish/guestfish-actions.pod:776
7750 "This copies a file or directory from C<src> to C<dest> recursively using the "
7755 #: ../src/guestfs-actions.pod:1158
7760 #: ../src/guestfs-actions.pod:1160
7764 " guestfs_dd (guestfs_h *g,\n"
7765 " const char *src,\n"
7766 " const char *dest);\n"
7771 #: ../src/guestfs-actions.pod:1165 ../fish/guestfish-actions.pod:783
7773 "This command copies from one source device or file C<src> to another "
7774 "destination device or file C<dest>. Normally you would use this to copy to "
7775 "or from a device or partition, for example to duplicate a filesystem."
7779 #: ../src/guestfs-actions.pod:1170
7781 "If the destination is a device, it must be as large or larger than the "
7782 "source file or device, otherwise the copy will fail. This command cannot do "
7783 "partial copies (see C<guestfs_copy_size>)."
7787 #: ../src/guestfs-actions.pod:1178
7792 #: ../src/guestfs-actions.pod:1180
7796 " guestfs_df (guestfs_h *g);\n"
7801 #: ../src/guestfs-actions.pod:1183 ../fish/guestfish-actions.pod:796
7802 msgid "This command runs the C<df> command to report disk space used."
7806 #: ../src/guestfs-actions.pod:1185 ../src/guestfs-actions.pod:1202
7808 "This command is mostly useful for interactive sessions. It is I<not> "
7809 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7814 #: ../src/guestfs-actions.pod:1192 ../src/guestfs-actions.pod:1209 ../src/guestfs-actions.pod:1327 ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2312 ../src/guestfs-actions.pod:2380 ../src/guestfs-actions.pod:4275 ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:7254 ../src/guestfs-actions.pod:7267 ../src/guestfs-actions.pod:7280
7815 msgid "(Added in 1.0.54)"
7819 #: ../src/guestfs-actions.pod:1194
7820 msgid "guestfs_df_h"
7824 #: ../src/guestfs-actions.pod:1196
7828 " guestfs_df_h (guestfs_h *g);\n"
7833 #: ../src/guestfs-actions.pod:1199 ../fish/guestfish-actions.pod:806
7835 "This command runs the C<df -h> command to report disk space used in "
7836 "human-readable format."
7840 #: ../src/guestfs-actions.pod:1211
7841 msgid "guestfs_dmesg"
7845 #: ../src/guestfs-actions.pod:1213
7849 " guestfs_dmesg (guestfs_h *g);\n"
7854 #: ../src/guestfs-actions.pod:1216 ../fish/guestfish-actions.pod:817
7856 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7857 "This is sometimes useful for extended debugging of problems."
7861 #: ../src/guestfs-actions.pod:1220
7863 "Another way to get the same information is to enable verbose messages with "
7864 "C<guestfs_set_verbose> or by setting the environment variable "
7865 "C<LIBGUESTFS_DEBUG=1> before running the program."
7869 #: ../src/guestfs-actions.pod:1230
7870 msgid "guestfs_download"
7874 #: ../src/guestfs-actions.pod:1232
7878 " guestfs_download (guestfs_h *g,\n"
7879 " const char *remotefilename,\n"
7880 " const char *filename);\n"
7885 #: ../src/guestfs-actions.pod:1237 ../src/guestfs-actions.pod:1262 ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
7887 "Download file C<remotefilename> and save it as C<filename> on the local "
7892 #: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:6861 ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4636
7893 msgid "C<filename> can also be a named pipe."
7897 #: ../src/guestfs-actions.pod:1242
7898 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7902 #: ../src/guestfs-actions.pod:1253
7903 msgid "guestfs_download_offset"
7907 #: ../src/guestfs-actions.pod:1255
7911 " guestfs_download_offset (guestfs_h *g,\n"
7912 " const char *remotefilename,\n"
7913 " const char *filename,\n"
7914 " int64_t offset,\n"
7920 #: ../src/guestfs-actions.pod:1265 ../fish/guestfish-actions.pod:846
7922 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7923 "region must be within the file or device)."
7927 #: ../src/guestfs-actions.pod:1268
7929 "Note that there is no limit on the amount of data that can be downloaded "
7930 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7931 "full amount unless an error occurs."
7935 #: ../src/guestfs-actions.pod:1273
7936 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7940 #: ../src/guestfs-actions.pod:1282 ../src/guestfs-actions.pod:6906
7941 msgid "(Added in 1.5.17)"
7945 #: ../src/guestfs-actions.pod:1284
7946 msgid "guestfs_drop_caches"
7950 #: ../src/guestfs-actions.pod:1286
7954 " guestfs_drop_caches (guestfs_h *g,\n"
7955 " int whattodrop);\n"
7960 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
7962 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7963 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7964 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7968 #: ../src/guestfs-actions.pod:1295 ../fish/guestfish-actions.pod:867
7969 msgid "Setting C<whattodrop> to 3 should drop everything."
7973 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:869
7975 "This automatically calls L<sync(2)> before the operation, so that the "
7976 "maximum guest memory is freed."
7980 #: ../src/guestfs-actions.pod:1304
7985 #: ../src/guestfs-actions.pod:1306
7989 " guestfs_du (guestfs_h *g,\n"
7990 " const char *path);\n"
7995 #: ../src/guestfs-actions.pod:1310 ../fish/guestfish-actions.pod:876
7997 "This command runs the C<du -s> command to estimate file space usage for "
8002 #: ../src/guestfs-actions.pod:1313 ../fish/guestfish-actions.pod:879
8004 "C<path> can be a file or a directory. If C<path> is a directory then the "
8005 "estimate includes the contents of the directory and all subdirectories "
8010 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:883
8011 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8015 #: ../src/guestfs-actions.pod:1329
8016 msgid "guestfs_e2fsck_f"
8020 #: ../src/guestfs-actions.pod:1331
8024 " guestfs_e2fsck_f (guestfs_h *g,\n"
8025 " const char *device);\n"
8030 #: ../src/guestfs-actions.pod:1335 ../fish/guestfish-actions.pod:890
8032 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8033 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8038 #: ../src/guestfs-actions.pod:1339
8040 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8041 "Normally you should use C<guestfs_fsck>."
8045 #: ../src/guestfs-actions.pod:1344
8046 msgid "(Added in 1.0.29)"
8050 #: ../src/guestfs-actions.pod:1346
8051 msgid "guestfs_echo_daemon"
8055 #: ../src/guestfs-actions.pod:1348
8059 " guestfs_echo_daemon (guestfs_h *g,\n"
8060 " char *const *words);\n"
8065 #: ../src/guestfs-actions.pod:1352 ../fish/guestfish-actions.pod:901
8067 "This command concatenates the list of C<words> passed with single spaces "
8068 "between them and returns the resulting string."
8072 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:904
8073 msgid "You can use this command to test the connection through to the daemon."
8077 #: ../src/guestfs-actions.pod:1357
8078 msgid "See also C<guestfs_ping_daemon>."
8082 #: ../src/guestfs-actions.pod:1362 ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:6077
8083 msgid "(Added in 1.0.69)"
8087 #: ../src/guestfs-actions.pod:1364
8088 msgid "guestfs_egrep"
8092 #: ../src/guestfs-actions.pod:1366
8096 " guestfs_egrep (guestfs_h *g,\n"
8097 " const char *regex,\n"
8098 " const char *path);\n"
8103 #: ../src/guestfs-actions.pod:1371 ../fish/guestfish-actions.pod:912
8104 msgid "This calls the external C<egrep> program and returns the matching lines."
8108 #: ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1503 ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:2414 ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2497 ../src/guestfs-actions.pod:2510 ../src/guestfs-actions.pod:3658 ../src/guestfs-actions.pod:3672 ../src/guestfs-actions.pod:3685 ../src/guestfs-actions.pod:3699 ../src/guestfs-actions.pod:4685 ../src/guestfs-actions.pod:5577 ../src/guestfs-actions.pod:5626 ../src/guestfs-actions.pod:6473 ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6546 ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6572 ../src/guestfs-actions.pod:7350 ../src/guestfs-actions.pod:7369 ../src/guestfs-actions.pod:7454 ../src/guestfs-actions.pod:7473 ../src/guestfs-actions.pod:7519 ../src/guestfs-actions.pod:7538
8109 msgid "(Added in 1.0.66)"
8113 #: ../src/guestfs-actions.pod:1383
8114 msgid "guestfs_egrepi"
8118 #: ../src/guestfs-actions.pod:1385
8122 " guestfs_egrepi (guestfs_h *g,\n"
8123 " const char *regex,\n"
8124 " const char *path);\n"
8129 #: ../src/guestfs-actions.pod:1390 ../fish/guestfish-actions.pod:922
8130 msgid "This calls the external C<egrep -i> program and returns the matching lines."
8134 #: ../src/guestfs-actions.pod:1402
8135 msgid "guestfs_equal"
8139 #: ../src/guestfs-actions.pod:1404
8143 " guestfs_equal (guestfs_h *g,\n"
8144 " const char *file1,\n"
8145 " const char *file2);\n"
8150 #: ../src/guestfs-actions.pod:1409 ../fish/guestfish-actions.pod:932
8152 "This compares the two files C<file1> and C<file2> and returns true if their "
8153 "content is exactly equal, or false otherwise."
8157 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:935
8158 msgid "The external L<cmp(1)> program is used for the comparison."
8162 #: ../src/guestfs-actions.pod:1418
8163 msgid "guestfs_exists"
8167 #: ../src/guestfs-actions.pod:1420
8171 " guestfs_exists (guestfs_h *g,\n"
8172 " const char *path);\n"
8177 #: ../src/guestfs-actions.pod:1424 ../fish/guestfish-actions.pod:941
8179 "This returns C<true> if and only if there is a file, directory (or anything) "
8180 "with the given C<path> name."
8184 #: ../src/guestfs-actions.pod:1427
8185 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8189 #: ../src/guestfs-actions.pod:1433
8190 msgid "guestfs_fallocate"
8194 #: ../src/guestfs-actions.pod:1435
8198 " guestfs_fallocate (guestfs_h *g,\n"
8199 " const char *path,\n"
8205 #: ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1466 ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8207 "This command preallocates a file (containing zero bytes) named C<path> of "
8208 "size C<len> bytes. If the file exists already, it is overwritten."
8212 #: ../src/guestfs-actions.pod:1444 ../fish/guestfish-actions.pod:954
8214 "Do not confuse this with the guestfish-specific C<alloc> command which "
8215 "allocates a file in the host and attaches it as a device."
8219 #: ../src/guestfs-actions.pod:1450
8221 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
8226 #: ../src/guestfs-actions.pod:1459
8227 msgid "guestfs_fallocate64"
8231 #: ../src/guestfs-actions.pod:1461
8235 " guestfs_fallocate64 (guestfs_h *g,\n"
8236 " const char *path,\n"
8242 #: ../src/guestfs-actions.pod:1470
8244 "Note that this call allocates disk blocks for the file. To create a sparse "
8245 "file use C<guestfs_truncate_size> instead."
8249 #: ../src/guestfs-actions.pod:1473
8251 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8252 "oversight it only allowed 30 bit lengths to be specified, effectively "
8253 "limiting the maximum size of files created through that call to 1GB."
8257 #: ../src/guestfs-actions.pod:1478 ../fish/guestfish-actions.pod:981
8259 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8260 "commands which create a file in the host and attach it as a device."
8264 #: ../src/guestfs-actions.pod:1484
8265 msgid "(Added in 1.3.17)"
8269 #: ../src/guestfs-actions.pod:1486
8270 msgid "guestfs_fgrep"
8274 #: ../src/guestfs-actions.pod:1488
8278 " guestfs_fgrep (guestfs_h *g,\n"
8279 " const char *pattern,\n"
8280 " const char *path);\n"
8285 #: ../src/guestfs-actions.pod:1493 ../fish/guestfish-actions.pod:989
8286 msgid "This calls the external C<fgrep> program and returns the matching lines."
8290 #: ../src/guestfs-actions.pod:1505
8291 msgid "guestfs_fgrepi"
8295 #: ../src/guestfs-actions.pod:1507
8299 " guestfs_fgrepi (guestfs_h *g,\n"
8300 " const char *pattern,\n"
8301 " const char *path);\n"
8306 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
8307 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8311 #: ../src/guestfs-actions.pod:1524
8312 msgid "guestfs_file"
8316 #: ../src/guestfs-actions.pod:1526
8320 " guestfs_file (guestfs_h *g,\n"
8321 " const char *path);\n"
8326 #: ../src/guestfs-actions.pod:1530 ../fish/guestfish-actions.pod:1009
8328 "This call uses the standard L<file(1)> command to determine the type or "
8329 "contents of the file."
8333 #: ../src/guestfs-actions.pod:1533 ../fish/guestfish-actions.pod:1012
8335 "This call will also transparently look inside various types of compressed "
8340 #: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1015
8342 "The exact command which runs is C<file -zb path>. Note in particular that "
8343 "the filename is not prepended to the output (the I<-b> option)."
8347 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1019
8349 "The output depends on the output of the underlying L<file(1)> command and it "
8350 "can change in future in ways beyond our control. In other words, the output "
8351 "is not guaranteed by the ABI."
8355 #: ../src/guestfs-actions.pod:1544
8357 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8358 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
8362 #: ../src/guestfs-actions.pod:1552
8363 msgid "guestfs_file_architecture"
8367 #: ../src/guestfs-actions.pod:1554
8371 " guestfs_file_architecture (guestfs_h *g,\n"
8372 " const char *filename);\n"
8377 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1030
8379 "This detects the architecture of the binary C<filename>, and returns it if "
8384 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1033
8385 msgid "Currently defined architectures are:"
8389 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1037
8394 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1039
8396 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8397 "irrespective of the precise processor requirements of the binary."
8401 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1042
8406 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1044
8407 msgid "64 bit x86-64."
8411 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1046
8416 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1048
8417 msgid "32 bit SPARC."
8421 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1050
8426 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1052
8427 msgid "64 bit SPARC V9 and above."
8431 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1054
8436 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1056
8437 msgid "Intel Itanium."
8441 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1058
8446 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1060
8447 msgid "32 bit Power PC."
8451 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1062
8456 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1064
8457 msgid "64 bit Power PC."
8461 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068
8462 msgid "Libguestfs may return other architecture strings in future."
8466 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1070
8467 msgid "The function works on at least the following types of files:"
8471 #: ../src/guestfs-actions.pod:1604 ../fish/guestfish-actions.pod:1076
8472 msgid "many types of Un*x and Linux binary"
8476 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1080
8477 msgid "many types of Un*x and Linux shared library"
8481 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1084
8482 msgid "Windows Win32 and Win64 binaries"
8486 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088
8487 msgid "Windows Win32 and Win64 DLLs"
8491 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090
8492 msgid "Win32 binaries and DLLs return C<i386>."
8496 #: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1092
8497 msgid "Win64 binaries and DLLs return C<x86_64>."
8501 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1096
8502 msgid "Linux kernel modules"
8506 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1100
8507 msgid "Linux new-style initrd images"
8511 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1104
8512 msgid "some non-x86 Linux vmlinuz kernels"
8516 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1108
8517 msgid "What it can't do currently:"
8521 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1114
8522 msgid "static libraries (libfoo.a)"
8526 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1118
8527 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8531 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122
8532 msgid "x86 Linux vmlinuz kernels"
8536 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1124
8538 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8539 "compressed code, and are horribly hard to unpack. If you want to find the "
8540 "architecture of a kernel, use the architecture of the associated initrd or "
8541 "kernel module(s) instead."
8545 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1825 ../src/guestfs-actions.pod:1842 ../src/guestfs-actions.pod:2533 ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2696 ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:2805 ../src/guestfs-actions.pod:2848 ../src/guestfs-actions.pod:2932 ../src/guestfs-actions.pod:3029 ../src/guestfs-actions.pod:3276 ../src/guestfs-actions.pod:3408
8546 msgid "(Added in 1.5.3)"
8550 #: ../src/guestfs-actions.pod:1664
8551 msgid "guestfs_filesize"
8555 #: ../src/guestfs-actions.pod:1666
8559 " guestfs_filesize (guestfs_h *g,\n"
8560 " const char *file);\n"
8565 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1135
8566 msgid "This command returns the size of C<file> in bytes."
8570 #: ../src/guestfs-actions.pod:1672
8572 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8573 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8574 "devices, use C<guestfs_blockdev_getsize64>."
8578 #: ../src/guestfs-actions.pod:1678
8579 msgid "(Added in 1.0.82)"
8583 #: ../src/guestfs-actions.pod:1680
8584 msgid "guestfs_fill"
8588 #: ../src/guestfs-actions.pod:1682
8592 " guestfs_fill (guestfs_h *g,\n"
8595 " const char *path);\n"
8600 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1145
8602 "This command creates a new file called C<path>. The initial content of the "
8603 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8608 #: ../src/guestfs-actions.pod:1692
8610 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8611 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8612 "bytes use C<guestfs_fill_pattern>."
8616 #: ../src/guestfs-actions.pod:1704
8617 msgid "(Added in 1.0.79)"
8621 #: ../src/guestfs-actions.pod:1706
8622 msgid "guestfs_fill_pattern"
8626 #: ../src/guestfs-actions.pod:1708
8630 " guestfs_fill_pattern (guestfs_h *g,\n"
8631 " const char *pattern,\n"
8633 " const char *path);\n"
8638 #: ../src/guestfs-actions.pod:1714
8640 "This function is like C<guestfs_fill> except that it creates a new file of "
8641 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8642 "pattern is truncated if necessary to ensure the length of the file is "
8643 "exactly C<len> bytes."
8647 #: ../src/guestfs-actions.pod:1726
8648 msgid "(Added in 1.3.12)"
8652 #: ../src/guestfs-actions.pod:1728
8653 msgid "guestfs_find"
8657 #: ../src/guestfs-actions.pod:1730
8661 " guestfs_find (guestfs_h *g,\n"
8662 " const char *directory);\n"
8667 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1167
8669 "This command lists out all files and directories, recursively, starting at "
8670 "C<directory>. It is essentially equivalent to running the shell command "
8671 "C<find directory -print> but some post-processing happens on the output, "
8676 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1172
8678 "This returns a list of strings I<without any prefix>. Thus if the directory "
8683 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1175
8693 #: ../src/guestfs-actions.pod:1746
8694 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8698 #: ../src/guestfs-actions.pod:1749 ../fish/guestfish-actions.pod:1182
8709 #: ../src/guestfs-actions.pod:1754 ../fish/guestfish-actions.pod:1187
8710 msgid "If C<directory> is not a directory, then this command returns an error."
8714 #: ../src/guestfs-actions.pod:1757 ../fish/guestfish-actions.pod:1190
8715 msgid "The returned list is sorted."
8719 #: ../src/guestfs-actions.pod:1759
8720 msgid "See also C<guestfs_find0>."
8724 #: ../src/guestfs-actions.pod:1768 ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:5661
8725 msgid "(Added in 1.0.27)"
8729 #: ../src/guestfs-actions.pod:1770
8730 msgid "guestfs_find0"
8734 #: ../src/guestfs-actions.pod:1772
8738 " guestfs_find0 (guestfs_h *g,\n"
8739 " const char *directory,\n"
8740 " const char *files);\n"
8745 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1201
8747 "This command lists out all files and directories, recursively, starting at "
8748 "C<directory>, placing the resulting list in the external file called "
8753 #: ../src/guestfs-actions.pod:1781
8755 "This command works the same way as C<guestfs_find> with the following "
8760 #: ../src/guestfs-actions.pod:1788 ../fish/guestfish-actions.pod:1212
8761 msgid "The resulting list is written to an external file."
8765 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1216
8767 "Items (filenames) in the result are separated by C<\\0> characters. See "
8768 "L<find(1)> option I<-print0>."
8772 #: ../src/guestfs-actions.pod:1797 ../fish/guestfish-actions.pod:1221
8773 msgid "This command is not limited in the number of names that it can return."
8777 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1226
8778 msgid "The result list is not sorted."
8782 #: ../src/guestfs-actions.pod:1808
8783 msgid "(Added in 1.0.74)"
8787 #: ../src/guestfs-actions.pod:1810
8788 msgid "guestfs_findfs_label"
8792 #: ../src/guestfs-actions.pod:1812
8796 " guestfs_findfs_label (guestfs_h *g,\n"
8797 " const char *label);\n"
8802 #: ../src/guestfs-actions.pod:1816 ../fish/guestfish-actions.pod:1236
8804 "This command searches the filesystems and returns the one which has the "
8805 "given label. An error is returned if no such filesystem can be found."
8809 #: ../src/guestfs-actions.pod:1820
8810 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8814 #: ../src/guestfs-actions.pod:1827
8815 msgid "guestfs_findfs_uuid"
8819 #: ../src/guestfs-actions.pod:1829
8823 " guestfs_findfs_uuid (guestfs_h *g,\n"
8824 " const char *uuid);\n"
8829 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1246
8831 "This command searches the filesystems and returns the one which has the "
8832 "given UUID. An error is returned if no such filesystem can be found."
8836 #: ../src/guestfs-actions.pod:1837
8837 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8841 #: ../src/guestfs-actions.pod:1844
8842 msgid "guestfs_fsck"
8846 #: ../src/guestfs-actions.pod:1846
8850 " guestfs_fsck (guestfs_h *g,\n"
8851 " const char *fstype,\n"
8852 " const char *device);\n"
8857 #: ../src/guestfs-actions.pod:1851 ../fish/guestfish-actions.pod:1256
8859 "This runs the filesystem checker (fsck) on C<device> which should have "
8860 "filesystem type C<fstype>."
8864 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1259
8866 "The returned integer is the status. See L<fsck(8)> for the list of status "
8867 "codes from C<fsck>."
8871 #: ../src/guestfs-actions.pod:1863 ../fish/guestfish-actions.pod:1268
8872 msgid "Multiple status codes can be summed together."
8876 #: ../src/guestfs-actions.pod:1867 ../fish/guestfish-actions.pod:1272
8878 "A non-zero return code can mean \"success\", for example if errors have been "
8879 "corrected on the filesystem."
8883 #: ../src/guestfs-actions.pod:1872 ../fish/guestfish-actions.pod:1277
8884 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8888 #: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1282
8889 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8893 #: ../src/guestfs-actions.pod:1881 ../src/guestfs-actions.pod:7392
8894 msgid "(Added in 1.0.16)"
8898 #: ../src/guestfs-actions.pod:1883
8899 msgid "guestfs_get_append"
8903 #: ../src/guestfs-actions.pod:1885
8907 " guestfs_get_append (guestfs_h *g);\n"
8912 #: ../src/guestfs-actions.pod:1888 ../fish/guestfish-actions.pod:1288
8914 "Return the additional kernel options which are added to the guest kernel "
8919 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1291
8920 msgid "If C<NULL> then no options are added."
8924 #: ../src/guestfs-actions.pod:1893
8926 "This function returns a string which may be NULL. There is no way to return "
8927 "an error from this function. The string is owned by the guest handle and "
8928 "must I<not> be freed."
8932 #: ../src/guestfs-actions.pod:1897 ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5819 ../src/guestfs-actions.pod:6240 ../src/guestfs-actions.pod:6259 ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6299 ../src/guestfs-actions.pod:7056 ../src/guestfs-actions.pod:7074 ../src/guestfs-actions.pod:7435
8933 msgid "(Added in 1.0.26)"
8937 #: ../src/guestfs-actions.pod:1899
8938 msgid "guestfs_get_attach_method"
8942 #: ../src/guestfs-actions.pod:1901
8946 " guestfs_get_attach_method (guestfs_h *g);\n"
8951 #: ../src/guestfs-actions.pod:1904
8952 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8956 #: ../src/guestfs-actions.pod:1909
8957 msgid "guestfs_get_autosync"
8961 #: ../src/guestfs-actions.pod:1911
8965 " guestfs_get_autosync (guestfs_h *g);\n"
8970 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1303
8971 msgid "Get the autosync flag."
8975 #: ../src/guestfs-actions.pod:1920
8976 msgid "guestfs_get_direct"
8980 #: ../src/guestfs-actions.pod:1922
8984 " guestfs_get_direct (guestfs_h *g);\n"
8989 #: ../src/guestfs-actions.pod:1925 ../fish/guestfish-actions.pod:1309
8990 msgid "Return the direct appliance mode flag."
8994 #: ../src/guestfs-actions.pod:1929 ../src/guestfs-actions.pod:5888
8995 msgid "(Added in 1.0.72)"
8999 #: ../src/guestfs-actions.pod:1931
9000 msgid "guestfs_get_e2label"
9004 #: ../src/guestfs-actions.pod:1933
9008 " guestfs_get_e2label (guestfs_h *g,\n"
9009 " const char *device);\n"
9014 #: ../src/guestfs-actions.pod:1937 ../fish/guestfish-actions.pod:1315
9015 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9019 #: ../src/guestfs-actions.pod:1943
9021 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
9026 #: ../src/guestfs-actions.pod:1950 ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:5906 ../src/guestfs-actions.pod:5925
9027 msgid "(Added in 1.0.15)"
9031 #: ../src/guestfs-actions.pod:1952
9032 msgid "guestfs_get_e2uuid"
9036 #: ../src/guestfs-actions.pod:1954
9040 " guestfs_get_e2uuid (guestfs_h *g,\n"
9041 " const char *device);\n"
9046 #: ../src/guestfs-actions.pod:1958 ../fish/guestfish-actions.pod:1329
9047 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9051 #: ../src/guestfs-actions.pod:1964
9053 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
9058 #: ../src/guestfs-actions.pod:1973
9059 msgid "guestfs_get_memsize"
9063 #: ../src/guestfs-actions.pod:1975
9067 " guestfs_get_memsize (guestfs_h *g);\n"
9072 #: ../src/guestfs-actions.pod:1978 ../fish/guestfish-actions.pod:1343
9073 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
9077 #: ../src/guestfs-actions.pod:1981
9079 "If C<guestfs_set_memsize> was not called on this handle, and if "
9080 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9081 "value for memsize."
9085 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:6048 ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401 ../fish/guestfish-actions.pod:4011 ../fish/guestfish-actions.pod:4098
9086 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9090 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:4393 ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4609 ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4657 ../src/guestfs-actions.pod:4670 ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5946 ../src/guestfs-actions.pod:6207 ../src/guestfs-actions.pod:6822
9091 msgid "(Added in 1.0.55)"
9095 #: ../src/guestfs-actions.pod:1992
9096 msgid "guestfs_get_network"
9100 #: ../src/guestfs-actions.pod:1994
9104 " guestfs_get_network (guestfs_h *g);\n"
9109 #: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1357
9110 msgid "This returns the enable network flag."
9114 #: ../src/guestfs-actions.pod:2001 ../src/guestfs-actions.pod:5965
9115 msgid "(Added in 1.5.4)"
9119 #: ../src/guestfs-actions.pod:2003
9120 msgid "guestfs_get_path"
9124 #: ../src/guestfs-actions.pod:2005
9128 " guestfs_get_path (guestfs_h *g);\n"
9133 #: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363
9134 msgid "Return the current search path."
9138 #: ../src/guestfs-actions.pod:2010 ../fish/guestfish-actions.pod:1365
9140 "This is always non-NULL. If it wasn't set already, then this will return "
9145 #: ../src/guestfs-actions.pod:2013 ../src/guestfs-actions.pod:2042
9147 "This function returns a string, or NULL on error. The string is owned by "
9148 "the guest handle and must I<not> be freed."
9152 #: ../src/guestfs-actions.pod:2018
9153 msgid "guestfs_get_pid"
9157 #: ../src/guestfs-actions.pod:2020
9161 " guestfs_get_pid (guestfs_h *g);\n"
9166 #: ../src/guestfs-actions.pod:2023 ../fish/guestfish-actions.pod:1374
9168 "Return the process ID of the qemu subprocess. If there is no qemu "
9169 "subprocess, then this will return an error."
9173 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1377
9174 msgid "This is an internal call used for debugging and testing."
9178 #: ../src/guestfs-actions.pod:2030
9179 msgid "(Added in 1.0.56)"
9183 #: ../src/guestfs-actions.pod:2032
9184 msgid "guestfs_get_qemu"
9188 #: ../src/guestfs-actions.pod:2034
9192 " guestfs_get_qemu (guestfs_h *g);\n"
9197 #: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383
9198 msgid "Return the current qemu binary."
9202 #: ../src/guestfs-actions.pod:2039 ../fish/guestfish-actions.pod:1385
9204 "This is always non-NULL. If it wasn't set already, then this will return "
9205 "the default qemu binary name."
9209 #: ../src/guestfs-actions.pod:2045 ../src/guestfs-actions.pod:6010
9210 msgid "(Added in 1.0.6)"
9214 #: ../src/guestfs-actions.pod:2047
9215 msgid "guestfs_get_recovery_proc"
9219 #: ../src/guestfs-actions.pod:2049
9223 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9228 #: ../src/guestfs-actions.pod:2052 ../fish/guestfish-actions.pod:1392
9229 msgid "Return the recovery process enabled flag."
9233 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:5269 ../src/guestfs-actions.pod:5612 ../src/guestfs-actions.pod:6034 ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6745 ../src/guestfs-actions.pod:6937
9234 msgid "(Added in 1.0.77)"
9238 #: ../src/guestfs-actions.pod:2058
9239 msgid "guestfs_get_selinux"
9243 #: ../src/guestfs-actions.pod:2060
9247 " guestfs_get_selinux (guestfs_h *g);\n"
9252 #: ../src/guestfs-actions.pod:2063
9254 "This returns the current setting of the selinux flag which is passed to the "
9255 "appliance at boot time. See C<guestfs_set_selinux>."
9259 #: ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2134 ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6111
9260 msgid "(Added in 1.0.67)"
9264 #: ../src/guestfs-actions.pod:2073
9265 msgid "guestfs_get_state"
9269 #: ../src/guestfs-actions.pod:2075
9273 " guestfs_get_state (guestfs_h *g);\n"
9278 #: ../src/guestfs-actions.pod:2078 ../fish/guestfish-actions.pod:1408
9280 "This returns the current state as an opaque integer. This is only useful "
9281 "for printing debug and internal error messages."
9285 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3418 ../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
9286 msgid "For more information on states, see L<guestfs(3)>."
9290 #: ../src/guestfs-actions.pod:2087
9291 msgid "guestfs_get_trace"
9295 #: ../src/guestfs-actions.pod:2089
9299 " guestfs_get_trace (guestfs_h *g);\n"
9304 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
9305 msgid "Return the command trace flag."
9309 #: ../src/guestfs-actions.pod:2098
9310 msgid "guestfs_get_umask"
9314 #: ../src/guestfs-actions.pod:2100
9318 " guestfs_get_umask (guestfs_h *g);\n"
9323 #: ../src/guestfs-actions.pod:2103
9325 "Return the current umask. By default the umask is C<022> unless it has been "
9326 "set by calling C<guestfs_umask>."
9330 #: ../src/guestfs-actions.pod:2110
9331 msgid "guestfs_get_verbose"
9335 #: ../src/guestfs-actions.pod:2112
9339 " guestfs_get_verbose (guestfs_h *g);\n"
9344 #: ../src/guestfs-actions.pod:2115 ../fish/guestfish-actions.pod:1430
9345 msgid "This returns the verbose messages flag."
9349 #: ../src/guestfs-actions.pod:2121
9350 msgid "guestfs_getcon"
9354 #: ../src/guestfs-actions.pod:2123
9358 " guestfs_getcon (guestfs_h *g);\n"
9363 #: ../src/guestfs-actions.pod:2126 ../fish/guestfish-actions.pod:1436
9364 msgid "This gets the SELinux security context of the daemon."
9368 #: ../src/guestfs-actions.pod:2128
9369 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9373 #: ../src/guestfs-actions.pod:2136
9374 msgid "guestfs_getxattr"
9378 #: ../src/guestfs-actions.pod:2138
9382 " guestfs_getxattr (guestfs_h *g,\n"
9383 " const char *path,\n"
9384 " const char *name,\n"
9385 " size_t *size_r);\n"
9390 #: ../src/guestfs-actions.pod:2144
9392 "Get a single extended attribute from file C<path> named C<name>. This call "
9393 "follows symlinks. If you want to lookup an extended attribute for the "
9394 "symlink itself, use C<guestfs_lgetxattr>."
9398 #: ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:3517
9400 "Normally it is better to get all extended attributes from a file in one go "
9401 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9402 "implementations are buggy and do not provide a way to list out attributes. "
9403 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9404 "extended attributes you want in advance and call this function."
9408 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3524 ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2462
9410 "Extended attribute values are blobs of binary data. If there is no extended "
9411 "attribute named C<name>, this returns an error."
9415 #: ../src/guestfs-actions.pod:2158
9416 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9420 #: ../src/guestfs-actions.pod:2160 ../src/guestfs-actions.pod:2351 ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:5469
9422 "This function returns a buffer, or NULL on error. The size of the returned "
9423 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9428 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:3533
9429 msgid "(Added in 1.7.24)"
9433 #: ../src/guestfs-actions.pod:2166
9434 msgid "guestfs_getxattrs"
9438 #: ../src/guestfs-actions.pod:2168
9441 " struct guestfs_xattr_list *\n"
9442 " guestfs_getxattrs (guestfs_h *g,\n"
9443 " const char *path);\n"
9448 #: ../src/guestfs-actions.pod:2172 ../fish/guestfish-actions.pod:1465
9449 msgid "This call lists the extended attributes of the file or directory C<path>."
9453 #: ../src/guestfs-actions.pod:2175 ../fish/guestfish-actions.pod:1468
9455 "At the system call level, this is a combination of the L<listxattr(2)> and "
9456 "L<getxattr(2)> calls."
9460 #: ../src/guestfs-actions.pod:2178
9461 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9465 #: ../src/guestfs-actions.pod:2180 ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:4196
9467 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9468 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9472 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:3549 ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3750 ../src/guestfs-actions.pod:5642 ../src/guestfs-actions.pod:6130 ../src/guestfs-actions.pod:7500
9473 msgid "(Added in 1.0.59)"
9477 #: ../src/guestfs-actions.pod:2186
9478 msgid "guestfs_glob_expand"
9482 #: ../src/guestfs-actions.pod:2188
9486 " guestfs_glob_expand (guestfs_h *g,\n"
9487 " const char *pattern);\n"
9492 #: ../src/guestfs-actions.pod:2192 ../fish/guestfish-actions.pod:1477
9494 "This command searches for all the pathnames matching C<pattern> according to "
9495 "the wildcard expansion rules used by the shell."
9499 #: ../src/guestfs-actions.pod:2196 ../fish/guestfish-actions.pod:1481
9500 msgid "If no paths match, then this returns an empty list (note: not an error)."
9504 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1484
9506 "It is just a wrapper around the C L<glob(3)> function with flags "
9507 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9511 #: ../src/guestfs-actions.pod:2207 ../src/guestfs-actions.pod:6323 ../src/guestfs-actions.pod:6340
9512 msgid "(Added in 1.0.50)"
9516 #: ../src/guestfs-actions.pod:2209
9517 msgid "guestfs_grep"
9521 #: ../src/guestfs-actions.pod:2211
9525 " guestfs_grep (guestfs_h *g,\n"
9526 " const char *regex,\n"
9527 " const char *path);\n"
9532 #: ../src/guestfs-actions.pod:2216 ../fish/guestfish-actions.pod:1492
9533 msgid "This calls the external C<grep> program and returns the matching lines."
9537 #: ../src/guestfs-actions.pod:2228
9538 msgid "guestfs_grepi"
9542 #: ../src/guestfs-actions.pod:2230
9546 " guestfs_grepi (guestfs_h *g,\n"
9547 " const char *regex,\n"
9548 " const char *path);\n"
9553 #: ../src/guestfs-actions.pod:2235 ../fish/guestfish-actions.pod:1502
9554 msgid "This calls the external C<grep -i> program and returns the matching lines."
9558 #: ../src/guestfs-actions.pod:2247
9559 msgid "guestfs_grub_install"
9563 #: ../src/guestfs-actions.pod:2249
9567 " guestfs_grub_install (guestfs_h *g,\n"
9568 " const char *root,\n"
9569 " const char *device);\n"
9574 #: ../src/guestfs-actions.pod:2254 ../fish/guestfish-actions.pod:1512
9576 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9577 "the root directory being C<root>."
9581 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1515
9583 "Note: If grub-install reports the error \"No suitable drive was found in the "
9584 "generated device map.\" it may be that you need to create a "
9585 "C</boot/grub/device.map> file first that contains the mapping between grub "
9586 "device names and Linux device names. It is usually sufficient to create a "
9591 #: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522
9599 #: ../src/guestfs-actions.pod:2266 ../fish/guestfish-actions.pod:1524
9600 msgid "replacing C</dev/vda> with the name of the installation device."
9604 #: ../src/guestfs-actions.pod:2270
9605 msgid "(Added in 1.0.17)"
9609 #: ../src/guestfs-actions.pod:2272
9610 msgid "guestfs_head"
9614 #: ../src/guestfs-actions.pod:2274
9618 " guestfs_head (guestfs_h *g,\n"
9619 " const char *path);\n"
9624 #: ../src/guestfs-actions.pod:2278 ../fish/guestfish-actions.pod:1530
9626 "This command returns up to the first 10 lines of a file as a list of "
9631 #: ../src/guestfs-actions.pod:2290
9632 msgid "guestfs_head_n"
9636 #: ../src/guestfs-actions.pod:2292
9640 " guestfs_head_n (guestfs_h *g,\n"
9642 " const char *path);\n"
9647 #: ../src/guestfs-actions.pod:2297 ../fish/guestfish-actions.pod:1540
9649 "If the parameter C<nrlines> is a positive number, this returns the first "
9650 "C<nrlines> lines of the file C<path>."
9654 #: ../src/guestfs-actions.pod:2300 ../fish/guestfish-actions.pod:1543
9656 "If the parameter C<nrlines> is a negative number, this returns lines from "
9657 "the file C<path>, excluding the last C<nrlines> lines."
9661 #: ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:6620 ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4476
9662 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9666 #: ../src/guestfs-actions.pod:2314
9667 msgid "guestfs_hexdump"
9671 #: ../src/guestfs-actions.pod:2316
9675 " guestfs_hexdump (guestfs_h *g,\n"
9676 " const char *path);\n"
9681 #: ../src/guestfs-actions.pod:2320 ../fish/guestfish-actions.pod:1555
9683 "This runs C<hexdump -C> on the given C<path>. The result is the "
9684 "human-readable, canonical hex dump of the file."
9688 #: ../src/guestfs-actions.pod:2329 ../src/guestfs-actions.pod:6404 ../src/guestfs-actions.pod:6459
9689 msgid "(Added in 1.0.22)"
9693 #: ../src/guestfs-actions.pod:2331
9694 msgid "guestfs_initrd_cat"
9698 #: ../src/guestfs-actions.pod:2333
9702 " guestfs_initrd_cat (guestfs_h *g,\n"
9703 " const char *initrdpath,\n"
9704 " const char *filename,\n"
9705 " size_t *size_r);\n"
9710 #: ../src/guestfs-actions.pod:2339 ../fish/guestfish-actions.pod:1565
9712 "This command unpacks the file C<filename> from the initrd file called "
9713 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9718 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1569
9720 "For example, in guestfish you could use the following command to examine the "
9721 "boot script (usually called C</init>) contained in a Linux initrd or "
9726 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1573
9729 " initrd-cat /boot/initrd-<version>.img init\n"
9734 #: ../src/guestfs-actions.pod:2349
9735 msgid "See also C<guestfs_initrd_list>."
9739 #: ../src/guestfs-actions.pod:2360
9740 msgid "guestfs_initrd_list"
9744 #: ../src/guestfs-actions.pod:2362
9748 " guestfs_initrd_list (guestfs_h *g,\n"
9749 " const char *path);\n"
9754 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584
9755 msgid "This command lists out files contained in an initrd."
9759 #: ../src/guestfs-actions.pod:2368 ../fish/guestfish-actions.pod:1586
9761 "The files are listed without any initial C</> character. The files are "
9762 "listed in the order they appear (not necessarily alphabetical). Directory "
9763 "names are listed as separate items."
9767 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1590
9769 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9770 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9775 #: ../src/guestfs-actions.pod:2382
9776 msgid "guestfs_inotify_add_watch"
9780 #: ../src/guestfs-actions.pod:2384
9784 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9785 " const char *path,\n"
9791 #: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598
9792 msgid "Watch C<path> for the events listed in C<mask>."
9796 #: ../src/guestfs-actions.pod:2391 ../fish/guestfish-actions.pod:1600
9798 "Note that if C<path> is a directory then events within that directory are "
9799 "watched, but this does I<not> happen recursively (in subdirectories)."
9803 #: ../src/guestfs-actions.pod:2395 ../fish/guestfish-actions.pod:1604
9805 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9806 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9810 #: ../src/guestfs-actions.pod:2403
9811 msgid "guestfs_inotify_close"
9815 #: ../src/guestfs-actions.pod:2405
9819 " guestfs_inotify_close (guestfs_h *g);\n"
9824 #: ../src/guestfs-actions.pod:2408 ../fish/guestfish-actions.pod:1612
9826 "This closes the inotify handle which was previously opened by inotify_init. "
9827 "It removes all watches, throws away any pending events, and deallocates all "
9832 #: ../src/guestfs-actions.pod:2416
9833 msgid "guestfs_inotify_files"
9837 #: ../src/guestfs-actions.pod:2418
9841 " guestfs_inotify_files (guestfs_h *g);\n"
9846 #: ../src/guestfs-actions.pod:2421
9848 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9849 "returns a list of pathnames of objects that were touched. The returned "
9850 "pathnames are sorted and deduplicated."
9854 #: ../src/guestfs-actions.pod:2431
9855 msgid "guestfs_inotify_init"
9859 #: ../src/guestfs-actions.pod:2433
9863 " guestfs_inotify_init (guestfs_h *g,\n"
9864 " int maxevents);\n"
9869 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1628
9871 "This command creates a new inotify handle. The inotify subsystem can be "
9872 "used to notify events which happen to objects in the guest filesystem."
9876 #: ../src/guestfs-actions.pod:2441
9878 "C<maxevents> is the maximum number of events which will be queued up between "
9879 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9880 "passed as C<0>, then the kernel (or previously set) default is used. For "
9881 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9882 "throws away events, but records the fact that it threw them away by setting "
9883 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9884 "C<guestfs_inotify_read>)."
9888 #: ../src/guestfs-actions.pod:2451
9890 "Before any events are generated, you have to add some watches to the "
9891 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9892 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9896 #: ../src/guestfs-actions.pod:2457
9898 "Queued up events should be read periodically by calling "
9899 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9900 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9901 "often enough then you risk the internal queue overflowing."
9905 #: ../src/guestfs-actions.pod:2464
9907 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9908 "This also removes any watches automatically."
9912 #: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1659
9914 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9915 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9916 "that there is one global inotify handle per libguestfs instance."
9920 #: ../src/guestfs-actions.pod:2477
9921 msgid "guestfs_inotify_read"
9925 #: ../src/guestfs-actions.pod:2479
9928 " struct guestfs_inotify_event_list *\n"
9929 " guestfs_inotify_read (guestfs_h *g);\n"
9934 #: ../src/guestfs-actions.pod:2482 ../fish/guestfish-actions.pod:1668
9936 "Return the complete queue of events that have happened since the previous "
9941 #: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671
9942 msgid "If no events have happened, this returns an empty list."
9946 #: ../src/guestfs-actions.pod:2487 ../fish/guestfish-actions.pod:1673
9948 "I<Note>: In order to make sure that all events have been read, you must call "
9949 "this function repeatedly until it returns an empty list. The reason is that "
9950 "the call will read events up to the maximum appliance-to-host message size "
9951 "and leave remaining events in the queue."
9955 #: ../src/guestfs-actions.pod:2493
9957 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9958 "there was an error. I<The caller must call "
9959 "C<guestfs_free_inotify_event_list> after use>."
9963 #: ../src/guestfs-actions.pod:2499
9964 msgid "guestfs_inotify_rm_watch"
9968 #: ../src/guestfs-actions.pod:2501
9972 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9978 #: ../src/guestfs-actions.pod:2505
9980 "Remove a previously defined inotify watch. See "
9981 "C<guestfs_inotify_add_watch>."
9985 #: ../src/guestfs-actions.pod:2512
9986 msgid "guestfs_inspect_get_arch"
9990 #: ../src/guestfs-actions.pod:2514
9994 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9995 " const char *root);\n"
10000 #: ../src/guestfs-actions.pod:2518 ../src/guestfs-actions.pod:2541 ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2678 ../src/guestfs-actions.pod:2704 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2765 ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:2856 ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:2916 ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:2995 ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058 ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3134
10002 "This function should only be called with a root device string as returned by "
10003 "C<guestfs_inspect_os>."
10007 #: ../src/guestfs-actions.pod:2521
10009 "This returns the architecture of the inspected operating system. The "
10010 "possible return values are listed under C<guestfs_file_architecture>."
10014 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1697
10016 "If the architecture could not be determined, then the string C<unknown> is "
10021 #: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2732 ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2780 ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:2927 ../src/guestfs-actions.pod:2981 ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3068 ../src/guestfs-actions.pod:3088 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3227 ../src/guestfs-actions.pod:3268 ../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
10022 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10026 #: ../src/guestfs-actions.pod:2535
10027 msgid "guestfs_inspect_get_distro"
10031 #: ../src/guestfs-actions.pod:2537
10035 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10036 " const char *root);\n"
10041 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1709
10042 msgid "This returns the distro (distribution) of the inspected operating system."
10046 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1712
10047 msgid "Currently defined distros are:"
10051 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716
10052 msgid "\"archlinux\""
10056 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718
10057 msgid "Arch Linux."
10061 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720
10066 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722
10071 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724
10076 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726
10081 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728
10086 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730
10091 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732
10096 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734
10101 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736
10102 msgid "\"linuxmint\""
10106 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738
10107 msgid "Linux Mint."
10111 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740
10112 msgid "\"mandriva\""
10116 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742
10121 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744
10126 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746
10131 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748
10136 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750
10141 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752
10142 msgid "\"redhat-based\""
10146 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754
10147 msgid "Some Red Hat-derived distro."
10151 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756
10156 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758
10157 msgid "Red Hat Enterprise Linux."
10161 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760
10162 msgid "\"scientificlinux\""
10166 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1762
10167 msgid "Scientific Linux."
10171 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764
10172 msgid "\"slackware\""
10176 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1766
10181 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768
10186 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1770
10191 #: ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2723 ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:1772 ../fish/guestfish-actions.pod:1865 ../fish/guestfish-actions.pod:2090
10192 msgid "\"unknown\""
10196 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1774
10197 msgid "The distro could not be determined."
10201 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:2082
10202 msgid "\"windows\""
10206 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1778
10208 "Windows does not have distributions. This string is returned if the OS type "
10213 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2729 ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:1783 ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:2096
10215 "Future versions of libguestfs may return other strings here. The caller "
10216 "should be prepared to handle any string."
10220 #: ../src/guestfs-actions.pod:2628
10221 msgid "guestfs_inspect_get_drive_mappings"
10225 #: ../src/guestfs-actions.pod:2630
10229 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10230 " const char *root);\n"
10235 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795
10237 "This call is useful for Windows which uses a primitive system of assigning "
10238 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10239 "Windows Registry to find out how disks/partitions are mapped to drive "
10240 "letters, and returns a hash table as in the example below:"
10244 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1801
10247 " C => /dev/vda2\n"
10248 " E => /dev/vdb1\n"
10249 " F => /dev/vdc1\n"
10254 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1805
10256 "Note that keys are drive letters. For Windows, the key is case insensitive "
10257 "and just contains the drive letter, without the customary colon separator "
10262 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1809
10264 "In future we may support other operating systems that also used drive "
10265 "letters, but the keys for those might not be case insensitive and might be "
10266 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10271 #: ../src/guestfs-actions.pod:2656 ../fish/guestfish-actions.pod:1814
10273 "For Windows guests, currently only hard drive mappings are returned. "
10274 "Removable disks (eg. DVD-ROMs) are ignored."
10278 #: ../src/guestfs-actions.pod:2659 ../fish/guestfish-actions.pod:1817
10280 "For guests that do not use drive mappings, or if the drive mappings could "
10281 "not be determined, this returns an empty hash table."
10285 #: ../src/guestfs-actions.pod:2662
10287 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10288 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10292 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2842 ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:4819 ../src/guestfs-actions.pod:6761
10294 "This function returns a NULL-terminated array of strings, or NULL if there "
10295 "was an error. The array of strings will always have length C<2n+1>, where "
10296 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10297 "caller must free the strings and the array after use>."
10301 #: ../src/guestfs-actions.pod:2672
10302 msgid "guestfs_inspect_get_filesystems"
10306 #: ../src/guestfs-actions.pod:2674
10310 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10311 " const char *root);\n"
10316 #: ../src/guestfs-actions.pod:2681 ../fish/guestfish-actions.pod:1831
10318 "This returns a list of all the filesystems that we think are associated with "
10319 "this operating system. This includes the root filesystem, other ordinary "
10320 "filesystems, and non-mounted devices like swap partitions."
10324 #: ../src/guestfs-actions.pod:2686 ../fish/guestfish-actions.pod:1836
10326 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10327 "to be shared between operating systems."
10331 #: ../src/guestfs-actions.pod:2689
10333 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10334 "C<guestfs_inspect_get_mountpoints>."
10338 #: ../src/guestfs-actions.pod:2698
10339 msgid "guestfs_inspect_get_format"
10343 #: ../src/guestfs-actions.pod:2700
10347 " guestfs_inspect_get_format (guestfs_h *g,\n"
10348 " const char *root);\n"
10353 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1849
10355 "This returns the format of the inspected operating system. You can use it "
10356 "to detect install images, live CDs and similar."
10360 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852
10361 msgid "Currently defined formats are:"
10365 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1856
10366 msgid "\"installed\""
10370 #: ../src/guestfs-actions.pod:2716 ../fish/guestfish-actions.pod:1858
10371 msgid "This is an installed operating system."
10375 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1860
10376 msgid "\"installer\""
10380 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1862
10382 "The disk image being inspected is not an installed operating system, but a "
10383 "I<bootable> install disk, live CD, or similar."
10387 #: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:1867
10388 msgid "The format of this disk image is not known."
10392 #: ../src/guestfs-actions.pod:2737
10393 msgid "guestfs_inspect_get_hostname"
10397 #: ../src/guestfs-actions.pod:2739
10401 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10402 " const char *root);\n"
10407 #: ../src/guestfs-actions.pod:2746 ../fish/guestfish-actions.pod:1883
10409 "This function returns the hostname of the operating system as found by "
10410 "inspection of the guest's configuration files."
10414 #: ../src/guestfs-actions.pod:2749 ../fish/guestfish-actions.pod:1886
10416 "If the hostname could not be determined, then the string C<unknown> is "
10421 #: ../src/guestfs-actions.pod:2757
10422 msgid "(Added in 1.7.9)"
10426 #: ../src/guestfs-actions.pod:2759
10427 msgid "guestfs_inspect_get_major_version"
10431 #: ../src/guestfs-actions.pod:2761
10435 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10436 " const char *root);\n"
10441 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1898
10442 msgid "This returns the major version number of the inspected operating system."
10446 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1901
10448 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10449 "popular public names used by the operating system. Notably the operating "
10450 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10451 "1). You can find out the real versions corresponding to releases of Windows "
10452 "by consulting Wikipedia or MSDN."
10456 #: ../src/guestfs-actions.pod:2778 ../src/guestfs-actions.pod:2798 ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1922
10457 msgid "If the version could not be determined, then C<0> is returned."
10461 #: ../src/guestfs-actions.pod:2786
10462 msgid "guestfs_inspect_get_minor_version"
10466 #: ../src/guestfs-actions.pod:2788
10470 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10471 " const char *root);\n"
10476 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1919
10477 msgid "This returns the minor version number of the inspected operating system."
10481 #: ../src/guestfs-actions.pod:2800
10483 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10484 "C<guestfs_inspect_get_major_version>."
10488 #: ../src/guestfs-actions.pod:2807
10489 msgid "guestfs_inspect_get_mountpoints"
10493 #: ../src/guestfs-actions.pod:2809
10497 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10498 " const char *root);\n"
10503 #: ../src/guestfs-actions.pod:2816 ../fish/guestfish-actions.pod:1934
10505 "This returns a hash of where we think the filesystems associated with this "
10506 "operating system should be mounted. Callers should note that this is at "
10507 "best an educated guess made by reading configuration files such as "
10508 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10509 "are non-existent or not mountable and callers should be prepared to handle "
10510 "or ignore failures if they try to mount them."
10514 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1943
10516 "Each element in the returned hashtable has a key which is the path of the "
10517 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10518 "mounted there (eg. C</dev/sda1>)."
10522 #: ../src/guestfs-actions.pod:2830 ../fish/guestfish-actions.pod:1948
10523 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10527 #: ../src/guestfs-actions.pod:2833
10529 "For operating systems like Windows which still use drive letters, this call "
10530 "will only return an entry for the first drive \"mounted on\" C</>. For "
10531 "information about the mapping of drive letters to partitions, see "
10532 "C<guestfs_inspect_get_drive_mappings>."
10536 #: ../src/guestfs-actions.pod:2839
10538 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10539 "C<guestfs_inspect_get_filesystems>."
10543 #: ../src/guestfs-actions.pod:2850
10544 msgid "guestfs_inspect_get_package_format"
10548 #: ../src/guestfs-actions.pod:2852
10552 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10553 " const char *root);\n"
10558 #: ../src/guestfs-actions.pod:2859
10560 "This function and C<guestfs_inspect_get_package_management> return the "
10561 "package format and package management tool used by the inspected operating "
10562 "system. For example for Fedora these functions would return C<rpm> (package "
10563 "format) and C<yum> (package management)."
10567 #: ../src/guestfs-actions.pod:2865 ../fish/guestfish-actions.pod:1973
10569 "This returns the string C<unknown> if we could not determine the package "
10570 "format I<or> if the operating system does not have a real packaging system "
10575 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1977
10577 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10578 "Future versions of libguestfs may return other strings."
10582 #: ../src/guestfs-actions.pod:2877 ../src/guestfs-actions.pod:2908
10583 msgid "(Added in 1.7.5)"
10587 #: ../src/guestfs-actions.pod:2879
10588 msgid "guestfs_inspect_get_package_management"
10592 #: ../src/guestfs-actions.pod:2881
10596 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10597 " const char *root);\n"
10602 #: ../src/guestfs-actions.pod:2888
10604 "C<guestfs_inspect_get_package_format> and this function return the package "
10605 "format and package management tool used by the inspected operating system. "
10606 "For example for Fedora these functions would return C<rpm> (package format) "
10607 "and C<yum> (package management)."
10611 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1995
10613 "This returns the string C<unknown> if we could not determine the package "
10614 "management tool I<or> if the operating system does not have a real packaging "
10615 "system (eg. Windows)."
10619 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1999
10621 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10622 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10623 "libguestfs may return other strings."
10627 #: ../src/guestfs-actions.pod:2910
10628 msgid "guestfs_inspect_get_product_name"
10632 #: ../src/guestfs-actions.pod:2912
10636 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10637 " const char *root);\n"
10642 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2013
10644 "This returns the product name of the inspected operating system. The "
10645 "product name is generally some freeform string which can be displayed to the "
10646 "user, but should not be parsed by programs."
10650 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2018
10652 "If the product name could not be determined, then the string C<unknown> is "
10657 #: ../src/guestfs-actions.pod:2934
10658 msgid "guestfs_inspect_get_product_variant"
10662 #: ../src/guestfs-actions.pod:2936
10666 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10667 " const char *root);\n"
10672 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2030
10673 msgid "This returns the product variant of the inspected operating system."
10677 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2033
10679 "For Windows guests, this returns the contents of the Registry key "
10680 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10681 "which is usually a string such as C<Client> or C<Server> (other values are "
10682 "possible). This can be used to distinguish consumer and enterprise versions "
10683 "of Windows that have the same version number (for example, Windows 7 and "
10684 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10685 "the latter is C<Server>)."
10689 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2042
10691 "For enterprise Linux guests, in future we intend this to return the product "
10692 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10693 "implemented at present."
10697 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2046
10699 "If the product variant could not be determined, then the string C<unknown> "
10704 #: ../src/guestfs-actions.pod:2962
10706 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10707 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10711 #: ../src/guestfs-actions.pod:2969
10712 msgid "guestfs_inspect_get_roots"
10716 #: ../src/guestfs-actions.pod:2971
10720 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10725 #: ../src/guestfs-actions.pod:2974
10727 "This function is a convenient way to get the list of root devices, as "
10728 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10729 "the whole inspection process."
10733 #: ../src/guestfs-actions.pod:2978
10735 "This returns an empty list if either no root devices were found or the "
10736 "caller has not called C<guestfs_inspect_os>."
10740 #: ../src/guestfs-actions.pod:2987
10741 msgid "(Added in 1.7.3)"
10745 #: ../src/guestfs-actions.pod:2989
10746 msgid "guestfs_inspect_get_type"
10750 #: ../src/guestfs-actions.pod:2991
10754 " guestfs_inspect_get_type (guestfs_h *g,\n"
10755 " const char *root);\n"
10760 #: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2073
10762 "This returns the type of the inspected operating system. Currently defined "
10767 #: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078
10772 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2080
10773 msgid "Any Linux-based operating system."
10777 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2084
10778 msgid "Any Microsoft Windows operating system."
10782 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2086
10783 msgid "\"freebsd\""
10787 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2088
10792 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2092
10793 msgid "The operating system type could not be determined."
10797 #: ../src/guestfs-actions.pod:3031
10798 msgid "guestfs_inspect_get_windows_current_control_set"
10802 #: ../src/guestfs-actions.pod:3033
10806 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
10807 " const char *root);\n"
10812 #: ../src/guestfs-actions.pod:3040 ../fish/guestfish-actions.pod:2108
10814 "This returns the Windows CurrentControlSet of the inspected guest. The "
10815 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10819 #: ../src/guestfs-actions.pod:3043 ../fish/guestfish-actions.pod:2111
10821 "This call assumes that the guest is Windows and that the Registry could be "
10822 "examined by inspection. If this is not the case then an error is returned."
10826 #: ../src/guestfs-actions.pod:3052
10827 msgid "guestfs_inspect_get_windows_systemroot"
10831 #: ../src/guestfs-actions.pod:3054
10835 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10836 " const char *root);\n"
10841 #: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2124
10843 "This returns the Windows systemroot of the inspected guest. The systemroot "
10844 "is a directory path such as C</WINDOWS>."
10848 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2127
10850 "This call assumes that the guest is Windows and that the systemroot could be "
10851 "determined by inspection. If this is not the case then an error is "
10856 #: ../src/guestfs-actions.pod:3073
10857 msgid "(Added in 1.5.25)"
10861 #: ../src/guestfs-actions.pod:3075
10862 msgid "guestfs_inspect_is_live"
10866 #: ../src/guestfs-actions.pod:3077
10870 " guestfs_inspect_is_live (guestfs_h *g,\n"
10871 " const char *root);\n"
10876 #: ../src/guestfs-actions.pod:3084
10878 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10879 "disk), then this returns true if a live image was detected on the disk."
10883 #: ../src/guestfs-actions.pod:3092
10884 msgid "guestfs_inspect_is_multipart"
10888 #: ../src/guestfs-actions.pod:3094
10892 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
10893 " const char *root);\n"
10898 #: ../src/guestfs-actions.pod:3101
10900 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10901 "disk), then this returns true if the disk is part of a set."
10905 #: ../src/guestfs-actions.pod:3109
10906 msgid "guestfs_inspect_is_netinst"
10910 #: ../src/guestfs-actions.pod:3111
10914 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
10915 " const char *root);\n"
10920 #: ../src/guestfs-actions.pod:3118
10922 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10923 "disk), then this returns true if the disk is a network installer, ie. not a "
10924 "self-contained install CD but one which is likely to require network access "
10925 "to complete the install."
10929 #: ../src/guestfs-actions.pod:3128
10930 msgid "guestfs_inspect_list_applications"
10934 #: ../src/guestfs-actions.pod:3130
10937 " struct guestfs_application_list *\n"
10938 " guestfs_inspect_list_applications (guestfs_h *g,\n"
10939 " const char *root);\n"
10944 #: ../src/guestfs-actions.pod:3137 ../fish/guestfish-actions.pod:2181
10945 msgid "Return the list of applications installed in the operating system."
10949 #: ../src/guestfs-actions.pod:3139
10951 "I<Note:> This call works differently from other parts of the inspection "
10952 "API. You have to call C<guestfs_inspect_os>, then "
10953 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
10954 "this. Listing applications is a significantly more difficult operation "
10955 "which requires access to the full filesystem. Also note that unlike the "
10956 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
10957 "the libguestfs handle, this call actually reads parts of the mounted "
10958 "filesystems during the call."
10962 #: ../src/guestfs-actions.pod:3149 ../fish/guestfish-actions.pod:2193
10964 "This returns an empty list if the inspection code was not able to determine "
10965 "the list of applications."
10969 #: ../src/guestfs-actions.pod:3152 ../fish/guestfish-actions.pod:2196
10970 msgid "The application structure contains the following fields:"
10974 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2200
10975 msgid "C<app_name>"
10979 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2202
10981 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10982 "guests, this is the package name."
10986 #: ../src/guestfs-actions.pod:3161 ../fish/guestfish-actions.pod:2205
10987 msgid "C<app_display_name>"
10991 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2207
10993 "The display name of the application, sometimes localized to the install "
10994 "language of the guest operating system."
10998 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2210
11000 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11001 "to display something can use C<app_name> instead."
11005 #: ../src/guestfs-actions.pod:3169 ../fish/guestfish-actions.pod:2213
11006 msgid "C<app_epoch>"
11010 #: ../src/guestfs-actions.pod:3171 ../fish/guestfish-actions.pod:2215
11012 "For package managers which use epochs, this contains the epoch of the "
11013 "package (an integer). If unavailable, this is returned as C<0>."
11017 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2218
11018 msgid "C<app_version>"
11022 #: ../src/guestfs-actions.pod:3176 ../fish/guestfish-actions.pod:2220
11024 "The version string of the application or package. If unavailable this is "
11025 "returned as an empty string C<\"\">."
11029 #: ../src/guestfs-actions.pod:3179 ../fish/guestfish-actions.pod:2223
11030 msgid "C<app_release>"
11034 #: ../src/guestfs-actions.pod:3181 ../fish/guestfish-actions.pod:2225
11036 "The release string of the application or package, for package managers that "
11037 "use this. If unavailable this is returned as an empty string C<\"\">."
11041 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2229
11042 msgid "C<app_install_path>"
11046 #: ../src/guestfs-actions.pod:3187 ../fish/guestfish-actions.pod:2231
11048 "The installation path of the application (on operating systems such as "
11049 "Windows which use installation paths). This path is in the format used by "
11050 "the guest operating system, it is not a libguestfs path."
11054 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2236
11055 msgid "If unavailable this is returned as an empty string C<\"\">."
11059 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2238
11060 msgid "C<app_trans_path>"
11064 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2240
11066 "The install path translated into a libguestfs path. If unavailable this is "
11067 "returned as an empty string C<\"\">."
11071 #: ../src/guestfs-actions.pod:3199 ../fish/guestfish-actions.pod:2243
11072 msgid "C<app_publisher>"
11076 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2245
11078 "The name of the publisher of the application, for package managers that use "
11079 "this. If unavailable this is returned as an empty string C<\"\">."
11083 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2249
11088 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2251
11090 "The URL (eg. upstream URL) of the application. If unavailable this is "
11091 "returned as an empty string C<\"\">."
11095 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2254
11096 msgid "C<app_source_package>"
11100 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2256
11102 "For packaging systems which support this, the name of the source package. "
11103 "If unavailable this is returned as an empty string C<\"\">."
11107 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2259
11108 msgid "C<app_summary>"
11112 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2261
11114 "A short (usually one line) description of the application or package. If "
11115 "unavailable this is returned as an empty string C<\"\">."
11119 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2264
11120 msgid "C<app_description>"
11124 #: ../src/guestfs-actions.pod:3222 ../fish/guestfish-actions.pod:2266
11126 "A longer description of the application or package. If unavailable this is "
11127 "returned as an empty string C<\"\">."
11131 #: ../src/guestfs-actions.pod:3229
11133 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11134 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11139 #: ../src/guestfs-actions.pod:3233
11140 msgid "(Added in 1.7.8)"
11144 #: ../src/guestfs-actions.pod:3235
11145 msgid "guestfs_inspect_os"
11149 #: ../src/guestfs-actions.pod:3237
11153 " guestfs_inspect_os (guestfs_h *g);\n"
11158 #: ../src/guestfs-actions.pod:3240 ../fish/guestfish-actions.pod:2277
11160 "This function uses other libguestfs functions and certain heuristics to "
11161 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11162 "for operating systems."
11166 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2281
11167 msgid "The list returned is empty if no operating systems were found."
11171 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2283
11173 "If one operating system was found, then this returns a list with a single "
11174 "element, which is the name of the root filesystem of this operating system. "
11175 "It is also possible for this function to return a list containing more than "
11176 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11177 "element being the root filesystem of one of the operating systems."
11181 #: ../src/guestfs-actions.pod:3253
11183 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11184 "functions in order to query further information about each operating system, "
11185 "such as the name and version."
11189 #: ../src/guestfs-actions.pod:3258
11191 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11192 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11193 "the contents. This should be called with no disks currently mounted. The "
11194 "function may also use Augeas, so any existing Augeas handle will be closed."
11198 #: ../src/guestfs-actions.pod:3264 ../fish/guestfish-actions.pod:2301
11200 "This function cannot decrypt encrypted disks. The caller must do that first "
11201 "(supplying the necessary keys) if the disk is encrypted."
11205 #: ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:3622
11206 msgid "See also C<guestfs_list_filesystems>."
11210 #: ../src/guestfs-actions.pod:3278
11211 msgid "guestfs_is_blockdev"
11215 #: ../src/guestfs-actions.pod:3280
11219 " guestfs_is_blockdev (guestfs_h *g,\n"
11220 " const char *path);\n"
11225 #: ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:2313
11227 "This returns C<true> if and only if there is a block device with the given "
11232 #: ../src/guestfs-actions.pod:3287 ../src/guestfs-actions.pod:3316 ../src/guestfs-actions.pod:3346 ../src/guestfs-actions.pod:3361 ../src/guestfs-actions.pod:3377 ../src/guestfs-actions.pod:3433 ../src/guestfs-actions.pod:3448
11233 msgid "See also C<guestfs_stat>."
11237 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:3437 ../src/guestfs-actions.pod:3452
11238 msgid "(Added in 1.5.10)"
11242 #: ../src/guestfs-actions.pod:3293
11243 msgid "guestfs_is_busy"
11247 #: ../src/guestfs-actions.pod:3295
11251 " guestfs_is_busy (guestfs_h *g);\n"
11256 #: ../src/guestfs-actions.pod:3298 ../fish/guestfish-actions.pod:2322
11258 "This returns true iff this handle is busy processing a command (in the "
11263 #: ../src/guestfs-actions.pod:3307
11264 msgid "guestfs_is_chardev"
11268 #: ../src/guestfs-actions.pod:3309
11272 " guestfs_is_chardev (guestfs_h *g,\n"
11273 " const char *path);\n"
11278 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2331
11280 "This returns C<true> if and only if there is a character device with the "
11281 "given C<path> name."
11285 #: ../src/guestfs-actions.pod:3322
11286 msgid "guestfs_is_config"
11290 #: ../src/guestfs-actions.pod:3324
11294 " guestfs_is_config (guestfs_h *g);\n"
11299 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2340
11301 "This returns true iff this handle is being configured (in the C<CONFIG> "
11306 #: ../src/guestfs-actions.pod:3336
11307 msgid "guestfs_is_dir"
11311 #: ../src/guestfs-actions.pod:3338
11315 " guestfs_is_dir (guestfs_h *g,\n"
11316 " const char *path);\n"
11321 #: ../src/guestfs-actions.pod:3342 ../fish/guestfish-actions.pod:2349
11323 "This returns C<true> if and only if there is a directory with the given "
11324 "C<path> name. Note that it returns false for other objects like files."
11328 #: ../src/guestfs-actions.pod:3352
11329 msgid "guestfs_is_fifo"
11333 #: ../src/guestfs-actions.pod:3354
11337 " guestfs_is_fifo (guestfs_h *g,\n"
11338 " const char *path);\n"
11343 #: ../src/guestfs-actions.pod:3358 ../fish/guestfish-actions.pod:2359
11345 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11346 "given C<path> name."
11350 #: ../src/guestfs-actions.pod:3367
11351 msgid "guestfs_is_file"
11355 #: ../src/guestfs-actions.pod:3369
11359 " guestfs_is_file (guestfs_h *g,\n"
11360 " const char *path);\n"
11365 #: ../src/guestfs-actions.pod:3373 ../fish/guestfish-actions.pod:2368
11367 "This returns C<true> if and only if there is a regular file with the given "
11368 "C<path> name. Note that it returns false for other objects like "
11373 #: ../src/guestfs-actions.pod:3383
11374 msgid "guestfs_is_launching"
11378 #: ../src/guestfs-actions.pod:3385
11382 " guestfs_is_launching (guestfs_h *g);\n"
11387 #: ../src/guestfs-actions.pod:3388 ../fish/guestfish-actions.pod:2378
11389 "This returns true iff this handle is launching the subprocess (in the "
11390 "C<LAUNCHING> state)."
11394 #: ../src/guestfs-actions.pod:3397
11395 msgid "guestfs_is_lv"
11399 #: ../src/guestfs-actions.pod:3399
11403 " guestfs_is_lv (guestfs_h *g,\n"
11404 " const char *device);\n"
11409 #: ../src/guestfs-actions.pod:3403 ../fish/guestfish-actions.pod:2387
11411 "This command tests whether C<device> is a logical volume, and returns true "
11412 "iff this is the case."
11416 #: ../src/guestfs-actions.pod:3410
11417 msgid "guestfs_is_ready"
11421 #: ../src/guestfs-actions.pod:3412
11425 " guestfs_is_ready (guestfs_h *g);\n"
11430 #: ../src/guestfs-actions.pod:3415 ../fish/guestfish-actions.pod:2394
11432 "This returns true iff this handle is ready to accept commands (in the "
11437 #: ../src/guestfs-actions.pod:3424
11438 msgid "guestfs_is_socket"
11442 #: ../src/guestfs-actions.pod:3426
11446 " guestfs_is_socket (guestfs_h *g,\n"
11447 " const char *path);\n"
11452 #: ../src/guestfs-actions.pod:3430 ../fish/guestfish-actions.pod:2403
11454 "This returns C<true> if and only if there is a Unix domain socket with the "
11455 "given C<path> name."
11459 #: ../src/guestfs-actions.pod:3439
11460 msgid "guestfs_is_symlink"
11464 #: ../src/guestfs-actions.pod:3441
11468 " guestfs_is_symlink (guestfs_h *g,\n"
11469 " const char *path);\n"
11474 #: ../src/guestfs-actions.pod:3445 ../fish/guestfish-actions.pod:2412
11476 "This returns C<true> if and only if there is a symbolic link with the given "
11481 #: ../src/guestfs-actions.pod:3454
11482 msgid "guestfs_kill_subprocess"
11486 #: ../src/guestfs-actions.pod:3456
11490 " guestfs_kill_subprocess (guestfs_h *g);\n"
11495 #: ../src/guestfs-actions.pod:3459 ../fish/guestfish-actions.pod:2421
11496 msgid "This kills the qemu subprocess. You should never need to call this."
11500 #: ../src/guestfs-actions.pod:3465
11501 msgid "guestfs_launch"
11505 #: ../src/guestfs-actions.pod:3467
11509 " guestfs_launch (guestfs_h *g);\n"
11514 #: ../src/guestfs-actions.pod:3470 ../fish/guestfish-actions.pod:2429
11516 "Internally libguestfs is implemented by running a virtual machine using "
11521 #: ../src/guestfs-actions.pod:3473 ../fish/guestfish-actions.pod:2432
11523 "You should call this after configuring the handle (eg. adding drives) but "
11524 "before performing any actions."
11528 #: ../src/guestfs-actions.pod:3485
11529 msgid "guestfs_lchown"
11533 #: ../src/guestfs-actions.pod:3487
11537 " guestfs_lchown (guestfs_h *g,\n"
11540 " const char *path);\n"
11545 #: ../src/guestfs-actions.pod:3493
11547 "Change the file owner to C<owner> and group to C<group>. This is like "
11548 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11549 "changed, not the target."
11553 #: ../src/guestfs-actions.pod:3505
11554 msgid "guestfs_lgetxattr"
11558 #: ../src/guestfs-actions.pod:3507
11562 " guestfs_lgetxattr (guestfs_h *g,\n"
11563 " const char *path,\n"
11564 " const char *name,\n"
11565 " size_t *size_r);\n"
11570 #: ../src/guestfs-actions.pod:3513 ../fish/guestfish-actions.pod:2451
11572 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11573 "is a symlink, then this call returns an extended attribute from the symlink."
11577 #: ../src/guestfs-actions.pod:3527
11578 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11582 #: ../src/guestfs-actions.pod:3535
11583 msgid "guestfs_lgetxattrs"
11587 #: ../src/guestfs-actions.pod:3537
11590 " struct guestfs_xattr_list *\n"
11591 " guestfs_lgetxattrs (guestfs_h *g,\n"
11592 " const char *path);\n"
11597 #: ../src/guestfs-actions.pod:3541
11599 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11600 "then it returns the extended attributes of the link itself."
11604 #: ../src/guestfs-actions.pod:3551
11605 msgid "guestfs_list_devices"
11609 #: ../src/guestfs-actions.pod:3553
11613 " guestfs_list_devices (guestfs_h *g);\n"
11618 #: ../src/guestfs-actions.pod:3556 ../fish/guestfish-actions.pod:2479
11619 msgid "List all the block devices."
11623 #: ../src/guestfs-actions.pod:3558 ../fish/guestfish-actions.pod:2481
11624 msgid "The full block device names are returned, eg. C</dev/sda>."
11628 #: ../src/guestfs-actions.pod:3568
11629 msgid "guestfs_list_filesystems"
11633 #: ../src/guestfs-actions.pod:3570
11637 " guestfs_list_filesystems (guestfs_h *g);\n"
11642 #: ../src/guestfs-actions.pod:3573 ../fish/guestfish-actions.pod:2489
11644 "This inspection command looks for filesystems on partitions, block devices "
11645 "and logical volumes, returning a list of devices containing filesystems and "
11650 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2493
11652 "The return value is a hash, where the keys are the devices containing "
11653 "filesystems, and the values are the filesystem types. For example:"
11657 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2497
11660 " \"/dev/sda1\" => \"ntfs\"\n"
11661 " \"/dev/sda2\" => \"ext2\"\n"
11662 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11663 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11668 #: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2502
11670 "The value can have the special value \"unknown\", meaning the content of the "
11671 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11675 #: ../src/guestfs-actions.pod:3590
11677 "This command runs other libguestfs commands, which might include "
11678 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11679 "soon after launch and only when nothing is mounted."
11683 #: ../src/guestfs-actions.pod:3594
11685 "Not all of the filesystems returned will be mountable. In particular, swap "
11686 "partitions are returned in the list. Also this command does not check that "
11687 "each filesystem found is valid and mountable, and some filesystems might be "
11688 "mountable but require special options. Filesystems may not all belong to a "
11689 "single logical operating system (use C<guestfs_inspect_os> to look for "
11694 #: ../src/guestfs-actions.pod:3608 ../src/guestfs-actions.pod:5229
11695 msgid "(Added in 1.5.15)"
11699 #: ../src/guestfs-actions.pod:3610
11700 msgid "guestfs_list_partitions"
11704 #: ../src/guestfs-actions.pod:3612
11708 " guestfs_list_partitions (guestfs_h *g);\n"
11713 #: ../src/guestfs-actions.pod:3615 ../fish/guestfish-actions.pod:2522
11714 msgid "List all the partitions detected on all block devices."
11718 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2524
11719 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11723 #: ../src/guestfs-actions.pod:3619
11725 "This does not return logical volumes. For that you will need to call "
11730 #: ../src/guestfs-actions.pod:3630
11735 #: ../src/guestfs-actions.pod:3632
11739 " guestfs_ll (guestfs_h *g,\n"
11740 " const char *directory);\n"
11745 #: ../src/guestfs-actions.pod:3636 ../fish/guestfish-actions.pod:2535
11747 "List the files in C<directory> (relative to the root directory, there is no "
11748 "cwd) in the format of 'ls -la'."
11752 #: ../src/guestfs-actions.pod:3639 ../fish/guestfish-actions.pod:2538
11754 "This command is mostly useful for interactive sessions. It is I<not> "
11755 "intended that you try to parse the output string."
11759 #: ../src/guestfs-actions.pod:3647
11764 #: ../src/guestfs-actions.pod:3649
11768 " guestfs_ln (guestfs_h *g,\n"
11769 " const char *target,\n"
11770 " const char *linkname);\n"
11775 #: ../src/guestfs-actions.pod:3654 ../fish/guestfish-actions.pod:2545
11776 msgid "This command creates a hard link using the C<ln> command."
11780 #: ../src/guestfs-actions.pod:3660
11781 msgid "guestfs_ln_f"
11785 #: ../src/guestfs-actions.pod:3662
11789 " guestfs_ln_f (guestfs_h *g,\n"
11790 " const char *target,\n"
11791 " const char *linkname);\n"
11796 #: ../src/guestfs-actions.pod:3667 ../fish/guestfish-actions.pod:2551
11798 "This command creates a hard link using the C<ln -f> command. The I<-f> "
11799 "option removes the link (C<linkname>) if it exists already."
11803 #: ../src/guestfs-actions.pod:3674
11804 msgid "guestfs_ln_s"
11808 #: ../src/guestfs-actions.pod:3676
11812 " guestfs_ln_s (guestfs_h *g,\n"
11813 " const char *target,\n"
11814 " const char *linkname);\n"
11819 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2558
11820 msgid "This command creates a symbolic link using the C<ln -s> command."
11824 #: ../src/guestfs-actions.pod:3687
11825 msgid "guestfs_ln_sf"
11829 #: ../src/guestfs-actions.pod:3689
11833 " guestfs_ln_sf (guestfs_h *g,\n"
11834 " const char *target,\n"
11835 " const char *linkname);\n"
11840 #: ../src/guestfs-actions.pod:3694 ../fish/guestfish-actions.pod:2564
11842 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
11843 "option removes the link (C<linkname>) if it exists already."
11847 #: ../src/guestfs-actions.pod:3701
11848 msgid "guestfs_lremovexattr"
11852 #: ../src/guestfs-actions.pod:3703
11856 " guestfs_lremovexattr (guestfs_h *g,\n"
11857 " const char *xattr,\n"
11858 " const char *path);\n"
11863 #: ../src/guestfs-actions.pod:3708
11865 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
11866 "link, then it removes an extended attribute of the link itself."
11870 #: ../src/guestfs-actions.pod:3716
11875 #: ../src/guestfs-actions.pod:3718
11879 " guestfs_ls (guestfs_h *g,\n"
11880 " const char *directory);\n"
11885 #: ../src/guestfs-actions.pod:3722 ../fish/guestfish-actions.pod:2579
11887 "List the files in C<directory> (relative to the root directory, there is no "
11888 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11893 #: ../src/guestfs-actions.pod:3726
11895 "This command is mostly useful for interactive sessions. Programs should "
11896 "probably use C<guestfs_readdir> instead."
11900 #: ../src/guestfs-actions.pod:3735
11901 msgid "guestfs_lsetxattr"
11905 #: ../src/guestfs-actions.pod:3737
11909 " guestfs_lsetxattr (guestfs_h *g,\n"
11910 " const char *xattr,\n"
11911 " const char *val,\n"
11913 " const char *path);\n"
11918 #: ../src/guestfs-actions.pod:3744
11920 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
11921 "then it sets an extended attribute of the link itself."
11925 #: ../src/guestfs-actions.pod:3752
11926 msgid "guestfs_lstat"
11930 #: ../src/guestfs-actions.pod:3754
11933 " struct guestfs_stat *\n"
11934 " guestfs_lstat (guestfs_h *g,\n"
11935 " const char *path);\n"
11940 #: ../src/guestfs-actions.pod:3758 ../src/guestfs-actions.pod:6360 ../fish/guestfish-actions.pod:2598 ../fish/guestfish-actions.pod:4311
11941 msgid "Returns file information for the given C<path>."
11945 #: ../src/guestfs-actions.pod:3760
11947 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
11948 "link, then the link is stat-ed, not the file it refers to."
11952 #: ../src/guestfs-actions.pod:3764 ../fish/guestfish-actions.pod:2604
11953 msgid "This is the same as the C<lstat(2)> system call."
11957 #: ../src/guestfs-actions.pod:3766 ../src/guestfs-actions.pod:6364
11959 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
11960 "error. I<The caller must call C<guestfs_free_stat> after use>."
11964 #: ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:6368 ../src/guestfs-actions.pod:6386 ../src/guestfs-actions.pod:6767
11965 msgid "(Added in 0.9.2)"
11969 #: ../src/guestfs-actions.pod:3772
11970 msgid "guestfs_lstatlist"
11974 #: ../src/guestfs-actions.pod:3774
11977 " struct guestfs_stat_list *\n"
11978 " guestfs_lstatlist (guestfs_h *g,\n"
11979 " const char *path,\n"
11980 " char *const *names);\n"
11985 #: ../src/guestfs-actions.pod:3779
11987 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
11988 "files, where all files are in the directory C<path>. C<names> is the list "
11989 "of files from this directory."
11993 #: ../src/guestfs-actions.pod:3783 ../fish/guestfish-actions.pod:2614
11995 "On return you get a list of stat structs, with a one-to-one correspondence "
11996 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11997 "then the C<ino> field of that structure is set to C<-1>."
12001 #: ../src/guestfs-actions.pod:3788
12003 "This call is intended for programs that want to efficiently list a directory "
12004 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12005 "for a similarly efficient call for getting extended attributes. Very long "
12006 "directory listings might cause the protocol message size to be exceeded, "
12007 "causing this call to fail. The caller must split up such requests into "
12008 "smaller groups of names."
12012 #: ../src/guestfs-actions.pod:3796
12014 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12015 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12019 #: ../src/guestfs-actions.pod:3802
12020 msgid "guestfs_luks_add_key"
12024 #: ../src/guestfs-actions.pod:3804
12028 " guestfs_luks_add_key (guestfs_h *g,\n"
12029 " const char *device,\n"
12030 " const char *key,\n"
12031 " const char *newkey,\n"
12037 #: ../src/guestfs-actions.pod:3811 ../fish/guestfish-actions.pod:2631
12039 "This command adds a new key on LUKS device C<device>. C<key> is any "
12040 "existing key, and is used to access the device. C<newkey> is the new key to "
12041 "add. C<keyslot> is the key slot that will be replaced."
12045 #: ../src/guestfs-actions.pod:3816
12047 "Note that if C<keyslot> already contains a key, then this command will "
12048 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12052 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:3885 ../src/guestfs-actions.pod:3905 ../src/guestfs-actions.pod:3937 ../src/guestfs-actions.pod:3956
12054 "This function takes a key or passphrase parameter which could contain "
12055 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12060 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3909
12061 msgid "(Added in 1.5.2)"
12065 #: ../src/guestfs-actions.pod:3828
12066 msgid "guestfs_luks_close"
12070 #: ../src/guestfs-actions.pod:3830
12074 " guestfs_luks_close (guestfs_h *g,\n"
12075 " const char *device);\n"
12080 #: ../src/guestfs-actions.pod:3834
12082 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12083 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12084 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12085 "underlying block device."
12089 #: ../src/guestfs-actions.pod:3842 ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:4010 ../src/guestfs-actions.pod:4058
12090 msgid "(Added in 1.5.1)"
12094 #: ../src/guestfs-actions.pod:3844
12095 msgid "guestfs_luks_format"
12099 #: ../src/guestfs-actions.pod:3846
12103 " guestfs_luks_format (guestfs_h *g,\n"
12104 " const char *device,\n"
12105 " const char *key,\n"
12111 #: ../src/guestfs-actions.pod:3852 ../fish/guestfish-actions.pod:2657
12113 "This command erases existing data on C<device> and formats the device as a "
12114 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12115 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12119 #: ../src/guestfs-actions.pod:3859 ../src/guestfs-actions.pod:3882 ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:5760 ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6230 ../src/guestfs-actions.pod:7411 ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2678 ../fish/guestfish-actions.pod:2762 ../fish/guestfish-actions.pod:3352 ../fish/guestfish-actions.pod:3872 ../fish/guestfish-actions.pod:4182 ../fish/guestfish-actions.pod:4205 ../fish/guestfish-actions.pod:4227 ../fish/guestfish-actions.pod:4956
12121 "B<This command is dangerous. Without careful use you can easily destroy all "
12126 #: ../src/guestfs-actions.pod:3868
12127 msgid "guestfs_luks_format_cipher"
12131 #: ../src/guestfs-actions.pod:3870
12135 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12136 " const char *device,\n"
12137 " const char *key,\n"
12139 " const char *cipher);\n"
12144 #: ../src/guestfs-actions.pod:3877
12146 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12147 "set the C<cipher> used."
12151 #: ../src/guestfs-actions.pod:3891
12152 msgid "guestfs_luks_kill_slot"
12156 #: ../src/guestfs-actions.pod:3893
12160 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12161 " const char *device,\n"
12162 " const char *key,\n"
12168 #: ../src/guestfs-actions.pod:3899 ../fish/guestfish-actions.pod:2685
12170 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12171 "device C<device>. C<key> must be one of the I<other> keys."
12175 #: ../src/guestfs-actions.pod:3911
12176 msgid "guestfs_luks_open"
12180 #: ../src/guestfs-actions.pod:3913
12184 " guestfs_luks_open (guestfs_h *g,\n"
12185 " const char *device,\n"
12186 " const char *key,\n"
12187 " const char *mapname);\n"
12192 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2696
12194 "This command opens a block device which has been encrypted according to the "
12195 "Linux Unified Key Setup (LUKS) standard."
12199 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2699
12200 msgid "C<device> is the encrypted block device or partition."
12204 #: ../src/guestfs-actions.pod:3924 ../fish/guestfish-actions.pod:2701
12206 "The caller must supply one of the keys associated with the LUKS block "
12207 "device, in the C<key> parameter."
12211 #: ../src/guestfs-actions.pod:3927 ../fish/guestfish-actions.pod:2704
12213 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12214 "writes to this block device are decrypted from and encrypted to the "
12215 "underlying C<device> respectively."
12219 #: ../src/guestfs-actions.pod:3931
12221 "If this block device contains LVM volume groups, then calling "
12222 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12227 #: ../src/guestfs-actions.pod:3943
12228 msgid "guestfs_luks_open_ro"
12232 #: ../src/guestfs-actions.pod:3945
12236 " guestfs_luks_open_ro (guestfs_h *g,\n"
12237 " const char *device,\n"
12238 " const char *key,\n"
12239 " const char *mapname);\n"
12244 #: ../src/guestfs-actions.pod:3951
12246 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12251 #: ../src/guestfs-actions.pod:3962
12252 msgid "guestfs_lvcreate"
12256 #: ../src/guestfs-actions.pod:3964
12260 " guestfs_lvcreate (guestfs_h *g,\n"
12261 " const char *logvol,\n"
12262 " const char *volgroup,\n"
12268 #: ../src/guestfs-actions.pod:3970 ../fish/guestfish-actions.pod:2729
12270 "This creates an LVM logical volume called C<logvol> on the volume group "
12271 "C<volgroup>, with C<size> megabytes."
12275 #: ../src/guestfs-actions.pod:3977
12276 msgid "guestfs_lvm_canonical_lv_name"
12280 #: ../src/guestfs-actions.pod:3979
12284 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12285 " const char *lvname);\n"
12290 #: ../src/guestfs-actions.pod:3983 ../fish/guestfish-actions.pod:2736
12292 "This converts alternative naming schemes for LVs that you might find to the "
12293 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12298 #: ../src/guestfs-actions.pod:3987 ../fish/guestfish-actions.pod:2740
12300 "This command returns an error if the C<lvname> parameter does not refer to a "
12305 #: ../src/guestfs-actions.pod:3990
12306 msgid "See also C<guestfs_is_lv>."
12310 #: ../src/guestfs-actions.pod:3995
12311 msgid "(Added in 1.5.24)"
12315 #: ../src/guestfs-actions.pod:3997
12316 msgid "guestfs_lvm_clear_filter"
12320 #: ../src/guestfs-actions.pod:3999
12324 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12329 #: ../src/guestfs-actions.pod:4002
12331 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12332 "see every block device."
12336 #: ../src/guestfs-actions.pod:4005 ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2752 ../fish/guestfish-actions.pod:2783
12337 msgid "This command also clears the LVM cache and performs a volume group scan."
12341 #: ../src/guestfs-actions.pod:4012
12342 msgid "guestfs_lvm_remove_all"
12346 #: ../src/guestfs-actions.pod:4014
12350 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12355 #: ../src/guestfs-actions.pod:4017 ../fish/guestfish-actions.pod:2759
12357 "This command removes all LVM logical volumes, volume groups and physical "
12362 #: ../src/guestfs-actions.pod:4027
12363 msgid "guestfs_lvm_set_filter"
12367 #: ../src/guestfs-actions.pod:4029
12371 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12372 " char *const *devices);\n"
12377 #: ../src/guestfs-actions.pod:4033 ../fish/guestfish-actions.pod:2769
12379 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12380 "block devices in the list C<devices>, and will ignore all other attached "
12385 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2773
12387 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12388 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12389 "there are two types of duplication possible: either cloned PVs/VGs which "
12390 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12391 "same name. In normal operation you cannot create this situation, but you "
12392 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12393 "inside the LVM metadata."
12397 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2786
12398 msgid "You can filter whole block devices or individual partitions."
12402 #: ../src/guestfs-actions.pod:4052 ../fish/guestfish-actions.pod:2788
12404 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12405 "filesystem), even if you are not filtering out that VG."
12409 #: ../src/guestfs-actions.pod:4060
12410 msgid "guestfs_lvremove"
12414 #: ../src/guestfs-actions.pod:4062
12418 " guestfs_lvremove (guestfs_h *g,\n"
12419 " const char *device);\n"
12424 #: ../src/guestfs-actions.pod:4066 ../fish/guestfish-actions.pod:2796
12426 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12427 "LV, such as C</dev/VG/LV>."
12431 #: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:2799
12433 "You can also remove all LVs in a volume group by specifying the VG name, "
12438 #: ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:7143
12439 msgid "(Added in 1.0.13)"
12443 #: ../src/guestfs-actions.pod:4076
12444 msgid "guestfs_lvrename"
12448 #: ../src/guestfs-actions.pod:4078
12452 " guestfs_lvrename (guestfs_h *g,\n"
12453 " const char *logvol,\n"
12454 " const char *newlogvol);\n"
12459 #: ../src/guestfs-actions.pod:4083 ../fish/guestfish-actions.pod:2806
12460 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12464 #: ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:7156
12465 msgid "(Added in 1.0.83)"
12469 #: ../src/guestfs-actions.pod:4089
12470 msgid "guestfs_lvresize"
12474 #: ../src/guestfs-actions.pod:4091
12478 " guestfs_lvresize (guestfs_h *g,\n"
12479 " const char *device,\n"
12485 #: ../src/guestfs-actions.pod:4096 ../fish/guestfish-actions.pod:2812
12487 "This resizes (expands or shrinks) an existing LVM logical volume to "
12488 "C<mbytes>. When reducing, data in the reduced part is lost."
12492 #: ../src/guestfs-actions.pod:4104
12493 msgid "guestfs_lvresize_free"
12497 #: ../src/guestfs-actions.pod:4106
12501 " guestfs_lvresize_free (guestfs_h *g,\n"
12502 " const char *lv,\n"
12508 #: ../src/guestfs-actions.pod:4111 ../fish/guestfish-actions.pod:2820
12510 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12511 "remaining free space in the volume group. Commonly you would call this with "
12512 "pc = 100 which expands the logical volume as much as possible, using all "
12513 "remaining free space in the volume group."
12517 #: ../src/guestfs-actions.pod:4119
12518 msgid "(Added in 1.3.3)"
12522 #: ../src/guestfs-actions.pod:4121
12523 msgid "guestfs_lvs"
12527 #: ../src/guestfs-actions.pod:4123
12531 " guestfs_lvs (guestfs_h *g);\n"
12536 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2830
12538 "List all the logical volumes detected. This is the equivalent of the "
12539 "L<lvs(8)> command."
12543 #: ../src/guestfs-actions.pod:4129 ../fish/guestfish-actions.pod:2833
12545 "This returns a list of the logical volume device names "
12546 "(eg. C</dev/VolGroup00/LogVol00>)."
12550 #: ../src/guestfs-actions.pod:4132
12551 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12555 #: ../src/guestfs-actions.pod:4140
12556 msgid "guestfs_lvs_full"
12560 #: ../src/guestfs-actions.pod:4142
12563 " struct guestfs_lvm_lv_list *\n"
12564 " guestfs_lvs_full (guestfs_h *g);\n"
12569 #: ../src/guestfs-actions.pod:4145 ../fish/guestfish-actions.pod:2842
12571 "List all the logical volumes detected. This is the equivalent of the "
12572 "L<lvs(8)> command. The \"full\" version includes all fields."
12576 #: ../src/guestfs-actions.pod:4148
12578 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12579 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12584 #: ../src/guestfs-actions.pod:4154
12585 msgid "guestfs_lvuuid"
12589 #: ../src/guestfs-actions.pod:4156
12593 " guestfs_lvuuid (guestfs_h *g,\n"
12594 " const char *device);\n"
12599 #: ../src/guestfs-actions.pod:4160 ../fish/guestfish-actions.pod:2849
12600 msgid "This command returns the UUID of the LVM LV C<device>."
12604 #: ../src/guestfs-actions.pod:4167
12605 msgid "guestfs_lxattrlist"
12609 #: ../src/guestfs-actions.pod:4169
12612 " struct guestfs_xattr_list *\n"
12613 " guestfs_lxattrlist (guestfs_h *g,\n"
12614 " const char *path,\n"
12615 " char *const *names);\n"
12620 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2855
12622 "This call allows you to get the extended attributes of multiple files, where "
12623 "all files are in the directory C<path>. C<names> is the list of files from "
12628 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2859
12630 "On return you get a flat list of xattr structs which must be interpreted "
12631 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12632 "C<attrval> in this struct is zero-length to indicate there was an error "
12633 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12634 "number (the number of following attributes for this file, which could be "
12635 "C<\"0\">). Then after the first xattr struct are the zero or more "
12636 "attributes for the first named file. This repeats for the second and "
12637 "subsequent files."
12641 #: ../src/guestfs-actions.pod:4188
12643 "This call is intended for programs that want to efficiently list a directory "
12644 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12645 "a similarly efficient call for getting standard stats. Very long directory "
12646 "listings might cause the protocol message size to be exceeded, causing this "
12647 "call to fail. The caller must split up such requests into smaller groups of "
12652 #: ../src/guestfs-actions.pod:4202
12653 msgid "guestfs_mkdir"
12657 #: ../src/guestfs-actions.pod:4204
12661 " guestfs_mkdir (guestfs_h *g,\n"
12662 " const char *path);\n"
12667 #: ../src/guestfs-actions.pod:4208 ../fish/guestfish-actions.pod:2881
12668 msgid "Create a directory named C<path>."
12672 #: ../src/guestfs-actions.pod:4214
12673 msgid "guestfs_mkdir_mode"
12677 #: ../src/guestfs-actions.pod:4216
12681 " guestfs_mkdir_mode (guestfs_h *g,\n"
12682 " const char *path,\n"
12688 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2887
12690 "This command creates a directory, setting the initial permissions of the "
12691 "directory to C<mode>."
12695 #: ../src/guestfs-actions.pod:4224 ../fish/guestfish-actions.pod:2890
12697 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12698 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12703 #: ../src/guestfs-actions.pod:4228
12704 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12708 #: ../src/guestfs-actions.pod:4234
12709 msgid "guestfs_mkdir_p"
12713 #: ../src/guestfs-actions.pod:4236
12717 " guestfs_mkdir_p (guestfs_h *g,\n"
12718 " const char *path);\n"
12723 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2900
12725 "Create a directory named C<path>, creating any parent directories as "
12726 "necessary. This is like the C<mkdir -p> shell command."
12730 #: ../src/guestfs-actions.pod:4247
12731 msgid "guestfs_mkdtemp"
12735 #: ../src/guestfs-actions.pod:4249
12739 " guestfs_mkdtemp (guestfs_h *g,\n"
12740 " const char *template);\n"
12745 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2907
12747 "This command creates a temporary directory. The C<template> parameter "
12748 "should be a full pathname for the temporary directory name with the final "
12749 "six characters being \"XXXXXX\"."
12753 #: ../src/guestfs-actions.pod:4258 ../fish/guestfish-actions.pod:2912
12755 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12756 "being suitable for Windows filesystems."
12760 #: ../src/guestfs-actions.pod:4261 ../fish/guestfish-actions.pod:2915
12761 msgid "The name of the temporary directory that was created is returned."
12765 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2918
12766 msgid "The temporary directory is created with mode 0700 and is owned by root."
12770 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2921
12772 "The caller is responsible for deleting the temporary directory and its "
12773 "contents after use."
12777 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2924
12778 msgid "See also: L<mkdtemp(3)>"
12782 #: ../src/guestfs-actions.pod:4277
12783 msgid "guestfs_mke2fs_J"
12787 #: ../src/guestfs-actions.pod:4279
12791 " guestfs_mke2fs_J (guestfs_h *g,\n"
12792 " const char *fstype,\n"
12793 " int blocksize,\n"
12794 " const char *device,\n"
12795 " const char *journal);\n"
12800 #: ../src/guestfs-actions.pod:4286 ../fish/guestfish-actions.pod:2930
12802 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12803 "C<journal>. It is equivalent to the command:"
12807 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2934
12810 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
12815 #: ../src/guestfs-actions.pod:4292
12816 msgid "See also C<guestfs_mke2journal>."
12820 #: ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4348 ../src/guestfs-actions.pod:4362 ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:4700
12821 msgid "(Added in 1.0.68)"
12825 #: ../src/guestfs-actions.pod:4298
12826 msgid "guestfs_mke2fs_JL"
12830 #: ../src/guestfs-actions.pod:4300
12834 " guestfs_mke2fs_JL (guestfs_h *g,\n"
12835 " const char *fstype,\n"
12836 " int blocksize,\n"
12837 " const char *device,\n"
12838 " const char *label);\n"
12843 #: ../src/guestfs-actions.pod:4307 ../fish/guestfish-actions.pod:2942
12845 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12846 "the journal labeled C<label>."
12850 #: ../src/guestfs-actions.pod:4310
12851 msgid "See also C<guestfs_mke2journal_L>."
12855 #: ../src/guestfs-actions.pod:4316
12856 msgid "guestfs_mke2fs_JU"
12860 #: ../src/guestfs-actions.pod:4318
12864 " guestfs_mke2fs_JU (guestfs_h *g,\n"
12865 " const char *fstype,\n"
12866 " int blocksize,\n"
12867 " const char *device,\n"
12868 " const char *uuid);\n"
12873 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2951
12875 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12876 "the journal with UUID C<uuid>."
12880 #: ../src/guestfs-actions.pod:4328
12881 msgid "See also C<guestfs_mke2journal_U>."
12885 #: ../src/guestfs-actions.pod:4334
12886 msgid "guestfs_mke2journal"
12890 #: ../src/guestfs-actions.pod:4336
12894 " guestfs_mke2journal (guestfs_h *g,\n"
12895 " int blocksize,\n"
12896 " const char *device);\n"
12901 #: ../src/guestfs-actions.pod:4341 ../fish/guestfish-actions.pod:2960
12903 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12908 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2963
12911 " mke2fs -O journal_dev -b blocksize device\n"
12916 #: ../src/guestfs-actions.pod:4350
12917 msgid "guestfs_mke2journal_L"
12921 #: ../src/guestfs-actions.pod:4352
12925 " guestfs_mke2journal_L (guestfs_h *g,\n"
12926 " int blocksize,\n"
12927 " const char *label,\n"
12928 " const char *device);\n"
12933 #: ../src/guestfs-actions.pod:4358 ../fish/guestfish-actions.pod:2969
12934 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12938 #: ../src/guestfs-actions.pod:4364
12939 msgid "guestfs_mke2journal_U"
12943 #: ../src/guestfs-actions.pod:4366
12947 " guestfs_mke2journal_U (guestfs_h *g,\n"
12948 " int blocksize,\n"
12949 " const char *uuid,\n"
12950 " const char *device);\n"
12955 #: ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:2975
12956 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12960 #: ../src/guestfs-actions.pod:4378
12961 msgid "guestfs_mkfifo"
12965 #: ../src/guestfs-actions.pod:4380
12969 " guestfs_mkfifo (guestfs_h *g,\n"
12971 " const char *path);\n"
12976 #: ../src/guestfs-actions.pod:4385
12978 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12979 "is just a convenient wrapper around C<guestfs_mknod>."
12983 #: ../src/guestfs-actions.pod:4395
12984 msgid "guestfs_mkfs"
12988 #: ../src/guestfs-actions.pod:4397
12992 " guestfs_mkfs (guestfs_h *g,\n"
12993 " const char *fstype,\n"
12994 " const char *device);\n"
12999 #: ../src/guestfs-actions.pod:4402 ../fish/guestfish-actions.pod:2991
13001 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13002 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13006 #: ../src/guestfs-actions.pod:4410
13007 msgid "guestfs_mkfs_b"
13011 #: ../src/guestfs-actions.pod:4412
13015 " guestfs_mkfs_b (guestfs_h *g,\n"
13016 " const char *fstype,\n"
13017 " int blocksize,\n"
13018 " const char *device);\n"
13023 #: ../src/guestfs-actions.pod:4418
13025 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13026 "block size of the resulting filesystem. Supported block sizes depend on the "
13027 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13031 #: ../src/guestfs-actions.pod:4423 ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3004 ../fish/guestfish-actions.pod:3031
13033 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13038 #: ../src/guestfs-actions.pod:4428
13040 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
13045 #: ../src/guestfs-actions.pod:4437
13046 msgid "guestfs_mkfs_opts"
13050 #: ../src/guestfs-actions.pod:4439
13054 " guestfs_mkfs_opts (guestfs_h *g,\n"
13055 " const char *fstype,\n"
13056 " const char *device,\n"
13062 #: ../src/guestfs-actions.pod:4450
13065 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13066 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13071 #: ../src/guestfs-actions.pod:4453 ../fish/guestfish-actions.pod:3018
13073 "This function creates a filesystem on C<device>. The filesystem type is "
13074 "C<fstype>, for example C<ext3>."
13078 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:3025
13079 msgid "C<blocksize>"
13083 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:3027
13085 "The filesystem block size. Supported block sizes depend on the filesystem "
13086 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13091 #: ../src/guestfs-actions.pod:4469 ../fish/guestfish-actions.pod:3034
13092 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13096 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3036
13097 msgid "C<features>"
13101 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3038
13102 msgid "This passes the I<-O> parameter to the external mkfs program."
13106 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3040
13108 "For certain filesystem types, this allows extra filesystem features to be "
13109 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13113 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:3044
13115 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13120 #: ../src/guestfs-actions.pod:4486
13121 msgid "(Added in 1.7.19)"
13125 #: ../src/guestfs-actions.pod:4488
13126 msgid "guestfs_mkfs_opts_va"
13130 #: ../src/guestfs-actions.pod:4490
13134 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13135 " const char *fstype,\n"
13136 " const char *device,\n"
13137 " va_list args);\n"
13142 #: ../src/guestfs-actions.pod:4496
13143 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13147 #: ../src/guestfs-actions.pod:4500
13148 msgid "guestfs_mkfs_opts_argv"
13152 #: ../src/guestfs-actions.pod:4502
13156 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13157 " const char *fstype,\n"
13158 " const char *device,\n"
13159 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13164 #: ../src/guestfs-actions.pod:4508
13165 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13169 #: ../src/guestfs-actions.pod:4512
13170 msgid "guestfs_mkmountpoint"
13174 #: ../src/guestfs-actions.pod:4514
13178 " guestfs_mkmountpoint (guestfs_h *g,\n"
13179 " const char *exemptpath);\n"
13184 #: ../src/guestfs-actions.pod:4518
13186 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13187 "that can be used to create extra mountpoints before mounting the first "
13192 #: ../src/guestfs-actions.pod:4522 ../fish/guestfish-actions.pod:3059
13194 "These calls are I<only> necessary in some very limited circumstances, mainly "
13195 "the case where you want to mount a mix of unrelated and/or read-only "
13196 "filesystems together."
13200 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3063
13202 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13203 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13204 "inside that. You can unpack this as follows in guestfish:"
13208 #: ../src/guestfs-actions.pod:4531 ../fish/guestfish-actions.pod:3068
13211 " add-ro Fedora-11-i686-Live.iso\n"
13213 " mkmountpoint /cd\n"
13214 " mkmountpoint /sqsh\n"
13215 " mkmountpoint /ext3fs\n"
13216 " mount /dev/sda /cd\n"
13217 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13218 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13223 #: ../src/guestfs-actions.pod:4540 ../fish/guestfish-actions.pod:3077
13224 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13228 #: ../src/guestfs-actions.pod:4542
13230 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13231 "may get unexpected errors if you try to mix these calls. It is safest to "
13232 "manually unmount filesystems and remove mountpoints after use."
13236 #: ../src/guestfs-actions.pod:4546
13238 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13239 "first, so for this to work for manual mountpoints, you must ensure that the "
13240 "innermost mountpoints have the longest pathnames, as in the example code "
13245 #: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3088
13246 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13250 #: ../src/guestfs-actions.pod:4553
13252 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13253 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13254 "can also trigger these issues."
13258 #: ../src/guestfs-actions.pod:4559 ../src/guestfs-actions.pod:4825 ../src/guestfs-actions.pod:5744
13259 msgid "(Added in 1.0.62)"
13263 #: ../src/guestfs-actions.pod:4561
13264 msgid "guestfs_mknod"
13268 #: ../src/guestfs-actions.pod:4563
13272 " guestfs_mknod (guestfs_h *g,\n"
13276 " const char *path);\n"
13281 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3098
13283 "This call creates block or character special devices, or named pipes "
13288 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3101
13290 "The C<mode> parameter should be the mode, using the standard constants. "
13291 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13292 "used when creating block and character special devices."
13296 #: ../src/guestfs-actions.pod:4578
13298 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13299 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13300 "regular file). These constants are available in the standard Linux header "
13301 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13302 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13303 "the appropriate constant for you."
13307 #: ../src/guestfs-actions.pod:4592
13308 msgid "guestfs_mknod_b"
13312 #: ../src/guestfs-actions.pod:4594
13316 " guestfs_mknod_b (guestfs_h *g,\n"
13320 " const char *path);\n"
13325 #: ../src/guestfs-actions.pod:4601
13327 "This call creates a block device node called C<path> with mode C<mode> and "
13328 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13329 "wrapper around C<guestfs_mknod>."
13333 #: ../src/guestfs-actions.pod:4611
13334 msgid "guestfs_mknod_c"
13338 #: ../src/guestfs-actions.pod:4613
13342 " guestfs_mknod_c (guestfs_h *g,\n"
13346 " const char *path);\n"
13351 #: ../src/guestfs-actions.pod:4620
13353 "This call creates a char device node called C<path> with mode C<mode> and "
13354 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13355 "wrapper around C<guestfs_mknod>."
13359 #: ../src/guestfs-actions.pod:4630
13360 msgid "guestfs_mkswap"
13364 #: ../src/guestfs-actions.pod:4632
13368 " guestfs_mkswap (guestfs_h *g,\n"
13369 " const char *device);\n"
13374 #: ../src/guestfs-actions.pod:4636 ../fish/guestfish-actions.pod:3140
13375 msgid "Create a swap partition on C<device>."
13379 #: ../src/guestfs-actions.pod:4642
13380 msgid "guestfs_mkswap_L"
13384 #: ../src/guestfs-actions.pod:4644
13388 " guestfs_mkswap_L (guestfs_h *g,\n"
13389 " const char *label,\n"
13390 " const char *device);\n"
13395 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3146
13396 msgid "Create a swap partition on C<device> with label C<label>."
13400 #: ../src/guestfs-actions.pod:4651 ../fish/guestfish-actions.pod:3148
13402 "Note that you cannot attach a swap label to a block device "
13403 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13404 "the kernel or swap tools."
13408 #: ../src/guestfs-actions.pod:4659
13409 msgid "guestfs_mkswap_U"
13413 #: ../src/guestfs-actions.pod:4661
13417 " guestfs_mkswap_U (guestfs_h *g,\n"
13418 " const char *uuid,\n"
13419 " const char *device);\n"
13424 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3156
13425 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13429 #: ../src/guestfs-actions.pod:4672
13430 msgid "guestfs_mkswap_file"
13434 #: ../src/guestfs-actions.pod:4674
13438 " guestfs_mkswap_file (guestfs_h *g,\n"
13439 " const char *path);\n"
13444 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3162
13445 msgid "Create a swap file."
13449 #: ../src/guestfs-actions.pod:4680
13451 "This command just writes a swap file signature to an existing file. To "
13452 "create the file itself, use something like C<guestfs_fallocate>."
13456 #: ../src/guestfs-actions.pod:4687
13457 msgid "guestfs_modprobe"
13461 #: ../src/guestfs-actions.pod:4689
13465 " guestfs_modprobe (guestfs_h *g,\n"
13466 " const char *modulename);\n"
13471 #: ../src/guestfs-actions.pod:4693 ../fish/guestfish-actions.pod:3171
13472 msgid "This loads a kernel module in the appliance."
13476 #: ../src/guestfs-actions.pod:4695 ../fish/guestfish-actions.pod:3173
13478 "The kernel module must have been whitelisted when libguestfs was built (see "
13479 "C<appliance/kmod.whitelist.in> in the source)."
13483 #: ../src/guestfs-actions.pod:4702
13484 msgid "guestfs_mount"
13488 #: ../src/guestfs-actions.pod:4704
13492 " guestfs_mount (guestfs_h *g,\n"
13493 " const char *device,\n"
13494 " const char *mountpoint);\n"
13499 #: ../src/guestfs-actions.pod:4709 ../fish/guestfish-actions.pod:3180
13501 "Mount a guest disk at a position in the filesystem. Block devices are named "
13502 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13503 "those block devices contain partitions, they will have the usual names "
13504 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13508 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3186
13510 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13511 "mounted on C</> before others can be mounted. Other filesystems can only be "
13512 "mounted on directories which already exist."
13516 #: ../src/guestfs-actions.pod:4720 ../fish/guestfish-actions.pod:3191
13518 "The mounted filesystem is writable, if we have sufficient permissions on the "
13519 "underlying device."
13523 #: ../src/guestfs-actions.pod:4723
13525 "B<Important note:> When you use this call, the filesystem options C<sync> "
13526 "and C<noatime> are set implicitly. This was originally done because we "
13527 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13528 "very large negative performance impact and negligible effect on "
13529 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13530 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13531 "(use an empty string for the first parameter if you don't want any options)."
13535 #: ../src/guestfs-actions.pod:4735
13537 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
13542 #: ../src/guestfs-actions.pod:4744
13543 msgid "guestfs_mount_loop"
13547 #: ../src/guestfs-actions.pod:4746
13551 " guestfs_mount_loop (guestfs_h *g,\n"
13552 " const char *file,\n"
13553 " const char *mountpoint);\n"
13558 #: ../src/guestfs-actions.pod:4751 ../fish/guestfish-actions.pod:3215
13560 "This command lets you mount C<file> (a filesystem image in a file) on a "
13561 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13566 #: ../src/guestfs-actions.pod:4759
13567 msgid "guestfs_mount_options"
13571 #: ../src/guestfs-actions.pod:4761
13575 " guestfs_mount_options (guestfs_h *g,\n"
13576 " const char *options,\n"
13577 " const char *device,\n"
13578 " const char *mountpoint);\n"
13583 #: ../src/guestfs-actions.pod:4767
13585 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13586 "the mount options as for the L<mount(8)> I<-o> flag."
13590 #: ../src/guestfs-actions.pod:4771 ../fish/guestfish-actions.pod:3227
13592 "If the C<options> parameter is an empty string, then no options are passed "
13593 "(all options default to whatever the filesystem uses)."
13597 #: ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4791 ../src/guestfs-actions.pod:4808
13598 msgid "(Added in 1.0.10)"
13602 #: ../src/guestfs-actions.pod:4779
13603 msgid "guestfs_mount_ro"
13607 #: ../src/guestfs-actions.pod:4781
13611 " guestfs_mount_ro (guestfs_h *g,\n"
13612 " const char *device,\n"
13613 " const char *mountpoint);\n"
13618 #: ../src/guestfs-actions.pod:4786
13620 "This is the same as the C<guestfs_mount> command, but it mounts the "
13621 "filesystem with the read-only (I<-o ro>) flag."
13625 #: ../src/guestfs-actions.pod:4793
13626 msgid "guestfs_mount_vfs"
13630 #: ../src/guestfs-actions.pod:4795
13634 " guestfs_mount_vfs (guestfs_h *g,\n"
13635 " const char *options,\n"
13636 " const char *vfstype,\n"
13637 " const char *device,\n"
13638 " const char *mountpoint);\n"
13643 #: ../src/guestfs-actions.pod:4802
13645 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13646 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13651 #: ../src/guestfs-actions.pod:4810
13652 msgid "guestfs_mountpoints"
13656 #: ../src/guestfs-actions.pod:4812
13660 " guestfs_mountpoints (guestfs_h *g);\n"
13665 #: ../src/guestfs-actions.pod:4815
13667 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13668 "devices. This one returns a hash table (map) of device name to directory "
13669 "where the device is mounted."
13673 #: ../src/guestfs-actions.pod:4827
13674 msgid "guestfs_mounts"
13678 #: ../src/guestfs-actions.pod:4829
13682 " guestfs_mounts (guestfs_h *g);\n"
13687 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3258
13689 "This returns the list of currently mounted filesystems. It returns the list "
13690 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13694 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3261
13695 msgid "Some internal mounts are not shown."
13699 #: ../src/guestfs-actions.pod:4837
13700 msgid "See also: C<guestfs_mountpoints>"
13704 #: ../src/guestfs-actions.pod:4845
13709 #: ../src/guestfs-actions.pod:4847
13713 " guestfs_mv (guestfs_h *g,\n"
13714 " const char *src,\n"
13715 " const char *dest);\n"
13720 #: ../src/guestfs-actions.pod:4852 ../fish/guestfish-actions.pod:3269
13722 "This moves a file from C<src> to C<dest> where C<dest> is either a "
13723 "destination filename or destination directory."
13727 #: ../src/guestfs-actions.pod:4859
13728 msgid "guestfs_ntfs_3g_probe"
13732 #: ../src/guestfs-actions.pod:4861
13736 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
13738 " const char *device);\n"
13743 #: ../src/guestfs-actions.pod:4866 ../fish/guestfish-actions.pod:3276
13745 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
13746 "C<device> for mountability. (Not all NTFS volumes can be mounted "
13747 "read-write, and some cannot be mounted at all)."
13751 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3280
13753 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
13754 "can be mounted read-write. Set it to false if you want to test if the "
13755 "volume can be mounted read-only."
13759 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3284
13761 "The return value is an integer which C<0> if the operation would succeed, or "
13762 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
13766 #: ../src/guestfs-actions.pod:4880
13767 msgid "(Added in 1.0.43)"
13771 #: ../src/guestfs-actions.pod:4882
13772 msgid "guestfs_ntfsresize"
13776 #: ../src/guestfs-actions.pod:4884
13780 " guestfs_ntfsresize (guestfs_h *g,\n"
13781 " const char *device);\n"
13786 #: ../src/guestfs-actions.pod:4888 ../fish/guestfish-actions.pod:3292
13788 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
13789 "size of the underlying device."
13793 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3295
13795 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
13796 "consistency check (for safety). You have to boot into Windows to perform "
13797 "this check and clear this condition. Furthermore, ntfsresize refuses to "
13798 "resize filesystems which have been marked in this way. So in effect it is "
13799 "not possible to call ntfsresize multiple times on a single filesystem "
13800 "without booting into Windows between each resize."
13804 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3303
13805 msgid "See also L<ntfsresize(8)>."
13809 #: ../src/guestfs-actions.pod:4905
13810 msgid "guestfs_ntfsresize_size"
13814 #: ../src/guestfs-actions.pod:4907
13818 " guestfs_ntfsresize_size (guestfs_h *g,\n"
13819 " const char *device,\n"
13820 " int64_t size);\n"
13825 #: ../src/guestfs-actions.pod:4912
13827 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
13828 "to specify the new size (in bytes) explicitly."
13832 #: ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:7298
13833 msgid "(Added in 1.3.14)"
13837 #: ../src/guestfs-actions.pod:4919
13838 msgid "guestfs_part_add"
13842 #: ../src/guestfs-actions.pod:4921
13846 " guestfs_part_add (guestfs_h *g,\n"
13847 " const char *device,\n"
13848 " const char *prlogex,\n"
13849 " int64_t startsect,\n"
13850 " int64_t endsect);\n"
13855 #: ../src/guestfs-actions.pod:4928
13857 "This command adds a partition to C<device>. If there is no partition table "
13858 "on the device, call C<guestfs_part_init> first."
13862 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3319
13864 "The C<prlogex> parameter is the type of partition. Normally you should pass "
13865 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
13866 "C<logical>) and C<e> (or C<extended>) partition types."
13870 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3324
13872 "C<startsect> and C<endsect> are the start and end of the partition in "
13873 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
13874 "from the end of the disk (C<-1> is the last sector)."
13878 #: ../src/guestfs-actions.pod:4940
13880 "Creating a partition which covers the whole disk is not so easy. Use "
13881 "C<guestfs_part_disk> to do that."
13885 #: ../src/guestfs-actions.pod:4945 ../src/guestfs-actions.pod:4983 ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5114 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5171 ../src/guestfs-actions.pod:5211
13886 msgid "(Added in 1.0.78)"
13890 #: ../src/guestfs-actions.pod:4947
13891 msgid "guestfs_part_del"
13895 #: ../src/guestfs-actions.pod:4949
13899 " guestfs_part_del (guestfs_h *g,\n"
13900 " const char *device,\n"
13906 #: ../src/guestfs-actions.pod:4954 ../fish/guestfish-actions.pod:3335
13907 msgid "This command deletes the partition numbered C<partnum> on C<device>."
13911 #: ../src/guestfs-actions.pod:4956 ../fish/guestfish-actions.pod:3337
13913 "Note that in the case of MBR partitioning, deleting an extended partition "
13914 "also deletes any logical partitions it contains."
13918 #: ../src/guestfs-actions.pod:4964
13919 msgid "guestfs_part_disk"
13923 #: ../src/guestfs-actions.pod:4966
13927 " guestfs_part_disk (guestfs_h *g,\n"
13928 " const char *device,\n"
13929 " const char *parttype);\n"
13934 #: ../src/guestfs-actions.pod:4971
13936 "This command is simply a combination of C<guestfs_part_init> followed by "
13937 "C<guestfs_part_add> to create a single primary partition covering the whole "
13942 #: ../src/guestfs-actions.pod:4975
13944 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
13945 "possible values are described in C<guestfs_part_init>."
13949 #: ../src/guestfs-actions.pod:4985
13950 msgid "guestfs_part_get_bootable"
13954 #: ../src/guestfs-actions.pod:4987
13958 " guestfs_part_get_bootable (guestfs_h *g,\n"
13959 " const char *device,\n"
13965 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3359
13967 "This command returns true if the partition C<partnum> on C<device> has the "
13968 "bootable flag set."
13972 #: ../src/guestfs-actions.pod:4995
13973 msgid "See also C<guestfs_part_set_bootable>."
13977 #: ../src/guestfs-actions.pod:5001
13978 msgid "guestfs_part_get_mbr_id"
13982 #: ../src/guestfs-actions.pod:5003
13986 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
13987 " const char *device,\n"
13993 #: ../src/guestfs-actions.pod:5008 ../fish/guestfish-actions.pod:3368
13995 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13996 "partition C<partnum>."
14000 #: ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5187
14002 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14003 "undefined results for other partition table types (see "
14004 "C<guestfs_part_get_parttype>)."
14008 #: ../src/guestfs-actions.pod:5019
14009 msgid "guestfs_part_get_parttype"
14013 #: ../src/guestfs-actions.pod:5021
14017 " guestfs_part_get_parttype (guestfs_h *g,\n"
14018 " const char *device);\n"
14023 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3379
14025 "This command examines the partition table on C<device> and returns the "
14026 "partition table type (format) being used."
14030 #: ../src/guestfs-actions.pod:5028
14032 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14033 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14034 "possible, although unusual. See C<guestfs_part_init> for a full list."
14038 #: ../src/guestfs-actions.pod:5038
14039 msgid "guestfs_part_init"
14043 #: ../src/guestfs-actions.pod:5040
14047 " guestfs_part_init (guestfs_h *g,\n"
14048 " const char *device,\n"
14049 " const char *parttype);\n"
14054 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3391
14056 "This creates an empty partition table on C<device> of one of the partition "
14057 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14058 "(for large disks)."
14062 #: ../src/guestfs-actions.pod:5049
14064 "Initially there are no partitions. Following this, you should call "
14065 "C<guestfs_part_add> for each partition required."
14069 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3398
14070 msgid "Possible values for C<parttype> are:"
14074 #: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3402
14075 msgid "B<efi> | B<gpt>"
14079 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3404
14080 msgid "Intel EFI / GPT partition table."
14084 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3406
14086 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14087 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14088 "the C<mbr> format."
14092 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3410
14093 msgid "B<mbr> | B<msdos>"
14097 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3412
14099 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14100 "Windows. This partition type will B<only> work for device sizes up to 2 "
14101 "TB. For large disks we recommend using C<gpt>."
14105 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3419
14106 msgid "Other partition table types that may work but are not supported include:"
14110 #: ../src/guestfs-actions.pod:5078 ../fish/guestfish-actions.pod:3424
14115 #: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3426
14116 msgid "AIX disk labels."
14120 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3428
14121 msgid "B<amiga> | B<rdb>"
14125 #: ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:3430
14126 msgid "Amiga \"Rigid Disk Block\" format."
14130 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3432
14135 #: ../src/guestfs-actions.pod:5088 ../fish/guestfish-actions.pod:3434
14136 msgid "BSD disk labels."
14140 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3436
14145 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3438
14146 msgid "DASD, used on IBM mainframes."
14150 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3440
14155 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3442
14156 msgid "MIPS/SGI volumes."
14160 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3444
14165 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3446
14166 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14170 #: ../src/guestfs-actions.pod:5102 ../fish/guestfish-actions.pod:3448
14175 #: ../src/guestfs-actions.pod:5104 ../fish/guestfish-actions.pod:3450
14176 msgid "NEC PC-98 format, common in Japan apparently."
14180 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3452
14185 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3454
14186 msgid "Sun disk labels."
14190 #: ../src/guestfs-actions.pod:5116
14191 msgid "guestfs_part_list"
14195 #: ../src/guestfs-actions.pod:5118
14198 " struct guestfs_partition_list *\n"
14199 " guestfs_part_list (guestfs_h *g,\n"
14200 " const char *device);\n"
14205 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3462
14207 "This command parses the partition table on C<device> and returns the list of "
14208 "partitions found."
14212 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3465
14213 msgid "The fields in the returned structure are:"
14217 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3469
14218 msgid "B<part_num>"
14222 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3471
14223 msgid "Partition number, counting from 1."
14227 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3473
14228 msgid "B<part_start>"
14232 #: ../src/guestfs-actions.pod:5135
14234 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14235 "the device's sector size, see C<guestfs_blockdev_getss>."
14239 #: ../src/guestfs-actions.pod:5138 ../fish/guestfish-actions.pod:3478
14240 msgid "B<part_end>"
14244 #: ../src/guestfs-actions.pod:5140 ../fish/guestfish-actions.pod:3480
14245 msgid "End of the partition in bytes."
14249 #: ../src/guestfs-actions.pod:5142 ../fish/guestfish-actions.pod:3482
14250 msgid "B<part_size>"
14254 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3484
14255 msgid "Size of the partition in bytes."
14259 #: ../src/guestfs-actions.pod:5148
14261 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14262 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14267 #: ../src/guestfs-actions.pod:5154
14268 msgid "guestfs_part_set_bootable"
14272 #: ../src/guestfs-actions.pod:5156
14276 " guestfs_part_set_bootable (guestfs_h *g,\n"
14277 " const char *device,\n"
14279 " int bootable);\n"
14284 #: ../src/guestfs-actions.pod:5162 ../fish/guestfish-actions.pod:3492
14286 "This sets the bootable flag on partition numbered C<partnum> on device "
14287 "C<device>. Note that partitions are numbered from 1."
14291 #: ../src/guestfs-actions.pod:5165 ../fish/guestfish-actions.pod:3495
14293 "The bootable flag is used by some operating systems (notably Windows) to "
14294 "determine which partition to boot from. It is by no means universally "
14299 #: ../src/guestfs-actions.pod:5173
14300 msgid "guestfs_part_set_mbr_id"
14304 #: ../src/guestfs-actions.pod:5175
14308 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14309 " const char *device,\n"
14316 #: ../src/guestfs-actions.pod:5181 ../fish/guestfish-actions.pod:3503
14318 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14319 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14320 "documentation are in fact hexadecimal numbers, but usually documented "
14321 "without any leading \"0x\" which might be confusing."
14325 #: ../src/guestfs-actions.pod:5195
14326 msgid "guestfs_part_set_name"
14330 #: ../src/guestfs-actions.pod:5197
14334 " guestfs_part_set_name (guestfs_h *g,\n"
14335 " const char *device,\n"
14337 " const char *name);\n"
14342 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3517
14344 "This sets the partition name on partition numbered C<partnum> on device "
14345 "C<device>. Note that partitions are numbered from 1."
14349 #: ../src/guestfs-actions.pod:5206 ../fish/guestfish-actions.pod:3520
14351 "The partition name can only be set on certain types of partition table. "
14352 "This works on C<gpt> but not on C<mbr> partitions."
14356 #: ../src/guestfs-actions.pod:5213
14357 msgid "guestfs_part_to_dev"
14361 #: ../src/guestfs-actions.pod:5215
14365 " guestfs_part_to_dev (guestfs_h *g,\n"
14366 " const char *partition);\n"
14371 #: ../src/guestfs-actions.pod:5219 ../fish/guestfish-actions.pod:3527
14373 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14374 "partition number, returning the device name (eg. \"/dev/sdb\")."
14378 #: ../src/guestfs-actions.pod:5223
14380 "The named partition must exist, for example as a string returned from "
14381 "C<guestfs_list_partitions>."
14385 #: ../src/guestfs-actions.pod:5231
14386 msgid "guestfs_ping_daemon"
14390 #: ../src/guestfs-actions.pod:5233
14394 " guestfs_ping_daemon (guestfs_h *g);\n"
14399 #: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:3538
14401 "This is a test probe into the guestfs daemon running inside the qemu "
14402 "subprocess. Calling this function checks that the daemon responds to the "
14403 "ping message, without affecting the daemon or attached block device(s) in "
14408 #: ../src/guestfs-actions.pod:5245
14409 msgid "guestfs_pread"
14413 #: ../src/guestfs-actions.pod:5247
14417 " guestfs_pread (guestfs_h *g,\n"
14418 " const char *path,\n"
14420 " int64_t offset,\n"
14421 " size_t *size_r);\n"
14426 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3547
14428 "This command lets you read part of a file. It reads C<count> bytes of the "
14429 "file, starting at C<offset>, from file C<path>."
14433 #: ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3550 ../fish/guestfish-actions.pod:3565
14435 "This may read fewer bytes than requested. For further details see the "
14436 "L<pread(2)> system call."
14440 #: ../src/guestfs-actions.pod:5260
14441 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14445 #: ../src/guestfs-actions.pod:5271
14446 msgid "guestfs_pread_device"
14450 #: ../src/guestfs-actions.pod:5273
14454 " guestfs_pread_device (guestfs_h *g,\n"
14455 " const char *device,\n"
14457 " int64_t offset,\n"
14458 " size_t *size_r);\n"
14463 #: ../src/guestfs-actions.pod:5280 ../fish/guestfish-actions.pod:3562
14465 "This command lets you read part of a file. It reads C<count> bytes of "
14466 "C<device>, starting at C<offset>."
14470 #: ../src/guestfs-actions.pod:5286
14471 msgid "See also C<guestfs_pread>."
14475 #: ../src/guestfs-actions.pod:5295
14476 msgid "(Added in 1.5.21)"
14480 #: ../src/guestfs-actions.pod:5297
14481 msgid "guestfs_pvcreate"
14485 #: ../src/guestfs-actions.pod:5299
14489 " guestfs_pvcreate (guestfs_h *g,\n"
14490 " const char *device);\n"
14495 #: ../src/guestfs-actions.pod:5303 ../fish/guestfish-actions.pod:3577
14497 "This creates an LVM physical volume on the named C<device>, where C<device> "
14498 "should usually be a partition name such as C</dev/sda1>."
14502 #: ../src/guestfs-actions.pod:5311
14503 msgid "guestfs_pvremove"
14507 #: ../src/guestfs-actions.pod:5313
14511 " guestfs_pvremove (guestfs_h *g,\n"
14512 " const char *device);\n"
14517 #: ../src/guestfs-actions.pod:5317 ../fish/guestfish-actions.pod:3585
14519 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14524 #: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:3588
14526 "The implementation uses the C<pvremove> command which refuses to wipe "
14527 "physical volumes that contain any volume groups, so you have to remove those "
14532 #: ../src/guestfs-actions.pod:5328
14533 msgid "guestfs_pvresize"
14537 #: ../src/guestfs-actions.pod:5330
14541 " guestfs_pvresize (guestfs_h *g,\n"
14542 " const char *device);\n"
14547 #: ../src/guestfs-actions.pod:5334 ../fish/guestfish-actions.pod:3596
14549 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14550 "the new size of the underlying device."
14554 #: ../src/guestfs-actions.pod:5341
14555 msgid "guestfs_pvresize_size"
14559 #: ../src/guestfs-actions.pod:5343
14563 " guestfs_pvresize_size (guestfs_h *g,\n"
14564 " const char *device,\n"
14565 " int64_t size);\n"
14570 #: ../src/guestfs-actions.pod:5348
14572 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14573 "specify the new size (in bytes) explicitly."
14577 #: ../src/guestfs-actions.pod:5355
14578 msgid "guestfs_pvs"
14582 #: ../src/guestfs-actions.pod:5357
14586 " guestfs_pvs (guestfs_h *g);\n"
14591 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3610
14593 "List all the physical volumes detected. This is the equivalent of the "
14594 "L<pvs(8)> command."
14598 #: ../src/guestfs-actions.pod:5363 ../fish/guestfish-actions.pod:3613
14600 "This returns a list of just the device names that contain PVs "
14601 "(eg. C</dev/sda2>)."
14605 #: ../src/guestfs-actions.pod:5366
14606 msgid "See also C<guestfs_pvs_full>."
14610 #: ../src/guestfs-actions.pod:5374
14611 msgid "guestfs_pvs_full"
14615 #: ../src/guestfs-actions.pod:5376
14618 " struct guestfs_lvm_pv_list *\n"
14619 " guestfs_pvs_full (guestfs_h *g);\n"
14624 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3622
14626 "List all the physical volumes detected. This is the equivalent of the "
14627 "L<pvs(8)> command. The \"full\" version includes all fields."
14631 #: ../src/guestfs-actions.pod:5382
14633 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14634 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14639 #: ../src/guestfs-actions.pod:5388
14640 msgid "guestfs_pvuuid"
14644 #: ../src/guestfs-actions.pod:5390
14648 " guestfs_pvuuid (guestfs_h *g,\n"
14649 " const char *device);\n"
14654 #: ../src/guestfs-actions.pod:5394 ../fish/guestfish-actions.pod:3629
14655 msgid "This command returns the UUID of the LVM PV C<device>."
14659 #: ../src/guestfs-actions.pod:5401
14660 msgid "guestfs_pwrite"
14664 #: ../src/guestfs-actions.pod:5403
14668 " guestfs_pwrite (guestfs_h *g,\n"
14669 " const char *path,\n"
14670 " const char *content,\n"
14671 " size_t content_size,\n"
14672 " int64_t offset);\n"
14677 #: ../src/guestfs-actions.pod:5410 ../fish/guestfish-actions.pod:3635
14679 "This command writes to part of a file. It writes the data buffer C<content> "
14680 "to the file C<path> starting at offset C<offset>."
14684 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3638
14686 "This command implements the L<pwrite(2)> system call, and like that system "
14687 "call it may not write the full data requested. The return value is the "
14688 "number of bytes that were actually written to the file. This could even be "
14689 "0, although short writes are unlikely for regular files in ordinary "
14694 #: ../src/guestfs-actions.pod:5419
14695 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14699 #: ../src/guestfs-actions.pod:5428
14700 msgid "guestfs_pwrite_device"
14704 #: ../src/guestfs-actions.pod:5430
14708 " guestfs_pwrite_device (guestfs_h *g,\n"
14709 " const char *device,\n"
14710 " const char *content,\n"
14711 " size_t content_size,\n"
14712 " int64_t offset);\n"
14717 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3653
14719 "This command writes to part of a device. It writes the data buffer "
14720 "C<content> to C<device> starting at offset C<offset>."
14724 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3656
14726 "This command implements the L<pwrite(2)> system call, and like that system "
14727 "call it may not write the full data requested (although short writes to disk "
14728 "devices and partitions are probably impossible with standard Linux kernels)."
14732 #: ../src/guestfs-actions.pod:5445
14733 msgid "See also C<guestfs_pwrite>."
14737 #: ../src/guestfs-actions.pod:5452
14738 msgid "(Added in 1.5.20)"
14742 #: ../src/guestfs-actions.pod:5454
14743 msgid "guestfs_read_file"
14747 #: ../src/guestfs-actions.pod:5456
14751 " guestfs_read_file (guestfs_h *g,\n"
14752 " const char *path,\n"
14753 " size_t *size_r);\n"
14758 #: ../src/guestfs-actions.pod:5461 ../fish/guestfish-actions.pod:3670
14759 msgid "This calls returns the contents of the file C<path> as a buffer."
14763 #: ../src/guestfs-actions.pod:5464
14765 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
14766 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
14767 "function is limited in the total size of file that can be handled."
14771 #: ../src/guestfs-actions.pod:5476
14772 msgid "(Added in 1.0.63)"
14776 #: ../src/guestfs-actions.pod:5478
14777 msgid "guestfs_read_lines"
14781 #: ../src/guestfs-actions.pod:5480
14785 " guestfs_read_lines (guestfs_h *g,\n"
14786 " const char *path);\n"
14791 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3687
14793 "The file contents are returned as a list of lines. Trailing C<LF> and "
14794 "C<CRLF> character sequences are I<not> returned."
14798 #: ../src/guestfs-actions.pod:5489
14800 "Note that this function cannot correctly handle binary files (specifically, "
14801 "files containing C<\\0> character which is treated as end of line). For "
14802 "those you need to use the C<guestfs_read_file> function which has a more "
14803 "complex interface."
14807 #: ../src/guestfs-actions.pod:5500
14808 msgid "guestfs_readdir"
14812 #: ../src/guestfs-actions.pod:5502
14815 " struct guestfs_dirent_list *\n"
14816 " guestfs_readdir (guestfs_h *g,\n"
14817 " const char *dir);\n"
14822 #: ../src/guestfs-actions.pod:5506 ../fish/guestfish-actions.pod:3699
14823 msgid "This returns the list of directory entries in directory C<dir>."
14827 #: ../src/guestfs-actions.pod:5508 ../fish/guestfish-actions.pod:3701
14829 "All entries in the directory are returned, including C<.> and C<..>. The "
14830 "entries are I<not> sorted, but returned in the same order as the underlying "
14835 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3705
14837 "Also this call returns basic file type information about each file. The "
14838 "C<ftyp> field will contain one of the following characters:"
14842 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3710
14847 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3712
14848 msgid "Block special"
14852 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3714
14857 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3716
14858 msgid "Char special"
14862 #: ../src/guestfs-actions.pod:5525 ../fish/guestfish-actions.pod:3718
14867 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3720
14872 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3722
14877 #: ../src/guestfs-actions.pod:5531 ../fish/guestfish-actions.pod:3724
14878 msgid "FIFO (named pipe)"
14882 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3726
14887 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3728
14888 msgid "Symbolic link"
14892 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3730
14897 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3732
14898 msgid "Regular file"
14902 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3734
14907 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3736
14912 #: ../src/guestfs-actions.pod:5545 ../fish/guestfish-actions.pod:3738
14917 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3740
14918 msgid "Unknown file type"
14922 #: ../src/guestfs-actions.pod:5549 ../fish/guestfish-actions.pod:3742
14927 #: ../src/guestfs-actions.pod:5551 ../fish/guestfish-actions.pod:3744
14928 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
14932 #: ../src/guestfs-actions.pod:5556
14934 "This function is primarily intended for use by programs. To get a simple "
14935 "list of names, use C<guestfs_ls>. To get a printable directory for human "
14936 "consumption, use C<guestfs_ll>."
14940 #: ../src/guestfs-actions.pod:5560
14942 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
14943 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
14948 #: ../src/guestfs-actions.pod:5566
14949 msgid "guestfs_readlink"
14953 #: ../src/guestfs-actions.pod:5568
14957 " guestfs_readlink (guestfs_h *g,\n"
14958 " const char *path);\n"
14963 #: ../src/guestfs-actions.pod:5572 ../fish/guestfish-actions.pod:3757
14964 msgid "This command reads the target of a symbolic link."
14968 #: ../src/guestfs-actions.pod:5579
14969 msgid "guestfs_readlinklist"
14973 #: ../src/guestfs-actions.pod:5581
14977 " guestfs_readlinklist (guestfs_h *g,\n"
14978 " const char *path,\n"
14979 " char *const *names);\n"
14984 #: ../src/guestfs-actions.pod:5586 ../fish/guestfish-actions.pod:3763
14986 "This call allows you to do a C<readlink> operation on multiple files, where "
14987 "all files are in the directory C<path>. C<names> is the list of files from "
14992 #: ../src/guestfs-actions.pod:5590 ../fish/guestfish-actions.pod:3767
14994 "On return you get a list of strings, with a one-to-one correspondence to the "
14995 "C<names> list. Each string is the value of the symbolic link."
14999 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3771
15001 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15002 "result string is the empty string C<\"\">. However the whole operation is "
15003 "completed even if there were C<readlink(2)> errors, and so you can call this "
15004 "function with names where you don't know if they are symbolic links already "
15005 "(albeit slightly less efficient)."
15009 #: ../src/guestfs-actions.pod:5601 ../fish/guestfish-actions.pod:3778
15011 "This call is intended for programs that want to efficiently list a directory "
15012 "contents without making many round-trips. Very long directory listings "
15013 "might cause the protocol message size to be exceeded, causing this call to "
15014 "fail. The caller must split up such requests into smaller groups of names."
15018 #: ../src/guestfs-actions.pod:5614
15019 msgid "guestfs_realpath"
15023 #: ../src/guestfs-actions.pod:5616
15027 " guestfs_realpath (guestfs_h *g,\n"
15028 " const char *path);\n"
15033 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:3789
15035 "Return the canonicalized absolute pathname of C<path>. The returned path "
15036 "has no C<.>, C<..> or symbolic link path elements."
15040 #: ../src/guestfs-actions.pod:5628
15041 msgid "guestfs_removexattr"
15045 #: ../src/guestfs-actions.pod:5630
15049 " guestfs_removexattr (guestfs_h *g,\n"
15050 " const char *xattr,\n"
15051 " const char *path);\n"
15056 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3796
15057 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
15061 #: ../src/guestfs-actions.pod:5638
15062 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15066 #: ../src/guestfs-actions.pod:5644
15067 msgid "guestfs_resize2fs"
15071 #: ../src/guestfs-actions.pod:5646
15075 " guestfs_resize2fs (guestfs_h *g,\n"
15076 " const char *device);\n"
15081 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3805
15083 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15084 "underlying device."
15088 #: ../src/guestfs-actions.pod:5653
15090 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15091 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15092 "sometimes gives an error about this and sometimes not. In any case, it is "
15093 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15097 #: ../src/guestfs-actions.pod:5663
15098 msgid "guestfs_resize2fs_M"
15102 #: ../src/guestfs-actions.pod:5665
15106 " guestfs_resize2fs_M (guestfs_h *g,\n"
15107 " const char *device);\n"
15112 #: ../src/guestfs-actions.pod:5669
15114 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15115 "resized to its minimum size. This works like the I<-M> option to the "
15116 "C<resize2fs> command."
15120 #: ../src/guestfs-actions.pod:5673
15122 "To get the resulting size of the filesystem you should call "
15123 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15124 "These two numbers, multiplied together, give the resulting size of the "
15125 "minimal filesystem in bytes."
15129 #: ../src/guestfs-actions.pod:5680
15130 msgid "guestfs_resize2fs_size"
15134 #: ../src/guestfs-actions.pod:5682
15138 " guestfs_resize2fs_size (guestfs_h *g,\n"
15139 " const char *device,\n"
15140 " int64_t size);\n"
15145 #: ../src/guestfs-actions.pod:5687
15147 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15148 "to specify the new size (in bytes) explicitly."
15152 #: ../src/guestfs-actions.pod:5694
15157 #: ../src/guestfs-actions.pod:5696
15161 " guestfs_rm (guestfs_h *g,\n"
15162 " const char *path);\n"
15167 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3838
15168 msgid "Remove the single file C<path>."
15172 #: ../src/guestfs-actions.pod:5706
15173 msgid "guestfs_rm_rf"
15177 #: ../src/guestfs-actions.pod:5708
15181 " guestfs_rm_rf (guestfs_h *g,\n"
15182 " const char *path);\n"
15187 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3844
15189 "Remove the file or directory C<path>, recursively removing the contents if "
15190 "its a directory. This is like the C<rm -rf> shell command."
15194 #: ../src/guestfs-actions.pod:5720
15195 msgid "guestfs_rmdir"
15199 #: ../src/guestfs-actions.pod:5722
15203 " guestfs_rmdir (guestfs_h *g,\n"
15204 " const char *path);\n"
15209 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3852
15210 msgid "Remove the single directory C<path>."
15214 #: ../src/guestfs-actions.pod:5732
15215 msgid "guestfs_rmmountpoint"
15219 #: ../src/guestfs-actions.pod:5734
15223 " guestfs_rmmountpoint (guestfs_h *g,\n"
15224 " const char *exemptpath);\n"
15229 #: ../src/guestfs-actions.pod:5738
15231 "This calls removes a mountpoint that was previously created with "
15232 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15236 #: ../src/guestfs-actions.pod:5746
15237 msgid "guestfs_scrub_device"
15241 #: ../src/guestfs-actions.pod:5748
15245 " guestfs_scrub_device (guestfs_h *g,\n"
15246 " const char *device);\n"
15251 #: ../src/guestfs-actions.pod:5752 ../fish/guestfish-actions.pod:3866
15253 "This command writes patterns over C<device> to make data retrieval more "
15258 #: ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3869 ../fish/guestfish-actions.pod:3884 ../fish/guestfish-actions.pod:3897
15260 "It is an interface to the L<scrub(1)> program. See that manual page for "
15265 #: ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5781 ../src/guestfs-actions.pod:5800
15266 msgid "(Added in 1.0.52)"
15270 #: ../src/guestfs-actions.pod:5765
15271 msgid "guestfs_scrub_file"
15275 #: ../src/guestfs-actions.pod:5767
15279 " guestfs_scrub_file (guestfs_h *g,\n"
15280 " const char *file);\n"
15285 #: ../src/guestfs-actions.pod:5771 ../fish/guestfish-actions.pod:3879
15287 "This command writes patterns over a file to make data retrieval more "
15292 #: ../src/guestfs-actions.pod:5774 ../fish/guestfish-actions.pod:3882
15293 msgid "The file is I<removed> after scrubbing."
15297 #: ../src/guestfs-actions.pod:5783
15298 msgid "guestfs_scrub_freespace"
15302 #: ../src/guestfs-actions.pod:5785
15306 " guestfs_scrub_freespace (guestfs_h *g,\n"
15307 " const char *dir);\n"
15312 #: ../src/guestfs-actions.pod:5789
15314 "This command creates the directory C<dir> and then fills it with files until "
15315 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15316 "and deletes them. The intention is to scrub any free space on the partition "
15317 "containing C<dir>."
15321 #: ../src/guestfs-actions.pod:5802
15322 msgid "guestfs_set_append"
15326 #: ../src/guestfs-actions.pod:5804
15330 " guestfs_set_append (guestfs_h *g,\n"
15331 " const char *append);\n"
15336 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3906
15338 "This function is used to add additional options to the guest kernel command "
15343 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3909
15345 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15346 "environment variable."
15350 #: ../src/guestfs-actions.pod:5814 ../fish/guestfish-actions.pod:3912
15352 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15353 "(libguestfs always adds a few of its own)."
15357 #: ../src/guestfs-actions.pod:5821
15358 msgid "guestfs_set_attach_method"
15362 #: ../src/guestfs-actions.pod:5823
15366 " guestfs_set_attach_method (guestfs_h *g,\n"
15367 " const char *attachmethod);\n"
15372 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3921
15374 "Set the method that libguestfs uses to connect to the back end guestfsd "
15375 "daemon. Possible methods are:"
15379 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3928
15381 "Launch an appliance and connect to it. This is the ordinary method and the "
15386 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3931
15387 msgid "C<unix:I<path>>"
15391 #: ../src/guestfs-actions.pod:5839 ../fish/guestfish-actions.pod:3933
15392 msgid "Connect to the Unix domain socket I<path>."
15396 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3935
15398 "This method lets you connect to an existing daemon or (using virtio-serial) "
15399 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15400 "RUNNING DAEMONS>."
15404 #: ../src/guestfs-actions.pod:5849
15405 msgid "guestfs_set_autosync"
15409 #: ../src/guestfs-actions.pod:5851
15413 " guestfs_set_autosync (guestfs_h *g,\n"
15414 " int autosync);\n"
15419 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3947
15421 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15422 "effort attempt to make filesystems consistent and synchronized when the "
15423 "handle is closed (also if the program exits without closing handles)."
15427 #: ../src/guestfs-actions.pod:5860 ../fish/guestfish-actions.pod:3952
15429 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15430 "disabled by default)."
15434 #: ../src/guestfs-actions.pod:5867
15435 msgid "guestfs_set_direct"
15439 #: ../src/guestfs-actions.pod:5869
15443 " guestfs_set_direct (guestfs_h *g,\n"
15449 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3961
15451 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15452 "passed directly through to the appliance once it is launched."
15456 #: ../src/guestfs-actions.pod:5877
15458 "One consequence of this is that log messages aren't caught by the library "
15459 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15464 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3969
15465 msgid "You probably don't want to use this unless you know what you are doing."
15469 #: ../src/guestfs-actions.pod:5884 ../fish/guestfish-actions.pod:3972
15470 msgid "The default is disabled."
15474 #: ../src/guestfs-actions.pod:5890
15475 msgid "guestfs_set_e2label"
15479 #: ../src/guestfs-actions.pod:5892
15483 " guestfs_set_e2label (guestfs_h *g,\n"
15484 " const char *device,\n"
15485 " const char *label);\n"
15490 #: ../src/guestfs-actions.pod:5897 ../fish/guestfish-actions.pod:3978
15492 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15493 "C<label>. Filesystem labels are limited to 16 characters."
15497 #: ../src/guestfs-actions.pod:5901
15499 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15500 "the existing label on a filesystem."
15504 #: ../src/guestfs-actions.pod:5908
15505 msgid "guestfs_set_e2uuid"
15509 #: ../src/guestfs-actions.pod:5910
15513 " guestfs_set_e2uuid (guestfs_h *g,\n"
15514 " const char *device,\n"
15515 " const char *uuid);\n"
15520 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3989
15522 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15523 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15524 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15528 #: ../src/guestfs-actions.pod:5920
15530 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15531 "the existing UUID of a filesystem."
15535 #: ../src/guestfs-actions.pod:5927
15536 msgid "guestfs_set_memsize"
15540 #: ../src/guestfs-actions.pod:5929
15544 " guestfs_set_memsize (guestfs_h *g,\n"
15550 #: ../src/guestfs-actions.pod:5933
15552 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15553 "This only has any effect if called before C<guestfs_launch>."
15557 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:4007
15559 "You can also change this by setting the environment variable "
15560 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15564 #: ../src/guestfs-actions.pod:5948
15565 msgid "guestfs_set_network"
15569 #: ../src/guestfs-actions.pod:5950
15573 " guestfs_set_network (guestfs_h *g,\n"
15579 #: ../src/guestfs-actions.pod:5954 ../fish/guestfish-actions.pod:4020
15581 "If C<network> is true, then the network is enabled in the libguestfs "
15582 "appliance. The default is false."
15586 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4023
15588 "This affects whether commands are able to access the network (see "
15589 "L<guestfs(3)/RUNNING COMMANDS>)."
15593 #: ../src/guestfs-actions.pod:5960
15595 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15600 #: ../src/guestfs-actions.pod:5967
15601 msgid "guestfs_set_path"
15605 #: ../src/guestfs-actions.pod:5969
15609 " guestfs_set_path (guestfs_h *g,\n"
15610 " const char *searchpath);\n"
15615 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4035
15616 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15620 #: ../src/guestfs-actions.pod:5975 ../fish/guestfish-actions.pod:4037
15622 "The default is C<$libdir/guestfs> unless overridden by setting "
15623 "C<LIBGUESTFS_PATH> environment variable."
15627 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4040
15628 msgid "Setting C<path> to C<NULL> restores the default path."
15632 #: ../src/guestfs-actions.pod:5984
15633 msgid "guestfs_set_qemu"
15637 #: ../src/guestfs-actions.pod:5986
15641 " guestfs_set_qemu (guestfs_h *g,\n"
15642 " const char *qemu);\n"
15647 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4048
15648 msgid "Set the qemu binary that we will use."
15652 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4050
15653 msgid "The default is chosen when the library was compiled by the configure script."
15657 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4053
15659 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15664 #: ../src/guestfs-actions.pod:5998 ../fish/guestfish-actions.pod:4056
15665 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15669 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4058
15671 "Note that you should call this function as early as possible after creating "
15672 "the handle. This is because some pre-launch operations depend on testing "
15673 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15674 "don't retest features, and so you might see inconsistent results. Using the "
15675 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15676 "the qemu binary at the same time as the handle is created."
15680 #: ../src/guestfs-actions.pod:6012
15681 msgid "guestfs_set_recovery_proc"
15685 #: ../src/guestfs-actions.pod:6014
15689 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15690 " int recoveryproc);\n"
15695 #: ../src/guestfs-actions.pod:6018
15697 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15698 "not create a recovery process. The purpose of the recovery process is to "
15699 "stop runaway qemu processes in the case where the main program aborts "
15704 #: ../src/guestfs-actions.pod:6023
15706 "This only has any effect if called before C<guestfs_launch>, and the default "
15711 #: ../src/guestfs-actions.pod:6026 ../fish/guestfish-actions.pod:4080
15713 "About the only time when you would want to disable this is if the main "
15714 "process will fork itself into the background (\"daemonize\" itself). In "
15715 "this case the recovery process thinks that the main program has disappeared "
15716 "and so kills qemu, which is not very helpful."
15720 #: ../src/guestfs-actions.pod:6036
15721 msgid "guestfs_set_selinux"
15725 #: ../src/guestfs-actions.pod:6038
15729 " guestfs_set_selinux (guestfs_h *g,\n"
15735 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4092
15737 "This sets the selinux flag that is passed to the appliance at boot time. "
15738 "The default is C<selinux=0> (disabled)."
15742 #: ../src/guestfs-actions.pod:6045 ../fish/guestfish-actions.pod:4095
15744 "Note that if SELinux is enabled, it is always in Permissive mode "
15745 "(C<enforcing=0>)."
15749 #: ../src/guestfs-actions.pod:6055
15750 msgid "guestfs_set_trace"
15754 #: ../src/guestfs-actions.pod:6057
15758 " guestfs_set_trace (guestfs_h *g,\n"
15764 #: ../src/guestfs-actions.pod:6061 ../fish/guestfish-actions.pod:4107
15766 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
15767 "return values are traced."
15771 #: ../src/guestfs-actions.pod:6064 ../fish/guestfish-actions.pod:4110
15773 "If you want to trace C API calls into libguestfs (and other libraries) then "
15774 "possibly a better way is to use the external ltrace(1) command."
15778 #: ../src/guestfs-actions.pod:6068 ../fish/guestfish-actions.pod:4114
15780 "Command traces are disabled unless the environment variable "
15781 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
15785 #: ../src/guestfs-actions.pod:6071
15787 "Trace messages are normally sent to C<stderr>, unless you register a "
15788 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15792 #: ../src/guestfs-actions.pod:6079
15793 msgid "guestfs_set_verbose"
15797 #: ../src/guestfs-actions.pod:6081
15801 " guestfs_set_verbose (guestfs_h *g,\n"
15807 #: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4127
15808 msgid "If C<verbose> is true, this turns on verbose messages."
15812 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4129
15814 "Verbose messages are disabled unless the environment variable "
15815 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
15819 #: ../src/guestfs-actions.pod:6090
15821 "Verbose messages are normally sent to C<stderr>, unless you register a "
15822 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15826 #: ../src/guestfs-actions.pod:6098
15827 msgid "guestfs_setcon"
15831 #: ../src/guestfs-actions.pod:6100
15835 " guestfs_setcon (guestfs_h *g,\n"
15836 " const char *context);\n"
15841 #: ../src/guestfs-actions.pod:6104 ../fish/guestfish-actions.pod:4140
15843 "This sets the SELinux security context of the daemon to the string "
15848 #: ../src/guestfs-actions.pod:6107 ../fish/guestfish-actions.pod:4143
15849 msgid "See the documentation about SELINUX in L<guestfs(3)>."
15853 #: ../src/guestfs-actions.pod:6113
15854 msgid "guestfs_setxattr"
15858 #: ../src/guestfs-actions.pod:6115
15862 " guestfs_setxattr (guestfs_h *g,\n"
15863 " const char *xattr,\n"
15864 " const char *val,\n"
15866 " const char *path);\n"
15871 #: ../src/guestfs-actions.pod:6122 ../fish/guestfish-actions.pod:4149
15873 "This call sets the extended attribute named C<xattr> of the file C<path> to "
15874 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
15878 #: ../src/guestfs-actions.pod:6126
15879 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
15883 #: ../src/guestfs-actions.pod:6132
15884 msgid "guestfs_sfdisk"
15888 #: ../src/guestfs-actions.pod:6134
15892 " guestfs_sfdisk (guestfs_h *g,\n"
15893 " const char *device,\n"
15897 " char *const *lines);\n"
15902 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4159
15904 "This is a direct interface to the L<sfdisk(8)> program for creating "
15905 "partitions on block devices."
15909 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4162
15910 msgid "C<device> should be a block device, for example C</dev/sda>."
15914 #: ../src/guestfs-actions.pod:6147 ../fish/guestfish-actions.pod:4164
15916 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
15917 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
15918 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
15919 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
15920 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
15921 "the kernel) cannot work out the right geometry and you will need to tell it."
15925 #: ../src/guestfs-actions.pod:6155 ../fish/guestfish-actions.pod:4172
15927 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
15928 "refer to the L<sfdisk(8)> manpage."
15932 #: ../src/guestfs-actions.pod:6158 ../fish/guestfish-actions.pod:4175
15934 "To create a single partition occupying the whole disk, you would pass "
15935 "C<lines> as a single element list, when the single element being the string "
15940 #: ../src/guestfs-actions.pod:6162
15941 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
15945 #: ../src/guestfs-actions.pod:6170 ../src/guestfs-actions.pod:6200 ../src/guestfs-actions.pod:6233
15947 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
15952 #: ../src/guestfs-actions.pod:6179
15953 msgid "guestfs_sfdiskM"
15957 #: ../src/guestfs-actions.pod:6181
15961 " guestfs_sfdiskM (guestfs_h *g,\n"
15962 " const char *device,\n"
15963 " char *const *lines);\n"
15968 #: ../src/guestfs-actions.pod:6186
15970 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
15971 "partition sizes are specified in megabytes only (rounded to the nearest "
15972 "cylinder) and you don't need to specify the cyls, heads and sectors "
15973 "parameters which were rarely if ever used anyway."
15977 #: ../src/guestfs-actions.pod:6192
15979 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
15980 "C<guestfs_part_disk>"
15984 #: ../src/guestfs-actions.pod:6209
15985 msgid "guestfs_sfdisk_N"
15989 #: ../src/guestfs-actions.pod:6211
15993 " guestfs_sfdisk_N (guestfs_h *g,\n"
15994 " const char *device,\n"
15999 " const char *line);\n"
16004 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4219
16006 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16007 "(note: C<n> counts from 1)."
16011 #: ../src/guestfs-actions.pod:6223
16013 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16014 "for the cyls/heads/sectors parameters."
16018 #: ../src/guestfs-actions.pod:6226
16019 msgid "See also: C<guestfs_part_add>"
16023 #: ../src/guestfs-actions.pod:6242
16024 msgid "guestfs_sfdisk_disk_geometry"
16028 #: ../src/guestfs-actions.pod:6244
16032 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16033 " const char *device);\n"
16038 #: ../src/guestfs-actions.pod:6248
16040 "This displays the disk geometry of C<device> read from the partition table. "
16041 "Especially in the case where the underlying block device has been resized, "
16042 "this can be different from the kernel's idea of the geometry (see "
16043 "C<guestfs_sfdisk_kernel_geometry>)."
16047 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4246 ../fish/guestfish-actions.pod:4255
16048 msgid "The result is in human-readable format, and not designed to be parsed."
16052 #: ../src/guestfs-actions.pod:6261
16053 msgid "guestfs_sfdisk_kernel_geometry"
16057 #: ../src/guestfs-actions.pod:6263
16061 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16062 " const char *device);\n"
16067 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4253
16068 msgid "This displays the kernel's idea of the geometry of C<device>."
16072 #: ../src/guestfs-actions.pod:6277
16073 msgid "guestfs_sfdisk_l"
16077 #: ../src/guestfs-actions.pod:6279
16081 " guestfs_sfdisk_l (guestfs_h *g,\n"
16082 " const char *device);\n"
16087 #: ../src/guestfs-actions.pod:6283 ../fish/guestfish-actions.pod:4262
16089 "This displays the partition table on C<device>, in the human-readable output "
16090 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16094 #: ../src/guestfs-actions.pod:6287
16095 msgid "See also: C<guestfs_part_list>"
16099 #: ../src/guestfs-actions.pod:6292
16101 "This function is deprecated. In new code, use the L</guestfs_part_list> "
16106 #: ../src/guestfs-actions.pod:6301
16111 #: ../src/guestfs-actions.pod:6303
16115 " guestfs_sh (guestfs_h *g,\n"
16116 " const char *command);\n"
16121 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4279
16123 "This call runs a command from the guest filesystem via the guest's "
16128 #: ../src/guestfs-actions.pod:6310
16129 msgid "This is like C<guestfs_command>, but passes the command to:"
16133 #: ../src/guestfs-actions.pod:6312 ../fish/guestfish-actions.pod:4284
16136 " /bin/sh -c \"command\"\n"
16141 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4286
16143 "Depending on the guest's shell, this usually results in wildcards being "
16144 "expanded, shell expressions being interpolated and so on."
16148 #: ../src/guestfs-actions.pod:6318
16149 msgid "All the provisos about C<guestfs_command> apply to this call."
16153 #: ../src/guestfs-actions.pod:6325
16154 msgid "guestfs_sh_lines"
16158 #: ../src/guestfs-actions.pod:6327
16162 " guestfs_sh_lines (guestfs_h *g,\n"
16163 " const char *command);\n"
16168 #: ../src/guestfs-actions.pod:6331
16170 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16175 #: ../src/guestfs-actions.pod:6334
16176 msgid "See also: C<guestfs_command_lines>"
16180 #: ../src/guestfs-actions.pod:6342
16181 msgid "guestfs_sleep"
16185 #: ../src/guestfs-actions.pod:6344
16189 " guestfs_sleep (guestfs_h *g,\n"
16195 #: ../src/guestfs-actions.pod:6348 ../fish/guestfish-actions.pod:4305
16196 msgid "Sleep for C<secs> seconds."
16200 #: ../src/guestfs-actions.pod:6352
16201 msgid "(Added in 1.0.41)"
16205 #: ../src/guestfs-actions.pod:6354 ../src/guestfs-structs.pod:109
16206 msgid "guestfs_stat"
16210 #: ../src/guestfs-actions.pod:6356
16213 " struct guestfs_stat *\n"
16214 " guestfs_stat (guestfs_h *g,\n"
16215 " const char *path);\n"
16220 #: ../src/guestfs-actions.pod:6362 ../fish/guestfish-actions.pod:4313
16221 msgid "This is the same as the C<stat(2)> system call."
16225 #: ../src/guestfs-actions.pod:6370 ../src/guestfs-structs.pod:135
16226 msgid "guestfs_statvfs"
16230 #: ../src/guestfs-actions.pod:6372
16233 " struct guestfs_statvfs *\n"
16234 " guestfs_statvfs (guestfs_h *g,\n"
16235 " const char *path);\n"
16240 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4319
16242 "Returns file system statistics for any mounted file system. C<path> should "
16243 "be a file or directory in the mounted file system (typically it is the mount "
16244 "point itself, but it doesn't need to be)."
16248 #: ../src/guestfs-actions.pod:6380 ../fish/guestfish-actions.pod:4323
16249 msgid "This is the same as the C<statvfs(2)> system call."
16253 #: ../src/guestfs-actions.pod:6382
16255 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16256 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16260 #: ../src/guestfs-actions.pod:6388
16261 msgid "guestfs_strings"
16265 #: ../src/guestfs-actions.pod:6390
16269 " guestfs_strings (guestfs_h *g,\n"
16270 " const char *path);\n"
16275 #: ../src/guestfs-actions.pod:6394 ../fish/guestfish-actions.pod:4329
16277 "This runs the L<strings(1)> command on a file and returns the list of "
16278 "printable strings found."
16282 #: ../src/guestfs-actions.pod:6406
16283 msgid "guestfs_strings_e"
16287 #: ../src/guestfs-actions.pod:6408
16291 " guestfs_strings_e (guestfs_h *g,\n"
16292 " const char *encoding,\n"
16293 " const char *path);\n"
16298 #: ../src/guestfs-actions.pod:6413
16300 "This is like the C<guestfs_strings> command, but allows you to specify the "
16301 "encoding of strings that are looked for in the source file C<path>."
16305 #: ../src/guestfs-actions.pod:6417 ../fish/guestfish-actions.pod:4343
16306 msgid "Allowed encodings are:"
16310 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4347
16315 #: ../src/guestfs-actions.pod:6423
16317 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16318 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16322 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4352
16327 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4354
16328 msgid "Single 8-bit-byte characters."
16332 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4356
16337 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4358
16338 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16342 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4361
16343 msgid "l (lower case letter L)"
16347 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4363
16349 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16350 "examining binaries in Windows guests."
16354 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4366
16359 #: ../src/guestfs-actions.pod:6442 ../fish/guestfish-actions.pod:4368
16360 msgid "32-bit big endian such as UCS-4BE."
16364 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4370
16369 #: ../src/guestfs-actions.pod:6446 ../fish/guestfish-actions.pod:4372
16370 msgid "32-bit little endian such as UCS-4LE."
16374 #: ../src/guestfs-actions.pod:6450 ../fish/guestfish-actions.pod:4376
16375 msgid "The returned strings are transcoded to UTF-8."
16379 #: ../src/guestfs-actions.pod:6461
16380 msgid "guestfs_swapoff_device"
16384 #: ../src/guestfs-actions.pod:6463
16388 " guestfs_swapoff_device (guestfs_h *g,\n"
16389 " const char *device);\n"
16394 #: ../src/guestfs-actions.pod:6467
16396 "This command disables the libguestfs appliance swap device or partition "
16397 "named C<device>. See C<guestfs_swapon_device>."
16401 #: ../src/guestfs-actions.pod:6475
16402 msgid "guestfs_swapoff_file"
16406 #: ../src/guestfs-actions.pod:6477
16410 " guestfs_swapoff_file (guestfs_h *g,\n"
16411 " const char *file);\n"
16416 #: ../src/guestfs-actions.pod:6481 ../fish/guestfish-actions.pod:4393
16417 msgid "This command disables the libguestfs appliance swap on file."
16421 #: ../src/guestfs-actions.pod:6487
16422 msgid "guestfs_swapoff_label"
16426 #: ../src/guestfs-actions.pod:6489
16430 " guestfs_swapoff_label (guestfs_h *g,\n"
16431 " const char *label);\n"
16436 #: ../src/guestfs-actions.pod:6493 ../fish/guestfish-actions.pod:4399
16438 "This command disables the libguestfs appliance swap on labeled swap "
16443 #: ../src/guestfs-actions.pod:6500
16444 msgid "guestfs_swapoff_uuid"
16448 #: ../src/guestfs-actions.pod:6502
16452 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16453 " const char *uuid);\n"
16458 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4406
16460 "This command disables the libguestfs appliance swap partition with the given "
16465 #: ../src/guestfs-actions.pod:6513
16466 msgid "guestfs_swapon_device"
16470 #: ../src/guestfs-actions.pod:6515
16474 " guestfs_swapon_device (guestfs_h *g,\n"
16475 " const char *device);\n"
16480 #: ../src/guestfs-actions.pod:6519
16482 "This command enables the libguestfs appliance to use the swap device or "
16483 "partition named C<device>. The increased memory is made available for all "
16484 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16488 #: ../src/guestfs-actions.pod:6524 ../fish/guestfish-actions.pod:4418
16490 "Note that you should not swap to existing guest swap partitions unless you "
16491 "know what you are doing. They may contain hibernation information, or other "
16492 "information that the guest doesn't want you to trash. You also risk leaking "
16493 "information about the host to the guest this way. Instead, attach a new "
16494 "host device to the guest and swap on that."
16498 #: ../src/guestfs-actions.pod:6535
16499 msgid "guestfs_swapon_file"
16503 #: ../src/guestfs-actions.pod:6537
16507 " guestfs_swapon_file (guestfs_h *g,\n"
16508 " const char *file);\n"
16513 #: ../src/guestfs-actions.pod:6541
16515 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16520 #: ../src/guestfs-actions.pod:6548
16521 msgid "guestfs_swapon_label"
16525 #: ../src/guestfs-actions.pod:6550
16529 " guestfs_swapon_label (guestfs_h *g,\n"
16530 " const char *label);\n"
16535 #: ../src/guestfs-actions.pod:6554
16537 "This command enables swap to a labeled swap partition. See "
16538 "C<guestfs_swapon_device> for other notes."
16542 #: ../src/guestfs-actions.pod:6561
16543 msgid "guestfs_swapon_uuid"
16547 #: ../src/guestfs-actions.pod:6563
16551 " guestfs_swapon_uuid (guestfs_h *g,\n"
16552 " const char *uuid);\n"
16557 #: ../src/guestfs-actions.pod:6567
16559 "This command enables swap to a swap partition with the given UUID. See "
16560 "C<guestfs_swapon_device> for other notes."
16564 #: ../src/guestfs-actions.pod:6574
16565 msgid "guestfs_sync"
16569 #: ../src/guestfs-actions.pod:6576
16573 " guestfs_sync (guestfs_h *g);\n"
16578 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4450
16580 "This syncs the disk, so that any writes are flushed through to the "
16581 "underlying disk image."
16585 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4453
16587 "You should always call this if you have modified a disk image, before "
16588 "closing the handle."
16592 #: ../src/guestfs-actions.pod:6589
16593 msgid "guestfs_tail"
16597 #: ../src/guestfs-actions.pod:6591
16601 " guestfs_tail (guestfs_h *g,\n"
16602 " const char *path);\n"
16607 #: ../src/guestfs-actions.pod:6595 ../fish/guestfish-actions.pod:4460
16608 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16612 #: ../src/guestfs-actions.pod:6607
16613 msgid "guestfs_tail_n"
16617 #: ../src/guestfs-actions.pod:6609
16621 " guestfs_tail_n (guestfs_h *g,\n"
16623 " const char *path);\n"
16628 #: ../src/guestfs-actions.pod:6614 ../fish/guestfish-actions.pod:4470
16630 "If the parameter C<nrlines> is a positive number, this returns the last "
16631 "C<nrlines> lines of the file C<path>."
16635 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4473
16637 "If the parameter C<nrlines> is a negative number, this returns lines from "
16638 "the file C<path>, starting with the C<-nrlines>th line."
16642 #: ../src/guestfs-actions.pod:6631
16643 msgid "guestfs_tar_in"
16647 #: ../src/guestfs-actions.pod:6633
16651 " guestfs_tar_in (guestfs_h *g,\n"
16652 " const char *tarfile,\n"
16653 " const char *directory);\n"
16658 #: ../src/guestfs-actions.pod:6638 ../fish/guestfish-actions.pod:4485
16660 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16661 "tar file) into C<directory>."
16665 #: ../src/guestfs-actions.pod:6641
16666 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16670 #: ../src/guestfs-actions.pod:6646 ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6695
16671 msgid "(Added in 1.0.3)"
16675 #: ../src/guestfs-actions.pod:6648
16676 msgid "guestfs_tar_out"
16680 #: ../src/guestfs-actions.pod:6650
16684 " guestfs_tar_out (guestfs_h *g,\n"
16685 " const char *directory,\n"
16686 " const char *tarfile);\n"
16691 #: ../src/guestfs-actions.pod:6655 ../fish/guestfish-actions.pod:4497
16693 "This command packs the contents of C<directory> and downloads it to local "
16698 #: ../src/guestfs-actions.pod:6658
16700 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16701 "C<guestfs_txz_out>."
16705 #: ../src/guestfs-actions.pod:6665
16706 msgid "guestfs_tgz_in"
16710 #: ../src/guestfs-actions.pod:6667
16714 " guestfs_tgz_in (guestfs_h *g,\n"
16715 " const char *tarball,\n"
16716 " const char *directory);\n"
16721 #: ../src/guestfs-actions.pod:6672 ../fish/guestfish-actions.pod:4509
16723 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
16724 "tar file) into C<directory>."
16728 #: ../src/guestfs-actions.pod:6675
16729 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
16733 #: ../src/guestfs-actions.pod:6681
16734 msgid "guestfs_tgz_out"
16738 #: ../src/guestfs-actions.pod:6683
16742 " guestfs_tgz_out (guestfs_h *g,\n"
16743 " const char *directory,\n"
16744 " const char *tarball);\n"
16749 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4520
16751 "This command packs the contents of C<directory> and downloads it to local "
16756 #: ../src/guestfs-actions.pod:6691
16757 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
16761 #: ../src/guestfs-actions.pod:6697
16762 msgid "guestfs_touch"
16766 #: ../src/guestfs-actions.pod:6699
16770 " guestfs_touch (guestfs_h *g,\n"
16771 " const char *path);\n"
16776 #: ../src/guestfs-actions.pod:6703 ../fish/guestfish-actions.pod:4531
16778 "Touch acts like the L<touch(1)> command. It can be used to update the "
16779 "timestamps on a file, or, if the file does not exist, to create a new "
16780 "zero-length file."
16784 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4535
16786 "This command only works on regular files, and will fail on other file types "
16787 "such as directories, symbolic links, block special etc."
16791 #: ../src/guestfs-actions.pod:6714
16792 msgid "guestfs_truncate"
16796 #: ../src/guestfs-actions.pod:6716
16800 " guestfs_truncate (guestfs_h *g,\n"
16801 " const char *path);\n"
16806 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4542
16808 "This command truncates C<path> to a zero-length file. The file must exist "
16813 #: ../src/guestfs-actions.pod:6727
16814 msgid "guestfs_truncate_size"
16818 #: ../src/guestfs-actions.pod:6729
16822 " guestfs_truncate_size (guestfs_h *g,\n"
16823 " const char *path,\n"
16824 " int64_t size);\n"
16829 #: ../src/guestfs-actions.pod:6734 ../fish/guestfish-actions.pod:4549
16831 "This command truncates C<path> to size C<size> bytes. The file must exist "
16836 #: ../src/guestfs-actions.pod:6737
16838 "If the current file size is less than C<size> then the file is extended to "
16839 "the required size with zero bytes. This creates a sparse file (ie. disk "
16840 "blocks are not allocated for the file until you write to it). To create a "
16841 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
16845 #: ../src/guestfs-actions.pod:6747
16846 msgid "guestfs_tune2fs_l"
16850 #: ../src/guestfs-actions.pod:6749
16854 " guestfs_tune2fs_l (guestfs_h *g,\n"
16855 " const char *device);\n"
16860 #: ../src/guestfs-actions.pod:6753 ../fish/guestfish-actions.pod:4562
16862 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
16867 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4565
16869 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
16870 "for more details. The list of fields returned isn't clearly defined, and "
16871 "depends on both the version of C<tune2fs> that libguestfs was built against, "
16872 "and the filesystem itself."
16876 #: ../src/guestfs-actions.pod:6769
16877 msgid "guestfs_txz_in"
16881 #: ../src/guestfs-actions.pod:6771
16885 " guestfs_txz_in (guestfs_h *g,\n"
16886 " const char *tarball,\n"
16887 " const char *directory);\n"
16892 #: ../src/guestfs-actions.pod:6776 ../fish/guestfish-actions.pod:4574
16894 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
16895 "tar file) into C<directory>."
16899 #: ../src/guestfs-actions.pod:6783
16900 msgid "guestfs_txz_out"
16904 #: ../src/guestfs-actions.pod:6785
16908 " guestfs_txz_out (guestfs_h *g,\n"
16909 " const char *directory,\n"
16910 " const char *tarball);\n"
16915 #: ../src/guestfs-actions.pod:6790 ../fish/guestfish-actions.pod:4583
16917 "This command packs the contents of C<directory> and downloads it to local "
16918 "file C<tarball> (as an xz compressed tar archive)."
16922 #: ../src/guestfs-actions.pod:6797
16923 msgid "guestfs_umask"
16927 #: ../src/guestfs-actions.pod:6799
16931 " guestfs_umask (guestfs_h *g,\n"
16937 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4592
16939 "This function sets the mask used for creating new files and device nodes to "
16944 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4595
16946 "Typical umask values would be C<022> which creates new files with "
16947 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
16948 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
16952 #: ../src/guestfs-actions.pod:6811 ../fish/guestfish-actions.pod:4600
16954 "The default umask is C<022>. This is important because it means that "
16955 "directories and device nodes will be created with C<0644> or C<0755> mode "
16956 "even if you specify C<0777>."
16960 #: ../src/guestfs-actions.pod:6815
16962 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
16963 "C<guestfs_mkdir>."
16967 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4607
16968 msgid "This call returns the previous umask."
16972 #: ../src/guestfs-actions.pod:6824
16973 msgid "guestfs_umount"
16977 #: ../src/guestfs-actions.pod:6826
16981 " guestfs_umount (guestfs_h *g,\n"
16982 " const char *pathordevice);\n"
16987 #: ../src/guestfs-actions.pod:6830 ../fish/guestfish-actions.pod:4615
16989 "This unmounts the given filesystem. The filesystem may be specified either "
16990 "by its mountpoint (path) or the device which contains the filesystem."
16994 #: ../src/guestfs-actions.pod:6838
16995 msgid "guestfs_umount_all"
16999 #: ../src/guestfs-actions.pod:6840
17003 " guestfs_umount_all (guestfs_h *g);\n"
17008 #: ../src/guestfs-actions.pod:6843 ../fish/guestfish-actions.pod:4625
17009 msgid "This unmounts all mounted filesystems."
17013 #: ../src/guestfs-actions.pod:6845 ../fish/guestfish-actions.pod:4627
17014 msgid "Some internal mounts are not unmounted by this call."
17018 #: ../src/guestfs-actions.pod:6851
17019 msgid "guestfs_upload"
17023 #: ../src/guestfs-actions.pod:6853
17027 " guestfs_upload (guestfs_h *g,\n"
17028 " const char *filename,\n"
17029 " const char *remotefilename);\n"
17034 #: ../src/guestfs-actions.pod:6858 ../src/guestfs-actions.pod:6882 ../fish/guestfish-actions.pod:4633 ../fish/guestfish-actions.pod:4646
17035 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17039 #: ../src/guestfs-actions.pod:6863
17040 msgid "See also C<guestfs_download>."
17044 #: ../src/guestfs-actions.pod:6874
17045 msgid "guestfs_upload_offset"
17049 #: ../src/guestfs-actions.pod:6876
17053 " guestfs_upload_offset (guestfs_h *g,\n"
17054 " const char *filename,\n"
17055 " const char *remotefilename,\n"
17056 " int64_t offset);\n"
17061 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4649
17063 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17064 "The intention is to overwrite parts of existing files or devices, although "
17065 "if a non-existant file is specified then it is created with a \"hole\" "
17066 "before C<offset>. The size of the data written is implicit in the size of "
17067 "the source C<filename>."
17071 #: ../src/guestfs-actions.pod:6892
17073 "Note that there is no limit on the amount of data that can be uploaded with "
17074 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17075 "full amount unless an error occurs."
17079 #: ../src/guestfs-actions.pod:6897
17080 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17084 #: ../src/guestfs-actions.pod:6908
17085 msgid "guestfs_utimens"
17089 #: ../src/guestfs-actions.pod:6910
17093 " guestfs_utimens (guestfs_h *g,\n"
17094 " const char *path,\n"
17095 " int64_t atsecs,\n"
17096 " int64_t atnsecs,\n"
17097 " int64_t mtsecs,\n"
17098 " int64_t mtnsecs);\n"
17103 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4669
17104 msgid "This command sets the timestamps of a file with nanosecond precision."
17108 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4672
17110 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17115 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4675
17117 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17118 "nanoseconds from the epoch."
17122 #: ../src/guestfs-actions.pod:6927 ../fish/guestfish-actions.pod:4678
17124 "If the C<*nsecs> field contains the special value C<-1> then the "
17125 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17126 "ignored in this case)."
17130 #: ../src/guestfs-actions.pod:6931 ../fish/guestfish-actions.pod:4682
17132 "If the C<*nsecs> field contains the special value C<-2> then the "
17133 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17138 #: ../src/guestfs-actions.pod:6939 ../src/guestfs-structs.pod:175
17139 msgid "guestfs_version"
17143 #: ../src/guestfs-actions.pod:6941
17146 " struct guestfs_version *\n"
17147 " guestfs_version (guestfs_h *g);\n"
17152 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4690
17153 msgid "Return the libguestfs version number that the program is linked against."
17157 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4693
17159 "Note that because of dynamic linking this is not necessarily the version of "
17160 "libguestfs that you compiled against. You can compile the program, and then "
17161 "at runtime dynamically link against a completely different C<libguestfs.so> "
17166 #: ../src/guestfs-actions.pod:6952 ../fish/guestfish-actions.pod:4698
17168 "This call was added in version C<1.0.58>. In previous versions of "
17169 "libguestfs there was no way to get the version number. From C code you can "
17170 "use dynamic linker functions to find out if this symbol exists (if it "
17171 "doesn't, then it's an earlier version)."
17175 #: ../src/guestfs-actions.pod:6958 ../fish/guestfish-actions.pod:4704
17177 "The call returns a structure with four elements. The first three (C<major>, "
17178 "C<minor> and C<release>) are numbers and correspond to the usual version "
17179 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17180 "but may be used for distro-specific information."
17184 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4710
17185 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
17189 #: ../src/guestfs-actions.pod:6967 ../fish/guestfish-actions.pod:4713
17190 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17194 #: ../src/guestfs-actions.pod:6969
17196 "I<Note:> Don't use this call to test for availability of features. In "
17197 "enterprise distributions we backport features from later versions into "
17198 "earlier versions, making this an unreliable way to test for features. Use "
17199 "C<guestfs_available> instead."
17203 #: ../src/guestfs-actions.pod:6975
17205 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17206 "error. I<The caller must call C<guestfs_free_version> after use>."
17210 #: ../src/guestfs-actions.pod:6979
17211 msgid "(Added in 1.0.58)"
17215 #: ../src/guestfs-actions.pod:6981
17216 msgid "guestfs_vfs_label"
17220 #: ../src/guestfs-actions.pod:6983
17224 " guestfs_vfs_label (guestfs_h *g,\n"
17225 " const char *device);\n"
17230 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4725
17231 msgid "This returns the filesystem label of the filesystem on C<device>."
17235 #: ../src/guestfs-actions.pod:6990 ../fish/guestfish-actions.pod:4728
17236 msgid "If the filesystem is unlabeled, this returns the empty string."
17240 #: ../src/guestfs-actions.pod:6992
17241 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17245 #: ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7034
17246 msgid "(Added in 1.3.18)"
17250 #: ../src/guestfs-actions.pod:6999
17251 msgid "guestfs_vfs_type"
17255 #: ../src/guestfs-actions.pod:7001
17259 " guestfs_vfs_type (guestfs_h *g,\n"
17260 " const char *device);\n"
17265 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4736
17267 "This command gets the filesystem type corresponding to the filesystem on "
17272 #: ../src/guestfs-actions.pod:7008 ../fish/guestfish-actions.pod:4739
17274 "For most filesystems, the result is the name of the Linux VFS module which "
17275 "would be used to mount this filesystem if you mounted it without specifying "
17276 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17280 #: ../src/guestfs-actions.pod:7018
17281 msgid "guestfs_vfs_uuid"
17285 #: ../src/guestfs-actions.pod:7020
17289 " guestfs_vfs_uuid (guestfs_h *g,\n"
17290 " const char *device);\n"
17295 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4748
17296 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17300 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4751
17301 msgid "If the filesystem does not have a UUID, this returns the empty string."
17305 #: ../src/guestfs-actions.pod:7029
17306 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17310 #: ../src/guestfs-actions.pod:7036
17311 msgid "guestfs_vg_activate"
17315 #: ../src/guestfs-actions.pod:7038
17319 " guestfs_vg_activate (guestfs_h *g,\n"
17321 " char *const *volgroups);\n"
17326 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4759
17328 "This command activates or (if C<activate> is false) deactivates all logical "
17329 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17330 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17331 "deactivated, then those devices disappear."
17335 #: ../src/guestfs-actions.pod:7049 ../fish/guestfish-actions.pod:4765
17336 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17340 #: ../src/guestfs-actions.pod:7051 ../fish/guestfish-actions.pod:4767
17342 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17343 "activated or deactivated."
17347 #: ../src/guestfs-actions.pod:7058
17348 msgid "guestfs_vg_activate_all"
17352 #: ../src/guestfs-actions.pod:7060
17356 " guestfs_vg_activate_all (guestfs_h *g,\n"
17357 " int activate);\n"
17362 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4774
17364 "This command activates or (if C<activate> is false) deactivates all logical "
17365 "volumes in all volume groups. If activated, then they are made known to the "
17366 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17367 "those devices disappear."
17371 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4780
17372 msgid "This command is the same as running C<vgchange -a y|n>"
17376 #: ../src/guestfs-actions.pod:7076
17377 msgid "guestfs_vgcreate"
17381 #: ../src/guestfs-actions.pod:7078
17385 " guestfs_vgcreate (guestfs_h *g,\n"
17386 " const char *volgroup,\n"
17387 " char *const *physvols);\n"
17392 #: ../src/guestfs-actions.pod:7083 ../fish/guestfish-actions.pod:4786
17394 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17395 "of physical volumes C<physvols>."
17399 #: ../src/guestfs-actions.pod:7090
17400 msgid "guestfs_vglvuuids"
17404 #: ../src/guestfs-actions.pod:7092
17408 " guestfs_vglvuuids (guestfs_h *g,\n"
17409 " const char *vgname);\n"
17414 #: ../src/guestfs-actions.pod:7096 ../fish/guestfish-actions.pod:4793
17416 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17417 "volumes created in this volume group."
17421 #: ../src/guestfs-actions.pod:7099
17423 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17424 "associate logical volumes and volume groups."
17428 #: ../src/guestfs-actions.pod:7102
17429 msgid "See also C<guestfs_vgpvuuids>."
17433 #: ../src/guestfs-actions.pod:7110
17434 msgid "guestfs_vgpvuuids"
17438 #: ../src/guestfs-actions.pod:7112
17442 " guestfs_vgpvuuids (guestfs_h *g,\n"
17443 " const char *vgname);\n"
17448 #: ../src/guestfs-actions.pod:7116 ../fish/guestfish-actions.pod:4805
17450 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17451 "volumes that this volume group resides on."
17455 #: ../src/guestfs-actions.pod:7119
17457 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17458 "associate physical volumes and volume groups."
17462 #: ../src/guestfs-actions.pod:7122
17463 msgid "See also C<guestfs_vglvuuids>."
17467 #: ../src/guestfs-actions.pod:7130
17468 msgid "guestfs_vgremove"
17472 #: ../src/guestfs-actions.pod:7132
17476 " guestfs_vgremove (guestfs_h *g,\n"
17477 " const char *vgname);\n"
17482 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4817
17483 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17487 #: ../src/guestfs-actions.pod:7138 ../fish/guestfish-actions.pod:4819
17488 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17492 #: ../src/guestfs-actions.pod:7145
17493 msgid "guestfs_vgrename"
17497 #: ../src/guestfs-actions.pod:7147
17501 " guestfs_vgrename (guestfs_h *g,\n"
17502 " const char *volgroup,\n"
17503 " const char *newvolgroup);\n"
17508 #: ../src/guestfs-actions.pod:7152 ../fish/guestfish-actions.pod:4826
17509 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17513 #: ../src/guestfs-actions.pod:7158
17514 msgid "guestfs_vgs"
17518 #: ../src/guestfs-actions.pod:7160
17522 " guestfs_vgs (guestfs_h *g);\n"
17527 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4832
17529 "List all the volumes groups detected. This is the equivalent of the "
17530 "L<vgs(8)> command."
17534 #: ../src/guestfs-actions.pod:7166 ../fish/guestfish-actions.pod:4835
17536 "This returns a list of just the volume group names that were detected "
17537 "(eg. C<VolGroup00>)."
17541 #: ../src/guestfs-actions.pod:7169
17542 msgid "See also C<guestfs_vgs_full>."
17546 #: ../src/guestfs-actions.pod:7177
17547 msgid "guestfs_vgs_full"
17551 #: ../src/guestfs-actions.pod:7179
17554 " struct guestfs_lvm_vg_list *\n"
17555 " guestfs_vgs_full (guestfs_h *g);\n"
17560 #: ../src/guestfs-actions.pod:7182 ../fish/guestfish-actions.pod:4844
17562 "List all the volumes groups detected. This is the equivalent of the "
17563 "L<vgs(8)> command. The \"full\" version includes all fields."
17567 #: ../src/guestfs-actions.pod:7185
17569 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17570 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17575 #: ../src/guestfs-actions.pod:7191
17576 msgid "guestfs_vgscan"
17580 #: ../src/guestfs-actions.pod:7193
17584 " guestfs_vgscan (guestfs_h *g);\n"
17589 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4851
17591 "This rescans all block devices and rebuilds the list of LVM physical "
17592 "volumes, volume groups and logical volumes."
17596 #: ../src/guestfs-actions.pod:7203
17597 msgid "guestfs_vguuid"
17601 #: ../src/guestfs-actions.pod:7205
17605 " guestfs_vguuid (guestfs_h *g,\n"
17606 " const char *vgname);\n"
17611 #: ../src/guestfs-actions.pod:7209 ../fish/guestfish-actions.pod:4858
17612 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17616 #: ../src/guestfs-actions.pod:7216
17617 msgid "guestfs_wait_ready"
17621 #: ../src/guestfs-actions.pod:7218
17625 " guestfs_wait_ready (guestfs_h *g);\n"
17630 #: ../src/guestfs-actions.pod:7221
17631 msgid "This function is a no op."
17635 #: ../src/guestfs-actions.pod:7223
17637 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17638 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17639 "is no longer necessary because C<guestfs_launch> now does the waiting."
17643 #: ../src/guestfs-actions.pod:7228
17645 "If you see any calls to this function in code then you can just remove them, "
17646 "unless you want to retain compatibility with older versions of the API."
17650 #: ../src/guestfs-actions.pod:7234
17652 "This function is deprecated. In new code, use the L</guestfs_launch> call "
17657 #: ../src/guestfs-actions.pod:7243
17658 msgid "guestfs_wc_c"
17662 #: ../src/guestfs-actions.pod:7245
17666 " guestfs_wc_c (guestfs_h *g,\n"
17667 " const char *path);\n"
17672 #: ../src/guestfs-actions.pod:7249 ../fish/guestfish-actions.pod:4864
17674 "This command counts the characters in a file, using the C<wc -c> external "
17679 #: ../src/guestfs-actions.pod:7256
17680 msgid "guestfs_wc_l"
17684 #: ../src/guestfs-actions.pod:7258
17688 " guestfs_wc_l (guestfs_h *g,\n"
17689 " const char *path);\n"
17694 #: ../src/guestfs-actions.pod:7262 ../fish/guestfish-actions.pod:4871
17696 "This command counts the lines in a file, using the C<wc -l> external "
17701 #: ../src/guestfs-actions.pod:7269
17702 msgid "guestfs_wc_w"
17706 #: ../src/guestfs-actions.pod:7271
17710 " guestfs_wc_w (guestfs_h *g,\n"
17711 " const char *path);\n"
17716 #: ../src/guestfs-actions.pod:7275 ../fish/guestfish-actions.pod:4878
17718 "This command counts the words in a file, using the C<wc -w> external "
17723 #: ../src/guestfs-actions.pod:7282
17724 msgid "guestfs_write"
17728 #: ../src/guestfs-actions.pod:7284
17732 " guestfs_write (guestfs_h *g,\n"
17733 " const char *path,\n"
17734 " const char *content,\n"
17735 " size_t content_size);\n"
17740 #: ../src/guestfs-actions.pod:7290 ../fish/guestfish-actions.pod:4885
17742 "This call creates a file called C<path>. The content of the file is the "
17743 "string C<content> (which can contain any 8 bit data)."
17747 #: ../src/guestfs-actions.pod:7300
17748 msgid "guestfs_write_file"
17752 #: ../src/guestfs-actions.pod:7302
17756 " guestfs_write_file (guestfs_h *g,\n"
17757 " const char *path,\n"
17758 " const char *content,\n"
17764 #: ../src/guestfs-actions.pod:7308 ../fish/guestfish-actions.pod:4895
17766 "This call creates a file called C<path>. The contents of the file is the "
17767 "string C<content> (which can contain any 8 bit data), with length C<size>."
17771 #: ../src/guestfs-actions.pod:7312 ../fish/guestfish-actions.pod:4899
17773 "As a special case, if C<size> is C<0> then the length is calculated using "
17774 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
17778 #: ../src/guestfs-actions.pod:7316 ../fish/guestfish-actions.pod:4903
17780 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
17781 "I<not> work, even if the length is specified."
17785 #: ../src/guestfs-actions.pod:7324
17787 "This function is deprecated. In new code, use the L</guestfs_write> call "
17792 #: ../src/guestfs-actions.pod:7333
17793 msgid "guestfs_zegrep"
17797 #: ../src/guestfs-actions.pod:7335
17801 " guestfs_zegrep (guestfs_h *g,\n"
17802 " const char *regex,\n"
17803 " const char *path);\n"
17808 #: ../src/guestfs-actions.pod:7340 ../fish/guestfish-actions.pod:4920
17809 msgid "This calls the external C<zegrep> program and returns the matching lines."
17813 #: ../src/guestfs-actions.pod:7352
17814 msgid "guestfs_zegrepi"
17818 #: ../src/guestfs-actions.pod:7354
17822 " guestfs_zegrepi (guestfs_h *g,\n"
17823 " const char *regex,\n"
17824 " const char *path);\n"
17829 #: ../src/guestfs-actions.pod:7359 ../fish/guestfish-actions.pod:4930
17830 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
17834 #: ../src/guestfs-actions.pod:7371
17835 msgid "guestfs_zero"
17839 #: ../src/guestfs-actions.pod:7373
17843 " guestfs_zero (guestfs_h *g,\n"
17844 " const char *device);\n"
17849 #: ../src/guestfs-actions.pod:7377 ../fish/guestfish-actions.pod:4940
17850 msgid "This command writes zeroes over the first few blocks of C<device>."
17854 #: ../src/guestfs-actions.pod:7379 ../fish/guestfish-actions.pod:4942
17856 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
17857 "securely wipe the device). It should be sufficient to remove any partition "
17858 "tables, filesystem superblocks and so on."
17862 #: ../src/guestfs-actions.pod:7383
17863 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
17867 #: ../src/guestfs-actions.pod:7394
17868 msgid "guestfs_zero_device"
17872 #: ../src/guestfs-actions.pod:7396
17876 " guestfs_zero_device (guestfs_h *g,\n"
17877 " const char *device);\n"
17882 #: ../src/guestfs-actions.pod:7400
17884 "This command writes zeroes over the entire C<device>. Compare with "
17885 "C<guestfs_zero> which just zeroes the first few blocks of a device."
17889 #: ../src/guestfs-actions.pod:7414
17890 msgid "(Added in 1.3.1)"
17894 #: ../src/guestfs-actions.pod:7416
17895 msgid "guestfs_zerofree"
17899 #: ../src/guestfs-actions.pod:7418
17903 " guestfs_zerofree (guestfs_h *g,\n"
17904 " const char *device);\n"
17909 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4963
17911 "This runs the I<zerofree> program on C<device>. This program claims to zero "
17912 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
17913 "possible to compress the filesystem more effectively."
17917 #: ../src/guestfs-actions.pod:7427 ../fish/guestfish-actions.pod:4968
17918 msgid "You should B<not> run this program if the filesystem is mounted."
17922 #: ../src/guestfs-actions.pod:7430 ../fish/guestfish-actions.pod:4971
17924 "It is possible that using this program can damage the filesystem or data on "
17929 #: ../src/guestfs-actions.pod:7437
17930 msgid "guestfs_zfgrep"
17934 #: ../src/guestfs-actions.pod:7439
17938 " guestfs_zfgrep (guestfs_h *g,\n"
17939 " const char *pattern,\n"
17940 " const char *path);\n"
17945 #: ../src/guestfs-actions.pod:7444 ../fish/guestfish-actions.pod:4978
17946 msgid "This calls the external C<zfgrep> program and returns the matching lines."
17950 #: ../src/guestfs-actions.pod:7456
17951 msgid "guestfs_zfgrepi"
17955 #: ../src/guestfs-actions.pod:7458
17959 " guestfs_zfgrepi (guestfs_h *g,\n"
17960 " const char *pattern,\n"
17961 " const char *path);\n"
17966 #: ../src/guestfs-actions.pod:7463 ../fish/guestfish-actions.pod:4988
17967 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
17971 #: ../src/guestfs-actions.pod:7475
17972 msgid "guestfs_zfile"
17976 #: ../src/guestfs-actions.pod:7477
17980 " guestfs_zfile (guestfs_h *g,\n"
17981 " const char *meth,\n"
17982 " const char *path);\n"
17987 #: ../src/guestfs-actions.pod:7482 ../fish/guestfish-actions.pod:4998
17988 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
17992 #: ../src/guestfs-actions.pod:7485 ../fish/guestfish-actions.pod:5001
17993 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
17997 #: ../src/guestfs-actions.pod:7487
17999 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18004 #: ../src/guestfs-actions.pod:7493
18006 "This function is deprecated. In new code, use the L</guestfs_file> call "
18011 #: ../src/guestfs-actions.pod:7502
18012 msgid "guestfs_zgrep"
18016 #: ../src/guestfs-actions.pod:7504
18020 " guestfs_zgrep (guestfs_h *g,\n"
18021 " const char *regex,\n"
18022 " const char *path);\n"
18027 #: ../src/guestfs-actions.pod:7509 ../fish/guestfish-actions.pod:5017
18028 msgid "This calls the external C<zgrep> program and returns the matching lines."
18032 #: ../src/guestfs-actions.pod:7521
18033 msgid "guestfs_zgrepi"
18037 #: ../src/guestfs-actions.pod:7523
18041 " guestfs_zgrepi (guestfs_h *g,\n"
18042 " const char *regex,\n"
18043 " const char *path);\n"
18048 #: ../src/guestfs-actions.pod:7528 ../fish/guestfish-actions.pod:5027
18049 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
18053 #: ../src/guestfs-availability.pod:3
18058 #: ../src/guestfs-availability.pod:5
18060 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
18061 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
18062 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
18063 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
18064 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
18068 #: ../src/guestfs-availability.pod:21
18073 #: ../src/guestfs-availability.pod:23
18075 "The following functions: L</guestfs_inotify_add_watch> "
18076 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
18077 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18081 #: ../src/guestfs-availability.pod:31
18082 msgid "B<linuxfsuuid>"
18086 #: ../src/guestfs-availability.pod:33
18088 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
18089 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18093 #: ../src/guestfs-availability.pod:40
18094 msgid "B<linuxmodules>"
18098 #: ../src/guestfs-availability.pod:42
18099 msgid "The following functions: L</guestfs_modprobe>"
18103 #: ../src/guestfs-availability.pod:45
18104 msgid "B<linuxxattrs>"
18108 #: ../src/guestfs-availability.pod:47
18110 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
18111 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
18112 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
18113 "L</guestfs_setxattr>"
18117 #: ../src/guestfs-availability.pod:58
18122 #: ../src/guestfs-availability.pod:60
18124 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
18125 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
18126 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18130 #: ../src/guestfs-availability.pod:69
18135 #: ../src/guestfs-availability.pod:71
18137 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
18138 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
18139 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
18140 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
18141 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
18142 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
18143 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
18144 "L</guestfs_vgs_full>"
18148 #: ../src/guestfs-availability.pod:94
18153 #: ../src/guestfs-availability.pod:96
18155 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
18156 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
18160 #: ../src/guestfs-availability.pod:102
18165 #: ../src/guestfs-availability.pod:104
18166 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18170 #: ../src/guestfs-availability.pod:107
18171 msgid "B<ntfsprogs>"
18175 #: ../src/guestfs-availability.pod:109
18176 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18180 #: ../src/guestfs-availability.pod:113
18181 msgid "B<realpath>"
18185 #: ../src/guestfs-availability.pod:115
18186 msgid "The following functions: L</guestfs_realpath>"
18190 #: ../src/guestfs-availability.pod:118
18195 #: ../src/guestfs-availability.pod:120
18197 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
18198 "L</guestfs_scrub_freespace>"
18202 #: ../src/guestfs-availability.pod:125
18207 #: ../src/guestfs-availability.pod:127
18208 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18212 #: ../src/guestfs-availability.pod:131
18217 #: ../src/guestfs-availability.pod:133
18218 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18222 #: ../src/guestfs-availability.pod:137
18223 msgid "B<zerofree>"
18227 #: ../src/guestfs-availability.pod:139
18228 msgid "The following functions: L</guestfs_zerofree>"
18232 #: ../src/guestfs-structs.pod:1
18233 msgid "guestfs_int_bool"
18237 #: ../src/guestfs-structs.pod:3
18240 " struct guestfs_int_bool {\n"
18248 #: ../src/guestfs-structs.pod:8
18251 " struct guestfs_int_bool_list {\n"
18252 " uint32_t len; /* Number of elements in list. */\n"
18253 " struct guestfs_int_bool *val; /* Elements. */\n"
18259 #: ../src/guestfs-structs.pod:13
18262 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18263 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18268 #: ../src/guestfs-structs.pod:16
18269 msgid "guestfs_lvm_pv"
18273 #: ../src/guestfs-structs.pod:18
18276 " struct guestfs_lvm_pv {\n"
18277 " char *pv_name;\n"
18278 " /* The next field is NOT nul-terminated, be careful when printing it: "
18280 " char pv_uuid[32];\n"
18282 " uint64_t pv_size;\n"
18283 " uint64_t dev_size;\n"
18284 " uint64_t pv_free;\n"
18285 " uint64_t pv_used;\n"
18286 " char *pv_attr;\n"
18287 " int64_t pv_pe_count;\n"
18288 " int64_t pv_pe_alloc_count;\n"
18289 " char *pv_tags;\n"
18290 " uint64_t pe_start;\n"
18291 " int64_t pv_mda_count;\n"
18292 " uint64_t pv_mda_free;\n"
18298 #: ../src/guestfs-structs.pod:36
18301 " struct guestfs_lvm_pv_list {\n"
18302 " uint32_t len; /* Number of elements in list. */\n"
18303 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18309 #: ../src/guestfs-structs.pod:41
18312 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18313 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18318 #: ../src/guestfs-structs.pod:44
18319 msgid "guestfs_lvm_vg"
18323 #: ../src/guestfs-structs.pod:46
18326 " struct guestfs_lvm_vg {\n"
18327 " char *vg_name;\n"
18328 " /* The next field is NOT nul-terminated, be careful when printing it: "
18330 " char vg_uuid[32];\n"
18332 " char *vg_attr;\n"
18333 " uint64_t vg_size;\n"
18334 " uint64_t vg_free;\n"
18335 " char *vg_sysid;\n"
18336 " uint64_t vg_extent_size;\n"
18337 " int64_t vg_extent_count;\n"
18338 " int64_t vg_free_count;\n"
18339 " int64_t max_lv;\n"
18340 " int64_t max_pv;\n"
18341 " int64_t pv_count;\n"
18342 " int64_t lv_count;\n"
18343 " int64_t snap_count;\n"
18344 " int64_t vg_seqno;\n"
18345 " char *vg_tags;\n"
18346 " int64_t vg_mda_count;\n"
18347 " uint64_t vg_mda_free;\n"
18353 #: ../src/guestfs-structs.pod:69
18356 " struct guestfs_lvm_vg_list {\n"
18357 " uint32_t len; /* Number of elements in list. */\n"
18358 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18364 #: ../src/guestfs-structs.pod:74
18367 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18368 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18373 #: ../src/guestfs-structs.pod:77
18374 msgid "guestfs_lvm_lv"
18378 #: ../src/guestfs-structs.pod:79
18381 " struct guestfs_lvm_lv {\n"
18382 " char *lv_name;\n"
18383 " /* The next field is NOT nul-terminated, be careful when printing it: "
18385 " char lv_uuid[32];\n"
18386 " char *lv_attr;\n"
18387 " int64_t lv_major;\n"
18388 " int64_t lv_minor;\n"
18389 " int64_t lv_kernel_major;\n"
18390 " int64_t lv_kernel_minor;\n"
18391 " uint64_t lv_size;\n"
18392 " int64_t seg_count;\n"
18394 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18395 " float snap_percent;\n"
18396 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18397 " float copy_percent;\n"
18398 " char *move_pv;\n"
18399 " char *lv_tags;\n"
18400 " char *mirror_log;\n"
18401 " char *modules;\n"
18407 #: ../src/guestfs-structs.pod:101
18410 " struct guestfs_lvm_lv_list {\n"
18411 " uint32_t len; /* Number of elements in list. */\n"
18412 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18418 #: ../src/guestfs-structs.pod:106
18421 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18422 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18427 #: ../src/guestfs-structs.pod:111
18430 " struct guestfs_stat {\n"
18434 " int64_t nlink;\n"
18439 " int64_t blksize;\n"
18440 " int64_t blocks;\n"
18441 " int64_t atime;\n"
18442 " int64_t mtime;\n"
18443 " int64_t ctime;\n"
18449 #: ../src/guestfs-structs.pod:127
18452 " struct guestfs_stat_list {\n"
18453 " uint32_t len; /* Number of elements in list. */\n"
18454 " struct guestfs_stat *val; /* Elements. */\n"
18460 #: ../src/guestfs-structs.pod:132
18463 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18464 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18469 #: ../src/guestfs-structs.pod:137
18472 " struct guestfs_statvfs {\n"
18473 " int64_t bsize;\n"
18474 " int64_t frsize;\n"
18475 " int64_t blocks;\n"
18476 " int64_t bfree;\n"
18477 " int64_t bavail;\n"
18478 " int64_t files;\n"
18479 " int64_t ffree;\n"
18480 " int64_t favail;\n"
18483 " int64_t namemax;\n"
18489 #: ../src/guestfs-structs.pod:151
18492 " struct guestfs_statvfs_list {\n"
18493 " uint32_t len; /* Number of elements in list. */\n"
18494 " struct guestfs_statvfs *val; /* Elements. */\n"
18500 #: ../src/guestfs-structs.pod:156
18503 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18504 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18509 #: ../src/guestfs-structs.pod:159
18510 msgid "guestfs_dirent"
18514 #: ../src/guestfs-structs.pod:161
18517 " struct guestfs_dirent {\n"
18526 #: ../src/guestfs-structs.pod:167
18529 " struct guestfs_dirent_list {\n"
18530 " uint32_t len; /* Number of elements in list. */\n"
18531 " struct guestfs_dirent *val; /* Elements. */\n"
18537 #: ../src/guestfs-structs.pod:172
18540 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18541 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18546 #: ../src/guestfs-structs.pod:177
18549 " struct guestfs_version {\n"
18550 " int64_t major;\n"
18551 " int64_t minor;\n"
18552 " int64_t release;\n"
18559 #: ../src/guestfs-structs.pod:184
18562 " struct guestfs_version_list {\n"
18563 " uint32_t len; /* Number of elements in list. */\n"
18564 " struct guestfs_version *val; /* Elements. */\n"
18570 #: ../src/guestfs-structs.pod:189
18573 " void guestfs_free_version (struct guestfs_free_version *);\n"
18574 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18579 #: ../src/guestfs-structs.pod:192
18580 msgid "guestfs_xattr"
18584 #: ../src/guestfs-structs.pod:194
18587 " struct guestfs_xattr {\n"
18588 " char *attrname;\n"
18589 " /* The next two fields describe a byte array. */\n"
18590 " uint32_t attrval_len;\n"
18591 " char *attrval;\n"
18597 #: ../src/guestfs-structs.pod:201
18600 " struct guestfs_xattr_list {\n"
18601 " uint32_t len; /* Number of elements in list. */\n"
18602 " struct guestfs_xattr *val; /* Elements. */\n"
18608 #: ../src/guestfs-structs.pod:206
18611 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18612 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18617 #: ../src/guestfs-structs.pod:209
18618 msgid "guestfs_inotify_event"
18622 #: ../src/guestfs-structs.pod:211
18625 " struct guestfs_inotify_event {\n"
18626 " int64_t in_wd;\n"
18627 " uint32_t in_mask;\n"
18628 " uint32_t in_cookie;\n"
18629 " char *in_name;\n"
18635 #: ../src/guestfs-structs.pod:218
18638 " struct guestfs_inotify_event_list {\n"
18639 " uint32_t len; /* Number of elements in list. */\n"
18640 " struct guestfs_inotify_event *val; /* Elements. */\n"
18646 #: ../src/guestfs-structs.pod:223
18649 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18650 " void guestfs_free_inotify_event_list (struct "
18651 "guestfs_free_inotify_event_list *);\n"
18656 #: ../src/guestfs-structs.pod:226
18657 msgid "guestfs_partition"
18661 #: ../src/guestfs-structs.pod:228
18664 " struct guestfs_partition {\n"
18665 " int32_t part_num;\n"
18666 " uint64_t part_start;\n"
18667 " uint64_t part_end;\n"
18668 " uint64_t part_size;\n"
18674 #: ../src/guestfs-structs.pod:235
18677 " struct guestfs_partition_list {\n"
18678 " uint32_t len; /* Number of elements in list. */\n"
18679 " struct guestfs_partition *val; /* Elements. */\n"
18685 #: ../src/guestfs-structs.pod:240
18688 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18689 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18694 #: ../src/guestfs-structs.pod:243
18695 msgid "guestfs_application"
18699 #: ../src/guestfs-structs.pod:245
18702 " struct guestfs_application {\n"
18703 " char *app_name;\n"
18704 " char *app_display_name;\n"
18705 " int32_t app_epoch;\n"
18706 " char *app_version;\n"
18707 " char *app_release;\n"
18708 " char *app_install_path;\n"
18709 " char *app_trans_path;\n"
18710 " char *app_publisher;\n"
18711 " char *app_url;\n"
18712 " char *app_source_package;\n"
18713 " char *app_summary;\n"
18714 " char *app_description;\n"
18720 #: ../src/guestfs-structs.pod:260
18723 " struct guestfs_application_list {\n"
18724 " uint32_t len; /* Number of elements in list. */\n"
18725 " struct guestfs_application *val; /* Elements. */\n"
18731 #: ../src/guestfs-structs.pod:265
18734 " void guestfs_free_application (struct guestfs_free_application *);\n"
18735 " void guestfs_free_application_list (struct guestfs_free_application_list "
18741 #: ../fish/guestfish.pod:5
18742 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18746 #: ../fish/guestfish.pod:9
18749 " guestfish [--options] [commands]\n"
18754 #: ../fish/guestfish.pod:11
18762 #: ../fish/guestfish.pod:13
18765 " guestfish [--ro|--rw] -a disk.img\n"
18770 #: ../fish/guestfish.pod:15
18773 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18778 #: ../fish/guestfish.pod:17
18781 " guestfish -d libvirt-domain\n"
18786 #: ../fish/guestfish.pod:19
18789 " guestfish [--ro|--rw] -a disk.img -i\n"
18794 #: ../fish/guestfish.pod:21
18797 " guestfish -d libvirt-domain -i\n"
18802 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
18807 #: ../fish/guestfish.pod:25
18809 "Using guestfish in read/write mode on live virtual machines can be "
18810 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18811 "option to use guestfish safely if the disk image or virtual machine might be "
18816 #: ../fish/guestfish.pod:32
18818 "Guestfish is a shell and command-line tool for examining and modifying "
18819 "virtual machine filesystems. It uses libguestfs and exposes all of the "
18820 "functionality of the guestfs API, see L<guestfs(3)>."
18824 #: ../fish/guestfish.pod:36
18826 "Guestfish gives you structured access to the libguestfs API, from shell "
18827 "scripts or the command line or interactively. If you want to rescue a "
18828 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
18833 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:958 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-tar.pl:50
18838 #: ../fish/guestfish.pod:43
18839 msgid "As an interactive shell"
18843 #: ../fish/guestfish.pod:45
18851 #: ../fish/guestfish.pod:47
18854 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
18855 " editing virtual machine filesystems.\n"
18860 #: ../fish/guestfish.pod:50
18863 " Type: 'help' for a list of commands\n"
18864 " 'man' to read the manual\n"
18865 " 'quit' to quit the shell\n"
18870 #: ../fish/guestfish.pod:54
18873 " ><fs> add-ro disk.img\n"
18875 " ><fs> list-filesystems\n"
18876 " /dev/sda1: ext4\n"
18877 " /dev/vg_guest/lv_root: ext4\n"
18878 " /dev/vg_guest/lv_swap: swap\n"
18879 " ><fs> mount /dev/vg_guest/lv_root /\n"
18880 " ><fs> cat /etc/fstab\n"
18882 " # Created by anaconda\n"
18889 #: ../fish/guestfish.pod:67
18890 msgid "From shell scripts"
18894 #: ../fish/guestfish.pod:69
18895 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18899 #: ../fish/guestfish.pod:71
18902 " guestfish <<_EOF_\n"
18905 " mount /dev/vg_guest/lv_root /\n"
18906 " write /etc/motd \"Welcome, new users\"\n"
18912 #: ../fish/guestfish.pod:78
18913 msgid "List the LVM logical volumes in a disk image:"
18917 #: ../fish/guestfish.pod:80
18920 " guestfish -a disk.img --ro <<_EOF_\n"
18928 #: ../fish/guestfish.pod:85
18929 msgid "List all the filesystems in a disk image:"
18933 #: ../fish/guestfish.pod:87
18936 " guestfish -a disk.img --ro <<_EOF_\n"
18938 " list-filesystems\n"
18944 #: ../fish/guestfish.pod:92
18945 msgid "On one command line"
18949 #: ../fish/guestfish.pod:94
18950 msgid "Update C</etc/resolv.conf> in a guest:"
18954 #: ../fish/guestfish.pod:96
18958 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
18959 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
18964 #: ../fish/guestfish.pod:100
18965 msgid "Edit C</boot/grub/grub.conf> interactively:"
18969 #: ../fish/guestfish.pod:102
18972 " guestfish --rw --add disk.img \\\n"
18973 " --mount /dev/vg_guest/lv_root \\\n"
18974 " --mount /dev/sda1:/boot \\\n"
18975 " edit /boot/grub/grub.conf\n"
18980 #: ../fish/guestfish.pod:107
18981 msgid "Mount disks automatically"
18985 #: ../fish/guestfish.pod:109
18987 "Use the I<-i> option to automatically mount the disks from a virtual "
18992 #: ../fish/guestfish.pod:112
18995 " guestfish --ro -a disk.img -i cat /etc/group\n"
19000 #: ../fish/guestfish.pod:114
19003 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19008 #: ../fish/guestfish.pod:116
19009 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19013 #: ../fish/guestfish.pod:118
19016 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19021 #: ../fish/guestfish.pod:120
19022 msgid "As a script interpreter"
19026 #: ../fish/guestfish.pod:122
19027 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19031 #: ../fish/guestfish.pod:124
19034 " #!/usr/bin/guestfish -f\n"
19035 " sparse test1.img 100M\n"
19037 " part-disk /dev/sda mbr\n"
19038 " mkfs ext2 /dev/sda1\n"
19043 #: ../fish/guestfish.pod:130
19044 msgid "Start with a prepared disk"
19048 #: ../fish/guestfish.pod:132
19050 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19051 "single ext2-formatted partition:"
19055 #: ../fish/guestfish.pod:135
19058 " guestfish -N fs\n"
19063 #: ../fish/guestfish.pod:137
19064 msgid "To list what is available do:"
19068 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:949
19071 " guestfish -N help | less\n"
19076 #: ../fish/guestfish.pod:141
19077 msgid "Remote control"
19081 #: ../fish/guestfish.pod:143
19084 " eval \"`guestfish --listen`\"\n"
19085 " guestfish --remote add-ro disk.img\n"
19086 " guestfish --remote run\n"
19087 " guestfish --remote lvs\n"
19092 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:83 ../tools/virt-edit.pl:81 ../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
19097 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:141 ../tools/virt-edit.pl:89 ../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
19102 #: ../fish/guestfish.pod:154
19103 msgid "Displays general help on options."
19107 #: ../fish/guestfish.pod:156
19112 #: ../fish/guestfish.pod:158
19113 msgid "B<--cmd-help>"
19117 #: ../fish/guestfish.pod:160
19118 msgid "Lists all available guestfish commands."
19122 #: ../fish/guestfish.pod:162
19127 #: ../fish/guestfish.pod:164
19128 msgid "B<--cmd-help cmd>"
19132 #: ../fish/guestfish.pod:166
19133 msgid "Displays detailed help on a single command C<cmd>."
19137 #: ../fish/guestfish.pod:168
19138 msgid "B<-a image>"
19142 #: ../fish/guestfish.pod:170
19143 msgid "B<--add image>"
19147 #: ../fish/guestfish.pod:172
19148 msgid "Add a block device or virtual machine image to the shell."
19152 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19154 "The format of the disk image is auto-detected. To override this and force a "
19155 "particular format use the I<--format=..> option."
19159 #: ../fish/guestfish.pod:177
19161 "Using this flag is mostly equivalent to using the C<add> command, with "
19162 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19163 "the I<--format=...> flag was given."
19167 #: ../fish/guestfish.pod:181
19172 #: ../fish/guestfish.pod:183
19173 msgid "B<--connect URI>"
19177 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19179 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19180 "URI to use. The default is to use the default libvirt connection."
19184 #: ../fish/guestfish.pod:189
19189 #: ../fish/guestfish.pod:191
19191 "If using the I<--listen> option and a csh-like shell, use this option. See "
19192 "section L</REMOTE CONTROL AND CSH> below."
19196 #: ../fish/guestfish.pod:194
19197 msgid "B<-d libvirt-domain>"
19201 #: ../fish/guestfish.pod:196
19202 msgid "B<--domain libvirt-domain>"
19206 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19208 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19209 "used, then any libvirt domain can be used. However in write mode, only "
19210 "libvirt domains which are shut down can be named here."
19214 #: ../fish/guestfish.pod:202
19216 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19217 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19218 "if the I<--format:...> flag was given."
19222 #: ../fish/guestfish.pod:206
19227 #: ../fish/guestfish.pod:208
19228 msgid "B<--no-dest-paths>"
19232 #: ../fish/guestfish.pod:210
19234 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19235 "to hit the tab key to complete paths on the guest filesystem, but this "
19236 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19237 "allow this feature to be disabled."
19241 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:118
19242 msgid "B<--echo-keys>"
19246 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19248 "When prompting for keys and passphrases, guestfish normally turns echoing "
19249 "off so you cannot see what you are typing. If you are not worried about "
19250 "Tempest attacks and there is no one else in the room you can specify this "
19251 "flag to see what you are typing."
19255 #: ../fish/guestfish.pod:222
19260 #: ../fish/guestfish.pod:224
19261 msgid "B<--file file>"
19265 #: ../fish/guestfish.pod:226
19266 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19270 #: ../fish/guestfish.pod:229
19273 " #!/usr/bin/guestfish -f\n"
19278 #: ../fish/guestfish.pod:231
19279 msgid "B<--format=raw|qcow2|..>"
19283 #: ../fish/guestfish.pod:233
19284 msgid "B<--format>"
19288 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:127
19290 "The default for the I<-a> option is to auto-detect the format of the disk "
19291 "image. Using this forces the disk format for I<-a> options which follow on "
19292 "the command line. Using I<--format> with no argument switches back to "
19293 "auto-detection for subsequent I<-a> options."
19297 #: ../fish/guestfish.pod:242
19300 " guestfish --format=raw -a disk.img\n"
19305 #: ../fish/guestfish.pod:244
19306 msgid "forces raw format (no auto-detection) for C<disk.img>."
19310 #: ../fish/guestfish.pod:246
19313 " guestfish --format=raw -a disk.img --format -a another.img\n"
19318 #: ../fish/guestfish.pod:248
19320 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19321 "auto-detection for C<another.img>."
19325 #: ../fish/guestfish.pod:251
19327 "If you have untrusted raw-format guest disk images, you should use this "
19328 "option to specify the disk format. This avoids a possible security problem "
19329 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19333 #: ../fish/guestfish.pod:256
19338 #: ../fish/guestfish.pod:258
19339 msgid "B<--inspector>"
19343 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:147
19345 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19346 "system and mount filesystems as they would be mounted on the real virtual "
19351 #: ../fish/guestfish.pod:264
19352 msgid "Typical usage is either:"
19356 #: ../fish/guestfish.pod:266
19359 " guestfish -d myguest -i\n"
19364 #: ../fish/guestfish.pod:268
19365 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19369 #: ../fish/guestfish.pod:270
19372 " guestfish --ro -d myguest -i\n"
19377 #: ../fish/guestfish.pod:272
19378 msgid "(for active domains, readonly), or specify the block device directly:"
19382 #: ../fish/guestfish.pod:274
19385 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19390 #: ../fish/guestfish.pod:276
19392 "Note that the command line syntax changed slightly over older versions of "
19393 "guestfish. You can still use the old syntax:"
19397 #: ../fish/guestfish.pod:279
19400 " guestfish [--ro] -i disk.img\n"
19405 #: ../fish/guestfish.pod:281
19408 " guestfish [--ro] -i libvirt-domain\n"
19413 #: ../fish/guestfish.pod:283
19415 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19416 "then using other commands to mount the filesystems that were found."
19420 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:151
19421 msgid "B<--keys-from-stdin>"
19425 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
19427 "Read key or passphrase parameters from stdin. The default is to try to read "
19428 "passphrases from the user by opening C</dev/tty>."
19432 #: ../fish/guestfish.pod:292
19433 msgid "B<--listen>"
19437 #: ../fish/guestfish.pod:294
19439 "Fork into the background and listen for remote commands. See section "
19440 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19444 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:156
19449 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
19451 "Connect to a live virtual machine. (Experimental, see "
19452 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19456 #: ../fish/guestfish.pod:302 ../fuse/guestmount.pod:161
19457 msgid "B<-m dev[:mountpoint[:options]]>"
19461 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
19462 msgid "B<--mount dev[:mountpoint[:options]]>"
19466 #: ../fish/guestfish.pod:306
19467 msgid "Mount the named partition or logical volume on the given mountpoint."
19471 #: ../fish/guestfish.pod:308
19472 msgid "If the mountpoint is omitted, it defaults to C</>."
19476 #: ../fish/guestfish.pod:310
19477 msgid "You have to mount something on C</> before most commands will work."
19481 #: ../fish/guestfish.pod:312
19483 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19488 #: ../fish/guestfish.pod:315
19490 "If you don't know what filesystems a disk image contains, you can either run "
19491 "guestfish without this option, then list the partitions, filesystems and LVs "
19492 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19493 "commands), or you can use the L<virt-filesystems(1)> program."
19497 #: ../fish/guestfish.pod:321 ../fuse/guestmount.pod:171
19499 "The third (and rarely used) part of the mount parameter is the list of mount "
19500 "options used to mount the underlying filesystem. If this is not given, then "
19501 "the mount options are either the empty string or C<ro> (the latter if the "
19502 "I<--ro> flag is used). By specifying the mount options, you override this "
19503 "default choice. Probably the only time you would use this is to enable ACLs "
19504 "and/or extended attributes if the filesystem can support them:"
19508 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:179
19511 " -m /dev/sda1:/:acl,user_xattr\n"
19516 #: ../fish/guestfish.pod:331
19517 msgid "Using this flag is equivalent to using the C<mount-options> command."
19521 #: ../fish/guestfish.pod:333
19526 #: ../fish/guestfish.pod:335
19527 msgid "B<--no-sync>"
19531 #: ../fish/guestfish.pod:337
19533 "Disable autosync. This is enabled by default. See the discussion of "
19534 "autosync in the L<guestfs(3)> manpage."
19538 #: ../fish/guestfish.pod:340
19543 #: ../fish/guestfish.pod:342
19544 msgid "B<--new type>"
19548 #: ../fish/guestfish.pod:344
19553 #: ../fish/guestfish.pod:346
19555 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19556 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19557 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19562 #: ../fish/guestfish.pod:351
19563 msgid "B<--progress-bars>"
19567 #: ../fish/guestfish.pod:353
19568 msgid "Enable progress bars, even when guestfish is used non-interactively."
19572 #: ../fish/guestfish.pod:355
19574 "Progress bars are enabled by default when guestfish is used as an "
19575 "interactive shell."
19579 #: ../fish/guestfish.pod:358
19580 msgid "B<--no-progress-bars>"
19584 #: ../fish/guestfish.pod:360
19585 msgid "Disable progress bars."
19589 #: ../fish/guestfish.pod:362
19590 msgid "B<--remote[=pid]>"
19594 #: ../fish/guestfish.pod:364
19596 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19597 "CONTROL GUESTFISH OVER A SOCKET> below."
19601 #: ../fish/guestfish.pod:367
19606 #: ../fish/guestfish.pod:369
19611 #: ../fish/guestfish.pod:371
19613 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19614 "mounts are done read-only."
19618 #: ../fish/guestfish.pod:374
19620 "The option must always be used if the disk image or virtual machine might be "
19621 "running, and is generally recommended in cases where you don't need write "
19622 "access to the disk."
19626 #: ../fish/guestfish.pod:378
19628 "Note that prepared disk images created with I<-N> are not affected by this "
19629 "option. Also commands like C<add> are not affected - you have to specify "
19630 "the C<readonly:true> option explicitly if you need it."
19634 #: ../fish/guestfish.pod:382
19635 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19639 #: ../fish/guestfish.pod:384 ../fuse/guestmount.pod:235
19640 msgid "B<--selinux>"
19644 #: ../fish/guestfish.pod:386
19645 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19649 #: ../fish/guestfish.pod:388
19654 #: ../fish/guestfish.pod:390
19655 msgid "B<--verbose>"
19659 #: ../fish/guestfish.pod:392
19661 "Enable very verbose messages. This is particularly useful if you find a "
19666 #: ../fish/guestfish.pod:395
19671 #: ../fish/guestfish.pod:397 ../tools/virt-edit.pl:97 ../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
19672 msgid "B<--version>"
19676 #: ../fish/guestfish.pod:399
19677 msgid "Display the guestfish / libguestfs version number and exit."
19681 #: ../fish/guestfish.pod:401
19686 #: ../fish/guestfish.pod:403
19691 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:249
19693 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19694 "mounts are done read-write."
19698 #: ../fish/guestfish.pod:408
19699 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19703 #: ../fish/guestfish.pod:410
19708 #: ../fish/guestfish.pod:412
19709 msgid "Echo each command before executing it."
19713 #: ../fish/guestfish.pod:416
19714 msgid "COMMANDS ON COMMAND LINE"
19718 #: ../fish/guestfish.pod:418
19719 msgid "Any additional (non-option) arguments are treated as commands to execute."
19723 #: ../fish/guestfish.pod:421
19725 "Commands to execute should be separated by a colon (C<:>), where the colon "
19726 "is a separate parameter. Thus:"
19730 #: ../fish/guestfish.pod:424
19733 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19738 #: ../fish/guestfish.pod:426
19740 "If there are no additional arguments, then we enter a shell, either an "
19741 "interactive shell with a prompt (if the input is a terminal) or a "
19742 "non-interactive shell."
19746 #: ../fish/guestfish.pod:430
19748 "In either command line mode or non-interactive shell, the first command that "
19749 "gives an error causes the whole shell to exit. In interactive mode (with a "
19750 "prompt) if a command fails, you can continue to enter commands."
19754 #: ../fish/guestfish.pod:435
19755 msgid "USING launch (OR run)"
19759 #: ../fish/guestfish.pod:437
19761 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19762 "then launch it, then mount any disks you need, and finally issue "
19763 "actions/commands. So the general order of the day is:"
19767 #: ../fish/guestfish.pod:445
19768 msgid "add or -a/--add"
19772 #: ../fish/guestfish.pod:449
19773 msgid "launch (aka run)"
19777 #: ../fish/guestfish.pod:453
19778 msgid "mount or -m/--mount"
19782 #: ../fish/guestfish.pod:457
19783 msgid "any other commands"
19787 #: ../fish/guestfish.pod:461
19789 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19790 "guest before mounting or performing any other commands."
19794 #: ../fish/guestfish.pod:464
19796 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19797 "I<--new> options were given then C<run> is done automatically, simply "
19798 "because guestfish can't perform the action you asked for without doing this."
19802 #: ../fish/guestfish.pod:469
19803 msgid "OPENING DISKS FOR READ AND WRITE"
19807 #: ../fish/guestfish.pod:471
19809 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
19810 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
19811 "I<-i> and I<-m> open disk images read-only or for writing."
19815 #: ../fish/guestfish.pod:476
19817 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
19818 "opening disk images supplied on the command line for write. To open a disk "
19819 "image read-only you have to do I<-a image --ro>."
19823 #: ../fish/guestfish.pod:480
19825 "This matters: If you accidentally open a live VM disk image writable then "
19826 "you will cause irreversible disk corruption."
19830 #: ../fish/guestfish.pod:483
19832 "By libguestfs 1.12 we intend to change the default the other way. Disk "
19833 "images will be opened read-only. You will have to either specify "
19834 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
19835 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
19836 "access for disk images specified by those other command line options."
19840 #: ../fish/guestfish.pod:490
19842 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
19843 "which does nothing (it is already the default). However it is highly "
19844 "recommended that you use this option to indicate that you need write access, "
19845 "and prepare your scripts for the day when this option will be required for "
19850 #: ../fish/guestfish.pod:496
19852 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
19853 "other libguestfs program apart from guestfish and guestmount."
19857 #: ../fish/guestfish.pod:499
19862 #: ../fish/guestfish.pod:501
19864 "You can quote ordinary parameters using either single or double quotes. For "
19869 #: ../fish/guestfish.pod:504
19872 " add \"file with a space.img\"\n"
19877 #: ../fish/guestfish.pod:506
19880 " rm '/file name'\n"
19885 #: ../fish/guestfish.pod:508
19893 #: ../fish/guestfish.pod:510
19895 "A few commands require a list of strings to be passed. For these, use a "
19896 "whitespace-separated list, enclosed in quotes. Strings containing "
19897 "whitespace to be passed through must be enclosed in single quotes. A "
19898 "literal single quote must be escaped with a backslash."
19902 #: ../fish/guestfish.pod:515
19905 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
19906 " command \"/bin/echo 'foo bar'\"\n"
19907 " command \"/bin/echo \\'foo\\'\"\n"
19912 #: ../fish/guestfish.pod:519
19913 msgid "OPTIONAL ARGUMENTS"
19917 #: ../fish/guestfish.pod:521
19919 "Some commands take optional arguments. These arguments appear in this "
19920 "documentation as C<[argname:..]>. You can use them as in these examples:"
19924 #: ../fish/guestfish.pod:525
19927 " add-drive-opts filename\n"
19932 #: ../fish/guestfish.pod:527
19935 " add-drive-opts filename readonly:true\n"
19940 #: ../fish/guestfish.pod:529
19943 " add-drive-opts filename format:qcow2 readonly:false\n"
19948 #: ../fish/guestfish.pod:531
19950 "Each optional argument can appear at most once. All optional arguments must "
19951 "appear after the required ones."
19955 #: ../fish/guestfish.pod:534
19960 #: ../fish/guestfish.pod:536
19961 msgid "This section applies to all commands which can take integers as parameters."
19965 #: ../fish/guestfish.pod:539
19966 msgid "SIZE SUFFIX"
19970 #: ../fish/guestfish.pod:541
19972 "When the command takes a parameter measured in bytes, you can use one of the "
19973 "following suffixes to specify kilobytes, megabytes and larger sizes:"
19977 #: ../fish/guestfish.pod:547
19978 msgid "B<k> or B<K> or B<KiB>"
19982 #: ../fish/guestfish.pod:549
19983 msgid "The size in kilobytes (multiplied by 1024)."
19987 #: ../fish/guestfish.pod:551
19992 #: ../fish/guestfish.pod:553
19993 msgid "The size in SI 1000 byte units."
19997 #: ../fish/guestfish.pod:555
19998 msgid "B<M> or B<MiB>"
20002 #: ../fish/guestfish.pod:557
20003 msgid "The size in megabytes (multiplied by 1048576)."
20007 #: ../fish/guestfish.pod:559
20012 #: ../fish/guestfish.pod:561
20013 msgid "The size in SI 1000000 byte units."
20017 #: ../fish/guestfish.pod:563
20018 msgid "B<G> or B<GiB>"
20022 #: ../fish/guestfish.pod:565
20023 msgid "The size in gigabytes (multiplied by 2**30)."
20027 #: ../fish/guestfish.pod:567
20032 #: ../fish/guestfish.pod:569
20033 msgid "The size in SI 10**9 byte units."
20037 #: ../fish/guestfish.pod:571
20038 msgid "B<T> or B<TiB>"
20042 #: ../fish/guestfish.pod:573
20043 msgid "The size in terabytes (multiplied by 2**40)."
20047 #: ../fish/guestfish.pod:575
20052 #: ../fish/guestfish.pod:577
20053 msgid "The size in SI 10**12 byte units."
20057 #: ../fish/guestfish.pod:579
20058 msgid "B<P> or B<PiB>"
20062 #: ../fish/guestfish.pod:581
20063 msgid "The size in petabytes (multiplied by 2**50)."
20067 #: ../fish/guestfish.pod:583
20072 #: ../fish/guestfish.pod:585
20073 msgid "The size in SI 10**15 byte units."
20077 #: ../fish/guestfish.pod:587
20078 msgid "B<E> or B<EiB>"
20082 #: ../fish/guestfish.pod:589
20083 msgid "The size in exabytes (multiplied by 2**60)."
20087 #: ../fish/guestfish.pod:591
20092 #: ../fish/guestfish.pod:593
20093 msgid "The size in SI 10**18 byte units."
20097 #: ../fish/guestfish.pod:595
20098 msgid "B<Z> or B<ZiB>"
20102 #: ../fish/guestfish.pod:597
20103 msgid "The size in zettabytes (multiplied by 2**70)."
20107 #: ../fish/guestfish.pod:599
20112 #: ../fish/guestfish.pod:601
20113 msgid "The size in SI 10**21 byte units."
20117 #: ../fish/guestfish.pod:603
20118 msgid "B<Y> or B<YiB>"
20122 #: ../fish/guestfish.pod:605
20123 msgid "The size in yottabytes (multiplied by 2**80)."
20127 #: ../fish/guestfish.pod:607
20132 #: ../fish/guestfish.pod:609
20133 msgid "The size in SI 10**24 byte units."
20137 #: ../fish/guestfish.pod:615
20140 " truncate-size /file 1G\n"
20145 #: ../fish/guestfish.pod:617
20146 msgid "would truncate the file to 1 gigabyte."
20150 #: ../fish/guestfish.pod:619
20152 "Be careful because a few commands take sizes in kilobytes or megabytes "
20153 "(eg. the parameter to L</memsize> is specified in megabytes already). "
20154 "Adding a suffix will probably not do what you expect."
20158 #: ../fish/guestfish.pod:623
20159 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20163 #: ../fish/guestfish.pod:625
20165 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20166 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20170 #: ../fish/guestfish.pod:628
20173 " 1234 decimal number 1234\n"
20174 " 02322 octal number, equivalent to decimal 1234\n"
20175 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20180 #: ../fish/guestfish.pod:632
20182 "When using the C<chmod> command, you almost always want to specify an octal "
20183 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20184 "L<chmod(1)> program):"
20188 #: ../fish/guestfish.pod:636
20191 " chmod 0777 /public # OK\n"
20192 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20197 #: ../fish/guestfish.pod:639
20199 "Commands that return numbers usually print them in decimal, but some "
20200 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20201 "octal, preceeded by C<0>)."
20205 #: ../fish/guestfish.pod:643
20206 msgid "WILDCARDS AND GLOBBING"
20210 #: ../fish/guestfish.pod:645
20212 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20213 "(globbing) by default. So for example the following will not do what you "
20218 #: ../fish/guestfish.pod:649
20226 #: ../fish/guestfish.pod:651
20228 "Assuming you don't have a directory called literally C</home/*> then the "
20229 "above command will return an error."
20233 #: ../fish/guestfish.pod:654
20234 msgid "To perform wildcard expansion, use the C<glob> command."
20238 #: ../fish/guestfish.pod:656
20241 " glob rm-rf /home/*\n"
20246 #: ../fish/guestfish.pod:658
20248 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20249 "many times), equivalent to:"
20253 #: ../fish/guestfish.pod:661
20256 " rm-rf /home/jim\n"
20257 " rm-rf /home/joe\n"
20258 " rm-rf /home/mary\n"
20263 #: ../fish/guestfish.pod:665
20264 msgid "C<glob> only works on simple guest paths and not on device names."
20268 #: ../fish/guestfish.pod:667
20270 "If you have several parameters, each containing a wildcard, then glob will "
20271 "perform a Cartesian product."
20275 #: ../fish/guestfish.pod:670
20280 #: ../fish/guestfish.pod:672
20282 "Any line which starts with a I<#> character is treated as a comment and "
20283 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20284 "a command. For example:"
20288 #: ../fish/guestfish.pod:676
20291 " # this is a comment\n"
20292 " # this is a comment\n"
20293 " foo # NOT a comment\n"
20298 #: ../fish/guestfish.pod:680
20299 msgid "Blank lines are also ignored."
20303 #: ../fish/guestfish.pod:682
20304 msgid "RUNNING COMMANDS LOCALLY"
20308 #: ../fish/guestfish.pod:684
20310 "Any line which starts with a I<!> character is treated as a command sent to "
20311 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20315 #: ../fish/guestfish.pod:688
20319 " tgz-out /remote local/remote-data.tar.gz\n"
20324 #: ../fish/guestfish.pod:691
20326 "will create a directory C<local> on the host, and then export the contents "
20327 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20328 "(See C<tgz-out>)."
20332 #: ../fish/guestfish.pod:695
20334 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20335 "effect, due to the way that subprocesses work in Unix."
20339 #: ../fish/guestfish.pod:698
20340 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20344 #: ../fish/guestfish.pod:700
20346 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20347 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20348 "and executed as guestfish commands."
20352 #: ../fish/guestfish.pod:704
20354 "Thus you can use shell script to construct arbitrary guestfish commands "
20355 "which are then parsed by guestfish."
20359 #: ../fish/guestfish.pod:707
20361 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20362 "through C</foo.100>) using guestfish commands alone. However this is simple "
20363 "if we use a shell script to create the guestfish commands for us:"
20367 #: ../fish/guestfish.pod:712
20370 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20375 #: ../fish/guestfish.pod:714
20376 msgid "or with names like C</foo.001>:"
20380 #: ../fish/guestfish.pod:716
20383 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20388 #: ../fish/guestfish.pod:718
20390 "When using guestfish interactively it can be helpful to just run the shell "
20391 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20392 "ordinary I<!> local command), see what guestfish commands it would run, and "
20393 "when you are happy with those prepend the C<E<lt>> character to run the "
20394 "guestfish commands for real."
20398 #: ../fish/guestfish.pod:724
20403 #: ../fish/guestfish.pod:726
20405 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20406 "command (a guestfish command) to the second command (any host command). For "
20411 #: ../fish/guestfish.pod:730
20414 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20419 #: ../fish/guestfish.pod:732
20421 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20422 "program). The above command would list all accounts in the guest filesystem "
20423 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20427 #: ../fish/guestfish.pod:737
20430 " hexdump /bin/ls | head\n"
20431 " list-devices | tail -1\n"
20432 " tgz-out / - | tar ztf -\n"
20437 #: ../fish/guestfish.pod:741
20439 "The space before the pipe symbol is required, any space after the pipe "
20440 "symbol is optional. Everything after the pipe symbol is just passed "
20441 "straight to the host shell, so it can contain redirections, globs and "
20442 "anything else that makes sense on the host side."
20446 #: ../fish/guestfish.pod:746
20448 "To use a literal argument which begins with a pipe symbol, you have to quote "
20453 #: ../fish/guestfish.pod:749
20461 #: ../fish/guestfish.pod:751
20462 msgid "HOME DIRECTORIES"
20466 #: ../fish/guestfish.pod:753
20468 "If a parameter starts with the character C<~> then the tilde may be expanded "
20469 "as a home directory path (either C<~> for the current user's home directory, "
20470 "or C<~user> for another user)."
20474 #: ../fish/guestfish.pod:757
20476 "Note that home directory expansion happens for users known I<on the host>, "
20477 "not in the guest filesystem."
20481 #: ../fish/guestfish.pod:760
20483 "To use a literal argument which begins with a tilde, you have to quote it, "
20488 #: ../fish/guestfish.pod:763
20496 #: ../fish/guestfish.pod:767
20498 "Libguestfs has some support for Linux guests encrypted according to the "
20499 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20500 "disk encryption systems used by modern Linux guests. Currently only "
20501 "LVM-on-LUKS is supported."
20505 #: ../fish/guestfish.pod:772
20506 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20510 #: ../fish/guestfish.pod:774
20513 " ><fs> vfs-type /dev/sda2\n"
20519 #: ../fish/guestfish.pod:777
20521 "Then open those devices using L</luks-open>. This creates a device-mapper "
20522 "device called C</dev/mapper/luksdev>."
20526 #: ../fish/guestfish.pod:780
20529 " ><fs> luks-open /dev/sda2 luksdev\n"
20530 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20535 #: ../fish/guestfish.pod:783
20537 "Finally you have to tell LVM to scan for volume groups on the newly created "
20542 #: ../fish/guestfish.pod:786
20546 " vg-activate-all true\n"
20551 #: ../fish/guestfish.pod:789
20552 msgid "The logical volume(s) can now be mounted in the usual way."
20556 #: ../fish/guestfish.pod:791
20558 "Before closing a LUKS device you must unmount any logical volumes on it and "
20559 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20560 "one. Then you can close the mapper device:"
20564 #: ../fish/guestfish.pod:795
20567 " vg-activate false /dev/VG\n"
20568 " luks-close /dev/mapper/luksdev\n"
20573 #: ../fish/guestfish.pod:798 ../tools/virt-edit.pl:342
20574 msgid "WINDOWS PATHS"
20578 #: ../fish/guestfish.pod:800
20580 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20581 "letters and paths (with some limitations). The following commands are "
20586 #: ../fish/guestfish.pod:804
20589 " file /WINDOWS/system32/config/system.LOG\n"
20594 #: ../fish/guestfish.pod:806
20597 " file win:\\windows\\system32\\config\\system.log\n"
20602 #: ../fish/guestfish.pod:808
20605 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20610 #: ../fish/guestfish.pod:810
20612 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20613 "where the drive is mounted, prepending that to the path, changing all "
20614 "backslash characters to forward slash, then resolving the result using "
20615 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
20616 "then the parameter might be rewritten like this:"
20620 #: ../fish/guestfish.pod:816
20623 " win:e:\\foo\\bar => /e/FOO/bar\n"
20628 #: ../fish/guestfish.pod:818
20629 msgid "This only works in argument positions that expect a path."
20633 #: ../fish/guestfish.pod:820
20634 msgid "UPLOADING AND DOWNLOADING FILES"
20638 #: ../fish/guestfish.pod:822
20640 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20641 "others which upload from or download to a local file, you can use the "
20642 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20646 #: ../fish/guestfish.pod:826
20654 #: ../fish/guestfish.pod:828
20655 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20659 #: ../fish/guestfish.pod:831
20662 " tar-out /etc - | tar tf -\n"
20667 #: ../fish/guestfish.pod:833
20669 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20670 "command (see L</PIPES>)."
20674 #: ../fish/guestfish.pod:836
20676 "When using C<-> to read from stdin, the input is read up to the end of "
20677 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20678 "some arbitrary end marker:"
20682 #: ../fish/guestfish.pod:840
20685 " upload -<<END /foo\n"
20694 #: ../fish/guestfish.pod:846
20696 "Any string of characters can be used instead of C<END>. The end marker must "
20697 "appear on a line of its own, without any preceeding or following characters "
20698 "(not even spaces)."
20702 #: ../fish/guestfish.pod:850
20704 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20705 "upload local files (so-called \"FileIn\" parameters in the generator)."
20709 #: ../fish/guestfish.pod:853
20710 msgid "EXIT ON ERROR BEHAVIOUR"
20714 #: ../fish/guestfish.pod:855
20716 "By default, guestfish will ignore any errors when in interactive mode "
20717 "(ie. taking commands from a human over a tty), and will exit on the first "
20718 "error in non-interactive mode (scripts, commands given on the command line)."
20722 #: ../fish/guestfish.pod:860
20724 "If you prefix a command with a I<-> character, then that command will not "
20725 "cause guestfish to exit, even if that (one) command returns an error."
20729 #: ../fish/guestfish.pod:864
20730 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20734 #: ../fish/guestfish.pod:866
20736 "Guestfish can be remote-controlled over a socket. This is useful "
20737 "particularly in shell scripts where you want to make several different "
20738 "changes to a filesystem, but you don't want the overhead of starting up a "
20739 "guestfish process each time."
20743 #: ../fish/guestfish.pod:871
20744 msgid "Start a guestfish server process using:"
20748 #: ../fish/guestfish.pod:873
20751 " eval \"`guestfish --listen`\"\n"
20756 #: ../fish/guestfish.pod:875
20757 msgid "and then send it commands by doing:"
20761 #: ../fish/guestfish.pod:877
20764 " guestfish --remote cmd [...]\n"
20769 #: ../fish/guestfish.pod:879
20770 msgid "To cause the server to exit, send it the exit command:"
20774 #: ../fish/guestfish.pod:881
20777 " guestfish --remote exit\n"
20782 #: ../fish/guestfish.pod:883
20784 "Note that the server will normally exit if there is an error in a command. "
20785 "You can change this in the usual way. See section L</EXIT ON ERROR "
20790 #: ../fish/guestfish.pod:887
20791 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20795 #: ../fish/guestfish.pod:889
20797 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20798 "is how the I<--remote> option knows where to send the commands. You can "
20799 "have several guestfish listener processes running using:"
20803 #: ../fish/guestfish.pod:893
20806 " eval \"`guestfish --listen`\"\n"
20807 " pid1=$GUESTFISH_PID\n"
20808 " eval \"`guestfish --listen`\"\n"
20809 " pid2=$GUESTFISH_PID\n"
20811 " guestfish --remote=$pid1 cmd\n"
20812 " guestfish --remote=$pid2 cmd\n"
20817 #: ../fish/guestfish.pod:901
20818 msgid "REMOTE CONTROL AND CSH"
20822 #: ../fish/guestfish.pod:903
20824 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
20829 #: ../fish/guestfish.pod:906
20832 " eval \"`guestfish --listen --csh`\"\n"
20837 #: ../fish/guestfish.pod:908
20838 msgid "REMOTE CONTROL DETAILS"
20842 #: ../fish/guestfish.pod:910
20844 "Remote control happens over a Unix domain socket called "
20845 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
20846 "of the process, and C<$PID> is the process ID of the server."
20850 #: ../fish/guestfish.pod:914
20851 msgid "Guestfish client and server versions must match exactly."
20855 #: ../fish/guestfish.pod:916
20856 msgid "REMOTE CONTROL RUN COMMAND HANGING"
20860 #: ../fish/guestfish.pod:918
20862 "Using the C<run> (or C<launch>) command remotely in a command substitution "
20863 "context hangs, ie. don't do (note the backquotes):"
20867 #: ../fish/guestfish.pod:921
20870 " a=`guestfish --remote run`\n"
20875 #: ../fish/guestfish.pod:923
20877 "Since the C<run> command produces no output on stdout, this is not useful "
20878 "anyway. For further information see "
20879 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
20883 #: ../fish/guestfish.pod:927
20884 msgid "PREPARED DISK IMAGES"
20888 #: ../fish/guestfish.pod:929
20890 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
20891 "preformatted disk images that guestfish can make for you to save typing. "
20892 "This is particularly useful for testing purposes. This option is used "
20893 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
20894 "can be mixed with I<-a>)."
20898 #: ../fish/guestfish.pod:935
20900 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
20901 "the second and so on. Existing files in the current directory are "
20906 #: ../fish/guestfish.pod:939
20908 "The type briefly describes how the disk should be sized, partitioned, how "
20909 "filesystem(s) should be created, and how content should be added. "
20910 "Optionally the type can be followed by extra parameters, separated by C<:> "
20911 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
20912 "sparsely-allocated disk, containing a single partition, with the partition "
20913 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
20914 "on a 1GB disk instead."
20918 #: ../fish/guestfish.pod:947
20919 msgid "To list the available types and any extra parameters they take, run:"
20923 #: ../fish/guestfish.pod:951
20925 "Note that the prepared filesystem is not mounted. You would usually have to "
20926 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
20930 #: ../fish/guestfish.pod:955
20932 "If any I<-N> or I<--new> options are given, the guest is automatically "
20937 #: ../fish/guestfish.pod:960
20938 msgid "Create a 100MB disk with an ext4-formatted partition:"
20942 #: ../fish/guestfish.pod:962
20945 " guestfish -N fs:ext4\n"
20950 #: ../fish/guestfish.pod:964
20951 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
20955 #: ../fish/guestfish.pod:966
20958 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
20963 #: ../fish/guestfish.pod:968
20964 msgid "Create a blank 200MB disk:"
20968 #: ../fish/guestfish.pod:970
20971 " guestfish -N disk:200M\n"
20976 #: ../fish/guestfish.pod:972
20977 msgid "PROGRESS BARS"
20981 #: ../fish/guestfish.pod:974
20983 "Some (not all) long-running commands send progress notification messages as "
20984 "they are running. Guestfish turns these messages into progress bars."
20988 #: ../fish/guestfish.pod:978
20990 "When a command that supports progress bars takes longer than two seconds to "
20991 "run, and if progress bars are enabled, then you will see one appearing below "
20996 #: ../fish/guestfish.pod:982
20999 " ><fs> copy-size /large-file /another-file 2048M\n"
21000 " / 10% [#####-----------------------------------------] 00:30\n"
21005 #: ../fish/guestfish.pod:985
21007 "The spinner on the left hand side moves round once for every progress "
21008 "notification received from the backend. This is a (reasonably) golden "
21009 "assurance that the command is \"doing something\" even if the progress bar "
21010 "is not moving, because the command is able to send the progress "
21011 "notifications. When the bar reaches 100% and the command finishes, the "
21012 "spinner disappears."
21016 #: ../fish/guestfish.pod:992
21018 "Progress bars are enabled by default when guestfish is used interactively. "
21019 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21020 "and you can disable them completely using I<--no-progress-bars>."
21024 #: ../fish/guestfish.pod:997
21025 msgid "GUESTFISH COMMANDS"
21029 #: ../fish/guestfish.pod:999
21031 "The commands in this section are guestfish convenience commands, in other "
21032 "words, they are not part of the L<guestfs(3)> API."
21036 #: ../fish/guestfish.pod:1002
21041 #: ../fish/guestfish.pod:1004
21050 #: ../fish/guestfish.pod:1007
21051 msgid "Without any parameter, this provides general help."
21055 #: ../fish/guestfish.pod:1009
21056 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21060 #: ../fish/guestfish.pod:1011
21061 msgid "quit | exit"
21065 #: ../fish/guestfish.pod:1013
21066 msgid "This exits guestfish. You can also use C<^D> key."
21070 #: ../fish/guestfish.pod:1015
21071 msgid "@FISH_COMMANDS@"
21075 #: ../fish/guestfish.pod:1017
21080 #: ../fish/guestfish.pod:1021 ../test-tool/libguestfs-test-tool.pod:77
21085 #: ../fish/guestfish.pod:1023
21087 "guestfish returns 0 if the commands completed without error, or 1 if there "
21092 #: ../fish/guestfish.pod:1030
21097 #: ../fish/guestfish.pod:1032
21099 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21104 #: ../fish/guestfish.pod:1035
21105 msgid "GUESTFISH_PID"
21109 #: ../fish/guestfish.pod:1037
21111 "Used with the I<--remote> option to specify the remote guestfish process to "
21112 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21116 #: ../fish/guestfish.pod:1041
21121 #: ../fish/guestfish.pod:1043
21123 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21124 "not specified, the external L<hexedit(1)> program is used."
21128 #: ../fish/guestfish.pod:1047
21133 #: ../fish/guestfish.pod:1049
21135 "If compiled with GNU readline support, various files in the home directory "
21136 "can be used. See L</FILES>."
21140 #: ../fish/guestfish.pod:1058
21142 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21143 "effect as using the B<-v> option."
21147 #: ../fish/guestfish.pod:1070
21149 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21150 "the discussion of paths in L<guestfs(3)>."
21154 #: ../fish/guestfish.pod:1081
21155 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21159 #: ../fish/guestfish.pod:1083
21164 #: ../fish/guestfish.pod:1085
21166 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21171 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:262
21176 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:266
21177 msgid "$HOME/.libguestfs-tools.rc"
21181 #: ../fish/guestfish.pod:1107 ../fuse/guestmount.pod:268
21182 msgid "/etc/libguestfs-tools.conf"
21186 #: ../fish/guestfish.pod:1109 ../fuse/guestmount.pod:270
21188 "This configuration file controls the default read-only or read-write mode "
21189 "(I<--ro> or I<--rw>)."
21193 #: ../fish/guestfish.pod:1112
21194 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21198 #: ../fish/guestfish.pod:1114
21199 msgid "$HOME/.guestfish"
21203 #: ../fish/guestfish.pod:1116
21205 "If compiled with GNU readline support, then the command history is saved in "
21210 #: ../fish/guestfish.pod:1119
21211 msgid "$HOME/.inputrc"
21215 #: ../fish/guestfish.pod:1121
21216 msgid "/etc/inputrc"
21220 #: ../fish/guestfish.pod:1123
21222 "If compiled with GNU readline support, then these files can be used to "
21223 "configure readline. For further information, please see "
21224 "L<readline(3)/INITIALIZATION FILE>."
21228 #: ../fish/guestfish.pod:1127
21229 msgid "To write rules which only apply to guestfish, use:"
21233 #: ../fish/guestfish.pod:1129
21243 #: ../fish/guestfish.pod:1133
21245 "Variables that you can set in inputrc that change the behaviour of guestfish "
21246 "in useful ways include:"
21250 #: ../fish/guestfish.pod:1138
21251 msgid "completion-ignore-case (default: on)"
21255 #: ../fish/guestfish.pod:1140
21257 "By default, guestfish will ignore case when tab-completing paths on the "
21262 #: ../fish/guestfish.pod:1143
21265 " set completion-ignore-case off\n"
21270 #: ../fish/guestfish.pod:1145
21271 msgid "to make guestfish case sensitive."
21275 #: ../fish/guestfish.pod:1149
21280 #: ../fish/guestfish.pod:1151
21281 msgid "test2.img (etc)"
21285 #: ../fish/guestfish.pod:1153
21287 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21288 "will be created in the file C<test1.img> in the current directory. The "
21289 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21290 "the same name will be overwritten."
21294 #: ../fish/guestfish.pod:1162
21296 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
21297 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
21298 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
21299 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21300 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21301 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
21305 #: ../fish/guestfish.pod:1192 ../test-tool/libguestfs-test-tool.pod:102 ../fuse/guestmount.pod:297 ../tools/virt-edit.pl:518 ../tools/virt-win-reg.pl:606 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
21307 "This program is free software; you can redistribute it and/or modify it "
21308 "under the terms of the GNU General Public License as published by the Free "
21309 "Software Foundation; either version 2 of the License, or (at your option) "
21310 "any later version."
21314 #: ../fish/guestfish.pod:1197 ../test-tool/libguestfs-test-tool.pod:107 ../fuse/guestmount.pod:302 ../tools/virt-edit.pl:523 ../tools/virt-win-reg.pl:611 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
21316 "This program is distributed in the hope that it will be useful, but WITHOUT "
21317 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21318 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21323 #: ../fish/guestfish.pod:1202 ../test-tool/libguestfs-test-tool.pod:112 ../fuse/guestmount.pod:307 ../tools/virt-edit.pl:528 ../tools/virt-win-reg.pl:616 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
21325 "You should have received a copy of the GNU General Public License along with "
21326 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21327 "Ave, Cambridge, MA 02139, USA."
21331 #: ../fish/guestfish-actions.pod:1
21336 #: ../fish/guestfish-actions.pod:3
21339 " add-cdrom filename\n"
21344 #: ../fish/guestfish-actions.pod:15
21346 "This call checks for the existence of C<filename>. This stops you from "
21347 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21348 "and C<http:> URLs. To specify those, use the general L</config> call "
21353 #: ../fish/guestfish-actions.pod:22
21355 "If you just want to add an ISO file (often you use this as an efficient way "
21356 "to transfer large files into the guest), then you should probably use "
21357 "L</add-drive-ro> instead."
21361 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
21363 "This function is deprecated. In new code, use the L</add_drive_opts> call "
21368 #: ../fish/guestfish-actions.pod:35
21373 #: ../fish/guestfish-actions.pod:37
21378 #: ../fish/guestfish-actions.pod:39
21381 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
21386 #: ../fish/guestfish-actions.pod:41
21388 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21389 "It works by connecting to libvirt, requesting the domain and domain XML from "
21390 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21394 #: ../fish/guestfish-actions.pod:71
21396 "The other optional parameters are passed directly through to "
21397 "L</add-drive-opts>."
21401 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138 ../fish/guestfish-actions.pod:3049
21403 "This command has one or more optional arguments. See L</OPTIONAL "
21408 #: ../fish/guestfish-actions.pod:76
21413 #: ../fish/guestfish-actions.pod:78
21416 " add-drive filename\n"
21421 #: ../fish/guestfish-actions.pod:80
21423 "This function is the equivalent of calling L</add-drive-opts> with no "
21424 "optional parameters, so the disk is added writable, with the format being "
21425 "detected automatically."
21429 #: ../fish/guestfish-actions.pod:84
21431 "Automatic detection of the format opens you up to a potential security hole "
21432 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21433 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21434 "you should think about replacing calls to this function with calls to "
21435 "L</add-drive-opts>, and specifying the format."
21439 #: ../fish/guestfish-actions.pod:91
21440 msgid "add-drive-opts"
21444 #: ../fish/guestfish-actions.pod:93
21449 #: ../fish/guestfish-actions.pod:95
21452 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21457 #: ../fish/guestfish-actions.pod:122
21459 "This forces the image format. If you omit this (or use L</add-drive> or "
21460 "L</add-drive-ro>) then the format is automatically detected. Possible "
21461 "formats include C<raw> and C<qcow2>."
21465 #: ../fish/guestfish-actions.pod:133
21467 "This rarely-used option lets you emulate the behaviour of the deprecated "
21468 "L</add-drive-with-if> call (q.v.)"
21472 #: ../fish/guestfish-actions.pod:140
21473 msgid "add-drive-ro"
21477 #: ../fish/guestfish-actions.pod:142
21482 #: ../fish/guestfish-actions.pod:144
21485 " add-drive-ro filename\n"
21490 #: ../fish/guestfish-actions.pod:146
21492 "This function is the equivalent of calling L</add-drive-opts> with the "
21493 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21494 "is added read-only, with the format being detected automatically."
21498 #: ../fish/guestfish-actions.pod:151
21499 msgid "add-drive-ro-with-if"
21503 #: ../fish/guestfish-actions.pod:153
21506 " add-drive-ro-with-if filename iface\n"
21511 #: ../fish/guestfish-actions.pod:155
21513 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21514 "interface emulation to use at run time."
21518 #: ../fish/guestfish-actions.pod:165
21519 msgid "add-drive-with-if"
21523 #: ../fish/guestfish-actions.pod:167
21526 " add-drive-with-if filename iface\n"
21531 #: ../fish/guestfish-actions.pod:169
21533 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21534 "interface emulation to use at run time."
21538 #: ../fish/guestfish-actions.pod:179
21543 #: ../fish/guestfish-actions.pod:181
21546 " aug-clear augpath\n"
21551 #: ../fish/guestfish-actions.pod:186
21556 #: ../fish/guestfish-actions.pod:188
21564 #: ../fish/guestfish-actions.pod:190
21566 "Close the current Augeas handle and free up any resources used by it. After "
21567 "calling this, you have to call L</aug-init> again before you can use any "
21568 "other Augeas functions."
21572 #: ../fish/guestfish-actions.pod:195
21573 msgid "aug-defnode"
21577 #: ../fish/guestfish-actions.pod:197
21580 " aug-defnode name expr val\n"
21585 #: ../fish/guestfish-actions.pod:202
21587 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21588 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21589 "containing that single node."
21593 #: ../fish/guestfish-actions.pod:210
21598 #: ../fish/guestfish-actions.pod:212
21601 " aug-defvar name expr\n"
21606 #: ../fish/guestfish-actions.pod:221
21611 #: ../fish/guestfish-actions.pod:223
21614 " aug-get augpath\n"
21619 #: ../fish/guestfish-actions.pod:228
21624 #: ../fish/guestfish-actions.pod:230
21627 " aug-init root flags\n"
21632 #: ../fish/guestfish-actions.pod:236
21633 msgid "You must call this before using any other L</aug-*> commands."
21637 #: ../fish/guestfish-actions.pod:261
21639 "This option is only useful when debugging Augeas lenses. Use of this option "
21640 "may require additional memory for the libguestfs appliance. You may need to "
21641 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
21645 #: ../fish/guestfish-actions.pod:276
21646 msgid "Do not load the tree in L</aug-init>."
21650 #: ../fish/guestfish-actions.pod:280
21651 msgid "To close the handle, you can call L</aug-close>."
21655 #: ../fish/guestfish-actions.pod:284
21660 #: ../fish/guestfish-actions.pod:286
21663 " aug-insert augpath label true|false\n"
21668 #: ../fish/guestfish-actions.pod:296
21673 #: ../fish/guestfish-actions.pod:298
21681 #: ../fish/guestfish-actions.pod:305
21686 #: ../fish/guestfish-actions.pod:307
21689 " aug-ls augpath\n"
21694 #: ../fish/guestfish-actions.pod:309
21696 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21697 "resulting nodes into alphabetical order."
21701 #: ../fish/guestfish-actions.pod:312
21706 #: ../fish/guestfish-actions.pod:314
21709 " aug-match augpath\n"
21714 #: ../fish/guestfish-actions.pod:320
21719 #: ../fish/guestfish-actions.pod:322
21722 " aug-mv src dest\n"
21727 #: ../fish/guestfish-actions.pod:327
21732 #: ../fish/guestfish-actions.pod:329
21735 " aug-rm augpath\n"
21740 #: ../fish/guestfish-actions.pod:335
21745 #: ../fish/guestfish-actions.pod:337
21753 #: ../fish/guestfish-actions.pod:341
21755 "The flags which were passed to L</aug-init> affect exactly how files are "
21760 #: ../fish/guestfish-actions.pod:344
21765 #: ../fish/guestfish-actions.pod:346
21768 " aug-set augpath val\n"
21773 #: ../fish/guestfish-actions.pod:350
21775 "In the Augeas API, it is possible to clear a node by setting the value to "
21776 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21777 "this call. Instead you must use the L</aug-clear> call."
21781 #: ../fish/guestfish-actions.pod:355
21786 #: ../fish/guestfish-actions.pod:357
21789 " available 'groups ...'\n"
21794 #: ../fish/guestfish-actions.pod:363
21796 "The libguestfs groups, and the functions that those groups correspond to, "
21797 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21798 "runtime by calling L</available-all-groups>."
21802 #: ../fish/guestfish-actions.pod:387
21803 msgid "You must call L</launch> before calling this function."
21807 #: ../fish/guestfish-actions.pod:409
21809 "This call was added in version C<1.0.80>. In previous versions of "
21810 "libguestfs all you could do would be to speculatively execute a command to "
21811 "find out if the daemon implemented it. See also L</version>."
21815 #: ../fish/guestfish-actions.pod:416
21816 msgid "available-all-groups"
21820 #: ../fish/guestfish-actions.pod:418
21823 " available-all-groups\n"
21828 #: ../fish/guestfish-actions.pod:420
21830 "This command returns a list of all optional groups that this daemon knows "
21831 "about. Note this returns both supported and unsupported groups. To find "
21832 "out which ones the daemon can actually support you have to call "
21833 "L</available> on each member of the returned list."
21837 #: ../fish/guestfish-actions.pod:426
21838 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
21842 #: ../fish/guestfish-actions.pod:428
21847 #: ../fish/guestfish-actions.pod:430
21850 " base64-in (base64file|-) filename\n"
21855 #: ../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:4491 ../fish/guestfish-actions.pod:4503 ../fish/guestfish-actions.pod:4514 ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4577 ../fish/guestfish-actions.pod:4586 ../fish/guestfish-actions.pod:4640 ../fish/guestfish-actions.pod:4663
21856 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
21860 #: ../fish/guestfish-actions.pod:437
21865 #: ../fish/guestfish-actions.pod:439
21868 " base64-out filename (base64file|-)\n"
21873 #: ../fish/guestfish-actions.pod:446
21874 msgid "blockdev-flushbufs"
21878 #: ../fish/guestfish-actions.pod:448
21881 " blockdev-flushbufs device\n"
21886 #: ../fish/guestfish-actions.pod:455
21887 msgid "blockdev-getbsz"
21891 #: ../fish/guestfish-actions.pod:457
21894 " blockdev-getbsz device\n"
21899 #: ../fish/guestfish-actions.pod:466
21900 msgid "blockdev-getro"
21904 #: ../fish/guestfish-actions.pod:468
21907 " blockdev-getro device\n"
21912 #: ../fish/guestfish-actions.pod:475
21913 msgid "blockdev-getsize64"
21917 #: ../fish/guestfish-actions.pod:477
21920 " blockdev-getsize64 device\n"
21925 #: ../fish/guestfish-actions.pod:481
21926 msgid "See also L</blockdev-getsz>."
21930 #: ../fish/guestfish-actions.pod:485
21931 msgid "blockdev-getss"
21935 #: ../fish/guestfish-actions.pod:487
21938 " blockdev-getss device\n"
21943 #: ../fish/guestfish-actions.pod:492
21944 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
21948 #: ../fish/guestfish-actions.pod:497
21949 msgid "blockdev-getsz"
21953 #: ../fish/guestfish-actions.pod:499
21956 " blockdev-getsz device\n"
21961 #: ../fish/guestfish-actions.pod:504
21963 "See also L</blockdev-getss> for the real sector size of the device, and "
21964 "L</blockdev-getsize64> for the more useful I<size in bytes>."
21968 #: ../fish/guestfish-actions.pod:510
21969 msgid "blockdev-rereadpt"
21973 #: ../fish/guestfish-actions.pod:512
21976 " blockdev-rereadpt device\n"
21981 #: ../fish/guestfish-actions.pod:518
21982 msgid "blockdev-setbsz"
21986 #: ../fish/guestfish-actions.pod:520
21989 " blockdev-setbsz device blocksize\n"
21994 #: ../fish/guestfish-actions.pod:529
21995 msgid "blockdev-setro"
21999 #: ../fish/guestfish-actions.pod:531
22002 " blockdev-setro device\n"
22007 #: ../fish/guestfish-actions.pod:537
22008 msgid "blockdev-setrw"
22012 #: ../fish/guestfish-actions.pod:539
22015 " blockdev-setrw device\n"
22020 #: ../fish/guestfish-actions.pod:545
22021 msgid "case-sensitive-path"
22025 #: ../fish/guestfish-actions.pod:547
22028 " case-sensitive-path path\n"
22033 #: ../fish/guestfish-actions.pod:571
22035 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
22036 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22037 "how the directories were originally created under Windows)."
22041 #: ../fish/guestfish-actions.pod:579
22042 msgid "See also L</realpath>."
22046 #: ../fish/guestfish-actions.pod:581
22051 #: ../fish/guestfish-actions.pod:583
22059 #: ../fish/guestfish-actions.pod:587
22061 "Note that this function cannot correctly handle binary files (specifically, "
22062 "files containing C<\\0> character which is treated as end of string). For "
22063 "those you need to use the L</read-file> or L</download> functions which have "
22064 "a more complex interface."
22068 #: ../fish/guestfish-actions.pod:595
22073 #: ../fish/guestfish-actions.pod:597
22076 " checksum csumtype path\n"
22081 #: ../fish/guestfish-actions.pod:640
22082 msgid "To get the checksum for a device, use L</checksum-device>."
22086 #: ../fish/guestfish-actions.pod:642
22087 msgid "To get the checksums for many files, use L</checksums-out>."
22091 #: ../fish/guestfish-actions.pod:644
22092 msgid "checksum-device"
22096 #: ../fish/guestfish-actions.pod:646
22099 " checksum-device csumtype device\n"
22104 #: ../fish/guestfish-actions.pod:648
22106 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22107 "device named C<device>. For the types of checksums supported see the "
22108 "L</checksum> command."
22112 #: ../fish/guestfish-actions.pod:652
22113 msgid "checksums-out"
22117 #: ../fish/guestfish-actions.pod:654
22120 " checksums-out csumtype directory (sumsfile|-)\n"
22125 #: ../fish/guestfish-actions.pod:670
22130 #: ../fish/guestfish-actions.pod:672
22133 " chmod mode path\n"
22138 #: ../fish/guestfish-actions.pod:683
22143 #: ../fish/guestfish-actions.pod:685
22146 " chown owner group path\n"
22151 #: ../fish/guestfish-actions.pod:693
22156 #: ../fish/guestfish-actions.pod:695
22159 " command 'arguments ...'\n"
22164 #: ../fish/guestfish-actions.pod:702
22166 "The single parameter is an argv-style list of arguments. The first element "
22167 "is the name of the program to run. Subsequent elements are parameters. The "
22168 "list must be non-empty (ie. must contain a program name). Note that the "
22169 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22173 #: ../fish/guestfish-actions.pod:730
22174 msgid "command-lines"
22178 #: ../fish/guestfish-actions.pod:732
22181 " command-lines 'arguments ...'\n"
22186 #: ../fish/guestfish-actions.pod:734
22187 msgid "This is the same as L</command>, but splits the result into a list of lines."
22191 #: ../fish/guestfish-actions.pod:737
22192 msgid "See also: L</sh-lines>"
22196 #: ../fish/guestfish-actions.pod:742
22201 #: ../fish/guestfish-actions.pod:744
22204 " config qemuparam qemuvalue\n"
22209 #: ../fish/guestfish-actions.pod:755
22214 #: ../fish/guestfish-actions.pod:757
22217 " copy-size src dest size\n"
22222 #: ../fish/guestfish-actions.pod:765
22227 #: ../fish/guestfish-actions.pod:767
22235 #: ../fish/guestfish-actions.pod:772
22240 #: ../fish/guestfish-actions.pod:774
22248 #: ../fish/guestfish-actions.pod:779
22253 #: ../fish/guestfish-actions.pod:781
22261 #: ../fish/guestfish-actions.pod:788
22263 "If the destination is a device, it must be as large or larger than the "
22264 "source file or device, otherwise the copy will fail. This command cannot do "
22265 "partial copies (see L</copy-size>)."
22269 #: ../fish/guestfish-actions.pod:792
22274 #: ../fish/guestfish-actions.pod:794
22282 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
22284 "This command is mostly useful for interactive sessions. It is I<not> "
22285 "intended that you try to parse the output string. Use L</statvfs> from "
22290 #: ../fish/guestfish-actions.pod:802
22295 #: ../fish/guestfish-actions.pod:804
22303 #: ../fish/guestfish-actions.pod:813
22308 #: ../fish/guestfish-actions.pod:815
22316 #: ../fish/guestfish-actions.pod:821
22318 "Another way to get the same information is to enable verbose messages with "
22319 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22320 "before running the program."
22324 #: ../fish/guestfish-actions.pod:826
22329 #: ../fish/guestfish-actions.pod:828
22332 " download remotefilename (filename|-)\n"
22337 #: ../fish/guestfish-actions.pod:835
22338 msgid "See also L</upload>, L</cat>."
22342 #: ../fish/guestfish-actions.pod:839
22343 msgid "download-offset"
22347 #: ../fish/guestfish-actions.pod:841
22350 " download-offset remotefilename (filename|-) offset size\n"
22355 #: ../fish/guestfish-actions.pod:849
22357 "Note that there is no limit on the amount of data that can be downloaded "
22358 "with this call, unlike with L</pread>, and this call always reads the full "
22359 "amount unless an error occurs."
22363 #: ../fish/guestfish-actions.pod:854
22364 msgid "See also L</download>, L</pread>."
22368 #: ../fish/guestfish-actions.pod:858
22369 msgid "drop-caches"
22373 #: ../fish/guestfish-actions.pod:860
22376 " drop-caches whattodrop\n"
22381 #: ../fish/guestfish-actions.pod:872
22386 #: ../fish/guestfish-actions.pod:874
22394 #: ../fish/guestfish-actions.pod:886
22399 #: ../fish/guestfish-actions.pod:888
22402 " e2fsck-f device\n"
22407 #: ../fish/guestfish-actions.pod:894
22409 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22410 "should use L</fsck>."
22414 #: ../fish/guestfish-actions.pod:897
22415 msgid "echo-daemon"
22419 #: ../fish/guestfish-actions.pod:899
22422 " echo-daemon 'words ...'\n"
22427 #: ../fish/guestfish-actions.pod:906
22428 msgid "See also L</ping-daemon>."
22432 #: ../fish/guestfish-actions.pod:908
22437 #: ../fish/guestfish-actions.pod:910
22440 " egrep regex path\n"
22445 #: ../fish/guestfish-actions.pod:918
22450 #: ../fish/guestfish-actions.pod:920
22453 " egrepi regex path\n"
22458 #: ../fish/guestfish-actions.pod:928
22463 #: ../fish/guestfish-actions.pod:930
22466 " equal file1 file2\n"
22471 #: ../fish/guestfish-actions.pod:937
22476 #: ../fish/guestfish-actions.pod:939
22484 #: ../fish/guestfish-actions.pod:944
22485 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22489 #: ../fish/guestfish-actions.pod:946
22494 #: ../fish/guestfish-actions.pod:948
22497 " fallocate path len\n"
22502 #: ../fish/guestfish-actions.pod:958
22504 "This function is deprecated. In new code, use the L</fallocate64> call "
22509 #: ../fish/guestfish-actions.pod:965
22510 msgid "fallocate64"
22514 #: ../fish/guestfish-actions.pod:967
22517 " fallocate64 path len\n"
22522 #: ../fish/guestfish-actions.pod:973
22524 "Note that this call allocates disk blocks for the file. To create a sparse "
22525 "file use L</truncate-size> instead."
22529 #: ../fish/guestfish-actions.pod:976
22531 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22532 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22533 "maximum size of files created through that call to 1GB."
22537 #: ../fish/guestfish-actions.pod:985
22542 #: ../fish/guestfish-actions.pod:987
22545 " fgrep pattern path\n"
22550 #: ../fish/guestfish-actions.pod:995
22555 #: ../fish/guestfish-actions.pod:997
22558 " fgrepi pattern path\n"
22563 #: ../fish/guestfish-actions.pod:1005
22568 #: ../fish/guestfish-actions.pod:1007
22576 #: ../fish/guestfish-actions.pod:1023
22578 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
22583 #: ../fish/guestfish-actions.pod:1026
22584 msgid "file-architecture"
22588 #: ../fish/guestfish-actions.pod:1028
22591 " file-architecture filename\n"
22596 #: ../fish/guestfish-actions.pod:1131
22601 #: ../fish/guestfish-actions.pod:1133
22609 #: ../fish/guestfish-actions.pod:1137
22611 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22612 "L</is-file> etc. To get the size of block devices, use "
22613 "L</blockdev-getsize64>."
22617 #: ../fish/guestfish-actions.pod:1141
22622 #: ../fish/guestfish-actions.pod:1143
22625 " fill c len path\n"
22630 #: ../fish/guestfish-actions.pod:1149
22632 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22633 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22634 "L</fill-pattern>."
22638 #: ../fish/guestfish-actions.pod:1154
22639 msgid "fill-pattern"
22643 #: ../fish/guestfish-actions.pod:1156
22646 " fill-pattern pattern len path\n"
22651 #: ../fish/guestfish-actions.pod:1158
22653 "This function is like L</fill> except that it creates a new file of length "
22654 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22655 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22660 #: ../fish/guestfish-actions.pod:1163
22665 #: ../fish/guestfish-actions.pod:1165
22668 " find directory\n"
22673 #: ../fish/guestfish-actions.pod:1179
22674 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22678 #: ../fish/guestfish-actions.pod:1192
22679 msgid "See also L</find0>."
22683 #: ../fish/guestfish-actions.pod:1197
22688 #: ../fish/guestfish-actions.pod:1199
22691 " find0 directory (files|-)\n"
22696 #: ../fish/guestfish-actions.pod:1205
22697 msgid "This command works the same way as L</find> with the following exceptions:"
22701 #: ../fish/guestfish-actions.pod:1232
22702 msgid "findfs-label"
22706 #: ../fish/guestfish-actions.pod:1234
22709 " findfs-label label\n"
22714 #: ../fish/guestfish-actions.pod:1240
22715 msgid "To find the label of a filesystem, use L</vfs-label>."
22719 #: ../fish/guestfish-actions.pod:1242
22720 msgid "findfs-uuid"
22724 #: ../fish/guestfish-actions.pod:1244
22727 " findfs-uuid uuid\n"
22732 #: ../fish/guestfish-actions.pod:1250
22733 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22737 #: ../fish/guestfish-actions.pod:1252
22742 #: ../fish/guestfish-actions.pod:1254
22745 " fsck fstype device\n"
22750 #: ../fish/guestfish-actions.pod:1284
22755 #: ../fish/guestfish-actions.pod:1286
22763 #: ../fish/guestfish-actions.pod:1293
22764 msgid "get-attach-method"
22768 #: ../fish/guestfish-actions.pod:1295
22771 " get-attach-method\n"
22776 #: ../fish/guestfish-actions.pod:1297
22777 msgid "Return the current attach method. See L</set-attach-method>."
22781 #: ../fish/guestfish-actions.pod:1299
22782 msgid "get-autosync"
22786 #: ../fish/guestfish-actions.pod:1301
22794 #: ../fish/guestfish-actions.pod:1305
22799 #: ../fish/guestfish-actions.pod:1307
22807 #: ../fish/guestfish-actions.pod:1311
22808 msgid "get-e2label"
22812 #: ../fish/guestfish-actions.pod:1313
22815 " get-e2label device\n"
22820 #: ../fish/guestfish-actions.pod:1318
22822 "This function is deprecated. In new code, use the L</vfs_label> call "
22827 #: ../fish/guestfish-actions.pod:1325
22832 #: ../fish/guestfish-actions.pod:1327
22835 " get-e2uuid device\n"
22840 #: ../fish/guestfish-actions.pod:1332
22842 "This function is deprecated. In new code, use the L</vfs_uuid> call "
22847 #: ../fish/guestfish-actions.pod:1339
22848 msgid "get-memsize"
22852 #: ../fish/guestfish-actions.pod:1341
22860 #: ../fish/guestfish-actions.pod:1346
22862 "If L</set-memsize> was not called on this handle, and if "
22863 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
22864 "value for memsize."
22868 #: ../fish/guestfish-actions.pod:1353
22869 msgid "get-network"
22873 #: ../fish/guestfish-actions.pod:1355
22881 #: ../fish/guestfish-actions.pod:1359
22886 #: ../fish/guestfish-actions.pod:1361
22894 #: ../fish/guestfish-actions.pod:1368
22899 #: ../fish/guestfish-actions.pod:1370
22904 #: ../fish/guestfish-actions.pod:1372
22912 #: ../fish/guestfish-actions.pod:1379
22917 #: ../fish/guestfish-actions.pod:1381
22925 #: ../fish/guestfish-actions.pod:1388
22926 msgid "get-recovery-proc"
22930 #: ../fish/guestfish-actions.pod:1390
22933 " get-recovery-proc\n"
22938 #: ../fish/guestfish-actions.pod:1394
22939 msgid "get-selinux"
22943 #: ../fish/guestfish-actions.pod:1396
22951 #: ../fish/guestfish-actions.pod:1398
22953 "This returns the current setting of the selinux flag which is passed to the "
22954 "appliance at boot time. See L</set-selinux>."
22958 #: ../fish/guestfish-actions.pod:1404
22963 #: ../fish/guestfish-actions.pod:1406
22971 #: ../fish/guestfish-actions.pod:1413
22976 #: ../fish/guestfish-actions.pod:1415
22984 #: ../fish/guestfish-actions.pod:1419
22989 #: ../fish/guestfish-actions.pod:1421
22997 #: ../fish/guestfish-actions.pod:1423
22999 "Return the current umask. By default the umask is C<022> unless it has been "
23000 "set by calling L</umask>."
23004 #: ../fish/guestfish-actions.pod:1426
23005 msgid "get-verbose"
23009 #: ../fish/guestfish-actions.pod:1428
23017 #: ../fish/guestfish-actions.pod:1432
23022 #: ../fish/guestfish-actions.pod:1434
23030 #: ../fish/guestfish-actions.pod:1438
23031 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23035 #: ../fish/guestfish-actions.pod:1441
23040 #: ../fish/guestfish-actions.pod:1443
23043 " getxattr path name\n"
23048 #: ../fish/guestfish-actions.pod:1445
23050 "Get a single extended attribute from file C<path> named C<name>. This call "
23051 "follows symlinks. If you want to lookup an extended attribute for the "
23052 "symlink itself, use L</lgetxattr>."
23056 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2455
23058 "Normally it is better to get all extended attributes from a file in one go "
23059 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23060 "buggy and do not provide a way to list out attributes. For these "
23061 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23062 "attributes you want in advance and call this function."
23066 #: ../fish/guestfish-actions.pod:1459
23067 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23071 #: ../fish/guestfish-actions.pod:1461
23076 #: ../fish/guestfish-actions.pod:1463
23079 " getxattrs path\n"
23084 #: ../fish/guestfish-actions.pod:1471
23085 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23089 #: ../fish/guestfish-actions.pod:1473
23090 msgid "glob-expand"
23094 #: ../fish/guestfish-actions.pod:1475
23097 " glob-expand pattern\n"
23102 #: ../fish/guestfish-actions.pod:1488
23107 #: ../fish/guestfish-actions.pod:1490
23110 " grep regex path\n"
23115 #: ../fish/guestfish-actions.pod:1498
23120 #: ../fish/guestfish-actions.pod:1500
23123 " grepi regex path\n"
23128 #: ../fish/guestfish-actions.pod:1508
23129 msgid "grub-install"
23133 #: ../fish/guestfish-actions.pod:1510
23136 " grub-install root device\n"
23141 #: ../fish/guestfish-actions.pod:1526
23146 #: ../fish/guestfish-actions.pod:1528
23154 #: ../fish/guestfish-actions.pod:1536
23159 #: ../fish/guestfish-actions.pod:1538
23162 " head-n nrlines path\n"
23167 #: ../fish/guestfish-actions.pod:1551
23172 #: ../fish/guestfish-actions.pod:1553
23180 #: ../fish/guestfish-actions.pod:1561
23185 #: ../fish/guestfish-actions.pod:1563
23188 " initrd-cat initrdpath filename\n"
23193 #: ../fish/guestfish-actions.pod:1575
23194 msgid "See also L</initrd-list>."
23198 #: ../fish/guestfish-actions.pod:1580
23199 msgid "initrd-list"
23203 #: ../fish/guestfish-actions.pod:1582
23206 " initrd-list path\n"
23211 #: ../fish/guestfish-actions.pod:1594
23212 msgid "inotify-add-watch"
23216 #: ../fish/guestfish-actions.pod:1596
23219 " inotify-add-watch path mask\n"
23224 #: ../fish/guestfish-actions.pod:1608
23225 msgid "inotify-close"
23229 #: ../fish/guestfish-actions.pod:1610
23237 #: ../fish/guestfish-actions.pod:1616
23238 msgid "inotify-files"
23242 #: ../fish/guestfish-actions.pod:1618
23250 #: ../fish/guestfish-actions.pod:1620
23252 "This function is a helpful wrapper around L</inotify-read> which just "
23253 "returns a list of pathnames of objects that were touched. The returned "
23254 "pathnames are sorted and deduplicated."
23258 #: ../fish/guestfish-actions.pod:1624
23259 msgid "inotify-init"
23263 #: ../fish/guestfish-actions.pod:1626
23266 " inotify-init maxevents\n"
23271 #: ../fish/guestfish-actions.pod:1632
23273 "C<maxevents> is the maximum number of events which will be queued up between "
23274 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23275 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23276 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23277 "but records the fact that it threw them away by setting a flag "
23278 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23282 #: ../fish/guestfish-actions.pod:1642
23284 "Before any events are generated, you have to add some watches to the "
23285 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23286 "L</inotify-watch-all>."
23290 #: ../fish/guestfish-actions.pod:1648
23292 "Queued up events should be read periodically by calling L</inotify-read> (or "
23293 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23294 "If you don't read the events out often enough then you risk the internal "
23295 "queue overflowing."
23299 #: ../fish/guestfish-actions.pod:1655
23301 "The handle should be closed after use by calling L</inotify-close>. This "
23302 "also removes any watches automatically."
23306 #: ../fish/guestfish-actions.pod:1664
23307 msgid "inotify-read"
23311 #: ../fish/guestfish-actions.pod:1666
23319 #: ../fish/guestfish-actions.pod:1679
23320 msgid "inotify-rm-watch"
23324 #: ../fish/guestfish-actions.pod:1681
23327 " inotify-rm-watch wd\n"
23332 #: ../fish/guestfish-actions.pod:1683
23333 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23337 #: ../fish/guestfish-actions.pod:1686
23338 msgid "inspect-get-arch"
23342 #: ../fish/guestfish-actions.pod:1688
23345 " inspect-get-arch root\n"
23350 #: ../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
23352 "This function should only be called with a root device string as returned by "
23357 #: ../fish/guestfish-actions.pod:1693
23359 "This returns the architecture of the inspected operating system. The "
23360 "possible return values are listed under L</file-architecture>."
23364 #: ../fish/guestfish-actions.pod:1702
23365 msgid "inspect-get-distro"
23369 #: ../fish/guestfish-actions.pod:1704
23372 " inspect-get-distro root\n"
23377 #: ../fish/guestfish-actions.pod:1788
23378 msgid "inspect-get-drive-mappings"
23382 #: ../fish/guestfish-actions.pod:1790
23385 " inspect-get-drive-mappings root\n"
23390 #: ../fish/guestfish-actions.pod:1820
23392 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23393 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23397 #: ../fish/guestfish-actions.pod:1824
23398 msgid "inspect-get-filesystems"
23402 #: ../fish/guestfish-actions.pod:1826
23405 " inspect-get-filesystems root\n"
23410 #: ../fish/guestfish-actions.pod:1839
23412 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23413 "L</inspect-get-mountpoints>."
23417 #: ../fish/guestfish-actions.pod:1842
23418 msgid "inspect-get-format"
23422 #: ../fish/guestfish-actions.pod:1844
23425 " inspect-get-format root\n"
23430 #: ../fish/guestfish-actions.pod:1876
23431 msgid "inspect-get-hostname"
23435 #: ../fish/guestfish-actions.pod:1878
23438 " inspect-get-hostname root\n"
23443 #: ../fish/guestfish-actions.pod:1891
23444 msgid "inspect-get-major-version"
23448 #: ../fish/guestfish-actions.pod:1893
23451 " inspect-get-major-version root\n"
23456 #: ../fish/guestfish-actions.pod:1912
23457 msgid "inspect-get-minor-version"
23461 #: ../fish/guestfish-actions.pod:1914
23464 " inspect-get-minor-version root\n"
23469 #: ../fish/guestfish-actions.pod:1924
23471 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23472 "L</inspect-get-major-version>."
23476 #: ../fish/guestfish-actions.pod:1927
23477 msgid "inspect-get-mountpoints"
23481 #: ../fish/guestfish-actions.pod:1929
23484 " inspect-get-mountpoints root\n"
23489 #: ../fish/guestfish-actions.pod:1951
23491 "For operating systems like Windows which still use drive letters, this call "
23492 "will only return an entry for the first drive \"mounted on\" C</>. For "
23493 "information about the mapping of drive letters to partitions, see "
23494 "L</inspect-get-drive-mappings>."
23498 #: ../fish/guestfish-actions.pod:1957
23500 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23501 "L</inspect-get-filesystems>."
23505 #: ../fish/guestfish-actions.pod:1960
23506 msgid "inspect-get-package-format"
23510 #: ../fish/guestfish-actions.pod:1962
23513 " inspect-get-package-format root\n"
23518 #: ../fish/guestfish-actions.pod:1967
23520 "This function and L</inspect-get-package-management> return the package "
23521 "format and package management tool used by the inspected operating system. "
23522 "For example for Fedora these functions would return C<rpm> (package format) "
23523 "and C<yum> (package management)."
23527 #: ../fish/guestfish-actions.pod:1982
23528 msgid "inspect-get-package-management"
23532 #: ../fish/guestfish-actions.pod:1984
23535 " inspect-get-package-management root\n"
23540 #: ../fish/guestfish-actions.pod:1989
23542 "L</inspect-get-package-format> and this function return the package format "
23543 "and package management tool used by the inspected operating system. For "
23544 "example for Fedora these functions would return C<rpm> (package format) and "
23545 "C<yum> (package management)."
23549 #: ../fish/guestfish-actions.pod:2006
23550 msgid "inspect-get-product-name"
23554 #: ../fish/guestfish-actions.pod:2008
23557 " inspect-get-product-name root\n"
23562 #: ../fish/guestfish-actions.pod:2023
23563 msgid "inspect-get-product-variant"
23567 #: ../fish/guestfish-actions.pod:2025
23570 " inspect-get-product-variant root\n"
23575 #: ../fish/guestfish-actions.pod:2049
23577 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23578 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23582 #: ../fish/guestfish-actions.pod:2053
23583 msgid "inspect-get-roots"
23587 #: ../fish/guestfish-actions.pod:2055
23590 " inspect-get-roots\n"
23595 #: ../fish/guestfish-actions.pod:2057
23597 "This function is a convenient way to get the list of root devices, as "
23598 "returned from a previous call to L</inspect-os>, but without redoing the "
23599 "whole inspection process."
23603 #: ../fish/guestfish-actions.pod:2061
23605 "This returns an empty list if either no root devices were found or the "
23606 "caller has not called L</inspect-os>."
23610 #: ../fish/guestfish-actions.pod:2066
23611 msgid "inspect-get-type"
23615 #: ../fish/guestfish-actions.pod:2068
23618 " inspect-get-type root\n"
23623 #: ../fish/guestfish-actions.pod:2101
23624 msgid "inspect-get-windows-current-control-set"
23628 #: ../fish/guestfish-actions.pod:2103
23631 " inspect-get-windows-current-control-set root\n"
23636 #: ../fish/guestfish-actions.pod:2117
23637 msgid "inspect-get-windows-systemroot"
23641 #: ../fish/guestfish-actions.pod:2119
23644 " inspect-get-windows-systemroot root\n"
23649 #: ../fish/guestfish-actions.pod:2133
23650 msgid "inspect-is-live"
23654 #: ../fish/guestfish-actions.pod:2135
23657 " inspect-is-live root\n"
23662 #: ../fish/guestfish-actions.pod:2140
23664 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23665 "then this returns true if a live image was detected on the disk."
23669 #: ../fish/guestfish-actions.pod:2146
23670 msgid "inspect-is-multipart"
23674 #: ../fish/guestfish-actions.pod:2148
23677 " inspect-is-multipart root\n"
23682 #: ../fish/guestfish-actions.pod:2153
23684 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23685 "then this returns true if the disk is part of a set."
23689 #: ../fish/guestfish-actions.pod:2159
23690 msgid "inspect-is-netinst"
23694 #: ../fish/guestfish-actions.pod:2161
23697 " inspect-is-netinst root\n"
23702 #: ../fish/guestfish-actions.pod:2166
23704 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23705 "then this returns true if the disk is a network installer, ie. not a "
23706 "self-contained install CD but one which is likely to require network access "
23707 "to complete the install."
23711 #: ../fish/guestfish-actions.pod:2174
23712 msgid "inspect-list-applications"
23716 #: ../fish/guestfish-actions.pod:2176
23719 " inspect-list-applications root\n"
23724 #: ../fish/guestfish-actions.pod:2183
23726 "I<Note:> This call works differently from other parts of the inspection "
23727 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23728 "then mount up the disks, before calling this. Listing applications is a "
23729 "significantly more difficult operation which requires access to the full "
23730 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23731 "are just returning data cached in the libguestfs handle, this call actually "
23732 "reads parts of the mounted filesystems during the call."
23736 #: ../fish/guestfish-actions.pod:2273
23741 #: ../fish/guestfish-actions.pod:2275
23749 #: ../fish/guestfish-actions.pod:2290
23751 "You can pass the root string(s) returned to other L</inspect-get-*> "
23752 "functions in order to query further information about each operating system, "
23753 "such as the name and version."
23757 #: ../fish/guestfish-actions.pod:2295
23759 "This function uses other libguestfs features such as L</mount-ro> and "
23760 "L</umount-all> in order to mount and unmount filesystems and look at the "
23761 "contents. This should be called with no disks currently mounted. The "
23762 "function may also use Augeas, so any existing Augeas handle will be closed."
23766 #: ../fish/guestfish-actions.pod:2307 ../fish/guestfish-actions.pod:2483 ../fish/guestfish-actions.pod:2529
23767 msgid "See also L</list-filesystems>."
23771 #: ../fish/guestfish-actions.pod:2309
23772 msgid "is-blockdev"
23776 #: ../fish/guestfish-actions.pod:2311
23779 " is-blockdev path\n"
23784 #: ../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
23785 msgid "See also L</stat>."
23789 #: ../fish/guestfish-actions.pod:2318
23794 #: ../fish/guestfish-actions.pod:2320
23802 #: ../fish/guestfish-actions.pod:2327
23807 #: ../fish/guestfish-actions.pod:2329
23810 " is-chardev path\n"
23815 #: ../fish/guestfish-actions.pod:2336
23820 #: ../fish/guestfish-actions.pod:2338
23828 #: ../fish/guestfish-actions.pod:2345
23833 #: ../fish/guestfish-actions.pod:2347
23841 #: ../fish/guestfish-actions.pod:2355
23846 #: ../fish/guestfish-actions.pod:2357
23854 #: ../fish/guestfish-actions.pod:2364
23859 #: ../fish/guestfish-actions.pod:2366
23867 #: ../fish/guestfish-actions.pod:2374
23868 msgid "is-launching"
23872 #: ../fish/guestfish-actions.pod:2376
23880 #: ../fish/guestfish-actions.pod:2383
23885 #: ../fish/guestfish-actions.pod:2385
23893 #: ../fish/guestfish-actions.pod:2390
23898 #: ../fish/guestfish-actions.pod:2392
23906 #: ../fish/guestfish-actions.pod:2399
23911 #: ../fish/guestfish-actions.pod:2401
23914 " is-socket path\n"
23919 #: ../fish/guestfish-actions.pod:2408
23924 #: ../fish/guestfish-actions.pod:2410
23927 " is-symlink path\n"
23932 #: ../fish/guestfish-actions.pod:2417
23933 msgid "kill-subprocess"
23937 #: ../fish/guestfish-actions.pod:2419
23940 " kill-subprocess\n"
23945 #: ../fish/guestfish-actions.pod:2423
23950 #: ../fish/guestfish-actions.pod:2425
23955 #: ../fish/guestfish-actions.pod:2427
23963 #: ../fish/guestfish-actions.pod:2435
23968 #: ../fish/guestfish-actions.pod:2437
23971 " lchown owner group path\n"
23976 #: ../fish/guestfish-actions.pod:2439
23978 "Change the file owner to C<owner> and group to C<group>. This is like "
23979 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
23984 #: ../fish/guestfish-actions.pod:2447
23989 #: ../fish/guestfish-actions.pod:2449
23992 " lgetxattr path name\n"
23997 #: ../fish/guestfish-actions.pod:2465
23998 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24002 #: ../fish/guestfish-actions.pod:2467
24007 #: ../fish/guestfish-actions.pod:2469
24010 " lgetxattrs path\n"
24015 #: ../fish/guestfish-actions.pod:2471
24017 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24018 "it returns the extended attributes of the link itself."
24022 #: ../fish/guestfish-actions.pod:2475
24023 msgid "list-devices"
24027 #: ../fish/guestfish-actions.pod:2477
24035 #: ../fish/guestfish-actions.pod:2485
24036 msgid "list-filesystems"
24040 #: ../fish/guestfish-actions.pod:2487
24043 " list-filesystems\n"
24048 #: ../fish/guestfish-actions.pod:2506
24050 "This command runs other libguestfs commands, which might include L</mount> "
24051 "and L</umount>, and therefore you should use this soon after launch and only "
24052 "when nothing is mounted."
24056 #: ../fish/guestfish-actions.pod:2510
24058 "Not all of the filesystems returned will be mountable. In particular, swap "
24059 "partitions are returned in the list. Also this command does not check that "
24060 "each filesystem found is valid and mountable, and some filesystems might be "
24061 "mountable but require special options. Filesystems may not all belong to a "
24062 "single logical operating system (use L</inspect-os> to look for OSes)."
24066 #: ../fish/guestfish-actions.pod:2518
24067 msgid "list-partitions"
24071 #: ../fish/guestfish-actions.pod:2520
24074 " list-partitions\n"
24079 #: ../fish/guestfish-actions.pod:2526
24081 "This does not return logical volumes. For that you will need to call "
24086 #: ../fish/guestfish-actions.pod:2531
24091 #: ../fish/guestfish-actions.pod:2533
24099 #: ../fish/guestfish-actions.pod:2541
24104 #: ../fish/guestfish-actions.pod:2543
24107 " ln target linkname\n"
24112 #: ../fish/guestfish-actions.pod:2547
24117 #: ../fish/guestfish-actions.pod:2549
24120 " ln-f target linkname\n"
24125 #: ../fish/guestfish-actions.pod:2554
24130 #: ../fish/guestfish-actions.pod:2556
24133 " ln-s target linkname\n"
24138 #: ../fish/guestfish-actions.pod:2560
24143 #: ../fish/guestfish-actions.pod:2562
24146 " ln-sf target linkname\n"
24151 #: ../fish/guestfish-actions.pod:2567
24152 msgid "lremovexattr"
24156 #: ../fish/guestfish-actions.pod:2569
24159 " lremovexattr xattr path\n"
24164 #: ../fish/guestfish-actions.pod:2571
24166 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24167 "it removes an extended attribute of the link itself."
24171 #: ../fish/guestfish-actions.pod:2575
24176 #: ../fish/guestfish-actions.pod:2577
24184 #: ../fish/guestfish-actions.pod:2583
24186 "This command is mostly useful for interactive sessions. Programs should "
24187 "probably use L</readdir> instead."
24191 #: ../fish/guestfish-actions.pod:2586
24196 #: ../fish/guestfish-actions.pod:2588
24199 " lsetxattr xattr val vallen path\n"
24204 #: ../fish/guestfish-actions.pod:2590
24206 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24207 "sets an extended attribute of the link itself."
24211 #: ../fish/guestfish-actions.pod:2594
24216 #: ../fish/guestfish-actions.pod:2596
24224 #: ../fish/guestfish-actions.pod:2600
24226 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24227 "the link is stat-ed, not the file it refers to."
24231 #: ../fish/guestfish-actions.pod:2606
24236 #: ../fish/guestfish-actions.pod:2608
24239 " lstatlist path 'names ...'\n"
24244 #: ../fish/guestfish-actions.pod:2610
24246 "This call allows you to perform the L</lstat> operation on multiple files, "
24247 "where all files are in the directory C<path>. C<names> is the list of files "
24248 "from this directory."
24252 #: ../fish/guestfish-actions.pod:2619
24254 "This call is intended for programs that want to efficiently list a directory "
24255 "contents without making many round-trips. See also L</lxattrlist> for a "
24256 "similarly efficient call for getting extended attributes. Very long "
24257 "directory listings might cause the protocol message size to be exceeded, "
24258 "causing this call to fail. The caller must split up such requests into "
24259 "smaller groups of names."
24263 #: ../fish/guestfish-actions.pod:2627
24264 msgid "luks-add-key"
24268 #: ../fish/guestfish-actions.pod:2629
24271 " luks-add-key device keyslot\n"
24276 #: ../fish/guestfish-actions.pod:2636
24278 "Note that if C<keyslot> already contains a key, then this command will "
24279 "fail. You have to use L</luks-kill-slot> first to remove that key."
24283 #: ../fish/guestfish-actions.pod:2640 ../fish/guestfish-actions.pod:2662 ../fish/guestfish-actions.pod:2675 ../fish/guestfish-actions.pod:2689 ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2722
24285 "This command has one or more key or passphrase parameters. Guestfish will "
24286 "prompt for these separately."
24290 #: ../fish/guestfish-actions.pod:2643
24295 #: ../fish/guestfish-actions.pod:2645
24298 " luks-close device\n"
24303 #: ../fish/guestfish-actions.pod:2647
24305 "This closes a LUKS device that was created earlier by L</luks-open> or "
24306 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
24307 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
24308 "underlying block device."
24312 #: ../fish/guestfish-actions.pod:2653
24313 msgid "luks-format"
24317 #: ../fish/guestfish-actions.pod:2655
24320 " luks-format device keyslot\n"
24325 #: ../fish/guestfish-actions.pod:2668
24326 msgid "luks-format-cipher"
24330 #: ../fish/guestfish-actions.pod:2670
24333 " luks-format-cipher device keyslot cipher\n"
24338 #: ../fish/guestfish-actions.pod:2672
24340 "This command is the same as L</luks-format> but it also allows you to set "
24341 "the C<cipher> used."
24345 #: ../fish/guestfish-actions.pod:2681
24346 msgid "luks-kill-slot"
24350 #: ../fish/guestfish-actions.pod:2683
24353 " luks-kill-slot device keyslot\n"
24358 #: ../fish/guestfish-actions.pod:2692
24363 #: ../fish/guestfish-actions.pod:2694
24366 " luks-open device mapname\n"
24371 #: ../fish/guestfish-actions.pod:2708
24373 "If this block device contains LVM volume groups, then calling L</vgscan> "
24374 "followed by L</vg-activate-all> will make them visible."
24378 #: ../fish/guestfish-actions.pod:2715
24379 msgid "luks-open-ro"
24383 #: ../fish/guestfish-actions.pod:2717
24386 " luks-open-ro device mapname\n"
24391 #: ../fish/guestfish-actions.pod:2719
24393 "This is the same as L</luks-open> except that a read-only mapping is "
24398 #: ../fish/guestfish-actions.pod:2725
24403 #: ../fish/guestfish-actions.pod:2727
24406 " lvcreate logvol volgroup mbytes\n"
24411 #: ../fish/guestfish-actions.pod:2732
24412 msgid "lvm-canonical-lv-name"
24416 #: ../fish/guestfish-actions.pod:2734
24419 " lvm-canonical-lv-name lvname\n"
24424 #: ../fish/guestfish-actions.pod:2743
24425 msgid "See also L</is-lv>."
24429 #: ../fish/guestfish-actions.pod:2745
24430 msgid "lvm-clear-filter"
24434 #: ../fish/guestfish-actions.pod:2747
24437 " lvm-clear-filter\n"
24442 #: ../fish/guestfish-actions.pod:2749
24444 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24449 #: ../fish/guestfish-actions.pod:2755
24450 msgid "lvm-remove-all"
24454 #: ../fish/guestfish-actions.pod:2757
24457 " lvm-remove-all\n"
24462 #: ../fish/guestfish-actions.pod:2765
24463 msgid "lvm-set-filter"
24467 #: ../fish/guestfish-actions.pod:2767
24470 " lvm-set-filter 'devices ...'\n"
24475 #: ../fish/guestfish-actions.pod:2792
24480 #: ../fish/guestfish-actions.pod:2794
24483 " lvremove device\n"
24488 #: ../fish/guestfish-actions.pod:2802
24493 #: ../fish/guestfish-actions.pod:2804
24496 " lvrename logvol newlogvol\n"
24501 #: ../fish/guestfish-actions.pod:2808
24506 #: ../fish/guestfish-actions.pod:2810
24509 " lvresize device mbytes\n"
24514 #: ../fish/guestfish-actions.pod:2816
24515 msgid "lvresize-free"
24519 #: ../fish/guestfish-actions.pod:2818
24522 " lvresize-free lv percent\n"
24527 #: ../fish/guestfish-actions.pod:2826
24532 #: ../fish/guestfish-actions.pod:2828
24540 #: ../fish/guestfish-actions.pod:2836
24541 msgid "See also L</lvs-full>, L</list-filesystems>."
24545 #: ../fish/guestfish-actions.pod:2838
24550 #: ../fish/guestfish-actions.pod:2840
24558 #: ../fish/guestfish-actions.pod:2845
24563 #: ../fish/guestfish-actions.pod:2847
24571 #: ../fish/guestfish-actions.pod:2851
24576 #: ../fish/guestfish-actions.pod:2853
24579 " lxattrlist path 'names ...'\n"
24584 #: ../fish/guestfish-actions.pod:2869
24586 "This call is intended for programs that want to efficiently list a directory "
24587 "contents without making many round-trips. See also L</lstatlist> for a "
24588 "similarly efficient call for getting standard stats. Very long directory "
24589 "listings might cause the protocol message size to be exceeded, causing this "
24590 "call to fail. The caller must split up such requests into smaller groups of "
24595 #: ../fish/guestfish-actions.pod:2877
24600 #: ../fish/guestfish-actions.pod:2879
24608 #: ../fish/guestfish-actions.pod:2883
24613 #: ../fish/guestfish-actions.pod:2885
24616 " mkdir-mode path mode\n"
24621 #: ../fish/guestfish-actions.pod:2894
24622 msgid "See also L</mkdir>, L</umask>"
24626 #: ../fish/guestfish-actions.pod:2896
24631 #: ../fish/guestfish-actions.pod:2898
24639 #: ../fish/guestfish-actions.pod:2903
24644 #: ../fish/guestfish-actions.pod:2905
24647 " mkdtemp template\n"
24652 #: ../fish/guestfish-actions.pod:2926
24657 #: ../fish/guestfish-actions.pod:2928
24660 " mke2fs-J fstype blocksize device journal\n"
24665 #: ../fish/guestfish-actions.pod:2936
24666 msgid "See also L</mke2journal>."
24670 #: ../fish/guestfish-actions.pod:2938
24675 #: ../fish/guestfish-actions.pod:2940
24678 " mke2fs-JL fstype blocksize device label\n"
24683 #: ../fish/guestfish-actions.pod:2945
24684 msgid "See also L</mke2journal-L>."
24688 #: ../fish/guestfish-actions.pod:2947
24693 #: ../fish/guestfish-actions.pod:2949
24696 " mke2fs-JU fstype blocksize device uuid\n"
24701 #: ../fish/guestfish-actions.pod:2954
24702 msgid "See also L</mke2journal-U>."
24706 #: ../fish/guestfish-actions.pod:2956
24707 msgid "mke2journal"
24711 #: ../fish/guestfish-actions.pod:2958
24714 " mke2journal blocksize device\n"
24719 #: ../fish/guestfish-actions.pod:2965
24720 msgid "mke2journal-L"
24724 #: ../fish/guestfish-actions.pod:2967
24727 " mke2journal-L blocksize label device\n"
24732 #: ../fish/guestfish-actions.pod:2971
24733 msgid "mke2journal-U"
24737 #: ../fish/guestfish-actions.pod:2973
24740 " mke2journal-U blocksize uuid device\n"
24745 #: ../fish/guestfish-actions.pod:2977
24750 #: ../fish/guestfish-actions.pod:2979
24753 " mkfifo mode path\n"
24758 #: ../fish/guestfish-actions.pod:2981
24760 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
24761 "is just a convenient wrapper around L</mknod>."
24765 #: ../fish/guestfish-actions.pod:2987
24770 #: ../fish/guestfish-actions.pod:2989
24773 " mkfs fstype device\n"
24778 #: ../fish/guestfish-actions.pod:2995
24783 #: ../fish/guestfish-actions.pod:2997
24786 " mkfs-b fstype blocksize device\n"
24791 #: ../fish/guestfish-actions.pod:2999
24793 "This call is similar to L</mkfs>, but it allows you to control the block "
24794 "size of the resulting filesystem. Supported block sizes depend on the "
24795 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
24799 #: ../fish/guestfish-actions.pod:3007
24801 "This function is deprecated. In new code, use the L</mkfs_opts> call "
24806 #: ../fish/guestfish-actions.pod:3014
24811 #: ../fish/guestfish-actions.pod:3016
24814 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
24819 #: ../fish/guestfish-actions.pod:3051
24820 msgid "mkmountpoint"
24824 #: ../fish/guestfish-actions.pod:3053
24827 " mkmountpoint exemptpath\n"
24832 #: ../fish/guestfish-actions.pod:3055
24834 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
24835 "to create extra mountpoints before mounting the first filesystem."
24839 #: ../fish/guestfish-actions.pod:3079
24841 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
24842 "unexpected errors if you try to mix these calls. It is safest to manually "
24843 "unmount filesystems and remove mountpoints after use."
24847 #: ../fish/guestfish-actions.pod:3083
24849 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
24850 "for this to work for manual mountpoints, you must ensure that the innermost "
24851 "mountpoints have the longest pathnames, as in the example code above."
24855 #: ../fish/guestfish-actions.pod:3090
24857 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
24858 "L</umount-all> to be called when the handle is closed which can also trigger "
24863 #: ../fish/guestfish-actions.pod:3094
24868 #: ../fish/guestfish-actions.pod:3096
24871 " mknod mode devmajor devminor path\n"
24876 #: ../fish/guestfish-actions.pod:3106
24878 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
24879 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
24880 "regular file). These constants are available in the standard Linux header "
24881 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
24882 "wrappers around this command which bitwise OR in the appropriate constant "
24887 #: ../fish/guestfish-actions.pod:3116
24892 #: ../fish/guestfish-actions.pod:3118
24895 " mknod-b mode devmajor devminor path\n"
24900 #: ../fish/guestfish-actions.pod:3120
24902 "This call creates a block device node called C<path> with mode C<mode> and "
24903 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24904 "wrapper around L</mknod>."
24908 #: ../fish/guestfish-actions.pod:3126
24913 #: ../fish/guestfish-actions.pod:3128
24916 " mknod-c mode devmajor devminor path\n"
24921 #: ../fish/guestfish-actions.pod:3130
24923 "This call creates a char device node called C<path> with mode C<mode> and "
24924 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24925 "wrapper around L</mknod>."
24929 #: ../fish/guestfish-actions.pod:3136
24934 #: ../fish/guestfish-actions.pod:3138
24942 #: ../fish/guestfish-actions.pod:3142
24947 #: ../fish/guestfish-actions.pod:3144
24950 " mkswap-L label device\n"
24955 #: ../fish/guestfish-actions.pod:3152
24960 #: ../fish/guestfish-actions.pod:3154
24963 " mkswap-U uuid device\n"
24968 #: ../fish/guestfish-actions.pod:3158
24969 msgid "mkswap-file"
24973 #: ../fish/guestfish-actions.pod:3160
24976 " mkswap-file path\n"
24981 #: ../fish/guestfish-actions.pod:3164
24983 "This command just writes a swap file signature to an existing file. To "
24984 "create the file itself, use something like L</fallocate>."
24988 #: ../fish/guestfish-actions.pod:3167
24993 #: ../fish/guestfish-actions.pod:3169
24996 " modprobe modulename\n"
25001 #: ../fish/guestfish-actions.pod:3176
25006 #: ../fish/guestfish-actions.pod:3178
25009 " mount device mountpoint\n"
25014 #: ../fish/guestfish-actions.pod:3194
25016 "B<Important note:> When you use this call, the filesystem options C<sync> "
25017 "and C<noatime> are set implicitly. This was originally done because we "
25018 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25019 "very large negative performance impact and negligible effect on "
25020 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25021 "code that needs performance, and instead use L</mount-options> (use an empty "
25022 "string for the first parameter if you don't want any options)."
25026 #: ../fish/guestfish-actions.pod:3204
25028 "This function is deprecated. In new code, use the L</mount_options> call "
25033 #: ../fish/guestfish-actions.pod:3211
25038 #: ../fish/guestfish-actions.pod:3213
25041 " mount-loop file mountpoint\n"
25046 #: ../fish/guestfish-actions.pod:3219
25047 msgid "mount-options"
25051 #: ../fish/guestfish-actions.pod:3221
25054 " mount-options options device mountpoint\n"
25059 #: ../fish/guestfish-actions.pod:3223
25061 "This is the same as the L</mount> command, but it allows you to set the "
25062 "mount options as for the L<mount(8)> I<-o> flag."
25066 #: ../fish/guestfish-actions.pod:3231
25071 #: ../fish/guestfish-actions.pod:3233
25074 " mount-ro device mountpoint\n"
25079 #: ../fish/guestfish-actions.pod:3235
25081 "This is the same as the L</mount> command, but it mounts the filesystem with "
25082 "the read-only (I<-o ro>) flag."
25086 #: ../fish/guestfish-actions.pod:3238
25091 #: ../fish/guestfish-actions.pod:3240
25094 " mount-vfs options vfstype device mountpoint\n"
25099 #: ../fish/guestfish-actions.pod:3242
25101 "This is the same as the L</mount> command, but it allows you to set both the "
25102 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25106 #: ../fish/guestfish-actions.pod:3246
25107 msgid "mountpoints"
25111 #: ../fish/guestfish-actions.pod:3248
25119 #: ../fish/guestfish-actions.pod:3250
25121 "This call is similar to L</mounts>. That call returns a list of devices. "
25122 "This one returns a hash table (map) of device name to directory where the "
25123 "device is mounted."
25127 #: ../fish/guestfish-actions.pod:3254
25132 #: ../fish/guestfish-actions.pod:3256
25140 #: ../fish/guestfish-actions.pod:3263
25141 msgid "See also: L</mountpoints>"
25145 #: ../fish/guestfish-actions.pod:3265
25150 #: ../fish/guestfish-actions.pod:3267
25158 #: ../fish/guestfish-actions.pod:3272
25159 msgid "ntfs-3g-probe"
25163 #: ../fish/guestfish-actions.pod:3274
25166 " ntfs-3g-probe true|false device\n"
25171 #: ../fish/guestfish-actions.pod:3288
25176 #: ../fish/guestfish-actions.pod:3290
25179 " ntfsresize device\n"
25184 #: ../fish/guestfish-actions.pod:3305
25185 msgid "ntfsresize-size"
25189 #: ../fish/guestfish-actions.pod:3307
25192 " ntfsresize-size device size\n"
25197 #: ../fish/guestfish-actions.pod:3309
25199 "This command is the same as L</ntfsresize> except that it allows you to "
25200 "specify the new size (in bytes) explicitly."
25204 #: ../fish/guestfish-actions.pod:3312
25209 #: ../fish/guestfish-actions.pod:3314
25212 " part-add device prlogex startsect endsect\n"
25217 #: ../fish/guestfish-actions.pod:3316
25219 "This command adds a partition to C<device>. If there is no partition table "
25220 "on the device, call L</part-init> first."
25224 #: ../fish/guestfish-actions.pod:3328
25226 "Creating a partition which covers the whole disk is not so easy. Use "
25227 "L</part-disk> to do that."
25231 #: ../fish/guestfish-actions.pod:3331
25236 #: ../fish/guestfish-actions.pod:3333
25239 " part-del device partnum\n"
25244 #: ../fish/guestfish-actions.pod:3341
25249 #: ../fish/guestfish-actions.pod:3343
25252 " part-disk device parttype\n"
25257 #: ../fish/guestfish-actions.pod:3345
25259 "This command is simply a combination of L</part-init> followed by "
25260 "L</part-add> to create a single primary partition covering the whole disk."
25264 #: ../fish/guestfish-actions.pod:3349
25266 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25267 "possible values are described in L</part-init>."
25271 #: ../fish/guestfish-actions.pod:3355
25272 msgid "part-get-bootable"
25276 #: ../fish/guestfish-actions.pod:3357
25279 " part-get-bootable device partnum\n"
25284 #: ../fish/guestfish-actions.pod:3362
25285 msgid "See also L</part-set-bootable>."
25289 #: ../fish/guestfish-actions.pod:3364
25290 msgid "part-get-mbr-id"
25294 #: ../fish/guestfish-actions.pod:3366
25297 " part-get-mbr-id device partnum\n"
25302 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3509
25304 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25305 "undefined results for other partition table types (see "
25306 "L</part-get-parttype>)."
25310 #: ../fish/guestfish-actions.pod:3375
25311 msgid "part-get-parttype"
25315 #: ../fish/guestfish-actions.pod:3377
25318 " part-get-parttype device\n"
25323 #: ../fish/guestfish-actions.pod:3382
25325 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25326 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25327 "possible, although unusual. See L</part-init> for a full list."
25331 #: ../fish/guestfish-actions.pod:3387
25336 #: ../fish/guestfish-actions.pod:3389
25339 " part-init device parttype\n"
25344 #: ../fish/guestfish-actions.pod:3395
25346 "Initially there are no partitions. Following this, you should call "
25347 "L</part-add> for each partition required."
25351 #: ../fish/guestfish-actions.pod:3458
25356 #: ../fish/guestfish-actions.pod:3460
25359 " part-list device\n"
25364 #: ../fish/guestfish-actions.pod:3475
25366 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25367 "the device's sector size, see L</blockdev-getss>."
25371 #: ../fish/guestfish-actions.pod:3488
25372 msgid "part-set-bootable"
25376 #: ../fish/guestfish-actions.pod:3490
25379 " part-set-bootable device partnum true|false\n"
25384 #: ../fish/guestfish-actions.pod:3499
25385 msgid "part-set-mbr-id"
25389 #: ../fish/guestfish-actions.pod:3501
25392 " part-set-mbr-id device partnum idbyte\n"
25397 #: ../fish/guestfish-actions.pod:3513
25398 msgid "part-set-name"
25402 #: ../fish/guestfish-actions.pod:3515
25405 " part-set-name device partnum name\n"
25410 #: ../fish/guestfish-actions.pod:3523
25411 msgid "part-to-dev"
25415 #: ../fish/guestfish-actions.pod:3525
25418 " part-to-dev partition\n"
25423 #: ../fish/guestfish-actions.pod:3531
25425 "The named partition must exist, for example as a string returned from "
25426 "L</list-partitions>."
25430 #: ../fish/guestfish-actions.pod:3534
25431 msgid "ping-daemon"
25435 #: ../fish/guestfish-actions.pod:3536
25443 #: ../fish/guestfish-actions.pod:3543
25448 #: ../fish/guestfish-actions.pod:3545
25451 " pread path count offset\n"
25456 #: ../fish/guestfish-actions.pod:3553
25457 msgid "See also L</pwrite>, L</pread-device>."
25461 #: ../fish/guestfish-actions.pod:3558
25462 msgid "pread-device"
25466 #: ../fish/guestfish-actions.pod:3560
25469 " pread-device device count offset\n"
25474 #: ../fish/guestfish-actions.pod:3568
25475 msgid "See also L</pread>."
25479 #: ../fish/guestfish-actions.pod:3573
25484 #: ../fish/guestfish-actions.pod:3575
25487 " pvcreate device\n"
25492 #: ../fish/guestfish-actions.pod:3581
25497 #: ../fish/guestfish-actions.pod:3583
25500 " pvremove device\n"
25505 #: ../fish/guestfish-actions.pod:3592
25510 #: ../fish/guestfish-actions.pod:3594
25513 " pvresize device\n"
25518 #: ../fish/guestfish-actions.pod:3599
25519 msgid "pvresize-size"
25523 #: ../fish/guestfish-actions.pod:3601
25526 " pvresize-size device size\n"
25531 #: ../fish/guestfish-actions.pod:3603
25533 "This command is the same as L</pvresize> except that it allows you to "
25534 "specify the new size (in bytes) explicitly."
25538 #: ../fish/guestfish-actions.pod:3606
25543 #: ../fish/guestfish-actions.pod:3608
25551 #: ../fish/guestfish-actions.pod:3616
25552 msgid "See also L</pvs-full>."
25556 #: ../fish/guestfish-actions.pod:3618
25561 #: ../fish/guestfish-actions.pod:3620
25569 #: ../fish/guestfish-actions.pod:3625
25574 #: ../fish/guestfish-actions.pod:3627
25582 #: ../fish/guestfish-actions.pod:3631
25587 #: ../fish/guestfish-actions.pod:3633
25590 " pwrite path content offset\n"
25595 #: ../fish/guestfish-actions.pod:3644
25596 msgid "See also L</pread>, L</pwrite-device>."
25600 #: ../fish/guestfish-actions.pod:3649
25601 msgid "pwrite-device"
25605 #: ../fish/guestfish-actions.pod:3651
25608 " pwrite-device device content offset\n"
25613 #: ../fish/guestfish-actions.pod:3661
25614 msgid "See also L</pwrite>."
25618 #: ../fish/guestfish-actions.pod:3666
25623 #: ../fish/guestfish-actions.pod:3668
25626 " read-file path\n"
25631 #: ../fish/guestfish-actions.pod:3673
25633 "Unlike L</cat>, this function can correctly handle files that contain "
25634 "embedded ASCII NUL characters. However unlike L</download>, this function "
25635 "is limited in the total size of file that can be handled."
25639 #: ../fish/guestfish-actions.pod:3681
25644 #: ../fish/guestfish-actions.pod:3683
25647 " read-lines path\n"
25652 #: ../fish/guestfish-actions.pod:3690
25654 "Note that this function cannot correctly handle binary files (specifically, "
25655 "files containing C<\\0> character which is treated as end of line). For "
25656 "those you need to use the L</read-file> function which has a more complex "
25661 #: ../fish/guestfish-actions.pod:3695
25666 #: ../fish/guestfish-actions.pod:3697
25674 #: ../fish/guestfish-actions.pod:3749
25676 "This function is primarily intended for use by programs. To get a simple "
25677 "list of names, use L</ls>. To get a printable directory for human "
25678 "consumption, use L</ll>."
25682 #: ../fish/guestfish-actions.pod:3753
25687 #: ../fish/guestfish-actions.pod:3755
25695 #: ../fish/guestfish-actions.pod:3759
25696 msgid "readlinklist"
25700 #: ../fish/guestfish-actions.pod:3761
25703 " readlinklist path 'names ...'\n"
25708 #: ../fish/guestfish-actions.pod:3785
25713 #: ../fish/guestfish-actions.pod:3787
25721 #: ../fish/guestfish-actions.pod:3792
25722 msgid "removexattr"
25726 #: ../fish/guestfish-actions.pod:3794
25729 " removexattr xattr path\n"
25734 #: ../fish/guestfish-actions.pod:3799
25735 msgid "See also: L</lremovexattr>, L<attr(5)>."
25739 #: ../fish/guestfish-actions.pod:3801
25744 #: ../fish/guestfish-actions.pod:3803
25747 " resize2fs device\n"
25752 #: ../fish/guestfish-actions.pod:3808
25754 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
25755 "before calling this command. For unknown reasons C<resize2fs> sometimes "
25756 "gives an error about this and sometimes not. In any case, it is always safe "
25757 "to call L</e2fsck-f> before calling this function."
25761 #: ../fish/guestfish-actions.pod:3814
25762 msgid "resize2fs-M"
25766 #: ../fish/guestfish-actions.pod:3816
25769 " resize2fs-M device\n"
25774 #: ../fish/guestfish-actions.pod:3818
25776 "This command is the same as L</resize2fs>, but the filesystem is resized to "
25777 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
25782 #: ../fish/guestfish-actions.pod:3822
25784 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
25785 "and read the C<Block size> and C<Block count> values. These two numbers, "
25786 "multiplied together, give the resulting size of the minimal filesystem in "
25791 #: ../fish/guestfish-actions.pod:3827
25792 msgid "resize2fs-size"
25796 #: ../fish/guestfish-actions.pod:3829
25799 " resize2fs-size device size\n"
25804 #: ../fish/guestfish-actions.pod:3831
25806 "This command is the same as L</resize2fs> except that it allows you to "
25807 "specify the new size (in bytes) explicitly."
25811 #: ../fish/guestfish-actions.pod:3834
25816 #: ../fish/guestfish-actions.pod:3836
25824 #: ../fish/guestfish-actions.pod:3840
25829 #: ../fish/guestfish-actions.pod:3842
25837 #: ../fish/guestfish-actions.pod:3848
25842 #: ../fish/guestfish-actions.pod:3850
25850 #: ../fish/guestfish-actions.pod:3854
25851 msgid "rmmountpoint"
25855 #: ../fish/guestfish-actions.pod:3856
25858 " rmmountpoint exemptpath\n"
25863 #: ../fish/guestfish-actions.pod:3858
25865 "This calls removes a mountpoint that was previously created with "
25866 "L</mkmountpoint>. See L</mkmountpoint> for full details."
25870 #: ../fish/guestfish-actions.pod:3862
25871 msgid "scrub-device"
25875 #: ../fish/guestfish-actions.pod:3864
25878 " scrub-device device\n"
25883 #: ../fish/guestfish-actions.pod:3875
25888 #: ../fish/guestfish-actions.pod:3877
25891 " scrub-file file\n"
25896 #: ../fish/guestfish-actions.pod:3887
25897 msgid "scrub-freespace"
25901 #: ../fish/guestfish-actions.pod:3889
25904 " scrub-freespace dir\n"
25909 #: ../fish/guestfish-actions.pod:3891
25911 "This command creates the directory C<dir> and then fills it with files until "
25912 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
25913 "deletes them. The intention is to scrub any free space on the partition "
25914 "containing C<dir>."
25918 #: ../fish/guestfish-actions.pod:3900
25923 #: ../fish/guestfish-actions.pod:3902
25928 #: ../fish/guestfish-actions.pod:3904
25931 " set-append append\n"
25936 #: ../fish/guestfish-actions.pod:3915
25937 msgid "set-attach-method"
25941 #: ../fish/guestfish-actions.pod:3917
25942 msgid "attach-method"
25946 #: ../fish/guestfish-actions.pod:3919
25949 " set-attach-method attachmethod\n"
25954 #: ../fish/guestfish-actions.pod:3941
25955 msgid "set-autosync"
25959 #: ../fish/guestfish-actions.pod:3943
25964 #: ../fish/guestfish-actions.pod:3945
25967 " set-autosync true|false\n"
25972 #: ../fish/guestfish-actions.pod:3955
25977 #: ../fish/guestfish-actions.pod:3957
25982 #: ../fish/guestfish-actions.pod:3959
25985 " set-direct true|false\n"
25990 #: ../fish/guestfish-actions.pod:3965
25992 "One consequence of this is that log messages aren't caught by the library "
25993 "and handled by L</set-log-message-callback>, but go straight to stdout."
25997 #: ../fish/guestfish-actions.pod:3974
25998 msgid "set-e2label"
26002 #: ../fish/guestfish-actions.pod:3976
26005 " set-e2label device label\n"
26010 #: ../fish/guestfish-actions.pod:3982
26012 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26013 "label on a filesystem."
26017 #: ../fish/guestfish-actions.pod:3985
26022 #: ../fish/guestfish-actions.pod:3987
26025 " set-e2uuid device uuid\n"
26030 #: ../fish/guestfish-actions.pod:3994
26032 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26033 "UUID of a filesystem."
26037 #: ../fish/guestfish-actions.pod:3997
26038 msgid "set-memsize"
26042 #: ../fish/guestfish-actions.pod:3999
26047 #: ../fish/guestfish-actions.pod:4001
26050 " set-memsize memsize\n"
26055 #: ../fish/guestfish-actions.pod:4003
26057 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26058 "This only has any effect if called before L</launch>."
26062 #: ../fish/guestfish-actions.pod:4014
26063 msgid "set-network"
26067 #: ../fish/guestfish-actions.pod:4016
26072 #: ../fish/guestfish-actions.pod:4018
26075 " set-network true|false\n"
26080 #: ../fish/guestfish-actions.pod:4026
26081 msgid "You must call this before calling L</launch>, otherwise it has no effect."
26085 #: ../fish/guestfish-actions.pod:4029
26090 #: ../fish/guestfish-actions.pod:4031
26095 #: ../fish/guestfish-actions.pod:4033
26098 " set-path searchpath\n"
26103 #: ../fish/guestfish-actions.pod:4042
26108 #: ../fish/guestfish-actions.pod:4044
26113 #: ../fish/guestfish-actions.pod:4046
26121 #: ../fish/guestfish-actions.pod:4066
26122 msgid "set-recovery-proc"
26126 #: ../fish/guestfish-actions.pod:4068
26127 msgid "recovery-proc"
26131 #: ../fish/guestfish-actions.pod:4070
26134 " set-recovery-proc true|false\n"
26139 #: ../fish/guestfish-actions.pod:4072
26141 "If this is called with the parameter C<false> then L</launch> does not "
26142 "create a recovery process. The purpose of the recovery process is to stop "
26143 "runaway qemu processes in the case where the main program aborts abruptly."
26147 #: ../fish/guestfish-actions.pod:4077
26149 "This only has any effect if called before L</launch>, and the default is "
26154 #: ../fish/guestfish-actions.pod:4086
26155 msgid "set-selinux"
26159 #: ../fish/guestfish-actions.pod:4088
26164 #: ../fish/guestfish-actions.pod:4090
26167 " set-selinux true|false\n"
26172 #: ../fish/guestfish-actions.pod:4101
26177 #: ../fish/guestfish-actions.pod:4103
26182 #: ../fish/guestfish-actions.pod:4105
26185 " set-trace true|false\n"
26190 #: ../fish/guestfish-actions.pod:4117
26192 "Trace messages are normally sent to C<stderr>, unless you register a "
26193 "callback to send them somewhere else (see L</set-event-callback>)."
26197 #: ../fish/guestfish-actions.pod:4121
26198 msgid "set-verbose"
26202 #: ../fish/guestfish-actions.pod:4123
26207 #: ../fish/guestfish-actions.pod:4125
26210 " set-verbose true|false\n"
26215 #: ../fish/guestfish-actions.pod:4132
26217 "Verbose messages are normally sent to C<stderr>, unless you register a "
26218 "callback to send them somewhere else (see L</set-event-callback>)."
26222 #: ../fish/guestfish-actions.pod:4136
26227 #: ../fish/guestfish-actions.pod:4138
26230 " setcon context\n"
26235 #: ../fish/guestfish-actions.pod:4145
26240 #: ../fish/guestfish-actions.pod:4147
26243 " setxattr xattr val vallen path\n"
26248 #: ../fish/guestfish-actions.pod:4153
26249 msgid "See also: L</lsetxattr>, L<attr(5)>."
26253 #: ../fish/guestfish-actions.pod:4155
26258 #: ../fish/guestfish-actions.pod:4157
26261 " sfdisk device cyls heads sectors 'lines ...'\n"
26266 #: ../fish/guestfish-actions.pod:4179
26267 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26271 #: ../fish/guestfish-actions.pod:4185 ../fish/guestfish-actions.pod:4208 ../fish/guestfish-actions.pod:4230
26273 "This function is deprecated. In new code, use the L</part_add> call "
26278 #: ../fish/guestfish-actions.pod:4192
26283 #: ../fish/guestfish-actions.pod:4194
26286 " sfdiskM device 'lines ...'\n"
26291 #: ../fish/guestfish-actions.pod:4196
26293 "This is a simplified interface to the L</sfdisk> command, where partition "
26294 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26295 "you don't need to specify the cyls, heads and sectors parameters which were "
26296 "rarely if ever used anyway."
26300 #: ../fish/guestfish-actions.pod:4202
26301 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26305 #: ../fish/guestfish-actions.pod:4215
26310 #: ../fish/guestfish-actions.pod:4217
26313 " sfdisk-N device partnum cyls heads sectors line\n"
26318 #: ../fish/guestfish-actions.pod:4222
26320 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26321 "cyls/heads/sectors parameters."
26325 #: ../fish/guestfish-actions.pod:4225
26326 msgid "See also: L</part-add>"
26330 #: ../fish/guestfish-actions.pod:4237
26331 msgid "sfdisk-disk-geometry"
26335 #: ../fish/guestfish-actions.pod:4239
26338 " sfdisk-disk-geometry device\n"
26343 #: ../fish/guestfish-actions.pod:4241
26345 "This displays the disk geometry of C<device> read from the partition table. "
26346 "Especially in the case where the underlying block device has been resized, "
26347 "this can be different from the kernel's idea of the geometry (see "
26348 "L</sfdisk-kernel-geometry>)."
26352 #: ../fish/guestfish-actions.pod:4249
26353 msgid "sfdisk-kernel-geometry"
26357 #: ../fish/guestfish-actions.pod:4251
26360 " sfdisk-kernel-geometry device\n"
26365 #: ../fish/guestfish-actions.pod:4258
26370 #: ../fish/guestfish-actions.pod:4260
26373 " sfdisk-l device\n"
26378 #: ../fish/guestfish-actions.pod:4266
26379 msgid "See also: L</part-list>"
26383 #: ../fish/guestfish-actions.pod:4268
26385 "This function is deprecated. In new code, use the L</part_list> call "
26390 #: ../fish/guestfish-actions.pod:4275
26395 #: ../fish/guestfish-actions.pod:4277
26403 #: ../fish/guestfish-actions.pod:4282
26404 msgid "This is like L</command>, but passes the command to:"
26408 #: ../fish/guestfish-actions.pod:4290
26409 msgid "All the provisos about L</command> apply to this call."
26413 #: ../fish/guestfish-actions.pod:4292
26418 #: ../fish/guestfish-actions.pod:4294
26421 " sh-lines command\n"
26426 #: ../fish/guestfish-actions.pod:4296
26427 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26431 #: ../fish/guestfish-actions.pod:4299
26432 msgid "See also: L</command-lines>"
26436 #: ../fish/guestfish-actions.pod:4301
26441 #: ../fish/guestfish-actions.pod:4303
26449 #: ../fish/guestfish-actions.pod:4307
26454 #: ../fish/guestfish-actions.pod:4309
26462 #: ../fish/guestfish-actions.pod:4315
26467 #: ../fish/guestfish-actions.pod:4317
26475 #: ../fish/guestfish-actions.pod:4325
26480 #: ../fish/guestfish-actions.pod:4327
26488 #: ../fish/guestfish-actions.pod:4335
26493 #: ../fish/guestfish-actions.pod:4337
26496 " strings-e encoding path\n"
26501 #: ../fish/guestfish-actions.pod:4339
26503 "This is like the L</strings> command, but allows you to specify the encoding "
26504 "of strings that are looked for in the source file C<path>."
26508 #: ../fish/guestfish-actions.pod:4349
26510 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26511 "ISO-8859-X (this is what L</strings> uses)."
26515 #: ../fish/guestfish-actions.pod:4381
26516 msgid "swapoff-device"
26520 #: ../fish/guestfish-actions.pod:4383
26523 " swapoff-device device\n"
26528 #: ../fish/guestfish-actions.pod:4385
26530 "This command disables the libguestfs appliance swap device or partition "
26531 "named C<device>. See L</swapon-device>."
26535 #: ../fish/guestfish-actions.pod:4389
26536 msgid "swapoff-file"
26540 #: ../fish/guestfish-actions.pod:4391
26543 " swapoff-file file\n"
26548 #: ../fish/guestfish-actions.pod:4395
26549 msgid "swapoff-label"
26553 #: ../fish/guestfish-actions.pod:4397
26556 " swapoff-label label\n"
26561 #: ../fish/guestfish-actions.pod:4402
26562 msgid "swapoff-uuid"
26566 #: ../fish/guestfish-actions.pod:4404
26569 " swapoff-uuid uuid\n"
26574 #: ../fish/guestfish-actions.pod:4409
26575 msgid "swapon-device"
26579 #: ../fish/guestfish-actions.pod:4411
26582 " swapon-device device\n"
26587 #: ../fish/guestfish-actions.pod:4413
26589 "This command enables the libguestfs appliance to use the swap device or "
26590 "partition named C<device>. The increased memory is made available for all "
26591 "commands, for example those run using L</command> or L</sh>."
26595 #: ../fish/guestfish-actions.pod:4425
26596 msgid "swapon-file"
26600 #: ../fish/guestfish-actions.pod:4427
26603 " swapon-file file\n"
26608 #: ../fish/guestfish-actions.pod:4429
26609 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26613 #: ../fish/guestfish-actions.pod:4432
26614 msgid "swapon-label"
26618 #: ../fish/guestfish-actions.pod:4434
26621 " swapon-label label\n"
26626 #: ../fish/guestfish-actions.pod:4436
26628 "This command enables swap to a labeled swap partition. See "
26629 "L</swapon-device> for other notes."
26633 #: ../fish/guestfish-actions.pod:4439
26634 msgid "swapon-uuid"
26638 #: ../fish/guestfish-actions.pod:4441
26641 " swapon-uuid uuid\n"
26646 #: ../fish/guestfish-actions.pod:4443
26648 "This command enables swap to a swap partition with the given UUID. See "
26649 "L</swapon-device> for other notes."
26653 #: ../fish/guestfish-actions.pod:4446
26658 #: ../fish/guestfish-actions.pod:4448
26666 #: ../fish/guestfish-actions.pod:4456
26671 #: ../fish/guestfish-actions.pod:4458
26679 #: ../fish/guestfish-actions.pod:4466
26684 #: ../fish/guestfish-actions.pod:4468
26687 " tail-n nrlines path\n"
26692 #: ../fish/guestfish-actions.pod:4481
26697 #: ../fish/guestfish-actions.pod:4483
26700 " tar-in (tarfile|-) directory\n"
26705 #: ../fish/guestfish-actions.pod:4488
26706 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26710 #: ../fish/guestfish-actions.pod:4493
26715 #: ../fish/guestfish-actions.pod:4495
26718 " tar-out directory (tarfile|-)\n"
26723 #: ../fish/guestfish-actions.pod:4500
26724 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26728 #: ../fish/guestfish-actions.pod:4505
26733 #: ../fish/guestfish-actions.pod:4507
26736 " tgz-in (tarball|-) directory\n"
26741 #: ../fish/guestfish-actions.pod:4512
26742 msgid "To upload an uncompressed tarball, use L</tar-in>."
26746 #: ../fish/guestfish-actions.pod:4516
26751 #: ../fish/guestfish-actions.pod:4518
26754 " tgz-out directory (tarball|-)\n"
26759 #: ../fish/guestfish-actions.pod:4523
26760 msgid "To download an uncompressed tarball, use L</tar-out>."
26764 #: ../fish/guestfish-actions.pod:4527
26769 #: ../fish/guestfish-actions.pod:4529
26777 #: ../fish/guestfish-actions.pod:4538
26782 #: ../fish/guestfish-actions.pod:4540
26790 #: ../fish/guestfish-actions.pod:4545
26791 msgid "truncate-size"
26795 #: ../fish/guestfish-actions.pod:4547
26798 " truncate-size path size\n"
26803 #: ../fish/guestfish-actions.pod:4552
26805 "If the current file size is less than C<size> then the file is extended to "
26806 "the required size with zero bytes. This creates a sparse file (ie. disk "
26807 "blocks are not allocated for the file until you write to it). To create a "
26808 "non-sparse file of zeroes, use L</fallocate64> instead."
26812 #: ../fish/guestfish-actions.pod:4558
26817 #: ../fish/guestfish-actions.pod:4560
26820 " tune2fs-l device\n"
26825 #: ../fish/guestfish-actions.pod:4570
26830 #: ../fish/guestfish-actions.pod:4572
26833 " txz-in (tarball|-) directory\n"
26838 #: ../fish/guestfish-actions.pod:4579
26843 #: ../fish/guestfish-actions.pod:4581
26846 " txz-out directory (tarball|-)\n"
26851 #: ../fish/guestfish-actions.pod:4588
26856 #: ../fish/guestfish-actions.pod:4590
26864 #: ../fish/guestfish-actions.pod:4604
26865 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
26869 #: ../fish/guestfish-actions.pod:4609
26874 #: ../fish/guestfish-actions.pod:4611
26879 #: ../fish/guestfish-actions.pod:4613
26882 " umount pathordevice\n"
26887 #: ../fish/guestfish-actions.pod:4619
26892 #: ../fish/guestfish-actions.pod:4621
26893 msgid "unmount-all"
26897 #: ../fish/guestfish-actions.pod:4623
26905 #: ../fish/guestfish-actions.pod:4629
26910 #: ../fish/guestfish-actions.pod:4631
26913 " upload (filename|-) remotefilename\n"
26918 #: ../fish/guestfish-actions.pod:4638
26919 msgid "See also L</download>."
26923 #: ../fish/guestfish-actions.pod:4642
26924 msgid "upload-offset"
26928 #: ../fish/guestfish-actions.pod:4644
26931 " upload-offset (filename|-) remotefilename offset\n"
26936 #: ../fish/guestfish-actions.pod:4656
26938 "Note that there is no limit on the amount of data that can be uploaded with "
26939 "this call, unlike with L</pwrite>, and this call always writes the full "
26940 "amount unless an error occurs."
26944 #: ../fish/guestfish-actions.pod:4661
26945 msgid "See also L</upload>, L</pwrite>."
26949 #: ../fish/guestfish-actions.pod:4665
26954 #: ../fish/guestfish-actions.pod:4667
26957 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
26962 #: ../fish/guestfish-actions.pod:4686
26967 #: ../fish/guestfish-actions.pod:4688
26975 #: ../fish/guestfish-actions.pod:4715
26977 "I<Note:> Don't use this call to test for availability of features. In "
26978 "enterprise distributions we backport features from later versions into "
26979 "earlier versions, making this an unreliable way to test for features. Use "
26980 "L</available> instead."
26984 #: ../fish/guestfish-actions.pod:4721
26989 #: ../fish/guestfish-actions.pod:4723
26992 " vfs-label device\n"
26997 #: ../fish/guestfish-actions.pod:4730
26998 msgid "To find a filesystem from the label, use L</findfs-label>."
27002 #: ../fish/guestfish-actions.pod:4732
27007 #: ../fish/guestfish-actions.pod:4734
27010 " vfs-type device\n"
27015 #: ../fish/guestfish-actions.pod:4744
27020 #: ../fish/guestfish-actions.pod:4746
27023 " vfs-uuid device\n"
27028 #: ../fish/guestfish-actions.pod:4753
27029 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27033 #: ../fish/guestfish-actions.pod:4755
27034 msgid "vg-activate"
27038 #: ../fish/guestfish-actions.pod:4757
27041 " vg-activate true|false 'volgroups ...'\n"
27046 #: ../fish/guestfish-actions.pod:4770
27047 msgid "vg-activate-all"
27051 #: ../fish/guestfish-actions.pod:4772
27054 " vg-activate-all true|false\n"
27059 #: ../fish/guestfish-actions.pod:4782
27064 #: ../fish/guestfish-actions.pod:4784
27067 " vgcreate volgroup 'physvols ...'\n"
27072 #: ../fish/guestfish-actions.pod:4789
27077 #: ../fish/guestfish-actions.pod:4791
27080 " vglvuuids vgname\n"
27085 #: ../fish/guestfish-actions.pod:4796
27087 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27088 "logical volumes and volume groups."
27092 #: ../fish/guestfish-actions.pod:4799
27093 msgid "See also L</vgpvuuids>."
27097 #: ../fish/guestfish-actions.pod:4801
27102 #: ../fish/guestfish-actions.pod:4803
27105 " vgpvuuids vgname\n"
27110 #: ../fish/guestfish-actions.pod:4808
27112 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27113 "physical volumes and volume groups."
27117 #: ../fish/guestfish-actions.pod:4811
27118 msgid "See also L</vglvuuids>."
27122 #: ../fish/guestfish-actions.pod:4813
27127 #: ../fish/guestfish-actions.pod:4815
27130 " vgremove vgname\n"
27135 #: ../fish/guestfish-actions.pod:4822
27140 #: ../fish/guestfish-actions.pod:4824
27143 " vgrename volgroup newvolgroup\n"
27148 #: ../fish/guestfish-actions.pod:4828
27153 #: ../fish/guestfish-actions.pod:4830
27161 #: ../fish/guestfish-actions.pod:4838
27162 msgid "See also L</vgs-full>."
27166 #: ../fish/guestfish-actions.pod:4840
27171 #: ../fish/guestfish-actions.pod:4842
27179 #: ../fish/guestfish-actions.pod:4847
27184 #: ../fish/guestfish-actions.pod:4849
27192 #: ../fish/guestfish-actions.pod:4854
27197 #: ../fish/guestfish-actions.pod:4856
27205 #: ../fish/guestfish-actions.pod:4860
27210 #: ../fish/guestfish-actions.pod:4862
27218 #: ../fish/guestfish-actions.pod:4867
27223 #: ../fish/guestfish-actions.pod:4869
27231 #: ../fish/guestfish-actions.pod:4874
27236 #: ../fish/guestfish-actions.pod:4876
27244 #: ../fish/guestfish-actions.pod:4881
27249 #: ../fish/guestfish-actions.pod:4883
27252 " write path content\n"
27257 #: ../fish/guestfish-actions.pod:4891
27262 #: ../fish/guestfish-actions.pod:4893
27265 " write-file path content size\n"
27270 #: ../fish/guestfish-actions.pod:4909
27271 msgid "This function is deprecated. In new code, use the L</write> call instead."
27275 #: ../fish/guestfish-actions.pod:4916
27280 #: ../fish/guestfish-actions.pod:4918
27283 " zegrep regex path\n"
27288 #: ../fish/guestfish-actions.pod:4926
27293 #: ../fish/guestfish-actions.pod:4928
27296 " zegrepi regex path\n"
27301 #: ../fish/guestfish-actions.pod:4936
27306 #: ../fish/guestfish-actions.pod:4938
27314 #: ../fish/guestfish-actions.pod:4946
27315 msgid "See also: L</zero-device>, L</scrub-device>."
27319 #: ../fish/guestfish-actions.pod:4948
27320 msgid "zero-device"
27324 #: ../fish/guestfish-actions.pod:4950
27327 " zero-device device\n"
27332 #: ../fish/guestfish-actions.pod:4952
27334 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27335 "which just zeroes the first few blocks of a device."
27339 #: ../fish/guestfish-actions.pod:4959
27344 #: ../fish/guestfish-actions.pod:4961
27347 " zerofree device\n"
27352 #: ../fish/guestfish-actions.pod:4974
27357 #: ../fish/guestfish-actions.pod:4976
27360 " zfgrep pattern path\n"
27365 #: ../fish/guestfish-actions.pod:4984
27370 #: ../fish/guestfish-actions.pod:4986
27373 " zfgrepi pattern path\n"
27378 #: ../fish/guestfish-actions.pod:4994
27383 #: ../fish/guestfish-actions.pod:4996
27386 " zfile meth path\n"
27391 #: ../fish/guestfish-actions.pod:5003
27392 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
27396 #: ../fish/guestfish-actions.pod:5006
27397 msgid "This function is deprecated. In new code, use the L</file> call instead."
27401 #: ../fish/guestfish-actions.pod:5013
27406 #: ../fish/guestfish-actions.pod:5015
27409 " zgrep regex path\n"
27414 #: ../fish/guestfish-actions.pod:5023
27419 #: ../fish/guestfish-actions.pod:5025
27422 " zgrepi regex path\n"
27427 #: ../fish/guestfish-commands.pod:1
27432 #: ../fish/guestfish-commands.pod:3
27437 #: ../fish/guestfish-commands.pod:5
27440 " alloc filename size\n"
27445 #: ../fish/guestfish-commands.pod:7
27447 "This creates an empty (zeroed) file of the given size, and then adds so it "
27448 "can be further examined."
27452 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27453 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27457 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27458 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27462 #: ../fish/guestfish-commands.pod:14
27464 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27465 "image, see L</PREPARED DISK IMAGES>."
27469 #: ../fish/guestfish-commands.pod:17
27474 #: ../fish/guestfish-commands.pod:19
27477 " copy-in local [local ...] /remotedir\n"
27482 #: ../fish/guestfish-commands.pod:21
27484 "C<copy-in> copies local files or directories recursively into the disk "
27485 "image, placing them in the directory called C</remotedir> (which must "
27486 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27487 "other commands as necessary."
27491 #: ../fish/guestfish-commands.pod:26
27493 "Multiple local files and directories can be specified, but the last "
27494 "parameter must always be a remote directory. Wildcards cannot be used."
27498 #: ../fish/guestfish-commands.pod:30
27503 #: ../fish/guestfish-commands.pod:32
27506 " copy-out remote [remote ...] localdir\n"
27511 #: ../fish/guestfish-commands.pod:34
27513 "C<copy-out> copies remote files or directories recursively out of the disk "
27514 "image, placing them on the host disk in a local directory called C<localdir> "
27515 "(which must exist). This guestfish meta-command turns into a sequence of "
27516 "L</download>, L</tar-out> and other commands as necessary."
27520 #: ../fish/guestfish-commands.pod:40
27522 "Multiple remote files and directories can be specified, but the last "
27523 "parameter must always be a local directory. To download to the current "
27524 "directory, use C<.> as in:"
27528 #: ../fish/guestfish-commands.pod:44
27531 " copy-out /home .\n"
27536 #: ../fish/guestfish-commands.pod:46
27538 "Wildcards cannot be used in the ordinary command, but you can use them with "
27539 "the help of L</glob> like this:"
27543 #: ../fish/guestfish-commands.pod:49
27546 " glob copy-out /home/* .\n"
27551 #: ../fish/guestfish-commands.pod:51
27556 #: ../fish/guestfish-commands.pod:53
27559 " echo [params ...]\n"
27564 #: ../fish/guestfish-commands.pod:55
27565 msgid "This echos the parameters to the terminal."
27569 #: ../fish/guestfish-commands.pod:57
27574 #: ../fish/guestfish-commands.pod:59
27579 #: ../fish/guestfish-commands.pod:61
27584 #: ../fish/guestfish-commands.pod:63
27592 #: ../fish/guestfish-commands.pod:65
27594 "This is used to edit a file. It downloads the file, edits it locally using "
27595 "your editor, then uploads the result."
27599 #: ../fish/guestfish-commands.pod:68
27601 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27602 "or C<emacs> you will get those corresponding editors."
27606 #: ../fish/guestfish-commands.pod:72
27611 #: ../fish/guestfish-commands.pod:74
27614 " glob command args...\n"
27619 #: ../fish/guestfish-commands.pod:76
27621 "Expand wildcards in any paths in the args list, and run C<command> "
27622 "repeatedly on each matching path."
27626 #: ../fish/guestfish-commands.pod:79
27627 msgid "See L</WILDCARDS AND GLOBBING>."
27631 #: ../fish/guestfish-commands.pod:81
27636 #: ../fish/guestfish-commands.pod:83
27639 " hexedit <filename|device>\n"
27640 " hexedit <filename|device> <max>\n"
27641 " hexedit <filename|device> <start> <max>\n"
27646 #: ../fish/guestfish-commands.pod:87
27648 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27653 #: ../fish/guestfish-commands.pod:90
27655 "This command works by downloading potentially the whole file or device, "
27656 "editing it locally, then uploading it. If the file or device is large, you "
27657 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27658 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27659 "usual modifiers allowed such as C<1M> (1 megabyte)."
27663 #: ../fish/guestfish-commands.pod:97
27664 msgid "For example to edit the first few sectors of a disk you might do:"
27668 #: ../fish/guestfish-commands.pod:100
27671 " hexedit /dev/sda 1M\n"
27676 #: ../fish/guestfish-commands.pod:102
27678 "which would allow you to edit anywhere within the first megabyte of the "
27683 #: ../fish/guestfish-commands.pod:105
27684 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27688 #: ../fish/guestfish-commands.pod:107
27691 " hexedit /dev/sda1 0x400 0x400\n"
27696 #: ../fish/guestfish-commands.pod:109
27697 msgid "(assuming the superblock is in the standard location)."
27701 #: ../fish/guestfish-commands.pod:111
27703 "This command requires the external L<hexedit(1)> program. You can specify "
27704 "another program to use by setting the C<HEXEDITOR> environment variable."
27708 #: ../fish/guestfish-commands.pod:115
27709 msgid "See also L</hexdump>."
27713 #: ../fish/guestfish-commands.pod:117
27718 #: ../fish/guestfish-commands.pod:119
27726 #: ../fish/guestfish-commands.pod:121
27727 msgid "Change the local directory, ie. the current directory of guestfish itself."
27731 #: ../fish/guestfish-commands.pod:124
27732 msgid "Note that C<!cd> won't do what you might expect."
27736 #: ../fish/guestfish-commands.pod:126
27741 #: ../fish/guestfish-commands.pod:128
27746 #: ../fish/guestfish-commands.pod:130
27754 #: ../fish/guestfish-commands.pod:132
27755 msgid "Opens the manual page for guestfish."
27759 #: ../fish/guestfish-commands.pod:134
27764 #: ../fish/guestfish-commands.pod:136
27769 #: ../fish/guestfish-commands.pod:138
27777 #: ../fish/guestfish-commands.pod:140
27785 #: ../fish/guestfish-commands.pod:142
27786 msgid "This is used to view a file."
27790 #: ../fish/guestfish-commands.pod:144
27792 "The default viewer is C<$PAGER>. However if you use the alternate command "
27793 "C<less> you will get the C<less> command specifically."
27797 #: ../fish/guestfish-commands.pod:147
27802 #: ../fish/guestfish-commands.pod:149
27810 #: ../fish/guestfish-commands.pod:151
27812 "Close and reopen the libguestfs handle. It is not necessary to use this "
27813 "normally, because the handle is closed properly when guestfish exits. "
27814 "However this is occasionally useful for testing."
27818 #: ../fish/guestfish-commands.pod:155
27823 #: ../fish/guestfish-commands.pod:157
27826 " sparse filename size\n"
27831 #: ../fish/guestfish-commands.pod:159
27833 "This creates an empty sparse file of the given size, and then adds so it can "
27834 "be further examined."
27838 #: ../fish/guestfish-commands.pod:162
27840 "In all respects it works the same as the L</alloc> command, except that the "
27841 "image file is allocated sparsely, which means that disk blocks are not "
27842 "assigned to the file until they are needed. Sparse disk files only use "
27843 "space when written to, but they are slower and there is a danger you could "
27844 "run out of real disk space during a write operation."
27848 #: ../fish/guestfish-commands.pod:172
27853 #: ../fish/guestfish-commands.pod:174
27861 #: ../fish/guestfish-commands.pod:176
27863 "This command returns a list of the optional groups known to the daemon, and "
27864 "indicates which ones are supported by this build of the libguestfs "
27869 #: ../fish/guestfish-commands.pod:180
27870 msgid "See also L<guestfs(3)/AVAILABILITY>."
27874 #: ../fish/guestfish-commands.pod:182
27879 #: ../fish/guestfish-commands.pod:184
27882 " time command args...\n"
27887 #: ../fish/guestfish-commands.pod:186
27889 "Run the command as usual, but print the elapsed time afterwards. This can "
27890 "be useful for benchmarking operations."
27894 #: ../test-tool/libguestfs-test-tool.pod:5
27895 msgid "libguestfs-test-tool - End user tests for libguestfs"
27899 #: ../test-tool/libguestfs-test-tool.pod:9
27902 " libguestfs-test-tool [--options]\n"
27907 #: ../test-tool/libguestfs-test-tool.pod:13
27909 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
27910 "and developers, to allow them to check basic libguestfs functionality is "
27911 "working. This is needed because libguestfs occasionally breaks for reasons "
27912 "beyond our control: usually because of changes in the underlying qemu or "
27913 "kernel packages, or the host environment."
27917 #: ../test-tool/libguestfs-test-tool.pod:20
27918 msgid "If you suspect a problem in libguestfs, then just run:"
27922 #: ../test-tool/libguestfs-test-tool.pod:22
27925 " libguestfs-test-tool\n"
27930 #: ../test-tool/libguestfs-test-tool.pod:24
27931 msgid "It will print lots of diagnostic messages."
27935 #: ../test-tool/libguestfs-test-tool.pod:26
27936 msgid "If it runs to completion successfully, you will see this near the end:"
27940 #: ../test-tool/libguestfs-test-tool.pod:28
27943 " ===== TEST FINISHED OK =====\n"
27948 #: ../test-tool/libguestfs-test-tool.pod:30
27949 msgid "and the test tool will exit with code 0."
27953 #: ../test-tool/libguestfs-test-tool.pod:32
27955 "If it fails (and/or exits with non-zero error code), please paste the "
27956 "B<complete, unedited> output of the test tool into a bug report. More "
27957 "information about reporting bugs can be found on the "
27958 "L<http://libguestfs.org/> website."
27962 #: ../test-tool/libguestfs-test-tool.pod:41
27967 #: ../test-tool/libguestfs-test-tool.pod:43
27968 msgid "Display short usage information and exit."
27972 #: ../test-tool/libguestfs-test-tool.pod:45
27973 msgid "I<--qemu qemu_binary>"
27977 #: ../test-tool/libguestfs-test-tool.pod:47
27979 "If you have downloaded another qemu binary, point this option at the full "
27980 "path of the binary to try it."
27984 #: ../test-tool/libguestfs-test-tool.pod:50
27985 msgid "I<--qemudir qemu_source_dir>"
27989 #: ../test-tool/libguestfs-test-tool.pod:52
27991 "If you have compiled qemu from source, point this option at the source "
27992 "directory to try it."
27996 #: ../test-tool/libguestfs-test-tool.pod:55
27997 msgid "I<--timeout N>"
28001 #: ../test-tool/libguestfs-test-tool.pod:57
28003 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28004 "does not usually need to be adjusted unless your machine is very slow."
28008 #: ../test-tool/libguestfs-test-tool.pod:63
28009 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28013 #: ../test-tool/libguestfs-test-tool.pod:65
28015 "If you have compiled another version of qemu from source and would like to "
28016 "try that, then you can use the I<--qemudir> option to point to the qemu "
28017 "source directory."
28021 #: ../test-tool/libguestfs-test-tool.pod:69
28023 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28024 "option to point to the binary."
28028 #: ../test-tool/libguestfs-test-tool.pod:72
28030 "When using an alternate qemu with libguestfs, usually you would need to "
28031 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
28032 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
28033 "when you use either of the I<--qemudir> or I<--qemu> options."
28037 #: ../test-tool/libguestfs-test-tool.pod:79
28039 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28040 "I<1> if there was an error."
28044 #: ../test-tool/libguestfs-test-tool.pod:84
28046 "For the full list of environment variables which may affect libguestfs, "
28047 "please see the L<guestfs(3)> manual page."
28051 #: ../test-tool/libguestfs-test-tool.pod:89
28052 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28056 #: ../fuse/guestmount.pod:5
28057 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28061 #: ../fuse/guestmount.pod:9
28064 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28069 #: ../fuse/guestmount.pod:11
28072 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28077 #: ../fuse/guestmount.pod:13
28080 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28085 #: ../fuse/guestmount.pod:17
28087 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28088 "machines. If you do this, you risk disk corruption in the VM."
28092 #: ../fuse/guestmount.pod:22
28094 "The guestmount program can be used to mount virtual machine filesystems and "
28095 "other disk images on the host. It uses libguestfs for access to the guest "
28096 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28097 "a mountable device."
28101 #: ../fuse/guestmount.pod:27
28103 "Along with other options, you have to give at least one device (I<-a> "
28104 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28105 "option) or use the I<-i> inspection option. How this works is better "
28106 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28111 #: ../fuse/guestmount.pod:33
28113 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28114 "by you, and the filesystem will not be visible to any other users unless you "
28115 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28116 "the filesystem, use the C<fusermount -u> command."
28120 #: ../fuse/guestmount.pod:41
28122 "For a typical Windows guest which has its main filesystem on the first "
28127 #: ../fuse/guestmount.pod:44
28130 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28135 #: ../fuse/guestmount.pod:46
28137 "For a typical Linux guest which has a /boot filesystem on the first "
28138 "partition, and the root filesystem on a logical volume:"
28142 #: ../fuse/guestmount.pod:49
28145 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28150 #: ../fuse/guestmount.pod:51
28151 msgid "To get libguestfs to detect guest mountpoints for you:"
28155 #: ../fuse/guestmount.pod:53
28158 " guestmount -a guest.img -i --ro /mnt\n"
28163 #: ../fuse/guestmount.pod:55
28164 msgid "For a libvirt guest called \"Guest\" you could do:"
28168 #: ../fuse/guestmount.pod:57
28171 " guestmount -d Guest -i --ro /mnt\n"
28176 #: ../fuse/guestmount.pod:59
28178 "If you don't know what filesystems are contained in a guest or disk image, "
28179 "use L<virt-filesystems(1)> first:"
28183 #: ../fuse/guestmount.pod:62
28186 " virt-filesystems MyGuest\n"
28191 #: ../fuse/guestmount.pod:64
28193 "If you want to trace the libguestfs calls but without excessive debugging "
28194 "information, we recommend:"
28198 #: ../fuse/guestmount.pod:67
28201 " guestmount [...] --trace /mnt\n"
28206 #: ../fuse/guestmount.pod:69
28207 msgid "If you want to debug the program, we recommend:"
28211 #: ../fuse/guestmount.pod:71
28214 " guestmount [...] --trace --verbose /mnt\n"
28219 #: ../fuse/guestmount.pod:73
28224 #: ../fuse/guestmount.pod:75
28225 msgid "Other users cannot see the filesystem by default"
28229 #: ../fuse/guestmount.pod:77
28231 "If you mount a filesystem as one user (eg. root), then other users will not "
28232 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28233 "option when mounting:"
28237 #: ../fuse/guestmount.pod:81
28240 " sudo guestmount [...] -o allow_other /mnt\n"
28245 #: ../fuse/guestmount.pod:87
28246 msgid "B<-a image> | B<--add image>"
28250 #: ../fuse/guestmount.pod:89
28251 msgid "Add a block device or virtual machine image."
28255 #: ../fuse/guestmount.pod:94
28256 msgid "B<-c URI> | B<--connect URI>"
28260 #: ../fuse/guestmount.pod:100
28261 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28265 #: ../fuse/guestmount.pod:106
28266 msgid "B<--dir-cache-timeout N>"
28270 #: ../fuse/guestmount.pod:108
28272 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28273 "seconds. The readdir cache [actually, there are several semi-independent "
28274 "caches] is populated after a readdir(2) call with the stat and extended "
28275 "attributes of the files in the directory, in anticipation that they will be "
28276 "requested soon after."
28280 #: ../fuse/guestmount.pod:114
28282 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28283 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28284 "requests, only cache existing ones."
28288 #: ../fuse/guestmount.pod:125
28289 msgid "B<--format=raw|qcow2|..> | B<--format>"
28293 #: ../fuse/guestmount.pod:132
28295 "If you have untrusted raw-format guest disk images, you should use this "
28296 "option to specify the disk format. This avoids a possible security problem "
28297 "with malicious guests (CVE-2010-3851). See also "
28298 "L<guestfs(3)/guestfs_add_drive_opts>."
28302 #: ../fuse/guestmount.pod:137
28303 msgid "B<--fuse-help>"
28307 #: ../fuse/guestmount.pod:139
28308 msgid "Display help on special FUSE options (see I<-o> below)."
28312 #: ../fuse/guestmount.pod:143
28313 msgid "Display brief help and exit."
28317 #: ../fuse/guestmount.pod:145
28318 msgid "B<-i> | B<--inspector>"
28322 #: ../fuse/guestmount.pod:165
28324 "Mount the named partition or logical volume on the given mountpoint B<in the "
28325 "guest> (this has nothing to do with mountpoints in the host)."
28329 #: ../fuse/guestmount.pod:168
28331 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28332 "something on C</>."
28336 #: ../fuse/guestmount.pod:181
28337 msgid "B<-n> | B<--no-sync>"
28341 #: ../fuse/guestmount.pod:183
28343 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28344 "unmounted. If you specify this option, then we don't attempt to sync the "
28345 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28349 #: ../fuse/guestmount.pod:188
28350 msgid "B<-o option> | B<--option option>"
28354 #: ../fuse/guestmount.pod:190
28355 msgid "Pass extra options to FUSE."
28359 #: ../fuse/guestmount.pod:192
28361 "To get a list of all the extra options supported by FUSE, use the command "
28362 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28363 "of them are a good idea."
28367 #: ../fuse/guestmount.pod:196
28370 " guestmount --fuse-help\n"
28375 #: ../fuse/guestmount.pod:198
28376 msgid "Some potentially useful FUSE options:"
28380 #: ../fuse/guestmount.pod:202
28381 msgid "B<-o allow_other>"
28385 #: ../fuse/guestmount.pod:204
28386 msgid "Allow other users to see the filesystem."
28390 #: ../fuse/guestmount.pod:206
28391 msgid "B<-o attr_timeout=N>"
28395 #: ../fuse/guestmount.pod:208
28396 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28400 #: ../fuse/guestmount.pod:210
28401 msgid "B<-o kernel_cache>"
28405 #: ../fuse/guestmount.pod:212
28407 "Allow the kernel to cache files (reduces the number of reads that have to go "
28408 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28409 "afford the extra memory usage."
28413 #: ../fuse/guestmount.pod:216
28414 msgid "B<-o uid=N> B<-o gid=N>"
28418 #: ../fuse/guestmount.pod:218
28420 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28421 "the chosen values."
28425 #: ../fuse/guestmount.pod:223
28426 msgid "B<-r> | B<--ro>"
28430 #: ../fuse/guestmount.pod:225
28432 "Add devices and mount everything read-only. Also disallow writes and make "
28433 "the disk appear read-only to FUSE."
28437 #: ../fuse/guestmount.pod:228
28439 "This is highly recommended if you are not going to edit the guest disk. If "
28440 "the guest is running and this option is I<not> supplied, then there is a "
28441 "strong risk of disk corruption in the guest. We try to prevent this from "
28442 "happening, but it is not always possible."
28446 #: ../fuse/guestmount.pod:233
28447 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28451 #: ../fuse/guestmount.pod:237
28452 msgid "Enable SELinux support for the guest."
28456 #: ../fuse/guestmount.pod:239
28457 msgid "B<-v> | B<--verbose>"
28461 #: ../fuse/guestmount.pod:241
28462 msgid "Enable verbose messages from underlying libguestfs."
28466 #: ../fuse/guestmount.pod:243
28467 msgid "B<-V> | B<--version>"
28471 #: ../fuse/guestmount.pod:245
28472 msgid "Display the program version and exit."
28476 #: ../fuse/guestmount.pod:247
28477 msgid "B<-w> | B<--rw>"
28481 #: ../fuse/guestmount.pod:252 ../fuse/guestmount.pod:273
28482 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28486 #: ../fuse/guestmount.pod:254
28487 msgid "B<-x> | B<--trace>"
28491 #: ../fuse/guestmount.pod:256
28492 msgid "Trace libguestfs calls and entry into each FUSE function."
28496 #: ../fuse/guestmount.pod:258
28497 msgid "This also stops the daemon from forking into the background."
28501 #: ../fuse/guestmount.pod:279
28503 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28504 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
28505 "L<http://fuse.sf.net/>."
28509 #: ../fuse/guestmount.pod:294
28510 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28514 #: ../tools/virt-edit.pl:34
28515 msgid "virt-edit - Edit a file in a virtual machine"
28519 #: ../tools/virt-edit.pl:38
28522 " virt-edit [--options] domname file\n"
28527 #: ../tools/virt-edit.pl:40
28530 " virt-edit [--options] disk.img [disk.img ...] file\n"
28535 #: ../tools/virt-edit.pl:42
28538 " virt-edit [domname|disk.img] file -e 'expr'\n"
28543 #: ../tools/virt-edit.pl:46
28545 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
28546 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
28547 "doing this, but doesn't catch all cases."
28551 #: ../tools/virt-edit.pl:52
28553 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
28554 "the named virtual machine (or disk image)."
28558 #: ../tools/virt-edit.pl:55
28559 msgid "If you want to just view a file, use L<virt-cat(1)>."
28563 #: ../tools/virt-edit.pl:57
28565 "For more complex cases you should look at the L<guestfish(1)> tool (see "
28566 "L</USING GUESTFISH> below)."
28570 #: ../tools/virt-edit.pl:60
28572 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
28573 "files. L<guestfish(1)> can do that and much more."
28577 #: ../tools/virt-edit.pl:65
28578 msgid "Edit the named files interactively:"
28582 #: ../tools/virt-edit.pl:67
28585 " virt-edit mydomain /boot/grub/grub.conf\n"
28590 #: ../tools/virt-edit.pl:69
28593 " virt-edit mydomain /etc/passwd\n"
28598 #: ../tools/virt-edit.pl:71
28599 msgid "For Windows guests, some Windows paths are understood:"
28603 #: ../tools/virt-edit.pl:73
28606 " virt-edit mywindomain 'c:\\autoexec.bat'\n"
28611 #: ../tools/virt-edit.pl:75
28613 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28614 "below). To change the init default level to 5:"
28618 #: ../tools/virt-edit.pl:79
28621 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28626 #: ../tools/virt-edit.pl:91 ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
28627 msgid "Display brief help."
28631 #: ../tools/virt-edit.pl:99 ../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
28632 msgid "Display version number and exit."
28636 #: ../tools/virt-edit.pl:105
28637 msgid "B<--backup extension> | B<-b extension>"
28641 #: ../tools/virt-edit.pl:107
28643 "Create a backup of the original file I<in the guest disk image>. The backup "
28644 "has the original filename with C<extension> added."
28648 #: ../tools/virt-edit.pl:110
28650 "Usually the first character of C<extension> would be a dot C<.> so you would "
28655 #: ../tools/virt-edit.pl:113
28658 " virt-edit -b .orig [etc]\n"
28663 #: ../tools/virt-edit.pl:115
28664 msgid "By default, no backup file is made."
28668 #: ../tools/virt-edit.pl:121 ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
28669 msgid "B<--connect URI> | B<-c URI>"
28673 #: ../tools/virt-edit.pl:123 ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
28675 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28676 "to the default libvirt hypervisor."
28680 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
28682 "If you specify guest block devices directly, then libvirt is not used at "
28687 #: ../tools/virt-edit.pl:133 ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
28688 msgid "B<--format> raw"
28692 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
28694 "Specify the format of disk images given on the command line. If this is "
28695 "omitted then the format is autodetected from the content of the disk image."
28699 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
28701 "If disk images are requested from libvirt, then this program asks libvirt "
28702 "for this information. In this case, the value of the format parameter is "
28707 #: ../tools/virt-edit.pl:143 ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
28709 "If working with untrusted raw-format guest disk images, you should ensure "
28710 "the format is always specified."
28714 #: ../tools/virt-edit.pl:150
28715 msgid "B<--expr EXPR> | B<-e EXPR>"
28719 #: ../tools/virt-edit.pl:152
28721 "Instead of launching the external editor, non-interactively apply the Perl "
28722 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28727 #: ../tools/virt-edit.pl:156
28729 "Be careful to properly quote the expression to prevent it from being altered "
28734 #: ../tools/virt-edit.pl:280
28735 msgid "NON-INTERACTIVE EDITING"
28739 #: ../tools/virt-edit.pl:282
28741 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28742 "administrator can interactively edit the file."
28746 #: ../tools/virt-edit.pl:285
28748 "There are two ways also to use C<virt-edit> from scripts in order to make "
28749 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
28750 "like this, it's less error-prone to write scripts directly using the "
28751 "libguestfs API and Augeas for configuration file editing.)"
28755 #: ../tools/virt-edit.pl:291
28757 "The first method is to temporarily set C<$EDITOR> to any script or program "
28758 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
28759 "update C<tmpfile> in place however it likes."
28763 #: ../tools/virt-edit.pl:295
28765 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
28766 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
28767 "instances of C<foo> with C<bar> in a file:"
28771 #: ../tools/virt-edit.pl:299
28774 " virt-edit domname filename -e 's/foo/bar/'\n"
28779 #: ../tools/virt-edit.pl:301
28781 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
28782 "For example to delete root's password you could do:"
28786 #: ../tools/virt-edit.pl:304
28789 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
28794 #: ../tools/virt-edit.pl:306
28796 "What really happens is that the snippet is evaluated as a Perl expression "
28797 "for each line of the file. The line, including the final C<\\n>, is passed "
28798 "in C<$_> and the expression should update C<$_> or leave it unchanged."
28802 #: ../tools/virt-edit.pl:311
28804 "To delete a line, set C<$_> to the empty string. For example, to delete the "
28805 "C<apache> user account from the password file you can do:"
28809 #: ../tools/virt-edit.pl:314
28812 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
28817 #: ../tools/virt-edit.pl:316
28819 "To insert a line, prepend or append it to C<$_>. However appending lines to "
28820 "the end of the file is rather difficult this way since there is no concept "
28821 "of \"last line of the file\" - your expression just doesn't get called "
28822 "again. You might want to use the first method (setting C<$EDITOR>) if you "
28827 #: ../tools/virt-edit.pl:322
28829 "The variable C<$lineno> contains the current line number. As is "
28830 "traditional, the first line in the file is number C<1>."
28834 #: ../tools/virt-edit.pl:325
28836 "The return value from the expression is ignored, but the expression may call "
28837 "C<die> in order to abort the whole program, leaving the original file "
28842 #: ../tools/virt-edit.pl:329
28844 "Remember when matching the end of a line that C<$_> may contain the final "
28845 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
28846 "newline then neither of these. Thus to match or substitute some text at the "
28847 "end of a line, use this regular expression:"
28851 #: ../tools/virt-edit.pl:334
28854 " /some text(\\r?\\n)?$/\n"
28859 #: ../tools/virt-edit.pl:336
28861 "Alternately, use the perl C<chomp> function, being careful not to chomp "
28862 "C<$_> itself (since that would remove all newlines from the file):"
28866 #: ../tools/virt-edit.pl:340
28869 " my $m = $_; chomp $m; $m =~ /some text$/\n"
28874 #: ../tools/virt-edit.pl:344
28876 "C<virt-edit> has a limited ability to understand Windows drive letters and "
28877 "paths (eg. C<E:\\foo\\bar.txt>)."
28881 #: ../tools/virt-edit.pl:347
28882 msgid "If and only if the guest is running Windows then:"
28886 #: ../tools/virt-edit.pl:353
28888 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
28889 "to the correct filesystem."
28893 #: ../tools/virt-edit.pl:358
28895 "Any backslash (C<\\>) characters in the path are replaced with forward "
28896 "slashes so that libguestfs can process it."
28900 #: ../tools/virt-edit.pl:363
28902 "The path is resolved case insensitively to locate the file that should be "
28907 #: ../tools/virt-edit.pl:368
28908 msgid "There are some known shortcomings:"
28912 #: ../tools/virt-edit.pl:374
28913 msgid "Some NTFS symbolic links may not be followed correctly."
28917 #: ../tools/virt-edit.pl:378
28918 msgid "NTFS junction points that cross filesystems are not followed."
28922 #: ../tools/virt-edit.pl:435
28923 msgid "USING GUESTFISH"
28927 #: ../tools/virt-edit.pl:437
28929 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
28930 "C<virt-edit> doesn't work."
28934 #: ../tools/virt-edit.pl:440
28935 msgid "Using C<virt-edit> is approximately equivalent to doing:"
28939 #: ../tools/virt-edit.pl:442
28942 " guestfish --rw -i -d domname edit /file\n"
28947 #: ../tools/virt-edit.pl:444
28949 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
28950 "path to the file."
28954 #: ../tools/virt-edit.pl:447
28956 "The command above uses libguestfs's guest inspection feature and so does not "
28957 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
28958 "disk images that don't contain guests. To edit a file on a disk image "
28963 #: ../tools/virt-edit.pl:452
28966 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
28971 #: ../tools/virt-edit.pl:454
28973 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
28974 "the disk image to edit, and C</file> is the full path to the file."
28978 #: ../tools/virt-edit.pl:458
28980 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
28981 "C<write> or C<upload> instead:"
28985 #: ../tools/virt-edit.pl:461
28988 " guestfish --rw -i -d domname touch /newfile\n"
28993 #: ../tools/virt-edit.pl:463
28996 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
29001 #: ../tools/virt-edit.pl:465
29004 " guestfish --rw -i -d domname upload localfile /newfile\n"
29009 #: ../tools/virt-edit.pl:467
29010 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
29014 #: ../tools/virt-edit.pl:470
29017 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
29022 #: ../tools/virt-edit.pl:480
29027 #: ../tools/virt-edit.pl:482
29029 "If set, this string is used as the editor. It may contain arguments, "
29030 "eg. C<\"emacs -nw\">"
29034 #: ../tools/virt-edit.pl:485
29035 msgid "If not set, C<vi> is used."
29039 #: ../tools/virt-edit.pl:489 ../tools/virt-win-reg.pl:559 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29040 msgid "SHELL QUOTING"
29044 #: ../tools/virt-edit.pl:491 ../tools/virt-win-reg.pl:567 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29046 "Libvirt guest names can contain arbitrary characters, some of which have "
29047 "meaning to the shell such as C<#> and space. You may need to quote or "
29048 "escape these characters on the command line. See the shell manual page "
29049 "L<sh(1)> for details."
29053 #: ../tools/virt-edit.pl:498
29055 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
29056 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29057 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
29061 #: ../tools/virt-edit.pl:510 ../tools/virt-win-reg.pl:598 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29066 #: ../tools/virt-edit.pl:512 ../tools/virt-win-reg.pl:600 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29067 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29071 #: ../tools/virt-edit.pl:516
29072 msgid "Copyright (C) 2009-2011 Red Hat Inc."
29076 #: ../tools/virt-win-reg.pl:37
29078 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
29083 #: ../tools/virt-win-reg.pl:41
29086 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29091 #: ../tools/virt-win-reg.pl:43
29094 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29099 #: ../tools/virt-win-reg.pl:45
29102 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29107 #: ../tools/virt-win-reg.pl:47
29110 " virt-win-reg --merge domname [input.reg ...]\n"
29115 #: ../tools/virt-win-reg.pl:49
29118 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29123 #: ../tools/virt-win-reg.pl:53
29125 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29126 "virtual machines. If you do this, you I<will> get irreversible disk "
29127 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29128 "but doesn't catch all cases."
29132 #: ../tools/virt-win-reg.pl:58
29134 "Modifying the Windows Registry is an inherently risky operation. The format "
29135 "is deliberately obscure and undocumented, and Registry changes can leave the "
29136 "system unbootable. Therefore when using the I<--merge> option, make sure "
29137 "you have a reliable backup first."
29141 #: ../tools/virt-win-reg.pl:65
29143 "This program can export and merge Windows Registry entries from a Windows "
29148 #: ../tools/virt-win-reg.pl:68
29150 "The first parameter is the libvirt guest name or the raw disk image of a "
29155 #: ../tools/virt-win-reg.pl:71
29157 "If I<--merge> is I<not> specified, then the chosen registry key is "
29158 "displayed/exported (recursively). For example:"
29162 #: ../tools/virt-win-reg.pl:74
29165 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29170 #: ../tools/virt-win-reg.pl:76
29171 msgid "You can also display single values from within registry keys, for example:"
29175 #: ../tools/virt-win-reg.pl:79
29178 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29179 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29180 " Windows 7 Enterprise\n"
29185 #: ../tools/virt-win-reg.pl:83
29187 "With I<--merge>, you can merge a textual regedit file into the Windows "
29192 #: ../tools/virt-win-reg.pl:86
29195 " $ virt-win-reg --merge Windows7 changes.reg\n"
29200 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29205 #: ../tools/virt-win-reg.pl:90
29207 "This program is only meant for simple access to the registry. If you want "
29208 "to do complicated things with the registry, we suggest you download the "
29209 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29210 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29211 "L<hivexregedit(1)>."
29215 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29220 #: ../tools/virt-win-reg.pl:122
29221 msgid "Enable debugging messages."
29225 #: ../tools/virt-win-reg.pl:157
29230 #: ../tools/virt-win-reg.pl:159
29232 "In merge mode, this merges a textual regedit file into the Windows Registry "
29233 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29234 "displays or exports Registry entries instead."
29238 #: ../tools/virt-win-reg.pl:163
29240 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29241 "result in disk corruption. However exporting (without this flag) is always "
29246 #: ../tools/virt-win-reg.pl:171
29247 msgid "B<--encoding> UTF-16LE|ASCII"
29251 #: ../tools/virt-win-reg.pl:173
29253 "When merging (only), you may need to specify the encoding for strings to be "
29254 "used in the hive file. This is explained in detail in "
29255 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
29259 #: ../tools/virt-win-reg.pl:177
29261 "The default is to use UTF-16LE, which should work with recent versions of "
29266 #: ../tools/virt-win-reg.pl:402
29267 msgid "SUPPORTED SYSTEMS"
29271 #: ../tools/virt-win-reg.pl:404
29273 "The program currently supports Windows NT-derived guests starting with "
29274 "Windows XP through to at least Windows 7."
29278 #: ../tools/virt-win-reg.pl:407
29280 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
29281 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
29282 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
29286 #: ../tools/virt-win-reg.pl:411
29288 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29293 #: ../tools/virt-win-reg.pl:414
29295 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
29300 #: ../tools/virt-win-reg.pl:417
29305 #: ../tools/virt-win-reg.pl:419
29307 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29308 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
29309 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
29310 "with Windows-style line endings, you may need to reencode the whole file "
29311 "before or after processing."
29315 #: ../tools/virt-win-reg.pl:425
29317 "To reencode a file from Windows format to Linux (before processing it with "
29318 "the I<--merge> option), you would do something like this:"
29322 #: ../tools/virt-win-reg.pl:428
29325 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29330 #: ../tools/virt-win-reg.pl:430
29332 "To go in the opposite direction, after exporting and before sending the file "
29333 "to a Windows user, do something like this:"
29337 #: ../tools/virt-win-reg.pl:433
29340 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29345 #: ../tools/virt-win-reg.pl:435
29346 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29350 #: ../tools/virt-win-reg.pl:437
29352 "If you are unsure about the current encoding, use the L<file(1)> command. "
29353 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
29354 "Windows-style (CRLF) line endings, like this:"
29358 #: ../tools/virt-win-reg.pl:441
29361 " $ file software.reg\n"
29362 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29363 " with CRLF line terminators\n"
29368 #: ../tools/virt-win-reg.pl:445
29369 msgid "This file would need conversion before you could I<--merge> it."
29373 #: ../tools/virt-win-reg.pl:447
29374 msgid "CurrentControlSet etc."
29378 #: ../tools/virt-win-reg.pl:449
29380 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29381 "Registry at the level of the hive file, and therefore you cannot modify "
29386 #: ../tools/virt-win-reg.pl:453
29388 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29389 "circumstances it might refer to another control set. The way to find out is "
29390 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29394 #: ../tools/virt-win-reg.pl:457
29397 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29398 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29399 " \"Current\"=dword:00000001\n"
29400 " \"Default\"=dword:00000001\n"
29401 " \"Failed\"=dword:00000000\n"
29402 " \"LastKnownGood\"=dword:00000002\n"
29407 #: ../tools/virt-win-reg.pl:464
29408 msgid "\"Current\" is the one which Windows will choose when it boots."
29412 #: ../tools/virt-win-reg.pl:466
29413 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
29417 #: ../tools/virt-win-reg.pl:469
29418 msgid "WINDOWS TIPS"
29422 #: ../tools/virt-win-reg.pl:471
29424 "Note that some of these tips modify the guest disk image. The guest I<must> "
29425 "be shut off, else you will get disk corruption."
29429 #: ../tools/virt-win-reg.pl:474
29430 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29434 #: ../tools/virt-win-reg.pl:476
29436 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29437 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29438 "is uploaded into C<C:\\>:"
29442 #: ../tools/virt-win-reg.pl:480
29445 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29450 #: ../tools/virt-win-reg.pl:482
29451 msgid "Prepare a regedit file containing the registry change:"
29455 #: ../tools/virt-win-reg.pl:484
29458 " cat > test.reg <<'EOF'\n"
29459 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29460 " \"Test\"=\"c:\\\\test.bat\"\n"
29466 #: ../tools/virt-win-reg.pl:489
29468 "In this example we use the key C<RunOnce> which means that the script will "
29469 "run precisely once when the first user logs in. If you want it to run every "
29470 "time a user logs in, replace C<RunOnce> with C<Run>."
29474 #: ../tools/virt-win-reg.pl:493
29475 msgid "Now update the registry:"
29479 #: ../tools/virt-win-reg.pl:495
29482 " virt-win-reg --merge WindowsGuest test.reg\n"
29487 #: ../tools/virt-win-reg.pl:497
29488 msgid "INSTALLING A SERVICE"
29492 #: ../tools/virt-win-reg.pl:499
29494 "This section assumes you are familiar with Windows services, and you either "
29495 "have a program which handles the Windows Service Control Protocol directly "
29496 "or you want to run any program using a service wrapper like SrvAny or the "
29501 #: ../tools/virt-win-reg.pl:504
29503 "First upload the program and optionally the service wrapper. In this case "
29504 "the test program is called C<test.exe> and we are using the RHSrvAny "
29509 #: ../tools/virt-win-reg.pl:508
29512 " guestfish -i -d WindowsGuest <<EOF\n"
29513 " upload rhsrvany.exe /rhsrvany.exe\n"
29514 " upload test.exe /test.exe\n"
29520 #: ../tools/virt-win-reg.pl:513
29522 "Prepare a regedit file containing the registry changes. In this example, "
29523 "the first registry change is needed for the service itself or the service "
29524 "wrapper (if used). The second registry change is only needed because I am "
29525 "using the RHSrvAny service wrapper."
29529 #: ../tools/virt-win-reg.pl:518
29532 " cat > service.reg <<'EOF'\n"
29533 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29534 " \"Type\"=dword:00000010\n"
29535 " \"Start\"=dword:00000002\n"
29536 " \"ErrorControl\"=dword:00000001\n"
29537 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29538 " \"DisplayName\"=\"RHSrvAny\"\n"
29539 " \"ObjectName\"=\"NetworkService\"\n"
29544 #: ../tools/virt-win-reg.pl:527
29547 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29548 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29549 " \"PWD\"=\"c:\\\\Temp\"\n"
29555 #: ../tools/virt-win-reg.pl:538
29557 "For use of C<ControlSet001> see the section above in this manual page. You "
29558 "may need to adjust this according to the control set that is in use by the "
29563 #: ../tools/virt-win-reg.pl:544
29565 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29566 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29567 "privileged account."
29571 #: ../tools/virt-win-reg.pl:550
29573 "For the meaning of the magic numbers, see this Microsoft KB article: "
29574 "L<http://support.microsoft.com/kb/103000>."
29578 #: ../tools/virt-win-reg.pl:555
29579 msgid "Update the registry:"
29583 #: ../tools/virt-win-reg.pl:557
29586 " virt-win-reg --merge WindowsGuest service.reg\n"
29591 #: ../tools/virt-win-reg.pl:561
29593 "Be careful when passing parameters containing C<\\> (backslash) in the "
29594 "shell. Usually you will have to use 'single quotes' or double backslashes "
29595 "(but not both) to protect them from the shell."
29599 #: ../tools/virt-win-reg.pl:565
29600 msgid "Paths and value names are case-insensitive."
29604 #: ../tools/virt-win-reg.pl:574
29606 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29607 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29608 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29609 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29613 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
29615 "When reporting bugs, please enable debugging and capture the I<complete> "
29620 #: ../tools/virt-win-reg.pl:592
29623 " export LIBGUESTFS_DEBUG=1\n"
29624 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29629 #: ../tools/virt-win-reg.pl:595
29631 "Attach /tmp/virt-win-reg.log to a new bug report at "
29632 "L<https://bugzilla.redhat.com/>"
29636 #: ../tools/virt-win-reg.pl:604 ../tools/virt-make-fs.pl:570
29637 msgid "Copyright (C) 2010 Red Hat Inc."
29641 #: ../tools/virt-list-filesystems.pl:32
29642 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29646 #: ../tools/virt-list-filesystems.pl:36
29649 " virt-list-filesystems [--options] domname\n"
29654 #: ../tools/virt-list-filesystems.pl:38
29657 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29662 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29664 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29669 #: ../tools/virt-list-filesystems.pl:45
29671 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29672 "are contained in a virtual machine or disk image."
29676 #: ../tools/virt-list-filesystems.pl:49
29678 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29679 "functionality. For more complex cases you should look at the "
29680 "L<guestfish(1)> tool."
29684 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29685 msgid "B<-l> | B<--long>"
29689 #: ../tools/virt-list-filesystems.pl:108
29691 "With this option, C<virt-list-filesystems> displays the type of each "
29692 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29696 #: ../tools/virt-list-filesystems.pl:115
29697 msgid "B<-a> | B<--all>"
29701 #: ../tools/virt-list-filesystems.pl:117
29703 "Normally we only show mountable filesystems. If this option is given then "
29704 "swap devices are shown too."
29708 #: ../tools/virt-list-filesystems.pl:191
29710 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29711 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29712 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29716 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29717 msgid "Copyright (C) 2009 Red Hat Inc."
29721 #: ../tools/virt-tar.pl:33
29722 msgid "virt-tar - Extract or upload files to a virtual machine"
29726 #: ../tools/virt-tar.pl:37
29729 " virt-tar [--options] -x domname directory tarball\n"
29734 #: ../tools/virt-tar.pl:39
29737 " virt-tar [--options] -u domname tarball directory\n"
29742 #: ../tools/virt-tar.pl:41
29745 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29750 #: ../tools/virt-tar.pl:43
29753 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29758 #: ../tools/virt-tar.pl:47
29760 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29761 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29765 #: ../tools/virt-tar.pl:52
29766 msgid "Download C</home> from the VM into a local tarball:"
29770 #: ../tools/virt-tar.pl:54
29773 " virt-tar -x domname /home home.tar\n"
29778 #: ../tools/virt-tar.pl:56
29781 " virt-tar -zx domname /home home.tar.gz\n"
29786 #: ../tools/virt-tar.pl:58
29787 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29791 #: ../tools/virt-tar.pl:60
29794 " virt-tar -u domname uploadstuff.tar /tmp\n"
29799 #: ../tools/virt-tar.pl:62
29802 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29807 #: ../tools/virt-tar.pl:66
29809 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
29810 "virtual machines. If you do this, you risk disk corruption in the VM. "
29811 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29815 #: ../tools/virt-tar.pl:71
29817 "You can use I<-x> (extract) on live virtual machines, but you might get "
29818 "inconsistent results or errors if there is filesystem activity inside the "
29819 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29820 "work, but the only way to guarantee consistent results is if the virtual "
29821 "machine is shut down."
29825 #: ../tools/virt-tar.pl:79
29827 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29828 "parts of a guest filesystem. There are many possibilities: making backups, "
29829 "uploading data files, snooping on guest activity, fixing or customizing "
29834 #: ../tools/virt-tar.pl:84
29836 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29837 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29838 "should look at the L<guestfish(1)> tool."
29842 #: ../tools/virt-tar.pl:88
29844 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
29845 "its contents (recursively) from the virtual machine into a local tarball. "
29846 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
29847 "virtual machine. You cannot use these two options together."
29851 #: ../tools/virt-tar.pl:94
29853 "In addition, you may need to use the I<-z> (gZip) option to enable "
29854 "compression. When uploading, you have to specify I<-z> if the upload file "
29855 "is compressed because virt-tar won't detect this on its own."
29859 #: ../tools/virt-tar.pl:98
29861 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29862 "example it cannot do PKZip files or bzip2 compression. If you want that "
29863 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29864 "the L<libguestfs(3)> API)."
29868 #: ../tools/virt-tar.pl:156
29869 msgid "B<-x> | B<--extract> | B<--download>"
29873 #: ../tools/virt-tar.pl:158
29874 msgid "B<-u> | B<--upload>"
29878 #: ../tools/virt-tar.pl:160
29880 "Use I<-x> to extract (download) a directory from a virtual machine to a "
29885 #: ../tools/virt-tar.pl:163
29887 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
29888 "Please read the L</WARNING> section above before using this option."
29892 #: ../tools/virt-tar.pl:167
29893 msgid "You must specify exactly one of these options."
29897 #: ../tools/virt-tar.pl:173
29898 msgid "B<-z> | B<--gzip>"
29902 #: ../tools/virt-tar.pl:175
29903 msgid "Specify that the input or output tarball is gzip-compressed."
29907 #: ../tools/virt-tar.pl:288
29909 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29910 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29911 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29912 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29916 #: ../tools/virt-make-fs.pl:37
29917 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29921 #: ../tools/virt-make-fs.pl:41
29924 " virt-make-fs [--options] input.tar output.img\n"
29929 #: ../tools/virt-make-fs.pl:43
29932 " virt-make-fs [--options] input.tar.gz output.img\n"
29937 #: ../tools/virt-make-fs.pl:45
29940 " virt-make-fs [--options] directory output.img\n"
29945 #: ../tools/virt-make-fs.pl:49
29947 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29948 "archive or some files in a directory. It is similar to tools like "
29949 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29950 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29951 "useful if you want to attach these filesystems to existing virtual machines "
29952 "(eg. to import large amounts of read-only data to a VM)."
29956 #: ../tools/virt-make-fs.pl:57
29957 msgid "Basic usage is:"
29961 #: ../tools/virt-make-fs.pl:59
29964 " virt-make-fs input output\n"
29969 #: ../tools/virt-make-fs.pl:61
29971 "where C<input> is either a directory containing files that you want to add, "
29972 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29973 "C<output> is a disk image. The input type is detected automatically. The "
29974 "output disk image defaults to a raw ext2 image unless you specify extra "
29975 "flags (see L</OPTIONS> below)."
29979 #: ../tools/virt-make-fs.pl:67
29980 msgid "EXTRA SPACE"
29984 #: ../tools/virt-make-fs.pl:69
29986 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29987 "the files that it contains, but might have extra space. Depending on how "
29988 "you are going to use the output, you might think this extra space is wasted "
29989 "and want to minimize it, or you might want to leave space so that more files "
29990 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29991 "but you can use the I<--size> flag to leave space in the filesystem if you "
29996 #: ../tools/virt-make-fs.pl:77
29998 "An alternative way to leave extra space but not make the output image any "
29999 "bigger is to use an alternative disk image format (instead of the default "
30000 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30001 "image format (check your hypervisor supports this before using it). This "
30002 "allows you to choose a large I<--size> but the extra space won't actually be "
30003 "allocated in the image until you try to store something in it."
30007 #: ../tools/virt-make-fs.pl:85
30009 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30010 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30011 "to build another image from scratch."
30015 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
30020 #: ../tools/virt-make-fs.pl:91
30023 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30028 #: ../tools/virt-make-fs.pl:93
30029 msgid "FILESYSTEM TYPE"
30033 #: ../tools/virt-make-fs.pl:95
30035 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30036 "libguestfs supports can be used (but I<not> read-only formats like "
30037 "ISO9660). Here are some of the more common choices:"
30041 #: ../tools/virt-make-fs.pl:101
30046 #: ../tools/virt-make-fs.pl:103
30048 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30049 "you are not going to use the filesystem in a way that requires the journal, "
30050 "then this is just wasted overhead."
30054 #: ../tools/virt-make-fs.pl:107
30055 msgid "I<ntfs> or I<vfat>"
30059 #: ../tools/virt-make-fs.pl:109
30060 msgid "Useful if exporting data to a Windows guest."
30064 #: ../tools/virt-make-fs.pl:111
30066 "I<Note for vfat>: The tar archive or local directory must only contain files "
30067 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30068 "program running within libguestfs is unable to change the ownership of "
30069 "non-root files, since vfat itself does not support this."
30073 #: ../tools/virt-make-fs.pl:116
30078 #: ../tools/virt-make-fs.pl:118
30080 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30081 "total filesystem size."
30085 #: ../tools/virt-make-fs.pl:125
30088 " virt-make-fs --type=minix input minixfs.img\n"
30093 #: ../tools/virt-make-fs.pl:127
30094 msgid "TO PARTITION OR NOT TO PARTITION"
30098 #: ../tools/virt-make-fs.pl:129
30099 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30103 #: ../tools/virt-make-fs.pl:131
30105 "Adding a partition can make the disk image more compatible with certain "
30106 "virtualized operating systems which don't expect to see a filesystem "
30107 "directly located on a block device (Linux doesn't care and will happily "
30108 "handle both types)."
30112 #: ../tools/virt-make-fs.pl:136
30114 "On the other hand, if you have a partition table then the output image is no "
30115 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30116 "directly on a partitioned disk image. (However libguestfs tools such as "
30117 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30121 #: ../tools/virt-make-fs.pl:144
30122 msgid "Add an MBR partition:"
30126 #: ../tools/virt-make-fs.pl:146
30129 " virt-make-fs --partition -- input disk.img\n"
30134 #: ../tools/virt-make-fs.pl:148
30136 "If the output disk image could be terabyte-sized or larger, it's better to "
30137 "use an EFI/GPT-compatible partition table:"
30141 #: ../tools/virt-make-fs.pl:151
30144 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30149 #: ../tools/virt-make-fs.pl:179
30150 msgid "Enable debugging information."
30154 #: ../tools/virt-make-fs.pl:185
30155 msgid "B<--size=E<lt>NE<gt>>"
30159 #: ../tools/virt-make-fs.pl:187
30160 msgid "B<--size=+E<lt>NE<gt>>"
30164 #: ../tools/virt-make-fs.pl:189
30165 msgid "B<-s E<lt>NE<gt>>"
30169 #: ../tools/virt-make-fs.pl:191
30170 msgid "B<-s +E<lt>NE<gt>>"
30174 #: ../tools/virt-make-fs.pl:193
30175 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30179 #: ../tools/virt-make-fs.pl:196
30181 "If this option is I<not> given, then the output image will be just large "
30182 "enough to contain all the files, with not much wasted space."
30186 #: ../tools/virt-make-fs.pl:199
30188 "To choose a fixed size output disk, specify an absolute number followed by "
30189 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30190 "Petabytes or Exabytes. This must be large enough to contain all the input "
30191 "files, else you will get an error."
30195 #: ../tools/virt-make-fs.pl:204
30197 "To leave extra space, specify C<+> (plus sign) and a number followed by "
30198 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30199 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30200 "the input files, and (approximately) an extra 200 MB free space."
30204 #: ../tools/virt-make-fs.pl:210
30206 "Note that virt-make-fs estimates free space, and therefore will not produce "
30207 "filesystems containing precisely the free space requested. (It is much more "
30208 "expensive and time-consuming to produce a filesystem which has precisely the "
30209 "desired free space)."
30213 #: ../tools/virt-make-fs.pl:219
30214 msgid "B<--format=E<lt>fmtE<gt>>"
30218 #: ../tools/virt-make-fs.pl:221
30219 msgid "B<-F E<lt>fmtE<gt>>"
30223 #: ../tools/virt-make-fs.pl:223
30224 msgid "Choose the output disk image format."
30228 #: ../tools/virt-make-fs.pl:225
30229 msgid "The default is C<raw> (raw disk image)."
30233 #: ../tools/virt-make-fs.pl:227
30235 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30236 "that would really make sense here is C<qcow2>."
30240 #: ../tools/virt-make-fs.pl:234
30241 msgid "B<--type=E<lt>fsE<gt>>"
30245 #: ../tools/virt-make-fs.pl:236
30246 msgid "B<-t E<lt>fsE<gt>>"
30250 #: ../tools/virt-make-fs.pl:238
30251 msgid "Choose the output filesystem type."
30255 #: ../tools/virt-make-fs.pl:240
30256 msgid "The default is C<ext2>."
30260 #: ../tools/virt-make-fs.pl:242
30261 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30265 #: ../tools/virt-make-fs.pl:249
30266 msgid "B<--partition>"
30270 #: ../tools/virt-make-fs.pl:251
30271 msgid "B<--partition=E<lt>parttypeE<gt>>"
30275 #: ../tools/virt-make-fs.pl:253
30277 "If specified, this flag adds an MBR partition table to the output disk "
30282 #: ../tools/virt-make-fs.pl:256
30284 "You can change the partition table type, eg. I<--partition=gpt> for large "
30289 #: ../tools/virt-make-fs.pl:259
30291 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30292 "might consider the next parameter to be the partition type. For example:"
30296 #: ../tools/virt-make-fs.pl:263
30299 " virt-make-fs --partition input.tar ...\n"
30304 #: ../tools/virt-make-fs.pl:265
30306 "would cause virt-make-fs to think you wanted to use a partition type of "
30307 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30308 "dash) between options and the input file argument:"
30312 #: ../tools/virt-make-fs.pl:269
30315 " virt-make-fs --partition -- input.tar ...\n"
30320 #: ../tools/virt-make-fs.pl:541
30322 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30323 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30324 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30328 #: ../tools/virt-make-fs.pl:558
30331 " export LIBGUESTFS_DEBUG=1\n"
30332 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30337 #: ../tools/virt-make-fs.pl:561
30339 "Attach /tmp/virt-make-fs.log to a new bug report at "
30340 "L<https://bugzilla.redhat.com/>"
30344 #: ../tools/virt-list-partitions.pl:32
30345 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
30349 #: ../tools/virt-list-partitions.pl:36
30352 " virt-list-partitions [--options] domname\n"
30357 #: ../tools/virt-list-partitions.pl:38
30360 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30365 #: ../tools/virt-list-partitions.pl:45
30367 "C<virt-list-partitions> is a command line tool to list the partitions that "
30368 "are contained in a virtual machine or disk image. It is mainly useful as a "
30369 "first step to using L<virt-resize(1)>."
30373 #: ../tools/virt-list-partitions.pl:50
30375 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30376 "functionality. For more complex cases you should look at the "
30377 "L<guestfish(1)> tool."
30381 #: ../tools/virt-list-partitions.pl:107
30382 msgid "B<-h> | B<--human-readable>"
30386 #: ../tools/virt-list-partitions.pl:109
30387 msgid "Show sizes in human-readable form (eg. \"1G\")."
30391 #: ../tools/virt-list-partitions.pl:117
30393 "With this option, C<virt-list-partitions> displays the type and size of each "
30394 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30398 #: ../tools/virt-list-partitions.pl:124
30399 msgid "B<-t> | B<--total>"
30403 #: ../tools/virt-list-partitions.pl:126
30404 msgid "Display the total size of each block device (as a separate row or rows)."
30408 #: ../tools/virt-list-partitions.pl:259
30410 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
30411 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
30412 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30416 #: ../tools/virt-list-partitions.pl:275
30417 msgid "Copyright (C) 2009-2010 Red Hat Inc."