1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: libguestfs 1.11.7\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-05-17 17:29+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
26 #: ../src/guestfs.pod:5
27 msgid "guestfs - Library for accessing and modifying virtual machine images"
31 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
36 #: ../src/guestfs.pod:9
39 " #include <guestfs.h>\n"
44 #: ../src/guestfs.pod:11
47 " guestfs_h *g = guestfs_create ();\n"
48 " guestfs_add_drive (g, \"guest.img\");\n"
49 " guestfs_launch (g);\n"
50 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
51 " guestfs_touch (g, \"/hello\");\n"
52 " guestfs_umount (g, \"/\");\n"
53 " guestfs_close (g);\n"
58 #: ../src/guestfs.pod:19
61 " cc prog.c -o prog -lguestfs\n"
63 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
68 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
73 #: ../src/guestfs.pod:25
75 "Libguestfs is a library for accessing and modifying guest disk images. "
76 "Amongst the things this is good for: making batch configuration changes to "
77 "guests, getting disk used/free statistics (see also: virt-df), migrating "
78 "between virtualization systems (see also: virt-p2v), performing partial "
79 "backups, performing partial guest clones, cloning guests and changing "
80 "registry/UUID/hostname info, and much else besides."
84 #: ../src/guestfs.pod:33
86 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
87 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
88 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
93 #: ../src/guestfs.pod:38
95 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
96 "what filesystem is in each LV, etc.). It can also run commands in the "
97 "context of the guest. Also you can access filesystems over FUSE."
101 #: ../src/guestfs.pod:43
103 "Libguestfs is a library that can be linked with C and C++ management "
104 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
105 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
110 #: ../src/guestfs.pod:48
112 "You don't need to be root to use libguestfs, although obviously you do need "
113 "enough permissions to access the disk images."
117 #: ../src/guestfs.pod:51
119 "Libguestfs is a large API because it can do many things. For a gentle "
120 "introduction, please read the L</API OVERVIEW> section next."
124 #: ../src/guestfs.pod:54
126 "There are also some example programs in the L<guestfs-examples(3)> manual "
131 #: ../src/guestfs.pod:57
136 #: ../src/guestfs.pod:59
138 "This section provides a gentler overview of the libguestfs API. We also try "
139 "to group API calls together, where that may not be obvious from reading "
140 "about the individual calls in the main section of this manual."
144 #: ../src/guestfs.pod:64
149 #: ../src/guestfs.pod:66
151 "Before you can use libguestfs calls, you have to create a handle. Then you "
152 "must add at least one disk image to the handle, followed by launching the "
153 "handle, then performing whatever operations you want, and finally closing "
154 "the handle. By convention we use the single letter C<g> for the name of the "
155 "handle variable, although of course you can use any name you want."
159 #: ../src/guestfs.pod:73
160 msgid "The general structure of all libguestfs-using programs looks like this:"
164 #: ../src/guestfs.pod:76
167 " guestfs_h *g = guestfs_create ();\n"
172 #: ../src/guestfs.pod:78
175 " /* Call guestfs_add_drive additional times if there are\n"
176 " * multiple disk images.\n"
178 " guestfs_add_drive (g, \"guest.img\");\n"
183 #: ../src/guestfs.pod:83
186 " /* Most manipulation calls won't work until you've launched\n"
187 " * the handle 'g'. You have to do this _after_ adding drives\n"
188 " * and _before_ other commands.\n"
190 " guestfs_launch (g);\n"
195 #: ../src/guestfs.pod:89
198 " /* Now you can examine what partitions, LVs etc are available.\n"
200 " char **partitions = guestfs_list_partitions (g);\n"
201 " char **logvols = guestfs_lvs (g);\n"
206 #: ../src/guestfs.pod:94
209 " /* To access a filesystem in the image, you must mount it.\n"
211 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
216 #: ../src/guestfs.pod:98
219 " /* Now you can perform filesystem actions on the guest\n"
222 " guestfs_touch (g, \"/hello\");\n"
227 #: ../src/guestfs.pod:103
230 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
231 " * it is done automatically when you close the handle. See\n"
232 " * discussion of autosync in this page.\n"
234 " guestfs_sync (g);\n"
239 #: ../src/guestfs.pod:109
242 " /* Close the handle 'g'. */\n"
243 " guestfs_close (g);\n"
248 #: ../src/guestfs.pod:112
250 "The code above doesn't include any error checking. In real code you should "
251 "check return values carefully for errors. In general all functions that "
252 "return integers return C<-1> on error, and all functions that return "
253 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
254 "how to handle errors, and consult the documentation for each function call "
255 "below to see precisely how they return error indications. See "
256 "L<guestfs-examples(3)> for fully worked examples."
260 #: ../src/guestfs.pod:121
265 #: ../src/guestfs.pod:123
267 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
268 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
269 "actual block device, or simply an empty file of zeroes that you have created "
270 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
275 #: ../src/guestfs.pod:129
277 "The call you should use in modern code for adding drives is "
278 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
279 "specifying that the format is raw, do:"
283 #: ../src/guestfs.pod:133
286 " guestfs_add_drive_opts (g, filename,\n"
287 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
293 #: ../src/guestfs.pod:137
294 msgid "You can add a disk read-only using:"
298 #: ../src/guestfs.pod:139
301 " guestfs_add_drive_opts (g, filename,\n"
302 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
303 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
309 #: ../src/guestfs.pod:144
311 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
312 "libguestfs won't modify the file."
316 #: ../src/guestfs.pod:147
318 "Be extremely cautious if the disk image is in use, eg. if it is being used "
319 "by a virtual machine. Adding it read-write will almost certainly cause disk "
320 "corruption, but adding it read-only is safe."
324 #: ../src/guestfs.pod:151
326 "You must add at least one disk image, and you may add multiple disk images. "
327 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
328 "first one you added), C</dev/sdb> (for the second one you added), etc."
332 #: ../src/guestfs.pod:156
334 "Once L</guestfs_launch> has been called you cannot add any more images. You "
335 "can call L</guestfs_list_devices> to get a list of the device names, in the "
336 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
340 #: ../src/guestfs.pod:161
345 #: ../src/guestfs.pod:163
347 "Before you can read or write files, create directories and so on in a disk "
348 "image that contains filesystems, you have to mount those filesystems using "
349 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
350 "a disk image contains (for example) one partition with a filesystem on that "
351 "partition, then you can mount it directly:"
355 #: ../src/guestfs.pod:170
358 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
363 #: ../src/guestfs.pod:172
365 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
366 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
367 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
368 "that these are libguestfs virtual devices, and are nothing to do with host "
373 #: ../src/guestfs.pod:178
375 "If you are given a disk image and you don't know what it contains then you "
376 "have to find out. Libguestfs can do that too: use "
377 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
378 "and LVs, and either try mounting each to see what is mountable, or else "
379 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
380 "filesystems, use L</guestfs_list_filesystems>."
384 #: ../src/guestfs.pod:186
386 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
387 "L</INSPECTION> below). But you might find it easier to look at higher level "
388 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
392 #: ../src/guestfs.pod:191
394 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
395 "several other variations of the C<guestfs_mount_*> call."
399 #: ../src/guestfs.pod:194
400 msgid "FILESYSTEM ACCESS AND MODIFICATION"
404 #: ../src/guestfs.pod:196
406 "The majority of the libguestfs API consists of fairly low-level calls for "
407 "accessing and modifying the files, directories, symlinks etc on mounted "
408 "filesystems. There are over a hundred such calls which you can find listed "
409 "in detail below in this man page, and we don't even pretend to cover them "
410 "all in this overview."
414 #: ../src/guestfs.pod:202
416 "Specify filenames as full paths, starting with C<\"/\"> and including the "
421 #: ../src/guestfs.pod:205
423 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
424 "the file called C<\"etc/passwd\"> then you could do:"
428 #: ../src/guestfs.pod:208
431 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
436 #: ../src/guestfs.pod:210
438 "This would return C<data> as a newly allocated buffer containing the full "
439 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
440 "or C<NULL> if there was an error."
444 #: ../src/guestfs.pod:214
446 "As another example, to create a top-level directory on that filesystem "
447 "called C<\"var\"> you would do:"
451 #: ../src/guestfs.pod:217
454 " guestfs_mkdir (g, \"/var\");\n"
459 #: ../src/guestfs.pod:219
460 msgid "To create a symlink you could do:"
464 #: ../src/guestfs.pod:221
467 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
468 " \"/etc/rc3.d/S30portmap\");\n"
473 #: ../src/guestfs.pod:224
475 "Libguestfs will reject attempts to use relative paths and there is no "
476 "concept of a current working directory."
480 #: ../src/guestfs.pod:227
482 "Libguestfs can return errors in many situations: for example if the "
483 "filesystem isn't writable, or if a file or directory that you requested "
484 "doesn't exist. If you are using the C API (documented here) you have to "
485 "check for those error conditions after each call. (Other language bindings "
486 "turn these errors into exceptions)."
490 #: ../src/guestfs.pod:233
492 "File writes are affected by the per-handle umask, set by calling "
493 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
497 #: ../src/guestfs.pod:236
502 #: ../src/guestfs.pod:238
504 "Libguestfs contains API calls to read, create and modify partition tables on "
509 #: ../src/guestfs.pod:241
511 "In the common case where you want to create a single partition covering the "
512 "whole disk, you should use the L</guestfs_part_disk> call:"
516 #: ../src/guestfs.pod:245
519 " const char *parttype = \"mbr\";\n"
520 " if (disk_is_larger_than_2TB)\n"
521 " parttype = \"gpt\";\n"
522 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
527 #: ../src/guestfs.pod:250
529 "Obviously this effectively wipes anything that was on that disk image "
534 #: ../src/guestfs.pod:253
539 #: ../src/guestfs.pod:255
541 "Libguestfs provides access to a large part of the LVM2 API, such as "
542 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
543 "unless you familiarize yourself with the concepts of physical volumes, "
544 "volume groups and logical volumes."
548 #: ../src/guestfs.pod:260
550 "This author strongly recommends reading the LVM HOWTO, online at "
551 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
555 #: ../src/guestfs.pod:263
560 #: ../src/guestfs.pod:265
562 "Use L</guestfs_cat> to download small, text only files. This call is "
563 "limited to files which are less than 2 MB and which cannot contain any ASCII "
564 "NUL (C<\\0>) characters. However the API is very simple to use."
568 #: ../src/guestfs.pod:269
570 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
571 "bit data, since it returns a (pointer, size) pair. However it is still "
572 "limited to \"small\" files, less than 2 MB."
576 #: ../src/guestfs.pod:273
578 "L</guestfs_download> can be used to download any file, with no limits on "
579 "content or size (even files larger than 4 GB)."
583 #: ../src/guestfs.pod:276
584 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
588 #: ../src/guestfs.pod:279
593 #: ../src/guestfs.pod:281
595 "It's often the case that you want to write a file or files to the disk "
600 #: ../src/guestfs.pod:284
602 "To write a small file with fixed content, use L</guestfs_write>. To create "
603 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
604 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
605 "variety of other functions for creating test files, for example "
606 "L</guestfs_fill> and L</guestfs_fill_pattern>."
610 #: ../src/guestfs.pod:290
612 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
613 "file content or size (even files larger than 4 GB)."
617 #: ../src/guestfs.pod:293
618 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
622 #: ../src/guestfs.pod:295
624 "However the fastest way to upload I<large numbers of arbitrary files> is to "
625 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
626 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
627 "the drive in a predictable way (eg. adding it last after all other drives) "
628 "then you can get the device name from L</guestfs_list_devices> and mount it "
629 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
630 "sometimes non-portable between kernel versions, and they don't support "
631 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
632 "using a label or UUID, use an ISO image instead."
636 #: ../src/guestfs.pod:306
641 #: ../src/guestfs.pod:308
643 "There are various different commands for copying between files and devices "
644 "and in and out of the guest filesystem. These are summarised in the table "
649 #: ../src/guestfs.pod:314
650 msgid "B<file> to B<file>"
654 #: ../src/guestfs.pod:316
656 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
657 "directories recursively."
661 #: ../src/guestfs.pod:319
662 msgid "B<file or device> to B<file or device>"
666 #: ../src/guestfs.pod:321
668 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
669 "devices in the guest."
673 #: ../src/guestfs.pod:324
674 msgid "Example: duplicate the contents of an LV:"
678 #: ../src/guestfs.pod:326
681 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
686 #: ../src/guestfs.pod:328
688 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
689 "(C</dev/VG/Original>). To copy less than the whole source device, use "
690 "L</guestfs_copy_size>."
694 #: ../src/guestfs.pod:332
695 msgid "B<file on the host> to B<file or device>"
699 #: ../src/guestfs.pod:334
700 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
704 #: ../src/guestfs.pod:336
705 msgid "B<file or device> to B<file on the host>"
709 #: ../src/guestfs.pod:338
710 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
714 #: ../src/guestfs.pod:342
715 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
719 #: ../src/guestfs.pod:344
721 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
722 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
723 "appears you can only upload and download to files. However many Un*x-like "
724 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
725 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
726 "stderr, and arbitrary file descriptor N."
730 #: ../src/guestfs.pod:352
731 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
735 #: ../src/guestfs.pod:355
738 " guestfs_download (g, filename, \"/dev/stdout\");\n"
743 #: ../src/guestfs.pod:357
744 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
748 #: ../src/guestfs.pod:359
752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
753 " guestfs_tar_out (g, \"/\", devfd);\n"
758 #: ../src/guestfs.pod:363
759 msgid "LISTING FILES"
763 #: ../src/guestfs.pod:365
765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
766 "L<guestfish(1)>-equivalent command C<ll>)."
770 #: ../src/guestfs.pod:368
772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
773 "programs, as a flat list of strings."
777 #: ../src/guestfs.pod:371
779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
780 "directory, plus additional information about each one. It is more "
781 "equivalent to using the L<readdir(3)> call on a local filesystem."
785 #: ../src/guestfs.pod:375
787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
792 #: ../src/guestfs.pod:378
793 msgid "RUNNING COMMANDS"
797 #: ../src/guestfs.pod:380
799 "Although libguestfs is primarily an API for manipulating files inside guest "
800 "images, we also provide some limited facilities for running commands inside "
805 #: ../src/guestfs.pod:384
806 msgid "There are many limitations to this:"
810 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064 ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763 ../src/guestfs.pod:1773 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013 ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381 ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398 ../src/guestfs.pod:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975 ../src/guestfs.pod:2979 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1606 ../src/guestfs-actions.pod:1610 ../src/guestfs-actions.pod:1614 ../src/guestfs-actions.pod:1618 ../src/guestfs-actions.pod:1626 ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1634 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1648 ../src/guestfs-actions.pod:1652 ../src/guestfs-actions.pod:1790 ../src/guestfs-actions.pod:1794 ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:1869 ../src/guestfs-actions.pod:1874 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1081 ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1097 ../fish/guestfish-actions.pod:1101 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1115 ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1213 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1227 ../fish/guestfish-actions.pod:1269 ../fish/guestfish-actions.pod:1273 ../fish/guestfish-actions.pod:1278 ../tools/virt-win-reg.pl:195 ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206 ../tools/virt-win-reg.pl:707 ../tools/virt-win-reg.pl:713 ../tools/virt-win-reg.pl:719
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395 ../src/guestfs.pod:2426
941 #: ../src/guestfs.pod:471
942 msgid "Before launching, do:"
946 #: ../src/guestfs.pod:473
949 " guestfs_set_selinux (g, 1);\n"
954 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399 ../src/guestfs.pod:2451
959 #: ../src/guestfs.pod:477
961 "After mounting the guest's filesystem(s), load the policy. This is best "
962 "done by running the L<load_policy(8)> command in the guest itself:"
966 #: ../src/guestfs.pod:481
969 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
974 #: ../src/guestfs.pod:483
976 "(Older versions of C<load_policy> require you to specify the name of the "
981 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
986 #: ../src/guestfs.pod:488
988 "Optionally, set the security context for the API. The correct security "
989 "context to use can only be known by inspecting the guest. As an example:"
993 #: ../src/guestfs.pod:492
996 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1001 #: ../src/guestfs.pod:496
1002 msgid "This will work for running commands and editing existing files."
1006 #: ../src/guestfs.pod:498
1008 "When new files are created, you may need to label them explicitly, for "
1009 "example by running the external command C<restorecon pathname>."
1013 #: ../src/guestfs.pod:502
1018 #: ../src/guestfs.pod:504
1020 "Certain calls are affected by the current file mode creation mask (the "
1021 "\"umask\"). In particular ones which create files or directories, such as "
1022 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1023 "either the default mode that the file is created with or modifies the mode "
1028 #: ../src/guestfs.pod:510
1030 "The default umask is C<022>, so files are created with modes such as C<0644> "
1031 "and directories with C<0755>."
1035 #: ../src/guestfs.pod:513
1037 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1038 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
1039 "L</guestfs_chmod> after creating each file or directory."
1043 #: ../src/guestfs.pod:517
1044 msgid "For more information about umask, see L<umask(2)>."
1048 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:767
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems, an install CD or a live CD. (These APIs used to "
1112 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1113 "version 1.5.3 the most frequently used part of this library has been "
1114 "rewritten in C and moved into the core code)."
1118 #: ../src/guestfs.pod:559
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:562
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:571
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:577
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:584
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:588
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:591
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:595
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:599
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:603
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:612
1213 msgid "INSPECTING INSTALL DISKS"
1217 #: ../src/guestfs.pod:614
1219 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1224 #: ../src/guestfs.pod:617
1226 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1227 "system, which currently can be C<installed> (a regular operating system) or "
1228 "C<installer> (some sort of install disk)."
1232 #: ../src/guestfs.pod:621
1234 "Further information is available about the operating system that can be "
1235 "installed using the regular inspection APIs like "
1236 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1241 #: ../src/guestfs.pod:626
1243 "Some additional information specific to installer disks is also available "
1244 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1245 "L</guestfs_inspect_is_multipart> calls."
1249 #: ../src/guestfs.pod:631
1250 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1254 #: ../src/guestfs.pod:633
1256 "Libguestfs can mount NTFS partitions. It does this using the "
1257 "L<http://www.ntfs-3g.org/> driver."
1261 #: ../src/guestfs.pod:636
1262 msgid "DRIVE LETTERS AND PATHS"
1266 #: ../src/guestfs.pod:638
1268 "DOS and Windows still use drive letters, and the filesystems are always "
1269 "treated as case insensitive by Windows itself, and therefore you might find "
1270 "a Windows configuration file referring to a path like "
1271 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1272 "that directory might be referred to as C</WINDOWS/System32>."
1276 #: ../src/guestfs.pod:644
1278 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1279 "L</guestfs_inspect_get_drive_mappings>)"
1283 #: ../src/guestfs.pod:647
1285 "Dealing with separator characters (backslash vs forward slash) is outside "
1286 "the scope of libguestfs, but usually a simple character replacement will "
1291 #: ../src/guestfs.pod:651
1293 "To resolve the case insensitivity of paths, call "
1294 "L</guestfs_case_sensitive_path>."
1298 #: ../src/guestfs.pod:654
1299 msgid "ACCESSING THE WINDOWS REGISTRY"
1303 #: ../src/guestfs.pod:656
1305 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1306 "files, through the library C<hivex> which is part of the libguestfs project "
1307 "although ships as a separate tarball. You have to locate and download the "
1308 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1309 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1310 "L<virt-win-reg(1)> for more help on this issue."
1314 #: ../src/guestfs.pod:664
1315 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1319 #: ../src/guestfs.pod:666
1321 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1322 "provide something which looks like a Linux symlink. The way it tries to do "
1323 "the rewriting is described here:"
1327 #: ../src/guestfs.pod:670
1328 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1332 #: ../src/guestfs.pod:672
1334 "The essential problem is that ntfs-3g simply does not have enough "
1335 "information to do a correct job. NTFS links can contain drive letters and "
1336 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1337 "It is almost certainly the case that libguestfs callers should ignore what "
1338 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1342 #: ../src/guestfs.pod:679
1344 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1345 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1346 "attribute, and read the raw reparse data from that (you can find the format "
1347 "documented in various places around the web)."
1351 #: ../src/guestfs.pod:684
1352 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1356 #: ../src/guestfs.pod:686
1358 "There are other useful extended attributes that can be read from ntfs-3g "
1359 "filesystems (using L</guestfs_getxattr>). See:"
1363 #: ../src/guestfs.pod:689
1364 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1368 #: ../src/guestfs.pod:691
1369 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1373 #: ../src/guestfs.pod:693
1375 "Although we don't want to discourage you from using the C API, we will "
1376 "mention here that the same API is also available in other languages."
1380 #: ../src/guestfs.pod:696
1382 "The API is broadly identical in all supported languages. This means that "
1383 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1384 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1385 "OCaml. In other words, a straightforward, predictable isomorphism between "
1390 #: ../src/guestfs.pod:702
1392 "Error messages are automatically transformed into exceptions if the language "
1397 #: ../src/guestfs.pod:705
1399 "We don't try to \"object orientify\" parts of the API in OO languages, "
1400 "although contributors are welcome to write higher level APIs above what we "
1401 "provide in their favourite languages if they wish."
1405 #: ../src/guestfs.pod:711
1410 #: ../src/guestfs.pod:713
1412 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1413 "identical to the C API. C++ classes and exceptions are not used."
1417 #: ../src/guestfs.pod:717
1422 #: ../src/guestfs.pod:719
1424 "The C# bindings are highly experimental. Please read the warnings at the "
1425 "top of C<csharp/Libguestfs.cs>."
1429 #: ../src/guestfs.pod:722
1434 #: ../src/guestfs.pod:724
1436 "This is the only language binding that is working but incomplete. Only "
1437 "calls which return simple integers have been bound in Haskell, and we are "
1438 "looking for help to complete this binding."
1442 #: ../src/guestfs.pod:728
1447 #: ../src/guestfs.pod:730
1449 "Full documentation is contained in the Javadoc which is distributed with "
1454 #: ../src/guestfs.pod:733
1459 #: ../src/guestfs.pod:735
1460 msgid "See L<guestfs-ocaml(3)>."
1464 #: ../src/guestfs.pod:737
1469 #: ../src/guestfs.pod:739
1470 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1474 #: ../src/guestfs.pod:741
1479 #: ../src/guestfs.pod:743
1481 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1482 "the php-libguestfs package for your distribution."
1486 #: ../src/guestfs.pod:746
1487 msgid "The PHP binding only works correctly on 64 bit machines."
1491 #: ../src/guestfs.pod:748
1496 #: ../src/guestfs.pod:750
1497 msgid "See L<guestfs-python(3)>."
1501 #: ../src/guestfs.pod:752
1506 #: ../src/guestfs.pod:754
1507 msgid "See L<guestfs-ruby(3)>."
1511 #: ../src/guestfs.pod:756
1512 msgid "B<shell scripts>"
1516 #: ../src/guestfs.pod:758
1517 msgid "See L<guestfish(1)>."
1521 #: ../src/guestfs.pod:762
1522 msgid "LIBGUESTFS GOTCHAS"
1526 #: ../src/guestfs.pod:764
1528 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1529 "system [...] that works in the way it is documented but is counterintuitive "
1530 "and almost invites mistakes.\""
1534 #: ../src/guestfs.pod:768
1536 "Since we developed libguestfs and the associated tools, there are several "
1537 "things we would have designed differently, but are now stuck with for "
1538 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1539 "release, you can expect these to change. Beware of them."
1543 #: ../src/guestfs.pod:776
1544 msgid "Autosync / forgetting to sync."
1548 #: ../src/guestfs.pod:778
1550 "I<Update:> Autosync is enabled by default for all API users starting from "
1551 "libguestfs 1.5.24. This section only applies to older versions."
1555 #: ../src/guestfs.pod:781
1557 "When modifying a filesystem from C or another language, you B<must> unmount "
1558 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1559 "libguestfs handle. You can also call:"
1563 #: ../src/guestfs.pod:785
1566 " guestfs_set_autosync (g, 1);\n"
1571 #: ../src/guestfs.pod:787
1573 "to have the unmount/sync done automatically for you when the handle 'g' is "
1574 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1579 #: ../src/guestfs.pod:791
1581 "If you forget to do this, then it is entirely possible that your changes "
1582 "won't be written out, or will be partially written, or (very rarely) that "
1583 "you'll get disk corruption."
1587 #: ../src/guestfs.pod:795
1589 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1590 "guestfish scripts that forget to sync will work just fine, which can make "
1591 "this very puzzling if you are trying to debug a problem."
1595 #: ../src/guestfs.pod:799
1596 msgid "Mount option C<-o sync> should not be the default."
1600 #: ../src/guestfs.pod:801
1602 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1603 "However C<-o sync> does not add any reliability benefit, but does have a "
1604 "very large performance impact."
1608 #: ../src/guestfs.pod:805
1610 "The work around is to use L</guestfs_mount_options> and set the mount "
1611 "options that you actually want to use."
1615 #: ../src/guestfs.pod:808
1616 msgid "Read-only should be the default."
1620 #: ../src/guestfs.pod:810
1622 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1623 "specify I<--rw> if you want to make changes to the image."
1627 #: ../src/guestfs.pod:813
1628 msgid "This would reduce the potential to corrupt live VM images."
1632 #: ../src/guestfs.pod:815
1634 "Note that many filesystems change the disk when you just mount and unmount, "
1635 "even if you didn't perform any writes. You need to use "
1636 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1640 #: ../src/guestfs.pod:819
1641 msgid "guestfish command line is hard to use."
1645 #: ../src/guestfs.pod:821
1647 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1648 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1649 "exist, so it fails. In earlier versions of guestfish the error message was "
1650 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1651 "we should have used C<guestfish -c command> to run commands."
1655 #: ../src/guestfs.pod:828
1656 msgid "guestfish megabyte modifiers don't work right on all commands"
1660 #: ../src/guestfs.pod:830
1662 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1663 "other modifiers). What guestfish actually does is to multiply the number "
1664 "part by the modifier part and pass the result to the C API. However this "
1665 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1666 "expecting some other unit (eg. megabytes)."
1670 #: ../src/guestfs.pod:837
1671 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1675 #: ../src/guestfs.pod:839
1678 " lvcreate LV VG 100M\n"
1683 #: ../src/guestfs.pod:841
1685 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1686 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1687 "megabytes * megabytes) logical volume. The error message you get from this "
1688 "is also a little obscure."
1692 #: ../src/guestfs.pod:846
1694 "This could be fixed in the generator by specially marking parameters and "
1695 "return values which take bytes or other units."
1699 #: ../src/guestfs.pod:849
1700 msgid "Ambiguity between devices and paths"
1704 #: ../src/guestfs.pod:851
1706 "There is a subtle ambiguity in the API between a device name "
1707 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1708 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1712 #: ../src/guestfs.pod:856
1714 "In the current API we usually resolve this ambiguity by having two separate "
1715 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1716 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1717 "detecting if the path supplied begins with C</dev/>."
1721 #: ../src/guestfs.pod:862
1723 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1724 "make paths/devices into structured names. One way to do this would be to "
1725 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1726 "aspect of grub. Another way would be to use a structured type, equivalent "
1727 "to this OCaml type:"
1731 #: ../src/guestfs.pod:868
1734 " type path = Path of string | Device of int | Partition of int * int\n"
1739 #: ../src/guestfs.pod:870
1740 msgid "which would allow you to pass arguments like:"
1744 #: ../src/guestfs.pod:872
1747 " Path \"/foo/bar\"\n"
1748 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1749 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1750 " Path \"/dev/sdb2\" (* not a device *)\n"
1755 #: ../src/guestfs.pod:877
1757 "As you can see there are still problems to resolve even with this "
1758 "representation. Also consider how it might work in guestfish."
1762 #: ../src/guestfs.pod:882
1763 msgid "KEYS AND PASSPHRASES"
1767 #: ../src/guestfs.pod:884
1769 "Certain libguestfs calls take a parameter that contains sensitive key "
1770 "material, passed in as a C string."
1774 #: ../src/guestfs.pod:887
1776 "In the future we would hope to change the libguestfs implementation so that "
1777 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1778 "swap. However this is I<not> done at the moment, because of the complexity "
1779 "of such an implementation."
1783 #: ../src/guestfs.pod:892
1785 "Therefore you should be aware that any key parameter you pass to libguestfs "
1786 "might end up being written out to the swap partition. If this is a concern, "
1787 "scrub the swap partition or don't use libguestfs on encrypted devices."
1791 #: ../src/guestfs.pod:897
1792 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1796 #: ../src/guestfs.pod:899
1798 "All high-level libguestfs actions are synchronous. If you want to use "
1799 "libguestfs asynchronously then you must create a thread."
1803 #: ../src/guestfs.pod:902
1805 "Only use the handle from a single thread. Either use the handle exclusively "
1806 "from one thread, or provide your own mutex so that two threads cannot issue "
1807 "calls on the same handle at the same time."
1811 #: ../src/guestfs.pod:906
1813 "See the graphical program guestfs-browser for one possible architecture for "
1814 "multithreaded programs using libvirt and libguestfs."
1818 #: ../src/guestfs.pod:909
1823 #: ../src/guestfs.pod:911
1825 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1830 #: ../src/guestfs.pod:914
1832 "By default it looks for these in the directory C<$libdir/guestfs> "
1833 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1837 #: ../src/guestfs.pod:917
1839 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1840 "to change the directories that libguestfs will search in. The value is a "
1841 "colon-separated list of paths. The current directory is I<not> searched "
1842 "unless the path contains an empty element or C<.>. For example "
1843 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1844 "then C</usr/lib/guestfs>."
1848 #: ../src/guestfs.pod:924
1849 msgid "QEMU WRAPPERS"
1853 #: ../src/guestfs.pod:926
1855 "If you want to compile your own qemu, run qemu from a non-standard location, "
1856 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1861 #: ../src/guestfs.pod:930
1863 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1864 "last command in the shell script (so that qemu replaces the shell and "
1865 "becomes the direct child of the libguestfs-using program). If you don't do "
1866 "this, then the qemu process won't be cleaned up correctly."
1870 #: ../src/guestfs.pod:935
1872 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1877 #: ../src/guestfs.pod:938
1881 " qemudir=/home/rjones/d/qemu\n"
1882 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1888 #: ../src/guestfs.pod:942
1890 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1891 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1896 #: ../src/guestfs.pod:946
1899 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1904 #: ../src/guestfs.pod:948
1906 "Note that libguestfs also calls qemu with the -help and -version options in "
1907 "order to determine features."
1911 #: ../src/guestfs.pod:951
1912 msgid "ATTACHING TO RUNNING DAEMONS"
1916 #: ../src/guestfs.pod:953
1918 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
1919 "babies. Use with caution."
1923 #: ../src/guestfs.pod:956
1925 "I<Note (2):> This section explains how to attach to a running daemon from a "
1926 "low level perspective. For most users, simply using virt tools such as "
1927 "L<guestfish(1)> with the I<--live> option will \"just work\"."
1931 #: ../src/guestfs.pod:960
1932 msgid "Using guestfs_set_attach_method"
1936 #: ../src/guestfs.pod:962
1938 "By calling L</guestfs_set_attach_method> you can change how the library "
1939 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
1940 "L</ARCHITECTURE> for some background)."
1944 #: ../src/guestfs.pod:966
1946 "The normal attach method is C<appliance>, where a small appliance is created "
1947 "containing the daemon, and then the library connects to this."
1951 #: ../src/guestfs.pod:969
1953 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
1954 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
1955 "daemon over the Unix domain socket."
1959 #: ../src/guestfs.pod:973
1961 "The normal use for this is to connect to a running virtual machine that "
1962 "contains a C<guestfsd> daemon, and send commands so you can read and write "
1963 "files inside the live virtual machine."
1967 #: ../src/guestfs.pod:977
1968 msgid "Using guestfs_add_domain with live flag"
1972 #: ../src/guestfs.pod:979
1974 "L</guestfs_add_domain> provides some help for getting the correct attach "
1975 "method. If you pass the C<live> option to this function, then (if the "
1976 "virtual machine is running) it will examine the libvirt XML looking for a "
1977 "virtio-serial channel to connect to:"
1981 #: ../src/guestfs.pod:985
1988 " <channel type='unix'>\n"
1989 " <source mode='bind' path='/path/to/socket'/>\n"
1990 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
1999 #: ../src/guestfs.pod:997
2001 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2002 "method to C<unix:/path/to/socket>."
2006 #: ../src/guestfs.pod:1000
2008 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2009 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2010 "to attach to and modify live virtual machines."
2014 #: ../src/guestfs.pod:1004
2016 "The virtual machine needs to have been set up beforehand so that it has the "
2017 "virtio-serial channel and so that guestfsd is running inside it."
2021 #: ../src/guestfs.pod:1008
2022 msgid "ABI GUARANTEE"
2026 #: ../src/guestfs.pod:1010
2028 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2029 "actions as outlined in this section. Although we will deprecate some "
2030 "actions, for example if they get replaced by newer calls, we will keep the "
2031 "old actions forever. This allows you the developer to program in confidence "
2032 "against the libguestfs API."
2036 #: ../src/guestfs.pod:1016
2037 msgid "BLOCK DEVICE NAMING"
2041 #: ../src/guestfs.pod:1018
2043 "In the kernel there is now quite a profusion of schemata for naming block "
2044 "devices (in this context, by I<block device> I mean a physical or virtual "
2045 "hard drive). The original Linux IDE driver used names starting with "
2046 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
2047 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2048 "replacement for the old IDE driver (particularly for SATA devices) those "
2049 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2050 "machines with paravirtualized drivers. This has created several different "
2051 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2056 #: ../src/guestfs.pod:1030
2058 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2059 "Linux kernel to access block devices. We can run a variety of appliances "
2060 "based on a variety of Linux kernels."
2064 #: ../src/guestfs.pod:1034
2066 "This causes a problem for libguestfs because many API calls use device or "
2067 "partition names. Working scripts and the recipe (example) scripts that we "
2068 "make available over the internet could fail if the naming scheme changes."
2072 #: ../src/guestfs.pod:1039
2074 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2075 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2076 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2077 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2081 #: ../src/guestfs.pod:1045
2083 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2084 "L</guestfs_list_partitions> and similar calls return the true names of the "
2085 "devices and partitions as known to the appliance."
2089 #: ../src/guestfs.pod:1050
2090 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2094 #: ../src/guestfs.pod:1052
2096 "Usually this translation is transparent. However in some (very rare) cases "
2097 "you may need to know the exact algorithm. Such cases include where you use "
2098 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2099 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2104 #: ../src/guestfs.pod:1058
2106 "The algorithm is applied only to I<parameters> which are known to be either "
2107 "device or partition names. Return values from functions such as "
2108 "L</guestfs_list_devices> are never changed."
2112 #: ../src/guestfs.pod:1066
2113 msgid "Is the string a parameter which is a device or partition name?"
2117 #: ../src/guestfs.pod:1070
2118 msgid "Does the string begin with C</dev/sd>?"
2122 #: ../src/guestfs.pod:1074
2124 "Does the named device exist? If so, we use that device. However if I<not> "
2125 "then we continue with this algorithm."
2129 #: ../src/guestfs.pod:1079
2130 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2134 #: ../src/guestfs.pod:1081
2135 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2139 #: ../src/guestfs.pod:1083
2140 msgid "If that named device exists, use it. If not, continue."
2144 #: ../src/guestfs.pod:1087
2145 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2149 #: ../src/guestfs.pod:1089
2150 msgid "If that named device exists, use it. If not, return an error."
2154 #: ../src/guestfs.pod:1093
2155 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2159 #: ../src/guestfs.pod:1095
2161 "Although the standard naming scheme and automatic translation is useful for "
2162 "simple programs and guestfish scripts, for larger programs it is best not to "
2163 "rely on this mechanism."
2167 #: ../src/guestfs.pod:1099
2169 "Where possible for maximum future portability programs using libguestfs "
2170 "should use these future-proof techniques:"
2174 #: ../src/guestfs.pod:1106
2176 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2177 "device names, and then use those names directly."
2181 #: ../src/guestfs.pod:1109
2182 msgid "Since those device names exist by definition, they will never be translated."
2186 #: ../src/guestfs.pod:1114
2188 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2189 "filesystem labels."
2193 #: ../src/guestfs.pod:1119
2198 #: ../src/guestfs.pod:1121
2200 "This section discusses security implications of using libguestfs, "
2201 "particularly with untrusted or malicious guests or disk images."
2205 #: ../src/guestfs.pod:1124
2206 msgid "GENERAL SECURITY CONSIDERATIONS"
2210 #: ../src/guestfs.pod:1126
2212 "Be careful with any files or data that you download from a guest (by "
2213 "\"download\" we mean not just the L</guestfs_download> command but any "
2214 "command that reads files, filenames, directories or anything else from a "
2215 "disk image). An attacker could manipulate the data to fool your program "
2216 "into doing the wrong thing. Consider cases such as:"
2220 #: ../src/guestfs.pod:1136
2221 msgid "the data (file etc) not being present"
2225 #: ../src/guestfs.pod:1140
2226 msgid "being present but empty"
2230 #: ../src/guestfs.pod:1144
2231 msgid "being much larger than normal"
2235 #: ../src/guestfs.pod:1148
2236 msgid "containing arbitrary 8 bit data"
2240 #: ../src/guestfs.pod:1152
2241 msgid "being in an unexpected character encoding"
2245 #: ../src/guestfs.pod:1156
2246 msgid "containing homoglyphs."
2250 #: ../src/guestfs.pod:1160
2251 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2255 #: ../src/guestfs.pod:1162
2257 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2258 "(VFS) module can sometimes be escalated into exploits by deliberately "
2259 "creating a malicious, malformed filesystem. These exploits are very severe "
2260 "for two reasons. Firstly there are very many filesystem drivers in the "
2261 "kernel, and many of them are infrequently used and not much developer "
2262 "attention has been paid to the code. Linux userspace helps potential "
2263 "crackers by detecting the filesystem type and automatically choosing the "
2264 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2265 "the administrator. Secondly, a kernel-level exploit is like a local root "
2266 "exploit (worse in some ways), giving immediate and total access to the "
2267 "system right down to the hardware level."
2271 #: ../src/guestfs.pod:1175
2273 "That explains why you should never mount a filesystem from an untrusted "
2274 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2275 "inside a qemu virtual machine, usually running as a non-root user. The "
2276 "attacker would need to write a filesystem which first exploited the kernel, "
2277 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2278 "the libguestfs protocol, and finally to be as serious as the host kernel "
2279 "exploit it would need to escalate its privileges to root. This multi-step "
2280 "escalation, performed by a static piece of data, is thought to be extremely "
2281 "hard to do, although we never say 'never' about security issues."
2285 #: ../src/guestfs.pod:1186
2287 "In any case callers can reduce the attack surface by forcing the filesystem "
2288 "type when mounting (use L</guestfs_mount_vfs>)."
2292 #: ../src/guestfs.pod:1189
2293 msgid "PROTOCOL SECURITY"
2297 #: ../src/guestfs.pod:1191
2299 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2300 "defined upper message size. However a program that uses libguestfs must "
2301 "also take care - for example you can write a program that downloads a binary "
2302 "from a disk image and executes it locally, and no amount of protocol "
2303 "security will save you from the consequences."
2307 #: ../src/guestfs.pod:1197
2308 msgid "INSPECTION SECURITY"
2312 #: ../src/guestfs.pod:1199
2314 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2315 "directly from the guest, and these could contain any 8 bit data. Callers "
2316 "should be careful to escape these before printing them to a structured file "
2317 "(for example, use HTML escaping if creating a web page)."
2321 #: ../src/guestfs.pod:1205
2323 "Guest configuration may be altered in unusual ways by the administrator of "
2324 "the virtual machine, and may not reflect reality (particularly for untrusted "
2325 "or actively malicious guests). For example we parse the hostname from "
2326 "configuration files like C</etc/sysconfig/network> that we find in the "
2327 "guest, but the guest administrator can easily manipulate these files to "
2328 "provide the wrong hostname."
2332 #: ../src/guestfs.pod:1213
2334 "The inspection API parses guest configuration using two external libraries: "
2335 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2336 "designed to be robust in the face of malicious data, although denial of "
2337 "service attacks are still possible, for example with oversized configuration "
2342 #: ../src/guestfs.pod:1219
2343 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2347 #: ../src/guestfs.pod:1221
2349 "Be very cautious about running commands from the guest. By running a "
2350 "command in the guest, you are giving CPU time to a binary that you do not "
2351 "control, under the same user account as the library, albeit wrapped in qemu "
2352 "virtualization. More information and alternatives can be found in the "
2353 "section L</RUNNING COMMANDS>."
2357 #: ../src/guestfs.pod:1227
2358 msgid "CVE-2010-3851"
2362 #: ../src/guestfs.pod:1229
2363 msgid "https://bugzilla.redhat.com/642934"
2367 #: ../src/guestfs.pod:1231
2369 "This security bug concerns the automatic disk format detection that qemu "
2370 "does on disk images."
2374 #: ../src/guestfs.pod:1234
2376 "A raw disk image is just the raw bytes, there is no header. Other disk "
2377 "images like qcow2 contain a special header. Qemu deals with this by looking "
2378 "for one of the known headers, and if none is found then assuming the disk "
2379 "image must be raw."
2383 #: ../src/guestfs.pod:1239
2385 "This allows a guest which has been given a raw disk image to write some "
2386 "other header. At next boot (or when the disk image is accessed by "
2387 "libguestfs) qemu would do autodetection and think the disk image format was, "
2388 "say, qcow2 based on the header written by the guest."
2392 #: ../src/guestfs.pod:1244
2394 "This in itself would not be a problem, but qcow2 offers many features, one "
2395 "of which is to allow a disk image to refer to another image (called the "
2396 "\"backing disk\"). It does this by placing the path to the backing disk "
2397 "into the qcow2 header. This path is not validated and could point to any "
2398 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2399 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2400 "control of the attacker."
2404 #: ../src/guestfs.pod:1252
2405 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2409 #: ../src/guestfs.pod:1259
2410 msgid "You have enabled the network or have opened the disk in write mode."
2414 #: ../src/guestfs.pod:1263
2416 "You are also running untrusted code from the guest (see L</RUNNING "
2421 #: ../src/guestfs.pod:1268
2423 "The way to avoid this is to specify the expected disk format when adding "
2424 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2425 "should always do this if the disk is raw format, and it's a good idea for "
2430 #: ../src/guestfs.pod:1273
2432 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2433 "format is fetched from libvirt and passed through."
2437 #: ../src/guestfs.pod:1276
2439 "For libguestfs tools, use the I<--format> command line parameter as "
2444 #: ../src/guestfs.pod:1279
2445 msgid "CONNECTION MANAGEMENT"
2449 #: ../src/guestfs.pod:1281
2454 #: ../src/guestfs.pod:1283
2456 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2457 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2458 "handle and release all resources used."
2462 #: ../src/guestfs.pod:1287
2464 "For information on using multiple handles and threads, see the section "
2465 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2469 #: ../src/guestfs.pod:1290
2470 msgid "guestfs_create"
2474 #: ../src/guestfs.pod:1292
2477 " guestfs_h *guestfs_create (void);\n"
2482 #: ../src/guestfs.pod:1294
2483 msgid "Create a connection handle."
2487 #: ../src/guestfs.pod:1296
2489 "On success this returns a non-NULL pointer to a handle. On error it returns "
2494 #: ../src/guestfs.pod:1299
2496 "You have to \"configure\" the handle after creating it. This includes "
2497 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2498 "handle at least once."
2502 #: ../src/guestfs.pod:1303
2503 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2507 #: ../src/guestfs.pod:1305
2509 "You may also want to configure error handling for the handle. See the "
2510 "L</ERROR HANDLING> section below."
2514 #: ../src/guestfs.pod:1308
2515 msgid "guestfs_close"
2519 #: ../src/guestfs.pod:1310
2522 " void guestfs_close (guestfs_h *g);\n"
2527 #: ../src/guestfs.pod:1312
2528 msgid "This closes the connection handle and frees up all resources used."
2532 #: ../src/guestfs.pod:1314
2534 "If autosync was set on the handle and the handle was launched, then this "
2535 "implicitly calls various functions to unmount filesystems and sync the "
2536 "disk. See L</guestfs_set_autosync> for more details."
2540 #: ../src/guestfs.pod:1318
2541 msgid "If a close callback was set on the handle, then it is called."
2545 #: ../src/guestfs.pod:1320
2546 msgid "ERROR HANDLING"
2550 #: ../src/guestfs.pod:1322
2552 "API functions can return errors. For example, almost all functions that "
2553 "return C<int> will return C<-1> to indicate an error."
2557 #: ../src/guestfs.pod:1325
2559 "Additional information is available for errors: an error message string and "
2560 "optionally an error number (errno) if the thing that failed was a system "
2565 #: ../src/guestfs.pod:1329
2567 "You can get at the additional information about the last error on the handle "
2568 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2569 "up an error handler with L</guestfs_set_error_handler>."
2573 #: ../src/guestfs.pod:1334
2575 "When the handle is created, a default error handler is installed which "
2576 "prints the error message string to C<stderr>. For small short-running "
2577 "command line programs it is sufficient to do:"
2581 #: ../src/guestfs.pod:1338
2584 " if (guestfs_launch (g) == -1)\n"
2585 " exit (EXIT_FAILURE);\n"
2590 #: ../src/guestfs.pod:1341
2592 "since the default error handler will ensure that an error message has been "
2593 "printed to C<stderr> before the program exits."
2597 #: ../src/guestfs.pod:1344
2599 "For other programs the caller will almost certainly want to install an "
2600 "alternate error handler or do error handling in-line like this:"
2604 #: ../src/guestfs.pod:1347
2607 " g = guestfs_create ();\n"
2612 #: ../src/guestfs.pod:1349
2615 " /* This disables the default behaviour of printing errors\n"
2617 " guestfs_set_error_handler (g, NULL, NULL);\n"
2622 #: ../src/guestfs.pod:1353
2625 " if (guestfs_launch (g) == -1) {\n"
2626 " /* Examine the error message and print it etc. */\n"
2627 " char *msg = guestfs_last_error (g);\n"
2628 " int errnum = guestfs_last_errno (g);\n"
2629 " fprintf (stderr, \"%s\\n\", msg);\n"
2636 #: ../src/guestfs.pod:1361
2638 "Out of memory errors are handled differently. The default action is to call "
2639 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2640 "L</guestfs_set_out_of_memory_handler>."
2644 #: ../src/guestfs.pod:1365
2646 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2647 "because there is no handle if this happens there is no way to get additional "
2648 "error information. However L</guestfs_create> is supposed to be a "
2649 "lightweight operation which can only fail because of insufficient memory (it "
2650 "returns NULL in this case)."
2654 #: ../src/guestfs.pod:1371
2655 msgid "guestfs_last_error"
2659 #: ../src/guestfs.pod:1373
2662 " const char *guestfs_last_error (guestfs_h *g);\n"
2667 #: ../src/guestfs.pod:1375
2669 "This returns the last error message that happened on C<g>. If there has not "
2670 "been an error since the handle was created, then this returns C<NULL>."
2674 #: ../src/guestfs.pod:1379
2676 "The lifetime of the returned string is until the next error occurs, or "
2677 "L</guestfs_close> is called."
2681 #: ../src/guestfs.pod:1382
2682 msgid "guestfs_last_errno"
2686 #: ../src/guestfs.pod:1384
2689 " int guestfs_last_errno (guestfs_h *g);\n"
2694 #: ../src/guestfs.pod:1386
2695 msgid "This returns the last error number (errno) that happened on C<g>."
2699 #: ../src/guestfs.pod:1388
2700 msgid "If successful, an errno integer not equal to zero is returned."
2704 #: ../src/guestfs.pod:1390
2705 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2709 #: ../src/guestfs.pod:1397
2710 msgid "There has not been any error on the handle."
2714 #: ../src/guestfs.pod:1401
2716 "There has been an error but the errno was meaningless. This corresponds to "
2717 "the case where the error did not come from a failed system call, but for "
2718 "some other reason."
2722 #: ../src/guestfs.pod:1407
2724 "There was an error from a failed system call, but for some reason the errno "
2725 "was not captured and returned. This usually indicates a bug in libguestfs."
2729 #: ../src/guestfs.pod:1413
2731 "Libguestfs tries to convert the errno from inside the applicance into a "
2732 "corresponding errno for the caller (not entirely trivial: the appliance "
2733 "might be running a completely different operating system from the library "
2734 "and error numbers are not standardized across Un*xen). If this could not be "
2735 "done, then the error is translated to C<EINVAL>. In practice this should "
2736 "only happen in very rare circumstances."
2740 #: ../src/guestfs.pod:1421
2741 msgid "guestfs_set_error_handler"
2745 #: ../src/guestfs.pod:1423
2748 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2750 " const char *msg);\n"
2751 " void guestfs_set_error_handler (guestfs_h *g,\n"
2752 " guestfs_error_handler_cb cb,\n"
2758 #: ../src/guestfs.pod:1430
2760 "The callback C<cb> will be called if there is an error. The parameters "
2761 "passed to the callback are an opaque data pointer and the error message "
2766 #: ../src/guestfs.pod:1434
2768 "C<errno> is not passed to the callback. To get that the callback must call "
2769 "L</guestfs_last_errno>."
2773 #: ../src/guestfs.pod:1437
2775 "Note that the message string C<msg> is freed as soon as the callback "
2776 "function returns, so if you want to stash it somewhere you must make your "
2781 #: ../src/guestfs.pod:1441
2782 msgid "The default handler prints messages on C<stderr>."
2786 #: ../src/guestfs.pod:1443
2787 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2791 #: ../src/guestfs.pod:1445
2792 msgid "guestfs_get_error_handler"
2796 #: ../src/guestfs.pod:1447
2799 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2800 " void **opaque_rtn);\n"
2805 #: ../src/guestfs.pod:1450
2806 msgid "Returns the current error handler callback."
2810 #: ../src/guestfs.pod:1452
2811 msgid "guestfs_set_out_of_memory_handler"
2815 #: ../src/guestfs.pod:1454
2818 " typedef void (*guestfs_abort_cb) (void);\n"
2819 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2820 " guestfs_abort_cb);\n"
2825 #: ../src/guestfs.pod:1458
2827 "The callback C<cb> will be called if there is an out of memory situation. "
2828 "I<Note this callback must not return>."
2832 #: ../src/guestfs.pod:1461
2833 msgid "The default is to call L<abort(3)>."
2837 #: ../src/guestfs.pod:1463
2838 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2842 #: ../src/guestfs.pod:1466
2843 msgid "guestfs_get_out_of_memory_handler"
2847 #: ../src/guestfs.pod:1468
2850 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2855 #: ../src/guestfs.pod:1470
2856 msgid "This returns the current out of memory handler."
2860 #: ../src/guestfs.pod:1472
2865 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1010
2870 #: ../src/guestfs.pod:1476
2875 #: ../src/guestfs.pod:1478
2880 #: ../src/guestfs.pod:1480
2881 msgid "AVAILABILITY"
2885 #: ../src/guestfs.pod:1482
2886 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2890 #: ../src/guestfs.pod:1484
2892 "Using L</guestfs_available> you can test availability of the following "
2893 "groups of functions. This test queries the appliance to see if the "
2894 "appliance you are currently using supports the functionality."
2898 #: ../src/guestfs.pod:1489
2899 msgid "@AVAILABILITY@"
2903 #: ../src/guestfs.pod:1491
2904 msgid "GUESTFISH supported COMMAND"
2908 #: ../src/guestfs.pod:1493
2910 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2911 "prints out the available groups and whether they are supported by this build "
2912 "of libguestfs. Note however that you have to do C<run> first."
2916 #: ../src/guestfs.pod:1498
2917 msgid "SINGLE CALLS AT COMPILE TIME"
2921 #: ../src/guestfs.pod:1500
2923 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2924 "function, such as:"
2928 #: ../src/guestfs.pod:1503
2931 " #define LIBGUESTFS_HAVE_DD 1\n"
2936 #: ../src/guestfs.pod:1505
2937 msgid "if L</guestfs_dd> is available."
2941 #: ../src/guestfs.pod:1507
2943 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2944 "function is available at compile time, we recommended using build tools such "
2945 "as autoconf or cmake. For example in autotools you could use:"
2949 #: ../src/guestfs.pod:1512
2952 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2953 " AC_CHECK_FUNCS([guestfs_dd])\n"
2958 #: ../src/guestfs.pod:1515
2960 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2965 #: ../src/guestfs.pod:1518
2966 msgid "SINGLE CALLS AT RUN TIME"
2970 #: ../src/guestfs.pod:1520
2972 "Testing at compile time doesn't guarantee that a function really exists in "
2973 "the library. The reason is that you might be dynamically linked against a "
2974 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2975 "This situation unfortunately results in a segmentation fault, which is a "
2976 "shortcoming of the C dynamic linking system itself."
2980 #: ../src/guestfs.pod:1527
2982 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2983 "in this example program (note that you still need the compile time check as "
2988 #: ../src/guestfs.pod:1531
2991 " #include <stdio.h>\n"
2992 " #include <stdlib.h>\n"
2993 " #include <unistd.h>\n"
2994 " #include <dlfcn.h>\n"
2995 " #include <guestfs.h>\n"
3000 #: ../src/guestfs.pod:1537
3005 " #ifdef LIBGUESTFS_HAVE_DD\n"
3007 " int has_function;\n"
3012 #: ../src/guestfs.pod:1543
3015 " /* Test if the function guestfs_dd is really available. */\n"
3016 " dl = dlopen (NULL, RTLD_LAZY);\n"
3018 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3019 " exit (EXIT_FAILURE);\n"
3021 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3027 #: ../src/guestfs.pod:1552
3030 " if (!has_function)\n"
3031 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3033 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3034 " /* Now it's safe to call\n"
3035 " guestfs_dd (g, \"foo\", \"bar\");\n"
3039 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3046 #: ../src/guestfs.pod:1565
3048 "You may think the above is an awful lot of hassle, and it is. There are "
3049 "other ways outside of the C linking system to ensure that this kind of "
3050 "incompatibility never arises, such as using package versioning:"
3054 #: ../src/guestfs.pod:1570
3057 " Requires: libguestfs >= 1.0.80\n"
3062 #: ../src/guestfs.pod:1572
3063 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3067 #: ../src/guestfs.pod:1574
3069 "A recent feature of the API is the introduction of calls which take optional "
3070 "arguments. In C these are declared 3 ways. The main way is as a call which "
3071 "takes variable arguments (ie. C<...>), as in this example:"
3075 #: ../src/guestfs.pod:1579
3078 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3083 #: ../src/guestfs.pod:1581
3085 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3086 "call with no optional arguments specified:"
3090 #: ../src/guestfs.pod:1584
3093 " guestfs_add_drive_opts (g, filename, -1);\n"
3098 #: ../src/guestfs.pod:1586
3099 msgid "With a single optional argument:"
3103 #: ../src/guestfs.pod:1588
3106 " guestfs_add_drive_opts (g, filename,\n"
3107 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3113 #: ../src/guestfs.pod:1592
3118 #: ../src/guestfs.pod:1594
3121 " guestfs_add_drive_opts (g, filename,\n"
3122 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3123 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3129 #: ../src/guestfs.pod:1599
3131 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3136 #: ../src/guestfs.pod:1602
3137 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3141 #: ../src/guestfs.pod:1604
3143 "The second variant has the same name with the suffix C<_va>, which works the "
3144 "same way but takes a C<va_list>. See the C manual for details. For the "
3145 "example function, this is declared:"
3149 #: ../src/guestfs.pod:1608
3152 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3158 #: ../src/guestfs.pod:1611
3159 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3163 #: ../src/guestfs.pod:1613
3165 "The third variant is useful where you need to construct these calls. You "
3166 "pass in a structure where you fill in the optional fields. The structure "
3167 "has a bitmask as the first element which you must set to indicate which "
3168 "fields you have filled in. For our example function the structure and call "
3173 #: ../src/guestfs.pod:1619
3176 " struct guestfs_add_drive_opts_argv {\n"
3177 " uint64_t bitmask;\n"
3179 " const char *format;\n"
3182 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3183 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3188 #: ../src/guestfs.pod:1628
3189 msgid "You could call it like this:"
3193 #: ../src/guestfs.pod:1630
3196 " struct guestfs_add_drive_opts_argv optargs = {\n"
3197 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3198 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3200 " .format = \"qcow2\"\n"
3206 #: ../src/guestfs.pod:1637
3209 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3214 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1265 ../tools/virt-win-reg.pl:703
3219 #: ../src/guestfs.pod:1645
3220 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3224 #: ../src/guestfs.pod:1650
3225 msgid "You do not need to fill in all fields of the structure."
3229 #: ../src/guestfs.pod:1654
3231 "There must be a one-to-one correspondence between fields of the structure "
3232 "that are filled in, and bits set in the bitmask."
3236 #: ../src/guestfs.pod:1659
3237 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3241 #: ../src/guestfs.pod:1661
3243 "In other languages, optional arguments are expressed in the way that is "
3244 "natural for that language. We refer you to the language-specific "
3245 "documentation for more details on that."
3249 #: ../src/guestfs.pod:1665
3250 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3254 #: ../src/guestfs.pod:1667
3255 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3259 #: ../src/guestfs.pod:1669
3261 "B<Note:> This section documents the generic event mechanism introduced in "
3262 "libguestfs 1.10, which you should use in new code if possible. The old "
3263 "functions C<guestfs_set_log_message_callback>, "
3264 "C<guestfs_set_subprocess_quit_callback>, "
3265 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3266 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3267 "page. Because of the ABI guarantee, the old functions continue to work."
3271 #: ../src/guestfs.pod:1678
3273 "Handles generate events when certain things happen, such as log messages "
3274 "being generated, progress messages during long-running operations, or the "
3275 "handle being closed. The API calls described below let you register a "
3276 "callback to be called when events happen. You can register multiple "
3277 "callbacks (for the same, different or overlapping sets of events), and "
3278 "individually remove callbacks. If callbacks are not removed, then they "
3279 "remain in force until the handle is closed."
3283 #: ../src/guestfs.pod:1686
3285 "In the current implementation, events are only generated synchronously: that "
3286 "means that events (and hence callbacks) can only happen while you are in the "
3287 "middle of making another libguestfs call. The callback is called in the "
3292 #: ../src/guestfs.pod:1691
3294 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3295 "unsigned integers, or a message buffer. Payloads are discussed later on."
3299 #: ../src/guestfs.pod:1695
3300 msgid "CLASSES OF EVENTS"
3304 #: ../src/guestfs.pod:1699
3305 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3309 #: ../src/guestfs.pod:1702
3311 "The callback function will be called while the handle is being closed "
3312 "(synchronously from L</guestfs_close>)."
3316 #: ../src/guestfs.pod:1705
3318 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3319 "handles that are open when the program exits. This means that this callback "
3320 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3321 "problems in higher-level languages (eg. if your HLL interpreter has already "
3322 "been cleaned up by the time this is called, and if your callback then jumps "
3323 "into some HLL function)."
3327 #: ../src/guestfs.pod:1712
3329 "If no callback is registered: the handle is closed without any callback "
3334 #: ../src/guestfs.pod:1715
3335 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3339 #: ../src/guestfs.pod:1718
3341 "The callback function will be called when the child process quits, either "
3342 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3343 "corresponds to a transition from any state to the CONFIG state)."
3347 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3348 msgid "If no callback is registered: the event is ignored."
3352 #: ../src/guestfs.pod:1724
3353 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3357 #: ../src/guestfs.pod:1727
3359 "The callback function will be called when the child process becomes ready "
3360 "first time after it has been launched. (This corresponds to a transition "
3361 "from LAUNCHING to the READY state)."
3365 #: ../src/guestfs.pod:1733
3366 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3370 #: ../src/guestfs.pod:1736
3372 "Some long-running operations can generate progress messages. If this "
3373 "callback is registered, then it will be called each time a progress message "
3374 "is generated (usually two seconds after the operation started, and three "
3375 "times per second thereafter until it completes, although the frequency may "
3376 "change in future versions)."
3380 #: ../src/guestfs.pod:1742
3382 "The callback receives in the payload four unsigned 64 bit numbers which are "
3383 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3387 #: ../src/guestfs.pod:1745
3389 "The units of C<total> are not defined, although for some operations C<total> "
3390 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3391 "or megabytes), and C<position> may be the portion which has been "
3396 #: ../src/guestfs.pod:1750
3397 msgid "The only defined and stable parts of the API are:"
3401 #: ../src/guestfs.pod:1756
3403 "The callback can display to the user some type of progress bar or indicator "
3404 "which shows the ratio of C<position>:C<total>."
3408 #: ../src/guestfs.pod:1761
3409 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3413 #: ../src/guestfs.pod:1765
3415 "If any progress notification is sent during a call, then a final progress "
3416 "notification is always sent when C<position> = C<total> (I<unless> the call "
3417 "fails with an error)."
3421 #: ../src/guestfs.pod:1769
3423 "This is to simplify caller code, so callers can easily set the progress "
3424 "indicator to \"100%\" at the end of the operation, without requiring special "
3425 "code to detect this case."
3429 #: ../src/guestfs.pod:1775
3431 "For some calls we are unable to estimate the progress of the call, but we "
3432 "can still generate progress messages to indicate activity. This is known as "
3433 "\"pulse mode\", and is directly supported by certain progress bar "
3434 "implementations (eg. GtkProgressBar)."
3438 #: ../src/guestfs.pod:1780
3440 "For these calls, zero or more progress messages are generated with "
3441 "C<position = 0> and C<total = 1>, followed by a final message with "
3442 "C<position = total = 1>."
3446 #: ../src/guestfs.pod:1784
3448 "As noted above, if the call fails with an error then the final message may "
3453 #: ../src/guestfs.pod:1789
3455 "The callback also receives the procedure number (C<proc_nr>) and serial "
3456 "number (C<serial>) of the call. These are only useful for debugging "
3457 "protocol issues, and the callback can normally ignore them. The callback "
3458 "may want to print these numbers in error messages or debugging messages."
3462 #: ../src/guestfs.pod:1795
3463 msgid "If no callback is registered: progress messages are discarded."
3467 #: ../src/guestfs.pod:1797
3468 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3472 #: ../src/guestfs.pod:1800
3474 "The callback function is called whenever a log message is generated by qemu, "
3475 "the appliance kernel, guestfsd (daemon), or utility programs."
3479 #: ../src/guestfs.pod:1803
3481 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
3482 "(L</guestfs_launch>) then additional debug messages are generated."
3486 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3488 "If no callback is registered: the messages are discarded unless the verbose "
3489 "flag is set in which case they are sent to stderr. You can override the "
3490 "printing of verbose messages to stderr by setting up a callback."
3494 #: ../src/guestfs.pod:1811
3495 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3499 #: ../src/guestfs.pod:1814
3501 "The callback function is called whenever a log message is generated by the "
3502 "library part of libguestfs."
3506 #: ../src/guestfs.pod:1817
3508 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3509 "messages are generated."
3513 #: ../src/guestfs.pod:1825
3514 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3518 #: ../src/guestfs.pod:1828
3520 "The callback function is called whenever a trace message is generated. This "
3521 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3525 #: ../src/guestfs.pod:1831
3527 "If no callback is registered: the messages are sent to stderr. You can "
3528 "override the printing of trace messages to stderr by setting up a callback."
3532 #: ../src/guestfs.pod:1837
3533 msgid "guestfs_set_event_callback"
3537 #: ../src/guestfs.pod:1839
3540 " int guestfs_set_event_callback (guestfs_h *g,\n"
3541 " guestfs_event_callback cb,\n"
3542 " uint64_t event_bitmask,\n"
3549 #: ../src/guestfs.pod:1845
3551 "This function registers a callback (C<cb>) for all event classes in the "
3556 #: ../src/guestfs.pod:1848
3558 "For example, to register for all log message events, you could call this "
3559 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3560 "To register a single callback for all possible classes of events, use "
3561 "C<GUESTFS_EVENT_ALL>."
3565 #: ../src/guestfs.pod:1854
3566 msgid "C<flags> should always be passed as 0."
3570 #: ../src/guestfs.pod:1856
3572 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3573 "it for any purpose."
3577 #: ../src/guestfs.pod:1859
3579 "The return value is the event handle (an integer) which you can use to "
3580 "delete the callback (see below)."
3584 #: ../src/guestfs.pod:1862
3586 "If there is an error, this function returns C<-1>, and sets the error in the "
3587 "handle in the usual way (see L</guestfs_last_error> etc.)"
3591 #: ../src/guestfs.pod:1865
3593 "Callbacks remain in effect until they are deleted, or until the handle is "
3598 #: ../src/guestfs.pod:1868
3600 "In the case where multiple callbacks are registered for a particular event "
3601 "class, all of the callbacks are called. The order in which multiple "
3602 "callbacks are called is not defined."
3606 #: ../src/guestfs.pod:1872
3607 msgid "guestfs_delete_event_callback"
3611 #: ../src/guestfs.pod:1874
3614 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3619 #: ../src/guestfs.pod:1876
3621 "Delete a callback that was previously registered. C<event_handle> should be "
3622 "the integer that was returned by a previous call to "
3623 "C<guestfs_set_event_callback> on the same handle."
3627 #: ../src/guestfs.pod:1880
3628 msgid "guestfs_event_callback"
3632 #: ../src/guestfs.pod:1882
3635 " typedef void (*guestfs_event_callback) (\n"
3638 " uint64_t event,\n"
3639 " int event_handle,\n"
3641 " const char *buf, size_t buf_len,\n"
3642 " const uint64_t *array, size_t array_len);\n"
3647 #: ../src/guestfs.pod:1891
3648 msgid "This is the type of the event callback function that you have to provide."
3652 #: ../src/guestfs.pod:1894
3654 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3655 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3656 "handle, and C<flags> which in the current API you should ignore."
3660 #: ../src/guestfs.pod:1898
3662 "The remaining parameters contain the event payload (if any). Each event may "
3663 "contain a payload, which usually relates to the event class, but for future "
3664 "proofing your code should be written to handle any payload for any event "
3669 #: ../src/guestfs.pod:1903
3671 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3672 "there is no message buffer). Note that this message buffer can contain "
3673 "arbitrary 8 bit data, including NUL bytes."
3677 #: ../src/guestfs.pod:1907
3679 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3680 "moment this is only used for progress messages."
3684 #: ../src/guestfs.pod:1910
3685 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3689 #: ../src/guestfs.pod:1912
3691 "One motivation for the generic event API was to allow GUI programs to "
3692 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3693 "unconditionally to C<stderr>."
3697 #: ../src/guestfs.pod:1916
3699 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3700 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3701 "messages are not events; you must capture error messages separately)."
3705 #: ../src/guestfs.pod:1921
3707 "Programs have to set up a callback to capture the classes of events of "
3712 #: ../src/guestfs.pod:1924
3716 " guestfs_set_event_callback\n"
3717 " (g, message_callback,\n"
3718 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3719 " GUESTFS_EVENT_TRACE,\n"
3720 " 0, NULL) == -1)\n"
3721 " if (eh == -1) {\n"
3722 " // handle error in the usual way\n"
3728 #: ../src/guestfs.pod:1934
3730 "The callback can then direct messages to the appropriate place. In this "
3731 "example, messages are directed to syslog:"
3735 #: ../src/guestfs.pod:1937
3739 " message_callback (\n"
3742 " uint64_t event,\n"
3743 " int event_handle,\n"
3745 " const char *buf, size_t buf_len,\n"
3746 " const uint64_t *array, size_t array_len)\n"
3748 " const int priority = LOG_USER|LOG_INFO;\n"
3749 " if (buf_len > 0)\n"
3750 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3756 #: ../src/guestfs.pod:1952
3757 msgid "PRIVATE DATA AREA"
3761 #: ../src/guestfs.pod:1954
3763 "You can attach named pieces of private data to the libguestfs handle, fetch "
3764 "them by name, and walk over them, for the lifetime of the handle. This is "
3765 "called the private data area and is only available from the C API."
3769 #: ../src/guestfs.pod:1959
3770 msgid "To attach a named piece of data, use the following call:"
3774 #: ../src/guestfs.pod:1961
3777 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3782 #: ../src/guestfs.pod:1963
3784 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3785 "pointer (which can be C<NULL>). Any previous item with the same key is "
3790 #: ../src/guestfs.pod:1967
3792 "You can use any C<key> you want, but your key should I<not> start with an "
3793 "underscore character. Keys beginning with an underscore character are "
3794 "reserved for internal libguestfs purposes (eg. for implementing language "
3795 "bindings). It is recommended that you prefix the key with some unique "
3796 "string to avoid collisions with other users."
3800 #: ../src/guestfs.pod:1973
3801 msgid "To retrieve the pointer, use:"
3805 #: ../src/guestfs.pod:1975
3808 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3813 #: ../src/guestfs.pod:1977
3815 "This function returns C<NULL> if either no data is found associated with "
3816 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3821 #: ../src/guestfs.pod:1981
3823 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3824 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3825 "all. In particular, libguestfs does I<not> try to free the data when the "
3826 "handle is closed. If the data must be freed, then the caller must either "
3827 "free it before calling L</guestfs_close> or must set up a close callback to "
3828 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3832 #: ../src/guestfs.pod:1988
3833 msgid "To walk over all entries, use these two functions:"
3837 #: ../src/guestfs.pod:1990
3840 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3845 #: ../src/guestfs.pod:1992
3848 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3853 #: ../src/guestfs.pod:1994
3855 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3856 "not have any particular meaning -- keys are not returned in any defined "
3857 "order). A pointer to the key is returned in C<*key_rtn> and the "
3858 "corresponding data pointer is returned from the function. C<NULL> is "
3859 "returned if there are no keys stored in the handle."
3863 #: ../src/guestfs.pod:2000
3865 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3866 "value of this function is also C<NULL> is there are no further entries to "
3871 #: ../src/guestfs.pod:2004
3872 msgid "Notes about walking over entries:"
3876 #: ../src/guestfs.pod:2010
3877 msgid "You must not call C<guestfs_set_private> while walking over the entries."
3881 #: ../src/guestfs.pod:2015
3883 "The handle maintains an internal iterator which is reset when you call "
3884 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3885 "call C<guestfs_set_private>."
3889 #: ../src/guestfs.pod:2021
3890 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3894 #: ../src/guestfs.pod:2023
3897 " guestfs_set_private (g, key, NULL);\n"
3902 #: ../src/guestfs.pod:2025
3903 msgid "then that C<key> is not returned when walking."
3907 #: ../src/guestfs.pod:2029
3909 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
3910 "C<guestfs_next_private> or C<guestfs_set_private>."
3914 #: ../src/guestfs.pod:2035
3916 "The following example code shows how to print all keys and data pointers "
3917 "that are associated with the handle C<g>:"
3921 #: ../src/guestfs.pod:2038
3924 " const char *key;\n"
3925 " void *data = guestfs_first_private (g, &key);\n"
3926 " while (data != NULL)\n"
3928 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3929 " data = guestfs_next_private (g, &key);\n"
3935 #: ../src/guestfs.pod:2046
3937 "More commonly you are only interested in keys that begin with an "
3938 "application-specific prefix C<foo_>. Modify the loop like so:"
3942 #: ../src/guestfs.pod:2049
3945 " const char *key;\n"
3946 " void *data = guestfs_first_private (g, &key);\n"
3947 " while (data != NULL)\n"
3949 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3950 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3951 " data = guestfs_next_private (g, &key);\n"
3957 #: ../src/guestfs.pod:2058
3959 "If you need to modify keys while walking, then you have to jump back to the "
3960 "beginning of the loop. For example, to delete all keys prefixed with "
3965 #: ../src/guestfs.pod:2062
3968 " const char *key;\n"
3971 " data = guestfs_first_private (g, &key);\n"
3972 " while (data != NULL)\n"
3974 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3976 " guestfs_set_private (g, key, NULL);\n"
3977 " /* note that 'key' pointer is now invalid, and so is\n"
3978 " the internal iterator */\n"
3981 " data = guestfs_next_private (g, &key);\n"
3987 #: ../src/guestfs.pod:2078
3989 "Note that the above loop is guaranteed to terminate because the keys are "
3990 "being deleted, but other manipulations of keys within the loop might not "
3991 "terminate unless you also maintain an indication of which keys have been "
3996 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4001 #: ../src/guestfs.pod:2085
4003 "<!-- old anchor for the next section --> <a "
4004 "name=\"state_machine_and_low_level_event_api\"/>"
4008 #: ../src/guestfs.pod:2090
4009 msgid "ARCHITECTURE"
4013 #: ../src/guestfs.pod:2092
4015 "Internally, libguestfs is implemented by running an appliance (a special "
4016 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4017 "process of the main program."
4021 #: ../src/guestfs.pod:2096
4024 " ___________________\n"
4026 " | main program |\n"
4028 " | | child process / appliance\n"
4029 " | | __________________________\n"
4031 " +-------------------+ RPC | +-----------------+ |\n"
4032 " | libguestfs <--------------------> guestfsd | |\n"
4033 " | | | +-----------------+ |\n"
4034 " \\___________________/ | | Linux kernel | |\n"
4035 " | +--^--------------+ |\n"
4036 " \\_________|________________/\n"
4042 " \\______________/\n"
4047 #: ../src/guestfs.pod:2116
4049 "The library, linked to the main program, creates the child process and hence "
4050 "the appliance in the L</guestfs_launch> function."
4054 #: ../src/guestfs.pod:2119
4056 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4057 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4058 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4059 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4060 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4061 "attached to the qemu process which translates device access by the "
4062 "appliance's Linux kernel into accesses to the image."
4066 #: ../src/guestfs.pod:2128
4068 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4069 "Although the disk image you are attached to might also be used by some "
4070 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4071 "care if both libguestfs's qemu process and your virtual machine are trying "
4072 "to update the disk image at the same time, since these usually results in "
4073 "massive disk corruption)."
4077 #: ../src/guestfs.pod:2135
4078 msgid "STATE MACHINE"
4082 #: ../src/guestfs.pod:2137
4083 msgid "libguestfs uses a state machine to model the child process:"
4087 #: ../src/guestfs.pod:2139
4099 " / | \\ \\ guestfs_launch\n"
4100 " / | _\\__V______\n"
4102 " / | | LAUNCHING |\n"
4103 " / | \\___________/\n"
4105 " / | guestfs_launch\n"
4107 " ______ / __|____V\n"
4108 " / \\ ------> / \\\n"
4109 " | BUSY | | READY |\n"
4110 " \\______/ <------ \\________/\n"
4115 #: ../src/guestfs.pod:2161
4117 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4118 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4119 "(3) alternating between READY and BUSY as commands are issued to, and "
4120 "carried out by, the child process."
4124 #: ../src/guestfs.pod:2166
4126 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4127 "asynchronously at any time (eg. due to some internal error), and that causes "
4128 "the state to transition back to CONFIG."
4132 #: ../src/guestfs.pod:2170
4134 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4135 "issued when in the CONFIG state."
4139 #: ../src/guestfs.pod:2173
4141 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4142 "L</guestfs_launch> blocks until the child process is READY to accept "
4143 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4144 "moves the state from CONFIG to LAUNCHING while it is running."
4148 #: ../src/guestfs.pod:2179
4150 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4151 "state. These API calls block waiting for the command to be carried out "
4152 "(ie. the state to transition to BUSY and then back to READY). There are no "
4153 "non-blocking versions, and no way to issue more than one command per handle "
4158 #: ../src/guestfs.pod:2185
4160 "Finally, the child process sends asynchronous messages back to the main "
4161 "program, such as kernel log messages. You can register a callback to "
4162 "receive these messages."
4166 #: ../src/guestfs.pod:2189
4171 #: ../src/guestfs.pod:2191
4172 msgid "COMMUNICATION PROTOCOL"
4176 #: ../src/guestfs.pod:2193
4178 "Don't rely on using this protocol directly. This section documents how it "
4179 "currently works, but it may change at any time."
4183 #: ../src/guestfs.pod:2196
4185 "The protocol used to talk between the library and the daemon running inside "
4186 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4187 "1014, RFC 1832, RFC 4506)."
4191 #: ../src/guestfs.pod:2200
4193 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4194 "this file is automatically generated)."
4198 #: ../src/guestfs.pod:2203
4200 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4201 "and C<FileOut> parameters, which are handled with very simple request/reply "
4202 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4203 "parameters, which use the same request and reply messages, but they may also "
4204 "be followed by files sent using a chunked encoding."
4208 #: ../src/guestfs.pod:2210
4209 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4213 #: ../src/guestfs.pod:2212
4214 msgid "For ordinary functions, the request message is:"
4218 #: ../src/guestfs.pod:2214
4221 " total length (header + arguments,\n"
4222 " but not including the length word itself)\n"
4223 " struct guestfs_message_header (encoded as XDR)\n"
4224 " struct guestfs_<foo>_args (encoded as XDR)\n"
4229 #: ../src/guestfs.pod:2219
4231 "The total length field allows the daemon to allocate a fixed size buffer "
4232 "into which it slurps the rest of the message. As a result, the total length "
4233 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4234 "effective size of any request is limited to somewhere under this size."
4238 #: ../src/guestfs.pod:2225
4240 "Note also that many functions don't take any arguments, in which case the "
4241 "C<guestfs_I<foo>_args> is completely omitted."
4245 #: ../src/guestfs.pod:2228
4247 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4248 "receiver knows what type of args structure to expect, or none at all."
4252 #: ../src/guestfs.pod:2232
4254 "For functions that take optional arguments, the optional arguments are "
4255 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4256 "arguments. A bitmask in the header indicates which optional arguments are "
4257 "meaningful. The bitmask is also checked to see if it contains bits set "
4258 "which the daemon does not know about (eg. if more optional arguments were "
4259 "added in a later version of the library), and this causes the call to be "
4264 #: ../src/guestfs.pod:2240
4265 msgid "The reply message for ordinary functions is:"
4269 #: ../src/guestfs.pod:2242
4272 " total length (header + ret,\n"
4273 " but not including the length word itself)\n"
4274 " struct guestfs_message_header (encoded as XDR)\n"
4275 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4280 #: ../src/guestfs.pod:2247
4282 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4283 "functions that return no formal return values."
4287 #: ../src/guestfs.pod:2250
4288 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4292 #: ../src/guestfs.pod:2253
4294 "In the case of an error, a flag is set in the header, and the reply message "
4295 "is slightly changed:"
4299 #: ../src/guestfs.pod:2256
4302 " total length (header + error,\n"
4303 " but not including the length word itself)\n"
4304 " struct guestfs_message_header (encoded as XDR)\n"
4305 " struct guestfs_message_error (encoded as XDR)\n"
4310 #: ../src/guestfs.pod:2261
4312 "The C<guestfs_message_error> structure contains the error message as a "
4317 #: ../src/guestfs.pod:2264
4318 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4322 #: ../src/guestfs.pod:2266
4324 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4325 "The normal request message is sent (see above). However this is followed by "
4326 "a sequence of file chunks."
4330 #: ../src/guestfs.pod:2270
4333 " total length (header + arguments,\n"
4334 " but not including the length word itself,\n"
4335 " and not including the chunks)\n"
4336 " struct guestfs_message_header (encoded as XDR)\n"
4337 " struct guestfs_<foo>_args (encoded as XDR)\n"
4338 " sequence of chunks for FileIn param #0\n"
4339 " sequence of chunks for FileIn param #1 etc.\n"
4344 #: ../src/guestfs.pod:2278
4345 msgid "The \"sequence of chunks\" is:"
4349 #: ../src/guestfs.pod:2280
4352 " length of chunk (not including length word itself)\n"
4353 " struct guestfs_chunk (encoded as XDR)\n"
4354 " length of chunk\n"
4355 " struct guestfs_chunk (encoded as XDR)\n"
4357 " length of chunk\n"
4358 " struct guestfs_chunk (with data.data_len == 0)\n"
4363 #: ../src/guestfs.pod:2288
4365 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4366 "is set in the final chunk to indicate either successful completion or early "
4371 #: ../src/guestfs.pod:2292
4373 "At time of writing there are no functions that have more than one FileIn "
4374 "parameter. However this is (theoretically) supported, by sending the "
4375 "sequence of chunks for each FileIn parameter one after another (from left to "
4380 #: ../src/guestfs.pod:2297
4382 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4383 "transfer. The library does this by sending a chunk with a special flag set "
4384 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4385 "RPC, does I<not> send any reply, and goes back to reading the next request."
4389 #: ../src/guestfs.pod:2303
4391 "The daemon may also cancel. It does this by writing a special word "
4392 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4393 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4394 "cancel chunk). The special word is chosen so that even if cancellation "
4395 "happens right at the end of the transfer (after the library has finished "
4396 "writing and has started listening for the reply), the \"spurious\" cancel "
4397 "flag will not be confused with the reply message."
4401 #: ../src/guestfs.pod:2312
4403 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4404 "limit), and also files where the size is not known in advance (eg. from "
4405 "pipes or sockets). However the chunks are rather small "
4406 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4407 "to keep much in memory."
4411 #: ../src/guestfs.pod:2318
4412 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4416 #: ../src/guestfs.pod:2320
4418 "The protocol for FileOut parameters is exactly the same as for FileIn "
4419 "parameters, but with the roles of daemon and library reversed."
4423 #: ../src/guestfs.pod:2323
4426 " total length (header + ret,\n"
4427 " but not including the length word itself,\n"
4428 " and not including the chunks)\n"
4429 " struct guestfs_message_header (encoded as XDR)\n"
4430 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4431 " sequence of chunks for FileOut param #0\n"
4432 " sequence of chunks for FileOut param #1 etc.\n"
4437 #: ../src/guestfs.pod:2331
4438 msgid "INITIAL MESSAGE"
4442 #: ../src/guestfs.pod:2333
4444 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4445 "which indicates that the guest and daemon is alive. This is what "
4446 "L</guestfs_launch> waits for."
4450 #: ../src/guestfs.pod:2337
4451 msgid "PROGRESS NOTIFICATION MESSAGES"
4455 #: ../src/guestfs.pod:2339
4457 "The daemon may send progress notification messages at any time. These are "
4458 "distinguished by the normal length word being replaced by "
4459 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4463 #: ../src/guestfs.pod:2343
4465 "The library turns them into progress callbacks (see "
4466 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4471 #: ../src/guestfs.pod:2347
4473 "The daemon self-limits the frequency of progress messages it sends (see "
4474 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4479 #: ../src/guestfs.pod:2351
4480 msgid "LIBGUESTFS VERSION NUMBERS"
4484 #: ../src/guestfs.pod:2353
4486 "Since April 2010, libguestfs has started to make separate development and "
4487 "stable releases, along with corresponding branches in our git repository. "
4488 "These separate releases can be identified by version number:"
4492 #: ../src/guestfs.pod:2358
4495 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4496 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4502 " | `-------- sub-version\n"
4504 " `------ always '1' because we don't change the ABI\n"
4509 #: ../src/guestfs.pod:2369
4510 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4514 #: ../src/guestfs.pod:2371
4516 "As time passes we cherry pick fixes from the development branch and backport "
4517 "those into the stable branch, the effect being that the stable branch should "
4518 "get more stable and less buggy over time. So the stable releases are ideal "
4519 "for people who don't need new features but would just like the software to "
4524 #: ../src/guestfs.pod:2377
4525 msgid "Our criteria for backporting changes are:"
4529 #: ../src/guestfs.pod:2383
4531 "Documentation changes which don't affect any code are backported unless the "
4532 "documentation refers to a future feature which is not in stable."
4536 #: ../src/guestfs.pod:2389
4538 "Bug fixes which are not controversial, fix obvious problems, and have been "
4539 "well tested are backported."
4543 #: ../src/guestfs.pod:2394
4545 "Simple rearrangements of code which shouldn't affect how it works get "
4546 "backported. This is so that the code in the two branches doesn't get too "
4547 "far out of step, allowing us to backport future fixes more easily."
4551 #: ../src/guestfs.pod:2400
4553 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4554 "exceptional case: the new feature is required in order to implement an "
4555 "important bug fix."
4559 #: ../src/guestfs.pod:2406
4561 "A new stable branch starts when we think the new features in development are "
4562 "substantial and compelling enough over the current stable branch to warrant "
4563 "it. When that happens we create new stable and development versions 1.N.0 "
4564 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4565 "stable at this point, but by backporting fixes from development, that branch "
4566 "will stabilize over time."
4570 #: ../src/guestfs.pod:2414
4571 msgid "EXTENDING LIBGUESTFS"
4575 #: ../src/guestfs.pod:2416
4576 msgid "ADDING A NEW API ACTION"
4580 #: ../src/guestfs.pod:2418
4582 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4583 "documentation) are generated, and this makes it easy to extend the "
4588 #: ../src/guestfs.pod:2422
4589 msgid "To add a new API action there are two changes:"
4593 #: ../src/guestfs.pod:2428
4595 "You need to add a description of the call (name, parameters, return type, "
4596 "tests, documentation) to C<generator/generator_actions.ml>."
4600 #: ../src/guestfs.pod:2431
4602 "There are two sorts of API action, depending on whether the call goes "
4603 "through to the daemon in the appliance, or is serviced entirely by the "
4604 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4605 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4606 "an example of the latter, since a trace flag is maintained in the handle and "
4607 "all tracing is done on the library side."
4611 #: ../src/guestfs.pod:2439
4613 "Most new actions are of the first type, and get added to the "
4614 "C<daemon_functions> list. Each function has a unique procedure number used "
4615 "in the RPC protocol which is assigned to that action when we publish "
4616 "libguestfs and cannot be reused. Take the latest procedure number and "
4621 #: ../src/guestfs.pod:2445
4623 "For library-only actions of the second type, add to the "
4624 "C<non_daemon_functions> list. Since these functions are serviced by the "
4625 "library and do not travel over the RPC mechanism to the daemon, these "
4626 "functions do not need a procedure number, and so the procedure number is set "
4631 #: ../src/guestfs.pod:2453
4632 msgid "Implement the action (in C):"
4636 #: ../src/guestfs.pod:2455
4638 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4639 "C<daemon/> directory."
4643 #: ../src/guestfs.pod:2458
4645 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4646 "(note: double underscore) in the C<src/> directory."
4650 #: ../src/guestfs.pod:2461
4651 msgid "In either case, use another function as an example of what to do."
4655 #: ../src/guestfs.pod:2465
4656 msgid "After making these changes, use C<make> to compile."
4660 #: ../src/guestfs.pod:2467
4662 "Note that you don't need to implement the RPC, language bindings, manual "
4663 "pages or anything else. It's all automatically generated from the OCaml "
4668 #: ../src/guestfs.pod:2471
4669 msgid "ADDING TESTS FOR AN API ACTION"
4673 #: ../src/guestfs.pod:2473
4675 "You can supply zero or as many tests as you want per API call. The tests "
4676 "can either be added as part of the API description "
4677 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4678 "drop a script into C<regressions/>. Note that adding a script to "
4679 "C<regressions/> is slower, so if possible use the first method."
4683 #: ../src/guestfs.pod:2479
4685 "The following describes the test environment used when you add an API test "
4686 "in C<generator_actions.ml>."
4690 #: ../src/guestfs.pod:2482
4691 msgid "The test environment has 4 block devices:"
4695 #: ../src/guestfs.pod:2486
4696 msgid "C</dev/sda> 500MB"
4700 #: ../src/guestfs.pod:2488
4701 msgid "General block device for testing."
4705 #: ../src/guestfs.pod:2490
4706 msgid "C</dev/sdb> 50MB"
4710 #: ../src/guestfs.pod:2492
4712 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4717 #: ../src/guestfs.pod:2495
4718 msgid "C</dev/sdc> 10MB"
4722 #: ../src/guestfs.pod:2497
4723 msgid "Used in a few tests where two block devices are needed."
4727 #: ../src/guestfs.pod:2499
4732 #: ../src/guestfs.pod:2501
4733 msgid "ISO with fixed content (see C<images/test.iso>)."
4737 #: ../src/guestfs.pod:2505
4739 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4740 "appliance and block devices are reused between tests. So don't try testing "
4741 "L</guestfs_kill_subprocess> :-x"
4745 #: ../src/guestfs.pod:2509
4747 "Each test starts with an initial scenario, selected using one of the "
4748 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4749 "initialize the disks mentioned above in a particular way as documented in "
4750 "C<generator_types.ml>. You should not assume anything about the previous "
4751 "contents of other disks that are not initialized."
4755 #: ../src/guestfs.pod:2515
4757 "You can add a prerequisite clause to any individual test. This is a "
4758 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4759 "if testing a command which might not work on all variations of libguestfs "
4760 "builds. A test that has prerequisite of C<Always> means to run "
4765 #: ../src/guestfs.pod:2521
4767 "In addition, packagers can skip individual tests by setting environment "
4768 "variables before running C<make check>."
4772 #: ../src/guestfs.pod:2524
4775 " SKIP_TEST_<CMD>_<NUM>=1\n"
4780 #: ../src/guestfs.pod:2526
4781 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4785 #: ../src/guestfs.pod:2528
4790 #: ../src/guestfs.pod:2530
4793 " SKIP_TEST_<CMD>=1\n"
4798 #: ../src/guestfs.pod:2532
4799 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4803 #: ../src/guestfs.pod:2534
4804 msgid "Packagers can run only certain tests by setting for example:"
4808 #: ../src/guestfs.pod:2536
4811 " TEST_ONLY=\"vfs_type zerofree\"\n"
4816 #: ../src/guestfs.pod:2538
4818 "See C<capitests/tests.c> for more details of how these environment variables "
4823 #: ../src/guestfs.pod:2541
4824 msgid "DEBUGGING NEW API ACTIONS"
4828 #: ../src/guestfs.pod:2543
4829 msgid "Test new actions work before submitting them."
4833 #: ../src/guestfs.pod:2545
4834 msgid "You can use guestfish to try out new commands."
4838 #: ../src/guestfs.pod:2547
4840 "Debugging the daemon is a problem because it runs inside a minimal "
4841 "environment. However you can fprintf messages in the daemon to stderr, and "
4842 "they will show up if you use C<guestfish -v>."
4846 #: ../src/guestfs.pod:2551
4847 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4851 #: ../src/guestfs.pod:2553
4853 "Our C source code generally adheres to some basic code-formatting "
4854 "conventions. The existing code base is not totally consistent on this "
4855 "front, but we do prefer that contributed code be formatted similarly. In "
4856 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4857 "indentation level, and other than that, follow the K&R style."
4861 #: ../src/guestfs.pod:2559
4863 "If you use Emacs, add the following to one of one of your start-up files "
4864 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4868 #: ../src/guestfs.pod:2562
4871 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4872 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4873 " (add-hook 'find-file-hook\n"
4874 " '(lambda () (if (and buffer-file-name\n"
4875 " (string-match \"/libguestfs\\\\>\"\n"
4876 " (buffer-file-name))\n"
4877 " (not (string-equal mode-name \"Change Log\"))\n"
4878 " (not (string-equal mode-name \"Makefile\")))\n"
4879 " (setq indent-tabs-mode nil))))\n"
4884 #: ../src/guestfs.pod:2572
4887 " ;;; When editing C sources in libguestfs, use this style.\n"
4888 " (defun libguestfs-c-mode ()\n"
4889 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4891 " (c-set-style \"K&R\")\n"
4892 " (setq c-indent-level 2)\n"
4893 " (setq c-basic-offset 2))\n"
4894 " (add-hook 'c-mode-hook\n"
4895 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4896 " (buffer-file-name))\n"
4897 " (libguestfs-c-mode))))\n"
4902 #: ../src/guestfs.pod:2584
4903 msgid "Enable warnings when compiling (and fix any problems this finds):"
4907 #: ../src/guestfs.pod:2587
4910 " ./configure --enable-gcc-warnings\n"
4915 #: ../src/guestfs.pod:2589
4916 msgid "Useful targets are:"
4920 #: ../src/guestfs.pod:2591
4923 " make syntax-check # checks the syntax of the C code\n"
4924 " make check # runs the test suite\n"
4929 #: ../src/guestfs.pod:2594
4930 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4934 #: ../src/guestfs.pod:2596
4936 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4937 "which are used to do shell quoting."
4941 #: ../src/guestfs.pod:2601
4946 #: ../src/guestfs.pod:2603
4948 "Simple shell quoted string. Any spaces or other shell characters are "
4953 #: ../src/guestfs.pod:2606
4958 #: ../src/guestfs.pod:2608
4960 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4965 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
4966 msgid "For example:"
4970 #: ../src/guestfs.pod:2615
4973 " asprintf (&cmd, \"cat %R\", path);\n"
4978 #: ../src/guestfs.pod:2617
4979 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4983 #: ../src/guestfs.pod:2619
4985 "I<Note:> Do I<not> use these when you are passing parameters to the "
4986 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4987 "because they are not passed via the shell (instead, straight to exec). You "
4988 "probably want to use the C<sysroot_path()> function however."
4992 #: ../src/guestfs.pod:2625
4993 msgid "SUBMITTING YOUR NEW API ACTIONS"
4997 #: ../src/guestfs.pod:2627
4999 "Submit patches to the mailing list: "
5000 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5001 "L<rjones@redhat.com>."
5005 #: ../src/guestfs.pod:2631
5006 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5010 #: ../src/guestfs.pod:2633
5011 msgid "We support i18n (gettext anyhow) in the library."
5015 #: ../src/guestfs.pod:2635
5017 "However many messages come from the daemon, and we don't translate those at "
5018 "the moment. One reason is that the appliance generally has all locale files "
5019 "removed from it, because they take up a lot of space. So we'd have to readd "
5020 "some of those, as well as copying our PO files into the appliance."
5024 #: ../src/guestfs.pod:2641
5026 "Debugging messages are never translated, since they are intended for the "
5031 #: ../src/guestfs.pod:2644
5032 msgid "SOURCE CODE SUBDIRECTORIES"
5036 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3920
5037 msgid "C<appliance>"
5041 #: ../src/guestfs.pod:2650
5042 msgid "The libguestfs appliance, build scripts and so on."
5046 #: ../src/guestfs.pod:2652
5047 msgid "C<capitests>"
5051 #: ../src/guestfs.pod:2654
5052 msgid "Automated tests of the C API."
5056 #: ../src/guestfs.pod:2656
5061 #: ../src/guestfs.pod:2658
5063 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5068 #: ../src/guestfs.pod:2661
5073 #: ../src/guestfs.pod:2663
5074 msgid "Outside contributions, experimental parts."
5078 #: ../src/guestfs.pod:2665
5083 #: ../src/guestfs.pod:2667
5085 "The daemon that runs inside the libguestfs appliance and carries out "
5090 #: ../src/guestfs.pod:2670
5095 #: ../src/guestfs.pod:2672
5096 msgid "L<virt-df(1)> command and documentation."
5100 #: ../src/guestfs.pod:2674
5105 #: ../src/guestfs.pod:2676
5106 msgid "L<virt-edit(1)> command and documentation."
5110 #: ../src/guestfs.pod:2678
5115 #: ../src/guestfs.pod:2680
5116 msgid "C API example code."
5120 #: ../src/guestfs.pod:2682
5125 #: ../src/guestfs.pod:2684
5127 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5128 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5129 "L<virt-tar-out(1)>."
5133 #: ../src/guestfs.pod:2688
5138 #: ../src/guestfs.pod:2690
5139 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5143 #: ../src/guestfs.pod:2692
5144 msgid "C<generator>"
5148 #: ../src/guestfs.pod:2694
5150 "The crucially important generator, used to automatically generate large "
5151 "amounts of boilerplate C code for things like RPC and bindings."
5155 #: ../src/guestfs.pod:2697
5160 #: ../src/guestfs.pod:2699
5161 msgid "Files used by the test suite."
5165 #: ../src/guestfs.pod:2701
5166 msgid "Some \"phony\" guest images which we test against."
5170 #: ../src/guestfs.pod:2703
5171 msgid "C<inspector>"
5175 #: ../src/guestfs.pod:2705
5176 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5180 #: ../src/guestfs.pod:2707
5185 #: ../src/guestfs.pod:2709
5186 msgid "Logo used on the website. The fish is called Arthur by the way."
5190 #: ../src/guestfs.pod:2711
5195 #: ../src/guestfs.pod:2713
5196 msgid "M4 macros used by autoconf."
5200 #: ../src/guestfs.pod:2715
5205 #: ../src/guestfs.pod:2717
5206 msgid "Translations of simple gettext strings."
5210 #: ../src/guestfs.pod:2719
5215 #: ../src/guestfs.pod:2721
5217 "The build infrastructure and PO files for translations of manpages and POD "
5218 "files. Eventually this will be combined with the C<po> directory, but that "
5219 "is rather complicated."
5223 #: ../src/guestfs.pod:2725
5224 msgid "C<regressions>"
5228 #: ../src/guestfs.pod:2727
5229 msgid "Regression tests."
5233 #: ../src/guestfs.pod:2729
5238 #: ../src/guestfs.pod:2731
5239 msgid "L<virt-rescue(1)> command and documentation."
5243 #: ../src/guestfs.pod:2733
5248 #: ../src/guestfs.pod:2735
5249 msgid "Source code to the C library."
5253 #: ../src/guestfs.pod:2737
5258 #: ../src/guestfs.pod:2739
5259 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5263 #: ../src/guestfs.pod:2741
5264 msgid "C<test-tool>"
5268 #: ../src/guestfs.pod:2743
5270 "Test tool for end users to test if their qemu/kernel combination will work "
5275 #: ../src/guestfs.pod:2746
5280 #: ../src/guestfs.pod:2748
5285 #: ../src/guestfs.pod:2750
5290 #: ../src/guestfs.pod:2752
5295 #: ../src/guestfs.pod:2754
5300 #: ../src/guestfs.pod:2756
5305 #: ../src/guestfs.pod:2758
5310 #: ../src/guestfs.pod:2760
5315 #: ../src/guestfs.pod:2762
5316 msgid "Language bindings."
5320 #: ../src/guestfs.pod:2766
5325 #: ../src/guestfs.pod:2768
5326 msgid "PROTOCOL LIMITS"
5330 #: ../src/guestfs.pod:2770
5332 "Internally libguestfs uses a message-based protocol to pass API calls and "
5333 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5334 "plenty more detail about this). The maximum message size used by the "
5335 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5336 "aware of this limit. The API calls which may be affected are individually "
5337 "documented, with a link back to this section of the documentation."
5341 #: ../src/guestfs.pod:2778
5343 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5344 "a simple string. Because this string is at some point internally encoded as "
5345 "a message, the maximum size that it can return is slightly under 4 MB. If "
5346 "the requested file is larger than this then you will get an error."
5350 #: ../src/guestfs.pod:2784
5352 "In order to transfer large files into and out of the guest filesystem, you "
5353 "need to use particular calls that support this. The sections L</UPLOADING> "
5354 "and L</DOWNLOADING> document how to do this."
5358 #: ../src/guestfs.pod:2788
5360 "You might also consider mounting the disk image using our FUSE filesystem "
5361 "support (L<guestmount(1)>)."
5365 #: ../src/guestfs.pod:2791
5366 msgid "MAXIMUM NUMBER OF DISKS"
5370 #: ../src/guestfs.pod:2793
5371 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5375 #: ../src/guestfs.pod:2796
5377 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5378 "slots. However febootstrap only understands disks with names C</dev/vda> "
5379 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5384 #: ../src/guestfs.pod:2801
5386 "We are working to substantially raise this limit in future versions but it "
5387 "requires complex changes to qemu."
5391 #: ../src/guestfs.pod:2804
5393 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5394 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5395 "requires changes to qemu."
5399 #: ../src/guestfs.pod:2808
5400 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5404 #: ../src/guestfs.pod:2810
5405 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5409 #: ../src/guestfs.pod:2812
5411 "This is because it reserves 4 bits for the minor device number (thus "
5412 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5416 #: ../src/guestfs.pod:2815
5418 "If you attach a disk with more than 15 partitions, the extra partitions are "
5419 "ignored by libguestfs."
5423 #: ../src/guestfs.pod:2818
5424 msgid "MAXIMUM SIZE OF A DISK"
5428 #: ../src/guestfs.pod:2820
5429 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5433 #: ../src/guestfs.pod:2822
5435 "We have tested block devices up to 1 exabyte (2**60 or "
5436 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5441 #: ../src/guestfs.pod:2826
5443 "Although libguestfs probably does not impose any limit, the underlying host "
5444 "storage will. If you store disk images on a host ext4 filesystem, then the "
5445 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5446 "TB). If you store disk images as host logical volumes then you are limited "
5447 "by the maximum size of an LV."
5451 #: ../src/guestfs.pod:2832
5453 "For the hugest disk image files, we recommend using XFS on the host for "
5458 #: ../src/guestfs.pod:2835
5459 msgid "MAXIMUM SIZE OF A PARTITION"
5463 #: ../src/guestfs.pod:2837
5465 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5466 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5467 "address a partition located beyond 2 TB on the disk."
5471 #: ../src/guestfs.pod:2841
5473 "It is recommended that you use GPT partitions on disks which are larger than "
5474 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5475 "which are theoretically larger than the largest disk we could support."
5479 #: ../src/guestfs.pod:2846
5480 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5484 #: ../src/guestfs.pod:2848
5486 "This depends on the filesystem type. libguestfs itself does not impose any "
5487 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5488 "what these limits are."
5492 #: ../src/guestfs.pod:2852
5493 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5497 #: ../src/guestfs.pod:2854
5499 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5500 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5501 "uploads and downloads."
5505 #: ../src/guestfs.pod:2858
5506 msgid "INSPECTION LIMITS"
5510 #: ../src/guestfs.pod:2860
5512 "The inspection code has several arbitrary limits on things like the size of "
5513 "Windows Registry hive it will read, and the length of product name. These "
5514 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5515 "memory and disk space on the host, and should not be reached in practice. "
5516 "See the source code for more information."
5520 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1017 ../test-tool/libguestfs-test-tool.pod:82
5521 msgid "ENVIRONMENT VARIABLES"
5525 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1043
5526 msgid "LIBGUESTFS_APPEND"
5530 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1045
5531 msgid "Pass additional options to the guest kernel."
5535 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1047
5536 msgid "LIBGUESTFS_DEBUG"
5540 #: ../src/guestfs.pod:2876
5542 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5543 "effect as calling C<guestfs_set_verbose (g, 1)>."
5547 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1052
5548 msgid "LIBGUESTFS_MEMSIZE"
5552 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1054
5553 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5557 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1057
5560 " LIBGUESTFS_MEMSIZE=700\n"
5565 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1059
5566 msgid "LIBGUESTFS_PATH"
5570 #: ../src/guestfs.pod:2888
5572 "Set the path that libguestfs uses to search for a supermin appliance. See "
5573 "the discussion of paths in section L</PATH> above."
5577 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1064
5578 msgid "LIBGUESTFS_QEMU"
5582 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1066
5584 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5585 "which was found at compile time by the configure script is used."
5589 #: ../src/guestfs.pod:2897
5590 msgid "See also L</QEMU WRAPPERS> above."
5594 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1070
5595 msgid "LIBGUESTFS_TRACE"
5599 #: ../src/guestfs.pod:2901
5601 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5602 "effect as calling C<guestfs_set_trace (g, 1)>."
5606 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1079
5611 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1081
5613 "Location of temporary directory, defaults to C</tmp> except for the cached "
5614 "supermin appliance which defaults to C</var/tmp>."
5618 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1084
5620 "If libguestfs was compiled to use the supermin appliance then the real "
5621 "appliance is cached in this directory, shared between all handles belonging "
5622 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5623 "use in case C</var/tmp> is not large enough."
5627 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1151 ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:269 ../tools/virt-win-reg.pl:743 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5632 #: ../src/guestfs.pod:2919
5634 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5635 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5636 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5637 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5638 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5639 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5640 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5641 "L<http://libguestfs.org/>."
5645 #: ../src/guestfs.pod:2946
5647 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5648 "L<lvm(8)>, L<disktype(1)>."
5652 #: ../src/guestfs.pod:2953 ../tools/virt-win-reg.pl:758 ../tools/virt-make-fs.pl:553
5657 #: ../src/guestfs.pod:2955
5658 msgid "To get a list of bugs against libguestfs use this link:"
5662 #: ../src/guestfs.pod:2957
5663 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5667 #: ../src/guestfs.pod:2959
5668 msgid "To report a new bug against libguestfs use this link:"
5672 #: ../src/guestfs.pod:2961
5673 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5677 #: ../src/guestfs.pod:2963
5678 msgid "When reporting a bug, please check:"
5682 #: ../src/guestfs.pod:2969
5683 msgid "That the bug hasn't been reported already."
5687 #: ../src/guestfs.pod:2973
5688 msgid "That you are testing a recent version."
5692 #: ../src/guestfs.pod:2977
5693 msgid "Describe the bug accurately, and give a way to reproduce it."
5697 #: ../src/guestfs.pod:2981
5699 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5704 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1174 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:280
5709 #: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1176 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:282
5710 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5714 #: ../src/guestfs.pod:2990 ../fish/guestfish.pod:1178 ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:284 ../tools/virt-win-reg.pl:773 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5719 #: ../src/guestfs.pod:2992 ../fish/guestfish.pod:1180 ../test-tool/libguestfs-test-tool.pod:99
5720 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5724 #: ../src/guestfs.pod:2995
5726 "This library is free software; you can redistribute it and/or modify it "
5727 "under the terms of the GNU Lesser General Public License as published by the "
5728 "Free Software Foundation; either version 2 of the License, or (at your "
5729 "option) any later version."
5733 #: ../src/guestfs.pod:3000
5735 "This library is distributed in the hope that it will be useful, but WITHOUT "
5736 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5737 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5742 #: ../src/guestfs.pod:3005
5744 "You should have received a copy of the GNU Lesser General Public License "
5745 "along with this library; if not, write to the Free Software Foundation, "
5746 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5750 #: ../src/guestfs-actions.pod:1
5751 msgid "guestfs_add_cdrom"
5755 #: ../src/guestfs-actions.pod:3
5759 " guestfs_add_cdrom (guestfs_h *g,\n"
5760 " const char *filename);\n"
5765 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5766 msgid "This function adds a virtual CD-ROM disk image to the guest."
5770 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5771 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5775 #: ../src/guestfs-actions.pod:17
5777 "This call checks for the existence of C<filename>. This stops you from "
5778 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5779 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5784 #: ../src/guestfs-actions.pod:24
5786 "If you just want to add an ISO file (often you use this as an efficient way "
5787 "to transfer large files into the guest), then you should probably use "
5788 "C<guestfs_add_drive_ro> instead."
5792 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307 ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547 ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821 ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104 ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175 ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276 ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343 ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483 ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1723 ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:2272 ../src/guestfs-actions.pod:2416 ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2512 ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3505 ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3674 ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:3701 ../src/guestfs-actions.pod:3716 ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:3861 ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3907 ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4024 ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4076 ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4104 ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4214 ../src/guestfs-actions.pod:4234 ../src/guestfs-actions.pod:4247 ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:4316 ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4378 ../src/guestfs-actions.pod:4395 ../src/guestfs-actions.pod:4410 ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4561 ../src/guestfs-actions.pod:4592 ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4659 ../src/guestfs-actions.pod:4672 ../src/guestfs-actions.pod:4687 ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:4759 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4810 ../src/guestfs-actions.pod:4859 ../src/guestfs-actions.pod:4896 ../src/guestfs-actions.pod:4910 ../src/guestfs-actions.pod:4938 ../src/guestfs-actions.pod:4955 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5186 ../src/guestfs-actions.pod:5204 ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5319 ../src/guestfs-actions.pod:5332 ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5635 ../src/guestfs-actions.pod:5654 ../src/guestfs-actions.pod:5673 ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5697 ../src/guestfs-actions.pod:5711 ../src/guestfs-actions.pod:5723 ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:5812 ../src/guestfs-actions.pod:5842 ../src/guestfs-actions.pod:5858 ../src/guestfs-actions.pod:5881 ../src/guestfs-actions.pod:5899 ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5939 ../src/guestfs-actions.pod:5958 ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6003 ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6046 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6089 ../src/guestfs-actions.pod:6104 ../src/guestfs-actions.pod:6123 ../src/guestfs-actions.pod:6160 ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6345 ../src/guestfs-actions.pod:6466 ../src/guestfs-actions.pod:6478 ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6504 ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6539 ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6565 ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6672 ../src/guestfs-actions.pod:6688 ../src/guestfs-actions.pod:6705 ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6738 ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:7049 ../src/guestfs-actions.pod:7067 ../src/guestfs-actions.pod:7081 ../src/guestfs-actions.pod:7136 ../src/guestfs-actions.pod:7149 ../src/guestfs-actions.pod:7194 ../src/guestfs-actions.pod:7227 ../src/guestfs-actions.pod:7288 ../src/guestfs-actions.pod:7314 ../src/guestfs-actions.pod:7380 ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7428
5793 msgid "This function returns 0 on success or -1 on error."
5797 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
5799 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5804 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:1950 ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:6168 ../src/guestfs-actions.pod:6198 ../src/guestfs-actions.pod:6231 ../src/guestfs-actions.pod:6290 ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7322 ../src/guestfs-actions.pod:7491 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1324 ../fish/guestfish-actions.pod:1338 ../fish/guestfish-actions.pod:3013 ../fish/guestfish-actions.pod:3210 ../fish/guestfish-actions.pod:4182 ../fish/guestfish-actions.pod:4205 ../fish/guestfish-actions.pod:4227 ../fish/guestfish-actions.pod:4265 ../fish/guestfish-actions.pod:4906 ../fish/guestfish-actions.pod:5003
5806 "Deprecated functions will not be removed from the API, but the fact that "
5807 "they are deprecated indicates that there are problems with correct use of "
5812 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3487 ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:5860 ../src/guestfs-actions.pod:5977 ../src/guestfs-actions.pod:6091 ../src/guestfs-actions.pod:6582 ../src/guestfs-actions.pod:6707 ../src/guestfs-actions.pod:7236
5813 msgid "(Added in 0.3)"
5817 #: ../src/guestfs-actions.pod:41
5818 msgid "guestfs_add_domain"
5822 #: ../src/guestfs-actions.pod:43
5826 " guestfs_add_domain (guestfs_h *g,\n"
5827 " const char *dom,\n"
5833 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:4449
5835 "You may supply a list of optional arguments to this call. Use zero or more "
5836 "of the following pairs of parameters, and terminate the list with C<-1> on "
5837 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5841 #: ../src/guestfs-actions.pod:53
5844 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5845 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5846 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5847 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5848 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
5853 #: ../src/guestfs-actions.pod:59
5855 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5856 "It works by connecting to libvirt, requesting the domain and domain XML from "
5857 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5862 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
5864 "The number of disks added is returned. This operation is atomic: if an "
5865 "error is returned, then no disks are added."
5869 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
5871 "This function does some minimal checks to make sure the libvirt domain is "
5872 "not running (unless C<readonly> is true). In a future version we will try "
5873 "to acquire the libvirt lock on each disk."
5877 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
5879 "Disks must be accessible locally. This often means that adding disks from a "
5880 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5881 "unless those disks are accessible via the same device path locally too."
5885 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
5887 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5888 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5889 "default libvirt URI (or one set through an environment variable, see the "
5890 "libvirt documentation for full details)."
5894 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
5896 "The optional C<live> flag controls whether this call will try to connect to "
5897 "a running virtual machine C<guestfsd> process if it sees a suitable "
5898 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5899 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5900 "DAEMONS> for more information."
5904 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
5906 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5907 "passed instead of the domain name. The C<dom> string is treated as a UUID "
5908 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
5913 #: ../src/guestfs-actions.pod:94
5915 "The other optional parameters are passed directly through to "
5916 "C<guestfs_add_drive_opts>."
5920 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1321 ../src/guestfs-actions.pod:1680 ../src/guestfs-actions.pod:1883 ../src/guestfs-actions.pod:1992 ../src/guestfs-actions.pod:2032 ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2110 ../src/guestfs-actions.pod:2403 ../src/guestfs-actions.pod:2786 ../src/guestfs-actions.pod:2807 ../src/guestfs-actions.pod:4882 ../src/guestfs-actions.pod:5010 ../src/guestfs-actions.pod:5416 ../src/guestfs-actions.pod:5442 ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7273
5921 msgid "On error this function returns -1."
5925 #: ../src/guestfs-actions.pod:99
5926 msgid "(Added in 1.7.4)"
5930 #: ../src/guestfs-actions.pod:101
5931 msgid "guestfs_add_domain_va"
5935 #: ../src/guestfs-actions.pod:103
5939 " guestfs_add_domain_va (guestfs_h *g,\n"
5940 " const char *dom,\n"
5946 #: ../src/guestfs-actions.pod:108
5947 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5951 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:4502 ../src/guestfs-actions.pod:4514
5952 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5956 #: ../src/guestfs-actions.pod:112
5957 msgid "guestfs_add_domain_argv"
5961 #: ../src/guestfs-actions.pod:114
5965 " guestfs_add_domain_argv (guestfs_h *g,\n"
5966 " const char *dom,\n"
5967 " const struct guestfs_add_domain_argv *optargs);\n"
5972 #: ../src/guestfs-actions.pod:119
5973 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5977 #: ../src/guestfs-actions.pod:123
5978 msgid "guestfs_add_drive"
5982 #: ../src/guestfs-actions.pod:125
5986 " guestfs_add_drive (guestfs_h *g,\n"
5987 " const char *filename);\n"
5992 #: ../src/guestfs-actions.pod:129
5994 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5995 "optional parameters, so the disk is added writable, with the format being "
5996 "detected automatically."
6000 #: ../src/guestfs-actions.pod:133
6002 "Automatic detection of the format opens you up to a potential security hole "
6003 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6004 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6005 "you should think about replacing calls to this function with calls to "
6006 "C<guestfs_add_drive_opts>, and specifying the format."
6010 #: ../src/guestfs-actions.pod:144
6011 msgid "guestfs_add_drive_opts"
6015 #: ../src/guestfs-actions.pod:146
6019 " guestfs_add_drive_opts (guestfs_h *g,\n"
6020 " const char *filename,\n"
6026 #: ../src/guestfs-actions.pod:156
6029 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6030 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6031 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6036 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6038 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6039 "The first time you call this function, the disk appears as C</dev/sda>, the "
6040 "second time as C</dev/sdb>, and so on."
6044 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6046 "You don't necessarily need to be root when using libguestfs. However you "
6047 "obviously do need sufficient permissions to access the filename for whatever "
6048 "operations you want to perform (ie. read access if you just want to read the "
6049 "image or write access if you want to modify the image)."
6053 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6054 msgid "This call checks that C<filename> exists."
6058 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3024
6059 msgid "The optional arguments are:"
6063 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6068 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6070 "If true then the image is treated as read-only. Writes are still allowed, "
6071 "but they are stored in a temporary snapshot overlay which is discarded at "
6072 "the end. The disk that you add is not modified."
6076 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6081 #: ../src/guestfs-actions.pod:185
6083 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6084 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6085 "Possible formats include C<raw> and C<qcow2>."
6089 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6091 "Automatic detection of the format opens you up to a potential security hole "
6092 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6093 "RHBZ#642934. Specifying the format closes this security hole."
6097 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6102 #: ../src/guestfs-actions.pod:196
6104 "This rarely-used option lets you emulate the behaviour of the deprecated "
6105 "C<guestfs_add_drive_with_if> call (q.v.)"
6109 #: ../src/guestfs-actions.pod:203
6110 msgid "(Added in 1.5.23)"
6114 #: ../src/guestfs-actions.pod:205
6115 msgid "guestfs_add_drive_opts_va"
6119 #: ../src/guestfs-actions.pod:207
6123 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6124 " const char *filename,\n"
6130 #: ../src/guestfs-actions.pod:212
6131 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6135 #: ../src/guestfs-actions.pod:216
6136 msgid "guestfs_add_drive_opts_argv"
6140 #: ../src/guestfs-actions.pod:218
6144 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6145 " const char *filename,\n"
6146 " const struct guestfs_add_drive_opts_argv "
6152 #: ../src/guestfs-actions.pod:223
6153 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6157 #: ../src/guestfs-actions.pod:227
6158 msgid "guestfs_add_drive_ro"
6162 #: ../src/guestfs-actions.pod:229
6166 " guestfs_add_drive_ro (guestfs_h *g,\n"
6167 " const char *filename);\n"
6172 #: ../src/guestfs-actions.pod:233
6174 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6175 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6176 "disk is added read-only, with the format being detected automatically."
6180 #: ../src/guestfs-actions.pod:240
6181 msgid "(Added in 1.0.38)"
6185 #: ../src/guestfs-actions.pod:242
6186 msgid "guestfs_add_drive_ro_with_if"
6190 #: ../src/guestfs-actions.pod:244
6194 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6195 " const char *filename,\n"
6196 " const char *iface);\n"
6201 #: ../src/guestfs-actions.pod:249
6203 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6204 "QEMU interface emulation to use at run time."
6208 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2362
6209 msgid "(Added in 1.0.84)"
6213 #: ../src/guestfs-actions.pod:263
6214 msgid "guestfs_add_drive_with_if"
6218 #: ../src/guestfs-actions.pod:265
6222 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6223 " const char *filename,\n"
6224 " const char *iface);\n"
6229 #: ../src/guestfs-actions.pod:270
6231 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6232 "QEMU interface emulation to use at run time."
6236 #: ../src/guestfs-actions.pod:284
6237 msgid "guestfs_aug_clear"
6241 #: ../src/guestfs-actions.pod:286
6245 " guestfs_aug_clear (guestfs_h *g,\n"
6246 " const char *augpath);\n"
6251 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6253 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6254 "L<augtool(1)> C<clear> command."
6258 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2112
6259 msgid "(Added in 1.3.4)"
6263 #: ../src/guestfs-actions.pod:297
6264 msgid "guestfs_aug_close"
6268 #: ../src/guestfs-actions.pod:299
6272 " guestfs_aug_close (guestfs_h *g);\n"
6277 #: ../src/guestfs-actions.pod:302
6279 "Close the current Augeas handle and free up any resources used by it. After "
6280 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6281 "any other Augeas functions."
6285 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366 ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:5493
6286 msgid "(Added in 0.7)"
6290 #: ../src/guestfs-actions.pod:311
6291 msgid "guestfs_aug_defnode"
6295 #: ../src/guestfs-actions.pod:313
6298 " struct guestfs_int_bool *\n"
6299 " guestfs_aug_defnode (guestfs_h *g,\n"
6300 " const char *name,\n"
6301 " const char *expr,\n"
6302 " const char *val);\n"
6307 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6308 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6312 #: ../src/guestfs-actions.pod:322
6314 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6315 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6316 "containing that single node."
6320 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6322 "On success this returns a pair containing the number of nodes in the "
6323 "nodeset, and a boolean flag if a node was created."
6327 #: ../src/guestfs-actions.pod:330
6329 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6330 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6334 #: ../src/guestfs-actions.pod:336
6335 msgid "guestfs_aug_defvar"
6339 #: ../src/guestfs-actions.pod:338
6343 " guestfs_aug_defvar (guestfs_h *g,\n"
6344 " const char *name,\n"
6345 " const char *expr);\n"
6350 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6352 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6353 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6357 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6359 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6360 "evaluates to something which is not a nodeset."
6364 #: ../src/guestfs-actions.pod:354
6365 msgid "guestfs_aug_get"
6369 #: ../src/guestfs-actions.pod:356
6373 " guestfs_aug_get (guestfs_h *g,\n"
6374 " const char *augpath);\n"
6379 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6381 "Look up the value associated with C<path>. If C<path> matches exactly one "
6382 "node, the C<value> is returned."
6386 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941 ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207 ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1551 ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:1910 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:2534 ../src/guestfs-actions.pod:2627 ../src/guestfs-actions.pod:2738 ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:2909 ../src/guestfs-actions.pod:2933 ../src/guestfs-actions.pod:2970 ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074 ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3996 ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4276 ../src/guestfs-actions.pod:5028 ../src/guestfs-actions.pod:5221 ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5569 ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:6251 ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6284 ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6989 ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7026 ../src/guestfs-actions.pod:7206 ../src/guestfs-actions.pod:7485
6388 "This function returns a string, or NULL on error. I<The caller must free "
6389 "the returned string after use>."
6393 #: ../src/guestfs-actions.pod:368
6394 msgid "guestfs_aug_init"
6398 #: ../src/guestfs-actions.pod:370
6402 " guestfs_aug_init (guestfs_h *g,\n"
6403 " const char *root,\n"
6409 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6411 "Create a new Augeas handle for editing configuration files. If there was "
6412 "any previous Augeas handle associated with this guestfs session, then it is "
6417 #: ../src/guestfs-actions.pod:379
6418 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6422 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6423 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6427 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6429 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6430 "logical I<or> of the following integers:"
6434 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6435 msgid "C<AUG_SAVE_BACKUP> = 1"
6439 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6440 msgid "Keep the original file with a C<.augsave> extension."
6444 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6445 msgid "C<AUG_SAVE_NEWFILE> = 2"
6449 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6451 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6452 "original. Overrides C<AUG_SAVE_BACKUP>."
6456 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6457 msgid "C<AUG_TYPE_CHECK> = 4"
6461 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6462 msgid "Typecheck lenses (can be expensive)."
6466 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6467 msgid "C<AUG_NO_STDINC> = 8"
6471 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6472 msgid "Do not use standard load path for modules."
6476 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6477 msgid "C<AUG_SAVE_NOOP> = 16"
6481 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6482 msgid "Make save a no-op, just record what would have been changed."
6486 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6487 msgid "C<AUG_NO_LOAD> = 32"
6491 #: ../src/guestfs-actions.pod:414
6492 msgid "Do not load the tree in C<guestfs_aug_init>."
6496 #: ../src/guestfs-actions.pod:418
6497 msgid "To close the handle, you can call C<guestfs_aug_close>."
6501 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6502 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6506 #: ../src/guestfs-actions.pod:426
6507 msgid "guestfs_aug_insert"
6511 #: ../src/guestfs-actions.pod:428
6515 " guestfs_aug_insert (guestfs_h *g,\n"
6516 " const char *augpath,\n"
6517 " const char *label,\n"
6523 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6525 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6526 "or after C<path> (depending on the boolean flag C<before>)."
6530 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6532 "C<path> must match exactly one existing node in the tree, and C<label> must "
6533 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6537 #: ../src/guestfs-actions.pod:446
6538 msgid "guestfs_aug_load"
6542 #: ../src/guestfs-actions.pod:448
6546 " guestfs_aug_load (guestfs_h *g);\n"
6551 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6552 msgid "Load files into the tree."
6556 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6557 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6561 #: ../src/guestfs-actions.pod:460
6562 msgid "guestfs_aug_ls"
6566 #: ../src/guestfs-actions.pod:462
6570 " guestfs_aug_ls (guestfs_h *g,\n"
6571 " const char *augpath);\n"
6576 #: ../src/guestfs-actions.pod:466
6578 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6579 "sorting the resulting nodes into alphabetical order."
6583 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485 ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516 ../src/guestfs-actions.pod:1765 ../src/guestfs-actions.pod:2207 ../src/guestfs-actions.pod:2223 ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:2309 ../src/guestfs-actions.pod:2380 ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:2696 ../src/guestfs-actions.pod:2987 ../src/guestfs-actions.pod:3276 ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3733 ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4843 ../src/guestfs-actions.pod:5363 ../src/guestfs-actions.pod:5489 ../src/guestfs-actions.pod:5603 ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6447 ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7119 ../src/guestfs-actions.pod:7166 ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7357 ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7461 ../src/guestfs-actions.pod:7507 ../src/guestfs-actions.pod:7526
6585 "This function returns a NULL-terminated array of strings (like "
6586 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6587 "strings and the array after use>."
6591 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:4029 ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4249 ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4847 ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5699 ../src/guestfs-actions.pod:5713 ../src/guestfs-actions.pod:5725 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6831 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:7083 ../src/guestfs-actions.pod:7326
6592 msgid "(Added in 0.8)"
6596 #: ../src/guestfs-actions.pod:475
6597 msgid "guestfs_aug_match"
6601 #: ../src/guestfs-actions.pod:477
6605 " guestfs_aug_match (guestfs_h *g,\n"
6606 " const char *augpath);\n"
6611 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6613 "Returns a list of paths which match the path expression C<path>. The "
6614 "returned paths are sufficiently qualified so that they match exactly one "
6615 "node in the current tree."
6619 #: ../src/guestfs-actions.pod:491
6620 msgid "guestfs_aug_mv"
6624 #: ../src/guestfs-actions.pod:493
6628 " guestfs_aug_mv (guestfs_h *g,\n"
6629 " const char *src,\n"
6630 " const char *dest);\n"
6635 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6637 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6638 "C<dest> is overwritten if it exists."
6642 #: ../src/guestfs-actions.pod:505
6643 msgid "guestfs_aug_rm"
6647 #: ../src/guestfs-actions.pod:507
6651 " guestfs_aug_rm (guestfs_h *g,\n"
6652 " const char *augpath);\n"
6657 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6658 msgid "Remove C<path> and all of its children."
6662 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
6663 msgid "On success this returns the number of entries which were removed."
6667 #: ../src/guestfs-actions.pod:519
6668 msgid "guestfs_aug_save"
6672 #: ../src/guestfs-actions.pod:521
6676 " guestfs_aug_save (guestfs_h *g);\n"
6681 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
6682 msgid "This writes all pending changes to disk."
6686 #: ../src/guestfs-actions.pod:526
6688 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6693 #: ../src/guestfs-actions.pod:533
6694 msgid "guestfs_aug_set"
6698 #: ../src/guestfs-actions.pod:535
6702 " guestfs_aug_set (guestfs_h *g,\n"
6703 " const char *augpath,\n"
6704 " const char *val);\n"
6709 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
6710 msgid "Set the value associated with C<path> to C<val>."
6714 #: ../src/guestfs-actions.pod:542
6716 "In the Augeas API, it is possible to clear a node by setting the value to "
6717 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6718 "this call. Instead you must use the C<guestfs_aug_clear> call."
6722 #: ../src/guestfs-actions.pod:551
6723 msgid "guestfs_available"
6727 #: ../src/guestfs-actions.pod:553
6731 " guestfs_available (guestfs_h *g,\n"
6732 " char *const *groups);\n"
6737 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
6739 "This command is used to check the availability of some groups of "
6740 "functionality in the appliance, which not all builds of the libguestfs "
6741 "appliance will be able to provide."
6745 #: ../src/guestfs-actions.pod:561
6747 "The libguestfs groups, and the functions that those groups correspond to, "
6748 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6749 "runtime by calling C<guestfs_available_all_groups>."
6753 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
6755 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6756 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6757 "and Augeas (configuration file editing) functions."
6761 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
6762 msgid "The command returns no error if I<all> requested groups are available."
6766 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
6768 "It fails with an error if one or more of the requested groups is unavailable "
6773 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
6775 "If an unknown group name is included in the list of groups then an error is "
6780 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
6785 #: ../src/guestfs-actions.pod:585
6786 msgid "You must call C<guestfs_launch> before calling this function."
6790 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
6792 "The reason is because we don't know what groups are supported by the "
6793 "appliance/daemon until it is running and can be queried."
6797 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
6799 "If a group of functions is available, this does not necessarily mean that "
6800 "they will work. You still have to check for errors when calling individual "
6801 "API functions even if they are available."
6805 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
6807 "It is usually the job of distro packagers to build complete functionality "
6808 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6809 "with all requirements satisfied, will support everything."
6813 #: ../src/guestfs-actions.pod:607
6815 "This call was added in version C<1.0.80>. In previous versions of "
6816 "libguestfs all you could do would be to speculatively execute a command to "
6817 "find out if the daemon implemented it. See also C<guestfs_version>."
6821 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
6822 msgid "(Added in 1.0.80)"
6826 #: ../src/guestfs-actions.pod:618
6827 msgid "guestfs_available_all_groups"
6831 #: ../src/guestfs-actions.pod:620
6835 " guestfs_available_all_groups (guestfs_h *g);\n"
6840 #: ../src/guestfs-actions.pod:623
6842 "This command returns a list of all optional groups that this daemon knows "
6843 "about. Note this returns both supported and unsupported groups. To find "
6844 "out which ones the daemon can actually support you have to call "
6845 "C<guestfs_available> on each member of the returned list."
6849 #: ../src/guestfs-actions.pod:629
6850 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6854 #: ../src/guestfs-actions.pod:635
6855 msgid "(Added in 1.3.15)"
6859 #: ../src/guestfs-actions.pod:637
6860 msgid "guestfs_base64_in"
6864 #: ../src/guestfs-actions.pod:639
6868 " guestfs_base64_in (guestfs_h *g,\n"
6869 " const char *base64file,\n"
6870 " const char *filename);\n"
6875 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
6876 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6880 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
6881 msgid "(Added in 1.3.5)"
6885 #: ../src/guestfs-actions.pod:651
6886 msgid "guestfs_base64_out"
6890 #: ../src/guestfs-actions.pod:653
6894 " guestfs_base64_out (guestfs_h *g,\n"
6895 " const char *filename,\n"
6896 " const char *base64file);\n"
6901 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
6903 "This command downloads the contents of C<filename>, writing it out to local "
6904 "file C<base64file> encoded as base64."
6908 #: ../src/guestfs-actions.pod:665
6909 msgid "guestfs_blockdev_flushbufs"
6913 #: ../src/guestfs-actions.pod:667
6917 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6918 " const char *device);\n"
6923 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
6924 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6928 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722 ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819 ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464 ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508 ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527 ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
6929 msgid "This uses the L<blockdev(8)> command."
6933 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
6934 msgid "(Added in 0.9.3)"
6938 #: ../src/guestfs-actions.pod:680
6939 msgid "guestfs_blockdev_getbsz"
6943 #: ../src/guestfs-actions.pod:682
6947 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6948 " const char *device);\n"
6953 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
6954 msgid "This returns the block size of a device."
6958 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788 ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
6960 "(Note this is different from both I<size in blocks> and I<filesystem block "
6965 #: ../src/guestfs-actions.pod:697
6966 msgid "guestfs_blockdev_getro"
6970 #: ../src/guestfs-actions.pod:699
6974 " guestfs_blockdev_getro (guestfs_h *g,\n"
6975 " const char *device);\n"
6980 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
6982 "Returns a boolean indicating if the block device is read-only (true if "
6983 "read-only, false if not)."
6987 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1920 ../src/guestfs-actions.pod:1931 ../src/guestfs-actions.pod:2003 ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2073 ../src/guestfs-actions.pod:2098 ../src/guestfs-actions.pod:2121 ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3352 ../src/guestfs-actions.pod:3367 ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3439 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:4992
6988 msgid "This function returns a C truth value on success or -1 on error."
6992 #: ../src/guestfs-actions.pod:712
6993 msgid "guestfs_blockdev_getsize64"
6997 #: ../src/guestfs-actions.pod:714
7001 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7002 " const char *device);\n"
7007 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7008 msgid "This returns the size of the device in bytes."
7012 #: ../src/guestfs-actions.pod:720
7013 msgid "See also C<guestfs_blockdev_getsz>."
7017 #: ../src/guestfs-actions.pod:728
7018 msgid "guestfs_blockdev_getss"
7022 #: ../src/guestfs-actions.pod:730
7026 " guestfs_blockdev_getss (guestfs_h *g,\n"
7027 " const char *device);\n"
7032 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7034 "This returns the size of sectors on a block device. Usually 512, but can be "
7035 "larger for modern devices."
7039 #: ../src/guestfs-actions.pod:737
7041 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7046 #: ../src/guestfs-actions.pod:746
7047 msgid "guestfs_blockdev_getsz"
7051 #: ../src/guestfs-actions.pod:748
7055 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7056 " const char *device);\n"
7061 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7063 "This returns the size of the device in units of 512-byte sectors (even if "
7064 "the sectorsize isn't 512 bytes ... weird)."
7068 #: ../src/guestfs-actions.pod:755
7070 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7071 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7075 #: ../src/guestfs-actions.pod:765
7076 msgid "guestfs_blockdev_rereadpt"
7080 #: ../src/guestfs-actions.pod:767
7084 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7085 " const char *device);\n"
7090 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7091 msgid "Reread the partition table on C<device>."
7095 #: ../src/guestfs-actions.pod:779
7096 msgid "guestfs_blockdev_setbsz"
7100 #: ../src/guestfs-actions.pod:781
7104 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7105 " const char *device,\n"
7106 " int blocksize);\n"
7111 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7112 msgid "This sets the block size of a device."
7116 #: ../src/guestfs-actions.pod:797
7117 msgid "guestfs_blockdev_setro"
7121 #: ../src/guestfs-actions.pod:799
7125 " guestfs_blockdev_setro (guestfs_h *g,\n"
7126 " const char *device);\n"
7131 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7132 msgid "Sets the block device named C<device> to read-only."
7136 #: ../src/guestfs-actions.pod:811
7137 msgid "guestfs_blockdev_setrw"
7141 #: ../src/guestfs-actions.pod:813
7145 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7146 " const char *device);\n"
7151 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7152 msgid "Sets the block device named C<device> to read-write."
7156 #: ../src/guestfs-actions.pod:825
7157 msgid "guestfs_case_sensitive_path"
7161 #: ../src/guestfs-actions.pod:827
7165 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7166 " const char *path);\n"
7171 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
7173 "This can be used to resolve case insensitive paths on a filesystem which is "
7174 "case sensitive. The use case is to resolve paths which you have read from "
7175 "Windows configuration files or the Windows Registry, to the true path."
7179 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
7181 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7182 "(and probably others), which is that although the underlying filesystem is "
7183 "case-insensitive, the driver exports the filesystem to Linux as "
7188 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
7190 "One consequence of this is that special directories such as C<c:\\windows> "
7191 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7192 "precise details of how they were created. In Windows itself this would not "
7197 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
7199 "Bug or feature? You decide: "
7200 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7204 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
7206 "This function resolves the true case of each element in the path and returns "
7207 "the case-sensitive path."
7211 #: ../src/guestfs-actions.pod:853
7213 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7214 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7215 "how the directories were originally created under Windows)."
7219 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
7220 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7224 #: ../src/guestfs-actions.pod:861
7225 msgid "See also C<guestfs_realpath>."
7229 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7011
7230 msgid "(Added in 1.0.75)"
7234 #: ../src/guestfs-actions.pod:868
7239 #: ../src/guestfs-actions.pod:870
7243 " guestfs_cat (guestfs_h *g,\n"
7244 " const char *path);\n"
7249 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3679
7250 msgid "Return the contents of the file named C<path>."
7254 #: ../src/guestfs-actions.pod:876
7256 "Note that this function cannot correctly handle binary files (specifically, "
7257 "files containing C<\\0> character which is treated as end of string). For "
7258 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7259 "functions which have a more complex interface."
7263 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063 ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:2227 ../src/guestfs-actions.pod:2246 ../src/guestfs-actions.pod:2289 ../src/guestfs-actions.pod:2313 ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5444 ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:6396 ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6597 ../src/guestfs-actions.pod:6621 ../src/guestfs-actions.pod:7290 ../src/guestfs-actions.pod:7316 ../src/guestfs-actions.pod:7342 ../src/guestfs-actions.pod:7361 ../src/guestfs-actions.pod:7446 ../src/guestfs-actions.pod:7465 ../src/guestfs-actions.pod:7511 ../src/guestfs-actions.pod:7530 ../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:1197 ../fish/guestfish-actions.pod:1498 ../fish/guestfish-actions.pod:1508 ../fish/guestfish-actions.pod:1536 ../fish/guestfish-actions.pod:1551 ../fish/guestfish-actions.pod:1561 ../fish/guestfish-actions.pod:1580 ../fish/guestfish-actions.pod:3549 ../fish/guestfish-actions.pod:3564 ../fish/guestfish-actions.pod:3640 ../fish/guestfish-actions.pod:3657 ../fish/guestfish-actions.pod:3672 ../fish/guestfish-actions.pod:4326 ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4457 ../fish/guestfish-actions.pod:4472 ../fish/guestfish-actions.pod:4882 ../fish/guestfish-actions.pod:4900 ../fish/guestfish-actions.pod:4917 ../fish/guestfish-actions.pod:4927 ../fish/guestfish-actions.pod:4975 ../fish/guestfish-actions.pod:4985 ../fish/guestfish-actions.pod:5014 ../fish/guestfish-actions.pod:5024
7265 "Because of the message protocol, there is a transfer limit of somewhere "
7266 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7270 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3570 ../src/guestfs-actions.pod:3632 ../src/guestfs-actions.pod:3649 ../src/guestfs-actions.pod:3737 ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:5367 ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:7170 ../src/guestfs-actions.pod:7184
7271 msgid "(Added in 0.4)"
7275 #: ../src/guestfs-actions.pod:889
7276 msgid "guestfs_checksum"
7280 #: ../src/guestfs-actions.pod:891
7284 " guestfs_checksum (guestfs_h *g,\n"
7285 " const char *csumtype,\n"
7286 " const char *path);\n"
7291 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
7292 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7296 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
7298 "The type of checksum to compute is given by the C<csumtype> parameter which "
7299 "must have one of the following values:"
7303 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
7308 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
7310 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7315 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
7320 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
7321 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7325 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
7330 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
7331 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7335 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
7340 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
7341 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7345 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
7350 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
7351 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7355 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
7360 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
7361 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7365 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
7370 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
7371 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7375 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
7376 msgid "The checksum is returned as a printable string."
7380 #: ../src/guestfs-actions.pod:937
7381 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7385 #: ../src/guestfs-actions.pod:939
7386 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7390 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:3309 ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3399 ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:6867
7391 msgid "(Added in 1.0.2)"
7395 #: ../src/guestfs-actions.pod:946
7396 msgid "guestfs_checksum_device"
7400 #: ../src/guestfs-actions.pod:948
7404 " guestfs_checksum_device (guestfs_h *g,\n"
7405 " const char *csumtype,\n"
7406 " const char *device);\n"
7411 #: ../src/guestfs-actions.pod:953
7413 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7414 "device named C<device>. For the types of checksums supported see the "
7415 "C<guestfs_checksum> command."
7419 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4957 ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5188 ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:6790 ../src/guestfs-actions.pod:7196
7420 msgid "(Added in 1.3.2)"
7424 #: ../src/guestfs-actions.pod:962
7425 msgid "guestfs_checksums_out"
7429 #: ../src/guestfs-actions.pod:964
7433 " guestfs_checksums_out (guestfs_h *g,\n"
7434 " const char *csumtype,\n"
7435 " const char *directory,\n"
7436 " const char *sumsfile);\n"
7441 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
7443 "This command computes the checksums of all regular files in C<directory> and "
7444 "then emits a list of those checksums to the local output file C<sumsfile>."
7448 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
7450 "This can be used for verifying the integrity of a virtual machine. However "
7451 "to be properly secure you should pay attention to the output of the checksum "
7452 "command (it uses the ones from GNU coreutils). In particular when the "
7453 "filename is not printable, coreutils uses a special backslash syntax. For "
7454 "more information, see the GNU coreutils info file."
7458 #: ../src/guestfs-actions.pod:984
7459 msgid "(Added in 1.3.7)"
7463 #: ../src/guestfs-actions.pod:986
7464 msgid "guestfs_chmod"
7468 #: ../src/guestfs-actions.pod:988
7472 " guestfs_chmod (guestfs_h *g,\n"
7474 " const char *path);\n"
7479 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
7481 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7486 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
7488 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7489 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7494 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4393 ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4609 ../src/guestfs-actions.pod:4628 ../fish/guestfish-actions.pod:681 ../fish/guestfish-actions.pod:2988 ../fish/guestfish-actions.pod:3117 ../fish/guestfish-actions.pod:3127 ../fish/guestfish-actions.pod:3137
7495 msgid "The mode actually set is affected by the umask."
7499 #: ../src/guestfs-actions.pod:1006
7500 msgid "guestfs_chown"
7504 #: ../src/guestfs-actions.pod:1008
7508 " guestfs_chown (guestfs_h *g,\n"
7511 " const char *path);\n"
7516 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
7517 msgid "Change the file owner to C<owner> and group to C<group>."
7521 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3501 ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2446
7523 "Only numeric uid and gid are supported. If you want to use names, you will "
7524 "need to locate and parse the password file yourself (Augeas support makes "
7525 "this relatively easy)."
7529 #: ../src/guestfs-actions.pod:1024
7530 msgid "guestfs_command"
7534 #: ../src/guestfs-actions.pod:1026
7538 " guestfs_command (guestfs_h *g,\n"
7539 " char *const *arguments);\n"
7544 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
7546 "This call runs a command from the guest filesystem. The filesystem must be "
7547 "mounted, and must contain a compatible operating system (ie. something "
7548 "Linux, with the same or compatible processor architecture)."
7552 #: ../src/guestfs-actions.pod:1035
7554 "The single parameter is an argv-style list of arguments. The first element "
7555 "is the name of the program to run. Subsequent elements are parameters. The "
7556 "list must be non-empty (ie. must contain a program name). Note that the "
7557 "command runs directly, and is I<not> invoked via the shell (see "
7562 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
7563 msgid "The return value is anything printed to I<stdout> by the command."
7567 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
7569 "If the command returns a non-zero exit status, then this function returns an "
7570 "error message. The error message string is the content of I<stderr> from "
7575 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
7577 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7578 "C</bin>. If you require a program from another location, you should provide "
7579 "the full path in the first parameter."
7583 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
7585 "Shared libraries and data files required by the program must be available on "
7586 "filesystems which are mounted in the correct places. It is the caller's "
7587 "responsibility to ensure all filesystems that are needed are mounted at the "
7592 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1554
7593 msgid "(Added in 0.9.1)"
7597 #: ../src/guestfs-actions.pod:1068
7598 msgid "guestfs_command_lines"
7602 #: ../src/guestfs-actions.pod:1070
7606 " guestfs_command_lines (guestfs_h *g,\n"
7607 " char *const *arguments);\n"
7612 #: ../src/guestfs-actions.pod:1074
7614 "This is the same as C<guestfs_command>, but splits the result into a list of "
7619 #: ../src/guestfs-actions.pod:1077
7620 msgid "See also: C<guestfs_sh_lines>"
7624 #: ../src/guestfs-actions.pod:1088
7625 msgid "guestfs_config"
7629 #: ../src/guestfs-actions.pod:1090
7633 " guestfs_config (guestfs_h *g,\n"
7634 " const char *qemuparam,\n"
7635 " const char *qemuvalue);\n"
7640 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
7642 "This can be used to add arbitrary qemu command line parameters of the form "
7643 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7644 "setting some parameters which would interfere with parameters that we use."
7648 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
7649 msgid "The first character of C<param> string must be a C<-> (dash)."
7653 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
7654 msgid "C<value> can be NULL."
7658 #: ../src/guestfs-actions.pod:1108
7659 msgid "guestfs_copy_size"
7663 #: ../src/guestfs-actions.pod:1110
7667 " guestfs_copy_size (guestfs_h *g,\n"
7668 " const char *src,\n"
7669 " const char *dest,\n"
7675 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
7677 "This command copies exactly C<size> bytes from one source device or file "
7678 "C<src> to another destination device or file C<dest>."
7682 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
7684 "Note this will fail if the source is too short or if the destination is not "
7689 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247 ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323 ../src/guestfs-actions.pod:1703 ../src/guestfs-actions.pod:1725 ../src/guestfs-actions.pod:3482 ../src/guestfs-actions.pod:6862 ../src/guestfs-actions.pod:6896 ../src/guestfs-actions.pod:7382 ../src/guestfs-actions.pod:7401
7691 "This long-running command can generate progress notification messages so "
7692 "that the caller can display a progress bar or indicator. To receive these "
7693 "messages, the caller must register a progress event callback. See "
7694 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7698 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4169 ../src/guestfs-actions.pod:5394 ../src/guestfs-actions.pod:7103 ../src/guestfs-actions.pod:7123 ../src/guestfs-actions.pod:7209
7699 msgid "(Added in 1.0.87)"
7703 #: ../src/guestfs-actions.pod:1131
7708 #: ../src/guestfs-actions.pod:1133
7712 " guestfs_cp (guestfs_h *g,\n"
7713 " const char *src,\n"
7714 " const char *dest);\n"
7719 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
7721 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7722 "destination filename or destination directory."
7726 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157 ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303 ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:4861 ../src/guestfs-actions.pod:5238
7727 msgid "(Added in 1.0.18)"
7731 #: ../src/guestfs-actions.pod:1145
7732 msgid "guestfs_cp_a"
7736 #: ../src/guestfs-actions.pod:1147
7740 " guestfs_cp_a (guestfs_h *g,\n"
7741 " const char *src,\n"
7742 " const char *dest);\n"
7747 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
7749 "This copies a file or directory from C<src> to C<dest> recursively using the "
7754 #: ../src/guestfs-actions.pod:1159
7759 #: ../src/guestfs-actions.pod:1161
7763 " guestfs_dd (guestfs_h *g,\n"
7764 " const char *src,\n"
7765 " const char *dest);\n"
7770 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
7772 "This command copies from one source device or file C<src> to another "
7773 "destination device or file C<dest>. Normally you would use this to copy to "
7774 "or from a device or partition, for example to duplicate a filesystem."
7778 #: ../src/guestfs-actions.pod:1171
7780 "If the destination is a device, it must be as large or larger than the "
7781 "source file or device, otherwise the copy will fail. This command cannot do "
7782 "partial copies (see C<guestfs_copy_size>)."
7786 #: ../src/guestfs-actions.pod:1179
7791 #: ../src/guestfs-actions.pod:1181
7795 " guestfs_df (guestfs_h *g);\n"
7800 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
7801 msgid "This command runs the C<df> command to report disk space used."
7805 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
7807 "This command is mostly useful for interactive sessions. It is I<not> "
7808 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7813 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210 ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2292 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2384 ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4761 ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6624 ../src/guestfs-actions.pod:7249 ../src/guestfs-actions.pod:7262 ../src/guestfs-actions.pod:7275
7814 msgid "(Added in 1.0.54)"
7818 #: ../src/guestfs-actions.pod:1195
7819 msgid "guestfs_df_h"
7823 #: ../src/guestfs-actions.pod:1197
7827 " guestfs_df_h (guestfs_h *g);\n"
7832 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
7834 "This command runs the C<df -h> command to report disk space used in "
7835 "human-readable format."
7839 #: ../src/guestfs-actions.pod:1212
7840 msgid "guestfs_dmesg"
7844 #: ../src/guestfs-actions.pod:1214
7848 " guestfs_dmesg (guestfs_h *g);\n"
7853 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
7855 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7856 "This is sometimes useful for extended debugging of problems."
7860 #: ../src/guestfs-actions.pod:1221
7862 "Another way to get the same information is to enable verbose messages with "
7863 "C<guestfs_set_verbose> or by setting the environment variable "
7864 "C<LIBGUESTFS_DEBUG=1> before running the program."
7868 #: ../src/guestfs-actions.pod:1231
7869 msgid "guestfs_download"
7873 #: ../src/guestfs-actions.pod:1233
7877 " guestfs_download (guestfs_h *g,\n"
7878 " const char *remotefilename,\n"
7879 " const char *filename);\n"
7884 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263 ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
7886 "Download file C<remotefilename> and save it as C<filename> on the local "
7891 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:6856 ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4630
7892 msgid "C<filename> can also be a named pipe."
7896 #: ../src/guestfs-actions.pod:1243
7897 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7901 #: ../src/guestfs-actions.pod:1254
7902 msgid "guestfs_download_offset"
7906 #: ../src/guestfs-actions.pod:1256
7910 " guestfs_download_offset (guestfs_h *g,\n"
7911 " const char *remotefilename,\n"
7912 " const char *filename,\n"
7913 " int64_t offset,\n"
7919 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
7921 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7922 "region must be within the file or device)."
7926 #: ../src/guestfs-actions.pod:1269
7928 "Note that there is no limit on the amount of data that can be downloaded "
7929 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7930 "full amount unless an error occurs."
7934 #: ../src/guestfs-actions.pod:1274
7935 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7939 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:6901
7940 msgid "(Added in 1.5.17)"
7944 #: ../src/guestfs-actions.pod:1285
7945 msgid "guestfs_drop_caches"
7949 #: ../src/guestfs-actions.pod:1287
7953 " guestfs_drop_caches (guestfs_h *g,\n"
7954 " int whattodrop);\n"
7959 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
7961 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7962 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7963 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7967 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
7968 msgid "Setting C<whattodrop> to 3 should drop everything."
7972 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
7974 "This automatically calls L<sync(2)> before the operation, so that the "
7975 "maximum guest memory is freed."
7979 #: ../src/guestfs-actions.pod:1305
7984 #: ../src/guestfs-actions.pod:1307
7988 " guestfs_du (guestfs_h *g,\n"
7989 " const char *path);\n"
7994 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
7996 "This command runs the C<du -s> command to estimate file space usage for "
8001 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
8003 "C<path> can be a file or a directory. If C<path> is a directory then the "
8004 "estimate includes the contents of the directory and all subdirectories "
8009 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
8010 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8014 #: ../src/guestfs-actions.pod:1330
8015 msgid "guestfs_e2fsck_f"
8019 #: ../src/guestfs-actions.pod:1332
8023 " guestfs_e2fsck_f (guestfs_h *g,\n"
8024 " const char *device);\n"
8029 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
8031 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8032 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8037 #: ../src/guestfs-actions.pod:1340
8039 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8040 "Normally you should use C<guestfs_fsck>."
8044 #: ../src/guestfs-actions.pod:1345
8045 msgid "(Added in 1.0.29)"
8049 #: ../src/guestfs-actions.pod:1347
8050 msgid "guestfs_echo_daemon"
8054 #: ../src/guestfs-actions.pod:1349
8058 " guestfs_echo_daemon (guestfs_h *g,\n"
8059 " char *const *words);\n"
8064 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
8066 "This command concatenates the list of C<words> passed with single spaces "
8067 "between them and returns the resulting string."
8071 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
8072 msgid "You can use this command to test the connection through to the daemon."
8076 #: ../src/guestfs-actions.pod:1358
8077 msgid "See also C<guestfs_ping_daemon>."
8081 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2100 ../src/guestfs-actions.pod:6072
8082 msgid "(Added in 1.0.69)"
8086 #: ../src/guestfs-actions.pod:1365
8087 msgid "guestfs_egrep"
8091 #: ../src/guestfs-actions.pod:1367
8095 " guestfs_egrep (guestfs_h *g,\n"
8096 " const char *regex,\n"
8097 " const char *path);\n"
8102 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
8103 msgid "This calls the external C<egrep> program and returns the matching lines."
8107 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401 ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2249 ../src/guestfs-actions.pod:2405 ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2433 ../src/guestfs-actions.pod:2479 ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:2514 ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3676 ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:6468 ../src/guestfs-actions.pod:6480 ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6506 ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6567 ../src/guestfs-actions.pod:7345 ../src/guestfs-actions.pod:7364 ../src/guestfs-actions.pod:7449 ../src/guestfs-actions.pod:7468 ../src/guestfs-actions.pod:7514 ../src/guestfs-actions.pod:7533
8108 msgid "(Added in 1.0.66)"
8112 #: ../src/guestfs-actions.pod:1384
8113 msgid "guestfs_egrepi"
8117 #: ../src/guestfs-actions.pod:1386
8121 " guestfs_egrepi (guestfs_h *g,\n"
8122 " const char *regex,\n"
8123 " const char *path);\n"
8128 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
8129 msgid "This calls the external C<egrep -i> program and returns the matching lines."
8133 #: ../src/guestfs-actions.pod:1403
8134 msgid "guestfs_equal"
8138 #: ../src/guestfs-actions.pod:1405
8142 " guestfs_equal (guestfs_h *g,\n"
8143 " const char *file1,\n"
8144 " const char *file2);\n"
8149 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
8151 "This compares the two files C<file1> and C<file2> and returns true if their "
8152 "content is exactly equal, or false otherwise."
8156 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
8157 msgid "The external L<cmp(1)> program is used for the comparison."
8161 #: ../src/guestfs-actions.pod:1419
8162 msgid "guestfs_exists"
8166 #: ../src/guestfs-actions.pod:1421
8170 " guestfs_exists (guestfs_h *g,\n"
8171 " const char *path);\n"
8176 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
8178 "This returns C<true> if and only if there is a file, directory (or anything) "
8179 "with the given C<path> name."
8183 #: ../src/guestfs-actions.pod:1428
8184 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8188 #: ../src/guestfs-actions.pod:1434
8189 msgid "guestfs_fallocate"
8193 #: ../src/guestfs-actions.pod:1436
8197 " guestfs_fallocate (guestfs_h *g,\n"
8198 " const char *path,\n"
8204 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467 ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8206 "This command preallocates a file (containing zero bytes) named C<path> of "
8207 "size C<len> bytes. If the file exists already, it is overwritten."
8211 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
8213 "Do not confuse this with the guestfish-specific C<alloc> command which "
8214 "allocates a file in the host and attaches it as a device."
8218 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
8220 "This function is deprecated. In new code, use the C<fallocate64> call "
8225 #: ../src/guestfs-actions.pod:1460
8226 msgid "guestfs_fallocate64"
8230 #: ../src/guestfs-actions.pod:1462
8234 " guestfs_fallocate64 (guestfs_h *g,\n"
8235 " const char *path,\n"
8241 #: ../src/guestfs-actions.pod:1471
8243 "Note that this call allocates disk blocks for the file. To create a sparse "
8244 "file use C<guestfs_truncate_size> instead."
8248 #: ../src/guestfs-actions.pod:1474
8250 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8251 "oversight it only allowed 30 bit lengths to be specified, effectively "
8252 "limiting the maximum size of files created through that call to 1GB."
8256 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
8258 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8259 "commands which create a file in the host and attach it as a device."
8263 #: ../src/guestfs-actions.pod:1485
8264 msgid "(Added in 1.3.17)"
8268 #: ../src/guestfs-actions.pod:1487
8269 msgid "guestfs_fgrep"
8273 #: ../src/guestfs-actions.pod:1489
8277 " guestfs_fgrep (guestfs_h *g,\n"
8278 " const char *pattern,\n"
8279 " const char *path);\n"
8284 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
8285 msgid "This calls the external C<fgrep> program and returns the matching lines."
8289 #: ../src/guestfs-actions.pod:1506
8290 msgid "guestfs_fgrepi"
8294 #: ../src/guestfs-actions.pod:1508
8298 " guestfs_fgrepi (guestfs_h *g,\n"
8299 " const char *pattern,\n"
8300 " const char *path);\n"
8305 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
8306 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8310 #: ../src/guestfs-actions.pod:1525
8311 msgid "guestfs_file"
8315 #: ../src/guestfs-actions.pod:1527
8319 " guestfs_file (guestfs_h *g,\n"
8320 " const char *path);\n"
8325 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
8327 "This call uses the standard L<file(1)> command to determine the type or "
8328 "contents of the file."
8332 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
8334 "This call will also transparently look inside various types of compressed "
8339 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
8341 "The exact command which runs is C<file -zb path>. Note in particular that "
8342 "the filename is not prepended to the output (the I<-b> option)."
8346 #: ../src/guestfs-actions.pod:1541
8348 "This command can also be used on C</dev/> devices (and partitions, LV "
8349 "names). You can for example use this to determine if a device contains a "
8350 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8354 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
8356 "If the C<path> does not begin with C</dev/> then this command only works for "
8357 "the content of regular files. For other file types (directory, symbolic "
8358 "link etc) it will just return the string C<directory> etc."
8362 #: ../src/guestfs-actions.pod:1556
8363 msgid "guestfs_file_architecture"
8367 #: ../src/guestfs-actions.pod:1558
8371 " guestfs_file_architecture (guestfs_h *g,\n"
8372 " const char *filename);\n"
8377 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
8379 "This detects the architecture of the binary C<filename>, and returns it if "
8384 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1036
8385 msgid "Currently defined architectures are:"
8389 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1040
8394 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
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:1574 ../fish/guestfish-actions.pod:1045
8406 #: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1047
8407 msgid "64 bit x86-64."
8411 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1049
8416 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1051
8417 msgid "32 bit SPARC."
8421 #: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:1053
8426 #: ../src/guestfs-actions.pod:1584 ../fish/guestfish-actions.pod:1055
8427 msgid "64 bit SPARC V9 and above."
8431 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1057
8436 #: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1059
8437 msgid "Intel Itanium."
8441 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1061
8446 #: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1063
8447 msgid "32 bit Power PC."
8451 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1065
8456 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1067
8457 msgid "64 bit Power PC."
8461 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1071
8462 msgid "Libguestfs may return other architecture strings in future."
8466 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1073
8467 msgid "The function works on at least the following types of files:"
8471 #: ../src/guestfs-actions.pod:1608 ../fish/guestfish-actions.pod:1079
8472 msgid "many types of Un*x and Linux binary"
8476 #: ../src/guestfs-actions.pod:1612 ../fish/guestfish-actions.pod:1083
8477 msgid "many types of Un*x and Linux shared library"
8481 #: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1087
8482 msgid "Windows Win32 and Win64 binaries"
8486 #: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1091
8487 msgid "Windows Win32 and Win64 DLLs"
8491 #: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1093
8492 msgid "Win32 binaries and DLLs return C<i386>."
8496 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1095
8497 msgid "Win64 binaries and DLLs return C<x86_64>."
8501 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1099
8502 msgid "Linux kernel modules"
8506 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1103
8507 msgid "Linux new-style initrd images"
8511 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1107
8512 msgid "some non-x86 Linux vmlinuz kernels"
8516 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1111
8517 msgid "What it can't do currently:"
8521 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1117
8522 msgid "static libraries (libfoo.a)"
8526 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1121
8527 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8531 #: ../src/guestfs-actions.pod:1654 ../fish/guestfish-actions.pod:1125
8532 msgid "x86 Linux vmlinuz kernels"
8536 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1127
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:1666 ../src/guestfs-actions.pod:1829 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:2537 ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2700 ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2809 ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:2936 ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:3280 ../src/guestfs-actions.pod:3412
8546 msgid "(Added in 1.5.3)"
8550 #: ../src/guestfs-actions.pod:1668
8551 msgid "guestfs_filesize"
8555 #: ../src/guestfs-actions.pod:1670
8559 " guestfs_filesize (guestfs_h *g,\n"
8560 " const char *file);\n"
8565 #: ../src/guestfs-actions.pod:1674 ../fish/guestfish-actions.pod:1138
8566 msgid "This command returns the size of C<file> in bytes."
8570 #: ../src/guestfs-actions.pod:1676
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:1682
8579 msgid "(Added in 1.0.82)"
8583 #: ../src/guestfs-actions.pod:1684
8584 msgid "guestfs_fill"
8588 #: ../src/guestfs-actions.pod:1686
8592 " guestfs_fill (guestfs_h *g,\n"
8595 " const char *path);\n"
8600 #: ../src/guestfs-actions.pod:1692 ../fish/guestfish-actions.pod:1148
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:1696
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:1708
8617 msgid "(Added in 1.0.79)"
8621 #: ../src/guestfs-actions.pod:1710
8622 msgid "guestfs_fill_pattern"
8626 #: ../src/guestfs-actions.pod:1712
8630 " guestfs_fill_pattern (guestfs_h *g,\n"
8631 " const char *pattern,\n"
8633 " const char *path);\n"
8638 #: ../src/guestfs-actions.pod:1718
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:1730
8648 msgid "(Added in 1.3.12)"
8652 #: ../src/guestfs-actions.pod:1732
8653 msgid "guestfs_find"
8657 #: ../src/guestfs-actions.pod:1734
8661 " guestfs_find (guestfs_h *g,\n"
8662 " const char *directory);\n"
8667 #: ../src/guestfs-actions.pod:1738 ../fish/guestfish-actions.pod:1170
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:1743 ../fish/guestfish-actions.pod:1175
8678 "This returns a list of strings I<without any prefix>. Thus if the directory "
8683 #: ../src/guestfs-actions.pod:1746 ../fish/guestfish-actions.pod:1178
8693 #: ../src/guestfs-actions.pod:1750
8694 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8698 #: ../src/guestfs-actions.pod:1753 ../fish/guestfish-actions.pod:1185
8709 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
8710 msgid "If C<directory> is not a directory, then this command returns an error."
8714 #: ../src/guestfs-actions.pod:1761 ../fish/guestfish-actions.pod:1193
8715 msgid "The returned list is sorted."
8719 #: ../src/guestfs-actions.pod:1763
8720 msgid "See also C<guestfs_find0>."
8724 #: ../src/guestfs-actions.pod:1772 ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:5656
8725 msgid "(Added in 1.0.27)"
8729 #: ../src/guestfs-actions.pod:1774
8730 msgid "guestfs_find0"
8734 #: ../src/guestfs-actions.pod:1776
8738 " guestfs_find0 (guestfs_h *g,\n"
8739 " const char *directory,\n"
8740 " const char *files);\n"
8745 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1204
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:1785
8755 "This command works the same way as C<guestfs_find> with the following "
8760 #: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1215
8761 msgid "The resulting list is written to an external file."
8765 #: ../src/guestfs-actions.pod:1796 ../fish/guestfish-actions.pod:1219
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:1801 ../fish/guestfish-actions.pod:1224
8773 msgid "This command is not limited in the number of names that it can return."
8777 #: ../src/guestfs-actions.pod:1806 ../fish/guestfish-actions.pod:1229
8778 msgid "The result list is not sorted."
8782 #: ../src/guestfs-actions.pod:1812
8783 msgid "(Added in 1.0.74)"
8787 #: ../src/guestfs-actions.pod:1814
8788 msgid "guestfs_findfs_label"
8792 #: ../src/guestfs-actions.pod:1816
8796 " guestfs_findfs_label (guestfs_h *g,\n"
8797 " const char *label);\n"
8802 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
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:1824
8810 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8814 #: ../src/guestfs-actions.pod:1831
8815 msgid "guestfs_findfs_uuid"
8819 #: ../src/guestfs-actions.pod:1833
8823 " guestfs_findfs_uuid (guestfs_h *g,\n"
8824 " const char *uuid);\n"
8829 #: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1249
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:1841
8837 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8841 #: ../src/guestfs-actions.pod:1848
8842 msgid "guestfs_fsck"
8846 #: ../src/guestfs-actions.pod:1850
8850 " guestfs_fsck (guestfs_h *g,\n"
8851 " const char *fstype,\n"
8852 " const char *device);\n"
8857 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
8859 "This runs the filesystem checker (fsck) on C<device> which should have "
8860 "filesystem type C<fstype>."
8864 #: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1262
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:1867 ../fish/guestfish-actions.pod:1271
8872 msgid "Multiple status codes can be summed together."
8876 #: ../src/guestfs-actions.pod:1871 ../fish/guestfish-actions.pod:1275
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:1876 ../fish/guestfish-actions.pod:1280
8884 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8888 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1285
8889 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8893 #: ../src/guestfs-actions.pod:1885 ../src/guestfs-actions.pod:7387
8894 msgid "(Added in 1.0.16)"
8898 #: ../src/guestfs-actions.pod:1887
8899 msgid "guestfs_get_append"
8903 #: ../src/guestfs-actions.pod:1889
8907 " guestfs_get_append (guestfs_h *g);\n"
8912 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
8914 "Return the additional kernel options which are added to the guest kernel "
8919 #: ../src/guestfs-actions.pod:1895 ../fish/guestfish-actions.pod:1294
8920 msgid "If C<NULL> then no options are added."
8924 #: ../src/guestfs-actions.pod:1897
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:1901 ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5814 ../src/guestfs-actions.pod:6235 ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6270 ../src/guestfs-actions.pod:6294 ../src/guestfs-actions.pod:7051 ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7430
8933 msgid "(Added in 1.0.26)"
8937 #: ../src/guestfs-actions.pod:1903
8938 msgid "guestfs_get_attach_method"
8942 #: ../src/guestfs-actions.pod:1905
8946 " guestfs_get_attach_method (guestfs_h *g);\n"
8951 #: ../src/guestfs-actions.pod:1908
8952 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8956 #: ../src/guestfs-actions.pod:1913
8957 msgid "guestfs_get_autosync"
8961 #: ../src/guestfs-actions.pod:1915
8965 " guestfs_get_autosync (guestfs_h *g);\n"
8970 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1306
8971 msgid "Get the autosync flag."
8975 #: ../src/guestfs-actions.pod:1924
8976 msgid "guestfs_get_direct"
8980 #: ../src/guestfs-actions.pod:1926
8984 " guestfs_get_direct (guestfs_h *g);\n"
8989 #: ../src/guestfs-actions.pod:1929 ../fish/guestfish-actions.pod:1312
8990 msgid "Return the direct appliance mode flag."
8994 #: ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:5883
8995 msgid "(Added in 1.0.72)"
8999 #: ../src/guestfs-actions.pod:1935
9000 msgid "guestfs_get_e2label"
9004 #: ../src/guestfs-actions.pod:1937
9008 " guestfs_get_e2label (guestfs_h *g,\n"
9009 " const char *device);\n"
9014 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1318
9015 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9019 #: ../src/guestfs-actions.pod:1947 ../fish/guestfish-actions.pod:1321
9021 "This function is deprecated. In new code, use the C<vfs_label> call "
9026 #: ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:1975 ../src/guestfs-actions.pod:5901 ../src/guestfs-actions.pod:5920
9027 msgid "(Added in 1.0.15)"
9031 #: ../src/guestfs-actions.pod:1956
9032 msgid "guestfs_get_e2uuid"
9036 #: ../src/guestfs-actions.pod:1958
9040 " guestfs_get_e2uuid (guestfs_h *g,\n"
9041 " const char *device);\n"
9046 #: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1332
9047 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9051 #: ../src/guestfs-actions.pod:1968 ../fish/guestfish-actions.pod:1335
9052 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9056 #: ../src/guestfs-actions.pod:1977
9057 msgid "guestfs_get_memsize"
9061 #: ../src/guestfs-actions.pod:1979
9065 " guestfs_get_memsize (guestfs_h *g);\n"
9070 #: ../src/guestfs-actions.pod:1982 ../fish/guestfish-actions.pod:1346
9071 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
9075 #: ../src/guestfs-actions.pod:1985
9077 "If C<guestfs_set_memsize> was not called on this handle, and if "
9078 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9079 "value for memsize."
9083 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2070 ../src/guestfs-actions.pod:5936 ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:1353 ../fish/guestfish-actions.pod:1404 ../fish/guestfish-actions.pod:4005 ../fish/guestfish-actions.pod:4092
9084 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9088 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:4397 ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4613 ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4644 ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4674 ../src/guestfs-actions.pod:5559 ../src/guestfs-actions.pod:5941 ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6817
9089 msgid "(Added in 1.0.55)"
9093 #: ../src/guestfs-actions.pod:1996
9094 msgid "guestfs_get_network"
9098 #: ../src/guestfs-actions.pod:1998
9102 " guestfs_get_network (guestfs_h *g);\n"
9107 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1360
9108 msgid "This returns the enable network flag."
9112 #: ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:5960
9113 msgid "(Added in 1.5.4)"
9117 #: ../src/guestfs-actions.pod:2007
9118 msgid "guestfs_get_path"
9122 #: ../src/guestfs-actions.pod:2009
9126 " guestfs_get_path (guestfs_h *g);\n"
9131 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1366
9132 msgid "Return the current search path."
9136 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1368
9138 "This is always non-NULL. If it wasn't set already, then this will return "
9143 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2046
9145 "This function returns a string, or NULL on error. The string is owned by "
9146 "the guest handle and must I<not> be freed."
9150 #: ../src/guestfs-actions.pod:2022
9151 msgid "guestfs_get_pid"
9155 #: ../src/guestfs-actions.pod:2024
9159 " guestfs_get_pid (guestfs_h *g);\n"
9164 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
9166 "Return the process ID of the qemu subprocess. If there is no qemu "
9167 "subprocess, then this will return an error."
9171 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1380
9172 msgid "This is an internal call used for debugging and testing."
9176 #: ../src/guestfs-actions.pod:2034
9177 msgid "(Added in 1.0.56)"
9181 #: ../src/guestfs-actions.pod:2036
9182 msgid "guestfs_get_qemu"
9186 #: ../src/guestfs-actions.pod:2038
9190 " guestfs_get_qemu (guestfs_h *g);\n"
9195 #: ../src/guestfs-actions.pod:2041 ../fish/guestfish-actions.pod:1386
9196 msgid "Return the current qemu binary."
9200 #: ../src/guestfs-actions.pod:2043 ../fish/guestfish-actions.pod:1388
9202 "This is always non-NULL. If it wasn't set already, then this will return "
9203 "the default qemu binary name."
9207 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:6005
9208 msgid "(Added in 1.0.6)"
9212 #: ../src/guestfs-actions.pod:2051
9213 msgid "guestfs_get_recovery_proc"
9217 #: ../src/guestfs-actions.pod:2053
9221 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9226 #: ../src/guestfs-actions.pod:2056 ../fish/guestfish-actions.pod:1395
9227 msgid "Return the recovery process enabled flag."
9231 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3507 ../src/guestfs-actions.pod:3804 ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:5264 ../src/guestfs-actions.pod:5607 ../src/guestfs-actions.pod:6029 ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6740 ../src/guestfs-actions.pod:6932
9232 msgid "(Added in 1.0.77)"
9236 #: ../src/guestfs-actions.pod:2062
9237 msgid "guestfs_get_selinux"
9241 #: ../src/guestfs-actions.pod:2064
9245 " guestfs_get_selinux (guestfs_h *g);\n"
9250 #: ../src/guestfs-actions.pod:2067
9252 "This returns the current setting of the selinux flag which is passed to the "
9253 "appliance at boot time. See C<guestfs_set_selinux>."
9257 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2138 ../src/guestfs-actions.pod:6048 ../src/guestfs-actions.pod:6106
9258 msgid "(Added in 1.0.67)"
9262 #: ../src/guestfs-actions.pod:2077
9263 msgid "guestfs_get_state"
9267 #: ../src/guestfs-actions.pod:2079
9271 " guestfs_get_state (guestfs_h *g);\n"
9276 #: ../src/guestfs-actions.pod:2082 ../fish/guestfish-actions.pod:1411
9278 "This returns the current state as an opaque integer. This is only useful "
9279 "for printing debug and internal error messages."
9283 #: ../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 ../fish/guestfish-actions.pod:1414 ../fish/guestfish-actions.pod:2328 ../fish/guestfish-actions.pod:2346 ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2400
9284 msgid "For more information on states, see L<guestfs(3)>."
9288 #: ../src/guestfs-actions.pod:2091
9289 msgid "guestfs_get_trace"
9293 #: ../src/guestfs-actions.pod:2093
9297 " guestfs_get_trace (guestfs_h *g);\n"
9302 #: ../src/guestfs-actions.pod:2096 ../fish/guestfish-actions.pod:1420
9303 msgid "Return the command trace flag."
9307 #: ../src/guestfs-actions.pod:2102
9308 msgid "guestfs_get_umask"
9312 #: ../src/guestfs-actions.pod:2104
9316 " guestfs_get_umask (guestfs_h *g);\n"
9321 #: ../src/guestfs-actions.pod:2107
9323 "Return the current umask. By default the umask is C<022> unless it has been "
9324 "set by calling C<guestfs_umask>."
9328 #: ../src/guestfs-actions.pod:2114
9329 msgid "guestfs_get_verbose"
9333 #: ../src/guestfs-actions.pod:2116
9337 " guestfs_get_verbose (guestfs_h *g);\n"
9342 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1433
9343 msgid "This returns the verbose messages flag."
9347 #: ../src/guestfs-actions.pod:2125
9348 msgid "guestfs_getcon"
9352 #: ../src/guestfs-actions.pod:2127
9356 " guestfs_getcon (guestfs_h *g);\n"
9361 #: ../src/guestfs-actions.pod:2130 ../fish/guestfish-actions.pod:1439
9362 msgid "This gets the SELinux security context of the daemon."
9366 #: ../src/guestfs-actions.pod:2132
9367 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9371 #: ../src/guestfs-actions.pod:2140
9372 msgid "guestfs_getxattr"
9376 #: ../src/guestfs-actions.pod:2142
9380 " guestfs_getxattr (guestfs_h *g,\n"
9381 " const char *path,\n"
9382 " const char *name,\n"
9383 " size_t *size_r);\n"
9388 #: ../src/guestfs-actions.pod:2148
9390 "Get a single extended attribute from file C<path> named C<name>. This call "
9391 "follows symlinks. If you want to lookup an extended attribute for the "
9392 "symlink itself, use C<guestfs_lgetxattr>."
9396 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3521
9398 "Normally it is better to get all extended attributes from a file in one go "
9399 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9400 "implementations are buggy and do not provide a way to list out attributes. "
9401 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9402 "extended attributes you want in advance and call this function."
9406 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3528 ../fish/guestfish-actions.pod:1459 ../fish/guestfish-actions.pod:2465
9408 "Extended attribute values are blobs of binary data. If there is no extended "
9409 "attribute named C<name>, this returns an error."
9413 #: ../src/guestfs-actions.pod:2162
9414 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9418 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2355 ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5464
9420 "This function returns a buffer, or NULL on error. The size of the returned "
9421 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9426 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:3537
9427 msgid "(Added in 1.7.24)"
9431 #: ../src/guestfs-actions.pod:2170
9432 msgid "guestfs_getxattrs"
9436 #: ../src/guestfs-actions.pod:2172
9439 " struct guestfs_xattr_list *\n"
9440 " guestfs_getxattrs (guestfs_h *g,\n"
9441 " const char *path);\n"
9446 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1468
9447 msgid "This call lists the extended attributes of the file or directory C<path>."
9451 #: ../src/guestfs-actions.pod:2179 ../fish/guestfish-actions.pod:1471
9453 "At the system call level, this is a combination of the L<listxattr(2)> and "
9454 "L<getxattr(2)> calls."
9458 #: ../src/guestfs-actions.pod:2182
9459 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9463 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:3549 ../src/guestfs-actions.pod:4200
9465 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9466 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9470 #: ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3718 ../src/guestfs-actions.pod:3754 ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:6125 ../src/guestfs-actions.pod:7495
9471 msgid "(Added in 1.0.59)"
9475 #: ../src/guestfs-actions.pod:2190
9476 msgid "guestfs_glob_expand"
9480 #: ../src/guestfs-actions.pod:2192
9484 " guestfs_glob_expand (guestfs_h *g,\n"
9485 " const char *pattern);\n"
9490 #: ../src/guestfs-actions.pod:2196 ../fish/guestfish-actions.pod:1480
9492 "This command searches for all the pathnames matching C<pattern> according to "
9493 "the wildcard expansion rules used by the shell."
9497 #: ../src/guestfs-actions.pod:2200 ../fish/guestfish-actions.pod:1484
9498 msgid "If no paths match, then this returns an empty list (note: not an error)."
9502 #: ../src/guestfs-actions.pod:2203 ../fish/guestfish-actions.pod:1487
9504 "It is just a wrapper around the C L<glob(3)> function with flags "
9505 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9509 #: ../src/guestfs-actions.pod:2211 ../src/guestfs-actions.pod:6318 ../src/guestfs-actions.pod:6335
9510 msgid "(Added in 1.0.50)"
9514 #: ../src/guestfs-actions.pod:2213
9515 msgid "guestfs_grep"
9519 #: ../src/guestfs-actions.pod:2215
9523 " guestfs_grep (guestfs_h *g,\n"
9524 " const char *regex,\n"
9525 " const char *path);\n"
9530 #: ../src/guestfs-actions.pod:2220 ../fish/guestfish-actions.pod:1495
9531 msgid "This calls the external C<grep> program and returns the matching lines."
9535 #: ../src/guestfs-actions.pod:2232
9536 msgid "guestfs_grepi"
9540 #: ../src/guestfs-actions.pod:2234
9544 " guestfs_grepi (guestfs_h *g,\n"
9545 " const char *regex,\n"
9546 " const char *path);\n"
9551 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1505
9552 msgid "This calls the external C<grep -i> program and returns the matching lines."
9556 #: ../src/guestfs-actions.pod:2251
9557 msgid "guestfs_grub_install"
9561 #: ../src/guestfs-actions.pod:2253
9565 " guestfs_grub_install (guestfs_h *g,\n"
9566 " const char *root,\n"
9567 " const char *device);\n"
9572 #: ../src/guestfs-actions.pod:2258 ../fish/guestfish-actions.pod:1515
9574 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9575 "the root directory being C<root>."
9579 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1518
9581 "Note: If grub-install reports the error \"No suitable drive was found in the "
9582 "generated device map.\" it may be that you need to create a "
9583 "C</boot/grub/device.map> file first that contains the mapping between grub "
9584 "device names and Linux device names. It is usually sufficient to create a "
9589 #: ../src/guestfs-actions.pod:2268 ../fish/guestfish-actions.pod:1525
9597 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1527
9598 msgid "replacing C</dev/vda> with the name of the installation device."
9602 #: ../src/guestfs-actions.pod:2274
9603 msgid "(Added in 1.0.17)"
9607 #: ../src/guestfs-actions.pod:2276
9608 msgid "guestfs_head"
9612 #: ../src/guestfs-actions.pod:2278
9616 " guestfs_head (guestfs_h *g,\n"
9617 " const char *path);\n"
9622 #: ../src/guestfs-actions.pod:2282 ../fish/guestfish-actions.pod:1533
9624 "This command returns up to the first 10 lines of a file as a list of "
9629 #: ../src/guestfs-actions.pod:2294
9630 msgid "guestfs_head_n"
9634 #: ../src/guestfs-actions.pod:2296
9638 " guestfs_head_n (guestfs_h *g,\n"
9640 " const char *path);\n"
9645 #: ../src/guestfs-actions.pod:2301 ../fish/guestfish-actions.pod:1543
9647 "If the parameter C<nrlines> is a positive number, this returns the first "
9648 "C<nrlines> lines of the file C<path>."
9652 #: ../src/guestfs-actions.pod:2304 ../fish/guestfish-actions.pod:1546
9654 "If the parameter C<nrlines> is a negative number, this returns lines from "
9655 "the file C<path>, excluding the last C<nrlines> lines."
9659 #: ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:6615 ../fish/guestfish-actions.pod:1549 ../fish/guestfish-actions.pod:4470
9660 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9664 #: ../src/guestfs-actions.pod:2318
9665 msgid "guestfs_hexdump"
9669 #: ../src/guestfs-actions.pod:2320
9673 " guestfs_hexdump (guestfs_h *g,\n"
9674 " const char *path);\n"
9679 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1558
9681 "This runs C<hexdump -C> on the given C<path>. The result is the "
9682 "human-readable, canonical hex dump of the file."
9686 #: ../src/guestfs-actions.pod:2333 ../src/guestfs-actions.pod:6399 ../src/guestfs-actions.pod:6454
9687 msgid "(Added in 1.0.22)"
9691 #: ../src/guestfs-actions.pod:2335
9692 msgid "guestfs_initrd_cat"
9696 #: ../src/guestfs-actions.pod:2337
9700 " guestfs_initrd_cat (guestfs_h *g,\n"
9701 " const char *initrdpath,\n"
9702 " const char *filename,\n"
9703 " size_t *size_r);\n"
9708 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1568
9710 "This command unpacks the file C<filename> from the initrd file called "
9711 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9716 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1572
9718 "For example, in guestfish you could use the following command to examine the "
9719 "boot script (usually called C</init>) contained in a Linux initrd or "
9724 #: ../src/guestfs-actions.pod:2351 ../fish/guestfish-actions.pod:1576
9727 " initrd-cat /boot/initrd-<version>.img init\n"
9732 #: ../src/guestfs-actions.pod:2353
9733 msgid "See also C<guestfs_initrd_list>."
9737 #: ../src/guestfs-actions.pod:2364
9738 msgid "guestfs_initrd_list"
9742 #: ../src/guestfs-actions.pod:2366
9746 " guestfs_initrd_list (guestfs_h *g,\n"
9747 " const char *path);\n"
9752 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1587
9753 msgid "This command lists out files contained in an initrd."
9757 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1589
9759 "The files are listed without any initial C</> character. The files are "
9760 "listed in the order they appear (not necessarily alphabetical). Directory "
9761 "names are listed as separate items."
9765 #: ../src/guestfs-actions.pod:2376 ../fish/guestfish-actions.pod:1593
9767 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9768 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9773 #: ../src/guestfs-actions.pod:2386
9774 msgid "guestfs_inotify_add_watch"
9778 #: ../src/guestfs-actions.pod:2388
9782 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9783 " const char *path,\n"
9789 #: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1601
9790 msgid "Watch C<path> for the events listed in C<mask>."
9794 #: ../src/guestfs-actions.pod:2395 ../fish/guestfish-actions.pod:1603
9796 "Note that if C<path> is a directory then events within that directory are "
9797 "watched, but this does I<not> happen recursively (in subdirectories)."
9801 #: ../src/guestfs-actions.pod:2399 ../fish/guestfish-actions.pod:1607
9803 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9804 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9808 #: ../src/guestfs-actions.pod:2407
9809 msgid "guestfs_inotify_close"
9813 #: ../src/guestfs-actions.pod:2409
9817 " guestfs_inotify_close (guestfs_h *g);\n"
9822 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1615
9824 "This closes the inotify handle which was previously opened by inotify_init. "
9825 "It removes all watches, throws away any pending events, and deallocates all "
9830 #: ../src/guestfs-actions.pod:2420
9831 msgid "guestfs_inotify_files"
9835 #: ../src/guestfs-actions.pod:2422
9839 " guestfs_inotify_files (guestfs_h *g);\n"
9844 #: ../src/guestfs-actions.pod:2425
9846 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9847 "returns a list of pathnames of objects that were touched. The returned "
9848 "pathnames are sorted and deduplicated."
9852 #: ../src/guestfs-actions.pod:2435
9853 msgid "guestfs_inotify_init"
9857 #: ../src/guestfs-actions.pod:2437
9861 " guestfs_inotify_init (guestfs_h *g,\n"
9862 " int maxevents);\n"
9867 #: ../src/guestfs-actions.pod:2441 ../fish/guestfish-actions.pod:1631
9869 "This command creates a new inotify handle. The inotify subsystem can be "
9870 "used to notify events which happen to objects in the guest filesystem."
9874 #: ../src/guestfs-actions.pod:2445
9876 "C<maxevents> is the maximum number of events which will be queued up between "
9877 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9878 "passed as C<0>, then the kernel (or previously set) default is used. For "
9879 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9880 "throws away events, but records the fact that it threw them away by setting "
9881 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9882 "C<guestfs_inotify_read>)."
9886 #: ../src/guestfs-actions.pod:2455
9888 "Before any events are generated, you have to add some watches to the "
9889 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9890 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9894 #: ../src/guestfs-actions.pod:2461
9896 "Queued up events should be read periodically by calling "
9897 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9898 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9899 "often enough then you risk the internal queue overflowing."
9903 #: ../src/guestfs-actions.pod:2468
9905 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9906 "This also removes any watches automatically."
9910 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1662
9912 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9913 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9914 "that there is one global inotify handle per libguestfs instance."
9918 #: ../src/guestfs-actions.pod:2481
9919 msgid "guestfs_inotify_read"
9923 #: ../src/guestfs-actions.pod:2483
9926 " struct guestfs_inotify_event_list *\n"
9927 " guestfs_inotify_read (guestfs_h *g);\n"
9932 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1671
9934 "Return the complete queue of events that have happened since the previous "
9939 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1674
9940 msgid "If no events have happened, this returns an empty list."
9944 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
9946 "I<Note>: In order to make sure that all events have been read, you must call "
9947 "this function repeatedly until it returns an empty list. The reason is that "
9948 "the call will read events up to the maximum appliance-to-host message size "
9949 "and leave remaining events in the queue."
9953 #: ../src/guestfs-actions.pod:2497
9955 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9956 "there was an error. I<The caller must call "
9957 "C<guestfs_free_inotify_event_list> after use>."
9961 #: ../src/guestfs-actions.pod:2503
9962 msgid "guestfs_inotify_rm_watch"
9966 #: ../src/guestfs-actions.pod:2505
9970 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9976 #: ../src/guestfs-actions.pod:2509
9978 "Remove a previously defined inotify watch. See "
9979 "C<guestfs_inotify_add_watch>."
9983 #: ../src/guestfs-actions.pod:2516
9984 msgid "guestfs_inspect_get_arch"
9988 #: ../src/guestfs-actions.pod:2518
9992 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9993 " const char *root);\n"
9998 #: ../src/guestfs-actions.pod:2522 ../src/guestfs-actions.pod:2545 ../src/guestfs-actions.pod:2638 ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2796 ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2889 ../src/guestfs-actions.pod:2920 ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2999 ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3062 ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3138
10000 "This function should only be called with a root device string as returned by "
10001 "C<guestfs_inspect_os>."
10005 #: ../src/guestfs-actions.pod:2525
10007 "This returns the architecture of the inspected operating system. The "
10008 "possible return values are listed under C<guestfs_file_architecture>."
10012 #: ../src/guestfs-actions.pod:2529 ../fish/guestfish-actions.pod:1700
10014 "If the architecture could not be determined, then the string C<unknown> is "
10019 #: ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:2736 ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:2784 ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2931 ../src/guestfs-actions.pod:2985 ../src/guestfs-actions.pod:3028 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3072 ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3231 ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:1703 ../fish/guestfish-actions.pod:1789 ../fish/guestfish-actions.pod:1877 ../fish/guestfish-actions.pod:1892 ../fish/guestfish-actions.pod:1913 ../fish/guestfish-actions.pod:1983 ../fish/guestfish-actions.pod:2007 ../fish/guestfish-actions.pod:2024 ../fish/guestfish-actions.pod:2067 ../fish/guestfish-actions.pod:2102 ../fish/guestfish-actions.pod:2118 ../fish/guestfish-actions.pod:2134 ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2175 ../fish/guestfish-actions.pod:2274 ../fish/guestfish-actions.pod:2308
10020 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10024 #: ../src/guestfs-actions.pod:2539
10025 msgid "guestfs_inspect_get_distro"
10029 #: ../src/guestfs-actions.pod:2541
10033 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10034 " const char *root);\n"
10039 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1712
10040 msgid "This returns the distro (distribution) of the inspected operating system."
10044 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1715
10045 msgid "Currently defined distros are:"
10049 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1719
10050 msgid "\"archlinux\""
10054 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1721
10055 msgid "Arch Linux."
10059 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1723
10064 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1725
10069 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1727
10074 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1729
10079 #: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1731
10084 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1733
10089 #: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1735
10094 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1737
10099 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1739
10100 msgid "\"linuxmint\""
10104 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1741
10105 msgid "Linux Mint."
10109 #: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1743
10110 msgid "\"mandriva\""
10114 #: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1745
10119 #: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1747
10124 #: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1749
10129 #: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1751
10134 #: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1753
10139 #: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1755
10140 msgid "\"redhat-based\""
10144 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1757
10145 msgid "Some Red Hat-derived distro."
10149 #: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1759
10154 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1761
10155 msgid "Red Hat Enterprise Linux."
10159 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1763
10160 msgid "\"scientificlinux\""
10164 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1765
10165 msgid "Scientific Linux."
10169 #: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1767
10170 msgid "\"slackware\""
10174 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1769
10179 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1771
10184 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1773
10189 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:1775 ../fish/guestfish-actions.pod:1868 ../fish/guestfish-actions.pod:2093
10190 msgid "\"unknown\""
10194 #: ../src/guestfs-actions.pod:2613 ../fish/guestfish-actions.pod:1777
10195 msgid "The distro could not be determined."
10199 #: ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:1779 ../fish/guestfish-actions.pod:2085
10200 msgid "\"windows\""
10204 #: ../src/guestfs-actions.pod:2617 ../fish/guestfish-actions.pod:1781
10206 "Windows does not have distributions. This string is returned if the OS type "
10211 #: ../src/guestfs-actions.pod:2622 ../src/guestfs-actions.pod:2733 ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:1786 ../fish/guestfish-actions.pod:1874 ../fish/guestfish-actions.pod:2099
10213 "Future versions of libguestfs may return other strings here. The caller "
10214 "should be prepared to handle any string."
10218 #: ../src/guestfs-actions.pod:2632
10219 msgid "guestfs_inspect_get_drive_mappings"
10223 #: ../src/guestfs-actions.pod:2634
10227 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10228 " const char *root);\n"
10233 #: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1798
10235 "This call is useful for Windows which uses a primitive system of assigning "
10236 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10237 "Windows Registry to find out how disks/partitions are mapped to drive "
10238 "letters, and returns a hash table as in the example below:"
10242 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
10245 " C => /dev/vda2\n"
10246 " E => /dev/vdb1\n"
10247 " F => /dev/vdc1\n"
10252 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1808
10254 "Note that keys are drive letters. For Windows, the key is case insensitive "
10255 "and just contains the drive letter, without the customary colon separator "
10260 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1812
10262 "In future we may support other operating systems that also used drive "
10263 "letters, but the keys for those might not be case insensitive and might be "
10264 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10269 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1817
10271 "For Windows guests, currently only hard drive mappings are returned. "
10272 "Removable disks (eg. DVD-ROMs) are ignored."
10276 #: ../src/guestfs-actions.pod:2663 ../fish/guestfish-actions.pod:1820
10278 "For guests that do not use drive mappings, or if the drive mappings could "
10279 "not be determined, this returns an empty hash table."
10283 #: ../src/guestfs-actions.pod:2666
10285 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10286 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10290 #: ../src/guestfs-actions.pod:2670 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:4823 ../src/guestfs-actions.pod:6756
10292 "This function returns a NULL-terminated array of strings, or NULL if there "
10293 "was an error. The array of strings will always have length C<2n+1>, where "
10294 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10295 "caller must free the strings and the array after use>."
10299 #: ../src/guestfs-actions.pod:2676
10300 msgid "guestfs_inspect_get_filesystems"
10304 #: ../src/guestfs-actions.pod:2678
10308 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10309 " const char *root);\n"
10314 #: ../src/guestfs-actions.pod:2685 ../fish/guestfish-actions.pod:1834
10316 "This returns a list of all the filesystems that we think are associated with "
10317 "this operating system. This includes the root filesystem, other ordinary "
10318 "filesystems, and non-mounted devices like swap partitions."
10322 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:1839
10324 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10325 "to be shared between operating systems."
10329 #: ../src/guestfs-actions.pod:2693
10331 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10332 "C<guestfs_inspect_get_mountpoints>."
10336 #: ../src/guestfs-actions.pod:2702
10337 msgid "guestfs_inspect_get_format"
10341 #: ../src/guestfs-actions.pod:2704
10345 " guestfs_inspect_get_format (guestfs_h *g,\n"
10346 " const char *root);\n"
10351 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
10353 "This returns the format of the inspected operating system. You can use it "
10354 "to detect install images, live CDs and similar."
10358 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1855
10359 msgid "Currently defined formats are:"
10363 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1859
10364 msgid "\"installed\""
10368 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1861
10369 msgid "This is an installed operating system."
10373 #: ../src/guestfs-actions.pod:2722 ../fish/guestfish-actions.pod:1863
10374 msgid "\"installer\""
10378 #: ../src/guestfs-actions.pod:2724 ../fish/guestfish-actions.pod:1865
10380 "The disk image being inspected is not an installed operating system, but a "
10381 "I<bootable> install disk, live CD, or similar."
10385 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1870
10386 msgid "The format of this disk image is not known."
10390 #: ../src/guestfs-actions.pod:2741
10391 msgid "guestfs_inspect_get_hostname"
10395 #: ../src/guestfs-actions.pod:2743
10399 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10400 " const char *root);\n"
10405 #: ../src/guestfs-actions.pod:2750 ../fish/guestfish-actions.pod:1886
10407 "This function returns the hostname of the operating system as found by "
10408 "inspection of the guest's configuration files."
10412 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1889
10414 "If the hostname could not be determined, then the string C<unknown> is "
10419 #: ../src/guestfs-actions.pod:2761
10420 msgid "(Added in 1.7.9)"
10424 #: ../src/guestfs-actions.pod:2763
10425 msgid "guestfs_inspect_get_major_version"
10429 #: ../src/guestfs-actions.pod:2765
10433 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10434 " const char *root);\n"
10439 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1901
10440 msgid "This returns the major version number of the inspected operating system."
10444 #: ../src/guestfs-actions.pod:2775 ../fish/guestfish-actions.pod:1904
10446 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10447 "popular public names used by the operating system. Notably the operating "
10448 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10449 "1). You can find out the real versions corresponding to releases of Windows "
10450 "by consulting Wikipedia or MSDN."
10454 #: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2802 ../fish/guestfish-actions.pod:1911 ../fish/guestfish-actions.pod:1925
10455 msgid "If the version could not be determined, then C<0> is returned."
10459 #: ../src/guestfs-actions.pod:2790
10460 msgid "guestfs_inspect_get_minor_version"
10464 #: ../src/guestfs-actions.pod:2792
10468 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10469 " const char *root);\n"
10474 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1922
10475 msgid "This returns the minor version number of the inspected operating system."
10479 #: ../src/guestfs-actions.pod:2804
10481 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10482 "C<guestfs_inspect_get_major_version>."
10486 #: ../src/guestfs-actions.pod:2811
10487 msgid "guestfs_inspect_get_mountpoints"
10491 #: ../src/guestfs-actions.pod:2813
10495 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10496 " const char *root);\n"
10501 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1937
10503 "This returns a hash of where we think the filesystems associated with this "
10504 "operating system should be mounted. Callers should note that this is at "
10505 "best an educated guess made by reading configuration files such as "
10506 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10507 "are non-existent or not mountable and callers should be prepared to handle "
10508 "or ignore failures if they try to mount them."
10512 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1946
10514 "Each element in the returned hashtable has a key which is the path of the "
10515 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10516 "mounted there (eg. C</dev/sda1>)."
10520 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1951
10521 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10525 #: ../src/guestfs-actions.pod:2837
10527 "For operating systems like Windows which still use drive letters, this call "
10528 "will only return an entry for the first drive \"mounted on\" C</>. For "
10529 "information about the mapping of drive letters to partitions, see "
10530 "C<guestfs_inspect_get_drive_mappings>."
10534 #: ../src/guestfs-actions.pod:2843
10536 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10537 "C<guestfs_inspect_get_filesystems>."
10541 #: ../src/guestfs-actions.pod:2854
10542 msgid "guestfs_inspect_get_package_format"
10546 #: ../src/guestfs-actions.pod:2856
10550 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10551 " const char *root);\n"
10556 #: ../src/guestfs-actions.pod:2863
10558 "This function and C<guestfs_inspect_get_package_management> return the "
10559 "package format and package management tool used by the inspected operating "
10560 "system. For example for Fedora these functions would return C<rpm> (package "
10561 "format) and C<yum> (package management)."
10565 #: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:1976
10567 "This returns the string C<unknown> if we could not determine the package "
10568 "format I<or> if the operating system does not have a real packaging system "
10573 #: ../src/guestfs-actions.pod:2873 ../fish/guestfish-actions.pod:1980
10575 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10576 "Future versions of libguestfs may return other strings."
10580 #: ../src/guestfs-actions.pod:2881 ../src/guestfs-actions.pod:2912
10581 msgid "(Added in 1.7.5)"
10585 #: ../src/guestfs-actions.pod:2883
10586 msgid "guestfs_inspect_get_package_management"
10590 #: ../src/guestfs-actions.pod:2885
10594 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10595 " const char *root);\n"
10600 #: ../src/guestfs-actions.pod:2892
10602 "C<guestfs_inspect_get_package_format> and this function return the package "
10603 "format and package management tool used by the inspected operating system. "
10604 "For example for Fedora these functions would return C<rpm> (package format) "
10605 "and C<yum> (package management)."
10609 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1998
10611 "This returns the string C<unknown> if we could not determine the package "
10612 "management tool I<or> if the operating system does not have a real packaging "
10613 "system (eg. Windows)."
10617 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2002
10619 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10620 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10621 "libguestfs may return other strings."
10625 #: ../src/guestfs-actions.pod:2914
10626 msgid "guestfs_inspect_get_product_name"
10630 #: ../src/guestfs-actions.pod:2916
10634 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10635 " const char *root);\n"
10640 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2016
10642 "This returns the product name of the inspected operating system. The "
10643 "product name is generally some freeform string which can be displayed to the "
10644 "user, but should not be parsed by programs."
10648 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2021
10650 "If the product name could not be determined, then the string C<unknown> is "
10655 #: ../src/guestfs-actions.pod:2938
10656 msgid "guestfs_inspect_get_product_variant"
10660 #: ../src/guestfs-actions.pod:2940
10664 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10665 " const char *root);\n"
10670 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2033
10671 msgid "This returns the product variant of the inspected operating system."
10675 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2036
10677 "For Windows guests, this returns the contents of the Registry key "
10678 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10679 "which is usually a string such as C<Client> or C<Server> (other values are "
10680 "possible). This can be used to distinguish consumer and enterprise versions "
10681 "of Windows that have the same version number (for example, Windows 7 and "
10682 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10683 "the latter is C<Server>)."
10687 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2045
10689 "For enterprise Linux guests, in future we intend this to return the product "
10690 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10691 "implemented at present."
10695 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2049
10697 "If the product variant could not be determined, then the string C<unknown> "
10702 #: ../src/guestfs-actions.pod:2966
10704 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10705 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10709 #: ../src/guestfs-actions.pod:2973
10710 msgid "guestfs_inspect_get_roots"
10714 #: ../src/guestfs-actions.pod:2975
10718 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10723 #: ../src/guestfs-actions.pod:2978
10725 "This function is a convenient way to get the list of root devices, as "
10726 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10727 "the whole inspection process."
10731 #: ../src/guestfs-actions.pod:2982
10733 "This returns an empty list if either no root devices were found or the "
10734 "caller has not called C<guestfs_inspect_os>."
10738 #: ../src/guestfs-actions.pod:2991
10739 msgid "(Added in 1.7.3)"
10743 #: ../src/guestfs-actions.pod:2993
10744 msgid "guestfs_inspect_get_type"
10748 #: ../src/guestfs-actions.pod:2995
10752 " guestfs_inspect_get_type (guestfs_h *g,\n"
10753 " const char *root);\n"
10758 #: ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:2076
10760 "This returns the type of the inspected operating system. Currently defined "
10765 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2081
10770 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2083
10771 msgid "Any Linux-based operating system."
10775 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2087
10776 msgid "Any Microsoft Windows operating system."
10780 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2089
10781 msgid "\"freebsd\""
10785 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2091
10790 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:2095
10791 msgid "The operating system type could not be determined."
10795 #: ../src/guestfs-actions.pod:3035
10796 msgid "guestfs_inspect_get_windows_current_control_set"
10800 #: ../src/guestfs-actions.pod:3037
10804 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
10805 " const char *root);\n"
10810 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2111
10812 "This returns the Windows CurrentControlSet of the inspected guest. The "
10813 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10817 #: ../src/guestfs-actions.pod:3047 ../fish/guestfish-actions.pod:2114
10819 "This call assumes that the guest is Windows and that the Registry could be "
10820 "examined by inspection. If this is not the case then an error is returned."
10824 #: ../src/guestfs-actions.pod:3056
10825 msgid "guestfs_inspect_get_windows_systemroot"
10829 #: ../src/guestfs-actions.pod:3058
10833 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10834 " const char *root);\n"
10839 #: ../src/guestfs-actions.pod:3065 ../fish/guestfish-actions.pod:2127
10841 "This returns the Windows systemroot of the inspected guest. The systemroot "
10842 "is a directory path such as C</WINDOWS>."
10846 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2130
10848 "This call assumes that the guest is Windows and that the systemroot could be "
10849 "determined by inspection. If this is not the case then an error is "
10854 #: ../src/guestfs-actions.pod:3077
10855 msgid "(Added in 1.5.25)"
10859 #: ../src/guestfs-actions.pod:3079
10860 msgid "guestfs_inspect_is_live"
10864 #: ../src/guestfs-actions.pod:3081
10868 " guestfs_inspect_is_live (guestfs_h *g,\n"
10869 " const char *root);\n"
10874 #: ../src/guestfs-actions.pod:3088
10876 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10877 "disk), then this returns true if a live image was detected on the disk."
10881 #: ../src/guestfs-actions.pod:3096
10882 msgid "guestfs_inspect_is_multipart"
10886 #: ../src/guestfs-actions.pod:3098
10890 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
10891 " const char *root);\n"
10896 #: ../src/guestfs-actions.pod:3105
10898 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10899 "disk), then this returns true if the disk is part of a set."
10903 #: ../src/guestfs-actions.pod:3113
10904 msgid "guestfs_inspect_is_netinst"
10908 #: ../src/guestfs-actions.pod:3115
10912 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
10913 " const char *root);\n"
10918 #: ../src/guestfs-actions.pod:3122
10920 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10921 "disk), then this returns true if the disk is a network installer, ie. not a "
10922 "self-contained install CD but one which is likely to require network access "
10923 "to complete the install."
10927 #: ../src/guestfs-actions.pod:3132
10928 msgid "guestfs_inspect_list_applications"
10932 #: ../src/guestfs-actions.pod:3134
10935 " struct guestfs_application_list *\n"
10936 " guestfs_inspect_list_applications (guestfs_h *g,\n"
10937 " const char *root);\n"
10942 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2184
10943 msgid "Return the list of applications installed in the operating system."
10947 #: ../src/guestfs-actions.pod:3143
10949 "I<Note:> This call works differently from other parts of the inspection "
10950 "API. You have to call C<guestfs_inspect_os>, then "
10951 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
10952 "this. Listing applications is a significantly more difficult operation "
10953 "which requires access to the full filesystem. Also note that unlike the "
10954 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
10955 "the libguestfs handle, this call actually reads parts of the mounted "
10956 "filesystems during the call."
10960 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2196
10962 "This returns an empty list if the inspection code was not able to determine "
10963 "the list of applications."
10967 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2199
10968 msgid "The application structure contains the following fields:"
10972 #: ../src/guestfs-actions.pod:3160 ../fish/guestfish-actions.pod:2203
10973 msgid "C<app_name>"
10977 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:2205
10979 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10980 "guests, this is the package name."
10984 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2208
10985 msgid "C<app_display_name>"
10989 #: ../src/guestfs-actions.pod:3167 ../fish/guestfish-actions.pod:2210
10991 "The display name of the application, sometimes localized to the install "
10992 "language of the guest operating system."
10996 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2213
10998 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10999 "to display something can use C<app_name> instead."
11003 #: ../src/guestfs-actions.pod:3173 ../fish/guestfish-actions.pod:2216
11004 msgid "C<app_epoch>"
11008 #: ../src/guestfs-actions.pod:3175 ../fish/guestfish-actions.pod:2218
11010 "For package managers which use epochs, this contains the epoch of the "
11011 "package (an integer). If unavailable, this is returned as C<0>."
11015 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2221
11016 msgid "C<app_version>"
11020 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2223
11022 "The version string of the application or package. If unavailable this is "
11023 "returned as an empty string C<\"\">."
11027 #: ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:2226
11028 msgid "C<app_release>"
11032 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:2228
11034 "The release string of the application or package, for package managers that "
11035 "use this. If unavailable this is returned as an empty string C<\"\">."
11039 #: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2232
11040 msgid "C<app_install_path>"
11044 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2234
11046 "The installation path of the application (on operating systems such as "
11047 "Windows which use installation paths). This path is in the format used by "
11048 "the guest operating system, it is not a libguestfs path."
11052 #: ../src/guestfs-actions.pod:3196 ../fish/guestfish-actions.pod:2239
11053 msgid "If unavailable this is returned as an empty string C<\"\">."
11057 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2241
11058 msgid "C<app_trans_path>"
11062 #: ../src/guestfs-actions.pod:3200 ../fish/guestfish-actions.pod:2243
11064 "The install path translated into a libguestfs path. If unavailable this is "
11065 "returned as an empty string C<\"\">."
11069 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2246
11070 msgid "C<app_publisher>"
11074 #: ../src/guestfs-actions.pod:3205 ../fish/guestfish-actions.pod:2248
11076 "The name of the publisher of the application, for package managers that use "
11077 "this. If unavailable this is returned as an empty string C<\"\">."
11081 #: ../src/guestfs-actions.pod:3209 ../fish/guestfish-actions.pod:2252
11086 #: ../src/guestfs-actions.pod:3211 ../fish/guestfish-actions.pod:2254
11088 "The URL (eg. upstream URL) of the application. If unavailable this is "
11089 "returned as an empty string C<\"\">."
11093 #: ../src/guestfs-actions.pod:3214 ../fish/guestfish-actions.pod:2257
11094 msgid "C<app_source_package>"
11098 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2259
11100 "For packaging systems which support this, the name of the source package. "
11101 "If unavailable this is returned as an empty string C<\"\">."
11105 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2262
11106 msgid "C<app_summary>"
11110 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2264
11112 "A short (usually one line) description of the application or package. If "
11113 "unavailable this is returned as an empty string C<\"\">."
11117 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2267
11118 msgid "C<app_description>"
11122 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2269
11124 "A longer description of the application or package. If unavailable this is "
11125 "returned as an empty string C<\"\">."
11129 #: ../src/guestfs-actions.pod:3233
11131 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11132 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11137 #: ../src/guestfs-actions.pod:3237
11138 msgid "(Added in 1.7.8)"
11142 #: ../src/guestfs-actions.pod:3239
11143 msgid "guestfs_inspect_os"
11147 #: ../src/guestfs-actions.pod:3241
11151 " guestfs_inspect_os (guestfs_h *g);\n"
11156 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2280
11158 "This function uses other libguestfs functions and certain heuristics to "
11159 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11160 "for operating systems."
11164 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2284
11165 msgid "The list returned is empty if no operating systems were found."
11169 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2286
11171 "If one operating system was found, then this returns a list with a single "
11172 "element, which is the name of the root filesystem of this operating system. "
11173 "It is also possible for this function to return a list containing more than "
11174 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11175 "element being the root filesystem of one of the operating systems."
11179 #: ../src/guestfs-actions.pod:3257
11181 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11182 "functions in order to query further information about each operating system, "
11183 "such as the name and version."
11187 #: ../src/guestfs-actions.pod:3262
11189 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11190 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11191 "the contents. This should be called with no disks currently mounted. The "
11192 "function may also use Augeas, so any existing Augeas handle will be closed."
11196 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2304
11198 "This function cannot decrypt encrypted disks. The caller must do that first "
11199 "(supplying the necessary keys) if the disk is encrypted."
11203 #: ../src/guestfs-actions.pod:3274 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3626
11204 msgid "See also C<guestfs_list_filesystems>."
11208 #: ../src/guestfs-actions.pod:3282
11209 msgid "guestfs_is_blockdev"
11213 #: ../src/guestfs-actions.pod:3284
11217 " guestfs_is_blockdev (guestfs_h *g,\n"
11218 " const char *path);\n"
11223 #: ../src/guestfs-actions.pod:3288 ../fish/guestfish-actions.pod:2316
11225 "This returns C<true> if and only if there is a block device with the given "
11230 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3437 ../src/guestfs-actions.pod:3452
11231 msgid "See also C<guestfs_stat>."
11235 #: ../src/guestfs-actions.pod:3295 ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3441 ../src/guestfs-actions.pod:3456
11236 msgid "(Added in 1.5.10)"
11240 #: ../src/guestfs-actions.pod:3297
11241 msgid "guestfs_is_busy"
11245 #: ../src/guestfs-actions.pod:3299
11249 " guestfs_is_busy (guestfs_h *g);\n"
11254 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2325
11256 "This returns true iff this handle is busy processing a command (in the "
11261 #: ../src/guestfs-actions.pod:3311
11262 msgid "guestfs_is_chardev"
11266 #: ../src/guestfs-actions.pod:3313
11270 " guestfs_is_chardev (guestfs_h *g,\n"
11271 " const char *path);\n"
11276 #: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2334
11278 "This returns C<true> if and only if there is a character device with the "
11279 "given C<path> name."
11283 #: ../src/guestfs-actions.pod:3326
11284 msgid "guestfs_is_config"
11288 #: ../src/guestfs-actions.pod:3328
11292 " guestfs_is_config (guestfs_h *g);\n"
11297 #: ../src/guestfs-actions.pod:3331 ../fish/guestfish-actions.pod:2343
11299 "This returns true iff this handle is being configured (in the C<CONFIG> "
11304 #: ../src/guestfs-actions.pod:3340
11305 msgid "guestfs_is_dir"
11309 #: ../src/guestfs-actions.pod:3342
11313 " guestfs_is_dir (guestfs_h *g,\n"
11314 " const char *path);\n"
11319 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2352
11321 "This returns C<true> if and only if there is a directory with the given "
11322 "C<path> name. Note that it returns false for other objects like files."
11326 #: ../src/guestfs-actions.pod:3356
11327 msgid "guestfs_is_fifo"
11331 #: ../src/guestfs-actions.pod:3358
11335 " guestfs_is_fifo (guestfs_h *g,\n"
11336 " const char *path);\n"
11341 #: ../src/guestfs-actions.pod:3362 ../fish/guestfish-actions.pod:2362
11343 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11344 "given C<path> name."
11348 #: ../src/guestfs-actions.pod:3371
11349 msgid "guestfs_is_file"
11353 #: ../src/guestfs-actions.pod:3373
11357 " guestfs_is_file (guestfs_h *g,\n"
11358 " const char *path);\n"
11363 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2371
11365 "This returns C<true> if and only if there is a regular file with the given "
11366 "C<path> name. Note that it returns false for other objects like "
11371 #: ../src/guestfs-actions.pod:3387
11372 msgid "guestfs_is_launching"
11376 #: ../src/guestfs-actions.pod:3389
11380 " guestfs_is_launching (guestfs_h *g);\n"
11385 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2381
11387 "This returns true iff this handle is launching the subprocess (in the "
11388 "C<LAUNCHING> state)."
11392 #: ../src/guestfs-actions.pod:3401
11393 msgid "guestfs_is_lv"
11397 #: ../src/guestfs-actions.pod:3403
11401 " guestfs_is_lv (guestfs_h *g,\n"
11402 " const char *device);\n"
11407 #: ../src/guestfs-actions.pod:3407 ../fish/guestfish-actions.pod:2390
11409 "This command tests whether C<device> is a logical volume, and returns true "
11410 "iff this is the case."
11414 #: ../src/guestfs-actions.pod:3414
11415 msgid "guestfs_is_ready"
11419 #: ../src/guestfs-actions.pod:3416
11423 " guestfs_is_ready (guestfs_h *g);\n"
11428 #: ../src/guestfs-actions.pod:3419 ../fish/guestfish-actions.pod:2397
11430 "This returns true iff this handle is ready to accept commands (in the "
11435 #: ../src/guestfs-actions.pod:3428
11436 msgid "guestfs_is_socket"
11440 #: ../src/guestfs-actions.pod:3430
11444 " guestfs_is_socket (guestfs_h *g,\n"
11445 " const char *path);\n"
11450 #: ../src/guestfs-actions.pod:3434 ../fish/guestfish-actions.pod:2406
11452 "This returns C<true> if and only if there is a Unix domain socket with the "
11453 "given C<path> name."
11457 #: ../src/guestfs-actions.pod:3443
11458 msgid "guestfs_is_symlink"
11462 #: ../src/guestfs-actions.pod:3445
11466 " guestfs_is_symlink (guestfs_h *g,\n"
11467 " const char *path);\n"
11472 #: ../src/guestfs-actions.pod:3449 ../fish/guestfish-actions.pod:2415
11474 "This returns C<true> if and only if there is a symbolic link with the given "
11479 #: ../src/guestfs-actions.pod:3458
11480 msgid "guestfs_kill_subprocess"
11484 #: ../src/guestfs-actions.pod:3460
11488 " guestfs_kill_subprocess (guestfs_h *g);\n"
11493 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2424
11494 msgid "This kills the qemu subprocess. You should never need to call this."
11498 #: ../src/guestfs-actions.pod:3469
11499 msgid "guestfs_launch"
11503 #: ../src/guestfs-actions.pod:3471
11507 " guestfs_launch (guestfs_h *g);\n"
11512 #: ../src/guestfs-actions.pod:3474 ../fish/guestfish-actions.pod:2432
11514 "Internally libguestfs is implemented by running a virtual machine using "
11519 #: ../src/guestfs-actions.pod:3477 ../fish/guestfish-actions.pod:2435
11521 "You should call this after configuring the handle (eg. adding drives) but "
11522 "before performing any actions."
11526 #: ../src/guestfs-actions.pod:3489
11527 msgid "guestfs_lchown"
11531 #: ../src/guestfs-actions.pod:3491
11535 " guestfs_lchown (guestfs_h *g,\n"
11538 " const char *path);\n"
11543 #: ../src/guestfs-actions.pod:3497
11545 "Change the file owner to C<owner> and group to C<group>. This is like "
11546 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11547 "changed, not the target."
11551 #: ../src/guestfs-actions.pod:3509
11552 msgid "guestfs_lgetxattr"
11556 #: ../src/guestfs-actions.pod:3511
11560 " guestfs_lgetxattr (guestfs_h *g,\n"
11561 " const char *path,\n"
11562 " const char *name,\n"
11563 " size_t *size_r);\n"
11568 #: ../src/guestfs-actions.pod:3517 ../fish/guestfish-actions.pod:2454
11570 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11571 "is a symlink, then this call returns an extended attribute from the symlink."
11575 #: ../src/guestfs-actions.pod:3531
11576 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11580 #: ../src/guestfs-actions.pod:3539
11581 msgid "guestfs_lgetxattrs"
11585 #: ../src/guestfs-actions.pod:3541
11588 " struct guestfs_xattr_list *\n"
11589 " guestfs_lgetxattrs (guestfs_h *g,\n"
11590 " const char *path);\n"
11595 #: ../src/guestfs-actions.pod:3545
11597 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11598 "then it returns the extended attributes of the link itself."
11602 #: ../src/guestfs-actions.pod:3555
11603 msgid "guestfs_list_devices"
11607 #: ../src/guestfs-actions.pod:3557
11611 " guestfs_list_devices (guestfs_h *g);\n"
11616 #: ../src/guestfs-actions.pod:3560 ../fish/guestfish-actions.pod:2482
11617 msgid "List all the block devices."
11621 #: ../src/guestfs-actions.pod:3562 ../fish/guestfish-actions.pod:2484
11622 msgid "The full block device names are returned, eg. C</dev/sda>."
11626 #: ../src/guestfs-actions.pod:3572
11627 msgid "guestfs_list_filesystems"
11631 #: ../src/guestfs-actions.pod:3574
11635 " guestfs_list_filesystems (guestfs_h *g);\n"
11640 #: ../src/guestfs-actions.pod:3577 ../fish/guestfish-actions.pod:2492
11642 "This inspection command looks for filesystems on partitions, block devices "
11643 "and logical volumes, returning a list of devices containing filesystems and "
11648 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2496
11650 "The return value is a hash, where the keys are the devices containing "
11651 "filesystems, and the values are the filesystem types. For example:"
11655 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2500
11658 " \"/dev/sda1\" => \"ntfs\"\n"
11659 " \"/dev/sda2\" => \"ext2\"\n"
11660 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11661 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11666 #: ../src/guestfs-actions.pod:3590 ../fish/guestfish-actions.pod:2505
11668 "The value can have the special value \"unknown\", meaning the content of the "
11669 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11673 #: ../src/guestfs-actions.pod:3594
11675 "This command runs other libguestfs commands, which might include "
11676 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11677 "soon after launch and only when nothing is mounted."
11681 #: ../src/guestfs-actions.pod:3598
11683 "Not all of the filesystems returned will be mountable. In particular, swap "
11684 "partitions are returned in the list. Also this command does not check that "
11685 "each filesystem found is valid and mountable, and some filesystems might be "
11686 "mountable but require special options. Filesystems may not all belong to a "
11687 "single logical operating system (use C<guestfs_inspect_os> to look for "
11692 #: ../src/guestfs-actions.pod:3612 ../src/guestfs-actions.pod:5224
11693 msgid "(Added in 1.5.15)"
11697 #: ../src/guestfs-actions.pod:3614
11698 msgid "guestfs_list_partitions"
11702 #: ../src/guestfs-actions.pod:3616
11706 " guestfs_list_partitions (guestfs_h *g);\n"
11711 #: ../src/guestfs-actions.pod:3619 ../fish/guestfish-actions.pod:2525
11712 msgid "List all the partitions detected on all block devices."
11716 #: ../src/guestfs-actions.pod:3621 ../fish/guestfish-actions.pod:2527
11717 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11721 #: ../src/guestfs-actions.pod:3623
11723 "This does not return logical volumes. For that you will need to call "
11728 #: ../src/guestfs-actions.pod:3634
11733 #: ../src/guestfs-actions.pod:3636
11737 " guestfs_ll (guestfs_h *g,\n"
11738 " const char *directory);\n"
11743 #: ../src/guestfs-actions.pod:3640 ../fish/guestfish-actions.pod:2538
11745 "List the files in C<directory> (relative to the root directory, there is no "
11746 "cwd) in the format of 'ls -la'."
11750 #: ../src/guestfs-actions.pod:3643 ../fish/guestfish-actions.pod:2541
11752 "This command is mostly useful for interactive sessions. It is I<not> "
11753 "intended that you try to parse the output string."
11757 #: ../src/guestfs-actions.pod:3651
11762 #: ../src/guestfs-actions.pod:3653
11766 " guestfs_ln (guestfs_h *g,\n"
11767 " const char *target,\n"
11768 " const char *linkname);\n"
11773 #: ../src/guestfs-actions.pod:3658 ../fish/guestfish-actions.pod:2548
11774 msgid "This command creates a hard link using the C<ln> command."
11778 #: ../src/guestfs-actions.pod:3664
11779 msgid "guestfs_ln_f"
11783 #: ../src/guestfs-actions.pod:3666
11787 " guestfs_ln_f (guestfs_h *g,\n"
11788 " const char *target,\n"
11789 " const char *linkname);\n"
11794 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2554
11796 "This command creates a hard link using the C<ln -f> command. The I<-f> "
11797 "option removes the link (C<linkname>) if it exists already."
11801 #: ../src/guestfs-actions.pod:3678
11802 msgid "guestfs_ln_s"
11806 #: ../src/guestfs-actions.pod:3680
11810 " guestfs_ln_s (guestfs_h *g,\n"
11811 " const char *target,\n"
11812 " const char *linkname);\n"
11817 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2561
11818 msgid "This command creates a symbolic link using the C<ln -s> command."
11822 #: ../src/guestfs-actions.pod:3691
11823 msgid "guestfs_ln_sf"
11827 #: ../src/guestfs-actions.pod:3693
11831 " guestfs_ln_sf (guestfs_h *g,\n"
11832 " const char *target,\n"
11833 " const char *linkname);\n"
11838 #: ../src/guestfs-actions.pod:3698 ../fish/guestfish-actions.pod:2567
11840 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
11841 "option removes the link (C<linkname>) if it exists already."
11845 #: ../src/guestfs-actions.pod:3705
11846 msgid "guestfs_lremovexattr"
11850 #: ../src/guestfs-actions.pod:3707
11854 " guestfs_lremovexattr (guestfs_h *g,\n"
11855 " const char *xattr,\n"
11856 " const char *path);\n"
11861 #: ../src/guestfs-actions.pod:3712
11863 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
11864 "link, then it removes an extended attribute of the link itself."
11868 #: ../src/guestfs-actions.pod:3720
11873 #: ../src/guestfs-actions.pod:3722
11877 " guestfs_ls (guestfs_h *g,\n"
11878 " const char *directory);\n"
11883 #: ../src/guestfs-actions.pod:3726 ../fish/guestfish-actions.pod:2582
11885 "List the files in C<directory> (relative to the root directory, there is no "
11886 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11891 #: ../src/guestfs-actions.pod:3730
11893 "This command is mostly useful for interactive sessions. Programs should "
11894 "probably use C<guestfs_readdir> instead."
11898 #: ../src/guestfs-actions.pod:3739
11899 msgid "guestfs_lsetxattr"
11903 #: ../src/guestfs-actions.pod:3741
11907 " guestfs_lsetxattr (guestfs_h *g,\n"
11908 " const char *xattr,\n"
11909 " const char *val,\n"
11911 " const char *path);\n"
11916 #: ../src/guestfs-actions.pod:3748
11918 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
11919 "then it sets an extended attribute of the link itself."
11923 #: ../src/guestfs-actions.pod:3756
11924 msgid "guestfs_lstat"
11928 #: ../src/guestfs-actions.pod:3758
11931 " struct guestfs_stat *\n"
11932 " guestfs_lstat (guestfs_h *g,\n"
11933 " const char *path);\n"
11938 #: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:6355 ../fish/guestfish-actions.pod:2601 ../fish/guestfish-actions.pod:4305
11939 msgid "Returns file information for the given C<path>."
11943 #: ../src/guestfs-actions.pod:3764
11945 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
11946 "link, then the link is stat-ed, not the file it refers to."
11950 #: ../src/guestfs-actions.pod:3768 ../fish/guestfish-actions.pod:2607
11951 msgid "This is the same as the C<lstat(2)> system call."
11955 #: ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:6359
11957 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
11958 "error. I<The caller must call C<guestfs_free_stat> after use>."
11962 #: ../src/guestfs-actions.pod:3774 ../src/guestfs-actions.pod:6363 ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6762
11963 msgid "(Added in 0.9.2)"
11967 #: ../src/guestfs-actions.pod:3776
11968 msgid "guestfs_lstatlist"
11972 #: ../src/guestfs-actions.pod:3778
11975 " struct guestfs_stat_list *\n"
11976 " guestfs_lstatlist (guestfs_h *g,\n"
11977 " const char *path,\n"
11978 " char *const *names);\n"
11983 #: ../src/guestfs-actions.pod:3783
11985 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
11986 "files, where all files are in the directory C<path>. C<names> is the list "
11987 "of files from this directory."
11991 #: ../src/guestfs-actions.pod:3787 ../fish/guestfish-actions.pod:2617
11993 "On return you get a list of stat structs, with a one-to-one correspondence "
11994 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11995 "then the C<ino> field of that structure is set to C<-1>."
11999 #: ../src/guestfs-actions.pod:3792
12001 "This call is intended for programs that want to efficiently list a directory "
12002 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12003 "for a similarly efficient call for getting extended attributes. Very long "
12004 "directory listings might cause the protocol message size to be exceeded, "
12005 "causing this call to fail. The caller must split up such requests into "
12006 "smaller groups of names."
12010 #: ../src/guestfs-actions.pod:3800
12012 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12013 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12017 #: ../src/guestfs-actions.pod:3806
12018 msgid "guestfs_luks_add_key"
12022 #: ../src/guestfs-actions.pod:3808
12026 " guestfs_luks_add_key (guestfs_h *g,\n"
12027 " const char *device,\n"
12028 " const char *key,\n"
12029 " const char *newkey,\n"
12035 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2634
12037 "This command adds a new key on LUKS device C<device>. C<key> is any "
12038 "existing key, and is used to access the device. C<newkey> is the new key to "
12039 "add. C<keyslot> is the key slot that will be replaced."
12043 #: ../src/guestfs-actions.pod:3820
12045 "Note that if C<keyslot> already contains a key, then this command will "
12046 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12050 #: ../src/guestfs-actions.pod:3826 ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3909 ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:3960
12052 "This function takes a key or passphrase parameter which could contain "
12053 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12058 #: ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3913
12059 msgid "(Added in 1.5.2)"
12063 #: ../src/guestfs-actions.pod:3832
12064 msgid "guestfs_luks_close"
12068 #: ../src/guestfs-actions.pod:3834
12072 " guestfs_luks_close (guestfs_h *g,\n"
12073 " const char *device);\n"
12078 #: ../src/guestfs-actions.pod:3838
12080 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12081 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12082 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12083 "underlying block device."
12087 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:3945 ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:4062
12088 msgid "(Added in 1.5.1)"
12092 #: ../src/guestfs-actions.pod:3848
12093 msgid "guestfs_luks_format"
12097 #: ../src/guestfs-actions.pod:3850
12101 " guestfs_luks_format (guestfs_h *g,\n"
12102 " const char *device,\n"
12103 " const char *key,\n"
12109 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2660
12111 "This command erases existing data on C<device> and formats the device as a "
12112 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12113 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12117 #: ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:3886 ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4975 ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6162 ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:7406 ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2681 ../fish/guestfish-actions.pod:2765 ../fish/guestfish-actions.pod:3346 ../fish/guestfish-actions.pod:3866 ../fish/guestfish-actions.pod:4176 ../fish/guestfish-actions.pod:4199 ../fish/guestfish-actions.pod:4221 ../fish/guestfish-actions.pod:4950
12119 "B<This command is dangerous. Without careful use you can easily destroy all "
12124 #: ../src/guestfs-actions.pod:3872
12125 msgid "guestfs_luks_format_cipher"
12129 #: ../src/guestfs-actions.pod:3874
12133 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12134 " const char *device,\n"
12135 " const char *key,\n"
12137 " const char *cipher);\n"
12142 #: ../src/guestfs-actions.pod:3881
12144 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12145 "set the C<cipher> used."
12149 #: ../src/guestfs-actions.pod:3895
12150 msgid "guestfs_luks_kill_slot"
12154 #: ../src/guestfs-actions.pod:3897
12158 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12159 " const char *device,\n"
12160 " const char *key,\n"
12166 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2688
12168 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12169 "device C<device>. C<key> must be one of the I<other> keys."
12173 #: ../src/guestfs-actions.pod:3915
12174 msgid "guestfs_luks_open"
12178 #: ../src/guestfs-actions.pod:3917
12182 " guestfs_luks_open (guestfs_h *g,\n"
12183 " const char *device,\n"
12184 " const char *key,\n"
12185 " const char *mapname);\n"
12190 #: ../src/guestfs-actions.pod:3923 ../fish/guestfish-actions.pod:2699
12192 "This command opens a block device which has been encrypted according to the "
12193 "Linux Unified Key Setup (LUKS) standard."
12197 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2702
12198 msgid "C<device> is the encrypted block device or partition."
12202 #: ../src/guestfs-actions.pod:3928 ../fish/guestfish-actions.pod:2704
12204 "The caller must supply one of the keys associated with the LUKS block "
12205 "device, in the C<key> parameter."
12209 #: ../src/guestfs-actions.pod:3931 ../fish/guestfish-actions.pod:2707
12211 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12212 "writes to this block device are decrypted from and encrypted to the "
12213 "underlying C<device> respectively."
12217 #: ../src/guestfs-actions.pod:3935
12219 "If this block device contains LVM volume groups, then calling "
12220 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12225 #: ../src/guestfs-actions.pod:3947
12226 msgid "guestfs_luks_open_ro"
12230 #: ../src/guestfs-actions.pod:3949
12234 " guestfs_luks_open_ro (guestfs_h *g,\n"
12235 " const char *device,\n"
12236 " const char *key,\n"
12237 " const char *mapname);\n"
12242 #: ../src/guestfs-actions.pod:3955
12244 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12249 #: ../src/guestfs-actions.pod:3966
12250 msgid "guestfs_lvcreate"
12254 #: ../src/guestfs-actions.pod:3968
12258 " guestfs_lvcreate (guestfs_h *g,\n"
12259 " const char *logvol,\n"
12260 " const char *volgroup,\n"
12266 #: ../src/guestfs-actions.pod:3974 ../fish/guestfish-actions.pod:2732
12268 "This creates an LVM logical volume called C<logvol> on the volume group "
12269 "C<volgroup>, with C<size> megabytes."
12273 #: ../src/guestfs-actions.pod:3981
12274 msgid "guestfs_lvm_canonical_lv_name"
12278 #: ../src/guestfs-actions.pod:3983
12282 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12283 " const char *lvname);\n"
12288 #: ../src/guestfs-actions.pod:3987 ../fish/guestfish-actions.pod:2739
12290 "This converts alternative naming schemes for LVs that you might find to the "
12291 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12296 #: ../src/guestfs-actions.pod:3991 ../fish/guestfish-actions.pod:2743
12298 "This command returns an error if the C<lvname> parameter does not refer to a "
12303 #: ../src/guestfs-actions.pod:3994
12304 msgid "See also C<guestfs_is_lv>."
12308 #: ../src/guestfs-actions.pod:3999
12309 msgid "(Added in 1.5.24)"
12313 #: ../src/guestfs-actions.pod:4001
12314 msgid "guestfs_lvm_clear_filter"
12318 #: ../src/guestfs-actions.pod:4003
12322 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12327 #: ../src/guestfs-actions.pod:4006
12329 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12330 "see every block device."
12334 #: ../src/guestfs-actions.pod:4009 ../src/guestfs-actions.pod:4051 ../fish/guestfish-actions.pod:2755 ../fish/guestfish-actions.pod:2786
12335 msgid "This command also clears the LVM cache and performs a volume group scan."
12339 #: ../src/guestfs-actions.pod:4016
12340 msgid "guestfs_lvm_remove_all"
12344 #: ../src/guestfs-actions.pod:4018
12348 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12353 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2762
12355 "This command removes all LVM logical volumes, volume groups and physical "
12360 #: ../src/guestfs-actions.pod:4031
12361 msgid "guestfs_lvm_set_filter"
12365 #: ../src/guestfs-actions.pod:4033
12369 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12370 " char *const *devices);\n"
12375 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2772
12377 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12378 "block devices in the list C<devices>, and will ignore all other attached "
12383 #: ../src/guestfs-actions.pod:4041 ../fish/guestfish-actions.pod:2776
12385 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12386 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12387 "there are two types of duplication possible: either cloned PVs/VGs which "
12388 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12389 "same name. In normal operation you cannot create this situation, but you "
12390 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12391 "inside the LVM metadata."
12395 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:2789
12396 msgid "You can filter whole block devices or individual partitions."
12400 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2791
12402 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12403 "filesystem), even if you are not filtering out that VG."
12407 #: ../src/guestfs-actions.pod:4064
12408 msgid "guestfs_lvremove"
12412 #: ../src/guestfs-actions.pod:4066
12416 " guestfs_lvremove (guestfs_h *g,\n"
12417 " const char *device);\n"
12422 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2799
12424 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12425 "LV, such as C</dev/VG/LV>."
12429 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2802
12431 "You can also remove all LVs in a volume group by specifying the VG name, "
12436 #: ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:5321 ../src/guestfs-actions.pod:7138
12437 msgid "(Added in 1.0.13)"
12441 #: ../src/guestfs-actions.pod:4080
12442 msgid "guestfs_lvrename"
12446 #: ../src/guestfs-actions.pod:4082
12450 " guestfs_lvrename (guestfs_h *g,\n"
12451 " const char *logvol,\n"
12452 " const char *newlogvol);\n"
12457 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2809
12458 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12462 #: ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:7151
12463 msgid "(Added in 1.0.83)"
12467 #: ../src/guestfs-actions.pod:4093
12468 msgid "guestfs_lvresize"
12472 #: ../src/guestfs-actions.pod:4095
12476 " guestfs_lvresize (guestfs_h *g,\n"
12477 " const char *device,\n"
12483 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2815
12485 "This resizes (expands or shrinks) an existing LVM logical volume to "
12486 "C<mbytes>. When reducing, data in the reduced part is lost."
12490 #: ../src/guestfs-actions.pod:4108
12491 msgid "guestfs_lvresize_free"
12495 #: ../src/guestfs-actions.pod:4110
12499 " guestfs_lvresize_free (guestfs_h *g,\n"
12500 " const char *lv,\n"
12506 #: ../src/guestfs-actions.pod:4115 ../fish/guestfish-actions.pod:2823
12508 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12509 "remaining free space in the volume group. Commonly you would call this with "
12510 "pc = 100 which expands the logical volume as much as possible, using all "
12511 "remaining free space in the volume group."
12515 #: ../src/guestfs-actions.pod:4123
12516 msgid "(Added in 1.3.3)"
12520 #: ../src/guestfs-actions.pod:4125
12521 msgid "guestfs_lvs"
12525 #: ../src/guestfs-actions.pod:4127
12529 " guestfs_lvs (guestfs_h *g);\n"
12534 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2833
12536 "List all the logical volumes detected. This is the equivalent of the "
12537 "L<lvs(8)> command."
12541 #: ../src/guestfs-actions.pod:4133 ../fish/guestfish-actions.pod:2836
12543 "This returns a list of the logical volume device names "
12544 "(eg. C</dev/VolGroup00/LogVol00>)."
12548 #: ../src/guestfs-actions.pod:4136
12549 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12553 #: ../src/guestfs-actions.pod:4144
12554 msgid "guestfs_lvs_full"
12558 #: ../src/guestfs-actions.pod:4146
12561 " struct guestfs_lvm_lv_list *\n"
12562 " guestfs_lvs_full (guestfs_h *g);\n"
12567 #: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2845
12569 "List all the logical volumes detected. This is the equivalent of the "
12570 "L<lvs(8)> command. The \"full\" version includes all fields."
12574 #: ../src/guestfs-actions.pod:4152
12576 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12577 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12582 #: ../src/guestfs-actions.pod:4158
12583 msgid "guestfs_lvuuid"
12587 #: ../src/guestfs-actions.pod:4160
12591 " guestfs_lvuuid (guestfs_h *g,\n"
12592 " const char *device);\n"
12597 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2852
12598 msgid "This command returns the UUID of the LVM LV C<device>."
12602 #: ../src/guestfs-actions.pod:4171
12603 msgid "guestfs_lxattrlist"
12607 #: ../src/guestfs-actions.pod:4173
12610 " struct guestfs_xattr_list *\n"
12611 " guestfs_lxattrlist (guestfs_h *g,\n"
12612 " const char *path,\n"
12613 " char *const *names);\n"
12618 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2858
12620 "This call allows you to get the extended attributes of multiple files, where "
12621 "all files are in the directory C<path>. C<names> is the list of files from "
12626 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2862
12628 "On return you get a flat list of xattr structs which must be interpreted "
12629 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12630 "C<attrval> in this struct is zero-length to indicate there was an error "
12631 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12632 "number (the number of following attributes for this file, which could be "
12633 "C<\"0\">). Then after the first xattr struct are the zero or more "
12634 "attributes for the first named file. This repeats for the second and "
12635 "subsequent files."
12639 #: ../src/guestfs-actions.pod:4192
12641 "This call is intended for programs that want to efficiently list a directory "
12642 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12643 "a similarly efficient call for getting standard stats. Very long directory "
12644 "listings might cause the protocol message size to be exceeded, causing this "
12645 "call to fail. The caller must split up such requests into smaller groups of "
12650 #: ../src/guestfs-actions.pod:4206
12651 msgid "guestfs_mkdir"
12655 #: ../src/guestfs-actions.pod:4208
12659 " guestfs_mkdir (guestfs_h *g,\n"
12660 " const char *path);\n"
12665 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2884
12666 msgid "Create a directory named C<path>."
12670 #: ../src/guestfs-actions.pod:4218
12671 msgid "guestfs_mkdir_mode"
12675 #: ../src/guestfs-actions.pod:4220
12679 " guestfs_mkdir_mode (guestfs_h *g,\n"
12680 " const char *path,\n"
12686 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2890
12688 "This command creates a directory, setting the initial permissions of the "
12689 "directory to C<mode>."
12693 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2893
12695 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12696 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12701 #: ../src/guestfs-actions.pod:4232
12702 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12706 #: ../src/guestfs-actions.pod:4238
12707 msgid "guestfs_mkdir_p"
12711 #: ../src/guestfs-actions.pod:4240
12715 " guestfs_mkdir_p (guestfs_h *g,\n"
12716 " const char *path);\n"
12721 #: ../src/guestfs-actions.pod:4244 ../fish/guestfish-actions.pod:2903
12723 "Create a directory named C<path>, creating any parent directories as "
12724 "necessary. This is like the C<mkdir -p> shell command."
12728 #: ../src/guestfs-actions.pod:4251
12729 msgid "guestfs_mkdtemp"
12733 #: ../src/guestfs-actions.pod:4253
12737 " guestfs_mkdtemp (guestfs_h *g,\n"
12738 " const char *template);\n"
12743 #: ../src/guestfs-actions.pod:4257 ../fish/guestfish-actions.pod:2910
12745 "This command creates a temporary directory. The C<template> parameter "
12746 "should be a full pathname for the temporary directory name with the final "
12747 "six characters being \"XXXXXX\"."
12751 #: ../src/guestfs-actions.pod:4262 ../fish/guestfish-actions.pod:2915
12753 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12754 "being suitable for Windows filesystems."
12758 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2918
12759 msgid "The name of the temporary directory that was created is returned."
12763 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2921
12764 msgid "The temporary directory is created with mode 0700 and is owned by root."
12768 #: ../src/guestfs-actions.pod:4271 ../fish/guestfish-actions.pod:2924
12770 "The caller is responsible for deleting the temporary directory and its "
12771 "contents after use."
12775 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:2927
12776 msgid "See also: L<mkdtemp(3)>"
12780 #: ../src/guestfs-actions.pod:4281
12781 msgid "guestfs_mke2fs_J"
12785 #: ../src/guestfs-actions.pod:4283
12789 " guestfs_mke2fs_J (guestfs_h *g,\n"
12790 " const char *fstype,\n"
12791 " int blocksize,\n"
12792 " const char *device,\n"
12793 " const char *journal);\n"
12798 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2933
12800 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12801 "C<journal>. It is equivalent to the command:"
12805 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2937
12808 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
12813 #: ../src/guestfs-actions.pod:4296
12814 msgid "See also C<guestfs_mke2journal>."
12818 #: ../src/guestfs-actions.pod:4300 ../src/guestfs-actions.pod:4318 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:4380 ../src/guestfs-actions.pod:4439 ../src/guestfs-actions.pod:4704
12819 msgid "(Added in 1.0.68)"
12823 #: ../src/guestfs-actions.pod:4302
12824 msgid "guestfs_mke2fs_JL"
12828 #: ../src/guestfs-actions.pod:4304
12832 " guestfs_mke2fs_JL (guestfs_h *g,\n"
12833 " const char *fstype,\n"
12834 " int blocksize,\n"
12835 " const char *device,\n"
12836 " const char *label);\n"
12841 #: ../src/guestfs-actions.pod:4311 ../fish/guestfish-actions.pod:2945
12843 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12844 "the journal labeled C<label>."
12848 #: ../src/guestfs-actions.pod:4314
12849 msgid "See also C<guestfs_mke2journal_L>."
12853 #: ../src/guestfs-actions.pod:4320
12854 msgid "guestfs_mke2fs_JU"
12858 #: ../src/guestfs-actions.pod:4322
12862 " guestfs_mke2fs_JU (guestfs_h *g,\n"
12863 " const char *fstype,\n"
12864 " int blocksize,\n"
12865 " const char *device,\n"
12866 " const char *uuid);\n"
12871 #: ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:2954
12873 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12874 "the journal with UUID C<uuid>."
12878 #: ../src/guestfs-actions.pod:4332
12879 msgid "See also C<guestfs_mke2journal_U>."
12883 #: ../src/guestfs-actions.pod:4338
12884 msgid "guestfs_mke2journal"
12888 #: ../src/guestfs-actions.pod:4340
12892 " guestfs_mke2journal (guestfs_h *g,\n"
12893 " int blocksize,\n"
12894 " const char *device);\n"
12899 #: ../src/guestfs-actions.pod:4345 ../fish/guestfish-actions.pod:2963
12901 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12906 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2966
12909 " mke2fs -O journal_dev -b blocksize device\n"
12914 #: ../src/guestfs-actions.pod:4354
12915 msgid "guestfs_mke2journal_L"
12919 #: ../src/guestfs-actions.pod:4356
12923 " guestfs_mke2journal_L (guestfs_h *g,\n"
12924 " int blocksize,\n"
12925 " const char *label,\n"
12926 " const char *device);\n"
12931 #: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:2972
12932 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12936 #: ../src/guestfs-actions.pod:4368
12937 msgid "guestfs_mke2journal_U"
12941 #: ../src/guestfs-actions.pod:4370
12945 " guestfs_mke2journal_U (guestfs_h *g,\n"
12946 " int blocksize,\n"
12947 " const char *uuid,\n"
12948 " const char *device);\n"
12953 #: ../src/guestfs-actions.pod:4376 ../fish/guestfish-actions.pod:2978
12954 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12958 #: ../src/guestfs-actions.pod:4382
12959 msgid "guestfs_mkfifo"
12963 #: ../src/guestfs-actions.pod:4384
12967 " guestfs_mkfifo (guestfs_h *g,\n"
12969 " const char *path);\n"
12974 #: ../src/guestfs-actions.pod:4389
12976 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12977 "is just a convenient wrapper around C<guestfs_mknod>."
12981 #: ../src/guestfs-actions.pod:4399
12982 msgid "guestfs_mkfs"
12986 #: ../src/guestfs-actions.pod:4401
12990 " guestfs_mkfs (guestfs_h *g,\n"
12991 " const char *fstype,\n"
12992 " const char *device);\n"
12997 #: ../src/guestfs-actions.pod:4406 ../fish/guestfish-actions.pod:2994
12999 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13000 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13004 #: ../src/guestfs-actions.pod:4414
13005 msgid "guestfs_mkfs_b"
13009 #: ../src/guestfs-actions.pod:4416
13013 " guestfs_mkfs_b (guestfs_h *g,\n"
13014 " const char *fstype,\n"
13015 " int blocksize,\n"
13016 " const char *device);\n"
13021 #: ../src/guestfs-actions.pod:4422
13023 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13024 "block size of the resulting filesystem. Supported block sizes depend on the "
13025 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13029 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:3007 ../fish/guestfish-actions.pod:3034
13031 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13036 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:3010
13038 "This function is deprecated. In new code, use the C<mkfs_opts> call "
13043 #: ../src/guestfs-actions.pod:4441
13044 msgid "guestfs_mkfs_opts"
13048 #: ../src/guestfs-actions.pod:4443
13052 " guestfs_mkfs_opts (guestfs_h *g,\n"
13053 " const char *fstype,\n"
13054 " const char *device,\n"
13060 #: ../src/guestfs-actions.pod:4454
13063 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13064 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13069 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:3021
13071 "This function creates a filesystem on C<device>. The filesystem type is "
13072 "C<fstype>, for example C<ext3>."
13076 #: ../src/guestfs-actions.pod:4464 ../fish/guestfish-actions.pod:3028
13077 msgid "C<blocksize>"
13081 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:3030
13083 "The filesystem block size. Supported block sizes depend on the filesystem "
13084 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13089 #: ../src/guestfs-actions.pod:4473 ../fish/guestfish-actions.pod:3037
13090 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13094 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3039
13095 msgid "C<features>"
13099 #: ../src/guestfs-actions.pod:4477 ../fish/guestfish-actions.pod:3041
13100 msgid "This passes the I<-O> parameter to the external mkfs program."
13104 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:3043
13106 "For certain filesystem types, this allows extra filesystem features to be "
13107 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13111 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3047
13113 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13118 #: ../src/guestfs-actions.pod:4490
13119 msgid "(Added in 1.7.19)"
13123 #: ../src/guestfs-actions.pod:4492
13124 msgid "guestfs_mkfs_opts_va"
13128 #: ../src/guestfs-actions.pod:4494
13132 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13133 " const char *fstype,\n"
13134 " const char *device,\n"
13135 " va_list args);\n"
13140 #: ../src/guestfs-actions.pod:4500
13141 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13145 #: ../src/guestfs-actions.pod:4504
13146 msgid "guestfs_mkfs_opts_argv"
13150 #: ../src/guestfs-actions.pod:4506
13154 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13155 " const char *fstype,\n"
13156 " const char *device,\n"
13157 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13162 #: ../src/guestfs-actions.pod:4512
13163 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13167 #: ../src/guestfs-actions.pod:4516
13168 msgid "guestfs_mkmountpoint"
13172 #: ../src/guestfs-actions.pod:4518
13176 " guestfs_mkmountpoint (guestfs_h *g,\n"
13177 " const char *exemptpath);\n"
13182 #: ../src/guestfs-actions.pod:4522
13184 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13185 "that can be used to create extra mountpoints before mounting the first "
13190 #: ../src/guestfs-actions.pod:4526 ../fish/guestfish-actions.pod:3062
13192 "These calls are I<only> necessary in some very limited circumstances, mainly "
13193 "the case where you want to mount a mix of unrelated and/or read-only "
13194 "filesystems together."
13198 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3066
13200 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13201 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13202 "inside that. You can unpack this as follows in guestfish:"
13206 #: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3071
13209 " add-ro Fedora-11-i686-Live.iso\n"
13211 " mkmountpoint /cd\n"
13212 " mkmountpoint /sqsh\n"
13213 " mkmountpoint /ext3fs\n"
13214 " mount /dev/sda /cd\n"
13215 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13216 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13221 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3080
13222 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13226 #: ../src/guestfs-actions.pod:4546
13228 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13229 "may get unexpected errors if you try to mix these calls. It is safest to "
13230 "manually unmount filesystems and remove mountpoints after use."
13234 #: ../src/guestfs-actions.pod:4550
13236 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13237 "first, so for this to work for manual mountpoints, you must ensure that the "
13238 "innermost mountpoints have the longest pathnames, as in the example code "
13243 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3091
13244 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13248 #: ../src/guestfs-actions.pod:4557
13250 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13251 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13252 "can also trigger these issues."
13256 #: ../src/guestfs-actions.pod:4563 ../src/guestfs-actions.pod:4829 ../src/guestfs-actions.pod:5739
13257 msgid "(Added in 1.0.62)"
13261 #: ../src/guestfs-actions.pod:4565
13262 msgid "guestfs_mknod"
13266 #: ../src/guestfs-actions.pod:4567
13270 " guestfs_mknod (guestfs_h *g,\n"
13274 " const char *path);\n"
13279 #: ../src/guestfs-actions.pod:4574 ../fish/guestfish-actions.pod:3101
13281 "This call creates block or character special devices, or named pipes "
13286 #: ../src/guestfs-actions.pod:4577 ../fish/guestfish-actions.pod:3104
13288 "The C<mode> parameter should be the mode, using the standard constants. "
13289 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13290 "used when creating block and character special devices."
13294 #: ../src/guestfs-actions.pod:4582
13296 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13297 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13298 "regular file). These constants are available in the standard Linux header "
13299 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13300 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13301 "the appropriate constant for you."
13305 #: ../src/guestfs-actions.pod:4596
13306 msgid "guestfs_mknod_b"
13310 #: ../src/guestfs-actions.pod:4598
13314 " guestfs_mknod_b (guestfs_h *g,\n"
13318 " const char *path);\n"
13323 #: ../src/guestfs-actions.pod:4605
13325 "This call creates a block device node called C<path> with mode C<mode> and "
13326 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13327 "wrapper around C<guestfs_mknod>."
13331 #: ../src/guestfs-actions.pod:4615
13332 msgid "guestfs_mknod_c"
13336 #: ../src/guestfs-actions.pod:4617
13340 " guestfs_mknod_c (guestfs_h *g,\n"
13344 " const char *path);\n"
13349 #: ../src/guestfs-actions.pod:4624
13351 "This call creates a char device node called C<path> with mode C<mode> and "
13352 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13353 "wrapper around C<guestfs_mknod>."
13357 #: ../src/guestfs-actions.pod:4634
13358 msgid "guestfs_mkswap"
13362 #: ../src/guestfs-actions.pod:4636
13366 " guestfs_mkswap (guestfs_h *g,\n"
13367 " const char *device);\n"
13372 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3143
13373 msgid "Create a swap partition on C<device>."
13377 #: ../src/guestfs-actions.pod:4646
13378 msgid "guestfs_mkswap_L"
13382 #: ../src/guestfs-actions.pod:4648
13386 " guestfs_mkswap_L (guestfs_h *g,\n"
13387 " const char *label,\n"
13388 " const char *device);\n"
13393 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3149
13394 msgid "Create a swap partition on C<device> with label C<label>."
13398 #: ../src/guestfs-actions.pod:4655 ../fish/guestfish-actions.pod:3151
13400 "Note that you cannot attach a swap label to a block device "
13401 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13402 "the kernel or swap tools."
13406 #: ../src/guestfs-actions.pod:4663
13407 msgid "guestfs_mkswap_U"
13411 #: ../src/guestfs-actions.pod:4665
13415 " guestfs_mkswap_U (guestfs_h *g,\n"
13416 " const char *uuid,\n"
13417 " const char *device);\n"
13422 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3159
13423 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13427 #: ../src/guestfs-actions.pod:4676
13428 msgid "guestfs_mkswap_file"
13432 #: ../src/guestfs-actions.pod:4678
13436 " guestfs_mkswap_file (guestfs_h *g,\n"
13437 " const char *path);\n"
13442 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3165
13443 msgid "Create a swap file."
13447 #: ../src/guestfs-actions.pod:4684
13449 "This command just writes a swap file signature to an existing file. To "
13450 "create the file itself, use something like C<guestfs_fallocate>."
13454 #: ../src/guestfs-actions.pod:4691
13455 msgid "guestfs_modprobe"
13459 #: ../src/guestfs-actions.pod:4693
13463 " guestfs_modprobe (guestfs_h *g,\n"
13464 " const char *modulename);\n"
13469 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3174
13470 msgid "This loads a kernel module in the appliance."
13474 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3176
13476 "The kernel module must have been whitelisted when libguestfs was built (see "
13477 "C<appliance/kmod.whitelist.in> in the source)."
13481 #: ../src/guestfs-actions.pod:4706
13482 msgid "guestfs_mount"
13486 #: ../src/guestfs-actions.pod:4708
13490 " guestfs_mount (guestfs_h *g,\n"
13491 " const char *device,\n"
13492 " const char *mountpoint);\n"
13497 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3183
13499 "Mount a guest disk at a position in the filesystem. Block devices are named "
13500 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13501 "those block devices contain partitions, they will have the usual names "
13502 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13506 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3189
13508 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13509 "mounted on C</> before others can be mounted. Other filesystems can only be "
13510 "mounted on directories which already exist."
13514 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3194
13516 "The mounted filesystem is writable, if we have sufficient permissions on the "
13517 "underlying device."
13521 #: ../src/guestfs-actions.pod:4727
13523 "B<Important note:> When you use this call, the filesystem options C<sync> "
13524 "and C<noatime> are set implicitly. This was originally done because we "
13525 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13526 "very large negative performance impact and negligible effect on "
13527 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13528 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13529 "(use an empty string for the first parameter if you don't want any options)."
13533 #: ../src/guestfs-actions.pod:4739 ../fish/guestfish-actions.pod:3207
13535 "This function is deprecated. In new code, use the C<mount_options> call "
13540 #: ../src/guestfs-actions.pod:4748
13541 msgid "guestfs_mount_loop"
13545 #: ../src/guestfs-actions.pod:4750
13549 " guestfs_mount_loop (guestfs_h *g,\n"
13550 " const char *file,\n"
13551 " const char *mountpoint);\n"
13556 #: ../src/guestfs-actions.pod:4755 ../fish/guestfish-actions.pod:3218
13558 "This command lets you mount C<file> (a filesystem image in a file) on a "
13559 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13564 #: ../src/guestfs-actions.pod:4763
13565 msgid "guestfs_mount_options"
13569 #: ../src/guestfs-actions.pod:4765
13573 " guestfs_mount_options (guestfs_h *g,\n"
13574 " const char *options,\n"
13575 " const char *device,\n"
13576 " const char *mountpoint);\n"
13581 #: ../src/guestfs-actions.pod:4771
13583 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13584 "the mount options as for the L<mount(8)> I<-o> flag."
13588 #: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3230
13590 "If the C<options> parameter is an empty string, then no options are passed "
13591 "(all options default to whatever the filesystem uses)."
13595 #: ../src/guestfs-actions.pod:4781 ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4812
13596 msgid "(Added in 1.0.10)"
13600 #: ../src/guestfs-actions.pod:4783
13601 msgid "guestfs_mount_ro"
13605 #: ../src/guestfs-actions.pod:4785
13609 " guestfs_mount_ro (guestfs_h *g,\n"
13610 " const char *device,\n"
13611 " const char *mountpoint);\n"
13616 #: ../src/guestfs-actions.pod:4790
13618 "This is the same as the C<guestfs_mount> command, but it mounts the "
13619 "filesystem with the read-only (I<-o ro>) flag."
13623 #: ../src/guestfs-actions.pod:4797
13624 msgid "guestfs_mount_vfs"
13628 #: ../src/guestfs-actions.pod:4799
13632 " guestfs_mount_vfs (guestfs_h *g,\n"
13633 " const char *options,\n"
13634 " const char *vfstype,\n"
13635 " const char *device,\n"
13636 " const char *mountpoint);\n"
13641 #: ../src/guestfs-actions.pod:4806
13643 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13644 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13649 #: ../src/guestfs-actions.pod:4814
13650 msgid "guestfs_mountpoints"
13654 #: ../src/guestfs-actions.pod:4816
13658 " guestfs_mountpoints (guestfs_h *g);\n"
13663 #: ../src/guestfs-actions.pod:4819
13665 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13666 "devices. This one returns a hash table (map) of device name to directory "
13667 "where the device is mounted."
13671 #: ../src/guestfs-actions.pod:4831
13672 msgid "guestfs_mounts"
13676 #: ../src/guestfs-actions.pod:4833
13680 " guestfs_mounts (guestfs_h *g);\n"
13685 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3261
13687 "This returns the list of currently mounted filesystems. It returns the list "
13688 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13692 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3264
13693 msgid "Some internal mounts are not shown."
13697 #: ../src/guestfs-actions.pod:4841
13698 msgid "See also: C<guestfs_mountpoints>"
13702 #: ../src/guestfs-actions.pod:4849
13707 #: ../src/guestfs-actions.pod:4851
13711 " guestfs_mv (guestfs_h *g,\n"
13712 " const char *src,\n"
13713 " const char *dest);\n"
13718 #: ../src/guestfs-actions.pod:4856 ../fish/guestfish-actions.pod:3272
13720 "This moves a file from C<src> to C<dest> where C<dest> is either a "
13721 "destination filename or destination directory."
13725 #: ../src/guestfs-actions.pod:4863
13726 msgid "guestfs_ntfs_3g_probe"
13730 #: ../src/guestfs-actions.pod:4865
13734 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
13736 " const char *device);\n"
13741 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3279
13743 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
13744 "C<device> for mountability. (Not all NTFS volumes can be mounted "
13745 "read-write, and some cannot be mounted at all)."
13749 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3283
13751 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
13752 "can be mounted read-write. Set it to false if you want to test if the "
13753 "volume can be mounted read-only."
13757 #: ../src/guestfs-actions.pod:4878 ../fish/guestfish-actions.pod:3287
13759 "The return value is an integer which C<0> if the operation would succeed, or "
13760 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
13764 #: ../src/guestfs-actions.pod:4884
13765 msgid "(Added in 1.0.43)"
13769 #: ../src/guestfs-actions.pod:4886
13770 msgid "guestfs_ntfsresize"
13774 #: ../src/guestfs-actions.pod:4888
13778 " guestfs_ntfsresize (guestfs_h *g,\n"
13779 " const char *device);\n"
13784 #: ../src/guestfs-actions.pod:4892 ../fish/guestfish-actions.pod:3295
13786 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
13787 "size of the underlying device. See also L<ntfsresize(8)>."
13791 #: ../src/guestfs-actions.pod:4900
13792 msgid "guestfs_ntfsresize_size"
13796 #: ../src/guestfs-actions.pod:4902
13800 " guestfs_ntfsresize_size (guestfs_h *g,\n"
13801 " const char *device,\n"
13802 " int64_t size);\n"
13807 #: ../src/guestfs-actions.pod:4907
13809 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
13810 "to specify the new size (in bytes) explicitly."
13814 #: ../src/guestfs-actions.pod:4912 ../src/guestfs-actions.pod:5348 ../src/guestfs-actions.pod:5421 ../src/guestfs-actions.pod:5687 ../src/guestfs-actions.pod:7293
13815 msgid "(Added in 1.3.14)"
13819 #: ../src/guestfs-actions.pod:4914
13820 msgid "guestfs_part_add"
13824 #: ../src/guestfs-actions.pod:4916
13828 " guestfs_part_add (guestfs_h *g,\n"
13829 " const char *device,\n"
13830 " const char *prlogex,\n"
13831 " int64_t startsect,\n"
13832 " int64_t endsect);\n"
13837 #: ../src/guestfs-actions.pod:4923
13839 "This command adds a partition to C<device>. If there is no partition table "
13840 "on the device, call C<guestfs_part_init> first."
13844 #: ../src/guestfs-actions.pod:4926 ../fish/guestfish-actions.pod:3313
13846 "The C<prlogex> parameter is the type of partition. Normally you should pass "
13847 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
13848 "C<logical>) and C<e> (or C<extended>) partition types."
13852 #: ../src/guestfs-actions.pod:4931 ../fish/guestfish-actions.pod:3318
13854 "C<startsect> and C<endsect> are the start and end of the partition in "
13855 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
13856 "from the end of the disk (C<-1> is the last sector)."
13860 #: ../src/guestfs-actions.pod:4935
13862 "Creating a partition which covers the whole disk is not so easy. Use "
13863 "C<guestfs_part_disk> to do that."
13867 #: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4978 ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5109 ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5166 ../src/guestfs-actions.pod:5206
13868 msgid "(Added in 1.0.78)"
13872 #: ../src/guestfs-actions.pod:4942
13873 msgid "guestfs_part_del"
13877 #: ../src/guestfs-actions.pod:4944
13881 " guestfs_part_del (guestfs_h *g,\n"
13882 " const char *device,\n"
13888 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3329
13889 msgid "This command deletes the partition numbered C<partnum> on C<device>."
13893 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3331
13895 "Note that in the case of MBR partitioning, deleting an extended partition "
13896 "also deletes any logical partitions it contains."
13900 #: ../src/guestfs-actions.pod:4959
13901 msgid "guestfs_part_disk"
13905 #: ../src/guestfs-actions.pod:4961
13909 " guestfs_part_disk (guestfs_h *g,\n"
13910 " const char *device,\n"
13911 " const char *parttype);\n"
13916 #: ../src/guestfs-actions.pod:4966
13918 "This command is simply a combination of C<guestfs_part_init> followed by "
13919 "C<guestfs_part_add> to create a single primary partition covering the whole "
13924 #: ../src/guestfs-actions.pod:4970
13926 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
13927 "possible values are described in C<guestfs_part_init>."
13931 #: ../src/guestfs-actions.pod:4980
13932 msgid "guestfs_part_get_bootable"
13936 #: ../src/guestfs-actions.pod:4982
13940 " guestfs_part_get_bootable (guestfs_h *g,\n"
13941 " const char *device,\n"
13947 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3353
13949 "This command returns true if the partition C<partnum> on C<device> has the "
13950 "bootable flag set."
13954 #: ../src/guestfs-actions.pod:4990
13955 msgid "See also C<guestfs_part_set_bootable>."
13959 #: ../src/guestfs-actions.pod:4996
13960 msgid "guestfs_part_get_mbr_id"
13964 #: ../src/guestfs-actions.pod:4998
13968 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
13969 " const char *device,\n"
13975 #: ../src/guestfs-actions.pod:5003 ../fish/guestfish-actions.pod:3362
13977 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13978 "partition C<partnum>."
13982 #: ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5182
13984 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
13985 "undefined results for other partition table types (see "
13986 "C<guestfs_part_get_parttype>)."
13990 #: ../src/guestfs-actions.pod:5014
13991 msgid "guestfs_part_get_parttype"
13995 #: ../src/guestfs-actions.pod:5016
13999 " guestfs_part_get_parttype (guestfs_h *g,\n"
14000 " const char *device);\n"
14005 #: ../src/guestfs-actions.pod:5020 ../fish/guestfish-actions.pod:3373
14007 "This command examines the partition table on C<device> and returns the "
14008 "partition table type (format) being used."
14012 #: ../src/guestfs-actions.pod:5023
14014 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14015 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14016 "possible, although unusual. See C<guestfs_part_init> for a full list."
14020 #: ../src/guestfs-actions.pod:5033
14021 msgid "guestfs_part_init"
14025 #: ../src/guestfs-actions.pod:5035
14029 " guestfs_part_init (guestfs_h *g,\n"
14030 " const char *device,\n"
14031 " const char *parttype);\n"
14036 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3385
14038 "This creates an empty partition table on C<device> of one of the partition "
14039 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14040 "(for large disks)."
14044 #: ../src/guestfs-actions.pod:5044
14046 "Initially there are no partitions. Following this, you should call "
14047 "C<guestfs_part_add> for each partition required."
14051 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3392
14052 msgid "Possible values for C<parttype> are:"
14056 #: ../src/guestfs-actions.pod:5051 ../fish/guestfish-actions.pod:3396
14057 msgid "B<efi> | B<gpt>"
14061 #: ../src/guestfs-actions.pod:5053 ../fish/guestfish-actions.pod:3398
14062 msgid "Intel EFI / GPT partition table."
14066 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3400
14068 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14069 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14070 "the C<mbr> format."
14074 #: ../src/guestfs-actions.pod:5059 ../fish/guestfish-actions.pod:3404
14075 msgid "B<mbr> | B<msdos>"
14079 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3406
14081 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14082 "Windows. This partition type will B<only> work for device sizes up to 2 "
14083 "TB. For large disks we recommend using C<gpt>."
14087 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3413
14088 msgid "Other partition table types that may work but are not supported include:"
14092 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3418
14097 #: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3420
14098 msgid "AIX disk labels."
14102 #: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3422
14103 msgid "B<amiga> | B<rdb>"
14107 #: ../src/guestfs-actions.pod:5079 ../fish/guestfish-actions.pod:3424
14108 msgid "Amiga \"Rigid Disk Block\" format."
14112 #: ../src/guestfs-actions.pod:5081 ../fish/guestfish-actions.pod:3426
14117 #: ../src/guestfs-actions.pod:5083 ../fish/guestfish-actions.pod:3428
14118 msgid "BSD disk labels."
14122 #: ../src/guestfs-actions.pod:5085 ../fish/guestfish-actions.pod:3430
14127 #: ../src/guestfs-actions.pod:5087 ../fish/guestfish-actions.pod:3432
14128 msgid "DASD, used on IBM mainframes."
14132 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3434
14137 #: ../src/guestfs-actions.pod:5091 ../fish/guestfish-actions.pod:3436
14138 msgid "MIPS/SGI volumes."
14142 #: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3438
14147 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3440
14148 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14152 #: ../src/guestfs-actions.pod:5097 ../fish/guestfish-actions.pod:3442
14157 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3444
14158 msgid "NEC PC-98 format, common in Japan apparently."
14162 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3446
14167 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3448
14168 msgid "Sun disk labels."
14172 #: ../src/guestfs-actions.pod:5111
14173 msgid "guestfs_part_list"
14177 #: ../src/guestfs-actions.pod:5113
14180 " struct guestfs_partition_list *\n"
14181 " guestfs_part_list (guestfs_h *g,\n"
14182 " const char *device);\n"
14187 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3456
14189 "This command parses the partition table on C<device> and returns the list of "
14190 "partitions found."
14194 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3459
14195 msgid "The fields in the returned structure are:"
14199 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3463
14200 msgid "B<part_num>"
14204 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3465
14205 msgid "Partition number, counting from 1."
14209 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3467
14210 msgid "B<part_start>"
14214 #: ../src/guestfs-actions.pod:5130
14216 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14217 "the device's sector size, see C<guestfs_blockdev_getss>."
14221 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3472
14222 msgid "B<part_end>"
14226 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3474
14227 msgid "End of the partition in bytes."
14231 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3476
14232 msgid "B<part_size>"
14236 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3478
14237 msgid "Size of the partition in bytes."
14241 #: ../src/guestfs-actions.pod:5143
14243 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14244 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14249 #: ../src/guestfs-actions.pod:5149
14250 msgid "guestfs_part_set_bootable"
14254 #: ../src/guestfs-actions.pod:5151
14258 " guestfs_part_set_bootable (guestfs_h *g,\n"
14259 " const char *device,\n"
14261 " int bootable);\n"
14266 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3486
14268 "This sets the bootable flag on partition numbered C<partnum> on device "
14269 "C<device>. Note that partitions are numbered from 1."
14273 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3489
14275 "The bootable flag is used by some operating systems (notably Windows) to "
14276 "determine which partition to boot from. It is by no means universally "
14281 #: ../src/guestfs-actions.pod:5168
14282 msgid "guestfs_part_set_mbr_id"
14286 #: ../src/guestfs-actions.pod:5170
14290 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14291 " const char *device,\n"
14298 #: ../src/guestfs-actions.pod:5176 ../fish/guestfish-actions.pod:3497
14300 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14301 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14302 "documentation are in fact hexadecimal numbers, but usually documented "
14303 "without any leading \"0x\" which might be confusing."
14307 #: ../src/guestfs-actions.pod:5190
14308 msgid "guestfs_part_set_name"
14312 #: ../src/guestfs-actions.pod:5192
14316 " guestfs_part_set_name (guestfs_h *g,\n"
14317 " const char *device,\n"
14319 " const char *name);\n"
14324 #: ../src/guestfs-actions.pod:5198 ../fish/guestfish-actions.pod:3511
14326 "This sets the partition name on partition numbered C<partnum> on device "
14327 "C<device>. Note that partitions are numbered from 1."
14331 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3514
14333 "The partition name can only be set on certain types of partition table. "
14334 "This works on C<gpt> but not on C<mbr> partitions."
14338 #: ../src/guestfs-actions.pod:5208
14339 msgid "guestfs_part_to_dev"
14343 #: ../src/guestfs-actions.pod:5210
14347 " guestfs_part_to_dev (guestfs_h *g,\n"
14348 " const char *partition);\n"
14353 #: ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:3521
14355 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14356 "partition number, returning the device name (eg. \"/dev/sdb\")."
14360 #: ../src/guestfs-actions.pod:5218
14362 "The named partition must exist, for example as a string returned from "
14363 "C<guestfs_list_partitions>."
14367 #: ../src/guestfs-actions.pod:5226
14368 msgid "guestfs_ping_daemon"
14372 #: ../src/guestfs-actions.pod:5228
14376 " guestfs_ping_daemon (guestfs_h *g);\n"
14381 #: ../src/guestfs-actions.pod:5231 ../fish/guestfish-actions.pod:3532
14383 "This is a test probe into the guestfs daemon running inside the qemu "
14384 "subprocess. Calling this function checks that the daemon responds to the "
14385 "ping message, without affecting the daemon or attached block device(s) in "
14390 #: ../src/guestfs-actions.pod:5240
14391 msgid "guestfs_pread"
14395 #: ../src/guestfs-actions.pod:5242
14399 " guestfs_pread (guestfs_h *g,\n"
14400 " const char *path,\n"
14402 " int64_t offset,\n"
14403 " size_t *size_r);\n"
14408 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3541
14410 "This command lets you read part of a file. It reads C<count> bytes of the "
14411 "file, starting at C<offset>, from file C<path>."
14415 #: ../src/guestfs-actions.pod:5252 ../src/guestfs-actions.pod:5278 ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3559
14417 "This may read fewer bytes than requested. For further details see the "
14418 "L<pread(2)> system call."
14422 #: ../src/guestfs-actions.pod:5255
14423 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14427 #: ../src/guestfs-actions.pod:5266
14428 msgid "guestfs_pread_device"
14432 #: ../src/guestfs-actions.pod:5268
14436 " guestfs_pread_device (guestfs_h *g,\n"
14437 " const char *device,\n"
14439 " int64_t offset,\n"
14440 " size_t *size_r);\n"
14445 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3556
14447 "This command lets you read part of a file. It reads C<count> bytes of "
14448 "C<device>, starting at C<offset>."
14452 #: ../src/guestfs-actions.pod:5281
14453 msgid "See also C<guestfs_pread>."
14457 #: ../src/guestfs-actions.pod:5290
14458 msgid "(Added in 1.5.21)"
14462 #: ../src/guestfs-actions.pod:5292
14463 msgid "guestfs_pvcreate"
14467 #: ../src/guestfs-actions.pod:5294
14471 " guestfs_pvcreate (guestfs_h *g,\n"
14472 " const char *device);\n"
14477 #: ../src/guestfs-actions.pod:5298 ../fish/guestfish-actions.pod:3571
14479 "This creates an LVM physical volume on the named C<device>, where C<device> "
14480 "should usually be a partition name such as C</dev/sda1>."
14484 #: ../src/guestfs-actions.pod:5306
14485 msgid "guestfs_pvremove"
14489 #: ../src/guestfs-actions.pod:5308
14493 " guestfs_pvremove (guestfs_h *g,\n"
14494 " const char *device);\n"
14499 #: ../src/guestfs-actions.pod:5312 ../fish/guestfish-actions.pod:3579
14501 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14506 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3582
14508 "The implementation uses the C<pvremove> command which refuses to wipe "
14509 "physical volumes that contain any volume groups, so you have to remove those "
14514 #: ../src/guestfs-actions.pod:5323
14515 msgid "guestfs_pvresize"
14519 #: ../src/guestfs-actions.pod:5325
14523 " guestfs_pvresize (guestfs_h *g,\n"
14524 " const char *device);\n"
14529 #: ../src/guestfs-actions.pod:5329 ../fish/guestfish-actions.pod:3590
14531 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14532 "the new size of the underlying device."
14536 #: ../src/guestfs-actions.pod:5336
14537 msgid "guestfs_pvresize_size"
14541 #: ../src/guestfs-actions.pod:5338
14545 " guestfs_pvresize_size (guestfs_h *g,\n"
14546 " const char *device,\n"
14547 " int64_t size);\n"
14552 #: ../src/guestfs-actions.pod:5343
14554 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14555 "specify the new size (in bytes) explicitly."
14559 #: ../src/guestfs-actions.pod:5350
14560 msgid "guestfs_pvs"
14564 #: ../src/guestfs-actions.pod:5352
14568 " guestfs_pvs (guestfs_h *g);\n"
14573 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3604
14575 "List all the physical volumes detected. This is the equivalent of the "
14576 "L<pvs(8)> command."
14580 #: ../src/guestfs-actions.pod:5358 ../fish/guestfish-actions.pod:3607
14582 "This returns a list of just the device names that contain PVs "
14583 "(eg. C</dev/sda2>)."
14587 #: ../src/guestfs-actions.pod:5361
14588 msgid "See also C<guestfs_pvs_full>."
14592 #: ../src/guestfs-actions.pod:5369
14593 msgid "guestfs_pvs_full"
14597 #: ../src/guestfs-actions.pod:5371
14600 " struct guestfs_lvm_pv_list *\n"
14601 " guestfs_pvs_full (guestfs_h *g);\n"
14606 #: ../src/guestfs-actions.pod:5374 ../fish/guestfish-actions.pod:3616
14608 "List all the physical volumes detected. This is the equivalent of the "
14609 "L<pvs(8)> command. The \"full\" version includes all fields."
14613 #: ../src/guestfs-actions.pod:5377
14615 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14616 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14621 #: ../src/guestfs-actions.pod:5383
14622 msgid "guestfs_pvuuid"
14626 #: ../src/guestfs-actions.pod:5385
14630 " guestfs_pvuuid (guestfs_h *g,\n"
14631 " const char *device);\n"
14636 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3623
14637 msgid "This command returns the UUID of the LVM PV C<device>."
14641 #: ../src/guestfs-actions.pod:5396
14642 msgid "guestfs_pwrite"
14646 #: ../src/guestfs-actions.pod:5398
14650 " guestfs_pwrite (guestfs_h *g,\n"
14651 " const char *path,\n"
14652 " const char *content,\n"
14653 " size_t content_size,\n"
14654 " int64_t offset);\n"
14659 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3629
14661 "This command writes to part of a file. It writes the data buffer C<content> "
14662 "to the file C<path> starting at offset C<offset>."
14666 #: ../src/guestfs-actions.pod:5408 ../fish/guestfish-actions.pod:3632
14668 "This command implements the L<pwrite(2)> system call, and like that system "
14669 "call it may not write the full data requested. The return value is the "
14670 "number of bytes that were actually written to the file. This could even be "
14671 "0, although short writes are unlikely for regular files in ordinary "
14676 #: ../src/guestfs-actions.pod:5414
14677 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14681 #: ../src/guestfs-actions.pod:5423
14682 msgid "guestfs_pwrite_device"
14686 #: ../src/guestfs-actions.pod:5425
14690 " guestfs_pwrite_device (guestfs_h *g,\n"
14691 " const char *device,\n"
14692 " const char *content,\n"
14693 " size_t content_size,\n"
14694 " int64_t offset);\n"
14699 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3647
14701 "This command writes to part of a device. It writes the data buffer "
14702 "C<content> to C<device> starting at offset C<offset>."
14706 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3650
14708 "This command implements the L<pwrite(2)> system call, and like that system "
14709 "call it may not write the full data requested (although short writes to disk "
14710 "devices and partitions are probably impossible with standard Linux kernels)."
14714 #: ../src/guestfs-actions.pod:5440
14715 msgid "See also C<guestfs_pwrite>."
14719 #: ../src/guestfs-actions.pod:5447
14720 msgid "(Added in 1.5.20)"
14724 #: ../src/guestfs-actions.pod:5449
14725 msgid "guestfs_read_file"
14729 #: ../src/guestfs-actions.pod:5451
14733 " guestfs_read_file (guestfs_h *g,\n"
14734 " const char *path,\n"
14735 " size_t *size_r);\n"
14740 #: ../src/guestfs-actions.pod:5456 ../fish/guestfish-actions.pod:3664
14741 msgid "This calls returns the contents of the file C<path> as a buffer."
14745 #: ../src/guestfs-actions.pod:5459
14747 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
14748 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
14749 "function is limited in the total size of file that can be handled."
14753 #: ../src/guestfs-actions.pod:5471
14754 msgid "(Added in 1.0.63)"
14758 #: ../src/guestfs-actions.pod:5473
14759 msgid "guestfs_read_lines"
14763 #: ../src/guestfs-actions.pod:5475
14767 " guestfs_read_lines (guestfs_h *g,\n"
14768 " const char *path);\n"
14773 #: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:3681
14775 "The file contents are returned as a list of lines. Trailing C<LF> and "
14776 "C<CRLF> character sequences are I<not> returned."
14780 #: ../src/guestfs-actions.pod:5484
14782 "Note that this function cannot correctly handle binary files (specifically, "
14783 "files containing C<\\0> character which is treated as end of line). For "
14784 "those you need to use the C<guestfs_read_file> function which has a more "
14785 "complex interface."
14789 #: ../src/guestfs-actions.pod:5495
14790 msgid "guestfs_readdir"
14794 #: ../src/guestfs-actions.pod:5497
14797 " struct guestfs_dirent_list *\n"
14798 " guestfs_readdir (guestfs_h *g,\n"
14799 " const char *dir);\n"
14804 #: ../src/guestfs-actions.pod:5501 ../fish/guestfish-actions.pod:3693
14805 msgid "This returns the list of directory entries in directory C<dir>."
14809 #: ../src/guestfs-actions.pod:5503 ../fish/guestfish-actions.pod:3695
14811 "All entries in the directory are returned, including C<.> and C<..>. The "
14812 "entries are I<not> sorted, but returned in the same order as the underlying "
14817 #: ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3699
14819 "Also this call returns basic file type information about each file. The "
14820 "C<ftyp> field will contain one of the following characters:"
14824 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3704
14829 #: ../src/guestfs-actions.pod:5514 ../fish/guestfish-actions.pod:3706
14830 msgid "Block special"
14834 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3708
14839 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3710
14840 msgid "Char special"
14844 #: ../src/guestfs-actions.pod:5520 ../fish/guestfish-actions.pod:3712
14849 #: ../src/guestfs-actions.pod:5522 ../fish/guestfish-actions.pod:3714
14854 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3716
14859 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3718
14860 msgid "FIFO (named pipe)"
14864 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3720
14869 #: ../src/guestfs-actions.pod:5530 ../fish/guestfish-actions.pod:3722
14870 msgid "Symbolic link"
14874 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3724
14879 #: ../src/guestfs-actions.pod:5534 ../fish/guestfish-actions.pod:3726
14880 msgid "Regular file"
14884 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3728
14889 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3730
14894 #: ../src/guestfs-actions.pod:5540 ../fish/guestfish-actions.pod:3732
14899 #: ../src/guestfs-actions.pod:5542 ../fish/guestfish-actions.pod:3734
14900 msgid "Unknown file type"
14904 #: ../src/guestfs-actions.pod:5544 ../fish/guestfish-actions.pod:3736
14909 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3738
14910 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
14914 #: ../src/guestfs-actions.pod:5551
14916 "This function is primarily intended for use by programs. To get a simple "
14917 "list of names, use C<guestfs_ls>. To get a printable directory for human "
14918 "consumption, use C<guestfs_ll>."
14922 #: ../src/guestfs-actions.pod:5555
14924 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
14925 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
14930 #: ../src/guestfs-actions.pod:5561
14931 msgid "guestfs_readlink"
14935 #: ../src/guestfs-actions.pod:5563
14939 " guestfs_readlink (guestfs_h *g,\n"
14940 " const char *path);\n"
14945 #: ../src/guestfs-actions.pod:5567 ../fish/guestfish-actions.pod:3751
14946 msgid "This command reads the target of a symbolic link."
14950 #: ../src/guestfs-actions.pod:5574
14951 msgid "guestfs_readlinklist"
14955 #: ../src/guestfs-actions.pod:5576
14959 " guestfs_readlinklist (guestfs_h *g,\n"
14960 " const char *path,\n"
14961 " char *const *names);\n"
14966 #: ../src/guestfs-actions.pod:5581 ../fish/guestfish-actions.pod:3757
14968 "This call allows you to do a C<readlink> operation on multiple files, where "
14969 "all files are in the directory C<path>. C<names> is the list of files from "
14974 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3761
14976 "On return you get a list of strings, with a one-to-one correspondence to the "
14977 "C<names> list. Each string is the value of the symbolic link."
14981 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3765
14983 "If the C<readlink(2)> operation fails on any name, then the corresponding "
14984 "result string is the empty string C<\"\">. However the whole operation is "
14985 "completed even if there were C<readlink(2)> errors, and so you can call this "
14986 "function with names where you don't know if they are symbolic links already "
14987 "(albeit slightly less efficient)."
14991 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:3772
14993 "This call is intended for programs that want to efficiently list a directory "
14994 "contents without making many round-trips. Very long directory listings "
14995 "might cause the protocol message size to be exceeded, causing this call to "
14996 "fail. The caller must split up such requests into smaller groups of names."
15000 #: ../src/guestfs-actions.pod:5609
15001 msgid "guestfs_realpath"
15005 #: ../src/guestfs-actions.pod:5611
15009 " guestfs_realpath (guestfs_h *g,\n"
15010 " const char *path);\n"
15015 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3783
15017 "Return the canonicalized absolute pathname of C<path>. The returned path "
15018 "has no C<.>, C<..> or symbolic link path elements."
15022 #: ../src/guestfs-actions.pod:5623
15023 msgid "guestfs_removexattr"
15027 #: ../src/guestfs-actions.pod:5625
15031 " guestfs_removexattr (guestfs_h *g,\n"
15032 " const char *xattr,\n"
15033 " const char *path);\n"
15038 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3790
15039 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
15043 #: ../src/guestfs-actions.pod:5633
15044 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15048 #: ../src/guestfs-actions.pod:5639
15049 msgid "guestfs_resize2fs"
15053 #: ../src/guestfs-actions.pod:5641
15057 " guestfs_resize2fs (guestfs_h *g,\n"
15058 " const char *device);\n"
15063 #: ../src/guestfs-actions.pod:5645 ../fish/guestfish-actions.pod:3799
15065 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15066 "underlying device."
15070 #: ../src/guestfs-actions.pod:5648
15072 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15073 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15074 "sometimes gives an error about this and sometimes not. In any case, it is "
15075 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15079 #: ../src/guestfs-actions.pod:5658
15080 msgid "guestfs_resize2fs_M"
15084 #: ../src/guestfs-actions.pod:5660
15088 " guestfs_resize2fs_M (guestfs_h *g,\n"
15089 " const char *device);\n"
15094 #: ../src/guestfs-actions.pod:5664
15096 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15097 "resized to its minimum size. This works like the I<-M> option to the "
15098 "C<resize2fs> command."
15102 #: ../src/guestfs-actions.pod:5668
15104 "To get the resulting size of the filesystem you should call "
15105 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15106 "These two numbers, multiplied together, give the resulting size of the "
15107 "minimal filesystem in bytes."
15111 #: ../src/guestfs-actions.pod:5675
15112 msgid "guestfs_resize2fs_size"
15116 #: ../src/guestfs-actions.pod:5677
15120 " guestfs_resize2fs_size (guestfs_h *g,\n"
15121 " const char *device,\n"
15122 " int64_t size);\n"
15127 #: ../src/guestfs-actions.pod:5682
15129 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15130 "to specify the new size (in bytes) explicitly."
15134 #: ../src/guestfs-actions.pod:5689
15139 #: ../src/guestfs-actions.pod:5691
15143 " guestfs_rm (guestfs_h *g,\n"
15144 " const char *path);\n"
15149 #: ../src/guestfs-actions.pod:5695 ../fish/guestfish-actions.pod:3832
15150 msgid "Remove the single file C<path>."
15154 #: ../src/guestfs-actions.pod:5701
15155 msgid "guestfs_rm_rf"
15159 #: ../src/guestfs-actions.pod:5703
15163 " guestfs_rm_rf (guestfs_h *g,\n"
15164 " const char *path);\n"
15169 #: ../src/guestfs-actions.pod:5707 ../fish/guestfish-actions.pod:3838
15171 "Remove the file or directory C<path>, recursively removing the contents if "
15172 "its a directory. This is like the C<rm -rf> shell command."
15176 #: ../src/guestfs-actions.pod:5715
15177 msgid "guestfs_rmdir"
15181 #: ../src/guestfs-actions.pod:5717
15185 " guestfs_rmdir (guestfs_h *g,\n"
15186 " const char *path);\n"
15191 #: ../src/guestfs-actions.pod:5721 ../fish/guestfish-actions.pod:3846
15192 msgid "Remove the single directory C<path>."
15196 #: ../src/guestfs-actions.pod:5727
15197 msgid "guestfs_rmmountpoint"
15201 #: ../src/guestfs-actions.pod:5729
15205 " guestfs_rmmountpoint (guestfs_h *g,\n"
15206 " const char *exemptpath);\n"
15211 #: ../src/guestfs-actions.pod:5733
15213 "This calls removes a mountpoint that was previously created with "
15214 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15218 #: ../src/guestfs-actions.pod:5741
15219 msgid "guestfs_scrub_device"
15223 #: ../src/guestfs-actions.pod:5743
15227 " guestfs_scrub_device (guestfs_h *g,\n"
15228 " const char *device);\n"
15233 #: ../src/guestfs-actions.pod:5747 ../fish/guestfish-actions.pod:3860
15235 "This command writes patterns over C<device> to make data retrieval more "
15240 #: ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3863 ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:3891
15242 "It is an interface to the L<scrub(1)> program. See that manual page for "
15247 #: ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:5795
15248 msgid "(Added in 1.0.52)"
15252 #: ../src/guestfs-actions.pod:5760
15253 msgid "guestfs_scrub_file"
15257 #: ../src/guestfs-actions.pod:5762
15261 " guestfs_scrub_file (guestfs_h *g,\n"
15262 " const char *file);\n"
15267 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3873
15269 "This command writes patterns over a file to make data retrieval more "
15274 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3876
15275 msgid "The file is I<removed> after scrubbing."
15279 #: ../src/guestfs-actions.pod:5778
15280 msgid "guestfs_scrub_freespace"
15284 #: ../src/guestfs-actions.pod:5780
15288 " guestfs_scrub_freespace (guestfs_h *g,\n"
15289 " const char *dir);\n"
15294 #: ../src/guestfs-actions.pod:5784
15296 "This command creates the directory C<dir> and then fills it with files until "
15297 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15298 "and deletes them. The intention is to scrub any free space on the partition "
15299 "containing C<dir>."
15303 #: ../src/guestfs-actions.pod:5797
15304 msgid "guestfs_set_append"
15308 #: ../src/guestfs-actions.pod:5799
15312 " guestfs_set_append (guestfs_h *g,\n"
15313 " const char *append);\n"
15318 #: ../src/guestfs-actions.pod:5803 ../fish/guestfish-actions.pod:3900
15320 "This function is used to add additional options to the guest kernel command "
15325 #: ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3903
15327 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15328 "environment variable."
15332 #: ../src/guestfs-actions.pod:5809 ../fish/guestfish-actions.pod:3906
15334 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15335 "(libguestfs always adds a few of its own)."
15339 #: ../src/guestfs-actions.pod:5816
15340 msgid "guestfs_set_attach_method"
15344 #: ../src/guestfs-actions.pod:5818
15348 " guestfs_set_attach_method (guestfs_h *g,\n"
15349 " const char *attachmethod);\n"
15354 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3915
15356 "Set the method that libguestfs uses to connect to the back end guestfsd "
15357 "daemon. Possible methods are:"
15361 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3922
15363 "Launch an appliance and connect to it. This is the ordinary method and the "
15368 #: ../src/guestfs-actions.pod:5832 ../fish/guestfish-actions.pod:3925
15369 msgid "C<unix:I<path>>"
15373 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3927
15374 msgid "Connect to the Unix domain socket I<path>."
15378 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3929
15380 "This method lets you connect to an existing daemon or (using virtio-serial) "
15381 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15382 "RUNNING DAEMONS>."
15386 #: ../src/guestfs-actions.pod:5844
15387 msgid "guestfs_set_autosync"
15391 #: ../src/guestfs-actions.pod:5846
15395 " guestfs_set_autosync (guestfs_h *g,\n"
15396 " int autosync);\n"
15401 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3941
15403 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15404 "effort attempt to make filesystems consistent and synchronized when the "
15405 "handle is closed (also if the program exits without closing handles)."
15409 #: ../src/guestfs-actions.pod:5855 ../fish/guestfish-actions.pod:3946
15411 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15412 "disabled by default)."
15416 #: ../src/guestfs-actions.pod:5862
15417 msgid "guestfs_set_direct"
15421 #: ../src/guestfs-actions.pod:5864
15425 " guestfs_set_direct (guestfs_h *g,\n"
15431 #: ../src/guestfs-actions.pod:5868 ../fish/guestfish-actions.pod:3955
15433 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15434 "passed directly through to the appliance once it is launched."
15438 #: ../src/guestfs-actions.pod:5872
15440 "One consequence of this is that log messages aren't caught by the library "
15441 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15446 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3963
15447 msgid "You probably don't want to use this unless you know what you are doing."
15451 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3966
15452 msgid "The default is disabled."
15456 #: ../src/guestfs-actions.pod:5885
15457 msgid "guestfs_set_e2label"
15461 #: ../src/guestfs-actions.pod:5887
15465 " guestfs_set_e2label (guestfs_h *g,\n"
15466 " const char *device,\n"
15467 " const char *label);\n"
15472 #: ../src/guestfs-actions.pod:5892 ../fish/guestfish-actions.pod:3972
15474 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15475 "C<label>. Filesystem labels are limited to 16 characters."
15479 #: ../src/guestfs-actions.pod:5896
15481 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15482 "the existing label on a filesystem."
15486 #: ../src/guestfs-actions.pod:5903
15487 msgid "guestfs_set_e2uuid"
15491 #: ../src/guestfs-actions.pod:5905
15495 " guestfs_set_e2uuid (guestfs_h *g,\n"
15496 " const char *device,\n"
15497 " const char *uuid);\n"
15502 #: ../src/guestfs-actions.pod:5910 ../fish/guestfish-actions.pod:3983
15504 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15505 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15506 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15510 #: ../src/guestfs-actions.pod:5915
15512 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15513 "the existing UUID of a filesystem."
15517 #: ../src/guestfs-actions.pod:5922
15518 msgid "guestfs_set_memsize"
15522 #: ../src/guestfs-actions.pod:5924
15526 " guestfs_set_memsize (guestfs_h *g,\n"
15532 #: ../src/guestfs-actions.pod:5928
15534 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15535 "This only has any effect if called before C<guestfs_launch>."
15539 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:4001
15541 "You can also change this by setting the environment variable "
15542 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15546 #: ../src/guestfs-actions.pod:5943
15547 msgid "guestfs_set_network"
15551 #: ../src/guestfs-actions.pod:5945
15555 " guestfs_set_network (guestfs_h *g,\n"
15561 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4014
15563 "If C<network> is true, then the network is enabled in the libguestfs "
15564 "appliance. The default is false."
15568 #: ../src/guestfs-actions.pod:5952 ../fish/guestfish-actions.pod:4017
15570 "This affects whether commands are able to access the network (see "
15571 "L<guestfs(3)/RUNNING COMMANDS>)."
15575 #: ../src/guestfs-actions.pod:5955
15577 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15582 #: ../src/guestfs-actions.pod:5962
15583 msgid "guestfs_set_path"
15587 #: ../src/guestfs-actions.pod:5964
15591 " guestfs_set_path (guestfs_h *g,\n"
15592 " const char *searchpath);\n"
15597 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:4029
15598 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15602 #: ../src/guestfs-actions.pod:5970 ../fish/guestfish-actions.pod:4031
15604 "The default is C<$libdir/guestfs> unless overridden by setting "
15605 "C<LIBGUESTFS_PATH> environment variable."
15609 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4034
15610 msgid "Setting C<path> to C<NULL> restores the default path."
15614 #: ../src/guestfs-actions.pod:5979
15615 msgid "guestfs_set_qemu"
15619 #: ../src/guestfs-actions.pod:5981
15623 " guestfs_set_qemu (guestfs_h *g,\n"
15624 " const char *qemu);\n"
15629 #: ../src/guestfs-actions.pod:5985 ../fish/guestfish-actions.pod:4042
15630 msgid "Set the qemu binary that we will use."
15634 #: ../src/guestfs-actions.pod:5987 ../fish/guestfish-actions.pod:4044
15635 msgid "The default is chosen when the library was compiled by the configure script."
15639 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:4047
15641 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15646 #: ../src/guestfs-actions.pod:5993 ../fish/guestfish-actions.pod:4050
15647 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15651 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4052
15653 "Note that you should call this function as early as possible after creating "
15654 "the handle. This is because some pre-launch operations depend on testing "
15655 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15656 "don't retest features, and so you might see inconsistent results. Using the "
15657 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15658 "the qemu binary at the same time as the handle is created."
15662 #: ../src/guestfs-actions.pod:6007
15663 msgid "guestfs_set_recovery_proc"
15667 #: ../src/guestfs-actions.pod:6009
15671 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15672 " int recoveryproc);\n"
15677 #: ../src/guestfs-actions.pod:6013
15679 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15680 "not create a recovery process. The purpose of the recovery process is to "
15681 "stop runaway qemu processes in the case where the main program aborts "
15686 #: ../src/guestfs-actions.pod:6018
15688 "This only has any effect if called before C<guestfs_launch>, and the default "
15693 #: ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:4074
15695 "About the only time when you would want to disable this is if the main "
15696 "process will fork itself into the background (\"daemonize\" itself). In "
15697 "this case the recovery process thinks that the main program has disappeared "
15698 "and so kills qemu, which is not very helpful."
15702 #: ../src/guestfs-actions.pod:6031
15703 msgid "guestfs_set_selinux"
15707 #: ../src/guestfs-actions.pod:6033
15711 " guestfs_set_selinux (guestfs_h *g,\n"
15717 #: ../src/guestfs-actions.pod:6037 ../fish/guestfish-actions.pod:4086
15719 "This sets the selinux flag that is passed to the appliance at boot time. "
15720 "The default is C<selinux=0> (disabled)."
15724 #: ../src/guestfs-actions.pod:6040 ../fish/guestfish-actions.pod:4089
15726 "Note that if SELinux is enabled, it is always in Permissive mode "
15727 "(C<enforcing=0>)."
15731 #: ../src/guestfs-actions.pod:6050
15732 msgid "guestfs_set_trace"
15736 #: ../src/guestfs-actions.pod:6052
15740 " guestfs_set_trace (guestfs_h *g,\n"
15746 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4101
15748 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
15749 "return values are traced."
15753 #: ../src/guestfs-actions.pod:6059 ../fish/guestfish-actions.pod:4104
15755 "If you want to trace C API calls into libguestfs (and other libraries) then "
15756 "possibly a better way is to use the external ltrace(1) command."
15760 #: ../src/guestfs-actions.pod:6063 ../fish/guestfish-actions.pod:4108
15762 "Command traces are disabled unless the environment variable "
15763 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
15767 #: ../src/guestfs-actions.pod:6066
15769 "Trace messages are normally sent to C<stderr>, unless you register a "
15770 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15774 #: ../src/guestfs-actions.pod:6074
15775 msgid "guestfs_set_verbose"
15779 #: ../src/guestfs-actions.pod:6076
15783 " guestfs_set_verbose (guestfs_h *g,\n"
15789 #: ../src/guestfs-actions.pod:6080 ../fish/guestfish-actions.pod:4121
15790 msgid "If C<verbose> is true, this turns on verbose messages."
15794 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4123
15796 "Verbose messages are disabled unless the environment variable "
15797 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
15801 #: ../src/guestfs-actions.pod:6085
15803 "Verbose messages are normally sent to C<stderr>, unless you register a "
15804 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15808 #: ../src/guestfs-actions.pod:6093
15809 msgid "guestfs_setcon"
15813 #: ../src/guestfs-actions.pod:6095
15817 " guestfs_setcon (guestfs_h *g,\n"
15818 " const char *context);\n"
15823 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4134
15825 "This sets the SELinux security context of the daemon to the string "
15830 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4137
15831 msgid "See the documentation about SELINUX in L<guestfs(3)>."
15835 #: ../src/guestfs-actions.pod:6108
15836 msgid "guestfs_setxattr"
15840 #: ../src/guestfs-actions.pod:6110
15844 " guestfs_setxattr (guestfs_h *g,\n"
15845 " const char *xattr,\n"
15846 " const char *val,\n"
15848 " const char *path);\n"
15853 #: ../src/guestfs-actions.pod:6117 ../fish/guestfish-actions.pod:4143
15855 "This call sets the extended attribute named C<xattr> of the file C<path> to "
15856 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
15860 #: ../src/guestfs-actions.pod:6121
15861 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
15865 #: ../src/guestfs-actions.pod:6127
15866 msgid "guestfs_sfdisk"
15870 #: ../src/guestfs-actions.pod:6129
15874 " guestfs_sfdisk (guestfs_h *g,\n"
15875 " const char *device,\n"
15879 " char *const *lines);\n"
15884 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4153
15886 "This is a direct interface to the L<sfdisk(8)> program for creating "
15887 "partitions on block devices."
15891 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4156
15892 msgid "C<device> should be a block device, for example C</dev/sda>."
15896 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4158
15898 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
15899 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
15900 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
15901 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
15902 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
15903 "the kernel) cannot work out the right geometry and you will need to tell it."
15907 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4166
15909 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
15910 "refer to the L<sfdisk(8)> manpage."
15914 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4169
15916 "To create a single partition occupying the whole disk, you would pass "
15917 "C<lines> as a single element list, when the single element being the string "
15922 #: ../src/guestfs-actions.pod:6157
15923 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
15927 #: ../src/guestfs-actions.pod:6165 ../src/guestfs-actions.pod:6195 ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4179 ../fish/guestfish-actions.pod:4202 ../fish/guestfish-actions.pod:4224
15928 msgid "This function is deprecated. In new code, use the C<part_add> call instead."
15932 #: ../src/guestfs-actions.pod:6174
15933 msgid "guestfs_sfdiskM"
15937 #: ../src/guestfs-actions.pod:6176
15941 " guestfs_sfdiskM (guestfs_h *g,\n"
15942 " const char *device,\n"
15943 " char *const *lines);\n"
15948 #: ../src/guestfs-actions.pod:6181
15950 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
15951 "partition sizes are specified in megabytes only (rounded to the nearest "
15952 "cylinder) and you don't need to specify the cyls, heads and sectors "
15953 "parameters which were rarely if ever used anyway."
15957 #: ../src/guestfs-actions.pod:6187
15959 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
15960 "C<guestfs_part_disk>"
15964 #: ../src/guestfs-actions.pod:6204
15965 msgid "guestfs_sfdisk_N"
15969 #: ../src/guestfs-actions.pod:6206
15973 " guestfs_sfdisk_N (guestfs_h *g,\n"
15974 " const char *device,\n"
15979 " const char *line);\n"
15984 #: ../src/guestfs-actions.pod:6215 ../fish/guestfish-actions.pod:4213
15986 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15987 "(note: C<n> counts from 1)."
15991 #: ../src/guestfs-actions.pod:6218
15993 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
15994 "for the cyls/heads/sectors parameters."
15998 #: ../src/guestfs-actions.pod:6221
15999 msgid "See also: C<guestfs_part_add>"
16003 #: ../src/guestfs-actions.pod:6237
16004 msgid "guestfs_sfdisk_disk_geometry"
16008 #: ../src/guestfs-actions.pod:6239
16012 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16013 " const char *device);\n"
16018 #: ../src/guestfs-actions.pod:6243
16020 "This displays the disk geometry of C<device> read from the partition table. "
16021 "Especially in the case where the underlying block device has been resized, "
16022 "this can be different from the kernel's idea of the geometry (see "
16023 "C<guestfs_sfdisk_kernel_geometry>)."
16027 #: ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4240 ../fish/guestfish-actions.pod:4249
16028 msgid "The result is in human-readable format, and not designed to be parsed."
16032 #: ../src/guestfs-actions.pod:6256
16033 msgid "guestfs_sfdisk_kernel_geometry"
16037 #: ../src/guestfs-actions.pod:6258
16041 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16042 " const char *device);\n"
16047 #: ../src/guestfs-actions.pod:6262 ../fish/guestfish-actions.pod:4247
16048 msgid "This displays the kernel's idea of the geometry of C<device>."
16052 #: ../src/guestfs-actions.pod:6272
16053 msgid "guestfs_sfdisk_l"
16057 #: ../src/guestfs-actions.pod:6274
16061 " guestfs_sfdisk_l (guestfs_h *g,\n"
16062 " const char *device);\n"
16067 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4256
16069 "This displays the partition table on C<device>, in the human-readable output "
16070 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16074 #: ../src/guestfs-actions.pod:6282
16075 msgid "See also: C<guestfs_part_list>"
16079 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4262
16081 "This function is deprecated. In new code, use the C<part_list> call "
16086 #: ../src/guestfs-actions.pod:6296
16091 #: ../src/guestfs-actions.pod:6298
16095 " guestfs_sh (guestfs_h *g,\n"
16096 " const char *command);\n"
16101 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4273
16103 "This call runs a command from the guest filesystem via the guest's "
16108 #: ../src/guestfs-actions.pod:6305
16109 msgid "This is like C<guestfs_command>, but passes the command to:"
16113 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4278
16116 " /bin/sh -c \"command\"\n"
16121 #: ../src/guestfs-actions.pod:6309 ../fish/guestfish-actions.pod:4280
16123 "Depending on the guest's shell, this usually results in wildcards being "
16124 "expanded, shell expressions being interpolated and so on."
16128 #: ../src/guestfs-actions.pod:6313
16129 msgid "All the provisos about C<guestfs_command> apply to this call."
16133 #: ../src/guestfs-actions.pod:6320
16134 msgid "guestfs_sh_lines"
16138 #: ../src/guestfs-actions.pod:6322
16142 " guestfs_sh_lines (guestfs_h *g,\n"
16143 " const char *command);\n"
16148 #: ../src/guestfs-actions.pod:6326
16150 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16155 #: ../src/guestfs-actions.pod:6329
16156 msgid "See also: C<guestfs_command_lines>"
16160 #: ../src/guestfs-actions.pod:6337
16161 msgid "guestfs_sleep"
16165 #: ../src/guestfs-actions.pod:6339
16169 " guestfs_sleep (guestfs_h *g,\n"
16175 #: ../src/guestfs-actions.pod:6343 ../fish/guestfish-actions.pod:4299
16176 msgid "Sleep for C<secs> seconds."
16180 #: ../src/guestfs-actions.pod:6347
16181 msgid "(Added in 1.0.41)"
16185 #: ../src/guestfs-actions.pod:6349 ../src/guestfs-structs.pod:109
16186 msgid "guestfs_stat"
16190 #: ../src/guestfs-actions.pod:6351
16193 " struct guestfs_stat *\n"
16194 " guestfs_stat (guestfs_h *g,\n"
16195 " const char *path);\n"
16200 #: ../src/guestfs-actions.pod:6357 ../fish/guestfish-actions.pod:4307
16201 msgid "This is the same as the C<stat(2)> system call."
16205 #: ../src/guestfs-actions.pod:6365 ../src/guestfs-structs.pod:135
16206 msgid "guestfs_statvfs"
16210 #: ../src/guestfs-actions.pod:6367
16213 " struct guestfs_statvfs *\n"
16214 " guestfs_statvfs (guestfs_h *g,\n"
16215 " const char *path);\n"
16220 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4313
16222 "Returns file system statistics for any mounted file system. C<path> should "
16223 "be a file or directory in the mounted file system (typically it is the mount "
16224 "point itself, but it doesn't need to be)."
16228 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4317
16229 msgid "This is the same as the C<statvfs(2)> system call."
16233 #: ../src/guestfs-actions.pod:6377
16235 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16236 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16240 #: ../src/guestfs-actions.pod:6383
16241 msgid "guestfs_strings"
16245 #: ../src/guestfs-actions.pod:6385
16249 " guestfs_strings (guestfs_h *g,\n"
16250 " const char *path);\n"
16255 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4323
16257 "This runs the L<strings(1)> command on a file and returns the list of "
16258 "printable strings found."
16262 #: ../src/guestfs-actions.pod:6401
16263 msgid "guestfs_strings_e"
16267 #: ../src/guestfs-actions.pod:6403
16271 " guestfs_strings_e (guestfs_h *g,\n"
16272 " const char *encoding,\n"
16273 " const char *path);\n"
16278 #: ../src/guestfs-actions.pod:6408
16280 "This is like the C<guestfs_strings> command, but allows you to specify the "
16281 "encoding of strings that are looked for in the source file C<path>."
16285 #: ../src/guestfs-actions.pod:6412 ../fish/guestfish-actions.pod:4337
16286 msgid "Allowed encodings are:"
16290 #: ../src/guestfs-actions.pod:6416 ../fish/guestfish-actions.pod:4341
16295 #: ../src/guestfs-actions.pod:6418
16297 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16298 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16302 #: ../src/guestfs-actions.pod:6421 ../fish/guestfish-actions.pod:4346
16307 #: ../src/guestfs-actions.pod:6423 ../fish/guestfish-actions.pod:4348
16308 msgid "Single 8-bit-byte characters."
16312 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4350
16317 #: ../src/guestfs-actions.pod:6427 ../fish/guestfish-actions.pod:4352
16318 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16322 #: ../src/guestfs-actions.pod:6430 ../fish/guestfish-actions.pod:4355
16323 msgid "l (lower case letter L)"
16327 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4357
16329 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16330 "examining binaries in Windows guests."
16334 #: ../src/guestfs-actions.pod:6435 ../fish/guestfish-actions.pod:4360
16339 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4362
16340 msgid "32-bit big endian such as UCS-4BE."
16344 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4364
16349 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4366
16350 msgid "32-bit little endian such as UCS-4LE."
16354 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4370
16355 msgid "The returned strings are transcoded to UTF-8."
16359 #: ../src/guestfs-actions.pod:6456
16360 msgid "guestfs_swapoff_device"
16364 #: ../src/guestfs-actions.pod:6458
16368 " guestfs_swapoff_device (guestfs_h *g,\n"
16369 " const char *device);\n"
16374 #: ../src/guestfs-actions.pod:6462
16376 "This command disables the libguestfs appliance swap device or partition "
16377 "named C<device>. See C<guestfs_swapon_device>."
16381 #: ../src/guestfs-actions.pod:6470
16382 msgid "guestfs_swapoff_file"
16386 #: ../src/guestfs-actions.pod:6472
16390 " guestfs_swapoff_file (guestfs_h *g,\n"
16391 " const char *file);\n"
16396 #: ../src/guestfs-actions.pod:6476 ../fish/guestfish-actions.pod:4387
16397 msgid "This command disables the libguestfs appliance swap on file."
16401 #: ../src/guestfs-actions.pod:6482
16402 msgid "guestfs_swapoff_label"
16406 #: ../src/guestfs-actions.pod:6484
16410 " guestfs_swapoff_label (guestfs_h *g,\n"
16411 " const char *label);\n"
16416 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4393
16418 "This command disables the libguestfs appliance swap on labeled swap "
16423 #: ../src/guestfs-actions.pod:6495
16424 msgid "guestfs_swapoff_uuid"
16428 #: ../src/guestfs-actions.pod:6497
16432 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16433 " const char *uuid);\n"
16438 #: ../src/guestfs-actions.pod:6501 ../fish/guestfish-actions.pod:4400
16440 "This command disables the libguestfs appliance swap partition with the given "
16445 #: ../src/guestfs-actions.pod:6508
16446 msgid "guestfs_swapon_device"
16450 #: ../src/guestfs-actions.pod:6510
16454 " guestfs_swapon_device (guestfs_h *g,\n"
16455 " const char *device);\n"
16460 #: ../src/guestfs-actions.pod:6514
16462 "This command enables the libguestfs appliance to use the swap device or "
16463 "partition named C<device>. The increased memory is made available for all "
16464 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16468 #: ../src/guestfs-actions.pod:6519 ../fish/guestfish-actions.pod:4412
16470 "Note that you should not swap to existing guest swap partitions unless you "
16471 "know what you are doing. They may contain hibernation information, or other "
16472 "information that the guest doesn't want you to trash. You also risk leaking "
16473 "information about the host to the guest this way. Instead, attach a new "
16474 "host device to the guest and swap on that."
16478 #: ../src/guestfs-actions.pod:6530
16479 msgid "guestfs_swapon_file"
16483 #: ../src/guestfs-actions.pod:6532
16487 " guestfs_swapon_file (guestfs_h *g,\n"
16488 " const char *file);\n"
16493 #: ../src/guestfs-actions.pod:6536
16495 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16500 #: ../src/guestfs-actions.pod:6543
16501 msgid "guestfs_swapon_label"
16505 #: ../src/guestfs-actions.pod:6545
16509 " guestfs_swapon_label (guestfs_h *g,\n"
16510 " const char *label);\n"
16515 #: ../src/guestfs-actions.pod:6549
16517 "This command enables swap to a labeled swap partition. See "
16518 "C<guestfs_swapon_device> for other notes."
16522 #: ../src/guestfs-actions.pod:6556
16523 msgid "guestfs_swapon_uuid"
16527 #: ../src/guestfs-actions.pod:6558
16531 " guestfs_swapon_uuid (guestfs_h *g,\n"
16532 " const char *uuid);\n"
16537 #: ../src/guestfs-actions.pod:6562
16539 "This command enables swap to a swap partition with the given UUID. See "
16540 "C<guestfs_swapon_device> for other notes."
16544 #: ../src/guestfs-actions.pod:6569
16545 msgid "guestfs_sync"
16549 #: ../src/guestfs-actions.pod:6571
16553 " guestfs_sync (guestfs_h *g);\n"
16558 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4444
16560 "This syncs the disk, so that any writes are flushed through to the "
16561 "underlying disk image."
16565 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4447
16567 "You should always call this if you have modified a disk image, before "
16568 "closing the handle."
16572 #: ../src/guestfs-actions.pod:6584
16573 msgid "guestfs_tail"
16577 #: ../src/guestfs-actions.pod:6586
16581 " guestfs_tail (guestfs_h *g,\n"
16582 " const char *path);\n"
16587 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4454
16588 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16592 #: ../src/guestfs-actions.pod:6602
16593 msgid "guestfs_tail_n"
16597 #: ../src/guestfs-actions.pod:6604
16601 " guestfs_tail_n (guestfs_h *g,\n"
16603 " const char *path);\n"
16608 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4464
16610 "If the parameter C<nrlines> is a positive number, this returns the last "
16611 "C<nrlines> lines of the file C<path>."
16615 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4467
16617 "If the parameter C<nrlines> is a negative number, this returns lines from "
16618 "the file C<path>, starting with the C<-nrlines>th line."
16622 #: ../src/guestfs-actions.pod:6626
16623 msgid "guestfs_tar_in"
16627 #: ../src/guestfs-actions.pod:6628
16631 " guestfs_tar_in (guestfs_h *g,\n"
16632 " const char *tarfile,\n"
16633 " const char *directory);\n"
16638 #: ../src/guestfs-actions.pod:6633 ../fish/guestfish-actions.pod:4479
16640 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16641 "tar file) into C<directory>."
16645 #: ../src/guestfs-actions.pod:6636
16646 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16650 #: ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6690
16651 msgid "(Added in 1.0.3)"
16655 #: ../src/guestfs-actions.pod:6643
16656 msgid "guestfs_tar_out"
16660 #: ../src/guestfs-actions.pod:6645
16664 " guestfs_tar_out (guestfs_h *g,\n"
16665 " const char *directory,\n"
16666 " const char *tarfile);\n"
16671 #: ../src/guestfs-actions.pod:6650 ../fish/guestfish-actions.pod:4491
16673 "This command packs the contents of C<directory> and downloads it to local "
16678 #: ../src/guestfs-actions.pod:6653
16680 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16681 "C<guestfs_txz_out>."
16685 #: ../src/guestfs-actions.pod:6660
16686 msgid "guestfs_tgz_in"
16690 #: ../src/guestfs-actions.pod:6662
16694 " guestfs_tgz_in (guestfs_h *g,\n"
16695 " const char *tarball,\n"
16696 " const char *directory);\n"
16701 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4503
16703 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
16704 "tar file) into C<directory>."
16708 #: ../src/guestfs-actions.pod:6670
16709 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
16713 #: ../src/guestfs-actions.pod:6676
16714 msgid "guestfs_tgz_out"
16718 #: ../src/guestfs-actions.pod:6678
16722 " guestfs_tgz_out (guestfs_h *g,\n"
16723 " const char *directory,\n"
16724 " const char *tarball);\n"
16729 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4514
16731 "This command packs the contents of C<directory> and downloads it to local "
16736 #: ../src/guestfs-actions.pod:6686
16737 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
16741 #: ../src/guestfs-actions.pod:6692
16742 msgid "guestfs_touch"
16746 #: ../src/guestfs-actions.pod:6694
16750 " guestfs_touch (guestfs_h *g,\n"
16751 " const char *path);\n"
16756 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4525
16758 "Touch acts like the L<touch(1)> command. It can be used to update the "
16759 "timestamps on a file, or, if the file does not exist, to create a new "
16760 "zero-length file."
16764 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4529
16766 "This command only works on regular files, and will fail on other file types "
16767 "such as directories, symbolic links, block special etc."
16771 #: ../src/guestfs-actions.pod:6709
16772 msgid "guestfs_truncate"
16776 #: ../src/guestfs-actions.pod:6711
16780 " guestfs_truncate (guestfs_h *g,\n"
16781 " const char *path);\n"
16786 #: ../src/guestfs-actions.pod:6715 ../fish/guestfish-actions.pod:4536
16788 "This command truncates C<path> to a zero-length file. The file must exist "
16793 #: ../src/guestfs-actions.pod:6722
16794 msgid "guestfs_truncate_size"
16798 #: ../src/guestfs-actions.pod:6724
16802 " guestfs_truncate_size (guestfs_h *g,\n"
16803 " const char *path,\n"
16804 " int64_t size);\n"
16809 #: ../src/guestfs-actions.pod:6729 ../fish/guestfish-actions.pod:4543
16811 "This command truncates C<path> to size C<size> bytes. The file must exist "
16816 #: ../src/guestfs-actions.pod:6732
16818 "If the current file size is less than C<size> then the file is extended to "
16819 "the required size with zero bytes. This creates a sparse file (ie. disk "
16820 "blocks are not allocated for the file until you write to it). To create a "
16821 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
16825 #: ../src/guestfs-actions.pod:6742
16826 msgid "guestfs_tune2fs_l"
16830 #: ../src/guestfs-actions.pod:6744
16834 " guestfs_tune2fs_l (guestfs_h *g,\n"
16835 " const char *device);\n"
16840 #: ../src/guestfs-actions.pod:6748 ../fish/guestfish-actions.pod:4556
16842 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
16847 #: ../src/guestfs-actions.pod:6751 ../fish/guestfish-actions.pod:4559
16849 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
16850 "for more details. The list of fields returned isn't clearly defined, and "
16851 "depends on both the version of C<tune2fs> that libguestfs was built against, "
16852 "and the filesystem itself."
16856 #: ../src/guestfs-actions.pod:6764
16857 msgid "guestfs_txz_in"
16861 #: ../src/guestfs-actions.pod:6766
16865 " guestfs_txz_in (guestfs_h *g,\n"
16866 " const char *tarball,\n"
16867 " const char *directory);\n"
16872 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4568
16874 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
16875 "tar file) into C<directory>."
16879 #: ../src/guestfs-actions.pod:6778
16880 msgid "guestfs_txz_out"
16884 #: ../src/guestfs-actions.pod:6780
16888 " guestfs_txz_out (guestfs_h *g,\n"
16889 " const char *directory,\n"
16890 " const char *tarball);\n"
16895 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4577
16897 "This command packs the contents of C<directory> and downloads it to local "
16898 "file C<tarball> (as an xz compressed tar archive)."
16902 #: ../src/guestfs-actions.pod:6792
16903 msgid "guestfs_umask"
16907 #: ../src/guestfs-actions.pod:6794
16911 " guestfs_umask (guestfs_h *g,\n"
16917 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4586
16919 "This function sets the mask used for creating new files and device nodes to "
16924 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4589
16926 "Typical umask values would be C<022> which creates new files with "
16927 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
16928 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
16932 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4594
16934 "The default umask is C<022>. This is important because it means that "
16935 "directories and device nodes will be created with C<0644> or C<0755> mode "
16936 "even if you specify C<0777>."
16940 #: ../src/guestfs-actions.pod:6810
16942 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
16943 "C<guestfs_mkdir>."
16947 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4601
16948 msgid "This call returns the previous umask."
16952 #: ../src/guestfs-actions.pod:6819
16953 msgid "guestfs_umount"
16957 #: ../src/guestfs-actions.pod:6821
16961 " guestfs_umount (guestfs_h *g,\n"
16962 " const char *pathordevice);\n"
16967 #: ../src/guestfs-actions.pod:6825 ../fish/guestfish-actions.pod:4609
16969 "This unmounts the given filesystem. The filesystem may be specified either "
16970 "by its mountpoint (path) or the device which contains the filesystem."
16974 #: ../src/guestfs-actions.pod:6833
16975 msgid "guestfs_umount_all"
16979 #: ../src/guestfs-actions.pod:6835
16983 " guestfs_umount_all (guestfs_h *g);\n"
16988 #: ../src/guestfs-actions.pod:6838 ../fish/guestfish-actions.pod:4619
16989 msgid "This unmounts all mounted filesystems."
16993 #: ../src/guestfs-actions.pod:6840 ../fish/guestfish-actions.pod:4621
16994 msgid "Some internal mounts are not unmounted by this call."
16998 #: ../src/guestfs-actions.pod:6846
16999 msgid "guestfs_upload"
17003 #: ../src/guestfs-actions.pod:6848
17007 " guestfs_upload (guestfs_h *g,\n"
17008 " const char *filename,\n"
17009 " const char *remotefilename);\n"
17014 #: ../src/guestfs-actions.pod:6853 ../src/guestfs-actions.pod:6877 ../fish/guestfish-actions.pod:4627 ../fish/guestfish-actions.pod:4640
17015 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17019 #: ../src/guestfs-actions.pod:6858
17020 msgid "See also C<guestfs_download>."
17024 #: ../src/guestfs-actions.pod:6869
17025 msgid "guestfs_upload_offset"
17029 #: ../src/guestfs-actions.pod:6871
17033 " guestfs_upload_offset (guestfs_h *g,\n"
17034 " const char *filename,\n"
17035 " const char *remotefilename,\n"
17036 " int64_t offset);\n"
17041 #: ../src/guestfs-actions.pod:6880 ../fish/guestfish-actions.pod:4643
17043 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17044 "The intention is to overwrite parts of existing files or devices, although "
17045 "if a non-existant file is specified then it is created with a \"hole\" "
17046 "before C<offset>. The size of the data written is implicit in the size of "
17047 "the source C<filename>."
17051 #: ../src/guestfs-actions.pod:6887
17053 "Note that there is no limit on the amount of data that can be uploaded with "
17054 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17055 "full amount unless an error occurs."
17059 #: ../src/guestfs-actions.pod:6892
17060 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17064 #: ../src/guestfs-actions.pod:6903
17065 msgid "guestfs_utimens"
17069 #: ../src/guestfs-actions.pod:6905
17073 " guestfs_utimens (guestfs_h *g,\n"
17074 " const char *path,\n"
17075 " int64_t atsecs,\n"
17076 " int64_t atnsecs,\n"
17077 " int64_t mtsecs,\n"
17078 " int64_t mtnsecs);\n"
17083 #: ../src/guestfs-actions.pod:6913 ../fish/guestfish-actions.pod:4663
17084 msgid "This command sets the timestamps of a file with nanosecond precision."
17088 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4666
17090 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17095 #: ../src/guestfs-actions.pod:6919 ../fish/guestfish-actions.pod:4669
17097 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17098 "nanoseconds from the epoch."
17102 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4672
17104 "If the C<*nsecs> field contains the special value C<-1> then the "
17105 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17106 "ignored in this case)."
17110 #: ../src/guestfs-actions.pod:6926 ../fish/guestfish-actions.pod:4676
17112 "If the C<*nsecs> field contains the special value C<-2> then the "
17113 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17118 #: ../src/guestfs-actions.pod:6934 ../src/guestfs-structs.pod:175
17119 msgid "guestfs_version"
17123 #: ../src/guestfs-actions.pod:6936
17126 " struct guestfs_version *\n"
17127 " guestfs_version (guestfs_h *g);\n"
17132 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4684
17133 msgid "Return the libguestfs version number that the program is linked against."
17137 #: ../src/guestfs-actions.pod:6942 ../fish/guestfish-actions.pod:4687
17139 "Note that because of dynamic linking this is not necessarily the version of "
17140 "libguestfs that you compiled against. You can compile the program, and then "
17141 "at runtime dynamically link against a completely different C<libguestfs.so> "
17146 #: ../src/guestfs-actions.pod:6947 ../fish/guestfish-actions.pod:4692
17148 "This call was added in version C<1.0.58>. In previous versions of "
17149 "libguestfs there was no way to get the version number. From C code you can "
17150 "use dynamic linker functions to find out if this symbol exists (if it "
17151 "doesn't, then it's an earlier version)."
17155 #: ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:4698
17157 "The call returns a structure with four elements. The first three (C<major>, "
17158 "C<minor> and C<release>) are numbers and correspond to the usual version "
17159 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17160 "but may be used for distro-specific information."
17164 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4704
17165 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
17169 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4707
17170 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17174 #: ../src/guestfs-actions.pod:6964
17176 "I<Note:> Don't use this call to test for availability of features. In "
17177 "enterprise distributions we backport features from later versions into "
17178 "earlier versions, making this an unreliable way to test for features. Use "
17179 "C<guestfs_available> instead."
17183 #: ../src/guestfs-actions.pod:6970
17185 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17186 "error. I<The caller must call C<guestfs_free_version> after use>."
17190 #: ../src/guestfs-actions.pod:6974
17191 msgid "(Added in 1.0.58)"
17195 #: ../src/guestfs-actions.pod:6976
17196 msgid "guestfs_vfs_label"
17200 #: ../src/guestfs-actions.pod:6978
17204 " guestfs_vfs_label (guestfs_h *g,\n"
17205 " const char *device);\n"
17210 #: ../src/guestfs-actions.pod:6982 ../fish/guestfish-actions.pod:4719
17211 msgid "This returns the filesystem label of the filesystem on C<device>."
17215 #: ../src/guestfs-actions.pod:6985 ../fish/guestfish-actions.pod:4722
17216 msgid "If the filesystem is unlabeled, this returns the empty string."
17220 #: ../src/guestfs-actions.pod:6987
17221 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17225 #: ../src/guestfs-actions.pod:6992 ../src/guestfs-actions.pod:7029
17226 msgid "(Added in 1.3.18)"
17230 #: ../src/guestfs-actions.pod:6994
17231 msgid "guestfs_vfs_type"
17235 #: ../src/guestfs-actions.pod:6996
17239 " guestfs_vfs_type (guestfs_h *g,\n"
17240 " const char *device);\n"
17245 #: ../src/guestfs-actions.pod:7000 ../fish/guestfish-actions.pod:4730
17247 "This command gets the filesystem type corresponding to the filesystem on "
17252 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4733
17254 "For most filesystems, the result is the name of the Linux VFS module which "
17255 "would be used to mount this filesystem if you mounted it without specifying "
17256 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17260 #: ../src/guestfs-actions.pod:7013
17261 msgid "guestfs_vfs_uuid"
17265 #: ../src/guestfs-actions.pod:7015
17269 " guestfs_vfs_uuid (guestfs_h *g,\n"
17270 " const char *device);\n"
17275 #: ../src/guestfs-actions.pod:7019 ../fish/guestfish-actions.pod:4742
17276 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17280 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4745
17281 msgid "If the filesystem does not have a UUID, this returns the empty string."
17285 #: ../src/guestfs-actions.pod:7024
17286 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17290 #: ../src/guestfs-actions.pod:7031
17291 msgid "guestfs_vg_activate"
17295 #: ../src/guestfs-actions.pod:7033
17299 " guestfs_vg_activate (guestfs_h *g,\n"
17301 " char *const *volgroups);\n"
17306 #: ../src/guestfs-actions.pod:7038 ../fish/guestfish-actions.pod:4753
17308 "This command activates or (if C<activate> is false) deactivates all logical "
17309 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17310 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17311 "deactivated, then those devices disappear."
17315 #: ../src/guestfs-actions.pod:7044 ../fish/guestfish-actions.pod:4759
17316 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17320 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4761
17322 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17323 "activated or deactivated."
17327 #: ../src/guestfs-actions.pod:7053
17328 msgid "guestfs_vg_activate_all"
17332 #: ../src/guestfs-actions.pod:7055
17336 " guestfs_vg_activate_all (guestfs_h *g,\n"
17337 " int activate);\n"
17342 #: ../src/guestfs-actions.pod:7059 ../fish/guestfish-actions.pod:4768
17344 "This command activates or (if C<activate> is false) deactivates all logical "
17345 "volumes in all volume groups. If activated, then they are made known to the "
17346 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17347 "those devices disappear."
17351 #: ../src/guestfs-actions.pod:7065 ../fish/guestfish-actions.pod:4774
17352 msgid "This command is the same as running C<vgchange -a y|n>"
17356 #: ../src/guestfs-actions.pod:7071
17357 msgid "guestfs_vgcreate"
17361 #: ../src/guestfs-actions.pod:7073
17365 " guestfs_vgcreate (guestfs_h *g,\n"
17366 " const char *volgroup,\n"
17367 " char *const *physvols);\n"
17372 #: ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:4780
17374 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17375 "of physical volumes C<physvols>."
17379 #: ../src/guestfs-actions.pod:7085
17380 msgid "guestfs_vglvuuids"
17384 #: ../src/guestfs-actions.pod:7087
17388 " guestfs_vglvuuids (guestfs_h *g,\n"
17389 " const char *vgname);\n"
17394 #: ../src/guestfs-actions.pod:7091 ../fish/guestfish-actions.pod:4787
17396 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17397 "volumes created in this volume group."
17401 #: ../src/guestfs-actions.pod:7094
17403 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17404 "associate logical volumes and volume groups."
17408 #: ../src/guestfs-actions.pod:7097
17409 msgid "See also C<guestfs_vgpvuuids>."
17413 #: ../src/guestfs-actions.pod:7105
17414 msgid "guestfs_vgpvuuids"
17418 #: ../src/guestfs-actions.pod:7107
17422 " guestfs_vgpvuuids (guestfs_h *g,\n"
17423 " const char *vgname);\n"
17428 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4799
17430 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17431 "volumes that this volume group resides on."
17435 #: ../src/guestfs-actions.pod:7114
17437 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17438 "associate physical volumes and volume groups."
17442 #: ../src/guestfs-actions.pod:7117
17443 msgid "See also C<guestfs_vglvuuids>."
17447 #: ../src/guestfs-actions.pod:7125
17448 msgid "guestfs_vgremove"
17452 #: ../src/guestfs-actions.pod:7127
17456 " guestfs_vgremove (guestfs_h *g,\n"
17457 " const char *vgname);\n"
17462 #: ../src/guestfs-actions.pod:7131 ../fish/guestfish-actions.pod:4811
17463 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17467 #: ../src/guestfs-actions.pod:7133 ../fish/guestfish-actions.pod:4813
17468 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17472 #: ../src/guestfs-actions.pod:7140
17473 msgid "guestfs_vgrename"
17477 #: ../src/guestfs-actions.pod:7142
17481 " guestfs_vgrename (guestfs_h *g,\n"
17482 " const char *volgroup,\n"
17483 " const char *newvolgroup);\n"
17488 #: ../src/guestfs-actions.pod:7147 ../fish/guestfish-actions.pod:4820
17489 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17493 #: ../src/guestfs-actions.pod:7153
17494 msgid "guestfs_vgs"
17498 #: ../src/guestfs-actions.pod:7155
17502 " guestfs_vgs (guestfs_h *g);\n"
17507 #: ../src/guestfs-actions.pod:7158 ../fish/guestfish-actions.pod:4826
17509 "List all the volumes groups detected. This is the equivalent of the "
17510 "L<vgs(8)> command."
17514 #: ../src/guestfs-actions.pod:7161 ../fish/guestfish-actions.pod:4829
17516 "This returns a list of just the volume group names that were detected "
17517 "(eg. C<VolGroup00>)."
17521 #: ../src/guestfs-actions.pod:7164
17522 msgid "See also C<guestfs_vgs_full>."
17526 #: ../src/guestfs-actions.pod:7172
17527 msgid "guestfs_vgs_full"
17531 #: ../src/guestfs-actions.pod:7174
17534 " struct guestfs_lvm_vg_list *\n"
17535 " guestfs_vgs_full (guestfs_h *g);\n"
17540 #: ../src/guestfs-actions.pod:7177 ../fish/guestfish-actions.pod:4838
17542 "List all the volumes groups detected. This is the equivalent of the "
17543 "L<vgs(8)> command. The \"full\" version includes all fields."
17547 #: ../src/guestfs-actions.pod:7180
17549 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17550 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17555 #: ../src/guestfs-actions.pod:7186
17556 msgid "guestfs_vgscan"
17560 #: ../src/guestfs-actions.pod:7188
17564 " guestfs_vgscan (guestfs_h *g);\n"
17569 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4845
17571 "This rescans all block devices and rebuilds the list of LVM physical "
17572 "volumes, volume groups and logical volumes."
17576 #: ../src/guestfs-actions.pod:7198
17577 msgid "guestfs_vguuid"
17581 #: ../src/guestfs-actions.pod:7200
17585 " guestfs_vguuid (guestfs_h *g,\n"
17586 " const char *vgname);\n"
17591 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4852
17592 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17596 #: ../src/guestfs-actions.pod:7211
17597 msgid "guestfs_wait_ready"
17601 #: ../src/guestfs-actions.pod:7213
17605 " guestfs_wait_ready (guestfs_h *g);\n"
17610 #: ../src/guestfs-actions.pod:7216
17611 msgid "This function is a no op."
17615 #: ../src/guestfs-actions.pod:7218
17617 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17618 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17619 "is no longer necessary because C<guestfs_launch> now does the waiting."
17623 #: ../src/guestfs-actions.pod:7223
17625 "If you see any calls to this function in code then you can just remove them, "
17626 "unless you want to retain compatibility with older versions of the API."
17630 #: ../src/guestfs-actions.pod:7229
17631 msgid "This function is deprecated. In new code, use the C<launch> call instead."
17635 #: ../src/guestfs-actions.pod:7238
17636 msgid "guestfs_wc_c"
17640 #: ../src/guestfs-actions.pod:7240
17644 " guestfs_wc_c (guestfs_h *g,\n"
17645 " const char *path);\n"
17650 #: ../src/guestfs-actions.pod:7244 ../fish/guestfish-actions.pod:4858
17652 "This command counts the characters in a file, using the C<wc -c> external "
17657 #: ../src/guestfs-actions.pod:7251
17658 msgid "guestfs_wc_l"
17662 #: ../src/guestfs-actions.pod:7253
17666 " guestfs_wc_l (guestfs_h *g,\n"
17667 " const char *path);\n"
17672 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4865
17674 "This command counts the lines in a file, using the C<wc -l> external "
17679 #: ../src/guestfs-actions.pod:7264
17680 msgid "guestfs_wc_w"
17684 #: ../src/guestfs-actions.pod:7266
17688 " guestfs_wc_w (guestfs_h *g,\n"
17689 " const char *path);\n"
17694 #: ../src/guestfs-actions.pod:7270 ../fish/guestfish-actions.pod:4872
17696 "This command counts the words in a file, using the C<wc -w> external "
17701 #: ../src/guestfs-actions.pod:7277
17702 msgid "guestfs_write"
17706 #: ../src/guestfs-actions.pod:7279
17710 " guestfs_write (guestfs_h *g,\n"
17711 " const char *path,\n"
17712 " const char *content,\n"
17713 " size_t content_size);\n"
17718 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4879
17720 "This call creates a file called C<path>. The content of the file is the "
17721 "string C<content> (which can contain any 8 bit data)."
17725 #: ../src/guestfs-actions.pod:7295
17726 msgid "guestfs_write_file"
17730 #: ../src/guestfs-actions.pod:7297
17734 " guestfs_write_file (guestfs_h *g,\n"
17735 " const char *path,\n"
17736 " const char *content,\n"
17742 #: ../src/guestfs-actions.pod:7303 ../fish/guestfish-actions.pod:4889
17744 "This call creates a file called C<path>. The contents of the file is the "
17745 "string C<content> (which can contain any 8 bit data), with length C<size>."
17749 #: ../src/guestfs-actions.pod:7307 ../fish/guestfish-actions.pod:4893
17751 "As a special case, if C<size> is C<0> then the length is calculated using "
17752 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
17756 #: ../src/guestfs-actions.pod:7311 ../fish/guestfish-actions.pod:4897
17758 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
17759 "I<not> work, even if the length is specified."
17763 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4903
17764 msgid "This function is deprecated. In new code, use the C<write> call instead."
17768 #: ../src/guestfs-actions.pod:7328
17769 msgid "guestfs_zegrep"
17773 #: ../src/guestfs-actions.pod:7330
17777 " guestfs_zegrep (guestfs_h *g,\n"
17778 " const char *regex,\n"
17779 " const char *path);\n"
17784 #: ../src/guestfs-actions.pod:7335 ../fish/guestfish-actions.pod:4914
17785 msgid "This calls the external C<zegrep> program and returns the matching lines."
17789 #: ../src/guestfs-actions.pod:7347
17790 msgid "guestfs_zegrepi"
17794 #: ../src/guestfs-actions.pod:7349
17798 " guestfs_zegrepi (guestfs_h *g,\n"
17799 " const char *regex,\n"
17800 " const char *path);\n"
17805 #: ../src/guestfs-actions.pod:7354 ../fish/guestfish-actions.pod:4924
17806 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
17810 #: ../src/guestfs-actions.pod:7366
17811 msgid "guestfs_zero"
17815 #: ../src/guestfs-actions.pod:7368
17819 " guestfs_zero (guestfs_h *g,\n"
17820 " const char *device);\n"
17825 #: ../src/guestfs-actions.pod:7372 ../fish/guestfish-actions.pod:4934
17826 msgid "This command writes zeroes over the first few blocks of C<device>."
17830 #: ../src/guestfs-actions.pod:7374 ../fish/guestfish-actions.pod:4936
17832 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
17833 "securely wipe the device). It should be sufficient to remove any partition "
17834 "tables, filesystem superblocks and so on."
17838 #: ../src/guestfs-actions.pod:7378
17839 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
17843 #: ../src/guestfs-actions.pod:7389
17844 msgid "guestfs_zero_device"
17848 #: ../src/guestfs-actions.pod:7391
17852 " guestfs_zero_device (guestfs_h *g,\n"
17853 " const char *device);\n"
17858 #: ../src/guestfs-actions.pod:7395
17860 "This command writes zeroes over the entire C<device>. Compare with "
17861 "C<guestfs_zero> which just zeroes the first few blocks of a device."
17865 #: ../src/guestfs-actions.pod:7409
17866 msgid "(Added in 1.3.1)"
17870 #: ../src/guestfs-actions.pod:7411
17871 msgid "guestfs_zerofree"
17875 #: ../src/guestfs-actions.pod:7413
17879 " guestfs_zerofree (guestfs_h *g,\n"
17880 " const char *device);\n"
17885 #: ../src/guestfs-actions.pod:7417 ../fish/guestfish-actions.pod:4957
17887 "This runs the I<zerofree> program on C<device>. This program claims to zero "
17888 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
17889 "possible to compress the filesystem more effectively."
17893 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4962
17894 msgid "You should B<not> run this program if the filesystem is mounted."
17898 #: ../src/guestfs-actions.pod:7425 ../fish/guestfish-actions.pod:4965
17900 "It is possible that using this program can damage the filesystem or data on "
17905 #: ../src/guestfs-actions.pod:7432
17906 msgid "guestfs_zfgrep"
17910 #: ../src/guestfs-actions.pod:7434
17914 " guestfs_zfgrep (guestfs_h *g,\n"
17915 " const char *pattern,\n"
17916 " const char *path);\n"
17921 #: ../src/guestfs-actions.pod:7439 ../fish/guestfish-actions.pod:4972
17922 msgid "This calls the external C<zfgrep> program and returns the matching lines."
17926 #: ../src/guestfs-actions.pod:7451
17927 msgid "guestfs_zfgrepi"
17931 #: ../src/guestfs-actions.pod:7453
17935 " guestfs_zfgrepi (guestfs_h *g,\n"
17936 " const char *pattern,\n"
17937 " const char *path);\n"
17942 #: ../src/guestfs-actions.pod:7458 ../fish/guestfish-actions.pod:4982
17943 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
17947 #: ../src/guestfs-actions.pod:7470
17948 msgid "guestfs_zfile"
17952 #: ../src/guestfs-actions.pod:7472
17956 " guestfs_zfile (guestfs_h *g,\n"
17957 " const char *meth,\n"
17958 " const char *path);\n"
17963 #: ../src/guestfs-actions.pod:7477 ../fish/guestfish-actions.pod:4992
17964 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
17968 #: ../src/guestfs-actions.pod:7480 ../fish/guestfish-actions.pod:4995
17969 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
17973 #: ../src/guestfs-actions.pod:7482
17975 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
17980 #: ../src/guestfs-actions.pod:7488 ../fish/guestfish-actions.pod:5000
17981 msgid "This function is deprecated. In new code, use the C<file> call instead."
17985 #: ../src/guestfs-actions.pod:7497
17986 msgid "guestfs_zgrep"
17990 #: ../src/guestfs-actions.pod:7499
17994 " guestfs_zgrep (guestfs_h *g,\n"
17995 " const char *regex,\n"
17996 " const char *path);\n"
18001 #: ../src/guestfs-actions.pod:7504 ../fish/guestfish-actions.pod:5011
18002 msgid "This calls the external C<zgrep> program and returns the matching lines."
18006 #: ../src/guestfs-actions.pod:7516
18007 msgid "guestfs_zgrepi"
18011 #: ../src/guestfs-actions.pod:7518
18015 " guestfs_zgrepi (guestfs_h *g,\n"
18016 " const char *regex,\n"
18017 " const char *path);\n"
18022 #: ../src/guestfs-actions.pod:7523 ../fish/guestfish-actions.pod:5021
18023 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
18027 #: ../src/guestfs-availability.pod:3
18032 #: ../src/guestfs-availability.pod:5
18034 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
18035 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
18036 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
18037 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
18038 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
18042 #: ../src/guestfs-availability.pod:21
18047 #: ../src/guestfs-availability.pod:23
18049 "The following functions: L</guestfs_inotify_add_watch> "
18050 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
18051 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18055 #: ../src/guestfs-availability.pod:31
18056 msgid "B<linuxfsuuid>"
18060 #: ../src/guestfs-availability.pod:33
18062 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
18063 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18067 #: ../src/guestfs-availability.pod:40
18068 msgid "B<linuxmodules>"
18072 #: ../src/guestfs-availability.pod:42
18073 msgid "The following functions: L</guestfs_modprobe>"
18077 #: ../src/guestfs-availability.pod:45
18078 msgid "B<linuxxattrs>"
18082 #: ../src/guestfs-availability.pod:47
18084 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
18085 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
18086 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
18087 "L</guestfs_setxattr>"
18091 #: ../src/guestfs-availability.pod:58
18096 #: ../src/guestfs-availability.pod:60
18098 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
18099 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
18100 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18104 #: ../src/guestfs-availability.pod:69
18109 #: ../src/guestfs-availability.pod:71
18111 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
18112 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
18113 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
18114 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
18115 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
18116 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
18117 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
18118 "L</guestfs_vgs_full>"
18122 #: ../src/guestfs-availability.pod:94
18127 #: ../src/guestfs-availability.pod:96
18129 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
18130 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
18134 #: ../src/guestfs-availability.pod:102
18139 #: ../src/guestfs-availability.pod:104
18140 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18144 #: ../src/guestfs-availability.pod:107
18145 msgid "B<ntfsprogs>"
18149 #: ../src/guestfs-availability.pod:109
18150 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18154 #: ../src/guestfs-availability.pod:113
18155 msgid "B<realpath>"
18159 #: ../src/guestfs-availability.pod:115
18160 msgid "The following functions: L</guestfs_realpath>"
18164 #: ../src/guestfs-availability.pod:118
18169 #: ../src/guestfs-availability.pod:120
18171 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
18172 "L</guestfs_scrub_freespace>"
18176 #: ../src/guestfs-availability.pod:125
18181 #: ../src/guestfs-availability.pod:127
18182 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18186 #: ../src/guestfs-availability.pod:131
18191 #: ../src/guestfs-availability.pod:133
18192 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18196 #: ../src/guestfs-availability.pod:137
18197 msgid "B<zerofree>"
18201 #: ../src/guestfs-availability.pod:139
18202 msgid "The following functions: L</guestfs_zerofree>"
18206 #: ../src/guestfs-structs.pod:1
18207 msgid "guestfs_int_bool"
18211 #: ../src/guestfs-structs.pod:3
18214 " struct guestfs_int_bool {\n"
18222 #: ../src/guestfs-structs.pod:8
18225 " struct guestfs_int_bool_list {\n"
18226 " uint32_t len; /* Number of elements in list. */\n"
18227 " struct guestfs_int_bool *val; /* Elements. */\n"
18233 #: ../src/guestfs-structs.pod:13
18236 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18237 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18242 #: ../src/guestfs-structs.pod:16
18243 msgid "guestfs_lvm_pv"
18247 #: ../src/guestfs-structs.pod:18
18250 " struct guestfs_lvm_pv {\n"
18251 " char *pv_name;\n"
18252 " /* The next field is NOT nul-terminated, be careful when printing it: "
18254 " char pv_uuid[32];\n"
18256 " uint64_t pv_size;\n"
18257 " uint64_t dev_size;\n"
18258 " uint64_t pv_free;\n"
18259 " uint64_t pv_used;\n"
18260 " char *pv_attr;\n"
18261 " int64_t pv_pe_count;\n"
18262 " int64_t pv_pe_alloc_count;\n"
18263 " char *pv_tags;\n"
18264 " uint64_t pe_start;\n"
18265 " int64_t pv_mda_count;\n"
18266 " uint64_t pv_mda_free;\n"
18272 #: ../src/guestfs-structs.pod:36
18275 " struct guestfs_lvm_pv_list {\n"
18276 " uint32_t len; /* Number of elements in list. */\n"
18277 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18283 #: ../src/guestfs-structs.pod:41
18286 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18287 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18292 #: ../src/guestfs-structs.pod:44
18293 msgid "guestfs_lvm_vg"
18297 #: ../src/guestfs-structs.pod:46
18300 " struct guestfs_lvm_vg {\n"
18301 " char *vg_name;\n"
18302 " /* The next field is NOT nul-terminated, be careful when printing it: "
18304 " char vg_uuid[32];\n"
18306 " char *vg_attr;\n"
18307 " uint64_t vg_size;\n"
18308 " uint64_t vg_free;\n"
18309 " char *vg_sysid;\n"
18310 " uint64_t vg_extent_size;\n"
18311 " int64_t vg_extent_count;\n"
18312 " int64_t vg_free_count;\n"
18313 " int64_t max_lv;\n"
18314 " int64_t max_pv;\n"
18315 " int64_t pv_count;\n"
18316 " int64_t lv_count;\n"
18317 " int64_t snap_count;\n"
18318 " int64_t vg_seqno;\n"
18319 " char *vg_tags;\n"
18320 " int64_t vg_mda_count;\n"
18321 " uint64_t vg_mda_free;\n"
18327 #: ../src/guestfs-structs.pod:69
18330 " struct guestfs_lvm_vg_list {\n"
18331 " uint32_t len; /* Number of elements in list. */\n"
18332 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18338 #: ../src/guestfs-structs.pod:74
18341 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18342 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18347 #: ../src/guestfs-structs.pod:77
18348 msgid "guestfs_lvm_lv"
18352 #: ../src/guestfs-structs.pod:79
18355 " struct guestfs_lvm_lv {\n"
18356 " char *lv_name;\n"
18357 " /* The next field is NOT nul-terminated, be careful when printing it: "
18359 " char lv_uuid[32];\n"
18360 " char *lv_attr;\n"
18361 " int64_t lv_major;\n"
18362 " int64_t lv_minor;\n"
18363 " int64_t lv_kernel_major;\n"
18364 " int64_t lv_kernel_minor;\n"
18365 " uint64_t lv_size;\n"
18366 " int64_t seg_count;\n"
18368 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18369 " float snap_percent;\n"
18370 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18371 " float copy_percent;\n"
18372 " char *move_pv;\n"
18373 " char *lv_tags;\n"
18374 " char *mirror_log;\n"
18375 " char *modules;\n"
18381 #: ../src/guestfs-structs.pod:101
18384 " struct guestfs_lvm_lv_list {\n"
18385 " uint32_t len; /* Number of elements in list. */\n"
18386 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18392 #: ../src/guestfs-structs.pod:106
18395 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18396 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18401 #: ../src/guestfs-structs.pod:111
18404 " struct guestfs_stat {\n"
18408 " int64_t nlink;\n"
18413 " int64_t blksize;\n"
18414 " int64_t blocks;\n"
18415 " int64_t atime;\n"
18416 " int64_t mtime;\n"
18417 " int64_t ctime;\n"
18423 #: ../src/guestfs-structs.pod:127
18426 " struct guestfs_stat_list {\n"
18427 " uint32_t len; /* Number of elements in list. */\n"
18428 " struct guestfs_stat *val; /* Elements. */\n"
18434 #: ../src/guestfs-structs.pod:132
18437 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18438 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18443 #: ../src/guestfs-structs.pod:137
18446 " struct guestfs_statvfs {\n"
18447 " int64_t bsize;\n"
18448 " int64_t frsize;\n"
18449 " int64_t blocks;\n"
18450 " int64_t bfree;\n"
18451 " int64_t bavail;\n"
18452 " int64_t files;\n"
18453 " int64_t ffree;\n"
18454 " int64_t favail;\n"
18457 " int64_t namemax;\n"
18463 #: ../src/guestfs-structs.pod:151
18466 " struct guestfs_statvfs_list {\n"
18467 " uint32_t len; /* Number of elements in list. */\n"
18468 " struct guestfs_statvfs *val; /* Elements. */\n"
18474 #: ../src/guestfs-structs.pod:156
18477 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18478 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18483 #: ../src/guestfs-structs.pod:159
18484 msgid "guestfs_dirent"
18488 #: ../src/guestfs-structs.pod:161
18491 " struct guestfs_dirent {\n"
18500 #: ../src/guestfs-structs.pod:167
18503 " struct guestfs_dirent_list {\n"
18504 " uint32_t len; /* Number of elements in list. */\n"
18505 " struct guestfs_dirent *val; /* Elements. */\n"
18511 #: ../src/guestfs-structs.pod:172
18514 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18515 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18520 #: ../src/guestfs-structs.pod:177
18523 " struct guestfs_version {\n"
18524 " int64_t major;\n"
18525 " int64_t minor;\n"
18526 " int64_t release;\n"
18533 #: ../src/guestfs-structs.pod:184
18536 " struct guestfs_version_list {\n"
18537 " uint32_t len; /* Number of elements in list. */\n"
18538 " struct guestfs_version *val; /* Elements. */\n"
18544 #: ../src/guestfs-structs.pod:189
18547 " void guestfs_free_version (struct guestfs_free_version *);\n"
18548 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18553 #: ../src/guestfs-structs.pod:192
18554 msgid "guestfs_xattr"
18558 #: ../src/guestfs-structs.pod:194
18561 " struct guestfs_xattr {\n"
18562 " char *attrname;\n"
18563 " /* The next two fields describe a byte array. */\n"
18564 " uint32_t attrval_len;\n"
18565 " char *attrval;\n"
18571 #: ../src/guestfs-structs.pod:201
18574 " struct guestfs_xattr_list {\n"
18575 " uint32_t len; /* Number of elements in list. */\n"
18576 " struct guestfs_xattr *val; /* Elements. */\n"
18582 #: ../src/guestfs-structs.pod:206
18585 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18586 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18591 #: ../src/guestfs-structs.pod:209
18592 msgid "guestfs_inotify_event"
18596 #: ../src/guestfs-structs.pod:211
18599 " struct guestfs_inotify_event {\n"
18600 " int64_t in_wd;\n"
18601 " uint32_t in_mask;\n"
18602 " uint32_t in_cookie;\n"
18603 " char *in_name;\n"
18609 #: ../src/guestfs-structs.pod:218
18612 " struct guestfs_inotify_event_list {\n"
18613 " uint32_t len; /* Number of elements in list. */\n"
18614 " struct guestfs_inotify_event *val; /* Elements. */\n"
18620 #: ../src/guestfs-structs.pod:223
18623 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18624 " void guestfs_free_inotify_event_list (struct "
18625 "guestfs_free_inotify_event_list *);\n"
18630 #: ../src/guestfs-structs.pod:226
18631 msgid "guestfs_partition"
18635 #: ../src/guestfs-structs.pod:228
18638 " struct guestfs_partition {\n"
18639 " int32_t part_num;\n"
18640 " uint64_t part_start;\n"
18641 " uint64_t part_end;\n"
18642 " uint64_t part_size;\n"
18648 #: ../src/guestfs-structs.pod:235
18651 " struct guestfs_partition_list {\n"
18652 " uint32_t len; /* Number of elements in list. */\n"
18653 " struct guestfs_partition *val; /* Elements. */\n"
18659 #: ../src/guestfs-structs.pod:240
18662 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18663 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18668 #: ../src/guestfs-structs.pod:243
18669 msgid "guestfs_application"
18673 #: ../src/guestfs-structs.pod:245
18676 " struct guestfs_application {\n"
18677 " char *app_name;\n"
18678 " char *app_display_name;\n"
18679 " int32_t app_epoch;\n"
18680 " char *app_version;\n"
18681 " char *app_release;\n"
18682 " char *app_install_path;\n"
18683 " char *app_trans_path;\n"
18684 " char *app_publisher;\n"
18685 " char *app_url;\n"
18686 " char *app_source_package;\n"
18687 " char *app_summary;\n"
18688 " char *app_description;\n"
18694 #: ../src/guestfs-structs.pod:260
18697 " struct guestfs_application_list {\n"
18698 " uint32_t len; /* Number of elements in list. */\n"
18699 " struct guestfs_application *val; /* Elements. */\n"
18705 #: ../src/guestfs-structs.pod:265
18708 " void guestfs_free_application (struct guestfs_free_application *);\n"
18709 " void guestfs_free_application_list (struct guestfs_free_application_list "
18715 #: ../fish/guestfish.pod:5
18716 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18720 #: ../fish/guestfish.pod:9
18723 " guestfish [--options] [commands]\n"
18728 #: ../fish/guestfish.pod:11
18736 #: ../fish/guestfish.pod:13
18739 " guestfish [--ro|--rw] -a disk.img\n"
18744 #: ../fish/guestfish.pod:15
18747 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18752 #: ../fish/guestfish.pod:17
18755 " guestfish -d libvirt-domain\n"
18760 #: ../fish/guestfish.pod:19
18763 " guestfish [--ro|--rw] -a disk.img -i\n"
18768 #: ../fish/guestfish.pod:21
18771 " guestfish -d libvirt-domain -i\n"
18776 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
18781 #: ../fish/guestfish.pod:25
18783 "Using guestfish in read/write mode on live virtual machines can be "
18784 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18785 "option to use guestfish safely if the disk image or virtual machine might be "
18790 #: ../fish/guestfish.pod:32
18792 "Guestfish is a shell and command-line tool for examining and modifying "
18793 "virtual machine filesystems. It uses libguestfs and exposes all of the "
18794 "functionality of the guestfs API, see L<guestfs(3)>."
18798 #: ../fish/guestfish.pod:36
18800 "Guestfish gives you structured access to the libguestfs API, from shell "
18801 "scripts or the command line or interactively. If you want to rescue a "
18802 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
18807 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949 ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
18812 #: ../fish/guestfish.pod:43
18813 msgid "As an interactive shell"
18817 #: ../fish/guestfish.pod:45
18825 #: ../fish/guestfish.pod:47
18828 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
18829 " editing virtual machine filesystems.\n"
18834 #: ../fish/guestfish.pod:50
18837 " Type: 'help' for a list of commands\n"
18838 " 'man' to read the manual\n"
18839 " 'quit' to quit the shell\n"
18844 #: ../fish/guestfish.pod:54
18847 " ><fs> add-ro disk.img\n"
18849 " ><fs> list-filesystems\n"
18850 " /dev/sda1: ext4\n"
18851 " /dev/vg_guest/lv_root: ext4\n"
18852 " /dev/vg_guest/lv_swap: swap\n"
18853 " ><fs> mount /dev/vg_guest/lv_root /\n"
18854 " ><fs> cat /etc/fstab\n"
18856 " # Created by anaconda\n"
18863 #: ../fish/guestfish.pod:67
18864 msgid "From shell scripts"
18868 #: ../fish/guestfish.pod:69
18869 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18873 #: ../fish/guestfish.pod:71
18876 " guestfish <<_EOF_\n"
18879 " mount /dev/vg_guest/lv_root /\n"
18880 " write /etc/motd \"Welcome, new users\"\n"
18886 #: ../fish/guestfish.pod:78
18887 msgid "List the LVM logical volumes in a disk image:"
18891 #: ../fish/guestfish.pod:80
18894 " guestfish -a disk.img --ro <<_EOF_\n"
18902 #: ../fish/guestfish.pod:85
18903 msgid "List all the filesystems in a disk image:"
18907 #: ../fish/guestfish.pod:87
18910 " guestfish -a disk.img --ro <<_EOF_\n"
18912 " list-filesystems\n"
18918 #: ../fish/guestfish.pod:92
18919 msgid "On one command line"
18923 #: ../fish/guestfish.pod:94
18924 msgid "Update C</etc/resolv.conf> in a guest:"
18928 #: ../fish/guestfish.pod:96
18932 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
18933 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
18938 #: ../fish/guestfish.pod:100
18939 msgid "Edit C</boot/grub/grub.conf> interactively:"
18943 #: ../fish/guestfish.pod:102
18946 " guestfish --rw --add disk.img \\\n"
18947 " --mount /dev/vg_guest/lv_root \\\n"
18948 " --mount /dev/sda1:/boot \\\n"
18949 " edit /boot/grub/grub.conf\n"
18954 #: ../fish/guestfish.pod:107
18955 msgid "Mount disks automatically"
18959 #: ../fish/guestfish.pod:109
18961 "Use the I<-i> option to automatically mount the disks from a virtual "
18966 #: ../fish/guestfish.pod:112
18969 " guestfish --ro -a disk.img -i cat /etc/group\n"
18974 #: ../fish/guestfish.pod:114
18977 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
18982 #: ../fish/guestfish.pod:116
18983 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
18987 #: ../fish/guestfish.pod:118
18990 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
18995 #: ../fish/guestfish.pod:120
18996 msgid "As a script interpreter"
19000 #: ../fish/guestfish.pod:122
19001 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19005 #: ../fish/guestfish.pod:124
19008 " #!/usr/bin/guestfish -f\n"
19009 " sparse test1.img 100M\n"
19011 " part-disk /dev/sda mbr\n"
19012 " mkfs ext2 /dev/sda1\n"
19017 #: ../fish/guestfish.pod:130
19018 msgid "Start with a prepared disk"
19022 #: ../fish/guestfish.pod:132
19024 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19025 "single ext2-formatted partition:"
19029 #: ../fish/guestfish.pod:135
19032 " guestfish -N fs\n"
19037 #: ../fish/guestfish.pod:137
19038 msgid "To list what is available do:"
19042 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
19045 " guestfish -N help | less\n"
19050 #: ../fish/guestfish.pod:141
19051 msgid "Remote control"
19055 #: ../fish/guestfish.pod:143
19058 " eval \"`guestfish --listen`\"\n"
19059 " guestfish --remote add-ro disk.img\n"
19060 " guestfish --remote run\n"
19061 " guestfish --remote lvs\n"
19066 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../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
19071 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:133 ../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
19076 #: ../fish/guestfish.pod:154
19077 msgid "Displays general help on options."
19081 #: ../fish/guestfish.pod:156
19086 #: ../fish/guestfish.pod:158
19087 msgid "B<--cmd-help>"
19091 #: ../fish/guestfish.pod:160
19092 msgid "Lists all available guestfish commands."
19096 #: ../fish/guestfish.pod:162
19101 #: ../fish/guestfish.pod:164
19102 msgid "B<--cmd-help cmd>"
19106 #: ../fish/guestfish.pod:166
19107 msgid "Displays detailed help on a single command C<cmd>."
19111 #: ../fish/guestfish.pod:168
19112 msgid "B<-a image>"
19116 #: ../fish/guestfish.pod:170
19117 msgid "B<--add image>"
19121 #: ../fish/guestfish.pod:172
19122 msgid "Add a block device or virtual machine image to the shell."
19126 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
19128 "The format of the disk image is auto-detected. To override this and force a "
19129 "particular format use the I<--format=..> option."
19133 #: ../fish/guestfish.pod:177
19135 "Using this flag is mostly equivalent to using the C<add> command, with "
19136 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19137 "the I<--format=...> flag was given."
19141 #: ../fish/guestfish.pod:181
19146 #: ../fish/guestfish.pod:183
19147 msgid "B<--connect URI>"
19151 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
19153 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19154 "URI to use. The default is to use the default libvirt connection."
19158 #: ../fish/guestfish.pod:189
19163 #: ../fish/guestfish.pod:191
19165 "If using the I<--listen> option and a csh-like shell, use this option. See "
19166 "section L</REMOTE CONTROL AND CSH> below."
19170 #: ../fish/guestfish.pod:194
19171 msgid "B<-d libvirt-domain>"
19175 #: ../fish/guestfish.pod:196
19176 msgid "B<--domain libvirt-domain>"
19180 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
19182 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19183 "used, then any libvirt domain can be used. However in write mode, only "
19184 "libvirt domains which are shut down can be named here."
19188 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:96
19189 msgid "Domain UUIDs can be used instead of names."
19193 #: ../fish/guestfish.pod:204
19195 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19196 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19197 "if the I<--format:...> flag was given."
19201 #: ../fish/guestfish.pod:208
19206 #: ../fish/guestfish.pod:210
19207 msgid "B<--no-dest-paths>"
19211 #: ../fish/guestfish.pod:212
19213 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19214 "to hit the tab key to complete paths on the guest filesystem, but this "
19215 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19216 "allow this feature to be disabled."
19220 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
19221 msgid "B<--echo-keys>"
19225 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:112
19227 "When prompting for keys and passphrases, guestfish normally turns echoing "
19228 "off so you cannot see what you are typing. If you are not worried about "
19229 "Tempest attacks and there is no one else in the room you can specify this "
19230 "flag to see what you are typing."
19234 #: ../fish/guestfish.pod:224
19239 #: ../fish/guestfish.pod:226
19240 msgid "B<--file file>"
19244 #: ../fish/guestfish.pod:228
19245 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19249 #: ../fish/guestfish.pod:231
19252 " #!/usr/bin/guestfish -f\n"
19257 #: ../fish/guestfish.pod:233
19258 msgid "B<--format=raw|qcow2|..>"
19262 #: ../fish/guestfish.pod:235
19263 msgid "B<--format>"
19267 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:119
19269 "The default for the I<-a> option is to auto-detect the format of the disk "
19270 "image. Using this forces the disk format for I<-a> options which follow on "
19271 "the command line. Using I<--format> with no argument switches back to "
19272 "auto-detection for subsequent I<-a> options."
19276 #: ../fish/guestfish.pod:244
19279 " guestfish --format=raw -a disk.img\n"
19284 #: ../fish/guestfish.pod:246
19285 msgid "forces raw format (no auto-detection) for C<disk.img>."
19289 #: ../fish/guestfish.pod:248
19292 " guestfish --format=raw -a disk.img --format -a another.img\n"
19297 #: ../fish/guestfish.pod:250
19299 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19300 "auto-detection for C<another.img>."
19304 #: ../fish/guestfish.pod:253
19306 "If you have untrusted raw-format guest disk images, you should use this "
19307 "option to specify the disk format. This avoids a possible security problem "
19308 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19312 #: ../fish/guestfish.pod:258
19317 #: ../fish/guestfish.pod:260
19318 msgid "B<--inspector>"
19322 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:139
19324 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19325 "system and mount filesystems as they would be mounted on the real virtual "
19330 #: ../fish/guestfish.pod:266
19331 msgid "Typical usage is either:"
19335 #: ../fish/guestfish.pod:268
19338 " guestfish -d myguest -i\n"
19343 #: ../fish/guestfish.pod:270
19344 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19348 #: ../fish/guestfish.pod:272
19351 " guestfish --ro -d myguest -i\n"
19356 #: ../fish/guestfish.pod:274
19357 msgid "(for active domains, readonly), or specify the block device directly:"
19361 #: ../fish/guestfish.pod:276
19364 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19369 #: ../fish/guestfish.pod:278
19371 "Note that the command line syntax changed slightly over older versions of "
19372 "guestfish. You can still use the old syntax:"
19376 #: ../fish/guestfish.pod:281
19379 " guestfish [--ro] -i disk.img\n"
19384 #: ../fish/guestfish.pod:283
19387 " guestfish [--ro] -i libvirt-domain\n"
19392 #: ../fish/guestfish.pod:285
19394 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19395 "then using other commands to mount the filesystems that were found."
19399 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19400 msgid "B<--keys-from-stdin>"
19404 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:145
19406 "Read key or passphrase parameters from stdin. The default is to try to read "
19407 "passphrases from the user by opening C</dev/tty>."
19411 #: ../fish/guestfish.pod:294
19412 msgid "B<--listen>"
19416 #: ../fish/guestfish.pod:296
19418 "Fork into the background and listen for remote commands. See section "
19419 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19423 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19428 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:150
19430 "Connect to a live virtual machine. (Experimental, see "
19431 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19435 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:153
19436 msgid "B<-m dev[:mountpoint[:options]]>"
19440 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:155
19441 msgid "B<--mount dev[:mountpoint[:options]]>"
19445 #: ../fish/guestfish.pod:308
19446 msgid "Mount the named partition or logical volume on the given mountpoint."
19450 #: ../fish/guestfish.pod:310
19451 msgid "If the mountpoint is omitted, it defaults to C</>."
19455 #: ../fish/guestfish.pod:312
19456 msgid "You have to mount something on C</> before most commands will work."
19460 #: ../fish/guestfish.pod:314
19462 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19467 #: ../fish/guestfish.pod:317
19469 "If you don't know what filesystems a disk image contains, you can either run "
19470 "guestfish without this option, then list the partitions, filesystems and LVs "
19471 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19472 "commands), or you can use the L<virt-filesystems(1)> program."
19476 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:163
19478 "The third (and rarely used) part of the mount parameter is the list of mount "
19479 "options used to mount the underlying filesystem. If this is not given, then "
19480 "the mount options are either the empty string or C<ro> (the latter if the "
19481 "I<--ro> flag is used). By specifying the mount options, you override this "
19482 "default choice. Probably the only time you would use this is to enable ACLs "
19483 "and/or extended attributes if the filesystem can support them:"
19487 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:171
19490 " -m /dev/sda1:/:acl,user_xattr\n"
19495 #: ../fish/guestfish.pod:333
19496 msgid "Using this flag is equivalent to using the C<mount-options> command."
19500 #: ../fish/guestfish.pod:335
19505 #: ../fish/guestfish.pod:337
19506 msgid "B<--no-sync>"
19510 #: ../fish/guestfish.pod:339
19512 "Disable autosync. This is enabled by default. See the discussion of "
19513 "autosync in the L<guestfs(3)> manpage."
19517 #: ../fish/guestfish.pod:342
19522 #: ../fish/guestfish.pod:344
19523 msgid "B<--new type>"
19527 #: ../fish/guestfish.pod:346
19532 #: ../fish/guestfish.pod:348
19534 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19535 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19536 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19541 #: ../fish/guestfish.pod:353
19542 msgid "B<--progress-bars>"
19546 #: ../fish/guestfish.pod:355
19547 msgid "Enable progress bars, even when guestfish is used non-interactively."
19551 #: ../fish/guestfish.pod:357
19553 "Progress bars are enabled by default when guestfish is used as an "
19554 "interactive shell."
19558 #: ../fish/guestfish.pod:360
19559 msgid "B<--no-progress-bars>"
19563 #: ../fish/guestfish.pod:362
19564 msgid "Disable progress bars."
19568 #: ../fish/guestfish.pod:364
19569 msgid "B<--remote[=pid]>"
19573 #: ../fish/guestfish.pod:366
19575 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19576 "CONTROL GUESTFISH OVER A SOCKET> below."
19580 #: ../fish/guestfish.pod:369
19585 #: ../fish/guestfish.pod:371
19590 #: ../fish/guestfish.pod:373
19592 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19593 "mounts are done read-only."
19597 #: ../fish/guestfish.pod:376
19599 "The option must always be used if the disk image or virtual machine might be "
19600 "running, and is generally recommended in cases where you don't need write "
19601 "access to the disk."
19605 #: ../fish/guestfish.pod:380
19607 "Note that prepared disk images created with I<-N> are not affected by this "
19608 "option. Also commands like C<add> are not affected - you have to specify "
19609 "the C<readonly:true> option explicitly if you need it."
19613 #: ../fish/guestfish.pod:384
19614 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19618 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:227
19619 msgid "B<--selinux>"
19623 #: ../fish/guestfish.pod:388
19624 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19628 #: ../fish/guestfish.pod:390
19633 #: ../fish/guestfish.pod:392
19634 msgid "B<--verbose>"
19638 #: ../fish/guestfish.pod:394
19640 "Enable very verbose messages. This is particularly useful if you find a "
19645 #: ../fish/guestfish.pod:397
19650 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
19651 msgid "B<--version>"
19655 #: ../fish/guestfish.pod:401
19656 msgid "Display the guestfish / libguestfs version number and exit."
19660 #: ../fish/guestfish.pod:403
19665 #: ../fish/guestfish.pod:405
19670 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:241
19672 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19673 "mounts are done read-write."
19677 #: ../fish/guestfish.pod:410
19678 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19682 #: ../fish/guestfish.pod:412
19687 #: ../fish/guestfish.pod:414
19688 msgid "Echo each command before executing it."
19692 #: ../fish/guestfish.pod:418
19693 msgid "COMMANDS ON COMMAND LINE"
19697 #: ../fish/guestfish.pod:420
19698 msgid "Any additional (non-option) arguments are treated as commands to execute."
19702 #: ../fish/guestfish.pod:423
19704 "Commands to execute should be separated by a colon (C<:>), where the colon "
19705 "is a separate parameter. Thus:"
19709 #: ../fish/guestfish.pod:426
19712 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19717 #: ../fish/guestfish.pod:428
19719 "If there are no additional arguments, then we enter a shell, either an "
19720 "interactive shell with a prompt (if the input is a terminal) or a "
19721 "non-interactive shell."
19725 #: ../fish/guestfish.pod:432
19727 "In either command line mode or non-interactive shell, the first command that "
19728 "gives an error causes the whole shell to exit. In interactive mode (with a "
19729 "prompt) if a command fails, you can continue to enter commands."
19733 #: ../fish/guestfish.pod:437
19734 msgid "USING launch (OR run)"
19738 #: ../fish/guestfish.pod:439
19740 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19741 "then launch it, then mount any disks you need, and finally issue "
19742 "actions/commands. So the general order of the day is:"
19746 #: ../fish/guestfish.pod:447
19747 msgid "add or -a/--add"
19751 #: ../fish/guestfish.pod:451
19752 msgid "launch (aka run)"
19756 #: ../fish/guestfish.pod:455
19757 msgid "mount or -m/--mount"
19761 #: ../fish/guestfish.pod:459
19762 msgid "any other commands"
19766 #: ../fish/guestfish.pod:463
19768 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19769 "guest before mounting or performing any other commands."
19773 #: ../fish/guestfish.pod:466
19775 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19776 "I<--new> options were given then C<run> is done automatically, simply "
19777 "because guestfish can't perform the action you asked for without doing this."
19781 #: ../fish/guestfish.pod:471
19782 msgid "OPENING DISKS FOR READ AND WRITE"
19786 #: ../fish/guestfish.pod:473
19788 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
19789 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
19790 "I<-i> and I<-m> open disk images read-only or for writing."
19794 #: ../fish/guestfish.pod:478
19796 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
19797 "opening disk images supplied on the command line for write. To open a disk "
19798 "image read-only you have to do I<-a image --ro>."
19802 #: ../fish/guestfish.pod:482
19804 "This matters: If you accidentally open a live VM disk image writable then "
19805 "you will cause irreversible disk corruption."
19809 #: ../fish/guestfish.pod:485
19811 "By libguestfs 1.12 we intend to change the default the other way. Disk "
19812 "images will be opened read-only. You will have to either specify "
19813 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
19814 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
19815 "access for disk images specified by those other command line options."
19819 #: ../fish/guestfish.pod:492
19821 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
19822 "which does nothing (it is already the default). However it is highly "
19823 "recommended that you use this option to indicate that you need write access, "
19824 "and prepare your scripts for the day when this option will be required for "
19829 #: ../fish/guestfish.pod:498
19831 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
19832 "other libguestfs program apart from guestfish and guestmount."
19836 #: ../fish/guestfish.pod:501
19841 #: ../fish/guestfish.pod:503
19843 "You can quote ordinary parameters using either single or double quotes. For "
19848 #: ../fish/guestfish.pod:506
19851 " add \"file with a space.img\"\n"
19856 #: ../fish/guestfish.pod:508
19859 " rm '/file name'\n"
19864 #: ../fish/guestfish.pod:510
19872 #: ../fish/guestfish.pod:512
19874 "A few commands require a list of strings to be passed. For these, use a "
19875 "whitespace-separated list, enclosed in quotes. Strings containing "
19876 "whitespace to be passed through must be enclosed in single quotes. A "
19877 "literal single quote must be escaped with a backslash."
19881 #: ../fish/guestfish.pod:517
19884 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
19885 " command \"/bin/echo 'foo bar'\"\n"
19886 " command \"/bin/echo \\'foo\\'\"\n"
19891 #: ../fish/guestfish.pod:521
19892 msgid "OPTIONAL ARGUMENTS"
19896 #: ../fish/guestfish.pod:523
19898 "Some commands take optional arguments. These arguments appear in this "
19899 "documentation as C<[argname:..]>. You can use them as in these examples:"
19903 #: ../fish/guestfish.pod:527
19906 " add-drive-opts filename\n"
19911 #: ../fish/guestfish.pod:529
19914 " add-drive-opts filename readonly:true\n"
19919 #: ../fish/guestfish.pod:531
19922 " add-drive-opts filename format:qcow2 readonly:false\n"
19927 #: ../fish/guestfish.pod:533
19929 "Each optional argument can appear at most once. All optional arguments must "
19930 "appear after the required ones."
19934 #: ../fish/guestfish.pod:536
19939 #: ../fish/guestfish.pod:538
19940 msgid "This section applies to all commands which can take integers as parameters."
19944 #: ../fish/guestfish.pod:541
19945 msgid "SIZE SUFFIX"
19949 #: ../fish/guestfish.pod:543
19951 "When the command takes a parameter measured in bytes, you can use one of the "
19952 "following suffixes to specify kilobytes, megabytes and larger sizes:"
19956 #: ../fish/guestfish.pod:549
19957 msgid "B<k> or B<K> or B<KiB>"
19961 #: ../fish/guestfish.pod:551
19962 msgid "The size in kilobytes (multiplied by 1024)."
19966 #: ../fish/guestfish.pod:553
19971 #: ../fish/guestfish.pod:555
19972 msgid "The size in SI 1000 byte units."
19976 #: ../fish/guestfish.pod:557
19977 msgid "B<M> or B<MiB>"
19981 #: ../fish/guestfish.pod:559
19982 msgid "The size in megabytes (multiplied by 1048576)."
19986 #: ../fish/guestfish.pod:561
19991 #: ../fish/guestfish.pod:563
19992 msgid "The size in SI 1000000 byte units."
19996 #: ../fish/guestfish.pod:565
19997 msgid "B<G> or B<GiB>"
20001 #: ../fish/guestfish.pod:567
20002 msgid "The size in gigabytes (multiplied by 2**30)."
20006 #: ../fish/guestfish.pod:569
20011 #: ../fish/guestfish.pod:571
20012 msgid "The size in SI 10**9 byte units."
20016 #: ../fish/guestfish.pod:573
20017 msgid "B<T> or B<TiB>"
20021 #: ../fish/guestfish.pod:575
20022 msgid "The size in terabytes (multiplied by 2**40)."
20026 #: ../fish/guestfish.pod:577
20031 #: ../fish/guestfish.pod:579
20032 msgid "The size in SI 10**12 byte units."
20036 #: ../fish/guestfish.pod:581
20037 msgid "B<P> or B<PiB>"
20041 #: ../fish/guestfish.pod:583
20042 msgid "The size in petabytes (multiplied by 2**50)."
20046 #: ../fish/guestfish.pod:585
20051 #: ../fish/guestfish.pod:587
20052 msgid "The size in SI 10**15 byte units."
20056 #: ../fish/guestfish.pod:589
20057 msgid "B<E> or B<EiB>"
20061 #: ../fish/guestfish.pod:591
20062 msgid "The size in exabytes (multiplied by 2**60)."
20066 #: ../fish/guestfish.pod:593
20071 #: ../fish/guestfish.pod:595
20072 msgid "The size in SI 10**18 byte units."
20076 #: ../fish/guestfish.pod:597
20077 msgid "B<Z> or B<ZiB>"
20081 #: ../fish/guestfish.pod:599
20082 msgid "The size in zettabytes (multiplied by 2**70)."
20086 #: ../fish/guestfish.pod:601
20091 #: ../fish/guestfish.pod:603
20092 msgid "The size in SI 10**21 byte units."
20096 #: ../fish/guestfish.pod:605
20097 msgid "B<Y> or B<YiB>"
20101 #: ../fish/guestfish.pod:607
20102 msgid "The size in yottabytes (multiplied by 2**80)."
20106 #: ../fish/guestfish.pod:609
20111 #: ../fish/guestfish.pod:611
20112 msgid "The size in SI 10**24 byte units."
20116 #: ../fish/guestfish.pod:617
20119 " truncate-size /file 1G\n"
20124 #: ../fish/guestfish.pod:619
20125 msgid "would truncate the file to 1 gigabyte."
20129 #: ../fish/guestfish.pod:621
20131 "Be careful because a few commands take sizes in kilobytes or megabytes "
20132 "(eg. the parameter to L</memsize> is specified in megabytes already). "
20133 "Adding a suffix will probably not do what you expect."
20137 #: ../fish/guestfish.pod:625
20138 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20142 #: ../fish/guestfish.pod:627
20144 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20145 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20149 #: ../fish/guestfish.pod:630
20152 " 1234 decimal number 1234\n"
20153 " 02322 octal number, equivalent to decimal 1234\n"
20154 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20159 #: ../fish/guestfish.pod:634
20161 "When using the C<chmod> command, you almost always want to specify an octal "
20162 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20163 "L<chmod(1)> program):"
20167 #: ../fish/guestfish.pod:638
20170 " chmod 0777 /public # OK\n"
20171 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20176 #: ../fish/guestfish.pod:641
20178 "Commands that return numbers usually print them in decimal, but some "
20179 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20180 "octal, preceeded by C<0>)."
20184 #: ../fish/guestfish.pod:645
20185 msgid "WILDCARDS AND GLOBBING"
20189 #: ../fish/guestfish.pod:647
20191 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20192 "(globbing) by default. So for example the following will not do what you "
20197 #: ../fish/guestfish.pod:651
20205 #: ../fish/guestfish.pod:653
20207 "Assuming you don't have a directory called literally C</home/*> then the "
20208 "above command will return an error."
20212 #: ../fish/guestfish.pod:656
20213 msgid "To perform wildcard expansion, use the C<glob> command."
20217 #: ../fish/guestfish.pod:658
20220 " glob rm-rf /home/*\n"
20225 #: ../fish/guestfish.pod:660
20227 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20228 "many times), equivalent to:"
20232 #: ../fish/guestfish.pod:663
20235 " rm-rf /home/jim\n"
20236 " rm-rf /home/joe\n"
20237 " rm-rf /home/mary\n"
20242 #: ../fish/guestfish.pod:667
20243 msgid "C<glob> only works on simple guest paths and not on device names."
20247 #: ../fish/guestfish.pod:669
20249 "If you have several parameters, each containing a wildcard, then glob will "
20250 "perform a Cartesian product."
20254 #: ../fish/guestfish.pod:672
20259 #: ../fish/guestfish.pod:674
20261 "Any line which starts with a I<#> character is treated as a comment and "
20262 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20263 "a command. For example:"
20267 #: ../fish/guestfish.pod:678
20270 " # this is a comment\n"
20271 " # this is a comment\n"
20272 " foo # NOT a comment\n"
20277 #: ../fish/guestfish.pod:682
20278 msgid "Blank lines are also ignored."
20282 #: ../fish/guestfish.pod:684
20283 msgid "RUNNING COMMANDS LOCALLY"
20287 #: ../fish/guestfish.pod:686
20289 "Any line which starts with a I<!> character is treated as a command sent to "
20290 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20294 #: ../fish/guestfish.pod:690
20298 " tgz-out /remote local/remote-data.tar.gz\n"
20303 #: ../fish/guestfish.pod:693
20305 "will create a directory C<local> on the host, and then export the contents "
20306 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20307 "(See C<tgz-out>)."
20311 #: ../fish/guestfish.pod:697
20313 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20314 "effect, due to the way that subprocesses work in Unix."
20318 #: ../fish/guestfish.pod:700
20319 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20323 #: ../fish/guestfish.pod:702
20325 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20326 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20327 "and executed as guestfish commands."
20331 #: ../fish/guestfish.pod:706
20333 "Thus you can use shell script to construct arbitrary guestfish commands "
20334 "which are then parsed by guestfish."
20338 #: ../fish/guestfish.pod:709
20340 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20341 "through C</foo.100>) using guestfish commands alone. However this is simple "
20342 "if we use a shell script to create the guestfish commands for us:"
20346 #: ../fish/guestfish.pod:714
20349 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20354 #: ../fish/guestfish.pod:716
20355 msgid "or with names like C</foo.001>:"
20359 #: ../fish/guestfish.pod:718
20362 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20367 #: ../fish/guestfish.pod:720
20369 "When using guestfish interactively it can be helpful to just run the shell "
20370 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20371 "ordinary I<!> local command), see what guestfish commands it would run, and "
20372 "when you are happy with those prepend the C<E<lt>> character to run the "
20373 "guestfish commands for real."
20377 #: ../fish/guestfish.pod:726
20382 #: ../fish/guestfish.pod:728
20384 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20385 "command (a guestfish command) to the second command (any host command). For "
20390 #: ../fish/guestfish.pod:732
20393 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20398 #: ../fish/guestfish.pod:734
20400 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20401 "program). The above command would list all accounts in the guest filesystem "
20402 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20406 #: ../fish/guestfish.pod:739
20409 " hexdump /bin/ls | head\n"
20410 " list-devices | tail -1\n"
20411 " tgz-out / - | tar ztf -\n"
20416 #: ../fish/guestfish.pod:743
20418 "The space before the pipe symbol is required, any space after the pipe "
20419 "symbol is optional. Everything after the pipe symbol is just passed "
20420 "straight to the host shell, so it can contain redirections, globs and "
20421 "anything else that makes sense on the host side."
20425 #: ../fish/guestfish.pod:748
20427 "To use a literal argument which begins with a pipe symbol, you have to quote "
20432 #: ../fish/guestfish.pod:751
20440 #: ../fish/guestfish.pod:753
20441 msgid "HOME DIRECTORIES"
20445 #: ../fish/guestfish.pod:755
20447 "If a parameter starts with the character C<~> then the tilde may be expanded "
20448 "as a home directory path (either C<~> for the current user's home directory, "
20449 "or C<~user> for another user)."
20453 #: ../fish/guestfish.pod:759
20455 "Note that home directory expansion happens for users known I<on the host>, "
20456 "not in the guest filesystem."
20460 #: ../fish/guestfish.pod:762
20462 "To use a literal argument which begins with a tilde, you have to quote it, "
20467 #: ../fish/guestfish.pod:765
20475 #: ../fish/guestfish.pod:769
20477 "Libguestfs has some support for Linux guests encrypted according to the "
20478 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20479 "disk encryption systems used by modern Linux guests. Currently only "
20480 "LVM-on-LUKS is supported."
20484 #: ../fish/guestfish.pod:774
20485 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20489 #: ../fish/guestfish.pod:776
20492 " ><fs> vfs-type /dev/sda2\n"
20498 #: ../fish/guestfish.pod:779
20500 "Then open those devices using L</luks-open>. This creates a device-mapper "
20501 "device called C</dev/mapper/luksdev>."
20505 #: ../fish/guestfish.pod:782
20508 " ><fs> luks-open /dev/sda2 luksdev\n"
20509 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20514 #: ../fish/guestfish.pod:785
20516 "Finally you have to tell LVM to scan for volume groups on the newly created "
20521 #: ../fish/guestfish.pod:788
20525 " vg-activate-all true\n"
20530 #: ../fish/guestfish.pod:791
20531 msgid "The logical volume(s) can now be mounted in the usual way."
20535 #: ../fish/guestfish.pod:793
20537 "Before closing a LUKS device you must unmount any logical volumes on it and "
20538 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20539 "one. Then you can close the mapper device:"
20543 #: ../fish/guestfish.pod:797
20546 " vg-activate false /dev/VG\n"
20547 " luks-close /dev/mapper/luksdev\n"
20552 #: ../fish/guestfish.pod:800
20553 msgid "WINDOWS PATHS"
20557 #: ../fish/guestfish.pod:802
20559 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20560 "letters and paths (with some limitations). The following commands are "
20565 #: ../fish/guestfish.pod:806
20568 " file /WINDOWS/system32/config/system.LOG\n"
20573 #: ../fish/guestfish.pod:808
20576 " file win:\\windows\\system32\\config\\system.log\n"
20581 #: ../fish/guestfish.pod:810
20584 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20589 #: ../fish/guestfish.pod:812
20591 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20592 "where the drive is mounted, prepending that to the path, changing all "
20593 "backslash characters to forward slash, then resolving the result using "
20594 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
20595 "then the parameter might be rewritten like this:"
20599 #: ../fish/guestfish.pod:818
20602 " win:e:\\foo\\bar => /e/FOO/bar\n"
20607 #: ../fish/guestfish.pod:820
20608 msgid "This only works in argument positions that expect a path."
20612 #: ../fish/guestfish.pod:822
20613 msgid "UPLOADING AND DOWNLOADING FILES"
20617 #: ../fish/guestfish.pod:824
20619 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20620 "others which upload from or download to a local file, you can use the "
20621 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20625 #: ../fish/guestfish.pod:828
20633 #: ../fish/guestfish.pod:830
20634 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20638 #: ../fish/guestfish.pod:833
20641 " tar-out /etc - | tar tf -\n"
20646 #: ../fish/guestfish.pod:835
20648 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20649 "command (see L</PIPES>)."
20653 #: ../fish/guestfish.pod:838
20655 "When using C<-> to read from stdin, the input is read up to the end of "
20656 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20657 "some arbitrary end marker:"
20661 #: ../fish/guestfish.pod:842
20664 " upload -<<END /foo\n"
20673 #: ../fish/guestfish.pod:848
20675 "Any string of characters can be used instead of C<END>. The end marker must "
20676 "appear on a line of its own, without any preceeding or following characters "
20677 "(not even spaces)."
20681 #: ../fish/guestfish.pod:852
20683 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20684 "upload local files (so-called \"FileIn\" parameters in the generator)."
20688 #: ../fish/guestfish.pod:855
20689 msgid "EXIT ON ERROR BEHAVIOUR"
20693 #: ../fish/guestfish.pod:857
20695 "By default, guestfish will ignore any errors when in interactive mode "
20696 "(ie. taking commands from a human over a tty), and will exit on the first "
20697 "error in non-interactive mode (scripts, commands given on the command line)."
20701 #: ../fish/guestfish.pod:862
20703 "If you prefix a command with a I<-> character, then that command will not "
20704 "cause guestfish to exit, even if that (one) command returns an error."
20708 #: ../fish/guestfish.pod:866
20709 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20713 #: ../fish/guestfish.pod:868
20715 "Guestfish can be remote-controlled over a socket. This is useful "
20716 "particularly in shell scripts where you want to make several different "
20717 "changes to a filesystem, but you don't want the overhead of starting up a "
20718 "guestfish process each time."
20722 #: ../fish/guestfish.pod:873
20723 msgid "Start a guestfish server process using:"
20727 #: ../fish/guestfish.pod:875
20730 " eval \"`guestfish --listen`\"\n"
20735 #: ../fish/guestfish.pod:877
20736 msgid "and then send it commands by doing:"
20740 #: ../fish/guestfish.pod:879
20743 " guestfish --remote cmd [...]\n"
20748 #: ../fish/guestfish.pod:881
20749 msgid "To cause the server to exit, send it the exit command:"
20753 #: ../fish/guestfish.pod:883
20756 " guestfish --remote exit\n"
20761 #: ../fish/guestfish.pod:885
20763 "Note that the server will normally exit if there is an error in a command. "
20764 "You can change this in the usual way. See section L</EXIT ON ERROR "
20769 #: ../fish/guestfish.pod:889
20770 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20774 #: ../fish/guestfish.pod:891
20776 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20777 "is how the I<--remote> option knows where to send the commands. You can "
20778 "have several guestfish listener processes running using:"
20782 #: ../fish/guestfish.pod:895
20785 " eval \"`guestfish --listen`\"\n"
20786 " pid1=$GUESTFISH_PID\n"
20787 " eval \"`guestfish --listen`\"\n"
20788 " pid2=$GUESTFISH_PID\n"
20790 " guestfish --remote=$pid1 cmd\n"
20791 " guestfish --remote=$pid2 cmd\n"
20796 #: ../fish/guestfish.pod:903
20797 msgid "REMOTE CONTROL AND CSH"
20801 #: ../fish/guestfish.pod:905
20803 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
20808 #: ../fish/guestfish.pod:908
20811 " eval \"`guestfish --listen --csh`\"\n"
20816 #: ../fish/guestfish.pod:910
20817 msgid "REMOTE CONTROL DETAILS"
20821 #: ../fish/guestfish.pod:912
20823 "Remote control happens over a Unix domain socket called "
20824 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
20825 "of the process, and C<$PID> is the process ID of the server."
20829 #: ../fish/guestfish.pod:916
20830 msgid "Guestfish client and server versions must match exactly."
20834 #: ../fish/guestfish.pod:918
20835 msgid "PREPARED DISK IMAGES"
20839 #: ../fish/guestfish.pod:920
20841 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
20842 "preformatted disk images that guestfish can make for you to save typing. "
20843 "This is particularly useful for testing purposes. This option is used "
20844 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
20845 "can be mixed with I<-a>)."
20849 #: ../fish/guestfish.pod:926
20851 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
20852 "the second and so on. Existing files in the current directory are "
20857 #: ../fish/guestfish.pod:930
20859 "The type briefly describes how the disk should be sized, partitioned, how "
20860 "filesystem(s) should be created, and how content should be added. "
20861 "Optionally the type can be followed by extra parameters, separated by C<:> "
20862 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
20863 "sparsely-allocated disk, containing a single partition, with the partition "
20864 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
20865 "on a 1GB disk instead."
20869 #: ../fish/guestfish.pod:938
20870 msgid "To list the available types and any extra parameters they take, run:"
20874 #: ../fish/guestfish.pod:942
20876 "Note that the prepared filesystem is not mounted. You would usually have to "
20877 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
20881 #: ../fish/guestfish.pod:946
20883 "If any I<-N> or I<--new> options are given, the guest is automatically "
20888 #: ../fish/guestfish.pod:951
20889 msgid "Create a 100MB disk with an ext4-formatted partition:"
20893 #: ../fish/guestfish.pod:953
20896 " guestfish -N fs:ext4\n"
20901 #: ../fish/guestfish.pod:955
20902 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
20906 #: ../fish/guestfish.pod:957
20909 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
20914 #: ../fish/guestfish.pod:959
20915 msgid "Create a blank 200MB disk:"
20919 #: ../fish/guestfish.pod:961
20922 " guestfish -N disk:200M\n"
20927 #: ../fish/guestfish.pod:963
20928 msgid "PROGRESS BARS"
20932 #: ../fish/guestfish.pod:965
20934 "Some (not all) long-running commands send progress notification messages as "
20935 "they are running. Guestfish turns these messages into progress bars."
20939 #: ../fish/guestfish.pod:969
20941 "When a command that supports progress bars takes longer than two seconds to "
20942 "run, and if progress bars are enabled, then you will see one appearing below "
20947 #: ../fish/guestfish.pod:973
20950 " ><fs> copy-size /large-file /another-file 2048M\n"
20951 " / 10% [#####-----------------------------------------] 00:30\n"
20956 #: ../fish/guestfish.pod:976
20958 "The spinner on the left hand side moves round once for every progress "
20959 "notification received from the backend. This is a (reasonably) golden "
20960 "assurance that the command is \"doing something\" even if the progress bar "
20961 "is not moving, because the command is able to send the progress "
20962 "notifications. When the bar reaches 100% and the command finishes, the "
20963 "spinner disappears."
20967 #: ../fish/guestfish.pod:983
20969 "Progress bars are enabled by default when guestfish is used interactively. "
20970 "You can enable them even for non-interactive modes using I<--progress-bars>, "
20971 "and you can disable them completely using I<--no-progress-bars>."
20975 #: ../fish/guestfish.pod:988
20976 msgid "GUESTFISH COMMANDS"
20980 #: ../fish/guestfish.pod:990
20982 "The commands in this section are guestfish convenience commands, in other "
20983 "words, they are not part of the L<guestfs(3)> API."
20987 #: ../fish/guestfish.pod:993
20992 #: ../fish/guestfish.pod:995
21001 #: ../fish/guestfish.pod:998
21002 msgid "Without any parameter, this provides general help."
21006 #: ../fish/guestfish.pod:1000
21007 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21011 #: ../fish/guestfish.pod:1002
21012 msgid "quit | exit"
21016 #: ../fish/guestfish.pod:1004
21017 msgid "This exits guestfish. You can also use C<^D> key."
21021 #: ../fish/guestfish.pod:1006
21022 msgid "@FISH_COMMANDS@"
21026 #: ../fish/guestfish.pod:1008
21031 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
21036 #: ../fish/guestfish.pod:1014
21038 "guestfish returns 0 if the commands completed without error, or 1 if there "
21043 #: ../fish/guestfish.pod:1021
21048 #: ../fish/guestfish.pod:1023
21050 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21055 #: ../fish/guestfish.pod:1026
21056 msgid "GUESTFISH_PID"
21060 #: ../fish/guestfish.pod:1028
21062 "Used with the I<--remote> option to specify the remote guestfish process to "
21063 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21067 #: ../fish/guestfish.pod:1032
21072 #: ../fish/guestfish.pod:1034
21074 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21075 "not specified, the external L<hexedit(1)> program is used."
21079 #: ../fish/guestfish.pod:1038
21084 #: ../fish/guestfish.pod:1040
21086 "If compiled with GNU readline support, various files in the home directory "
21087 "can be used. See L</FILES>."
21091 #: ../fish/guestfish.pod:1049
21093 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21094 "effect as using the B<-v> option."
21098 #: ../fish/guestfish.pod:1061
21100 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21101 "the discussion of paths in L<guestfs(3)>."
21105 #: ../fish/guestfish.pod:1072
21106 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21110 #: ../fish/guestfish.pod:1074
21115 #: ../fish/guestfish.pod:1076
21117 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21122 #: ../fish/guestfish.pod:1092 ../fuse/guestmount.pod:254
21127 #: ../fish/guestfish.pod:1096 ../fuse/guestmount.pod:258
21128 msgid "$HOME/.libguestfs-tools.rc"
21132 #: ../fish/guestfish.pod:1098 ../fuse/guestmount.pod:260
21133 msgid "/etc/libguestfs-tools.conf"
21137 #: ../fish/guestfish.pod:1100 ../fuse/guestmount.pod:262
21139 "This configuration file controls the default read-only or read-write mode "
21140 "(I<--ro> or I<--rw>)."
21144 #: ../fish/guestfish.pod:1103
21145 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21149 #: ../fish/guestfish.pod:1105
21150 msgid "$HOME/.guestfish"
21154 #: ../fish/guestfish.pod:1107
21156 "If compiled with GNU readline support, then the command history is saved in "
21161 #: ../fish/guestfish.pod:1110
21162 msgid "$HOME/.inputrc"
21166 #: ../fish/guestfish.pod:1112
21167 msgid "/etc/inputrc"
21171 #: ../fish/guestfish.pod:1114
21173 "If compiled with GNU readline support, then these files can be used to "
21174 "configure readline. For further information, please see "
21175 "L<readline(3)/INITIALIZATION FILE>."
21179 #: ../fish/guestfish.pod:1118
21180 msgid "To write rules which only apply to guestfish, use:"
21184 #: ../fish/guestfish.pod:1120
21194 #: ../fish/guestfish.pod:1124
21196 "Variables that you can set in inputrc that change the behaviour of guestfish "
21197 "in useful ways include:"
21201 #: ../fish/guestfish.pod:1129
21202 msgid "completion-ignore-case (default: on)"
21206 #: ../fish/guestfish.pod:1131
21208 "By default, guestfish will ignore case when tab-completing paths on the "
21213 #: ../fish/guestfish.pod:1134
21216 " set completion-ignore-case off\n"
21221 #: ../fish/guestfish.pod:1136
21222 msgid "to make guestfish case sensitive."
21226 #: ../fish/guestfish.pod:1140
21231 #: ../fish/guestfish.pod:1142
21232 msgid "test2.img (etc)"
21236 #: ../fish/guestfish.pod:1144
21238 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21239 "will be created in the file C<test1.img> in the current directory. The "
21240 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21241 "the same name will be overwritten."
21245 #: ../fish/guestfish.pod:1153
21247 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
21248 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
21249 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
21250 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21251 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21252 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
21256 #: ../fish/guestfish.pod:1183 ../test-tool/libguestfs-test-tool.pod:102 ../fuse/guestmount.pod:289 ../tools/virt-win-reg.pl:777 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
21258 "This program is free software; you can redistribute it and/or modify it "
21259 "under the terms of the GNU General Public License as published by the Free "
21260 "Software Foundation; either version 2 of the License, or (at your option) "
21261 "any later version."
21265 #: ../fish/guestfish.pod:1188 ../test-tool/libguestfs-test-tool.pod:107 ../fuse/guestmount.pod:294 ../tools/virt-win-reg.pl:782 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
21267 "This program is distributed in the hope that it will be useful, but WITHOUT "
21268 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21269 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21274 #: ../fish/guestfish.pod:1193 ../test-tool/libguestfs-test-tool.pod:112 ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:787 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
21276 "You should have received a copy of the GNU General Public License along with "
21277 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21278 "Ave, Cambridge, MA 02139, USA."
21282 #: ../fish/guestfish-actions.pod:1
21287 #: ../fish/guestfish-actions.pod:3
21290 " add-cdrom filename\n"
21295 #: ../fish/guestfish-actions.pod:15
21297 "This call checks for the existence of C<filename>. This stops you from "
21298 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21299 "and C<http:> URLs. To specify those, use the general L</config> call "
21304 #: ../fish/guestfish-actions.pod:22
21306 "If you just want to add an ISO file (often you use this as an efficient way "
21307 "to transfer large files into the guest), then you should probably use "
21308 "L</add-drive-ro> instead."
21312 #: ../fish/guestfish-actions.pod:35
21317 #: ../fish/guestfish-actions.pod:37
21322 #: ../fish/guestfish-actions.pod:39
21325 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
21331 #: ../fish/guestfish-actions.pod:41
21333 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21334 "It works by connecting to libvirt, requesting the domain and domain XML from "
21335 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21339 #: ../fish/guestfish-actions.pod:76
21341 "The other optional parameters are passed directly through to "
21342 "L</add-drive-opts>."
21346 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:3052
21348 "This command has one or more optional arguments. See L</OPTIONAL "
21353 #: ../fish/guestfish-actions.pod:81
21358 #: ../fish/guestfish-actions.pod:83
21361 " add-drive filename\n"
21366 #: ../fish/guestfish-actions.pod:85
21368 "This function is the equivalent of calling L</add-drive-opts> with no "
21369 "optional parameters, so the disk is added writable, with the format being "
21370 "detected automatically."
21374 #: ../fish/guestfish-actions.pod:89
21376 "Automatic detection of the format opens you up to a potential security hole "
21377 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21378 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21379 "you should think about replacing calls to this function with calls to "
21380 "L</add-drive-opts>, and specifying the format."
21384 #: ../fish/guestfish-actions.pod:96
21385 msgid "add-drive-opts"
21389 #: ../fish/guestfish-actions.pod:98
21394 #: ../fish/guestfish-actions.pod:100
21397 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21402 #: ../fish/guestfish-actions.pod:127
21404 "This forces the image format. If you omit this (or use L</add-drive> or "
21405 "L</add-drive-ro>) then the format is automatically detected. Possible "
21406 "formats include C<raw> and C<qcow2>."
21410 #: ../fish/guestfish-actions.pod:138
21412 "This rarely-used option lets you emulate the behaviour of the deprecated "
21413 "L</add-drive-with-if> call (q.v.)"
21417 #: ../fish/guestfish-actions.pod:145
21418 msgid "add-drive-ro"
21422 #: ../fish/guestfish-actions.pod:147
21427 #: ../fish/guestfish-actions.pod:149
21430 " add-drive-ro filename\n"
21435 #: ../fish/guestfish-actions.pod:151
21437 "This function is the equivalent of calling L</add-drive-opts> with the "
21438 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21439 "is added read-only, with the format being detected automatically."
21443 #: ../fish/guestfish-actions.pod:156
21444 msgid "add-drive-ro-with-if"
21448 #: ../fish/guestfish-actions.pod:158
21451 " add-drive-ro-with-if filename iface\n"
21456 #: ../fish/guestfish-actions.pod:160
21458 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21459 "interface emulation to use at run time."
21463 #: ../fish/guestfish-actions.pod:170
21464 msgid "add-drive-with-if"
21468 #: ../fish/guestfish-actions.pod:172
21471 " add-drive-with-if filename iface\n"
21476 #: ../fish/guestfish-actions.pod:174
21478 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21479 "interface emulation to use at run time."
21483 #: ../fish/guestfish-actions.pod:184
21488 #: ../fish/guestfish-actions.pod:186
21491 " aug-clear augpath\n"
21496 #: ../fish/guestfish-actions.pod:191
21501 #: ../fish/guestfish-actions.pod:193
21509 #: ../fish/guestfish-actions.pod:195
21511 "Close the current Augeas handle and free up any resources used by it. After "
21512 "calling this, you have to call L</aug-init> again before you can use any "
21513 "other Augeas functions."
21517 #: ../fish/guestfish-actions.pod:200
21518 msgid "aug-defnode"
21522 #: ../fish/guestfish-actions.pod:202
21525 " aug-defnode name expr val\n"
21530 #: ../fish/guestfish-actions.pod:207
21532 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21533 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21534 "containing that single node."
21538 #: ../fish/guestfish-actions.pod:215
21543 #: ../fish/guestfish-actions.pod:217
21546 " aug-defvar name expr\n"
21551 #: ../fish/guestfish-actions.pod:226
21556 #: ../fish/guestfish-actions.pod:228
21559 " aug-get augpath\n"
21564 #: ../fish/guestfish-actions.pod:233
21569 #: ../fish/guestfish-actions.pod:235
21572 " aug-init root flags\n"
21577 #: ../fish/guestfish-actions.pod:241
21578 msgid "You must call this before using any other L</aug-*> commands."
21582 #: ../fish/guestfish-actions.pod:276
21583 msgid "Do not load the tree in L</aug-init>."
21587 #: ../fish/guestfish-actions.pod:280
21588 msgid "To close the handle, you can call L</aug-close>."
21592 #: ../fish/guestfish-actions.pod:284
21597 #: ../fish/guestfish-actions.pod:286
21600 " aug-insert augpath label true|false\n"
21605 #: ../fish/guestfish-actions.pod:296
21610 #: ../fish/guestfish-actions.pod:298
21618 #: ../fish/guestfish-actions.pod:305
21623 #: ../fish/guestfish-actions.pod:307
21626 " aug-ls augpath\n"
21631 #: ../fish/guestfish-actions.pod:309
21633 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21634 "resulting nodes into alphabetical order."
21638 #: ../fish/guestfish-actions.pod:312
21643 #: ../fish/guestfish-actions.pod:314
21646 " aug-match augpath\n"
21651 #: ../fish/guestfish-actions.pod:320
21656 #: ../fish/guestfish-actions.pod:322
21659 " aug-mv src dest\n"
21664 #: ../fish/guestfish-actions.pod:327
21669 #: ../fish/guestfish-actions.pod:329
21672 " aug-rm augpath\n"
21677 #: ../fish/guestfish-actions.pod:335
21682 #: ../fish/guestfish-actions.pod:337
21690 #: ../fish/guestfish-actions.pod:341
21692 "The flags which were passed to L</aug-init> affect exactly how files are "
21697 #: ../fish/guestfish-actions.pod:344
21702 #: ../fish/guestfish-actions.pod:346
21705 " aug-set augpath val\n"
21710 #: ../fish/guestfish-actions.pod:350
21712 "In the Augeas API, it is possible to clear a node by setting the value to "
21713 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21714 "this call. Instead you must use the L</aug-clear> call."
21718 #: ../fish/guestfish-actions.pod:355
21723 #: ../fish/guestfish-actions.pod:357
21726 " available 'groups ...'\n"
21731 #: ../fish/guestfish-actions.pod:363
21733 "The libguestfs groups, and the functions that those groups correspond to, "
21734 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21735 "runtime by calling L</available-all-groups>."
21739 #: ../fish/guestfish-actions.pod:387
21740 msgid "You must call L</launch> before calling this function."
21744 #: ../fish/guestfish-actions.pod:409
21746 "This call was added in version C<1.0.80>. In previous versions of "
21747 "libguestfs all you could do would be to speculatively execute a command to "
21748 "find out if the daemon implemented it. See also L</version>."
21752 #: ../fish/guestfish-actions.pod:416
21753 msgid "available-all-groups"
21757 #: ../fish/guestfish-actions.pod:418
21760 " available-all-groups\n"
21765 #: ../fish/guestfish-actions.pod:420
21767 "This command returns a list of all optional groups that this daemon knows "
21768 "about. Note this returns both supported and unsupported groups. To find "
21769 "out which ones the daemon can actually support you have to call "
21770 "L</available> on each member of the returned list."
21774 #: ../fish/guestfish-actions.pod:426
21775 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
21779 #: ../fish/guestfish-actions.pod:428
21784 #: ../fish/guestfish-actions.pod:430
21787 " base64-in (base64file|-) filename\n"
21792 #: ../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:1233 ../fish/guestfish-actions.pod:4485 ../fish/guestfish-actions.pod:4497 ../fish/guestfish-actions.pod:4508 ../fish/guestfish-actions.pod:4519 ../fish/guestfish-actions.pod:4571 ../fish/guestfish-actions.pod:4580 ../fish/guestfish-actions.pod:4634 ../fish/guestfish-actions.pod:4657
21793 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
21797 #: ../fish/guestfish-actions.pod:437
21802 #: ../fish/guestfish-actions.pod:439
21805 " base64-out filename (base64file|-)\n"
21810 #: ../fish/guestfish-actions.pod:446
21811 msgid "blockdev-flushbufs"
21815 #: ../fish/guestfish-actions.pod:448
21818 " blockdev-flushbufs device\n"
21823 #: ../fish/guestfish-actions.pod:455
21824 msgid "blockdev-getbsz"
21828 #: ../fish/guestfish-actions.pod:457
21831 " blockdev-getbsz device\n"
21836 #: ../fish/guestfish-actions.pod:466
21837 msgid "blockdev-getro"
21841 #: ../fish/guestfish-actions.pod:468
21844 " blockdev-getro device\n"
21849 #: ../fish/guestfish-actions.pod:475
21850 msgid "blockdev-getsize64"
21854 #: ../fish/guestfish-actions.pod:477
21857 " blockdev-getsize64 device\n"
21862 #: ../fish/guestfish-actions.pod:481
21863 msgid "See also L</blockdev-getsz>."
21867 #: ../fish/guestfish-actions.pod:485
21868 msgid "blockdev-getss"
21872 #: ../fish/guestfish-actions.pod:487
21875 " blockdev-getss device\n"
21880 #: ../fish/guestfish-actions.pod:492
21881 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
21885 #: ../fish/guestfish-actions.pod:497
21886 msgid "blockdev-getsz"
21890 #: ../fish/guestfish-actions.pod:499
21893 " blockdev-getsz device\n"
21898 #: ../fish/guestfish-actions.pod:504
21900 "See also L</blockdev-getss> for the real sector size of the device, and "
21901 "L</blockdev-getsize64> for the more useful I<size in bytes>."
21905 #: ../fish/guestfish-actions.pod:510
21906 msgid "blockdev-rereadpt"
21910 #: ../fish/guestfish-actions.pod:512
21913 " blockdev-rereadpt device\n"
21918 #: ../fish/guestfish-actions.pod:518
21919 msgid "blockdev-setbsz"
21923 #: ../fish/guestfish-actions.pod:520
21926 " blockdev-setbsz device blocksize\n"
21931 #: ../fish/guestfish-actions.pod:529
21932 msgid "blockdev-setro"
21936 #: ../fish/guestfish-actions.pod:531
21939 " blockdev-setro device\n"
21944 #: ../fish/guestfish-actions.pod:537
21945 msgid "blockdev-setrw"
21949 #: ../fish/guestfish-actions.pod:539
21952 " blockdev-setrw device\n"
21957 #: ../fish/guestfish-actions.pod:545
21958 msgid "case-sensitive-path"
21962 #: ../fish/guestfish-actions.pod:547
21965 " case-sensitive-path path\n"
21970 #: ../fish/guestfish-actions.pod:571
21972 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
21973 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
21974 "how the directories were originally created under Windows)."
21978 #: ../fish/guestfish-actions.pod:579
21979 msgid "See also L</realpath>."
21983 #: ../fish/guestfish-actions.pod:581
21988 #: ../fish/guestfish-actions.pod:583
21996 #: ../fish/guestfish-actions.pod:587
21998 "Note that this function cannot correctly handle binary files (specifically, "
21999 "files containing C<\\0> character which is treated as end of string). For "
22000 "those you need to use the L</read-file> or L</download> functions which have "
22001 "a more complex interface."
22005 #: ../fish/guestfish-actions.pod:595
22010 #: ../fish/guestfish-actions.pod:597
22013 " checksum csumtype path\n"
22018 #: ../fish/guestfish-actions.pod:640
22019 msgid "To get the checksum for a device, use L</checksum-device>."
22023 #: ../fish/guestfish-actions.pod:642
22024 msgid "To get the checksums for many files, use L</checksums-out>."
22028 #: ../fish/guestfish-actions.pod:644
22029 msgid "checksum-device"
22033 #: ../fish/guestfish-actions.pod:646
22036 " checksum-device csumtype device\n"
22041 #: ../fish/guestfish-actions.pod:648
22043 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22044 "device named C<device>. For the types of checksums supported see the "
22045 "L</checksum> command."
22049 #: ../fish/guestfish-actions.pod:652
22050 msgid "checksums-out"
22054 #: ../fish/guestfish-actions.pod:654
22057 " checksums-out csumtype directory (sumsfile|-)\n"
22062 #: ../fish/guestfish-actions.pod:670
22067 #: ../fish/guestfish-actions.pod:672
22070 " chmod mode path\n"
22075 #: ../fish/guestfish-actions.pod:683
22080 #: ../fish/guestfish-actions.pod:685
22083 " chown owner group path\n"
22088 #: ../fish/guestfish-actions.pod:693
22093 #: ../fish/guestfish-actions.pod:695
22096 " command 'arguments ...'\n"
22101 #: ../fish/guestfish-actions.pod:702
22103 "The single parameter is an argv-style list of arguments. The first element "
22104 "is the name of the program to run. Subsequent elements are parameters. The "
22105 "list must be non-empty (ie. must contain a program name). Note that the "
22106 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22110 #: ../fish/guestfish-actions.pod:730
22111 msgid "command-lines"
22115 #: ../fish/guestfish-actions.pod:732
22118 " command-lines 'arguments ...'\n"
22123 #: ../fish/guestfish-actions.pod:734
22124 msgid "This is the same as L</command>, but splits the result into a list of lines."
22128 #: ../fish/guestfish-actions.pod:737
22129 msgid "See also: L</sh-lines>"
22133 #: ../fish/guestfish-actions.pod:742
22138 #: ../fish/guestfish-actions.pod:744
22141 " config qemuparam qemuvalue\n"
22146 #: ../fish/guestfish-actions.pod:755
22151 #: ../fish/guestfish-actions.pod:757
22154 " copy-size src dest size\n"
22159 #: ../fish/guestfish-actions.pod:765
22164 #: ../fish/guestfish-actions.pod:767
22172 #: ../fish/guestfish-actions.pod:772
22177 #: ../fish/guestfish-actions.pod:774
22185 #: ../fish/guestfish-actions.pod:779
22190 #: ../fish/guestfish-actions.pod:781
22198 #: ../fish/guestfish-actions.pod:788
22200 "If the destination is a device, it must be as large or larger than the "
22201 "source file or device, otherwise the copy will fail. This command cannot do "
22202 "partial copies (see L</copy-size>)."
22206 #: ../fish/guestfish-actions.pod:792
22211 #: ../fish/guestfish-actions.pod:794
22219 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
22221 "This command is mostly useful for interactive sessions. It is I<not> "
22222 "intended that you try to parse the output string. Use L</statvfs> from "
22227 #: ../fish/guestfish-actions.pod:802
22232 #: ../fish/guestfish-actions.pod:804
22240 #: ../fish/guestfish-actions.pod:813
22245 #: ../fish/guestfish-actions.pod:815
22253 #: ../fish/guestfish-actions.pod:821
22255 "Another way to get the same information is to enable verbose messages with "
22256 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22257 "before running the program."
22261 #: ../fish/guestfish-actions.pod:826
22266 #: ../fish/guestfish-actions.pod:828
22269 " download remotefilename (filename|-)\n"
22274 #: ../fish/guestfish-actions.pod:835
22275 msgid "See also L</upload>, L</cat>."
22279 #: ../fish/guestfish-actions.pod:839
22280 msgid "download-offset"
22284 #: ../fish/guestfish-actions.pod:841
22287 " download-offset remotefilename (filename|-) offset size\n"
22292 #: ../fish/guestfish-actions.pod:849
22294 "Note that there is no limit on the amount of data that can be downloaded "
22295 "with this call, unlike with L</pread>, and this call always reads the full "
22296 "amount unless an error occurs."
22300 #: ../fish/guestfish-actions.pod:854
22301 msgid "See also L</download>, L</pread>."
22305 #: ../fish/guestfish-actions.pod:858
22306 msgid "drop-caches"
22310 #: ../fish/guestfish-actions.pod:860
22313 " drop-caches whattodrop\n"
22318 #: ../fish/guestfish-actions.pod:872
22323 #: ../fish/guestfish-actions.pod:874
22331 #: ../fish/guestfish-actions.pod:886
22336 #: ../fish/guestfish-actions.pod:888
22339 " e2fsck-f device\n"
22344 #: ../fish/guestfish-actions.pod:894
22346 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22347 "should use L</fsck>."
22351 #: ../fish/guestfish-actions.pod:897
22352 msgid "echo-daemon"
22356 #: ../fish/guestfish-actions.pod:899
22359 " echo-daemon 'words ...'\n"
22364 #: ../fish/guestfish-actions.pod:906
22365 msgid "See also L</ping-daemon>."
22369 #: ../fish/guestfish-actions.pod:908
22374 #: ../fish/guestfish-actions.pod:910
22377 " egrep regex path\n"
22382 #: ../fish/guestfish-actions.pod:918
22387 #: ../fish/guestfish-actions.pod:920
22390 " egrepi regex path\n"
22395 #: ../fish/guestfish-actions.pod:928
22400 #: ../fish/guestfish-actions.pod:930
22403 " equal file1 file2\n"
22408 #: ../fish/guestfish-actions.pod:937
22413 #: ../fish/guestfish-actions.pod:939
22421 #: ../fish/guestfish-actions.pod:944
22422 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22426 #: ../fish/guestfish-actions.pod:946
22431 #: ../fish/guestfish-actions.pod:948
22434 " fallocate path len\n"
22439 #: ../fish/guestfish-actions.pod:965
22440 msgid "fallocate64"
22444 #: ../fish/guestfish-actions.pod:967
22447 " fallocate64 path len\n"
22452 #: ../fish/guestfish-actions.pod:973
22454 "Note that this call allocates disk blocks for the file. To create a sparse "
22455 "file use L</truncate-size> instead."
22459 #: ../fish/guestfish-actions.pod:976
22461 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22462 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22463 "maximum size of files created through that call to 1GB."
22467 #: ../fish/guestfish-actions.pod:985
22472 #: ../fish/guestfish-actions.pod:987
22475 " fgrep pattern path\n"
22480 #: ../fish/guestfish-actions.pod:995
22485 #: ../fish/guestfish-actions.pod:997
22488 " fgrepi pattern path\n"
22493 #: ../fish/guestfish-actions.pod:1005
22498 #: ../fish/guestfish-actions.pod:1007
22506 #: ../fish/guestfish-actions.pod:1019
22508 "This command can also be used on C</dev/> devices (and partitions, LV "
22509 "names). You can for example use this to determine if a device contains a "
22510 "filesystem, although it's usually better to use L</vfs-type>."
22514 #: ../fish/guestfish-actions.pod:1029
22515 msgid "file-architecture"
22519 #: ../fish/guestfish-actions.pod:1031
22522 " file-architecture filename\n"
22527 #: ../fish/guestfish-actions.pod:1134
22532 #: ../fish/guestfish-actions.pod:1136
22540 #: ../fish/guestfish-actions.pod:1140
22542 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22543 "L</is-file> etc. To get the size of block devices, use "
22544 "L</blockdev-getsize64>."
22548 #: ../fish/guestfish-actions.pod:1144
22553 #: ../fish/guestfish-actions.pod:1146
22556 " fill c len path\n"
22561 #: ../fish/guestfish-actions.pod:1152
22563 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22564 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22565 "L</fill-pattern>."
22569 #: ../fish/guestfish-actions.pod:1157
22570 msgid "fill-pattern"
22574 #: ../fish/guestfish-actions.pod:1159
22577 " fill-pattern pattern len path\n"
22582 #: ../fish/guestfish-actions.pod:1161
22584 "This function is like L</fill> except that it creates a new file of length "
22585 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22586 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22591 #: ../fish/guestfish-actions.pod:1166
22596 #: ../fish/guestfish-actions.pod:1168
22599 " find directory\n"
22604 #: ../fish/guestfish-actions.pod:1182
22605 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22609 #: ../fish/guestfish-actions.pod:1195
22610 msgid "See also L</find0>."
22614 #: ../fish/guestfish-actions.pod:1200
22619 #: ../fish/guestfish-actions.pod:1202
22622 " find0 directory (files|-)\n"
22627 #: ../fish/guestfish-actions.pod:1208
22628 msgid "This command works the same way as L</find> with the following exceptions:"
22632 #: ../fish/guestfish-actions.pod:1235
22633 msgid "findfs-label"
22637 #: ../fish/guestfish-actions.pod:1237
22640 " findfs-label label\n"
22645 #: ../fish/guestfish-actions.pod:1243
22646 msgid "To find the label of a filesystem, use L</vfs-label>."
22650 #: ../fish/guestfish-actions.pod:1245
22651 msgid "findfs-uuid"
22655 #: ../fish/guestfish-actions.pod:1247
22658 " findfs-uuid uuid\n"
22663 #: ../fish/guestfish-actions.pod:1253
22664 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22668 #: ../fish/guestfish-actions.pod:1255
22673 #: ../fish/guestfish-actions.pod:1257
22676 " fsck fstype device\n"
22681 #: ../fish/guestfish-actions.pod:1287
22686 #: ../fish/guestfish-actions.pod:1289
22694 #: ../fish/guestfish-actions.pod:1296
22695 msgid "get-attach-method"
22699 #: ../fish/guestfish-actions.pod:1298
22702 " get-attach-method\n"
22707 #: ../fish/guestfish-actions.pod:1300
22708 msgid "Return the current attach method. See L</set-attach-method>."
22712 #: ../fish/guestfish-actions.pod:1302
22713 msgid "get-autosync"
22717 #: ../fish/guestfish-actions.pod:1304
22725 #: ../fish/guestfish-actions.pod:1308
22730 #: ../fish/guestfish-actions.pod:1310
22738 #: ../fish/guestfish-actions.pod:1314
22739 msgid "get-e2label"
22743 #: ../fish/guestfish-actions.pod:1316
22746 " get-e2label device\n"
22751 #: ../fish/guestfish-actions.pod:1328
22756 #: ../fish/guestfish-actions.pod:1330
22759 " get-e2uuid device\n"
22764 #: ../fish/guestfish-actions.pod:1342
22765 msgid "get-memsize"
22769 #: ../fish/guestfish-actions.pod:1344
22777 #: ../fish/guestfish-actions.pod:1349
22779 "If L</set-memsize> was not called on this handle, and if "
22780 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
22781 "value for memsize."
22785 #: ../fish/guestfish-actions.pod:1356
22786 msgid "get-network"
22790 #: ../fish/guestfish-actions.pod:1358
22798 #: ../fish/guestfish-actions.pod:1362
22803 #: ../fish/guestfish-actions.pod:1364
22811 #: ../fish/guestfish-actions.pod:1371
22816 #: ../fish/guestfish-actions.pod:1373
22821 #: ../fish/guestfish-actions.pod:1375
22829 #: ../fish/guestfish-actions.pod:1382
22834 #: ../fish/guestfish-actions.pod:1384
22842 #: ../fish/guestfish-actions.pod:1391
22843 msgid "get-recovery-proc"
22847 #: ../fish/guestfish-actions.pod:1393
22850 " get-recovery-proc\n"
22855 #: ../fish/guestfish-actions.pod:1397
22856 msgid "get-selinux"
22860 #: ../fish/guestfish-actions.pod:1399
22868 #: ../fish/guestfish-actions.pod:1401
22870 "This returns the current setting of the selinux flag which is passed to the "
22871 "appliance at boot time. See L</set-selinux>."
22875 #: ../fish/guestfish-actions.pod:1407
22880 #: ../fish/guestfish-actions.pod:1409
22888 #: ../fish/guestfish-actions.pod:1416
22893 #: ../fish/guestfish-actions.pod:1418
22901 #: ../fish/guestfish-actions.pod:1422
22906 #: ../fish/guestfish-actions.pod:1424
22914 #: ../fish/guestfish-actions.pod:1426
22916 "Return the current umask. By default the umask is C<022> unless it has been "
22917 "set by calling L</umask>."
22921 #: ../fish/guestfish-actions.pod:1429
22922 msgid "get-verbose"
22926 #: ../fish/guestfish-actions.pod:1431
22934 #: ../fish/guestfish-actions.pod:1435
22939 #: ../fish/guestfish-actions.pod:1437
22947 #: ../fish/guestfish-actions.pod:1441
22948 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
22952 #: ../fish/guestfish-actions.pod:1444
22957 #: ../fish/guestfish-actions.pod:1446
22960 " getxattr path name\n"
22965 #: ../fish/guestfish-actions.pod:1448
22967 "Get a single extended attribute from file C<path> named C<name>. This call "
22968 "follows symlinks. If you want to lookup an extended attribute for the "
22969 "symlink itself, use L</lgetxattr>."
22973 #: ../fish/guestfish-actions.pod:1452 ../fish/guestfish-actions.pod:2458
22975 "Normally it is better to get all extended attributes from a file in one go "
22976 "by calling L</getxattrs>. However some Linux filesystem implementations are "
22977 "buggy and do not provide a way to list out attributes. For these "
22978 "filesystems (notably ntfs-3g) you have to know the names of the extended "
22979 "attributes you want in advance and call this function."
22983 #: ../fish/guestfish-actions.pod:1462
22984 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
22988 #: ../fish/guestfish-actions.pod:1464
22993 #: ../fish/guestfish-actions.pod:1466
22996 " getxattrs path\n"
23001 #: ../fish/guestfish-actions.pod:1474
23002 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23006 #: ../fish/guestfish-actions.pod:1476
23007 msgid "glob-expand"
23011 #: ../fish/guestfish-actions.pod:1478
23014 " glob-expand pattern\n"
23019 #: ../fish/guestfish-actions.pod:1491
23024 #: ../fish/guestfish-actions.pod:1493
23027 " grep regex path\n"
23032 #: ../fish/guestfish-actions.pod:1501
23037 #: ../fish/guestfish-actions.pod:1503
23040 " grepi regex path\n"
23045 #: ../fish/guestfish-actions.pod:1511
23046 msgid "grub-install"
23050 #: ../fish/guestfish-actions.pod:1513
23053 " grub-install root device\n"
23058 #: ../fish/guestfish-actions.pod:1529
23063 #: ../fish/guestfish-actions.pod:1531
23071 #: ../fish/guestfish-actions.pod:1539
23076 #: ../fish/guestfish-actions.pod:1541
23079 " head-n nrlines path\n"
23084 #: ../fish/guestfish-actions.pod:1554
23089 #: ../fish/guestfish-actions.pod:1556
23097 #: ../fish/guestfish-actions.pod:1564
23102 #: ../fish/guestfish-actions.pod:1566
23105 " initrd-cat initrdpath filename\n"
23110 #: ../fish/guestfish-actions.pod:1578
23111 msgid "See also L</initrd-list>."
23115 #: ../fish/guestfish-actions.pod:1583
23116 msgid "initrd-list"
23120 #: ../fish/guestfish-actions.pod:1585
23123 " initrd-list path\n"
23128 #: ../fish/guestfish-actions.pod:1597
23129 msgid "inotify-add-watch"
23133 #: ../fish/guestfish-actions.pod:1599
23136 " inotify-add-watch path mask\n"
23141 #: ../fish/guestfish-actions.pod:1611
23142 msgid "inotify-close"
23146 #: ../fish/guestfish-actions.pod:1613
23154 #: ../fish/guestfish-actions.pod:1619
23155 msgid "inotify-files"
23159 #: ../fish/guestfish-actions.pod:1621
23167 #: ../fish/guestfish-actions.pod:1623
23169 "This function is a helpful wrapper around L</inotify-read> which just "
23170 "returns a list of pathnames of objects that were touched. The returned "
23171 "pathnames are sorted and deduplicated."
23175 #: ../fish/guestfish-actions.pod:1627
23176 msgid "inotify-init"
23180 #: ../fish/guestfish-actions.pod:1629
23183 " inotify-init maxevents\n"
23188 #: ../fish/guestfish-actions.pod:1635
23190 "C<maxevents> is the maximum number of events which will be queued up between "
23191 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23192 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23193 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23194 "but records the fact that it threw them away by setting a flag "
23195 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23199 #: ../fish/guestfish-actions.pod:1645
23201 "Before any events are generated, you have to add some watches to the "
23202 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23203 "L</inotify-watch-all>."
23207 #: ../fish/guestfish-actions.pod:1651
23209 "Queued up events should be read periodically by calling L</inotify-read> (or "
23210 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23211 "If you don't read the events out often enough then you risk the internal "
23212 "queue overflowing."
23216 #: ../fish/guestfish-actions.pod:1658
23218 "The handle should be closed after use by calling L</inotify-close>. This "
23219 "also removes any watches automatically."
23223 #: ../fish/guestfish-actions.pod:1667
23224 msgid "inotify-read"
23228 #: ../fish/guestfish-actions.pod:1669
23236 #: ../fish/guestfish-actions.pod:1682
23237 msgid "inotify-rm-watch"
23241 #: ../fish/guestfish-actions.pod:1684
23244 " inotify-rm-watch wd\n"
23249 #: ../fish/guestfish-actions.pod:1686
23250 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23254 #: ../fish/guestfish-actions.pod:1689
23255 msgid "inspect-get-arch"
23259 #: ../fish/guestfish-actions.pod:1691
23262 " inspect-get-arch root\n"
23267 #: ../fish/guestfish-actions.pod:1693 ../fish/guestfish-actions.pod:1709 ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1831 ../fish/guestfish-actions.pod:1849 ../fish/guestfish-actions.pod:1883 ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1919 ../fish/guestfish-actions.pod:1934 ../fish/guestfish-actions.pod:1967 ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2013 ../fish/guestfish-actions.pod:2030 ../fish/guestfish-actions.pod:2073 ../fish/guestfish-actions.pod:2108 ../fish/guestfish-actions.pod:2124 ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2166 ../fish/guestfish-actions.pod:2181
23269 "This function should only be called with a root device string as returned by "
23274 #: ../fish/guestfish-actions.pod:1696
23276 "This returns the architecture of the inspected operating system. The "
23277 "possible return values are listed under L</file-architecture>."
23281 #: ../fish/guestfish-actions.pod:1705
23282 msgid "inspect-get-distro"
23286 #: ../fish/guestfish-actions.pod:1707
23289 " inspect-get-distro root\n"
23294 #: ../fish/guestfish-actions.pod:1791
23295 msgid "inspect-get-drive-mappings"
23299 #: ../fish/guestfish-actions.pod:1793
23302 " inspect-get-drive-mappings root\n"
23307 #: ../fish/guestfish-actions.pod:1823
23309 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23310 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23314 #: ../fish/guestfish-actions.pod:1827
23315 msgid "inspect-get-filesystems"
23319 #: ../fish/guestfish-actions.pod:1829
23322 " inspect-get-filesystems root\n"
23327 #: ../fish/guestfish-actions.pod:1842
23329 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23330 "L</inspect-get-mountpoints>."
23334 #: ../fish/guestfish-actions.pod:1845
23335 msgid "inspect-get-format"
23339 #: ../fish/guestfish-actions.pod:1847
23342 " inspect-get-format root\n"
23347 #: ../fish/guestfish-actions.pod:1879
23348 msgid "inspect-get-hostname"
23352 #: ../fish/guestfish-actions.pod:1881
23355 " inspect-get-hostname root\n"
23360 #: ../fish/guestfish-actions.pod:1894
23361 msgid "inspect-get-major-version"
23365 #: ../fish/guestfish-actions.pod:1896
23368 " inspect-get-major-version root\n"
23373 #: ../fish/guestfish-actions.pod:1915
23374 msgid "inspect-get-minor-version"
23378 #: ../fish/guestfish-actions.pod:1917
23381 " inspect-get-minor-version root\n"
23386 #: ../fish/guestfish-actions.pod:1927
23388 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23389 "L</inspect-get-major-version>."
23393 #: ../fish/guestfish-actions.pod:1930
23394 msgid "inspect-get-mountpoints"
23398 #: ../fish/guestfish-actions.pod:1932
23401 " inspect-get-mountpoints root\n"
23406 #: ../fish/guestfish-actions.pod:1954
23408 "For operating systems like Windows which still use drive letters, this call "
23409 "will only return an entry for the first drive \"mounted on\" C</>. For "
23410 "information about the mapping of drive letters to partitions, see "
23411 "L</inspect-get-drive-mappings>."
23415 #: ../fish/guestfish-actions.pod:1960
23417 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23418 "L</inspect-get-filesystems>."
23422 #: ../fish/guestfish-actions.pod:1963
23423 msgid "inspect-get-package-format"
23427 #: ../fish/guestfish-actions.pod:1965
23430 " inspect-get-package-format root\n"
23435 #: ../fish/guestfish-actions.pod:1970
23437 "This function and L</inspect-get-package-management> return the package "
23438 "format and package management tool used by the inspected operating system. "
23439 "For example for Fedora these functions would return C<rpm> (package format) "
23440 "and C<yum> (package management)."
23444 #: ../fish/guestfish-actions.pod:1985
23445 msgid "inspect-get-package-management"
23449 #: ../fish/guestfish-actions.pod:1987
23452 " inspect-get-package-management root\n"
23457 #: ../fish/guestfish-actions.pod:1992
23459 "L</inspect-get-package-format> and this function return the package format "
23460 "and package management tool used by the inspected operating system. For "
23461 "example for Fedora these functions would return C<rpm> (package format) and "
23462 "C<yum> (package management)."
23466 #: ../fish/guestfish-actions.pod:2009
23467 msgid "inspect-get-product-name"
23471 #: ../fish/guestfish-actions.pod:2011
23474 " inspect-get-product-name root\n"
23479 #: ../fish/guestfish-actions.pod:2026
23480 msgid "inspect-get-product-variant"
23484 #: ../fish/guestfish-actions.pod:2028
23487 " inspect-get-product-variant root\n"
23492 #: ../fish/guestfish-actions.pod:2052
23494 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23495 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23499 #: ../fish/guestfish-actions.pod:2056
23500 msgid "inspect-get-roots"
23504 #: ../fish/guestfish-actions.pod:2058
23507 " inspect-get-roots\n"
23512 #: ../fish/guestfish-actions.pod:2060
23514 "This function is a convenient way to get the list of root devices, as "
23515 "returned from a previous call to L</inspect-os>, but without redoing the "
23516 "whole inspection process."
23520 #: ../fish/guestfish-actions.pod:2064
23522 "This returns an empty list if either no root devices were found or the "
23523 "caller has not called L</inspect-os>."
23527 #: ../fish/guestfish-actions.pod:2069
23528 msgid "inspect-get-type"
23532 #: ../fish/guestfish-actions.pod:2071
23535 " inspect-get-type root\n"
23540 #: ../fish/guestfish-actions.pod:2104
23541 msgid "inspect-get-windows-current-control-set"
23545 #: ../fish/guestfish-actions.pod:2106
23548 " inspect-get-windows-current-control-set root\n"
23553 #: ../fish/guestfish-actions.pod:2120
23554 msgid "inspect-get-windows-systemroot"
23558 #: ../fish/guestfish-actions.pod:2122
23561 " inspect-get-windows-systemroot root\n"
23566 #: ../fish/guestfish-actions.pod:2136
23567 msgid "inspect-is-live"
23571 #: ../fish/guestfish-actions.pod:2138
23574 " inspect-is-live root\n"
23579 #: ../fish/guestfish-actions.pod:2143
23581 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23582 "then this returns true if a live image was detected on the disk."
23586 #: ../fish/guestfish-actions.pod:2149
23587 msgid "inspect-is-multipart"
23591 #: ../fish/guestfish-actions.pod:2151
23594 " inspect-is-multipart root\n"
23599 #: ../fish/guestfish-actions.pod:2156
23601 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23602 "then this returns true if the disk is part of a set."
23606 #: ../fish/guestfish-actions.pod:2162
23607 msgid "inspect-is-netinst"
23611 #: ../fish/guestfish-actions.pod:2164
23614 " inspect-is-netinst root\n"
23619 #: ../fish/guestfish-actions.pod:2169
23621 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23622 "then this returns true if the disk is a network installer, ie. not a "
23623 "self-contained install CD but one which is likely to require network access "
23624 "to complete the install."
23628 #: ../fish/guestfish-actions.pod:2177
23629 msgid "inspect-list-applications"
23633 #: ../fish/guestfish-actions.pod:2179
23636 " inspect-list-applications root\n"
23641 #: ../fish/guestfish-actions.pod:2186
23643 "I<Note:> This call works differently from other parts of the inspection "
23644 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23645 "then mount up the disks, before calling this. Listing applications is a "
23646 "significantly more difficult operation which requires access to the full "
23647 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23648 "are just returning data cached in the libguestfs handle, this call actually "
23649 "reads parts of the mounted filesystems during the call."
23653 #: ../fish/guestfish-actions.pod:2276
23658 #: ../fish/guestfish-actions.pod:2278
23666 #: ../fish/guestfish-actions.pod:2293
23668 "You can pass the root string(s) returned to other L</inspect-get-*> "
23669 "functions in order to query further information about each operating system, "
23670 "such as the name and version."
23674 #: ../fish/guestfish-actions.pod:2298
23676 "This function uses other libguestfs features such as L</mount-ro> and "
23677 "L</umount-all> in order to mount and unmount filesystems and look at the "
23678 "contents. This should be called with no disks currently mounted. The "
23679 "function may also use Augeas, so any existing Augeas handle will be closed."
23683 #: ../fish/guestfish-actions.pod:2310 ../fish/guestfish-actions.pod:2486 ../fish/guestfish-actions.pod:2532
23684 msgid "See also L</list-filesystems>."
23688 #: ../fish/guestfish-actions.pod:2312
23689 msgid "is-blockdev"
23693 #: ../fish/guestfish-actions.pod:2314
23696 " is-blockdev path\n"
23701 #: ../fish/guestfish-actions.pod:2319 ../fish/guestfish-actions.pod:2337 ../fish/guestfish-actions.pod:2356 ../fish/guestfish-actions.pod:2365 ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2409 ../fish/guestfish-actions.pod:2418
23702 msgid "See also L</stat>."
23706 #: ../fish/guestfish-actions.pod:2321
23711 #: ../fish/guestfish-actions.pod:2323
23719 #: ../fish/guestfish-actions.pod:2330
23724 #: ../fish/guestfish-actions.pod:2332
23727 " is-chardev path\n"
23732 #: ../fish/guestfish-actions.pod:2339
23737 #: ../fish/guestfish-actions.pod:2341
23745 #: ../fish/guestfish-actions.pod:2348
23750 #: ../fish/guestfish-actions.pod:2350
23758 #: ../fish/guestfish-actions.pod:2358
23763 #: ../fish/guestfish-actions.pod:2360
23771 #: ../fish/guestfish-actions.pod:2367
23776 #: ../fish/guestfish-actions.pod:2369
23784 #: ../fish/guestfish-actions.pod:2377
23785 msgid "is-launching"
23789 #: ../fish/guestfish-actions.pod:2379
23797 #: ../fish/guestfish-actions.pod:2386
23802 #: ../fish/guestfish-actions.pod:2388
23810 #: ../fish/guestfish-actions.pod:2393
23815 #: ../fish/guestfish-actions.pod:2395
23823 #: ../fish/guestfish-actions.pod:2402
23828 #: ../fish/guestfish-actions.pod:2404
23831 " is-socket path\n"
23836 #: ../fish/guestfish-actions.pod:2411
23841 #: ../fish/guestfish-actions.pod:2413
23844 " is-symlink path\n"
23849 #: ../fish/guestfish-actions.pod:2420
23850 msgid "kill-subprocess"
23854 #: ../fish/guestfish-actions.pod:2422
23857 " kill-subprocess\n"
23862 #: ../fish/guestfish-actions.pod:2426
23867 #: ../fish/guestfish-actions.pod:2428
23872 #: ../fish/guestfish-actions.pod:2430
23880 #: ../fish/guestfish-actions.pod:2438
23885 #: ../fish/guestfish-actions.pod:2440
23888 " lchown owner group path\n"
23893 #: ../fish/guestfish-actions.pod:2442
23895 "Change the file owner to C<owner> and group to C<group>. This is like "
23896 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
23901 #: ../fish/guestfish-actions.pod:2450
23906 #: ../fish/guestfish-actions.pod:2452
23909 " lgetxattr path name\n"
23914 #: ../fish/guestfish-actions.pod:2468
23915 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
23919 #: ../fish/guestfish-actions.pod:2470
23924 #: ../fish/guestfish-actions.pod:2472
23927 " lgetxattrs path\n"
23932 #: ../fish/guestfish-actions.pod:2474
23934 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
23935 "it returns the extended attributes of the link itself."
23939 #: ../fish/guestfish-actions.pod:2478
23940 msgid "list-devices"
23944 #: ../fish/guestfish-actions.pod:2480
23952 #: ../fish/guestfish-actions.pod:2488
23953 msgid "list-filesystems"
23957 #: ../fish/guestfish-actions.pod:2490
23960 " list-filesystems\n"
23965 #: ../fish/guestfish-actions.pod:2509
23967 "This command runs other libguestfs commands, which might include L</mount> "
23968 "and L</umount>, and therefore you should use this soon after launch and only "
23969 "when nothing is mounted."
23973 #: ../fish/guestfish-actions.pod:2513
23975 "Not all of the filesystems returned will be mountable. In particular, swap "
23976 "partitions are returned in the list. Also this command does not check that "
23977 "each filesystem found is valid and mountable, and some filesystems might be "
23978 "mountable but require special options. Filesystems may not all belong to a "
23979 "single logical operating system (use L</inspect-os> to look for OSes)."
23983 #: ../fish/guestfish-actions.pod:2521
23984 msgid "list-partitions"
23988 #: ../fish/guestfish-actions.pod:2523
23991 " list-partitions\n"
23996 #: ../fish/guestfish-actions.pod:2529
23998 "This does not return logical volumes. For that you will need to call "
24003 #: ../fish/guestfish-actions.pod:2534
24008 #: ../fish/guestfish-actions.pod:2536
24016 #: ../fish/guestfish-actions.pod:2544
24021 #: ../fish/guestfish-actions.pod:2546
24024 " ln target linkname\n"
24029 #: ../fish/guestfish-actions.pod:2550
24034 #: ../fish/guestfish-actions.pod:2552
24037 " ln-f target linkname\n"
24042 #: ../fish/guestfish-actions.pod:2557
24047 #: ../fish/guestfish-actions.pod:2559
24050 " ln-s target linkname\n"
24055 #: ../fish/guestfish-actions.pod:2563
24060 #: ../fish/guestfish-actions.pod:2565
24063 " ln-sf target linkname\n"
24068 #: ../fish/guestfish-actions.pod:2570
24069 msgid "lremovexattr"
24073 #: ../fish/guestfish-actions.pod:2572
24076 " lremovexattr xattr path\n"
24081 #: ../fish/guestfish-actions.pod:2574
24083 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24084 "it removes an extended attribute of the link itself."
24088 #: ../fish/guestfish-actions.pod:2578
24093 #: ../fish/guestfish-actions.pod:2580
24101 #: ../fish/guestfish-actions.pod:2586
24103 "This command is mostly useful for interactive sessions. Programs should "
24104 "probably use L</readdir> instead."
24108 #: ../fish/guestfish-actions.pod:2589
24113 #: ../fish/guestfish-actions.pod:2591
24116 " lsetxattr xattr val vallen path\n"
24121 #: ../fish/guestfish-actions.pod:2593
24123 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24124 "sets an extended attribute of the link itself."
24128 #: ../fish/guestfish-actions.pod:2597
24133 #: ../fish/guestfish-actions.pod:2599
24141 #: ../fish/guestfish-actions.pod:2603
24143 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24144 "the link is stat-ed, not the file it refers to."
24148 #: ../fish/guestfish-actions.pod:2609
24153 #: ../fish/guestfish-actions.pod:2611
24156 " lstatlist path 'names ...'\n"
24161 #: ../fish/guestfish-actions.pod:2613
24163 "This call allows you to perform the L</lstat> operation on multiple files, "
24164 "where all files are in the directory C<path>. C<names> is the list of files "
24165 "from this directory."
24169 #: ../fish/guestfish-actions.pod:2622
24171 "This call is intended for programs that want to efficiently list a directory "
24172 "contents without making many round-trips. See also L</lxattrlist> for a "
24173 "similarly efficient call for getting extended attributes. Very long "
24174 "directory listings might cause the protocol message size to be exceeded, "
24175 "causing this call to fail. The caller must split up such requests into "
24176 "smaller groups of names."
24180 #: ../fish/guestfish-actions.pod:2630
24181 msgid "luks-add-key"
24185 #: ../fish/guestfish-actions.pod:2632
24188 " luks-add-key device keyslot\n"
24193 #: ../fish/guestfish-actions.pod:2639
24195 "Note that if C<keyslot> already contains a key, then this command will "
24196 "fail. You have to use L</luks-kill-slot> first to remove that key."
24200 #: ../fish/guestfish-actions.pod:2643 ../fish/guestfish-actions.pod:2665 ../fish/guestfish-actions.pod:2678 ../fish/guestfish-actions.pod:2692 ../fish/guestfish-actions.pod:2715 ../fish/guestfish-actions.pod:2725
24202 "This command has one or more key or passphrase parameters. Guestfish will "
24203 "prompt for these separately."
24207 #: ../fish/guestfish-actions.pod:2646
24212 #: ../fish/guestfish-actions.pod:2648
24215 " luks-close device\n"
24220 #: ../fish/guestfish-actions.pod:2650
24222 "This closes a LUKS device that was created earlier by L</luks-open> or "
24223 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
24224 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
24225 "underlying block device."
24229 #: ../fish/guestfish-actions.pod:2656
24230 msgid "luks-format"
24234 #: ../fish/guestfish-actions.pod:2658
24237 " luks-format device keyslot\n"
24242 #: ../fish/guestfish-actions.pod:2671
24243 msgid "luks-format-cipher"
24247 #: ../fish/guestfish-actions.pod:2673
24250 " luks-format-cipher device keyslot cipher\n"
24255 #: ../fish/guestfish-actions.pod:2675
24257 "This command is the same as L</luks-format> but it also allows you to set "
24258 "the C<cipher> used."
24262 #: ../fish/guestfish-actions.pod:2684
24263 msgid "luks-kill-slot"
24267 #: ../fish/guestfish-actions.pod:2686
24270 " luks-kill-slot device keyslot\n"
24275 #: ../fish/guestfish-actions.pod:2695
24280 #: ../fish/guestfish-actions.pod:2697
24283 " luks-open device mapname\n"
24288 #: ../fish/guestfish-actions.pod:2711
24290 "If this block device contains LVM volume groups, then calling L</vgscan> "
24291 "followed by L</vg-activate-all> will make them visible."
24295 #: ../fish/guestfish-actions.pod:2718
24296 msgid "luks-open-ro"
24300 #: ../fish/guestfish-actions.pod:2720
24303 " luks-open-ro device mapname\n"
24308 #: ../fish/guestfish-actions.pod:2722
24310 "This is the same as L</luks-open> except that a read-only mapping is "
24315 #: ../fish/guestfish-actions.pod:2728
24320 #: ../fish/guestfish-actions.pod:2730
24323 " lvcreate logvol volgroup mbytes\n"
24328 #: ../fish/guestfish-actions.pod:2735
24329 msgid "lvm-canonical-lv-name"
24333 #: ../fish/guestfish-actions.pod:2737
24336 " lvm-canonical-lv-name lvname\n"
24341 #: ../fish/guestfish-actions.pod:2746
24342 msgid "See also L</is-lv>."
24346 #: ../fish/guestfish-actions.pod:2748
24347 msgid "lvm-clear-filter"
24351 #: ../fish/guestfish-actions.pod:2750
24354 " lvm-clear-filter\n"
24359 #: ../fish/guestfish-actions.pod:2752
24361 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24366 #: ../fish/guestfish-actions.pod:2758
24367 msgid "lvm-remove-all"
24371 #: ../fish/guestfish-actions.pod:2760
24374 " lvm-remove-all\n"
24379 #: ../fish/guestfish-actions.pod:2768
24380 msgid "lvm-set-filter"
24384 #: ../fish/guestfish-actions.pod:2770
24387 " lvm-set-filter 'devices ...'\n"
24392 #: ../fish/guestfish-actions.pod:2795
24397 #: ../fish/guestfish-actions.pod:2797
24400 " lvremove device\n"
24405 #: ../fish/guestfish-actions.pod:2805
24410 #: ../fish/guestfish-actions.pod:2807
24413 " lvrename logvol newlogvol\n"
24418 #: ../fish/guestfish-actions.pod:2811
24423 #: ../fish/guestfish-actions.pod:2813
24426 " lvresize device mbytes\n"
24431 #: ../fish/guestfish-actions.pod:2819
24432 msgid "lvresize-free"
24436 #: ../fish/guestfish-actions.pod:2821
24439 " lvresize-free lv percent\n"
24444 #: ../fish/guestfish-actions.pod:2829
24449 #: ../fish/guestfish-actions.pod:2831
24457 #: ../fish/guestfish-actions.pod:2839
24458 msgid "See also L</lvs-full>, L</list-filesystems>."
24462 #: ../fish/guestfish-actions.pod:2841
24467 #: ../fish/guestfish-actions.pod:2843
24475 #: ../fish/guestfish-actions.pod:2848
24480 #: ../fish/guestfish-actions.pod:2850
24488 #: ../fish/guestfish-actions.pod:2854
24493 #: ../fish/guestfish-actions.pod:2856
24496 " lxattrlist path 'names ...'\n"
24501 #: ../fish/guestfish-actions.pod:2872
24503 "This call is intended for programs that want to efficiently list a directory "
24504 "contents without making many round-trips. See also L</lstatlist> for a "
24505 "similarly efficient call for getting standard stats. Very long directory "
24506 "listings might cause the protocol message size to be exceeded, causing this "
24507 "call to fail. The caller must split up such requests into smaller groups of "
24512 #: ../fish/guestfish-actions.pod:2880
24517 #: ../fish/guestfish-actions.pod:2882
24525 #: ../fish/guestfish-actions.pod:2886
24530 #: ../fish/guestfish-actions.pod:2888
24533 " mkdir-mode path mode\n"
24538 #: ../fish/guestfish-actions.pod:2897
24539 msgid "See also L</mkdir>, L</umask>"
24543 #: ../fish/guestfish-actions.pod:2899
24548 #: ../fish/guestfish-actions.pod:2901
24556 #: ../fish/guestfish-actions.pod:2906
24561 #: ../fish/guestfish-actions.pod:2908
24564 " mkdtemp template\n"
24569 #: ../fish/guestfish-actions.pod:2929
24574 #: ../fish/guestfish-actions.pod:2931
24577 " mke2fs-J fstype blocksize device journal\n"
24582 #: ../fish/guestfish-actions.pod:2939
24583 msgid "See also L</mke2journal>."
24587 #: ../fish/guestfish-actions.pod:2941
24592 #: ../fish/guestfish-actions.pod:2943
24595 " mke2fs-JL fstype blocksize device label\n"
24600 #: ../fish/guestfish-actions.pod:2948
24601 msgid "See also L</mke2journal-L>."
24605 #: ../fish/guestfish-actions.pod:2950
24610 #: ../fish/guestfish-actions.pod:2952
24613 " mke2fs-JU fstype blocksize device uuid\n"
24618 #: ../fish/guestfish-actions.pod:2957
24619 msgid "See also L</mke2journal-U>."
24623 #: ../fish/guestfish-actions.pod:2959
24624 msgid "mke2journal"
24628 #: ../fish/guestfish-actions.pod:2961
24631 " mke2journal blocksize device\n"
24636 #: ../fish/guestfish-actions.pod:2968
24637 msgid "mke2journal-L"
24641 #: ../fish/guestfish-actions.pod:2970
24644 " mke2journal-L blocksize label device\n"
24649 #: ../fish/guestfish-actions.pod:2974
24650 msgid "mke2journal-U"
24654 #: ../fish/guestfish-actions.pod:2976
24657 " mke2journal-U blocksize uuid device\n"
24662 #: ../fish/guestfish-actions.pod:2980
24667 #: ../fish/guestfish-actions.pod:2982
24670 " mkfifo mode path\n"
24675 #: ../fish/guestfish-actions.pod:2984
24677 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
24678 "is just a convenient wrapper around L</mknod>."
24682 #: ../fish/guestfish-actions.pod:2990
24687 #: ../fish/guestfish-actions.pod:2992
24690 " mkfs fstype device\n"
24695 #: ../fish/guestfish-actions.pod:2998
24700 #: ../fish/guestfish-actions.pod:3000
24703 " mkfs-b fstype blocksize device\n"
24708 #: ../fish/guestfish-actions.pod:3002
24710 "This call is similar to L</mkfs>, but it allows you to control the block "
24711 "size of the resulting filesystem. Supported block sizes depend on the "
24712 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
24716 #: ../fish/guestfish-actions.pod:3017
24721 #: ../fish/guestfish-actions.pod:3019
24724 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
24729 #: ../fish/guestfish-actions.pod:3054
24730 msgid "mkmountpoint"
24734 #: ../fish/guestfish-actions.pod:3056
24737 " mkmountpoint exemptpath\n"
24742 #: ../fish/guestfish-actions.pod:3058
24744 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
24745 "to create extra mountpoints before mounting the first filesystem."
24749 #: ../fish/guestfish-actions.pod:3082
24751 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
24752 "unexpected errors if you try to mix these calls. It is safest to manually "
24753 "unmount filesystems and remove mountpoints after use."
24757 #: ../fish/guestfish-actions.pod:3086
24759 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
24760 "for this to work for manual mountpoints, you must ensure that the innermost "
24761 "mountpoints have the longest pathnames, as in the example code above."
24765 #: ../fish/guestfish-actions.pod:3093
24767 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
24768 "L</umount-all> to be called when the handle is closed which can also trigger "
24773 #: ../fish/guestfish-actions.pod:3097
24778 #: ../fish/guestfish-actions.pod:3099
24781 " mknod mode devmajor devminor path\n"
24786 #: ../fish/guestfish-actions.pod:3109
24788 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
24789 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
24790 "regular file). These constants are available in the standard Linux header "
24791 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
24792 "wrappers around this command which bitwise OR in the appropriate constant "
24797 #: ../fish/guestfish-actions.pod:3119
24802 #: ../fish/guestfish-actions.pod:3121
24805 " mknod-b mode devmajor devminor path\n"
24810 #: ../fish/guestfish-actions.pod:3123
24812 "This call creates a block device node called C<path> with mode C<mode> and "
24813 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24814 "wrapper around L</mknod>."
24818 #: ../fish/guestfish-actions.pod:3129
24823 #: ../fish/guestfish-actions.pod:3131
24826 " mknod-c mode devmajor devminor path\n"
24831 #: ../fish/guestfish-actions.pod:3133
24833 "This call creates a char device node called C<path> with mode C<mode> and "
24834 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24835 "wrapper around L</mknod>."
24839 #: ../fish/guestfish-actions.pod:3139
24844 #: ../fish/guestfish-actions.pod:3141
24852 #: ../fish/guestfish-actions.pod:3145
24857 #: ../fish/guestfish-actions.pod:3147
24860 " mkswap-L label device\n"
24865 #: ../fish/guestfish-actions.pod:3155
24870 #: ../fish/guestfish-actions.pod:3157
24873 " mkswap-U uuid device\n"
24878 #: ../fish/guestfish-actions.pod:3161
24879 msgid "mkswap-file"
24883 #: ../fish/guestfish-actions.pod:3163
24886 " mkswap-file path\n"
24891 #: ../fish/guestfish-actions.pod:3167
24893 "This command just writes a swap file signature to an existing file. To "
24894 "create the file itself, use something like L</fallocate>."
24898 #: ../fish/guestfish-actions.pod:3170
24903 #: ../fish/guestfish-actions.pod:3172
24906 " modprobe modulename\n"
24911 #: ../fish/guestfish-actions.pod:3179
24916 #: ../fish/guestfish-actions.pod:3181
24919 " mount device mountpoint\n"
24924 #: ../fish/guestfish-actions.pod:3197
24926 "B<Important note:> When you use this call, the filesystem options C<sync> "
24927 "and C<noatime> are set implicitly. This was originally done because we "
24928 "thought it would improve reliability, but it turns out that I<-o sync> has a "
24929 "very large negative performance impact and negligible effect on "
24930 "reliability. Therefore we recommend that you avoid using L</mount> in any "
24931 "code that needs performance, and instead use L</mount-options> (use an empty "
24932 "string for the first parameter if you don't want any options)."
24936 #: ../fish/guestfish-actions.pod:3214
24941 #: ../fish/guestfish-actions.pod:3216
24944 " mount-loop file mountpoint\n"
24949 #: ../fish/guestfish-actions.pod:3222
24950 msgid "mount-options"
24954 #: ../fish/guestfish-actions.pod:3224
24957 " mount-options options device mountpoint\n"
24962 #: ../fish/guestfish-actions.pod:3226
24964 "This is the same as the L</mount> command, but it allows you to set the "
24965 "mount options as for the L<mount(8)> I<-o> flag."
24969 #: ../fish/guestfish-actions.pod:3234
24974 #: ../fish/guestfish-actions.pod:3236
24977 " mount-ro device mountpoint\n"
24982 #: ../fish/guestfish-actions.pod:3238
24984 "This is the same as the L</mount> command, but it mounts the filesystem with "
24985 "the read-only (I<-o ro>) flag."
24989 #: ../fish/guestfish-actions.pod:3241
24994 #: ../fish/guestfish-actions.pod:3243
24997 " mount-vfs options vfstype device mountpoint\n"
25002 #: ../fish/guestfish-actions.pod:3245
25004 "This is the same as the L</mount> command, but it allows you to set both the "
25005 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25009 #: ../fish/guestfish-actions.pod:3249
25010 msgid "mountpoints"
25014 #: ../fish/guestfish-actions.pod:3251
25022 #: ../fish/guestfish-actions.pod:3253
25024 "This call is similar to L</mounts>. That call returns a list of devices. "
25025 "This one returns a hash table (map) of device name to directory where the "
25026 "device is mounted."
25030 #: ../fish/guestfish-actions.pod:3257
25035 #: ../fish/guestfish-actions.pod:3259
25043 #: ../fish/guestfish-actions.pod:3266
25044 msgid "See also: L</mountpoints>"
25048 #: ../fish/guestfish-actions.pod:3268
25053 #: ../fish/guestfish-actions.pod:3270
25061 #: ../fish/guestfish-actions.pod:3275
25062 msgid "ntfs-3g-probe"
25066 #: ../fish/guestfish-actions.pod:3277
25069 " ntfs-3g-probe true|false device\n"
25074 #: ../fish/guestfish-actions.pod:3291
25079 #: ../fish/guestfish-actions.pod:3293
25082 " ntfsresize device\n"
25087 #: ../fish/guestfish-actions.pod:3299
25088 msgid "ntfsresize-size"
25092 #: ../fish/guestfish-actions.pod:3301
25095 " ntfsresize-size device size\n"
25100 #: ../fish/guestfish-actions.pod:3303
25102 "This command is the same as L</ntfsresize> except that it allows you to "
25103 "specify the new size (in bytes) explicitly."
25107 #: ../fish/guestfish-actions.pod:3306
25112 #: ../fish/guestfish-actions.pod:3308
25115 " part-add device prlogex startsect endsect\n"
25120 #: ../fish/guestfish-actions.pod:3310
25122 "This command adds a partition to C<device>. If there is no partition table "
25123 "on the device, call L</part-init> first."
25127 #: ../fish/guestfish-actions.pod:3322
25129 "Creating a partition which covers the whole disk is not so easy. Use "
25130 "L</part-disk> to do that."
25134 #: ../fish/guestfish-actions.pod:3325
25139 #: ../fish/guestfish-actions.pod:3327
25142 " part-del device partnum\n"
25147 #: ../fish/guestfish-actions.pod:3335
25152 #: ../fish/guestfish-actions.pod:3337
25155 " part-disk device parttype\n"
25160 #: ../fish/guestfish-actions.pod:3339
25162 "This command is simply a combination of L</part-init> followed by "
25163 "L</part-add> to create a single primary partition covering the whole disk."
25167 #: ../fish/guestfish-actions.pod:3343
25169 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25170 "possible values are described in L</part-init>."
25174 #: ../fish/guestfish-actions.pod:3349
25175 msgid "part-get-bootable"
25179 #: ../fish/guestfish-actions.pod:3351
25182 " part-get-bootable device partnum\n"
25187 #: ../fish/guestfish-actions.pod:3356
25188 msgid "See also L</part-set-bootable>."
25192 #: ../fish/guestfish-actions.pod:3358
25193 msgid "part-get-mbr-id"
25197 #: ../fish/guestfish-actions.pod:3360
25200 " part-get-mbr-id device partnum\n"
25205 #: ../fish/guestfish-actions.pod:3365 ../fish/guestfish-actions.pod:3503
25207 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25208 "undefined results for other partition table types (see "
25209 "L</part-get-parttype>)."
25213 #: ../fish/guestfish-actions.pod:3369
25214 msgid "part-get-parttype"
25218 #: ../fish/guestfish-actions.pod:3371
25221 " part-get-parttype device\n"
25226 #: ../fish/guestfish-actions.pod:3376
25228 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25229 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25230 "possible, although unusual. See L</part-init> for a full list."
25234 #: ../fish/guestfish-actions.pod:3381
25239 #: ../fish/guestfish-actions.pod:3383
25242 " part-init device parttype\n"
25247 #: ../fish/guestfish-actions.pod:3389
25249 "Initially there are no partitions. Following this, you should call "
25250 "L</part-add> for each partition required."
25254 #: ../fish/guestfish-actions.pod:3452
25259 #: ../fish/guestfish-actions.pod:3454
25262 " part-list device\n"
25267 #: ../fish/guestfish-actions.pod:3469
25269 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25270 "the device's sector size, see L</blockdev-getss>."
25274 #: ../fish/guestfish-actions.pod:3482
25275 msgid "part-set-bootable"
25279 #: ../fish/guestfish-actions.pod:3484
25282 " part-set-bootable device partnum true|false\n"
25287 #: ../fish/guestfish-actions.pod:3493
25288 msgid "part-set-mbr-id"
25292 #: ../fish/guestfish-actions.pod:3495
25295 " part-set-mbr-id device partnum idbyte\n"
25300 #: ../fish/guestfish-actions.pod:3507
25301 msgid "part-set-name"
25305 #: ../fish/guestfish-actions.pod:3509
25308 " part-set-name device partnum name\n"
25313 #: ../fish/guestfish-actions.pod:3517
25314 msgid "part-to-dev"
25318 #: ../fish/guestfish-actions.pod:3519
25321 " part-to-dev partition\n"
25326 #: ../fish/guestfish-actions.pod:3525
25328 "The named partition must exist, for example as a string returned from "
25329 "L</list-partitions>."
25333 #: ../fish/guestfish-actions.pod:3528
25334 msgid "ping-daemon"
25338 #: ../fish/guestfish-actions.pod:3530
25346 #: ../fish/guestfish-actions.pod:3537
25351 #: ../fish/guestfish-actions.pod:3539
25354 " pread path count offset\n"
25359 #: ../fish/guestfish-actions.pod:3547
25360 msgid "See also L</pwrite>, L</pread-device>."
25364 #: ../fish/guestfish-actions.pod:3552
25365 msgid "pread-device"
25369 #: ../fish/guestfish-actions.pod:3554
25372 " pread-device device count offset\n"
25377 #: ../fish/guestfish-actions.pod:3562
25378 msgid "See also L</pread>."
25382 #: ../fish/guestfish-actions.pod:3567
25387 #: ../fish/guestfish-actions.pod:3569
25390 " pvcreate device\n"
25395 #: ../fish/guestfish-actions.pod:3575
25400 #: ../fish/guestfish-actions.pod:3577
25403 " pvremove device\n"
25408 #: ../fish/guestfish-actions.pod:3586
25413 #: ../fish/guestfish-actions.pod:3588
25416 " pvresize device\n"
25421 #: ../fish/guestfish-actions.pod:3593
25422 msgid "pvresize-size"
25426 #: ../fish/guestfish-actions.pod:3595
25429 " pvresize-size device size\n"
25434 #: ../fish/guestfish-actions.pod:3597
25436 "This command is the same as L</pvresize> except that it allows you to "
25437 "specify the new size (in bytes) explicitly."
25441 #: ../fish/guestfish-actions.pod:3600
25446 #: ../fish/guestfish-actions.pod:3602
25454 #: ../fish/guestfish-actions.pod:3610
25455 msgid "See also L</pvs-full>."
25459 #: ../fish/guestfish-actions.pod:3612
25464 #: ../fish/guestfish-actions.pod:3614
25472 #: ../fish/guestfish-actions.pod:3619
25477 #: ../fish/guestfish-actions.pod:3621
25485 #: ../fish/guestfish-actions.pod:3625
25490 #: ../fish/guestfish-actions.pod:3627
25493 " pwrite path content offset\n"
25498 #: ../fish/guestfish-actions.pod:3638
25499 msgid "See also L</pread>, L</pwrite-device>."
25503 #: ../fish/guestfish-actions.pod:3643
25504 msgid "pwrite-device"
25508 #: ../fish/guestfish-actions.pod:3645
25511 " pwrite-device device content offset\n"
25516 #: ../fish/guestfish-actions.pod:3655
25517 msgid "See also L</pwrite>."
25521 #: ../fish/guestfish-actions.pod:3660
25526 #: ../fish/guestfish-actions.pod:3662
25529 " read-file path\n"
25534 #: ../fish/guestfish-actions.pod:3667
25536 "Unlike L</cat>, this function can correctly handle files that contain "
25537 "embedded ASCII NUL characters. However unlike L</download>, this function "
25538 "is limited in the total size of file that can be handled."
25542 #: ../fish/guestfish-actions.pod:3675
25547 #: ../fish/guestfish-actions.pod:3677
25550 " read-lines path\n"
25555 #: ../fish/guestfish-actions.pod:3684
25557 "Note that this function cannot correctly handle binary files (specifically, "
25558 "files containing C<\\0> character which is treated as end of line). For "
25559 "those you need to use the L</read-file> function which has a more complex "
25564 #: ../fish/guestfish-actions.pod:3689
25569 #: ../fish/guestfish-actions.pod:3691
25577 #: ../fish/guestfish-actions.pod:3743
25579 "This function is primarily intended for use by programs. To get a simple "
25580 "list of names, use L</ls>. To get a printable directory for human "
25581 "consumption, use L</ll>."
25585 #: ../fish/guestfish-actions.pod:3747
25590 #: ../fish/guestfish-actions.pod:3749
25598 #: ../fish/guestfish-actions.pod:3753
25599 msgid "readlinklist"
25603 #: ../fish/guestfish-actions.pod:3755
25606 " readlinklist path 'names ...'\n"
25611 #: ../fish/guestfish-actions.pod:3779
25616 #: ../fish/guestfish-actions.pod:3781
25624 #: ../fish/guestfish-actions.pod:3786
25625 msgid "removexattr"
25629 #: ../fish/guestfish-actions.pod:3788
25632 " removexattr xattr path\n"
25637 #: ../fish/guestfish-actions.pod:3793
25638 msgid "See also: L</lremovexattr>, L<attr(5)>."
25642 #: ../fish/guestfish-actions.pod:3795
25647 #: ../fish/guestfish-actions.pod:3797
25650 " resize2fs device\n"
25655 #: ../fish/guestfish-actions.pod:3802
25657 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
25658 "before calling this command. For unknown reasons C<resize2fs> sometimes "
25659 "gives an error about this and sometimes not. In any case, it is always safe "
25660 "to call L</e2fsck-f> before calling this function."
25664 #: ../fish/guestfish-actions.pod:3808
25665 msgid "resize2fs-M"
25669 #: ../fish/guestfish-actions.pod:3810
25672 " resize2fs-M device\n"
25677 #: ../fish/guestfish-actions.pod:3812
25679 "This command is the same as L</resize2fs>, but the filesystem is resized to "
25680 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
25685 #: ../fish/guestfish-actions.pod:3816
25687 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
25688 "and read the C<Block size> and C<Block count> values. These two numbers, "
25689 "multiplied together, give the resulting size of the minimal filesystem in "
25694 #: ../fish/guestfish-actions.pod:3821
25695 msgid "resize2fs-size"
25699 #: ../fish/guestfish-actions.pod:3823
25702 " resize2fs-size device size\n"
25707 #: ../fish/guestfish-actions.pod:3825
25709 "This command is the same as L</resize2fs> except that it allows you to "
25710 "specify the new size (in bytes) explicitly."
25714 #: ../fish/guestfish-actions.pod:3828
25719 #: ../fish/guestfish-actions.pod:3830
25727 #: ../fish/guestfish-actions.pod:3834
25732 #: ../fish/guestfish-actions.pod:3836
25740 #: ../fish/guestfish-actions.pod:3842
25745 #: ../fish/guestfish-actions.pod:3844
25753 #: ../fish/guestfish-actions.pod:3848
25754 msgid "rmmountpoint"
25758 #: ../fish/guestfish-actions.pod:3850
25761 " rmmountpoint exemptpath\n"
25766 #: ../fish/guestfish-actions.pod:3852
25768 "This calls removes a mountpoint that was previously created with "
25769 "L</mkmountpoint>. See L</mkmountpoint> for full details."
25773 #: ../fish/guestfish-actions.pod:3856
25774 msgid "scrub-device"
25778 #: ../fish/guestfish-actions.pod:3858
25781 " scrub-device device\n"
25786 #: ../fish/guestfish-actions.pod:3869
25791 #: ../fish/guestfish-actions.pod:3871
25794 " scrub-file file\n"
25799 #: ../fish/guestfish-actions.pod:3881
25800 msgid "scrub-freespace"
25804 #: ../fish/guestfish-actions.pod:3883
25807 " scrub-freespace dir\n"
25812 #: ../fish/guestfish-actions.pod:3885
25814 "This command creates the directory C<dir> and then fills it with files until "
25815 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
25816 "deletes them. The intention is to scrub any free space on the partition "
25817 "containing C<dir>."
25821 #: ../fish/guestfish-actions.pod:3894
25826 #: ../fish/guestfish-actions.pod:3896
25831 #: ../fish/guestfish-actions.pod:3898
25834 " set-append append\n"
25839 #: ../fish/guestfish-actions.pod:3909
25840 msgid "set-attach-method"
25844 #: ../fish/guestfish-actions.pod:3911
25845 msgid "attach-method"
25849 #: ../fish/guestfish-actions.pod:3913
25852 " set-attach-method attachmethod\n"
25857 #: ../fish/guestfish-actions.pod:3935
25858 msgid "set-autosync"
25862 #: ../fish/guestfish-actions.pod:3937
25867 #: ../fish/guestfish-actions.pod:3939
25870 " set-autosync true|false\n"
25875 #: ../fish/guestfish-actions.pod:3949
25880 #: ../fish/guestfish-actions.pod:3951
25885 #: ../fish/guestfish-actions.pod:3953
25888 " set-direct true|false\n"
25893 #: ../fish/guestfish-actions.pod:3959
25895 "One consequence of this is that log messages aren't caught by the library "
25896 "and handled by L</set-log-message-callback>, but go straight to stdout."
25900 #: ../fish/guestfish-actions.pod:3968
25901 msgid "set-e2label"
25905 #: ../fish/guestfish-actions.pod:3970
25908 " set-e2label device label\n"
25913 #: ../fish/guestfish-actions.pod:3976
25915 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
25916 "label on a filesystem."
25920 #: ../fish/guestfish-actions.pod:3979
25925 #: ../fish/guestfish-actions.pod:3981
25928 " set-e2uuid device uuid\n"
25933 #: ../fish/guestfish-actions.pod:3988
25935 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
25936 "UUID of a filesystem."
25940 #: ../fish/guestfish-actions.pod:3991
25941 msgid "set-memsize"
25945 #: ../fish/guestfish-actions.pod:3993
25950 #: ../fish/guestfish-actions.pod:3995
25953 " set-memsize memsize\n"
25958 #: ../fish/guestfish-actions.pod:3997
25960 "This sets the memory size in megabytes allocated to the qemu subprocess. "
25961 "This only has any effect if called before L</launch>."
25965 #: ../fish/guestfish-actions.pod:4008
25966 msgid "set-network"
25970 #: ../fish/guestfish-actions.pod:4010
25975 #: ../fish/guestfish-actions.pod:4012
25978 " set-network true|false\n"
25983 #: ../fish/guestfish-actions.pod:4020
25984 msgid "You must call this before calling L</launch>, otherwise it has no effect."
25988 #: ../fish/guestfish-actions.pod:4023
25993 #: ../fish/guestfish-actions.pod:4025
25998 #: ../fish/guestfish-actions.pod:4027
26001 " set-path searchpath\n"
26006 #: ../fish/guestfish-actions.pod:4036
26011 #: ../fish/guestfish-actions.pod:4038
26016 #: ../fish/guestfish-actions.pod:4040
26024 #: ../fish/guestfish-actions.pod:4060
26025 msgid "set-recovery-proc"
26029 #: ../fish/guestfish-actions.pod:4062
26030 msgid "recovery-proc"
26034 #: ../fish/guestfish-actions.pod:4064
26037 " set-recovery-proc true|false\n"
26042 #: ../fish/guestfish-actions.pod:4066
26044 "If this is called with the parameter C<false> then L</launch> does not "
26045 "create a recovery process. The purpose of the recovery process is to stop "
26046 "runaway qemu processes in the case where the main program aborts abruptly."
26050 #: ../fish/guestfish-actions.pod:4071
26052 "This only has any effect if called before L</launch>, and the default is "
26057 #: ../fish/guestfish-actions.pod:4080
26058 msgid "set-selinux"
26062 #: ../fish/guestfish-actions.pod:4082
26067 #: ../fish/guestfish-actions.pod:4084
26070 " set-selinux true|false\n"
26075 #: ../fish/guestfish-actions.pod:4095
26080 #: ../fish/guestfish-actions.pod:4097
26085 #: ../fish/guestfish-actions.pod:4099
26088 " set-trace true|false\n"
26093 #: ../fish/guestfish-actions.pod:4111
26095 "Trace messages are normally sent to C<stderr>, unless you register a "
26096 "callback to send them somewhere else (see L</set-event-callback>)."
26100 #: ../fish/guestfish-actions.pod:4115
26101 msgid "set-verbose"
26105 #: ../fish/guestfish-actions.pod:4117
26110 #: ../fish/guestfish-actions.pod:4119
26113 " set-verbose true|false\n"
26118 #: ../fish/guestfish-actions.pod:4126
26120 "Verbose messages are normally sent to C<stderr>, unless you register a "
26121 "callback to send them somewhere else (see L</set-event-callback>)."
26125 #: ../fish/guestfish-actions.pod:4130
26130 #: ../fish/guestfish-actions.pod:4132
26133 " setcon context\n"
26138 #: ../fish/guestfish-actions.pod:4139
26143 #: ../fish/guestfish-actions.pod:4141
26146 " setxattr xattr val vallen path\n"
26151 #: ../fish/guestfish-actions.pod:4147
26152 msgid "See also: L</lsetxattr>, L<attr(5)>."
26156 #: ../fish/guestfish-actions.pod:4149
26161 #: ../fish/guestfish-actions.pod:4151
26164 " sfdisk device cyls heads sectors 'lines ...'\n"
26169 #: ../fish/guestfish-actions.pod:4173
26170 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26174 #: ../fish/guestfish-actions.pod:4186
26179 #: ../fish/guestfish-actions.pod:4188
26182 " sfdiskM device 'lines ...'\n"
26187 #: ../fish/guestfish-actions.pod:4190
26189 "This is a simplified interface to the L</sfdisk> command, where partition "
26190 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26191 "you don't need to specify the cyls, heads and sectors parameters which were "
26192 "rarely if ever used anyway."
26196 #: ../fish/guestfish-actions.pod:4196
26197 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26201 #: ../fish/guestfish-actions.pod:4209
26206 #: ../fish/guestfish-actions.pod:4211
26209 " sfdisk-N device partnum cyls heads sectors line\n"
26214 #: ../fish/guestfish-actions.pod:4216
26216 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26217 "cyls/heads/sectors parameters."
26221 #: ../fish/guestfish-actions.pod:4219
26222 msgid "See also: L</part-add>"
26226 #: ../fish/guestfish-actions.pod:4231
26227 msgid "sfdisk-disk-geometry"
26231 #: ../fish/guestfish-actions.pod:4233
26234 " sfdisk-disk-geometry device\n"
26239 #: ../fish/guestfish-actions.pod:4235
26241 "This displays the disk geometry of C<device> read from the partition table. "
26242 "Especially in the case where the underlying block device has been resized, "
26243 "this can be different from the kernel's idea of the geometry (see "
26244 "L</sfdisk-kernel-geometry>)."
26248 #: ../fish/guestfish-actions.pod:4243
26249 msgid "sfdisk-kernel-geometry"
26253 #: ../fish/guestfish-actions.pod:4245
26256 " sfdisk-kernel-geometry device\n"
26261 #: ../fish/guestfish-actions.pod:4252
26266 #: ../fish/guestfish-actions.pod:4254
26269 " sfdisk-l device\n"
26274 #: ../fish/guestfish-actions.pod:4260
26275 msgid "See also: L</part-list>"
26279 #: ../fish/guestfish-actions.pod:4269
26284 #: ../fish/guestfish-actions.pod:4271
26292 #: ../fish/guestfish-actions.pod:4276
26293 msgid "This is like L</command>, but passes the command to:"
26297 #: ../fish/guestfish-actions.pod:4284
26298 msgid "All the provisos about L</command> apply to this call."
26302 #: ../fish/guestfish-actions.pod:4286
26307 #: ../fish/guestfish-actions.pod:4288
26310 " sh-lines command\n"
26315 #: ../fish/guestfish-actions.pod:4290
26316 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26320 #: ../fish/guestfish-actions.pod:4293
26321 msgid "See also: L</command-lines>"
26325 #: ../fish/guestfish-actions.pod:4295
26330 #: ../fish/guestfish-actions.pod:4297
26338 #: ../fish/guestfish-actions.pod:4301
26343 #: ../fish/guestfish-actions.pod:4303
26351 #: ../fish/guestfish-actions.pod:4309
26356 #: ../fish/guestfish-actions.pod:4311
26364 #: ../fish/guestfish-actions.pod:4319
26369 #: ../fish/guestfish-actions.pod:4321
26377 #: ../fish/guestfish-actions.pod:4329
26382 #: ../fish/guestfish-actions.pod:4331
26385 " strings-e encoding path\n"
26390 #: ../fish/guestfish-actions.pod:4333
26392 "This is like the L</strings> command, but allows you to specify the encoding "
26393 "of strings that are looked for in the source file C<path>."
26397 #: ../fish/guestfish-actions.pod:4343
26399 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26400 "ISO-8859-X (this is what L</strings> uses)."
26404 #: ../fish/guestfish-actions.pod:4375
26405 msgid "swapoff-device"
26409 #: ../fish/guestfish-actions.pod:4377
26412 " swapoff-device device\n"
26417 #: ../fish/guestfish-actions.pod:4379
26419 "This command disables the libguestfs appliance swap device or partition "
26420 "named C<device>. See L</swapon-device>."
26424 #: ../fish/guestfish-actions.pod:4383
26425 msgid "swapoff-file"
26429 #: ../fish/guestfish-actions.pod:4385
26432 " swapoff-file file\n"
26437 #: ../fish/guestfish-actions.pod:4389
26438 msgid "swapoff-label"
26442 #: ../fish/guestfish-actions.pod:4391
26445 " swapoff-label label\n"
26450 #: ../fish/guestfish-actions.pod:4396
26451 msgid "swapoff-uuid"
26455 #: ../fish/guestfish-actions.pod:4398
26458 " swapoff-uuid uuid\n"
26463 #: ../fish/guestfish-actions.pod:4403
26464 msgid "swapon-device"
26468 #: ../fish/guestfish-actions.pod:4405
26471 " swapon-device device\n"
26476 #: ../fish/guestfish-actions.pod:4407
26478 "This command enables the libguestfs appliance to use the swap device or "
26479 "partition named C<device>. The increased memory is made available for all "
26480 "commands, for example those run using L</command> or L</sh>."
26484 #: ../fish/guestfish-actions.pod:4419
26485 msgid "swapon-file"
26489 #: ../fish/guestfish-actions.pod:4421
26492 " swapon-file file\n"
26497 #: ../fish/guestfish-actions.pod:4423
26498 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26502 #: ../fish/guestfish-actions.pod:4426
26503 msgid "swapon-label"
26507 #: ../fish/guestfish-actions.pod:4428
26510 " swapon-label label\n"
26515 #: ../fish/guestfish-actions.pod:4430
26517 "This command enables swap to a labeled swap partition. See "
26518 "L</swapon-device> for other notes."
26522 #: ../fish/guestfish-actions.pod:4433
26523 msgid "swapon-uuid"
26527 #: ../fish/guestfish-actions.pod:4435
26530 " swapon-uuid uuid\n"
26535 #: ../fish/guestfish-actions.pod:4437
26537 "This command enables swap to a swap partition with the given UUID. See "
26538 "L</swapon-device> for other notes."
26542 #: ../fish/guestfish-actions.pod:4440
26547 #: ../fish/guestfish-actions.pod:4442
26555 #: ../fish/guestfish-actions.pod:4450
26560 #: ../fish/guestfish-actions.pod:4452
26568 #: ../fish/guestfish-actions.pod:4460
26573 #: ../fish/guestfish-actions.pod:4462
26576 " tail-n nrlines path\n"
26581 #: ../fish/guestfish-actions.pod:4475
26586 #: ../fish/guestfish-actions.pod:4477
26589 " tar-in (tarfile|-) directory\n"
26594 #: ../fish/guestfish-actions.pod:4482
26595 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26599 #: ../fish/guestfish-actions.pod:4487
26604 #: ../fish/guestfish-actions.pod:4489
26607 " tar-out directory (tarfile|-)\n"
26612 #: ../fish/guestfish-actions.pod:4494
26613 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26617 #: ../fish/guestfish-actions.pod:4499
26622 #: ../fish/guestfish-actions.pod:4501
26625 " tgz-in (tarball|-) directory\n"
26630 #: ../fish/guestfish-actions.pod:4506
26631 msgid "To upload an uncompressed tarball, use L</tar-in>."
26635 #: ../fish/guestfish-actions.pod:4510
26640 #: ../fish/guestfish-actions.pod:4512
26643 " tgz-out directory (tarball|-)\n"
26648 #: ../fish/guestfish-actions.pod:4517
26649 msgid "To download an uncompressed tarball, use L</tar-out>."
26653 #: ../fish/guestfish-actions.pod:4521
26658 #: ../fish/guestfish-actions.pod:4523
26666 #: ../fish/guestfish-actions.pod:4532
26671 #: ../fish/guestfish-actions.pod:4534
26679 #: ../fish/guestfish-actions.pod:4539
26680 msgid "truncate-size"
26684 #: ../fish/guestfish-actions.pod:4541
26687 " truncate-size path size\n"
26692 #: ../fish/guestfish-actions.pod:4546
26694 "If the current file size is less than C<size> then the file is extended to "
26695 "the required size with zero bytes. This creates a sparse file (ie. disk "
26696 "blocks are not allocated for the file until you write to it). To create a "
26697 "non-sparse file of zeroes, use L</fallocate64> instead."
26701 #: ../fish/guestfish-actions.pod:4552
26706 #: ../fish/guestfish-actions.pod:4554
26709 " tune2fs-l device\n"
26714 #: ../fish/guestfish-actions.pod:4564
26719 #: ../fish/guestfish-actions.pod:4566
26722 " txz-in (tarball|-) directory\n"
26727 #: ../fish/guestfish-actions.pod:4573
26732 #: ../fish/guestfish-actions.pod:4575
26735 " txz-out directory (tarball|-)\n"
26740 #: ../fish/guestfish-actions.pod:4582
26745 #: ../fish/guestfish-actions.pod:4584
26753 #: ../fish/guestfish-actions.pod:4598
26754 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
26758 #: ../fish/guestfish-actions.pod:4603
26763 #: ../fish/guestfish-actions.pod:4605
26768 #: ../fish/guestfish-actions.pod:4607
26771 " umount pathordevice\n"
26776 #: ../fish/guestfish-actions.pod:4613
26781 #: ../fish/guestfish-actions.pod:4615
26782 msgid "unmount-all"
26786 #: ../fish/guestfish-actions.pod:4617
26794 #: ../fish/guestfish-actions.pod:4623
26799 #: ../fish/guestfish-actions.pod:4625
26802 " upload (filename|-) remotefilename\n"
26807 #: ../fish/guestfish-actions.pod:4632
26808 msgid "See also L</download>."
26812 #: ../fish/guestfish-actions.pod:4636
26813 msgid "upload-offset"
26817 #: ../fish/guestfish-actions.pod:4638
26820 " upload-offset (filename|-) remotefilename offset\n"
26825 #: ../fish/guestfish-actions.pod:4650
26827 "Note that there is no limit on the amount of data that can be uploaded with "
26828 "this call, unlike with L</pwrite>, and this call always writes the full "
26829 "amount unless an error occurs."
26833 #: ../fish/guestfish-actions.pod:4655
26834 msgid "See also L</upload>, L</pwrite>."
26838 #: ../fish/guestfish-actions.pod:4659
26843 #: ../fish/guestfish-actions.pod:4661
26846 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
26851 #: ../fish/guestfish-actions.pod:4680
26856 #: ../fish/guestfish-actions.pod:4682
26864 #: ../fish/guestfish-actions.pod:4709
26866 "I<Note:> Don't use this call to test for availability of features. In "
26867 "enterprise distributions we backport features from later versions into "
26868 "earlier versions, making this an unreliable way to test for features. Use "
26869 "L</available> instead."
26873 #: ../fish/guestfish-actions.pod:4715
26878 #: ../fish/guestfish-actions.pod:4717
26881 " vfs-label device\n"
26886 #: ../fish/guestfish-actions.pod:4724
26887 msgid "To find a filesystem from the label, use L</findfs-label>."
26891 #: ../fish/guestfish-actions.pod:4726
26896 #: ../fish/guestfish-actions.pod:4728
26899 " vfs-type device\n"
26904 #: ../fish/guestfish-actions.pod:4738
26909 #: ../fish/guestfish-actions.pod:4740
26912 " vfs-uuid device\n"
26917 #: ../fish/guestfish-actions.pod:4747
26918 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
26922 #: ../fish/guestfish-actions.pod:4749
26923 msgid "vg-activate"
26927 #: ../fish/guestfish-actions.pod:4751
26930 " vg-activate true|false 'volgroups ...'\n"
26935 #: ../fish/guestfish-actions.pod:4764
26936 msgid "vg-activate-all"
26940 #: ../fish/guestfish-actions.pod:4766
26943 " vg-activate-all true|false\n"
26948 #: ../fish/guestfish-actions.pod:4776
26953 #: ../fish/guestfish-actions.pod:4778
26956 " vgcreate volgroup 'physvols ...'\n"
26961 #: ../fish/guestfish-actions.pod:4783
26966 #: ../fish/guestfish-actions.pod:4785
26969 " vglvuuids vgname\n"
26974 #: ../fish/guestfish-actions.pod:4790
26976 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
26977 "logical volumes and volume groups."
26981 #: ../fish/guestfish-actions.pod:4793
26982 msgid "See also L</vgpvuuids>."
26986 #: ../fish/guestfish-actions.pod:4795
26991 #: ../fish/guestfish-actions.pod:4797
26994 " vgpvuuids vgname\n"
26999 #: ../fish/guestfish-actions.pod:4802
27001 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27002 "physical volumes and volume groups."
27006 #: ../fish/guestfish-actions.pod:4805
27007 msgid "See also L</vglvuuids>."
27011 #: ../fish/guestfish-actions.pod:4807
27016 #: ../fish/guestfish-actions.pod:4809
27019 " vgremove vgname\n"
27024 #: ../fish/guestfish-actions.pod:4816
27029 #: ../fish/guestfish-actions.pod:4818
27032 " vgrename volgroup newvolgroup\n"
27037 #: ../fish/guestfish-actions.pod:4822
27042 #: ../fish/guestfish-actions.pod:4824
27050 #: ../fish/guestfish-actions.pod:4832
27051 msgid "See also L</vgs-full>."
27055 #: ../fish/guestfish-actions.pod:4834
27060 #: ../fish/guestfish-actions.pod:4836
27068 #: ../fish/guestfish-actions.pod:4841
27073 #: ../fish/guestfish-actions.pod:4843
27081 #: ../fish/guestfish-actions.pod:4848
27086 #: ../fish/guestfish-actions.pod:4850
27094 #: ../fish/guestfish-actions.pod:4854
27099 #: ../fish/guestfish-actions.pod:4856
27107 #: ../fish/guestfish-actions.pod:4861
27112 #: ../fish/guestfish-actions.pod:4863
27120 #: ../fish/guestfish-actions.pod:4868
27125 #: ../fish/guestfish-actions.pod:4870
27133 #: ../fish/guestfish-actions.pod:4875
27138 #: ../fish/guestfish-actions.pod:4877
27141 " write path content\n"
27146 #: ../fish/guestfish-actions.pod:4885
27151 #: ../fish/guestfish-actions.pod:4887
27154 " write-file path content size\n"
27159 #: ../fish/guestfish-actions.pod:4910
27164 #: ../fish/guestfish-actions.pod:4912
27167 " zegrep regex path\n"
27172 #: ../fish/guestfish-actions.pod:4920
27177 #: ../fish/guestfish-actions.pod:4922
27180 " zegrepi regex path\n"
27185 #: ../fish/guestfish-actions.pod:4930
27190 #: ../fish/guestfish-actions.pod:4932
27198 #: ../fish/guestfish-actions.pod:4940
27199 msgid "See also: L</zero-device>, L</scrub-device>."
27203 #: ../fish/guestfish-actions.pod:4942
27204 msgid "zero-device"
27208 #: ../fish/guestfish-actions.pod:4944
27211 " zero-device device\n"
27216 #: ../fish/guestfish-actions.pod:4946
27218 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27219 "which just zeroes the first few blocks of a device."
27223 #: ../fish/guestfish-actions.pod:4953
27228 #: ../fish/guestfish-actions.pod:4955
27231 " zerofree device\n"
27236 #: ../fish/guestfish-actions.pod:4968
27241 #: ../fish/guestfish-actions.pod:4970
27244 " zfgrep pattern path\n"
27249 #: ../fish/guestfish-actions.pod:4978
27254 #: ../fish/guestfish-actions.pod:4980
27257 " zfgrepi pattern path\n"
27262 #: ../fish/guestfish-actions.pod:4988
27267 #: ../fish/guestfish-actions.pod:4990
27270 " zfile meth path\n"
27275 #: ../fish/guestfish-actions.pod:4997
27276 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
27280 #: ../fish/guestfish-actions.pod:5007
27285 #: ../fish/guestfish-actions.pod:5009
27288 " zgrep regex path\n"
27293 #: ../fish/guestfish-actions.pod:5017
27298 #: ../fish/guestfish-actions.pod:5019
27301 " zgrepi regex path\n"
27306 #: ../fish/guestfish-commands.pod:1
27311 #: ../fish/guestfish-commands.pod:3
27316 #: ../fish/guestfish-commands.pod:5
27319 " alloc filename size\n"
27324 #: ../fish/guestfish-commands.pod:7
27326 "This creates an empty (zeroed) file of the given size, and then adds so it "
27327 "can be further examined."
27331 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
27332 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27336 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
27337 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27341 #: ../fish/guestfish-commands.pod:14
27343 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27344 "image, see L</PREPARED DISK IMAGES>."
27348 #: ../fish/guestfish-commands.pod:17
27353 #: ../fish/guestfish-commands.pod:19
27356 " copy-in local [local ...] /remotedir\n"
27361 #: ../fish/guestfish-commands.pod:21
27363 "C<copy-in> copies local files or directories recursively into the disk "
27364 "image, placing them in the directory called C</remotedir> (which must "
27365 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27366 "other commands as necessary."
27370 #: ../fish/guestfish-commands.pod:26
27372 "Multiple local files and directories can be specified, but the last "
27373 "parameter must always be a remote directory. Wildcards cannot be used."
27377 #: ../fish/guestfish-commands.pod:30
27382 #: ../fish/guestfish-commands.pod:32
27385 " copy-out remote [remote ...] localdir\n"
27390 #: ../fish/guestfish-commands.pod:34
27392 "C<copy-out> copies remote files or directories recursively out of the disk "
27393 "image, placing them on the host disk in a local directory called C<localdir> "
27394 "(which must exist). This guestfish meta-command turns into a sequence of "
27395 "L</download>, L</tar-out> and other commands as necessary."
27399 #: ../fish/guestfish-commands.pod:40
27401 "Multiple remote files and directories can be specified, but the last "
27402 "parameter must always be a local directory. To download to the current "
27403 "directory, use C<.> as in:"
27407 #: ../fish/guestfish-commands.pod:44
27410 " copy-out /home .\n"
27415 #: ../fish/guestfish-commands.pod:46
27417 "Wildcards cannot be used in the ordinary command, but you can use them with "
27418 "the help of L</glob> like this:"
27422 #: ../fish/guestfish-commands.pod:49
27425 " glob copy-out /home/* .\n"
27430 #: ../fish/guestfish-commands.pod:51
27435 #: ../fish/guestfish-commands.pod:53
27438 " echo [params ...]\n"
27443 #: ../fish/guestfish-commands.pod:55
27444 msgid "This echos the parameters to the terminal."
27448 #: ../fish/guestfish-commands.pod:57
27453 #: ../fish/guestfish-commands.pod:59
27458 #: ../fish/guestfish-commands.pod:61
27463 #: ../fish/guestfish-commands.pod:63
27471 #: ../fish/guestfish-commands.pod:65
27473 "This is used to edit a file. It downloads the file, edits it locally using "
27474 "your editor, then uploads the result."
27478 #: ../fish/guestfish-commands.pod:68
27480 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27481 "or C<emacs> you will get those corresponding editors."
27485 #: ../fish/guestfish-commands.pod:72
27490 #: ../fish/guestfish-commands.pod:74
27493 " glob command args...\n"
27498 #: ../fish/guestfish-commands.pod:76
27500 "Expand wildcards in any paths in the args list, and run C<command> "
27501 "repeatedly on each matching path."
27505 #: ../fish/guestfish-commands.pod:79
27506 msgid "See L</WILDCARDS AND GLOBBING>."
27510 #: ../fish/guestfish-commands.pod:81
27515 #: ../fish/guestfish-commands.pod:83
27518 " hexedit <filename|device>\n"
27519 " hexedit <filename|device> <max>\n"
27520 " hexedit <filename|device> <start> <max>\n"
27525 #: ../fish/guestfish-commands.pod:87
27527 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27532 #: ../fish/guestfish-commands.pod:90
27534 "This command works by downloading potentially the whole file or device, "
27535 "editing it locally, then uploading it. If the file or device is large, you "
27536 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27537 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27538 "usual modifiers allowed such as C<1M> (1 megabyte)."
27542 #: ../fish/guestfish-commands.pod:97
27543 msgid "For example to edit the first few sectors of a disk you might do:"
27547 #: ../fish/guestfish-commands.pod:100
27550 " hexedit /dev/sda 1M\n"
27555 #: ../fish/guestfish-commands.pod:102
27557 "which would allow you to edit anywhere within the first megabyte of the "
27562 #: ../fish/guestfish-commands.pod:105
27563 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27567 #: ../fish/guestfish-commands.pod:107
27570 " hexedit /dev/sda1 0x400 0x400\n"
27575 #: ../fish/guestfish-commands.pod:109
27576 msgid "(assuming the superblock is in the standard location)."
27580 #: ../fish/guestfish-commands.pod:111
27582 "This command requires the external L<hexedit(1)> program. You can specify "
27583 "another program to use by setting the C<HEXEDITOR> environment variable."
27587 #: ../fish/guestfish-commands.pod:115
27588 msgid "See also L</hexdump>."
27592 #: ../fish/guestfish-commands.pod:117
27597 #: ../fish/guestfish-commands.pod:119
27605 #: ../fish/guestfish-commands.pod:121
27606 msgid "Change the local directory, ie. the current directory of guestfish itself."
27610 #: ../fish/guestfish-commands.pod:124
27611 msgid "Note that C<!cd> won't do what you might expect."
27615 #: ../fish/guestfish-commands.pod:126
27620 #: ../fish/guestfish-commands.pod:128
27625 #: ../fish/guestfish-commands.pod:130
27633 #: ../fish/guestfish-commands.pod:132
27634 msgid "Opens the manual page for guestfish."
27638 #: ../fish/guestfish-commands.pod:134
27643 #: ../fish/guestfish-commands.pod:136
27648 #: ../fish/guestfish-commands.pod:138
27656 #: ../fish/guestfish-commands.pod:140
27664 #: ../fish/guestfish-commands.pod:142
27665 msgid "This is used to view a file."
27669 #: ../fish/guestfish-commands.pod:144
27671 "The default viewer is C<$PAGER>. However if you use the alternate command "
27672 "C<less> you will get the C<less> command specifically."
27676 #: ../fish/guestfish-commands.pod:147
27681 #: ../fish/guestfish-commands.pod:149
27689 #: ../fish/guestfish-commands.pod:151
27691 "Close and reopen the libguestfs handle. It is not necessary to use this "
27692 "normally, because the handle is closed properly when guestfish exits. "
27693 "However this is occasionally useful for testing."
27697 #: ../fish/guestfish-commands.pod:155
27702 #: ../fish/guestfish-commands.pod:157
27705 " sparse filename size\n"
27710 #: ../fish/guestfish-commands.pod:159
27712 "This creates an empty sparse file of the given size, and then adds so it can "
27713 "be further examined."
27717 #: ../fish/guestfish-commands.pod:162
27719 "In all respects it works the same as the L</alloc> command, except that the "
27720 "image file is allocated sparsely, which means that disk blocks are not "
27721 "assigned to the file until they are needed. Sparse disk files only use "
27722 "space when written to, but they are slower and there is a danger you could "
27723 "run out of real disk space during a write operation."
27727 #: ../fish/guestfish-commands.pod:172
27732 #: ../fish/guestfish-commands.pod:174
27740 #: ../fish/guestfish-commands.pod:176
27742 "This command returns a list of the optional groups known to the daemon, and "
27743 "indicates which ones are supported by this build of the libguestfs "
27748 #: ../fish/guestfish-commands.pod:180
27749 msgid "See also L<guestfs(3)/AVAILABILITY>."
27753 #: ../fish/guestfish-commands.pod:182
27758 #: ../fish/guestfish-commands.pod:184
27761 " time command args...\n"
27766 #: ../fish/guestfish-commands.pod:186
27768 "Run the command as usual, but print the elapsed time afterwards. This can "
27769 "be useful for benchmarking operations."
27773 #: ../test-tool/libguestfs-test-tool.pod:5
27774 msgid "libguestfs-test-tool - End user tests for libguestfs"
27778 #: ../test-tool/libguestfs-test-tool.pod:9
27781 " libguestfs-test-tool [--options]\n"
27786 #: ../test-tool/libguestfs-test-tool.pod:13
27788 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
27789 "and developers, to allow them to check basic libguestfs functionality is "
27790 "working. This is needed because libguestfs occasionally breaks for reasons "
27791 "beyond our control: usually because of changes in the underlying qemu or "
27792 "kernel packages, or the host environment."
27796 #: ../test-tool/libguestfs-test-tool.pod:20
27797 msgid "If you suspect a problem in libguestfs, then just run:"
27801 #: ../test-tool/libguestfs-test-tool.pod:22
27804 " libguestfs-test-tool\n"
27809 #: ../test-tool/libguestfs-test-tool.pod:24
27810 msgid "It will print lots of diagnostic messages."
27814 #: ../test-tool/libguestfs-test-tool.pod:26
27815 msgid "If it runs to completion successfully, you will see this near the end:"
27819 #: ../test-tool/libguestfs-test-tool.pod:28
27822 " ===== TEST FINISHED OK =====\n"
27827 #: ../test-tool/libguestfs-test-tool.pod:30
27828 msgid "and the test tool will exit with code 0."
27832 #: ../test-tool/libguestfs-test-tool.pod:32
27834 "If it fails (and/or exits with non-zero error code), please paste the "
27835 "B<complete, unedited> output of the test tool into a bug report. More "
27836 "information about reporting bugs can be found on the "
27837 "L<http://libguestfs.org/> website."
27841 #: ../test-tool/libguestfs-test-tool.pod:41
27846 #: ../test-tool/libguestfs-test-tool.pod:43
27847 msgid "Display short usage information and exit."
27851 #: ../test-tool/libguestfs-test-tool.pod:45
27852 msgid "I<--qemu qemu_binary>"
27856 #: ../test-tool/libguestfs-test-tool.pod:47
27858 "If you have downloaded another qemu binary, point this option at the full "
27859 "path of the binary to try it."
27863 #: ../test-tool/libguestfs-test-tool.pod:50
27864 msgid "I<--qemudir qemu_source_dir>"
27868 #: ../test-tool/libguestfs-test-tool.pod:52
27870 "If you have compiled qemu from source, point this option at the source "
27871 "directory to try it."
27875 #: ../test-tool/libguestfs-test-tool.pod:55
27876 msgid "I<--timeout N>"
27880 #: ../test-tool/libguestfs-test-tool.pod:57
27882 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
27883 "does not usually need to be adjusted unless your machine is very slow."
27887 #: ../test-tool/libguestfs-test-tool.pod:63
27888 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
27892 #: ../test-tool/libguestfs-test-tool.pod:65
27894 "If you have compiled another version of qemu from source and would like to "
27895 "try that, then you can use the I<--qemudir> option to point to the qemu "
27896 "source directory."
27900 #: ../test-tool/libguestfs-test-tool.pod:69
27902 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
27903 "option to point to the binary."
27907 #: ../test-tool/libguestfs-test-tool.pod:72
27909 "When using an alternate qemu with libguestfs, usually you would need to "
27910 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
27911 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
27912 "when you use either of the I<--qemudir> or I<--qemu> options."
27916 #: ../test-tool/libguestfs-test-tool.pod:79
27918 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
27919 "I<1> if there was an error."
27923 #: ../test-tool/libguestfs-test-tool.pod:84
27925 "For the full list of environment variables which may affect libguestfs, "
27926 "please see the L<guestfs(3)> manual page."
27930 #: ../test-tool/libguestfs-test-tool.pod:89
27931 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
27935 #: ../fuse/guestmount.pod:5
27936 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
27940 #: ../fuse/guestmount.pod:9
27943 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
27948 #: ../fuse/guestmount.pod:11
27951 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
27956 #: ../fuse/guestmount.pod:13
27959 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
27964 #: ../fuse/guestmount.pod:17
27966 "You must I<not> use C<guestmount> in read-write mode on live virtual "
27967 "machines. If you do this, you risk disk corruption in the VM."
27971 #: ../fuse/guestmount.pod:22
27973 "The guestmount program can be used to mount virtual machine filesystems and "
27974 "other disk images on the host. It uses libguestfs for access to the guest "
27975 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
27976 "a mountable device."
27980 #: ../fuse/guestmount.pod:27
27982 "Along with other options, you have to give at least one device (I<-a> "
27983 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
27984 "option) or use the I<-i> inspection option. How this works is better "
27985 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
27990 #: ../fuse/guestmount.pod:33
27992 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
27993 "by you, and the filesystem will not be visible to any other users unless you "
27994 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
27995 "the filesystem, use the C<fusermount -u> command."
27999 #: ../fuse/guestmount.pod:41
28001 "For a typical Windows guest which has its main filesystem on the first "
28006 #: ../fuse/guestmount.pod:44
28009 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28014 #: ../fuse/guestmount.pod:46
28016 "For a typical Linux guest which has a /boot filesystem on the first "
28017 "partition, and the root filesystem on a logical volume:"
28021 #: ../fuse/guestmount.pod:49
28024 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28029 #: ../fuse/guestmount.pod:51
28030 msgid "To get libguestfs to detect guest mountpoints for you:"
28034 #: ../fuse/guestmount.pod:53
28037 " guestmount -a guest.img -i --ro /mnt\n"
28042 #: ../fuse/guestmount.pod:55
28043 msgid "For a libvirt guest called \"Guest\" you could do:"
28047 #: ../fuse/guestmount.pod:57
28050 " guestmount -d Guest -i --ro /mnt\n"
28055 #: ../fuse/guestmount.pod:59
28057 "If you don't know what filesystems are contained in a guest or disk image, "
28058 "use L<virt-filesystems(1)> first:"
28062 #: ../fuse/guestmount.pod:62
28065 " virt-filesystems MyGuest\n"
28070 #: ../fuse/guestmount.pod:64
28072 "If you want to trace the libguestfs calls but without excessive debugging "
28073 "information, we recommend:"
28077 #: ../fuse/guestmount.pod:67
28080 " guestmount [...] --trace /mnt\n"
28085 #: ../fuse/guestmount.pod:69
28086 msgid "If you want to debug the program, we recommend:"
28090 #: ../fuse/guestmount.pod:71
28093 " guestmount [...] --trace --verbose /mnt\n"
28098 #: ../fuse/guestmount.pod:77
28099 msgid "B<-a image> | B<--add image>"
28103 #: ../fuse/guestmount.pod:79
28104 msgid "Add a block device or virtual machine image."
28108 #: ../fuse/guestmount.pod:84
28109 msgid "B<-c URI> | B<--connect URI>"
28113 #: ../fuse/guestmount.pod:90
28114 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28118 #: ../fuse/guestmount.pod:98
28119 msgid "B<--dir-cache-timeout N>"
28123 #: ../fuse/guestmount.pod:100
28125 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28126 "seconds. The readdir cache [actually, there are several semi-independent "
28127 "caches] is populated after a readdir(2) call with the stat and extended "
28128 "attributes of the files in the directory, in anticipation that they will be "
28129 "requested soon after."
28133 #: ../fuse/guestmount.pod:106
28135 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28136 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28137 "requests, only cache existing ones."
28141 #: ../fuse/guestmount.pod:117
28142 msgid "B<--format=raw|qcow2|..> | B<--format>"
28146 #: ../fuse/guestmount.pod:124
28148 "If you have untrusted raw-format guest disk images, you should use this "
28149 "option to specify the disk format. This avoids a possible security problem "
28150 "with malicious guests (CVE-2010-3851). See also "
28151 "L<guestfs(3)/guestfs_add_drive_opts>."
28155 #: ../fuse/guestmount.pod:129
28156 msgid "B<--fuse-help>"
28160 #: ../fuse/guestmount.pod:131
28161 msgid "Display help on special FUSE options (see I<-o> below)."
28165 #: ../fuse/guestmount.pod:135
28166 msgid "Display brief help and exit."
28170 #: ../fuse/guestmount.pod:137
28171 msgid "B<-i> | B<--inspector>"
28175 #: ../fuse/guestmount.pod:157
28177 "Mount the named partition or logical volume on the given mountpoint B<in the "
28178 "guest> (this has nothing to do with mountpoints in the host)."
28182 #: ../fuse/guestmount.pod:160
28184 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28185 "something on C</>."
28189 #: ../fuse/guestmount.pod:173
28190 msgid "B<-n> | B<--no-sync>"
28194 #: ../fuse/guestmount.pod:175
28196 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28197 "unmounted. If you specify this option, then we don't attempt to sync the "
28198 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28202 #: ../fuse/guestmount.pod:180
28203 msgid "B<-o option> | B<--option option>"
28207 #: ../fuse/guestmount.pod:182
28208 msgid "Pass extra options to FUSE."
28212 #: ../fuse/guestmount.pod:184
28214 "To get a list of all the extra options supported by FUSE, use the command "
28215 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28216 "of them are a good idea."
28220 #: ../fuse/guestmount.pod:188
28223 " guestmount --fuse-help\n"
28228 #: ../fuse/guestmount.pod:190
28229 msgid "Some potentially useful FUSE options:"
28233 #: ../fuse/guestmount.pod:194
28234 msgid "B<-o allow_other>"
28238 #: ../fuse/guestmount.pod:196
28239 msgid "Allow other users to see the filesystem."
28243 #: ../fuse/guestmount.pod:198
28244 msgid "B<-o attr_timeout=N>"
28248 #: ../fuse/guestmount.pod:200
28249 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28253 #: ../fuse/guestmount.pod:202
28254 msgid "B<-o kernel_cache>"
28258 #: ../fuse/guestmount.pod:204
28260 "Allow the kernel to cache files (reduces the number of reads that have to go "
28261 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28262 "afford the extra memory usage."
28266 #: ../fuse/guestmount.pod:208
28267 msgid "B<-o uid=N> B<-o gid=N>"
28271 #: ../fuse/guestmount.pod:210
28273 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28274 "the chosen values."
28278 #: ../fuse/guestmount.pod:215
28279 msgid "B<-r> | B<--ro>"
28283 #: ../fuse/guestmount.pod:217
28285 "Add devices and mount everything read-only. Also disallow writes and make "
28286 "the disk appear read-only to FUSE."
28290 #: ../fuse/guestmount.pod:220
28292 "This is highly recommended if you are not going to edit the guest disk. If "
28293 "the guest is running and this option is I<not> supplied, then there is a "
28294 "strong risk of disk corruption in the guest. We try to prevent this from "
28295 "happening, but it is not always possible."
28299 #: ../fuse/guestmount.pod:225
28300 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28304 #: ../fuse/guestmount.pod:229
28305 msgid "Enable SELinux support for the guest."
28309 #: ../fuse/guestmount.pod:231
28310 msgid "B<-v> | B<--verbose>"
28314 #: ../fuse/guestmount.pod:233
28315 msgid "Enable verbose messages from underlying libguestfs."
28319 #: ../fuse/guestmount.pod:235
28320 msgid "B<-V> | B<--version>"
28324 #: ../fuse/guestmount.pod:237
28325 msgid "Display the program version and exit."
28329 #: ../fuse/guestmount.pod:239
28330 msgid "B<-w> | B<--rw>"
28334 #: ../fuse/guestmount.pod:244 ../fuse/guestmount.pod:265
28335 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28339 #: ../fuse/guestmount.pod:246
28340 msgid "B<-x> | B<--trace>"
28344 #: ../fuse/guestmount.pod:248
28345 msgid "Trace libguestfs calls and entry into each FUSE function."
28349 #: ../fuse/guestmount.pod:250
28350 msgid "This also stops the daemon from forking into the background."
28354 #: ../fuse/guestmount.pod:271
28356 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28357 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
28358 "L<http://fuse.sf.net/>."
28362 #: ../fuse/guestmount.pod:286
28363 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28367 #: ../tools/virt-win-reg.pl:37
28369 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
28374 #: ../tools/virt-win-reg.pl:41
28377 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28382 #: ../tools/virt-win-reg.pl:43
28385 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28390 #: ../tools/virt-win-reg.pl:45
28393 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28398 #: ../tools/virt-win-reg.pl:47
28401 " virt-win-reg --merge domname [input.reg ...]\n"
28406 #: ../tools/virt-win-reg.pl:49
28409 " virt-win-reg [--options] disk.img ... # instead of domname\n"
28414 #: ../tools/virt-win-reg.pl:53
28416 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
28417 "virtual machines. If you do this, you I<will> get irreversible disk "
28418 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
28419 "but doesn't catch all cases."
28423 #: ../tools/virt-win-reg.pl:58
28425 "Modifying the Windows Registry is an inherently risky operation. The format "
28426 "is deliberately obscure and undocumented, and Registry changes can leave the "
28427 "system unbootable. Therefore when using the I<--merge> option, make sure "
28428 "you have a reliable backup first."
28432 #: ../tools/virt-win-reg.pl:65
28434 "This program can export and merge Windows Registry entries from a Windows "
28439 #: ../tools/virt-win-reg.pl:68
28441 "The first parameter is the libvirt guest name or the raw disk image of a "
28446 #: ../tools/virt-win-reg.pl:71
28448 "If I<--merge> is I<not> specified, then the chosen registry key is "
28449 "displayed/exported (recursively). For example:"
28453 #: ../tools/virt-win-reg.pl:74
28456 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
28461 #: ../tools/virt-win-reg.pl:76
28462 msgid "You can also display single values from within registry keys, for example:"
28466 #: ../tools/virt-win-reg.pl:79
28469 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
28470 " $ virt-win-reg Windows7 $cvkey ProductName\n"
28471 " Windows 7 Enterprise\n"
28476 #: ../tools/virt-win-reg.pl:83
28478 "With I<--merge>, you can merge a textual regedit file into the Windows "
28483 #: ../tools/virt-win-reg.pl:86
28486 " $ virt-win-reg --merge Windows7 changes.reg\n"
28491 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
28496 #: ../tools/virt-win-reg.pl:90
28498 "This program is only meant for simple access to the registry. If you want "
28499 "to do complicated things with the registry, we suggest you download the "
28500 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
28501 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
28502 "L<hivexregedit(1)>."
28506 #: ../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
28507 msgid "Display brief help."
28511 #: ../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
28512 msgid "Display version number and exit."
28516 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
28521 #: ../tools/virt-win-reg.pl:122
28522 msgid "Enable debugging messages."
28526 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
28527 msgid "B<--connect URI> | B<-c URI>"
28531 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
28533 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28534 "to the default libvirt hypervisor."
28538 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
28540 "If you specify guest block devices directly, then libvirt is not used at "
28545 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
28546 msgid "B<--format> raw"
28550 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
28552 "Specify the format of disk images given on the command line. If this is "
28553 "omitted then the format is autodetected from the content of the disk image."
28557 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
28559 "If disk images are requested from libvirt, then this program asks libvirt "
28560 "for this information. In this case, the value of the format parameter is "
28565 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
28567 "If working with untrusted raw-format guest disk images, you should ensure "
28568 "the format is always specified."
28572 #: ../tools/virt-win-reg.pl:157
28577 #: ../tools/virt-win-reg.pl:159
28579 "In merge mode, this merges a textual regedit file into the Windows Registry "
28580 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
28581 "displays or exports Registry entries instead."
28585 #: ../tools/virt-win-reg.pl:163
28587 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
28588 "result in disk corruption. However exporting (without this flag) is always "
28593 #: ../tools/virt-win-reg.pl:171
28594 msgid "B<--encoding> UTF-16LE|ASCII"
28598 #: ../tools/virt-win-reg.pl:173
28600 "When merging (only), you may need to specify the encoding for strings to be "
28601 "used in the hive file. This is explained in detail in "
28602 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
28606 #: ../tools/virt-win-reg.pl:177
28608 "The default is to use UTF-16LE, which should work with recent versions of "
28613 #: ../tools/virt-win-reg.pl:184
28614 msgid "B<--unsafe-printable-strings>"
28618 #: ../tools/virt-win-reg.pl:186
28620 "When exporting (only), assume strings are UTF-16LE and print them as strings "
28621 "instead of hex sequences. Remove the final zero codepoint from strings if "
28626 #: ../tools/virt-win-reg.pl:190
28628 "This is unsafe and does not preserve the fidelity of strings in the original "
28629 "Registry for various reasons:"
28633 #: ../tools/virt-win-reg.pl:197
28635 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
28636 "other encodings will be corrupted by this transformation."
28640 #: ../tools/virt-win-reg.pl:202
28642 "Assumes that everything which has type 1 or 2 is really a string and that "
28643 "everything else is not a string, but the type field in real Registries is "
28648 #: ../tools/virt-win-reg.pl:208
28650 "Loses information about whether a zero codepoint followed the string in the "
28655 #: ../tools/virt-win-reg.pl:213
28657 "This all happens because the Registry itself contains no information about "
28658 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
28662 #: ../tools/virt-win-reg.pl:217
28664 "You should only use this option for quick hacking and debugging of the "
28665 "Registry contents, and I<never> use it if the output is going to be passed "
28666 "into another program or stored in another Registry."
28670 #: ../tools/virt-win-reg.pl:553
28671 msgid "SUPPORTED SYSTEMS"
28675 #: ../tools/virt-win-reg.pl:555
28677 "The program currently supports Windows NT-derived guests starting with "
28678 "Windows XP through to at least Windows 7."
28682 #: ../tools/virt-win-reg.pl:558
28683 msgid "The following Registry keys are supported:"
28687 #: ../tools/virt-win-reg.pl:562
28688 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
28692 #: ../tools/virt-win-reg.pl:564
28693 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
28697 #: ../tools/virt-win-reg.pl:566
28698 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
28702 #: ../tools/virt-win-reg.pl:568
28703 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
28707 #: ../tools/virt-win-reg.pl:570
28708 msgid "C<HKEY_USERS\\.DEFAULT>"
28712 #: ../tools/virt-win-reg.pl:572
28713 msgid "C<HKEY_USERS\\I<SID>>"
28717 #: ../tools/virt-win-reg.pl:574
28718 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
28722 #: ../tools/virt-win-reg.pl:576
28723 msgid "C<HKEY_USERS\\I<username>>"
28727 #: ../tools/virt-win-reg.pl:578
28728 msgid "where I<username> is a local user name (this is a libguestfs extension)."
28732 #: ../tools/virt-win-reg.pl:582
28734 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
28739 #: ../tools/virt-win-reg.pl:585
28741 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
28742 "supported (there is no \"current user\")."
28746 #: ../tools/virt-win-reg.pl:588
28751 #: ../tools/virt-win-reg.pl:590
28753 "C<virt-win-reg> expects that regedit files have already been reencoded in "
28754 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
28755 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
28756 "with Windows-style line endings, you may need to reencode the whole file "
28757 "before or after processing."
28761 #: ../tools/virt-win-reg.pl:596
28763 "To reencode a file from Windows format to Linux (before processing it with "
28764 "the I<--merge> option), you would do something like this:"
28768 #: ../tools/virt-win-reg.pl:599
28771 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
28776 #: ../tools/virt-win-reg.pl:601
28778 "To go in the opposite direction, after exporting and before sending the file "
28779 "to a Windows user, do something like this:"
28783 #: ../tools/virt-win-reg.pl:604
28786 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
28791 #: ../tools/virt-win-reg.pl:606
28792 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
28796 #: ../tools/virt-win-reg.pl:608
28798 "If you are unsure about the current encoding, use the L<file(1)> command. "
28799 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
28800 "Windows-style (CRLF) line endings, like this:"
28804 #: ../tools/virt-win-reg.pl:612
28807 " $ file software.reg\n"
28808 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
28809 " with CRLF line terminators\n"
28814 #: ../tools/virt-win-reg.pl:616
28815 msgid "This file would need conversion before you could I<--merge> it."
28819 #: ../tools/virt-win-reg.pl:618
28820 msgid "CurrentControlSet etc."
28824 #: ../tools/virt-win-reg.pl:620
28826 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
28827 "Registry at the level of the hive file, and therefore you cannot modify "
28832 #: ../tools/virt-win-reg.pl:624
28834 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
28835 "circumstances it might refer to another control set. The way to find out is "
28836 "to look at the C<HKLM\\SYSTEM\\Select> key:"
28840 #: ../tools/virt-win-reg.pl:628
28843 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
28844 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
28845 " \"Current\"=dword:00000001\n"
28846 " \"Default\"=dword:00000001\n"
28847 " \"Failed\"=dword:00000000\n"
28848 " \"LastKnownGood\"=dword:00000002\n"
28853 #: ../tools/virt-win-reg.pl:635
28854 msgid "\"Current\" is the one which Windows will choose when it boots."
28858 #: ../tools/virt-win-reg.pl:637
28859 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
28863 #: ../tools/virt-win-reg.pl:640
28864 msgid "WINDOWS TIPS"
28868 #: ../tools/virt-win-reg.pl:642
28870 "Note that some of these tips modify the guest disk image. The guest I<must> "
28871 "be shut off, else you will get disk corruption."
28875 #: ../tools/virt-win-reg.pl:645
28876 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
28880 #: ../tools/virt-win-reg.pl:647
28882 "Prepare a DOS batch script, VBScript or executable. Upload this using "
28883 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
28884 "is uploaded into C<C:\\>:"
28888 #: ../tools/virt-win-reg.pl:651
28891 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
28896 #: ../tools/virt-win-reg.pl:653
28897 msgid "Prepare a regedit file containing the registry change:"
28901 #: ../tools/virt-win-reg.pl:655
28904 " cat > test.reg <<'EOF'\n"
28905 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
28906 " \"Test\"=\"c:\\\\test.bat\"\n"
28912 #: ../tools/virt-win-reg.pl:660
28914 "In this example we use the key C<RunOnce> which means that the script will "
28915 "run precisely once when the first user logs in. If you want it to run every "
28916 "time a user logs in, replace C<RunOnce> with C<Run>."
28920 #: ../tools/virt-win-reg.pl:664
28921 msgid "Now update the registry:"
28925 #: ../tools/virt-win-reg.pl:666
28928 " virt-win-reg --merge WindowsGuest test.reg\n"
28933 #: ../tools/virt-win-reg.pl:668
28934 msgid "INSTALLING A SERVICE"
28938 #: ../tools/virt-win-reg.pl:670
28940 "This section assumes you are familiar with Windows services, and you either "
28941 "have a program which handles the Windows Service Control Protocol directly "
28942 "or you want to run any program using a service wrapper like SrvAny or the "
28947 #: ../tools/virt-win-reg.pl:675
28949 "First upload the program and optionally the service wrapper. In this case "
28950 "the test program is called C<test.exe> and we are using the RHSrvAny "
28955 #: ../tools/virt-win-reg.pl:679
28958 " guestfish -i -d WindowsGuest <<EOF\n"
28959 " upload rhsrvany.exe /rhsrvany.exe\n"
28960 " upload test.exe /test.exe\n"
28966 #: ../tools/virt-win-reg.pl:684
28968 "Prepare a regedit file containing the registry changes. In this example, "
28969 "the first registry change is needed for the service itself or the service "
28970 "wrapper (if used). The second registry change is only needed because I am "
28971 "using the RHSrvAny service wrapper."
28975 #: ../tools/virt-win-reg.pl:689
28978 " cat > service.reg <<'EOF'\n"
28979 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
28980 " \"Type\"=dword:00000010\n"
28981 " \"Start\"=dword:00000002\n"
28982 " \"ErrorControl\"=dword:00000001\n"
28983 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
28984 " \"DisplayName\"=\"RHSrvAny\"\n"
28985 " \"ObjectName\"=\"NetworkService\"\n"
28990 #: ../tools/virt-win-reg.pl:698
28993 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
28994 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
28995 " \"PWD\"=\"c:\\\\Temp\"\n"
29001 #: ../tools/virt-win-reg.pl:709
29003 "For use of C<ControlSet001> see the section above in this manual page. You "
29004 "may need to adjust this according to the control set that is in use by the "
29009 #: ../tools/virt-win-reg.pl:715
29011 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29012 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29013 "privileged account."
29017 #: ../tools/virt-win-reg.pl:721
29019 "For the meaning of the magic numbers, see this Microsoft KB article: "
29020 "L<http://support.microsoft.com/kb/103000>."
29024 #: ../tools/virt-win-reg.pl:726
29025 msgid "Update the registry:"
29029 #: ../tools/virt-win-reg.pl:728
29032 " virt-win-reg --merge WindowsGuest service.reg\n"
29037 #: ../tools/virt-win-reg.pl:730 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
29038 msgid "SHELL QUOTING"
29042 #: ../tools/virt-win-reg.pl:732
29044 "Be careful when passing parameters containing C<\\> (backslash) in the "
29045 "shell. Usually you will have to use 'single quotes' or double backslashes "
29046 "(but not both) to protect them from the shell."
29050 #: ../tools/virt-win-reg.pl:736
29051 msgid "Paths and value names are case-insensitive."
29055 #: ../tools/virt-win-reg.pl:738 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
29057 "Libvirt guest names can contain arbitrary characters, some of which have "
29058 "meaning to the shell such as C<#> and space. You may need to quote or "
29059 "escape these characters on the command line. See the shell manual page "
29060 "L<sh(1)> for details."
29064 #: ../tools/virt-win-reg.pl:745
29066 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29067 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29068 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29069 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29073 #: ../tools/virt-win-reg.pl:760 ../tools/virt-make-fs.pl:555
29075 "When reporting bugs, please enable debugging and capture the I<complete> "
29080 #: ../tools/virt-win-reg.pl:763
29083 " export LIBGUESTFS_DEBUG=1\n"
29084 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29089 #: ../tools/virt-win-reg.pl:766
29091 "Attach /tmp/virt-win-reg.log to a new bug report at "
29092 "L<https://bugzilla.redhat.com/>"
29096 #: ../tools/virt-win-reg.pl:769 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
29101 #: ../tools/virt-win-reg.pl:771 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
29102 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29106 #: ../tools/virt-win-reg.pl:775 ../tools/virt-make-fs.pl:570
29107 msgid "Copyright (C) 2010 Red Hat Inc."
29111 #: ../tools/virt-list-filesystems.pl:32
29112 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29116 #: ../tools/virt-list-filesystems.pl:36
29119 " virt-list-filesystems [--options] domname\n"
29124 #: ../tools/virt-list-filesystems.pl:38
29127 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29132 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29134 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29139 #: ../tools/virt-list-filesystems.pl:45
29141 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29142 "are contained in a virtual machine or disk image."
29146 #: ../tools/virt-list-filesystems.pl:49
29148 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29149 "functionality. For more complex cases you should look at the "
29150 "L<guestfish(1)> tool."
29154 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29155 msgid "B<-l> | B<--long>"
29159 #: ../tools/virt-list-filesystems.pl:108
29161 "With this option, C<virt-list-filesystems> displays the type of each "
29162 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29166 #: ../tools/virt-list-filesystems.pl:115
29167 msgid "B<-a> | B<--all>"
29171 #: ../tools/virt-list-filesystems.pl:117
29173 "Normally we only show mountable filesystems. If this option is given then "
29174 "swap devices are shown too."
29178 #: ../tools/virt-list-filesystems.pl:191
29180 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29181 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29182 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29186 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29187 msgid "Copyright (C) 2009 Red Hat Inc."
29191 #: ../tools/virt-tar.pl:33
29192 msgid "virt-tar - Extract or upload files to a virtual machine"
29196 #: ../tools/virt-tar.pl:37
29199 " virt-tar [--options] -x domname directory tarball\n"
29204 #: ../tools/virt-tar.pl:39
29207 " virt-tar [--options] -u domname tarball directory\n"
29212 #: ../tools/virt-tar.pl:41
29215 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29220 #: ../tools/virt-tar.pl:43
29223 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29228 #: ../tools/virt-tar.pl:47
29230 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29231 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29235 #: ../tools/virt-tar.pl:52
29236 msgid "Download C</home> from the VM into a local tarball:"
29240 #: ../tools/virt-tar.pl:54
29243 " virt-tar -x domname /home home.tar\n"
29248 #: ../tools/virt-tar.pl:56
29251 " virt-tar -zx domname /home home.tar.gz\n"
29256 #: ../tools/virt-tar.pl:58
29257 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29261 #: ../tools/virt-tar.pl:60
29264 " virt-tar -u domname uploadstuff.tar /tmp\n"
29269 #: ../tools/virt-tar.pl:62
29272 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29277 #: ../tools/virt-tar.pl:66
29279 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
29280 "virtual machines. If you do this, you risk disk corruption in the VM. "
29281 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29285 #: ../tools/virt-tar.pl:71
29287 "You can use I<-x> (extract) on live virtual machines, but you might get "
29288 "inconsistent results or errors if there is filesystem activity inside the "
29289 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29290 "work, but the only way to guarantee consistent results is if the virtual "
29291 "machine is shut down."
29295 #: ../tools/virt-tar.pl:79
29297 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29298 "parts of a guest filesystem. There are many possibilities: making backups, "
29299 "uploading data files, snooping on guest activity, fixing or customizing "
29304 #: ../tools/virt-tar.pl:84
29306 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29307 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29308 "should look at the L<guestfish(1)> tool."
29312 #: ../tools/virt-tar.pl:88
29314 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
29315 "its contents (recursively) from the virtual machine into a local tarball. "
29316 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
29317 "virtual machine. You cannot use these two options together."
29321 #: ../tools/virt-tar.pl:94
29323 "In addition, you may need to use the I<-z> (gZip) option to enable "
29324 "compression. When uploading, you have to specify I<-z> if the upload file "
29325 "is compressed because virt-tar won't detect this on its own."
29329 #: ../tools/virt-tar.pl:98
29331 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29332 "example it cannot do PKZip files or bzip2 compression. If you want that "
29333 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29334 "the L<libguestfs(3)> API)."
29338 #: ../tools/virt-tar.pl:156
29339 msgid "B<-x> | B<--extract> | B<--download>"
29343 #: ../tools/virt-tar.pl:158
29344 msgid "B<-u> | B<--upload>"
29348 #: ../tools/virt-tar.pl:160
29350 "Use I<-x> to extract (download) a directory from a virtual machine to a "
29355 #: ../tools/virt-tar.pl:163
29357 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
29358 "Please read the L</WARNING> section above before using this option."
29362 #: ../tools/virt-tar.pl:167
29363 msgid "You must specify exactly one of these options."
29367 #: ../tools/virt-tar.pl:173
29368 msgid "B<-z> | B<--gzip>"
29372 #: ../tools/virt-tar.pl:175
29373 msgid "Specify that the input or output tarball is gzip-compressed."
29377 #: ../tools/virt-tar.pl:288
29379 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29380 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29381 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29382 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29386 #: ../tools/virt-make-fs.pl:37
29387 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29391 #: ../tools/virt-make-fs.pl:41
29394 " virt-make-fs [--options] input.tar output.img\n"
29399 #: ../tools/virt-make-fs.pl:43
29402 " virt-make-fs [--options] input.tar.gz output.img\n"
29407 #: ../tools/virt-make-fs.pl:45
29410 " virt-make-fs [--options] directory output.img\n"
29415 #: ../tools/virt-make-fs.pl:49
29417 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29418 "archive or some files in a directory. It is similar to tools like "
29419 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29420 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29421 "useful if you want to attach these filesystems to existing virtual machines "
29422 "(eg. to import large amounts of read-only data to a VM)."
29426 #: ../tools/virt-make-fs.pl:57
29427 msgid "Basic usage is:"
29431 #: ../tools/virt-make-fs.pl:59
29434 " virt-make-fs input output\n"
29439 #: ../tools/virt-make-fs.pl:61
29441 "where C<input> is either a directory containing files that you want to add, "
29442 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29443 "C<output> is a disk image. The input type is detected automatically. The "
29444 "output disk image defaults to a raw ext2 image unless you specify extra "
29445 "flags (see L</OPTIONS> below)."
29449 #: ../tools/virt-make-fs.pl:67
29450 msgid "EXTRA SPACE"
29454 #: ../tools/virt-make-fs.pl:69
29456 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29457 "the files that it contains, but might have extra space. Depending on how "
29458 "you are going to use the output, you might think this extra space is wasted "
29459 "and want to minimize it, or you might want to leave space so that more files "
29460 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29461 "but you can use the I<--size> flag to leave space in the filesystem if you "
29466 #: ../tools/virt-make-fs.pl:77
29468 "An alternative way to leave extra space but not make the output image any "
29469 "bigger is to use an alternative disk image format (instead of the default "
29470 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
29471 "image format (check your hypervisor supports this before using it). This "
29472 "allows you to choose a large I<--size> but the extra space won't actually be "
29473 "allocated in the image until you try to store something in it."
29477 #: ../tools/virt-make-fs.pl:85
29479 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29480 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29481 "to build another image from scratch."
29485 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29490 #: ../tools/virt-make-fs.pl:91
29493 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29498 #: ../tools/virt-make-fs.pl:93
29499 msgid "FILESYSTEM TYPE"
29503 #: ../tools/virt-make-fs.pl:95
29505 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29506 "libguestfs supports can be used (but I<not> read-only formats like "
29507 "ISO9660). Here are some of the more common choices:"
29511 #: ../tools/virt-make-fs.pl:101
29516 #: ../tools/virt-make-fs.pl:103
29518 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29519 "you are not going to use the filesystem in a way that requires the journal, "
29520 "then this is just wasted overhead."
29524 #: ../tools/virt-make-fs.pl:107
29525 msgid "I<ntfs> or I<vfat>"
29529 #: ../tools/virt-make-fs.pl:109
29530 msgid "Useful if exporting data to a Windows guest."
29534 #: ../tools/virt-make-fs.pl:111
29536 "I<Note for vfat>: The tar archive or local directory must only contain files "
29537 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29538 "program running within libguestfs is unable to change the ownership of "
29539 "non-root files, since vfat itself does not support this."
29543 #: ../tools/virt-make-fs.pl:116
29548 #: ../tools/virt-make-fs.pl:118
29550 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29551 "total filesystem size."
29555 #: ../tools/virt-make-fs.pl:125
29558 " virt-make-fs --type=minix input minixfs.img\n"
29563 #: ../tools/virt-make-fs.pl:127
29564 msgid "TO PARTITION OR NOT TO PARTITION"
29568 #: ../tools/virt-make-fs.pl:129
29569 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29573 #: ../tools/virt-make-fs.pl:131
29575 "Adding a partition can make the disk image more compatible with certain "
29576 "virtualized operating systems which don't expect to see a filesystem "
29577 "directly located on a block device (Linux doesn't care and will happily "
29578 "handle both types)."
29582 #: ../tools/virt-make-fs.pl:136
29584 "On the other hand, if you have a partition table then the output image is no "
29585 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29586 "directly on a partitioned disk image. (However libguestfs tools such as "
29587 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29591 #: ../tools/virt-make-fs.pl:144
29592 msgid "Add an MBR partition:"
29596 #: ../tools/virt-make-fs.pl:146
29599 " virt-make-fs --partition -- input disk.img\n"
29604 #: ../tools/virt-make-fs.pl:148
29606 "If the output disk image could be terabyte-sized or larger, it's better to "
29607 "use an EFI/GPT-compatible partition table:"
29611 #: ../tools/virt-make-fs.pl:151
29614 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29619 #: ../tools/virt-make-fs.pl:179
29620 msgid "Enable debugging information."
29624 #: ../tools/virt-make-fs.pl:185
29625 msgid "B<--size=E<lt>NE<gt>>"
29629 #: ../tools/virt-make-fs.pl:187
29630 msgid "B<--size=+E<lt>NE<gt>>"
29634 #: ../tools/virt-make-fs.pl:189
29635 msgid "B<-s E<lt>NE<gt>>"
29639 #: ../tools/virt-make-fs.pl:191
29640 msgid "B<-s +E<lt>NE<gt>>"
29644 #: ../tools/virt-make-fs.pl:193
29645 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
29649 #: ../tools/virt-make-fs.pl:196
29651 "If this option is I<not> given, then the output image will be just large "
29652 "enough to contain all the files, with not much wasted space."
29656 #: ../tools/virt-make-fs.pl:199
29658 "To choose a fixed size output disk, specify an absolute number followed by "
29659 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29660 "Petabytes or Exabytes. This must be large enough to contain all the input "
29661 "files, else you will get an error."
29665 #: ../tools/virt-make-fs.pl:204
29667 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29668 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29669 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
29670 "the input files, and (approximately) an extra 200 MB free space."
29674 #: ../tools/virt-make-fs.pl:210
29676 "Note that virt-make-fs estimates free space, and therefore will not produce "
29677 "filesystems containing precisely the free space requested. (It is much more "
29678 "expensive and time-consuming to produce a filesystem which has precisely the "
29679 "desired free space)."
29683 #: ../tools/virt-make-fs.pl:219
29684 msgid "B<--format=E<lt>fmtE<gt>>"
29688 #: ../tools/virt-make-fs.pl:221
29689 msgid "B<-F E<lt>fmtE<gt>>"
29693 #: ../tools/virt-make-fs.pl:223
29694 msgid "Choose the output disk image format."
29698 #: ../tools/virt-make-fs.pl:225
29699 msgid "The default is C<raw> (raw disk image)."
29703 #: ../tools/virt-make-fs.pl:227
29705 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29706 "that would really make sense here is C<qcow2>."
29710 #: ../tools/virt-make-fs.pl:234
29711 msgid "B<--type=E<lt>fsE<gt>>"
29715 #: ../tools/virt-make-fs.pl:236
29716 msgid "B<-t E<lt>fsE<gt>>"
29720 #: ../tools/virt-make-fs.pl:238
29721 msgid "Choose the output filesystem type."
29725 #: ../tools/virt-make-fs.pl:240
29726 msgid "The default is C<ext2>."
29730 #: ../tools/virt-make-fs.pl:242
29731 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29735 #: ../tools/virt-make-fs.pl:249
29736 msgid "B<--partition>"
29740 #: ../tools/virt-make-fs.pl:251
29741 msgid "B<--partition=E<lt>parttypeE<gt>>"
29745 #: ../tools/virt-make-fs.pl:253
29747 "If specified, this flag adds an MBR partition table to the output disk "
29752 #: ../tools/virt-make-fs.pl:256
29754 "You can change the partition table type, eg. I<--partition=gpt> for large "
29759 #: ../tools/virt-make-fs.pl:259
29761 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
29762 "might consider the next parameter to be the partition type. For example:"
29766 #: ../tools/virt-make-fs.pl:263
29769 " virt-make-fs --partition input.tar ...\n"
29774 #: ../tools/virt-make-fs.pl:265
29776 "would cause virt-make-fs to think you wanted to use a partition type of "
29777 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
29778 "dash) between options and the input file argument:"
29782 #: ../tools/virt-make-fs.pl:269
29785 " virt-make-fs --partition -- input.tar ...\n"
29790 #: ../tools/virt-make-fs.pl:541
29792 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
29793 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29794 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29798 #: ../tools/virt-make-fs.pl:558
29801 " export LIBGUESTFS_DEBUG=1\n"
29802 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29807 #: ../tools/virt-make-fs.pl:561
29809 "Attach /tmp/virt-make-fs.log to a new bug report at "
29810 "L<https://bugzilla.redhat.com/>"
29814 #: ../tools/virt-list-partitions.pl:32
29815 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29819 #: ../tools/virt-list-partitions.pl:36
29822 " virt-list-partitions [--options] domname\n"
29827 #: ../tools/virt-list-partitions.pl:38
29830 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29835 #: ../tools/virt-list-partitions.pl:45
29837 "C<virt-list-partitions> is a command line tool to list the partitions that "
29838 "are contained in a virtual machine or disk image. It is mainly useful as a "
29839 "first step to using L<virt-resize(1)>."
29843 #: ../tools/virt-list-partitions.pl:50
29845 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29846 "functionality. For more complex cases you should look at the "
29847 "L<guestfish(1)> tool."
29851 #: ../tools/virt-list-partitions.pl:107
29852 msgid "B<-h> | B<--human-readable>"
29856 #: ../tools/virt-list-partitions.pl:109
29857 msgid "Show sizes in human-readable form (eg. \"1G\")."
29861 #: ../tools/virt-list-partitions.pl:117
29863 "With this option, C<virt-list-partitions> displays the type and size of each "
29864 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29868 #: ../tools/virt-list-partitions.pl:124
29869 msgid "B<-t> | B<--total>"
29873 #: ../tools/virt-list-partitions.pl:126
29874 msgid "Display the total size of each block device (as a separate row or rows)."
29878 #: ../tools/virt-list-partitions.pl:259
29880 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29881 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29882 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29886 #: ../tools/virt-list-partitions.pl:275
29887 msgid "Copyright (C) 2009-2010 Red Hat Inc."