1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: libguestfs 1.9.3\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-01-11 21:54+0000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
26 #: ../src/guestfs.pod:5
27 msgid "guestfs - Library for accessing and modifying virtual machine images"
31 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
36 #: ../src/guestfs.pod:9
39 " #include <guestfs.h>\n"
44 #: ../src/guestfs.pod:11
47 " guestfs_h *g = guestfs_create ();\n"
48 " guestfs_add_drive (g, \"guest.img\");\n"
49 " guestfs_launch (g);\n"
50 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
51 " guestfs_touch (g, \"/hello\");\n"
52 " guestfs_umount (g, \"/\");\n"
53 " guestfs_close (g);\n"
58 #: ../src/guestfs.pod:19
61 " cc prog.c -o prog -lguestfs\n"
63 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
68 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
73 #: ../src/guestfs.pod:25
75 "Libguestfs is a library for accessing and modifying guest disk images. "
76 "Amongst the things this is good for: making batch configuration changes to "
77 "guests, getting disk used/free statistics (see also: virt-df), migrating "
78 "between virtualization systems (see also: virt-p2v), performing partial "
79 "backups, performing partial guest clones, cloning guests and changing "
80 "registry/UUID/hostname info, and much else besides."
84 #: ../src/guestfs.pod:33
86 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
87 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
88 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
93 #: ../src/guestfs.pod:38
95 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
96 "what filesystem is in each LV, etc.). It can also run commands in the "
97 "context of the guest. Also you can access filesystems over FUSE."
101 #: ../src/guestfs.pod:43
103 "Libguestfs is a library that can be linked with C and C++ management "
104 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
105 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
110 #: ../src/guestfs.pod:48
112 "You don't need to be root to use libguestfs, although obviously you do need "
113 "enough permissions to access the disk images."
117 #: ../src/guestfs.pod:51
119 "Libguestfs is a large API because it can do many things. For a gentle "
120 "introduction, please read the L</API OVERVIEW> section next."
124 #: ../src/guestfs.pod:54
126 "There are also some example programs in the L<guestfs-examples(3)> manual "
131 #: ../src/guestfs.pod:57
136 #: ../src/guestfs.pod:59
138 "This section provides a gentler overview of the libguestfs API. We also try "
139 "to group API calls together, where that may not be obvious from reading "
140 "about the individual calls in the main section of this manual."
144 #: ../src/guestfs.pod:64
149 #: ../src/guestfs.pod:66
151 "Before you can use libguestfs calls, you have to create a handle. Then you "
152 "must add at least one disk image to the handle, followed by launching the "
153 "handle, then performing whatever operations you want, and finally closing "
154 "the handle. By convention we use the single letter C<g> for the name of the "
155 "handle variable, although of course you can use any name you want."
159 #: ../src/guestfs.pod:73
160 msgid "The general structure of all libguestfs-using programs looks like this:"
164 #: ../src/guestfs.pod:76
167 " guestfs_h *g = guestfs_create ();\n"
172 #: ../src/guestfs.pod:78
175 " /* Call guestfs_add_drive additional times if there are\n"
176 " * multiple disk images.\n"
178 " guestfs_add_drive (g, \"guest.img\");\n"
183 #: ../src/guestfs.pod:83
186 " /* Most manipulation calls won't work until you've launched\n"
187 " * the handle 'g'. You have to do this _after_ adding drives\n"
188 " * and _before_ other commands.\n"
190 " guestfs_launch (g);\n"
195 #: ../src/guestfs.pod:89
198 " /* Now you can examine what partitions, LVs etc are available.\n"
200 " char **partitions = guestfs_list_partitions (g);\n"
201 " char **logvols = guestfs_lvs (g);\n"
206 #: ../src/guestfs.pod:94
209 " /* To access a filesystem in the image, you must mount it.\n"
211 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
216 #: ../src/guestfs.pod:98
219 " /* Now you can perform filesystem actions on the guest\n"
222 " guestfs_touch (g, \"/hello\");\n"
227 #: ../src/guestfs.pod:103
230 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
231 " * it is done automatically when you close the handle. See\n"
232 " * discussion of autosync in this page.\n"
234 " guestfs_sync (g);\n"
239 #: ../src/guestfs.pod:109
242 " /* Close the handle 'g'. */\n"
243 " guestfs_close (g);\n"
248 #: ../src/guestfs.pod:112
250 "The code above doesn't include any error checking. In real code you should "
251 "check return values carefully for errors. In general all functions that "
252 "return integers return C<-1> on error, and all functions that return "
253 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
254 "how to handle errors, and consult the documentation for each function call "
255 "below to see precisely how they return error indications. See "
256 "L<guestfs-examples(3)> for fully worked examples."
260 #: ../src/guestfs.pod:121
265 #: ../src/guestfs.pod:123
267 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
268 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
269 "actual block device, or simply an empty file of zeroes that you have created "
270 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
275 #: ../src/guestfs.pod:129
277 "The call you should use in modern code for adding drives is "
278 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
279 "specifying that the format is raw, do:"
283 #: ../src/guestfs.pod:133
286 " guestfs_add_drive_opts (g, filename,\n"
287 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
293 #: ../src/guestfs.pod:137
294 msgid "You can add a disk read-only using:"
298 #: ../src/guestfs.pod:139
301 " guestfs_add_drive_opts (g, filename,\n"
302 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
303 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
309 #: ../src/guestfs.pod:144
311 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
312 "libguestfs won't modify the file."
316 #: ../src/guestfs.pod:147
318 "Be extremely cautious if the disk image is in use, eg. if it is being used "
319 "by a virtual machine. Adding it read-write will almost certainly cause disk "
320 "corruption, but adding it read-only is safe."
324 #: ../src/guestfs.pod:151
326 "You must add at least one disk image, and you may add multiple disk images. "
327 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
328 "first one you added), C</dev/sdb> (for the second one you added), etc."
332 #: ../src/guestfs.pod:156
334 "Once L</guestfs_launch> has been called you cannot add any more images. You "
335 "can call L</guestfs_list_devices> to get a list of the device names, in the "
336 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
340 #: ../src/guestfs.pod:161
345 #: ../src/guestfs.pod:163
347 "Before you can read or write files, create directories and so on in a disk "
348 "image that contains filesystems, you have to mount those filesystems using "
349 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
350 "a disk image contains (for example) one partition with a filesystem on that "
351 "partition, then you can mount it directly:"
355 #: ../src/guestfs.pod:170
358 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
363 #: ../src/guestfs.pod:172
365 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
366 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
367 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
368 "that these are libguestfs virtual devices, and are nothing to do with host "
373 #: ../src/guestfs.pod:178
375 "If you are given a disk image and you don't know what it contains then you "
376 "have to find out. Libguestfs can do that too: use "
377 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
378 "and LVs, and either try mounting each to see what is mountable, or else "
379 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
380 "filesystems, use L</guestfs_list_filesystems>."
384 #: ../src/guestfs.pod:186
386 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
387 "L</INSPECTION> below). But you might find it easier to look at higher level "
388 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
392 #: ../src/guestfs.pod:191
394 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
395 "several other variations of the C<guestfs_mount_*> call."
399 #: ../src/guestfs.pod:194
400 msgid "FILESYSTEM ACCESS AND MODIFICATION"
404 #: ../src/guestfs.pod:196
406 "The majority of the libguestfs API consists of fairly low-level calls for "
407 "accessing and modifying the files, directories, symlinks etc on mounted "
408 "filesystems. There are over a hundred such calls which you can find listed "
409 "in detail below in this man page, and we don't even pretend to cover them "
410 "all in this overview."
414 #: ../src/guestfs.pod:202
416 "Specify filenames as full paths, starting with C<\"/\"> and including the "
421 #: ../src/guestfs.pod:205
423 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
424 "the file called C<\"etc/passwd\"> then you could do:"
428 #: ../src/guestfs.pod:208
431 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
436 #: ../src/guestfs.pod:210
438 "This would return C<data> as a newly allocated buffer containing the full "
439 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
440 "or C<NULL> if there was an error."
444 #: ../src/guestfs.pod:214
446 "As another example, to create a top-level directory on that filesystem "
447 "called C<\"var\"> you would do:"
451 #: ../src/guestfs.pod:217
454 " guestfs_mkdir (g, \"/var\");\n"
459 #: ../src/guestfs.pod:219
460 msgid "To create a symlink you could do:"
464 #: ../src/guestfs.pod:221
467 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
468 " \"/etc/rc3.d/S30portmap\");\n"
473 #: ../src/guestfs.pod:224
475 "Libguestfs will reject attempts to use relative paths and there is no "
476 "concept of a current working directory."
480 #: ../src/guestfs.pod:227
482 "Libguestfs can return errors in many situations: for example if the "
483 "filesystem isn't writable, or if a file or directory that you requested "
484 "doesn't exist. If you are using the C API (documented here) you have to "
485 "check for those error conditions after each call. (Other language bindings "
486 "turn these errors into exceptions)."
490 #: ../src/guestfs.pod:233
492 "File writes are affected by the per-handle umask, set by calling "
493 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
497 #: ../src/guestfs.pod:236
502 #: ../src/guestfs.pod:238
504 "Libguestfs contains API calls to read, create and modify partition tables on "
509 #: ../src/guestfs.pod:241
511 "In the common case where you want to create a single partition covering the "
512 "whole disk, you should use the L</guestfs_part_disk> call:"
516 #: ../src/guestfs.pod:245
519 " const char *parttype = \"mbr\";\n"
520 " if (disk_is_larger_than_2TB)\n"
521 " parttype = \"gpt\";\n"
522 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
527 #: ../src/guestfs.pod:250
529 "Obviously this effectively wipes anything that was on that disk image "
534 #: ../src/guestfs.pod:253
539 #: ../src/guestfs.pod:255
541 "Libguestfs provides access to a large part of the LVM2 API, such as "
542 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
543 "unless you familiarize yourself with the concepts of physical volumes, "
544 "volume groups and logical volumes."
548 #: ../src/guestfs.pod:260
550 "This author strongly recommends reading the LVM HOWTO, online at "
551 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
555 #: ../src/guestfs.pod:263
560 #: ../src/guestfs.pod:265
562 "Use L</guestfs_cat> to download small, text only files. This call is "
563 "limited to files which are less than 2 MB and which cannot contain any ASCII "
564 "NUL (C<\\0>) characters. However the API is very simple to use."
568 #: ../src/guestfs.pod:269
570 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
571 "bit data, since it returns a (pointer, size) pair. However it is still "
572 "limited to \"small\" files, less than 2 MB."
576 #: ../src/guestfs.pod:273
578 "L</guestfs_download> can be used to download any file, with no limits on "
579 "content or size (even files larger than 4 GB)."
583 #: ../src/guestfs.pod:276
584 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
588 #: ../src/guestfs.pod:279
593 #: ../src/guestfs.pod:281
595 "It's often the case that you want to write a file or files to the disk "
600 #: ../src/guestfs.pod:284
602 "To write a small file with fixed content, use L</guestfs_write>. To create "
603 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
604 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
605 "variety of other functions for creating test files, for example "
606 "L</guestfs_fill> and L</guestfs_fill_pattern>."
610 #: ../src/guestfs.pod:290
612 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
613 "file content or size (even files larger than 4 GB)."
617 #: ../src/guestfs.pod:293
618 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
622 #: ../src/guestfs.pod:295
624 "However the fastest way to upload I<large numbers of arbitrary files> is to "
625 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
626 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
627 "the drive in a predictable way (eg. adding it last after all other drives) "
628 "then you can get the device name from L</guestfs_list_devices> and mount it "
629 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
630 "sometimes non-portable between kernel versions, and they don't support "
631 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
632 "using a label or UUID, use an ISO image instead."
636 #: ../src/guestfs.pod:306
641 #: ../src/guestfs.pod:308
643 "There are various different commands for copying between files and devices "
644 "and in and out of the guest filesystem. These are summarised in the table "
649 #: ../src/guestfs.pod:314
650 msgid "B<file> to B<file>"
654 #: ../src/guestfs.pod:316
656 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
657 "directories recursively."
661 #: ../src/guestfs.pod:319
662 msgid "B<file or device> to B<file or device>"
666 #: ../src/guestfs.pod:321
668 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
669 "devices in the guest."
673 #: ../src/guestfs.pod:324
674 msgid "Example: duplicate the contents of an LV:"
678 #: ../src/guestfs.pod:326
681 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
686 #: ../src/guestfs.pod:328
688 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
689 "(C</dev/VG/Original>). To copy less than the whole source device, use "
690 "L</guestfs_copy_size>."
694 #: ../src/guestfs.pod:332
695 msgid "B<file on the host> to B<file or device>"
699 #: ../src/guestfs.pod:334
700 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
704 #: ../src/guestfs.pod:336
705 msgid "B<file or device> to B<file on the host>"
709 #: ../src/guestfs.pod:338
710 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
714 #: ../src/guestfs.pod:342
715 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
719 #: ../src/guestfs.pod:344
721 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
722 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
723 "appears you can only upload and download to files. However many Un*x-like "
724 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
725 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
726 "stderr, and arbitrary file descriptor N."
730 #: ../src/guestfs.pod:352
731 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
735 #: ../src/guestfs.pod:355
738 " guestfs_download (g, filename, \"/dev/stdout\");\n"
743 #: ../src/guestfs.pod:357
744 msgid "and you can write tar output to a pipe C<fd> by doing:"
748 #: ../src/guestfs.pod:359
752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
753 " guestfs_tar_out (g, \"/\", devfd);\n"
758 #: ../src/guestfs.pod:363
759 msgid "LISTING FILES"
763 #: ../src/guestfs.pod:365
765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
766 "L<guestfish(1)>-equivalent command C<ll>)."
770 #: ../src/guestfs.pod:368
772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
773 "programs, as a flat list of strings."
777 #: ../src/guestfs.pod:371
779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
780 "directory, plus additional information about each one. It is more "
781 "equivalent to using the L<readdir(3)> call on a local filesystem."
785 #: ../src/guestfs.pod:375
787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
792 #: ../src/guestfs.pod:378
793 msgid "RUNNING COMMANDS"
797 #: ../src/guestfs.pod:380
799 "Although libguestfs is primarily an API for manipulating files inside guest "
800 "images, we also provide some limited facilities for running commands inside "
805 #: ../src/guestfs.pod:384
806 msgid "There are many limitations to this:"
810 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1011 ../src/guestfs.pod:1015 ../src/guestfs.pod:1019 ../src/guestfs.pod:1024 ../src/guestfs.pod:1032 ../src/guestfs.pod:1051 ../src/guestfs.pod:1059 ../src/guestfs.pod:1081 ../src/guestfs.pod:1085 ../src/guestfs.pod:1089 ../src/guestfs.pod:1093 ../src/guestfs.pod:1097 ../src/guestfs.pod:1101 ../src/guestfs.pod:1583 ../src/guestfs.pod:1588 ../src/guestfs.pod:1592 ../src/guestfs.pod:1702 ../src/guestfs.pod:1707 ../src/guestfs.pod:1711 ../src/guestfs.pod:2063 ../src/guestfs.pod:2069 ../src/guestfs.pod:2074 ../src/guestfs.pod:2080 ../src/guestfs.pod:2544 ../src/guestfs.pod:2548 ../src/guestfs.pod:2552 ../src/guestfs.pod:2556 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373 ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073 ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257 ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1204 ../src/guestfs.pod:1335 ../src/guestfs.pod:2108
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:1208 ../src/guestfs.pod:1339 ../src/guestfs.pod:2133
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:1345
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:720
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. (These APIs used to be in a separate Perl-only "
1112 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1113 "frequently used part of this library has been rewritten in C and moved into "
1118 #: ../src/guestfs.pod:558
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:561
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:570
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:576
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:583
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:587
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:590
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:594
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:598
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:602
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:611
1213 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1217 #: ../src/guestfs.pod:613
1219 "Libguestfs can mount NTFS partitions. It does this using the "
1220 "L<http://www.ntfs-3g.org/> driver."
1224 #: ../src/guestfs.pod:616
1225 msgid "DRIVE LETTERS AND PATHS"
1229 #: ../src/guestfs.pod:618
1231 "DOS and Windows still use drive letters, and the filesystems are always "
1232 "treated as case insensitive by Windows itself, and therefore you might find "
1233 "a Windows configuration file referring to a path like "
1234 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1235 "that directory might be referred to as C</WINDOWS/System32>."
1239 #: ../src/guestfs.pod:624
1241 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1242 "libguestfs to read the appropriate Windows Registry and configuration files, "
1243 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1244 "L<virt-inspector(1)>)."
1248 #: ../src/guestfs.pod:629
1250 "Replacing backslash characters with forward slash characters is also outside "
1251 "the scope of libguestfs, but something that you can easily do."
1255 #: ../src/guestfs.pod:632
1257 "Where we can help is in resolving the case insensitivity of paths. For "
1258 "this, call L</guestfs_case_sensitive_path>."
1262 #: ../src/guestfs.pod:635
1263 msgid "ACCESSING THE WINDOWS REGISTRY"
1267 #: ../src/guestfs.pod:637
1269 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1270 "files, through the library C<hivex> which is part of the libguestfs project "
1271 "although ships as a separate tarball. You have to locate and download the "
1272 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1273 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1274 "L<virt-win-reg(1)> for more help on this issue."
1278 #: ../src/guestfs.pod:645
1279 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1283 #: ../src/guestfs.pod:647
1285 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1286 "provide something which looks like a Linux symlink. The way it tries to do "
1287 "the rewriting is described here:"
1291 #: ../src/guestfs.pod:651
1292 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1296 #: ../src/guestfs.pod:653
1298 "The essential problem is that ntfs-3g simply does not have enough "
1299 "information to do a correct job. NTFS links can contain drive letters and "
1300 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1301 "It is almost certainly the case that libguestfs callers should ignore what "
1302 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1306 #: ../src/guestfs.pod:660
1308 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1309 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1310 "attribute, and read the raw reparse data from that (you can find the format "
1311 "documented in various places around the web)."
1315 #: ../src/guestfs.pod:665
1316 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1320 #: ../src/guestfs.pod:667
1322 "There are other useful extended attributes that can be read from ntfs-3g "
1323 "filesystems (using L</guestfs_getxattr>). See:"
1327 #: ../src/guestfs.pod:670
1328 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1332 #: ../src/guestfs.pod:672
1333 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1337 #: ../src/guestfs.pod:674
1339 "Although we don't want to discourage you from using the C API, we will "
1340 "mention here that the same API is also available in other languages."
1344 #: ../src/guestfs.pod:677
1346 "The API is broadly identical in all supported languages. This means that "
1347 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1348 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1349 "OCaml. In other words, a straightforward, predictable isomorphism between "
1354 #: ../src/guestfs.pod:683
1356 "Error messages are automatically transformed into exceptions if the language "
1361 #: ../src/guestfs.pod:686
1363 "We don't try to \"object orientify\" parts of the API in OO languages, "
1364 "although contributors are welcome to write higher level APIs above what we "
1365 "provide in their favourite languages if they wish."
1369 #: ../src/guestfs.pod:692
1374 #: ../src/guestfs.pod:694
1376 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1377 "identical to the C API. C++ classes and exceptions are not used."
1381 #: ../src/guestfs.pod:698
1386 #: ../src/guestfs.pod:700
1388 "The C# bindings are highly experimental. Please read the warnings at the "
1389 "top of C<csharp/Libguestfs.cs>."
1393 #: ../src/guestfs.pod:703
1398 #: ../src/guestfs.pod:705
1400 "This is the only language binding that is working but incomplete. Only "
1401 "calls which return simple integers have been bound in Haskell, and we are "
1402 "looking for help to complete this binding."
1406 #: ../src/guestfs.pod:709
1411 #: ../src/guestfs.pod:711
1413 "Full documentation is contained in the Javadoc which is distributed with "
1418 #: ../src/guestfs.pod:714
1423 #: ../src/guestfs.pod:716
1424 msgid "See L<guestfs-ocaml(3)>."
1428 #: ../src/guestfs.pod:718
1433 #: ../src/guestfs.pod:720
1434 msgid "See L<Sys::Guestfs(3)>."
1438 #: ../src/guestfs.pod:722
1443 #: ../src/guestfs.pod:724
1445 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1446 "the php-libguestfs package for your distribution."
1450 #: ../src/guestfs.pod:727
1451 msgid "The PHP binding only works correctly on 64 bit machines."
1455 #: ../src/guestfs.pod:729
1460 #: ../src/guestfs.pod:731
1461 msgid "See L<guestfs-python(3)>."
1465 #: ../src/guestfs.pod:733
1470 #: ../src/guestfs.pod:735
1471 msgid "See L<guestfs-ruby(3)>."
1475 #: ../src/guestfs.pod:737
1476 msgid "B<shell scripts>"
1480 #: ../src/guestfs.pod:739
1481 msgid "See L<guestfish(1)>."
1485 #: ../src/guestfs.pod:743
1486 msgid "LIBGUESTFS GOTCHAS"
1490 #: ../src/guestfs.pod:745
1492 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1493 "system [...] that works in the way it is documented but is counterintuitive "
1494 "and almost invites mistakes.\""
1498 #: ../src/guestfs.pod:749
1500 "Since we developed libguestfs and the associated tools, there are several "
1501 "things we would have designed differently, but are now stuck with for "
1502 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1503 "release, you can expect these to change. Beware of them."
1507 #: ../src/guestfs.pod:757
1508 msgid "Autosync / forgetting to sync."
1512 #: ../src/guestfs.pod:759
1514 "When modifying a filesystem from C or another language, you B<must> unmount "
1515 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1516 "libguestfs handle. You can also call:"
1520 #: ../src/guestfs.pod:763
1523 " guestfs_set_autosync (g, 1);\n"
1528 #: ../src/guestfs.pod:765
1530 "to have the unmount/sync done automatically for you when the handle 'g' is "
1531 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1536 #: ../src/guestfs.pod:769
1538 "If you forget to do this, then it is entirely possible that your changes "
1539 "won't be written out, or will be partially written, or (very rarely) that "
1540 "you'll get disk corruption."
1544 #: ../src/guestfs.pod:773
1546 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1547 "guestfish scripts that forget to sync will work just fine, which can make "
1548 "this very puzzling if you are trying to debug a problem."
1552 #: ../src/guestfs.pod:777
1554 "Update: Autosync is enabled by default for all API users starting from "
1555 "libguestfs 1.5.24."
1559 #: ../src/guestfs.pod:780
1560 msgid "Mount option C<-o sync> should not be the default."
1564 #: ../src/guestfs.pod:782
1566 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1567 "However C<-o sync> does not add any reliability benefit, but does have a "
1568 "very large performance impact."
1572 #: ../src/guestfs.pod:786
1574 "The work around is to use L</guestfs_mount_options> and set the mount "
1575 "options that you actually want to use."
1579 #: ../src/guestfs.pod:789
1580 msgid "Read-only should be the default."
1584 #: ../src/guestfs.pod:791
1586 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1587 "specify I<--rw> if you want to make changes to the image."
1591 #: ../src/guestfs.pod:794
1592 msgid "This would reduce the potential to corrupt live VM images."
1596 #: ../src/guestfs.pod:796
1598 "Note that many filesystems change the disk when you just mount and unmount, "
1599 "even if you didn't perform any writes. You need to use "
1600 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1604 #: ../src/guestfs.pod:800
1605 msgid "guestfish command line is hard to use."
1609 #: ../src/guestfs.pod:802
1611 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1612 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1613 "exist, so it fails. In earlier versions of guestfish the error message was "
1614 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1615 "we should have used C<guestfish -c command> to run commands."
1619 #: ../src/guestfs.pod:809
1620 msgid "guestfish megabyte modifiers don't work right on all commands"
1624 #: ../src/guestfs.pod:811
1626 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1627 "other modifiers). What guestfish actually does is to multiply the number "
1628 "part by the modifier part and pass the result to the C API. However this "
1629 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1630 "expecting some other unit (eg. megabytes)."
1634 #: ../src/guestfs.pod:818
1635 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1639 #: ../src/guestfs.pod:820
1642 " lvcreate LV VG 100M\n"
1647 #: ../src/guestfs.pod:822
1649 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1650 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1651 "megabytes * megabytes) logical volume. The error message you get from this "
1652 "is also a little obscure."
1656 #: ../src/guestfs.pod:827
1658 "This could be fixed in the generator by specially marking parameters and "
1659 "return values which take bytes or other units."
1663 #: ../src/guestfs.pod:830
1664 msgid "Ambiguity between devices and paths"
1668 #: ../src/guestfs.pod:832
1670 "There is a subtle ambiguity in the API between a device name "
1671 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1672 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1676 #: ../src/guestfs.pod:837
1678 "In the current API we usually resolve this ambiguity by having two separate "
1679 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1680 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1681 "detecting if the path supplied begins with C</dev/>."
1685 #: ../src/guestfs.pod:843
1687 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1688 "make paths/devices into structured names. One way to do this would be to "
1689 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1690 "aspect of grub. Another way would be to use a structured type, equivalent "
1691 "to this OCaml type:"
1695 #: ../src/guestfs.pod:849
1698 " type path = Path of string | Device of int | Partition of int * int\n"
1703 #: ../src/guestfs.pod:851
1704 msgid "which would allow you to pass arguments like:"
1708 #: ../src/guestfs.pod:853
1711 " Path \"/foo/bar\"\n"
1712 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1713 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1714 " Path \"/dev/sdb2\" (* not a device *)\n"
1719 #: ../src/guestfs.pod:858
1721 "As you can see there are still problems to resolve even with this "
1722 "representation. Also consider how it might work in guestfish."
1726 #: ../src/guestfs.pod:863
1727 msgid "PROTOCOL LIMITS"
1731 #: ../src/guestfs.pod:865
1733 "Internally libguestfs uses a message-based protocol to pass API calls and "
1734 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1735 "plenty more detail about this). The maximum message size used by the "
1736 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1737 "aware of this limit. The API calls which may be affected are individually "
1738 "documented, with a link back to this section of the documentation."
1742 #: ../src/guestfs.pod:873
1744 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1745 "a simple string. Because this string is at some point internally encoded as "
1746 "a message, the maximum size that it can return is slightly under 4 MB. If "
1747 "the requested file is larger than this then you will get an error."
1751 #: ../src/guestfs.pod:879
1753 "In order to transfer large files into and out of the guest filesystem, you "
1754 "need to use particular calls that support this. The sections L</UPLOADING> "
1755 "and L</DOWNLOADING> document how to do this."
1759 #: ../src/guestfs.pod:883
1761 "You might also consider mounting the disk image using our FUSE filesystem "
1762 "support (L<guestmount(1)>)."
1766 #: ../src/guestfs.pod:886
1767 msgid "KEYS AND PASSPHRASES"
1771 #: ../src/guestfs.pod:888
1773 "Certain libguestfs calls take a parameter that contains sensitive key "
1774 "material, passed in as a C string."
1778 #: ../src/guestfs.pod:891
1780 "In the future we would hope to change the libguestfs implementation so that "
1781 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1782 "swap. However this is I<not> done at the moment, because of the complexity "
1783 "of such an implementation."
1787 #: ../src/guestfs.pod:896
1789 "Therefore you should be aware that any key parameter you pass to libguestfs "
1790 "might end up being written out to the swap partition. If this is a concern, "
1791 "scrub the swap partition or don't use libguestfs on encrypted devices."
1795 #: ../src/guestfs.pod:901
1796 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1800 #: ../src/guestfs.pod:903
1802 "All high-level libguestfs actions are synchronous. If you want to use "
1803 "libguestfs asynchronously then you must create a thread."
1807 #: ../src/guestfs.pod:906
1809 "Only use the handle from a single thread. Either use the handle exclusively "
1810 "from one thread, or provide your own mutex so that two threads cannot issue "
1811 "calls on the same handle at the same time."
1815 #: ../src/guestfs.pod:910
1817 "See the graphical program guestfs-browser for one possible architecture for "
1818 "multithreaded programs using libvirt and libguestfs."
1822 #: ../src/guestfs.pod:913
1827 #: ../src/guestfs.pod:915
1829 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1834 #: ../src/guestfs.pod:918
1836 "By default it looks for these in the directory C<$libdir/guestfs> "
1837 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1841 #: ../src/guestfs.pod:921
1843 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1844 "to change the directories that libguestfs will search in. The value is a "
1845 "colon-separated list of paths. The current directory is I<not> searched "
1846 "unless the path contains an empty element or C<.>. For example "
1847 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1848 "then C</usr/lib/guestfs>."
1852 #: ../src/guestfs.pod:928
1853 msgid "QEMU WRAPPERS"
1857 #: ../src/guestfs.pod:930
1859 "If you want to compile your own qemu, run qemu from a non-standard location, "
1860 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1865 #: ../src/guestfs.pod:934
1867 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1868 "last command in the shell script (so that qemu replaces the shell and "
1869 "becomes the direct child of the libguestfs-using program). If you don't do "
1870 "this, then the qemu process won't be cleaned up correctly."
1874 #: ../src/guestfs.pod:939
1876 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1881 #: ../src/guestfs.pod:942
1885 " qemudir=/home/rjones/d/qemu\n"
1886 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1892 #: ../src/guestfs.pod:946
1894 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1895 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1900 #: ../src/guestfs.pod:950
1903 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1908 #: ../src/guestfs.pod:952
1910 "Note that libguestfs also calls qemu with the -help and -version options in "
1911 "order to determine features."
1915 #: ../src/guestfs.pod:955
1916 msgid "ABI GUARANTEE"
1920 #: ../src/guestfs.pod:957
1922 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1923 "actions as outlined in this section. Although we will deprecate some "
1924 "actions, for example if they get replaced by newer calls, we will keep the "
1925 "old actions forever. This allows you the developer to program in confidence "
1926 "against the libguestfs API."
1930 #: ../src/guestfs.pod:963
1931 msgid "BLOCK DEVICE NAMING"
1935 #: ../src/guestfs.pod:965
1937 "In the kernel there is now quite a profusion of schemata for naming block "
1938 "devices (in this context, by I<block device> I mean a physical or virtual "
1939 "hard drive). The original Linux IDE driver used names starting with "
1940 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1941 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1942 "replacement for the old IDE driver (particularly for SATA devices) those "
1943 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1944 "machines with paravirtualized drivers. This has created several different "
1945 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1950 #: ../src/guestfs.pod:977
1952 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1953 "Linux kernel to access block devices. We can run a variety of appliances "
1954 "based on a variety of Linux kernels."
1958 #: ../src/guestfs.pod:981
1960 "This causes a problem for libguestfs because many API calls use device or "
1961 "partition names. Working scripts and the recipe (example) scripts that we "
1962 "make available over the internet could fail if the naming scheme changes."
1966 #: ../src/guestfs.pod:986
1968 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1969 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1970 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1971 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1975 #: ../src/guestfs.pod:992
1977 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1978 "L</guestfs_list_partitions> and similar calls return the true names of the "
1979 "devices and partitions as known to the appliance."
1983 #: ../src/guestfs.pod:997
1984 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1988 #: ../src/guestfs.pod:999
1990 "Usually this translation is transparent. However in some (very rare) cases "
1991 "you may need to know the exact algorithm. Such cases include where you use "
1992 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
1993 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
1998 #: ../src/guestfs.pod:1005
2000 "The algorithm is applied only to I<parameters> which are known to be either "
2001 "device or partition names. Return values from functions such as "
2002 "L</guestfs_list_devices> are never changed."
2006 #: ../src/guestfs.pod:1013
2007 msgid "Is the string a parameter which is a device or partition name?"
2011 #: ../src/guestfs.pod:1017
2012 msgid "Does the string begin with C</dev/sd>?"
2016 #: ../src/guestfs.pod:1021
2018 "Does the named device exist? If so, we use that device. However if I<not> "
2019 "then we continue with this algorithm."
2023 #: ../src/guestfs.pod:1026
2024 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2028 #: ../src/guestfs.pod:1028
2029 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2033 #: ../src/guestfs.pod:1030
2034 msgid "If that named device exists, use it. If not, continue."
2038 #: ../src/guestfs.pod:1034
2039 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2043 #: ../src/guestfs.pod:1036
2044 msgid "If that named device exists, use it. If not, return an error."
2048 #: ../src/guestfs.pod:1040
2049 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2053 #: ../src/guestfs.pod:1042
2055 "Although the standard naming scheme and automatic translation is useful for "
2056 "simple programs and guestfish scripts, for larger programs it is best not to "
2057 "rely on this mechanism."
2061 #: ../src/guestfs.pod:1046
2063 "Where possible for maximum future portability programs using libguestfs "
2064 "should use these future-proof techniques:"
2068 #: ../src/guestfs.pod:1053
2070 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2071 "device names, and then use those names directly."
2075 #: ../src/guestfs.pod:1056
2076 msgid "Since those device names exist by definition, they will never be translated."
2080 #: ../src/guestfs.pod:1061
2082 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2083 "filesystem labels."
2087 #: ../src/guestfs.pod:1066
2092 #: ../src/guestfs.pod:1068
2094 "This section discusses security implications of using libguestfs, "
2095 "particularly with untrusted or malicious guests or disk images."
2099 #: ../src/guestfs.pod:1071
2100 msgid "GENERAL SECURITY CONSIDERATIONS"
2104 #: ../src/guestfs.pod:1073
2106 "Be careful with any files or data that you download from a guest (by "
2107 "\"download\" we mean not just the L</guestfs_download> command but any "
2108 "command that reads files, filenames, directories or anything else from a "
2109 "disk image). An attacker could manipulate the data to fool your program "
2110 "into doing the wrong thing. Consider cases such as:"
2114 #: ../src/guestfs.pod:1083
2115 msgid "the data (file etc) not being present"
2119 #: ../src/guestfs.pod:1087
2120 msgid "being present but empty"
2124 #: ../src/guestfs.pod:1091
2125 msgid "being much larger than normal"
2129 #: ../src/guestfs.pod:1095
2130 msgid "containing arbitrary 8 bit data"
2134 #: ../src/guestfs.pod:1099
2135 msgid "being in an unexpected character encoding"
2139 #: ../src/guestfs.pod:1103
2140 msgid "containing homoglyphs."
2144 #: ../src/guestfs.pod:1107
2145 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2149 #: ../src/guestfs.pod:1109
2151 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2152 "(VFS) module can sometimes be escalated into exploits by deliberately "
2153 "creating a malicious, malformed filesystem. These exploits are very severe "
2154 "for two reasons. Firstly there are very many filesystem drivers in the "
2155 "kernel, and many of them are infrequently used and not much developer "
2156 "attention has been paid to the code. Linux userspace helps potential "
2157 "crackers by detecting the filesystem type and automatically choosing the "
2158 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2159 "the administrator. Secondly, a kernel-level exploit is like a local root "
2160 "exploit (worse in some ways), giving immediate and total access to the "
2161 "system right down to the hardware level."
2165 #: ../src/guestfs.pod:1122
2167 "That explains why you should never mount a filesystem from an untrusted "
2168 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2169 "inside a qemu virtual machine, usually running as a non-root user. The "
2170 "attacker would need to write a filesystem which first exploited the kernel, "
2171 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2172 "the libguestfs protocol, and finally to be as serious as the host kernel "
2173 "exploit it would need to escalate its privileges to root. This multi-step "
2174 "escalation, performed by a static piece of data, is thought to be extremely "
2175 "hard to do, although we never say 'never' about security issues."
2179 #: ../src/guestfs.pod:1133
2181 "In any case callers can reduce the attack surface by forcing the filesystem "
2182 "type when mounting (use L</guestfs_mount_vfs>)."
2186 #: ../src/guestfs.pod:1136
2187 msgid "PROTOCOL SECURITY"
2191 #: ../src/guestfs.pod:1138
2193 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2194 "defined upper message size. However a program that uses libguestfs must "
2195 "also take care - for example you can write a program that downloads a binary "
2196 "from a disk image and executes it locally, and no amount of protocol "
2197 "security will save you from the consequences."
2201 #: ../src/guestfs.pod:1144
2202 msgid "INSPECTION SECURITY"
2206 #: ../src/guestfs.pod:1146
2208 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2209 "directly from the guest, and these could contain any 8 bit data. Callers "
2210 "should be careful to escape these before printing them to a structured file "
2211 "(for example, use HTML escaping if creating a web page)."
2215 #: ../src/guestfs.pod:1152
2217 "Guest configuration may be altered in unusual ways by the administrator of "
2218 "the virtual machine, and may not reflect reality (particularly for untrusted "
2219 "or actively malicious guests). For example we parse the hostname from "
2220 "configuration files like C</etc/sysconfig/network> that we find in the "
2221 "guest, but the guest administrator can easily manipulate these files to "
2222 "provide the wrong hostname."
2226 #: ../src/guestfs.pod:1160
2228 "The inspection API parses guest configuration using two external libraries: "
2229 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2230 "designed to be robust in the face of malicious data, although denial of "
2231 "service attacks are still possible, for example with oversized configuration "
2236 #: ../src/guestfs.pod:1166
2237 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2241 #: ../src/guestfs.pod:1168
2243 "Be very cautious about running commands from the guest. By running a "
2244 "command in the guest, you are giving CPU time to a binary that you do not "
2245 "control, under the same user account as the library, albeit wrapped in qemu "
2246 "virtualization. More information and alternatives can be found in the "
2247 "section L</RUNNING COMMANDS>."
2251 #: ../src/guestfs.pod:1174
2252 msgid "CVE-2010-3851"
2256 #: ../src/guestfs.pod:1176
2257 msgid "https://bugzilla.redhat.com/642934"
2261 #: ../src/guestfs.pod:1178
2263 "This security bug concerns the automatic disk format detection that qemu "
2264 "does on disk images."
2268 #: ../src/guestfs.pod:1181
2270 "A raw disk image is just the raw bytes, there is no header. Other disk "
2271 "images like qcow2 contain a special header. Qemu deals with this by looking "
2272 "for one of the known headers, and if none is found then assuming the disk "
2273 "image must be raw."
2277 #: ../src/guestfs.pod:1186
2279 "This allows a guest which has been given a raw disk image to write some "
2280 "other header. At next boot (or when the disk image is accessed by "
2281 "libguestfs) qemu would do autodetection and think the disk image format was, "
2282 "say, qcow2 based on the header written by the guest."
2286 #: ../src/guestfs.pod:1191
2288 "This in itself would not be a problem, but qcow2 offers many features, one "
2289 "of which is to allow a disk image to refer to another image (called the "
2290 "\"backing disk\"). It does this by placing the path to the backing disk "
2291 "into the qcow2 header. This path is not validated and could point to any "
2292 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2293 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2294 "control of the attacker."
2298 #: ../src/guestfs.pod:1199
2299 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2303 #: ../src/guestfs.pod:1206
2304 msgid "You have enabled the network or have opened the disk in write mode."
2308 #: ../src/guestfs.pod:1210
2310 "You are also running untrusted code from the guest (see L</RUNNING "
2315 #: ../src/guestfs.pod:1215
2317 "The way to avoid this is to specify the expected disk format when adding "
2318 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2319 "should always do this if the disk is raw format, and it's a good idea for "
2324 #: ../src/guestfs.pod:1220
2326 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2327 "format is fetched from libvirt and passed through."
2331 #: ../src/guestfs.pod:1223
2333 "For libguestfs tools, use the I<--format> command line parameter as "
2338 #: ../src/guestfs.pod:1226
2339 msgid "CONNECTION MANAGEMENT"
2343 #: ../src/guestfs.pod:1228
2348 #: ../src/guestfs.pod:1230
2350 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2351 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2352 "handle and release all resources used."
2356 #: ../src/guestfs.pod:1234
2358 "For information on using multiple handles and threads, see the section "
2359 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2363 #: ../src/guestfs.pod:1237
2364 msgid "guestfs_create"
2368 #: ../src/guestfs.pod:1239
2371 " guestfs_h *guestfs_create (void);\n"
2376 #: ../src/guestfs.pod:1241
2377 msgid "Create a connection handle."
2381 #: ../src/guestfs.pod:1243
2383 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2384 "on the handle at least once."
2388 #: ../src/guestfs.pod:1246
2390 "This function returns a non-NULL pointer to a handle on success or NULL on "
2395 #: ../src/guestfs.pod:1249
2396 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2400 #: ../src/guestfs.pod:1251
2402 "You may also want to configure error handling for the handle. See L</ERROR "
2403 "HANDLING> section below."
2407 #: ../src/guestfs.pod:1254
2408 msgid "guestfs_close"
2412 #: ../src/guestfs.pod:1256
2415 " void guestfs_close (guestfs_h *g);\n"
2420 #: ../src/guestfs.pod:1258
2421 msgid "This closes the connection handle and frees up all resources used."
2425 #: ../src/guestfs.pod:1260
2426 msgid "ERROR HANDLING"
2430 #: ../src/guestfs.pod:1262
2432 "API functions can return errors. For example, almost all functions that "
2433 "return C<int> will return C<-1> to indicate an error."
2437 #: ../src/guestfs.pod:1265
2439 "Additional information is available for errors: an error message string and "
2440 "optionally an error number (errno) if the thing that failed was a system "
2445 #: ../src/guestfs.pod:1269
2447 "You can get at the additional information about the last error on the handle "
2448 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2449 "up an error handler with L</guestfs_set_error_handler>."
2453 #: ../src/guestfs.pod:1274
2455 "When the handle is created, a default error handler is installed which "
2456 "prints the error message string to C<stderr>. For small short-running "
2457 "command line programs it is sufficient to do:"
2461 #: ../src/guestfs.pod:1278
2464 " if (guestfs_launch (g) == -1)\n"
2465 " exit (EXIT_FAILURE);\n"
2470 #: ../src/guestfs.pod:1281
2472 "since the default error handler will ensure that an error message has been "
2473 "printed to C<stderr> before the program exits."
2477 #: ../src/guestfs.pod:1284
2479 "For other programs the caller will almost certainly want to install an "
2480 "alternate error handler or do error handling in-line like this:"
2484 #: ../src/guestfs.pod:1287
2487 " g = guestfs_create ();\n"
2492 #: ../src/guestfs.pod:1289
2495 " /* This disables the default behaviour of printing errors\n"
2497 " guestfs_set_error_handler (g, NULL, NULL);\n"
2502 #: ../src/guestfs.pod:1293
2505 " if (guestfs_launch (g) == -1) {\n"
2506 " /* Examine the error message and print it etc. */\n"
2507 " char *msg = guestfs_last_error (g);\n"
2508 " int errnum = guestfs_last_errno (g);\n"
2509 " fprintf (stderr, \"%s\\n\", msg);\n"
2516 #: ../src/guestfs.pod:1301
2518 "Out of memory errors are handled differently. The default action is to call "
2519 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2520 "L</guestfs_set_out_of_memory_handler>."
2524 #: ../src/guestfs.pod:1305
2526 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2527 "because there is no handle if this happens there is no way to get additional "
2528 "error information. However L</guestfs_create> is supposed to be a "
2529 "lightweight operation which can only fail because of insufficient memory (it "
2530 "returns NULL in this case)."
2534 #: ../src/guestfs.pod:1311
2535 msgid "guestfs_last_error"
2539 #: ../src/guestfs.pod:1313
2542 " const char *guestfs_last_error (guestfs_h *g);\n"
2547 #: ../src/guestfs.pod:1315
2549 "This returns the last error message that happened on C<g>. If there has not "
2550 "been an error since the handle was created, then this returns C<NULL>."
2554 #: ../src/guestfs.pod:1319
2556 "The lifetime of the returned string is until the next error occurs, or "
2557 "L</guestfs_close> is called."
2561 #: ../src/guestfs.pod:1322
2562 msgid "guestfs_last_errno"
2566 #: ../src/guestfs.pod:1324
2569 " int guestfs_last_errno (guestfs_h *g);\n"
2574 #: ../src/guestfs.pod:1326
2575 msgid "This returns the last error number (errno) that happened on C<g>."
2579 #: ../src/guestfs.pod:1328
2580 msgid "If successful, an errno integer not equal to zero is returned."
2584 #: ../src/guestfs.pod:1330
2585 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2589 #: ../src/guestfs.pod:1337
2590 msgid "There has not been any error on the handle."
2594 #: ../src/guestfs.pod:1341
2596 "There has been an error but the errno was meaningless. This corresponds to "
2597 "the case where the error did not come from a failed system call, but for "
2598 "some other reason."
2602 #: ../src/guestfs.pod:1347
2604 "There was an error from a failed system call, but for some reason the errno "
2605 "was not captured and returned. This usually indicates a bug in libguestfs."
2609 #: ../src/guestfs.pod:1353
2611 "Libguestfs tries to convert the errno from inside the applicance into a "
2612 "corresponding errno for the caller (not entirely trivial: the appliance "
2613 "might be running a completely different operating system from the library "
2614 "and error numbers are not standardized across Un*xen). If this could not be "
2615 "done, then the error is translated to C<EINVAL>. In practice this should "
2616 "only happen in very rare circumstances."
2620 #: ../src/guestfs.pod:1361
2621 msgid "guestfs_set_error_handler"
2625 #: ../src/guestfs.pod:1363
2628 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2630 " const char *msg);\n"
2631 " void guestfs_set_error_handler (guestfs_h *g,\n"
2632 " guestfs_error_handler_cb cb,\n"
2638 #: ../src/guestfs.pod:1370
2640 "The callback C<cb> will be called if there is an error. The parameters "
2641 "passed to the callback are an opaque data pointer and the error message "
2646 #: ../src/guestfs.pod:1374
2648 "C<errno> is not passed to the callback. To get that the callback must call "
2649 "L</guestfs_last_errno>."
2653 #: ../src/guestfs.pod:1377
2655 "Note that the message string C<msg> is freed as soon as the callback "
2656 "function returns, so if you want to stash it somewhere you must make your "
2661 #: ../src/guestfs.pod:1381
2662 msgid "The default handler prints messages on C<stderr>."
2666 #: ../src/guestfs.pod:1383
2667 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2671 #: ../src/guestfs.pod:1385
2672 msgid "guestfs_get_error_handler"
2676 #: ../src/guestfs.pod:1387
2679 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2680 " void **opaque_rtn);\n"
2685 #: ../src/guestfs.pod:1390
2686 msgid "Returns the current error handler callback."
2690 #: ../src/guestfs.pod:1392
2691 msgid "guestfs_set_out_of_memory_handler"
2695 #: ../src/guestfs.pod:1394
2698 " typedef void (*guestfs_abort_cb) (void);\n"
2699 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2700 " guestfs_abort_cb);\n"
2705 #: ../src/guestfs.pod:1398
2707 "The callback C<cb> will be called if there is an out of memory situation. "
2708 "I<Note this callback must not return>."
2712 #: ../src/guestfs.pod:1401
2713 msgid "The default is to call L<abort(3)>."
2717 #: ../src/guestfs.pod:1403
2718 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2722 #: ../src/guestfs.pod:1406
2723 msgid "guestfs_get_out_of_memory_handler"
2727 #: ../src/guestfs.pod:1408
2730 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2735 #: ../src/guestfs.pod:1410
2736 msgid "This returns the current out of memory handler."
2740 #: ../src/guestfs.pod:1412
2745 #: ../src/guestfs.pod:1414 ../fish/guestfish.pod:958
2750 #: ../src/guestfs.pod:1416
2755 #: ../src/guestfs.pod:1418
2760 #: ../src/guestfs.pod:1420
2761 msgid "AVAILABILITY"
2765 #: ../src/guestfs.pod:1422
2766 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2770 #: ../src/guestfs.pod:1424
2772 "Using L</guestfs_available> you can test availability of the following "
2773 "groups of functions. This test queries the appliance to see if the "
2774 "appliance you are currently using supports the functionality."
2778 #: ../src/guestfs.pod:1429
2779 msgid "@AVAILABILITY@"
2783 #: ../src/guestfs.pod:1431
2784 msgid "GUESTFISH supported COMMAND"
2788 #: ../src/guestfs.pod:1433
2790 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2791 "prints out the available groups and whether they are supported by this build "
2792 "of libguestfs. Note however that you have to do C<run> first."
2796 #: ../src/guestfs.pod:1438
2797 msgid "SINGLE CALLS AT COMPILE TIME"
2801 #: ../src/guestfs.pod:1440
2803 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2804 "function, such as:"
2808 #: ../src/guestfs.pod:1443
2811 " #define LIBGUESTFS_HAVE_DD 1\n"
2816 #: ../src/guestfs.pod:1445
2817 msgid "if L</guestfs_dd> is available."
2821 #: ../src/guestfs.pod:1447
2823 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2824 "function is available at compile time, we recommended using build tools such "
2825 "as autoconf or cmake. For example in autotools you could use:"
2829 #: ../src/guestfs.pod:1452
2832 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2833 " AC_CHECK_FUNCS([guestfs_dd])\n"
2838 #: ../src/guestfs.pod:1455
2840 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2845 #: ../src/guestfs.pod:1458
2846 msgid "SINGLE CALLS AT RUN TIME"
2850 #: ../src/guestfs.pod:1460
2852 "Testing at compile time doesn't guarantee that a function really exists in "
2853 "the library. The reason is that you might be dynamically linked against a "
2854 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2855 "This situation unfortunately results in a segmentation fault, which is a "
2856 "shortcoming of the C dynamic linking system itself."
2860 #: ../src/guestfs.pod:1467
2862 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2863 "in this example program (note that you still need the compile time check as "
2868 #: ../src/guestfs.pod:1471
2871 " #include <stdio.h>\n"
2872 " #include <stdlib.h>\n"
2873 " #include <unistd.h>\n"
2874 " #include <dlfcn.h>\n"
2875 " #include <guestfs.h>\n"
2880 #: ../src/guestfs.pod:1477
2885 " #ifdef LIBGUESTFS_HAVE_DD\n"
2887 " int has_function;\n"
2892 #: ../src/guestfs.pod:1483
2895 " /* Test if the function guestfs_dd is really available. */\n"
2896 " dl = dlopen (NULL, RTLD_LAZY);\n"
2898 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2899 " exit (EXIT_FAILURE);\n"
2901 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2907 #: ../src/guestfs.pod:1492
2910 " if (!has_function)\n"
2911 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2913 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2914 " /* Now it's safe to call\n"
2915 " guestfs_dd (g, \"foo\", \"bar\");\n"
2919 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2926 #: ../src/guestfs.pod:1505
2928 "You may think the above is an awful lot of hassle, and it is. There are "
2929 "other ways outside of the C linking system to ensure that this kind of "
2930 "incompatibility never arises, such as using package versioning:"
2934 #: ../src/guestfs.pod:1510
2937 " Requires: libguestfs >= 1.0.80\n"
2942 #: ../src/guestfs.pod:1512
2943 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2947 #: ../src/guestfs.pod:1514
2949 "A recent feature of the API is the introduction of calls which take optional "
2950 "arguments. In C these are declared 3 ways. The main way is as a call which "
2951 "takes variable arguments (ie. C<...>), as in this example:"
2955 #: ../src/guestfs.pod:1519
2958 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2963 #: ../src/guestfs.pod:1521
2965 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2966 "call with no optional arguments specified:"
2970 #: ../src/guestfs.pod:1524
2973 " guestfs_add_drive_opts (g, filename, -1);\n"
2978 #: ../src/guestfs.pod:1526
2979 msgid "With a single optional argument:"
2983 #: ../src/guestfs.pod:1528
2986 " guestfs_add_drive_opts (g, filename,\n"
2987 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2993 #: ../src/guestfs.pod:1532
2998 #: ../src/guestfs.pod:1534
3001 " guestfs_add_drive_opts (g, filename,\n"
3002 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3003 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3009 #: ../src/guestfs.pod:1539
3011 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3016 #: ../src/guestfs.pod:1542
3017 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3021 #: ../src/guestfs.pod:1544
3023 "The second variant has the same name with the suffix C<_va>, which works the "
3024 "same way but takes a C<va_list>. See the C manual for details. For the "
3025 "example function, this is declared:"
3029 #: ../src/guestfs.pod:1548
3032 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3038 #: ../src/guestfs.pod:1551
3039 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3043 #: ../src/guestfs.pod:1553
3045 "The third variant is useful where you need to construct these calls. You "
3046 "pass in a structure where you fill in the optional fields. The structure "
3047 "has a bitmask as the first element which you must set to indicate which "
3048 "fields you have filled in. For our example function the structure and call "
3053 #: ../src/guestfs.pod:1559
3056 " struct guestfs_add_drive_opts_argv {\n"
3057 " uint64_t bitmask;\n"
3059 " const char *format;\n"
3062 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3063 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3068 #: ../src/guestfs.pod:1568
3069 msgid "You could call it like this:"
3073 #: ../src/guestfs.pod:1570
3076 " struct guestfs_add_drive_opts_argv optargs = {\n"
3077 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3078 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3080 " .format = \"qcow2\"\n"
3086 #: ../src/guestfs.pod:1577
3089 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3094 #: ../src/guestfs.pod:1579 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1253 ../tools/virt-win-reg.pl:532
3099 #: ../src/guestfs.pod:1585
3100 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3104 #: ../src/guestfs.pod:1590
3105 msgid "You do not need to fill in all fields of the structure."
3109 #: ../src/guestfs.pod:1594
3111 "There must be a one-to-one correspondence between fields of the structure "
3112 "that are filled in, and bits set in the bitmask."
3116 #: ../src/guestfs.pod:1599
3117 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3121 #: ../src/guestfs.pod:1601
3123 "In other languages, optional arguments are expressed in the way that is "
3124 "natural for that language. We refer you to the language-specific "
3125 "documentation for more details on that."
3129 #: ../src/guestfs.pod:1605
3130 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3134 #: ../src/guestfs.pod:1607
3135 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3139 #: ../src/guestfs.pod:1609
3141 "The child process generates events in some situations. Current events "
3142 "include: receiving a log message, the child process exits."
3146 #: ../src/guestfs.pod:1612
3148 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3153 #: ../src/guestfs.pod:1615
3155 "Only I<one callback of each type> can be registered for each handle. "
3156 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3157 "that type. Cancel all callbacks of this type by calling this function with "
3158 "C<cb> set to C<NULL>."
3162 #: ../src/guestfs.pod:1620
3163 msgid "guestfs_set_log_message_callback"
3167 #: ../src/guestfs.pod:1622
3170 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3171 " char *buf, int len);\n"
3172 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3173 " guestfs_log_message_cb cb,\n"
3179 #: ../src/guestfs.pod:1628
3181 "The callback function C<cb> will be called whenever qemu or the guest writes "
3182 "anything to the console."
3186 #: ../src/guestfs.pod:1631
3187 msgid "Use this function to capture kernel messages and similar."
3191 #: ../src/guestfs.pod:1633
3193 "Normally there is no log message handler, and log messages are just "
3198 #: ../src/guestfs.pod:1636
3199 msgid "guestfs_set_subprocess_quit_callback"
3203 #: ../src/guestfs.pod:1638
3206 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3207 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3208 " guestfs_subprocess_quit_cb cb,\n"
3214 #: ../src/guestfs.pod:1643
3216 "The callback function C<cb> will be called when the child process quits, "
3217 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3218 "corresponds to a transition from any state to the CONFIG state)."
3222 #: ../src/guestfs.pod:1648
3223 msgid "guestfs_set_launch_done_callback"
3227 #: ../src/guestfs.pod:1650
3230 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3231 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3232 " guestfs_launch_done_cb cb,\n"
3238 #: ../src/guestfs.pod:1655
3240 "The callback function C<cb> will be called when the child process becomes "
3241 "ready first time after it has been launched. (This corresponds to a "
3242 "transition from LAUNCHING to the READY state)."
3246 #: ../src/guestfs.pod:1659
3247 msgid "guestfs_set_close_callback"
3251 #: ../src/guestfs.pod:1661
3254 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3255 " void guestfs_set_close_callback (guestfs_h *g,\n"
3256 " guestfs_close_cb cb,\n"
3262 #: ../src/guestfs.pod:1666
3264 "The callback function C<cb> will be called while the handle is being closed "
3265 "(synchronously from L</guestfs_close>)."
3269 #: ../src/guestfs.pod:1669
3271 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3272 "handles that are open when the program exits. This means that this callback "
3273 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3274 "problems in higher-level languages (eg. if your HLL interpreter has already "
3275 "been cleaned up by the time this is called, and if your callback then jumps "
3276 "into some HLL function)."
3280 #: ../src/guestfs.pod:1677
3281 msgid "guestfs_set_progress_callback"
3285 #: ../src/guestfs.pod:1679
3288 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3289 " int proc_nr, int serial,\n"
3290 " uint64_t position, uint64_t total);\n"
3291 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3292 " guestfs_progress_cb cb,\n"
3298 #: ../src/guestfs.pod:1686
3300 "Some long-running operations can generate progress messages. If this "
3301 "callback is registered, then it will be called each time a progress message "
3302 "is generated (usually two seconds after the operation started, and three "
3303 "times per second thereafter until it completes, although the frequency may "
3304 "change in future versions)."
3308 #: ../src/guestfs.pod:1692
3310 "The callback receives two numbers: C<position> and C<total>. The units of "
3311 "C<total> are not defined, although for some operations C<total> may relate "
3312 "in some way to the amount of data to be transferred (eg. in bytes or "
3313 "megabytes), and C<position> may be the portion which has been transferred."
3317 #: ../src/guestfs.pod:1698
3318 msgid "The only defined and stable parts of the API are:"
3322 #: ../src/guestfs.pod:1704
3324 "The callback can display to the user some type of progress bar or indicator "
3325 "which shows the ratio of C<position>:C<total>."
3329 #: ../src/guestfs.pod:1709
3330 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3334 #: ../src/guestfs.pod:1713
3336 "If any progress notification is sent during a call, then a final progress "
3337 "notification is always sent when C<position> = C<total>."
3341 #: ../src/guestfs.pod:1716
3343 "This is to simplify caller code, so callers can easily set the progress "
3344 "indicator to \"100%\" at the end of the operation, without requiring special "
3345 "code to detect this case."
3349 #: ../src/guestfs.pod:1722
3351 "The callback also receives the procedure number and serial number of the "
3352 "call. These are only useful for debugging protocol issues, and the callback "
3353 "can normally ignore them. The callback may want to print these numbers in "
3354 "error messages or debugging messages."
3358 #: ../src/guestfs.pod:1727
3359 msgid "PRIVATE DATA AREA"
3363 #: ../src/guestfs.pod:1729
3365 "You can attach named pieces of private data to the libguestfs handle, and "
3366 "fetch them by name for the lifetime of the handle. This is called the "
3367 "private data area and is only available from the C API."
3371 #: ../src/guestfs.pod:1733
3372 msgid "To attach a named piece of data, use the following call:"
3376 #: ../src/guestfs.pod:1735
3379 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3384 #: ../src/guestfs.pod:1737
3386 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3387 "pointer (which can be C<NULL>). Any previous item with the same name is "
3392 #: ../src/guestfs.pod:1741
3394 "You can use any C<key> you want, but names beginning with an underscore "
3395 "character are reserved for internal libguestfs purposes (for implementing "
3396 "language bindings). It is recommended to prefix the name with some unique "
3397 "string to avoid collisions with other users."
3401 #: ../src/guestfs.pod:1746
3402 msgid "To retrieve the pointer, use:"
3406 #: ../src/guestfs.pod:1748
3409 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3414 #: ../src/guestfs.pod:1750
3416 "This function returns C<NULL> if either no data is found associated with "
3417 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3422 #: ../src/guestfs.pod:1754
3424 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3425 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3426 "all. In particular, libguestfs does I<not> try to free the data when the "
3427 "handle is closed. If the data must be freed, then the caller must either "
3428 "free it before calling L</guestfs_close> or must set up a close callback to "
3429 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3430 "can be registered for a handle)."
3434 #: ../src/guestfs.pod:1762
3436 "The private data area is implemented using a hash table, and should be "
3437 "reasonably efficient for moderate numbers of keys."
3441 #: ../src/guestfs.pod:1765 ../src/guestfs.pod:1770
3446 #: ../src/guestfs.pod:1767
3448 "<!-- old anchor for the next section --> <a "
3449 "name=\"state_machine_and_low_level_event_api\"/>"
3453 #: ../src/guestfs.pod:1772
3454 msgid "ARCHITECTURE"
3458 #: ../src/guestfs.pod:1774
3460 "Internally, libguestfs is implemented by running an appliance (a special "
3461 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3462 "process of the main program."
3466 #: ../src/guestfs.pod:1778
3469 " ___________________\n"
3471 " | main program |\n"
3473 " | | child process / appliance\n"
3474 " | | __________________________\n"
3476 " +-------------------+ RPC | +-----------------+ |\n"
3477 " | libguestfs <--------------------> guestfsd | |\n"
3478 " | | | +-----------------+ |\n"
3479 " \\___________________/ | | Linux kernel | |\n"
3480 " | +--^--------------+ |\n"
3481 " \\_________|________________/\n"
3487 " \\______________/\n"
3492 #: ../src/guestfs.pod:1798
3494 "The library, linked to the main program, creates the child process and hence "
3495 "the appliance in the L</guestfs_launch> function."
3499 #: ../src/guestfs.pod:1801
3501 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3502 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3503 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3504 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3505 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3506 "attached to the qemu process which translates device access by the "
3507 "appliance's Linux kernel into accesses to the image."
3511 #: ../src/guestfs.pod:1810
3513 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3514 "Although the disk image you are attached to might also be used by some "
3515 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3516 "care if both libguestfs's qemu process and your virtual machine are trying "
3517 "to update the disk image at the same time, since these usually results in "
3518 "massive disk corruption)."
3522 #: ../src/guestfs.pod:1817
3523 msgid "STATE MACHINE"
3527 #: ../src/guestfs.pod:1819
3528 msgid "libguestfs uses a state machine to model the child process:"
3532 #: ../src/guestfs.pod:1821
3544 " / | \\ \\ guestfs_launch\n"
3545 " / | _\\__V______\n"
3547 " / | | LAUNCHING |\n"
3548 " / | \\___________/\n"
3550 " / | guestfs_launch\n"
3552 " ______ / __|____V\n"
3553 " / \\ ------> / \\\n"
3554 " | BUSY | | READY |\n"
3555 " \\______/ <------ \\________/\n"
3560 #: ../src/guestfs.pod:1843
3562 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3563 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3564 "(3) alternating between READY and BUSY as commands are issued to, and "
3565 "carried out by, the child process."
3569 #: ../src/guestfs.pod:1848
3571 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3572 "asynchronously at any time (eg. due to some internal error), and that causes "
3573 "the state to transition back to CONFIG."
3577 #: ../src/guestfs.pod:1852
3579 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3580 "issued when in the CONFIG state."
3584 #: ../src/guestfs.pod:1855
3586 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3587 "L</guestfs_launch> blocks until the child process is READY to accept "
3588 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3589 "moves the state from CONFIG to LAUNCHING while it is running."
3593 #: ../src/guestfs.pod:1861
3595 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3596 "state. These API calls block waiting for the command to be carried out "
3597 "(ie. the state to transition to BUSY and then back to READY). There are no "
3598 "non-blocking versions, and no way to issue more than one command per handle "
3603 #: ../src/guestfs.pod:1867
3605 "Finally, the child process sends asynchronous messages back to the main "
3606 "program, such as kernel log messages. You can register a callback to "
3607 "receive these messages."
3611 #: ../src/guestfs.pod:1871
3616 #: ../src/guestfs.pod:1873
3617 msgid "COMMUNICATION PROTOCOL"
3621 #: ../src/guestfs.pod:1875
3623 "Don't rely on using this protocol directly. This section documents how it "
3624 "currently works, but it may change at any time."
3628 #: ../src/guestfs.pod:1878
3630 "The protocol used to talk between the library and the daemon running inside "
3631 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3632 "1014, RFC 1832, RFC 4506)."
3636 #: ../src/guestfs.pod:1882
3638 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3639 "this file is automatically generated)."
3643 #: ../src/guestfs.pod:1885
3645 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3646 "and C<FileOut> parameters, which are handled with very simple request/reply "
3647 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3648 "parameters, which use the same request and reply messages, but they may also "
3649 "be followed by files sent using a chunked encoding."
3653 #: ../src/guestfs.pod:1892
3654 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3658 #: ../src/guestfs.pod:1894
3659 msgid "For ordinary functions, the request message is:"
3663 #: ../src/guestfs.pod:1896
3666 " total length (header + arguments,\n"
3667 " but not including the length word itself)\n"
3668 " struct guestfs_message_header (encoded as XDR)\n"
3669 " struct guestfs_<foo>_args (encoded as XDR)\n"
3674 #: ../src/guestfs.pod:1901
3676 "The total length field allows the daemon to allocate a fixed size buffer "
3677 "into which it slurps the rest of the message. As a result, the total length "
3678 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3679 "effective size of any request is limited to somewhere under this size."
3683 #: ../src/guestfs.pod:1907
3685 "Note also that many functions don't take any arguments, in which case the "
3686 "C<guestfs_I<foo>_args> is completely omitted."
3690 #: ../src/guestfs.pod:1910
3692 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3693 "receiver knows what type of args structure to expect, or none at all."
3697 #: ../src/guestfs.pod:1914
3699 "For functions that take optional arguments, the optional arguments are "
3700 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3701 "arguments. A bitmask in the header indicates which optional arguments are "
3702 "meaningful. The bitmask is also checked to see if it contains bits set "
3703 "which the daemon does not know about (eg. if more optional arguments were "
3704 "added in a later version of the library), and this causes the call to be "
3709 #: ../src/guestfs.pod:1922
3710 msgid "The reply message for ordinary functions is:"
3714 #: ../src/guestfs.pod:1924
3717 " total length (header + ret,\n"
3718 " but not including the length word itself)\n"
3719 " struct guestfs_message_header (encoded as XDR)\n"
3720 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3725 #: ../src/guestfs.pod:1929
3727 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3728 "functions that return no formal return values."
3732 #: ../src/guestfs.pod:1932
3733 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3737 #: ../src/guestfs.pod:1935
3739 "In the case of an error, a flag is set in the header, and the reply message "
3740 "is slightly changed:"
3744 #: ../src/guestfs.pod:1938
3747 " total length (header + error,\n"
3748 " but not including the length word itself)\n"
3749 " struct guestfs_message_header (encoded as XDR)\n"
3750 " struct guestfs_message_error (encoded as XDR)\n"
3755 #: ../src/guestfs.pod:1943
3757 "The C<guestfs_message_error> structure contains the error message as a "
3762 #: ../src/guestfs.pod:1946
3763 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3767 #: ../src/guestfs.pod:1948
3769 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3770 "The normal request message is sent (see above). However this is followed by "
3771 "a sequence of file chunks."
3775 #: ../src/guestfs.pod:1952
3778 " total length (header + arguments,\n"
3779 " but not including the length word itself,\n"
3780 " and not including the chunks)\n"
3781 " struct guestfs_message_header (encoded as XDR)\n"
3782 " struct guestfs_<foo>_args (encoded as XDR)\n"
3783 " sequence of chunks for FileIn param #0\n"
3784 " sequence of chunks for FileIn param #1 etc.\n"
3789 #: ../src/guestfs.pod:1960
3790 msgid "The \"sequence of chunks\" is:"
3794 #: ../src/guestfs.pod:1962
3797 " length of chunk (not including length word itself)\n"
3798 " struct guestfs_chunk (encoded as XDR)\n"
3799 " length of chunk\n"
3800 " struct guestfs_chunk (encoded as XDR)\n"
3802 " length of chunk\n"
3803 " struct guestfs_chunk (with data.data_len == 0)\n"
3808 #: ../src/guestfs.pod:1970
3810 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3811 "is set in the final chunk to indicate either successful completion or early "
3816 #: ../src/guestfs.pod:1974
3818 "At time of writing there are no functions that have more than one FileIn "
3819 "parameter. However this is (theoretically) supported, by sending the "
3820 "sequence of chunks for each FileIn parameter one after another (from left to "
3825 #: ../src/guestfs.pod:1979
3827 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3828 "transfer. The library does this by sending a chunk with a special flag set "
3829 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3830 "RPC, does I<not> send any reply, and goes back to reading the next request."
3834 #: ../src/guestfs.pod:1985
3836 "The daemon may also cancel. It does this by writing a special word "
3837 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3838 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3839 "cancel chunk). The special word is chosen so that even if cancellation "
3840 "happens right at the end of the transfer (after the library has finished "
3841 "writing and has started listening for the reply), the \"spurious\" cancel "
3842 "flag will not be confused with the reply message."
3846 #: ../src/guestfs.pod:1994
3848 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3849 "limit), and also files where the size is not known in advance (eg. from "
3850 "pipes or sockets). However the chunks are rather small "
3851 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3852 "to keep much in memory."
3856 #: ../src/guestfs.pod:2000
3857 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3861 #: ../src/guestfs.pod:2002
3863 "The protocol for FileOut parameters is exactly the same as for FileIn "
3864 "parameters, but with the roles of daemon and library reversed."
3868 #: ../src/guestfs.pod:2005
3871 " total length (header + ret,\n"
3872 " but not including the length word itself,\n"
3873 " and not including the chunks)\n"
3874 " struct guestfs_message_header (encoded as XDR)\n"
3875 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3876 " sequence of chunks for FileOut param #0\n"
3877 " sequence of chunks for FileOut param #1 etc.\n"
3882 #: ../src/guestfs.pod:2013
3883 msgid "INITIAL MESSAGE"
3887 #: ../src/guestfs.pod:2015
3889 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3890 "which indicates that the guest and daemon is alive. This is what "
3891 "L</guestfs_launch> waits for."
3895 #: ../src/guestfs.pod:2019
3896 msgid "PROGRESS NOTIFICATION MESSAGES"
3900 #: ../src/guestfs.pod:2021
3902 "The daemon may send progress notification messages at any time. These are "
3903 "distinguished by the normal length word being replaced by "
3904 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3908 #: ../src/guestfs.pod:2025
3910 "The library turns them into progress callbacks (see "
3911 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3912 "discards them if not."
3916 #: ../src/guestfs.pod:2029
3918 "The daemon self-limits the frequency of progress messages it sends (see "
3919 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3924 #: ../src/guestfs.pod:2033
3925 msgid "LIBGUESTFS VERSION NUMBERS"
3929 #: ../src/guestfs.pod:2035
3931 "Since April 2010, libguestfs has started to make separate development and "
3932 "stable releases, along with corresponding branches in our git repository. "
3933 "These separate releases can be identified by version number:"
3937 #: ../src/guestfs.pod:2040
3940 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3941 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3947 " | `-------- sub-version\n"
3949 " `------ always '1' because we don't change the ABI\n"
3954 #: ../src/guestfs.pod:2051
3955 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3959 #: ../src/guestfs.pod:2053
3961 "As time passes we cherry pick fixes from the development branch and backport "
3962 "those into the stable branch, the effect being that the stable branch should "
3963 "get more stable and less buggy over time. So the stable releases are ideal "
3964 "for people who don't need new features but would just like the software to "
3969 #: ../src/guestfs.pod:2059
3970 msgid "Our criteria for backporting changes are:"
3974 #: ../src/guestfs.pod:2065
3976 "Documentation changes which don't affect any code are backported unless the "
3977 "documentation refers to a future feature which is not in stable."
3981 #: ../src/guestfs.pod:2071
3983 "Bug fixes which are not controversial, fix obvious problems, and have been "
3984 "well tested are backported."
3988 #: ../src/guestfs.pod:2076
3990 "Simple rearrangements of code which shouldn't affect how it works get "
3991 "backported. This is so that the code in the two branches doesn't get too "
3992 "far out of step, allowing us to backport future fixes more easily."
3996 #: ../src/guestfs.pod:2082
3998 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3999 "exceptional case: the new feature is required in order to implement an "
4000 "important bug fix."
4004 #: ../src/guestfs.pod:2088
4006 "A new stable branch starts when we think the new features in development are "
4007 "substantial and compelling enough over the current stable branch to warrant "
4008 "it. When that happens we create new stable and development versions 1.N.0 "
4009 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4010 "stable at this point, but by backporting fixes from development, that branch "
4011 "will stabilize over time."
4015 #: ../src/guestfs.pod:2096
4016 msgid "EXTENDING LIBGUESTFS"
4020 #: ../src/guestfs.pod:2098
4021 msgid "ADDING A NEW API ACTION"
4025 #: ../src/guestfs.pod:2100
4027 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4028 "documentation) are generated, and this makes it easy to extend the "
4033 #: ../src/guestfs.pod:2104
4034 msgid "To add a new API action there are two changes:"
4038 #: ../src/guestfs.pod:2110
4040 "You need to add a description of the call (name, parameters, return type, "
4041 "tests, documentation) to C<generator/generator_actions.ml>."
4045 #: ../src/guestfs.pod:2113
4047 "There are two sorts of API action, depending on whether the call goes "
4048 "through to the daemon in the appliance, or is serviced entirely by the "
4049 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4050 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4051 "an example of the latter, since a trace flag is maintained in the handle and "
4052 "all tracing is done on the library side."
4056 #: ../src/guestfs.pod:2121
4058 "Most new actions are of the first type, and get added to the "
4059 "C<daemon_functions> list. Each function has a unique procedure number used "
4060 "in the RPC protocol which is assigned to that action when we publish "
4061 "libguestfs and cannot be reused. Take the latest procedure number and "
4066 #: ../src/guestfs.pod:2127
4068 "For library-only actions of the second type, add to the "
4069 "C<non_daemon_functions> list. Since these functions are serviced by the "
4070 "library and do not travel over the RPC mechanism to the daemon, these "
4071 "functions do not need a procedure number, and so the procedure number is set "
4076 #: ../src/guestfs.pod:2135
4077 msgid "Implement the action (in C):"
4081 #: ../src/guestfs.pod:2137
4083 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4084 "C<daemon/> directory."
4088 #: ../src/guestfs.pod:2140
4090 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4091 "(note: double underscore) in the C<src/> directory."
4095 #: ../src/guestfs.pod:2143
4096 msgid "In either case, use another function as an example of what to do."
4100 #: ../src/guestfs.pod:2147
4101 msgid "After making these changes, use C<make> to compile."
4105 #: ../src/guestfs.pod:2149
4107 "Note that you don't need to implement the RPC, language bindings, manual "
4108 "pages or anything else. It's all automatically generated from the OCaml "
4113 #: ../src/guestfs.pod:2153
4114 msgid "ADDING TESTS FOR AN API ACTION"
4118 #: ../src/guestfs.pod:2155
4120 "You can supply zero or as many tests as you want per API call. The tests "
4121 "can either be added as part of the API description "
4122 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4123 "drop a script into C<regressions/>. Note that adding a script to "
4124 "C<regressions/> is slower, so if possible use the first method."
4128 #: ../src/guestfs.pod:2161
4130 "The following describes the test environment used when you add an API test "
4131 "in C<generator_actions.ml>."
4135 #: ../src/guestfs.pod:2164
4136 msgid "The test environment has 4 block devices:"
4140 #: ../src/guestfs.pod:2168
4141 msgid "C</dev/sda> 500MB"
4145 #: ../src/guestfs.pod:2170
4146 msgid "General block device for testing."
4150 #: ../src/guestfs.pod:2172
4151 msgid "C</dev/sdb> 50MB"
4155 #: ../src/guestfs.pod:2174
4157 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4162 #: ../src/guestfs.pod:2177
4163 msgid "C</dev/sdc> 10MB"
4167 #: ../src/guestfs.pod:2179
4168 msgid "Used in a few tests where two block devices are needed."
4172 #: ../src/guestfs.pod:2181
4177 #: ../src/guestfs.pod:2183
4178 msgid "ISO with fixed content (see C<images/test.iso>)."
4182 #: ../src/guestfs.pod:2187
4184 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4185 "appliance and block devices are reused between tests. So don't try testing "
4186 "L</guestfs_kill_subprocess> :-x"
4190 #: ../src/guestfs.pod:2191
4192 "Each test starts with an initial scenario, selected using one of the "
4193 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4194 "initialize the disks mentioned above in a particular way as documented in "
4195 "C<generator_types.ml>. You should not assume anything about the previous "
4196 "contents of other disks that are not initialized."
4200 #: ../src/guestfs.pod:2197
4202 "You can add a prerequisite clause to any individual test. This is a "
4203 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4204 "if testing a command which might not work on all variations of libguestfs "
4205 "builds. A test that has prerequisite of C<Always> means to run "
4210 #: ../src/guestfs.pod:2203
4212 "In addition, packagers can skip individual tests by setting environment "
4213 "variables before running C<make check>."
4217 #: ../src/guestfs.pod:2206
4220 " SKIP_TEST_<CMD>_<NUM>=1\n"
4225 #: ../src/guestfs.pod:2208
4226 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4230 #: ../src/guestfs.pod:2210
4235 #: ../src/guestfs.pod:2212
4238 " SKIP_TEST_<CMD>=1\n"
4243 #: ../src/guestfs.pod:2214
4244 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4248 #: ../src/guestfs.pod:2216
4249 msgid "Packagers can run only certain tests by setting for example:"
4253 #: ../src/guestfs.pod:2218
4256 " TEST_ONLY=\"vfs_type zerofree\"\n"
4261 #: ../src/guestfs.pod:2220
4263 "See C<capitests/tests.c> for more details of how these environment variables "
4268 #: ../src/guestfs.pod:2223
4269 msgid "DEBUGGING NEW API ACTIONS"
4273 #: ../src/guestfs.pod:2225
4274 msgid "Test new actions work before submitting them."
4278 #: ../src/guestfs.pod:2227
4279 msgid "You can use guestfish to try out new commands."
4283 #: ../src/guestfs.pod:2229
4285 "Debugging the daemon is a problem because it runs inside a minimal "
4286 "environment. However you can fprintf messages in the daemon to stderr, and "
4287 "they will show up if you use C<guestfish -v>."
4291 #: ../src/guestfs.pod:2233
4292 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4296 #: ../src/guestfs.pod:2235
4298 "Our C source code generally adheres to some basic code-formatting "
4299 "conventions. The existing code base is not totally consistent on this "
4300 "front, but we do prefer that contributed code be formatted similarly. In "
4301 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4302 "indentation level, and other than that, follow the K&R style."
4306 #: ../src/guestfs.pod:2241
4308 "If you use Emacs, add the following to one of one of your start-up files "
4309 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4313 #: ../src/guestfs.pod:2244
4316 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4317 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4318 " (add-hook 'find-file-hook\n"
4319 " '(lambda () (if (and buffer-file-name\n"
4320 " (string-match \"/libguestfs\\\\>\"\n"
4321 " (buffer-file-name))\n"
4322 " (not (string-equal mode-name \"Change Log\"))\n"
4323 " (not (string-equal mode-name \"Makefile\")))\n"
4324 " (setq indent-tabs-mode nil))))\n"
4329 #: ../src/guestfs.pod:2254
4332 " ;;; When editing C sources in libguestfs, use this style.\n"
4333 " (defun libguestfs-c-mode ()\n"
4334 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4336 " (c-set-style \"K&R\")\n"
4337 " (setq c-indent-level 2)\n"
4338 " (setq c-basic-offset 2))\n"
4339 " (add-hook 'c-mode-hook\n"
4340 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4341 " (buffer-file-name))\n"
4342 " (libguestfs-c-mode))))\n"
4347 #: ../src/guestfs.pod:2266
4348 msgid "Enable warnings when compiling (and fix any problems this finds):"
4352 #: ../src/guestfs.pod:2269
4355 " ./configure --enable-gcc-warnings\n"
4360 #: ../src/guestfs.pod:2271
4361 msgid "Useful targets are:"
4365 #: ../src/guestfs.pod:2273
4368 " make syntax-check # checks the syntax of the C code\n"
4369 " make check # runs the test suite\n"
4374 #: ../src/guestfs.pod:2276
4375 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4379 #: ../src/guestfs.pod:2278
4381 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4382 "which are used to do shell quoting."
4386 #: ../src/guestfs.pod:2283
4391 #: ../src/guestfs.pod:2285
4393 "Simple shell quoted string. Any spaces or other shell characters are "
4398 #: ../src/guestfs.pod:2288
4403 #: ../src/guestfs.pod:2290
4405 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4410 #: ../src/guestfs.pod:2295 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4411 msgid "For example:"
4415 #: ../src/guestfs.pod:2297
4418 " asprintf (&cmd, \"cat %R\", path);\n"
4423 #: ../src/guestfs.pod:2299
4424 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4428 #: ../src/guestfs.pod:2301
4430 "I<Note:> Do I<not> use these when you are passing parameters to the "
4431 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4432 "because they are not passed via the shell (instead, straight to exec). You "
4433 "probably want to use the C<sysroot_path()> function however."
4437 #: ../src/guestfs.pod:2307
4438 msgid "SUBMITTING YOUR NEW API ACTIONS"
4442 #: ../src/guestfs.pod:2309
4444 "Submit patches to the mailing list: "
4445 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
4446 "L<rjones@redhat.com>."
4450 #: ../src/guestfs.pod:2313
4451 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
4455 #: ../src/guestfs.pod:2315
4456 msgid "We support i18n (gettext anyhow) in the library."
4460 #: ../src/guestfs.pod:2317
4462 "However many messages come from the daemon, and we don't translate those at "
4463 "the moment. One reason is that the appliance generally has all locale files "
4464 "removed from it, because they take up a lot of space. So we'd have to readd "
4465 "some of those, as well as copying our PO files into the appliance."
4469 #: ../src/guestfs.pod:2323
4471 "Debugging messages are never translated, since they are intended for the "
4476 #: ../src/guestfs.pod:2326
4477 msgid "SOURCE CODE SUBDIRECTORIES"
4481 #: ../src/guestfs.pod:2330
4482 msgid "C<appliance>"
4486 #: ../src/guestfs.pod:2332
4487 msgid "The libguestfs appliance, build scripts and so on."
4491 #: ../src/guestfs.pod:2334
4492 msgid "C<capitests>"
4496 #: ../src/guestfs.pod:2336
4497 msgid "Automated tests of the C API."
4501 #: ../src/guestfs.pod:2338
4506 #: ../src/guestfs.pod:2340
4508 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
4513 #: ../src/guestfs.pod:2343
4518 #: ../src/guestfs.pod:2345
4519 msgid "Outside contributions, experimental parts."
4523 #: ../src/guestfs.pod:2347
4528 #: ../src/guestfs.pod:2349
4530 "The daemon that runs inside the libguestfs appliance and carries out "
4535 #: ../src/guestfs.pod:2352
4540 #: ../src/guestfs.pod:2354
4541 msgid "L<virt-df(1)> command and documentation."
4545 #: ../src/guestfs.pod:2356
4550 #: ../src/guestfs.pod:2358
4551 msgid "C API example code."
4555 #: ../src/guestfs.pod:2360
4560 #: ../src/guestfs.pod:2362
4562 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
4563 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
4564 "L<virt-tar-out(1)>."
4568 #: ../src/guestfs.pod:2366
4573 #: ../src/guestfs.pod:2368
4574 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
4578 #: ../src/guestfs.pod:2370
4579 msgid "C<generator>"
4583 #: ../src/guestfs.pod:2372
4585 "The crucially important generator, used to automatically generate large "
4586 "amounts of boilerplate C code for things like RPC and bindings."
4590 #: ../src/guestfs.pod:2375
4595 #: ../src/guestfs.pod:2377
4596 msgid "Files used by the test suite."
4600 #: ../src/guestfs.pod:2379
4601 msgid "Some \"phony\" guest images which we test against."
4605 #: ../src/guestfs.pod:2381
4606 msgid "C<inspector>"
4610 #: ../src/guestfs.pod:2383
4611 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
4615 #: ../src/guestfs.pod:2385
4620 #: ../src/guestfs.pod:2387
4621 msgid "Logo used on the website. The fish is called Arthur by the way."
4625 #: ../src/guestfs.pod:2389
4630 #: ../src/guestfs.pod:2391
4631 msgid "M4 macros used by autoconf."
4635 #: ../src/guestfs.pod:2393
4640 #: ../src/guestfs.pod:2395
4641 msgid "Translations of simple gettext strings."
4645 #: ../src/guestfs.pod:2397
4650 #: ../src/guestfs.pod:2399
4652 "The build infrastructure and PO files for translations of manpages and POD "
4653 "files. Eventually this will be combined with the C<po> directory, but that "
4654 "is rather complicated."
4658 #: ../src/guestfs.pod:2403
4659 msgid "C<regressions>"
4663 #: ../src/guestfs.pod:2405
4664 msgid "Regression tests."
4668 #: ../src/guestfs.pod:2407
4673 #: ../src/guestfs.pod:2409
4674 msgid "L<virt-rescue(1)> command and documentation."
4678 #: ../src/guestfs.pod:2411
4683 #: ../src/guestfs.pod:2413
4684 msgid "Source code to the C library."
4688 #: ../src/guestfs.pod:2415
4693 #: ../src/guestfs.pod:2417
4694 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
4698 #: ../src/guestfs.pod:2419
4699 msgid "C<test-tool>"
4703 #: ../src/guestfs.pod:2421
4705 "Test tool for end users to test if their qemu/kernel combination will work "
4710 #: ../src/guestfs.pod:2424
4715 #: ../src/guestfs.pod:2426
4720 #: ../src/guestfs.pod:2428
4725 #: ../src/guestfs.pod:2430
4730 #: ../src/guestfs.pod:2432
4735 #: ../src/guestfs.pod:2434
4740 #: ../src/guestfs.pod:2436
4745 #: ../src/guestfs.pod:2438
4750 #: ../src/guestfs.pod:2440
4751 msgid "Language bindings."
4755 #: ../src/guestfs.pod:2444 ../fish/guestfish.pod:965 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
4756 msgid "ENVIRONMENT VARIABLES"
4760 #: ../src/guestfs.pod:2448 ../fish/guestfish.pod:991
4761 msgid "LIBGUESTFS_APPEND"
4765 #: ../src/guestfs.pod:2450 ../fish/guestfish.pod:993
4766 msgid "Pass additional options to the guest kernel."
4770 #: ../src/guestfs.pod:2452 ../fish/guestfish.pod:995
4771 msgid "LIBGUESTFS_DEBUG"
4775 #: ../src/guestfs.pod:2454
4777 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
4778 "effect as calling C<guestfs_set_verbose (g, 1)>."
4782 #: ../src/guestfs.pod:2457 ../fish/guestfish.pod:1000
4783 msgid "LIBGUESTFS_MEMSIZE"
4787 #: ../src/guestfs.pod:2459 ../fish/guestfish.pod:1002
4788 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
4792 #: ../src/guestfs.pod:2462 ../fish/guestfish.pod:1005
4795 " LIBGUESTFS_MEMSIZE=700\n"
4800 #: ../src/guestfs.pod:2464 ../fish/guestfish.pod:1007
4801 msgid "LIBGUESTFS_PATH"
4805 #: ../src/guestfs.pod:2466
4807 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
4808 "the discussion of paths in section PATH above."
4812 #: ../src/guestfs.pod:2469 ../fish/guestfish.pod:1012
4813 msgid "LIBGUESTFS_QEMU"
4817 #: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1014
4819 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4820 "which was found at compile time by the configure script is used."
4824 #: ../src/guestfs.pod:2475
4825 msgid "See also L</QEMU WRAPPERS> above."
4829 #: ../src/guestfs.pod:2477 ../fish/guestfish.pod:1018
4830 msgid "LIBGUESTFS_TRACE"
4834 #: ../src/guestfs.pod:2479
4836 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4837 "effect as calling C<guestfs_set_trace (g, 1)>."
4841 #: ../src/guestfs.pod:2482 ../fish/guestfish.pod:1027
4846 #: ../src/guestfs.pod:2484 ../fish/guestfish.pod:1029
4847 msgid "Location of temporary directory, defaults to C</tmp>."
4851 #: ../src/guestfs.pod:2486 ../fish/guestfish.pod:1031
4853 "If libguestfs was compiled to use the supermin appliance then the real "
4854 "appliance is cached in this directory, shared between all handles belonging "
4855 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4856 "use in case C</tmp> is not large enough."
4860 #: ../src/guestfs.pod:2494 ../fish/guestfish.pod:1089 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572 ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
4865 #: ../src/guestfs.pod:2496
4867 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4868 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4869 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
4870 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4871 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4872 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
4873 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
4874 "L<http://libguestfs.org/>."
4878 #: ../src/guestfs.pod:2523
4880 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4881 "L<lvm(8)>, L<disktype(1)>."
4885 #: ../src/guestfs.pod:2530 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:548
4890 #: ../src/guestfs.pod:2532
4891 msgid "To get a list of bugs against libguestfs use this link:"
4895 #: ../src/guestfs.pod:2534
4896 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4900 #: ../src/guestfs.pod:2536
4901 msgid "To report a new bug against libguestfs use this link:"
4905 #: ../src/guestfs.pod:2538
4906 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4910 #: ../src/guestfs.pod:2540
4911 msgid "When reporting a bug, please check:"
4915 #: ../src/guestfs.pod:2546
4916 msgid "That the bug hasn't been reported already."
4920 #: ../src/guestfs.pod:2550
4921 msgid "That you are testing a recent version."
4925 #: ../src/guestfs.pod:2554
4926 msgid "Describe the bug accurately, and give a way to reproduce it."
4930 #: ../src/guestfs.pod:2558
4932 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4937 #: ../src/guestfs.pod:2563 ../fish/guestfish.pod:1112 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4942 #: ../src/guestfs.pod:2565 ../fish/guestfish.pod:1114 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4943 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4947 #: ../src/guestfs.pod:2567 ../fish/guestfish.pod:1116 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:368 ../tools/virt-win-reg.pl:602 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
4952 #: ../src/guestfs.pod:2569 ../fish/guestfish.pod:1118 ../fuse/guestmount.pod:250
4953 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4957 #: ../src/guestfs.pod:2572
4959 "This library is free software; you can redistribute it and/or modify it "
4960 "under the terms of the GNU Lesser General Public License as published by the "
4961 "Free Software Foundation; either version 2 of the License, or (at your "
4962 "option) any later version."
4966 #: ../src/guestfs.pod:2577
4968 "This library is distributed in the hope that it will be useful, but WITHOUT "
4969 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4970 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4975 #: ../src/guestfs.pod:2582
4977 "You should have received a copy of the GNU Lesser General Public License "
4978 "along with this library; if not, write to the Free Software Foundation, "
4979 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4983 #: ../src/guestfs-actions.pod:1
4984 msgid "guestfs_add_cdrom"
4988 #: ../src/guestfs-actions.pod:3
4992 " guestfs_add_cdrom (guestfs_h *g,\n"
4993 " const char *filename);\n"
4998 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4999 msgid "This function adds a virtual CD-ROM disk image to the guest."
5003 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5004 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5008 #: ../src/guestfs-actions.pod:17
5010 "This call checks for the existence of C<filename>. This stops you from "
5011 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5012 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5017 #: ../src/guestfs-actions.pod:24
5019 "If you just want to add an ISO file (often you use this as an efficient way "
5020 "to transfer large files into the guest), then you should probably use "
5021 "C<guestfs_add_drive_ro> instead."
5025 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262 ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448 ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3226 ../src/guestfs-actions.pod:3241 ../src/guestfs-actions.pod:3261 ../src/guestfs-actions.pod:3416 ../src/guestfs-actions.pod:3430 ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3457 ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:3617 ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:3695 ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3733 ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:3780 ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3860 ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:3990 ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:4120 ../src/guestfs-actions.pod:4134 ../src/guestfs-actions.pod:4151 ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4186 ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4303 ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4353 ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4384 ../src/guestfs-actions.pod:4401 ../src/guestfs-actions.pod:4414 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4444 ../src/guestfs-actions.pod:4479 ../src/guestfs-actions.pod:4494 ../src/guestfs-actions.pod:4514 ../src/guestfs-actions.pod:4528 ../src/guestfs-actions.pod:4545 ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4631 ../src/guestfs-actions.pod:4645 ../src/guestfs-actions.pod:4673 ../src/guestfs-actions.pod:4690 ../src/guestfs-actions.pod:4708 ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:4899 ../src/guestfs-actions.pod:4921 ../src/guestfs-actions.pod:4939 ../src/guestfs-actions.pod:4971 ../src/guestfs-actions.pod:5037 ../src/guestfs-actions.pod:5054 ../src/guestfs-actions.pod:5067 ../src/guestfs-actions.pod:5081 ../src/guestfs-actions.pod:5370 ../src/guestfs-actions.pod:5389 ../src/guestfs-actions.pod:5403 ../src/guestfs-actions.pod:5415 ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:5441 ../src/guestfs-actions.pod:5455 ../src/guestfs-actions.pod:5471 ../src/guestfs-actions.pod:5492 ../src/guestfs-actions.pod:5511 ../src/guestfs-actions.pod:5530 ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5571 ../src/guestfs-actions.pod:5589 ../src/guestfs-actions.pod:5608 ../src/guestfs-actions.pod:5629 ../src/guestfs-actions.pod:5648 ../src/guestfs-actions.pod:5665 ../src/guestfs-actions.pod:5693 ../src/guestfs-actions.pod:5717 ../src/guestfs-actions.pod:5736 ../src/guestfs-actions.pod:5760 ../src/guestfs-actions.pod:5775 ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5809 ../src/guestfs-actions.pod:5846 ../src/guestfs-actions.pod:5869 ../src/guestfs-actions.pod:5895 ../src/guestfs-actions.pod:6003 ../src/guestfs-actions.pod:6124 ../src/guestfs-actions.pod:6136 ../src/guestfs-actions.pod:6149 ../src/guestfs-actions.pod:6162 ../src/guestfs-actions.pod:6184 ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6210 ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6238 ../src/guestfs-actions.pod:6297 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6330 ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6363 ../src/guestfs-actions.pod:6376 ../src/guestfs-actions.pod:6396 ../src/guestfs-actions.pod:6432 ../src/guestfs-actions.pod:6446 ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:6500 ../src/guestfs-actions.pod:6518 ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:6588 ../src/guestfs-actions.pod:6707 ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6739 ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6807 ../src/guestfs-actions.pod:6852 ../src/guestfs-actions.pod:6885 ../src/guestfs-actions.pod:6939 ../src/guestfs-actions.pod:6965 ../src/guestfs-actions.pod:7031 ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7079
5026 msgid "This function returns 0 on success or -1 on error."
5030 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
5032 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5037 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942 ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:6973 ../src/guestfs-actions.pod:7142 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168 ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1306 ../fish/guestfish-actions.pod:1320 ../fish/guestfish-actions.pod:2820 ../fish/guestfish-actions.pod:4622 ../fish/guestfish-actions.pod:4719
5039 "Deprecated functions will not be removed from the API, but the fact that "
5040 "they are deprecated indicates that there are problems with correct use of "
5045 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3228 ../src/guestfs-actions.pod:3243 ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:6240 ../src/guestfs-actions.pod:6365 ../src/guestfs-actions.pod:6887
5046 msgid "(Added in 0.3)"
5050 #: ../src/guestfs-actions.pod:41
5051 msgid "guestfs_add_domain"
5055 #: ../src/guestfs-actions.pod:43
5059 " guestfs_add_domain (guestfs_h *g,\n"
5060 " const char *dom,\n"
5066 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137 ../src/guestfs-actions.pod:4205
5068 "You may supply a list of optional arguments to this call. Use zero or more "
5069 "of the following pairs of parameters, and terminate the list with C<-1> on "
5070 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5074 #: ../src/guestfs-actions.pod:53
5077 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5078 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5079 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5084 #: ../src/guestfs-actions.pod:57
5086 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5087 "It works by connecting to libvirt, requesting the domain and domain XML from "
5088 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5093 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5095 "The number of disks added is returned. This operation is atomic: if an "
5096 "error is returned, then no disks are added."
5100 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5102 "This function does some minimal checks to make sure the libvirt domain is "
5103 "not running (unless C<readonly> is true). In a future version we will try "
5104 "to acquire the libvirt lock on each disk."
5108 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5110 "Disks must be accessible locally. This often means that adding disks from a "
5111 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5112 "unless those disks are accessible via the same device path locally too."
5116 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5118 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5119 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5120 "default libvirt URI (or one set through an environment variable, see the "
5121 "libvirt documentation for full details)."
5125 #: ../src/guestfs-actions.pod:80
5127 "The other optional parameters are passed directly through to "
5128 "C<guestfs_add_drive_opts>."
5132 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003 ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2662 ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4745 ../src/guestfs-actions.pod:5151 ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:6473 ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6911 ../src/guestfs-actions.pod:6924
5133 msgid "On error this function returns -1."
5137 #: ../src/guestfs-actions.pod:85
5138 msgid "(Added in 1.7.4)"
5142 #: ../src/guestfs-actions.pod:87
5143 msgid "guestfs_add_domain_va"
5147 #: ../src/guestfs-actions.pod:89
5151 " guestfs_add_domain_va (guestfs_h *g,\n"
5152 " const char *dom,\n"
5158 #: ../src/guestfs-actions.pod:94
5159 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5163 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4256
5164 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5168 #: ../src/guestfs-actions.pod:98
5169 msgid "guestfs_add_domain_argv"
5173 #: ../src/guestfs-actions.pod:100
5177 " guestfs_add_domain_argv (guestfs_h *g,\n"
5178 " const char *dom,\n"
5179 " const struct guestfs_add_domain_argv *optargs);\n"
5184 #: ../src/guestfs-actions.pod:105
5185 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5189 #: ../src/guestfs-actions.pod:109
5190 msgid "guestfs_add_drive"
5194 #: ../src/guestfs-actions.pod:111
5198 " guestfs_add_drive (guestfs_h *g,\n"
5199 " const char *filename);\n"
5204 #: ../src/guestfs-actions.pod:115
5206 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5207 "optional parameters, so the disk is added writable, with the format being "
5208 "detected automatically."
5212 #: ../src/guestfs-actions.pod:119
5214 "Automatic detection of the format opens you up to a potential security hole "
5215 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5216 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5217 "you should think about replacing calls to this function with calls to "
5218 "C<guestfs_add_drive_opts>, and specifying the format."
5222 #: ../src/guestfs-actions.pod:130
5223 msgid "guestfs_add_drive_opts"
5227 #: ../src/guestfs-actions.pod:132
5231 " guestfs_add_drive_opts (guestfs_h *g,\n"
5232 " const char *filename,\n"
5238 #: ../src/guestfs-actions.pod:142
5241 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5242 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5243 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5248 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
5250 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5251 "The first time you call this function, the disk appears as C</dev/sda>, the "
5252 "second time as C</dev/sdb>, and so on."
5256 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
5258 "You don't necessarily need to be root when using libguestfs. However you "
5259 "obviously do need sufficient permissions to access the filename for whatever "
5260 "operations you want to perform (ie. read access if you just want to read the "
5261 "image or write access if you want to modify the image)."
5265 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
5266 msgid "This call checks that C<filename> exists."
5270 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4215 ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2831
5271 msgid "The optional arguments are:"
5275 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
5280 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
5282 "If true then the image is treated as read-only. Writes are still allowed, "
5283 "but they are stored in a temporary snapshot overlay which is discarded at "
5284 "the end. The disk that you add is not modified."
5288 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
5293 #: ../src/guestfs-actions.pod:171
5295 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5296 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5297 "Possible formats include C<raw> and C<qcow2>."
5301 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
5303 "Automatic detection of the format opens you up to a potential security hole "
5304 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5305 "RHBZ#642934. Specifying the format closes this security hole."
5309 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
5314 #: ../src/guestfs-actions.pod:182
5316 "This rarely-used option lets you emulate the behaviour of the deprecated "
5317 "C<guestfs_add_drive_with_if> call (q.v.)"
5321 #: ../src/guestfs-actions.pod:189
5322 msgid "(Added in 1.5.23)"
5326 #: ../src/guestfs-actions.pod:191
5327 msgid "guestfs_add_drive_opts_va"
5331 #: ../src/guestfs-actions.pod:193
5335 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5336 " const char *filename,\n"
5342 #: ../src/guestfs-actions.pod:198
5343 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5347 #: ../src/guestfs-actions.pod:202
5348 msgid "guestfs_add_drive_opts_argv"
5352 #: ../src/guestfs-actions.pod:204
5356 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5357 " const char *filename,\n"
5358 " const struct guestfs_add_drive_opts_argv "
5364 #: ../src/guestfs-actions.pod:209
5365 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5369 #: ../src/guestfs-actions.pod:213
5370 msgid "guestfs_add_drive_ro"
5374 #: ../src/guestfs-actions.pod:215
5378 " guestfs_add_drive_ro (guestfs_h *g,\n"
5379 " const char *filename);\n"
5384 #: ../src/guestfs-actions.pod:219
5386 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5387 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5388 "disk is added read-only, with the format being detected automatically."
5392 #: ../src/guestfs-actions.pod:226
5393 msgid "(Added in 1.0.38)"
5397 #: ../src/guestfs-actions.pod:228
5398 msgid "guestfs_add_drive_ro_with_if"
5402 #: ../src/guestfs-actions.pod:230
5406 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
5407 " const char *filename,\n"
5408 " const char *iface);\n"
5413 #: ../src/guestfs-actions.pod:235
5415 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
5416 "QEMU interface emulation to use at run time."
5420 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2333
5421 msgid "(Added in 1.0.84)"
5425 #: ../src/guestfs-actions.pod:249
5426 msgid "guestfs_add_drive_with_if"
5430 #: ../src/guestfs-actions.pod:251
5434 " guestfs_add_drive_with_if (guestfs_h *g,\n"
5435 " const char *filename,\n"
5436 " const char *iface);\n"
5441 #: ../src/guestfs-actions.pod:256
5443 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
5444 "QEMU interface emulation to use at run time."
5448 #: ../src/guestfs-actions.pod:270
5449 msgid "guestfs_aug_clear"
5453 #: ../src/guestfs-actions.pod:272
5457 " guestfs_aug_clear (guestfs_h *g,\n"
5458 " const char *augpath);\n"
5463 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
5465 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5466 "L<augtool(1)> C<clear> command."
5470 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
5471 msgid "(Added in 1.3.4)"
5475 #: ../src/guestfs-actions.pod:283
5476 msgid "guestfs_aug_close"
5480 #: ../src/guestfs-actions.pod:285
5484 " guestfs_aug_close (guestfs_h *g);\n"
5489 #: ../src/guestfs-actions.pod:288
5491 "Close the current Augeas handle and free up any resources used by it. After "
5492 "calling this, you have to call C<guestfs_aug_init> again before you can use "
5493 "any other Augeas functions."
5497 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:5228
5498 msgid "(Added in 0.7)"
5502 #: ../src/guestfs-actions.pod:297
5503 msgid "guestfs_aug_defnode"
5507 #: ../src/guestfs-actions.pod:299
5510 " struct guestfs_int_bool *\n"
5511 " guestfs_aug_defnode (guestfs_h *g,\n"
5512 " const char *name,\n"
5513 " const char *expr,\n"
5514 " const char *val);\n"
5519 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
5520 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5524 #: ../src/guestfs-actions.pod:308
5526 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5527 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
5528 "containing that single node."
5532 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
5534 "On success this returns a pair containing the number of nodes in the "
5535 "nodeset, and a boolean flag if a node was created."
5539 #: ../src/guestfs-actions.pod:316
5541 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
5542 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
5546 #: ../src/guestfs-actions.pod:322
5547 msgid "guestfs_aug_defvar"
5551 #: ../src/guestfs-actions.pod:324
5555 " guestfs_aug_defvar (guestfs_h *g,\n"
5556 " const char *name,\n"
5557 " const char *expr);\n"
5562 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
5564 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5565 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5569 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
5571 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5572 "evaluates to something which is not a nodeset."
5576 #: ../src/guestfs-actions.pod:340
5577 msgid "guestfs_aug_get"
5581 #: ../src/guestfs-actions.pod:342
5585 " guestfs_aug_get (guestfs_h *g,\n"
5586 " const char *augpath);\n"
5591 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
5593 "Look up the value associated with C<path>. If C<path> matches exactly one "
5594 "node, the C<value> is returned."
5598 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341 ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2748 ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2888 ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4763 ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5916 ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:5949 ../src/guestfs-actions.pod:5973 ../src/guestfs-actions.pod:6647 ../src/guestfs-actions.pod:6666 ../src/guestfs-actions.pod:6684 ../src/guestfs-actions.pod:6864 ../src/guestfs-actions.pod:7136
5600 "This function returns a string, or NULL on error. I<The caller must free "
5601 "the returned string after use>."
5605 #: ../src/guestfs-actions.pod:354
5606 msgid "guestfs_aug_init"
5610 #: ../src/guestfs-actions.pod:356
5614 " guestfs_aug_init (guestfs_h *g,\n"
5615 " const char *root,\n"
5621 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
5623 "Create a new Augeas handle for editing configuration files. If there was "
5624 "any previous Augeas handle associated with this guestfs session, then it is "
5629 #: ../src/guestfs-actions.pod:365
5630 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5634 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
5635 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5639 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
5641 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5642 "logical I<or> of the following integers:"
5646 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
5647 msgid "C<AUG_SAVE_BACKUP> = 1"
5651 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
5652 msgid "Keep the original file with a C<.augsave> extension."
5656 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
5657 msgid "C<AUG_SAVE_NEWFILE> = 2"
5661 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
5663 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5664 "original. Overrides C<AUG_SAVE_BACKUP>."
5668 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
5669 msgid "C<AUG_TYPE_CHECK> = 4"
5673 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
5674 msgid "Typecheck lenses (can be expensive)."
5678 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
5679 msgid "C<AUG_NO_STDINC> = 8"
5683 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
5684 msgid "Do not use standard load path for modules."
5688 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
5689 msgid "C<AUG_SAVE_NOOP> = 16"
5693 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
5694 msgid "Make save a no-op, just record what would have been changed."
5698 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
5699 msgid "C<AUG_NO_LOAD> = 32"
5703 #: ../src/guestfs-actions.pod:400
5704 msgid "Do not load the tree in C<guestfs_aug_init>."
5708 #: ../src/guestfs-actions.pod:404
5709 msgid "To close the handle, you can call C<guestfs_aug_close>."
5713 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:270
5714 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5718 #: ../src/guestfs-actions.pod:412
5719 msgid "guestfs_aug_insert"
5723 #: ../src/guestfs-actions.pod:414
5727 " guestfs_aug_insert (guestfs_h *g,\n"
5728 " const char *augpath,\n"
5729 " const char *label,\n"
5735 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:276
5737 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5738 "or after C<path> (depending on the boolean flag C<before>)."
5742 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:280
5744 "C<path> must match exactly one existing node in the tree, and C<label> must "
5745 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5749 #: ../src/guestfs-actions.pod:432
5750 msgid "guestfs_aug_load"
5754 #: ../src/guestfs-actions.pod:434
5758 " guestfs_aug_load (guestfs_h *g);\n"
5763 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:288
5764 msgid "Load files into the tree."
5768 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
5769 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5773 #: ../src/guestfs-actions.pod:446
5774 msgid "guestfs_aug_ls"
5778 #: ../src/guestfs-actions.pod:448
5782 " guestfs_aug_ls (guestfs_h *g,\n"
5783 " const char *augpath);\n"
5788 #: ../src/guestfs-actions.pod:452
5790 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5791 "sorting the resulting nodes into alphabetical order."
5795 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471 ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:2194 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2351 ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2822 ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3384 ../src/guestfs-actions.pod:3489 ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5224 ../src/guestfs-actions.pod:5338 ../src/guestfs-actions.pod:5989 ../src/guestfs-actions.pod:6050 ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6251 ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6757 ../src/guestfs-actions.pod:6777 ../src/guestfs-actions.pod:6824 ../src/guestfs-actions.pod:6989 ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7093 ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7158 ../src/guestfs-actions.pod:7177
5797 "This function returns a NULL-terminated array of strings (like "
5798 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
5799 "strings and the array after use>."
5803 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3735 ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:3972 ../src/guestfs-actions.pod:4005 ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4582 ../src/guestfs-actions.pod:5039 ../src/guestfs-actions.pod:5417 ../src/guestfs-actions.pod:5431 ../src/guestfs-actions.pod:5443 ../src/guestfs-actions.pod:5851 ../src/guestfs-actions.pod:6489 ../src/guestfs-actions.pod:6502 ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:6977
5804 msgid "(Added in 0.8)"
5808 #: ../src/guestfs-actions.pod:461
5809 msgid "guestfs_aug_match"
5813 #: ../src/guestfs-actions.pod:463
5817 " guestfs_aug_match (guestfs_h *g,\n"
5818 " const char *augpath);\n"
5823 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:304
5825 "Returns a list of paths which match the path expression C<path>. The "
5826 "returned paths are sufficiently qualified so that they match exactly one "
5827 "node in the current tree."
5831 #: ../src/guestfs-actions.pod:477
5832 msgid "guestfs_aug_mv"
5836 #: ../src/guestfs-actions.pod:479
5840 " guestfs_aug_mv (guestfs_h *g,\n"
5841 " const char *src,\n"
5842 " const char *dest);\n"
5847 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:312
5849 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5850 "C<dest> is overwritten if it exists."
5854 #: ../src/guestfs-actions.pod:491
5855 msgid "guestfs_aug_rm"
5859 #: ../src/guestfs-actions.pod:493
5863 " guestfs_aug_rm (guestfs_h *g,\n"
5864 " const char *augpath);\n"
5869 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:319
5870 msgid "Remove C<path> and all of its children."
5874 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5875 msgid "On success this returns the number of entries which were removed."
5879 #: ../src/guestfs-actions.pod:505
5880 msgid "guestfs_aug_save"
5884 #: ../src/guestfs-actions.pod:507
5888 " guestfs_aug_save (guestfs_h *g);\n"
5893 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:327
5894 msgid "This writes all pending changes to disk."
5898 #: ../src/guestfs-actions.pod:512
5900 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5905 #: ../src/guestfs-actions.pod:519
5906 msgid "guestfs_aug_set"
5910 #: ../src/guestfs-actions.pod:521
5914 " guestfs_aug_set (guestfs_h *g,\n"
5915 " const char *augpath,\n"
5916 " const char *val);\n"
5921 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:336
5922 msgid "Set the value associated with C<path> to C<val>."
5926 #: ../src/guestfs-actions.pod:528
5928 "In the Augeas API, it is possible to clear a node by setting the value to "
5929 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5930 "this call. Instead you must use the C<guestfs_aug_clear> call."
5934 #: ../src/guestfs-actions.pod:537
5935 msgid "guestfs_available"
5939 #: ../src/guestfs-actions.pod:539
5943 " guestfs_available (guestfs_h *g,\n"
5944 " char *const *groups);\n"
5949 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:347
5951 "This command is used to check the availability of some groups of "
5952 "functionality in the appliance, which not all builds of the libguestfs "
5953 "appliance will be able to provide."
5957 #: ../src/guestfs-actions.pod:547
5959 "The libguestfs groups, and the functions that those groups correspond to, "
5960 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5961 "runtime by calling C<guestfs_available_all_groups>."
5965 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:356
5967 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5968 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5969 "and Augeas (configuration file editing) functions."
5973 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
5974 msgid "The command returns no error if I<all> requested groups are available."
5978 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
5980 "It fails with an error if one or more of the requested groups is unavailable "
5985 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
5987 "If an unknown group name is included in the list of groups then an error is "
5992 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:369
5997 #: ../src/guestfs-actions.pod:571
5998 msgid "You must call C<guestfs_launch> before calling this function."
6002 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:377
6004 "The reason is because we don't know what groups are supported by the "
6005 "appliance/daemon until it is running and can be queried."
6009 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:383
6011 "If a group of functions is available, this does not necessarily mean that "
6012 "they will work. You still have to check for errors when calling individual "
6013 "API functions even if they are available."
6017 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:390
6019 "It is usually the job of distro packagers to build complete functionality "
6020 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6021 "with all requirements satisfied, will support everything."
6025 #: ../src/guestfs-actions.pod:593
6027 "This call was added in version C<1.0.80>. In previous versions of "
6028 "libguestfs all you could do would be to speculatively execute a command to "
6029 "find out if the daemon implemented it. See also C<guestfs_version>."
6033 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
6034 msgid "(Added in 1.0.80)"
6038 #: ../src/guestfs-actions.pod:604
6039 msgid "guestfs_available_all_groups"
6043 #: ../src/guestfs-actions.pod:606
6047 " guestfs_available_all_groups (guestfs_h *g);\n"
6052 #: ../src/guestfs-actions.pod:609
6054 "This command returns a list of all optional groups that this daemon knows "
6055 "about. Note this returns both supported and unsupported groups. To find "
6056 "out which ones the daemon can actually support you have to call "
6057 "C<guestfs_available> on each member of the returned list."
6061 #: ../src/guestfs-actions.pod:615
6062 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6066 #: ../src/guestfs-actions.pod:621
6067 msgid "(Added in 1.3.15)"
6071 #: ../src/guestfs-actions.pod:623
6072 msgid "guestfs_base64_in"
6076 #: ../src/guestfs-actions.pod:625
6080 " guestfs_base64_in (guestfs_h *g,\n"
6081 " const char *base64file,\n"
6082 " const char *filename);\n"
6087 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:420
6088 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6092 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
6093 msgid "(Added in 1.3.5)"
6097 #: ../src/guestfs-actions.pod:637
6098 msgid "guestfs_base64_out"
6102 #: ../src/guestfs-actions.pod:639
6106 " guestfs_base64_out (guestfs_h *g,\n"
6107 " const char *filename,\n"
6108 " const char *base64file);\n"
6113 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:429
6115 "This command downloads the contents of C<filename>, writing it out to local "
6116 "file C<base64file> encoded as base64."
6120 #: ../src/guestfs-actions.pod:651
6121 msgid "guestfs_blockdev_flushbufs"
6125 #: ../src/guestfs-actions.pod:653
6129 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6130 " const char *device);\n"
6135 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:438
6136 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6140 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:441 ../fish/guestfish-actions.pod:452 ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:471 ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:496 ../fish/guestfish-actions.pod:504 ../fish/guestfish-actions.pod:515 ../fish/guestfish-actions.pod:523 ../fish/guestfish-actions.pod:531
6141 msgid "This uses the L<blockdev(8)> command."
6145 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
6146 msgid "(Added in 0.9.3)"
6150 #: ../src/guestfs-actions.pod:666
6151 msgid "guestfs_blockdev_getbsz"
6155 #: ../src/guestfs-actions.pod:668
6159 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6160 " const char *device);\n"
6165 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:447
6166 msgid "This returns the block size of a device."
6170 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:512
6172 "(Note this is different from both I<size in blocks> and I<filesystem block "
6177 #: ../src/guestfs-actions.pod:683
6178 msgid "guestfs_blockdev_getro"
6182 #: ../src/guestfs-actions.pod:685
6186 " guestfs_blockdev_getro (guestfs_h *g,\n"
6187 " const char *device);\n"
6192 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:458
6194 "Returns a boolean indicating if the block device is read-only (true if "
6195 "read-only, false if not)."
6199 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:3054 ../src/guestfs-actions.pod:3068 ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3158 ../src/guestfs-actions.pod:3171 ../src/guestfs-actions.pod:3185 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3215 ../src/guestfs-actions.pod:4727
6200 msgid "This function returns a C truth value on success or -1 on error."
6204 #: ../src/guestfs-actions.pod:698
6205 msgid "guestfs_blockdev_getsize64"
6209 #: ../src/guestfs-actions.pod:700
6213 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6214 " const char *device);\n"
6219 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:467
6220 msgid "This returns the size of the device in bytes."
6224 #: ../src/guestfs-actions.pod:706
6225 msgid "See also C<guestfs_blockdev_getsz>."
6229 #: ../src/guestfs-actions.pod:714
6230 msgid "guestfs_blockdev_getss"
6234 #: ../src/guestfs-actions.pod:716
6238 " guestfs_blockdev_getss (guestfs_h *g,\n"
6239 " const char *device);\n"
6244 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:477
6246 "This returns the size of sectors on a block device. Usually 512, but can be "
6247 "larger for modern devices."
6251 #: ../src/guestfs-actions.pod:723
6253 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6258 #: ../src/guestfs-actions.pod:732
6259 msgid "guestfs_blockdev_getsz"
6263 #: ../src/guestfs-actions.pod:734
6267 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6268 " const char *device);\n"
6273 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:489
6275 "This returns the size of the device in units of 512-byte sectors (even if "
6276 "the sectorsize isn't 512 bytes ... weird)."
6280 #: ../src/guestfs-actions.pod:741
6282 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6283 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6287 #: ../src/guestfs-actions.pod:751
6288 msgid "guestfs_blockdev_rereadpt"
6292 #: ../src/guestfs-actions.pod:753
6296 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6297 " const char *device);\n"
6302 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:502
6303 msgid "Reread the partition table on C<device>."
6307 #: ../src/guestfs-actions.pod:765
6308 msgid "guestfs_blockdev_setbsz"
6312 #: ../src/guestfs-actions.pod:767
6316 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6317 " const char *device,\n"
6318 " int blocksize);\n"
6323 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:510
6324 msgid "This sets the block size of a device."
6328 #: ../src/guestfs-actions.pod:783
6329 msgid "guestfs_blockdev_setro"
6333 #: ../src/guestfs-actions.pod:785
6337 " guestfs_blockdev_setro (guestfs_h *g,\n"
6338 " const char *device);\n"
6343 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:521
6344 msgid "Sets the block device named C<device> to read-only."
6348 #: ../src/guestfs-actions.pod:797
6349 msgid "guestfs_blockdev_setrw"
6353 #: ../src/guestfs-actions.pod:799
6357 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6358 " const char *device);\n"
6363 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:529
6364 msgid "Sets the block device named C<device> to read-write."
6368 #: ../src/guestfs-actions.pod:811
6369 msgid "guestfs_case_sensitive_path"
6373 #: ../src/guestfs-actions.pod:813
6377 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6378 " const char *path);\n"
6383 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:537
6385 "This can be used to resolve case insensitive paths on a filesystem which is "
6386 "case sensitive. The use case is to resolve paths which you have read from "
6387 "Windows configuration files or the Windows Registry, to the true path."
6391 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
6393 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6394 "(and probably others), which is that although the underlying filesystem is "
6395 "case-insensitive, the driver exports the filesystem to Linux as "
6400 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
6402 "One consequence of this is that special directories such as C<c:\\windows> "
6403 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6404 "precise details of how they were created. In Windows itself this would not "
6409 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:553
6411 "Bug or feature? You decide: "
6412 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6416 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:556
6418 "This function resolves the true case of each element in the path and returns "
6419 "the case-sensitive path."
6423 #: ../src/guestfs-actions.pod:839
6425 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
6426 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6427 "how the directories were originally created under Windows)."
6431 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:564
6432 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6436 #: ../src/guestfs-actions.pod:847
6437 msgid "See also C<guestfs_realpath>."
6441 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6669
6442 msgid "(Added in 1.0.75)"
6446 #: ../src/guestfs-actions.pod:854
6451 #: ../src/guestfs-actions.pod:856
6455 " guestfs_cat (guestfs_h *g,\n"
6456 " const char *path);\n"
6461 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:3466
6462 msgid "Return the contents of the file named C<path>."
6466 #: ../src/guestfs-actions.pod:862
6468 "Note that this function cannot correctly handle binary files (specifically, "
6469 "files containing C<\\0> character which is treated as end of string). For "
6470 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
6471 "functions which have a more complex interface."
6475 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2260 ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:4996 ../src/guestfs-actions.pod:5022 ../src/guestfs-actions.pod:5153 ../src/guestfs-actions.pod:5179 ../src/guestfs-actions.pod:5203 ../src/guestfs-actions.pod:6054 ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6255 ../src/guestfs-actions.pod:6279 ../src/guestfs-actions.pod:6941 ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:6993 ../src/guestfs-actions.pod:7012 ../src/guestfs-actions.pod:7097 ../src/guestfs-actions.pod:7116 ../src/guestfs-actions.pod:7162 ../src/guestfs-actions.pod:7181 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:715 ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:913 ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990 ../fish/guestfish-actions.pod:1185 ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:1490 ../fish/guestfish-actions.pod:1518 ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:1543 ../fish/guestfish-actions.pod:1562 ../fish/guestfish-actions.pod:3336 ../fish/guestfish-actions.pod:3351 ../fish/guestfish-actions.pod:3427 ../fish/guestfish-actions.pod:3444 ../fish/guestfish-actions.pod:3459 ../fish/guestfish-actions.pod:4042 ../fish/guestfish-actions.pod:4088 ../fish/guestfish-actions.pod:4173 ../fish/guestfish-actions.pod:4188 ../fish/guestfish-actions.pod:4598 ../fish/guestfish-actions.pod:4616 ../fish/guestfish-actions.pod:4633 ../fish/guestfish-actions.pod:4643 ../fish/guestfish-actions.pod:4691 ../fish/guestfish-actions.pod:4701 ../fish/guestfish-actions.pod:4730 ../fish/guestfish-actions.pod:4740
6477 "Because of the message protocol, there is a transfer limit of somewhere "
6478 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6482 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3326 ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3912 ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5116 ../src/guestfs-actions.pod:6828 ../src/guestfs-actions.pod:6842
6483 msgid "(Added in 0.4)"
6487 #: ../src/guestfs-actions.pod:875
6488 msgid "guestfs_checksum"
6492 #: ../src/guestfs-actions.pod:877
6496 " guestfs_checksum (guestfs_h *g,\n"
6497 " const char *csumtype,\n"
6498 " const char *path);\n"
6503 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:587
6504 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6508 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:590
6510 "The type of checksum to compute is given by the C<csumtype> parameter which "
6511 "must have one of the following values:"
6515 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
6520 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
6522 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6527 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
6532 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
6533 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6537 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
6542 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
6543 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6547 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
6552 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
6553 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6557 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
6562 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
6563 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6567 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
6572 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
6573 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6577 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
6582 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
6583 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6587 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:626
6588 msgid "The checksum is returned as a printable string."
6592 #: ../src/guestfs-actions.pod:923
6593 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6597 #: ../src/guestfs-actions.pod:925
6598 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6602 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3070 ../src/guestfs-actions.pod:3099 ../src/guestfs-actions.pod:3160 ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:6525
6603 msgid "(Added in 1.0.2)"
6607 #: ../src/guestfs-actions.pod:932
6608 msgid "guestfs_checksum_device"
6612 #: ../src/guestfs-actions.pod:934
6616 " guestfs_checksum_device (guestfs_h *g,\n"
6617 " const char *csumtype,\n"
6618 " const char *device);\n"
6623 #: ../src/guestfs-actions.pod:939
6625 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6626 "device named C<device>. For the types of checksums supported see the "
6627 "C<guestfs_checksum> command."
6631 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4729 ../src/guestfs-actions.pod:4747 ../src/guestfs-actions.pod:4923 ../src/guestfs-actions.pod:6434 ../src/guestfs-actions.pod:6448 ../src/guestfs-actions.pod:6854
6632 msgid "(Added in 1.3.2)"
6636 #: ../src/guestfs-actions.pod:948
6637 msgid "guestfs_checksums_out"
6641 #: ../src/guestfs-actions.pod:950
6645 " guestfs_checksums_out (guestfs_h *g,\n"
6646 " const char *csumtype,\n"
6647 " const char *directory,\n"
6648 " const char *sumsfile);\n"
6653 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:644
6655 "This command computes the checksums of all regular files in C<directory> and "
6656 "then emits a list of those checksums to the local output file C<sumsfile>."
6660 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:648
6662 "This can be used for verifying the integrity of a virtual machine. However "
6663 "to be properly secure you should pay attention to the output of the checksum "
6664 "command (it uses the ones from GNU coreutils). In particular when the "
6665 "filename is not printable, coreutils uses a special backslash syntax. For "
6666 "more information, see the GNU coreutils info file."
6670 #: ../src/guestfs-actions.pod:970
6671 msgid "(Added in 1.3.7)"
6675 #: ../src/guestfs-actions.pod:972
6676 msgid "guestfs_chmod"
6680 #: ../src/guestfs-actions.pod:974
6684 " guestfs_chmod (guestfs_h *g,\n"
6686 " const char *path);\n"
6691 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:662
6693 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6698 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:665
6700 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6701 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6706 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4149 ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4351 ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:669 ../fish/guestfish-actions.pod:2795 ../fish/guestfish-actions.pod:2911 ../fish/guestfish-actions.pod:2921 ../fish/guestfish-actions.pod:2931
6707 msgid "The mode actually set is affected by the umask."
6711 #: ../src/guestfs-actions.pod:992
6712 msgid "guestfs_chown"
6716 #: ../src/guestfs-actions.pod:994
6720 " guestfs_chown (guestfs_h *g,\n"
6723 " const char *path);\n"
6728 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:675
6729 msgid "Change the file owner to C<owner> and group to C<group>."
6733 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:677 ../fish/guestfish-actions.pod:2253
6735 "Only numeric uid and gid are supported. If you want to use names, you will "
6736 "need to locate and parse the password file yourself (Augeas support makes "
6737 "this relatively easy)."
6741 #: ../src/guestfs-actions.pod:1010
6742 msgid "guestfs_command"
6746 #: ../src/guestfs-actions.pod:1012
6750 " guestfs_command (guestfs_h *g,\n"
6751 " char *const *arguments);\n"
6756 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:685
6758 "This call runs a command from the guest filesystem. The filesystem must be "
6759 "mounted, and must contain a compatible operating system (ie. something "
6760 "Linux, with the same or compatible processor architecture)."
6764 #: ../src/guestfs-actions.pod:1021
6766 "The single parameter is an argv-style list of arguments. The first element "
6767 "is the name of the program to run. Subsequent elements are parameters. The "
6768 "list must be non-empty (ie. must contain a program name). Note that the "
6769 "command runs directly, and is I<not> invoked via the shell (see "
6774 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:697
6775 msgid "The return value is anything printed to I<stdout> by the command."
6779 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:700
6781 "If the command returns a non-zero exit status, then this function returns an "
6782 "error message. The error message string is the content of I<stderr> from "
6787 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:704
6789 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6790 "C</bin>. If you require a program from another location, you should provide "
6791 "the full path in the first parameter."
6795 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
6797 "Shared libraries and data files required by the program must be available on "
6798 "filesystems which are mounted in the correct places. It is the caller's "
6799 "responsibility to ensure all filesystems that are needed are mounted at the "
6804 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072 ../src/guestfs-actions.pod:1535
6805 msgid "(Added in 0.9.1)"
6809 #: ../src/guestfs-actions.pod:1054
6810 msgid "guestfs_command_lines"
6814 #: ../src/guestfs-actions.pod:1056
6818 " guestfs_command_lines (guestfs_h *g,\n"
6819 " char *const *arguments);\n"
6824 #: ../src/guestfs-actions.pod:1060
6826 "This is the same as C<guestfs_command>, but splits the result into a list of "
6831 #: ../src/guestfs-actions.pod:1063
6832 msgid "See also: C<guestfs_sh_lines>"
6836 #: ../src/guestfs-actions.pod:1074
6837 msgid "guestfs_config"
6841 #: ../src/guestfs-actions.pod:1076
6845 " guestfs_config (guestfs_h *g,\n"
6846 " const char *qemuparam,\n"
6847 " const char *qemuvalue);\n"
6852 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:734
6854 "This can be used to add arbitrary qemu command line parameters of the form "
6855 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6856 "setting some parameters which would interfere with parameters that we use."
6860 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
6861 msgid "The first character of C<param> string must be a C<-> (dash)."
6865 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
6866 msgid "C<value> can be NULL."
6870 #: ../src/guestfs-actions.pod:1094
6871 msgid "guestfs_copy_size"
6875 #: ../src/guestfs-actions.pod:1096
6879 " guestfs_copy_size (guestfs_h *g,\n"
6880 " const char *src,\n"
6881 " const char *dest,\n"
6887 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:747
6889 "This command copies exactly C<size> bytes from one source device or file "
6890 "C<src> to another destination device or file C<dest>."
6894 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:750
6896 "Note this will fail if the source is too short or if the destination is not "
6901 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6520 ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:7033 ../src/guestfs-actions.pod:7052
6903 "This long-running command can generate progress notification messages so "
6904 "that the caller can display a progress bar or indicator. To receive these "
6905 "messages, the caller must register a progress callback. See "
6906 "L<guestfs(3)/guestfs_set_progress_callback>."
6910 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:5129 ../src/guestfs-actions.pod:6761 ../src/guestfs-actions.pod:6781 ../src/guestfs-actions.pod:6867
6911 msgid "(Added in 1.0.87)"
6915 #: ../src/guestfs-actions.pod:1117
6920 #: ../src/guestfs-actions.pod:1119
6924 " guestfs_cp (guestfs_h *g,\n"
6925 " const char *src,\n"
6926 " const char *dest);\n"
6931 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:757
6933 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6934 "destination filename or destination directory."
6938 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4596 ../src/guestfs-actions.pod:4973
6939 msgid "(Added in 1.0.18)"
6943 #: ../src/guestfs-actions.pod:1131
6944 msgid "guestfs_cp_a"
6948 #: ../src/guestfs-actions.pod:1133
6952 " guestfs_cp_a (guestfs_h *g,\n"
6953 " const char *src,\n"
6954 " const char *dest);\n"
6959 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:764
6961 "This copies a file or directory from C<src> to C<dest> recursively using the "
6966 #: ../src/guestfs-actions.pod:1145
6971 #: ../src/guestfs-actions.pod:1147
6975 " guestfs_dd (guestfs_h *g,\n"
6976 " const char *src,\n"
6977 " const char *dest);\n"
6982 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
6984 "This command copies from one source device or file C<src> to another "
6985 "destination device or file C<dest>. Normally you would use this to copy to "
6986 "or from a device or partition, for example to duplicate a filesystem."
6990 #: ../src/guestfs-actions.pod:1157
6992 "If the destination is a device, it must be as large or larger than the "
6993 "source file or device, otherwise the copy will fail. This command cannot do "
6994 "partial copies (see C<guestfs_copy_size>)."
6998 #: ../src/guestfs-actions.pod:1165
7003 #: ../src/guestfs-actions.pod:1167
7007 " guestfs_df (guestfs_h *g);\n"
7012 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:784
7013 msgid "This command runs the C<df> command to report disk space used."
7017 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
7019 "This command is mostly useful for interactive sessions. It is I<not> "
7020 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7025 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2263 ../src/guestfs-actions.pod:2287 ../src/guestfs-actions.pod:2355 ../src/guestfs-actions.pod:4035 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6282 ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6913 ../src/guestfs-actions.pod:6926
7026 msgid "(Added in 1.0.54)"
7030 #: ../src/guestfs-actions.pod:1181
7031 msgid "guestfs_df_h"
7035 #: ../src/guestfs-actions.pod:1183
7039 " guestfs_df_h (guestfs_h *g);\n"
7044 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:794
7046 "This command runs the C<df -h> command to report disk space used in "
7047 "human-readable format."
7051 #: ../src/guestfs-actions.pod:1198
7052 msgid "guestfs_dmesg"
7056 #: ../src/guestfs-actions.pod:1200
7060 " guestfs_dmesg (guestfs_h *g);\n"
7065 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:805
7067 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7068 "This is sometimes useful for extended debugging of problems."
7072 #: ../src/guestfs-actions.pod:1207
7074 "Another way to get the same information is to enable verbose messages with "
7075 "C<guestfs_set_verbose> or by setting the environment variable "
7076 "C<LIBGUESTFS_DEBUG=1> before running the program."
7080 #: ../src/guestfs-actions.pod:1217
7081 msgid "guestfs_download"
7085 #: ../src/guestfs-actions.pod:1219
7089 " guestfs_download (guestfs_h *g,\n"
7090 " const char *remotefilename,\n"
7091 " const char *filename);\n"
7096 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249 ../fish/guestfish-actions.pod:818 ../fish/guestfish-actions.pod:831
7098 "Download file C<remotefilename> and save it as C<filename> on the local "
7103 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6514 ../fish/guestfish-actions.pod:821 ../fish/guestfish-actions.pod:4346
7104 msgid "C<filename> can also be a named pipe."
7108 #: ../src/guestfs-actions.pod:1229
7109 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7113 #: ../src/guestfs-actions.pod:1240
7114 msgid "guestfs_download_offset"
7118 #: ../src/guestfs-actions.pod:1242
7122 " guestfs_download_offset (guestfs_h *g,\n"
7123 " const char *remotefilename,\n"
7124 " const char *filename,\n"
7125 " int64_t offset,\n"
7131 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:834
7133 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7134 "region must be within the file or device)."
7138 #: ../src/guestfs-actions.pod:1255
7140 "Note that there is no limit on the amount of data that can be downloaded "
7141 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7142 "full amount unless an error occurs."
7146 #: ../src/guestfs-actions.pod:1260
7147 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7151 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6559
7152 msgid "(Added in 1.5.17)"
7156 #: ../src/guestfs-actions.pod:1271
7157 msgid "guestfs_drop_caches"
7161 #: ../src/guestfs-actions.pod:1273
7165 " guestfs_drop_caches (guestfs_h *g,\n"
7166 " int whattodrop);\n"
7171 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:850
7173 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7174 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7175 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7179 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
7180 msgid "Setting C<whattodrop> to 3 should drop everything."
7184 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
7186 "This automatically calls L<sync(2)> before the operation, so that the "
7187 "maximum guest memory is freed."
7191 #: ../src/guestfs-actions.pod:1291
7196 #: ../src/guestfs-actions.pod:1293
7200 " guestfs_du (guestfs_h *g,\n"
7201 " const char *path);\n"
7206 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:864
7208 "This command runs the C<du -s> command to estimate file space usage for "
7213 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:867
7215 "C<path> can be a file or a directory. If C<path> is a directory then the "
7216 "estimate includes the contents of the directory and all subdirectories "
7221 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:871
7222 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7226 #: ../src/guestfs-actions.pod:1311
7227 msgid "guestfs_e2fsck_f"
7231 #: ../src/guestfs-actions.pod:1313
7235 " guestfs_e2fsck_f (guestfs_h *g,\n"
7236 " const char *device);\n"
7241 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:878
7243 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7244 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7249 #: ../src/guestfs-actions.pod:1321
7251 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7252 "Normally you should use C<guestfs_fsck>."
7256 #: ../src/guestfs-actions.pod:1326
7257 msgid "(Added in 1.0.29)"
7261 #: ../src/guestfs-actions.pod:1328
7262 msgid "guestfs_echo_daemon"
7266 #: ../src/guestfs-actions.pod:1330
7270 " guestfs_echo_daemon (guestfs_h *g,\n"
7271 " char *const *words);\n"
7276 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:889
7278 "This command concatenates the list of C<words> passed with single spaces "
7279 "between them and returns the resulting string."
7283 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:892
7284 msgid "You can use this command to test the connection through to the daemon."
7288 #: ../src/guestfs-actions.pod:1339
7289 msgid "See also C<guestfs_ping_daemon>."
7293 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:5762
7294 msgid "(Added in 1.0.69)"
7298 #: ../src/guestfs-actions.pod:1346
7299 msgid "guestfs_egrep"
7303 #: ../src/guestfs-actions.pod:1348
7307 " guestfs_egrep (guestfs_h *g,\n"
7308 " const char *regex,\n"
7309 " const char *path);\n"
7314 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:900
7315 msgid "This calls the external C<egrep> program and returns the matching lines."
7319 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2201 ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:2404 ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:3459 ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5356 ../src/guestfs-actions.pod:6126 ../src/guestfs-actions.pod:6138 ../src/guestfs-actions.pod:6151 ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6186 ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6996 ../src/guestfs-actions.pod:7015 ../src/guestfs-actions.pod:7100 ../src/guestfs-actions.pod:7119 ../src/guestfs-actions.pod:7165 ../src/guestfs-actions.pod:7184
7320 msgid "(Added in 1.0.66)"
7324 #: ../src/guestfs-actions.pod:1365
7325 msgid "guestfs_egrepi"
7329 #: ../src/guestfs-actions.pod:1367
7333 " guestfs_egrepi (guestfs_h *g,\n"
7334 " const char *regex,\n"
7335 " const char *path);\n"
7340 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:910
7341 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7345 #: ../src/guestfs-actions.pod:1384
7346 msgid "guestfs_equal"
7350 #: ../src/guestfs-actions.pod:1386
7354 " guestfs_equal (guestfs_h *g,\n"
7355 " const char *file1,\n"
7356 " const char *file2);\n"
7361 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:920
7363 "This compares the two files C<file1> and C<file2> and returns true if their "
7364 "content is exactly equal, or false otherwise."
7368 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:923
7369 msgid "The external L<cmp(1)> program is used for the comparison."
7373 #: ../src/guestfs-actions.pod:1400
7374 msgid "guestfs_exists"
7378 #: ../src/guestfs-actions.pod:1402
7382 " guestfs_exists (guestfs_h *g,\n"
7383 " const char *path);\n"
7388 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:929
7390 "This returns C<true> if and only if there is a file, directory (or anything) "
7391 "with the given C<path> name."
7395 #: ../src/guestfs-actions.pod:1409
7396 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7400 #: ../src/guestfs-actions.pod:1415
7401 msgid "guestfs_fallocate"
7405 #: ../src/guestfs-actions.pod:1417
7409 " guestfs_fallocate (guestfs_h *g,\n"
7410 " const char *path,\n"
7416 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:957
7418 "This command preallocates a file (containing zero bytes) named C<path> of "
7419 "size C<len> bytes. If the file exists already, it is overwritten."
7423 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:942
7425 "Do not confuse this with the guestfish-specific C<alloc> command which "
7426 "allocates a file in the host and attaches it as a device."
7430 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:946
7432 "This function is deprecated. In new code, use the C<fallocate64> call "
7437 #: ../src/guestfs-actions.pod:1441
7438 msgid "guestfs_fallocate64"
7442 #: ../src/guestfs-actions.pod:1443
7446 " guestfs_fallocate64 (guestfs_h *g,\n"
7447 " const char *path,\n"
7453 #: ../src/guestfs-actions.pod:1452
7455 "Note that this call allocates disk blocks for the file. To create a sparse "
7456 "file use C<guestfs_truncate_size> instead."
7460 #: ../src/guestfs-actions.pod:1455
7462 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
7463 "oversight it only allowed 30 bit lengths to be specified, effectively "
7464 "limiting the maximum size of files created through that call to 1GB."
7468 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:969
7470 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7471 "commands which create a file in the host and attach it as a device."
7475 #: ../src/guestfs-actions.pod:1466
7476 msgid "(Added in 1.3.17)"
7480 #: ../src/guestfs-actions.pod:1468
7481 msgid "guestfs_fgrep"
7485 #: ../src/guestfs-actions.pod:1470
7489 " guestfs_fgrep (guestfs_h *g,\n"
7490 " const char *pattern,\n"
7491 " const char *path);\n"
7496 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:977
7497 msgid "This calls the external C<fgrep> program and returns the matching lines."
7501 #: ../src/guestfs-actions.pod:1487
7502 msgid "guestfs_fgrepi"
7506 #: ../src/guestfs-actions.pod:1489
7510 " guestfs_fgrepi (guestfs_h *g,\n"
7511 " const char *pattern,\n"
7512 " const char *path);\n"
7517 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:987
7518 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7522 #: ../src/guestfs-actions.pod:1506
7523 msgid "guestfs_file"
7527 #: ../src/guestfs-actions.pod:1508
7531 " guestfs_file (guestfs_h *g,\n"
7532 " const char *path);\n"
7537 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:997
7539 "This call uses the standard L<file(1)> command to determine the type or "
7540 "contents of the file."
7544 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1000
7546 "This call will also transparently look inside various types of compressed "
7551 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1003
7553 "The exact command which runs is C<file -zb path>. Note in particular that "
7554 "the filename is not prepended to the output (the C<-b> option)."
7558 #: ../src/guestfs-actions.pod:1522
7560 "This command can also be used on C</dev/> devices (and partitions, LV "
7561 "names). You can for example use this to determine if a device contains a "
7562 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7566 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1012
7568 "If the C<path> does not begin with C</dev/> then this command only works for "
7569 "the content of regular files. For other file types (directory, symbolic "
7570 "link etc) it will just return the string C<directory> etc."
7574 #: ../src/guestfs-actions.pod:1537
7575 msgid "guestfs_file_architecture"
7579 #: ../src/guestfs-actions.pod:1539
7583 " guestfs_file_architecture (guestfs_h *g,\n"
7584 " const char *filename);\n"
7589 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1021
7591 "This detects the architecture of the binary C<filename>, and returns it if "
7596 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
7597 msgid "Currently defined architectures are:"
7601 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1028
7606 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7608 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7609 "irrespective of the precise processor requirements of the binary."
7613 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1033
7618 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
7619 msgid "64 bit x86-64."
7623 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
7628 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
7629 msgid "32 bit SPARC."
7633 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
7638 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
7639 msgid "64 bit SPARC V9 and above."
7643 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
7648 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
7649 msgid "Intel Itanium."
7653 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
7658 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
7659 msgid "32 bit Power PC."
7663 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
7668 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
7669 msgid "64 bit Power PC."
7673 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1059
7674 msgid "Libguestfs may return other architecture strings in future."
7678 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
7679 msgid "The function works on at least the following types of files:"
7683 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1067
7684 msgid "many types of Un*x and Linux binary"
7688 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1071
7689 msgid "many types of Un*x and Linux shared library"
7693 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1075
7694 msgid "Windows Win32 and Win64 binaries"
7698 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1079
7699 msgid "Windows Win32 and Win64 DLLs"
7703 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
7704 msgid "Win32 binaries and DLLs return C<i386>."
7708 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
7709 msgid "Win64 binaries and DLLs return C<x86_64>."
7713 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1087
7714 msgid "Linux kernel modules"
7718 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1091
7719 msgid "Linux new-style initrd images"
7723 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1095
7724 msgid "some non-x86 Linux vmlinuz kernels"
7728 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1099
7729 msgid "What it can't do currently:"
7733 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1105
7734 msgid "static libraries (libfoo.a)"
7738 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1109
7739 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7743 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1113
7744 msgid "x86 Linux vmlinuz kernels"
7748 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
7750 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7751 "compressed code, and are horribly hard to unpack. If you want to find the "
7752 "architecture of a kernel, use the architecture of the associated initrd or "
7753 "kernel module(s) instead."
7757 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:2589 ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2806 ../src/guestfs-actions.pod:2868 ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3173
7758 msgid "(Added in 1.5.3)"
7762 #: ../src/guestfs-actions.pod:1649
7763 msgid "guestfs_filesize"
7767 #: ../src/guestfs-actions.pod:1651
7771 " guestfs_filesize (guestfs_h *g,\n"
7772 " const char *file);\n"
7777 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1126
7778 msgid "This command returns the size of C<file> in bytes."
7782 #: ../src/guestfs-actions.pod:1657
7784 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7785 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7786 "devices, use C<guestfs_blockdev_getsize64>."
7790 #: ../src/guestfs-actions.pod:1663
7791 msgid "(Added in 1.0.82)"
7795 #: ../src/guestfs-actions.pod:1665
7796 msgid "guestfs_fill"
7800 #: ../src/guestfs-actions.pod:1667
7804 " guestfs_fill (guestfs_h *g,\n"
7807 " const char *path);\n"
7812 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1136
7814 "This command creates a new file called C<path>. The initial content of the "
7815 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7820 #: ../src/guestfs-actions.pod:1677
7822 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7823 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7824 "bytes use C<guestfs_fill_pattern>."
7828 #: ../src/guestfs-actions.pod:1689
7829 msgid "(Added in 1.0.79)"
7833 #: ../src/guestfs-actions.pod:1691
7834 msgid "guestfs_fill_pattern"
7838 #: ../src/guestfs-actions.pod:1693
7842 " guestfs_fill_pattern (guestfs_h *g,\n"
7843 " const char *pattern,\n"
7845 " const char *path);\n"
7850 #: ../src/guestfs-actions.pod:1699
7852 "This function is like C<guestfs_fill> except that it creates a new file of "
7853 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7854 "pattern is truncated if necessary to ensure the length of the file is "
7855 "exactly C<len> bytes."
7859 #: ../src/guestfs-actions.pod:1711
7860 msgid "(Added in 1.3.12)"
7864 #: ../src/guestfs-actions.pod:1713
7865 msgid "guestfs_find"
7869 #: ../src/guestfs-actions.pod:1715
7873 " guestfs_find (guestfs_h *g,\n"
7874 " const char *directory);\n"
7879 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1158
7881 "This command lists out all files and directories, recursively, starting at "
7882 "C<directory>. It is essentially equivalent to running the shell command "
7883 "C<find directory -print> but some post-processing happens on the output, "
7888 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1163
7890 "This returns a list of strings I<without any prefix>. Thus if the directory "
7895 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1166
7905 #: ../src/guestfs-actions.pod:1731
7906 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7910 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1173
7921 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1178
7922 msgid "If C<directory> is not a directory, then this command returns an error."
7926 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1181
7927 msgid "The returned list is sorted."
7931 #: ../src/guestfs-actions.pod:1744
7932 msgid "See also C<guestfs_find0>."
7936 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:5391
7937 msgid "(Added in 1.0.27)"
7941 #: ../src/guestfs-actions.pod:1755
7942 msgid "guestfs_find0"
7946 #: ../src/guestfs-actions.pod:1757
7950 " guestfs_find0 (guestfs_h *g,\n"
7951 " const char *directory,\n"
7952 " const char *files);\n"
7957 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1192
7959 "This command lists out all files and directories, recursively, starting at "
7960 "C<directory>, placing the resulting list in the external file called "
7965 #: ../src/guestfs-actions.pod:1766
7967 "This command works the same way as C<guestfs_find> with the following "
7972 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1203
7973 msgid "The resulting list is written to an external file."
7977 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1207
7979 "Items (filenames) in the result are separated by C<\\0> characters. See "
7980 "L<find(1)> option I<-print0>."
7984 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1212
7985 msgid "This command is not limited in the number of names that it can return."
7989 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1217
7990 msgid "The result list is not sorted."
7994 #: ../src/guestfs-actions.pod:1793
7995 msgid "(Added in 1.0.74)"
7999 #: ../src/guestfs-actions.pod:1795
8000 msgid "guestfs_findfs_label"
8004 #: ../src/guestfs-actions.pod:1797
8008 " guestfs_findfs_label (guestfs_h *g,\n"
8009 " const char *label);\n"
8014 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1227
8016 "This command searches the filesystems and returns the one which has the "
8017 "given label. An error is returned if no such filesystem can be found."
8021 #: ../src/guestfs-actions.pod:1805
8022 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8026 #: ../src/guestfs-actions.pod:1812
8027 msgid "guestfs_findfs_uuid"
8031 #: ../src/guestfs-actions.pod:1814
8035 " guestfs_findfs_uuid (guestfs_h *g,\n"
8036 " const char *uuid);\n"
8041 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1237
8043 "This command searches the filesystems and returns the one which has the "
8044 "given UUID. An error is returned if no such filesystem can be found."
8048 #: ../src/guestfs-actions.pod:1822
8049 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8053 #: ../src/guestfs-actions.pod:1829
8054 msgid "guestfs_fsck"
8058 #: ../src/guestfs-actions.pod:1831
8062 " guestfs_fsck (guestfs_h *g,\n"
8063 " const char *fstype,\n"
8064 " const char *device);\n"
8069 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1247
8071 "This runs the filesystem checker (fsck) on C<device> which should have "
8072 "filesystem type C<fstype>."
8076 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1250
8078 "The returned integer is the status. See L<fsck(8)> for the list of status "
8079 "codes from C<fsck>."
8083 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1259
8084 msgid "Multiple status codes can be summed together."
8088 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1263
8090 "A non-zero return code can mean \"success\", for example if errors have been "
8091 "corrected on the filesystem."
8095 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1268
8096 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8100 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1273
8101 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8105 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:7038
8106 msgid "(Added in 1.0.16)"
8110 #: ../src/guestfs-actions.pod:1868
8111 msgid "guestfs_get_append"
8115 #: ../src/guestfs-actions.pod:1870
8119 " guestfs_get_append (guestfs_h *g);\n"
8124 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1279
8126 "Return the additional kernel options which are added to the guest kernel "
8131 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1282
8132 msgid "If C<NULL> then no options are added."
8136 #: ../src/guestfs-actions.pod:1878
8138 "This function returns a string which may be NULL. There is no way to return "
8139 "an error from this function. The string is owned by the guest handle and "
8140 "must I<not> be freed."
8144 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:5069 ../src/guestfs-actions.pod:5532 ../src/guestfs-actions.pod:5900 ../src/guestfs-actions.pod:5919 ../src/guestfs-actions.pod:5935 ../src/guestfs-actions.pod:5952 ../src/guestfs-actions.pod:6709 ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:7081
8145 msgid "(Added in 1.0.26)"
8149 #: ../src/guestfs-actions.pod:1884
8150 msgid "guestfs_get_autosync"
8154 #: ../src/guestfs-actions.pod:1886
8158 " guestfs_get_autosync (guestfs_h *g);\n"
8163 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
8164 msgid "Get the autosync flag."
8168 #: ../src/guestfs-actions.pod:1895
8169 msgid "guestfs_get_direct"
8173 #: ../src/guestfs-actions.pod:1897
8177 " guestfs_get_direct (guestfs_h *g);\n"
8182 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1294
8183 msgid "Return the direct appliance mode flag."
8187 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5573
8188 msgid "(Added in 1.0.72)"
8192 #: ../src/guestfs-actions.pod:1906
8193 msgid "guestfs_get_e2label"
8197 #: ../src/guestfs-actions.pod:1908
8201 " guestfs_get_e2label (guestfs_h *g,\n"
8202 " const char *device);\n"
8207 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1300
8208 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8212 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1303
8214 "This function is deprecated. In new code, use the C<vfs_label> call "
8219 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:5591 ../src/guestfs-actions.pod:5610
8220 msgid "(Added in 1.0.15)"
8224 #: ../src/guestfs-actions.pod:1927
8225 msgid "guestfs_get_e2uuid"
8229 #: ../src/guestfs-actions.pod:1929
8233 " guestfs_get_e2uuid (guestfs_h *g,\n"
8234 " const char *device);\n"
8239 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1314
8240 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8244 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1317
8245 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
8249 #: ../src/guestfs-actions.pod:1948
8250 msgid "guestfs_get_memsize"
8254 #: ../src/guestfs-actions.pod:1950
8258 " guestfs_get_memsize (guestfs_h *g);\n"
8263 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1328
8264 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8268 #: ../src/guestfs-actions.pod:1956
8270 "If C<guestfs_set_memsize> was not called on this handle, and if "
8271 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8272 "value for memsize."
8276 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:5626 ../src/guestfs-actions.pod:5733 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:1386 ../fish/guestfish-actions.pod:3753 ../fish/guestfish-actions.pod:3840
8277 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8281 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4153 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:5294 ../src/guestfs-actions.pod:5631 ../src/guestfs-actions.pod:5874 ../src/guestfs-actions.pod:6475
8282 msgid "(Added in 1.0.55)"
8286 #: ../src/guestfs-actions.pod:1967
8287 msgid "guestfs_get_network"
8291 #: ../src/guestfs-actions.pod:1969
8295 " guestfs_get_network (guestfs_h *g);\n"
8300 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1342
8301 msgid "This returns the enable network flag."
8305 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5650
8306 msgid "(Added in 1.5.4)"
8310 #: ../src/guestfs-actions.pod:1978
8311 msgid "guestfs_get_path"
8315 #: ../src/guestfs-actions.pod:1980
8319 " guestfs_get_path (guestfs_h *g);\n"
8324 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1348
8325 msgid "Return the current search path."
8329 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
8331 "This is always non-NULL. If it wasn't set already, then this will return "
8336 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
8338 "This function returns a string, or NULL on error. The string is owned by "
8339 "the guest handle and must I<not> be freed."
8343 #: ../src/guestfs-actions.pod:1993
8344 msgid "guestfs_get_pid"
8348 #: ../src/guestfs-actions.pod:1995
8352 " guestfs_get_pid (guestfs_h *g);\n"
8357 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1359
8359 "Return the process ID of the qemu subprocess. If there is no qemu "
8360 "subprocess, then this will return an error."
8364 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1362
8365 msgid "This is an internal call used for debugging and testing."
8369 #: ../src/guestfs-actions.pod:2005
8370 msgid "(Added in 1.0.56)"
8374 #: ../src/guestfs-actions.pod:2007
8375 msgid "guestfs_get_qemu"
8379 #: ../src/guestfs-actions.pod:2009
8383 " guestfs_get_qemu (guestfs_h *g);\n"
8388 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1368
8389 msgid "Return the current qemu binary."
8393 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
8395 "This is always non-NULL. If it wasn't set already, then this will return "
8396 "the default qemu binary name."
8400 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5695
8401 msgid "(Added in 1.0.6)"
8405 #: ../src/guestfs-actions.pod:2022
8406 msgid "guestfs_get_recovery_proc"
8410 #: ../src/guestfs-actions.pod:2024
8414 " guestfs_get_recovery_proc (guestfs_h *g);\n"
8419 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
8420 msgid "Return the recovery process enabled flag."
8424 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3263 ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6398 ../src/guestfs-actions.pod:6590
8425 msgid "(Added in 1.0.77)"
8429 #: ../src/guestfs-actions.pod:2033
8430 msgid "guestfs_get_selinux"
8434 #: ../src/guestfs-actions.pod:2035
8438 " guestfs_get_selinux (guestfs_h *g);\n"
8443 #: ../src/guestfs-actions.pod:2038
8445 "This returns the current setting of the selinux flag which is passed to the "
8446 "appliance at boot time. See C<guestfs_set_selinux>."
8450 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109 ../src/guestfs-actions.pod:5738 ../src/guestfs-actions.pod:5792
8451 msgid "(Added in 1.0.67)"
8455 #: ../src/guestfs-actions.pod:2048
8456 msgid "guestfs_get_state"
8460 #: ../src/guestfs-actions.pod:2050
8464 " guestfs_get_state (guestfs_h *g);\n"
8469 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1393
8471 "This returns the current state as an opaque integer. This is only useful "
8472 "for printing debug and internal error messages."
8476 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3066 ../src/guestfs-actions.pod:3095 ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:1396 ../fish/guestfish-actions.pod:2135 ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2191 ../fish/guestfish-actions.pod:2207
8477 msgid "For more information on states, see L<guestfs(3)>."
8481 #: ../src/guestfs-actions.pod:2062
8482 msgid "guestfs_get_trace"
8486 #: ../src/guestfs-actions.pod:2064
8490 " guestfs_get_trace (guestfs_h *g);\n"
8495 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1402
8496 msgid "Return the command trace flag."
8500 #: ../src/guestfs-actions.pod:2073
8501 msgid "guestfs_get_umask"
8505 #: ../src/guestfs-actions.pod:2075
8509 " guestfs_get_umask (guestfs_h *g);\n"
8514 #: ../src/guestfs-actions.pod:2078
8516 "Return the current umask. By default the umask is C<022> unless it has been "
8517 "set by calling C<guestfs_umask>."
8521 #: ../src/guestfs-actions.pod:2085
8522 msgid "guestfs_get_verbose"
8526 #: ../src/guestfs-actions.pod:2087
8530 " guestfs_get_verbose (guestfs_h *g);\n"
8535 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
8536 msgid "This returns the verbose messages flag."
8540 #: ../src/guestfs-actions.pod:2096
8541 msgid "guestfs_getcon"
8545 #: ../src/guestfs-actions.pod:2098
8549 " guestfs_getcon (guestfs_h *g);\n"
8554 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1421
8555 msgid "This gets the SELinux security context of the daemon."
8559 #: ../src/guestfs-actions.pod:2103
8560 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8564 #: ../src/guestfs-actions.pod:2111
8565 msgid "guestfs_getxattr"
8569 #: ../src/guestfs-actions.pod:2113
8573 " guestfs_getxattr (guestfs_h *g,\n"
8574 " const char *path,\n"
8575 " const char *name,\n"
8576 " size_t *size_r);\n"
8581 #: ../src/guestfs-actions.pod:2119
8583 "Get a single extended attribute from file C<path> named C<name>. This call "
8584 "follows symlinks. If you want to lookup an extended attribute for the "
8585 "symlink itself, use C<guestfs_lgetxattr>."
8589 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:3277
8591 "Normally it is better to get all extended attributes from a file in one go "
8592 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
8593 "implementations are buggy and do not provide a way to list out attributes. "
8594 "For these filesystems (notably ntfs-3g) you have to know the names of the "
8595 "extended attributes you want in advance and call this function."
8599 #: ../src/guestfs-actions.pod:2130 ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:1441 ../fish/guestfish-actions.pod:2272
8601 "Extended attribute values are blobs of binary data. If there is no extended "
8602 "attribute named C<name>, this returns an error."
8606 #: ../src/guestfs-actions.pod:2133
8607 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
8611 #: ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:4992 ../src/guestfs-actions.pod:5018 ../src/guestfs-actions.pod:5199
8613 "This function returns a buffer, or NULL on error. The size of the returned "
8614 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8619 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:3293
8620 msgid "(Added in 1.7.24)"
8624 #: ../src/guestfs-actions.pod:2141
8625 msgid "guestfs_getxattrs"
8629 #: ../src/guestfs-actions.pod:2143
8632 " struct guestfs_xattr_list *\n"
8633 " guestfs_getxattrs (guestfs_h *g,\n"
8634 " const char *path);\n"
8639 #: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1450
8640 msgid "This call lists the extended attributes of the file or directory C<path>."
8644 #: ../src/guestfs-actions.pod:2150 ../fish/guestfish-actions.pod:1453
8646 "At the system call level, this is a combination of the L<listxattr(2)> and "
8647 "L<getxattr(2)> calls."
8651 #: ../src/guestfs-actions.pod:2153
8652 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8656 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3305 ../src/guestfs-actions.pod:3956
8658 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8659 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8663 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3309 ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:5372 ../src/guestfs-actions.pod:5811 ../src/guestfs-actions.pod:7146
8664 msgid "(Added in 1.0.59)"
8668 #: ../src/guestfs-actions.pod:2161
8669 msgid "guestfs_glob_expand"
8673 #: ../src/guestfs-actions.pod:2163
8677 " guestfs_glob_expand (guestfs_h *g,\n"
8678 " const char *pattern);\n"
8683 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1462
8685 "This command searches for all the pathnames matching C<pattern> according to "
8686 "the wildcard expansion rules used by the shell."
8690 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1466
8691 msgid "If no paths match, then this returns an empty list (note: not an error)."
8695 #: ../src/guestfs-actions.pod:2174 ../fish/guestfish-actions.pod:1469
8697 "It is just a wrapper around the C L<glob(3)> function with flags "
8698 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8702 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:5976 ../src/guestfs-actions.pod:5993
8703 msgid "(Added in 1.0.50)"
8707 #: ../src/guestfs-actions.pod:2184
8708 msgid "guestfs_grep"
8712 #: ../src/guestfs-actions.pod:2186
8716 " guestfs_grep (guestfs_h *g,\n"
8717 " const char *regex,\n"
8718 " const char *path);\n"
8723 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1477
8724 msgid "This calls the external C<grep> program and returns the matching lines."
8728 #: ../src/guestfs-actions.pod:2203
8729 msgid "guestfs_grepi"
8733 #: ../src/guestfs-actions.pod:2205
8737 " guestfs_grepi (guestfs_h *g,\n"
8738 " const char *regex,\n"
8739 " const char *path);\n"
8744 #: ../src/guestfs-actions.pod:2210 ../fish/guestfish-actions.pod:1487
8745 msgid "This calls the external C<grep -i> program and returns the matching lines."
8749 #: ../src/guestfs-actions.pod:2222
8750 msgid "guestfs_grub_install"
8754 #: ../src/guestfs-actions.pod:2224
8758 " guestfs_grub_install (guestfs_h *g,\n"
8759 " const char *root,\n"
8760 " const char *device);\n"
8765 #: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1497
8767 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8768 "the root directory being C<root>."
8772 #: ../src/guestfs-actions.pod:2232 ../fish/guestfish-actions.pod:1500
8774 "Note: If grub-install reports the error \"No suitable drive was found in the "
8775 "generated device map.\" it may be that you need to create a "
8776 "C</boot/grub/device.map> file first that contains the mapping between grub "
8777 "device names and Linux device names. It is usually sufficient to create a "
8782 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1507
8790 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1509
8791 msgid "replacing C</dev/vda> with the name of the installation device."
8795 #: ../src/guestfs-actions.pod:2245
8796 msgid "(Added in 1.0.17)"
8800 #: ../src/guestfs-actions.pod:2247
8801 msgid "guestfs_head"
8805 #: ../src/guestfs-actions.pod:2249
8809 " guestfs_head (guestfs_h *g,\n"
8810 " const char *path);\n"
8815 #: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1515
8817 "This command returns up to the first 10 lines of a file as a list of "
8822 #: ../src/guestfs-actions.pod:2265
8823 msgid "guestfs_head_n"
8827 #: ../src/guestfs-actions.pod:2267
8831 " guestfs_head_n (guestfs_h *g,\n"
8833 " const char *path);\n"
8838 #: ../src/guestfs-actions.pod:2272 ../fish/guestfish-actions.pod:1525
8840 "If the parameter C<nrlines> is a positive number, this returns the first "
8841 "C<nrlines> lines of the file C<path>."
8845 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish-actions.pod:1528
8847 "If the parameter C<nrlines> is a negative number, this returns lines from "
8848 "the file C<path>, excluding the last C<nrlines> lines."
8852 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6273 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:4186
8853 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8857 #: ../src/guestfs-actions.pod:2289
8858 msgid "guestfs_hexdump"
8862 #: ../src/guestfs-actions.pod:2291
8866 " guestfs_hexdump (guestfs_h *g,\n"
8867 " const char *path);\n"
8872 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1540
8874 "This runs C<hexdump -C> on the given C<path>. The result is the "
8875 "human-readable, canonical hex dump of the file."
8879 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6112
8880 msgid "(Added in 1.0.22)"
8884 #: ../src/guestfs-actions.pod:2306
8885 msgid "guestfs_initrd_cat"
8889 #: ../src/guestfs-actions.pod:2308
8893 " guestfs_initrd_cat (guestfs_h *g,\n"
8894 " const char *initrdpath,\n"
8895 " const char *filename,\n"
8896 " size_t *size_r);\n"
8901 #: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1550
8903 "This command unpacks the file C<filename> from the initrd file called "
8904 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8909 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1554
8911 "For example, in guestfish you could use the following command to examine the "
8912 "boot script (usually called C</init>) contained in a Linux initrd or "
8917 #: ../src/guestfs-actions.pod:2322 ../fish/guestfish-actions.pod:1558
8920 " initrd-cat /boot/initrd-<version>.img init\n"
8925 #: ../src/guestfs-actions.pod:2324
8926 msgid "See also C<guestfs_initrd_list>."
8930 #: ../src/guestfs-actions.pod:2335
8931 msgid "guestfs_initrd_list"
8935 #: ../src/guestfs-actions.pod:2337
8939 " guestfs_initrd_list (guestfs_h *g,\n"
8940 " const char *path);\n"
8945 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1569
8946 msgid "This command lists out files contained in an initrd."
8950 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1571
8952 "The files are listed without any initial C</> character. The files are "
8953 "listed in the order they appear (not necessarily alphabetical). Directory "
8954 "names are listed as separate items."
8958 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1575
8960 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8961 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8966 #: ../src/guestfs-actions.pod:2357
8967 msgid "guestfs_inotify_add_watch"
8971 #: ../src/guestfs-actions.pod:2359
8975 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8976 " const char *path,\n"
8982 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1583
8983 msgid "Watch C<path> for the events listed in C<mask>."
8987 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1585
8989 "Note that if C<path> is a directory then events within that directory are "
8990 "watched, but this does I<not> happen recursively (in subdirectories)."
8994 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1589
8996 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8997 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9001 #: ../src/guestfs-actions.pod:2378
9002 msgid "guestfs_inotify_close"
9006 #: ../src/guestfs-actions.pod:2380
9010 " guestfs_inotify_close (guestfs_h *g);\n"
9015 #: ../src/guestfs-actions.pod:2383 ../fish/guestfish-actions.pod:1597
9017 "This closes the inotify handle which was previously opened by inotify_init. "
9018 "It removes all watches, throws away any pending events, and deallocates all "
9023 #: ../src/guestfs-actions.pod:2391
9024 msgid "guestfs_inotify_files"
9028 #: ../src/guestfs-actions.pod:2393
9032 " guestfs_inotify_files (guestfs_h *g);\n"
9037 #: ../src/guestfs-actions.pod:2396
9039 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9040 "returns a list of pathnames of objects that were touched. The returned "
9041 "pathnames are sorted and deduplicated."
9045 #: ../src/guestfs-actions.pod:2406
9046 msgid "guestfs_inotify_init"
9050 #: ../src/guestfs-actions.pod:2408
9054 " guestfs_inotify_init (guestfs_h *g,\n"
9055 " int maxevents);\n"
9060 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1613
9062 "This command creates a new inotify handle. The inotify subsystem can be "
9063 "used to notify events which happen to objects in the guest filesystem."
9067 #: ../src/guestfs-actions.pod:2416
9069 "C<maxevents> is the maximum number of events which will be queued up between "
9070 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9071 "passed as C<0>, then the kernel (or previously set) default is used. For "
9072 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9073 "throws away events, but records the fact that it threw them away by setting "
9074 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9075 "C<guestfs_inotify_read>)."
9079 #: ../src/guestfs-actions.pod:2426
9081 "Before any events are generated, you have to add some watches to the "
9082 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9083 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9087 #: ../src/guestfs-actions.pod:2432
9089 "Queued up events should be read periodically by calling "
9090 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9091 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9092 "often enough then you risk the internal queue overflowing."
9096 #: ../src/guestfs-actions.pod:2439
9098 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9099 "This also removes any watches automatically."
9103 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1644
9105 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9106 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9107 "that there is one global inotify handle per libguestfs instance."
9111 #: ../src/guestfs-actions.pod:2452
9112 msgid "guestfs_inotify_read"
9116 #: ../src/guestfs-actions.pod:2454
9119 " struct guestfs_inotify_event_list *\n"
9120 " guestfs_inotify_read (guestfs_h *g);\n"
9125 #: ../src/guestfs-actions.pod:2457 ../fish/guestfish-actions.pod:1653
9127 "Return the complete queue of events that have happened since the previous "
9132 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1656
9133 msgid "If no events have happened, this returns an empty list."
9137 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1658
9139 "I<Note>: In order to make sure that all events have been read, you must call "
9140 "this function repeatedly until it returns an empty list. The reason is that "
9141 "the call will read events up to the maximum appliance-to-host message size "
9142 "and leave remaining events in the queue."
9146 #: ../src/guestfs-actions.pod:2468
9148 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9149 "there was an error. I<The caller must call "
9150 "C<guestfs_free_inotify_event_list> after use>."
9154 #: ../src/guestfs-actions.pod:2474
9155 msgid "guestfs_inotify_rm_watch"
9159 #: ../src/guestfs-actions.pod:2476
9163 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9169 #: ../src/guestfs-actions.pod:2480
9171 "Remove a previously defined inotify watch. See "
9172 "C<guestfs_inotify_add_watch>."
9176 #: ../src/guestfs-actions.pod:2487
9177 msgid "guestfs_inspect_get_arch"
9181 #: ../src/guestfs-actions.pod:2489
9185 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9186 " const char *root);\n"
9191 #: ../src/guestfs-actions.pod:2493 ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2645 ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2759 ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2834 ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2899
9193 "This function should only be called with a root device string as returned by "
9194 "C<guestfs_inspect_os>."
9198 #: ../src/guestfs-actions.pod:2496
9200 "This returns the architecture of the inspected operating system. The "
9201 "possible return values are listed under C<guestfs_file_architecture>."
9205 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1682
9207 "If the architecture could not be determined, then the string C<unknown> is "
9212 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:2584 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2777 ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:2820 ../src/guestfs-actions.pod:2863 ../src/guestfs-actions.pod:2886 ../src/guestfs-actions.pod:2992 ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1792 ../fish/guestfish-actions.pod:1813 ../fish/guestfish-actions.pod:1877 ../fish/guestfish-actions.pod:1901 ../fish/guestfish-actions.pod:1918 ../fish/guestfish-actions.pod:1931 ../fish/guestfish-actions.pod:1966 ../fish/guestfish-actions.pod:1982 ../fish/guestfish-actions.pod:2081 ../fish/guestfish-actions.pod:2115
9213 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9217 #: ../src/guestfs-actions.pod:2510
9218 msgid "guestfs_inspect_get_distro"
9222 #: ../src/guestfs-actions.pod:2512
9226 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9227 " const char *root);\n"
9232 #: ../src/guestfs-actions.pod:2519 ../fish/guestfish-actions.pod:1694
9233 msgid "This returns the distro (distribution) of the inspected operating system."
9237 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1697
9238 msgid "Currently defined distros are:"
9242 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1701
9243 msgid "\"archlinux\""
9247 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1703
9252 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1705
9257 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1707
9262 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1709
9267 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1711
9272 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1713
9277 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1715
9282 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1717
9283 msgid "\"linuxmint\""
9287 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1719
9292 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1721
9293 msgid "\"mandriva\""
9297 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1723
9302 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1725
9307 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1727
9312 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1729
9317 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1731
9322 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1733
9323 msgid "\"redhat-based\""
9327 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1735
9328 msgid "Some Red Hat-derived distro."
9332 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1737
9337 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1739
9338 msgid "Red Hat Enterprise Linux and some derivatives."
9342 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1741
9347 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1743
9352 #: ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2854 ../fish/guestfish-actions.pod:1745 ../fish/guestfish-actions.pod:1957
9357 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1747
9358 msgid "The distro could not be determined."
9362 #: ../src/guestfs-actions.pod:2574 ../src/guestfs-actions.pod:2846 ../fish/guestfish-actions.pod:1749 ../fish/guestfish-actions.pod:1949
9367 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1751
9369 "Windows does not have distributions. This string is returned if the OS type "
9374 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1756 ../fish/guestfish-actions.pod:1963
9376 "Future versions of libguestfs may return other strings here. The caller "
9377 "should be prepared to handle any string."
9381 #: ../src/guestfs-actions.pod:2591
9382 msgid "guestfs_inspect_get_filesystems"
9386 #: ../src/guestfs-actions.pod:2593
9390 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9391 " const char *root);\n"
9396 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1768
9398 "This returns a list of all the filesystems that we think are associated with "
9399 "this operating system. This includes the root filesystem, other ordinary "
9400 "filesystems, and non-mounted devices like swap partitions."
9404 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1773
9406 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9407 "to be shared between operating systems."
9411 #: ../src/guestfs-actions.pod:2608
9413 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9414 "C<guestfs_inspect_get_mountpoints>."
9418 #: ../src/guestfs-actions.pod:2617
9419 msgid "guestfs_inspect_get_hostname"
9423 #: ../src/guestfs-actions.pod:2619
9427 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
9428 " const char *root);\n"
9433 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1786
9435 "This function returns the hostname of the operating system as found by "
9436 "inspection of the guest's configuration files."
9440 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1789
9442 "If the hostname could not be determined, then the string C<unknown> is "
9447 #: ../src/guestfs-actions.pod:2637
9448 msgid "(Added in 1.7.9)"
9452 #: ../src/guestfs-actions.pod:2639
9453 msgid "guestfs_inspect_get_major_version"
9457 #: ../src/guestfs-actions.pod:2641
9461 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
9462 " const char *root);\n"
9467 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1801
9468 msgid "This returns the major version number of the inspected operating system."
9472 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1804
9474 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9475 "popular public names used by the operating system. Notably the operating "
9476 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9477 "1). You can find out the real versions corresponding to releases of Windows "
9478 "by consulting Wikipedia or MSDN."
9482 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1825
9483 msgid "If the version could not be determined, then C<0> is returned."
9487 #: ../src/guestfs-actions.pod:2666
9488 msgid "guestfs_inspect_get_minor_version"
9492 #: ../src/guestfs-actions.pod:2668
9496 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9497 " const char *root);\n"
9502 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1822
9503 msgid "This returns the minor version number of the inspected operating system."
9507 #: ../src/guestfs-actions.pod:2680
9509 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9510 "C<guestfs_inspect_get_major_version>."
9514 #: ../src/guestfs-actions.pod:2687
9515 msgid "guestfs_inspect_get_mountpoints"
9519 #: ../src/guestfs-actions.pod:2689
9523 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9524 " const char *root);\n"
9529 #: ../src/guestfs-actions.pod:2696 ../fish/guestfish-actions.pod:1837
9531 "This returns a hash of where we think the filesystems associated with this "
9532 "operating system should be mounted. Callers should note that this is at "
9533 "best an educated guess made by reading configuration files such as "
9534 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
9535 "are non-existent or not mountable and callers should be prepared to handle "
9536 "or ignore failures if they try to mount them."
9540 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1846
9542 "Each element in the returned hashtable has a key which is the path of the "
9543 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9544 "mounted there (eg. C</dev/sda1>)."
9548 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1851
9549 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9553 #: ../src/guestfs-actions.pod:2713
9555 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9556 "C<guestfs_inspect_get_filesystems>."
9560 #: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:3362 ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:6414
9562 "This function returns a NULL-terminated array of strings, or NULL if there "
9563 "was an error. The array of strings will always have length C<2n+1>, where "
9564 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9565 "caller must free the strings and the array after use>."
9569 #: ../src/guestfs-actions.pod:2724
9570 msgid "guestfs_inspect_get_package_format"
9574 #: ../src/guestfs-actions.pod:2726
9578 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9579 " const char *root);\n"
9584 #: ../src/guestfs-actions.pod:2733
9586 "This function and C<guestfs_inspect_get_package_management> return the "
9587 "package format and package management tool used by the inspected operating "
9588 "system. For example for Fedora these functions would return C<rpm> (package "
9589 "format) and C<yum> (package management)."
9593 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1870
9595 "This returns the string C<unknown> if we could not determine the package "
9596 "format I<or> if the operating system does not have a real packaging system "
9601 #: ../src/guestfs-actions.pod:2743 ../fish/guestfish-actions.pod:1874
9603 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9604 "Future versions of libguestfs may return other strings."
9608 #: ../src/guestfs-actions.pod:2751 ../src/guestfs-actions.pod:2782
9609 msgid "(Added in 1.7.5)"
9613 #: ../src/guestfs-actions.pod:2753
9614 msgid "guestfs_inspect_get_package_management"
9618 #: ../src/guestfs-actions.pod:2755
9622 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9623 " const char *root);\n"
9628 #: ../src/guestfs-actions.pod:2762
9630 "C<guestfs_inspect_get_package_format> and this function return the package "
9631 "format and package management tool used by the inspected operating system. "
9632 "For example for Fedora these functions would return C<rpm> (package format) "
9633 "and C<yum> (package management)."
9637 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1892
9639 "This returns the string C<unknown> if we could not determine the package "
9640 "management tool I<or> if the operating system does not have a real packaging "
9641 "system (eg. Windows)."
9645 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1896
9647 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9648 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9649 "libguestfs may return other strings."
9653 #: ../src/guestfs-actions.pod:2784
9654 msgid "guestfs_inspect_get_product_name"
9658 #: ../src/guestfs-actions.pod:2786
9662 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9663 " const char *root);\n"
9668 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1910
9670 "This returns the product name of the inspected operating system. The "
9671 "product name is generally some freeform string which can be displayed to the "
9672 "user, but should not be parsed by programs."
9676 #: ../src/guestfs-actions.pod:2798 ../fish/guestfish-actions.pod:1915
9678 "If the product name could not be determined, then the string C<unknown> is "
9683 #: ../src/guestfs-actions.pod:2808
9684 msgid "guestfs_inspect_get_roots"
9688 #: ../src/guestfs-actions.pod:2810
9692 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9697 #: ../src/guestfs-actions.pod:2813
9699 "This function is a convenient way to get the list of root devices, as "
9700 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9701 "the whole inspection process."
9705 #: ../src/guestfs-actions.pod:2817
9707 "This returns an empty list if either no root devices were found or the "
9708 "caller has not called C<guestfs_inspect_os>."
9712 #: ../src/guestfs-actions.pod:2826
9713 msgid "(Added in 1.7.3)"
9717 #: ../src/guestfs-actions.pod:2828
9718 msgid "guestfs_inspect_get_type"
9722 #: ../src/guestfs-actions.pod:2830
9726 " guestfs_inspect_get_type (guestfs_h *g,\n"
9727 " const char *root);\n"
9732 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1940
9734 "This returns the type of the inspected operating system. Currently defined "
9739 #: ../src/guestfs-actions.pod:2842 ../fish/guestfish-actions.pod:1945
9744 #: ../src/guestfs-actions.pod:2844 ../fish/guestfish-actions.pod:1947
9745 msgid "Any Linux-based operating system."
9749 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1951
9750 msgid "Any Microsoft Windows operating system."
9754 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1953
9759 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1955
9764 #: ../src/guestfs-actions.pod:2856 ../fish/guestfish-actions.pod:1959
9765 msgid "The operating system type could not be determined."
9769 #: ../src/guestfs-actions.pod:2870
9770 msgid "guestfs_inspect_get_windows_systemroot"
9774 #: ../src/guestfs-actions.pod:2872
9778 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9779 " const char *root);\n"
9784 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1975
9786 "This returns the Windows systemroot of the inspected guest. The systemroot "
9787 "is a directory path such as C</WINDOWS>."
9791 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1978
9793 "This call assumes that the guest is Windows and that the systemroot could be "
9794 "determined by inspection. If this is not the case then an error is "
9799 #: ../src/guestfs-actions.pod:2891
9800 msgid "(Added in 1.5.25)"
9804 #: ../src/guestfs-actions.pod:2893
9805 msgid "guestfs_inspect_list_applications"
9809 #: ../src/guestfs-actions.pod:2895
9812 " struct guestfs_application_list *\n"
9813 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9814 " const char *root);\n"
9819 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:1991
9820 msgid "Return the list of applications installed in the operating system."
9824 #: ../src/guestfs-actions.pod:2904
9826 "I<Note:> This call works differently from other parts of the inspection "
9827 "API. You have to call C<guestfs_inspect_os>, then "
9828 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9829 "this. Listing applications is a significantly more difficult operation "
9830 "which requires access to the full filesystem. Also note that unlike the "
9831 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9832 "the libguestfs handle, this call actually reads parts of the mounted "
9833 "filesystems during the call."
9837 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2003
9839 "This returns an empty list if the inspection code was not able to determine "
9840 "the list of applications."
9844 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2006
9845 msgid "The application structure contains the following fields:"
9849 #: ../src/guestfs-actions.pod:2921 ../fish/guestfish-actions.pod:2010
9854 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2012
9856 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9857 "guests, this is the package name."
9861 #: ../src/guestfs-actions.pod:2926 ../fish/guestfish-actions.pod:2015
9862 msgid "C<app_display_name>"
9866 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2017
9868 "The display name of the application, sometimes localized to the install "
9869 "language of the guest operating system."
9873 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2020
9875 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9876 "to display something can use C<app_name> instead."
9880 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2023
9881 msgid "C<app_epoch>"
9885 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2025
9887 "For package managers which use epochs, this contains the epoch of the "
9888 "package (an integer). If unavailable, this is returned as C<0>."
9892 #: ../src/guestfs-actions.pod:2939 ../fish/guestfish-actions.pod:2028
9893 msgid "C<app_version>"
9897 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
9899 "The version string of the application or package. If unavailable this is "
9900 "returned as an empty string C<\"\">."
9904 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2033
9905 msgid "C<app_release>"
9909 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2035
9911 "The release string of the application or package, for package managers that "
9912 "use this. If unavailable this is returned as an empty string C<\"\">."
9916 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2039
9917 msgid "C<app_install_path>"
9921 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2041
9923 "The installation path of the application (on operating systems such as "
9924 "Windows which use installation paths). This path is in the format used by "
9925 "the guest operating system, it is not a libguestfs path."
9929 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2046
9930 msgid "If unavailable this is returned as an empty string C<\"\">."
9934 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2048
9935 msgid "C<app_trans_path>"
9939 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2050
9941 "The install path translated into a libguestfs path. If unavailable this is "
9942 "returned as an empty string C<\"\">."
9946 #: ../src/guestfs-actions.pod:2964 ../fish/guestfish-actions.pod:2053
9947 msgid "C<app_publisher>"
9951 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2055
9953 "The name of the publisher of the application, for package managers that use "
9954 "this. If unavailable this is returned as an empty string C<\"\">."
9958 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2059
9963 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2061
9965 "The URL (eg. upstream URL) of the application. If unavailable this is "
9966 "returned as an empty string C<\"\">."
9970 #: ../src/guestfs-actions.pod:2975 ../fish/guestfish-actions.pod:2064
9971 msgid "C<app_source_package>"
9975 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2066
9977 "For packaging systems which support this, the name of the source package. "
9978 "If unavailable this is returned as an empty string C<\"\">."
9982 #: ../src/guestfs-actions.pod:2980 ../fish/guestfish-actions.pod:2069
9983 msgid "C<app_summary>"
9987 #: ../src/guestfs-actions.pod:2982 ../fish/guestfish-actions.pod:2071
9989 "A short (usually one line) description of the application or package. If "
9990 "unavailable this is returned as an empty string C<\"\">."
9994 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2074
9995 msgid "C<app_description>"
9999 #: ../src/guestfs-actions.pod:2987 ../fish/guestfish-actions.pod:2076
10001 "A longer description of the application or package. If unavailable this is "
10002 "returned as an empty string C<\"\">."
10006 #: ../src/guestfs-actions.pod:2994
10008 "This function returns a C<struct guestfs_application_list *>, or NULL if "
10009 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10014 #: ../src/guestfs-actions.pod:2998
10015 msgid "(Added in 1.7.8)"
10019 #: ../src/guestfs-actions.pod:3000
10020 msgid "guestfs_inspect_os"
10024 #: ../src/guestfs-actions.pod:3002
10028 " guestfs_inspect_os (guestfs_h *g);\n"
10033 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2087
10035 "This function uses other libguestfs functions and certain heuristics to "
10036 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10037 "for operating systems."
10041 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2091
10042 msgid "The list returned is empty if no operating systems were found."
10046 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2093
10048 "If one operating system was found, then this returns a list with a single "
10049 "element, which is the name of the root filesystem of this operating system. "
10050 "It is also possible for this function to return a list containing more than "
10051 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10052 "element being the root filesystem of one of the operating systems."
10056 #: ../src/guestfs-actions.pod:3018
10058 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10059 "functions in order to query further information about each operating system, "
10060 "such as the name and version."
10064 #: ../src/guestfs-actions.pod:3023
10066 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10067 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10068 "the contents. This should be called with no disks currently mounted. The "
10069 "function may also use Augeas, so any existing Augeas handle will be closed."
10073 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2111
10075 "This function cannot decrypt encrypted disks. The caller must do that first "
10076 "(supplying the necessary keys) if the disk is encrypted."
10080 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3382
10081 msgid "See also C<guestfs_list_filesystems>."
10085 #: ../src/guestfs-actions.pod:3043
10086 msgid "guestfs_is_blockdev"
10090 #: ../src/guestfs-actions.pod:3045
10094 " guestfs_is_blockdev (guestfs_h *g,\n"
10095 " const char *path);\n"
10100 #: ../src/guestfs-actions.pod:3049 ../fish/guestfish-actions.pod:2123
10102 "This returns C<true> if and only if there is a block device with the given "
10107 #: ../src/guestfs-actions.pod:3052 ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3126 ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3213
10108 msgid "See also C<guestfs_stat>."
10112 #: ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3202 ../src/guestfs-actions.pod:3217
10113 msgid "(Added in 1.5.10)"
10117 #: ../src/guestfs-actions.pod:3058
10118 msgid "guestfs_is_busy"
10122 #: ../src/guestfs-actions.pod:3060
10126 " guestfs_is_busy (guestfs_h *g);\n"
10131 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2132
10133 "This returns true iff this handle is busy processing a command (in the "
10138 #: ../src/guestfs-actions.pod:3072
10139 msgid "guestfs_is_chardev"
10143 #: ../src/guestfs-actions.pod:3074
10147 " guestfs_is_chardev (guestfs_h *g,\n"
10148 " const char *path);\n"
10153 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2141
10155 "This returns C<true> if and only if there is a character device with the "
10156 "given C<path> name."
10160 #: ../src/guestfs-actions.pod:3087
10161 msgid "guestfs_is_config"
10165 #: ../src/guestfs-actions.pod:3089
10169 " guestfs_is_config (guestfs_h *g);\n"
10174 #: ../src/guestfs-actions.pod:3092 ../fish/guestfish-actions.pod:2150
10176 "This returns true iff this handle is being configured (in the C<CONFIG> "
10181 #: ../src/guestfs-actions.pod:3101
10182 msgid "guestfs_is_dir"
10186 #: ../src/guestfs-actions.pod:3103
10190 " guestfs_is_dir (guestfs_h *g,\n"
10191 " const char *path);\n"
10196 #: ../src/guestfs-actions.pod:3107 ../fish/guestfish-actions.pod:2159
10198 "This returns C<true> if and only if there is a directory with the given "
10199 "C<path> name. Note that it returns false for other objects like files."
10203 #: ../src/guestfs-actions.pod:3117
10204 msgid "guestfs_is_fifo"
10208 #: ../src/guestfs-actions.pod:3119
10212 " guestfs_is_fifo (guestfs_h *g,\n"
10213 " const char *path);\n"
10218 #: ../src/guestfs-actions.pod:3123 ../fish/guestfish-actions.pod:2169
10220 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10221 "given C<path> name."
10225 #: ../src/guestfs-actions.pod:3132
10226 msgid "guestfs_is_file"
10230 #: ../src/guestfs-actions.pod:3134
10234 " guestfs_is_file (guestfs_h *g,\n"
10235 " const char *path);\n"
10240 #: ../src/guestfs-actions.pod:3138 ../fish/guestfish-actions.pod:2178
10242 "This returns C<true> if and only if there is a regular file with the given "
10243 "C<path> name. Note that it returns false for other objects like "
10248 #: ../src/guestfs-actions.pod:3148
10249 msgid "guestfs_is_launching"
10253 #: ../src/guestfs-actions.pod:3150
10257 " guestfs_is_launching (guestfs_h *g);\n"
10262 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2188
10264 "This returns true iff this handle is launching the subprocess (in the "
10265 "C<LAUNCHING> state)."
10269 #: ../src/guestfs-actions.pod:3162
10270 msgid "guestfs_is_lv"
10274 #: ../src/guestfs-actions.pod:3164
10278 " guestfs_is_lv (guestfs_h *g,\n"
10279 " const char *device);\n"
10284 #: ../src/guestfs-actions.pod:3168 ../fish/guestfish-actions.pod:2197
10286 "This command tests whether C<device> is a logical volume, and returns true "
10287 "iff this is the case."
10291 #: ../src/guestfs-actions.pod:3175
10292 msgid "guestfs_is_ready"
10296 #: ../src/guestfs-actions.pod:3177
10300 " guestfs_is_ready (guestfs_h *g);\n"
10305 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2204
10307 "This returns true iff this handle is ready to accept commands (in the "
10312 #: ../src/guestfs-actions.pod:3189
10313 msgid "guestfs_is_socket"
10317 #: ../src/guestfs-actions.pod:3191
10321 " guestfs_is_socket (guestfs_h *g,\n"
10322 " const char *path);\n"
10327 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2213
10329 "This returns C<true> if and only if there is a Unix domain socket with the "
10330 "given C<path> name."
10334 #: ../src/guestfs-actions.pod:3204
10335 msgid "guestfs_is_symlink"
10339 #: ../src/guestfs-actions.pod:3206
10343 " guestfs_is_symlink (guestfs_h *g,\n"
10344 " const char *path);\n"
10349 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2222
10351 "This returns C<true> if and only if there is a symbolic link with the given "
10356 #: ../src/guestfs-actions.pod:3219
10357 msgid "guestfs_kill_subprocess"
10361 #: ../src/guestfs-actions.pod:3221
10365 " guestfs_kill_subprocess (guestfs_h *g);\n"
10370 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2231
10371 msgid "This kills the qemu subprocess. You should never need to call this."
10375 #: ../src/guestfs-actions.pod:3230
10376 msgid "guestfs_launch"
10380 #: ../src/guestfs-actions.pod:3232
10384 " guestfs_launch (guestfs_h *g);\n"
10389 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2239
10391 "Internally libguestfs is implemented by running a virtual machine using "
10396 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2242
10398 "You should call this after configuring the handle (eg. adding drives) but "
10399 "before performing any actions."
10403 #: ../src/guestfs-actions.pod:3245
10404 msgid "guestfs_lchown"
10408 #: ../src/guestfs-actions.pod:3247
10412 " guestfs_lchown (guestfs_h *g,\n"
10415 " const char *path);\n"
10420 #: ../src/guestfs-actions.pod:3253
10422 "Change the file owner to C<owner> and group to C<group>. This is like "
10423 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
10424 "changed, not the target."
10428 #: ../src/guestfs-actions.pod:3265
10429 msgid "guestfs_lgetxattr"
10433 #: ../src/guestfs-actions.pod:3267
10437 " guestfs_lgetxattr (guestfs_h *g,\n"
10438 " const char *path,\n"
10439 " const char *name,\n"
10440 " size_t *size_r);\n"
10445 #: ../src/guestfs-actions.pod:3273 ../fish/guestfish-actions.pod:2261
10447 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10448 "is a symlink, then this call returns an extended attribute from the symlink."
10452 #: ../src/guestfs-actions.pod:3287
10453 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
10457 #: ../src/guestfs-actions.pod:3295
10458 msgid "guestfs_lgetxattrs"
10462 #: ../src/guestfs-actions.pod:3297
10465 " struct guestfs_xattr_list *\n"
10466 " guestfs_lgetxattrs (guestfs_h *g,\n"
10467 " const char *path);\n"
10472 #: ../src/guestfs-actions.pod:3301
10474 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
10475 "then it returns the extended attributes of the link itself."
10479 #: ../src/guestfs-actions.pod:3311
10480 msgid "guestfs_list_devices"
10484 #: ../src/guestfs-actions.pod:3313
10488 " guestfs_list_devices (guestfs_h *g);\n"
10493 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2289
10494 msgid "List all the block devices."
10498 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2291
10499 msgid "The full block device names are returned, eg. C</dev/sda>."
10503 #: ../src/guestfs-actions.pod:3328
10504 msgid "guestfs_list_filesystems"
10508 #: ../src/guestfs-actions.pod:3330
10512 " guestfs_list_filesystems (guestfs_h *g);\n"
10517 #: ../src/guestfs-actions.pod:3333 ../fish/guestfish-actions.pod:2299
10519 "This inspection command looks for filesystems on partitions, block devices "
10520 "and logical volumes, returning a list of devices containing filesystems and "
10525 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2303
10527 "The return value is a hash, where the keys are the devices containing "
10528 "filesystems, and the values are the filesystem types. For example:"
10532 #: ../src/guestfs-actions.pod:3341 ../fish/guestfish-actions.pod:2307
10535 " \"/dev/sda1\" => \"ntfs\"\n"
10536 " \"/dev/sda2\" => \"ext2\"\n"
10537 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10538 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10543 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2312
10545 "The value can have the special value \"unknown\", meaning the content of the "
10546 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10550 #: ../src/guestfs-actions.pod:3350
10552 "This command runs other libguestfs commands, which might include "
10553 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10554 "soon after launch and only when nothing is mounted."
10558 #: ../src/guestfs-actions.pod:3354
10560 "Not all of the filesystems returned will be mountable. In particular, swap "
10561 "partitions are returned in the list. Also this command does not check that "
10562 "each filesystem found is valid and mountable, and some filesystems might be "
10563 "mountable but require special options. Filesystems may not all belong to a "
10564 "single logical operating system (use C<guestfs_inspect_os> to look for "
10569 #: ../src/guestfs-actions.pod:3368 ../src/guestfs-actions.pod:4959
10570 msgid "(Added in 1.5.15)"
10574 #: ../src/guestfs-actions.pod:3370
10575 msgid "guestfs_list_partitions"
10579 #: ../src/guestfs-actions.pod:3372
10583 " guestfs_list_partitions (guestfs_h *g);\n"
10588 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2332
10589 msgid "List all the partitions detected on all block devices."
10593 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2334
10594 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10598 #: ../src/guestfs-actions.pod:3379
10600 "This does not return logical volumes. For that you will need to call "
10605 #: ../src/guestfs-actions.pod:3390
10610 #: ../src/guestfs-actions.pod:3392
10614 " guestfs_ll (guestfs_h *g,\n"
10615 " const char *directory);\n"
10620 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2345
10622 "List the files in C<directory> (relative to the root directory, there is no "
10623 "cwd) in the format of 'ls -la'."
10627 #: ../src/guestfs-actions.pod:3399 ../fish/guestfish-actions.pod:2348
10629 "This command is mostly useful for interactive sessions. It is I<not> "
10630 "intended that you try to parse the output string."
10634 #: ../src/guestfs-actions.pod:3407
10639 #: ../src/guestfs-actions.pod:3409
10643 " guestfs_ln (guestfs_h *g,\n"
10644 " const char *target,\n"
10645 " const char *linkname);\n"
10650 #: ../src/guestfs-actions.pod:3414 ../fish/guestfish-actions.pod:2355
10651 msgid "This command creates a hard link using the C<ln> command."
10655 #: ../src/guestfs-actions.pod:3420
10656 msgid "guestfs_ln_f"
10660 #: ../src/guestfs-actions.pod:3422
10664 " guestfs_ln_f (guestfs_h *g,\n"
10665 " const char *target,\n"
10666 " const char *linkname);\n"
10671 #: ../src/guestfs-actions.pod:3427 ../fish/guestfish-actions.pod:2361
10673 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10674 "option removes the link (C<linkname>) if it exists already."
10678 #: ../src/guestfs-actions.pod:3434
10679 msgid "guestfs_ln_s"
10683 #: ../src/guestfs-actions.pod:3436
10687 " guestfs_ln_s (guestfs_h *g,\n"
10688 " const char *target,\n"
10689 " const char *linkname);\n"
10694 #: ../src/guestfs-actions.pod:3441 ../fish/guestfish-actions.pod:2368
10695 msgid "This command creates a symbolic link using the C<ln -s> command."
10699 #: ../src/guestfs-actions.pod:3447
10700 msgid "guestfs_ln_sf"
10704 #: ../src/guestfs-actions.pod:3449
10708 " guestfs_ln_sf (guestfs_h *g,\n"
10709 " const char *target,\n"
10710 " const char *linkname);\n"
10715 #: ../src/guestfs-actions.pod:3454 ../fish/guestfish-actions.pod:2374
10717 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10718 "option removes the link (C<linkname>) if it exists already."
10722 #: ../src/guestfs-actions.pod:3461
10723 msgid "guestfs_lremovexattr"
10727 #: ../src/guestfs-actions.pod:3463
10731 " guestfs_lremovexattr (guestfs_h *g,\n"
10732 " const char *xattr,\n"
10733 " const char *path);\n"
10738 #: ../src/guestfs-actions.pod:3468
10740 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10741 "link, then it removes an extended attribute of the link itself."
10745 #: ../src/guestfs-actions.pod:3476
10750 #: ../src/guestfs-actions.pod:3478
10754 " guestfs_ls (guestfs_h *g,\n"
10755 " const char *directory);\n"
10760 #: ../src/guestfs-actions.pod:3482 ../fish/guestfish-actions.pod:2389
10762 "List the files in C<directory> (relative to the root directory, there is no "
10763 "cwd). The '.' and '..' entries are not returned, but hidden files are "
10768 #: ../src/guestfs-actions.pod:3486
10770 "This command is mostly useful for interactive sessions. Programs should "
10771 "probably use C<guestfs_readdir> instead."
10775 #: ../src/guestfs-actions.pod:3495
10776 msgid "guestfs_lsetxattr"
10780 #: ../src/guestfs-actions.pod:3497
10784 " guestfs_lsetxattr (guestfs_h *g,\n"
10785 " const char *xattr,\n"
10786 " const char *val,\n"
10788 " const char *path);\n"
10793 #: ../src/guestfs-actions.pod:3504
10795 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10796 "then it sets an extended attribute of the link itself."
10800 #: ../src/guestfs-actions.pod:3512
10801 msgid "guestfs_lstat"
10805 #: ../src/guestfs-actions.pod:3514
10808 " struct guestfs_stat *\n"
10809 " guestfs_lstat (guestfs_h *g,\n"
10810 " const char *path);\n"
10815 #: ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:6013 ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:4021
10816 msgid "Returns file information for the given C<path>."
10820 #: ../src/guestfs-actions.pod:3520
10822 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10823 "link, then the link is stat-ed, not the file it refers to."
10827 #: ../src/guestfs-actions.pod:3524 ../fish/guestfish-actions.pod:2414
10828 msgid "This is the same as the C<lstat(2)> system call."
10832 #: ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:6017
10834 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10835 "error. I<The caller must call C<guestfs_free_stat> after use>."
10839 #: ../src/guestfs-actions.pod:3530 ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6039 ../src/guestfs-actions.pod:6420
10840 msgid "(Added in 0.9.2)"
10844 #: ../src/guestfs-actions.pod:3532
10845 msgid "guestfs_lstatlist"
10849 #: ../src/guestfs-actions.pod:3534
10852 " struct guestfs_stat_list *\n"
10853 " guestfs_lstatlist (guestfs_h *g,\n"
10854 " const char *path,\n"
10855 " char *const *names);\n"
10860 #: ../src/guestfs-actions.pod:3539
10862 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10863 "files, where all files are in the directory C<path>. C<names> is the list "
10864 "of files from this directory."
10868 #: ../src/guestfs-actions.pod:3543 ../fish/guestfish-actions.pod:2424
10870 "On return you get a list of stat structs, with a one-to-one correspondence "
10871 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10872 "then the C<ino> field of that structure is set to C<-1>."
10876 #: ../src/guestfs-actions.pod:3548
10878 "This call is intended for programs that want to efficiently list a directory "
10879 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10880 "for a similarly efficient call for getting extended attributes. Very long "
10881 "directory listings might cause the protocol message size to be exceeded, "
10882 "causing this call to fail. The caller must split up such requests into "
10883 "smaller groups of names."
10887 #: ../src/guestfs-actions.pod:3556
10889 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10890 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10894 #: ../src/guestfs-actions.pod:3562
10895 msgid "guestfs_luks_add_key"
10899 #: ../src/guestfs-actions.pod:3564
10903 " guestfs_luks_add_key (guestfs_h *g,\n"
10904 " const char *device,\n"
10905 " const char *key,\n"
10906 " const char *newkey,\n"
10912 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2441
10914 "This command adds a new key on LUKS device C<device>. C<key> is any "
10915 "existing key, and is used to access the device. C<newkey> is the new key to "
10916 "add. C<keyslot> is the key slot that will be replaced."
10920 #: ../src/guestfs-actions.pod:3576
10922 "Note that if C<keyslot> already contains a key, then this command will "
10923 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10927 #: ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3622 ../src/guestfs-actions.pod:3645 ../src/guestfs-actions.pod:3665 ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:3716
10929 "This function takes a key or passphrase parameter which could contain "
10930 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10935 #: ../src/guestfs-actions.pod:3586 ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3649 ../src/guestfs-actions.pod:3669
10936 msgid "(Added in 1.5.2)"
10940 #: ../src/guestfs-actions.pod:3588
10941 msgid "guestfs_luks_close"
10945 #: ../src/guestfs-actions.pod:3590
10949 " guestfs_luks_close (guestfs_h *g,\n"
10950 " const char *device);\n"
10955 #: ../src/guestfs-actions.pod:3594
10957 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10958 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10959 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10960 "underlying block device."
10964 #: ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:3701 ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:3818
10965 msgid "(Added in 1.5.1)"
10969 #: ../src/guestfs-actions.pod:3604
10970 msgid "guestfs_luks_format"
10974 #: ../src/guestfs-actions.pod:3606
10978 " guestfs_luks_format (guestfs_h *g,\n"
10979 " const char *device,\n"
10980 " const char *key,\n"
10986 #: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2467
10988 "This command erases existing data on C<device> and formats the device as a "
10989 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10990 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10994 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:4710 ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:5848 ../src/guestfs-actions.pod:5871 ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:7057 ../fish/guestfish-actions.pod:2475 ../fish/guestfish-actions.pod:2488 ../fish/guestfish-actions.pod:2572 ../fish/guestfish-actions.pod:3133 ../fish/guestfish-actions.pod:3640 ../fish/guestfish-actions.pod:3920 ../fish/guestfish-actions.pod:3936 ../fish/guestfish-actions.pod:3951 ../fish/guestfish-actions.pod:4666
10996 "B<This command is dangerous. Without careful use you can easily destroy all "
11001 #: ../src/guestfs-actions.pod:3628
11002 msgid "guestfs_luks_format_cipher"
11006 #: ../src/guestfs-actions.pod:3630
11010 " guestfs_luks_format_cipher (guestfs_h *g,\n"
11011 " const char *device,\n"
11012 " const char *key,\n"
11014 " const char *cipher);\n"
11019 #: ../src/guestfs-actions.pod:3637
11021 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11022 "set the C<cipher> used."
11026 #: ../src/guestfs-actions.pod:3651
11027 msgid "guestfs_luks_kill_slot"
11031 #: ../src/guestfs-actions.pod:3653
11035 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11036 " const char *device,\n"
11037 " const char *key,\n"
11043 #: ../src/guestfs-actions.pod:3659 ../fish/guestfish-actions.pod:2495
11045 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11046 "device C<device>. C<key> must be one of the I<other> keys."
11050 #: ../src/guestfs-actions.pod:3671
11051 msgid "guestfs_luks_open"
11055 #: ../src/guestfs-actions.pod:3673
11059 " guestfs_luks_open (guestfs_h *g,\n"
11060 " const char *device,\n"
11061 " const char *key,\n"
11062 " const char *mapname);\n"
11067 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2506
11069 "This command opens a block device which has been encrypted according to the "
11070 "Linux Unified Key Setup (LUKS) standard."
11074 #: ../src/guestfs-actions.pod:3682 ../fish/guestfish-actions.pod:2509
11075 msgid "C<device> is the encrypted block device or partition."
11079 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2511
11081 "The caller must supply one of the keys associated with the LUKS block "
11082 "device, in the C<key> parameter."
11086 #: ../src/guestfs-actions.pod:3687 ../fish/guestfish-actions.pod:2514
11088 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11089 "writes to this block device are decrypted from and encrypted to the "
11090 "underlying C<device> respectively."
11094 #: ../src/guestfs-actions.pod:3691
11096 "If this block device contains LVM volume groups, then calling "
11097 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11102 #: ../src/guestfs-actions.pod:3703
11103 msgid "guestfs_luks_open_ro"
11107 #: ../src/guestfs-actions.pod:3705
11111 " guestfs_luks_open_ro (guestfs_h *g,\n"
11112 " const char *device,\n"
11113 " const char *key,\n"
11114 " const char *mapname);\n"
11119 #: ../src/guestfs-actions.pod:3711
11121 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11126 #: ../src/guestfs-actions.pod:3722
11127 msgid "guestfs_lvcreate"
11131 #: ../src/guestfs-actions.pod:3724
11135 " guestfs_lvcreate (guestfs_h *g,\n"
11136 " const char *logvol,\n"
11137 " const char *volgroup,\n"
11143 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2539
11145 "This creates an LVM logical volume called C<logvol> on the volume group "
11146 "C<volgroup>, with C<size> megabytes."
11150 #: ../src/guestfs-actions.pod:3737
11151 msgid "guestfs_lvm_canonical_lv_name"
11155 #: ../src/guestfs-actions.pod:3739
11159 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11160 " const char *lvname);\n"
11165 #: ../src/guestfs-actions.pod:3743 ../fish/guestfish-actions.pod:2546
11167 "This converts alternative naming schemes for LVs that you might find to the "
11168 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11173 #: ../src/guestfs-actions.pod:3747 ../fish/guestfish-actions.pod:2550
11175 "This command returns an error if the C<lvname> parameter does not refer to a "
11180 #: ../src/guestfs-actions.pod:3750
11181 msgid "See also C<guestfs_is_lv>."
11185 #: ../src/guestfs-actions.pod:3755
11186 msgid "(Added in 1.5.24)"
11190 #: ../src/guestfs-actions.pod:3757
11191 msgid "guestfs_lvm_clear_filter"
11195 #: ../src/guestfs-actions.pod:3759
11199 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11204 #: ../src/guestfs-actions.pod:3762
11206 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11207 "see every block device."
11211 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2562 ../fish/guestfish-actions.pod:2593
11212 msgid "This command also clears the LVM cache and performs a volume group scan."
11216 #: ../src/guestfs-actions.pod:3772
11217 msgid "guestfs_lvm_remove_all"
11221 #: ../src/guestfs-actions.pod:3774
11225 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11230 #: ../src/guestfs-actions.pod:3777 ../fish/guestfish-actions.pod:2569
11232 "This command removes all LVM logical volumes, volume groups and physical "
11237 #: ../src/guestfs-actions.pod:3787
11238 msgid "guestfs_lvm_set_filter"
11242 #: ../src/guestfs-actions.pod:3789
11246 " guestfs_lvm_set_filter (guestfs_h *g,\n"
11247 " char *const *devices);\n"
11252 #: ../src/guestfs-actions.pod:3793 ../fish/guestfish-actions.pod:2579
11254 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11255 "block devices in the list C<devices>, and will ignore all other attached "
11260 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2583
11262 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11263 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11264 "there are two types of duplication possible: either cloned PVs/VGs which "
11265 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11266 "same name. In normal operation you cannot create this situation, but you "
11267 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11268 "inside the LVM metadata."
11272 #: ../src/guestfs-actions.pod:3810 ../fish/guestfish-actions.pod:2596
11273 msgid "You can filter whole block devices or individual partitions."
11277 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
11279 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11280 "filesystem), even if you are not filtering out that VG."
11284 #: ../src/guestfs-actions.pod:3820
11285 msgid "guestfs_lvremove"
11289 #: ../src/guestfs-actions.pod:3822
11293 " guestfs_lvremove (guestfs_h *g,\n"
11294 " const char *device);\n"
11299 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2606
11301 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11302 "LV, such as C</dev/VG/LV>."
11306 #: ../src/guestfs-actions.pod:3829 ../fish/guestfish-actions.pod:2609
11308 "You can also remove all LVs in a volume group by specifying the VG name, "
11313 #: ../src/guestfs-actions.pod:3834 ../src/guestfs-actions.pod:5056 ../src/guestfs-actions.pod:6796
11314 msgid "(Added in 1.0.13)"
11318 #: ../src/guestfs-actions.pod:3836
11319 msgid "guestfs_lvrename"
11323 #: ../src/guestfs-actions.pod:3838
11327 " guestfs_lvrename (guestfs_h *g,\n"
11328 " const char *logvol,\n"
11329 " const char *newlogvol);\n"
11334 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2616
11335 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11339 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:6809
11340 msgid "(Added in 1.0.83)"
11344 #: ../src/guestfs-actions.pod:3849
11345 msgid "guestfs_lvresize"
11349 #: ../src/guestfs-actions.pod:3851
11353 " guestfs_lvresize (guestfs_h *g,\n"
11354 " const char *device,\n"
11360 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2622
11362 "This resizes (expands or shrinks) an existing LVM logical volume to "
11363 "C<mbytes>. When reducing, data in the reduced part is lost."
11367 #: ../src/guestfs-actions.pod:3864
11368 msgid "guestfs_lvresize_free"
11372 #: ../src/guestfs-actions.pod:3866
11376 " guestfs_lvresize_free (guestfs_h *g,\n"
11377 " const char *lv,\n"
11383 #: ../src/guestfs-actions.pod:3871 ../fish/guestfish-actions.pod:2630
11385 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11386 "remaining free space in the volume group. Commonly you would call this with "
11387 "pc = 100 which expands the logical volume as much as possible, using all "
11388 "remaining free space in the volume group."
11392 #: ../src/guestfs-actions.pod:3879
11393 msgid "(Added in 1.3.3)"
11397 #: ../src/guestfs-actions.pod:3881
11398 msgid "guestfs_lvs"
11402 #: ../src/guestfs-actions.pod:3883
11406 " guestfs_lvs (guestfs_h *g);\n"
11411 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2640
11413 "List all the logical volumes detected. This is the equivalent of the "
11414 "L<lvs(8)> command."
11418 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2643
11420 "This returns a list of the logical volume device names "
11421 "(eg. C</dev/VolGroup00/LogVol00>)."
11425 #: ../src/guestfs-actions.pod:3892
11426 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
11430 #: ../src/guestfs-actions.pod:3900
11431 msgid "guestfs_lvs_full"
11435 #: ../src/guestfs-actions.pod:3902
11438 " struct guestfs_lvm_lv_list *\n"
11439 " guestfs_lvs_full (guestfs_h *g);\n"
11444 #: ../src/guestfs-actions.pod:3905 ../fish/guestfish-actions.pod:2652
11446 "List all the logical volumes detected. This is the equivalent of the "
11447 "L<lvs(8)> command. The \"full\" version includes all fields."
11451 #: ../src/guestfs-actions.pod:3908
11453 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
11454 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
11459 #: ../src/guestfs-actions.pod:3914
11460 msgid "guestfs_lvuuid"
11464 #: ../src/guestfs-actions.pod:3916
11468 " guestfs_lvuuid (guestfs_h *g,\n"
11469 " const char *device);\n"
11474 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2659
11475 msgid "This command returns the UUID of the LVM LV C<device>."
11479 #: ../src/guestfs-actions.pod:3927
11480 msgid "guestfs_lxattrlist"
11484 #: ../src/guestfs-actions.pod:3929
11487 " struct guestfs_xattr_list *\n"
11488 " guestfs_lxattrlist (guestfs_h *g,\n"
11489 " const char *path,\n"
11490 " char *const *names);\n"
11495 #: ../src/guestfs-actions.pod:3934 ../fish/guestfish-actions.pod:2665
11497 "This call allows you to get the extended attributes of multiple files, where "
11498 "all files are in the directory C<path>. C<names> is the list of files from "
11503 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2669
11505 "On return you get a flat list of xattr structs which must be interpreted "
11506 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11507 "C<attrval> in this struct is zero-length to indicate there was an error "
11508 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11509 "number (the number of following attributes for this file, which could be "
11510 "C<\"0\">). Then after the first xattr struct are the zero or more "
11511 "attributes for the first named file. This repeats for the second and "
11512 "subsequent files."
11516 #: ../src/guestfs-actions.pod:3948
11518 "This call is intended for programs that want to efficiently list a directory "
11519 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11520 "a similarly efficient call for getting standard stats. Very long directory "
11521 "listings might cause the protocol message size to be exceeded, causing this "
11522 "call to fail. The caller must split up such requests into smaller groups of "
11527 #: ../src/guestfs-actions.pod:3962
11528 msgid "guestfs_mkdir"
11532 #: ../src/guestfs-actions.pod:3964
11536 " guestfs_mkdir (guestfs_h *g,\n"
11537 " const char *path);\n"
11542 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2691
11543 msgid "Create a directory named C<path>."
11547 #: ../src/guestfs-actions.pod:3974
11548 msgid "guestfs_mkdir_mode"
11552 #: ../src/guestfs-actions.pod:3976
11556 " guestfs_mkdir_mode (guestfs_h *g,\n"
11557 " const char *path,\n"
11563 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2697
11565 "This command creates a directory, setting the initial permissions of the "
11566 "directory to C<mode>."
11570 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2700
11572 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11573 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11578 #: ../src/guestfs-actions.pod:3988
11579 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11583 #: ../src/guestfs-actions.pod:3994
11584 msgid "guestfs_mkdir_p"
11588 #: ../src/guestfs-actions.pod:3996
11592 " guestfs_mkdir_p (guestfs_h *g,\n"
11593 " const char *path);\n"
11598 #: ../src/guestfs-actions.pod:4000 ../fish/guestfish-actions.pod:2710
11600 "Create a directory named C<path>, creating any parent directories as "
11601 "necessary. This is like the C<mkdir -p> shell command."
11605 #: ../src/guestfs-actions.pod:4007
11606 msgid "guestfs_mkdtemp"
11610 #: ../src/guestfs-actions.pod:4009
11614 " guestfs_mkdtemp (guestfs_h *g,\n"
11615 " const char *template);\n"
11620 #: ../src/guestfs-actions.pod:4013 ../fish/guestfish-actions.pod:2717
11622 "This command creates a temporary directory. The C<template> parameter "
11623 "should be a full pathname for the temporary directory name with the final "
11624 "six characters being \"XXXXXX\"."
11628 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2722
11630 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11631 "being suitable for Windows filesystems."
11635 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2725
11636 msgid "The name of the temporary directory that was created is returned."
11640 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2728
11641 msgid "The temporary directory is created with mode 0700 and is owned by root."
11645 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2731
11647 "The caller is responsible for deleting the temporary directory and its "
11648 "contents after use."
11652 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2734
11653 msgid "See also: L<mkdtemp(3)>"
11657 #: ../src/guestfs-actions.pod:4037
11658 msgid "guestfs_mke2fs_J"
11662 #: ../src/guestfs-actions.pod:4039
11666 " guestfs_mke2fs_J (guestfs_h *g,\n"
11667 " const char *fstype,\n"
11668 " int blocksize,\n"
11669 " const char *device,\n"
11670 " const char *journal);\n"
11675 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2740
11677 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11678 "C<journal>. It is equivalent to the command:"
11682 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2744
11685 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11690 #: ../src/guestfs-actions.pod:4052
11691 msgid "See also C<guestfs_mke2journal>."
11695 #: ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:4108 ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4195 ../src/guestfs-actions.pod:4446
11696 msgid "(Added in 1.0.68)"
11700 #: ../src/guestfs-actions.pod:4058
11701 msgid "guestfs_mke2fs_JL"
11705 #: ../src/guestfs-actions.pod:4060
11709 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11710 " const char *fstype,\n"
11711 " int blocksize,\n"
11712 " const char *device,\n"
11713 " const char *label);\n"
11718 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2752
11720 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11721 "the journal labeled C<label>."
11725 #: ../src/guestfs-actions.pod:4070
11726 msgid "See also C<guestfs_mke2journal_L>."
11730 #: ../src/guestfs-actions.pod:4076
11731 msgid "guestfs_mke2fs_JU"
11735 #: ../src/guestfs-actions.pod:4078
11739 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11740 " const char *fstype,\n"
11741 " int blocksize,\n"
11742 " const char *device,\n"
11743 " const char *uuid);\n"
11748 #: ../src/guestfs-actions.pod:4085 ../fish/guestfish-actions.pod:2761
11750 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11751 "the journal with UUID C<uuid>."
11755 #: ../src/guestfs-actions.pod:4088
11756 msgid "See also C<guestfs_mke2journal_U>."
11760 #: ../src/guestfs-actions.pod:4094
11761 msgid "guestfs_mke2journal"
11765 #: ../src/guestfs-actions.pod:4096
11769 " guestfs_mke2journal (guestfs_h *g,\n"
11770 " int blocksize,\n"
11771 " const char *device);\n"
11776 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2770
11778 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11783 #: ../src/guestfs-actions.pod:4104 ../fish/guestfish-actions.pod:2773
11786 " mke2fs -O journal_dev -b blocksize device\n"
11791 #: ../src/guestfs-actions.pod:4110
11792 msgid "guestfs_mke2journal_L"
11796 #: ../src/guestfs-actions.pod:4112
11800 " guestfs_mke2journal_L (guestfs_h *g,\n"
11801 " int blocksize,\n"
11802 " const char *label,\n"
11803 " const char *device);\n"
11808 #: ../src/guestfs-actions.pod:4118 ../fish/guestfish-actions.pod:2779
11809 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11813 #: ../src/guestfs-actions.pod:4124
11814 msgid "guestfs_mke2journal_U"
11818 #: ../src/guestfs-actions.pod:4126
11822 " guestfs_mke2journal_U (guestfs_h *g,\n"
11823 " int blocksize,\n"
11824 " const char *uuid,\n"
11825 " const char *device);\n"
11830 #: ../src/guestfs-actions.pod:4132 ../fish/guestfish-actions.pod:2785
11831 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11835 #: ../src/guestfs-actions.pod:4138
11836 msgid "guestfs_mkfifo"
11840 #: ../src/guestfs-actions.pod:4140
11844 " guestfs_mkfifo (guestfs_h *g,\n"
11846 " const char *path);\n"
11851 #: ../src/guestfs-actions.pod:4145
11853 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11854 "is just a convenient wrapper around C<guestfs_mknod>."
11858 #: ../src/guestfs-actions.pod:4155
11859 msgid "guestfs_mkfs"
11863 #: ../src/guestfs-actions.pod:4157
11867 " guestfs_mkfs (guestfs_h *g,\n"
11868 " const char *fstype,\n"
11869 " const char *device);\n"
11874 #: ../src/guestfs-actions.pod:4162 ../fish/guestfish-actions.pod:2801
11876 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11877 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11881 #: ../src/guestfs-actions.pod:4170
11882 msgid "guestfs_mkfs_b"
11886 #: ../src/guestfs-actions.pod:4172
11890 " guestfs_mkfs_b (guestfs_h *g,\n"
11891 " const char *fstype,\n"
11892 " int blocksize,\n"
11893 " const char *device);\n"
11898 #: ../src/guestfs-actions.pod:4178
11900 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11901 "block size of the resulting filesystem. Supported block sizes depend on the "
11902 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11906 #: ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2814 ../fish/guestfish-actions.pod:2841
11908 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11913 #: ../src/guestfs-actions.pod:4188 ../fish/guestfish-actions.pod:2817
11915 "This function is deprecated. In new code, use the C<mkfs_opts> call "
11920 #: ../src/guestfs-actions.pod:4197
11921 msgid "guestfs_mkfs_opts"
11925 #: ../src/guestfs-actions.pod:4199
11929 " guestfs_mkfs_opts (guestfs_h *g,\n"
11930 " const char *fstype,\n"
11931 " const char *device,\n"
11937 #: ../src/guestfs-actions.pod:4210
11940 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
11945 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2828
11947 "This function creates a filesystem on C<device>. The filesystem type is "
11948 "C<fstype>, for example C<ext3>."
11952 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2835
11953 msgid "C<blocksize>"
11957 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2837
11959 "The filesystem block size. Supported block sizes depend on the filesystem "
11960 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11965 #: ../src/guestfs-actions.pod:4232
11966 msgid "(Added in 1.7.19)"
11970 #: ../src/guestfs-actions.pod:4234
11971 msgid "guestfs_mkfs_opts_va"
11975 #: ../src/guestfs-actions.pod:4236
11979 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
11980 " const char *fstype,\n"
11981 " const char *device,\n"
11982 " va_list args);\n"
11987 #: ../src/guestfs-actions.pod:4242
11988 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
11992 #: ../src/guestfs-actions.pod:4246
11993 msgid "guestfs_mkfs_opts_argv"
11997 #: ../src/guestfs-actions.pod:4248
12001 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
12002 " const char *fstype,\n"
12003 " const char *device,\n"
12004 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12009 #: ../src/guestfs-actions.pod:4254
12010 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12014 #: ../src/guestfs-actions.pod:4258
12015 msgid "guestfs_mkmountpoint"
12019 #: ../src/guestfs-actions.pod:4260
12023 " guestfs_mkmountpoint (guestfs_h *g,\n"
12024 " const char *exemptpath);\n"
12029 #: ../src/guestfs-actions.pod:4264
12031 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12032 "that can be used to create extra mountpoints before mounting the first "
12037 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2856
12039 "These calls are I<only> necessary in some very limited circumstances, mainly "
12040 "the case where you want to mount a mix of unrelated and/or read-only "
12041 "filesystems together."
12045 #: ../src/guestfs-actions.pod:4272 ../fish/guestfish-actions.pod:2860
12047 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12048 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12049 "inside that. You can unpack this as follows in guestfish:"
12053 #: ../src/guestfs-actions.pod:4277 ../fish/guestfish-actions.pod:2865
12056 " add-ro Fedora-11-i686-Live.iso\n"
12058 " mkmountpoint /cd\n"
12059 " mkmountpoint /sqsh\n"
12060 " mkmountpoint /ext3fs\n"
12061 " mount /dev/sda /cd\n"
12062 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12063 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12068 #: ../src/guestfs-actions.pod:4286 ../fish/guestfish-actions.pod:2874
12069 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12073 #: ../src/guestfs-actions.pod:4288
12075 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12076 "may get unexpected errors if you try to mix these calls. It is safest to "
12077 "manually unmount filesystems and remove mountpoints after use."
12081 #: ../src/guestfs-actions.pod:4292
12083 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12084 "first, so for this to work for manual mountpoints, you must ensure that the "
12085 "innermost mountpoints have the longest pathnames, as in the example code "
12090 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2885
12091 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12095 #: ../src/guestfs-actions.pod:4299
12097 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12098 "means that C<guestfs_umount_all> is called when the handle is closed which "
12099 "can also trigger these issues."
12103 #: ../src/guestfs-actions.pod:4305 ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:5457
12104 msgid "(Added in 1.0.62)"
12108 #: ../src/guestfs-actions.pod:4307
12109 msgid "guestfs_mknod"
12113 #: ../src/guestfs-actions.pod:4309
12117 " guestfs_mknod (guestfs_h *g,\n"
12121 " const char *path);\n"
12126 #: ../src/guestfs-actions.pod:4316 ../fish/guestfish-actions.pod:2895
12128 "This call creates block or character special devices, or named pipes "
12133 #: ../src/guestfs-actions.pod:4319 ../fish/guestfish-actions.pod:2898
12135 "The C<mode> parameter should be the mode, using the standard constants. "
12136 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12137 "used when creating block and character special devices."
12141 #: ../src/guestfs-actions.pod:4324
12143 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12144 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12145 "regular file). These constants are available in the standard Linux header "
12146 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12147 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12148 "the appropriate constant for you."
12152 #: ../src/guestfs-actions.pod:4338
12153 msgid "guestfs_mknod_b"
12157 #: ../src/guestfs-actions.pod:4340
12161 " guestfs_mknod_b (guestfs_h *g,\n"
12165 " const char *path);\n"
12170 #: ../src/guestfs-actions.pod:4347
12172 "This call creates a block device node called C<path> with mode C<mode> and "
12173 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12174 "wrapper around C<guestfs_mknod>."
12178 #: ../src/guestfs-actions.pod:4357
12179 msgid "guestfs_mknod_c"
12183 #: ../src/guestfs-actions.pod:4359
12187 " guestfs_mknod_c (guestfs_h *g,\n"
12191 " const char *path);\n"
12196 #: ../src/guestfs-actions.pod:4366
12198 "This call creates a char device node called C<path> with mode C<mode> and "
12199 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12200 "wrapper around C<guestfs_mknod>."
12204 #: ../src/guestfs-actions.pod:4376
12205 msgid "guestfs_mkswap"
12209 #: ../src/guestfs-actions.pod:4378
12213 " guestfs_mkswap (guestfs_h *g,\n"
12214 " const char *device);\n"
12219 #: ../src/guestfs-actions.pod:4382 ../fish/guestfish-actions.pod:2937
12220 msgid "Create a swap partition on C<device>."
12224 #: ../src/guestfs-actions.pod:4388
12225 msgid "guestfs_mkswap_L"
12229 #: ../src/guestfs-actions.pod:4390
12233 " guestfs_mkswap_L (guestfs_h *g,\n"
12234 " const char *label,\n"
12235 " const char *device);\n"
12240 #: ../src/guestfs-actions.pod:4395 ../fish/guestfish-actions.pod:2943
12241 msgid "Create a swap partition on C<device> with label C<label>."
12245 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2945
12247 "Note that you cannot attach a swap label to a block device "
12248 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12249 "the kernel or swap tools."
12253 #: ../src/guestfs-actions.pod:4405
12254 msgid "guestfs_mkswap_U"
12258 #: ../src/guestfs-actions.pod:4407
12262 " guestfs_mkswap_U (guestfs_h *g,\n"
12263 " const char *uuid,\n"
12264 " const char *device);\n"
12269 #: ../src/guestfs-actions.pod:4412 ../fish/guestfish-actions.pod:2953
12270 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12274 #: ../src/guestfs-actions.pod:4418
12275 msgid "guestfs_mkswap_file"
12279 #: ../src/guestfs-actions.pod:4420
12283 " guestfs_mkswap_file (guestfs_h *g,\n"
12284 " const char *path);\n"
12289 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:2959
12290 msgid "Create a swap file."
12294 #: ../src/guestfs-actions.pod:4426
12296 "This command just writes a swap file signature to an existing file. To "
12297 "create the file itself, use something like C<guestfs_fallocate>."
12301 #: ../src/guestfs-actions.pod:4433
12302 msgid "guestfs_modprobe"
12306 #: ../src/guestfs-actions.pod:4435
12310 " guestfs_modprobe (guestfs_h *g,\n"
12311 " const char *modulename);\n"
12316 #: ../src/guestfs-actions.pod:4439 ../fish/guestfish-actions.pod:2968
12317 msgid "This loads a kernel module in the appliance."
12321 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:2970
12323 "The kernel module must have been whitelisted when libguestfs was built (see "
12324 "C<appliance/kmod.whitelist.in> in the source)."
12328 #: ../src/guestfs-actions.pod:4448
12329 msgid "guestfs_mount"
12333 #: ../src/guestfs-actions.pod:4450
12337 " guestfs_mount (guestfs_h *g,\n"
12338 " const char *device,\n"
12339 " const char *mountpoint);\n"
12344 #: ../src/guestfs-actions.pod:4455 ../fish/guestfish-actions.pod:2977
12346 "Mount a guest disk at a position in the filesystem. Block devices are named "
12347 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12348 "those block devices contain partitions, they will have the usual names "
12349 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12353 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:2983
12355 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12356 "mounted on C</> before others can be mounted. Other filesystems can only be "
12357 "mounted on directories which already exist."
12361 #: ../src/guestfs-actions.pod:4466 ../fish/guestfish-actions.pod:2988
12363 "The mounted filesystem is writable, if we have sufficient permissions on the "
12364 "underlying device."
12368 #: ../src/guestfs-actions.pod:4469
12370 "B<Important note:> When you use this call, the filesystem options C<sync> "
12371 "and C<noatime> are set implicitly. This was originally done because we "
12372 "thought it would improve reliability, but it turns out that I<-o sync> has a "
12373 "very large negative performance impact and negligible effect on "
12374 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
12375 "in any code that needs performance, and instead use C<guestfs_mount_options> "
12376 "(use an empty string for the first parameter if you don't want any options)."
12380 #: ../src/guestfs-actions.pod:4483
12381 msgid "guestfs_mount_loop"
12385 #: ../src/guestfs-actions.pod:4485
12389 " guestfs_mount_loop (guestfs_h *g,\n"
12390 " const char *file,\n"
12391 " const char *mountpoint);\n"
12396 #: ../src/guestfs-actions.pod:4490 ../fish/guestfish-actions.pod:3005
12398 "This command lets you mount C<file> (a filesystem image in a file) on a "
12399 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12404 #: ../src/guestfs-actions.pod:4498
12405 msgid "guestfs_mount_options"
12409 #: ../src/guestfs-actions.pod:4500
12413 " guestfs_mount_options (guestfs_h *g,\n"
12414 " const char *options,\n"
12415 " const char *device,\n"
12416 " const char *mountpoint);\n"
12421 #: ../src/guestfs-actions.pod:4506
12423 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12424 "the mount options as for the L<mount(8)> I<-o> flag."
12428 #: ../src/guestfs-actions.pod:4510 ../fish/guestfish-actions.pod:3017
12430 "If the C<options> parameter is an empty string, then no options are passed "
12431 "(all options default to whatever the filesystem uses)."
12435 #: ../src/guestfs-actions.pod:4516 ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4547
12436 msgid "(Added in 1.0.10)"
12440 #: ../src/guestfs-actions.pod:4518
12441 msgid "guestfs_mount_ro"
12445 #: ../src/guestfs-actions.pod:4520
12449 " guestfs_mount_ro (guestfs_h *g,\n"
12450 " const char *device,\n"
12451 " const char *mountpoint);\n"
12456 #: ../src/guestfs-actions.pod:4525
12458 "This is the same as the C<guestfs_mount> command, but it mounts the "
12459 "filesystem with the read-only (I<-o ro>) flag."
12463 #: ../src/guestfs-actions.pod:4532
12464 msgid "guestfs_mount_vfs"
12468 #: ../src/guestfs-actions.pod:4534
12472 " guestfs_mount_vfs (guestfs_h *g,\n"
12473 " const char *options,\n"
12474 " const char *vfstype,\n"
12475 " const char *device,\n"
12476 " const char *mountpoint);\n"
12481 #: ../src/guestfs-actions.pod:4541
12483 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12484 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
12489 #: ../src/guestfs-actions.pod:4549
12490 msgid "guestfs_mountpoints"
12494 #: ../src/guestfs-actions.pod:4551
12498 " guestfs_mountpoints (guestfs_h *g);\n"
12503 #: ../src/guestfs-actions.pod:4554
12505 "This call is similar to C<guestfs_mounts>. That call returns a list of "
12506 "devices. This one returns a hash table (map) of device name to directory "
12507 "where the device is mounted."
12511 #: ../src/guestfs-actions.pod:4566
12512 msgid "guestfs_mounts"
12516 #: ../src/guestfs-actions.pod:4568
12520 " guestfs_mounts (guestfs_h *g);\n"
12525 #: ../src/guestfs-actions.pod:4571 ../fish/guestfish-actions.pod:3048
12527 "This returns the list of currently mounted filesystems. It returns the list "
12528 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12532 #: ../src/guestfs-actions.pod:4574 ../fish/guestfish-actions.pod:3051
12533 msgid "Some internal mounts are not shown."
12537 #: ../src/guestfs-actions.pod:4576
12538 msgid "See also: C<guestfs_mountpoints>"
12542 #: ../src/guestfs-actions.pod:4584
12547 #: ../src/guestfs-actions.pod:4586
12551 " guestfs_mv (guestfs_h *g,\n"
12552 " const char *src,\n"
12553 " const char *dest);\n"
12558 #: ../src/guestfs-actions.pod:4591 ../fish/guestfish-actions.pod:3059
12560 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12561 "destination filename or destination directory."
12565 #: ../src/guestfs-actions.pod:4598
12566 msgid "guestfs_ntfs_3g_probe"
12570 #: ../src/guestfs-actions.pod:4600
12574 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12576 " const char *device);\n"
12581 #: ../src/guestfs-actions.pod:4605 ../fish/guestfish-actions.pod:3066
12583 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12584 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12585 "read-write, and some cannot be mounted at all)."
12589 #: ../src/guestfs-actions.pod:4609 ../fish/guestfish-actions.pod:3070
12591 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12592 "can be mounted read-write. Set it to false if you want to test if the "
12593 "volume can be mounted read-only."
12597 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3074
12599 "The return value is an integer which C<0> if the operation would succeed, or "
12600 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12604 #: ../src/guestfs-actions.pod:4619
12605 msgid "(Added in 1.0.43)"
12609 #: ../src/guestfs-actions.pod:4621
12610 msgid "guestfs_ntfsresize"
12614 #: ../src/guestfs-actions.pod:4623
12618 " guestfs_ntfsresize (guestfs_h *g,\n"
12619 " const char *device);\n"
12624 #: ../src/guestfs-actions.pod:4627 ../fish/guestfish-actions.pod:3082
12626 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12627 "size of the underlying device. See also L<ntfsresize(8)>."
12631 #: ../src/guestfs-actions.pod:4635
12632 msgid "guestfs_ntfsresize_size"
12636 #: ../src/guestfs-actions.pod:4637
12640 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12641 " const char *device,\n"
12642 " int64_t size);\n"
12647 #: ../src/guestfs-actions.pod:4642
12649 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12650 "to specify the new size (in bytes) explicitly."
12654 #: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:5083 ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:6944
12655 msgid "(Added in 1.3.14)"
12659 #: ../src/guestfs-actions.pod:4649
12660 msgid "guestfs_part_add"
12664 #: ../src/guestfs-actions.pod:4651
12668 " guestfs_part_add (guestfs_h *g,\n"
12669 " const char *device,\n"
12670 " const char *prlogex,\n"
12671 " int64_t startsect,\n"
12672 " int64_t endsect);\n"
12677 #: ../src/guestfs-actions.pod:4658
12679 "This command adds a partition to C<device>. If there is no partition table "
12680 "on the device, call C<guestfs_part_init> first."
12684 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3100
12686 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12687 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12688 "C<logical>) and C<e> (or C<extended>) partition types."
12692 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3105
12694 "C<startsect> and C<endsect> are the start and end of the partition in "
12695 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12696 "from the end of the disk (C<-1> is the last sector)."
12700 #: ../src/guestfs-actions.pod:4670
12702 "Creating a partition which covers the whole disk is not so easy. Use "
12703 "C<guestfs_part_disk> to do that."
12707 #: ../src/guestfs-actions.pod:4675 ../src/guestfs-actions.pod:4713 ../src/guestfs-actions.pod:4766 ../src/guestfs-actions.pod:4844 ../src/guestfs-actions.pod:4882 ../src/guestfs-actions.pod:4901 ../src/guestfs-actions.pod:4941
12708 msgid "(Added in 1.0.78)"
12712 #: ../src/guestfs-actions.pod:4677
12713 msgid "guestfs_part_del"
12717 #: ../src/guestfs-actions.pod:4679
12721 " guestfs_part_del (guestfs_h *g,\n"
12722 " const char *device,\n"
12728 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3116
12729 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12733 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3118
12735 "Note that in the case of MBR partitioning, deleting an extended partition "
12736 "also deletes any logical partitions it contains."
12740 #: ../src/guestfs-actions.pod:4694
12741 msgid "guestfs_part_disk"
12745 #: ../src/guestfs-actions.pod:4696
12749 " guestfs_part_disk (guestfs_h *g,\n"
12750 " const char *device,\n"
12751 " const char *parttype);\n"
12756 #: ../src/guestfs-actions.pod:4701
12758 "This command is simply a combination of C<guestfs_part_init> followed by "
12759 "C<guestfs_part_add> to create a single primary partition covering the whole "
12764 #: ../src/guestfs-actions.pod:4705
12766 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12767 "possible values are described in C<guestfs_part_init>."
12771 #: ../src/guestfs-actions.pod:4715
12772 msgid "guestfs_part_get_bootable"
12776 #: ../src/guestfs-actions.pod:4717
12780 " guestfs_part_get_bootable (guestfs_h *g,\n"
12781 " const char *device,\n"
12787 #: ../src/guestfs-actions.pod:4722 ../fish/guestfish-actions.pod:3140
12789 "This command returns true if the partition C<partnum> on C<device> has the "
12790 "bootable flag set."
12794 #: ../src/guestfs-actions.pod:4725
12795 msgid "See also C<guestfs_part_set_bootable>."
12799 #: ../src/guestfs-actions.pod:4731
12800 msgid "guestfs_part_get_mbr_id"
12804 #: ../src/guestfs-actions.pod:4733
12808 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12809 " const char *device,\n"
12815 #: ../src/guestfs-actions.pod:4738 ../fish/guestfish-actions.pod:3149
12817 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12818 "partition C<partnum>."
12822 #: ../src/guestfs-actions.pod:4741 ../src/guestfs-actions.pod:4917
12824 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12825 "undefined results for other partition table types (see "
12826 "C<guestfs_part_get_parttype>)."
12830 #: ../src/guestfs-actions.pod:4749
12831 msgid "guestfs_part_get_parttype"
12835 #: ../src/guestfs-actions.pod:4751
12839 " guestfs_part_get_parttype (guestfs_h *g,\n"
12840 " const char *device);\n"
12845 #: ../src/guestfs-actions.pod:4755 ../fish/guestfish-actions.pod:3160
12847 "This command examines the partition table on C<device> and returns the "
12848 "partition table type (format) being used."
12852 #: ../src/guestfs-actions.pod:4758
12854 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12855 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12856 "possible, although unusual. See C<guestfs_part_init> for a full list."
12860 #: ../src/guestfs-actions.pod:4768
12861 msgid "guestfs_part_init"
12865 #: ../src/guestfs-actions.pod:4770
12869 " guestfs_part_init (guestfs_h *g,\n"
12870 " const char *device,\n"
12871 " const char *parttype);\n"
12876 #: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3172
12878 "This creates an empty partition table on C<device> of one of the partition "
12879 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12880 "(for large disks)."
12884 #: ../src/guestfs-actions.pod:4779
12886 "Initially there are no partitions. Following this, you should call "
12887 "C<guestfs_part_add> for each partition required."
12891 #: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3179
12892 msgid "Possible values for C<parttype> are:"
12896 #: ../src/guestfs-actions.pod:4786 ../fish/guestfish-actions.pod:3183
12897 msgid "B<efi> | B<gpt>"
12901 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3185
12902 msgid "Intel EFI / GPT partition table."
12906 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3187
12908 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12909 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12910 "the C<mbr> format."
12914 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3191
12915 msgid "B<mbr> | B<msdos>"
12919 #: ../src/guestfs-actions.pod:4796 ../fish/guestfish-actions.pod:3193
12921 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12922 "Windows. This partition type will B<only> work for device sizes up to 2 "
12923 "TB. For large disks we recommend using C<gpt>."
12927 #: ../src/guestfs-actions.pod:4803 ../fish/guestfish-actions.pod:3200
12928 msgid "Other partition table types that may work but are not supported include:"
12932 #: ../src/guestfs-actions.pod:4808 ../fish/guestfish-actions.pod:3205
12937 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3207
12938 msgid "AIX disk labels."
12942 #: ../src/guestfs-actions.pod:4812 ../fish/guestfish-actions.pod:3209
12943 msgid "B<amiga> | B<rdb>"
12947 #: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3211
12948 msgid "Amiga \"Rigid Disk Block\" format."
12952 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3213
12957 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3215
12958 msgid "BSD disk labels."
12962 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:3217
12967 #: ../src/guestfs-actions.pod:4822 ../fish/guestfish-actions.pod:3219
12968 msgid "DASD, used on IBM mainframes."
12972 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3221
12977 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3223
12978 msgid "MIPS/SGI volumes."
12982 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3225
12987 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3227
12988 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12992 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3229
12997 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3231
12998 msgid "NEC PC-98 format, common in Japan apparently."
13002 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3233
13007 #: ../src/guestfs-actions.pod:4838 ../fish/guestfish-actions.pod:3235
13008 msgid "Sun disk labels."
13012 #: ../src/guestfs-actions.pod:4846
13013 msgid "guestfs_part_list"
13017 #: ../src/guestfs-actions.pod:4848
13020 " struct guestfs_partition_list *\n"
13021 " guestfs_part_list (guestfs_h *g,\n"
13022 " const char *device);\n"
13027 #: ../src/guestfs-actions.pod:4852 ../fish/guestfish-actions.pod:3243
13029 "This command parses the partition table on C<device> and returns the list of "
13030 "partitions found."
13034 #: ../src/guestfs-actions.pod:4855 ../fish/guestfish-actions.pod:3246
13035 msgid "The fields in the returned structure are:"
13039 #: ../src/guestfs-actions.pod:4859 ../fish/guestfish-actions.pod:3250
13040 msgid "B<part_num>"
13044 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3252
13045 msgid "Partition number, counting from 1."
13049 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3254
13050 msgid "B<part_start>"
13054 #: ../src/guestfs-actions.pod:4865
13056 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13057 "the device's sector size, see C<guestfs_blockdev_getss>."
13061 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3259
13062 msgid "B<part_end>"
13066 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3261
13067 msgid "End of the partition in bytes."
13071 #: ../src/guestfs-actions.pod:4872 ../fish/guestfish-actions.pod:3263
13072 msgid "B<part_size>"
13076 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3265
13077 msgid "Size of the partition in bytes."
13081 #: ../src/guestfs-actions.pod:4878
13083 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13084 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13089 #: ../src/guestfs-actions.pod:4884
13090 msgid "guestfs_part_set_bootable"
13094 #: ../src/guestfs-actions.pod:4886
13098 " guestfs_part_set_bootable (guestfs_h *g,\n"
13099 " const char *device,\n"
13101 " int bootable);\n"
13106 #: ../src/guestfs-actions.pod:4892 ../fish/guestfish-actions.pod:3273
13108 "This sets the bootable flag on partition numbered C<partnum> on device "
13109 "C<device>. Note that partitions are numbered from 1."
13113 #: ../src/guestfs-actions.pod:4895 ../fish/guestfish-actions.pod:3276
13115 "The bootable flag is used by some operating systems (notably Windows) to "
13116 "determine which partition to boot from. It is by no means universally "
13121 #: ../src/guestfs-actions.pod:4903
13122 msgid "guestfs_part_set_mbr_id"
13126 #: ../src/guestfs-actions.pod:4905
13130 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13131 " const char *device,\n"
13138 #: ../src/guestfs-actions.pod:4911 ../fish/guestfish-actions.pod:3284
13140 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13141 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13142 "documentation are in fact hexadecimal numbers, but usually documented "
13143 "without any leading \"0x\" which might be confusing."
13147 #: ../src/guestfs-actions.pod:4925
13148 msgid "guestfs_part_set_name"
13152 #: ../src/guestfs-actions.pod:4927
13156 " guestfs_part_set_name (guestfs_h *g,\n"
13157 " const char *device,\n"
13159 " const char *name);\n"
13164 #: ../src/guestfs-actions.pod:4933 ../fish/guestfish-actions.pod:3298
13166 "This sets the partition name on partition numbered C<partnum> on device "
13167 "C<device>. Note that partitions are numbered from 1."
13171 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3301
13173 "The partition name can only be set on certain types of partition table. "
13174 "This works on C<gpt> but not on C<mbr> partitions."
13178 #: ../src/guestfs-actions.pod:4943
13179 msgid "guestfs_part_to_dev"
13183 #: ../src/guestfs-actions.pod:4945
13187 " guestfs_part_to_dev (guestfs_h *g,\n"
13188 " const char *partition);\n"
13193 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3308
13195 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13196 "partition number, returning the device name (eg. \"/dev/sdb\")."
13200 #: ../src/guestfs-actions.pod:4953
13202 "The named partition must exist, for example as a string returned from "
13203 "C<guestfs_list_partitions>."
13207 #: ../src/guestfs-actions.pod:4961
13208 msgid "guestfs_ping_daemon"
13212 #: ../src/guestfs-actions.pod:4963
13216 " guestfs_ping_daemon (guestfs_h *g);\n"
13221 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3319
13223 "This is a test probe into the guestfs daemon running inside the qemu "
13224 "subprocess. Calling this function checks that the daemon responds to the "
13225 "ping message, without affecting the daemon or attached block device(s) in "
13230 #: ../src/guestfs-actions.pod:4975
13231 msgid "guestfs_pread"
13235 #: ../src/guestfs-actions.pod:4977
13239 " guestfs_pread (guestfs_h *g,\n"
13240 " const char *path,\n"
13242 " int64_t offset,\n"
13243 " size_t *size_r);\n"
13248 #: ../src/guestfs-actions.pod:4984 ../fish/guestfish-actions.pod:3328
13250 "This command lets you read part of a file. It reads C<count> bytes of the "
13251 "file, starting at C<offset>, from file C<path>."
13255 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:5013 ../fish/guestfish-actions.pod:3331 ../fish/guestfish-actions.pod:3346
13257 "This may read fewer bytes than requested. For further details see the "
13258 "L<pread(2)> system call."
13262 #: ../src/guestfs-actions.pod:4990
13263 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
13267 #: ../src/guestfs-actions.pod:5001
13268 msgid "guestfs_pread_device"
13272 #: ../src/guestfs-actions.pod:5003
13276 " guestfs_pread_device (guestfs_h *g,\n"
13277 " const char *device,\n"
13279 " int64_t offset,\n"
13280 " size_t *size_r);\n"
13285 #: ../src/guestfs-actions.pod:5010 ../fish/guestfish-actions.pod:3343
13287 "This command lets you read part of a file. It reads C<count> bytes of "
13288 "C<device>, starting at C<offset>."
13292 #: ../src/guestfs-actions.pod:5016
13293 msgid "See also C<guestfs_pread>."
13297 #: ../src/guestfs-actions.pod:5025
13298 msgid "(Added in 1.5.21)"
13302 #: ../src/guestfs-actions.pod:5027
13303 msgid "guestfs_pvcreate"
13307 #: ../src/guestfs-actions.pod:5029
13311 " guestfs_pvcreate (guestfs_h *g,\n"
13312 " const char *device);\n"
13317 #: ../src/guestfs-actions.pod:5033 ../fish/guestfish-actions.pod:3358
13319 "This creates an LVM physical volume on the named C<device>, where C<device> "
13320 "should usually be a partition name such as C</dev/sda1>."
13324 #: ../src/guestfs-actions.pod:5041
13325 msgid "guestfs_pvremove"
13329 #: ../src/guestfs-actions.pod:5043
13333 " guestfs_pvremove (guestfs_h *g,\n"
13334 " const char *device);\n"
13339 #: ../src/guestfs-actions.pod:5047 ../fish/guestfish-actions.pod:3366
13341 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13346 #: ../src/guestfs-actions.pod:5050 ../fish/guestfish-actions.pod:3369
13348 "The implementation uses the C<pvremove> command which refuses to wipe "
13349 "physical volumes that contain any volume groups, so you have to remove those "
13354 #: ../src/guestfs-actions.pod:5058
13355 msgid "guestfs_pvresize"
13359 #: ../src/guestfs-actions.pod:5060
13363 " guestfs_pvresize (guestfs_h *g,\n"
13364 " const char *device);\n"
13369 #: ../src/guestfs-actions.pod:5064 ../fish/guestfish-actions.pod:3377
13371 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13372 "the new size of the underlying device."
13376 #: ../src/guestfs-actions.pod:5071
13377 msgid "guestfs_pvresize_size"
13381 #: ../src/guestfs-actions.pod:5073
13385 " guestfs_pvresize_size (guestfs_h *g,\n"
13386 " const char *device,\n"
13387 " int64_t size);\n"
13392 #: ../src/guestfs-actions.pod:5078
13394 "This command is the same as C<guestfs_pvresize> except that it allows you to "
13395 "specify the new size (in bytes) explicitly."
13399 #: ../src/guestfs-actions.pod:5085
13400 msgid "guestfs_pvs"
13404 #: ../src/guestfs-actions.pod:5087
13408 " guestfs_pvs (guestfs_h *g);\n"
13413 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3391
13415 "List all the physical volumes detected. This is the equivalent of the "
13416 "L<pvs(8)> command."
13420 #: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3394
13422 "This returns a list of just the device names that contain PVs "
13423 "(eg. C</dev/sda2>)."
13427 #: ../src/guestfs-actions.pod:5096
13428 msgid "See also C<guestfs_pvs_full>."
13432 #: ../src/guestfs-actions.pod:5104
13433 msgid "guestfs_pvs_full"
13437 #: ../src/guestfs-actions.pod:5106
13440 " struct guestfs_lvm_pv_list *\n"
13441 " guestfs_pvs_full (guestfs_h *g);\n"
13446 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3403
13448 "List all the physical volumes detected. This is the equivalent of the "
13449 "L<pvs(8)> command. The \"full\" version includes all fields."
13453 #: ../src/guestfs-actions.pod:5112
13455 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
13456 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
13461 #: ../src/guestfs-actions.pod:5118
13462 msgid "guestfs_pvuuid"
13466 #: ../src/guestfs-actions.pod:5120
13470 " guestfs_pvuuid (guestfs_h *g,\n"
13471 " const char *device);\n"
13476 #: ../src/guestfs-actions.pod:5124 ../fish/guestfish-actions.pod:3410
13477 msgid "This command returns the UUID of the LVM PV C<device>."
13481 #: ../src/guestfs-actions.pod:5131
13482 msgid "guestfs_pwrite"
13486 #: ../src/guestfs-actions.pod:5133
13490 " guestfs_pwrite (guestfs_h *g,\n"
13491 " const char *path,\n"
13492 " const char *content,\n"
13493 " size_t content_size,\n"
13494 " int64_t offset);\n"
13499 #: ../src/guestfs-actions.pod:5140 ../fish/guestfish-actions.pod:3416
13501 "This command writes to part of a file. It writes the data buffer C<content> "
13502 "to the file C<path> starting at offset C<offset>."
13506 #: ../src/guestfs-actions.pod:5143 ../fish/guestfish-actions.pod:3419
13508 "This command implements the L<pwrite(2)> system call, and like that system "
13509 "call it may not write the full data requested. The return value is the "
13510 "number of bytes that were actually written to the file. This could even be "
13511 "0, although short writes are unlikely for regular files in ordinary "
13516 #: ../src/guestfs-actions.pod:5149
13517 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
13521 #: ../src/guestfs-actions.pod:5158
13522 msgid "guestfs_pwrite_device"
13526 #: ../src/guestfs-actions.pod:5160
13530 " guestfs_pwrite_device (guestfs_h *g,\n"
13531 " const char *device,\n"
13532 " const char *content,\n"
13533 " size_t content_size,\n"
13534 " int64_t offset);\n"
13539 #: ../src/guestfs-actions.pod:5167 ../fish/guestfish-actions.pod:3434
13541 "This command writes to part of a device. It writes the data buffer "
13542 "C<content> to C<device> starting at offset C<offset>."
13546 #: ../src/guestfs-actions.pod:5170 ../fish/guestfish-actions.pod:3437
13548 "This command implements the L<pwrite(2)> system call, and like that system "
13549 "call it may not write the full data requested (although short writes to disk "
13550 "devices and partitions are probably impossible with standard Linux kernels)."
13554 #: ../src/guestfs-actions.pod:5175
13555 msgid "See also C<guestfs_pwrite>."
13559 #: ../src/guestfs-actions.pod:5182
13560 msgid "(Added in 1.5.20)"
13564 #: ../src/guestfs-actions.pod:5184
13565 msgid "guestfs_read_file"
13569 #: ../src/guestfs-actions.pod:5186
13573 " guestfs_read_file (guestfs_h *g,\n"
13574 " const char *path,\n"
13575 " size_t *size_r);\n"
13580 #: ../src/guestfs-actions.pod:5191 ../fish/guestfish-actions.pod:3451
13581 msgid "This calls returns the contents of the file C<path> as a buffer."
13585 #: ../src/guestfs-actions.pod:5194
13587 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13588 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13589 "function is limited in the total size of file that can be handled."
13593 #: ../src/guestfs-actions.pod:5206
13594 msgid "(Added in 1.0.63)"
13598 #: ../src/guestfs-actions.pod:5208
13599 msgid "guestfs_read_lines"
13603 #: ../src/guestfs-actions.pod:5210
13607 " guestfs_read_lines (guestfs_h *g,\n"
13608 " const char *path);\n"
13613 #: ../src/guestfs-actions.pod:5216 ../fish/guestfish-actions.pod:3468
13615 "The file contents are returned as a list of lines. Trailing C<LF> and "
13616 "C<CRLF> character sequences are I<not> returned."
13620 #: ../src/guestfs-actions.pod:5219
13622 "Note that this function cannot correctly handle binary files (specifically, "
13623 "files containing C<\\0> character which is treated as end of line). For "
13624 "those you need to use the C<guestfs_read_file> function which has a more "
13625 "complex interface."
13629 #: ../src/guestfs-actions.pod:5230
13630 msgid "guestfs_readdir"
13634 #: ../src/guestfs-actions.pod:5232
13637 " struct guestfs_dirent_list *\n"
13638 " guestfs_readdir (guestfs_h *g,\n"
13639 " const char *dir);\n"
13644 #: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:3480
13645 msgid "This returns the list of directory entries in directory C<dir>."
13649 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3482
13651 "All entries in the directory are returned, including C<.> and C<..>. The "
13652 "entries are I<not> sorted, but returned in the same order as the underlying "
13657 #: ../src/guestfs-actions.pod:5242 ../fish/guestfish-actions.pod:3486
13659 "Also this call returns basic file type information about each file. The "
13660 "C<ftyp> field will contain one of the following characters:"
13664 #: ../src/guestfs-actions.pod:5247 ../fish/guestfish-actions.pod:3491
13669 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3493
13670 msgid "Block special"
13674 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3495
13679 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:3497
13680 msgid "Char special"
13684 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3499
13689 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3501
13694 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3503
13699 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3505
13700 msgid "FIFO (named pipe)"
13704 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3507
13709 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3509
13710 msgid "Symbolic link"
13714 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3511
13719 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:3513
13720 msgid "Regular file"
13724 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3515
13729 #: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:3517
13734 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3519
13739 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3521
13740 msgid "Unknown file type"
13744 #: ../src/guestfs-actions.pod:5279 ../fish/guestfish-actions.pod:3523
13749 #: ../src/guestfs-actions.pod:5281 ../fish/guestfish-actions.pod:3525
13750 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13754 #: ../src/guestfs-actions.pod:5286
13756 "This function is primarily intended for use by programs. To get a simple "
13757 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13758 "consumption, use C<guestfs_ll>."
13762 #: ../src/guestfs-actions.pod:5290
13764 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13765 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
13770 #: ../src/guestfs-actions.pod:5296
13771 msgid "guestfs_readlink"
13775 #: ../src/guestfs-actions.pod:5298
13779 " guestfs_readlink (guestfs_h *g,\n"
13780 " const char *path);\n"
13785 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3538
13786 msgid "This command reads the target of a symbolic link."
13790 #: ../src/guestfs-actions.pod:5309
13791 msgid "guestfs_readlinklist"
13795 #: ../src/guestfs-actions.pod:5311
13799 " guestfs_readlinklist (guestfs_h *g,\n"
13800 " const char *path,\n"
13801 " char *const *names);\n"
13806 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3544
13808 "This call allows you to do a C<readlink> operation on multiple files, where "
13809 "all files are in the directory C<path>. C<names> is the list of files from "
13814 #: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:3548
13816 "On return you get a list of strings, with a one-to-one correspondence to the "
13817 "C<names> list. Each string is the value of the symbolic link."
13821 #: ../src/guestfs-actions.pod:5324 ../fish/guestfish-actions.pod:3552
13823 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13824 "result string is the empty string C<\"\">. However the whole operation is "
13825 "completed even if there were C<readlink(2)> errors, and so you can call this "
13826 "function with names where you don't know if they are symbolic links already "
13827 "(albeit slightly less efficient)."
13831 #: ../src/guestfs-actions.pod:5331 ../fish/guestfish-actions.pod:3559
13833 "This call is intended for programs that want to efficiently list a directory "
13834 "contents without making many round-trips. Very long directory listings "
13835 "might cause the protocol message size to be exceeded, causing this call to "
13836 "fail. The caller must split up such requests into smaller groups of names."
13840 #: ../src/guestfs-actions.pod:5344
13841 msgid "guestfs_realpath"
13845 #: ../src/guestfs-actions.pod:5346
13849 " guestfs_realpath (guestfs_h *g,\n"
13850 " const char *path);\n"
13855 #: ../src/guestfs-actions.pod:5350 ../fish/guestfish-actions.pod:3570
13857 "Return the canonicalized absolute pathname of C<path>. The returned path "
13858 "has no C<.>, C<..> or symbolic link path elements."
13862 #: ../src/guestfs-actions.pod:5358
13863 msgid "guestfs_removexattr"
13867 #: ../src/guestfs-actions.pod:5360
13871 " guestfs_removexattr (guestfs_h *g,\n"
13872 " const char *xattr,\n"
13873 " const char *path);\n"
13878 #: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:3577
13879 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
13883 #: ../src/guestfs-actions.pod:5368
13884 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13888 #: ../src/guestfs-actions.pod:5374
13889 msgid "guestfs_resize2fs"
13893 #: ../src/guestfs-actions.pod:5376
13897 " guestfs_resize2fs (guestfs_h *g,\n"
13898 " const char *device);\n"
13903 #: ../src/guestfs-actions.pod:5380 ../fish/guestfish-actions.pod:3586
13905 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13906 "underlying device."
13910 #: ../src/guestfs-actions.pod:5383
13912 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13913 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13914 "sometimes gives an error about this and sometimes not. In any case, it is "
13915 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13919 #: ../src/guestfs-actions.pod:5393
13920 msgid "guestfs_resize2fs_size"
13924 #: ../src/guestfs-actions.pod:5395
13928 " guestfs_resize2fs_size (guestfs_h *g,\n"
13929 " const char *device,\n"
13930 " int64_t size);\n"
13935 #: ../src/guestfs-actions.pod:5400
13937 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13938 "to specify the new size (in bytes) explicitly."
13942 #: ../src/guestfs-actions.pod:5407
13947 #: ../src/guestfs-actions.pod:5409
13951 " guestfs_rm (guestfs_h *g,\n"
13952 " const char *path);\n"
13957 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3606
13958 msgid "Remove the single file C<path>."
13962 #: ../src/guestfs-actions.pod:5419
13963 msgid "guestfs_rm_rf"
13967 #: ../src/guestfs-actions.pod:5421
13971 " guestfs_rm_rf (guestfs_h *g,\n"
13972 " const char *path);\n"
13977 #: ../src/guestfs-actions.pod:5425 ../fish/guestfish-actions.pod:3612
13979 "Remove the file or directory C<path>, recursively removing the contents if "
13980 "its a directory. This is like the C<rm -rf> shell command."
13984 #: ../src/guestfs-actions.pod:5433
13985 msgid "guestfs_rmdir"
13989 #: ../src/guestfs-actions.pod:5435
13993 " guestfs_rmdir (guestfs_h *g,\n"
13994 " const char *path);\n"
13999 #: ../src/guestfs-actions.pod:5439 ../fish/guestfish-actions.pod:3620
14000 msgid "Remove the single directory C<path>."
14004 #: ../src/guestfs-actions.pod:5445
14005 msgid "guestfs_rmmountpoint"
14009 #: ../src/guestfs-actions.pod:5447
14013 " guestfs_rmmountpoint (guestfs_h *g,\n"
14014 " const char *exemptpath);\n"
14019 #: ../src/guestfs-actions.pod:5451
14021 "This calls removes a mountpoint that was previously created with "
14022 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14026 #: ../src/guestfs-actions.pod:5459
14027 msgid "guestfs_scrub_device"
14031 #: ../src/guestfs-actions.pod:5461
14035 " guestfs_scrub_device (guestfs_h *g,\n"
14036 " const char *device);\n"
14041 #: ../src/guestfs-actions.pod:5465 ../fish/guestfish-actions.pod:3634
14043 "This command writes patterns over C<device> to make data retrieval more "
14048 #: ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:5489 ../src/guestfs-actions.pod:5508 ../fish/guestfish-actions.pod:3637 ../fish/guestfish-actions.pod:3652 ../fish/guestfish-actions.pod:3665
14050 "It is an interface to the L<scrub(1)> program. See that manual page for "
14055 #: ../src/guestfs-actions.pod:5476 ../src/guestfs-actions.pod:5494 ../src/guestfs-actions.pod:5513
14056 msgid "(Added in 1.0.52)"
14060 #: ../src/guestfs-actions.pod:5478
14061 msgid "guestfs_scrub_file"
14065 #: ../src/guestfs-actions.pod:5480
14069 " guestfs_scrub_file (guestfs_h *g,\n"
14070 " const char *file);\n"
14075 #: ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:3647
14077 "This command writes patterns over a file to make data retrieval more "
14082 #: ../src/guestfs-actions.pod:5487 ../fish/guestfish-actions.pod:3650
14083 msgid "The file is I<removed> after scrubbing."
14087 #: ../src/guestfs-actions.pod:5496
14088 msgid "guestfs_scrub_freespace"
14092 #: ../src/guestfs-actions.pod:5498
14096 " guestfs_scrub_freespace (guestfs_h *g,\n"
14097 " const char *dir);\n"
14102 #: ../src/guestfs-actions.pod:5502
14104 "This command creates the directory C<dir> and then fills it with files until "
14105 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14106 "and deletes them. The intention is to scrub any free space on the partition "
14107 "containing C<dir>."
14111 #: ../src/guestfs-actions.pod:5515
14112 msgid "guestfs_set_append"
14116 #: ../src/guestfs-actions.pod:5517
14120 " guestfs_set_append (guestfs_h *g,\n"
14121 " const char *append);\n"
14126 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3674
14128 "This function is used to add additional options to the guest kernel command "
14133 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3677
14135 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14136 "environment variable."
14140 #: ../src/guestfs-actions.pod:5527 ../fish/guestfish-actions.pod:3680
14142 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14143 "(libguestfs always adds a few of its own)."
14147 #: ../src/guestfs-actions.pod:5534
14148 msgid "guestfs_set_autosync"
14152 #: ../src/guestfs-actions.pod:5536
14156 " guestfs_set_autosync (guestfs_h *g,\n"
14157 " int autosync);\n"
14162 #: ../src/guestfs-actions.pod:5540
14164 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14165 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
14166 "the handle is closed (also if the program exits without closing handles)."
14170 #: ../src/guestfs-actions.pod:5545 ../fish/guestfish-actions.pod:3694
14172 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14173 "disabled by default)."
14177 #: ../src/guestfs-actions.pod:5552
14178 msgid "guestfs_set_direct"
14182 #: ../src/guestfs-actions.pod:5554
14186 " guestfs_set_direct (guestfs_h *g,\n"
14192 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3703
14194 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14195 "passed directly through to the appliance once it is launched."
14199 #: ../src/guestfs-actions.pod:5562
14201 "One consequence of this is that log messages aren't caught by the library "
14202 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
14207 #: ../src/guestfs-actions.pod:5566 ../fish/guestfish-actions.pod:3711
14208 msgid "You probably don't want to use this unless you know what you are doing."
14212 #: ../src/guestfs-actions.pod:5569 ../fish/guestfish-actions.pod:3714
14213 msgid "The default is disabled."
14217 #: ../src/guestfs-actions.pod:5575
14218 msgid "guestfs_set_e2label"
14222 #: ../src/guestfs-actions.pod:5577
14226 " guestfs_set_e2label (guestfs_h *g,\n"
14227 " const char *device,\n"
14228 " const char *label);\n"
14233 #: ../src/guestfs-actions.pod:5582 ../fish/guestfish-actions.pod:3720
14235 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14236 "C<label>. Filesystem labels are limited to 16 characters."
14240 #: ../src/guestfs-actions.pod:5586
14242 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
14243 "the existing label on a filesystem."
14247 #: ../src/guestfs-actions.pod:5593
14248 msgid "guestfs_set_e2uuid"
14252 #: ../src/guestfs-actions.pod:5595
14256 " guestfs_set_e2uuid (guestfs_h *g,\n"
14257 " const char *device,\n"
14258 " const char *uuid);\n"
14263 #: ../src/guestfs-actions.pod:5600 ../fish/guestfish-actions.pod:3731
14265 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14266 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14267 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14271 #: ../src/guestfs-actions.pod:5605
14273 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
14274 "the existing UUID of a filesystem."
14278 #: ../src/guestfs-actions.pod:5612
14279 msgid "guestfs_set_memsize"
14283 #: ../src/guestfs-actions.pod:5614
14287 " guestfs_set_memsize (guestfs_h *g,\n"
14293 #: ../src/guestfs-actions.pod:5618
14295 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14296 "This only has any effect if called before C<guestfs_launch>."
14300 #: ../src/guestfs-actions.pod:5622 ../fish/guestfish-actions.pod:3749
14302 "You can also change this by setting the environment variable "
14303 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14307 #: ../src/guestfs-actions.pod:5633
14308 msgid "guestfs_set_network"
14312 #: ../src/guestfs-actions.pod:5635
14316 " guestfs_set_network (guestfs_h *g,\n"
14322 #: ../src/guestfs-actions.pod:5639 ../fish/guestfish-actions.pod:3762
14324 "If C<network> is true, then the network is enabled in the libguestfs "
14325 "appliance. The default is false."
14329 #: ../src/guestfs-actions.pod:5642 ../fish/guestfish-actions.pod:3765
14331 "This affects whether commands are able to access the network (see "
14332 "L<guestfs(3)/RUNNING COMMANDS>)."
14336 #: ../src/guestfs-actions.pod:5645
14338 "You must call this before calling C<guestfs_launch>, otherwise it has no "
14343 #: ../src/guestfs-actions.pod:5652
14344 msgid "guestfs_set_path"
14348 #: ../src/guestfs-actions.pod:5654
14352 " guestfs_set_path (guestfs_h *g,\n"
14353 " const char *searchpath);\n"
14358 #: ../src/guestfs-actions.pod:5658 ../fish/guestfish-actions.pod:3777
14359 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14363 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3779
14365 "The default is C<$libdir/guestfs> unless overridden by setting "
14366 "C<LIBGUESTFS_PATH> environment variable."
14370 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3782
14371 msgid "Setting C<path> to C<NULL> restores the default path."
14375 #: ../src/guestfs-actions.pod:5669
14376 msgid "guestfs_set_qemu"
14380 #: ../src/guestfs-actions.pod:5671
14384 " guestfs_set_qemu (guestfs_h *g,\n"
14385 " const char *qemu);\n"
14390 #: ../src/guestfs-actions.pod:5675 ../fish/guestfish-actions.pod:3790
14391 msgid "Set the qemu binary that we will use."
14395 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:3792
14396 msgid "The default is chosen when the library was compiled by the configure script."
14400 #: ../src/guestfs-actions.pod:5680 ../fish/guestfish-actions.pod:3795
14402 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14407 #: ../src/guestfs-actions.pod:5683 ../fish/guestfish-actions.pod:3798
14408 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14412 #: ../src/guestfs-actions.pod:5685 ../fish/guestfish-actions.pod:3800
14414 "Note that you should call this function as early as possible after creating "
14415 "the handle. This is because some pre-launch operations depend on testing "
14416 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14417 "don't retest features, and so you might see inconsistent results. Using the "
14418 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14419 "the qemu binary at the same time as the handle is created."
14423 #: ../src/guestfs-actions.pod:5697
14424 msgid "guestfs_set_recovery_proc"
14428 #: ../src/guestfs-actions.pod:5699
14432 " guestfs_set_recovery_proc (guestfs_h *g,\n"
14433 " int recoveryproc);\n"
14438 #: ../src/guestfs-actions.pod:5703
14440 "If this is called with the parameter C<false> then C<guestfs_launch> does "
14441 "not create a recovery process. The purpose of the recovery process is to "
14442 "stop runaway qemu processes in the case where the main program aborts "
14447 #: ../src/guestfs-actions.pod:5708
14449 "This only has any effect if called before C<guestfs_launch>, and the default "
14454 #: ../src/guestfs-actions.pod:5711 ../fish/guestfish-actions.pod:3822
14456 "About the only time when you would want to disable this is if the main "
14457 "process will fork itself into the background (\"daemonize\" itself). In "
14458 "this case the recovery process thinks that the main program has disappeared "
14459 "and so kills qemu, which is not very helpful."
14463 #: ../src/guestfs-actions.pod:5721
14464 msgid "guestfs_set_selinux"
14468 #: ../src/guestfs-actions.pod:5723
14472 " guestfs_set_selinux (guestfs_h *g,\n"
14478 #: ../src/guestfs-actions.pod:5727 ../fish/guestfish-actions.pod:3834
14480 "This sets the selinux flag that is passed to the appliance at boot time. "
14481 "The default is C<selinux=0> (disabled)."
14485 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:3837
14487 "Note that if SELinux is enabled, it is always in Permissive mode "
14488 "(C<enforcing=0>)."
14492 #: ../src/guestfs-actions.pod:5740
14493 msgid "guestfs_set_trace"
14497 #: ../src/guestfs-actions.pod:5742
14501 " guestfs_set_trace (guestfs_h *g,\n"
14507 #: ../src/guestfs-actions.pod:5746 ../fish/guestfish-actions.pod:3849
14509 "If the command trace flag is set to 1, then commands are printed on stderr "
14510 "before they are executed in a format which is very similar to the one used "
14511 "by guestfish. In other words, you can run a program with this enabled, and "
14512 "you will get out a script which you can feed to guestfish to perform the "
14513 "same set of actions."
14517 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3856
14519 "If you want to trace C API calls into libguestfs (and other libraries) then "
14520 "possibly a better way is to use the external ltrace(1) command."
14524 #: ../src/guestfs-actions.pod:5757 ../fish/guestfish-actions.pod:3860
14526 "Command traces are disabled unless the environment variable "
14527 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14531 #: ../src/guestfs-actions.pod:5764
14532 msgid "guestfs_set_verbose"
14536 #: ../src/guestfs-actions.pod:5766
14540 " guestfs_set_verbose (guestfs_h *g,\n"
14546 #: ../src/guestfs-actions.pod:5770 ../fish/guestfish-actions.pod:3869
14547 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
14551 #: ../src/guestfs-actions.pod:5772 ../fish/guestfish-actions.pod:3871
14553 "Verbose messages are disabled unless the environment variable "
14554 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14558 #: ../src/guestfs-actions.pod:5779
14559 msgid "guestfs_setcon"
14563 #: ../src/guestfs-actions.pod:5781
14567 " guestfs_setcon (guestfs_h *g,\n"
14568 " const char *context);\n"
14573 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3878
14575 "This sets the SELinux security context of the daemon to the string "
14580 #: ../src/guestfs-actions.pod:5788 ../fish/guestfish-actions.pod:3881
14581 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14585 #: ../src/guestfs-actions.pod:5794
14586 msgid "guestfs_setxattr"
14590 #: ../src/guestfs-actions.pod:5796
14594 " guestfs_setxattr (guestfs_h *g,\n"
14595 " const char *xattr,\n"
14596 " const char *val,\n"
14598 " const char *path);\n"
14603 #: ../src/guestfs-actions.pod:5803 ../fish/guestfish-actions.pod:3887
14605 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14606 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14610 #: ../src/guestfs-actions.pod:5807
14611 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14615 #: ../src/guestfs-actions.pod:5813
14616 msgid "guestfs_sfdisk"
14620 #: ../src/guestfs-actions.pod:5815
14624 " guestfs_sfdisk (guestfs_h *g,\n"
14625 " const char *device,\n"
14629 " char *const *lines);\n"
14634 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3897
14636 "This is a direct interface to the L<sfdisk(8)> program for creating "
14637 "partitions on block devices."
14641 #: ../src/guestfs-actions.pod:5826 ../fish/guestfish-actions.pod:3900
14642 msgid "C<device> should be a block device, for example C</dev/sda>."
14646 #: ../src/guestfs-actions.pod:5828 ../fish/guestfish-actions.pod:3902
14648 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14649 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14650 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14651 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14652 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14653 "the kernel) cannot work out the right geometry and you will need to tell it."
14657 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3910
14659 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14660 "refer to the L<sfdisk(8)> manpage."
14664 #: ../src/guestfs-actions.pod:5839 ../fish/guestfish-actions.pod:3913
14666 "To create a single partition occupying the whole disk, you would pass "
14667 "C<lines> as a single element list, when the single element being the string "
14672 #: ../src/guestfs-actions.pod:5843
14673 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14677 #: ../src/guestfs-actions.pod:5853
14678 msgid "guestfs_sfdiskM"
14682 #: ../src/guestfs-actions.pod:5855
14686 " guestfs_sfdiskM (guestfs_h *g,\n"
14687 " const char *device,\n"
14688 " char *const *lines);\n"
14693 #: ../src/guestfs-actions.pod:5860
14695 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14696 "partition sizes are specified in megabytes only (rounded to the nearest "
14697 "cylinder) and you don't need to specify the cyls, heads and sectors "
14698 "parameters which were rarely if ever used anyway."
14702 #: ../src/guestfs-actions.pod:5866
14704 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14705 "C<guestfs_part_disk>"
14709 #: ../src/guestfs-actions.pod:5876
14710 msgid "guestfs_sfdisk_N"
14714 #: ../src/guestfs-actions.pod:5878
14718 " guestfs_sfdisk_N (guestfs_h *g,\n"
14719 " const char *device,\n"
14724 " const char *line);\n"
14729 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3943
14731 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14732 "(note: C<n> counts from 1)."
14736 #: ../src/guestfs-actions.pod:5890
14738 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14739 "for the cyls/heads/sectors parameters."
14743 #: ../src/guestfs-actions.pod:5893
14744 msgid "See also: C<guestfs_part_add>"
14748 #: ../src/guestfs-actions.pod:5902
14749 msgid "guestfs_sfdisk_disk_geometry"
14753 #: ../src/guestfs-actions.pod:5904
14757 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14758 " const char *device);\n"
14763 #: ../src/guestfs-actions.pod:5908
14765 "This displays the disk geometry of C<device> read from the partition table. "
14766 "Especially in the case where the underlying block device has been resized, "
14767 "this can be different from the kernel's idea of the geometry (see "
14768 "C<guestfs_sfdisk_kernel_geometry>)."
14772 #: ../src/guestfs-actions.pod:5913 ../src/guestfs-actions.pod:5929 ../fish/guestfish-actions.pod:3963 ../fish/guestfish-actions.pod:3972
14773 msgid "The result is in human-readable format, and not designed to be parsed."
14777 #: ../src/guestfs-actions.pod:5921
14778 msgid "guestfs_sfdisk_kernel_geometry"
14782 #: ../src/guestfs-actions.pod:5923
14786 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14787 " const char *device);\n"
14792 #: ../src/guestfs-actions.pod:5927 ../fish/guestfish-actions.pod:3970
14793 msgid "This displays the kernel's idea of the geometry of C<device>."
14797 #: ../src/guestfs-actions.pod:5937
14798 msgid "guestfs_sfdisk_l"
14802 #: ../src/guestfs-actions.pod:5939
14806 " guestfs_sfdisk_l (guestfs_h *g,\n"
14807 " const char *device);\n"
14812 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:3979
14814 "This displays the partition table on C<device>, in the human-readable output "
14815 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14819 #: ../src/guestfs-actions.pod:5947
14820 msgid "See also: C<guestfs_part_list>"
14824 #: ../src/guestfs-actions.pod:5954
14829 #: ../src/guestfs-actions.pod:5956
14833 " guestfs_sh (guestfs_h *g,\n"
14834 " const char *command);\n"
14839 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:3989
14841 "This call runs a command from the guest filesystem via the guest's "
14846 #: ../src/guestfs-actions.pod:5963
14847 msgid "This is like C<guestfs_command>, but passes the command to:"
14851 #: ../src/guestfs-actions.pod:5965 ../fish/guestfish-actions.pod:3994
14854 " /bin/sh -c \"command\"\n"
14859 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:3996
14861 "Depending on the guest's shell, this usually results in wildcards being "
14862 "expanded, shell expressions being interpolated and so on."
14866 #: ../src/guestfs-actions.pod:5971
14867 msgid "All the provisos about C<guestfs_command> apply to this call."
14871 #: ../src/guestfs-actions.pod:5978
14872 msgid "guestfs_sh_lines"
14876 #: ../src/guestfs-actions.pod:5980
14880 " guestfs_sh_lines (guestfs_h *g,\n"
14881 " const char *command);\n"
14886 #: ../src/guestfs-actions.pod:5984
14888 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14893 #: ../src/guestfs-actions.pod:5987
14894 msgid "See also: C<guestfs_command_lines>"
14898 #: ../src/guestfs-actions.pod:5995
14899 msgid "guestfs_sleep"
14903 #: ../src/guestfs-actions.pod:5997
14907 " guestfs_sleep (guestfs_h *g,\n"
14913 #: ../src/guestfs-actions.pod:6001 ../fish/guestfish-actions.pod:4015
14914 msgid "Sleep for C<secs> seconds."
14918 #: ../src/guestfs-actions.pod:6005
14919 msgid "(Added in 1.0.41)"
14923 #: ../src/guestfs-actions.pod:6007 ../src/guestfs-structs.pod:109
14924 msgid "guestfs_stat"
14928 #: ../src/guestfs-actions.pod:6009
14931 " struct guestfs_stat *\n"
14932 " guestfs_stat (guestfs_h *g,\n"
14933 " const char *path);\n"
14938 #: ../src/guestfs-actions.pod:6015 ../fish/guestfish-actions.pod:4023
14939 msgid "This is the same as the C<stat(2)> system call."
14943 #: ../src/guestfs-actions.pod:6023 ../src/guestfs-structs.pod:135
14944 msgid "guestfs_statvfs"
14948 #: ../src/guestfs-actions.pod:6025
14951 " struct guestfs_statvfs *\n"
14952 " guestfs_statvfs (guestfs_h *g,\n"
14953 " const char *path);\n"
14958 #: ../src/guestfs-actions.pod:6029 ../fish/guestfish-actions.pod:4029
14960 "Returns file system statistics for any mounted file system. C<path> should "
14961 "be a file or directory in the mounted file system (typically it is the mount "
14962 "point itself, but it doesn't need to be)."
14966 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4033
14967 msgid "This is the same as the C<statvfs(2)> system call."
14971 #: ../src/guestfs-actions.pod:6035
14973 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14974 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14978 #: ../src/guestfs-actions.pod:6041
14979 msgid "guestfs_strings"
14983 #: ../src/guestfs-actions.pod:6043
14987 " guestfs_strings (guestfs_h *g,\n"
14988 " const char *path);\n"
14993 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4039
14995 "This runs the L<strings(1)> command on a file and returns the list of "
14996 "printable strings found."
15000 #: ../src/guestfs-actions.pod:6059
15001 msgid "guestfs_strings_e"
15005 #: ../src/guestfs-actions.pod:6061
15009 " guestfs_strings_e (guestfs_h *g,\n"
15010 " const char *encoding,\n"
15011 " const char *path);\n"
15016 #: ../src/guestfs-actions.pod:6066
15018 "This is like the C<guestfs_strings> command, but allows you to specify the "
15019 "encoding of strings that are looked for in the source file C<path>."
15023 #: ../src/guestfs-actions.pod:6070 ../fish/guestfish-actions.pod:4053
15024 msgid "Allowed encodings are:"
15028 #: ../src/guestfs-actions.pod:6074 ../fish/guestfish-actions.pod:4057
15033 #: ../src/guestfs-actions.pod:6076
15035 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15036 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15040 #: ../src/guestfs-actions.pod:6079 ../fish/guestfish-actions.pod:4062
15045 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4064
15046 msgid "Single 8-bit-byte characters."
15050 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4066
15055 #: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4068
15056 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15060 #: ../src/guestfs-actions.pod:6088 ../fish/guestfish-actions.pod:4071
15061 msgid "l (lower case letter L)"
15065 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4073
15067 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15068 "examining binaries in Windows guests."
15072 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4076
15077 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4078
15078 msgid "32-bit big endian such as UCS-4BE."
15082 #: ../src/guestfs-actions.pod:6097 ../fish/guestfish-actions.pod:4080
15087 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4082
15088 msgid "32-bit little endian such as UCS-4LE."
15092 #: ../src/guestfs-actions.pod:6103 ../fish/guestfish-actions.pod:4086
15093 msgid "The returned strings are transcoded to UTF-8."
15097 #: ../src/guestfs-actions.pod:6114
15098 msgid "guestfs_swapoff_device"
15102 #: ../src/guestfs-actions.pod:6116
15106 " guestfs_swapoff_device (guestfs_h *g,\n"
15107 " const char *device);\n"
15112 #: ../src/guestfs-actions.pod:6120
15114 "This command disables the libguestfs appliance swap device or partition "
15115 "named C<device>. See C<guestfs_swapon_device>."
15119 #: ../src/guestfs-actions.pod:6128
15120 msgid "guestfs_swapoff_file"
15124 #: ../src/guestfs-actions.pod:6130
15128 " guestfs_swapoff_file (guestfs_h *g,\n"
15129 " const char *file);\n"
15134 #: ../src/guestfs-actions.pod:6134 ../fish/guestfish-actions.pod:4103
15135 msgid "This command disables the libguestfs appliance swap on file."
15139 #: ../src/guestfs-actions.pod:6140
15140 msgid "guestfs_swapoff_label"
15144 #: ../src/guestfs-actions.pod:6142
15148 " guestfs_swapoff_label (guestfs_h *g,\n"
15149 " const char *label);\n"
15154 #: ../src/guestfs-actions.pod:6146 ../fish/guestfish-actions.pod:4109
15156 "This command disables the libguestfs appliance swap on labeled swap "
15161 #: ../src/guestfs-actions.pod:6153
15162 msgid "guestfs_swapoff_uuid"
15166 #: ../src/guestfs-actions.pod:6155
15170 " guestfs_swapoff_uuid (guestfs_h *g,\n"
15171 " const char *uuid);\n"
15176 #: ../src/guestfs-actions.pod:6159 ../fish/guestfish-actions.pod:4116
15178 "This command disables the libguestfs appliance swap partition with the given "
15183 #: ../src/guestfs-actions.pod:6166
15184 msgid "guestfs_swapon_device"
15188 #: ../src/guestfs-actions.pod:6168
15192 " guestfs_swapon_device (guestfs_h *g,\n"
15193 " const char *device);\n"
15198 #: ../src/guestfs-actions.pod:6172
15200 "This command enables the libguestfs appliance to use the swap device or "
15201 "partition named C<device>. The increased memory is made available for all "
15202 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
15206 #: ../src/guestfs-actions.pod:6177 ../fish/guestfish-actions.pod:4128
15208 "Note that you should not swap to existing guest swap partitions unless you "
15209 "know what you are doing. They may contain hibernation information, or other "
15210 "information that the guest doesn't want you to trash. You also risk leaking "
15211 "information about the host to the guest this way. Instead, attach a new "
15212 "host device to the guest and swap on that."
15216 #: ../src/guestfs-actions.pod:6188
15217 msgid "guestfs_swapon_file"
15221 #: ../src/guestfs-actions.pod:6190
15225 " guestfs_swapon_file (guestfs_h *g,\n"
15226 " const char *file);\n"
15231 #: ../src/guestfs-actions.pod:6194
15233 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
15238 #: ../src/guestfs-actions.pod:6201
15239 msgid "guestfs_swapon_label"
15243 #: ../src/guestfs-actions.pod:6203
15247 " guestfs_swapon_label (guestfs_h *g,\n"
15248 " const char *label);\n"
15253 #: ../src/guestfs-actions.pod:6207
15255 "This command enables swap to a labeled swap partition. See "
15256 "C<guestfs_swapon_device> for other notes."
15260 #: ../src/guestfs-actions.pod:6214
15261 msgid "guestfs_swapon_uuid"
15265 #: ../src/guestfs-actions.pod:6216
15269 " guestfs_swapon_uuid (guestfs_h *g,\n"
15270 " const char *uuid);\n"
15275 #: ../src/guestfs-actions.pod:6220
15277 "This command enables swap to a swap partition with the given UUID. See "
15278 "C<guestfs_swapon_device> for other notes."
15282 #: ../src/guestfs-actions.pod:6227
15283 msgid "guestfs_sync"
15287 #: ../src/guestfs-actions.pod:6229
15291 " guestfs_sync (guestfs_h *g);\n"
15296 #: ../src/guestfs-actions.pod:6232 ../fish/guestfish-actions.pod:4160
15298 "This syncs the disk, so that any writes are flushed through to the "
15299 "underlying disk image."
15303 #: ../src/guestfs-actions.pod:6235 ../fish/guestfish-actions.pod:4163
15305 "You should always call this if you have modified a disk image, before "
15306 "closing the handle."
15310 #: ../src/guestfs-actions.pod:6242
15311 msgid "guestfs_tail"
15315 #: ../src/guestfs-actions.pod:6244
15319 " guestfs_tail (guestfs_h *g,\n"
15320 " const char *path);\n"
15325 #: ../src/guestfs-actions.pod:6248 ../fish/guestfish-actions.pod:4170
15326 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15330 #: ../src/guestfs-actions.pod:6260
15331 msgid "guestfs_tail_n"
15335 #: ../src/guestfs-actions.pod:6262
15339 " guestfs_tail_n (guestfs_h *g,\n"
15341 " const char *path);\n"
15346 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4180
15348 "If the parameter C<nrlines> is a positive number, this returns the last "
15349 "C<nrlines> lines of the file C<path>."
15353 #: ../src/guestfs-actions.pod:6270 ../fish/guestfish-actions.pod:4183
15355 "If the parameter C<nrlines> is a negative number, this returns lines from "
15356 "the file C<path>, starting with the C<-nrlines>th line."
15360 #: ../src/guestfs-actions.pod:6284
15361 msgid "guestfs_tar_in"
15365 #: ../src/guestfs-actions.pod:6286
15369 " guestfs_tar_in (guestfs_h *g,\n"
15370 " const char *tarfile,\n"
15371 " const char *directory);\n"
15376 #: ../src/guestfs-actions.pod:6291 ../fish/guestfish-actions.pod:4195
15378 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15379 "tar file) into C<directory>."
15383 #: ../src/guestfs-actions.pod:6294
15384 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
15388 #: ../src/guestfs-actions.pod:6299 ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6348
15389 msgid "(Added in 1.0.3)"
15393 #: ../src/guestfs-actions.pod:6301
15394 msgid "guestfs_tar_out"
15398 #: ../src/guestfs-actions.pod:6303
15402 " guestfs_tar_out (guestfs_h *g,\n"
15403 " const char *directory,\n"
15404 " const char *tarfile);\n"
15409 #: ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:4207
15411 "This command packs the contents of C<directory> and downloads it to local "
15416 #: ../src/guestfs-actions.pod:6311
15418 "To download a compressed tarball, use C<guestfs_tgz_out> or "
15419 "C<guestfs_txz_out>."
15423 #: ../src/guestfs-actions.pod:6318
15424 msgid "guestfs_tgz_in"
15428 #: ../src/guestfs-actions.pod:6320
15432 " guestfs_tgz_in (guestfs_h *g,\n"
15433 " const char *tarball,\n"
15434 " const char *directory);\n"
15439 #: ../src/guestfs-actions.pod:6325 ../fish/guestfish-actions.pod:4219
15441 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15442 "tar file) into C<directory>."
15446 #: ../src/guestfs-actions.pod:6328
15447 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
15451 #: ../src/guestfs-actions.pod:6334
15452 msgid "guestfs_tgz_out"
15456 #: ../src/guestfs-actions.pod:6336
15460 " guestfs_tgz_out (guestfs_h *g,\n"
15461 " const char *directory,\n"
15462 " const char *tarball);\n"
15467 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4230
15469 "This command packs the contents of C<directory> and downloads it to local "
15474 #: ../src/guestfs-actions.pod:6344
15475 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
15479 #: ../src/guestfs-actions.pod:6350
15480 msgid "guestfs_touch"
15484 #: ../src/guestfs-actions.pod:6352
15488 " guestfs_touch (guestfs_h *g,\n"
15489 " const char *path);\n"
15494 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4241
15496 "Touch acts like the L<touch(1)> command. It can be used to update the "
15497 "timestamps on a file, or, if the file does not exist, to create a new "
15498 "zero-length file."
15502 #: ../src/guestfs-actions.pod:6360 ../fish/guestfish-actions.pod:4245
15504 "This command only works on regular files, and will fail on other file types "
15505 "such as directories, symbolic links, block special etc."
15509 #: ../src/guestfs-actions.pod:6367
15510 msgid "guestfs_truncate"
15514 #: ../src/guestfs-actions.pod:6369
15518 " guestfs_truncate (guestfs_h *g,\n"
15519 " const char *path);\n"
15524 #: ../src/guestfs-actions.pod:6373 ../fish/guestfish-actions.pod:4252
15526 "This command truncates C<path> to a zero-length file. The file must exist "
15531 #: ../src/guestfs-actions.pod:6380
15532 msgid "guestfs_truncate_size"
15536 #: ../src/guestfs-actions.pod:6382
15540 " guestfs_truncate_size (guestfs_h *g,\n"
15541 " const char *path,\n"
15542 " int64_t size);\n"
15547 #: ../src/guestfs-actions.pod:6387 ../fish/guestfish-actions.pod:4259
15549 "This command truncates C<path> to size C<size> bytes. The file must exist "
15554 #: ../src/guestfs-actions.pod:6390
15556 "If the current file size is less than C<size> then the file is extended to "
15557 "the required size with zero bytes. This creates a sparse file (ie. disk "
15558 "blocks are not allocated for the file until you write to it). To create a "
15559 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15563 #: ../src/guestfs-actions.pod:6400
15564 msgid "guestfs_tune2fs_l"
15568 #: ../src/guestfs-actions.pod:6402
15572 " guestfs_tune2fs_l (guestfs_h *g,\n"
15573 " const char *device);\n"
15578 #: ../src/guestfs-actions.pod:6406 ../fish/guestfish-actions.pod:4272
15580 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15585 #: ../src/guestfs-actions.pod:6409 ../fish/guestfish-actions.pod:4275
15587 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15588 "for more details. The list of fields returned isn't clearly defined, and "
15589 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15590 "and the filesystem itself."
15594 #: ../src/guestfs-actions.pod:6422
15595 msgid "guestfs_txz_in"
15599 #: ../src/guestfs-actions.pod:6424
15603 " guestfs_txz_in (guestfs_h *g,\n"
15604 " const char *tarball,\n"
15605 " const char *directory);\n"
15610 #: ../src/guestfs-actions.pod:6429 ../fish/guestfish-actions.pod:4284
15612 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15613 "tar file) into C<directory>."
15617 #: ../src/guestfs-actions.pod:6436
15618 msgid "guestfs_txz_out"
15622 #: ../src/guestfs-actions.pod:6438
15626 " guestfs_txz_out (guestfs_h *g,\n"
15627 " const char *directory,\n"
15628 " const char *tarball);\n"
15633 #: ../src/guestfs-actions.pod:6443 ../fish/guestfish-actions.pod:4293
15635 "This command packs the contents of C<directory> and downloads it to local "
15636 "file C<tarball> (as an xz compressed tar archive)."
15640 #: ../src/guestfs-actions.pod:6450
15641 msgid "guestfs_umask"
15645 #: ../src/guestfs-actions.pod:6452
15649 " guestfs_umask (guestfs_h *g,\n"
15655 #: ../src/guestfs-actions.pod:6456 ../fish/guestfish-actions.pod:4302
15657 "This function sets the mask used for creating new files and device nodes to "
15662 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4305
15664 "Typical umask values would be C<022> which creates new files with "
15665 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15666 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15670 #: ../src/guestfs-actions.pod:6464 ../fish/guestfish-actions.pod:4310
15672 "The default umask is C<022>. This is important because it means that "
15673 "directories and device nodes will be created with C<0644> or C<0755> mode "
15674 "even if you specify C<0777>."
15678 #: ../src/guestfs-actions.pod:6468
15680 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15681 "C<guestfs_mkdir>."
15685 #: ../src/guestfs-actions.pod:6471 ../fish/guestfish-actions.pod:4317
15686 msgid "This call returns the previous umask."
15690 #: ../src/guestfs-actions.pod:6477
15691 msgid "guestfs_umount"
15695 #: ../src/guestfs-actions.pod:6479
15699 " guestfs_umount (guestfs_h *g,\n"
15700 " const char *pathordevice);\n"
15705 #: ../src/guestfs-actions.pod:6483 ../fish/guestfish-actions.pod:4325
15707 "This unmounts the given filesystem. The filesystem may be specified either "
15708 "by its mountpoint (path) or the device which contains the filesystem."
15712 #: ../src/guestfs-actions.pod:6491
15713 msgid "guestfs_umount_all"
15717 #: ../src/guestfs-actions.pod:6493
15721 " guestfs_umount_all (guestfs_h *g);\n"
15726 #: ../src/guestfs-actions.pod:6496 ../fish/guestfish-actions.pod:4335
15727 msgid "This unmounts all mounted filesystems."
15731 #: ../src/guestfs-actions.pod:6498 ../fish/guestfish-actions.pod:4337
15732 msgid "Some internal mounts are not unmounted by this call."
15736 #: ../src/guestfs-actions.pod:6504
15737 msgid "guestfs_upload"
15741 #: ../src/guestfs-actions.pod:6506
15745 " guestfs_upload (guestfs_h *g,\n"
15746 " const char *filename,\n"
15747 " const char *remotefilename);\n"
15752 #: ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6535 ../fish/guestfish-actions.pod:4343 ../fish/guestfish-actions.pod:4356
15753 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15757 #: ../src/guestfs-actions.pod:6516
15758 msgid "See also C<guestfs_download>."
15762 #: ../src/guestfs-actions.pod:6527
15763 msgid "guestfs_upload_offset"
15767 #: ../src/guestfs-actions.pod:6529
15771 " guestfs_upload_offset (guestfs_h *g,\n"
15772 " const char *filename,\n"
15773 " const char *remotefilename,\n"
15774 " int64_t offset);\n"
15779 #: ../src/guestfs-actions.pod:6538 ../fish/guestfish-actions.pod:4359
15781 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15782 "The intention is to overwrite parts of existing files or devices, although "
15783 "if a non-existant file is specified then it is created with a \"hole\" "
15784 "before C<offset>. The size of the data written is implicit in the size of "
15785 "the source C<filename>."
15789 #: ../src/guestfs-actions.pod:6545
15791 "Note that there is no limit on the amount of data that can be uploaded with "
15792 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15793 "full amount unless an error occurs."
15797 #: ../src/guestfs-actions.pod:6550
15798 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15802 #: ../src/guestfs-actions.pod:6561
15803 msgid "guestfs_utimens"
15807 #: ../src/guestfs-actions.pod:6563
15811 " guestfs_utimens (guestfs_h *g,\n"
15812 " const char *path,\n"
15813 " int64_t atsecs,\n"
15814 " int64_t atnsecs,\n"
15815 " int64_t mtsecs,\n"
15816 " int64_t mtnsecs);\n"
15821 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4379
15822 msgid "This command sets the timestamps of a file with nanosecond precision."
15826 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4382
15828 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15833 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4385
15835 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15836 "nanoseconds from the epoch."
15840 #: ../src/guestfs-actions.pod:6580 ../fish/guestfish-actions.pod:4388
15842 "If the C<*nsecs> field contains the special value C<-1> then the "
15843 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15844 "ignored in this case)."
15848 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4392
15850 "If the C<*nsecs> field contains the special value C<-2> then the "
15851 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15856 #: ../src/guestfs-actions.pod:6592 ../src/guestfs-structs.pod:175
15857 msgid "guestfs_version"
15861 #: ../src/guestfs-actions.pod:6594
15864 " struct guestfs_version *\n"
15865 " guestfs_version (guestfs_h *g);\n"
15870 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4400
15871 msgid "Return the libguestfs version number that the program is linked against."
15875 #: ../src/guestfs-actions.pod:6600 ../fish/guestfish-actions.pod:4403
15877 "Note that because of dynamic linking this is not necessarily the version of "
15878 "libguestfs that you compiled against. You can compile the program, and then "
15879 "at runtime dynamically link against a completely different C<libguestfs.so> "
15884 #: ../src/guestfs-actions.pod:6605 ../fish/guestfish-actions.pod:4408
15886 "This call was added in version C<1.0.58>. In previous versions of "
15887 "libguestfs there was no way to get the version number. From C code you can "
15888 "use dynamic linker functions to find out if this symbol exists (if it "
15889 "doesn't, then it's an earlier version)."
15893 #: ../src/guestfs-actions.pod:6611 ../fish/guestfish-actions.pod:4414
15895 "The call returns a structure with four elements. The first three (C<major>, "
15896 "C<minor> and C<release>) are numbers and correspond to the usual version "
15897 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15898 "but may be used for distro-specific information."
15902 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4420
15903 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
15907 #: ../src/guestfs-actions.pod:6620 ../fish/guestfish-actions.pod:4423
15908 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15912 #: ../src/guestfs-actions.pod:6622
15914 "I<Note:> Don't use this call to test for availability of features. In "
15915 "enterprise distributions we backport features from later versions into "
15916 "earlier versions, making this an unreliable way to test for features. Use "
15917 "C<guestfs_available> instead."
15921 #: ../src/guestfs-actions.pod:6628
15923 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15924 "error. I<The caller must call C<guestfs_free_version> after use>."
15928 #: ../src/guestfs-actions.pod:6632
15929 msgid "(Added in 1.0.58)"
15933 #: ../src/guestfs-actions.pod:6634
15934 msgid "guestfs_vfs_label"
15938 #: ../src/guestfs-actions.pod:6636
15942 " guestfs_vfs_label (guestfs_h *g,\n"
15943 " const char *device);\n"
15948 #: ../src/guestfs-actions.pod:6640 ../fish/guestfish-actions.pod:4435
15949 msgid "This returns the filesystem label of the filesystem on C<device>."
15953 #: ../src/guestfs-actions.pod:6643 ../fish/guestfish-actions.pod:4438
15954 msgid "If the filesystem is unlabeled, this returns the empty string."
15958 #: ../src/guestfs-actions.pod:6645
15959 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15963 #: ../src/guestfs-actions.pod:6650 ../src/guestfs-actions.pod:6687
15964 msgid "(Added in 1.3.18)"
15968 #: ../src/guestfs-actions.pod:6652
15969 msgid "guestfs_vfs_type"
15973 #: ../src/guestfs-actions.pod:6654
15977 " guestfs_vfs_type (guestfs_h *g,\n"
15978 " const char *device);\n"
15983 #: ../src/guestfs-actions.pod:6658 ../fish/guestfish-actions.pod:4446
15985 "This command gets the filesystem type corresponding to the filesystem on "
15990 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4449
15992 "For most filesystems, the result is the name of the Linux VFS module which "
15993 "would be used to mount this filesystem if you mounted it without specifying "
15994 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15998 #: ../src/guestfs-actions.pod:6671
15999 msgid "guestfs_vfs_uuid"
16003 #: ../src/guestfs-actions.pod:6673
16007 " guestfs_vfs_uuid (guestfs_h *g,\n"
16008 " const char *device);\n"
16013 #: ../src/guestfs-actions.pod:6677 ../fish/guestfish-actions.pod:4458
16014 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16018 #: ../src/guestfs-actions.pod:6680 ../fish/guestfish-actions.pod:4461
16019 msgid "If the filesystem does not have a UUID, this returns the empty string."
16023 #: ../src/guestfs-actions.pod:6682
16024 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16028 #: ../src/guestfs-actions.pod:6689
16029 msgid "guestfs_vg_activate"
16033 #: ../src/guestfs-actions.pod:6691
16037 " guestfs_vg_activate (guestfs_h *g,\n"
16039 " char *const *volgroups);\n"
16044 #: ../src/guestfs-actions.pod:6696 ../fish/guestfish-actions.pod:4469
16046 "This command activates or (if C<activate> is false) deactivates all logical "
16047 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16048 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16049 "deactivated, then those devices disappear."
16053 #: ../src/guestfs-actions.pod:6702 ../fish/guestfish-actions.pod:4475
16054 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16058 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4477
16060 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16061 "activated or deactivated."
16065 #: ../src/guestfs-actions.pod:6711
16066 msgid "guestfs_vg_activate_all"
16070 #: ../src/guestfs-actions.pod:6713
16074 " guestfs_vg_activate_all (guestfs_h *g,\n"
16075 " int activate);\n"
16080 #: ../src/guestfs-actions.pod:6717 ../fish/guestfish-actions.pod:4484
16082 "This command activates or (if C<activate> is false) deactivates all logical "
16083 "volumes in all volume groups. If activated, then they are made known to the "
16084 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16085 "those devices disappear."
16089 #: ../src/guestfs-actions.pod:6723 ../fish/guestfish-actions.pod:4490
16090 msgid "This command is the same as running C<vgchange -a y|n>"
16094 #: ../src/guestfs-actions.pod:6729
16095 msgid "guestfs_vgcreate"
16099 #: ../src/guestfs-actions.pod:6731
16103 " guestfs_vgcreate (guestfs_h *g,\n"
16104 " const char *volgroup,\n"
16105 " char *const *physvols);\n"
16110 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4496
16112 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16113 "of physical volumes C<physvols>."
16117 #: ../src/guestfs-actions.pod:6743
16118 msgid "guestfs_vglvuuids"
16122 #: ../src/guestfs-actions.pod:6745
16126 " guestfs_vglvuuids (guestfs_h *g,\n"
16127 " const char *vgname);\n"
16132 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4503
16134 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16135 "volumes created in this volume group."
16139 #: ../src/guestfs-actions.pod:6752
16141 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
16142 "associate logical volumes and volume groups."
16146 #: ../src/guestfs-actions.pod:6755
16147 msgid "See also C<guestfs_vgpvuuids>."
16151 #: ../src/guestfs-actions.pod:6763
16152 msgid "guestfs_vgpvuuids"
16156 #: ../src/guestfs-actions.pod:6765
16160 " guestfs_vgpvuuids (guestfs_h *g,\n"
16161 " const char *vgname);\n"
16166 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4515
16168 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16169 "volumes that this volume group resides on."
16173 #: ../src/guestfs-actions.pod:6772
16175 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
16176 "associate physical volumes and volume groups."
16180 #: ../src/guestfs-actions.pod:6775
16181 msgid "See also C<guestfs_vglvuuids>."
16185 #: ../src/guestfs-actions.pod:6783
16186 msgid "guestfs_vgremove"
16190 #: ../src/guestfs-actions.pod:6785
16194 " guestfs_vgremove (guestfs_h *g,\n"
16195 " const char *vgname);\n"
16200 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4527
16201 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16205 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4529
16206 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16210 #: ../src/guestfs-actions.pod:6798
16211 msgid "guestfs_vgrename"
16215 #: ../src/guestfs-actions.pod:6800
16219 " guestfs_vgrename (guestfs_h *g,\n"
16220 " const char *volgroup,\n"
16221 " const char *newvolgroup);\n"
16226 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4536
16227 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16231 #: ../src/guestfs-actions.pod:6811
16232 msgid "guestfs_vgs"
16236 #: ../src/guestfs-actions.pod:6813
16240 " guestfs_vgs (guestfs_h *g);\n"
16245 #: ../src/guestfs-actions.pod:6816 ../fish/guestfish-actions.pod:4542
16247 "List all the volumes groups detected. This is the equivalent of the "
16248 "L<vgs(8)> command."
16252 #: ../src/guestfs-actions.pod:6819 ../fish/guestfish-actions.pod:4545
16254 "This returns a list of just the volume group names that were detected "
16255 "(eg. C<VolGroup00>)."
16259 #: ../src/guestfs-actions.pod:6822
16260 msgid "See also C<guestfs_vgs_full>."
16264 #: ../src/guestfs-actions.pod:6830
16265 msgid "guestfs_vgs_full"
16269 #: ../src/guestfs-actions.pod:6832
16272 " struct guestfs_lvm_vg_list *\n"
16273 " guestfs_vgs_full (guestfs_h *g);\n"
16278 #: ../src/guestfs-actions.pod:6835 ../fish/guestfish-actions.pod:4554
16280 "List all the volumes groups detected. This is the equivalent of the "
16281 "L<vgs(8)> command. The \"full\" version includes all fields."
16285 #: ../src/guestfs-actions.pod:6838
16287 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
16288 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
16293 #: ../src/guestfs-actions.pod:6844
16294 msgid "guestfs_vgscan"
16298 #: ../src/guestfs-actions.pod:6846
16302 " guestfs_vgscan (guestfs_h *g);\n"
16307 #: ../src/guestfs-actions.pod:6849 ../fish/guestfish-actions.pod:4561
16309 "This rescans all block devices and rebuilds the list of LVM physical "
16310 "volumes, volume groups and logical volumes."
16314 #: ../src/guestfs-actions.pod:6856
16315 msgid "guestfs_vguuid"
16319 #: ../src/guestfs-actions.pod:6858
16323 " guestfs_vguuid (guestfs_h *g,\n"
16324 " const char *vgname);\n"
16329 #: ../src/guestfs-actions.pod:6862 ../fish/guestfish-actions.pod:4568
16330 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16334 #: ../src/guestfs-actions.pod:6869
16335 msgid "guestfs_wait_ready"
16339 #: ../src/guestfs-actions.pod:6871
16343 " guestfs_wait_ready (guestfs_h *g);\n"
16348 #: ../src/guestfs-actions.pod:6874
16349 msgid "This function is a no op."
16353 #: ../src/guestfs-actions.pod:6876
16355 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
16356 "calling C<guestfs_launch> to wait for the launch to complete. However this "
16357 "is no longer necessary because C<guestfs_launch> now does the waiting."
16361 #: ../src/guestfs-actions.pod:6881
16363 "If you see any calls to this function in code then you can just remove them, "
16364 "unless you want to retain compatibility with older versions of the API."
16368 #: ../src/guestfs-actions.pod:6889
16369 msgid "guestfs_wc_c"
16373 #: ../src/guestfs-actions.pod:6891
16377 " guestfs_wc_c (guestfs_h *g,\n"
16378 " const char *path);\n"
16383 #: ../src/guestfs-actions.pod:6895 ../fish/guestfish-actions.pod:4574
16385 "This command counts the characters in a file, using the C<wc -c> external "
16390 #: ../src/guestfs-actions.pod:6902
16391 msgid "guestfs_wc_l"
16395 #: ../src/guestfs-actions.pod:6904
16399 " guestfs_wc_l (guestfs_h *g,\n"
16400 " const char *path);\n"
16405 #: ../src/guestfs-actions.pod:6908 ../fish/guestfish-actions.pod:4581
16407 "This command counts the lines in a file, using the C<wc -l> external "
16412 #: ../src/guestfs-actions.pod:6915
16413 msgid "guestfs_wc_w"
16417 #: ../src/guestfs-actions.pod:6917
16421 " guestfs_wc_w (guestfs_h *g,\n"
16422 " const char *path);\n"
16427 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4588
16429 "This command counts the words in a file, using the C<wc -w> external "
16434 #: ../src/guestfs-actions.pod:6928
16435 msgid "guestfs_write"
16439 #: ../src/guestfs-actions.pod:6930
16443 " guestfs_write (guestfs_h *g,\n"
16444 " const char *path,\n"
16445 " const char *content,\n"
16446 " size_t content_size);\n"
16451 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4595
16453 "This call creates a file called C<path>. The content of the file is the "
16454 "string C<content> (which can contain any 8 bit data)."
16458 #: ../src/guestfs-actions.pod:6946
16459 msgid "guestfs_write_file"
16463 #: ../src/guestfs-actions.pod:6948
16467 " guestfs_write_file (guestfs_h *g,\n"
16468 " const char *path,\n"
16469 " const char *content,\n"
16475 #: ../src/guestfs-actions.pod:6954 ../fish/guestfish-actions.pod:4605
16477 "This call creates a file called C<path>. The contents of the file is the "
16478 "string C<content> (which can contain any 8 bit data), with length C<size>."
16482 #: ../src/guestfs-actions.pod:6958 ../fish/guestfish-actions.pod:4609
16484 "As a special case, if C<size> is C<0> then the length is calculated using "
16485 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16489 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4613
16491 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16492 "I<not> work, even if the length is specified."
16496 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4619
16497 msgid "This function is deprecated. In new code, use the C<write> call instead."
16501 #: ../src/guestfs-actions.pod:6979
16502 msgid "guestfs_zegrep"
16506 #: ../src/guestfs-actions.pod:6981
16510 " guestfs_zegrep (guestfs_h *g,\n"
16511 " const char *regex,\n"
16512 " const char *path);\n"
16517 #: ../src/guestfs-actions.pod:6986 ../fish/guestfish-actions.pod:4630
16518 msgid "This calls the external C<zegrep> program and returns the matching lines."
16522 #: ../src/guestfs-actions.pod:6998
16523 msgid "guestfs_zegrepi"
16527 #: ../src/guestfs-actions.pod:7000
16531 " guestfs_zegrepi (guestfs_h *g,\n"
16532 " const char *regex,\n"
16533 " const char *path);\n"
16538 #: ../src/guestfs-actions.pod:7005 ../fish/guestfish-actions.pod:4640
16539 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16543 #: ../src/guestfs-actions.pod:7017
16544 msgid "guestfs_zero"
16548 #: ../src/guestfs-actions.pod:7019
16552 " guestfs_zero (guestfs_h *g,\n"
16553 " const char *device);\n"
16558 #: ../src/guestfs-actions.pod:7023 ../fish/guestfish-actions.pod:4650
16559 msgid "This command writes zeroes over the first few blocks of C<device>."
16563 #: ../src/guestfs-actions.pod:7025 ../fish/guestfish-actions.pod:4652
16565 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16566 "securely wipe the device). It should be sufficient to remove any partition "
16567 "tables, filesystem superblocks and so on."
16571 #: ../src/guestfs-actions.pod:7029
16572 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16576 #: ../src/guestfs-actions.pod:7040
16577 msgid "guestfs_zero_device"
16581 #: ../src/guestfs-actions.pod:7042
16585 " guestfs_zero_device (guestfs_h *g,\n"
16586 " const char *device);\n"
16591 #: ../src/guestfs-actions.pod:7046
16593 "This command writes zeroes over the entire C<device>. Compare with "
16594 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16598 #: ../src/guestfs-actions.pod:7060
16599 msgid "(Added in 1.3.1)"
16603 #: ../src/guestfs-actions.pod:7062
16604 msgid "guestfs_zerofree"
16608 #: ../src/guestfs-actions.pod:7064
16612 " guestfs_zerofree (guestfs_h *g,\n"
16613 " const char *device);\n"
16618 #: ../src/guestfs-actions.pod:7068 ../fish/guestfish-actions.pod:4673
16620 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16621 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16622 "possible to compress the filesystem more effectively."
16626 #: ../src/guestfs-actions.pod:7073 ../fish/guestfish-actions.pod:4678
16627 msgid "You should B<not> run this program if the filesystem is mounted."
16631 #: ../src/guestfs-actions.pod:7076 ../fish/guestfish-actions.pod:4681
16633 "It is possible that using this program can damage the filesystem or data on "
16638 #: ../src/guestfs-actions.pod:7083
16639 msgid "guestfs_zfgrep"
16643 #: ../src/guestfs-actions.pod:7085
16647 " guestfs_zfgrep (guestfs_h *g,\n"
16648 " const char *pattern,\n"
16649 " const char *path);\n"
16654 #: ../src/guestfs-actions.pod:7090 ../fish/guestfish-actions.pod:4688
16655 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16659 #: ../src/guestfs-actions.pod:7102
16660 msgid "guestfs_zfgrepi"
16664 #: ../src/guestfs-actions.pod:7104
16668 " guestfs_zfgrepi (guestfs_h *g,\n"
16669 " const char *pattern,\n"
16670 " const char *path);\n"
16675 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4698
16676 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16680 #: ../src/guestfs-actions.pod:7121
16681 msgid "guestfs_zfile"
16685 #: ../src/guestfs-actions.pod:7123
16689 " guestfs_zfile (guestfs_h *g,\n"
16690 " const char *meth,\n"
16691 " const char *path);\n"
16696 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4708
16697 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16701 #: ../src/guestfs-actions.pod:7131 ../fish/guestfish-actions.pod:4711
16702 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16706 #: ../src/guestfs-actions.pod:7133
16708 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16713 #: ../src/guestfs-actions.pod:7139 ../fish/guestfish-actions.pod:4716
16714 msgid "This function is deprecated. In new code, use the C<file> call instead."
16718 #: ../src/guestfs-actions.pod:7148
16719 msgid "guestfs_zgrep"
16723 #: ../src/guestfs-actions.pod:7150
16727 " guestfs_zgrep (guestfs_h *g,\n"
16728 " const char *regex,\n"
16729 " const char *path);\n"
16734 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:4727
16735 msgid "This calls the external C<zgrep> program and returns the matching lines."
16739 #: ../src/guestfs-actions.pod:7167
16740 msgid "guestfs_zgrepi"
16744 #: ../src/guestfs-actions.pod:7169
16748 " guestfs_zgrepi (guestfs_h *g,\n"
16749 " const char *regex,\n"
16750 " const char *path);\n"
16755 #: ../src/guestfs-actions.pod:7174 ../fish/guestfish-actions.pod:4737
16756 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16760 #: ../src/guestfs-availability.pod:3
16765 #: ../src/guestfs-availability.pod:5
16767 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
16768 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
16769 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
16770 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
16771 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
16775 #: ../src/guestfs-availability.pod:21
16780 #: ../src/guestfs-availability.pod:23
16782 "The following functions: L</guestfs_inotify_add_watch> "
16783 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
16784 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16788 #: ../src/guestfs-availability.pod:31
16789 msgid "B<linuxfsuuid>"
16793 #: ../src/guestfs-availability.pod:33
16795 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
16796 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16800 #: ../src/guestfs-availability.pod:40
16801 msgid "B<linuxmodules>"
16805 #: ../src/guestfs-availability.pod:42
16806 msgid "The following functions: L</guestfs_modprobe>"
16810 #: ../src/guestfs-availability.pod:45
16811 msgid "B<linuxxattrs>"
16815 #: ../src/guestfs-availability.pod:47
16817 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
16818 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
16819 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
16820 "L</guestfs_setxattr>"
16824 #: ../src/guestfs-availability.pod:58
16829 #: ../src/guestfs-availability.pod:60
16831 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
16832 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
16833 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16837 #: ../src/guestfs-availability.pod:69
16842 #: ../src/guestfs-availability.pod:71
16844 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
16845 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
16846 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
16847 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
16848 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
16849 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
16850 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
16851 "L</guestfs_vgs_full>"
16855 #: ../src/guestfs-availability.pod:94
16860 #: ../src/guestfs-availability.pod:96
16862 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
16863 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
16867 #: ../src/guestfs-availability.pod:102
16872 #: ../src/guestfs-availability.pod:104
16873 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16877 #: ../src/guestfs-availability.pod:107
16878 msgid "B<ntfsprogs>"
16882 #: ../src/guestfs-availability.pod:109
16883 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16887 #: ../src/guestfs-availability.pod:113
16888 msgid "B<realpath>"
16892 #: ../src/guestfs-availability.pod:115
16893 msgid "The following functions: L</guestfs_realpath>"
16897 #: ../src/guestfs-availability.pod:118
16902 #: ../src/guestfs-availability.pod:120
16904 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
16905 "L</guestfs_scrub_freespace>"
16909 #: ../src/guestfs-availability.pod:125
16914 #: ../src/guestfs-availability.pod:127
16915 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16919 #: ../src/guestfs-availability.pod:131
16924 #: ../src/guestfs-availability.pod:133
16925 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16929 #: ../src/guestfs-availability.pod:137
16930 msgid "B<zerofree>"
16934 #: ../src/guestfs-availability.pod:139
16935 msgid "The following functions: L</guestfs_zerofree>"
16939 #: ../src/guestfs-structs.pod:1
16940 msgid "guestfs_int_bool"
16944 #: ../src/guestfs-structs.pod:3
16947 " struct guestfs_int_bool {\n"
16955 #: ../src/guestfs-structs.pod:8
16958 " struct guestfs_int_bool_list {\n"
16959 " uint32_t len; /* Number of elements in list. */\n"
16960 " struct guestfs_int_bool *val; /* Elements. */\n"
16966 #: ../src/guestfs-structs.pod:13
16969 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16970 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16975 #: ../src/guestfs-structs.pod:16
16976 msgid "guestfs_lvm_pv"
16980 #: ../src/guestfs-structs.pod:18
16983 " struct guestfs_lvm_pv {\n"
16984 " char *pv_name;\n"
16985 " /* The next field is NOT nul-terminated, be careful when printing it: "
16987 " char pv_uuid[32];\n"
16989 " uint64_t pv_size;\n"
16990 " uint64_t dev_size;\n"
16991 " uint64_t pv_free;\n"
16992 " uint64_t pv_used;\n"
16993 " char *pv_attr;\n"
16994 " int64_t pv_pe_count;\n"
16995 " int64_t pv_pe_alloc_count;\n"
16996 " char *pv_tags;\n"
16997 " uint64_t pe_start;\n"
16998 " int64_t pv_mda_count;\n"
16999 " uint64_t pv_mda_free;\n"
17005 #: ../src/guestfs-structs.pod:36
17008 " struct guestfs_lvm_pv_list {\n"
17009 " uint32_t len; /* Number of elements in list. */\n"
17010 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17016 #: ../src/guestfs-structs.pod:41
17019 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17020 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17025 #: ../src/guestfs-structs.pod:44
17026 msgid "guestfs_lvm_vg"
17030 #: ../src/guestfs-structs.pod:46
17033 " struct guestfs_lvm_vg {\n"
17034 " char *vg_name;\n"
17035 " /* The next field is NOT nul-terminated, be careful when printing it: "
17037 " char vg_uuid[32];\n"
17039 " char *vg_attr;\n"
17040 " uint64_t vg_size;\n"
17041 " uint64_t vg_free;\n"
17042 " char *vg_sysid;\n"
17043 " uint64_t vg_extent_size;\n"
17044 " int64_t vg_extent_count;\n"
17045 " int64_t vg_free_count;\n"
17046 " int64_t max_lv;\n"
17047 " int64_t max_pv;\n"
17048 " int64_t pv_count;\n"
17049 " int64_t lv_count;\n"
17050 " int64_t snap_count;\n"
17051 " int64_t vg_seqno;\n"
17052 " char *vg_tags;\n"
17053 " int64_t vg_mda_count;\n"
17054 " uint64_t vg_mda_free;\n"
17060 #: ../src/guestfs-structs.pod:69
17063 " struct guestfs_lvm_vg_list {\n"
17064 " uint32_t len; /* Number of elements in list. */\n"
17065 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17071 #: ../src/guestfs-structs.pod:74
17074 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17075 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17080 #: ../src/guestfs-structs.pod:77
17081 msgid "guestfs_lvm_lv"
17085 #: ../src/guestfs-structs.pod:79
17088 " struct guestfs_lvm_lv {\n"
17089 " char *lv_name;\n"
17090 " /* The next field is NOT nul-terminated, be careful when printing it: "
17092 " char lv_uuid[32];\n"
17093 " char *lv_attr;\n"
17094 " int64_t lv_major;\n"
17095 " int64_t lv_minor;\n"
17096 " int64_t lv_kernel_major;\n"
17097 " int64_t lv_kernel_minor;\n"
17098 " uint64_t lv_size;\n"
17099 " int64_t seg_count;\n"
17101 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17102 " float snap_percent;\n"
17103 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17104 " float copy_percent;\n"
17105 " char *move_pv;\n"
17106 " char *lv_tags;\n"
17107 " char *mirror_log;\n"
17108 " char *modules;\n"
17114 #: ../src/guestfs-structs.pod:101
17117 " struct guestfs_lvm_lv_list {\n"
17118 " uint32_t len; /* Number of elements in list. */\n"
17119 " struct guestfs_lvm_lv *val; /* Elements. */\n"
17125 #: ../src/guestfs-structs.pod:106
17128 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
17129 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
17134 #: ../src/guestfs-structs.pod:111
17137 " struct guestfs_stat {\n"
17141 " int64_t nlink;\n"
17146 " int64_t blksize;\n"
17147 " int64_t blocks;\n"
17148 " int64_t atime;\n"
17149 " int64_t mtime;\n"
17150 " int64_t ctime;\n"
17156 #: ../src/guestfs-structs.pod:127
17159 " struct guestfs_stat_list {\n"
17160 " uint32_t len; /* Number of elements in list. */\n"
17161 " struct guestfs_stat *val; /* Elements. */\n"
17167 #: ../src/guestfs-structs.pod:132
17170 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
17171 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
17176 #: ../src/guestfs-structs.pod:137
17179 " struct guestfs_statvfs {\n"
17180 " int64_t bsize;\n"
17181 " int64_t frsize;\n"
17182 " int64_t blocks;\n"
17183 " int64_t bfree;\n"
17184 " int64_t bavail;\n"
17185 " int64_t files;\n"
17186 " int64_t ffree;\n"
17187 " int64_t favail;\n"
17190 " int64_t namemax;\n"
17196 #: ../src/guestfs-structs.pod:151
17199 " struct guestfs_statvfs_list {\n"
17200 " uint32_t len; /* Number of elements in list. */\n"
17201 " struct guestfs_statvfs *val; /* Elements. */\n"
17207 #: ../src/guestfs-structs.pod:156
17210 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
17211 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
17216 #: ../src/guestfs-structs.pod:159
17217 msgid "guestfs_dirent"
17221 #: ../src/guestfs-structs.pod:161
17224 " struct guestfs_dirent {\n"
17233 #: ../src/guestfs-structs.pod:167
17236 " struct guestfs_dirent_list {\n"
17237 " uint32_t len; /* Number of elements in list. */\n"
17238 " struct guestfs_dirent *val; /* Elements. */\n"
17244 #: ../src/guestfs-structs.pod:172
17247 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
17248 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
17253 #: ../src/guestfs-structs.pod:177
17256 " struct guestfs_version {\n"
17257 " int64_t major;\n"
17258 " int64_t minor;\n"
17259 " int64_t release;\n"
17266 #: ../src/guestfs-structs.pod:184
17269 " struct guestfs_version_list {\n"
17270 " uint32_t len; /* Number of elements in list. */\n"
17271 " struct guestfs_version *val; /* Elements. */\n"
17277 #: ../src/guestfs-structs.pod:189
17280 " void guestfs_free_version (struct guestfs_free_version *);\n"
17281 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
17286 #: ../src/guestfs-structs.pod:192
17287 msgid "guestfs_xattr"
17291 #: ../src/guestfs-structs.pod:194
17294 " struct guestfs_xattr {\n"
17295 " char *attrname;\n"
17296 " /* The next two fields describe a byte array. */\n"
17297 " uint32_t attrval_len;\n"
17298 " char *attrval;\n"
17304 #: ../src/guestfs-structs.pod:201
17307 " struct guestfs_xattr_list {\n"
17308 " uint32_t len; /* Number of elements in list. */\n"
17309 " struct guestfs_xattr *val; /* Elements. */\n"
17315 #: ../src/guestfs-structs.pod:206
17318 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
17319 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
17324 #: ../src/guestfs-structs.pod:209
17325 msgid "guestfs_inotify_event"
17329 #: ../src/guestfs-structs.pod:211
17332 " struct guestfs_inotify_event {\n"
17333 " int64_t in_wd;\n"
17334 " uint32_t in_mask;\n"
17335 " uint32_t in_cookie;\n"
17336 " char *in_name;\n"
17342 #: ../src/guestfs-structs.pod:218
17345 " struct guestfs_inotify_event_list {\n"
17346 " uint32_t len; /* Number of elements in list. */\n"
17347 " struct guestfs_inotify_event *val; /* Elements. */\n"
17353 #: ../src/guestfs-structs.pod:223
17356 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
17357 " void guestfs_free_inotify_event_list (struct "
17358 "guestfs_free_inotify_event_list *);\n"
17363 #: ../src/guestfs-structs.pod:226
17364 msgid "guestfs_partition"
17368 #: ../src/guestfs-structs.pod:228
17371 " struct guestfs_partition {\n"
17372 " int32_t part_num;\n"
17373 " uint64_t part_start;\n"
17374 " uint64_t part_end;\n"
17375 " uint64_t part_size;\n"
17381 #: ../src/guestfs-structs.pod:235
17384 " struct guestfs_partition_list {\n"
17385 " uint32_t len; /* Number of elements in list. */\n"
17386 " struct guestfs_partition *val; /* Elements. */\n"
17392 #: ../src/guestfs-structs.pod:240
17395 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
17396 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
17401 #: ../src/guestfs-structs.pod:243
17402 msgid "guestfs_application"
17406 #: ../src/guestfs-structs.pod:245
17409 " struct guestfs_application {\n"
17410 " char *app_name;\n"
17411 " char *app_display_name;\n"
17412 " int32_t app_epoch;\n"
17413 " char *app_version;\n"
17414 " char *app_release;\n"
17415 " char *app_install_path;\n"
17416 " char *app_trans_path;\n"
17417 " char *app_publisher;\n"
17418 " char *app_url;\n"
17419 " char *app_source_package;\n"
17420 " char *app_summary;\n"
17421 " char *app_description;\n"
17427 #: ../src/guestfs-structs.pod:260
17430 " struct guestfs_application_list {\n"
17431 " uint32_t len; /* Number of elements in list. */\n"
17432 " struct guestfs_application *val; /* Elements. */\n"
17438 #: ../src/guestfs-structs.pod:265
17441 " void guestfs_free_application (struct guestfs_free_application *);\n"
17442 " void guestfs_free_application_list (struct guestfs_free_application_list "
17448 #: ../fish/guestfish.pod:5
17449 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17453 #: ../fish/guestfish.pod:9
17456 " guestfish [--options] [commands]\n"
17461 #: ../fish/guestfish.pod:11
17469 #: ../fish/guestfish.pod:13
17472 " guestfish [--ro|--rw] -a disk.img\n"
17477 #: ../fish/guestfish.pod:15
17480 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17485 #: ../fish/guestfish.pod:17
17488 " guestfish -d libvirt-domain\n"
17493 #: ../fish/guestfish.pod:19
17496 " guestfish [--ro|--rw] -a disk.img -i\n"
17501 #: ../fish/guestfish.pod:21
17504 " guestfish -d libvirt-domain -i\n"
17509 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
17514 #: ../fish/guestfish.pod:25
17516 "Using guestfish in read/write mode on live virtual machines can be "
17517 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17518 "option to use guestfish safely if the disk image or virtual machine might be "
17523 #: ../fish/guestfish.pod:32
17525 "Guestfish is a shell and command-line tool for examining and modifying "
17526 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17527 "functionality of the guestfs API, see L<guestfs(3)>."
17531 #: ../fish/guestfish.pod:36
17533 "Guestfish gives you structured access to the libguestfs API, from shell "
17534 "scripts or the command line or interactively. If you want to rescue a "
17535 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17540 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:897 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
17545 #: ../fish/guestfish.pod:43
17546 msgid "As an interactive shell"
17550 #: ../fish/guestfish.pod:45
17558 #: ../fish/guestfish.pod:47
17561 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17562 " editing virtual machine filesystems.\n"
17567 #: ../fish/guestfish.pod:50
17570 " Type: 'help' for a list of commands\n"
17571 " 'man' to read the manual\n"
17572 " 'quit' to quit the shell\n"
17577 #: ../fish/guestfish.pod:54
17580 " ><fs> add-ro disk.img\n"
17582 " ><fs> list-filesystems\n"
17583 " /dev/sda1: ext4\n"
17584 " /dev/vg_guest/lv_root: ext4\n"
17585 " /dev/vg_guest/lv_swap: swap\n"
17586 " ><fs> mount /dev/vg_guest/lv_root /\n"
17587 " ><fs> cat /etc/fstab\n"
17589 " # Created by anaconda\n"
17596 #: ../fish/guestfish.pod:67
17597 msgid "From shell scripts"
17601 #: ../fish/guestfish.pod:69
17602 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17606 #: ../fish/guestfish.pod:71
17609 " guestfish <<_EOF_\n"
17612 " mount /dev/vg_guest/lv_root /\n"
17613 " write /etc/motd \"Welcome, new users\"\n"
17619 #: ../fish/guestfish.pod:78
17620 msgid "List the LVM logical volumes in a disk image:"
17624 #: ../fish/guestfish.pod:80
17627 " guestfish -a disk.img --ro <<_EOF_\n"
17635 #: ../fish/guestfish.pod:85
17636 msgid "List all the filesystems in a disk image:"
17640 #: ../fish/guestfish.pod:87
17643 " guestfish -a disk.img --ro <<_EOF_\n"
17645 " list-filesystems\n"
17651 #: ../fish/guestfish.pod:92
17652 msgid "On one command line"
17656 #: ../fish/guestfish.pod:94
17657 msgid "Update C</etc/resolv.conf> in a guest:"
17661 #: ../fish/guestfish.pod:96
17665 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17666 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17671 #: ../fish/guestfish.pod:100
17672 msgid "Edit C</boot/grub/grub.conf> interactively:"
17676 #: ../fish/guestfish.pod:102
17679 " guestfish --rw --add disk.img \\\n"
17680 " --mount /dev/vg_guest/lv_root \\\n"
17681 " --mount /dev/sda1:/boot \\\n"
17682 " edit /boot/grub/grub.conf\n"
17687 #: ../fish/guestfish.pod:107
17688 msgid "Mount disks automatically"
17692 #: ../fish/guestfish.pod:109
17694 "Use the I<-i> option to automatically mount the disks from a virtual "
17699 #: ../fish/guestfish.pod:112
17702 " guestfish --ro -a disk.img -i cat /etc/group\n"
17707 #: ../fish/guestfish.pod:114
17710 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17715 #: ../fish/guestfish.pod:116
17716 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17720 #: ../fish/guestfish.pod:118
17723 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17728 #: ../fish/guestfish.pod:120
17729 msgid "As a script interpreter"
17733 #: ../fish/guestfish.pod:122
17734 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17738 #: ../fish/guestfish.pod:124
17741 " #!/usr/bin/guestfish -f\n"
17742 " sparse test1.img 100M\n"
17744 " part-disk /dev/sda mbr\n"
17745 " mkfs ext2 /dev/sda1\n"
17750 #: ../fish/guestfish.pod:130
17751 msgid "Start with a prepared disk"
17755 #: ../fish/guestfish.pod:132
17757 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17758 "single ext2-formatted partition:"
17762 #: ../fish/guestfish.pod:135
17765 " guestfish -N fs\n"
17770 #: ../fish/guestfish.pod:137
17771 msgid "To list what is available do:"
17775 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:888
17778 " guestfish -N help | less\n"
17783 #: ../fish/guestfish.pod:141
17784 msgid "Remote control"
17788 #: ../fish/guestfish.pod:143
17791 " eval \"`guestfish --listen`\"\n"
17792 " guestfish --remote add-ro disk.img\n"
17793 " guestfish --remote run\n"
17794 " guestfish --remote lvs\n"
17799 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
17804 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:104 ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
17809 #: ../fish/guestfish.pod:154
17810 msgid "Displays general help on options."
17814 #: ../fish/guestfish.pod:156
17819 #: ../fish/guestfish.pod:158
17820 msgid "B<--cmd-help>"
17824 #: ../fish/guestfish.pod:160
17825 msgid "Lists all available guestfish commands."
17829 #: ../fish/guestfish.pod:162
17834 #: ../fish/guestfish.pod:164
17835 msgid "B<--cmd-help cmd>"
17839 #: ../fish/guestfish.pod:166
17840 msgid "Displays detailed help on a single command C<cmd>."
17844 #: ../fish/guestfish.pod:168
17845 msgid "B<-a image>"
17849 #: ../fish/guestfish.pod:170
17850 msgid "B<--add image>"
17854 #: ../fish/guestfish.pod:172
17855 msgid "Add a block device or virtual machine image to the shell."
17859 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
17861 "The format of the disk image is auto-detected. To override this and force a "
17862 "particular format use the I<--format=..> option."
17866 #: ../fish/guestfish.pod:177
17868 "Using this flag is mostly equivalent to using the C<add> command, with "
17869 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17870 "the I<--format:...> flag was given."
17874 #: ../fish/guestfish.pod:181
17879 #: ../fish/guestfish.pod:183
17880 msgid "B<--connect URI>"
17884 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
17886 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17887 "URI to use. The default is to use the default libvirt connection."
17891 #: ../fish/guestfish.pod:189
17896 #: ../fish/guestfish.pod:191
17898 "If using the I<--listen> option and a csh-like shell, use this option. See "
17899 "section L</REMOTE CONTROL AND CSH> below."
17903 #: ../fish/guestfish.pod:194
17904 msgid "B<-d libvirt-domain>"
17908 #: ../fish/guestfish.pod:196
17909 msgid "B<--domain libvirt-domain>"
17913 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
17915 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17916 "used, then any libvirt domain can be used. However in write mode, only "
17917 "libvirt domains which are shut down can be named here."
17921 #: ../fish/guestfish.pod:202
17923 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17924 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17925 "if the I<--format:...> flag was given."
17929 #: ../fish/guestfish.pod:206
17934 #: ../fish/guestfish.pod:208
17935 msgid "B<--no-dest-paths>"
17939 #: ../fish/guestfish.pod:210
17941 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17942 "to hit the tab key to complete paths on the guest filesystem, but this "
17943 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17944 "allow this feature to be disabled."
17948 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
17949 msgid "B<--echo-keys>"
17953 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
17955 "When prompting for keys and passphrases, guestfish normally turns echoing "
17956 "off so you cannot see what you are typing. If you are not worried about "
17957 "Tempest attacks and there is no one else in the room you can specify this "
17958 "flag to see what you are typing."
17962 #: ../fish/guestfish.pod:222
17967 #: ../fish/guestfish.pod:224
17968 msgid "B<--file file>"
17972 #: ../fish/guestfish.pod:226
17973 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17977 #: ../fish/guestfish.pod:229
17980 " #!/usr/bin/guestfish -f\n"
17985 #: ../fish/guestfish.pod:231
17986 msgid "B<--format=raw|qcow2|..>"
17990 #: ../fish/guestfish.pod:233
17991 msgid "B<--format>"
17995 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
17997 "The default for the I<-a> option is to auto-detect the format of the disk "
17998 "image. Using this forces the disk format for I<-a> options which follow on "
17999 "the command line. Using I<--format> with no argument switches back to "
18000 "auto-detection for subsequent I<-a> options."
18004 #: ../fish/guestfish.pod:242
18007 " guestfish --format=raw -a disk.img\n"
18012 #: ../fish/guestfish.pod:244
18013 msgid "forces raw format (no auto-detection) for C<disk.img>."
18017 #: ../fish/guestfish.pod:246
18020 " guestfish --format=raw -a disk.img --format -a another.img\n"
18025 #: ../fish/guestfish.pod:248
18027 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18028 "auto-detection for C<another.img>."
18032 #: ../fish/guestfish.pod:251
18034 "If you have untrusted raw-format guest disk images, you should use this "
18035 "option to specify the disk format. This avoids a possible security problem "
18036 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18040 #: ../fish/guestfish.pod:256
18045 #: ../fish/guestfish.pod:258
18046 msgid "B<--inspector>"
18050 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18052 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18053 "system and mount filesystems as they would be mounted on the real virtual "
18058 #: ../fish/guestfish.pod:264
18059 msgid "Typical usage is either:"
18063 #: ../fish/guestfish.pod:266
18066 " guestfish -d myguest -i\n"
18071 #: ../fish/guestfish.pod:268
18072 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18076 #: ../fish/guestfish.pod:270
18079 " guestfish --ro -d myguest -i\n"
18084 #: ../fish/guestfish.pod:272
18085 msgid "(for active domains, readonly), or specify the block device directly:"
18089 #: ../fish/guestfish.pod:274
18092 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18097 #: ../fish/guestfish.pod:276
18099 "Note that the command line syntax changed slightly over older versions of "
18100 "guestfish. You can still use the old syntax:"
18104 #: ../fish/guestfish.pod:279
18107 " guestfish [--ro] -i disk.img\n"
18112 #: ../fish/guestfish.pod:281
18115 " guestfish [--ro] -i libvirt-domain\n"
18120 #: ../fish/guestfish.pod:283
18122 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
18123 "then using other commands to mount the filesystems that were found."
18127 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
18128 msgid "B<--keys-from-stdin>"
18132 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
18134 "Read key or passphrase parameters from stdin. The default is to try to read "
18135 "passphrases from the user by opening C</dev/tty>."
18139 #: ../fish/guestfish.pod:292
18140 msgid "B<--listen>"
18144 #: ../fish/guestfish.pod:294
18146 "Fork into the background and listen for remote commands. See section "
18147 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18151 #: ../fish/guestfish.pod:297
18152 msgid "B<-m dev[:mountpoint]>"
18156 #: ../fish/guestfish.pod:299
18157 msgid "B<--mount dev[:mountpoint]>"
18161 #: ../fish/guestfish.pod:301
18162 msgid "Mount the named partition or logical volume on the given mountpoint."
18166 #: ../fish/guestfish.pod:303
18167 msgid "If the mountpoint is omitted, it defaults to C</>."
18171 #: ../fish/guestfish.pod:305
18172 msgid "You have to mount something on C</> before most commands will work."
18176 #: ../fish/guestfish.pod:307
18178 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18183 #: ../fish/guestfish.pod:310
18185 "If you don't know what filesystems a disk image contains, you can either run "
18186 "guestfish without this option, then list the partitions, filesystems and LVs "
18187 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18188 "commands), or you can use the L<virt-filesystems(1)> program."
18192 #: ../fish/guestfish.pod:316
18194 "Using this flag is mostly equivalent to using the C<mount-options> command "
18195 "or the C<mount-ro> command if the I<--ro> flag was given."
18199 #: ../fish/guestfish.pod:319
18204 #: ../fish/guestfish.pod:321
18205 msgid "B<--no-sync>"
18209 #: ../fish/guestfish.pod:323
18211 "Disable autosync. This is enabled by default. See the discussion of "
18212 "autosync in the L<guestfs(3)> manpage."
18216 #: ../fish/guestfish.pod:326
18221 #: ../fish/guestfish.pod:328
18222 msgid "B<--new type>"
18226 #: ../fish/guestfish.pod:330
18231 #: ../fish/guestfish.pod:332
18233 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18234 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18235 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18240 #: ../fish/guestfish.pod:337
18241 msgid "B<--progress-bars>"
18245 #: ../fish/guestfish.pod:339
18246 msgid "Enable progress bars, even when guestfish is used non-interactively."
18250 #: ../fish/guestfish.pod:341
18252 "Progress bars are enabled by default when guestfish is used as an "
18253 "interactive shell."
18257 #: ../fish/guestfish.pod:344
18258 msgid "B<--no-progress-bars>"
18262 #: ../fish/guestfish.pod:346
18263 msgid "Disable progress bars."
18267 #: ../fish/guestfish.pod:348
18268 msgid "B<--remote[=pid]>"
18272 #: ../fish/guestfish.pod:350
18274 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18275 "CONTROL GUESTFISH OVER A SOCKET> below."
18279 #: ../fish/guestfish.pod:353
18284 #: ../fish/guestfish.pod:355
18289 #: ../fish/guestfish.pod:357
18291 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18292 "mounts are done read-only."
18296 #: ../fish/guestfish.pod:360
18298 "The option must always be used if the disk image or virtual machine might be "
18299 "running, and is generally recommended in cases where you don't need write "
18300 "access to the disk."
18304 #: ../fish/guestfish.pod:364
18306 "Note that prepared disk images created with I<-N> are not affected by this "
18307 "option. Also commands like C<add> are not affected - you have to specify "
18308 "the C<readonly:true> option explicitly if you need it."
18312 #: ../fish/guestfish.pod:368
18313 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18317 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
18318 msgid "B<--selinux>"
18322 #: ../fish/guestfish.pod:372
18323 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18327 #: ../fish/guestfish.pod:374
18332 #: ../fish/guestfish.pod:376
18333 msgid "B<--verbose>"
18337 #: ../fish/guestfish.pod:378
18339 "Enable very verbose messages. This is particularly useful if you find a "
18344 #: ../fish/guestfish.pod:381
18349 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
18350 msgid "B<--version>"
18354 #: ../fish/guestfish.pod:385
18355 msgid "Display the guestfish / libguestfs version number and exit."
18359 #: ../fish/guestfish.pod:387
18364 #: ../fish/guestfish.pod:389
18369 #: ../fish/guestfish.pod:391
18371 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
18376 #: ../fish/guestfish.pod:394
18381 #: ../fish/guestfish.pod:396
18382 msgid "Echo each command before executing it."
18386 #: ../fish/guestfish.pod:400
18387 msgid "COMMANDS ON COMMAND LINE"
18391 #: ../fish/guestfish.pod:402
18392 msgid "Any additional (non-option) arguments are treated as commands to execute."
18396 #: ../fish/guestfish.pod:405
18398 "Commands to execute should be separated by a colon (C<:>), where the colon "
18399 "is a separate parameter. Thus:"
18403 #: ../fish/guestfish.pod:408
18406 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18411 #: ../fish/guestfish.pod:410
18413 "If there are no additional arguments, then we enter a shell, either an "
18414 "interactive shell with a prompt (if the input is a terminal) or a "
18415 "non-interactive shell."
18419 #: ../fish/guestfish.pod:414
18421 "In either command line mode or non-interactive shell, the first command that "
18422 "gives an error causes the whole shell to exit. In interactive mode (with a "
18423 "prompt) if a command fails, you can continue to enter commands."
18427 #: ../fish/guestfish.pod:419
18428 msgid "USING launch (OR run)"
18432 #: ../fish/guestfish.pod:421
18434 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18435 "then launch it, then mount any disks you need, and finally issue "
18436 "actions/commands. So the general order of the day is:"
18440 #: ../fish/guestfish.pod:429
18441 msgid "add or -a/--add"
18445 #: ../fish/guestfish.pod:433
18446 msgid "launch (aka run)"
18450 #: ../fish/guestfish.pod:437
18451 msgid "mount or -m/--mount"
18455 #: ../fish/guestfish.pod:441
18456 msgid "any other commands"
18460 #: ../fish/guestfish.pod:445
18462 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18463 "guest before mounting or performing any other commands."
18467 #: ../fish/guestfish.pod:448
18469 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18470 "I<--new> options were given then C<run> is done automatically, simply "
18471 "because guestfish can't perform the action you asked for without doing this."
18475 #: ../fish/guestfish.pod:453
18476 msgid "OPENING DISKS FOR READ AND WRITE"
18480 #: ../fish/guestfish.pod:455
18482 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
18483 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
18484 "open disk images read-only or for writing."
18488 #: ../fish/guestfish.pod:459
18490 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
18491 "disk images supplied on the command line for write. To open a disk image "
18492 "read-only you have to do I<-a image --ro>."
18496 #: ../fish/guestfish.pod:463
18498 "This matters: If you accidentally open a live VM disk image writable then "
18499 "you will cause irreversible disk corruption."
18503 #: ../fish/guestfish.pod:466
18505 "By libguestfs 1.10 we intend to change the default the other way. Disk "
18506 "images will be opened read-only. You will have to either specify "
18507 "I<guestfish --rw> or change a configuration file in order to get write "
18508 "access for disk images specified by those other command line options."
18512 #: ../fish/guestfish.pod:471
18514 "This version of guestfish has a I<--rw> option which does nothing (it is "
18515 "already the default). However it is highly recommended that you use this "
18516 "option to indicate that guestfish needs write access, and to prepare your "
18517 "scripts for the day when this option will be required for write access."
18521 #: ../fish/guestfish.pod:477
18523 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18524 "other libguestfs program apart from guestfish and guestmount."
18528 #: ../fish/guestfish.pod:480
18533 #: ../fish/guestfish.pod:482
18535 "You can quote ordinary parameters using either single or double quotes. For "
18540 #: ../fish/guestfish.pod:485
18543 " add \"file with a space.img\"\n"
18548 #: ../fish/guestfish.pod:487
18551 " rm '/file name'\n"
18556 #: ../fish/guestfish.pod:489
18564 #: ../fish/guestfish.pod:491
18566 "A few commands require a list of strings to be passed. For these, use a "
18567 "whitespace-separated list, enclosed in quotes. Strings containing "
18568 "whitespace to be passed through must be enclosed in single quotes. A "
18569 "literal single quote must be escaped with a backslash."
18573 #: ../fish/guestfish.pod:496
18576 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18577 " command \"/bin/echo 'foo bar'\"\n"
18578 " command \"/bin/echo \\'foo\\'\"\n"
18583 #: ../fish/guestfish.pod:500
18584 msgid "OPTIONAL ARGUMENTS"
18588 #: ../fish/guestfish.pod:502
18590 "Some commands take optional arguments. These arguments appear in this "
18591 "documentation as C<[argname:..]>. You can use them as in these examples:"
18595 #: ../fish/guestfish.pod:506
18598 " add-drive-opts filename\n"
18603 #: ../fish/guestfish.pod:508
18606 " add-drive-opts filename readonly:true\n"
18611 #: ../fish/guestfish.pod:510
18614 " add-drive-opts filename format:qcow2 readonly:false\n"
18619 #: ../fish/guestfish.pod:512
18621 "Each optional argument can appear at most once. All optional arguments must "
18622 "appear after the required ones."
18626 #: ../fish/guestfish.pod:515
18631 #: ../fish/guestfish.pod:517
18632 msgid "This section applies to all commands which can take integers as parameters."
18636 #: ../fish/guestfish.pod:520
18637 msgid "SIZE SUFFIX"
18641 #: ../fish/guestfish.pod:522
18643 "When the command takes a parameter measured in bytes, you can use one of the "
18644 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18648 #: ../fish/guestfish.pod:528
18649 msgid "B<k> or B<K> or B<KiB>"
18653 #: ../fish/guestfish.pod:530
18654 msgid "The size in kilobytes (multiplied by 1024)."
18658 #: ../fish/guestfish.pod:532
18663 #: ../fish/guestfish.pod:534
18664 msgid "The size in SI 1000 byte units."
18668 #: ../fish/guestfish.pod:536
18669 msgid "B<M> or B<MiB>"
18673 #: ../fish/guestfish.pod:538
18674 msgid "The size in megabytes (multiplied by 1048576)."
18678 #: ../fish/guestfish.pod:540
18683 #: ../fish/guestfish.pod:542
18684 msgid "The size in SI 1000000 byte units."
18688 #: ../fish/guestfish.pod:544
18689 msgid "B<G> or B<GiB>"
18693 #: ../fish/guestfish.pod:546
18694 msgid "The size in gigabytes (multiplied by 2**30)."
18698 #: ../fish/guestfish.pod:548
18703 #: ../fish/guestfish.pod:550
18704 msgid "The size in SI 10**9 byte units."
18708 #: ../fish/guestfish.pod:552
18709 msgid "B<T> or B<TiB>"
18713 #: ../fish/guestfish.pod:554
18714 msgid "The size in terabytes (multiplied by 2**40)."
18718 #: ../fish/guestfish.pod:556
18723 #: ../fish/guestfish.pod:558
18724 msgid "The size in SI 10**12 byte units."
18728 #: ../fish/guestfish.pod:560
18729 msgid "B<P> or B<PiB>"
18733 #: ../fish/guestfish.pod:562
18734 msgid "The size in petabytes (multiplied by 2**50)."
18738 #: ../fish/guestfish.pod:564
18743 #: ../fish/guestfish.pod:566
18744 msgid "The size in SI 10**15 byte units."
18748 #: ../fish/guestfish.pod:568
18749 msgid "B<E> or B<EiB>"
18753 #: ../fish/guestfish.pod:570
18754 msgid "The size in exabytes (multiplied by 2**60)."
18758 #: ../fish/guestfish.pod:572
18763 #: ../fish/guestfish.pod:574
18764 msgid "The size in SI 10**18 byte units."
18768 #: ../fish/guestfish.pod:576
18769 msgid "B<Z> or B<ZiB>"
18773 #: ../fish/guestfish.pod:578
18774 msgid "The size in zettabytes (multiplied by 2**70)."
18778 #: ../fish/guestfish.pod:580
18783 #: ../fish/guestfish.pod:582
18784 msgid "The size in SI 10**21 byte units."
18788 #: ../fish/guestfish.pod:584
18789 msgid "B<Y> or B<YiB>"
18793 #: ../fish/guestfish.pod:586
18794 msgid "The size in yottabytes (multiplied by 2**80)."
18798 #: ../fish/guestfish.pod:588
18803 #: ../fish/guestfish.pod:590
18804 msgid "The size in SI 10**24 byte units."
18808 #: ../fish/guestfish.pod:596
18811 " truncate-size /file 1G\n"
18816 #: ../fish/guestfish.pod:598
18817 msgid "would truncate the file to 1 gigabyte."
18821 #: ../fish/guestfish.pod:600
18823 "Be careful because a few commands take sizes in kilobytes or megabytes "
18824 "(eg. the parameter to L</memsize> is specified in megabytes already). "
18825 "Adding a suffix will probably not do what you expect."
18829 #: ../fish/guestfish.pod:604
18830 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18834 #: ../fish/guestfish.pod:606
18836 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18837 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18841 #: ../fish/guestfish.pod:609
18844 " 1234 decimal number 1234\n"
18845 " 02322 octal number, equivalent to decimal 1234\n"
18846 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18851 #: ../fish/guestfish.pod:613
18853 "When using the C<chmod> command, you almost always want to specify an octal "
18854 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18855 "L<chmod(1)> program):"
18859 #: ../fish/guestfish.pod:617
18862 " chmod 0777 /public # OK\n"
18863 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18868 #: ../fish/guestfish.pod:620
18870 "Commands that return numbers usually print them in decimal, but some "
18871 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18872 "octal, preceeded by C<0>)."
18876 #: ../fish/guestfish.pod:624
18877 msgid "WILDCARDS AND GLOBBING"
18881 #: ../fish/guestfish.pod:626
18883 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18884 "(globbing) by default. So for example the following will not do what you "
18889 #: ../fish/guestfish.pod:630
18897 #: ../fish/guestfish.pod:632
18899 "Assuming you don't have a directory called literally C</home/*> then the "
18900 "above command will return an error."
18904 #: ../fish/guestfish.pod:635
18905 msgid "To perform wildcard expansion, use the C<glob> command."
18909 #: ../fish/guestfish.pod:637
18912 " glob rm-rf /home/*\n"
18917 #: ../fish/guestfish.pod:639
18919 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18920 "many times), equivalent to:"
18924 #: ../fish/guestfish.pod:642
18927 " rm-rf /home/jim\n"
18928 " rm-rf /home/joe\n"
18929 " rm-rf /home/mary\n"
18934 #: ../fish/guestfish.pod:646
18935 msgid "C<glob> only works on simple guest paths and not on device names."
18939 #: ../fish/guestfish.pod:648
18941 "If you have several parameters, each containing a wildcard, then glob will "
18942 "perform a Cartesian product."
18946 #: ../fish/guestfish.pod:651
18951 #: ../fish/guestfish.pod:653
18953 "Any line which starts with a I<#> character is treated as a comment and "
18954 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18955 "a command. For example:"
18959 #: ../fish/guestfish.pod:657
18962 " # this is a comment\n"
18963 " # this is a comment\n"
18964 " foo # NOT a comment\n"
18969 #: ../fish/guestfish.pod:661
18970 msgid "Blank lines are also ignored."
18974 #: ../fish/guestfish.pod:663
18975 msgid "RUNNING COMMANDS LOCALLY"
18979 #: ../fish/guestfish.pod:665
18981 "Any line which starts with a I<!> character is treated as a command sent to "
18982 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18986 #: ../fish/guestfish.pod:669
18990 " tgz-out /remote local/remote-data.tar.gz\n"
18995 #: ../fish/guestfish.pod:672
18997 "will create a directory C<local> on the host, and then export the contents "
18998 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18999 "(See C<tgz-out>)."
19003 #: ../fish/guestfish.pod:676
19005 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
19006 "effect, due to the way that subprocesses work in Unix."
19010 #: ../fish/guestfish.pod:679
19015 #: ../fish/guestfish.pod:681
19017 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19018 "command (a guestfish command) to the second command (any host command). For "
19023 #: ../fish/guestfish.pod:685
19026 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19031 #: ../fish/guestfish.pod:687
19033 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19034 "program). The above command would list all accounts in the guest filesystem "
19035 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19039 #: ../fish/guestfish.pod:692
19042 " hexdump /bin/ls | head\n"
19043 " list-devices | tail -1\n"
19044 " tgz-out / - | tar ztf -\n"
19049 #: ../fish/guestfish.pod:696
19051 "The space before the pipe symbol is required, any space after the pipe "
19052 "symbol is optional. Everything after the pipe symbol is just passed "
19053 "straight to the host shell, so it can contain redirections, globs and "
19054 "anything else that makes sense on the host side."
19058 #: ../fish/guestfish.pod:701
19060 "To use a literal argument which begins with a pipe symbol, you have to quote "
19065 #: ../fish/guestfish.pod:704
19073 #: ../fish/guestfish.pod:706
19074 msgid "HOME DIRECTORIES"
19078 #: ../fish/guestfish.pod:708
19080 "If a parameter starts with the character C<~> then the tilde may be expanded "
19081 "as a home directory path (either C<~> for the current user's home directory, "
19082 "or C<~user> for another user)."
19086 #: ../fish/guestfish.pod:712
19088 "Note that home directory expansion happens for users known I<on the host>, "
19089 "not in the guest filesystem."
19093 #: ../fish/guestfish.pod:715
19095 "To use a literal argument which begins with a tilde, you have to quote it, "
19100 #: ../fish/guestfish.pod:718
19108 #: ../fish/guestfish.pod:722
19110 "Libguestfs has some support for Linux guests encrypted according to the "
19111 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19112 "disk encryption systems used by modern Linux guests. Currently only "
19113 "LVM-on-LUKS is supported."
19117 #: ../fish/guestfish.pod:727
19118 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19122 #: ../fish/guestfish.pod:729
19125 " ><fs> vfs-type /dev/sda2\n"
19131 #: ../fish/guestfish.pod:732
19133 "Then open those devices using L</luks-open>. This creates a device-mapper "
19134 "device called C</dev/mapper/luksdev>."
19138 #: ../fish/guestfish.pod:735
19141 " ><fs> luks-open /dev/sda2 luksdev\n"
19142 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19147 #: ../fish/guestfish.pod:738
19149 "Finally you have to tell LVM to scan for volume groups on the newly created "
19154 #: ../fish/guestfish.pod:741
19158 " vg-activate-all true\n"
19163 #: ../fish/guestfish.pod:744
19164 msgid "The logical volume(s) can now be mounted in the usual way."
19168 #: ../fish/guestfish.pod:746
19170 "Before closing a LUKS device you must unmount any logical volumes on it and "
19171 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19172 "one. Then you can close the mapper device:"
19176 #: ../fish/guestfish.pod:750
19179 " vg-activate false /dev/VG\n"
19180 " luks-close /dev/mapper/luksdev\n"
19185 #: ../fish/guestfish.pod:753
19186 msgid "WINDOWS PATHS"
19190 #: ../fish/guestfish.pod:755
19192 "If a path is prefixed with C<win:> then you can use Windows-style paths "
19193 "(with some limitations). The following commands are equivalent:"
19197 #: ../fish/guestfish.pod:758
19200 " file /WINDOWS/system32/config/system.LOG\n"
19205 #: ../fish/guestfish.pod:760
19208 " file win:/windows/system32/config/system.log\n"
19213 #: ../fish/guestfish.pod:762
19216 " file win:\\windows\\system32\\config\\system.log\n"
19221 #: ../fish/guestfish.pod:764
19224 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
19229 #: ../fish/guestfish.pod:766
19231 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
19232 "handles case insensitivity like Windows would. This only works in argument "
19233 "positions that expect a path."
19237 #: ../fish/guestfish.pod:770
19238 msgid "UPLOADING AND DOWNLOADING FILES"
19242 #: ../fish/guestfish.pod:772
19244 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19245 "others which upload from or download to a local file, you can use the "
19246 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19250 #: ../fish/guestfish.pod:776
19258 #: ../fish/guestfish.pod:778
19259 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19263 #: ../fish/guestfish.pod:781
19266 " tar-out /etc - | tar tf -\n"
19271 #: ../fish/guestfish.pod:783
19273 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19274 "command (see L</PIPES>)."
19278 #: ../fish/guestfish.pod:786
19280 "When using C<-> to read from stdin, the input is read up to the end of "
19281 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19282 "some arbitrary end marker:"
19286 #: ../fish/guestfish.pod:790
19289 " upload -<<END /foo\n"
19298 #: ../fish/guestfish.pod:796
19300 "Any string of characters can be used instead of C<END>. The end marker must "
19301 "appear on a line of its own, without any preceeding or following characters "
19302 "(not even spaces)."
19306 #: ../fish/guestfish.pod:800
19308 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19309 "upload local files (so-called \"FileIn\" parameters in the generator)."
19313 #: ../fish/guestfish.pod:803
19314 msgid "EXIT ON ERROR BEHAVIOUR"
19318 #: ../fish/guestfish.pod:805
19320 "By default, guestfish will ignore any errors when in interactive mode "
19321 "(ie. taking commands from a human over a tty), and will exit on the first "
19322 "error in non-interactive mode (scripts, commands given on the command line)."
19326 #: ../fish/guestfish.pod:810
19328 "If you prefix a command with a I<-> character, then that command will not "
19329 "cause guestfish to exit, even if that (one) command returns an error."
19333 #: ../fish/guestfish.pod:814
19334 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19338 #: ../fish/guestfish.pod:816
19340 "Guestfish can be remote-controlled over a socket. This is useful "
19341 "particularly in shell scripts where you want to make several different "
19342 "changes to a filesystem, but you don't want the overhead of starting up a "
19343 "guestfish process each time."
19347 #: ../fish/guestfish.pod:821
19348 msgid "Start a guestfish server process using:"
19352 #: ../fish/guestfish.pod:823
19355 " eval \"`guestfish --listen`\"\n"
19360 #: ../fish/guestfish.pod:825
19361 msgid "and then send it commands by doing:"
19365 #: ../fish/guestfish.pod:827
19368 " guestfish --remote cmd [...]\n"
19373 #: ../fish/guestfish.pod:829
19374 msgid "To cause the server to exit, send it the exit command:"
19378 #: ../fish/guestfish.pod:831
19381 " guestfish --remote exit\n"
19386 #: ../fish/guestfish.pod:833
19388 "Note that the server will normally exit if there is an error in a command. "
19389 "You can change this in the usual way. See section L</EXIT ON ERROR "
19394 #: ../fish/guestfish.pod:837
19395 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19399 #: ../fish/guestfish.pod:839
19401 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19402 "is how the I<--remote> option knows where to send the commands. You can "
19403 "have several guestfish listener processes running using:"
19407 #: ../fish/guestfish.pod:843
19410 " eval \"`guestfish --listen`\"\n"
19411 " pid1=$GUESTFISH_PID\n"
19412 " eval \"`guestfish --listen`\"\n"
19413 " pid2=$GUESTFISH_PID\n"
19415 " guestfish --remote=$pid1 cmd\n"
19416 " guestfish --remote=$pid2 cmd\n"
19421 #: ../fish/guestfish.pod:851
19422 msgid "REMOTE CONTROL AND CSH"
19426 #: ../fish/guestfish.pod:853
19428 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19433 #: ../fish/guestfish.pod:856
19436 " eval \"`guestfish --listen --csh`\"\n"
19441 #: ../fish/guestfish.pod:858
19442 msgid "REMOTE CONTROL DETAILS"
19446 #: ../fish/guestfish.pod:860
19448 "Remote control happens over a Unix domain socket called "
19449 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19450 "of the process, and C<$PID> is the process ID of the server."
19454 #: ../fish/guestfish.pod:864
19455 msgid "Guestfish client and server versions must match exactly."
19459 #: ../fish/guestfish.pod:866
19460 msgid "PREPARED DISK IMAGES"
19464 #: ../fish/guestfish.pod:868
19466 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19467 "preformatted disk images that guestfish can make for you to save typing. "
19468 "This is particularly useful for testing purposes. This option is used "
19469 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19470 "can be mixed with I<-a>)."
19474 #: ../fish/guestfish.pod:874
19476 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19477 "the second and so on. Existing files in the current directory are "
19482 #: ../fish/guestfish.pod:878
19484 "The type briefly describes how the disk should be sized, partitioned, how "
19485 "filesystem(s) should be created, and how content should be added. "
19486 "Optionally the type can be followed by extra parameters, separated by C<:> "
19487 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19488 "sparsely-allocated disk, containing a single partition, with the partition "
19489 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19490 "on a 1GB disk instead."
19494 #: ../fish/guestfish.pod:886
19495 msgid "To list the available types and any extra parameters they take, run:"
19499 #: ../fish/guestfish.pod:890
19501 "Note that the prepared filesystem is not mounted. You would usually have to "
19502 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19506 #: ../fish/guestfish.pod:894
19508 "If any I<-N> or I<--new> options are given, the guest is automatically "
19513 #: ../fish/guestfish.pod:899
19514 msgid "Create a 100MB disk with an ext4-formatted partition:"
19518 #: ../fish/guestfish.pod:901
19521 " guestfish -N fs:ext4\n"
19526 #: ../fish/guestfish.pod:903
19527 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19531 #: ../fish/guestfish.pod:905
19534 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19539 #: ../fish/guestfish.pod:907
19540 msgid "Create a blank 200MB disk:"
19544 #: ../fish/guestfish.pod:909
19547 " guestfish -N disk:200M\n"
19552 #: ../fish/guestfish.pod:911
19553 msgid "PROGRESS BARS"
19557 #: ../fish/guestfish.pod:913
19559 "Some (not all) long-running commands send progress notification messages as "
19560 "they are running. Guestfish turns these messages into progress bars."
19564 #: ../fish/guestfish.pod:917
19566 "When a command that supports progress bars takes longer than two seconds to "
19567 "run, and if progress bars are enabled, then you will see one appearing below "
19572 #: ../fish/guestfish.pod:921
19575 " ><fs> copy-size /large-file /another-file 2048M\n"
19576 " / 10% [#####-----------------------------------------] 00:30\n"
19581 #: ../fish/guestfish.pod:924
19583 "The spinner on the left hand side moves round once for every progress "
19584 "notification received from the backend. This is a (reasonably) golden "
19585 "assurance that the command is \"doing something\" even if the progress bar "
19586 "is not moving, because the command is able to send the progress "
19587 "notifications. When the bar reaches 100% and the command finishes, the "
19588 "spinner disappears."
19592 #: ../fish/guestfish.pod:931
19594 "Progress bars are enabled by default when guestfish is used interactively. "
19595 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19596 "and you can disable them completely using I<--no-progress-bars>."
19600 #: ../fish/guestfish.pod:936
19601 msgid "GUESTFISH COMMANDS"
19605 #: ../fish/guestfish.pod:938
19607 "The commands in this section are guestfish convenience commands, in other "
19608 "words, they are not part of the L<guestfs(3)> API."
19612 #: ../fish/guestfish.pod:941
19617 #: ../fish/guestfish.pod:943
19626 #: ../fish/guestfish.pod:946
19627 msgid "Without any parameter, this provides general help."
19631 #: ../fish/guestfish.pod:948
19632 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19636 #: ../fish/guestfish.pod:950
19637 msgid "quit | exit"
19641 #: ../fish/guestfish.pod:952
19642 msgid "This exits guestfish. You can also use C<^D> key."
19646 #: ../fish/guestfish.pod:954
19647 msgid "@FISH_COMMANDS@"
19651 #: ../fish/guestfish.pod:956
19656 #: ../fish/guestfish.pod:960 ../test-tool/libguestfs-test-tool.pod:83
19661 #: ../fish/guestfish.pod:962
19663 "guestfish returns 0 if the commands completed without error, or 1 if there "
19668 #: ../fish/guestfish.pod:969
19673 #: ../fish/guestfish.pod:971
19675 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19680 #: ../fish/guestfish.pod:974
19681 msgid "GUESTFISH_PID"
19685 #: ../fish/guestfish.pod:976
19687 "Used with the I<--remote> option to specify the remote guestfish process to "
19688 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19692 #: ../fish/guestfish.pod:980
19697 #: ../fish/guestfish.pod:982
19699 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19700 "not specified, the external L<hexedit(1)> program is used."
19704 #: ../fish/guestfish.pod:986
19709 #: ../fish/guestfish.pod:988
19711 "If compiled with GNU readline support, various files in the home directory "
19712 "can be used. See L</FILES>."
19716 #: ../fish/guestfish.pod:997
19718 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19719 "effect as using the B<-v> option."
19723 #: ../fish/guestfish.pod:1009
19725 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19726 "the discussion of paths in L<guestfs(3)>."
19730 #: ../fish/guestfish.pod:1020
19731 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19735 #: ../fish/guestfish.pod:1022
19740 #: ../fish/guestfish.pod:1024
19742 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19747 #: ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:88
19752 #: ../fish/guestfish.pod:1043
19753 msgid "$HOME/.guestfish"
19757 #: ../fish/guestfish.pod:1045
19759 "If compiled with GNU readline support, then the command history is saved in "
19764 #: ../fish/guestfish.pod:1048
19765 msgid "$HOME/.inputrc"
19769 #: ../fish/guestfish.pod:1050
19770 msgid "/etc/inputrc"
19774 #: ../fish/guestfish.pod:1052
19776 "If compiled with GNU readline support, then these files can be used to "
19777 "configure readline. For further information, please see "
19778 "L<readline(3)/INITIALIZATION FILE>."
19782 #: ../fish/guestfish.pod:1056
19783 msgid "To write rules which only apply to guestfish, use:"
19787 #: ../fish/guestfish.pod:1058
19797 #: ../fish/guestfish.pod:1062
19799 "Variables that you can set in inputrc that change the behaviour of guestfish "
19800 "in useful ways include:"
19804 #: ../fish/guestfish.pod:1067
19805 msgid "completion-ignore-case (default: on)"
19809 #: ../fish/guestfish.pod:1069
19811 "By default, guestfish will ignore case when tab-completing paths on the "
19816 #: ../fish/guestfish.pod:1072
19819 " set completion-ignore-case off\n"
19824 #: ../fish/guestfish.pod:1074
19825 msgid "to make guestfish case sensitive."
19829 #: ../fish/guestfish.pod:1078
19834 #: ../fish/guestfish.pod:1080
19835 msgid "test2.img (etc)"
19839 #: ../fish/guestfish.pod:1082
19841 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19842 "will be created in the file C<test1.img> in the current directory. The "
19843 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19844 "the same name will be overwritten."
19848 #: ../fish/guestfish.pod:1091
19850 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
19851 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
19852 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
19853 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
19854 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
19855 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
19859 #: ../fish/guestfish.pod:1121 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:372 ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
19861 "This program is free software; you can redistribute it and/or modify it "
19862 "under the terms of the GNU General Public License as published by the Free "
19863 "Software Foundation; either version 2 of the License, or (at your option) "
19864 "any later version."
19868 #: ../fish/guestfish.pod:1126 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:377 ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1517 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
19870 "This program is distributed in the hope that it will be useful, but WITHOUT "
19871 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19872 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19877 #: ../fish/guestfish.pod:1131 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:382 ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1522 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
19879 "You should have received a copy of the GNU General Public License along with "
19880 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19881 "Ave, Cambridge, MA 02139, USA."
19885 #: ../fish/guestfish-actions.pod:1
19890 #: ../fish/guestfish-actions.pod:3
19893 " add-cdrom filename\n"
19898 #: ../fish/guestfish-actions.pod:15
19900 "This call checks for the existence of C<filename>. This stops you from "
19901 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19902 "and C<http:> URLs. To specify those, use the general L</config> call "
19907 #: ../fish/guestfish-actions.pod:22
19909 "If you just want to add an ISO file (often you use this as an efficient way "
19910 "to transfer large files into the guest), then you should probably use "
19911 "L</add-drive-ro> instead."
19915 #: ../fish/guestfish-actions.pod:35
19920 #: ../fish/guestfish-actions.pod:37
19925 #: ../fish/guestfish-actions.pod:39
19928 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19933 #: ../fish/guestfish-actions.pod:41
19935 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19936 "It works by connecting to libvirt, requesting the domain and domain XML from "
19937 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19941 #: ../fish/guestfish-actions.pod:64
19943 "The other optional parameters are passed directly through to "
19944 "L</add-drive-opts>."
19948 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131 ../fish/guestfish-actions.pod:2846
19950 "This command has one or more optional arguments. See L</OPTIONAL "
19955 #: ../fish/guestfish-actions.pod:69
19960 #: ../fish/guestfish-actions.pod:71
19963 " add-drive filename\n"
19968 #: ../fish/guestfish-actions.pod:73
19970 "This function is the equivalent of calling L</add-drive-opts> with no "
19971 "optional parameters, so the disk is added writable, with the format being "
19972 "detected automatically."
19976 #: ../fish/guestfish-actions.pod:77
19978 "Automatic detection of the format opens you up to a potential security hole "
19979 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19980 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19981 "you should think about replacing calls to this function with calls to "
19982 "L</add-drive-opts>, and specifying the format."
19986 #: ../fish/guestfish-actions.pod:84
19987 msgid "add-drive-opts"
19991 #: ../fish/guestfish-actions.pod:86
19996 #: ../fish/guestfish-actions.pod:88
19999 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
20004 #: ../fish/guestfish-actions.pod:115
20006 "This forces the image format. If you omit this (or use L</add-drive> or "
20007 "L</add-drive-ro>) then the format is automatically detected. Possible "
20008 "formats include C<raw> and C<qcow2>."
20012 #: ../fish/guestfish-actions.pod:126
20014 "This rarely-used option lets you emulate the behaviour of the deprecated "
20015 "L</add-drive-with-if> call (q.v.)"
20019 #: ../fish/guestfish-actions.pod:133
20020 msgid "add-drive-ro"
20024 #: ../fish/guestfish-actions.pod:135
20029 #: ../fish/guestfish-actions.pod:137
20032 " add-drive-ro filename\n"
20037 #: ../fish/guestfish-actions.pod:139
20039 "This function is the equivalent of calling L</add-drive-opts> with the "
20040 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20041 "is added read-only, with the format being detected automatically."
20045 #: ../fish/guestfish-actions.pod:144
20046 msgid "add-drive-ro-with-if"
20050 #: ../fish/guestfish-actions.pod:146
20053 " add-drive-ro-with-if filename iface\n"
20058 #: ../fish/guestfish-actions.pod:148
20060 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
20061 "interface emulation to use at run time."
20065 #: ../fish/guestfish-actions.pod:158
20066 msgid "add-drive-with-if"
20070 #: ../fish/guestfish-actions.pod:160
20073 " add-drive-with-if filename iface\n"
20078 #: ../fish/guestfish-actions.pod:162
20080 "This is the same as L</add-drive> but it allows you to specify the QEMU "
20081 "interface emulation to use at run time."
20085 #: ../fish/guestfish-actions.pod:172
20090 #: ../fish/guestfish-actions.pod:174
20093 " aug-clear augpath\n"
20098 #: ../fish/guestfish-actions.pod:179
20103 #: ../fish/guestfish-actions.pod:181
20111 #: ../fish/guestfish-actions.pod:183
20113 "Close the current Augeas handle and free up any resources used by it. After "
20114 "calling this, you have to call L</aug-init> again before you can use any "
20115 "other Augeas functions."
20119 #: ../fish/guestfish-actions.pod:188
20120 msgid "aug-defnode"
20124 #: ../fish/guestfish-actions.pod:190
20127 " aug-defnode name expr val\n"
20132 #: ../fish/guestfish-actions.pod:195
20134 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
20135 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
20136 "containing that single node."
20140 #: ../fish/guestfish-actions.pod:203
20145 #: ../fish/guestfish-actions.pod:205
20148 " aug-defvar name expr\n"
20153 #: ../fish/guestfish-actions.pod:214
20158 #: ../fish/guestfish-actions.pod:216
20161 " aug-get augpath\n"
20166 #: ../fish/guestfish-actions.pod:221
20171 #: ../fish/guestfish-actions.pod:223
20174 " aug-init root flags\n"
20179 #: ../fish/guestfish-actions.pod:229
20180 msgid "You must call this before using any other L</aug-*> commands."
20184 #: ../fish/guestfish-actions.pod:264
20185 msgid "Do not load the tree in L</aug-init>."
20189 #: ../fish/guestfish-actions.pod:268
20190 msgid "To close the handle, you can call L</aug-close>."
20194 #: ../fish/guestfish-actions.pod:272
20199 #: ../fish/guestfish-actions.pod:274
20202 " aug-insert augpath label true|false\n"
20207 #: ../fish/guestfish-actions.pod:284
20212 #: ../fish/guestfish-actions.pod:286
20220 #: ../fish/guestfish-actions.pod:293
20225 #: ../fish/guestfish-actions.pod:295
20228 " aug-ls augpath\n"
20233 #: ../fish/guestfish-actions.pod:297
20235 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
20236 "resulting nodes into alphabetical order."
20240 #: ../fish/guestfish-actions.pod:300
20245 #: ../fish/guestfish-actions.pod:302
20248 " aug-match augpath\n"
20253 #: ../fish/guestfish-actions.pod:308
20258 #: ../fish/guestfish-actions.pod:310
20261 " aug-mv src dest\n"
20266 #: ../fish/guestfish-actions.pod:315
20271 #: ../fish/guestfish-actions.pod:317
20274 " aug-rm augpath\n"
20279 #: ../fish/guestfish-actions.pod:323
20284 #: ../fish/guestfish-actions.pod:325
20292 #: ../fish/guestfish-actions.pod:329
20294 "The flags which were passed to L</aug-init> affect exactly how files are "
20299 #: ../fish/guestfish-actions.pod:332
20304 #: ../fish/guestfish-actions.pod:334
20307 " aug-set augpath val\n"
20312 #: ../fish/guestfish-actions.pod:338
20314 "In the Augeas API, it is possible to clear a node by setting the value to "
20315 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
20316 "this call. Instead you must use the L</aug-clear> call."
20320 #: ../fish/guestfish-actions.pod:343
20325 #: ../fish/guestfish-actions.pod:345
20328 " available 'groups ...'\n"
20333 #: ../fish/guestfish-actions.pod:351
20335 "The libguestfs groups, and the functions that those groups correspond to, "
20336 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
20337 "runtime by calling L</available-all-groups>."
20341 #: ../fish/guestfish-actions.pod:375
20342 msgid "You must call L</launch> before calling this function."
20346 #: ../fish/guestfish-actions.pod:397
20348 "This call was added in version C<1.0.80>. In previous versions of "
20349 "libguestfs all you could do would be to speculatively execute a command to "
20350 "find out if the daemon implemented it. See also L</version>."
20354 #: ../fish/guestfish-actions.pod:404
20355 msgid "available-all-groups"
20359 #: ../fish/guestfish-actions.pod:406
20362 " available-all-groups\n"
20367 #: ../fish/guestfish-actions.pod:408
20369 "This command returns a list of all optional groups that this daemon knows "
20370 "about. Note this returns both supported and unsupported groups. To find "
20371 "out which ones the daemon can actually support you have to call "
20372 "L</available> on each member of the returned list."
20376 #: ../fish/guestfish-actions.pod:414
20377 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
20381 #: ../fish/guestfish-actions.pod:416
20386 #: ../fish/guestfish-actions.pod:418
20389 " base64-in (base64file|-) filename\n"
20394 #: ../fish/guestfish-actions.pod:423 ../fish/guestfish-actions.pod:432 ../fish/guestfish-actions.pod:656 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:844 ../fish/guestfish-actions.pod:1221 ../fish/guestfish-actions.pod:4201 ../fish/guestfish-actions.pod:4213 ../fish/guestfish-actions.pod:4224 ../fish/guestfish-actions.pod:4235 ../fish/guestfish-actions.pod:4287 ../fish/guestfish-actions.pod:4296 ../fish/guestfish-actions.pod:4350 ../fish/guestfish-actions.pod:4373
20395 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
20399 #: ../fish/guestfish-actions.pod:425
20404 #: ../fish/guestfish-actions.pod:427
20407 " base64-out filename (base64file|-)\n"
20412 #: ../fish/guestfish-actions.pod:434
20413 msgid "blockdev-flushbufs"
20417 #: ../fish/guestfish-actions.pod:436
20420 " blockdev-flushbufs device\n"
20425 #: ../fish/guestfish-actions.pod:443
20426 msgid "blockdev-getbsz"
20430 #: ../fish/guestfish-actions.pod:445
20433 " blockdev-getbsz device\n"
20438 #: ../fish/guestfish-actions.pod:454
20439 msgid "blockdev-getro"
20443 #: ../fish/guestfish-actions.pod:456
20446 " blockdev-getro device\n"
20451 #: ../fish/guestfish-actions.pod:463
20452 msgid "blockdev-getsize64"
20456 #: ../fish/guestfish-actions.pod:465
20459 " blockdev-getsize64 device\n"
20464 #: ../fish/guestfish-actions.pod:469
20465 msgid "See also L</blockdev-getsz>."
20469 #: ../fish/guestfish-actions.pod:473
20470 msgid "blockdev-getss"
20474 #: ../fish/guestfish-actions.pod:475
20477 " blockdev-getss device\n"
20482 #: ../fish/guestfish-actions.pod:480
20483 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
20487 #: ../fish/guestfish-actions.pod:485
20488 msgid "blockdev-getsz"
20492 #: ../fish/guestfish-actions.pod:487
20495 " blockdev-getsz device\n"
20500 #: ../fish/guestfish-actions.pod:492
20502 "See also L</blockdev-getss> for the real sector size of the device, and "
20503 "L</blockdev-getsize64> for the more useful I<size in bytes>."
20507 #: ../fish/guestfish-actions.pod:498
20508 msgid "blockdev-rereadpt"
20512 #: ../fish/guestfish-actions.pod:500
20515 " blockdev-rereadpt device\n"
20520 #: ../fish/guestfish-actions.pod:506
20521 msgid "blockdev-setbsz"
20525 #: ../fish/guestfish-actions.pod:508
20528 " blockdev-setbsz device blocksize\n"
20533 #: ../fish/guestfish-actions.pod:517
20534 msgid "blockdev-setro"
20538 #: ../fish/guestfish-actions.pod:519
20541 " blockdev-setro device\n"
20546 #: ../fish/guestfish-actions.pod:525
20547 msgid "blockdev-setrw"
20551 #: ../fish/guestfish-actions.pod:527
20554 " blockdev-setrw device\n"
20559 #: ../fish/guestfish-actions.pod:533
20560 msgid "case-sensitive-path"
20564 #: ../fish/guestfish-actions.pod:535
20567 " case-sensitive-path path\n"
20572 #: ../fish/guestfish-actions.pod:559
20574 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
20575 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
20576 "how the directories were originally created under Windows)."
20580 #: ../fish/guestfish-actions.pod:567
20581 msgid "See also L</realpath>."
20585 #: ../fish/guestfish-actions.pod:569
20590 #: ../fish/guestfish-actions.pod:571
20598 #: ../fish/guestfish-actions.pod:575
20600 "Note that this function cannot correctly handle binary files (specifically, "
20601 "files containing C<\\0> character which is treated as end of string). For "
20602 "those you need to use the L</read-file> or L</download> functions which have "
20603 "a more complex interface."
20607 #: ../fish/guestfish-actions.pod:583
20612 #: ../fish/guestfish-actions.pod:585
20615 " checksum csumtype path\n"
20620 #: ../fish/guestfish-actions.pod:628
20621 msgid "To get the checksum for a device, use L</checksum-device>."
20625 #: ../fish/guestfish-actions.pod:630
20626 msgid "To get the checksums for many files, use L</checksums-out>."
20630 #: ../fish/guestfish-actions.pod:632
20631 msgid "checksum-device"
20635 #: ../fish/guestfish-actions.pod:634
20638 " checksum-device csumtype device\n"
20643 #: ../fish/guestfish-actions.pod:636
20645 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20646 "device named C<device>. For the types of checksums supported see the "
20647 "L</checksum> command."
20651 #: ../fish/guestfish-actions.pod:640
20652 msgid "checksums-out"
20656 #: ../fish/guestfish-actions.pod:642
20659 " checksums-out csumtype directory (sumsfile|-)\n"
20664 #: ../fish/guestfish-actions.pod:658
20669 #: ../fish/guestfish-actions.pod:660
20672 " chmod mode path\n"
20677 #: ../fish/guestfish-actions.pod:671
20682 #: ../fish/guestfish-actions.pod:673
20685 " chown owner group path\n"
20690 #: ../fish/guestfish-actions.pod:681
20695 #: ../fish/guestfish-actions.pod:683
20698 " command 'arguments ...'\n"
20703 #: ../fish/guestfish-actions.pod:690
20705 "The single parameter is an argv-style list of arguments. The first element "
20706 "is the name of the program to run. Subsequent elements are parameters. The "
20707 "list must be non-empty (ie. must contain a program name). Note that the "
20708 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20712 #: ../fish/guestfish-actions.pod:718
20713 msgid "command-lines"
20717 #: ../fish/guestfish-actions.pod:720
20720 " command-lines 'arguments ...'\n"
20725 #: ../fish/guestfish-actions.pod:722
20726 msgid "This is the same as L</command>, but splits the result into a list of lines."
20730 #: ../fish/guestfish-actions.pod:725
20731 msgid "See also: L</sh-lines>"
20735 #: ../fish/guestfish-actions.pod:730
20740 #: ../fish/guestfish-actions.pod:732
20743 " config qemuparam qemuvalue\n"
20748 #: ../fish/guestfish-actions.pod:743
20753 #: ../fish/guestfish-actions.pod:745
20756 " copy-size src dest size\n"
20761 #: ../fish/guestfish-actions.pod:753
20766 #: ../fish/guestfish-actions.pod:755
20774 #: ../fish/guestfish-actions.pod:760
20779 #: ../fish/guestfish-actions.pod:762
20787 #: ../fish/guestfish-actions.pod:767
20792 #: ../fish/guestfish-actions.pod:769
20800 #: ../fish/guestfish-actions.pod:776
20802 "If the destination is a device, it must be as large or larger than the "
20803 "source file or device, otherwise the copy will fail. This command cannot do "
20804 "partial copies (see L</copy-size>)."
20808 #: ../fish/guestfish-actions.pod:780
20813 #: ../fish/guestfish-actions.pod:782
20821 #: ../fish/guestfish-actions.pod:786 ../fish/guestfish-actions.pod:797
20823 "This command is mostly useful for interactive sessions. It is I<not> "
20824 "intended that you try to parse the output string. Use L</statvfs> from "
20829 #: ../fish/guestfish-actions.pod:790
20834 #: ../fish/guestfish-actions.pod:792
20842 #: ../fish/guestfish-actions.pod:801
20847 #: ../fish/guestfish-actions.pod:803
20855 #: ../fish/guestfish-actions.pod:809
20857 "Another way to get the same information is to enable verbose messages with "
20858 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20859 "before running the program."
20863 #: ../fish/guestfish-actions.pod:814
20868 #: ../fish/guestfish-actions.pod:816
20871 " download remotefilename (filename|-)\n"
20876 #: ../fish/guestfish-actions.pod:823
20877 msgid "See also L</upload>, L</cat>."
20881 #: ../fish/guestfish-actions.pod:827
20882 msgid "download-offset"
20886 #: ../fish/guestfish-actions.pod:829
20889 " download-offset remotefilename (filename|-) offset size\n"
20894 #: ../fish/guestfish-actions.pod:837
20896 "Note that there is no limit on the amount of data that can be downloaded "
20897 "with this call, unlike with L</pread>, and this call always reads the full "
20898 "amount unless an error occurs."
20902 #: ../fish/guestfish-actions.pod:842
20903 msgid "See also L</download>, L</pread>."
20907 #: ../fish/guestfish-actions.pod:846
20908 msgid "drop-caches"
20912 #: ../fish/guestfish-actions.pod:848
20915 " drop-caches whattodrop\n"
20920 #: ../fish/guestfish-actions.pod:860
20925 #: ../fish/guestfish-actions.pod:862
20933 #: ../fish/guestfish-actions.pod:874
20938 #: ../fish/guestfish-actions.pod:876
20941 " e2fsck-f device\n"
20946 #: ../fish/guestfish-actions.pod:882
20948 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20949 "should use L</fsck>."
20953 #: ../fish/guestfish-actions.pod:885
20954 msgid "echo-daemon"
20958 #: ../fish/guestfish-actions.pod:887
20961 " echo-daemon 'words ...'\n"
20966 #: ../fish/guestfish-actions.pod:894
20967 msgid "See also L</ping-daemon>."
20971 #: ../fish/guestfish-actions.pod:896
20976 #: ../fish/guestfish-actions.pod:898
20979 " egrep regex path\n"
20984 #: ../fish/guestfish-actions.pod:906
20989 #: ../fish/guestfish-actions.pod:908
20992 " egrepi regex path\n"
20997 #: ../fish/guestfish-actions.pod:916
21002 #: ../fish/guestfish-actions.pod:918
21005 " equal file1 file2\n"
21010 #: ../fish/guestfish-actions.pod:925
21015 #: ../fish/guestfish-actions.pod:927
21023 #: ../fish/guestfish-actions.pod:932
21024 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21028 #: ../fish/guestfish-actions.pod:934
21033 #: ../fish/guestfish-actions.pod:936
21036 " fallocate path len\n"
21041 #: ../fish/guestfish-actions.pod:953
21042 msgid "fallocate64"
21046 #: ../fish/guestfish-actions.pod:955
21049 " fallocate64 path len\n"
21054 #: ../fish/guestfish-actions.pod:961
21056 "Note that this call allocates disk blocks for the file. To create a sparse "
21057 "file use L</truncate-size> instead."
21061 #: ../fish/guestfish-actions.pod:964
21063 "The deprecated call L</fallocate> does the same, but owing to an oversight "
21064 "it only allowed 30 bit lengths to be specified, effectively limiting the "
21065 "maximum size of files created through that call to 1GB."
21069 #: ../fish/guestfish-actions.pod:973
21074 #: ../fish/guestfish-actions.pod:975
21077 " fgrep pattern path\n"
21082 #: ../fish/guestfish-actions.pod:983
21087 #: ../fish/guestfish-actions.pod:985
21090 " fgrepi pattern path\n"
21095 #: ../fish/guestfish-actions.pod:993
21100 #: ../fish/guestfish-actions.pod:995
21108 #: ../fish/guestfish-actions.pod:1007
21110 "This command can also be used on C</dev/> devices (and partitions, LV "
21111 "names). You can for example use this to determine if a device contains a "
21112 "filesystem, although it's usually better to use L</vfs-type>."
21116 #: ../fish/guestfish-actions.pod:1017
21117 msgid "file-architecture"
21121 #: ../fish/guestfish-actions.pod:1019
21124 " file-architecture filename\n"
21129 #: ../fish/guestfish-actions.pod:1122
21134 #: ../fish/guestfish-actions.pod:1124
21142 #: ../fish/guestfish-actions.pod:1128
21144 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
21145 "L</is-file> etc. To get the size of block devices, use "
21146 "L</blockdev-getsize64>."
21150 #: ../fish/guestfish-actions.pod:1132
21155 #: ../fish/guestfish-actions.pod:1134
21158 " fill c len path\n"
21163 #: ../fish/guestfish-actions.pod:1140
21165 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
21166 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
21167 "L</fill-pattern>."
21171 #: ../fish/guestfish-actions.pod:1145
21172 msgid "fill-pattern"
21176 #: ../fish/guestfish-actions.pod:1147
21179 " fill-pattern pattern len path\n"
21184 #: ../fish/guestfish-actions.pod:1149
21186 "This function is like L</fill> except that it creates a new file of length "
21187 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
21188 "is truncated if necessary to ensure the length of the file is exactly C<len> "
21193 #: ../fish/guestfish-actions.pod:1154
21198 #: ../fish/guestfish-actions.pod:1156
21201 " find directory\n"
21206 #: ../fish/guestfish-actions.pod:1170
21207 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
21211 #: ../fish/guestfish-actions.pod:1183
21212 msgid "See also L</find0>."
21216 #: ../fish/guestfish-actions.pod:1188
21221 #: ../fish/guestfish-actions.pod:1190
21224 " find0 directory (files|-)\n"
21229 #: ../fish/guestfish-actions.pod:1196
21230 msgid "This command works the same way as L</find> with the following exceptions:"
21234 #: ../fish/guestfish-actions.pod:1223
21235 msgid "findfs-label"
21239 #: ../fish/guestfish-actions.pod:1225
21242 " findfs-label label\n"
21247 #: ../fish/guestfish-actions.pod:1231
21248 msgid "To find the label of a filesystem, use L</vfs-label>."
21252 #: ../fish/guestfish-actions.pod:1233
21253 msgid "findfs-uuid"
21257 #: ../fish/guestfish-actions.pod:1235
21260 " findfs-uuid uuid\n"
21265 #: ../fish/guestfish-actions.pod:1241
21266 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
21270 #: ../fish/guestfish-actions.pod:1243
21275 #: ../fish/guestfish-actions.pod:1245
21278 " fsck fstype device\n"
21283 #: ../fish/guestfish-actions.pod:1275
21288 #: ../fish/guestfish-actions.pod:1277
21296 #: ../fish/guestfish-actions.pod:1284
21297 msgid "get-autosync"
21301 #: ../fish/guestfish-actions.pod:1286
21309 #: ../fish/guestfish-actions.pod:1290
21314 #: ../fish/guestfish-actions.pod:1292
21322 #: ../fish/guestfish-actions.pod:1296
21323 msgid "get-e2label"
21327 #: ../fish/guestfish-actions.pod:1298
21330 " get-e2label device\n"
21335 #: ../fish/guestfish-actions.pod:1310
21340 #: ../fish/guestfish-actions.pod:1312
21343 " get-e2uuid device\n"
21348 #: ../fish/guestfish-actions.pod:1324
21349 msgid "get-memsize"
21353 #: ../fish/guestfish-actions.pod:1326
21361 #: ../fish/guestfish-actions.pod:1331
21363 "If L</set-memsize> was not called on this handle, and if "
21364 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
21365 "value for memsize."
21369 #: ../fish/guestfish-actions.pod:1338
21370 msgid "get-network"
21374 #: ../fish/guestfish-actions.pod:1340
21382 #: ../fish/guestfish-actions.pod:1344
21387 #: ../fish/guestfish-actions.pod:1346
21395 #: ../fish/guestfish-actions.pod:1353
21400 #: ../fish/guestfish-actions.pod:1355
21405 #: ../fish/guestfish-actions.pod:1357
21413 #: ../fish/guestfish-actions.pod:1364
21418 #: ../fish/guestfish-actions.pod:1366
21426 #: ../fish/guestfish-actions.pod:1373
21427 msgid "get-recovery-proc"
21431 #: ../fish/guestfish-actions.pod:1375
21434 " get-recovery-proc\n"
21439 #: ../fish/guestfish-actions.pod:1379
21440 msgid "get-selinux"
21444 #: ../fish/guestfish-actions.pod:1381
21452 #: ../fish/guestfish-actions.pod:1383
21454 "This returns the current setting of the selinux flag which is passed to the "
21455 "appliance at boot time. See L</set-selinux>."
21459 #: ../fish/guestfish-actions.pod:1389
21464 #: ../fish/guestfish-actions.pod:1391
21472 #: ../fish/guestfish-actions.pod:1398
21477 #: ../fish/guestfish-actions.pod:1400
21485 #: ../fish/guestfish-actions.pod:1404
21490 #: ../fish/guestfish-actions.pod:1406
21498 #: ../fish/guestfish-actions.pod:1408
21500 "Return the current umask. By default the umask is C<022> unless it has been "
21501 "set by calling L</umask>."
21505 #: ../fish/guestfish-actions.pod:1411
21506 msgid "get-verbose"
21510 #: ../fish/guestfish-actions.pod:1413
21518 #: ../fish/guestfish-actions.pod:1417
21523 #: ../fish/guestfish-actions.pod:1419
21531 #: ../fish/guestfish-actions.pod:1423
21532 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
21536 #: ../fish/guestfish-actions.pod:1426
21541 #: ../fish/guestfish-actions.pod:1428
21544 " getxattr path name\n"
21549 #: ../fish/guestfish-actions.pod:1430
21551 "Get a single extended attribute from file C<path> named C<name>. This call "
21552 "follows symlinks. If you want to lookup an extended attribute for the "
21553 "symlink itself, use L</lgetxattr>."
21557 #: ../fish/guestfish-actions.pod:1434 ../fish/guestfish-actions.pod:2265
21559 "Normally it is better to get all extended attributes from a file in one go "
21560 "by calling L</getxattrs>. However some Linux filesystem implementations are "
21561 "buggy and do not provide a way to list out attributes. For these "
21562 "filesystems (notably ntfs-3g) you have to know the names of the extended "
21563 "attributes you want in advance and call this function."
21567 #: ../fish/guestfish-actions.pod:1444
21568 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
21572 #: ../fish/guestfish-actions.pod:1446
21577 #: ../fish/guestfish-actions.pod:1448
21580 " getxattrs path\n"
21585 #: ../fish/guestfish-actions.pod:1456
21586 msgid "See also: L</lgetxattrs>, L<attr(5)>."
21590 #: ../fish/guestfish-actions.pod:1458
21591 msgid "glob-expand"
21595 #: ../fish/guestfish-actions.pod:1460
21598 " glob-expand pattern\n"
21603 #: ../fish/guestfish-actions.pod:1473
21608 #: ../fish/guestfish-actions.pod:1475
21611 " grep regex path\n"
21616 #: ../fish/guestfish-actions.pod:1483
21621 #: ../fish/guestfish-actions.pod:1485
21624 " grepi regex path\n"
21629 #: ../fish/guestfish-actions.pod:1493
21630 msgid "grub-install"
21634 #: ../fish/guestfish-actions.pod:1495
21637 " grub-install root device\n"
21642 #: ../fish/guestfish-actions.pod:1511
21647 #: ../fish/guestfish-actions.pod:1513
21655 #: ../fish/guestfish-actions.pod:1521
21660 #: ../fish/guestfish-actions.pod:1523
21663 " head-n nrlines path\n"
21668 #: ../fish/guestfish-actions.pod:1536
21673 #: ../fish/guestfish-actions.pod:1538
21681 #: ../fish/guestfish-actions.pod:1546
21686 #: ../fish/guestfish-actions.pod:1548
21689 " initrd-cat initrdpath filename\n"
21694 #: ../fish/guestfish-actions.pod:1560
21695 msgid "See also L</initrd-list>."
21699 #: ../fish/guestfish-actions.pod:1565
21700 msgid "initrd-list"
21704 #: ../fish/guestfish-actions.pod:1567
21707 " initrd-list path\n"
21712 #: ../fish/guestfish-actions.pod:1579
21713 msgid "inotify-add-watch"
21717 #: ../fish/guestfish-actions.pod:1581
21720 " inotify-add-watch path mask\n"
21725 #: ../fish/guestfish-actions.pod:1593
21726 msgid "inotify-close"
21730 #: ../fish/guestfish-actions.pod:1595
21738 #: ../fish/guestfish-actions.pod:1601
21739 msgid "inotify-files"
21743 #: ../fish/guestfish-actions.pod:1603
21751 #: ../fish/guestfish-actions.pod:1605
21753 "This function is a helpful wrapper around L</inotify-read> which just "
21754 "returns a list of pathnames of objects that were touched. The returned "
21755 "pathnames are sorted and deduplicated."
21759 #: ../fish/guestfish-actions.pod:1609
21760 msgid "inotify-init"
21764 #: ../fish/guestfish-actions.pod:1611
21767 " inotify-init maxevents\n"
21772 #: ../fish/guestfish-actions.pod:1617
21774 "C<maxevents> is the maximum number of events which will be queued up between "
21775 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21776 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21777 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21778 "but records the fact that it threw them away by setting a flag "
21779 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21783 #: ../fish/guestfish-actions.pod:1627
21785 "Before any events are generated, you have to add some watches to the "
21786 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21787 "L</inotify-watch-all>."
21791 #: ../fish/guestfish-actions.pod:1633
21793 "Queued up events should be read periodically by calling L</inotify-read> (or "
21794 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21795 "If you don't read the events out often enough then you risk the internal "
21796 "queue overflowing."
21800 #: ../fish/guestfish-actions.pod:1640
21802 "The handle should be closed after use by calling L</inotify-close>. This "
21803 "also removes any watches automatically."
21807 #: ../fish/guestfish-actions.pod:1649
21808 msgid "inotify-read"
21812 #: ../fish/guestfish-actions.pod:1651
21820 #: ../fish/guestfish-actions.pod:1664
21821 msgid "inotify-rm-watch"
21825 #: ../fish/guestfish-actions.pod:1666
21828 " inotify-rm-watch wd\n"
21833 #: ../fish/guestfish-actions.pod:1668
21834 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21838 #: ../fish/guestfish-actions.pod:1671
21839 msgid "inspect-get-arch"
21843 #: ../fish/guestfish-actions.pod:1673
21846 " inspect-get-arch root\n"
21851 #: ../fish/guestfish-actions.pod:1675 ../fish/guestfish-actions.pod:1691 ../fish/guestfish-actions.pod:1765 ../fish/guestfish-actions.pod:1783 ../fish/guestfish-actions.pod:1798 ../fish/guestfish-actions.pod:1819 ../fish/guestfish-actions.pod:1834 ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1883 ../fish/guestfish-actions.pod:1907 ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:1972 ../fish/guestfish-actions.pod:1988
21853 "This function should only be called with a root device string as returned by "
21858 #: ../fish/guestfish-actions.pod:1678
21860 "This returns the architecture of the inspected operating system. The "
21861 "possible return values are listed under L</file-architecture>."
21865 #: ../fish/guestfish-actions.pod:1687
21866 msgid "inspect-get-distro"
21870 #: ../fish/guestfish-actions.pod:1689
21873 " inspect-get-distro root\n"
21878 #: ../fish/guestfish-actions.pod:1761
21879 msgid "inspect-get-filesystems"
21883 #: ../fish/guestfish-actions.pod:1763
21886 " inspect-get-filesystems root\n"
21891 #: ../fish/guestfish-actions.pod:1776
21893 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21894 "L</inspect-get-mountpoints>."
21898 #: ../fish/guestfish-actions.pod:1779
21899 msgid "inspect-get-hostname"
21903 #: ../fish/guestfish-actions.pod:1781
21906 " inspect-get-hostname root\n"
21911 #: ../fish/guestfish-actions.pod:1794
21912 msgid "inspect-get-major-version"
21916 #: ../fish/guestfish-actions.pod:1796
21919 " inspect-get-major-version root\n"
21924 #: ../fish/guestfish-actions.pod:1815
21925 msgid "inspect-get-minor-version"
21929 #: ../fish/guestfish-actions.pod:1817
21932 " inspect-get-minor-version root\n"
21937 #: ../fish/guestfish-actions.pod:1827
21939 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21940 "L</inspect-get-major-version>."
21944 #: ../fish/guestfish-actions.pod:1830
21945 msgid "inspect-get-mountpoints"
21949 #: ../fish/guestfish-actions.pod:1832
21952 " inspect-get-mountpoints root\n"
21957 #: ../fish/guestfish-actions.pod:1854
21959 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21960 "L</inspect-get-filesystems>."
21964 #: ../fish/guestfish-actions.pod:1857
21965 msgid "inspect-get-package-format"
21969 #: ../fish/guestfish-actions.pod:1859
21972 " inspect-get-package-format root\n"
21977 #: ../fish/guestfish-actions.pod:1864
21979 "This function and L</inspect-get-package-management> return the package "
21980 "format and package management tool used by the inspected operating system. "
21981 "For example for Fedora these functions would return C<rpm> (package format) "
21982 "and C<yum> (package management)."
21986 #: ../fish/guestfish-actions.pod:1879
21987 msgid "inspect-get-package-management"
21991 #: ../fish/guestfish-actions.pod:1881
21994 " inspect-get-package-management root\n"
21999 #: ../fish/guestfish-actions.pod:1886
22001 "L</inspect-get-package-format> and this function return the package format "
22002 "and package management tool used by the inspected operating system. For "
22003 "example for Fedora these functions would return C<rpm> (package format) and "
22004 "C<yum> (package management)."
22008 #: ../fish/guestfish-actions.pod:1903
22009 msgid "inspect-get-product-name"
22013 #: ../fish/guestfish-actions.pod:1905
22016 " inspect-get-product-name root\n"
22021 #: ../fish/guestfish-actions.pod:1920
22022 msgid "inspect-get-roots"
22026 #: ../fish/guestfish-actions.pod:1922
22029 " inspect-get-roots\n"
22034 #: ../fish/guestfish-actions.pod:1924
22036 "This function is a convenient way to get the list of root devices, as "
22037 "returned from a previous call to L</inspect-os>, but without redoing the "
22038 "whole inspection process."
22042 #: ../fish/guestfish-actions.pod:1928
22044 "This returns an empty list if either no root devices were found or the "
22045 "caller has not called L</inspect-os>."
22049 #: ../fish/guestfish-actions.pod:1933
22050 msgid "inspect-get-type"
22054 #: ../fish/guestfish-actions.pod:1935
22057 " inspect-get-type root\n"
22062 #: ../fish/guestfish-actions.pod:1968
22063 msgid "inspect-get-windows-systemroot"
22067 #: ../fish/guestfish-actions.pod:1970
22070 " inspect-get-windows-systemroot root\n"
22075 #: ../fish/guestfish-actions.pod:1984
22076 msgid "inspect-list-applications"
22080 #: ../fish/guestfish-actions.pod:1986
22083 " inspect-list-applications root\n"
22088 #: ../fish/guestfish-actions.pod:1993
22090 "I<Note:> This call works differently from other parts of the inspection "
22091 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
22092 "then mount up the disks, before calling this. Listing applications is a "
22093 "significantly more difficult operation which requires access to the full "
22094 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
22095 "are just returning data cached in the libguestfs handle, this call actually "
22096 "reads parts of the mounted filesystems during the call."
22100 #: ../fish/guestfish-actions.pod:2083
22105 #: ../fish/guestfish-actions.pod:2085
22113 #: ../fish/guestfish-actions.pod:2100
22115 "You can pass the root string(s) returned to other L</inspect-get-*> "
22116 "functions in order to query further information about each operating system, "
22117 "such as the name and version."
22121 #: ../fish/guestfish-actions.pod:2105
22123 "This function uses other libguestfs features such as L</mount-ro> and "
22124 "L</umount-all> in order to mount and unmount filesystems and look at the "
22125 "contents. This should be called with no disks currently mounted. The "
22126 "function may also use Augeas, so any existing Augeas handle will be closed."
22130 #: ../fish/guestfish-actions.pod:2117 ../fish/guestfish-actions.pod:2293 ../fish/guestfish-actions.pod:2339
22131 msgid "See also L</list-filesystems>."
22135 #: ../fish/guestfish-actions.pod:2119
22136 msgid "is-blockdev"
22140 #: ../fish/guestfish-actions.pod:2121
22143 " is-blockdev path\n"
22148 #: ../fish/guestfish-actions.pod:2126 ../fish/guestfish-actions.pod:2144 ../fish/guestfish-actions.pod:2163 ../fish/guestfish-actions.pod:2172 ../fish/guestfish-actions.pod:2182 ../fish/guestfish-actions.pod:2216 ../fish/guestfish-actions.pod:2225
22149 msgid "See also L</stat>."
22153 #: ../fish/guestfish-actions.pod:2128
22158 #: ../fish/guestfish-actions.pod:2130
22166 #: ../fish/guestfish-actions.pod:2137
22171 #: ../fish/guestfish-actions.pod:2139
22174 " is-chardev path\n"
22179 #: ../fish/guestfish-actions.pod:2146
22184 #: ../fish/guestfish-actions.pod:2148
22192 #: ../fish/guestfish-actions.pod:2155
22197 #: ../fish/guestfish-actions.pod:2157
22205 #: ../fish/guestfish-actions.pod:2165
22210 #: ../fish/guestfish-actions.pod:2167
22218 #: ../fish/guestfish-actions.pod:2174
22223 #: ../fish/guestfish-actions.pod:2176
22231 #: ../fish/guestfish-actions.pod:2184
22232 msgid "is-launching"
22236 #: ../fish/guestfish-actions.pod:2186
22244 #: ../fish/guestfish-actions.pod:2193
22249 #: ../fish/guestfish-actions.pod:2195
22257 #: ../fish/guestfish-actions.pod:2200
22262 #: ../fish/guestfish-actions.pod:2202
22270 #: ../fish/guestfish-actions.pod:2209
22275 #: ../fish/guestfish-actions.pod:2211
22278 " is-socket path\n"
22283 #: ../fish/guestfish-actions.pod:2218
22288 #: ../fish/guestfish-actions.pod:2220
22291 " is-symlink path\n"
22296 #: ../fish/guestfish-actions.pod:2227
22297 msgid "kill-subprocess"
22301 #: ../fish/guestfish-actions.pod:2229
22304 " kill-subprocess\n"
22309 #: ../fish/guestfish-actions.pod:2233
22314 #: ../fish/guestfish-actions.pod:2235
22319 #: ../fish/guestfish-actions.pod:2237
22327 #: ../fish/guestfish-actions.pod:2245
22332 #: ../fish/guestfish-actions.pod:2247
22335 " lchown owner group path\n"
22340 #: ../fish/guestfish-actions.pod:2249
22342 "Change the file owner to C<owner> and group to C<group>. This is like "
22343 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
22348 #: ../fish/guestfish-actions.pod:2257
22353 #: ../fish/guestfish-actions.pod:2259
22356 " lgetxattr path name\n"
22361 #: ../fish/guestfish-actions.pod:2275
22362 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
22366 #: ../fish/guestfish-actions.pod:2277
22371 #: ../fish/guestfish-actions.pod:2279
22374 " lgetxattrs path\n"
22379 #: ../fish/guestfish-actions.pod:2281
22381 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
22382 "it returns the extended attributes of the link itself."
22386 #: ../fish/guestfish-actions.pod:2285
22387 msgid "list-devices"
22391 #: ../fish/guestfish-actions.pod:2287
22399 #: ../fish/guestfish-actions.pod:2295
22400 msgid "list-filesystems"
22404 #: ../fish/guestfish-actions.pod:2297
22407 " list-filesystems\n"
22412 #: ../fish/guestfish-actions.pod:2316
22414 "This command runs other libguestfs commands, which might include L</mount> "
22415 "and L</umount>, and therefore you should use this soon after launch and only "
22416 "when nothing is mounted."
22420 #: ../fish/guestfish-actions.pod:2320
22422 "Not all of the filesystems returned will be mountable. In particular, swap "
22423 "partitions are returned in the list. Also this command does not check that "
22424 "each filesystem found is valid and mountable, and some filesystems might be "
22425 "mountable but require special options. Filesystems may not all belong to a "
22426 "single logical operating system (use L</inspect-os> to look for OSes)."
22430 #: ../fish/guestfish-actions.pod:2328
22431 msgid "list-partitions"
22435 #: ../fish/guestfish-actions.pod:2330
22438 " list-partitions\n"
22443 #: ../fish/guestfish-actions.pod:2336
22445 "This does not return logical volumes. For that you will need to call "
22450 #: ../fish/guestfish-actions.pod:2341
22455 #: ../fish/guestfish-actions.pod:2343
22463 #: ../fish/guestfish-actions.pod:2351
22468 #: ../fish/guestfish-actions.pod:2353
22471 " ln target linkname\n"
22476 #: ../fish/guestfish-actions.pod:2357
22481 #: ../fish/guestfish-actions.pod:2359
22484 " ln-f target linkname\n"
22489 #: ../fish/guestfish-actions.pod:2364
22494 #: ../fish/guestfish-actions.pod:2366
22497 " ln-s target linkname\n"
22502 #: ../fish/guestfish-actions.pod:2370
22507 #: ../fish/guestfish-actions.pod:2372
22510 " ln-sf target linkname\n"
22515 #: ../fish/guestfish-actions.pod:2377
22516 msgid "lremovexattr"
22520 #: ../fish/guestfish-actions.pod:2379
22523 " lremovexattr xattr path\n"
22528 #: ../fish/guestfish-actions.pod:2381
22530 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
22531 "it removes an extended attribute of the link itself."
22535 #: ../fish/guestfish-actions.pod:2385
22540 #: ../fish/guestfish-actions.pod:2387
22548 #: ../fish/guestfish-actions.pod:2393
22550 "This command is mostly useful for interactive sessions. Programs should "
22551 "probably use L</readdir> instead."
22555 #: ../fish/guestfish-actions.pod:2396
22560 #: ../fish/guestfish-actions.pod:2398
22563 " lsetxattr xattr val vallen path\n"
22568 #: ../fish/guestfish-actions.pod:2400
22570 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
22571 "sets an extended attribute of the link itself."
22575 #: ../fish/guestfish-actions.pod:2404
22580 #: ../fish/guestfish-actions.pod:2406
22588 #: ../fish/guestfish-actions.pod:2410
22590 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
22591 "the link is stat-ed, not the file it refers to."
22595 #: ../fish/guestfish-actions.pod:2416
22600 #: ../fish/guestfish-actions.pod:2418
22603 " lstatlist path 'names ...'\n"
22608 #: ../fish/guestfish-actions.pod:2420
22610 "This call allows you to perform the L</lstat> operation on multiple files, "
22611 "where all files are in the directory C<path>. C<names> is the list of files "
22612 "from this directory."
22616 #: ../fish/guestfish-actions.pod:2429
22618 "This call is intended for programs that want to efficiently list a directory "
22619 "contents without making many round-trips. See also L</lxattrlist> for a "
22620 "similarly efficient call for getting extended attributes. Very long "
22621 "directory listings might cause the protocol message size to be exceeded, "
22622 "causing this call to fail. The caller must split up such requests into "
22623 "smaller groups of names."
22627 #: ../fish/guestfish-actions.pod:2437
22628 msgid "luks-add-key"
22632 #: ../fish/guestfish-actions.pod:2439
22635 " luks-add-key device keyslot\n"
22640 #: ../fish/guestfish-actions.pod:2446
22642 "Note that if C<keyslot> already contains a key, then this command will "
22643 "fail. You have to use L</luks-kill-slot> first to remove that key."
22647 #: ../fish/guestfish-actions.pod:2450 ../fish/guestfish-actions.pod:2472 ../fish/guestfish-actions.pod:2485 ../fish/guestfish-actions.pod:2499 ../fish/guestfish-actions.pod:2522 ../fish/guestfish-actions.pod:2532
22649 "This command has one or more key or passphrase parameters. Guestfish will "
22650 "prompt for these separately."
22654 #: ../fish/guestfish-actions.pod:2453
22659 #: ../fish/guestfish-actions.pod:2455
22662 " luks-close device\n"
22667 #: ../fish/guestfish-actions.pod:2457
22669 "This closes a LUKS device that was created earlier by L</luks-open> or "
22670 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
22671 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
22672 "underlying block device."
22676 #: ../fish/guestfish-actions.pod:2463
22677 msgid "luks-format"
22681 #: ../fish/guestfish-actions.pod:2465
22684 " luks-format device keyslot\n"
22689 #: ../fish/guestfish-actions.pod:2478
22690 msgid "luks-format-cipher"
22694 #: ../fish/guestfish-actions.pod:2480
22697 " luks-format-cipher device keyslot cipher\n"
22702 #: ../fish/guestfish-actions.pod:2482
22704 "This command is the same as L</luks-format> but it also allows you to set "
22705 "the C<cipher> used."
22709 #: ../fish/guestfish-actions.pod:2491
22710 msgid "luks-kill-slot"
22714 #: ../fish/guestfish-actions.pod:2493
22717 " luks-kill-slot device keyslot\n"
22722 #: ../fish/guestfish-actions.pod:2502
22727 #: ../fish/guestfish-actions.pod:2504
22730 " luks-open device mapname\n"
22735 #: ../fish/guestfish-actions.pod:2518
22737 "If this block device contains LVM volume groups, then calling L</vgscan> "
22738 "followed by L</vg-activate-all> will make them visible."
22742 #: ../fish/guestfish-actions.pod:2525
22743 msgid "luks-open-ro"
22747 #: ../fish/guestfish-actions.pod:2527
22750 " luks-open-ro device mapname\n"
22755 #: ../fish/guestfish-actions.pod:2529
22757 "This is the same as L</luks-open> except that a read-only mapping is "
22762 #: ../fish/guestfish-actions.pod:2535
22767 #: ../fish/guestfish-actions.pod:2537
22770 " lvcreate logvol volgroup mbytes\n"
22775 #: ../fish/guestfish-actions.pod:2542
22776 msgid "lvm-canonical-lv-name"
22780 #: ../fish/guestfish-actions.pod:2544
22783 " lvm-canonical-lv-name lvname\n"
22788 #: ../fish/guestfish-actions.pod:2553
22789 msgid "See also L</is-lv>."
22793 #: ../fish/guestfish-actions.pod:2555
22794 msgid "lvm-clear-filter"
22798 #: ../fish/guestfish-actions.pod:2557
22801 " lvm-clear-filter\n"
22806 #: ../fish/guestfish-actions.pod:2559
22808 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22813 #: ../fish/guestfish-actions.pod:2565
22814 msgid "lvm-remove-all"
22818 #: ../fish/guestfish-actions.pod:2567
22821 " lvm-remove-all\n"
22826 #: ../fish/guestfish-actions.pod:2575
22827 msgid "lvm-set-filter"
22831 #: ../fish/guestfish-actions.pod:2577
22834 " lvm-set-filter 'devices ...'\n"
22839 #: ../fish/guestfish-actions.pod:2602
22844 #: ../fish/guestfish-actions.pod:2604
22847 " lvremove device\n"
22852 #: ../fish/guestfish-actions.pod:2612
22857 #: ../fish/guestfish-actions.pod:2614
22860 " lvrename logvol newlogvol\n"
22865 #: ../fish/guestfish-actions.pod:2618
22870 #: ../fish/guestfish-actions.pod:2620
22873 " lvresize device mbytes\n"
22878 #: ../fish/guestfish-actions.pod:2626
22879 msgid "lvresize-free"
22883 #: ../fish/guestfish-actions.pod:2628
22886 " lvresize-free lv percent\n"
22891 #: ../fish/guestfish-actions.pod:2636
22896 #: ../fish/guestfish-actions.pod:2638
22904 #: ../fish/guestfish-actions.pod:2646
22905 msgid "See also L</lvs-full>, L</list-filesystems>."
22909 #: ../fish/guestfish-actions.pod:2648
22914 #: ../fish/guestfish-actions.pod:2650
22922 #: ../fish/guestfish-actions.pod:2655
22927 #: ../fish/guestfish-actions.pod:2657
22935 #: ../fish/guestfish-actions.pod:2661
22940 #: ../fish/guestfish-actions.pod:2663
22943 " lxattrlist path 'names ...'\n"
22948 #: ../fish/guestfish-actions.pod:2679
22950 "This call is intended for programs that want to efficiently list a directory "
22951 "contents without making many round-trips. See also L</lstatlist> for a "
22952 "similarly efficient call for getting standard stats. Very long directory "
22953 "listings might cause the protocol message size to be exceeded, causing this "
22954 "call to fail. The caller must split up such requests into smaller groups of "
22959 #: ../fish/guestfish-actions.pod:2687
22964 #: ../fish/guestfish-actions.pod:2689
22972 #: ../fish/guestfish-actions.pod:2693
22977 #: ../fish/guestfish-actions.pod:2695
22980 " mkdir-mode path mode\n"
22985 #: ../fish/guestfish-actions.pod:2704
22986 msgid "See also L</mkdir>, L</umask>"
22990 #: ../fish/guestfish-actions.pod:2706
22995 #: ../fish/guestfish-actions.pod:2708
23003 #: ../fish/guestfish-actions.pod:2713
23008 #: ../fish/guestfish-actions.pod:2715
23011 " mkdtemp template\n"
23016 #: ../fish/guestfish-actions.pod:2736
23021 #: ../fish/guestfish-actions.pod:2738
23024 " mke2fs-J fstype blocksize device journal\n"
23029 #: ../fish/guestfish-actions.pod:2746
23030 msgid "See also L</mke2journal>."
23034 #: ../fish/guestfish-actions.pod:2748
23039 #: ../fish/guestfish-actions.pod:2750
23042 " mke2fs-JL fstype blocksize device label\n"
23047 #: ../fish/guestfish-actions.pod:2755
23048 msgid "See also L</mke2journal-L>."
23052 #: ../fish/guestfish-actions.pod:2757
23057 #: ../fish/guestfish-actions.pod:2759
23060 " mke2fs-JU fstype blocksize device uuid\n"
23065 #: ../fish/guestfish-actions.pod:2764
23066 msgid "See also L</mke2journal-U>."
23070 #: ../fish/guestfish-actions.pod:2766
23071 msgid "mke2journal"
23075 #: ../fish/guestfish-actions.pod:2768
23078 " mke2journal blocksize device\n"
23083 #: ../fish/guestfish-actions.pod:2775
23084 msgid "mke2journal-L"
23088 #: ../fish/guestfish-actions.pod:2777
23091 " mke2journal-L blocksize label device\n"
23096 #: ../fish/guestfish-actions.pod:2781
23097 msgid "mke2journal-U"
23101 #: ../fish/guestfish-actions.pod:2783
23104 " mke2journal-U blocksize uuid device\n"
23109 #: ../fish/guestfish-actions.pod:2787
23114 #: ../fish/guestfish-actions.pod:2789
23117 " mkfifo mode path\n"
23122 #: ../fish/guestfish-actions.pod:2791
23124 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
23125 "is just a convenient wrapper around L</mknod>."
23129 #: ../fish/guestfish-actions.pod:2797
23134 #: ../fish/guestfish-actions.pod:2799
23137 " mkfs fstype device\n"
23142 #: ../fish/guestfish-actions.pod:2805
23147 #: ../fish/guestfish-actions.pod:2807
23150 " mkfs-b fstype blocksize device\n"
23155 #: ../fish/guestfish-actions.pod:2809
23157 "This call is similar to L</mkfs>, but it allows you to control the block "
23158 "size of the resulting filesystem. Supported block sizes depend on the "
23159 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
23163 #: ../fish/guestfish-actions.pod:2824
23168 #: ../fish/guestfish-actions.pod:2826
23171 " mkfs-opts fstype device [blocksize:..]\n"
23176 #: ../fish/guestfish-actions.pod:2848
23177 msgid "mkmountpoint"
23181 #: ../fish/guestfish-actions.pod:2850
23184 " mkmountpoint exemptpath\n"
23189 #: ../fish/guestfish-actions.pod:2852
23191 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
23192 "to create extra mountpoints before mounting the first filesystem."
23196 #: ../fish/guestfish-actions.pod:2876
23198 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
23199 "unexpected errors if you try to mix these calls. It is safest to manually "
23200 "unmount filesystems and remove mountpoints after use."
23204 #: ../fish/guestfish-actions.pod:2880
23206 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
23207 "for this to work for manual mountpoints, you must ensure that the innermost "
23208 "mountpoints have the longest pathnames, as in the example code above."
23212 #: ../fish/guestfish-actions.pod:2887
23214 "Autosync [see L</set-autosync>, this is set by default on handles] means "
23215 "that L</umount-all> is called when the handle is closed which can also "
23216 "trigger these issues."
23220 #: ../fish/guestfish-actions.pod:2891
23225 #: ../fish/guestfish-actions.pod:2893
23228 " mknod mode devmajor devminor path\n"
23233 #: ../fish/guestfish-actions.pod:2903
23235 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
23236 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
23237 "regular file). These constants are available in the standard Linux header "
23238 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
23239 "wrappers around this command which bitwise OR in the appropriate constant "
23244 #: ../fish/guestfish-actions.pod:2913
23249 #: ../fish/guestfish-actions.pod:2915
23252 " mknod-b mode devmajor devminor path\n"
23257 #: ../fish/guestfish-actions.pod:2917
23259 "This call creates a block device node called C<path> with mode C<mode> and "
23260 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23261 "wrapper around L</mknod>."
23265 #: ../fish/guestfish-actions.pod:2923
23270 #: ../fish/guestfish-actions.pod:2925
23273 " mknod-c mode devmajor devminor path\n"
23278 #: ../fish/guestfish-actions.pod:2927
23280 "This call creates a char device node called C<path> with mode C<mode> and "
23281 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23282 "wrapper around L</mknod>."
23286 #: ../fish/guestfish-actions.pod:2933
23291 #: ../fish/guestfish-actions.pod:2935
23299 #: ../fish/guestfish-actions.pod:2939
23304 #: ../fish/guestfish-actions.pod:2941
23307 " mkswap-L label device\n"
23312 #: ../fish/guestfish-actions.pod:2949
23317 #: ../fish/guestfish-actions.pod:2951
23320 " mkswap-U uuid device\n"
23325 #: ../fish/guestfish-actions.pod:2955
23326 msgid "mkswap-file"
23330 #: ../fish/guestfish-actions.pod:2957
23333 " mkswap-file path\n"
23338 #: ../fish/guestfish-actions.pod:2961
23340 "This command just writes a swap file signature to an existing file. To "
23341 "create the file itself, use something like L</fallocate>."
23345 #: ../fish/guestfish-actions.pod:2964
23350 #: ../fish/guestfish-actions.pod:2966
23353 " modprobe modulename\n"
23358 #: ../fish/guestfish-actions.pod:2973
23363 #: ../fish/guestfish-actions.pod:2975
23366 " mount device mountpoint\n"
23371 #: ../fish/guestfish-actions.pod:2991
23373 "B<Important note:> When you use this call, the filesystem options C<sync> "
23374 "and C<noatime> are set implicitly. This was originally done because we "
23375 "thought it would improve reliability, but it turns out that I<-o sync> has a "
23376 "very large negative performance impact and negligible effect on "
23377 "reliability. Therefore we recommend that you avoid using L</mount> in any "
23378 "code that needs performance, and instead use L</mount-options> (use an empty "
23379 "string for the first parameter if you don't want any options)."
23383 #: ../fish/guestfish-actions.pod:3001
23388 #: ../fish/guestfish-actions.pod:3003
23391 " mount-loop file mountpoint\n"
23396 #: ../fish/guestfish-actions.pod:3009
23397 msgid "mount-options"
23401 #: ../fish/guestfish-actions.pod:3011
23404 " mount-options options device mountpoint\n"
23409 #: ../fish/guestfish-actions.pod:3013
23411 "This is the same as the L</mount> command, but it allows you to set the "
23412 "mount options as for the L<mount(8)> I<-o> flag."
23416 #: ../fish/guestfish-actions.pod:3021
23421 #: ../fish/guestfish-actions.pod:3023
23424 " mount-ro device mountpoint\n"
23429 #: ../fish/guestfish-actions.pod:3025
23431 "This is the same as the L</mount> command, but it mounts the filesystem with "
23432 "the read-only (I<-o ro>) flag."
23436 #: ../fish/guestfish-actions.pod:3028
23441 #: ../fish/guestfish-actions.pod:3030
23444 " mount-vfs options vfstype device mountpoint\n"
23449 #: ../fish/guestfish-actions.pod:3032
23451 "This is the same as the L</mount> command, but it allows you to set both the "
23452 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
23456 #: ../fish/guestfish-actions.pod:3036
23457 msgid "mountpoints"
23461 #: ../fish/guestfish-actions.pod:3038
23469 #: ../fish/guestfish-actions.pod:3040
23471 "This call is similar to L</mounts>. That call returns a list of devices. "
23472 "This one returns a hash table (map) of device name to directory where the "
23473 "device is mounted."
23477 #: ../fish/guestfish-actions.pod:3044
23482 #: ../fish/guestfish-actions.pod:3046
23490 #: ../fish/guestfish-actions.pod:3053
23491 msgid "See also: L</mountpoints>"
23495 #: ../fish/guestfish-actions.pod:3055
23500 #: ../fish/guestfish-actions.pod:3057
23508 #: ../fish/guestfish-actions.pod:3062
23509 msgid "ntfs-3g-probe"
23513 #: ../fish/guestfish-actions.pod:3064
23516 " ntfs-3g-probe true|false device\n"
23521 #: ../fish/guestfish-actions.pod:3078
23526 #: ../fish/guestfish-actions.pod:3080
23529 " ntfsresize device\n"
23534 #: ../fish/guestfish-actions.pod:3086
23535 msgid "ntfsresize-size"
23539 #: ../fish/guestfish-actions.pod:3088
23542 " ntfsresize-size device size\n"
23547 #: ../fish/guestfish-actions.pod:3090
23549 "This command is the same as L</ntfsresize> except that it allows you to "
23550 "specify the new size (in bytes) explicitly."
23554 #: ../fish/guestfish-actions.pod:3093
23559 #: ../fish/guestfish-actions.pod:3095
23562 " part-add device prlogex startsect endsect\n"
23567 #: ../fish/guestfish-actions.pod:3097
23569 "This command adds a partition to C<device>. If there is no partition table "
23570 "on the device, call L</part-init> first."
23574 #: ../fish/guestfish-actions.pod:3109
23576 "Creating a partition which covers the whole disk is not so easy. Use "
23577 "L</part-disk> to do that."
23581 #: ../fish/guestfish-actions.pod:3112
23586 #: ../fish/guestfish-actions.pod:3114
23589 " part-del device partnum\n"
23594 #: ../fish/guestfish-actions.pod:3122
23599 #: ../fish/guestfish-actions.pod:3124
23602 " part-disk device parttype\n"
23607 #: ../fish/guestfish-actions.pod:3126
23609 "This command is simply a combination of L</part-init> followed by "
23610 "L</part-add> to create a single primary partition covering the whole disk."
23614 #: ../fish/guestfish-actions.pod:3130
23616 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
23617 "possible values are described in L</part-init>."
23621 #: ../fish/guestfish-actions.pod:3136
23622 msgid "part-get-bootable"
23626 #: ../fish/guestfish-actions.pod:3138
23629 " part-get-bootable device partnum\n"
23634 #: ../fish/guestfish-actions.pod:3143
23635 msgid "See also L</part-set-bootable>."
23639 #: ../fish/guestfish-actions.pod:3145
23640 msgid "part-get-mbr-id"
23644 #: ../fish/guestfish-actions.pod:3147
23647 " part-get-mbr-id device partnum\n"
23652 #: ../fish/guestfish-actions.pod:3152 ../fish/guestfish-actions.pod:3290
23654 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
23655 "undefined results for other partition table types (see "
23656 "L</part-get-parttype>)."
23660 #: ../fish/guestfish-actions.pod:3156
23661 msgid "part-get-parttype"
23665 #: ../fish/guestfish-actions.pod:3158
23668 " part-get-parttype device\n"
23673 #: ../fish/guestfish-actions.pod:3163
23675 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
23676 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
23677 "possible, although unusual. See L</part-init> for a full list."
23681 #: ../fish/guestfish-actions.pod:3168
23686 #: ../fish/guestfish-actions.pod:3170
23689 " part-init device parttype\n"
23694 #: ../fish/guestfish-actions.pod:3176
23696 "Initially there are no partitions. Following this, you should call "
23697 "L</part-add> for each partition required."
23701 #: ../fish/guestfish-actions.pod:3239
23706 #: ../fish/guestfish-actions.pod:3241
23709 " part-list device\n"
23714 #: ../fish/guestfish-actions.pod:3256
23716 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23717 "the device's sector size, see L</blockdev-getss>."
23721 #: ../fish/guestfish-actions.pod:3269
23722 msgid "part-set-bootable"
23726 #: ../fish/guestfish-actions.pod:3271
23729 " part-set-bootable device partnum true|false\n"
23734 #: ../fish/guestfish-actions.pod:3280
23735 msgid "part-set-mbr-id"
23739 #: ../fish/guestfish-actions.pod:3282
23742 " part-set-mbr-id device partnum idbyte\n"
23747 #: ../fish/guestfish-actions.pod:3294
23748 msgid "part-set-name"
23752 #: ../fish/guestfish-actions.pod:3296
23755 " part-set-name device partnum name\n"
23760 #: ../fish/guestfish-actions.pod:3304
23761 msgid "part-to-dev"
23765 #: ../fish/guestfish-actions.pod:3306
23768 " part-to-dev partition\n"
23773 #: ../fish/guestfish-actions.pod:3312
23775 "The named partition must exist, for example as a string returned from "
23776 "L</list-partitions>."
23780 #: ../fish/guestfish-actions.pod:3315
23781 msgid "ping-daemon"
23785 #: ../fish/guestfish-actions.pod:3317
23793 #: ../fish/guestfish-actions.pod:3324
23798 #: ../fish/guestfish-actions.pod:3326
23801 " pread path count offset\n"
23806 #: ../fish/guestfish-actions.pod:3334
23807 msgid "See also L</pwrite>, L</pread-device>."
23811 #: ../fish/guestfish-actions.pod:3339
23812 msgid "pread-device"
23816 #: ../fish/guestfish-actions.pod:3341
23819 " pread-device device count offset\n"
23824 #: ../fish/guestfish-actions.pod:3349
23825 msgid "See also L</pread>."
23829 #: ../fish/guestfish-actions.pod:3354
23834 #: ../fish/guestfish-actions.pod:3356
23837 " pvcreate device\n"
23842 #: ../fish/guestfish-actions.pod:3362
23847 #: ../fish/guestfish-actions.pod:3364
23850 " pvremove device\n"
23855 #: ../fish/guestfish-actions.pod:3373
23860 #: ../fish/guestfish-actions.pod:3375
23863 " pvresize device\n"
23868 #: ../fish/guestfish-actions.pod:3380
23869 msgid "pvresize-size"
23873 #: ../fish/guestfish-actions.pod:3382
23876 " pvresize-size device size\n"
23881 #: ../fish/guestfish-actions.pod:3384
23883 "This command is the same as L</pvresize> except that it allows you to "
23884 "specify the new size (in bytes) explicitly."
23888 #: ../fish/guestfish-actions.pod:3387
23893 #: ../fish/guestfish-actions.pod:3389
23901 #: ../fish/guestfish-actions.pod:3397
23902 msgid "See also L</pvs-full>."
23906 #: ../fish/guestfish-actions.pod:3399
23911 #: ../fish/guestfish-actions.pod:3401
23919 #: ../fish/guestfish-actions.pod:3406
23924 #: ../fish/guestfish-actions.pod:3408
23932 #: ../fish/guestfish-actions.pod:3412
23937 #: ../fish/guestfish-actions.pod:3414
23940 " pwrite path content offset\n"
23945 #: ../fish/guestfish-actions.pod:3425
23946 msgid "See also L</pread>, L</pwrite-device>."
23950 #: ../fish/guestfish-actions.pod:3430
23951 msgid "pwrite-device"
23955 #: ../fish/guestfish-actions.pod:3432
23958 " pwrite-device device content offset\n"
23963 #: ../fish/guestfish-actions.pod:3442
23964 msgid "See also L</pwrite>."
23968 #: ../fish/guestfish-actions.pod:3447
23973 #: ../fish/guestfish-actions.pod:3449
23976 " read-file path\n"
23981 #: ../fish/guestfish-actions.pod:3454
23983 "Unlike L</cat>, this function can correctly handle files that contain "
23984 "embedded ASCII NUL characters. However unlike L</download>, this function "
23985 "is limited in the total size of file that can be handled."
23989 #: ../fish/guestfish-actions.pod:3462
23994 #: ../fish/guestfish-actions.pod:3464
23997 " read-lines path\n"
24002 #: ../fish/guestfish-actions.pod:3471
24004 "Note that this function cannot correctly handle binary files (specifically, "
24005 "files containing C<\\0> character which is treated as end of line). For "
24006 "those you need to use the L</read-file> function which has a more complex "
24011 #: ../fish/guestfish-actions.pod:3476
24016 #: ../fish/guestfish-actions.pod:3478
24024 #: ../fish/guestfish-actions.pod:3530
24026 "This function is primarily intended for use by programs. To get a simple "
24027 "list of names, use L</ls>. To get a printable directory for human "
24028 "consumption, use L</ll>."
24032 #: ../fish/guestfish-actions.pod:3534
24037 #: ../fish/guestfish-actions.pod:3536
24045 #: ../fish/guestfish-actions.pod:3540
24046 msgid "readlinklist"
24050 #: ../fish/guestfish-actions.pod:3542
24053 " readlinklist path 'names ...'\n"
24058 #: ../fish/guestfish-actions.pod:3566
24063 #: ../fish/guestfish-actions.pod:3568
24071 #: ../fish/guestfish-actions.pod:3573
24072 msgid "removexattr"
24076 #: ../fish/guestfish-actions.pod:3575
24079 " removexattr xattr path\n"
24084 #: ../fish/guestfish-actions.pod:3580
24085 msgid "See also: L</lremovexattr>, L<attr(5)>."
24089 #: ../fish/guestfish-actions.pod:3582
24094 #: ../fish/guestfish-actions.pod:3584
24097 " resize2fs device\n"
24102 #: ../fish/guestfish-actions.pod:3589
24104 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
24105 "before calling this command. For unknown reasons C<resize2fs> sometimes "
24106 "gives an error about this and sometimes not. In any case, it is always safe "
24107 "to call L</e2fsck-f> before calling this function."
24111 #: ../fish/guestfish-actions.pod:3595
24112 msgid "resize2fs-size"
24116 #: ../fish/guestfish-actions.pod:3597
24119 " resize2fs-size device size\n"
24124 #: ../fish/guestfish-actions.pod:3599
24126 "This command is the same as L</resize2fs> except that it allows you to "
24127 "specify the new size (in bytes) explicitly."
24131 #: ../fish/guestfish-actions.pod:3602
24136 #: ../fish/guestfish-actions.pod:3604
24144 #: ../fish/guestfish-actions.pod:3608
24149 #: ../fish/guestfish-actions.pod:3610
24157 #: ../fish/guestfish-actions.pod:3616
24162 #: ../fish/guestfish-actions.pod:3618
24170 #: ../fish/guestfish-actions.pod:3622
24171 msgid "rmmountpoint"
24175 #: ../fish/guestfish-actions.pod:3624
24178 " rmmountpoint exemptpath\n"
24183 #: ../fish/guestfish-actions.pod:3626
24185 "This calls removes a mountpoint that was previously created with "
24186 "L</mkmountpoint>. See L</mkmountpoint> for full details."
24190 #: ../fish/guestfish-actions.pod:3630
24191 msgid "scrub-device"
24195 #: ../fish/guestfish-actions.pod:3632
24198 " scrub-device device\n"
24203 #: ../fish/guestfish-actions.pod:3643
24208 #: ../fish/guestfish-actions.pod:3645
24211 " scrub-file file\n"
24216 #: ../fish/guestfish-actions.pod:3655
24217 msgid "scrub-freespace"
24221 #: ../fish/guestfish-actions.pod:3657
24224 " scrub-freespace dir\n"
24229 #: ../fish/guestfish-actions.pod:3659
24231 "This command creates the directory C<dir> and then fills it with files until "
24232 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
24233 "deletes them. The intention is to scrub any free space on the partition "
24234 "containing C<dir>."
24238 #: ../fish/guestfish-actions.pod:3668
24243 #: ../fish/guestfish-actions.pod:3670
24248 #: ../fish/guestfish-actions.pod:3672
24251 " set-append append\n"
24256 #: ../fish/guestfish-actions.pod:3683
24257 msgid "set-autosync"
24261 #: ../fish/guestfish-actions.pod:3685
24266 #: ../fish/guestfish-actions.pod:3687
24269 " set-autosync true|false\n"
24274 #: ../fish/guestfish-actions.pod:3689
24276 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
24277 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
24278 "closed (also if the program exits without closing handles)."
24282 #: ../fish/guestfish-actions.pod:3697
24287 #: ../fish/guestfish-actions.pod:3699
24292 #: ../fish/guestfish-actions.pod:3701
24295 " set-direct true|false\n"
24300 #: ../fish/guestfish-actions.pod:3707
24302 "One consequence of this is that log messages aren't caught by the library "
24303 "and handled by L</set-log-message-callback>, but go straight to stdout."
24307 #: ../fish/guestfish-actions.pod:3716
24308 msgid "set-e2label"
24312 #: ../fish/guestfish-actions.pod:3718
24315 " set-e2label device label\n"
24320 #: ../fish/guestfish-actions.pod:3724
24322 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
24323 "label on a filesystem."
24327 #: ../fish/guestfish-actions.pod:3727
24332 #: ../fish/guestfish-actions.pod:3729
24335 " set-e2uuid device uuid\n"
24340 #: ../fish/guestfish-actions.pod:3736
24342 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
24343 "UUID of a filesystem."
24347 #: ../fish/guestfish-actions.pod:3739
24348 msgid "set-memsize"
24352 #: ../fish/guestfish-actions.pod:3741
24357 #: ../fish/guestfish-actions.pod:3743
24360 " set-memsize memsize\n"
24365 #: ../fish/guestfish-actions.pod:3745
24367 "This sets the memory size in megabytes allocated to the qemu subprocess. "
24368 "This only has any effect if called before L</launch>."
24372 #: ../fish/guestfish-actions.pod:3756
24373 msgid "set-network"
24377 #: ../fish/guestfish-actions.pod:3758
24382 #: ../fish/guestfish-actions.pod:3760
24385 " set-network true|false\n"
24390 #: ../fish/guestfish-actions.pod:3768
24391 msgid "You must call this before calling L</launch>, otherwise it has no effect."
24395 #: ../fish/guestfish-actions.pod:3771
24400 #: ../fish/guestfish-actions.pod:3773
24405 #: ../fish/guestfish-actions.pod:3775
24408 " set-path searchpath\n"
24413 #: ../fish/guestfish-actions.pod:3784
24418 #: ../fish/guestfish-actions.pod:3786
24423 #: ../fish/guestfish-actions.pod:3788
24431 #: ../fish/guestfish-actions.pod:3808
24432 msgid "set-recovery-proc"
24436 #: ../fish/guestfish-actions.pod:3810
24437 msgid "recovery-proc"
24441 #: ../fish/guestfish-actions.pod:3812
24444 " set-recovery-proc true|false\n"
24449 #: ../fish/guestfish-actions.pod:3814
24451 "If this is called with the parameter C<false> then L</launch> does not "
24452 "create a recovery process. The purpose of the recovery process is to stop "
24453 "runaway qemu processes in the case where the main program aborts abruptly."
24457 #: ../fish/guestfish-actions.pod:3819
24459 "This only has any effect if called before L</launch>, and the default is "
24464 #: ../fish/guestfish-actions.pod:3828
24465 msgid "set-selinux"
24469 #: ../fish/guestfish-actions.pod:3830
24474 #: ../fish/guestfish-actions.pod:3832
24477 " set-selinux true|false\n"
24482 #: ../fish/guestfish-actions.pod:3843
24487 #: ../fish/guestfish-actions.pod:3845
24492 #: ../fish/guestfish-actions.pod:3847
24495 " set-trace true|false\n"
24500 #: ../fish/guestfish-actions.pod:3863
24501 msgid "set-verbose"
24505 #: ../fish/guestfish-actions.pod:3865
24510 #: ../fish/guestfish-actions.pod:3867
24513 " set-verbose true|false\n"
24518 #: ../fish/guestfish-actions.pod:3874
24523 #: ../fish/guestfish-actions.pod:3876
24526 " setcon context\n"
24531 #: ../fish/guestfish-actions.pod:3883
24536 #: ../fish/guestfish-actions.pod:3885
24539 " setxattr xattr val vallen path\n"
24544 #: ../fish/guestfish-actions.pod:3891
24545 msgid "See also: L</lsetxattr>, L<attr(5)>."
24549 #: ../fish/guestfish-actions.pod:3893
24554 #: ../fish/guestfish-actions.pod:3895
24557 " sfdisk device cyls heads sectors 'lines ...'\n"
24562 #: ../fish/guestfish-actions.pod:3917
24563 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
24567 #: ../fish/guestfish-actions.pod:3923
24572 #: ../fish/guestfish-actions.pod:3925
24575 " sfdiskM device 'lines ...'\n"
24580 #: ../fish/guestfish-actions.pod:3927
24582 "This is a simplified interface to the L</sfdisk> command, where partition "
24583 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
24584 "you don't need to specify the cyls, heads and sectors parameters which were "
24585 "rarely if ever used anyway."
24589 #: ../fish/guestfish-actions.pod:3933
24590 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
24594 #: ../fish/guestfish-actions.pod:3939
24599 #: ../fish/guestfish-actions.pod:3941
24602 " sfdisk-N device partnum cyls heads sectors line\n"
24607 #: ../fish/guestfish-actions.pod:3946
24609 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
24610 "cyls/heads/sectors parameters."
24614 #: ../fish/guestfish-actions.pod:3949
24615 msgid "See also: L</part-add>"
24619 #: ../fish/guestfish-actions.pod:3954
24620 msgid "sfdisk-disk-geometry"
24624 #: ../fish/guestfish-actions.pod:3956
24627 " sfdisk-disk-geometry device\n"
24632 #: ../fish/guestfish-actions.pod:3958
24634 "This displays the disk geometry of C<device> read from the partition table. "
24635 "Especially in the case where the underlying block device has been resized, "
24636 "this can be different from the kernel's idea of the geometry (see "
24637 "L</sfdisk-kernel-geometry>)."
24641 #: ../fish/guestfish-actions.pod:3966
24642 msgid "sfdisk-kernel-geometry"
24646 #: ../fish/guestfish-actions.pod:3968
24649 " sfdisk-kernel-geometry device\n"
24654 #: ../fish/guestfish-actions.pod:3975
24659 #: ../fish/guestfish-actions.pod:3977
24662 " sfdisk-l device\n"
24667 #: ../fish/guestfish-actions.pod:3983
24668 msgid "See also: L</part-list>"
24672 #: ../fish/guestfish-actions.pod:3985
24677 #: ../fish/guestfish-actions.pod:3987
24685 #: ../fish/guestfish-actions.pod:3992
24686 msgid "This is like L</command>, but passes the command to:"
24690 #: ../fish/guestfish-actions.pod:4000
24691 msgid "All the provisos about L</command> apply to this call."
24695 #: ../fish/guestfish-actions.pod:4002
24700 #: ../fish/guestfish-actions.pod:4004
24703 " sh-lines command\n"
24708 #: ../fish/guestfish-actions.pod:4006
24709 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24713 #: ../fish/guestfish-actions.pod:4009
24714 msgid "See also: L</command-lines>"
24718 #: ../fish/guestfish-actions.pod:4011
24723 #: ../fish/guestfish-actions.pod:4013
24731 #: ../fish/guestfish-actions.pod:4017
24736 #: ../fish/guestfish-actions.pod:4019
24744 #: ../fish/guestfish-actions.pod:4025
24749 #: ../fish/guestfish-actions.pod:4027
24757 #: ../fish/guestfish-actions.pod:4035
24762 #: ../fish/guestfish-actions.pod:4037
24770 #: ../fish/guestfish-actions.pod:4045
24775 #: ../fish/guestfish-actions.pod:4047
24778 " strings-e encoding path\n"
24783 #: ../fish/guestfish-actions.pod:4049
24785 "This is like the L</strings> command, but allows you to specify the encoding "
24786 "of strings that are looked for in the source file C<path>."
24790 #: ../fish/guestfish-actions.pod:4059
24792 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24793 "ISO-8859-X (this is what L</strings> uses)."
24797 #: ../fish/guestfish-actions.pod:4091
24798 msgid "swapoff-device"
24802 #: ../fish/guestfish-actions.pod:4093
24805 " swapoff-device device\n"
24810 #: ../fish/guestfish-actions.pod:4095
24812 "This command disables the libguestfs appliance swap device or partition "
24813 "named C<device>. See L</swapon-device>."
24817 #: ../fish/guestfish-actions.pod:4099
24818 msgid "swapoff-file"
24822 #: ../fish/guestfish-actions.pod:4101
24825 " swapoff-file file\n"
24830 #: ../fish/guestfish-actions.pod:4105
24831 msgid "swapoff-label"
24835 #: ../fish/guestfish-actions.pod:4107
24838 " swapoff-label label\n"
24843 #: ../fish/guestfish-actions.pod:4112
24844 msgid "swapoff-uuid"
24848 #: ../fish/guestfish-actions.pod:4114
24851 " swapoff-uuid uuid\n"
24856 #: ../fish/guestfish-actions.pod:4119
24857 msgid "swapon-device"
24861 #: ../fish/guestfish-actions.pod:4121
24864 " swapon-device device\n"
24869 #: ../fish/guestfish-actions.pod:4123
24871 "This command enables the libguestfs appliance to use the swap device or "
24872 "partition named C<device>. The increased memory is made available for all "
24873 "commands, for example those run using L</command> or L</sh>."
24877 #: ../fish/guestfish-actions.pod:4135
24878 msgid "swapon-file"
24882 #: ../fish/guestfish-actions.pod:4137
24885 " swapon-file file\n"
24890 #: ../fish/guestfish-actions.pod:4139
24891 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
24895 #: ../fish/guestfish-actions.pod:4142
24896 msgid "swapon-label"
24900 #: ../fish/guestfish-actions.pod:4144
24903 " swapon-label label\n"
24908 #: ../fish/guestfish-actions.pod:4146
24910 "This command enables swap to a labeled swap partition. See "
24911 "L</swapon-device> for other notes."
24915 #: ../fish/guestfish-actions.pod:4149
24916 msgid "swapon-uuid"
24920 #: ../fish/guestfish-actions.pod:4151
24923 " swapon-uuid uuid\n"
24928 #: ../fish/guestfish-actions.pod:4153
24930 "This command enables swap to a swap partition with the given UUID. See "
24931 "L</swapon-device> for other notes."
24935 #: ../fish/guestfish-actions.pod:4156
24940 #: ../fish/guestfish-actions.pod:4158
24948 #: ../fish/guestfish-actions.pod:4166
24953 #: ../fish/guestfish-actions.pod:4168
24961 #: ../fish/guestfish-actions.pod:4176
24966 #: ../fish/guestfish-actions.pod:4178
24969 " tail-n nrlines path\n"
24974 #: ../fish/guestfish-actions.pod:4191
24979 #: ../fish/guestfish-actions.pod:4193
24982 " tar-in (tarfile|-) directory\n"
24987 #: ../fish/guestfish-actions.pod:4198
24988 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24992 #: ../fish/guestfish-actions.pod:4203
24997 #: ../fish/guestfish-actions.pod:4205
25000 " tar-out directory (tarfile|-)\n"
25005 #: ../fish/guestfish-actions.pod:4210
25006 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
25010 #: ../fish/guestfish-actions.pod:4215
25015 #: ../fish/guestfish-actions.pod:4217
25018 " tgz-in (tarball|-) directory\n"
25023 #: ../fish/guestfish-actions.pod:4222
25024 msgid "To upload an uncompressed tarball, use L</tar-in>."
25028 #: ../fish/guestfish-actions.pod:4226
25033 #: ../fish/guestfish-actions.pod:4228
25036 " tgz-out directory (tarball|-)\n"
25041 #: ../fish/guestfish-actions.pod:4233
25042 msgid "To download an uncompressed tarball, use L</tar-out>."
25046 #: ../fish/guestfish-actions.pod:4237
25051 #: ../fish/guestfish-actions.pod:4239
25059 #: ../fish/guestfish-actions.pod:4248
25064 #: ../fish/guestfish-actions.pod:4250
25072 #: ../fish/guestfish-actions.pod:4255
25073 msgid "truncate-size"
25077 #: ../fish/guestfish-actions.pod:4257
25080 " truncate-size path size\n"
25085 #: ../fish/guestfish-actions.pod:4262
25087 "If the current file size is less than C<size> then the file is extended to "
25088 "the required size with zero bytes. This creates a sparse file (ie. disk "
25089 "blocks are not allocated for the file until you write to it). To create a "
25090 "non-sparse file of zeroes, use L</fallocate64> instead."
25094 #: ../fish/guestfish-actions.pod:4268
25099 #: ../fish/guestfish-actions.pod:4270
25102 " tune2fs-l device\n"
25107 #: ../fish/guestfish-actions.pod:4280
25112 #: ../fish/guestfish-actions.pod:4282
25115 " txz-in (tarball|-) directory\n"
25120 #: ../fish/guestfish-actions.pod:4289
25125 #: ../fish/guestfish-actions.pod:4291
25128 " txz-out directory (tarball|-)\n"
25133 #: ../fish/guestfish-actions.pod:4298
25138 #: ../fish/guestfish-actions.pod:4300
25146 #: ../fish/guestfish-actions.pod:4314
25147 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
25151 #: ../fish/guestfish-actions.pod:4319
25156 #: ../fish/guestfish-actions.pod:4321
25161 #: ../fish/guestfish-actions.pod:4323
25164 " umount pathordevice\n"
25169 #: ../fish/guestfish-actions.pod:4329
25174 #: ../fish/guestfish-actions.pod:4331
25175 msgid "unmount-all"
25179 #: ../fish/guestfish-actions.pod:4333
25187 #: ../fish/guestfish-actions.pod:4339
25192 #: ../fish/guestfish-actions.pod:4341
25195 " upload (filename|-) remotefilename\n"
25200 #: ../fish/guestfish-actions.pod:4348
25201 msgid "See also L</download>."
25205 #: ../fish/guestfish-actions.pod:4352
25206 msgid "upload-offset"
25210 #: ../fish/guestfish-actions.pod:4354
25213 " upload-offset (filename|-) remotefilename offset\n"
25218 #: ../fish/guestfish-actions.pod:4366
25220 "Note that there is no limit on the amount of data that can be uploaded with "
25221 "this call, unlike with L</pwrite>, and this call always writes the full "
25222 "amount unless an error occurs."
25226 #: ../fish/guestfish-actions.pod:4371
25227 msgid "See also L</upload>, L</pwrite>."
25231 #: ../fish/guestfish-actions.pod:4375
25236 #: ../fish/guestfish-actions.pod:4377
25239 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
25244 #: ../fish/guestfish-actions.pod:4396
25249 #: ../fish/guestfish-actions.pod:4398
25257 #: ../fish/guestfish-actions.pod:4425
25259 "I<Note:> Don't use this call to test for availability of features. In "
25260 "enterprise distributions we backport features from later versions into "
25261 "earlier versions, making this an unreliable way to test for features. Use "
25262 "L</available> instead."
25266 #: ../fish/guestfish-actions.pod:4431
25271 #: ../fish/guestfish-actions.pod:4433
25274 " vfs-label device\n"
25279 #: ../fish/guestfish-actions.pod:4440
25280 msgid "To find a filesystem from the label, use L</findfs-label>."
25284 #: ../fish/guestfish-actions.pod:4442
25289 #: ../fish/guestfish-actions.pod:4444
25292 " vfs-type device\n"
25297 #: ../fish/guestfish-actions.pod:4454
25302 #: ../fish/guestfish-actions.pod:4456
25305 " vfs-uuid device\n"
25310 #: ../fish/guestfish-actions.pod:4463
25311 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
25315 #: ../fish/guestfish-actions.pod:4465
25316 msgid "vg-activate"
25320 #: ../fish/guestfish-actions.pod:4467
25323 " vg-activate true|false 'volgroups ...'\n"
25328 #: ../fish/guestfish-actions.pod:4480
25329 msgid "vg-activate-all"
25333 #: ../fish/guestfish-actions.pod:4482
25336 " vg-activate-all true|false\n"
25341 #: ../fish/guestfish-actions.pod:4492
25346 #: ../fish/guestfish-actions.pod:4494
25349 " vgcreate volgroup 'physvols ...'\n"
25354 #: ../fish/guestfish-actions.pod:4499
25359 #: ../fish/guestfish-actions.pod:4501
25362 " vglvuuids vgname\n"
25367 #: ../fish/guestfish-actions.pod:4506
25369 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
25370 "logical volumes and volume groups."
25374 #: ../fish/guestfish-actions.pod:4509
25375 msgid "See also L</vgpvuuids>."
25379 #: ../fish/guestfish-actions.pod:4511
25384 #: ../fish/guestfish-actions.pod:4513
25387 " vgpvuuids vgname\n"
25392 #: ../fish/guestfish-actions.pod:4518
25394 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
25395 "physical volumes and volume groups."
25399 #: ../fish/guestfish-actions.pod:4521
25400 msgid "See also L</vglvuuids>."
25404 #: ../fish/guestfish-actions.pod:4523
25409 #: ../fish/guestfish-actions.pod:4525
25412 " vgremove vgname\n"
25417 #: ../fish/guestfish-actions.pod:4532
25422 #: ../fish/guestfish-actions.pod:4534
25425 " vgrename volgroup newvolgroup\n"
25430 #: ../fish/guestfish-actions.pod:4538
25435 #: ../fish/guestfish-actions.pod:4540
25443 #: ../fish/guestfish-actions.pod:4548
25444 msgid "See also L</vgs-full>."
25448 #: ../fish/guestfish-actions.pod:4550
25453 #: ../fish/guestfish-actions.pod:4552
25461 #: ../fish/guestfish-actions.pod:4557
25466 #: ../fish/guestfish-actions.pod:4559
25474 #: ../fish/guestfish-actions.pod:4564
25479 #: ../fish/guestfish-actions.pod:4566
25487 #: ../fish/guestfish-actions.pod:4570
25492 #: ../fish/guestfish-actions.pod:4572
25500 #: ../fish/guestfish-actions.pod:4577
25505 #: ../fish/guestfish-actions.pod:4579
25513 #: ../fish/guestfish-actions.pod:4584
25518 #: ../fish/guestfish-actions.pod:4586
25526 #: ../fish/guestfish-actions.pod:4591
25531 #: ../fish/guestfish-actions.pod:4593
25534 " write path content\n"
25539 #: ../fish/guestfish-actions.pod:4601
25544 #: ../fish/guestfish-actions.pod:4603
25547 " write-file path content size\n"
25552 #: ../fish/guestfish-actions.pod:4626
25557 #: ../fish/guestfish-actions.pod:4628
25560 " zegrep regex path\n"
25565 #: ../fish/guestfish-actions.pod:4636
25570 #: ../fish/guestfish-actions.pod:4638
25573 " zegrepi regex path\n"
25578 #: ../fish/guestfish-actions.pod:4646
25583 #: ../fish/guestfish-actions.pod:4648
25591 #: ../fish/guestfish-actions.pod:4656
25592 msgid "See also: L</zero-device>, L</scrub-device>."
25596 #: ../fish/guestfish-actions.pod:4658
25597 msgid "zero-device"
25601 #: ../fish/guestfish-actions.pod:4660
25604 " zero-device device\n"
25609 #: ../fish/guestfish-actions.pod:4662
25611 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
25612 "which just zeroes the first few blocks of a device."
25616 #: ../fish/guestfish-actions.pod:4669
25621 #: ../fish/guestfish-actions.pod:4671
25624 " zerofree device\n"
25629 #: ../fish/guestfish-actions.pod:4684
25634 #: ../fish/guestfish-actions.pod:4686
25637 " zfgrep pattern path\n"
25642 #: ../fish/guestfish-actions.pod:4694
25647 #: ../fish/guestfish-actions.pod:4696
25650 " zfgrepi pattern path\n"
25655 #: ../fish/guestfish-actions.pod:4704
25660 #: ../fish/guestfish-actions.pod:4706
25663 " zfile meth path\n"
25668 #: ../fish/guestfish-actions.pod:4713
25669 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
25673 #: ../fish/guestfish-actions.pod:4723
25678 #: ../fish/guestfish-actions.pod:4725
25681 " zgrep regex path\n"
25686 #: ../fish/guestfish-actions.pod:4733
25691 #: ../fish/guestfish-actions.pod:4735
25694 " zgrepi regex path\n"
25699 #: ../fish/guestfish-commands.pod:1
25704 #: ../fish/guestfish-commands.pod:3
25709 #: ../fish/guestfish-commands.pod:5
25712 " alloc filename size\n"
25717 #: ../fish/guestfish-commands.pod:7
25719 "This creates an empty (zeroed) file of the given size, and then adds so it "
25720 "can be further examined."
25724 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25725 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25729 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25730 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25734 #: ../fish/guestfish-commands.pod:14
25736 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25737 "image, see L</PREPARED DISK IMAGES>."
25741 #: ../fish/guestfish-commands.pod:17
25746 #: ../fish/guestfish-commands.pod:19
25749 " copy-in local [local ...] /remotedir\n"
25754 #: ../fish/guestfish-commands.pod:21
25756 "C<copy-in> copies local files or directories recursively into the disk "
25757 "image, placing them in the directory called C</remotedir> (which must "
25758 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25759 "other commands as necessary."
25763 #: ../fish/guestfish-commands.pod:26
25765 "Multiple local files and directories can be specified, but the last "
25766 "parameter must always be a remote directory. Wildcards cannot be used."
25770 #: ../fish/guestfish-commands.pod:30
25775 #: ../fish/guestfish-commands.pod:32
25778 " copy-out remote [remote ...] localdir\n"
25783 #: ../fish/guestfish-commands.pod:34
25785 "C<copy-out> copies remote files or directories recursively out of the disk "
25786 "image, placing them on the host disk in a local directory called C<localdir> "
25787 "(which must exist). This guestfish meta-command turns into a sequence of "
25788 "L</download>, L</tar-out> and other commands as necessary."
25792 #: ../fish/guestfish-commands.pod:40
25794 "Multiple remote files and directories can be specified, but the last "
25795 "parameter must always be a local directory. To download to the current "
25796 "directory, use C<.> as in:"
25800 #: ../fish/guestfish-commands.pod:44
25803 " copy-out /home .\n"
25808 #: ../fish/guestfish-commands.pod:46
25810 "Wildcards cannot be used in the ordinary command, but you can use them with "
25811 "the help of L</glob> like this:"
25815 #: ../fish/guestfish-commands.pod:49
25818 " glob copy-out /home/* .\n"
25823 #: ../fish/guestfish-commands.pod:51
25828 #: ../fish/guestfish-commands.pod:53
25831 " echo [params ...]\n"
25836 #: ../fish/guestfish-commands.pod:55
25837 msgid "This echos the parameters to the terminal."
25841 #: ../fish/guestfish-commands.pod:57
25846 #: ../fish/guestfish-commands.pod:59
25851 #: ../fish/guestfish-commands.pod:61
25856 #: ../fish/guestfish-commands.pod:63
25864 #: ../fish/guestfish-commands.pod:65
25866 "This is used to edit a file. It downloads the file, edits it locally using "
25867 "your editor, then uploads the result."
25871 #: ../fish/guestfish-commands.pod:68
25873 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25874 "or C<emacs> you will get those corresponding editors."
25878 #: ../fish/guestfish-commands.pod:72
25883 #: ../fish/guestfish-commands.pod:74
25886 " glob command args...\n"
25891 #: ../fish/guestfish-commands.pod:76
25893 "Expand wildcards in any paths in the args list, and run C<command> "
25894 "repeatedly on each matching path."
25898 #: ../fish/guestfish-commands.pod:79
25899 msgid "See L</WILDCARDS AND GLOBBING>."
25903 #: ../fish/guestfish-commands.pod:81
25908 #: ../fish/guestfish-commands.pod:83
25911 " hexedit <filename|device>\n"
25912 " hexedit <filename|device> <max>\n"
25913 " hexedit <filename|device> <start> <max>\n"
25918 #: ../fish/guestfish-commands.pod:87
25920 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25925 #: ../fish/guestfish-commands.pod:90
25927 "This command works by downloading potentially the whole file or device, "
25928 "editing it locally, then uploading it. If the file or device is large, you "
25929 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25930 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25931 "usual modifiers allowed such as C<1M> (1 megabyte)."
25935 #: ../fish/guestfish-commands.pod:97
25936 msgid "For example to edit the first few sectors of a disk you might do:"
25940 #: ../fish/guestfish-commands.pod:100
25943 " hexedit /dev/sda 1M\n"
25948 #: ../fish/guestfish-commands.pod:102
25950 "which would allow you to edit anywhere within the first megabyte of the "
25955 #: ../fish/guestfish-commands.pod:105
25956 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25960 #: ../fish/guestfish-commands.pod:107
25963 " hexedit /dev/sda1 0x400 0x400\n"
25968 #: ../fish/guestfish-commands.pod:109
25969 msgid "(assuming the superblock is in the standard location)."
25973 #: ../fish/guestfish-commands.pod:111
25975 "This command requires the external L<hexedit(1)> program. You can specify "
25976 "another program to use by setting the C<HEXEDITOR> environment variable."
25980 #: ../fish/guestfish-commands.pod:115
25981 msgid "See also L</hexdump>."
25985 #: ../fish/guestfish-commands.pod:117
25990 #: ../fish/guestfish-commands.pod:119
25998 #: ../fish/guestfish-commands.pod:121
25999 msgid "Change the local directory, ie. the current directory of guestfish itself."
26003 #: ../fish/guestfish-commands.pod:124
26004 msgid "Note that C<!cd> won't do what you might expect."
26008 #: ../fish/guestfish-commands.pod:126
26013 #: ../fish/guestfish-commands.pod:128
26018 #: ../fish/guestfish-commands.pod:130
26026 #: ../fish/guestfish-commands.pod:132
26027 msgid "Opens the manual page for guestfish."
26031 #: ../fish/guestfish-commands.pod:134
26036 #: ../fish/guestfish-commands.pod:136
26041 #: ../fish/guestfish-commands.pod:138
26049 #: ../fish/guestfish-commands.pod:140
26057 #: ../fish/guestfish-commands.pod:142
26058 msgid "This is used to view a file."
26062 #: ../fish/guestfish-commands.pod:144
26064 "The default viewer is C<$PAGER>. However if you use the alternate command "
26065 "C<less> you will get the C<less> command specifically."
26069 #: ../fish/guestfish-commands.pod:147
26074 #: ../fish/guestfish-commands.pod:149
26082 #: ../fish/guestfish-commands.pod:151
26084 "Close and reopen the libguestfs handle. It is not necessary to use this "
26085 "normally, because the handle is closed properly when guestfish exits. "
26086 "However this is occasionally useful for testing."
26090 #: ../fish/guestfish-commands.pod:155
26095 #: ../fish/guestfish-commands.pod:157
26098 " sparse filename size\n"
26103 #: ../fish/guestfish-commands.pod:159
26105 "This creates an empty sparse file of the given size, and then adds so it can "
26106 "be further examined."
26110 #: ../fish/guestfish-commands.pod:162
26112 "In all respects it works the same as the L</alloc> command, except that the "
26113 "image file is allocated sparsely, which means that disk blocks are not "
26114 "assigned to the file until they are needed. Sparse disk files only use "
26115 "space when written to, but they are slower and there is a danger you could "
26116 "run out of real disk space during a write operation."
26120 #: ../fish/guestfish-commands.pod:172
26125 #: ../fish/guestfish-commands.pod:174
26133 #: ../fish/guestfish-commands.pod:176
26135 "This command returns a list of the optional groups known to the daemon, and "
26136 "indicates which ones are supported by this build of the libguestfs "
26141 #: ../fish/guestfish-commands.pod:180
26142 msgid "See also L<guestfs(3)/AVAILABILITY>."
26146 #: ../fish/guestfish-commands.pod:182
26151 #: ../fish/guestfish-commands.pod:184
26154 " time command args...\n"
26159 #: ../fish/guestfish-commands.pod:186
26161 "Run the command as usual, but print the elapsed time afterwards. This can "
26162 "be useful for benchmarking operations."
26166 #: ../test-tool/libguestfs-test-tool.pod:5
26167 msgid "libguestfs-test-tool - End user tests for libguestfs"
26171 #: ../test-tool/libguestfs-test-tool.pod:9
26174 " libguestfs-test-tool [--options]\n"
26179 #: ../test-tool/libguestfs-test-tool.pod:13
26181 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
26182 "and developers, to allow them to check basic libguestfs functionality is "
26183 "working. This is needed because libguestfs occasionally breaks for reasons "
26184 "beyond our control: usually because of changes in the underlying qemu or "
26185 "kernel packages, or the host environment."
26189 #: ../test-tool/libguestfs-test-tool.pod:20
26190 msgid "If you suspect a problem in libguestfs, then just run:"
26194 #: ../test-tool/libguestfs-test-tool.pod:22
26197 " libguestfs-test-tool\n"
26202 #: ../test-tool/libguestfs-test-tool.pod:24
26203 msgid "It will print lots of diagnostic messages."
26207 #: ../test-tool/libguestfs-test-tool.pod:26
26208 msgid "If it runs to completion successfully, you will see this near the end:"
26212 #: ../test-tool/libguestfs-test-tool.pod:28
26215 " ===== TEST FINISHED OK =====\n"
26220 #: ../test-tool/libguestfs-test-tool.pod:30
26221 msgid "and the test tool will exit with code 0."
26225 #: ../test-tool/libguestfs-test-tool.pod:32
26227 "If it fails (and/or exits with non-zero error code), please paste the "
26228 "B<complete, unedited> output of the test tool into a bug report. More "
26229 "information about reporting bugs can be found on the "
26230 "L<http://libguestfs.org/> website."
26234 #: ../test-tool/libguestfs-test-tool.pod:41
26239 #: ../test-tool/libguestfs-test-tool.pod:43
26240 msgid "Display short usage information and exit."
26244 #: ../test-tool/libguestfs-test-tool.pod:45
26245 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
26249 #: ../test-tool/libguestfs-test-tool.pod:47
26251 "Pass an alternate name for the helper program. libguestfs-test-tool will "
26252 "normally look in the C<$libexec> directory that was configured when the tool "
26257 #: ../test-tool/libguestfs-test-tool.pod:51
26258 msgid "I<--qemu qemu_binary>"
26262 #: ../test-tool/libguestfs-test-tool.pod:53
26264 "If you have downloaded another qemu binary, point this option at the full "
26265 "path of the binary to try it."
26269 #: ../test-tool/libguestfs-test-tool.pod:56
26270 msgid "I<--qemudir qemu_source_dir>"
26274 #: ../test-tool/libguestfs-test-tool.pod:58
26276 "If you have compiled qemu from source, point this option at the source "
26277 "directory to try it."
26281 #: ../test-tool/libguestfs-test-tool.pod:61
26282 msgid "I<--timeout N>"
26286 #: ../test-tool/libguestfs-test-tool.pod:63
26288 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
26289 "does not usually need to be adjusted unless your machine is very slow."
26293 #: ../test-tool/libguestfs-test-tool.pod:69
26294 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
26298 #: ../test-tool/libguestfs-test-tool.pod:71
26300 "If you have compiled another version of qemu from source and would like to "
26301 "try that, then you can use the I<--qemudir> option to point to the qemu "
26302 "source directory."
26306 #: ../test-tool/libguestfs-test-tool.pod:75
26308 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
26309 "option to point to the binary."
26313 #: ../test-tool/libguestfs-test-tool.pod:78
26315 "When using an alternate qemu with libguestfs, usually you would need to "
26316 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
26317 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
26318 "when you use either of the I<--qemudir> or I<--qemu> options."
26322 #: ../test-tool/libguestfs-test-tool.pod:85
26324 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
26325 "I<1> if there was an error."
26329 #: ../test-tool/libguestfs-test-tool.pod:92
26330 msgid "/usr/libexec/libguestfs-test-tool-helper"
26334 #: ../test-tool/libguestfs-test-tool.pod:94
26336 "This helper program is run inside the appliance and provides additional "
26341 #: ../test-tool/libguestfs-test-tool.pod:97
26342 msgid "/usr/bin/mkisofs"
26346 #: ../test-tool/libguestfs-test-tool.pod:99
26348 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
26349 "which is used as part of the tests."
26353 #: ../test-tool/libguestfs-test-tool.pod:106
26355 "For the full list of environment variables which may affect libguestfs, "
26356 "please see the L<guestfs(3)> manual page."
26360 #: ../test-tool/libguestfs-test-tool.pod:111
26361 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
26365 #: ../test-tool/libguestfs-test-tool.pod:121
26366 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
26370 #: ../fuse/guestmount.pod:5
26371 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
26375 #: ../fuse/guestmount.pod:9
26378 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
26383 #: ../fuse/guestmount.pod:11
26386 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
26391 #: ../fuse/guestmount.pod:13
26394 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
26399 #: ../fuse/guestmount.pod:17
26401 "You must I<not> use C<guestmount> in read-write mode on live virtual "
26402 "machines. If you do this, you risk disk corruption in the VM."
26406 #: ../fuse/guestmount.pod:22
26408 "The guestmount program can be used to mount virtual machine filesystems and "
26409 "other disk images on the host. It uses libguestfs for access to the guest "
26410 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
26411 "a mountable device."
26415 #: ../fuse/guestmount.pod:27
26417 "Along with other options, you have to give at least one device (I<-a> "
26418 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
26419 "option) or use the I<-i> inspection option. How this works is better "
26420 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
26425 #: ../fuse/guestmount.pod:33
26427 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
26428 "by you, and the filesystem will not be visible to any other users unless you "
26429 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
26430 "the filesystem, use the C<fusermount -u> command."
26434 #: ../fuse/guestmount.pod:41
26436 "For a typical Windows guest which has its main filesystem on the first "
26441 #: ../fuse/guestmount.pod:44
26444 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
26449 #: ../fuse/guestmount.pod:46
26451 "For a typical Linux guest which has a /boot filesystem on the first "
26452 "partition, and the root filesystem on a logical volume:"
26456 #: ../fuse/guestmount.pod:49
26459 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
26464 #: ../fuse/guestmount.pod:51
26465 msgid "To get libguestfs to detect guest mountpoints for you:"
26469 #: ../fuse/guestmount.pod:53
26472 " guestmount -a guest.img -i --ro /mnt\n"
26477 #: ../fuse/guestmount.pod:55
26478 msgid "For a libvirt guest called \"Guest\" you could do:"
26482 #: ../fuse/guestmount.pod:57
26485 " guestmount -d Guest -i --ro /mnt\n"
26490 #: ../fuse/guestmount.pod:59
26492 "If you don't know what filesystems are contained in a guest or disk image, "
26493 "use L<virt-filesystems(1)> first:"
26497 #: ../fuse/guestmount.pod:62
26500 " virt-filesystems MyGuest\n"
26505 #: ../fuse/guestmount.pod:64
26507 "If you want to trace the libguestfs calls but without excessive debugging "
26508 "information, we recommend:"
26512 #: ../fuse/guestmount.pod:67
26515 " guestmount [...] --trace /mnt\n"
26520 #: ../fuse/guestmount.pod:69
26521 msgid "If you want to debug the program, we recommend:"
26525 #: ../fuse/guestmount.pod:71
26528 " guestmount [...] --trace --verbose /mnt\n"
26533 #: ../fuse/guestmount.pod:77
26534 msgid "B<-a image> | B<--add image>"
26538 #: ../fuse/guestmount.pod:79
26539 msgid "Add a block device or virtual machine image."
26543 #: ../fuse/guestmount.pod:84
26544 msgid "B<-c URI> | B<--connect URI>"
26548 #: ../fuse/guestmount.pod:90
26549 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
26553 #: ../fuse/guestmount.pod:96
26554 msgid "B<--dir-cache-timeout N>"
26558 #: ../fuse/guestmount.pod:98
26560 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
26561 "seconds. The readdir cache [actually, there are several semi-independent "
26562 "caches] is populated after a readdir(2) call with the stat and extended "
26563 "attributes of the files in the directory, in anticipation that they will be "
26564 "requested soon after."
26568 #: ../fuse/guestmount.pod:104
26570 "There is also a different attribute cache implemented by FUSE (see the FUSE "
26571 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
26572 "requests, only cache existing ones."
26576 #: ../fuse/guestmount.pod:115
26577 msgid "B<--format=raw|qcow2|..> | B<--format>"
26581 #: ../fuse/guestmount.pod:122
26583 "If you have untrusted raw-format guest disk images, you should use this "
26584 "option to specify the disk format. This avoids a possible security problem "
26585 "with malicious guests (CVE-2010-3851). See also "
26586 "L<guestfs(3)/guestfs_add_drive_opts>."
26590 #: ../fuse/guestmount.pod:127
26591 msgid "B<--fuse-help>"
26595 #: ../fuse/guestmount.pod:129
26596 msgid "Display help on special FUSE options (see I<-o> below)."
26600 #: ../fuse/guestmount.pod:133
26601 msgid "Display brief help and exit."
26605 #: ../fuse/guestmount.pod:135
26606 msgid "B<-i> | B<--inspector>"
26610 #: ../fuse/guestmount.pod:146
26611 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
26615 #: ../fuse/guestmount.pod:148
26617 "Mount the named partition or logical volume on the given mountpoint B<in the "
26618 "guest> (this has nothing to do with mountpoints in the host)."
26622 #: ../fuse/guestmount.pod:151
26624 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
26625 "something on C</>."
26629 #: ../fuse/guestmount.pod:154
26630 msgid "B<-n> | B<--no-sync>"
26634 #: ../fuse/guestmount.pod:156
26636 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
26637 "unmounted. If you specify this option, then we don't attempt to sync the "
26638 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
26642 #: ../fuse/guestmount.pod:161
26643 msgid "B<-o option> | B<--option option>"
26647 #: ../fuse/guestmount.pod:163
26648 msgid "Pass extra options to FUSE."
26652 #: ../fuse/guestmount.pod:165
26654 "To get a list of all the extra options supported by FUSE, use the command "
26655 "below. Note that only the FUSE I<-o> options can be passed, and only some "
26656 "of them are a good idea."
26660 #: ../fuse/guestmount.pod:169
26663 " guestmount --fuse-help\n"
26668 #: ../fuse/guestmount.pod:171
26669 msgid "Some potentially useful FUSE options:"
26673 #: ../fuse/guestmount.pod:175
26674 msgid "B<-o allow_other>"
26678 #: ../fuse/guestmount.pod:177
26679 msgid "Allow other users to see the filesystem."
26683 #: ../fuse/guestmount.pod:179
26684 msgid "B<-o attr_timeout=N>"
26688 #: ../fuse/guestmount.pod:181
26689 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
26693 #: ../fuse/guestmount.pod:183
26694 msgid "B<-o kernel_cache>"
26698 #: ../fuse/guestmount.pod:185
26700 "Allow the kernel to cache files (reduces the number of reads that have to go "
26701 "through the L<guestfs(3)> API). This is generally a good idea if you can "
26702 "afford the extra memory usage."
26706 #: ../fuse/guestmount.pod:189
26707 msgid "B<-o uid=N> B<-o gid=N>"
26711 #: ../fuse/guestmount.pod:191
26713 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
26714 "the chosen values."
26718 #: ../fuse/guestmount.pod:196
26719 msgid "B<-r> | B<--ro>"
26723 #: ../fuse/guestmount.pod:198
26725 "Add devices and mount everything read-only. Also disallow writes and make "
26726 "the disk appear read-only to FUSE."
26730 #: ../fuse/guestmount.pod:201
26732 "This is highly recommended if you are not going to edit the guest disk. If "
26733 "the guest is running and this option is I<not> supplied, then there is a "
26734 "strong risk of disk corruption in the guest. We try to prevent this from "
26735 "happening, but it is not always possible."
26739 #: ../fuse/guestmount.pod:206
26740 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26744 #: ../fuse/guestmount.pod:210
26745 msgid "Enable SELinux support for the guest."
26749 #: ../fuse/guestmount.pod:212
26750 msgid "B<-v> | B<--verbose>"
26754 #: ../fuse/guestmount.pod:214
26755 msgid "Enable verbose messages from underlying libguestfs."
26759 #: ../fuse/guestmount.pod:216
26760 msgid "B<-V> | B<--version>"
26764 #: ../fuse/guestmount.pod:218
26765 msgid "Display the program version and exit."
26769 #: ../fuse/guestmount.pod:220
26770 msgid "B<-w> | B<--rw>"
26774 #: ../fuse/guestmount.pod:222
26776 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26777 "FOR READ AND WRITE>."
26781 #: ../fuse/guestmount.pod:225
26782 msgid "B<-x> | B<--trace>"
26786 #: ../fuse/guestmount.pod:227
26787 msgid "Trace libguestfs calls and entry into each FUSE function."
26791 #: ../fuse/guestmount.pod:229
26792 msgid "This also stops the daemon from forking into the background."
26796 #: ../fuse/guestmount.pod:235
26798 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26799 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
26800 "L<http://fuse.sf.net/>."
26804 #: ../tools/virt-edit.pl:34
26805 msgid "virt-edit - Edit a file in a virtual machine"
26809 #: ../tools/virt-edit.pl:38
26812 " virt-edit [--options] domname file\n"
26817 #: ../tools/virt-edit.pl:40
26820 " virt-edit [--options] disk.img [disk.img ...] file\n"
26825 #: ../tools/virt-edit.pl:42
26828 " virt-edit [domname|disk.img] file -e 'expr'\n"
26833 #: ../tools/virt-edit.pl:46
26835 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26836 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26837 "doing this, but doesn't catch all cases."
26841 #: ../tools/virt-edit.pl:52
26843 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26844 "the named virtual machine (or disk image)."
26848 #: ../tools/virt-edit.pl:55
26850 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
26851 "you should look at the L<guestfish(1)> tool."
26855 #: ../tools/virt-edit.pl:60
26856 msgid "Edit the named files interactively:"
26860 #: ../tools/virt-edit.pl:62
26863 " virt-edit mydomain /boot/grub/grub.conf\n"
26868 #: ../tools/virt-edit.pl:64
26871 " virt-edit mydomain /etc/passwd\n"
26876 #: ../tools/virt-edit.pl:66
26878 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26879 "below). To change the init default level to 5:"
26883 #: ../tools/virt-edit.pl:70
26886 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26891 #: ../tools/virt-edit.pl:82 ../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
26892 msgid "Display brief help."
26896 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:114 ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
26897 msgid "Display version number and exit."
26901 #: ../tools/virt-edit.pl:96
26902 msgid "B<--backup extension> | B<-b extension>"
26906 #: ../tools/virt-edit.pl:98
26908 "Create a backup of the original file I<in the guest disk image>. The backup "
26909 "has the original filename with C<extension> added."
26913 #: ../tools/virt-edit.pl:101
26915 "Usually the first character of C<extension> would be a dot C<.> so you would "
26920 #: ../tools/virt-edit.pl:104
26923 " virt-edit -b .orig [etc]\n"
26928 #: ../tools/virt-edit.pl:106
26929 msgid "By default, no backup file is made."
26933 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
26934 msgid "B<--connect URI> | B<-c URI>"
26938 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
26940 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26941 "to the default libvirt hypervisor."
26945 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
26947 "If you specify guest block devices directly, then libvirt is not used at "
26952 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:140 ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
26953 msgid "B<--format> raw"
26957 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
26959 "Specify the format of disk images given on the command line. If this is "
26960 "omitted then the format is autodetected from the content of the disk image."
26964 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
26966 "If disk images are requested from libvirt, then this program asks libvirt "
26967 "for this information. In this case, the value of the format parameter is "
26972 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:150 ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
26974 "If working with untrusted raw-format guest disk images, you should ensure "
26975 "the format is always specified."
26979 #: ../tools/virt-edit.pl:141
26980 msgid "B<--expr EXPR> | B<-e EXPR>"
26984 #: ../tools/virt-edit.pl:143
26986 "Instead of launching the external editor, non-interactively apply the Perl "
26987 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26992 #: ../tools/virt-edit.pl:147
26994 "Be careful to properly quote the expression to prevent it from being altered "
26999 #: ../tools/virt-edit.pl:268
27000 msgid "NON-INTERACTIVE EDITING"
27004 #: ../tools/virt-edit.pl:270
27006 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
27007 "administrator can interactively edit the file."
27011 #: ../tools/virt-edit.pl:273
27013 "There are two ways also to use C<virt-edit> from scripts in order to make "
27014 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
27015 "like this, it's less error-prone to write scripts directly using the "
27016 "libguestfs API and Augeas for configuration file editing.)"
27020 #: ../tools/virt-edit.pl:279
27022 "The first method is to temporarily set C<$EDITOR> to any script or program "
27023 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
27024 "update C<tmpfile> in place however it likes."
27028 #: ../tools/virt-edit.pl:283
27030 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
27031 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
27032 "instances of C<foo> with C<bar> in a file:"
27036 #: ../tools/virt-edit.pl:287
27039 " virt-edit domname filename -e 's/foo/bar/'\n"
27044 #: ../tools/virt-edit.pl:289
27046 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
27047 "For example to delete root's password you could do:"
27051 #: ../tools/virt-edit.pl:292
27054 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
27059 #: ../tools/virt-edit.pl:294
27061 "What really happens is that the snippet is evaluated as a Perl expression "
27062 "for each line of the file. The line, including the final C<\\n>, is passed "
27063 "in C<$_> and the expression should update C<$_> or leave it unchanged."
27067 #: ../tools/virt-edit.pl:299
27069 "To delete a line, set C<$_> to the empty string. For example, to delete the "
27070 "C<apache> user account from the password file you can do:"
27074 #: ../tools/virt-edit.pl:302
27077 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
27082 #: ../tools/virt-edit.pl:304
27084 "To insert a line, prepend or append it to C<$_>. However appending lines to "
27085 "the end of the file is rather difficult this way since there is no concept "
27086 "of \"last line of the file\" - your expression just doesn't get called "
27087 "again. You might want to use the first method (setting C<$EDITOR>) if you "
27092 #: ../tools/virt-edit.pl:310
27094 "The variable C<$lineno> contains the current line number. As is "
27095 "traditional, the first line in the file is number C<1>."
27099 #: ../tools/virt-edit.pl:313
27101 "The return value from the expression is ignored, but the expression may call "
27102 "C<die> in order to abort the whole program, leaving the original file "
27107 #: ../tools/virt-edit.pl:317
27109 "Remember when matching the end of a line that C<$_> may contain the final "
27110 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
27111 "newline then neither of these. Thus to match or substitute some text at the "
27112 "end of a line, use this regular expression:"
27116 #: ../tools/virt-edit.pl:322
27119 " /some text(\\r?\\n)?$/\n"
27124 #: ../tools/virt-edit.pl:324
27126 "Alternately, use the perl C<chomp> function, being careful not to chomp "
27127 "C<$_> itself (since that would remove all newlines from the file):"
27131 #: ../tools/virt-edit.pl:328
27134 " my $m = $_; chomp $m; $m =~ /some text$/\n"
27139 #: ../tools/virt-edit.pl:334
27144 #: ../tools/virt-edit.pl:336
27146 "If set, this string is used as the editor. It may contain arguments, "
27147 "eg. C<\"emacs -nw\">"
27151 #: ../tools/virt-edit.pl:339
27152 msgid "If not set, C<vi> is used."
27156 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559 ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
27157 msgid "SHELL QUOTING"
27161 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567 ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:252
27163 "Libvirt guest names can contain arbitrary characters, some of which have "
27164 "meaning to the shell such as C<#> and space. You may need to quote or "
27165 "escape these characters on the command line. See the shell manual page "
27166 "L<sh(1)> for details."
27170 #: ../tools/virt-edit.pl:352
27172 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
27173 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27174 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
27178 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:598 ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:269
27183 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:600 ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:271
27184 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
27188 #: ../tools/virt-edit.pl:370 ../tools/virt-list-partitions.pl:275
27189 msgid "Copyright (C) 2009-2010 Red Hat Inc."
27193 #: ../tools/virt-win-reg.pl:37
27195 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
27200 #: ../tools/virt-win-reg.pl:41
27203 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
27208 #: ../tools/virt-win-reg.pl:43
27211 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
27216 #: ../tools/virt-win-reg.pl:45
27219 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
27224 #: ../tools/virt-win-reg.pl:47
27227 " virt-win-reg --merge domname [input.reg ...]\n"
27232 #: ../tools/virt-win-reg.pl:49
27235 " virt-win-reg [--options] disk.img ... # instead of domname\n"
27240 #: ../tools/virt-win-reg.pl:53
27242 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
27243 "virtual machines. If you do this, you I<will> get irreversible disk "
27244 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
27245 "but doesn't catch all cases."
27249 #: ../tools/virt-win-reg.pl:58
27251 "Modifying the Windows Registry is an inherently risky operation. The format "
27252 "is deliberately obscure and undocumented, and Registry changes can leave the "
27253 "system unbootable. Therefore when using the C<--merge> option, make sure "
27254 "you have a reliable backup first."
27258 #: ../tools/virt-win-reg.pl:65
27260 "This program can export and merge Windows Registry entries from a Windows "
27265 #: ../tools/virt-win-reg.pl:68
27267 "The first parameter is the libvirt guest name or the raw disk image of a "
27272 #: ../tools/virt-win-reg.pl:71
27274 "If C<--merge> is I<not> specified, then the chosen registry key is "
27275 "displayed/exported (recursively). For example:"
27279 #: ../tools/virt-win-reg.pl:74
27282 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
27287 #: ../tools/virt-win-reg.pl:76
27288 msgid "You can also display single values from within registry keys, for example:"
27292 #: ../tools/virt-win-reg.pl:79
27295 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
27296 " $ virt-win-reg Windows7 $cvkey ProductName\n"
27297 " Windows 7 Enterprise\n"
27302 #: ../tools/virt-win-reg.pl:83
27304 "With C<--merge>, you can merge a textual regedit file into the Windows "
27309 #: ../tools/virt-win-reg.pl:86
27312 " $ virt-win-reg --merge Windows7 changes.reg\n"
27317 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
27322 #: ../tools/virt-win-reg.pl:90
27324 "This program is only meant for simple access to the registry. If you want "
27325 "to do complicated things with the registry, we suggest you download the "
27326 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27327 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27328 "L<hivexregedit(1)>."
27332 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
27337 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
27338 msgid "Enable debugging messages."
27342 #: ../tools/virt-win-reg.pl:157
27347 #: ../tools/virt-win-reg.pl:159
27349 "In merge mode, this merges a textual regedit file into the Windows Registry "
27350 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27351 "displays or exports Registry entries instead."
27355 #: ../tools/virt-win-reg.pl:163
27357 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27358 "result in disk corruption. However exporting (without this flag) is always "
27363 #: ../tools/virt-win-reg.pl:171
27364 msgid "B<--encoding> UTF-16LE|ASCII"
27368 #: ../tools/virt-win-reg.pl:173
27370 "When merging (only), you may need to specify the encoding for strings to be "
27371 "used in the hive file. This is explained in detail in "
27372 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
27376 #: ../tools/virt-win-reg.pl:177
27378 "The default is to use UTF-16LE, which should work with recent versions of "
27383 #: ../tools/virt-win-reg.pl:402
27384 msgid "SUPPORTED SYSTEMS"
27388 #: ../tools/virt-win-reg.pl:404
27390 "The program currently supports Windows NT-derived guests starting with "
27391 "Windows XP through to at least Windows 7."
27395 #: ../tools/virt-win-reg.pl:407
27397 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
27398 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
27399 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
27403 #: ../tools/virt-win-reg.pl:411
27405 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
27410 #: ../tools/virt-win-reg.pl:414
27412 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
27417 #: ../tools/virt-win-reg.pl:417
27422 #: ../tools/virt-win-reg.pl:419
27424 "C<virt-win-reg> expects that regedit files have already been reencoded in "
27425 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
27426 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
27427 "with Windows-style line endings, you may need to reencode the whole file "
27428 "before or after processing."
27432 #: ../tools/virt-win-reg.pl:425
27434 "To reencode a file from Windows format to Linux (before processing it with "
27435 "the C<--merge> option), you would do something like this:"
27439 #: ../tools/virt-win-reg.pl:428
27442 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
27447 #: ../tools/virt-win-reg.pl:430
27449 "To go in the opposite direction, after exporting and before sending the file "
27450 "to a Windows user, do something like this:"
27454 #: ../tools/virt-win-reg.pl:433
27457 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
27462 #: ../tools/virt-win-reg.pl:435
27463 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
27467 #: ../tools/virt-win-reg.pl:437
27469 "If you are unsure about the current encoding, use the L<file(1)> command. "
27470 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
27471 "Windows-style (CRLF) line endings, like this:"
27475 #: ../tools/virt-win-reg.pl:441
27478 " $ file software.reg\n"
27479 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
27480 " with CRLF line terminators\n"
27485 #: ../tools/virt-win-reg.pl:445
27486 msgid "This file would need conversion before you could C<--merge> it."
27490 #: ../tools/virt-win-reg.pl:447
27491 msgid "CurrentControlSet etc."
27495 #: ../tools/virt-win-reg.pl:449
27497 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
27498 "Registry at the level of the hive file, and therefore you cannot modify "
27503 #: ../tools/virt-win-reg.pl:453
27505 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
27506 "circumstances it might refer to another control set. The way to find out is "
27507 "to look at the C<HKLM\\SYSTEM\\Select> key:"
27511 #: ../tools/virt-win-reg.pl:457
27514 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
27515 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
27516 " \"Current\"=dword:00000001\n"
27517 " \"Default\"=dword:00000001\n"
27518 " \"Failed\"=dword:00000000\n"
27519 " \"LastKnownGood\"=dword:00000002\n"
27524 #: ../tools/virt-win-reg.pl:464
27525 msgid "\"Current\" is the one which Windows will choose when it boots."
27529 #: ../tools/virt-win-reg.pl:466
27530 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
27534 #: ../tools/virt-win-reg.pl:469
27535 msgid "WINDOWS TIPS"
27539 #: ../tools/virt-win-reg.pl:471
27541 "Note that some of these tips modify the guest disk image. The guest I<must> "
27542 "be shut off, else you will get disk corruption."
27546 #: ../tools/virt-win-reg.pl:474
27547 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
27551 #: ../tools/virt-win-reg.pl:476
27553 "Prepare a DOS batch script, VBScript or executable. Upload this using "
27554 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
27555 "is uploaded into C<C:\\>:"
27559 #: ../tools/virt-win-reg.pl:480
27562 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
27567 #: ../tools/virt-win-reg.pl:482
27568 msgid "Prepare a regedit file containing the registry change:"
27572 #: ../tools/virt-win-reg.pl:484
27575 " cat > test.reg <<'EOF'\n"
27576 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
27577 " \"Test\"=\"c:\\\\test.bat\"\n"
27583 #: ../tools/virt-win-reg.pl:489
27585 "In this example we use the key C<RunOnce> which means that the script will "
27586 "run precisely once when the first user logs in. If you want it to run every "
27587 "time a user logs in, replace C<RunOnce> with C<Run>."
27591 #: ../tools/virt-win-reg.pl:493
27592 msgid "Now update the registry:"
27596 #: ../tools/virt-win-reg.pl:495
27599 " virt-win-reg --merge WindowsGuest test.reg\n"
27604 #: ../tools/virt-win-reg.pl:497
27605 msgid "INSTALLING A SERVICE"
27609 #: ../tools/virt-win-reg.pl:499
27611 "This section assumes you are familiar with Windows services, and you either "
27612 "have a program which handles the Windows Service Control Protocol directly "
27613 "or you want to run any program using a service wrapper like SrvAny or the "
27618 #: ../tools/virt-win-reg.pl:504
27620 "First upload the program and optionally the service wrapper. In this case "
27621 "the test program is called C<test.exe> and we are using the RHSrvAny "
27626 #: ../tools/virt-win-reg.pl:508
27629 " guestfish -i -d WindowsGuest <<EOF\n"
27630 " upload rhsrvany.exe /rhsrvany.exe\n"
27631 " upload test.exe /test.exe\n"
27637 #: ../tools/virt-win-reg.pl:513
27639 "Prepare a regedit file containing the registry changes. In this example, "
27640 "the first registry change is needed for the service itself or the service "
27641 "wrapper (if used). The second registry change is only needed because I am "
27642 "using the RHSrvAny service wrapper."
27646 #: ../tools/virt-win-reg.pl:518
27649 " cat > service.reg <<'EOF'\n"
27650 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
27651 " \"Type\"=dword:00000010\n"
27652 " \"Start\"=dword:00000002\n"
27653 " \"ErrorControl\"=dword:00000001\n"
27654 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
27655 " \"DisplayName\"=\"RHSrvAny\"\n"
27656 " \"ObjectName\"=\"NetworkService\"\n"
27661 #: ../tools/virt-win-reg.pl:527
27664 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
27665 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
27666 " \"PWD\"=\"c:\\\\Temp\"\n"
27672 #: ../tools/virt-win-reg.pl:538
27674 "For use of C<ControlSet001> see the section above in this manual page. You "
27675 "may need to adjust this according to the control set that is in use by the "
27680 #: ../tools/virt-win-reg.pl:544
27682 "C<\"ObjectName\"> controls the privileges that the service will have. An "
27683 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
27684 "privileged account."
27688 #: ../tools/virt-win-reg.pl:550
27690 "For the meaning of the magic numbers, see this Microsoft KB article: "
27691 "L<http://support.microsoft.com/kb/103000>."
27695 #: ../tools/virt-win-reg.pl:555
27696 msgid "Update the registry:"
27700 #: ../tools/virt-win-reg.pl:557
27703 " virt-win-reg --merge WindowsGuest service.reg\n"
27708 #: ../tools/virt-win-reg.pl:561
27710 "Be careful when passing parameters containing C<\\> (backslash) in the "
27711 "shell. Usually you will have to use 'single quotes' or double backslashes "
27712 "(but not both) to protect them from the shell."
27716 #: ../tools/virt-win-reg.pl:565
27717 msgid "Paths and value names are case-insensitive."
27721 #: ../tools/virt-win-reg.pl:574
27723 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
27724 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27725 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
27726 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27730 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:550
27732 "When reporting bugs, please enable debugging and capture the I<complete> "
27737 #: ../tools/virt-win-reg.pl:592
27740 " export LIBGUESTFS_DEBUG=1\n"
27741 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
27746 #: ../tools/virt-win-reg.pl:595
27748 "Attach /tmp/virt-win-reg.log to a new bug report at "
27749 "L<https://bugzilla.redhat.com/>"
27753 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:565
27754 msgid "Copyright (C) 2010 Red Hat Inc."
27758 #: ../tools/virt-resize.pl:42
27759 msgid "virt-resize - Resize a virtual machine disk"
27763 #: ../tools/virt-resize.pl:46
27766 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27767 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27768 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27773 #: ../tools/virt-resize.pl:52
27775 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27776 "larger or smaller overall, and resizing or deleting any partitions contained "
27781 #: ../tools/virt-resize.pl:56
27783 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27784 "not> be used on live virtual machines - for consistent results, shut the "
27785 "virtual machine down before resizing it."
27789 #: ../tools/virt-resize.pl:60
27791 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
27792 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
27796 #: ../tools/virt-resize.pl:66
27798 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27799 "fill the extra 5GB of space."
27803 #: ../tools/virt-resize.pl:69
27806 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27807 " virt-filesystems --long -h --all -a olddisk\n"
27808 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27809 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27814 #: ../tools/virt-resize.pl:74
27816 "As above, but make the /boot partition 200MB bigger, while giving the "
27817 "remaining space to /dev/sda2:"
27821 #: ../tools/virt-resize.pl:77
27824 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
27829 #: ../tools/virt-resize.pl:79
27830 msgid "As above, but the output format will be uncompressed qcow2:"
27834 #: ../tools/virt-resize.pl:81
27837 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
27838 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
27843 #: ../tools/virt-resize.pl:84
27844 msgid "DETAILED USAGE"
27848 #: ../tools/virt-resize.pl:86
27849 msgid "EXPANDING A VIRTUAL MACHINE DISK"
27853 #: ../tools/virt-resize.pl:90
27854 msgid "1. Shut down the virtual machine"
27858 #: ../tools/virt-resize.pl:92
27859 msgid "2. Locate input disk image"
27863 #: ../tools/virt-resize.pl:94
27865 "Locate the input disk image (ie. the file or device on the host containing "
27866 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27867 "dumpxml> like this to find the disk image name:"
27871 #: ../tools/virt-resize.pl:98
27874 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27875 " Found 1 nodes:\n"
27877 " <source dev=\"/dev/vg/lv_guest\" />\n"
27882 #: ../tools/virt-resize.pl:103
27883 msgid "3. Look at current sizing"
27887 #: ../tools/virt-resize.pl:105
27888 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
27892 #: ../tools/virt-resize.pl:108
27895 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
27896 " Name Type Size Parent\n"
27897 " /dev/sda1 partition 101M /dev/sda\n"
27898 " /dev/sda2 partition 7.9G /dev/sda\n"
27899 " /dev/sda device 8.0G -\n"
27904 #: ../tools/virt-resize.pl:114
27906 "(This example is a virtual machine with an 8 GB disk which we would like to "
27907 "expand up to 10 GB)."
27911 #: ../tools/virt-resize.pl:117
27912 msgid "4. Create output disk"
27916 #: ../tools/virt-resize.pl:119
27918 "Virt-resize cannot do in-place disk modifications. You have to have space "
27919 "to store the resized output disk."
27923 #: ../tools/virt-resize.pl:122
27924 msgid "To store the resized disk image in a file, create a file of a suitable size:"
27928 #: ../tools/virt-resize.pl:125
27931 " # rm -f outdisk\n"
27932 " # truncate -s 10G outdisk\n"
27937 #: ../tools/virt-resize.pl:128
27938 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27942 #: ../tools/virt-resize.pl:130
27945 " # lvcreate -L 10G -n lv_name vg_name\n"
27950 #: ../tools/virt-resize.pl:132
27951 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27955 #: ../tools/virt-resize.pl:134
27958 " # virsh pool-list\n"
27959 " # virsh vol-create-as poolname newvol 10G\n"
27964 #: ../tools/virt-resize.pl:137
27969 #: ../tools/virt-resize.pl:139
27971 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27972 "file) and the output disk. The output disk is the one created in the "
27977 #: ../tools/virt-resize.pl:143
27980 " # virt-resize indisk outdisk\n"
27985 #: ../tools/virt-resize.pl:145
27987 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27988 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27989 "larger, then an extra, empty partition is created at the end of the disk "
27990 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27995 #: ../tools/virt-resize.pl:151
27997 "More realistically you'd want to expand existing partitions in the disk "
27998 "image by passing extra options (for the full list see the L</OPTIONS> "
28003 #: ../tools/virt-resize.pl:155
28005 "L</--expand> is the most useful option. It expands the named partition "
28006 "within the disk to fill any extra space:"
28010 #: ../tools/virt-resize.pl:158
28013 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
28018 #: ../tools/virt-resize.pl:160
28020 "(In this case, an extra partition is I<not> created at the end of the disk, "
28021 "because there will be no unused space)."
28025 #: ../tools/virt-resize.pl:163
28027 "L</--resize> is the other commonly used option. The following would "
28028 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
28029 "rest of the available space:"
28033 #: ../tools/virt-resize.pl:167
28036 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
28037 " indisk outdisk\n"
28042 #: ../tools/virt-resize.pl:170
28044 "If the expanded partition in the image contains a filesystem or LVM PV, then "
28045 "if virt-resize knows how, it will resize the contents, the equivalent of "
28046 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
28047 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
28048 "filesystems, so you would have to online resize them after booting the "
28053 #: ../tools/virt-resize.pl:177
28054 msgid "Other options are covered below."
28058 #: ../tools/virt-resize.pl:179
28063 #: ../tools/virt-resize.pl:181
28064 msgid "Thoroughly test the new disk image I<before> discarding the old one."
28068 #: ../tools/virt-resize.pl:183
28069 msgid "If you are using libvirt, edit the XML to point at the new disk:"
28073 #: ../tools/virt-resize.pl:185
28076 " # virsh edit guestname\n"
28081 #: ../tools/virt-resize.pl:187
28083 "Change E<lt>source ...E<gt>, see "
28084 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
28088 #: ../tools/virt-resize.pl:190
28089 msgid "Then start up the domain with the new, resized disk:"
28093 #: ../tools/virt-resize.pl:192
28096 " # virsh start guestname\n"
28101 #: ../tools/virt-resize.pl:194
28103 "and check that it still works. See also the L</NOTES> section below for "
28104 "additional information."
28108 #: ../tools/virt-resize.pl:197
28109 msgid "7. Resize LVs etc inside the guest"
28113 #: ../tools/virt-resize.pl:199
28114 msgid "(This can also be done offline using L<guestfish(1)>)"
28118 #: ../tools/virt-resize.pl:201
28120 "Once the guest has booted you should see the new space available, at least "
28121 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
28122 "may need to resize LVs inside PVs, and also resize filesystem types that "
28123 "virt-resize does not know how to expand."
28127 #: ../tools/virt-resize.pl:208
28128 msgid "SHRINKING A VIRTUAL MACHINE DISK"
28132 #: ../tools/virt-resize.pl:210
28134 "Shrinking is somewhat more complex than expanding, and only an overview is "
28139 #: ../tools/virt-resize.pl:213
28141 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
28142 "filesystems). The user has to shrink content before passing the disk image "
28143 "to virt-resize, and virt-resize will check that the content has been shrunk "
28148 #: ../tools/virt-resize.pl:218
28149 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28153 #: ../tools/virt-resize.pl:220
28155 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28156 "steps 3 and 4 above to allocate a new disk image."
28160 #: ../tools/virt-resize.pl:223
28161 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28165 #: ../tools/virt-resize.pl:226
28166 msgid "IGNORING OR DELETING PARTITIONS"
28170 #: ../tools/virt-resize.pl:228
28172 "virt-resize also gives a convenient way to ignore or delete partitions when "
28173 "copying from the input disk to the output disk. Ignoring a partition speeds "
28174 "up the copy where you don't care about the existing contents of a "
28175 "partition. Deleting a partition removes it completely, but note that it "
28176 "also renumbers any partitions after the one which is deleted, which can "
28177 "leave some guests unbootable."
28181 #: ../tools/virt-resize.pl:235
28182 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28186 #: ../tools/virt-resize.pl:237
28188 "If the input disk is in qcow2 format, then you may prefer that the output is "
28189 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28190 "the fly. The output format is simply determined by the format of the empty "
28191 "output container that you provide. Thus to create qcow2 output, use:"
28195 #: ../tools/virt-resize.pl:243
28198 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28203 #: ../tools/virt-resize.pl:245
28204 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28208 #: ../tools/virt-resize.pl:247
28209 msgid "Similarly, to get non-sparse raw output use:"
28213 #: ../tools/virt-resize.pl:249
28216 " fallocate -l size outdisk\n"
28221 #: ../tools/virt-resize.pl:251
28223 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
28224 "if=/dev/zero of=outdisk bs=1M count=..>)"
28228 #: ../tools/virt-resize.pl:264
28229 msgid "Display help."
28233 #: ../tools/virt-resize.pl:278
28234 msgid "B<--resize part=size>"
28238 #: ../tools/virt-resize.pl:280
28240 "Resize the named partition (expanding or shrinking it) so that it has the "
28245 #: ../tools/virt-resize.pl:283
28247 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28248 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28249 "Exabytes; or as a percentage of the current size; or as a relative number or "
28250 "percentage. For example:"
28254 #: ../tools/virt-resize.pl:288
28257 " --resize /dev/sda2=10G\n"
28262 #: ../tools/virt-resize.pl:290
28265 " --resize /dev/sda4=90%\n"
28270 #: ../tools/virt-resize.pl:292
28273 " --resize /dev/sda2=+1G\n"
28278 #: ../tools/virt-resize.pl:294
28281 " --resize /dev/sda2=-200M\n"
28286 #: ../tools/virt-resize.pl:296
28289 " --resize /dev/sda1=+128K\n"
28294 #: ../tools/virt-resize.pl:298
28297 " --resize /dev/sda1=+10%\n"
28302 #: ../tools/virt-resize.pl:300
28305 " --resize /dev/sda1=-10%\n"
28310 #: ../tools/virt-resize.pl:302
28312 "You can increase the size of any partition. Virt-resize will expand the "
28313 "direct content of the partition if it knows how (see C<--expand> below)."
28317 #: ../tools/virt-resize.pl:306
28319 "You can only I<decrease> the size of partitions that contain filesystems or "
28320 "PVs which have already been shrunk. Virt-resize will check this has been "
28321 "done before proceeding, or else will print an error (see also "
28322 "C<--resize-force>)."
28326 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
28327 msgid "You can give this option multiple times."
28331 #: ../tools/virt-resize.pl:317
28332 msgid "B<--resize-force part=size>"
28336 #: ../tools/virt-resize.pl:319
28338 "This is the same as C<--resize> except that it will let you decrease the "
28339 "size of any partition. Generally this means you will lose any data which "
28340 "was at the end of the partition you shrink, but you may not care about that "
28341 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28342 "as a swap partition)."
28346 #: ../tools/virt-resize.pl:325
28347 msgid "See also the C<--ignore> option."
28351 #: ../tools/virt-resize.pl:331
28352 msgid "B<--expand part>"
28356 #: ../tools/virt-resize.pl:333
28358 "Expand the named partition so it uses up all extra space (space left over "
28359 "after any other resize changes that you request have been done)."
28363 #: ../tools/virt-resize.pl:336
28365 "If virt-resize knows how, it will expand the direct content of the "
28366 "partition. For example, if the partition is an LVM PV, it will expand the "
28367 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28368 "content it doesn't know about alone."
28372 #: ../tools/virt-resize.pl:341
28373 msgid "Currently virt-resize can resize:"
28377 #: ../tools/virt-resize.pl:347
28379 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28384 #: ../tools/virt-resize.pl:352
28386 "NTFS filesystems contained directly in a partition, if libguestfs was "
28387 "compiled with support for NTFS."
28391 #: ../tools/virt-resize.pl:355
28393 "The filesystem must have been shut down consistently last time it was used. "
28394 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
28395 "consistency check, so at the first boot after resizing Windows will check "
28400 #: ../tools/virt-resize.pl:362
28402 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
28403 "inside the PV, but see the C<--LV-expand> option. The user could also "
28404 "resize LVs as desired after boot."
28408 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
28409 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
28413 #: ../tools/virt-resize.pl:374
28414 msgid "B<--shrink part>"
28418 #: ../tools/virt-resize.pl:376
28420 "Shrink the named partition until the overall disk image fits in the "
28421 "destination. The named partition B<must> contain a filesystem or PV which "
28422 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
28423 "online tools). Virt-resize will check this and give an error if it has not "
28428 #: ../tools/virt-resize.pl:382
28430 "The amount by which the overall disk must be shrunk (after carrying out all "
28431 "other operations requested by the user) is called the \"deficit\". For "
28432 "example, a straight copy (assume no other operations) from a 5GB disk image "
28433 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
28434 "would give an error unless the user specified a partition to shrink and that "
28435 "partition had more than a gigabyte of free space."
28439 #: ../tools/virt-resize.pl:396
28440 msgid "B<--ignore part>"
28444 #: ../tools/virt-resize.pl:398
28446 "Ignore the named partition. Effectively this means the partition is "
28447 "allocated on the destination disk, but the content is not copied across from "
28448 "the source disk. The content of the partition will be blank (all zero "
28453 #: ../tools/virt-resize.pl:409
28454 msgid "B<--delete part>"
28458 #: ../tools/virt-resize.pl:411
28460 "Delete the named partition. It would be more accurate to describe this as "
28461 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
28462 "the original disk image is left intact."
28466 #: ../tools/virt-resize.pl:415
28468 "Note that when you delete a partition, then anything contained in the "
28469 "partition is also deleted. Furthermore, this causes any partitions that "
28470 "come after to be I<renumbered>, which can easily make your guest unbootable."
28474 #: ../tools/virt-resize.pl:426
28475 msgid "B<--LV-expand logvol>"
28479 #: ../tools/virt-resize.pl:428
28481 "This takes the logical volume and, as a final step, expands it to fill all "
28482 "the space available in its volume group. A typical usage, assuming a Linux "
28483 "guest with a single PV C</dev/sda2> and a root device called "
28484 "C</dev/vg_guest/lv_root> would be:"
28488 #: ../tools/virt-resize.pl:433
28491 " virt-resize indisk outdisk \\\n"
28492 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
28497 #: ../tools/virt-resize.pl:436
28499 "This would first expand the partition (and PV), and then expand the root "
28500 "device to fill the extra space in the PV."
28504 #: ../tools/virt-resize.pl:439
28506 "The contents of the LV are also resized if virt-resize knows how to do "
28507 "that. You can stop virt-resize from trying to expand the content by using "
28508 "the option C<--no-expand-content>."
28512 #: ../tools/virt-resize.pl:443
28513 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
28517 #: ../tools/virt-resize.pl:446
28519 "You can give this option multiple times, I<but> it doesn't make sense to do "
28520 "this unless the logical volumes you specify are all in different volume "
28525 #: ../tools/virt-resize.pl:454
28526 msgid "B<--no-copy-boot-loader>"
28530 #: ../tools/virt-resize.pl:456
28532 "By default, virt-resize copies over some sectors at the start of the disk "
28533 "(up to the beginning of the first partition). Commonly these sectors "
28534 "contain the Master Boot Record (MBR) and the boot loader, and are required "
28535 "in order for the guest to boot correctly."
28539 #: ../tools/virt-resize.pl:461
28541 "If you specify this flag, then this initial copy is not done. You may need "
28542 "to reinstall the boot loader in this case."
28546 #: ../tools/virt-resize.pl:469
28547 msgid "B<--no-extra-partition>"
28551 #: ../tools/virt-resize.pl:471
28553 "By default, virt-resize creates an extra partition if there is any extra, "
28554 "unused space after all resizing has happened. Use this option to prevent "
28555 "the extra partition from being created. If you do this then the extra space "
28556 "will be inaccessible until you run fdisk, parted, or some other partitioning "
28557 "tool in the guest."
28561 #: ../tools/virt-resize.pl:477
28563 "Note that if the surplus space is smaller than 10 MB, no extra partition "
28568 #: ../tools/virt-resize.pl:484
28569 msgid "B<--no-expand-content>"
28573 #: ../tools/virt-resize.pl:486
28575 "By default, virt-resize will try to expand the direct contents of "
28576 "partitions, if it knows how (see C<--expand> option above)."
28580 #: ../tools/virt-resize.pl:489
28582 "If you give the C<--no-expand-content> option then virt-resize will not "
28587 #: ../tools/virt-resize.pl:496
28588 msgid "B<-d> | B<--debug>"
28592 #: ../tools/virt-resize.pl:504
28593 msgid "B<-n> | B<--dryrun>"
28597 #: ../tools/virt-resize.pl:506
28598 msgid "Print a summary of what would be done, but don't do anything."
28602 #: ../tools/virt-resize.pl:512
28603 msgid "B<-q> | B<--quiet>"
28607 #: ../tools/virt-resize.pl:514
28608 msgid "Don't print the summary."
28612 #: ../tools/virt-resize.pl:522
28614 "Specify the format of the input disk image. If this flag is not given then "
28615 "it is auto-detected from the image itself."
28619 #: ../tools/virt-resize.pl:528
28621 "Note that this option I<does not> affect the output format. See L</QCOW2 "
28622 "AND NON-SPARSE RAW FORMATS>."
28626 #: ../tools/virt-resize.pl:535
28627 msgid "B<--output-format> raw"
28631 #: ../tools/virt-resize.pl:537
28633 "Specify the format of the output disk image. If this flag is not given then "
28634 "it is auto-detected from the image itself."
28638 #: ../tools/virt-resize.pl:543
28640 "Note that you still need to create the output disk with the right format. "
28641 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28645 #: ../tools/virt-resize.pl:1419
28650 #: ../tools/virt-resize.pl:1421
28651 msgid "\"Partition 1 does not end on cylinder boundary.\""
28655 #: ../tools/virt-resize.pl:1423
28657 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28658 "means the partitions will not be aligned to the ancient CHS geometry. "
28659 "However CHS geometry is meaningless for disks manufactured since the early "
28660 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28661 "cylinders is not required by any modern operating system."
28665 #: ../tools/virt-resize.pl:1430
28666 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28670 #: ../tools/virt-resize.pl:1432
28672 "In Windows Vista and later versions, Microsoft switched to using a separate "
28673 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28674 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28675 "the boot partition. Doing so seems to break the guest completely. However "
28676 "expanding the second partition (ie. C: drive) should work."
28680 #: ../tools/virt-resize.pl:1439
28682 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28683 "NTFS partitions have been expanded. This is just a safety check and (unless "
28684 "it find errors) is nothing to worry about."
28688 #: ../tools/virt-resize.pl:1443
28689 msgid "GUEST BOOT STUCK AT \"GRUB\""
28693 #: ../tools/virt-resize.pl:1445
28695 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28696 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28697 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28698 "although we think is to do with partition alignment."
28702 #: ../tools/virt-resize.pl:1450
28705 " guestfish -i -a newdisk\n"
28706 " ><fs> cat /boot/grub/device.map\n"
28707 " # check the contents of this file are sensible or\n"
28708 " # edit the file if necessary\n"
28709 " ><fs> grub-install / /dev/vda\n"
28715 #: ../tools/virt-resize.pl:1457
28717 "For more flexible guest reconfiguration, including if you need to specify "
28718 "other parameters to grub-install, use L<virt-rescue(1)>."
28722 #: ../tools/virt-resize.pl:1460
28723 msgid "ALTERNATIVE TOOLS"
28727 #: ../tools/virt-resize.pl:1462
28729 "There are several proprietary tools for resizing partitions. We won't "
28730 "mention any here."
28734 #: ../tools/virt-resize.pl:1465
28736 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28737 "operations on disk images. They can resize and move partitions, but I don't "
28738 "think they can do anything with the contents, and they certainly don't "
28743 #: ../tools/virt-resize.pl:1470
28745 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28746 "but at a much lower level. You will probably end up hand-calculating sector "
28747 "offsets, which is something that virt-resize was designed to avoid. If you "
28748 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
28753 #: ../tools/virt-resize.pl:1485
28755 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
28756 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
28757 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
28758 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
28759 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28763 #: ../tools/virt-list-filesystems.pl:32
28764 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28768 #: ../tools/virt-list-filesystems.pl:36
28771 " virt-list-filesystems [--options] domname\n"
28776 #: ../tools/virt-list-filesystems.pl:38
28779 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28784 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
28786 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
28791 #: ../tools/virt-list-filesystems.pl:45
28793 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28794 "are contained in a virtual machine or disk image."
28798 #: ../tools/virt-list-filesystems.pl:49
28800 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28801 "functionality. For more complex cases you should look at the "
28802 "L<guestfish(1)> tool."
28806 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
28807 msgid "B<-l> | B<--long>"
28811 #: ../tools/virt-list-filesystems.pl:108
28813 "With this option, C<virt-list-filesystems> displays the type of each "
28814 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28818 #: ../tools/virt-list-filesystems.pl:115
28819 msgid "B<-a> | B<--all>"
28823 #: ../tools/virt-list-filesystems.pl:117
28825 "Normally we only show mountable filesystems. If this option is given then "
28826 "swap devices are shown too."
28830 #: ../tools/virt-list-filesystems.pl:191
28832 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
28833 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
28834 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28838 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
28839 msgid "Copyright (C) 2009 Red Hat Inc."
28843 #: ../tools/virt-tar.pl:33
28844 msgid "virt-tar - Extract or upload files to a virtual machine"
28848 #: ../tools/virt-tar.pl:37
28851 " virt-tar [--options] -x domname directory tarball\n"
28856 #: ../tools/virt-tar.pl:39
28859 " virt-tar [--options] -u domname tarball directory\n"
28864 #: ../tools/virt-tar.pl:41
28867 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28872 #: ../tools/virt-tar.pl:43
28875 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28880 #: ../tools/virt-tar.pl:47
28882 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
28883 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
28887 #: ../tools/virt-tar.pl:52
28888 msgid "Download C</home> from the VM into a local tarball:"
28892 #: ../tools/virt-tar.pl:54
28895 " virt-tar -x domname /home home.tar\n"
28900 #: ../tools/virt-tar.pl:56
28903 " virt-tar -zx domname /home home.tar.gz\n"
28908 #: ../tools/virt-tar.pl:58
28909 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28913 #: ../tools/virt-tar.pl:60
28916 " virt-tar -u domname uploadstuff.tar /tmp\n"
28921 #: ../tools/virt-tar.pl:62
28924 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28929 #: ../tools/virt-tar.pl:66
28931 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28932 "virtual machines. If you do this, you risk disk corruption in the VM. "
28933 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28937 #: ../tools/virt-tar.pl:71
28939 "You can use C<-x> (extract) on live virtual machines, but you might get "
28940 "inconsistent results or errors if there is filesystem activity inside the "
28941 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28942 "work, but the only way to guarantee consistent results is if the virtual "
28943 "machine is shut down."
28947 #: ../tools/virt-tar.pl:79
28949 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28950 "parts of a guest filesystem. There are many possibilities: making backups, "
28951 "uploading data files, snooping on guest activity, fixing or customizing "
28956 #: ../tools/virt-tar.pl:84
28958 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28959 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28960 "should look at the L<guestfish(1)> tool."
28964 #: ../tools/virt-tar.pl:88
28966 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28967 "its contents (recursively) from the virtual machine into a local tarball. "
28968 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28969 "virtual machine. You cannot use these two options together."
28973 #: ../tools/virt-tar.pl:94
28975 "In addition, you may need to use the C<-z> (gZip) option to enable "
28976 "compression. When uploading, you have to specify C<-z> if the upload file "
28977 "is compressed because virt-tar won't detect this on its own."
28981 #: ../tools/virt-tar.pl:98
28983 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28984 "example it cannot do PKZip files or bzip2 compression. If you want that "
28985 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28986 "the L<libguestfs(3)> API)."
28990 #: ../tools/virt-tar.pl:156
28991 msgid "B<-x> | B<--extract> | B<--download>"
28995 #: ../tools/virt-tar.pl:158
28996 msgid "B<-u> | B<--upload>"
29000 #: ../tools/virt-tar.pl:160
29002 "Use C<-x> to extract (download) a directory from a virtual machine to a "
29007 #: ../tools/virt-tar.pl:163
29009 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
29010 "Please read the L</WARNING> section above before using this option."
29014 #: ../tools/virt-tar.pl:167
29015 msgid "You must specify exactly one of these options."
29019 #: ../tools/virt-tar.pl:173
29020 msgid "B<-z> | B<--gzip>"
29024 #: ../tools/virt-tar.pl:175
29025 msgid "Specify that the input or output tarball is gzip-compressed."
29029 #: ../tools/virt-tar.pl:288
29031 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29032 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29033 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29034 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29038 #: ../tools/virt-make-fs.pl:37
29039 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29043 #: ../tools/virt-make-fs.pl:41
29046 " virt-make-fs [--options] input.tar output.img\n"
29051 #: ../tools/virt-make-fs.pl:43
29054 " virt-make-fs [--options] input.tar.gz output.img\n"
29059 #: ../tools/virt-make-fs.pl:45
29062 " virt-make-fs [--options] directory output.img\n"
29067 #: ../tools/virt-make-fs.pl:49
29069 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29070 "archive or some files in a directory. It is similar to tools like "
29071 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29072 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29073 "useful if you want to attach these filesystems to existing virtual machines "
29074 "(eg. to import large amounts of read-only data to a VM)."
29078 #: ../tools/virt-make-fs.pl:57
29079 msgid "Basic usage is:"
29083 #: ../tools/virt-make-fs.pl:59
29086 " virt-make-fs input output\n"
29091 #: ../tools/virt-make-fs.pl:61
29093 "where C<input> is either a directory containing files that you want to add, "
29094 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29095 "C<output> is a disk image. The input type is detected automatically. The "
29096 "output disk image defaults to a raw ext2 image unless you specify extra "
29097 "flags (see L</OPTIONS> below)."
29101 #: ../tools/virt-make-fs.pl:67
29102 msgid "EXTRA SPACE"
29106 #: ../tools/virt-make-fs.pl:69
29108 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29109 "the files that it contains, but might have extra space. Depending on how "
29110 "you are going to use the output, you might think this extra space is wasted "
29111 "and want to minimize it, or you might want to leave space so that more files "
29112 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29113 "but you can use the C<--size> flag to leave space in the filesystem if you "
29118 #: ../tools/virt-make-fs.pl:77
29120 "An alternative way to leave extra space but not make the output image any "
29121 "bigger is to use an alternative disk image format (instead of the default "
29122 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29123 "image format (check your hypervisor supports this before using it). This "
29124 "allows you to choose a large C<--size> but the extra space won't actually be "
29125 "allocated in the image until you try to store something in it."
29129 #: ../tools/virt-make-fs.pl:85
29131 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29132 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
29133 "virt-make-resize to build another image from scratch."
29137 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29142 #: ../tools/virt-make-fs.pl:91
29145 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29150 #: ../tools/virt-make-fs.pl:93
29151 msgid "FILESYSTEM TYPE"
29155 #: ../tools/virt-make-fs.pl:95
29157 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29158 "libguestfs supports can be used (but I<not> read-only formats like "
29159 "ISO9660). Here are some of the more common choices:"
29163 #: ../tools/virt-make-fs.pl:101
29168 #: ../tools/virt-make-fs.pl:103
29170 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29171 "you are not going to use the filesystem in a way that requires the journal, "
29172 "then this is just wasted overhead."
29176 #: ../tools/virt-make-fs.pl:107
29177 msgid "I<ntfs> or I<vfat>"
29181 #: ../tools/virt-make-fs.pl:109
29182 msgid "Useful if exporting data to a Windows guest."
29186 #: ../tools/virt-make-fs.pl:111
29188 "I<Note for vfat>: The tar archive or local directory must only contain files "
29189 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29190 "program running within libguestfs is unable to change the ownership of "
29191 "non-root files, since vfat itself does not support this."
29195 #: ../tools/virt-make-fs.pl:116
29200 #: ../tools/virt-make-fs.pl:118
29202 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29203 "total filesystem size."
29207 #: ../tools/virt-make-fs.pl:125
29210 " virt-make-fs --type=minix input minixfs.img\n"
29215 #: ../tools/virt-make-fs.pl:127
29216 msgid "TO PARTITION OR NOT TO PARTITION"
29220 #: ../tools/virt-make-fs.pl:129
29221 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29225 #: ../tools/virt-make-fs.pl:131
29227 "Adding a partition can make the disk image more compatible with certain "
29228 "virtualized operating systems which don't expect to see a filesystem "
29229 "directly located on a block device (Linux doesn't care and will happily "
29230 "handle both types)."
29234 #: ../tools/virt-make-fs.pl:136
29236 "On the other hand, if you have a partition table then the output image is no "
29237 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29238 "directly on a partitioned disk image. (However libguestfs tools such as "
29239 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29243 #: ../tools/virt-make-fs.pl:144
29244 msgid "Add an MBR partition:"
29248 #: ../tools/virt-make-fs.pl:146
29251 " virt-make-fs --partition -- input disk.img\n"
29256 #: ../tools/virt-make-fs.pl:148
29258 "If the output disk image could be terabyte-sized or larger, it's better to "
29259 "use an EFI/GPT-compatible partition table:"
29263 #: ../tools/virt-make-fs.pl:151
29266 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29271 #: ../tools/virt-make-fs.pl:179
29272 msgid "Enable debugging information."
29276 #: ../tools/virt-make-fs.pl:185
29277 msgid "B<--size=E<lt>NE<gt>>"
29281 #: ../tools/virt-make-fs.pl:187
29282 msgid "B<--size=+E<lt>NE<gt>>"
29286 #: ../tools/virt-make-fs.pl:189
29287 msgid "B<-s E<lt>NE<gt>>"
29291 #: ../tools/virt-make-fs.pl:191
29292 msgid "B<-s +E<lt>NE<gt>>"
29296 #: ../tools/virt-make-fs.pl:193
29297 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29301 #: ../tools/virt-make-fs.pl:196
29303 "If this option is I<not> given, then the output image will be just large "
29304 "enough to contain all the files, with not much wasted space."
29308 #: ../tools/virt-make-fs.pl:199
29310 "To choose a fixed size output disk, specify an absolute number followed by "
29311 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29312 "Petabytes or Exabytes. This must be large enough to contain all the input "
29313 "files, else you will get an error."
29317 #: ../tools/virt-make-fs.pl:204
29319 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29320 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29321 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29322 "the input files, and (approximately) an extra 200 MB free space."
29326 #: ../tools/virt-make-fs.pl:210
29328 "Note that virt-make-fs estimates free space, and therefore will not produce "
29329 "filesystems containing precisely the free space requested. (It is much more "
29330 "expensive and time-consuming to produce a filesystem which has precisely the "
29331 "desired free space)."
29335 #: ../tools/virt-make-fs.pl:219
29336 msgid "B<--format=E<lt>fmtE<gt>>"
29340 #: ../tools/virt-make-fs.pl:221
29341 msgid "B<-F E<lt>fmtE<gt>>"
29345 #: ../tools/virt-make-fs.pl:223
29346 msgid "Choose the output disk image format."
29350 #: ../tools/virt-make-fs.pl:225
29351 msgid "The default is C<raw> (raw disk image)."
29355 #: ../tools/virt-make-fs.pl:227
29357 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29358 "that would really make sense here is C<qcow2>."
29362 #: ../tools/virt-make-fs.pl:234
29363 msgid "B<--type=E<lt>fsE<gt>>"
29367 #: ../tools/virt-make-fs.pl:236
29368 msgid "B<-t E<lt>fsE<gt>>"
29372 #: ../tools/virt-make-fs.pl:238
29373 msgid "Choose the output filesystem type."
29377 #: ../tools/virt-make-fs.pl:240
29378 msgid "The default is C<ext2>."
29382 #: ../tools/virt-make-fs.pl:242
29383 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29387 #: ../tools/virt-make-fs.pl:249
29388 msgid "B<--partition>"
29392 #: ../tools/virt-make-fs.pl:251
29393 msgid "B<--partition=E<lt>parttypeE<gt>>"
29397 #: ../tools/virt-make-fs.pl:253
29399 "If specified, this flag adds an MBR partition table to the output disk "
29404 #: ../tools/virt-make-fs.pl:256
29406 "You can change the partition table type, eg. C<--partition=gpt> for large "
29411 #: ../tools/virt-make-fs.pl:259
29413 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29414 "might consider the next parameter to be the partition type. For example:"
29418 #: ../tools/virt-make-fs.pl:263
29421 " virt-make-fs --partition input.tar ...\n"
29426 #: ../tools/virt-make-fs.pl:265
29428 "would cause virt-make-fs to think you wanted to use a partition type of "
29429 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29430 "dash) between options and the input file argument:"
29434 #: ../tools/virt-make-fs.pl:269
29437 " virt-make-fs --partition -- input.tar ...\n"
29442 #: ../tools/virt-make-fs.pl:536
29444 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
29445 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29446 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29450 #: ../tools/virt-make-fs.pl:553
29453 " export LIBGUESTFS_DEBUG=1\n"
29454 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29459 #: ../tools/virt-make-fs.pl:556
29461 "Attach /tmp/virt-make-fs.log to a new bug report at "
29462 "L<https://bugzilla.redhat.com/>"
29466 #: ../tools/virt-list-partitions.pl:32
29467 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29471 #: ../tools/virt-list-partitions.pl:36
29474 " virt-list-partitions [--options] domname\n"
29479 #: ../tools/virt-list-partitions.pl:38
29482 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29487 #: ../tools/virt-list-partitions.pl:45
29489 "C<virt-list-partitions> is a command line tool to list the partitions that "
29490 "are contained in a virtual machine or disk image. It is mainly useful as a "
29491 "first step to using L<virt-resize(1)>."
29495 #: ../tools/virt-list-partitions.pl:50
29497 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29498 "functionality. For more complex cases you should look at the "
29499 "L<guestfish(1)> tool."
29503 #: ../tools/virt-list-partitions.pl:107
29504 msgid "B<-h> | B<--human-readable>"
29508 #: ../tools/virt-list-partitions.pl:109
29509 msgid "Show sizes in human-readable form (eg. \"1G\")."
29513 #: ../tools/virt-list-partitions.pl:117
29515 "With this option, C<virt-list-partitions> displays the type and size of each "
29516 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29520 #: ../tools/virt-list-partitions.pl:124
29521 msgid "B<-t> | B<--total>"
29525 #: ../tools/virt-list-partitions.pl:126
29526 msgid "Display the total size of each block device (as a separate row or rows)."
29530 #: ../tools/virt-list-partitions.pl:259
29532 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29533 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29534 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."