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.10\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-03-08 16:20+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:1088 ../src/guestfs.pod:1092 ../src/guestfs.pod:1096 ../src/guestfs.pod:1101 ../src/guestfs.pod:1109 ../src/guestfs.pod:1128 ../src/guestfs.pod:1136 ../src/guestfs.pod:1158 ../src/guestfs.pod:1162 ../src/guestfs.pod:1166 ../src/guestfs.pod:1170 ../src/guestfs.pod:1174 ../src/guestfs.pod:1178 ../src/guestfs.pod:1660 ../src/guestfs.pod:1665 ../src/guestfs.pod:1669 ../src/guestfs.pod:1779 ../src/guestfs.pod:1784 ../src/guestfs.pod:1788 ../src/guestfs.pod:2140 ../src/guestfs.pod:2146 ../src/guestfs.pod:2151 ../src/guestfs.pod:2157 ../src/guestfs.pod:2622 ../src/guestfs.pod:2626 ../src/guestfs.pod:2630 ../src/guestfs.pod:2634 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592 ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1619 ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1637 ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1783 ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:1854 ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1863 ../fish/guestfish.pod:432 ../fish/guestfish.pod:436 ../fish/guestfish.pod:440 ../fish/guestfish.pod:444 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402 ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096 ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110 ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222 ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1273 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1281 ../src/guestfs.pod:1412 ../src/guestfs.pod:2185
941 #: ../src/guestfs.pod:471
942 msgid "Before launching, do:"
946 #: ../src/guestfs.pod:473
949 " guestfs_set_selinux (g, 1);\n"
954 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416 ../src/guestfs.pod:2210
959 #: ../src/guestfs.pod:477
961 "After mounting the guest's filesystem(s), load the policy. This is best "
962 "done by running the L<load_policy(8)> command in the guest itself:"
966 #: ../src/guestfs.pod:481
969 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
974 #: ../src/guestfs.pod:483
976 "(Older versions of C<load_policy> require you to specify the name of the "
981 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1422
986 #: ../src/guestfs.pod:488
988 "Optionally, set the security context for the API. The correct security "
989 "context to use can only be known by inspecting the guest. As an example:"
993 #: ../src/guestfs.pod:492
996 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1001 #: ../src/guestfs.pod:496
1002 msgid "This will work for running commands and editing existing files."
1006 #: ../src/guestfs.pod:498
1008 "When new files are created, you may need to label them explicitly, for "
1009 "example by running the external command C<restorecon pathname>."
1013 #: ../src/guestfs.pod:502
1018 #: ../src/guestfs.pod:504
1020 "Certain calls are affected by the current file mode creation mask (the "
1021 "\"umask\"). In particular ones which create files or directories, such as "
1022 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1023 "either the default mode that the file is created with or modifies the mode "
1028 #: ../src/guestfs.pod:510
1030 "The default umask is C<022>, so files are created with modes such as C<0644> "
1031 "and directories with C<0755>."
1035 #: ../src/guestfs.pod:513
1037 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1038 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
1039 "L</guestfs_chmod> after creating each file or directory."
1043 #: ../src/guestfs.pod:517
1044 msgid "For more information about umask, see L<umask(2)>."
1048 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:751
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems, an install CD or a live CD. (These APIs used to "
1112 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1113 "version 1.5.3 the most frequently used part of this library has been "
1114 "rewritten in C and moved into the core code)."
1118 #: ../src/guestfs.pod:559
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:562
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:571
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:577
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:584
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:588
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:591
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:595
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:599
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:603
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:612
1213 msgid "INSPECTING INSTALL DISKS"
1217 #: ../src/guestfs.pod:614
1219 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1224 #: ../src/guestfs.pod:617
1226 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1227 "system, which currently can be C<installed> (a regular operating system) or "
1228 "C<installer> (some sort of install disk)."
1232 #: ../src/guestfs.pod:621
1234 "Further information is available about the operating system that can be "
1235 "installed using the regular inspection APIs like "
1236 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1241 #: ../src/guestfs.pod:626
1243 "Some additional information specific to installer disks is also available "
1244 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1245 "L</guestfs_inspect_is_multipart> calls."
1249 #: ../src/guestfs.pod:631
1250 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1254 #: ../src/guestfs.pod:633
1256 "Libguestfs can mount NTFS partitions. It does this using the "
1257 "L<http://www.ntfs-3g.org/> driver."
1261 #: ../src/guestfs.pod:636
1262 msgid "DRIVE LETTERS AND PATHS"
1266 #: ../src/guestfs.pod:638
1268 "DOS and Windows still use drive letters, and the filesystems are always "
1269 "treated as case insensitive by Windows itself, and therefore you might find "
1270 "a Windows configuration file referring to a path like "
1271 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1272 "that directory might be referred to as C</WINDOWS/System32>."
1276 #: ../src/guestfs.pod:644
1278 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1279 "libguestfs to read the appropriate Windows Registry and configuration files, "
1280 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1281 "L<virt-inspector(1)>)."
1285 #: ../src/guestfs.pod:649
1287 "Replacing backslash characters with forward slash characters is also outside "
1288 "the scope of libguestfs, but something that you can easily do."
1292 #: ../src/guestfs.pod:652
1294 "Where we can help is in resolving the case insensitivity of paths. For "
1295 "this, call L</guestfs_case_sensitive_path>."
1299 #: ../src/guestfs.pod:655
1300 msgid "ACCESSING THE WINDOWS REGISTRY"
1304 #: ../src/guestfs.pod:657
1306 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1307 "files, through the library C<hivex> which is part of the libguestfs project "
1308 "although ships as a separate tarball. You have to locate and download the "
1309 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1310 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1311 "L<virt-win-reg(1)> for more help on this issue."
1315 #: ../src/guestfs.pod:665
1316 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1320 #: ../src/guestfs.pod:667
1322 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1323 "provide something which looks like a Linux symlink. The way it tries to do "
1324 "the rewriting is described here:"
1328 #: ../src/guestfs.pod:671
1329 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1333 #: ../src/guestfs.pod:673
1335 "The essential problem is that ntfs-3g simply does not have enough "
1336 "information to do a correct job. NTFS links can contain drive letters and "
1337 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1338 "It is almost certainly the case that libguestfs callers should ignore what "
1339 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1343 #: ../src/guestfs.pod:680
1345 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1346 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1347 "attribute, and read the raw reparse data from that (you can find the format "
1348 "documented in various places around the web)."
1352 #: ../src/guestfs.pod:685
1353 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1357 #: ../src/guestfs.pod:687
1359 "There are other useful extended attributes that can be read from ntfs-3g "
1360 "filesystems (using L</guestfs_getxattr>). See:"
1364 #: ../src/guestfs.pod:690
1365 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1369 #: ../src/guestfs.pod:692
1370 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1374 #: ../src/guestfs.pod:694
1376 "Although we don't want to discourage you from using the C API, we will "
1377 "mention here that the same API is also available in other languages."
1381 #: ../src/guestfs.pod:697
1383 "The API is broadly identical in all supported languages. This means that "
1384 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1385 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1386 "OCaml. In other words, a straightforward, predictable isomorphism between "
1391 #: ../src/guestfs.pod:703
1393 "Error messages are automatically transformed into exceptions if the language "
1398 #: ../src/guestfs.pod:706
1400 "We don't try to \"object orientify\" parts of the API in OO languages, "
1401 "although contributors are welcome to write higher level APIs above what we "
1402 "provide in their favourite languages if they wish."
1406 #: ../src/guestfs.pod:712
1411 #: ../src/guestfs.pod:714
1413 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1414 "identical to the C API. C++ classes and exceptions are not used."
1418 #: ../src/guestfs.pod:718
1423 #: ../src/guestfs.pod:720
1425 "The C# bindings are highly experimental. Please read the warnings at the "
1426 "top of C<csharp/Libguestfs.cs>."
1430 #: ../src/guestfs.pod:723
1435 #: ../src/guestfs.pod:725
1437 "This is the only language binding that is working but incomplete. Only "
1438 "calls which return simple integers have been bound in Haskell, and we are "
1439 "looking for help to complete this binding."
1443 #: ../src/guestfs.pod:729
1448 #: ../src/guestfs.pod:731
1450 "Full documentation is contained in the Javadoc which is distributed with "
1455 #: ../src/guestfs.pod:734
1460 #: ../src/guestfs.pod:736
1461 msgid "See L<guestfs-ocaml(3)>."
1465 #: ../src/guestfs.pod:738
1470 #: ../src/guestfs.pod:740
1471 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1475 #: ../src/guestfs.pod:742
1480 #: ../src/guestfs.pod:744
1482 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1483 "the php-libguestfs package for your distribution."
1487 #: ../src/guestfs.pod:747
1488 msgid "The PHP binding only works correctly on 64 bit machines."
1492 #: ../src/guestfs.pod:749
1497 #: ../src/guestfs.pod:751
1498 msgid "See L<guestfs-python(3)>."
1502 #: ../src/guestfs.pod:753
1507 #: ../src/guestfs.pod:755
1508 msgid "See L<guestfs-ruby(3)>."
1512 #: ../src/guestfs.pod:757
1513 msgid "B<shell scripts>"
1517 #: ../src/guestfs.pod:759
1518 msgid "See L<guestfish(1)>."
1522 #: ../src/guestfs.pod:763
1523 msgid "LIBGUESTFS GOTCHAS"
1527 #: ../src/guestfs.pod:765
1529 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1530 "system [...] that works in the way it is documented but is counterintuitive "
1531 "and almost invites mistakes.\""
1535 #: ../src/guestfs.pod:769
1537 "Since we developed libguestfs and the associated tools, there are several "
1538 "things we would have designed differently, but are now stuck with for "
1539 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1540 "release, you can expect these to change. Beware of them."
1544 #: ../src/guestfs.pod:777
1545 msgid "Autosync / forgetting to sync."
1549 #: ../src/guestfs.pod:779
1551 "When modifying a filesystem from C or another language, you B<must> unmount "
1552 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1553 "libguestfs handle. You can also call:"
1557 #: ../src/guestfs.pod:783
1560 " guestfs_set_autosync (g, 1);\n"
1565 #: ../src/guestfs.pod:785
1567 "to have the unmount/sync done automatically for you when the handle 'g' is "
1568 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1573 #: ../src/guestfs.pod:789
1575 "If you forget to do this, then it is entirely possible that your changes "
1576 "won't be written out, or will be partially written, or (very rarely) that "
1577 "you'll get disk corruption."
1581 #: ../src/guestfs.pod:793
1583 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1584 "guestfish scripts that forget to sync will work just fine, which can make "
1585 "this very puzzling if you are trying to debug a problem."
1589 #: ../src/guestfs.pod:797
1591 "Update: Autosync is enabled by default for all API users starting from "
1592 "libguestfs 1.5.24."
1596 #: ../src/guestfs.pod:800
1597 msgid "Mount option C<-o sync> should not be the default."
1601 #: ../src/guestfs.pod:802
1603 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1604 "However C<-o sync> does not add any reliability benefit, but does have a "
1605 "very large performance impact."
1609 #: ../src/guestfs.pod:806
1611 "The work around is to use L</guestfs_mount_options> and set the mount "
1612 "options that you actually want to use."
1616 #: ../src/guestfs.pod:809
1617 msgid "Read-only should be the default."
1621 #: ../src/guestfs.pod:811
1623 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1624 "specify I<--rw> if you want to make changes to the image."
1628 #: ../src/guestfs.pod:814
1629 msgid "This would reduce the potential to corrupt live VM images."
1633 #: ../src/guestfs.pod:816
1635 "Note that many filesystems change the disk when you just mount and unmount, "
1636 "even if you didn't perform any writes. You need to use "
1637 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1641 #: ../src/guestfs.pod:820
1642 msgid "guestfish command line is hard to use."
1646 #: ../src/guestfs.pod:822
1648 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1649 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1650 "exist, so it fails. In earlier versions of guestfish the error message was "
1651 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1652 "we should have used C<guestfish -c command> to run commands."
1656 #: ../src/guestfs.pod:829
1657 msgid "guestfish megabyte modifiers don't work right on all commands"
1661 #: ../src/guestfs.pod:831
1663 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1664 "other modifiers). What guestfish actually does is to multiply the number "
1665 "part by the modifier part and pass the result to the C API. However this "
1666 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1667 "expecting some other unit (eg. megabytes)."
1671 #: ../src/guestfs.pod:838
1672 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1676 #: ../src/guestfs.pod:840
1679 " lvcreate LV VG 100M\n"
1684 #: ../src/guestfs.pod:842
1686 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1687 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1688 "megabytes * megabytes) logical volume. The error message you get from this "
1689 "is also a little obscure."
1693 #: ../src/guestfs.pod:847
1695 "This could be fixed in the generator by specially marking parameters and "
1696 "return values which take bytes or other units."
1700 #: ../src/guestfs.pod:850
1701 msgid "Ambiguity between devices and paths"
1705 #: ../src/guestfs.pod:852
1707 "There is a subtle ambiguity in the API between a device name "
1708 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1709 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1713 #: ../src/guestfs.pod:857
1715 "In the current API we usually resolve this ambiguity by having two separate "
1716 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1717 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1718 "detecting if the path supplied begins with C</dev/>."
1722 #: ../src/guestfs.pod:863
1724 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1725 "make paths/devices into structured names. One way to do this would be to "
1726 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1727 "aspect of grub. Another way would be to use a structured type, equivalent "
1728 "to this OCaml type:"
1732 #: ../src/guestfs.pod:869
1735 " type path = Path of string | Device of int | Partition of int * int\n"
1740 #: ../src/guestfs.pod:871
1741 msgid "which would allow you to pass arguments like:"
1745 #: ../src/guestfs.pod:873
1748 " Path \"/foo/bar\"\n"
1749 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1750 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1751 " Path \"/dev/sdb2\" (* not a device *)\n"
1756 #: ../src/guestfs.pod:878
1758 "As you can see there are still problems to resolve even with this "
1759 "representation. Also consider how it might work in guestfish."
1763 #: ../src/guestfs.pod:883
1764 msgid "PROTOCOL LIMITS"
1768 #: ../src/guestfs.pod:885
1770 "Internally libguestfs uses a message-based protocol to pass API calls and "
1771 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1772 "plenty more detail about this). The maximum message size used by the "
1773 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1774 "aware of this limit. The API calls which may be affected are individually "
1775 "documented, with a link back to this section of the documentation."
1779 #: ../src/guestfs.pod:893
1781 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1782 "a simple string. Because this string is at some point internally encoded as "
1783 "a message, the maximum size that it can return is slightly under 4 MB. If "
1784 "the requested file is larger than this then you will get an error."
1788 #: ../src/guestfs.pod:899
1790 "In order to transfer large files into and out of the guest filesystem, you "
1791 "need to use particular calls that support this. The sections L</UPLOADING> "
1792 "and L</DOWNLOADING> document how to do this."
1796 #: ../src/guestfs.pod:903
1798 "You might also consider mounting the disk image using our FUSE filesystem "
1799 "support (L<guestmount(1)>)."
1803 #: ../src/guestfs.pod:906
1804 msgid "KEYS AND PASSPHRASES"
1808 #: ../src/guestfs.pod:908
1810 "Certain libguestfs calls take a parameter that contains sensitive key "
1811 "material, passed in as a C string."
1815 #: ../src/guestfs.pod:911
1817 "In the future we would hope to change the libguestfs implementation so that "
1818 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1819 "swap. However this is I<not> done at the moment, because of the complexity "
1820 "of such an implementation."
1824 #: ../src/guestfs.pod:916
1826 "Therefore you should be aware that any key parameter you pass to libguestfs "
1827 "might end up being written out to the swap partition. If this is a concern, "
1828 "scrub the swap partition or don't use libguestfs on encrypted devices."
1832 #: ../src/guestfs.pod:921
1833 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1837 #: ../src/guestfs.pod:923
1839 "All high-level libguestfs actions are synchronous. If you want to use "
1840 "libguestfs asynchronously then you must create a thread."
1844 #: ../src/guestfs.pod:926
1846 "Only use the handle from a single thread. Either use the handle exclusively "
1847 "from one thread, or provide your own mutex so that two threads cannot issue "
1848 "calls on the same handle at the same time."
1852 #: ../src/guestfs.pod:930
1854 "See the graphical program guestfs-browser for one possible architecture for "
1855 "multithreaded programs using libvirt and libguestfs."
1859 #: ../src/guestfs.pod:933
1864 #: ../src/guestfs.pod:935
1866 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1871 #: ../src/guestfs.pod:938
1873 "By default it looks for these in the directory C<$libdir/guestfs> "
1874 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1878 #: ../src/guestfs.pod:941
1880 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1881 "to change the directories that libguestfs will search in. The value is a "
1882 "colon-separated list of paths. The current directory is I<not> searched "
1883 "unless the path contains an empty element or C<.>. For example "
1884 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1885 "then C</usr/lib/guestfs>."
1889 #: ../src/guestfs.pod:948
1890 msgid "QEMU WRAPPERS"
1894 #: ../src/guestfs.pod:950
1896 "If you want to compile your own qemu, run qemu from a non-standard location, "
1897 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1902 #: ../src/guestfs.pod:954
1904 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1905 "last command in the shell script (so that qemu replaces the shell and "
1906 "becomes the direct child of the libguestfs-using program). If you don't do "
1907 "this, then the qemu process won't be cleaned up correctly."
1911 #: ../src/guestfs.pod:959
1913 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1918 #: ../src/guestfs.pod:962
1922 " qemudir=/home/rjones/d/qemu\n"
1923 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1929 #: ../src/guestfs.pod:966
1931 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1932 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1937 #: ../src/guestfs.pod:970
1940 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1945 #: ../src/guestfs.pod:972
1947 "Note that libguestfs also calls qemu with the -help and -version options in "
1948 "order to determine features."
1952 #: ../src/guestfs.pod:975
1953 msgid "ATTACHING TO RUNNING DAEMONS"
1957 #: ../src/guestfs.pod:977
1959 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
1960 "babies. Use with caution."
1964 #: ../src/guestfs.pod:980
1966 "I<Note (2):> This section explains how to attach to a running daemon from a "
1967 "low level perspective. For most users, simply using virt tools such as "
1968 "L<guestfish(1)> with the I<--live> option will \"just work\"."
1972 #: ../src/guestfs.pod:984
1973 msgid "Using guestfs_set_attach_method"
1977 #: ../src/guestfs.pod:986
1979 "By calling L</guestfs_set_attach_method> you can change how the library "
1980 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
1981 "L</ARCHITECTURE> for some background)."
1985 #: ../src/guestfs.pod:990
1987 "The normal attach method is C<appliance>, where a small appliance is created "
1988 "containing the daemon, and then the library connects to this."
1992 #: ../src/guestfs.pod:993
1994 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
1995 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
1996 "daemon over the Unix domain socket."
2000 #: ../src/guestfs.pod:997
2002 "The normal use for this is to connect to a running virtual machine that "
2003 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2004 "files inside the live virtual machine."
2008 #: ../src/guestfs.pod:1001
2009 msgid "Using guestfs_add_domain with live flag"
2013 #: ../src/guestfs.pod:1003
2015 "L</guestfs_add_domain> provides some help for getting the correct attach "
2016 "method. If you pass the C<live> option to this function, then (if the "
2017 "virtual machine is running) it will examine the libvirt XML looking for a "
2018 "virtio-serial channel to connect to:"
2022 #: ../src/guestfs.pod:1009
2029 " <channel type='unix'>\n"
2030 " <source mode='bind' path='/path/to/socket'/>\n"
2031 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2040 #: ../src/guestfs.pod:1021
2042 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2043 "method to C<unix:/path/to/socket>."
2047 #: ../src/guestfs.pod:1024
2049 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2050 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2051 "to attach to and modify live virtual machines."
2055 #: ../src/guestfs.pod:1028
2057 "The virtual machine needs to have been set up beforehand so that it has the "
2058 "virtio-serial channel and so that guestfsd is running inside it."
2062 #: ../src/guestfs.pod:1032
2063 msgid "ABI GUARANTEE"
2067 #: ../src/guestfs.pod:1034
2069 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2070 "actions as outlined in this section. Although we will deprecate some "
2071 "actions, for example if they get replaced by newer calls, we will keep the "
2072 "old actions forever. This allows you the developer to program in confidence "
2073 "against the libguestfs API."
2077 #: ../src/guestfs.pod:1040
2078 msgid "BLOCK DEVICE NAMING"
2082 #: ../src/guestfs.pod:1042
2084 "In the kernel there is now quite a profusion of schemata for naming block "
2085 "devices (in this context, by I<block device> I mean a physical or virtual "
2086 "hard drive). The original Linux IDE driver used names starting with "
2087 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
2088 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2089 "replacement for the old IDE driver (particularly for SATA devices) those "
2090 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2091 "machines with paravirtualized drivers. This has created several different "
2092 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2097 #: ../src/guestfs.pod:1054
2099 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2100 "Linux kernel to access block devices. We can run a variety of appliances "
2101 "based on a variety of Linux kernels."
2105 #: ../src/guestfs.pod:1058
2107 "This causes a problem for libguestfs because many API calls use device or "
2108 "partition names. Working scripts and the recipe (example) scripts that we "
2109 "make available over the internet could fail if the naming scheme changes."
2113 #: ../src/guestfs.pod:1063
2115 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2116 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2117 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2118 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2122 #: ../src/guestfs.pod:1069
2124 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2125 "L</guestfs_list_partitions> and similar calls return the true names of the "
2126 "devices and partitions as known to the appliance."
2130 #: ../src/guestfs.pod:1074
2131 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2135 #: ../src/guestfs.pod:1076
2137 "Usually this translation is transparent. However in some (very rare) cases "
2138 "you may need to know the exact algorithm. Such cases include where you use "
2139 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2140 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2145 #: ../src/guestfs.pod:1082
2147 "The algorithm is applied only to I<parameters> which are known to be either "
2148 "device or partition names. Return values from functions such as "
2149 "L</guestfs_list_devices> are never changed."
2153 #: ../src/guestfs.pod:1090
2154 msgid "Is the string a parameter which is a device or partition name?"
2158 #: ../src/guestfs.pod:1094
2159 msgid "Does the string begin with C</dev/sd>?"
2163 #: ../src/guestfs.pod:1098
2165 "Does the named device exist? If so, we use that device. However if I<not> "
2166 "then we continue with this algorithm."
2170 #: ../src/guestfs.pod:1103
2171 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2175 #: ../src/guestfs.pod:1105
2176 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2180 #: ../src/guestfs.pod:1107
2181 msgid "If that named device exists, use it. If not, continue."
2185 #: ../src/guestfs.pod:1111
2186 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2190 #: ../src/guestfs.pod:1113
2191 msgid "If that named device exists, use it. If not, return an error."
2195 #: ../src/guestfs.pod:1117
2196 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2200 #: ../src/guestfs.pod:1119
2202 "Although the standard naming scheme and automatic translation is useful for "
2203 "simple programs and guestfish scripts, for larger programs it is best not to "
2204 "rely on this mechanism."
2208 #: ../src/guestfs.pod:1123
2210 "Where possible for maximum future portability programs using libguestfs "
2211 "should use these future-proof techniques:"
2215 #: ../src/guestfs.pod:1130
2217 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2218 "device names, and then use those names directly."
2222 #: ../src/guestfs.pod:1133
2223 msgid "Since those device names exist by definition, they will never be translated."
2227 #: ../src/guestfs.pod:1138
2229 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2230 "filesystem labels."
2234 #: ../src/guestfs.pod:1143
2239 #: ../src/guestfs.pod:1145
2241 "This section discusses security implications of using libguestfs, "
2242 "particularly with untrusted or malicious guests or disk images."
2246 #: ../src/guestfs.pod:1148
2247 msgid "GENERAL SECURITY CONSIDERATIONS"
2251 #: ../src/guestfs.pod:1150
2253 "Be careful with any files or data that you download from a guest (by "
2254 "\"download\" we mean not just the L</guestfs_download> command but any "
2255 "command that reads files, filenames, directories or anything else from a "
2256 "disk image). An attacker could manipulate the data to fool your program "
2257 "into doing the wrong thing. Consider cases such as:"
2261 #: ../src/guestfs.pod:1160
2262 msgid "the data (file etc) not being present"
2266 #: ../src/guestfs.pod:1164
2267 msgid "being present but empty"
2271 #: ../src/guestfs.pod:1168
2272 msgid "being much larger than normal"
2276 #: ../src/guestfs.pod:1172
2277 msgid "containing arbitrary 8 bit data"
2281 #: ../src/guestfs.pod:1176
2282 msgid "being in an unexpected character encoding"
2286 #: ../src/guestfs.pod:1180
2287 msgid "containing homoglyphs."
2291 #: ../src/guestfs.pod:1184
2292 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2296 #: ../src/guestfs.pod:1186
2298 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2299 "(VFS) module can sometimes be escalated into exploits by deliberately "
2300 "creating a malicious, malformed filesystem. These exploits are very severe "
2301 "for two reasons. Firstly there are very many filesystem drivers in the "
2302 "kernel, and many of them are infrequently used and not much developer "
2303 "attention has been paid to the code. Linux userspace helps potential "
2304 "crackers by detecting the filesystem type and automatically choosing the "
2305 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2306 "the administrator. Secondly, a kernel-level exploit is like a local root "
2307 "exploit (worse in some ways), giving immediate and total access to the "
2308 "system right down to the hardware level."
2312 #: ../src/guestfs.pod:1199
2314 "That explains why you should never mount a filesystem from an untrusted "
2315 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2316 "inside a qemu virtual machine, usually running as a non-root user. The "
2317 "attacker would need to write a filesystem which first exploited the kernel, "
2318 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2319 "the libguestfs protocol, and finally to be as serious as the host kernel "
2320 "exploit it would need to escalate its privileges to root. This multi-step "
2321 "escalation, performed by a static piece of data, is thought to be extremely "
2322 "hard to do, although we never say 'never' about security issues."
2326 #: ../src/guestfs.pod:1210
2328 "In any case callers can reduce the attack surface by forcing the filesystem "
2329 "type when mounting (use L</guestfs_mount_vfs>)."
2333 #: ../src/guestfs.pod:1213
2334 msgid "PROTOCOL SECURITY"
2338 #: ../src/guestfs.pod:1215
2340 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2341 "defined upper message size. However a program that uses libguestfs must "
2342 "also take care - for example you can write a program that downloads a binary "
2343 "from a disk image and executes it locally, and no amount of protocol "
2344 "security will save you from the consequences."
2348 #: ../src/guestfs.pod:1221
2349 msgid "INSPECTION SECURITY"
2353 #: ../src/guestfs.pod:1223
2355 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2356 "directly from the guest, and these could contain any 8 bit data. Callers "
2357 "should be careful to escape these before printing them to a structured file "
2358 "(for example, use HTML escaping if creating a web page)."
2362 #: ../src/guestfs.pod:1229
2364 "Guest configuration may be altered in unusual ways by the administrator of "
2365 "the virtual machine, and may not reflect reality (particularly for untrusted "
2366 "or actively malicious guests). For example we parse the hostname from "
2367 "configuration files like C</etc/sysconfig/network> that we find in the "
2368 "guest, but the guest administrator can easily manipulate these files to "
2369 "provide the wrong hostname."
2373 #: ../src/guestfs.pod:1237
2375 "The inspection API parses guest configuration using two external libraries: "
2376 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2377 "designed to be robust in the face of malicious data, although denial of "
2378 "service attacks are still possible, for example with oversized configuration "
2383 #: ../src/guestfs.pod:1243
2384 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2388 #: ../src/guestfs.pod:1245
2390 "Be very cautious about running commands from the guest. By running a "
2391 "command in the guest, you are giving CPU time to a binary that you do not "
2392 "control, under the same user account as the library, albeit wrapped in qemu "
2393 "virtualization. More information and alternatives can be found in the "
2394 "section L</RUNNING COMMANDS>."
2398 #: ../src/guestfs.pod:1251
2399 msgid "CVE-2010-3851"
2403 #: ../src/guestfs.pod:1253
2404 msgid "https://bugzilla.redhat.com/642934"
2408 #: ../src/guestfs.pod:1255
2410 "This security bug concerns the automatic disk format detection that qemu "
2411 "does on disk images."
2415 #: ../src/guestfs.pod:1258
2417 "A raw disk image is just the raw bytes, there is no header. Other disk "
2418 "images like qcow2 contain a special header. Qemu deals with this by looking "
2419 "for one of the known headers, and if none is found then assuming the disk "
2420 "image must be raw."
2424 #: ../src/guestfs.pod:1263
2426 "This allows a guest which has been given a raw disk image to write some "
2427 "other header. At next boot (or when the disk image is accessed by "
2428 "libguestfs) qemu would do autodetection and think the disk image format was, "
2429 "say, qcow2 based on the header written by the guest."
2433 #: ../src/guestfs.pod:1268
2435 "This in itself would not be a problem, but qcow2 offers many features, one "
2436 "of which is to allow a disk image to refer to another image (called the "
2437 "\"backing disk\"). It does this by placing the path to the backing disk "
2438 "into the qcow2 header. This path is not validated and could point to any "
2439 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2440 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2441 "control of the attacker."
2445 #: ../src/guestfs.pod:1276
2446 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2450 #: ../src/guestfs.pod:1283
2451 msgid "You have enabled the network or have opened the disk in write mode."
2455 #: ../src/guestfs.pod:1287
2457 "You are also running untrusted code from the guest (see L</RUNNING "
2462 #: ../src/guestfs.pod:1292
2464 "The way to avoid this is to specify the expected disk format when adding "
2465 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2466 "should always do this if the disk is raw format, and it's a good idea for "
2471 #: ../src/guestfs.pod:1297
2473 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2474 "format is fetched from libvirt and passed through."
2478 #: ../src/guestfs.pod:1300
2480 "For libguestfs tools, use the I<--format> command line parameter as "
2485 #: ../src/guestfs.pod:1303
2486 msgid "CONNECTION MANAGEMENT"
2490 #: ../src/guestfs.pod:1305
2495 #: ../src/guestfs.pod:1307
2497 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2498 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2499 "handle and release all resources used."
2503 #: ../src/guestfs.pod:1311
2505 "For information on using multiple handles and threads, see the section "
2506 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2510 #: ../src/guestfs.pod:1314
2511 msgid "guestfs_create"
2515 #: ../src/guestfs.pod:1316
2518 " guestfs_h *guestfs_create (void);\n"
2523 #: ../src/guestfs.pod:1318
2524 msgid "Create a connection handle."
2528 #: ../src/guestfs.pod:1320
2530 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2531 "on the handle at least once."
2535 #: ../src/guestfs.pod:1323
2537 "This function returns a non-NULL pointer to a handle on success or NULL on "
2542 #: ../src/guestfs.pod:1326
2543 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2547 #: ../src/guestfs.pod:1328
2549 "You may also want to configure error handling for the handle. See L</ERROR "
2550 "HANDLING> section below."
2554 #: ../src/guestfs.pod:1331
2555 msgid "guestfs_close"
2559 #: ../src/guestfs.pod:1333
2562 " void guestfs_close (guestfs_h *g);\n"
2567 #: ../src/guestfs.pod:1335
2568 msgid "This closes the connection handle and frees up all resources used."
2572 #: ../src/guestfs.pod:1337
2573 msgid "ERROR HANDLING"
2577 #: ../src/guestfs.pod:1339
2579 "API functions can return errors. For example, almost all functions that "
2580 "return C<int> will return C<-1> to indicate an error."
2584 #: ../src/guestfs.pod:1342
2586 "Additional information is available for errors: an error message string and "
2587 "optionally an error number (errno) if the thing that failed was a system "
2592 #: ../src/guestfs.pod:1346
2594 "You can get at the additional information about the last error on the handle "
2595 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2596 "up an error handler with L</guestfs_set_error_handler>."
2600 #: ../src/guestfs.pod:1351
2602 "When the handle is created, a default error handler is installed which "
2603 "prints the error message string to C<stderr>. For small short-running "
2604 "command line programs it is sufficient to do:"
2608 #: ../src/guestfs.pod:1355
2611 " if (guestfs_launch (g) == -1)\n"
2612 " exit (EXIT_FAILURE);\n"
2617 #: ../src/guestfs.pod:1358
2619 "since the default error handler will ensure that an error message has been "
2620 "printed to C<stderr> before the program exits."
2624 #: ../src/guestfs.pod:1361
2626 "For other programs the caller will almost certainly want to install an "
2627 "alternate error handler or do error handling in-line like this:"
2631 #: ../src/guestfs.pod:1364
2634 " g = guestfs_create ();\n"
2639 #: ../src/guestfs.pod:1366
2642 " /* This disables the default behaviour of printing errors\n"
2644 " guestfs_set_error_handler (g, NULL, NULL);\n"
2649 #: ../src/guestfs.pod:1370
2652 " if (guestfs_launch (g) == -1) {\n"
2653 " /* Examine the error message and print it etc. */\n"
2654 " char *msg = guestfs_last_error (g);\n"
2655 " int errnum = guestfs_last_errno (g);\n"
2656 " fprintf (stderr, \"%s\\n\", msg);\n"
2663 #: ../src/guestfs.pod:1378
2665 "Out of memory errors are handled differently. The default action is to call "
2666 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2667 "L</guestfs_set_out_of_memory_handler>."
2671 #: ../src/guestfs.pod:1382
2673 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2674 "because there is no handle if this happens there is no way to get additional "
2675 "error information. However L</guestfs_create> is supposed to be a "
2676 "lightweight operation which can only fail because of insufficient memory (it "
2677 "returns NULL in this case)."
2681 #: ../src/guestfs.pod:1388
2682 msgid "guestfs_last_error"
2686 #: ../src/guestfs.pod:1390
2689 " const char *guestfs_last_error (guestfs_h *g);\n"
2694 #: ../src/guestfs.pod:1392
2696 "This returns the last error message that happened on C<g>. If there has not "
2697 "been an error since the handle was created, then this returns C<NULL>."
2701 #: ../src/guestfs.pod:1396
2703 "The lifetime of the returned string is until the next error occurs, or "
2704 "L</guestfs_close> is called."
2708 #: ../src/guestfs.pod:1399
2709 msgid "guestfs_last_errno"
2713 #: ../src/guestfs.pod:1401
2716 " int guestfs_last_errno (guestfs_h *g);\n"
2721 #: ../src/guestfs.pod:1403
2722 msgid "This returns the last error number (errno) that happened on C<g>."
2726 #: ../src/guestfs.pod:1405
2727 msgid "If successful, an errno integer not equal to zero is returned."
2731 #: ../src/guestfs.pod:1407
2732 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2736 #: ../src/guestfs.pod:1414
2737 msgid "There has not been any error on the handle."
2741 #: ../src/guestfs.pod:1418
2743 "There has been an error but the errno was meaningless. This corresponds to "
2744 "the case where the error did not come from a failed system call, but for "
2745 "some other reason."
2749 #: ../src/guestfs.pod:1424
2751 "There was an error from a failed system call, but for some reason the errno "
2752 "was not captured and returned. This usually indicates a bug in libguestfs."
2756 #: ../src/guestfs.pod:1430
2758 "Libguestfs tries to convert the errno from inside the applicance into a "
2759 "corresponding errno for the caller (not entirely trivial: the appliance "
2760 "might be running a completely different operating system from the library "
2761 "and error numbers are not standardized across Un*xen). If this could not be "
2762 "done, then the error is translated to C<EINVAL>. In practice this should "
2763 "only happen in very rare circumstances."
2767 #: ../src/guestfs.pod:1438
2768 msgid "guestfs_set_error_handler"
2772 #: ../src/guestfs.pod:1440
2775 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2777 " const char *msg);\n"
2778 " void guestfs_set_error_handler (guestfs_h *g,\n"
2779 " guestfs_error_handler_cb cb,\n"
2785 #: ../src/guestfs.pod:1447
2787 "The callback C<cb> will be called if there is an error. The parameters "
2788 "passed to the callback are an opaque data pointer and the error message "
2793 #: ../src/guestfs.pod:1451
2795 "C<errno> is not passed to the callback. To get that the callback must call "
2796 "L</guestfs_last_errno>."
2800 #: ../src/guestfs.pod:1454
2802 "Note that the message string C<msg> is freed as soon as the callback "
2803 "function returns, so if you want to stash it somewhere you must make your "
2808 #: ../src/guestfs.pod:1458
2809 msgid "The default handler prints messages on C<stderr>."
2813 #: ../src/guestfs.pod:1460
2814 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2818 #: ../src/guestfs.pod:1462
2819 msgid "guestfs_get_error_handler"
2823 #: ../src/guestfs.pod:1464
2826 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2827 " void **opaque_rtn);\n"
2832 #: ../src/guestfs.pod:1467
2833 msgid "Returns the current error handler callback."
2837 #: ../src/guestfs.pod:1469
2838 msgid "guestfs_set_out_of_memory_handler"
2842 #: ../src/guestfs.pod:1471
2845 " typedef void (*guestfs_abort_cb) (void);\n"
2846 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2847 " guestfs_abort_cb);\n"
2852 #: ../src/guestfs.pod:1475
2854 "The callback C<cb> will be called if there is an out of memory situation. "
2855 "I<Note this callback must not return>."
2859 #: ../src/guestfs.pod:1478
2860 msgid "The default is to call L<abort(3)>."
2864 #: ../src/guestfs.pod:1480
2865 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2869 #: ../src/guestfs.pod:1483
2870 msgid "guestfs_get_out_of_memory_handler"
2874 #: ../src/guestfs.pod:1485
2877 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2882 #: ../src/guestfs.pod:1487
2883 msgid "This returns the current out of memory handler."
2887 #: ../src/guestfs.pod:1489
2892 #: ../src/guestfs.pod:1491 ../fish/guestfish.pod:989
2897 #: ../src/guestfs.pod:1493
2902 #: ../src/guestfs.pod:1495
2907 #: ../src/guestfs.pod:1497
2908 msgid "AVAILABILITY"
2912 #: ../src/guestfs.pod:1499
2913 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2917 #: ../src/guestfs.pod:1501
2919 "Using L</guestfs_available> you can test availability of the following "
2920 "groups of functions. This test queries the appliance to see if the "
2921 "appliance you are currently using supports the functionality."
2925 #: ../src/guestfs.pod:1506
2926 msgid "@AVAILABILITY@"
2930 #: ../src/guestfs.pod:1508
2931 msgid "GUESTFISH supported COMMAND"
2935 #: ../src/guestfs.pod:1510
2937 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2938 "prints out the available groups and whether they are supported by this build "
2939 "of libguestfs. Note however that you have to do C<run> first."
2943 #: ../src/guestfs.pod:1515
2944 msgid "SINGLE CALLS AT COMPILE TIME"
2948 #: ../src/guestfs.pod:1517
2950 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2951 "function, such as:"
2955 #: ../src/guestfs.pod:1520
2958 " #define LIBGUESTFS_HAVE_DD 1\n"
2963 #: ../src/guestfs.pod:1522
2964 msgid "if L</guestfs_dd> is available."
2968 #: ../src/guestfs.pod:1524
2970 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2971 "function is available at compile time, we recommended using build tools such "
2972 "as autoconf or cmake. For example in autotools you could use:"
2976 #: ../src/guestfs.pod:1529
2979 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2980 " AC_CHECK_FUNCS([guestfs_dd])\n"
2985 #: ../src/guestfs.pod:1532
2987 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2992 #: ../src/guestfs.pod:1535
2993 msgid "SINGLE CALLS AT RUN TIME"
2997 #: ../src/guestfs.pod:1537
2999 "Testing at compile time doesn't guarantee that a function really exists in "
3000 "the library. The reason is that you might be dynamically linked against a "
3001 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3002 "This situation unfortunately results in a segmentation fault, which is a "
3003 "shortcoming of the C dynamic linking system itself."
3007 #: ../src/guestfs.pod:1544
3009 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3010 "in this example program (note that you still need the compile time check as "
3015 #: ../src/guestfs.pod:1548
3018 " #include <stdio.h>\n"
3019 " #include <stdlib.h>\n"
3020 " #include <unistd.h>\n"
3021 " #include <dlfcn.h>\n"
3022 " #include <guestfs.h>\n"
3027 #: ../src/guestfs.pod:1554
3032 " #ifdef LIBGUESTFS_HAVE_DD\n"
3034 " int has_function;\n"
3039 #: ../src/guestfs.pod:1560
3042 " /* Test if the function guestfs_dd is really available. */\n"
3043 " dl = dlopen (NULL, RTLD_LAZY);\n"
3045 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3046 " exit (EXIT_FAILURE);\n"
3048 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3054 #: ../src/guestfs.pod:1569
3057 " if (!has_function)\n"
3058 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3060 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3061 " /* Now it's safe to call\n"
3062 " guestfs_dd (g, \"foo\", \"bar\");\n"
3066 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3073 #: ../src/guestfs.pod:1582
3075 "You may think the above is an awful lot of hassle, and it is. There are "
3076 "other ways outside of the C linking system to ensure that this kind of "
3077 "incompatibility never arises, such as using package versioning:"
3081 #: ../src/guestfs.pod:1587
3084 " Requires: libguestfs >= 1.0.80\n"
3089 #: ../src/guestfs.pod:1589
3090 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3094 #: ../src/guestfs.pod:1591
3096 "A recent feature of the API is the introduction of calls which take optional "
3097 "arguments. In C these are declared 3 ways. The main way is as a call which "
3098 "takes variable arguments (ie. C<...>), as in this example:"
3102 #: ../src/guestfs.pod:1596
3105 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3110 #: ../src/guestfs.pod:1598
3112 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3113 "call with no optional arguments specified:"
3117 #: ../src/guestfs.pod:1601
3120 " guestfs_add_drive_opts (g, filename, -1);\n"
3125 #: ../src/guestfs.pod:1603
3126 msgid "With a single optional argument:"
3130 #: ../src/guestfs.pod:1605
3133 " guestfs_add_drive_opts (g, filename,\n"
3134 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3140 #: ../src/guestfs.pod:1609
3145 #: ../src/guestfs.pod:1611
3148 " guestfs_add_drive_opts (g, filename,\n"
3149 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3150 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3156 #: ../src/guestfs.pod:1616
3158 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3163 #: ../src/guestfs.pod:1619
3164 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3168 #: ../src/guestfs.pod:1621
3170 "The second variant has the same name with the suffix C<_va>, which works the "
3171 "same way but takes a C<va_list>. See the C manual for details. For the "
3172 "example function, this is declared:"
3176 #: ../src/guestfs.pod:1625
3179 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3185 #: ../src/guestfs.pod:1628
3186 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3190 #: ../src/guestfs.pod:1630
3192 "The third variant is useful where you need to construct these calls. You "
3193 "pass in a structure where you fill in the optional fields. The structure "
3194 "has a bitmask as the first element which you must set to indicate which "
3195 "fields you have filled in. For our example function the structure and call "
3200 #: ../src/guestfs.pod:1636
3203 " struct guestfs_add_drive_opts_argv {\n"
3204 " uint64_t bitmask;\n"
3206 " const char *format;\n"
3209 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3210 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3215 #: ../src/guestfs.pod:1645
3216 msgid "You could call it like this:"
3220 #: ../src/guestfs.pod:1647
3223 " struct guestfs_add_drive_opts_argv optargs = {\n"
3224 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3225 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3227 " .format = \"qcow2\"\n"
3233 #: ../src/guestfs.pod:1654
3236 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3241 #: ../src/guestfs.pod:1656 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532
3246 #: ../src/guestfs.pod:1662
3247 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3251 #: ../src/guestfs.pod:1667
3252 msgid "You do not need to fill in all fields of the structure."
3256 #: ../src/guestfs.pod:1671
3258 "There must be a one-to-one correspondence between fields of the structure "
3259 "that are filled in, and bits set in the bitmask."
3263 #: ../src/guestfs.pod:1676
3264 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3268 #: ../src/guestfs.pod:1678
3270 "In other languages, optional arguments are expressed in the way that is "
3271 "natural for that language. We refer you to the language-specific "
3272 "documentation for more details on that."
3276 #: ../src/guestfs.pod:1682
3277 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3281 #: ../src/guestfs.pod:1684
3282 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3286 #: ../src/guestfs.pod:1686
3288 "The child process generates events in some situations. Current events "
3289 "include: receiving a log message, the child process exits."
3293 #: ../src/guestfs.pod:1689
3295 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3300 #: ../src/guestfs.pod:1692
3302 "Only I<one callback of each type> can be registered for each handle. "
3303 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3304 "that type. Cancel all callbacks of this type by calling this function with "
3305 "C<cb> set to C<NULL>."
3309 #: ../src/guestfs.pod:1697
3310 msgid "guestfs_set_log_message_callback"
3314 #: ../src/guestfs.pod:1699
3317 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3318 " char *buf, int len);\n"
3319 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3320 " guestfs_log_message_cb cb,\n"
3326 #: ../src/guestfs.pod:1705
3328 "The callback function C<cb> will be called whenever qemu or the guest writes "
3329 "anything to the console."
3333 #: ../src/guestfs.pod:1708
3334 msgid "Use this function to capture kernel messages and similar."
3338 #: ../src/guestfs.pod:1710
3340 "Normally there is no log message handler, and log messages are just "
3345 #: ../src/guestfs.pod:1713
3346 msgid "guestfs_set_subprocess_quit_callback"
3350 #: ../src/guestfs.pod:1715
3353 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3354 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3355 " guestfs_subprocess_quit_cb cb,\n"
3361 #: ../src/guestfs.pod:1720
3363 "The callback function C<cb> will be called when the child process quits, "
3364 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3365 "corresponds to a transition from any state to the CONFIG state)."
3369 #: ../src/guestfs.pod:1725
3370 msgid "guestfs_set_launch_done_callback"
3374 #: ../src/guestfs.pod:1727
3377 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3378 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3379 " guestfs_launch_done_cb cb,\n"
3385 #: ../src/guestfs.pod:1732
3387 "The callback function C<cb> will be called when the child process becomes "
3388 "ready first time after it has been launched. (This corresponds to a "
3389 "transition from LAUNCHING to the READY state)."
3393 #: ../src/guestfs.pod:1736
3394 msgid "guestfs_set_close_callback"
3398 #: ../src/guestfs.pod:1738
3401 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3402 " void guestfs_set_close_callback (guestfs_h *g,\n"
3403 " guestfs_close_cb cb,\n"
3409 #: ../src/guestfs.pod:1743
3411 "The callback function C<cb> will be called while the handle is being closed "
3412 "(synchronously from L</guestfs_close>)."
3416 #: ../src/guestfs.pod:1746
3418 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3419 "handles that are open when the program exits. This means that this callback "
3420 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3421 "problems in higher-level languages (eg. if your HLL interpreter has already "
3422 "been cleaned up by the time this is called, and if your callback then jumps "
3423 "into some HLL function)."
3427 #: ../src/guestfs.pod:1754
3428 msgid "guestfs_set_progress_callback"
3432 #: ../src/guestfs.pod:1756
3435 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3436 " int proc_nr, int serial,\n"
3437 " uint64_t position, uint64_t total);\n"
3438 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3439 " guestfs_progress_cb cb,\n"
3445 #: ../src/guestfs.pod:1763
3447 "Some long-running operations can generate progress messages. If this "
3448 "callback is registered, then it will be called each time a progress message "
3449 "is generated (usually two seconds after the operation started, and three "
3450 "times per second thereafter until it completes, although the frequency may "
3451 "change in future versions)."
3455 #: ../src/guestfs.pod:1769
3457 "The callback receives two numbers: C<position> and C<total>. The units of "
3458 "C<total> are not defined, although for some operations C<total> may relate "
3459 "in some way to the amount of data to be transferred (eg. in bytes or "
3460 "megabytes), and C<position> may be the portion which has been transferred."
3464 #: ../src/guestfs.pod:1775
3465 msgid "The only defined and stable parts of the API are:"
3469 #: ../src/guestfs.pod:1781
3471 "The callback can display to the user some type of progress bar or indicator "
3472 "which shows the ratio of C<position>:C<total>."
3476 #: ../src/guestfs.pod:1786
3477 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3481 #: ../src/guestfs.pod:1790
3483 "If any progress notification is sent during a call, then a final progress "
3484 "notification is always sent when C<position> = C<total>."
3488 #: ../src/guestfs.pod:1793
3490 "This is to simplify caller code, so callers can easily set the progress "
3491 "indicator to \"100%\" at the end of the operation, without requiring special "
3492 "code to detect this case."
3496 #: ../src/guestfs.pod:1799
3498 "The callback also receives the procedure number and serial number of the "
3499 "call. These are only useful for debugging protocol issues, and the callback "
3500 "can normally ignore them. The callback may want to print these numbers in "
3501 "error messages or debugging messages."
3505 #: ../src/guestfs.pod:1804
3506 msgid "PRIVATE DATA AREA"
3510 #: ../src/guestfs.pod:1806
3512 "You can attach named pieces of private data to the libguestfs handle, and "
3513 "fetch them by name for the lifetime of the handle. This is called the "
3514 "private data area and is only available from the C API."
3518 #: ../src/guestfs.pod:1810
3519 msgid "To attach a named piece of data, use the following call:"
3523 #: ../src/guestfs.pod:1812
3526 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3531 #: ../src/guestfs.pod:1814
3533 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3534 "pointer (which can be C<NULL>). Any previous item with the same name is "
3539 #: ../src/guestfs.pod:1818
3541 "You can use any C<key> you want, but names beginning with an underscore "
3542 "character are reserved for internal libguestfs purposes (for implementing "
3543 "language bindings). It is recommended to prefix the name with some unique "
3544 "string to avoid collisions with other users."
3548 #: ../src/guestfs.pod:1823
3549 msgid "To retrieve the pointer, use:"
3553 #: ../src/guestfs.pod:1825
3556 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3561 #: ../src/guestfs.pod:1827
3563 "This function returns C<NULL> if either no data is found associated with "
3564 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3569 #: ../src/guestfs.pod:1831
3571 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3572 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3573 "all. In particular, libguestfs does I<not> try to free the data when the "
3574 "handle is closed. If the data must be freed, then the caller must either "
3575 "free it before calling L</guestfs_close> or must set up a close callback to "
3576 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3577 "can be registered for a handle)."
3581 #: ../src/guestfs.pod:1839
3583 "The private data area is implemented using a hash table, and should be "
3584 "reasonably efficient for moderate numbers of keys."
3588 #: ../src/guestfs.pod:1842 ../src/guestfs.pod:1847
3593 #: ../src/guestfs.pod:1844
3595 "<!-- old anchor for the next section --> <a "
3596 "name=\"state_machine_and_low_level_event_api\"/>"
3600 #: ../src/guestfs.pod:1849
3601 msgid "ARCHITECTURE"
3605 #: ../src/guestfs.pod:1851
3607 "Internally, libguestfs is implemented by running an appliance (a special "
3608 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3609 "process of the main program."
3613 #: ../src/guestfs.pod:1855
3616 " ___________________\n"
3618 " | main program |\n"
3620 " | | child process / appliance\n"
3621 " | | __________________________\n"
3623 " +-------------------+ RPC | +-----------------+ |\n"
3624 " | libguestfs <--------------------> guestfsd | |\n"
3625 " | | | +-----------------+ |\n"
3626 " \\___________________/ | | Linux kernel | |\n"
3627 " | +--^--------------+ |\n"
3628 " \\_________|________________/\n"
3634 " \\______________/\n"
3639 #: ../src/guestfs.pod:1875
3641 "The library, linked to the main program, creates the child process and hence "
3642 "the appliance in the L</guestfs_launch> function."
3646 #: ../src/guestfs.pod:1878
3648 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3649 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3650 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3651 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3652 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3653 "attached to the qemu process which translates device access by the "
3654 "appliance's Linux kernel into accesses to the image."
3658 #: ../src/guestfs.pod:1887
3660 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3661 "Although the disk image you are attached to might also be used by some "
3662 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3663 "care if both libguestfs's qemu process and your virtual machine are trying "
3664 "to update the disk image at the same time, since these usually results in "
3665 "massive disk corruption)."
3669 #: ../src/guestfs.pod:1894
3670 msgid "STATE MACHINE"
3674 #: ../src/guestfs.pod:1896
3675 msgid "libguestfs uses a state machine to model the child process:"
3679 #: ../src/guestfs.pod:1898
3691 " / | \\ \\ guestfs_launch\n"
3692 " / | _\\__V______\n"
3694 " / | | LAUNCHING |\n"
3695 " / | \\___________/\n"
3697 " / | guestfs_launch\n"
3699 " ______ / __|____V\n"
3700 " / \\ ------> / \\\n"
3701 " | BUSY | | READY |\n"
3702 " \\______/ <------ \\________/\n"
3707 #: ../src/guestfs.pod:1920
3709 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3710 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3711 "(3) alternating between READY and BUSY as commands are issued to, and "
3712 "carried out by, the child process."
3716 #: ../src/guestfs.pod:1925
3718 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3719 "asynchronously at any time (eg. due to some internal error), and that causes "
3720 "the state to transition back to CONFIG."
3724 #: ../src/guestfs.pod:1929
3726 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3727 "issued when in the CONFIG state."
3731 #: ../src/guestfs.pod:1932
3733 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3734 "L</guestfs_launch> blocks until the child process is READY to accept "
3735 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3736 "moves the state from CONFIG to LAUNCHING while it is running."
3740 #: ../src/guestfs.pod:1938
3742 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3743 "state. These API calls block waiting for the command to be carried out "
3744 "(ie. the state to transition to BUSY and then back to READY). There are no "
3745 "non-blocking versions, and no way to issue more than one command per handle "
3750 #: ../src/guestfs.pod:1944
3752 "Finally, the child process sends asynchronous messages back to the main "
3753 "program, such as kernel log messages. You can register a callback to "
3754 "receive these messages."
3758 #: ../src/guestfs.pod:1948
3763 #: ../src/guestfs.pod:1950
3764 msgid "COMMUNICATION PROTOCOL"
3768 #: ../src/guestfs.pod:1952
3770 "Don't rely on using this protocol directly. This section documents how it "
3771 "currently works, but it may change at any time."
3775 #: ../src/guestfs.pod:1955
3777 "The protocol used to talk between the library and the daemon running inside "
3778 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3779 "1014, RFC 1832, RFC 4506)."
3783 #: ../src/guestfs.pod:1959
3785 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3786 "this file is automatically generated)."
3790 #: ../src/guestfs.pod:1962
3792 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3793 "and C<FileOut> parameters, which are handled with very simple request/reply "
3794 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3795 "parameters, which use the same request and reply messages, but they may also "
3796 "be followed by files sent using a chunked encoding."
3800 #: ../src/guestfs.pod:1969
3801 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3805 #: ../src/guestfs.pod:1971
3806 msgid "For ordinary functions, the request message is:"
3810 #: ../src/guestfs.pod:1973
3813 " total length (header + arguments,\n"
3814 " but not including the length word itself)\n"
3815 " struct guestfs_message_header (encoded as XDR)\n"
3816 " struct guestfs_<foo>_args (encoded as XDR)\n"
3821 #: ../src/guestfs.pod:1978
3823 "The total length field allows the daemon to allocate a fixed size buffer "
3824 "into which it slurps the rest of the message. As a result, the total length "
3825 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3826 "effective size of any request is limited to somewhere under this size."
3830 #: ../src/guestfs.pod:1984
3832 "Note also that many functions don't take any arguments, in which case the "
3833 "C<guestfs_I<foo>_args> is completely omitted."
3837 #: ../src/guestfs.pod:1987
3839 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3840 "receiver knows what type of args structure to expect, or none at all."
3844 #: ../src/guestfs.pod:1991
3846 "For functions that take optional arguments, the optional arguments are "
3847 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3848 "arguments. A bitmask in the header indicates which optional arguments are "
3849 "meaningful. The bitmask is also checked to see if it contains bits set "
3850 "which the daemon does not know about (eg. if more optional arguments were "
3851 "added in a later version of the library), and this causes the call to be "
3856 #: ../src/guestfs.pod:1999
3857 msgid "The reply message for ordinary functions is:"
3861 #: ../src/guestfs.pod:2001
3864 " total length (header + ret,\n"
3865 " but not including the length word itself)\n"
3866 " struct guestfs_message_header (encoded as XDR)\n"
3867 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3872 #: ../src/guestfs.pod:2006
3874 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3875 "functions that return no formal return values."
3879 #: ../src/guestfs.pod:2009
3880 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3884 #: ../src/guestfs.pod:2012
3886 "In the case of an error, a flag is set in the header, and the reply message "
3887 "is slightly changed:"
3891 #: ../src/guestfs.pod:2015
3894 " total length (header + error,\n"
3895 " but not including the length word itself)\n"
3896 " struct guestfs_message_header (encoded as XDR)\n"
3897 " struct guestfs_message_error (encoded as XDR)\n"
3902 #: ../src/guestfs.pod:2020
3904 "The C<guestfs_message_error> structure contains the error message as a "
3909 #: ../src/guestfs.pod:2023
3910 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3914 #: ../src/guestfs.pod:2025
3916 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3917 "The normal request message is sent (see above). However this is followed by "
3918 "a sequence of file chunks."
3922 #: ../src/guestfs.pod:2029
3925 " total length (header + arguments,\n"
3926 " but not including the length word itself,\n"
3927 " and not including the chunks)\n"
3928 " struct guestfs_message_header (encoded as XDR)\n"
3929 " struct guestfs_<foo>_args (encoded as XDR)\n"
3930 " sequence of chunks for FileIn param #0\n"
3931 " sequence of chunks for FileIn param #1 etc.\n"
3936 #: ../src/guestfs.pod:2037
3937 msgid "The \"sequence of chunks\" is:"
3941 #: ../src/guestfs.pod:2039
3944 " length of chunk (not including length word itself)\n"
3945 " struct guestfs_chunk (encoded as XDR)\n"
3946 " length of chunk\n"
3947 " struct guestfs_chunk (encoded as XDR)\n"
3949 " length of chunk\n"
3950 " struct guestfs_chunk (with data.data_len == 0)\n"
3955 #: ../src/guestfs.pod:2047
3957 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3958 "is set in the final chunk to indicate either successful completion or early "
3963 #: ../src/guestfs.pod:2051
3965 "At time of writing there are no functions that have more than one FileIn "
3966 "parameter. However this is (theoretically) supported, by sending the "
3967 "sequence of chunks for each FileIn parameter one after another (from left to "
3972 #: ../src/guestfs.pod:2056
3974 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3975 "transfer. The library does this by sending a chunk with a special flag set "
3976 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3977 "RPC, does I<not> send any reply, and goes back to reading the next request."
3981 #: ../src/guestfs.pod:2062
3983 "The daemon may also cancel. It does this by writing a special word "
3984 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3985 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3986 "cancel chunk). The special word is chosen so that even if cancellation "
3987 "happens right at the end of the transfer (after the library has finished "
3988 "writing and has started listening for the reply), the \"spurious\" cancel "
3989 "flag will not be confused with the reply message."
3993 #: ../src/guestfs.pod:2071
3995 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3996 "limit), and also files where the size is not known in advance (eg. from "
3997 "pipes or sockets). However the chunks are rather small "
3998 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3999 "to keep much in memory."
4003 #: ../src/guestfs.pod:2077
4004 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4008 #: ../src/guestfs.pod:2079
4010 "The protocol for FileOut parameters is exactly the same as for FileIn "
4011 "parameters, but with the roles of daemon and library reversed."
4015 #: ../src/guestfs.pod:2082
4018 " total length (header + ret,\n"
4019 " but not including the length word itself,\n"
4020 " and not including the chunks)\n"
4021 " struct guestfs_message_header (encoded as XDR)\n"
4022 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4023 " sequence of chunks for FileOut param #0\n"
4024 " sequence of chunks for FileOut param #1 etc.\n"
4029 #: ../src/guestfs.pod:2090
4030 msgid "INITIAL MESSAGE"
4034 #: ../src/guestfs.pod:2092
4036 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4037 "which indicates that the guest and daemon is alive. This is what "
4038 "L</guestfs_launch> waits for."
4042 #: ../src/guestfs.pod:2096
4043 msgid "PROGRESS NOTIFICATION MESSAGES"
4047 #: ../src/guestfs.pod:2098
4049 "The daemon may send progress notification messages at any time. These are "
4050 "distinguished by the normal length word being replaced by "
4051 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4055 #: ../src/guestfs.pod:2102
4057 "The library turns them into progress callbacks (see "
4058 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
4059 "discards them if not."
4063 #: ../src/guestfs.pod:2106
4065 "The daemon self-limits the frequency of progress messages it sends (see "
4066 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4071 #: ../src/guestfs.pod:2110
4072 msgid "LIBGUESTFS VERSION NUMBERS"
4076 #: ../src/guestfs.pod:2112
4078 "Since April 2010, libguestfs has started to make separate development and "
4079 "stable releases, along with corresponding branches in our git repository. "
4080 "These separate releases can be identified by version number:"
4084 #: ../src/guestfs.pod:2117
4087 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4088 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4094 " | `-------- sub-version\n"
4096 " `------ always '1' because we don't change the ABI\n"
4101 #: ../src/guestfs.pod:2128
4102 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4106 #: ../src/guestfs.pod:2130
4108 "As time passes we cherry pick fixes from the development branch and backport "
4109 "those into the stable branch, the effect being that the stable branch should "
4110 "get more stable and less buggy over time. So the stable releases are ideal "
4111 "for people who don't need new features but would just like the software to "
4116 #: ../src/guestfs.pod:2136
4117 msgid "Our criteria for backporting changes are:"
4121 #: ../src/guestfs.pod:2142
4123 "Documentation changes which don't affect any code are backported unless the "
4124 "documentation refers to a future feature which is not in stable."
4128 #: ../src/guestfs.pod:2148
4130 "Bug fixes which are not controversial, fix obvious problems, and have been "
4131 "well tested are backported."
4135 #: ../src/guestfs.pod:2153
4137 "Simple rearrangements of code which shouldn't affect how it works get "
4138 "backported. This is so that the code in the two branches doesn't get too "
4139 "far out of step, allowing us to backport future fixes more easily."
4143 #: ../src/guestfs.pod:2159
4145 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4146 "exceptional case: the new feature is required in order to implement an "
4147 "important bug fix."
4151 #: ../src/guestfs.pod:2165
4153 "A new stable branch starts when we think the new features in development are "
4154 "substantial and compelling enough over the current stable branch to warrant "
4155 "it. When that happens we create new stable and development versions 1.N.0 "
4156 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4157 "stable at this point, but by backporting fixes from development, that branch "
4158 "will stabilize over time."
4162 #: ../src/guestfs.pod:2173
4163 msgid "EXTENDING LIBGUESTFS"
4167 #: ../src/guestfs.pod:2175
4168 msgid "ADDING A NEW API ACTION"
4172 #: ../src/guestfs.pod:2177
4174 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4175 "documentation) are generated, and this makes it easy to extend the "
4180 #: ../src/guestfs.pod:2181
4181 msgid "To add a new API action there are two changes:"
4185 #: ../src/guestfs.pod:2187
4187 "You need to add a description of the call (name, parameters, return type, "
4188 "tests, documentation) to C<generator/generator_actions.ml>."
4192 #: ../src/guestfs.pod:2190
4194 "There are two sorts of API action, depending on whether the call goes "
4195 "through to the daemon in the appliance, or is serviced entirely by the "
4196 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4197 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4198 "an example of the latter, since a trace flag is maintained in the handle and "
4199 "all tracing is done on the library side."
4203 #: ../src/guestfs.pod:2198
4205 "Most new actions are of the first type, and get added to the "
4206 "C<daemon_functions> list. Each function has a unique procedure number used "
4207 "in the RPC protocol which is assigned to that action when we publish "
4208 "libguestfs and cannot be reused. Take the latest procedure number and "
4213 #: ../src/guestfs.pod:2204
4215 "For library-only actions of the second type, add to the "
4216 "C<non_daemon_functions> list. Since these functions are serviced by the "
4217 "library and do not travel over the RPC mechanism to the daemon, these "
4218 "functions do not need a procedure number, and so the procedure number is set "
4223 #: ../src/guestfs.pod:2212
4224 msgid "Implement the action (in C):"
4228 #: ../src/guestfs.pod:2214
4230 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4231 "C<daemon/> directory."
4235 #: ../src/guestfs.pod:2217
4237 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4238 "(note: double underscore) in the C<src/> directory."
4242 #: ../src/guestfs.pod:2220
4243 msgid "In either case, use another function as an example of what to do."
4247 #: ../src/guestfs.pod:2224
4248 msgid "After making these changes, use C<make> to compile."
4252 #: ../src/guestfs.pod:2226
4254 "Note that you don't need to implement the RPC, language bindings, manual "
4255 "pages or anything else. It's all automatically generated from the OCaml "
4260 #: ../src/guestfs.pod:2230
4261 msgid "ADDING TESTS FOR AN API ACTION"
4265 #: ../src/guestfs.pod:2232
4267 "You can supply zero or as many tests as you want per API call. The tests "
4268 "can either be added as part of the API description "
4269 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4270 "drop a script into C<regressions/>. Note that adding a script to "
4271 "C<regressions/> is slower, so if possible use the first method."
4275 #: ../src/guestfs.pod:2238
4277 "The following describes the test environment used when you add an API test "
4278 "in C<generator_actions.ml>."
4282 #: ../src/guestfs.pod:2241
4283 msgid "The test environment has 4 block devices:"
4287 #: ../src/guestfs.pod:2245
4288 msgid "C</dev/sda> 500MB"
4292 #: ../src/guestfs.pod:2247
4293 msgid "General block device for testing."
4297 #: ../src/guestfs.pod:2249
4298 msgid "C</dev/sdb> 50MB"
4302 #: ../src/guestfs.pod:2251
4304 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4309 #: ../src/guestfs.pod:2254
4310 msgid "C</dev/sdc> 10MB"
4314 #: ../src/guestfs.pod:2256
4315 msgid "Used in a few tests where two block devices are needed."
4319 #: ../src/guestfs.pod:2258
4324 #: ../src/guestfs.pod:2260
4325 msgid "ISO with fixed content (see C<images/test.iso>)."
4329 #: ../src/guestfs.pod:2264
4331 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4332 "appliance and block devices are reused between tests. So don't try testing "
4333 "L</guestfs_kill_subprocess> :-x"
4337 #: ../src/guestfs.pod:2268
4339 "Each test starts with an initial scenario, selected using one of the "
4340 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4341 "initialize the disks mentioned above in a particular way as documented in "
4342 "C<generator_types.ml>. You should not assume anything about the previous "
4343 "contents of other disks that are not initialized."
4347 #: ../src/guestfs.pod:2274
4349 "You can add a prerequisite clause to any individual test. This is a "
4350 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4351 "if testing a command which might not work on all variations of libguestfs "
4352 "builds. A test that has prerequisite of C<Always> means to run "
4357 #: ../src/guestfs.pod:2280
4359 "In addition, packagers can skip individual tests by setting environment "
4360 "variables before running C<make check>."
4364 #: ../src/guestfs.pod:2283
4367 " SKIP_TEST_<CMD>_<NUM>=1\n"
4372 #: ../src/guestfs.pod:2285
4373 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4377 #: ../src/guestfs.pod:2287
4382 #: ../src/guestfs.pod:2289
4385 " SKIP_TEST_<CMD>=1\n"
4390 #: ../src/guestfs.pod:2291
4391 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4395 #: ../src/guestfs.pod:2293
4396 msgid "Packagers can run only certain tests by setting for example:"
4400 #: ../src/guestfs.pod:2295
4403 " TEST_ONLY=\"vfs_type zerofree\"\n"
4408 #: ../src/guestfs.pod:2297
4410 "See C<capitests/tests.c> for more details of how these environment variables "
4415 #: ../src/guestfs.pod:2300
4416 msgid "DEBUGGING NEW API ACTIONS"
4420 #: ../src/guestfs.pod:2302
4421 msgid "Test new actions work before submitting them."
4425 #: ../src/guestfs.pod:2304
4426 msgid "You can use guestfish to try out new commands."
4430 #: ../src/guestfs.pod:2306
4432 "Debugging the daemon is a problem because it runs inside a minimal "
4433 "environment. However you can fprintf messages in the daemon to stderr, and "
4434 "they will show up if you use C<guestfish -v>."
4438 #: ../src/guestfs.pod:2310
4439 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4443 #: ../src/guestfs.pod:2312
4445 "Our C source code generally adheres to some basic code-formatting "
4446 "conventions. The existing code base is not totally consistent on this "
4447 "front, but we do prefer that contributed code be formatted similarly. In "
4448 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4449 "indentation level, and other than that, follow the K&R style."
4453 #: ../src/guestfs.pod:2318
4455 "If you use Emacs, add the following to one of one of your start-up files "
4456 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4460 #: ../src/guestfs.pod:2321
4463 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4464 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4465 " (add-hook 'find-file-hook\n"
4466 " '(lambda () (if (and buffer-file-name\n"
4467 " (string-match \"/libguestfs\\\\>\"\n"
4468 " (buffer-file-name))\n"
4469 " (not (string-equal mode-name \"Change Log\"))\n"
4470 " (not (string-equal mode-name \"Makefile\")))\n"
4471 " (setq indent-tabs-mode nil))))\n"
4476 #: ../src/guestfs.pod:2331
4479 " ;;; When editing C sources in libguestfs, use this style.\n"
4480 " (defun libguestfs-c-mode ()\n"
4481 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4483 " (c-set-style \"K&R\")\n"
4484 " (setq c-indent-level 2)\n"
4485 " (setq c-basic-offset 2))\n"
4486 " (add-hook 'c-mode-hook\n"
4487 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4488 " (buffer-file-name))\n"
4489 " (libguestfs-c-mode))))\n"
4494 #: ../src/guestfs.pod:2343
4495 msgid "Enable warnings when compiling (and fix any problems this finds):"
4499 #: ../src/guestfs.pod:2346
4502 " ./configure --enable-gcc-warnings\n"
4507 #: ../src/guestfs.pod:2348
4508 msgid "Useful targets are:"
4512 #: ../src/guestfs.pod:2350
4515 " make syntax-check # checks the syntax of the C code\n"
4516 " make check # runs the test suite\n"
4521 #: ../src/guestfs.pod:2353
4522 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4526 #: ../src/guestfs.pod:2355
4528 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4529 "which are used to do shell quoting."
4533 #: ../src/guestfs.pod:2360
4538 #: ../src/guestfs.pod:2362
4540 "Simple shell quoted string. Any spaces or other shell characters are "
4545 #: ../src/guestfs.pod:2365
4550 #: ../src/guestfs.pod:2367
4552 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4557 #: ../src/guestfs.pod:2372 ../fish/guestfish.pod:240 ../fish/guestfish.pod:599
4558 msgid "For example:"
4562 #: ../src/guestfs.pod:2374
4565 " asprintf (&cmd, \"cat %R\", path);\n"
4570 #: ../src/guestfs.pod:2376
4571 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4575 #: ../src/guestfs.pod:2378
4577 "I<Note:> Do I<not> use these when you are passing parameters to the "
4578 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4579 "because they are not passed via the shell (instead, straight to exec). You "
4580 "probably want to use the C<sysroot_path()> function however."
4584 #: ../src/guestfs.pod:2384
4585 msgid "SUBMITTING YOUR NEW API ACTIONS"
4589 #: ../src/guestfs.pod:2386
4591 "Submit patches to the mailing list: "
4592 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
4593 "L<rjones@redhat.com>."
4597 #: ../src/guestfs.pod:2390
4598 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
4602 #: ../src/guestfs.pod:2392
4603 msgid "We support i18n (gettext anyhow) in the library."
4607 #: ../src/guestfs.pod:2394
4609 "However many messages come from the daemon, and we don't translate those at "
4610 "the moment. One reason is that the appliance generally has all locale files "
4611 "removed from it, because they take up a lot of space. So we'd have to readd "
4612 "some of those, as well as copying our PO files into the appliance."
4616 #: ../src/guestfs.pod:2400
4618 "Debugging messages are never translated, since they are intended for the "
4623 #: ../src/guestfs.pod:2403
4624 msgid "SOURCE CODE SUBDIRECTORIES"
4628 #: ../src/guestfs.pod:2407 ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3808
4629 msgid "C<appliance>"
4633 #: ../src/guestfs.pod:2409
4634 msgid "The libguestfs appliance, build scripts and so on."
4638 #: ../src/guestfs.pod:2411
4639 msgid "C<capitests>"
4643 #: ../src/guestfs.pod:2413
4644 msgid "Automated tests of the C API."
4648 #: ../src/guestfs.pod:2415
4653 #: ../src/guestfs.pod:2417
4655 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
4660 #: ../src/guestfs.pod:2420
4665 #: ../src/guestfs.pod:2422
4666 msgid "Outside contributions, experimental parts."
4670 #: ../src/guestfs.pod:2424
4675 #: ../src/guestfs.pod:2426
4677 "The daemon that runs inside the libguestfs appliance and carries out "
4682 #: ../src/guestfs.pod:2429
4687 #: ../src/guestfs.pod:2431
4688 msgid "L<virt-df(1)> command and documentation."
4692 #: ../src/guestfs.pod:2433
4697 #: ../src/guestfs.pod:2435
4698 msgid "C API example code."
4702 #: ../src/guestfs.pod:2437
4707 #: ../src/guestfs.pod:2439
4709 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
4710 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
4711 "L<virt-tar-out(1)>."
4715 #: ../src/guestfs.pod:2443
4720 #: ../src/guestfs.pod:2445
4721 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
4725 #: ../src/guestfs.pod:2447
4726 msgid "C<generator>"
4730 #: ../src/guestfs.pod:2449
4732 "The crucially important generator, used to automatically generate large "
4733 "amounts of boilerplate C code for things like RPC and bindings."
4737 #: ../src/guestfs.pod:2452
4742 #: ../src/guestfs.pod:2454
4743 msgid "Files used by the test suite."
4747 #: ../src/guestfs.pod:2456
4748 msgid "Some \"phony\" guest images which we test against."
4752 #: ../src/guestfs.pod:2458
4753 msgid "C<inspector>"
4757 #: ../src/guestfs.pod:2460
4758 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
4762 #: ../src/guestfs.pod:2462
4767 #: ../src/guestfs.pod:2464
4768 msgid "Logo used on the website. The fish is called Arthur by the way."
4772 #: ../src/guestfs.pod:2466
4777 #: ../src/guestfs.pod:2468
4778 msgid "M4 macros used by autoconf."
4782 #: ../src/guestfs.pod:2470
4787 #: ../src/guestfs.pod:2472
4788 msgid "Translations of simple gettext strings."
4792 #: ../src/guestfs.pod:2474
4797 #: ../src/guestfs.pod:2476
4799 "The build infrastructure and PO files for translations of manpages and POD "
4800 "files. Eventually this will be combined with the C<po> directory, but that "
4801 "is rather complicated."
4805 #: ../src/guestfs.pod:2480
4806 msgid "C<regressions>"
4810 #: ../src/guestfs.pod:2482
4811 msgid "Regression tests."
4815 #: ../src/guestfs.pod:2484
4820 #: ../src/guestfs.pod:2486
4821 msgid "L<virt-rescue(1)> command and documentation."
4825 #: ../src/guestfs.pod:2488
4830 #: ../src/guestfs.pod:2490
4831 msgid "Source code to the C library."
4835 #: ../src/guestfs.pod:2492
4840 #: ../src/guestfs.pod:2494
4841 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
4845 #: ../src/guestfs.pod:2496
4846 msgid "C<test-tool>"
4850 #: ../src/guestfs.pod:2498
4852 "Test tool for end users to test if their qemu/kernel combination will work "
4857 #: ../src/guestfs.pod:2501
4862 #: ../src/guestfs.pod:2503
4867 #: ../src/guestfs.pod:2505
4872 #: ../src/guestfs.pod:2507
4877 #: ../src/guestfs.pod:2509
4882 #: ../src/guestfs.pod:2511
4887 #: ../src/guestfs.pod:2513
4892 #: ../src/guestfs.pod:2515
4897 #: ../src/guestfs.pod:2517
4898 msgid "Language bindings."
4902 #: ../src/guestfs.pod:2521 ../fish/guestfish.pod:996 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
4903 msgid "ENVIRONMENT VARIABLES"
4907 #: ../src/guestfs.pod:2525 ../fish/guestfish.pod:1022
4908 msgid "LIBGUESTFS_APPEND"
4912 #: ../src/guestfs.pod:2527 ../fish/guestfish.pod:1024
4913 msgid "Pass additional options to the guest kernel."
4917 #: ../src/guestfs.pod:2529 ../fish/guestfish.pod:1026
4918 msgid "LIBGUESTFS_DEBUG"
4922 #: ../src/guestfs.pod:2531
4924 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
4925 "effect as calling C<guestfs_set_verbose (g, 1)>."
4929 #: ../src/guestfs.pod:2534 ../fish/guestfish.pod:1031
4930 msgid "LIBGUESTFS_MEMSIZE"
4934 #: ../src/guestfs.pod:2536 ../fish/guestfish.pod:1033
4935 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
4939 #: ../src/guestfs.pod:2539 ../fish/guestfish.pod:1036
4942 " LIBGUESTFS_MEMSIZE=700\n"
4947 #: ../src/guestfs.pod:2541 ../fish/guestfish.pod:1038
4948 msgid "LIBGUESTFS_PATH"
4952 #: ../src/guestfs.pod:2543
4954 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
4955 "the discussion of paths in section PATH above."
4959 #: ../src/guestfs.pod:2546 ../fish/guestfish.pod:1043
4960 msgid "LIBGUESTFS_QEMU"
4964 #: ../src/guestfs.pod:2548 ../fish/guestfish.pod:1045
4966 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4967 "which was found at compile time by the configure script is used."
4971 #: ../src/guestfs.pod:2552
4972 msgid "See also L</QEMU WRAPPERS> above."
4976 #: ../src/guestfs.pod:2554 ../fish/guestfish.pod:1049
4977 msgid "LIBGUESTFS_TRACE"
4981 #: ../src/guestfs.pod:2556
4983 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4984 "effect as calling C<guestfs_set_trace (g, 1)>."
4988 #: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1058
4993 #: ../src/guestfs.pod:2561 ../fish/guestfish.pod:1060
4995 "Location of temporary directory, defaults to C</tmp> except for the cached "
4996 "supermin appliance which defaults to C</var/tmp>."
5000 #: ../src/guestfs.pod:2564 ../fish/guestfish.pod:1063
5002 "If libguestfs was compiled to use the supermin appliance then the real "
5003 "appliance is cached in this directory, shared between all handles belonging "
5004 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5005 "use in case C</var/tmp> is not large enough."
5009 #: ../src/guestfs.pod:2572 ../fish/guestfish.pod:1121 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:238 ../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:539 ../tools/virt-list-partitions.pl:257
5014 #: ../src/guestfs.pod:2574
5016 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5017 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5018 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5019 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5020 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5021 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5022 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5023 "L<http://libguestfs.org/>."
5027 #: ../src/guestfs.pod:2601
5029 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5030 "L<lvm(8)>, L<disktype(1)>."
5034 #: ../src/guestfs.pod:2608 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
5039 #: ../src/guestfs.pod:2610
5040 msgid "To get a list of bugs against libguestfs use this link:"
5044 #: ../src/guestfs.pod:2612
5045 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5049 #: ../src/guestfs.pod:2614
5050 msgid "To report a new bug against libguestfs use this link:"
5054 #: ../src/guestfs.pod:2616
5055 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5059 #: ../src/guestfs.pod:2618
5060 msgid "When reporting a bug, please check:"
5064 #: ../src/guestfs.pod:2624
5065 msgid "That the bug hasn't been reported already."
5069 #: ../src/guestfs.pod:2628
5070 msgid "That you are testing a recent version."
5074 #: ../src/guestfs.pod:2632
5075 msgid "Describe the bug accurately, and give a way to reproduce it."
5079 #: ../src/guestfs.pod:2636
5081 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5086 #: ../src/guestfs.pod:2641 ../fish/guestfish.pod:1144 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:249
5091 #: ../src/guestfs.pod:2643 ../fish/guestfish.pod:1146 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:251
5092 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5096 #: ../src/guestfs.pod:2645 ../fish/guestfish.pod:1148 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:253 ../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:568 ../tools/virt-list-partitions.pl:273
5101 #: ../src/guestfs.pod:2647 ../fish/guestfish.pod:1150 ../fuse/guestmount.pod:255
5102 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
5106 #: ../src/guestfs.pod:2650
5108 "This library is free software; you can redistribute it and/or modify it "
5109 "under the terms of the GNU Lesser General Public License as published by the "
5110 "Free Software Foundation; either version 2 of the License, or (at your "
5111 "option) any later version."
5115 #: ../src/guestfs.pod:2655
5117 "This library is distributed in the hope that it will be useful, but WITHOUT "
5118 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5119 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5124 #: ../src/guestfs.pod:2660
5126 "You should have received a copy of the GNU Lesser General Public License "
5127 "along with this library; if not, write to the Free Software Foundation, "
5128 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5132 #: ../src/guestfs-actions.pod:1
5133 msgid "guestfs_add_cdrom"
5137 #: ../src/guestfs-actions.pod:3
5141 " guestfs_add_cdrom (guestfs_h *g,\n"
5142 " const char *filename);\n"
5147 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5148 msgid "This function adds a virtual CD-ROM disk image to the guest."
5152 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5153 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5157 #: ../src/guestfs-actions.pod:17
5159 "This call checks for the existence of C<filename>. This stops you from "
5160 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5161 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5166 #: ../src/guestfs-actions.pod:24
5168 "If you just want to add an ISO file (often you use this as an efficient way "
5169 "to transfer large files into the guest), then you should probably use "
5170 "C<guestfs_add_drive_ro> instead."
5174 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:134 ../src/guestfs-actions.pod:195 ../src/guestfs-actions.pod:232 ../src/guestfs-actions.pod:246 ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:287 ../src/guestfs-actions.pod:301 ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:436 ../src/guestfs-actions.pod:450 ../src/guestfs-actions.pod:495 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:541 ../src/guestfs-actions.pod:608 ../src/guestfs-actions.pod:641 ../src/guestfs-actions.pod:655 ../src/guestfs-actions.pod:670 ../src/guestfs-actions.pod:769 ../src/guestfs-actions.pod:787 ../src/guestfs-actions.pod:801 ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:996 ../src/guestfs-actions.pod:1014 ../src/guestfs-actions.pod:1098 ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1149 ../src/guestfs-actions.pod:1169 ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1270 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1332 ../src/guestfs-actions.pod:1438 ../src/guestfs-actions.pod:1472 ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1712 ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:2261 ../src/guestfs-actions.pod:2405 ../src/guestfs-actions.pod:2466 ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3351 ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3567 ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3690 ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3750 ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:3805 ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3890 ../src/guestfs-actions.pod:3926 ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:3955 ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4113 ../src/guestfs-actions.pod:4164 ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4276 ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4458 ../src/guestfs-actions.pod:4477 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4508 ../src/guestfs-actions.pod:4525 ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4553 ../src/guestfs-actions.pod:4568 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4638 ../src/guestfs-actions.pod:4652 ../src/guestfs-actions.pod:4669 ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4769 ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4832 ../src/guestfs-actions.pod:4966 ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5095 ../src/guestfs-actions.pod:5161 ../src/guestfs-actions.pod:5178 ../src/guestfs-actions.pod:5191 ../src/guestfs-actions.pod:5205 ../src/guestfs-actions.pod:5494 ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5532 ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5556 ../src/guestfs-actions.pod:5570 ../src/guestfs-actions.pod:5582 ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5612 ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5652 ../src/guestfs-actions.pod:5671 ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:5717 ../src/guestfs-actions.pod:5740 ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5817 ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:5862 ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:5929 ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5959 ../src/guestfs-actions.pod:5978 ../src/guestfs-actions.pod:6015 ../src/guestfs-actions.pod:6038 ../src/guestfs-actions.pod:6064 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6293 ../src/guestfs-actions.pod:6305 ../src/guestfs-actions.pod:6318 ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6353 ../src/guestfs-actions.pod:6366 ../src/guestfs-actions.pod:6379 ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6407 ../src/guestfs-actions.pod:6466 ../src/guestfs-actions.pod:6483 ../src/guestfs-actions.pod:6499 ../src/guestfs-actions.pod:6515 ../src/guestfs-actions.pod:6532 ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:6565 ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6669 ../src/guestfs-actions.pod:6687 ../src/guestfs-actions.pod:6721 ../src/guestfs-actions.pod:6757 ../src/guestfs-actions.pod:6876 ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6908 ../src/guestfs-actions.pod:6963 ../src/guestfs-actions.pod:6976 ../src/guestfs-actions.pod:7021 ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7134 ../src/guestfs-actions.pod:7200 ../src/guestfs-actions.pod:7219 ../src/guestfs-actions.pod:7248
5175 msgid "This function returns 0 on success or -1 on error."
5179 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:269 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:158 ../fish/guestfish-actions.pod:172
5181 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5186 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:251 ../src/guestfs-actions.pod:272 ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:4301 ../src/guestfs-actions.pod:7142 ../src/guestfs-actions.pod:7311 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:175 ../fish/guestfish-actions.pod:956 ../fish/guestfish-actions.pod:1319 ../fish/guestfish-actions.pod:1333 ../fish/guestfish-actions.pod:2908 ../fish/guestfish-actions.pod:4762 ../fish/guestfish-actions.pod:4859
5188 "Deprecated functions will not be removed from the API, but the fact that "
5189 "they are deprecated indicates that there are problems with correct use of "
5194 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:136 ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1911 ../src/guestfs-actions.pod:2009 ../src/guestfs-actions.pod:2112 ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:5836 ../src/guestfs-actions.pod:5946 ../src/guestfs-actions.pod:6409 ../src/guestfs-actions.pod:6534 ../src/guestfs-actions.pod:7056
5195 msgid "(Added in 0.3)"
5199 #: ../src/guestfs-actions.pod:41
5200 msgid "guestfs_add_domain"
5204 #: ../src/guestfs-actions.pod:43
5208 " guestfs_add_domain (guestfs_h *g,\n"
5209 " const char *dom,\n"
5215 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145 ../src/guestfs-actions.pod:4315
5217 "You may supply a list of optional arguments to this call. Use zero or more "
5218 "of the following pairs of parameters, and terminate the list with C<-1> on "
5219 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5223 #: ../src/guestfs-actions.pod:53
5226 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5227 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5228 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5229 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5234 #: ../src/guestfs-actions.pod:58
5236 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5237 "It works by connecting to libvirt, requesting the domain and domain XML from "
5238 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5243 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5245 "The number of disks added is returned. This operation is atomic: if an "
5246 "error is returned, then no disks are added."
5250 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5252 "This function does some minimal checks to make sure the libvirt domain is "
5253 "not running (unless C<readonly> is true). In a future version we will try "
5254 "to acquire the libvirt lock on each disk."
5258 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5260 "Disks must be accessible locally. This often means that adding disks from a "
5261 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5262 "unless those disks are accessible via the same device path locally too."
5266 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5268 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5269 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5270 "default libvirt URI (or one set through an environment variable, see the "
5271 "libvirt documentation for full details)."
5275 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5277 "The optional C<live> flag controls whether this call will try to connect to "
5278 "a running virtual machine C<guestfsd> process if it sees a suitable "
5279 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5280 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5281 "DAEMONS> for more information."
5285 #: ../src/guestfs-actions.pod:88
5287 "The other optional parameters are passed directly through to "
5288 "C<guestfs_add_drive_opts>."
5292 #: ../src/guestfs-actions.pod:91 ../src/guestfs-actions.pod:344 ../src/guestfs-actions.pod:509 ../src/guestfs-actions.pod:687 ../src/guestfs-actions.pod:718 ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:755 ../src/guestfs-actions.pod:1315 ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1872 ../src/guestfs-actions.pod:1981 ../src/guestfs-actions.pod:2021 ../src/guestfs-actions.pod:2076 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2392 ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2740 ../src/guestfs-actions.pod:4741 ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:5301 ../src/guestfs-actions.pod:6642 ../src/guestfs-actions.pod:7067 ../src/guestfs-actions.pod:7080 ../src/guestfs-actions.pod:7093
5293 msgid "On error this function returns -1."
5297 #: ../src/guestfs-actions.pod:93
5298 msgid "(Added in 1.7.4)"
5302 #: ../src/guestfs-actions.pod:95
5303 msgid "guestfs_add_domain_va"
5307 #: ../src/guestfs-actions.pod:97
5311 " guestfs_add_domain_va (guestfs_h *g,\n"
5312 " const char *dom,\n"
5318 #: ../src/guestfs-actions.pod:102
5319 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5323 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219 ../src/guestfs-actions.pod:4368 ../src/guestfs-actions.pod:4380
5324 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5328 #: ../src/guestfs-actions.pod:106
5329 msgid "guestfs_add_domain_argv"
5333 #: ../src/guestfs-actions.pod:108
5337 " guestfs_add_domain_argv (guestfs_h *g,\n"
5338 " const char *dom,\n"
5339 " const struct guestfs_add_domain_argv *optargs);\n"
5344 #: ../src/guestfs-actions.pod:113
5345 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5349 #: ../src/guestfs-actions.pod:117
5350 msgid "guestfs_add_drive"
5354 #: ../src/guestfs-actions.pod:119
5358 " guestfs_add_drive (guestfs_h *g,\n"
5359 " const char *filename);\n"
5364 #: ../src/guestfs-actions.pod:123
5366 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5367 "optional parameters, so the disk is added writable, with the format being "
5368 "detected automatically."
5372 #: ../src/guestfs-actions.pod:127
5374 "Automatic detection of the format opens you up to a potential security hole "
5375 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5376 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5377 "you should think about replacing calls to this function with calls to "
5378 "C<guestfs_add_drive_opts>, and specifying the format."
5382 #: ../src/guestfs-actions.pod:138
5383 msgid "guestfs_add_drive_opts"
5387 #: ../src/guestfs-actions.pod:140
5391 " guestfs_add_drive_opts (guestfs_h *g,\n"
5392 " const char *filename,\n"
5398 #: ../src/guestfs-actions.pod:150
5401 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5402 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5403 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5408 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
5410 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5411 "The first time you call this function, the disk appears as C</dev/sda>, the "
5412 "second time as C</dev/sdb>, and so on."
5416 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
5418 "You don't necessarily need to be root when using libguestfs. However you "
5419 "obviously do need sufficient permissions to access the filename for whatever "
5420 "operations you want to perform (ie. read access if you just want to read the "
5421 "image or write access if you want to modify the image)."
5425 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
5426 msgid "This call checks that C<filename> exists."
5430 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4326 ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:2919
5431 msgid "The optional arguments are:"
5435 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
5440 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
5442 "If true then the image is treated as read-only. Writes are still allowed, "
5443 "but they are stored in a temporary snapshot overlay which is discarded at "
5444 "the end. The disk that you add is not modified."
5448 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
5453 #: ../src/guestfs-actions.pod:179
5455 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5456 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5457 "Possible formats include C<raw> and C<qcow2>."
5461 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
5463 "Automatic detection of the format opens you up to a potential security hole "
5464 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5465 "RHBZ#642934. Specifying the format closes this security hole."
5469 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
5474 #: ../src/guestfs-actions.pod:190
5476 "This rarely-used option lets you emulate the behaviour of the deprecated "
5477 "C<guestfs_add_drive_with_if> call (q.v.)"
5481 #: ../src/guestfs-actions.pod:197
5482 msgid "(Added in 1.5.23)"
5486 #: ../src/guestfs-actions.pod:199
5487 msgid "guestfs_add_drive_opts_va"
5491 #: ../src/guestfs-actions.pod:201
5495 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5496 " const char *filename,\n"
5502 #: ../src/guestfs-actions.pod:206
5503 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5507 #: ../src/guestfs-actions.pod:210
5508 msgid "guestfs_add_drive_opts_argv"
5512 #: ../src/guestfs-actions.pod:212
5516 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5517 " const char *filename,\n"
5518 " const struct guestfs_add_drive_opts_argv "
5524 #: ../src/guestfs-actions.pod:217
5525 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5529 #: ../src/guestfs-actions.pod:221
5530 msgid "guestfs_add_drive_ro"
5534 #: ../src/guestfs-actions.pod:223
5538 " guestfs_add_drive_ro (guestfs_h *g,\n"
5539 " const char *filename);\n"
5544 #: ../src/guestfs-actions.pod:227
5546 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5547 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5548 "disk is added read-only, with the format being detected automatically."
5552 #: ../src/guestfs-actions.pod:234
5553 msgid "(Added in 1.0.38)"
5557 #: ../src/guestfs-actions.pod:236
5558 msgid "guestfs_add_drive_ro_with_if"
5562 #: ../src/guestfs-actions.pod:238
5566 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
5567 " const char *filename,\n"
5568 " const char *iface);\n"
5573 #: ../src/guestfs-actions.pod:243
5575 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
5576 "QEMU interface emulation to use at run time."
5580 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:2351
5581 msgid "(Added in 1.0.84)"
5585 #: ../src/guestfs-actions.pod:257
5586 msgid "guestfs_add_drive_with_if"
5590 #: ../src/guestfs-actions.pod:259
5594 " guestfs_add_drive_with_if (guestfs_h *g,\n"
5595 " const char *filename,\n"
5596 " const char *iface);\n"
5601 #: ../src/guestfs-actions.pod:264
5603 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
5604 "QEMU interface emulation to use at run time."
5608 #: ../src/guestfs-actions.pod:278
5609 msgid "guestfs_aug_clear"
5613 #: ../src/guestfs-actions.pod:280
5617 " guestfs_aug_clear (guestfs_h *g,\n"
5618 " const char *augpath);\n"
5623 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
5625 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5626 "L<augtool(1)> C<clear> command."
5630 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2101
5631 msgid "(Added in 1.3.4)"
5635 #: ../src/guestfs-actions.pod:291
5636 msgid "guestfs_aug_close"
5640 #: ../src/guestfs-actions.pod:293
5644 " guestfs_aug_close (guestfs_h *g);\n"
5649 #: ../src/guestfs-actions.pod:296
5651 "Close the current Augeas handle and free up any resources used by it. After "
5652 "calling this, you have to call C<guestfs_aug_init> again before you can use "
5653 "any other Augeas functions."
5657 #: ../src/guestfs-actions.pod:303 ../src/guestfs-actions.pod:328 ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:418 ../src/guestfs-actions.pod:438 ../src/guestfs-actions.pod:452 ../src/guestfs-actions.pod:483 ../src/guestfs-actions.pod:497 ../src/guestfs-actions.pod:511 ../src/guestfs-actions.pod:525 ../src/guestfs-actions.pod:543 ../src/guestfs-actions.pod:5352
5658 msgid "(Added in 0.7)"
5662 #: ../src/guestfs-actions.pod:305
5663 msgid "guestfs_aug_defnode"
5667 #: ../src/guestfs-actions.pod:307
5670 " struct guestfs_int_bool *\n"
5671 " guestfs_aug_defnode (guestfs_h *g,\n"
5672 " const char *name,\n"
5673 " const char *expr,\n"
5674 " const char *val);\n"
5679 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
5680 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5684 #: ../src/guestfs-actions.pod:316
5686 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5687 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
5688 "containing that single node."
5692 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
5694 "On success this returns a pair containing the number of nodes in the "
5695 "nodeset, and a boolean flag if a node was created."
5699 #: ../src/guestfs-actions.pod:324
5701 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
5702 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
5706 #: ../src/guestfs-actions.pod:330
5707 msgid "guestfs_aug_defvar"
5711 #: ../src/guestfs-actions.pod:332
5715 " guestfs_aug_defvar (guestfs_h *g,\n"
5716 " const char *name,\n"
5717 " const char *expr);\n"
5722 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
5724 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5725 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5729 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
5731 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5732 "evaluates to something which is not a nodeset."
5736 #: ../src/guestfs-actions.pod:348
5737 msgid "guestfs_aug_get"
5741 #: ../src/guestfs-actions.pod:350
5745 " guestfs_aug_get (guestfs_h *g,\n"
5746 " const char *augpath);\n"
5751 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
5753 "Look up the value associated with C<path>. If C<path> matches exactly one "
5754 "node, the C<value> is returned."
5758 #: ../src/guestfs-actions.pod:357 ../src/guestfs-actions.pod:857 ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:935 ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201 ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1349 ../src/guestfs-actions.pod:1540 ../src/guestfs-actions.pod:1652 ../src/guestfs-actions.pod:1815 ../src/guestfs-actions.pod:1832 ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:1954 ../src/guestfs-actions.pod:2124 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2523 ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2671 ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2805 ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:2945 ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4142 ../src/guestfs-actions.pod:4887 ../src/guestfs-actions.pod:5080 ../src/guestfs-actions.pod:5250 ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5477 ../src/guestfs-actions.pod:6085 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6142 ../src/guestfs-actions.pod:6816 ../src/guestfs-actions.pod:6835 ../src/guestfs-actions.pod:6853 ../src/guestfs-actions.pod:7033 ../src/guestfs-actions.pod:7305
5760 "This function returns a string, or NULL on error. I<The caller must free "
5761 "the returned string after use>."
5765 #: ../src/guestfs-actions.pod:362
5766 msgid "guestfs_aug_init"
5770 #: ../src/guestfs-actions.pod:364
5774 " guestfs_aug_init (guestfs_h *g,\n"
5775 " const char *root,\n"
5781 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
5783 "Create a new Augeas handle for editing configuration files. If there was "
5784 "any previous Augeas handle associated with this guestfs session, then it is "
5789 #: ../src/guestfs-actions.pod:373
5790 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5794 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
5795 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5799 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
5801 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5802 "logical I<or> of the following integers:"
5806 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
5807 msgid "C<AUG_SAVE_BACKUP> = 1"
5811 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
5812 msgid "Keep the original file with a C<.augsave> extension."
5816 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
5817 msgid "C<AUG_SAVE_NEWFILE> = 2"
5821 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
5823 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5824 "original. Overrides C<AUG_SAVE_BACKUP>."
5828 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
5829 msgid "C<AUG_TYPE_CHECK> = 4"
5833 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
5834 msgid "Typecheck lenses (can be expensive)."
5838 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
5839 msgid "C<AUG_NO_STDINC> = 8"
5843 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
5844 msgid "Do not use standard load path for modules."
5848 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
5849 msgid "C<AUG_SAVE_NOOP> = 16"
5853 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
5854 msgid "Make save a no-op, just record what would have been changed."
5858 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
5859 msgid "C<AUG_NO_LOAD> = 32"
5863 #: ../src/guestfs-actions.pod:408
5864 msgid "Do not load the tree in C<guestfs_aug_init>."
5868 #: ../src/guestfs-actions.pod:412
5869 msgid "To close the handle, you can call C<guestfs_aug_close>."
5873 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
5874 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5878 #: ../src/guestfs-actions.pod:420
5879 msgid "guestfs_aug_insert"
5883 #: ../src/guestfs-actions.pod:422
5887 " guestfs_aug_insert (guestfs_h *g,\n"
5888 " const char *augpath,\n"
5889 " const char *label,\n"
5895 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
5897 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5898 "or after C<path> (depending on the boolean flag C<before>)."
5902 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
5904 "C<path> must match exactly one existing node in the tree, and C<label> must "
5905 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5909 #: ../src/guestfs-actions.pod:440
5910 msgid "guestfs_aug_load"
5914 #: ../src/guestfs-actions.pod:442
5918 " guestfs_aug_load (guestfs_h *g);\n"
5923 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
5924 msgid "Load files into the tree."
5928 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
5929 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5933 #: ../src/guestfs-actions.pod:454
5934 msgid "guestfs_aug_ls"
5938 #: ../src/guestfs-actions.pod:456
5942 " guestfs_aug_ls (guestfs_h *g,\n"
5943 " const char *augpath);\n"
5948 #: ../src/guestfs-actions.pod:460
5950 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5951 "sorting the resulting nodes into alphabetical order."
5955 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:479 ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1364 ../src/guestfs-actions.pod:1383 ../src/guestfs-actions.pod:1486 ../src/guestfs-actions.pod:1505 ../src/guestfs-actions.pod:1754 ../src/guestfs-actions.pod:2196 ../src/guestfs-actions.pod:2212 ../src/guestfs-actions.pod:2231 ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2369 ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2879 ../src/guestfs-actions.pod:3147 ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3494 ../src/guestfs-actions.pod:3599 ../src/guestfs-actions.pod:4004 ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:5222 ../src/guestfs-actions.pod:5348 ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:6158 ../src/guestfs-actions.pod:6219 ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6420 ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6926 ../src/guestfs-actions.pod:6946 ../src/guestfs-actions.pod:6993 ../src/guestfs-actions.pod:7158 ../src/guestfs-actions.pod:7177 ../src/guestfs-actions.pod:7262 ../src/guestfs-actions.pod:7281 ../src/guestfs-actions.pod:7327 ../src/guestfs-actions.pod:7346
5957 "This function returns a NULL-terminated array of strings (like "
5958 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
5959 "strings and the array after use>."
5963 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1421 ../src/guestfs-actions.pod:3225 ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:4115 ../src/guestfs-actions.pod:4278 ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5558 ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:5584 ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:6910 ../src/guestfs-actions.pod:7146
5964 msgid "(Added in 0.8)"
5968 #: ../src/guestfs-actions.pod:469
5969 msgid "guestfs_aug_match"
5973 #: ../src/guestfs-actions.pod:471
5977 " guestfs_aug_match (guestfs_h *g,\n"
5978 " const char *augpath);\n"
5983 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
5985 "Returns a list of paths which match the path expression C<path>. The "
5986 "returned paths are sufficiently qualified so that they match exactly one "
5987 "node in the current tree."
5991 #: ../src/guestfs-actions.pod:485
5992 msgid "guestfs_aug_mv"
5996 #: ../src/guestfs-actions.pod:487
6000 " guestfs_aug_mv (guestfs_h *g,\n"
6001 " const char *src,\n"
6002 " const char *dest);\n"
6007 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6009 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6010 "C<dest> is overwritten if it exists."
6014 #: ../src/guestfs-actions.pod:499
6015 msgid "guestfs_aug_rm"
6019 #: ../src/guestfs-actions.pod:501
6023 " guestfs_aug_rm (guestfs_h *g,\n"
6024 " const char *augpath);\n"
6029 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6030 msgid "Remove C<path> and all of its children."
6034 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6035 msgid "On success this returns the number of entries which were removed."
6039 #: ../src/guestfs-actions.pod:513
6040 msgid "guestfs_aug_save"
6044 #: ../src/guestfs-actions.pod:515
6048 " guestfs_aug_save (guestfs_h *g);\n"
6053 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6054 msgid "This writes all pending changes to disk."
6058 #: ../src/guestfs-actions.pod:520
6060 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6065 #: ../src/guestfs-actions.pod:527
6066 msgid "guestfs_aug_set"
6070 #: ../src/guestfs-actions.pod:529
6074 " guestfs_aug_set (guestfs_h *g,\n"
6075 " const char *augpath,\n"
6076 " const char *val);\n"
6081 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6082 msgid "Set the value associated with C<path> to C<val>."
6086 #: ../src/guestfs-actions.pod:536
6088 "In the Augeas API, it is possible to clear a node by setting the value to "
6089 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6090 "this call. Instead you must use the C<guestfs_aug_clear> call."
6094 #: ../src/guestfs-actions.pod:545
6095 msgid "guestfs_available"
6099 #: ../src/guestfs-actions.pod:547
6103 " guestfs_available (guestfs_h *g,\n"
6104 " char *const *groups);\n"
6109 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6111 "This command is used to check the availability of some groups of "
6112 "functionality in the appliance, which not all builds of the libguestfs "
6113 "appliance will be able to provide."
6117 #: ../src/guestfs-actions.pod:555
6119 "The libguestfs groups, and the functions that those groups correspond to, "
6120 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6121 "runtime by calling C<guestfs_available_all_groups>."
6125 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6127 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6128 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6129 "and Augeas (configuration file editing) functions."
6133 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6134 msgid "The command returns no error if I<all> requested groups are available."
6138 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6140 "It fails with an error if one or more of the requested groups is unavailable "
6145 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6147 "If an unknown group name is included in the list of groups then an error is "
6152 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6157 #: ../src/guestfs-actions.pod:579
6158 msgid "You must call C<guestfs_launch> before calling this function."
6162 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6164 "The reason is because we don't know what groups are supported by the "
6165 "appliance/daemon until it is running and can be queried."
6169 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6171 "If a group of functions is available, this does not necessarily mean that "
6172 "they will work. You still have to check for errors when calling individual "
6173 "API functions even if they are available."
6177 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6179 "It is usually the job of distro packagers to build complete functionality "
6180 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6181 "with all requirements satisfied, will support everything."
6185 #: ../src/guestfs-actions.pod:601
6187 "This call was added in version C<1.0.80>. In previous versions of "
6188 "libguestfs all you could do would be to speculatively execute a command to "
6189 "find out if the daemon implemented it. See also C<guestfs_version>."
6193 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6194 msgid "(Added in 1.0.80)"
6198 #: ../src/guestfs-actions.pod:612
6199 msgid "guestfs_available_all_groups"
6203 #: ../src/guestfs-actions.pod:614
6207 " guestfs_available_all_groups (guestfs_h *g);\n"
6212 #: ../src/guestfs-actions.pod:617
6214 "This command returns a list of all optional groups that this daemon knows "
6215 "about. Note this returns both supported and unsupported groups. To find "
6216 "out which ones the daemon can actually support you have to call "
6217 "C<guestfs_available> on each member of the returned list."
6221 #: ../src/guestfs-actions.pod:623
6222 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6226 #: ../src/guestfs-actions.pod:629
6227 msgid "(Added in 1.3.15)"
6231 #: ../src/guestfs-actions.pod:631
6232 msgid "guestfs_base64_in"
6236 #: ../src/guestfs-actions.pod:633
6240 " guestfs_base64_in (guestfs_h *g,\n"
6241 " const char *base64file,\n"
6242 " const char *filename);\n"
6247 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6248 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6252 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6253 msgid "(Added in 1.3.5)"
6257 #: ../src/guestfs-actions.pod:645
6258 msgid "guestfs_base64_out"
6262 #: ../src/guestfs-actions.pod:647
6266 " guestfs_base64_out (guestfs_h *g,\n"
6267 " const char *filename,\n"
6268 " const char *base64file);\n"
6273 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
6275 "This command downloads the contents of C<filename>, writing it out to local "
6276 "file C<base64file> encoded as base64."
6280 #: ../src/guestfs-actions.pod:659
6281 msgid "guestfs_blockdev_flushbufs"
6285 #: ../src/guestfs-actions.pod:661
6289 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6290 " const char *device);\n"
6295 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
6296 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6300 #: ../src/guestfs-actions.pod:668 ../src/guestfs-actions.pod:685 ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:716 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:753 ../src/guestfs-actions.pod:767 ../src/guestfs-actions.pod:785 ../src/guestfs-actions.pod:799 ../src/guestfs-actions.pod:813 ../fish/guestfish-actions.pod:448 ../fish/guestfish-actions.pod:459 ../fish/guestfish-actions.pod:468 ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:490 ../fish/guestfish-actions.pod:503 ../fish/guestfish-actions.pod:511 ../fish/guestfish-actions.pod:522 ../fish/guestfish-actions.pod:530 ../fish/guestfish-actions.pod:538
6301 msgid "This uses the L<blockdev(8)> command."
6305 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:689 ../src/guestfs-actions.pod:704 ../src/guestfs-actions.pod:720 ../src/guestfs-actions.pod:738 ../src/guestfs-actions.pod:757 ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:789 ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:817
6306 msgid "(Added in 0.9.3)"
6310 #: ../src/guestfs-actions.pod:674
6311 msgid "guestfs_blockdev_getbsz"
6315 #: ../src/guestfs-actions.pod:676
6319 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6320 " const char *device);\n"
6325 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
6326 msgid "This returns the block size of a device."
6330 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782 ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
6332 "(Note this is different from both I<size in blocks> and I<filesystem block "
6337 #: ../src/guestfs-actions.pod:691
6338 msgid "guestfs_blockdev_getro"
6342 #: ../src/guestfs-actions.pod:693
6346 " guestfs_blockdev_getro (guestfs_h *g,\n"
6347 " const char *device);\n"
6352 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
6354 "Returns a boolean indicating if the block device is read-only (true if "
6355 "read-only, false if not)."
6359 #: ../src/guestfs-actions.pod:702 ../src/guestfs-actions.pod:1404 ../src/guestfs-actions.pod:1419 ../src/guestfs-actions.pod:1909 ../src/guestfs-actions.pod:1920 ../src/guestfs-actions.pod:1992 ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2062 ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2110 ../src/guestfs-actions.pod:2965 ../src/guestfs-actions.pod:2982 ../src/guestfs-actions.pod:3001 ../src/guestfs-actions.pod:3164 ../src/guestfs-actions.pod:3178 ../src/guestfs-actions.pod:3193 ../src/guestfs-actions.pod:3207 ../src/guestfs-actions.pod:3223 ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3254 ../src/guestfs-actions.pod:3268 ../src/guestfs-actions.pod:3281 ../src/guestfs-actions.pod:3295 ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3325 ../src/guestfs-actions.pod:4851
6360 msgid "This function returns a C truth value on success or -1 on error."
6364 #: ../src/guestfs-actions.pod:706
6365 msgid "guestfs_blockdev_getsize64"
6369 #: ../src/guestfs-actions.pod:708
6373 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6374 " const char *device);\n"
6379 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
6380 msgid "This returns the size of the device in bytes."
6384 #: ../src/guestfs-actions.pod:714
6385 msgid "See also C<guestfs_blockdev_getsz>."
6389 #: ../src/guestfs-actions.pod:722
6390 msgid "guestfs_blockdev_getss"
6394 #: ../src/guestfs-actions.pod:724
6398 " guestfs_blockdev_getss (guestfs_h *g,\n"
6399 " const char *device);\n"
6404 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
6406 "This returns the size of sectors on a block device. Usually 512, but can be "
6407 "larger for modern devices."
6411 #: ../src/guestfs-actions.pod:731
6413 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6418 #: ../src/guestfs-actions.pod:740
6419 msgid "guestfs_blockdev_getsz"
6423 #: ../src/guestfs-actions.pod:742
6427 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6428 " const char *device);\n"
6433 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
6435 "This returns the size of the device in units of 512-byte sectors (even if "
6436 "the sectorsize isn't 512 bytes ... weird)."
6440 #: ../src/guestfs-actions.pod:749
6442 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6443 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6447 #: ../src/guestfs-actions.pod:759
6448 msgid "guestfs_blockdev_rereadpt"
6452 #: ../src/guestfs-actions.pod:761
6456 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6457 " const char *device);\n"
6462 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
6463 msgid "Reread the partition table on C<device>."
6467 #: ../src/guestfs-actions.pod:773
6468 msgid "guestfs_blockdev_setbsz"
6472 #: ../src/guestfs-actions.pod:775
6476 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6477 " const char *device,\n"
6478 " int blocksize);\n"
6483 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
6484 msgid "This sets the block size of a device."
6488 #: ../src/guestfs-actions.pod:791
6489 msgid "guestfs_blockdev_setro"
6493 #: ../src/guestfs-actions.pod:793
6497 " guestfs_blockdev_setro (guestfs_h *g,\n"
6498 " const char *device);\n"
6503 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
6504 msgid "Sets the block device named C<device> to read-only."
6508 #: ../src/guestfs-actions.pod:805
6509 msgid "guestfs_blockdev_setrw"
6513 #: ../src/guestfs-actions.pod:807
6517 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6518 " const char *device);\n"
6523 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
6524 msgid "Sets the block device named C<device> to read-write."
6528 #: ../src/guestfs-actions.pod:819
6529 msgid "guestfs_case_sensitive_path"
6533 #: ../src/guestfs-actions.pod:821
6537 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6538 " const char *path);\n"
6543 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
6545 "This can be used to resolve case insensitive paths on a filesystem which is "
6546 "case sensitive. The use case is to resolve paths which you have read from "
6547 "Windows configuration files or the Windows Registry, to the true path."
6551 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
6553 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6554 "(and probably others), which is that although the underlying filesystem is "
6555 "case-insensitive, the driver exports the filesystem to Linux as "
6560 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
6562 "One consequence of this is that special directories such as C<c:\\windows> "
6563 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6564 "precise details of how they were created. In Windows itself this would not "
6569 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
6571 "Bug or feature? You decide: "
6572 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6576 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
6578 "This function resolves the true case of each element in the path and returns "
6579 "the case-sensitive path."
6583 #: ../src/guestfs-actions.pod:847
6585 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
6586 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6587 "how the directories were originally created under Windows)."
6591 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
6592 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6596 #: ../src/guestfs-actions.pod:855
6597 msgid "See also C<guestfs_realpath>."
6601 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6838
6602 msgid "(Added in 1.0.75)"
6606 #: ../src/guestfs-actions.pod:862
6611 #: ../src/guestfs-actions.pod:864
6615 " guestfs_cat (guestfs_h *g,\n"
6616 " const char *path);\n"
6621 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5338 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3567
6622 msgid "Return the contents of the file named C<path>."
6626 #: ../src/guestfs-actions.pod:870
6628 "Note that this function cannot correctly handle binary files (specifically, "
6629 "files containing C<\\0> character which is treated as end of string). For "
6630 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
6631 "functions which have a more complex interface."
6635 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1368 ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:1490 ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:1758 ../src/guestfs-actions.pod:2216 ../src/guestfs-actions.pod:2235 ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:2302 ../src/guestfs-actions.pod:2319 ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:5120 ../src/guestfs-actions.pod:5146 ../src/guestfs-actions.pod:5277 ../src/guestfs-actions.pod:5303 ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6278 ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6448 ../src/guestfs-actions.pod:7110 ../src/guestfs-actions.pod:7136 ../src/guestfs-actions.pod:7162 ../src/guestfs-actions.pod:7181 ../src/guestfs-actions.pod:7266 ../src/guestfs-actions.pod:7285 ../src/guestfs-actions.pod:7331 ../src/guestfs-actions.pod:7350 ../fish/guestfish-actions.pod:587 ../fish/guestfish-actions.pod:722 ../fish/guestfish-actions.pod:734 ../fish/guestfish-actions.pod:910 ../fish/guestfish-actions.pod:920 ../fish/guestfish-actions.pod:987 ../fish/guestfish-actions.pod:997 ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1493 ../fish/guestfish-actions.pod:1503 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:1556 ../fish/guestfish-actions.pod:1575 ../fish/guestfish-actions.pod:3437 ../fish/guestfish-actions.pod:3452 ../fish/guestfish-actions.pod:3528 ../fish/guestfish-actions.pod:3545 ../fish/guestfish-actions.pod:3560 ../fish/guestfish-actions.pod:4182 ../fish/guestfish-actions.pod:4228 ../fish/guestfish-actions.pod:4313 ../fish/guestfish-actions.pod:4328 ../fish/guestfish-actions.pod:4738 ../fish/guestfish-actions.pod:4756 ../fish/guestfish-actions.pod:4773 ../fish/guestfish-actions.pod:4783 ../fish/guestfish-actions.pod:4831 ../fish/guestfish-actions.pod:4841 ../fish/guestfish-actions.pod:4870 ../fish/guestfish-actions.pod:4880
6637 "Because of the message protocol, there is a transfer limit of somewhere "
6638 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6642 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7011
6643 msgid "(Added in 0.4)"
6647 #: ../src/guestfs-actions.pod:883
6648 msgid "guestfs_checksum"
6652 #: ../src/guestfs-actions.pod:885
6656 " guestfs_checksum (guestfs_h *g,\n"
6657 " const char *csumtype,\n"
6658 " const char *path);\n"
6663 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
6664 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6668 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
6670 "The type of checksum to compute is given by the C<csumtype> parameter which "
6671 "must have one of the following values:"
6675 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
6680 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
6682 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6687 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
6692 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
6693 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6697 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
6702 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
6703 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6707 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
6712 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
6713 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6717 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
6722 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
6723 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6727 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
6732 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
6733 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6737 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
6742 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
6743 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6747 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
6748 msgid "The checksum is returned as a printable string."
6752 #: ../src/guestfs-actions.pod:931
6753 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6757 #: ../src/guestfs-actions.pod:933
6758 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6762 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246 ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:3180 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3270 ../src/guestfs-actions.pod:3297 ../src/guestfs-actions.pod:6694
6763 msgid "(Added in 1.0.2)"
6767 #: ../src/guestfs-actions.pod:940
6768 msgid "guestfs_checksum_device"
6772 #: ../src/guestfs-actions.pod:942
6776 " guestfs_checksum_device (guestfs_h *g,\n"
6777 " const char *csumtype,\n"
6778 " const char *device);\n"
6783 #: ../src/guestfs-actions.pod:947
6785 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6786 "device named C<device>. For the types of checksums supported see the "
6787 "C<guestfs_checksum> command."
6791 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4816 ../src/guestfs-actions.pod:4853 ../src/guestfs-actions.pod:4871 ../src/guestfs-actions.pod:5047 ../src/guestfs-actions.pod:6603 ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:7023
6792 msgid "(Added in 1.3.2)"
6796 #: ../src/guestfs-actions.pod:956
6797 msgid "guestfs_checksums_out"
6801 #: ../src/guestfs-actions.pod:958
6805 " guestfs_checksums_out (guestfs_h *g,\n"
6806 " const char *csumtype,\n"
6807 " const char *directory,\n"
6808 " const char *sumsfile);\n"
6813 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
6815 "This command computes the checksums of all regular files in C<directory> and "
6816 "then emits a list of those checksums to the local output file C<sumsfile>."
6820 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
6822 "This can be used for verifying the integrity of a virtual machine. However "
6823 "to be properly secure you should pay attention to the output of the checksum "
6824 "command (it uses the ones from GNU coreutils). In particular when the "
6825 "filename is not printable, coreutils uses a special backslash syntax. For "
6826 "more information, see the GNU coreutils info file."
6830 #: ../src/guestfs-actions.pod:978
6831 msgid "(Added in 1.3.7)"
6835 #: ../src/guestfs-actions.pod:980
6836 msgid "guestfs_chmod"
6840 #: ../src/guestfs-actions.pod:982
6844 " guestfs_chmod (guestfs_h *g,\n"
6846 " const char *path);\n"
6851 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
6853 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6858 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
6860 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6861 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6866 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4456 ../src/guestfs-actions.pod:4475 ../src/guestfs-actions.pod:4494 ../fish/guestfish-actions.pod:676 ../fish/guestfish-actions.pod:2883 ../fish/guestfish-actions.pod:3012 ../fish/guestfish-actions.pod:3022 ../fish/guestfish-actions.pod:3032
6867 msgid "The mode actually set is affected by the umask."
6871 #: ../src/guestfs-actions.pod:1000
6872 msgid "guestfs_chown"
6876 #: ../src/guestfs-actions.pod:1002
6880 " guestfs_chown (guestfs_h *g,\n"
6883 " const char *path);\n"
6888 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
6889 msgid "Change the file owner to C<owner> and group to C<group>."
6893 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2341
6895 "Only numeric uid and gid are supported. If you want to use names, you will "
6896 "need to locate and parse the password file yourself (Augeas support makes "
6897 "this relatively easy)."
6901 #: ../src/guestfs-actions.pod:1018
6902 msgid "guestfs_command"
6906 #: ../src/guestfs-actions.pod:1020
6910 " guestfs_command (guestfs_h *g,\n"
6911 " char *const *arguments);\n"
6916 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
6918 "This call runs a command from the guest filesystem. The filesystem must be "
6919 "mounted, and must contain a compatible operating system (ie. something "
6920 "Linux, with the same or compatible processor architecture)."
6924 #: ../src/guestfs-actions.pod:1029
6926 "The single parameter is an argv-style list of arguments. The first element "
6927 "is the name of the program to run. Subsequent elements are parameters. The "
6928 "list must be non-empty (ie. must contain a program name). Note that the "
6929 "command runs directly, and is I<not> invoked via the shell (see "
6934 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
6935 msgid "The return value is anything printed to I<stdout> by the command."
6939 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
6941 "If the command returns a non-zero exit status, then this function returns an "
6942 "error message. The error message string is the content of I<stderr> from "
6947 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
6949 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6950 "C</bin>. If you require a program from another location, you should provide "
6951 "the full path in the first parameter."
6955 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
6957 "Shared libraries and data files required by the program must be available on "
6958 "filesystems which are mounted in the correct places. It is the caller's "
6959 "responsibility to ensure all filesystems that are needed are mounted at the "
6964 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:1543
6965 msgid "(Added in 0.9.1)"
6969 #: ../src/guestfs-actions.pod:1062
6970 msgid "guestfs_command_lines"
6974 #: ../src/guestfs-actions.pod:1064
6978 " guestfs_command_lines (guestfs_h *g,\n"
6979 " char *const *arguments);\n"
6984 #: ../src/guestfs-actions.pod:1068
6986 "This is the same as C<guestfs_command>, but splits the result into a list of "
6991 #: ../src/guestfs-actions.pod:1071
6992 msgid "See also: C<guestfs_sh_lines>"
6996 #: ../src/guestfs-actions.pod:1082
6997 msgid "guestfs_config"
7001 #: ../src/guestfs-actions.pod:1084
7005 " guestfs_config (guestfs_h *g,\n"
7006 " const char *qemuparam,\n"
7007 " const char *qemuvalue);\n"
7012 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7014 "This can be used to add arbitrary qemu command line parameters of the form "
7015 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
7016 "setting some parameters which would interfere with parameters that we use."
7020 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7021 msgid "The first character of C<param> string must be a C<-> (dash)."
7025 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7026 msgid "C<value> can be NULL."
7030 #: ../src/guestfs-actions.pod:1102
7031 msgid "guestfs_copy_size"
7035 #: ../src/guestfs-actions.pod:1104
7039 " guestfs_copy_size (guestfs_h *g,\n"
7040 " const char *src,\n"
7041 " const char *dest,\n"
7047 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7049 "This command copies exactly C<size> bytes from one source device or file "
7050 "C<src> to another destination device or file C<dest>."
7054 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7056 "Note this will fail if the source is too short or if the destination is not "
7061 #: ../src/guestfs-actions.pod:1118 ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:1272 ../src/guestfs-actions.pod:1692 ../src/guestfs-actions.pod:1714 ../src/guestfs-actions.pod:6689 ../src/guestfs-actions.pod:6723 ../src/guestfs-actions.pod:7202 ../src/guestfs-actions.pod:7221
7063 "This long-running command can generate progress notification messages so "
7064 "that the caller can display a progress bar or indicator. To receive these "
7065 "messages, the caller must register a progress callback. See "
7066 "L<guestfs(3)/guestfs_set_progress_callback>."
7070 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4035 ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:6950 ../src/guestfs-actions.pod:7036
7071 msgid "(Added in 1.0.87)"
7075 #: ../src/guestfs-actions.pod:1125
7080 #: ../src/guestfs-actions.pod:1127
7084 " guestfs_cp (guestfs_h *g,\n"
7085 " const char *src,\n"
7086 " const char *dest);\n"
7091 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7093 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7094 "destination filename or destination directory."
7098 #: ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1151 ../src/guestfs-actions.pod:1223 ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1406 ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:5097
7099 msgid "(Added in 1.0.18)"
7103 #: ../src/guestfs-actions.pod:1139
7104 msgid "guestfs_cp_a"
7108 #: ../src/guestfs-actions.pod:1141
7112 " guestfs_cp_a (guestfs_h *g,\n"
7113 " const char *src,\n"
7114 " const char *dest);\n"
7119 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7121 "This copies a file or directory from C<src> to C<dest> recursively using the "
7126 #: ../src/guestfs-actions.pod:1153
7131 #: ../src/guestfs-actions.pod:1155
7135 " guestfs_dd (guestfs_h *g,\n"
7136 " const char *src,\n"
7137 " const char *dest);\n"
7142 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7144 "This command copies from one source device or file C<src> to another "
7145 "destination device or file C<dest>. Normally you would use this to copy to "
7146 "or from a device or partition, for example to duplicate a filesystem."
7150 #: ../src/guestfs-actions.pod:1165
7152 "If the destination is a device, it must be as large or larger than the "
7153 "source file or device, otherwise the copy will fail. This command cannot do "
7154 "partial copies (see C<guestfs_copy_size>)."
7158 #: ../src/guestfs-actions.pod:1173
7163 #: ../src/guestfs-actions.pod:1175
7167 " guestfs_df (guestfs_h *g);\n"
7172 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
7173 msgid "This command runs the C<df> command to report disk space used."
7177 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
7179 "This command is mostly useful for interactive sessions. It is I<not> "
7180 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7185 #: ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1204 ../src/guestfs-actions.pod:1317 ../src/guestfs-actions.pod:2281 ../src/guestfs-actions.pod:2305 ../src/guestfs-actions.pod:2373 ../src/guestfs-actions.pod:4145 ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7082 ../src/guestfs-actions.pod:7095
7186 msgid "(Added in 1.0.54)"
7190 #: ../src/guestfs-actions.pod:1189
7191 msgid "guestfs_df_h"
7195 #: ../src/guestfs-actions.pod:1191
7199 " guestfs_df_h (guestfs_h *g);\n"
7204 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
7206 "This command runs the C<df -h> command to report disk space used in "
7207 "human-readable format."
7211 #: ../src/guestfs-actions.pod:1206
7212 msgid "guestfs_dmesg"
7216 #: ../src/guestfs-actions.pod:1208
7220 " guestfs_dmesg (guestfs_h *g);\n"
7225 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
7227 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7228 "This is sometimes useful for extended debugging of problems."
7232 #: ../src/guestfs-actions.pod:1215
7234 "Another way to get the same information is to enable verbose messages with "
7235 "C<guestfs_set_verbose> or by setting the environment variable "
7236 "C<LIBGUESTFS_DEBUG=1> before running the program."
7240 #: ../src/guestfs-actions.pod:1225
7241 msgid "guestfs_download"
7245 #: ../src/guestfs-actions.pod:1227
7249 " guestfs_download (guestfs_h *g,\n"
7250 " const char *remotefilename,\n"
7251 " const char *filename);\n"
7256 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
7258 "Download file C<remotefilename> and save it as C<filename> on the local "
7263 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4486
7264 msgid "C<filename> can also be a named pipe."
7268 #: ../src/guestfs-actions.pod:1237
7269 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7273 #: ../src/guestfs-actions.pod:1248
7274 msgid "guestfs_download_offset"
7278 #: ../src/guestfs-actions.pod:1250
7282 " guestfs_download_offset (guestfs_h *g,\n"
7283 " const char *remotefilename,\n"
7284 " const char *filename,\n"
7285 " int64_t offset,\n"
7291 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
7293 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7294 "region must be within the file or device)."
7298 #: ../src/guestfs-actions.pod:1263
7300 "Note that there is no limit on the amount of data that can be downloaded "
7301 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7302 "full amount unless an error occurs."
7306 #: ../src/guestfs-actions.pod:1268
7307 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7311 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6728
7312 msgid "(Added in 1.5.17)"
7316 #: ../src/guestfs-actions.pod:1279
7317 msgid "guestfs_drop_caches"
7321 #: ../src/guestfs-actions.pod:1281
7325 " guestfs_drop_caches (guestfs_h *g,\n"
7326 " int whattodrop);\n"
7331 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
7333 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7334 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7335 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7339 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
7340 msgid "Setting C<whattodrop> to 3 should drop everything."
7344 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
7346 "This automatically calls L<sync(2)> before the operation, so that the "
7347 "maximum guest memory is freed."
7351 #: ../src/guestfs-actions.pod:1299
7356 #: ../src/guestfs-actions.pod:1301
7360 " guestfs_du (guestfs_h *g,\n"
7361 " const char *path);\n"
7366 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
7368 "This command runs the C<du -s> command to estimate file space usage for "
7373 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
7375 "C<path> can be a file or a directory. If C<path> is a directory then the "
7376 "estimate includes the contents of the directory and all subdirectories "
7381 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
7382 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7386 #: ../src/guestfs-actions.pod:1319
7387 msgid "guestfs_e2fsck_f"
7391 #: ../src/guestfs-actions.pod:1321
7395 " guestfs_e2fsck_f (guestfs_h *g,\n"
7396 " const char *device);\n"
7401 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:885
7403 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7404 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7409 #: ../src/guestfs-actions.pod:1329
7411 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7412 "Normally you should use C<guestfs_fsck>."
7416 #: ../src/guestfs-actions.pod:1334
7417 msgid "(Added in 1.0.29)"
7421 #: ../src/guestfs-actions.pod:1336
7422 msgid "guestfs_echo_daemon"
7426 #: ../src/guestfs-actions.pod:1338
7430 " guestfs_echo_daemon (guestfs_h *g,\n"
7431 " char *const *words);\n"
7436 #: ../src/guestfs-actions.pod:1342 ../fish/guestfish-actions.pod:896
7438 "This command concatenates the list of C<words> passed with single spaces "
7439 "between them and returns the resulting string."
7443 #: ../src/guestfs-actions.pod:1345 ../fish/guestfish-actions.pod:899
7444 msgid "You can use this command to test the connection through to the daemon."
7448 #: ../src/guestfs-actions.pod:1347
7449 msgid "See also C<guestfs_ping_daemon>."
7453 #: ../src/guestfs-actions.pod:1352 ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:5931
7454 msgid "(Added in 1.0.69)"
7458 #: ../src/guestfs-actions.pod:1354
7459 msgid "guestfs_egrep"
7463 #: ../src/guestfs-actions.pod:1356
7467 " guestfs_egrep (guestfs_h *g,\n"
7468 " const char *regex,\n"
7469 " const char *path);\n"
7474 #: ../src/guestfs-actions.pod:1361 ../fish/guestfish-actions.pod:907
7475 msgid "This calls the external C<egrep> program and returns the matching lines."
7479 #: ../src/guestfs-actions.pod:1371 ../src/guestfs-actions.pod:1390 ../src/guestfs-actions.pod:1447 ../src/guestfs-actions.pod:1493 ../src/guestfs-actions.pod:1512 ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:2422 ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2490 ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3569 ../src/guestfs-actions.pod:4555 ../src/guestfs-actions.pod:5431 ../src/guestfs-actions.pod:5480 ../src/guestfs-actions.pod:6295 ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6333 ../src/guestfs-actions.pod:6355 ../src/guestfs-actions.pod:6368 ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6394 ../src/guestfs-actions.pod:7165 ../src/guestfs-actions.pod:7184 ../src/guestfs-actions.pod:7269 ../src/guestfs-actions.pod:7288 ../src/guestfs-actions.pod:7334 ../src/guestfs-actions.pod:7353
7480 msgid "(Added in 1.0.66)"
7484 #: ../src/guestfs-actions.pod:1373
7485 msgid "guestfs_egrepi"
7489 #: ../src/guestfs-actions.pod:1375
7493 " guestfs_egrepi (guestfs_h *g,\n"
7494 " const char *regex,\n"
7495 " const char *path);\n"
7500 #: ../src/guestfs-actions.pod:1380 ../fish/guestfish-actions.pod:917
7501 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7505 #: ../src/guestfs-actions.pod:1392
7506 msgid "guestfs_equal"
7510 #: ../src/guestfs-actions.pod:1394
7514 " guestfs_equal (guestfs_h *g,\n"
7515 " const char *file1,\n"
7516 " const char *file2);\n"
7521 #: ../src/guestfs-actions.pod:1399 ../fish/guestfish-actions.pod:927
7523 "This compares the two files C<file1> and C<file2> and returns true if their "
7524 "content is exactly equal, or false otherwise."
7528 #: ../src/guestfs-actions.pod:1402 ../fish/guestfish-actions.pod:930
7529 msgid "The external L<cmp(1)> program is used for the comparison."
7533 #: ../src/guestfs-actions.pod:1408
7534 msgid "guestfs_exists"
7538 #: ../src/guestfs-actions.pod:1410
7542 " guestfs_exists (guestfs_h *g,\n"
7543 " const char *path);\n"
7548 #: ../src/guestfs-actions.pod:1414 ../fish/guestfish-actions.pod:936
7550 "This returns C<true> if and only if there is a file, directory (or anything) "
7551 "with the given C<path> name."
7555 #: ../src/guestfs-actions.pod:1417
7556 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7560 #: ../src/guestfs-actions.pod:1423
7561 msgid "guestfs_fallocate"
7565 #: ../src/guestfs-actions.pod:1425
7569 " guestfs_fallocate (guestfs_h *g,\n"
7570 " const char *path,\n"
7576 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1456 ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
7578 "This command preallocates a file (containing zero bytes) named C<path> of "
7579 "size C<len> bytes. If the file exists already, it is overwritten."
7583 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:949
7585 "Do not confuse this with the guestfish-specific C<alloc> command which "
7586 "allocates a file in the host and attaches it as a device."
7590 #: ../src/guestfs-actions.pod:1440 ../fish/guestfish-actions.pod:953
7592 "This function is deprecated. In new code, use the C<fallocate64> call "
7597 #: ../src/guestfs-actions.pod:1449
7598 msgid "guestfs_fallocate64"
7602 #: ../src/guestfs-actions.pod:1451
7606 " guestfs_fallocate64 (guestfs_h *g,\n"
7607 " const char *path,\n"
7613 #: ../src/guestfs-actions.pod:1460
7615 "Note that this call allocates disk blocks for the file. To create a sparse "
7616 "file use C<guestfs_truncate_size> instead."
7620 #: ../src/guestfs-actions.pod:1463
7622 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
7623 "oversight it only allowed 30 bit lengths to be specified, effectively "
7624 "limiting the maximum size of files created through that call to 1GB."
7628 #: ../src/guestfs-actions.pod:1468 ../fish/guestfish-actions.pod:976
7630 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7631 "commands which create a file in the host and attach it as a device."
7635 #: ../src/guestfs-actions.pod:1474
7636 msgid "(Added in 1.3.17)"
7640 #: ../src/guestfs-actions.pod:1476
7641 msgid "guestfs_fgrep"
7645 #: ../src/guestfs-actions.pod:1478
7649 " guestfs_fgrep (guestfs_h *g,\n"
7650 " const char *pattern,\n"
7651 " const char *path);\n"
7656 #: ../src/guestfs-actions.pod:1483 ../fish/guestfish-actions.pod:984
7657 msgid "This calls the external C<fgrep> program and returns the matching lines."
7661 #: ../src/guestfs-actions.pod:1495
7662 msgid "guestfs_fgrepi"
7666 #: ../src/guestfs-actions.pod:1497
7670 " guestfs_fgrepi (guestfs_h *g,\n"
7671 " const char *pattern,\n"
7672 " const char *path);\n"
7677 #: ../src/guestfs-actions.pod:1502 ../fish/guestfish-actions.pod:994
7678 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7682 #: ../src/guestfs-actions.pod:1514
7683 msgid "guestfs_file"
7687 #: ../src/guestfs-actions.pod:1516
7691 " guestfs_file (guestfs_h *g,\n"
7692 " const char *path);\n"
7697 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1004
7699 "This call uses the standard L<file(1)> command to determine the type or "
7700 "contents of the file."
7704 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1007
7706 "This call will also transparently look inside various types of compressed "
7711 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1010
7713 "The exact command which runs is C<file -zb path>. Note in particular that "
7714 "the filename is not prepended to the output (the C<-b> option)."
7718 #: ../src/guestfs-actions.pod:1530
7720 "This command can also be used on C</dev/> devices (and partitions, LV "
7721 "names). You can for example use this to determine if a device contains a "
7722 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7726 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1019
7728 "If the C<path> does not begin with C</dev/> then this command only works for "
7729 "the content of regular files. For other file types (directory, symbolic "
7730 "link etc) it will just return the string C<directory> etc."
7734 #: ../src/guestfs-actions.pod:1545
7735 msgid "guestfs_file_architecture"
7739 #: ../src/guestfs-actions.pod:1547
7743 " guestfs_file_architecture (guestfs_h *g,\n"
7744 " const char *filename);\n"
7749 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1028
7751 "This detects the architecture of the binary C<filename>, and returns it if "
7756 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1031
7757 msgid "Currently defined architectures are:"
7761 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1035
7766 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1037
7768 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7769 "irrespective of the precise processor requirements of the binary."
7773 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1040
7778 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1042
7779 msgid "64 bit x86-64."
7783 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1044
7788 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1046
7789 msgid "32 bit SPARC."
7793 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1048
7798 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1050
7799 msgid "64 bit SPARC V9 and above."
7803 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1052
7808 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1054
7809 msgid "Intel Itanium."
7813 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1056
7818 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1058
7819 msgid "32 bit Power PC."
7823 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1060
7828 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1062
7829 msgid "64 bit Power PC."
7833 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1066
7834 msgid "Libguestfs may return other architecture strings in future."
7838 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1068
7839 msgid "The function works on at least the following types of files:"
7843 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1074
7844 msgid "many types of Un*x and Linux binary"
7848 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1078
7849 msgid "many types of Un*x and Linux shared library"
7853 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1082
7854 msgid "Windows Win32 and Win64 binaries"
7858 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1086
7859 msgid "Windows Win32 and Win64 DLLs"
7863 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1088
7864 msgid "Win32 binaries and DLLs return C<i386>."
7868 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1090
7869 msgid "Win64 binaries and DLLs return C<x86_64>."
7873 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1094
7874 msgid "Linux kernel modules"
7878 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1098
7879 msgid "Linux new-style initrd images"
7883 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1102
7884 msgid "some non-x86 Linux vmlinuz kernels"
7888 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1106
7889 msgid "What it can't do currently:"
7893 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1112
7894 msgid "static libraries (libfoo.a)"
7898 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1116
7899 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7903 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1120
7904 msgid "x86 Linux vmlinuz kernels"
7908 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1122
7910 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7911 "compressed code, and are horribly hard to unpack. If you want to find the "
7912 "architecture of a kernel, use the architecture of the associated initrd or "
7913 "kernel module(s) instead."
7917 #: ../src/guestfs-actions.pod:1655 ../src/guestfs-actions.pod:1818 ../src/guestfs-actions.pod:1835 ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2633 ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2742 ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2863 ../src/guestfs-actions.pod:2925 ../src/guestfs-actions.pod:3151 ../src/guestfs-actions.pod:3283
7918 msgid "(Added in 1.5.3)"
7922 #: ../src/guestfs-actions.pod:1657
7923 msgid "guestfs_filesize"
7927 #: ../src/guestfs-actions.pod:1659
7931 " guestfs_filesize (guestfs_h *g,\n"
7932 " const char *file);\n"
7937 #: ../src/guestfs-actions.pod:1663 ../fish/guestfish-actions.pod:1133
7938 msgid "This command returns the size of C<file> in bytes."
7942 #: ../src/guestfs-actions.pod:1665
7944 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7945 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7946 "devices, use C<guestfs_blockdev_getsize64>."
7950 #: ../src/guestfs-actions.pod:1671
7951 msgid "(Added in 1.0.82)"
7955 #: ../src/guestfs-actions.pod:1673
7956 msgid "guestfs_fill"
7960 #: ../src/guestfs-actions.pod:1675
7964 " guestfs_fill (guestfs_h *g,\n"
7967 " const char *path);\n"
7972 #: ../src/guestfs-actions.pod:1681 ../fish/guestfish-actions.pod:1143
7974 "This command creates a new file called C<path>. The initial content of the "
7975 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7980 #: ../src/guestfs-actions.pod:1685
7982 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7983 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7984 "bytes use C<guestfs_fill_pattern>."
7988 #: ../src/guestfs-actions.pod:1697
7989 msgid "(Added in 1.0.79)"
7993 #: ../src/guestfs-actions.pod:1699
7994 msgid "guestfs_fill_pattern"
7998 #: ../src/guestfs-actions.pod:1701
8002 " guestfs_fill_pattern (guestfs_h *g,\n"
8003 " const char *pattern,\n"
8005 " const char *path);\n"
8010 #: ../src/guestfs-actions.pod:1707
8012 "This function is like C<guestfs_fill> except that it creates a new file of "
8013 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8014 "pattern is truncated if necessary to ensure the length of the file is "
8015 "exactly C<len> bytes."
8019 #: ../src/guestfs-actions.pod:1719
8020 msgid "(Added in 1.3.12)"
8024 #: ../src/guestfs-actions.pod:1721
8025 msgid "guestfs_find"
8029 #: ../src/guestfs-actions.pod:1723
8033 " guestfs_find (guestfs_h *g,\n"
8034 " const char *directory);\n"
8039 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1165
8041 "This command lists out all files and directories, recursively, starting at "
8042 "C<directory>. It is essentially equivalent to running the shell command "
8043 "C<find directory -print> but some post-processing happens on the output, "
8048 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1170
8050 "This returns a list of strings I<without any prefix>. Thus if the directory "
8055 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1173
8065 #: ../src/guestfs-actions.pod:1739
8066 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8070 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1180
8081 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1185
8082 msgid "If C<directory> is not a directory, then this command returns an error."
8086 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1188
8087 msgid "The returned list is sorted."
8091 #: ../src/guestfs-actions.pod:1752
8092 msgid "See also C<guestfs_find0>."
8096 #: ../src/guestfs-actions.pod:1761 ../src/guestfs-actions.pod:3972 ../src/guestfs-actions.pod:5515
8097 msgid "(Added in 1.0.27)"
8101 #: ../src/guestfs-actions.pod:1763
8102 msgid "guestfs_find0"
8106 #: ../src/guestfs-actions.pod:1765
8110 " guestfs_find0 (guestfs_h *g,\n"
8111 " const char *directory,\n"
8112 " const char *files);\n"
8117 #: ../src/guestfs-actions.pod:1770 ../fish/guestfish-actions.pod:1199
8119 "This command lists out all files and directories, recursively, starting at "
8120 "C<directory>, placing the resulting list in the external file called "
8125 #: ../src/guestfs-actions.pod:1774
8127 "This command works the same way as C<guestfs_find> with the following "
8132 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1210
8133 msgid "The resulting list is written to an external file."
8137 #: ../src/guestfs-actions.pod:1785 ../fish/guestfish-actions.pod:1214
8139 "Items (filenames) in the result are separated by C<\\0> characters. See "
8140 "L<find(1)> option I<-print0>."
8144 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1219
8145 msgid "This command is not limited in the number of names that it can return."
8149 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1224
8150 msgid "The result list is not sorted."
8154 #: ../src/guestfs-actions.pod:1801
8155 msgid "(Added in 1.0.74)"
8159 #: ../src/guestfs-actions.pod:1803
8160 msgid "guestfs_findfs_label"
8164 #: ../src/guestfs-actions.pod:1805
8168 " guestfs_findfs_label (guestfs_h *g,\n"
8169 " const char *label);\n"
8174 #: ../src/guestfs-actions.pod:1809 ../fish/guestfish-actions.pod:1234
8176 "This command searches the filesystems and returns the one which has the "
8177 "given label. An error is returned if no such filesystem can be found."
8181 #: ../src/guestfs-actions.pod:1813
8182 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8186 #: ../src/guestfs-actions.pod:1820
8187 msgid "guestfs_findfs_uuid"
8191 #: ../src/guestfs-actions.pod:1822
8195 " guestfs_findfs_uuid (guestfs_h *g,\n"
8196 " const char *uuid);\n"
8201 #: ../src/guestfs-actions.pod:1826 ../fish/guestfish-actions.pod:1244
8203 "This command searches the filesystems and returns the one which has the "
8204 "given UUID. An error is returned if no such filesystem can be found."
8208 #: ../src/guestfs-actions.pod:1830
8209 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8213 #: ../src/guestfs-actions.pod:1837
8214 msgid "guestfs_fsck"
8218 #: ../src/guestfs-actions.pod:1839
8222 " guestfs_fsck (guestfs_h *g,\n"
8223 " const char *fstype,\n"
8224 " const char *device);\n"
8229 #: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:1254
8231 "This runs the filesystem checker (fsck) on C<device> which should have "
8232 "filesystem type C<fstype>."
8236 #: ../src/guestfs-actions.pod:1847 ../fish/guestfish-actions.pod:1257
8238 "The returned integer is the status. See L<fsck(8)> for the list of status "
8239 "codes from C<fsck>."
8243 #: ../src/guestfs-actions.pod:1856 ../fish/guestfish-actions.pod:1266
8244 msgid "Multiple status codes can be summed together."
8248 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1270
8250 "A non-zero return code can mean \"success\", for example if errors have been "
8251 "corrected on the filesystem."
8255 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1275
8256 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8260 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1280
8261 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8265 #: ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:7207
8266 msgid "(Added in 1.0.16)"
8270 #: ../src/guestfs-actions.pod:1876
8271 msgid "guestfs_get_append"
8275 #: ../src/guestfs-actions.pod:1878
8279 " guestfs_get_append (guestfs_h *g);\n"
8284 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1286
8286 "Return the additional kernel options which are added to the guest kernel "
8291 #: ../src/guestfs-actions.pod:1884 ../fish/guestfish-actions.pod:1289
8292 msgid "If C<NULL> then no options are added."
8296 #: ../src/guestfs-actions.pod:1886
8298 "This function returns a string which may be NULL. There is no way to return "
8299 "an error from this function. The string is owned by the guest handle and "
8300 "must I<not> be freed."
8304 #: ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:5193 ../src/guestfs-actions.pod:5673 ../src/guestfs-actions.pod:6069 ../src/guestfs-actions.pod:6088 ../src/guestfs-actions.pod:6104 ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:6878 ../src/guestfs-actions.pod:6896 ../src/guestfs-actions.pod:7250
8305 msgid "(Added in 1.0.26)"
8309 #: ../src/guestfs-actions.pod:1892
8310 msgid "guestfs_get_attach_method"
8314 #: ../src/guestfs-actions.pod:1894
8318 " guestfs_get_attach_method (guestfs_h *g);\n"
8323 #: ../src/guestfs-actions.pod:1897
8324 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8328 #: ../src/guestfs-actions.pod:1902
8329 msgid "guestfs_get_autosync"
8333 #: ../src/guestfs-actions.pod:1904
8337 " guestfs_get_autosync (guestfs_h *g);\n"
8342 #: ../src/guestfs-actions.pod:1907 ../fish/guestfish-actions.pod:1301
8343 msgid "Get the autosync flag."
8347 #: ../src/guestfs-actions.pod:1913
8348 msgid "guestfs_get_direct"
8352 #: ../src/guestfs-actions.pod:1915
8356 " guestfs_get_direct (guestfs_h *g);\n"
8361 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1307
8362 msgid "Return the direct appliance mode flag."
8366 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:5742
8367 msgid "(Added in 1.0.72)"
8371 #: ../src/guestfs-actions.pod:1924
8372 msgid "guestfs_get_e2label"
8376 #: ../src/guestfs-actions.pod:1926
8380 " guestfs_get_e2label (guestfs_h *g,\n"
8381 " const char *device);\n"
8386 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1313
8387 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8391 #: ../src/guestfs-actions.pod:1936 ../fish/guestfish-actions.pod:1316
8393 "This function is deprecated. In new code, use the C<vfs_label> call "
8398 #: ../src/guestfs-actions.pod:1943 ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:5760 ../src/guestfs-actions.pod:5779
8399 msgid "(Added in 1.0.15)"
8403 #: ../src/guestfs-actions.pod:1945
8404 msgid "guestfs_get_e2uuid"
8408 #: ../src/guestfs-actions.pod:1947
8412 " guestfs_get_e2uuid (guestfs_h *g,\n"
8413 " const char *device);\n"
8418 #: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1327
8419 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8423 #: ../src/guestfs-actions.pod:1957 ../fish/guestfish-actions.pod:1330
8424 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
8428 #: ../src/guestfs-actions.pod:1966
8429 msgid "guestfs_get_memsize"
8433 #: ../src/guestfs-actions.pod:1968
8437 " guestfs_get_memsize (guestfs_h *g);\n"
8442 #: ../src/guestfs-actions.pod:1971 ../fish/guestfish-actions.pod:1341
8443 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8447 #: ../src/guestfs-actions.pod:1974
8449 "If C<guestfs_set_memsize> was not called on this handle, and if "
8450 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8451 "value for memsize."
8455 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:2059 ../src/guestfs-actions.pod:5795 ../src/guestfs-actions.pod:5902 ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399 ../fish/guestfish-actions.pod:3893 ../fish/guestfish-actions.pod:3980
8456 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8460 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:4263 ../src/guestfs-actions.pod:4460 ../src/guestfs-actions.pod:4479 ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4510 ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4540 ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5800 ../src/guestfs-actions.pod:6043 ../src/guestfs-actions.pod:6644
8461 msgid "(Added in 1.0.55)"
8465 #: ../src/guestfs-actions.pod:1985
8466 msgid "guestfs_get_network"
8470 #: ../src/guestfs-actions.pod:1987
8474 " guestfs_get_network (guestfs_h *g);\n"
8479 #: ../src/guestfs-actions.pod:1990 ../fish/guestfish-actions.pod:1355
8480 msgid "This returns the enable network flag."
8484 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:5819
8485 msgid "(Added in 1.5.4)"
8489 #: ../src/guestfs-actions.pod:1996
8490 msgid "guestfs_get_path"
8494 #: ../src/guestfs-actions.pod:1998
8498 " guestfs_get_path (guestfs_h *g);\n"
8503 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1361
8504 msgid "Return the current search path."
8508 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1363
8510 "This is always non-NULL. If it wasn't set already, then this will return "
8515 #: ../src/guestfs-actions.pod:2006 ../src/guestfs-actions.pod:2035
8517 "This function returns a string, or NULL on error. The string is owned by "
8518 "the guest handle and must I<not> be freed."
8522 #: ../src/guestfs-actions.pod:2011
8523 msgid "guestfs_get_pid"
8527 #: ../src/guestfs-actions.pod:2013
8531 " guestfs_get_pid (guestfs_h *g);\n"
8536 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
8538 "Return the process ID of the qemu subprocess. If there is no qemu "
8539 "subprocess, then this will return an error."
8543 #: ../src/guestfs-actions.pod:2019 ../fish/guestfish-actions.pod:1375
8544 msgid "This is an internal call used for debugging and testing."
8548 #: ../src/guestfs-actions.pod:2023
8549 msgid "(Added in 1.0.56)"
8553 #: ../src/guestfs-actions.pod:2025
8554 msgid "guestfs_get_qemu"
8558 #: ../src/guestfs-actions.pod:2027
8562 " guestfs_get_qemu (guestfs_h *g);\n"
8567 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1381
8568 msgid "Return the current qemu binary."
8572 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1383
8574 "This is always non-NULL. If it wasn't set already, then this will return "
8575 "the default qemu binary name."
8579 #: ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:5864
8580 msgid "(Added in 1.0.6)"
8584 #: ../src/guestfs-actions.pod:2040
8585 msgid "guestfs_get_recovery_proc"
8589 #: ../src/guestfs-actions.pod:2042
8593 " guestfs_get_recovery_proc (guestfs_h *g);\n"
8598 #: ../src/guestfs-actions.pod:2045 ../fish/guestfish-actions.pod:1390
8599 msgid "Return the recovery process enabled flag."
8603 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:3373 ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:4070 ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:5123 ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5888 ../src/guestfs-actions.pod:6547 ../src/guestfs-actions.pod:6567 ../src/guestfs-actions.pod:6759
8604 msgid "(Added in 1.0.77)"
8608 #: ../src/guestfs-actions.pod:2051
8609 msgid "guestfs_get_selinux"
8613 #: ../src/guestfs-actions.pod:2053
8617 " guestfs_get_selinux (guestfs_h *g);\n"
8622 #: ../src/guestfs-actions.pod:2056
8624 "This returns the current setting of the selinux flag which is passed to the "
8625 "appliance at boot time. See C<guestfs_set_selinux>."
8629 #: ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:5907 ../src/guestfs-actions.pod:5961
8630 msgid "(Added in 1.0.67)"
8634 #: ../src/guestfs-actions.pod:2066
8635 msgid "guestfs_get_state"
8639 #: ../src/guestfs-actions.pod:2068
8643 " guestfs_get_state (guestfs_h *g);\n"
8648 #: ../src/guestfs-actions.pod:2071 ../fish/guestfish-actions.pod:1406
8650 "This returns the current state as an opaque integer. This is only useful "
8651 "for printing debug and internal error messages."
8655 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:3176 ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3266 ../src/guestfs-actions.pod:3293 ../fish/guestfish-actions.pod:1409 ../fish/guestfish-actions.pod:2223 ../fish/guestfish-actions.pod:2241 ../fish/guestfish-actions.pod:2279 ../fish/guestfish-actions.pod:2295
8656 msgid "For more information on states, see L<guestfs(3)>."
8660 #: ../src/guestfs-actions.pod:2080
8661 msgid "guestfs_get_trace"
8665 #: ../src/guestfs-actions.pod:2082
8669 " guestfs_get_trace (guestfs_h *g);\n"
8674 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1415
8675 msgid "Return the command trace flag."
8679 #: ../src/guestfs-actions.pod:2091
8680 msgid "guestfs_get_umask"
8684 #: ../src/guestfs-actions.pod:2093
8688 " guestfs_get_umask (guestfs_h *g);\n"
8693 #: ../src/guestfs-actions.pod:2096
8695 "Return the current umask. By default the umask is C<022> unless it has been "
8696 "set by calling C<guestfs_umask>."
8700 #: ../src/guestfs-actions.pod:2103
8701 msgid "guestfs_get_verbose"
8705 #: ../src/guestfs-actions.pod:2105
8709 " guestfs_get_verbose (guestfs_h *g);\n"
8714 #: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1428
8715 msgid "This returns the verbose messages flag."
8719 #: ../src/guestfs-actions.pod:2114
8720 msgid "guestfs_getcon"
8724 #: ../src/guestfs-actions.pod:2116
8728 " guestfs_getcon (guestfs_h *g);\n"
8733 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1434
8734 msgid "This gets the SELinux security context of the daemon."
8738 #: ../src/guestfs-actions.pod:2121
8739 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8743 #: ../src/guestfs-actions.pod:2129
8744 msgid "guestfs_getxattr"
8748 #: ../src/guestfs-actions.pod:2131
8752 " guestfs_getxattr (guestfs_h *g,\n"
8753 " const char *path,\n"
8754 " const char *name,\n"
8755 " size_t *size_r);\n"
8760 #: ../src/guestfs-actions.pod:2137
8762 "Get a single extended attribute from file C<path> named C<name>. This call "
8763 "follows symlinks. If you want to lookup an extended attribute for the "
8764 "symlink itself, use C<guestfs_lgetxattr>."
8768 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3387
8770 "Normally it is better to get all extended attributes from a file in one go "
8771 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
8772 "implementations are buggy and do not provide a way to list out attributes. "
8773 "For these filesystems (notably ntfs-3g) you have to know the names of the "
8774 "extended attributes you want in advance and call this function."
8778 #: ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:3394 ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2360
8780 "Extended attribute values are blobs of binary data. If there is no extended "
8781 "attribute named C<name>, this returns an error."
8785 #: ../src/guestfs-actions.pod:2151
8786 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
8790 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:3399 ../src/guestfs-actions.pod:5116 ../src/guestfs-actions.pod:5142 ../src/guestfs-actions.pod:5323
8792 "This function returns a buffer, or NULL on error. The size of the returned "
8793 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8798 #: ../src/guestfs-actions.pod:2157 ../src/guestfs-actions.pod:3403
8799 msgid "(Added in 1.7.24)"
8803 #: ../src/guestfs-actions.pod:2159
8804 msgid "guestfs_getxattrs"
8808 #: ../src/guestfs-actions.pod:2161
8811 " struct guestfs_xattr_list *\n"
8812 " guestfs_getxattrs (guestfs_h *g,\n"
8813 " const char *path);\n"
8818 #: ../src/guestfs-actions.pod:2165 ../fish/guestfish-actions.pod:1463
8819 msgid "This call lists the extended attributes of the file or directory C<path>."
8823 #: ../src/guestfs-actions.pod:2168 ../fish/guestfish-actions.pod:1466
8825 "At the system call level, this is a combination of the L<listxattr(2)> and "
8826 "L<getxattr(2)> calls."
8830 #: ../src/guestfs-actions.pod:2171
8831 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8835 #: ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:4066
8837 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8838 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8842 #: ../src/guestfs-actions.pod:2177 ../src/guestfs-actions.pod:3419 ../src/guestfs-actions.pod:3584 ../src/guestfs-actions.pod:3620 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:7315
8843 msgid "(Added in 1.0.59)"
8847 #: ../src/guestfs-actions.pod:2179
8848 msgid "guestfs_glob_expand"
8852 #: ../src/guestfs-actions.pod:2181
8856 " guestfs_glob_expand (guestfs_h *g,\n"
8857 " const char *pattern);\n"
8862 #: ../src/guestfs-actions.pod:2185 ../fish/guestfish-actions.pod:1475
8864 "This command searches for all the pathnames matching C<pattern> according to "
8865 "the wildcard expansion rules used by the shell."
8869 #: ../src/guestfs-actions.pod:2189 ../fish/guestfish-actions.pod:1479
8870 msgid "If no paths match, then this returns an empty list (note: not an error)."
8874 #: ../src/guestfs-actions.pod:2192 ../fish/guestfish-actions.pod:1482
8876 "It is just a wrapper around the C L<glob(3)> function with flags "
8877 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8881 #: ../src/guestfs-actions.pod:2200 ../src/guestfs-actions.pod:6145 ../src/guestfs-actions.pod:6162
8882 msgid "(Added in 1.0.50)"
8886 #: ../src/guestfs-actions.pod:2202
8887 msgid "guestfs_grep"
8891 #: ../src/guestfs-actions.pod:2204
8895 " guestfs_grep (guestfs_h *g,\n"
8896 " const char *regex,\n"
8897 " const char *path);\n"
8902 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1490
8903 msgid "This calls the external C<grep> program and returns the matching lines."
8907 #: ../src/guestfs-actions.pod:2221
8908 msgid "guestfs_grepi"
8912 #: ../src/guestfs-actions.pod:2223
8916 " guestfs_grepi (guestfs_h *g,\n"
8917 " const char *regex,\n"
8918 " const char *path);\n"
8923 #: ../src/guestfs-actions.pod:2228 ../fish/guestfish-actions.pod:1500
8924 msgid "This calls the external C<grep -i> program and returns the matching lines."
8928 #: ../src/guestfs-actions.pod:2240
8929 msgid "guestfs_grub_install"
8933 #: ../src/guestfs-actions.pod:2242
8937 " guestfs_grub_install (guestfs_h *g,\n"
8938 " const char *root,\n"
8939 " const char *device);\n"
8944 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
8946 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8947 "the root directory being C<root>."
8951 #: ../src/guestfs-actions.pod:2250 ../fish/guestfish-actions.pod:1513
8953 "Note: If grub-install reports the error \"No suitable drive was found in the "
8954 "generated device map.\" it may be that you need to create a "
8955 "C</boot/grub/device.map> file first that contains the mapping between grub "
8956 "device names and Linux device names. It is usually sufficient to create a "
8961 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1520
8969 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1522
8970 msgid "replacing C</dev/vda> with the name of the installation device."
8974 #: ../src/guestfs-actions.pod:2263
8975 msgid "(Added in 1.0.17)"
8979 #: ../src/guestfs-actions.pod:2265
8980 msgid "guestfs_head"
8984 #: ../src/guestfs-actions.pod:2267
8988 " guestfs_head (guestfs_h *g,\n"
8989 " const char *path);\n"
8994 #: ../src/guestfs-actions.pod:2271 ../fish/guestfish-actions.pod:1528
8996 "This command returns up to the first 10 lines of a file as a list of "
9001 #: ../src/guestfs-actions.pod:2283
9002 msgid "guestfs_head_n"
9006 #: ../src/guestfs-actions.pod:2285
9010 " guestfs_head_n (guestfs_h *g,\n"
9012 " const char *path);\n"
9017 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1538
9019 "If the parameter C<nrlines> is a positive number, this returns the first "
9020 "C<nrlines> lines of the file C<path>."
9024 #: ../src/guestfs-actions.pod:2293 ../fish/guestfish-actions.pod:1541
9026 "If the parameter C<nrlines> is a negative number, this returns lines from "
9027 "the file C<path>, excluding the last C<nrlines> lines."
9031 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:6442 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4326
9032 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9036 #: ../src/guestfs-actions.pod:2307
9037 msgid "guestfs_hexdump"
9041 #: ../src/guestfs-actions.pod:2309
9045 " guestfs_hexdump (guestfs_h *g,\n"
9046 " const char *path);\n"
9051 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
9053 "This runs C<hexdump -C> on the given C<path>. The result is the "
9054 "human-readable, canonical hex dump of the file."
9058 #: ../src/guestfs-actions.pod:2322 ../src/guestfs-actions.pod:6226 ../src/guestfs-actions.pod:6281
9059 msgid "(Added in 1.0.22)"
9063 #: ../src/guestfs-actions.pod:2324
9064 msgid "guestfs_initrd_cat"
9068 #: ../src/guestfs-actions.pod:2326
9072 " guestfs_initrd_cat (guestfs_h *g,\n"
9073 " const char *initrdpath,\n"
9074 " const char *filename,\n"
9075 " size_t *size_r);\n"
9080 #: ../src/guestfs-actions.pod:2332 ../fish/guestfish-actions.pod:1563
9082 "This command unpacks the file C<filename> from the initrd file called "
9083 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9088 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
9090 "For example, in guestfish you could use the following command to examine the "
9091 "boot script (usually called C</init>) contained in a Linux initrd or "
9096 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
9099 " initrd-cat /boot/initrd-<version>.img init\n"
9104 #: ../src/guestfs-actions.pod:2342
9105 msgid "See also C<guestfs_initrd_list>."
9109 #: ../src/guestfs-actions.pod:2353
9110 msgid "guestfs_initrd_list"
9114 #: ../src/guestfs-actions.pod:2355
9118 " guestfs_initrd_list (guestfs_h *g,\n"
9119 " const char *path);\n"
9124 #: ../src/guestfs-actions.pod:2359 ../fish/guestfish-actions.pod:1582
9125 msgid "This command lists out files contained in an initrd."
9129 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1584
9131 "The files are listed without any initial C</> character. The files are "
9132 "listed in the order they appear (not necessarily alphabetical). Directory "
9133 "names are listed as separate items."
9137 #: ../src/guestfs-actions.pod:2365 ../fish/guestfish-actions.pod:1588
9139 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9140 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9145 #: ../src/guestfs-actions.pod:2375
9146 msgid "guestfs_inotify_add_watch"
9150 #: ../src/guestfs-actions.pod:2377
9154 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9155 " const char *path,\n"
9161 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1596
9162 msgid "Watch C<path> for the events listed in C<mask>."
9166 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1598
9168 "Note that if C<path> is a directory then events within that directory are "
9169 "watched, but this does I<not> happen recursively (in subdirectories)."
9173 #: ../src/guestfs-actions.pod:2388 ../fish/guestfish-actions.pod:1602
9175 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9176 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9180 #: ../src/guestfs-actions.pod:2396
9181 msgid "guestfs_inotify_close"
9185 #: ../src/guestfs-actions.pod:2398
9189 " guestfs_inotify_close (guestfs_h *g);\n"
9194 #: ../src/guestfs-actions.pod:2401 ../fish/guestfish-actions.pod:1610
9196 "This closes the inotify handle which was previously opened by inotify_init. "
9197 "It removes all watches, throws away any pending events, and deallocates all "
9202 #: ../src/guestfs-actions.pod:2409
9203 msgid "guestfs_inotify_files"
9207 #: ../src/guestfs-actions.pod:2411
9211 " guestfs_inotify_files (guestfs_h *g);\n"
9216 #: ../src/guestfs-actions.pod:2414
9218 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9219 "returns a list of pathnames of objects that were touched. The returned "
9220 "pathnames are sorted and deduplicated."
9224 #: ../src/guestfs-actions.pod:2424
9225 msgid "guestfs_inotify_init"
9229 #: ../src/guestfs-actions.pod:2426
9233 " guestfs_inotify_init (guestfs_h *g,\n"
9234 " int maxevents);\n"
9239 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1626
9241 "This command creates a new inotify handle. The inotify subsystem can be "
9242 "used to notify events which happen to objects in the guest filesystem."
9246 #: ../src/guestfs-actions.pod:2434
9248 "C<maxevents> is the maximum number of events which will be queued up between "
9249 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9250 "passed as C<0>, then the kernel (or previously set) default is used. For "
9251 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9252 "throws away events, but records the fact that it threw them away by setting "
9253 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9254 "C<guestfs_inotify_read>)."
9258 #: ../src/guestfs-actions.pod:2444
9260 "Before any events are generated, you have to add some watches to the "
9261 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9262 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9266 #: ../src/guestfs-actions.pod:2450
9268 "Queued up events should be read periodically by calling "
9269 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9270 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9271 "often enough then you risk the internal queue overflowing."
9275 #: ../src/guestfs-actions.pod:2457
9277 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9278 "This also removes any watches automatically."
9282 #: ../src/guestfs-actions.pod:2461 ../fish/guestfish-actions.pod:1657
9284 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9285 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9286 "that there is one global inotify handle per libguestfs instance."
9290 #: ../src/guestfs-actions.pod:2470
9291 msgid "guestfs_inotify_read"
9295 #: ../src/guestfs-actions.pod:2472
9298 " struct guestfs_inotify_event_list *\n"
9299 " guestfs_inotify_read (guestfs_h *g);\n"
9304 #: ../src/guestfs-actions.pod:2475 ../fish/guestfish-actions.pod:1666
9306 "Return the complete queue of events that have happened since the previous "
9311 #: ../src/guestfs-actions.pod:2478 ../fish/guestfish-actions.pod:1669
9312 msgid "If no events have happened, this returns an empty list."
9316 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1671
9318 "I<Note>: In order to make sure that all events have been read, you must call "
9319 "this function repeatedly until it returns an empty list. The reason is that "
9320 "the call will read events up to the maximum appliance-to-host message size "
9321 "and leave remaining events in the queue."
9325 #: ../src/guestfs-actions.pod:2486
9327 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9328 "there was an error. I<The caller must call "
9329 "C<guestfs_free_inotify_event_list> after use>."
9333 #: ../src/guestfs-actions.pod:2492
9334 msgid "guestfs_inotify_rm_watch"
9338 #: ../src/guestfs-actions.pod:2494
9342 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9348 #: ../src/guestfs-actions.pod:2498
9350 "Remove a previously defined inotify watch. See "
9351 "C<guestfs_inotify_add_watch>."
9355 #: ../src/guestfs-actions.pod:2505
9356 msgid "guestfs_inspect_get_arch"
9360 #: ../src/guestfs-actions.pod:2507
9364 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9365 " const char *root);\n"
9370 #: ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:2534 ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2641 ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:2702 ../src/guestfs-actions.pod:2729 ../src/guestfs-actions.pod:2750 ../src/guestfs-actions.pod:2787 ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2847 ../src/guestfs-actions.pod:2891 ../src/guestfs-actions.pod:2933 ../src/guestfs-actions.pod:2956 ../src/guestfs-actions.pod:2973 ../src/guestfs-actions.pod:2990 ../src/guestfs-actions.pod:3009
9372 "This function should only be called with a root device string as returned by "
9373 "C<guestfs_inspect_os>."
9377 #: ../src/guestfs-actions.pod:2514
9379 "This returns the architecture of the inspected operating system. The "
9380 "possible return values are listed under C<guestfs_file_architecture>."
9384 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1695
9386 "If the architecture could not be determined, then the string C<unknown> is "
9391 #: ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2669 ../src/guestfs-actions.pod:2689 ../src/guestfs-actions.pod:2717 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2834 ../src/guestfs-actions.pod:2858 ../src/guestfs-actions.pod:2877 ../src/guestfs-actions.pod:2920 ../src/guestfs-actions.pod:2943 ../src/guestfs-actions.pod:2963 ../src/guestfs-actions.pod:2980 ../src/guestfs-actions.pod:2999 ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3143 ../fish/guestfish-actions.pod:1698 ../fish/guestfish-actions.pod:1772 ../fish/guestfish-actions.pod:1824 ../fish/guestfish-actions.pod:1839 ../fish/guestfish-actions.pod:1860 ../fish/guestfish-actions.pod:1924 ../fish/guestfish-actions.pod:1948 ../fish/guestfish-actions.pod:1965 ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:2013 ../fish/guestfish-actions.pod:2029 ../fish/guestfish-actions.pod:2042 ../fish/guestfish-actions.pod:2055 ../fish/guestfish-actions.pod:2070 ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2203
9392 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9396 #: ../src/guestfs-actions.pod:2528
9397 msgid "guestfs_inspect_get_distro"
9401 #: ../src/guestfs-actions.pod:2530
9405 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9406 " const char *root);\n"
9411 #: ../src/guestfs-actions.pod:2537 ../fish/guestfish-actions.pod:1707
9412 msgid "This returns the distro (distribution) of the inspected operating system."
9416 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1710
9417 msgid "Currently defined distros are:"
9421 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1714
9422 msgid "\"archlinux\""
9426 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1716
9431 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1718
9436 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1720
9441 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1722
9446 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1724
9451 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1726
9456 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1728
9461 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1730
9462 msgid "\"linuxmint\""
9466 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1732
9471 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1734
9472 msgid "\"mandriva\""
9476 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1736
9481 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1738
9486 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1740
9491 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1742
9496 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1744
9501 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1746
9502 msgid "\"redhat-based\""
9506 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1748
9507 msgid "Some Red Hat-derived distro."
9511 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1750
9516 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1752
9517 msgid "Red Hat Enterprise Linux and some derivatives."
9521 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1754
9526 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1756
9531 #: ../src/guestfs-actions.pod:2588 ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:1758 ../fish/guestfish-actions.pod:1815 ../fish/guestfish-actions.pod:2004
9536 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1760
9537 msgid "The distro could not be determined."
9541 #: ../src/guestfs-actions.pod:2592 ../src/guestfs-actions.pod:2903 ../fish/guestfish-actions.pod:1762 ../fish/guestfish-actions.pod:1996
9546 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1764
9548 "Windows does not have distributions. This string is returned if the OS type "
9553 #: ../src/guestfs-actions.pod:2599 ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:1769 ../fish/guestfish-actions.pod:1821 ../fish/guestfish-actions.pod:2010
9555 "Future versions of libguestfs may return other strings here. The caller "
9556 "should be prepared to handle any string."
9560 #: ../src/guestfs-actions.pod:2609
9561 msgid "guestfs_inspect_get_filesystems"
9565 #: ../src/guestfs-actions.pod:2611
9569 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9570 " const char *root);\n"
9575 #: ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1781
9577 "This returns a list of all the filesystems that we think are associated with "
9578 "this operating system. This includes the root filesystem, other ordinary "
9579 "filesystems, and non-mounted devices like swap partitions."
9583 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1786
9585 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9586 "to be shared between operating systems."
9590 #: ../src/guestfs-actions.pod:2626
9592 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9593 "C<guestfs_inspect_get_mountpoints>."
9597 #: ../src/guestfs-actions.pod:2635
9598 msgid "guestfs_inspect_get_format"
9602 #: ../src/guestfs-actions.pod:2637
9606 " guestfs_inspect_get_format (guestfs_h *g,\n"
9607 " const char *root);\n"
9612 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1799
9614 "This returns the format of the inspected operating system. You can use it "
9615 "to detect install images, live CDs and similar."
9619 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1802
9620 msgid "Currently defined formats are:"
9624 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1806
9625 msgid "\"installed\""
9629 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1808
9630 msgid "This is an installed operating system."
9634 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1810
9635 msgid "\"installer\""
9639 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1812
9641 "The disk image being inspected is not an installed operating system, but a "
9642 "I<bootable> install disk, live CD, or similar."
9646 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1817
9647 msgid "The format of this disk image is not known."
9651 #: ../src/guestfs-actions.pod:2674
9652 msgid "guestfs_inspect_get_hostname"
9656 #: ../src/guestfs-actions.pod:2676
9660 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
9661 " const char *root);\n"
9666 #: ../src/guestfs-actions.pod:2683 ../fish/guestfish-actions.pod:1833
9668 "This function returns the hostname of the operating system as found by "
9669 "inspection of the guest's configuration files."
9673 #: ../src/guestfs-actions.pod:2686 ../fish/guestfish-actions.pod:1836
9675 "If the hostname could not be determined, then the string C<unknown> is "
9680 #: ../src/guestfs-actions.pod:2694
9681 msgid "(Added in 1.7.9)"
9685 #: ../src/guestfs-actions.pod:2696
9686 msgid "guestfs_inspect_get_major_version"
9690 #: ../src/guestfs-actions.pod:2698
9694 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
9695 " const char *root);\n"
9700 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1848
9701 msgid "This returns the major version number of the inspected operating system."
9705 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1851
9707 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9708 "popular public names used by the operating system. Notably the operating "
9709 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9710 "1). You can find out the real versions corresponding to releases of Windows "
9711 "by consulting Wikipedia or MSDN."
9715 #: ../src/guestfs-actions.pod:2715 ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:1858 ../fish/guestfish-actions.pod:1872
9716 msgid "If the version could not be determined, then C<0> is returned."
9720 #: ../src/guestfs-actions.pod:2723
9721 msgid "guestfs_inspect_get_minor_version"
9725 #: ../src/guestfs-actions.pod:2725
9729 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9730 " const char *root);\n"
9735 #: ../src/guestfs-actions.pod:2732 ../fish/guestfish-actions.pod:1869
9736 msgid "This returns the minor version number of the inspected operating system."
9740 #: ../src/guestfs-actions.pod:2737
9742 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9743 "C<guestfs_inspect_get_major_version>."
9747 #: ../src/guestfs-actions.pod:2744
9748 msgid "guestfs_inspect_get_mountpoints"
9752 #: ../src/guestfs-actions.pod:2746
9756 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9757 " const char *root);\n"
9762 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1884
9764 "This returns a hash of where we think the filesystems associated with this "
9765 "operating system should be mounted. Callers should note that this is at "
9766 "best an educated guess made by reading configuration files such as "
9767 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
9768 "are non-existent or not mountable and callers should be prepared to handle "
9769 "or ignore failures if they try to mount them."
9773 #: ../src/guestfs-actions.pod:2762 ../fish/guestfish-actions.pod:1893
9775 "Each element in the returned hashtable has a key which is the path of the "
9776 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9777 "mounted there (eg. C</dev/sda1>)."
9781 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1898
9782 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9786 #: ../src/guestfs-actions.pod:2770
9788 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9789 "C<guestfs_inspect_get_filesystems>."
9793 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:4682 ../src/guestfs-actions.pod:6583
9795 "This function returns a NULL-terminated array of strings, or NULL if there "
9796 "was an error. The array of strings will always have length C<2n+1>, where "
9797 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9798 "caller must free the strings and the array after use>."
9802 #: ../src/guestfs-actions.pod:2781
9803 msgid "guestfs_inspect_get_package_format"
9807 #: ../src/guestfs-actions.pod:2783
9811 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9812 " const char *root);\n"
9817 #: ../src/guestfs-actions.pod:2790
9819 "This function and C<guestfs_inspect_get_package_management> return the "
9820 "package format and package management tool used by the inspected operating "
9821 "system. For example for Fedora these functions would return C<rpm> (package "
9822 "format) and C<yum> (package management)."
9826 #: ../src/guestfs-actions.pod:2796 ../fish/guestfish-actions.pod:1917
9828 "This returns the string C<unknown> if we could not determine the package "
9829 "format I<or> if the operating system does not have a real packaging system "
9834 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1921
9836 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9837 "Future versions of libguestfs may return other strings."
9841 #: ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2839
9842 msgid "(Added in 1.7.5)"
9846 #: ../src/guestfs-actions.pod:2810
9847 msgid "guestfs_inspect_get_package_management"
9851 #: ../src/guestfs-actions.pod:2812
9855 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9856 " const char *root);\n"
9861 #: ../src/guestfs-actions.pod:2819
9863 "C<guestfs_inspect_get_package_format> and this function return the package "
9864 "format and package management tool used by the inspected operating system. "
9865 "For example for Fedora these functions would return C<rpm> (package format) "
9866 "and C<yum> (package management)."
9870 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1939
9872 "This returns the string C<unknown> if we could not determine the package "
9873 "management tool I<or> if the operating system does not have a real packaging "
9874 "system (eg. Windows)."
9878 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1943
9880 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9881 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9882 "libguestfs may return other strings."
9886 #: ../src/guestfs-actions.pod:2841
9887 msgid "guestfs_inspect_get_product_name"
9891 #: ../src/guestfs-actions.pod:2843
9895 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9896 " const char *root);\n"
9901 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1957
9903 "This returns the product name of the inspected operating system. The "
9904 "product name is generally some freeform string which can be displayed to the "
9905 "user, but should not be parsed by programs."
9909 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1962
9911 "If the product name could not be determined, then the string C<unknown> is "
9916 #: ../src/guestfs-actions.pod:2865
9917 msgid "guestfs_inspect_get_roots"
9921 #: ../src/guestfs-actions.pod:2867
9925 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9930 #: ../src/guestfs-actions.pod:2870
9932 "This function is a convenient way to get the list of root devices, as "
9933 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9934 "the whole inspection process."
9938 #: ../src/guestfs-actions.pod:2874
9940 "This returns an empty list if either no root devices were found or the "
9941 "caller has not called C<guestfs_inspect_os>."
9945 #: ../src/guestfs-actions.pod:2883
9946 msgid "(Added in 1.7.3)"
9950 #: ../src/guestfs-actions.pod:2885
9951 msgid "guestfs_inspect_get_type"
9955 #: ../src/guestfs-actions.pod:2887
9959 " guestfs_inspect_get_type (guestfs_h *g,\n"
9960 " const char *root);\n"
9965 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1987
9967 "This returns the type of the inspected operating system. Currently defined "
9972 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1992
9977 #: ../src/guestfs-actions.pod:2901 ../fish/guestfish-actions.pod:1994
9978 msgid "Any Linux-based operating system."
9982 #: ../src/guestfs-actions.pod:2905 ../fish/guestfish-actions.pod:1998
9983 msgid "Any Microsoft Windows operating system."
9987 #: ../src/guestfs-actions.pod:2907 ../fish/guestfish-actions.pod:2000
9992 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2002
9997 #: ../src/guestfs-actions.pod:2913 ../fish/guestfish-actions.pod:2006
9998 msgid "The operating system type could not be determined."
10002 #: ../src/guestfs-actions.pod:2927
10003 msgid "guestfs_inspect_get_windows_systemroot"
10007 #: ../src/guestfs-actions.pod:2929
10011 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10012 " const char *root);\n"
10017 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2022
10019 "This returns the Windows systemroot of the inspected guest. The systemroot "
10020 "is a directory path such as C</WINDOWS>."
10024 #: ../src/guestfs-actions.pod:2939 ../fish/guestfish-actions.pod:2025
10026 "This call assumes that the guest is Windows and that the systemroot could be "
10027 "determined by inspection. If this is not the case then an error is "
10032 #: ../src/guestfs-actions.pod:2948
10033 msgid "(Added in 1.5.25)"
10037 #: ../src/guestfs-actions.pod:2950
10038 msgid "guestfs_inspect_is_live"
10042 #: ../src/guestfs-actions.pod:2952
10046 " guestfs_inspect_is_live (guestfs_h *g,\n"
10047 " const char *root);\n"
10052 #: ../src/guestfs-actions.pod:2959
10054 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10055 "disk), then this returns true if a live image was detected on the disk."
10059 #: ../src/guestfs-actions.pod:2967
10060 msgid "guestfs_inspect_is_multipart"
10064 #: ../src/guestfs-actions.pod:2969
10068 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
10069 " const char *root);\n"
10074 #: ../src/guestfs-actions.pod:2976
10076 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10077 "disk), then this returns true if the disk is part of a set."
10081 #: ../src/guestfs-actions.pod:2984
10082 msgid "guestfs_inspect_is_netinst"
10086 #: ../src/guestfs-actions.pod:2986
10090 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
10091 " const char *root);\n"
10096 #: ../src/guestfs-actions.pod:2993
10098 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10099 "disk), then this returns true if the disk is a network installer, ie. not a "
10100 "self-contained install CD but one which is likely to require network access "
10101 "to complete the install."
10105 #: ../src/guestfs-actions.pod:3003
10106 msgid "guestfs_inspect_list_applications"
10110 #: ../src/guestfs-actions.pod:3005
10113 " struct guestfs_application_list *\n"
10114 " guestfs_inspect_list_applications (guestfs_h *g,\n"
10115 " const char *root);\n"
10120 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2079
10121 msgid "Return the list of applications installed in the operating system."
10125 #: ../src/guestfs-actions.pod:3014
10127 "I<Note:> This call works differently from other parts of the inspection "
10128 "API. You have to call C<guestfs_inspect_os>, then "
10129 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
10130 "this. Listing applications is a significantly more difficult operation "
10131 "which requires access to the full filesystem. Also note that unlike the "
10132 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
10133 "the libguestfs handle, this call actually reads parts of the mounted "
10134 "filesystems during the call."
10138 #: ../src/guestfs-actions.pod:3024 ../fish/guestfish-actions.pod:2091
10140 "This returns an empty list if the inspection code was not able to determine "
10141 "the list of applications."
10145 #: ../src/guestfs-actions.pod:3027 ../fish/guestfish-actions.pod:2094
10146 msgid "The application structure contains the following fields:"
10150 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2098
10151 msgid "C<app_name>"
10155 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2100
10157 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10158 "guests, this is the package name."
10162 #: ../src/guestfs-actions.pod:3036 ../fish/guestfish-actions.pod:2103
10163 msgid "C<app_display_name>"
10167 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2105
10169 "The display name of the application, sometimes localized to the install "
10170 "language of the guest operating system."
10174 #: ../src/guestfs-actions.pod:3041 ../fish/guestfish-actions.pod:2108
10176 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10177 "to display something can use C<app_name> instead."
10181 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2111
10182 msgid "C<app_epoch>"
10186 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2113
10188 "For package managers which use epochs, this contains the epoch of the "
10189 "package (an integer). If unavailable, this is returned as C<0>."
10193 #: ../src/guestfs-actions.pod:3049 ../fish/guestfish-actions.pod:2116
10194 msgid "C<app_version>"
10198 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2118
10200 "The version string of the application or package. If unavailable this is "
10201 "returned as an empty string C<\"\">."
10205 #: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2121
10206 msgid "C<app_release>"
10210 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2123
10212 "The release string of the application or package, for package managers that "
10213 "use this. If unavailable this is returned as an empty string C<\"\">."
10217 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2127
10218 msgid "C<app_install_path>"
10222 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2129
10224 "The installation path of the application (on operating systems such as "
10225 "Windows which use installation paths). This path is in the format used by "
10226 "the guest operating system, it is not a libguestfs path."
10230 #: ../src/guestfs-actions.pod:3067 ../fish/guestfish-actions.pod:2134
10231 msgid "If unavailable this is returned as an empty string C<\"\">."
10235 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2136
10236 msgid "C<app_trans_path>"
10240 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2138
10242 "The install path translated into a libguestfs path. If unavailable this is "
10243 "returned as an empty string C<\"\">."
10247 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2141
10248 msgid "C<app_publisher>"
10252 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2143
10254 "The name of the publisher of the application, for package managers that use "
10255 "this. If unavailable this is returned as an empty string C<\"\">."
10259 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2147
10264 #: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2149
10266 "The URL (eg. upstream URL) of the application. If unavailable this is "
10267 "returned as an empty string C<\"\">."
10271 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2152
10272 msgid "C<app_source_package>"
10276 #: ../src/guestfs-actions.pod:3087 ../fish/guestfish-actions.pod:2154
10278 "For packaging systems which support this, the name of the source package. "
10279 "If unavailable this is returned as an empty string C<\"\">."
10283 #: ../src/guestfs-actions.pod:3090 ../fish/guestfish-actions.pod:2157
10284 msgid "C<app_summary>"
10288 #: ../src/guestfs-actions.pod:3092 ../fish/guestfish-actions.pod:2159
10290 "A short (usually one line) description of the application or package. If "
10291 "unavailable this is returned as an empty string C<\"\">."
10295 #: ../src/guestfs-actions.pod:3095 ../fish/guestfish-actions.pod:2162
10296 msgid "C<app_description>"
10300 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2164
10302 "A longer description of the application or package. If unavailable this is "
10303 "returned as an empty string C<\"\">."
10307 #: ../src/guestfs-actions.pod:3104
10309 "This function returns a C<struct guestfs_application_list *>, or NULL if "
10310 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10315 #: ../src/guestfs-actions.pod:3108
10316 msgid "(Added in 1.7.8)"
10320 #: ../src/guestfs-actions.pod:3110
10321 msgid "guestfs_inspect_os"
10325 #: ../src/guestfs-actions.pod:3112
10329 " guestfs_inspect_os (guestfs_h *g);\n"
10334 #: ../src/guestfs-actions.pod:3115 ../fish/guestfish-actions.pod:2175
10336 "This function uses other libguestfs functions and certain heuristics to "
10337 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10338 "for operating systems."
10342 #: ../src/guestfs-actions.pod:3119 ../fish/guestfish-actions.pod:2179
10343 msgid "The list returned is empty if no operating systems were found."
10347 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2181
10349 "If one operating system was found, then this returns a list with a single "
10350 "element, which is the name of the root filesystem of this operating system. "
10351 "It is also possible for this function to return a list containing more than "
10352 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10353 "element being the root filesystem of one of the operating systems."
10357 #: ../src/guestfs-actions.pod:3128
10359 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10360 "functions in order to query further information about each operating system, "
10361 "such as the name and version."
10365 #: ../src/guestfs-actions.pod:3133
10367 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10368 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10369 "the contents. This should be called with no disks currently mounted. The "
10370 "function may also use Augeas, so any existing Augeas handle will be closed."
10374 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2199
10376 "This function cannot decrypt encrypted disks. The caller must do that first "
10377 "(supplying the necessary keys) if the disk is encrypted."
10381 #: ../src/guestfs-actions.pod:3145 ../src/guestfs-actions.pod:3430 ../src/guestfs-actions.pod:3492
10382 msgid "See also C<guestfs_list_filesystems>."
10386 #: ../src/guestfs-actions.pod:3153
10387 msgid "guestfs_is_blockdev"
10391 #: ../src/guestfs-actions.pod:3155
10395 " guestfs_is_blockdev (guestfs_h *g,\n"
10396 " const char *path);\n"
10401 #: ../src/guestfs-actions.pod:3159 ../fish/guestfish-actions.pod:2211
10403 "This returns C<true> if and only if there is a block device with the given "
10408 #: ../src/guestfs-actions.pod:3162 ../src/guestfs-actions.pod:3191 ../src/guestfs-actions.pod:3221 ../src/guestfs-actions.pod:3236 ../src/guestfs-actions.pod:3252 ../src/guestfs-actions.pod:3308 ../src/guestfs-actions.pod:3323
10409 msgid "See also C<guestfs_stat>."
10413 #: ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:3195 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3312 ../src/guestfs-actions.pod:3327
10414 msgid "(Added in 1.5.10)"
10418 #: ../src/guestfs-actions.pod:3168
10419 msgid "guestfs_is_busy"
10423 #: ../src/guestfs-actions.pod:3170
10427 " guestfs_is_busy (guestfs_h *g);\n"
10432 #: ../src/guestfs-actions.pod:3173 ../fish/guestfish-actions.pod:2220
10434 "This returns true iff this handle is busy processing a command (in the "
10439 #: ../src/guestfs-actions.pod:3182
10440 msgid "guestfs_is_chardev"
10444 #: ../src/guestfs-actions.pod:3184
10448 " guestfs_is_chardev (guestfs_h *g,\n"
10449 " const char *path);\n"
10454 #: ../src/guestfs-actions.pod:3188 ../fish/guestfish-actions.pod:2229
10456 "This returns C<true> if and only if there is a character device with the "
10457 "given C<path> name."
10461 #: ../src/guestfs-actions.pod:3197
10462 msgid "guestfs_is_config"
10466 #: ../src/guestfs-actions.pod:3199
10470 " guestfs_is_config (guestfs_h *g);\n"
10475 #: ../src/guestfs-actions.pod:3202 ../fish/guestfish-actions.pod:2238
10477 "This returns true iff this handle is being configured (in the C<CONFIG> "
10482 #: ../src/guestfs-actions.pod:3211
10483 msgid "guestfs_is_dir"
10487 #: ../src/guestfs-actions.pod:3213
10491 " guestfs_is_dir (guestfs_h *g,\n"
10492 " const char *path);\n"
10497 #: ../src/guestfs-actions.pod:3217 ../fish/guestfish-actions.pod:2247
10499 "This returns C<true> if and only if there is a directory with the given "
10500 "C<path> name. Note that it returns false for other objects like files."
10504 #: ../src/guestfs-actions.pod:3227
10505 msgid "guestfs_is_fifo"
10509 #: ../src/guestfs-actions.pod:3229
10513 " guestfs_is_fifo (guestfs_h *g,\n"
10514 " const char *path);\n"
10519 #: ../src/guestfs-actions.pod:3233 ../fish/guestfish-actions.pod:2257
10521 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10522 "given C<path> name."
10526 #: ../src/guestfs-actions.pod:3242
10527 msgid "guestfs_is_file"
10531 #: ../src/guestfs-actions.pod:3244
10535 " guestfs_is_file (guestfs_h *g,\n"
10536 " const char *path);\n"
10541 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2266
10543 "This returns C<true> if and only if there is a regular file with the given "
10544 "C<path> name. Note that it returns false for other objects like "
10549 #: ../src/guestfs-actions.pod:3258
10550 msgid "guestfs_is_launching"
10554 #: ../src/guestfs-actions.pod:3260
10558 " guestfs_is_launching (guestfs_h *g);\n"
10563 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2276
10565 "This returns true iff this handle is launching the subprocess (in the "
10566 "C<LAUNCHING> state)."
10570 #: ../src/guestfs-actions.pod:3272
10571 msgid "guestfs_is_lv"
10575 #: ../src/guestfs-actions.pod:3274
10579 " guestfs_is_lv (guestfs_h *g,\n"
10580 " const char *device);\n"
10585 #: ../src/guestfs-actions.pod:3278 ../fish/guestfish-actions.pod:2285
10587 "This command tests whether C<device> is a logical volume, and returns true "
10588 "iff this is the case."
10592 #: ../src/guestfs-actions.pod:3285
10593 msgid "guestfs_is_ready"
10597 #: ../src/guestfs-actions.pod:3287
10601 " guestfs_is_ready (guestfs_h *g);\n"
10606 #: ../src/guestfs-actions.pod:3290 ../fish/guestfish-actions.pod:2292
10608 "This returns true iff this handle is ready to accept commands (in the "
10613 #: ../src/guestfs-actions.pod:3299
10614 msgid "guestfs_is_socket"
10618 #: ../src/guestfs-actions.pod:3301
10622 " guestfs_is_socket (guestfs_h *g,\n"
10623 " const char *path);\n"
10628 #: ../src/guestfs-actions.pod:3305 ../fish/guestfish-actions.pod:2301
10630 "This returns C<true> if and only if there is a Unix domain socket with the "
10631 "given C<path> name."
10635 #: ../src/guestfs-actions.pod:3314
10636 msgid "guestfs_is_symlink"
10640 #: ../src/guestfs-actions.pod:3316
10644 " guestfs_is_symlink (guestfs_h *g,\n"
10645 " const char *path);\n"
10650 #: ../src/guestfs-actions.pod:3320 ../fish/guestfish-actions.pod:2310
10652 "This returns C<true> if and only if there is a symbolic link with the given "
10657 #: ../src/guestfs-actions.pod:3329
10658 msgid "guestfs_kill_subprocess"
10662 #: ../src/guestfs-actions.pod:3331
10666 " guestfs_kill_subprocess (guestfs_h *g);\n"
10671 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2319
10672 msgid "This kills the qemu subprocess. You should never need to call this."
10676 #: ../src/guestfs-actions.pod:3340
10677 msgid "guestfs_launch"
10681 #: ../src/guestfs-actions.pod:3342
10685 " guestfs_launch (guestfs_h *g);\n"
10690 #: ../src/guestfs-actions.pod:3345 ../fish/guestfish-actions.pod:2327
10692 "Internally libguestfs is implemented by running a virtual machine using "
10697 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2330
10699 "You should call this after configuring the handle (eg. adding drives) but "
10700 "before performing any actions."
10704 #: ../src/guestfs-actions.pod:3355
10705 msgid "guestfs_lchown"
10709 #: ../src/guestfs-actions.pod:3357
10713 " guestfs_lchown (guestfs_h *g,\n"
10716 " const char *path);\n"
10721 #: ../src/guestfs-actions.pod:3363
10723 "Change the file owner to C<owner> and group to C<group>. This is like "
10724 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
10725 "changed, not the target."
10729 #: ../src/guestfs-actions.pod:3375
10730 msgid "guestfs_lgetxattr"
10734 #: ../src/guestfs-actions.pod:3377
10738 " guestfs_lgetxattr (guestfs_h *g,\n"
10739 " const char *path,\n"
10740 " const char *name,\n"
10741 " size_t *size_r);\n"
10746 #: ../src/guestfs-actions.pod:3383 ../fish/guestfish-actions.pod:2349
10748 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10749 "is a symlink, then this call returns an extended attribute from the symlink."
10753 #: ../src/guestfs-actions.pod:3397
10754 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
10758 #: ../src/guestfs-actions.pod:3405
10759 msgid "guestfs_lgetxattrs"
10763 #: ../src/guestfs-actions.pod:3407
10766 " struct guestfs_xattr_list *\n"
10767 " guestfs_lgetxattrs (guestfs_h *g,\n"
10768 " const char *path);\n"
10773 #: ../src/guestfs-actions.pod:3411
10775 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
10776 "then it returns the extended attributes of the link itself."
10780 #: ../src/guestfs-actions.pod:3421
10781 msgid "guestfs_list_devices"
10785 #: ../src/guestfs-actions.pod:3423
10789 " guestfs_list_devices (guestfs_h *g);\n"
10794 #: ../src/guestfs-actions.pod:3426 ../fish/guestfish-actions.pod:2377
10795 msgid "List all the block devices."
10799 #: ../src/guestfs-actions.pod:3428 ../fish/guestfish-actions.pod:2379
10800 msgid "The full block device names are returned, eg. C</dev/sda>."
10804 #: ../src/guestfs-actions.pod:3438
10805 msgid "guestfs_list_filesystems"
10809 #: ../src/guestfs-actions.pod:3440
10813 " guestfs_list_filesystems (guestfs_h *g);\n"
10818 #: ../src/guestfs-actions.pod:3443 ../fish/guestfish-actions.pod:2387
10820 "This inspection command looks for filesystems on partitions, block devices "
10821 "and logical volumes, returning a list of devices containing filesystems and "
10826 #: ../src/guestfs-actions.pod:3447 ../fish/guestfish-actions.pod:2391
10828 "The return value is a hash, where the keys are the devices containing "
10829 "filesystems, and the values are the filesystem types. For example:"
10833 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2395
10836 " \"/dev/sda1\" => \"ntfs\"\n"
10837 " \"/dev/sda2\" => \"ext2\"\n"
10838 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10839 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10844 #: ../src/guestfs-actions.pod:3456 ../fish/guestfish-actions.pod:2400
10846 "The value can have the special value \"unknown\", meaning the content of the "
10847 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10851 #: ../src/guestfs-actions.pod:3460
10853 "This command runs other libguestfs commands, which might include "
10854 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10855 "soon after launch and only when nothing is mounted."
10859 #: ../src/guestfs-actions.pod:3464
10861 "Not all of the filesystems returned will be mountable. In particular, swap "
10862 "partitions are returned in the list. Also this command does not check that "
10863 "each filesystem found is valid and mountable, and some filesystems might be "
10864 "mountable but require special options. Filesystems may not all belong to a "
10865 "single logical operating system (use C<guestfs_inspect_os> to look for "
10870 #: ../src/guestfs-actions.pod:3478 ../src/guestfs-actions.pod:5083
10871 msgid "(Added in 1.5.15)"
10875 #: ../src/guestfs-actions.pod:3480
10876 msgid "guestfs_list_partitions"
10880 #: ../src/guestfs-actions.pod:3482
10884 " guestfs_list_partitions (guestfs_h *g);\n"
10889 #: ../src/guestfs-actions.pod:3485 ../fish/guestfish-actions.pod:2420
10890 msgid "List all the partitions detected on all block devices."
10894 #: ../src/guestfs-actions.pod:3487 ../fish/guestfish-actions.pod:2422
10895 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10899 #: ../src/guestfs-actions.pod:3489
10901 "This does not return logical volumes. For that you will need to call "
10906 #: ../src/guestfs-actions.pod:3500
10911 #: ../src/guestfs-actions.pod:3502
10915 " guestfs_ll (guestfs_h *g,\n"
10916 " const char *directory);\n"
10921 #: ../src/guestfs-actions.pod:3506 ../fish/guestfish-actions.pod:2433
10923 "List the files in C<directory> (relative to the root directory, there is no "
10924 "cwd) in the format of 'ls -la'."
10928 #: ../src/guestfs-actions.pod:3509 ../fish/guestfish-actions.pod:2436
10930 "This command is mostly useful for interactive sessions. It is I<not> "
10931 "intended that you try to parse the output string."
10935 #: ../src/guestfs-actions.pod:3517
10940 #: ../src/guestfs-actions.pod:3519
10944 " guestfs_ln (guestfs_h *g,\n"
10945 " const char *target,\n"
10946 " const char *linkname);\n"
10951 #: ../src/guestfs-actions.pod:3524 ../fish/guestfish-actions.pod:2443
10952 msgid "This command creates a hard link using the C<ln> command."
10956 #: ../src/guestfs-actions.pod:3530
10957 msgid "guestfs_ln_f"
10961 #: ../src/guestfs-actions.pod:3532
10965 " guestfs_ln_f (guestfs_h *g,\n"
10966 " const char *target,\n"
10967 " const char *linkname);\n"
10972 #: ../src/guestfs-actions.pod:3537 ../fish/guestfish-actions.pod:2449
10974 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10975 "option removes the link (C<linkname>) if it exists already."
10979 #: ../src/guestfs-actions.pod:3544
10980 msgid "guestfs_ln_s"
10984 #: ../src/guestfs-actions.pod:3546
10988 " guestfs_ln_s (guestfs_h *g,\n"
10989 " const char *target,\n"
10990 " const char *linkname);\n"
10995 #: ../src/guestfs-actions.pod:3551 ../fish/guestfish-actions.pod:2456
10996 msgid "This command creates a symbolic link using the C<ln -s> command."
11000 #: ../src/guestfs-actions.pod:3557
11001 msgid "guestfs_ln_sf"
11005 #: ../src/guestfs-actions.pod:3559
11009 " guestfs_ln_sf (guestfs_h *g,\n"
11010 " const char *target,\n"
11011 " const char *linkname);\n"
11016 #: ../src/guestfs-actions.pod:3564 ../fish/guestfish-actions.pod:2462
11018 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
11019 "option removes the link (C<linkname>) if it exists already."
11023 #: ../src/guestfs-actions.pod:3571
11024 msgid "guestfs_lremovexattr"
11028 #: ../src/guestfs-actions.pod:3573
11032 " guestfs_lremovexattr (guestfs_h *g,\n"
11033 " const char *xattr,\n"
11034 " const char *path);\n"
11039 #: ../src/guestfs-actions.pod:3578
11041 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
11042 "link, then it removes an extended attribute of the link itself."
11046 #: ../src/guestfs-actions.pod:3586
11051 #: ../src/guestfs-actions.pod:3588
11055 " guestfs_ls (guestfs_h *g,\n"
11056 " const char *directory);\n"
11061 #: ../src/guestfs-actions.pod:3592 ../fish/guestfish-actions.pod:2477
11063 "List the files in C<directory> (relative to the root directory, there is no "
11064 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11069 #: ../src/guestfs-actions.pod:3596
11071 "This command is mostly useful for interactive sessions. Programs should "
11072 "probably use C<guestfs_readdir> instead."
11076 #: ../src/guestfs-actions.pod:3605
11077 msgid "guestfs_lsetxattr"
11081 #: ../src/guestfs-actions.pod:3607
11085 " guestfs_lsetxattr (guestfs_h *g,\n"
11086 " const char *xattr,\n"
11087 " const char *val,\n"
11089 " const char *path);\n"
11094 #: ../src/guestfs-actions.pod:3614
11096 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
11097 "then it sets an extended attribute of the link itself."
11101 #: ../src/guestfs-actions.pod:3622
11102 msgid "guestfs_lstat"
11106 #: ../src/guestfs-actions.pod:3624
11109 " struct guestfs_stat *\n"
11110 " guestfs_lstat (guestfs_h *g,\n"
11111 " const char *path);\n"
11116 #: ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:6182 ../fish/guestfish-actions.pod:2496 ../fish/guestfish-actions.pod:4161
11117 msgid "Returns file information for the given C<path>."
11121 #: ../src/guestfs-actions.pod:3630
11123 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
11124 "link, then the link is stat-ed, not the file it refers to."
11128 #: ../src/guestfs-actions.pod:3634 ../fish/guestfish-actions.pod:2502
11129 msgid "This is the same as the C<lstat(2)> system call."
11133 #: ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:6186
11135 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
11136 "error. I<The caller must call C<guestfs_free_stat> after use>."
11140 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6208 ../src/guestfs-actions.pod:6589
11141 msgid "(Added in 0.9.2)"
11145 #: ../src/guestfs-actions.pod:3642
11146 msgid "guestfs_lstatlist"
11150 #: ../src/guestfs-actions.pod:3644
11153 " struct guestfs_stat_list *\n"
11154 " guestfs_lstatlist (guestfs_h *g,\n"
11155 " const char *path,\n"
11156 " char *const *names);\n"
11161 #: ../src/guestfs-actions.pod:3649
11163 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
11164 "files, where all files are in the directory C<path>. C<names> is the list "
11165 "of files from this directory."
11169 #: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2512
11171 "On return you get a list of stat structs, with a one-to-one correspondence "
11172 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11173 "then the C<ino> field of that structure is set to C<-1>."
11177 #: ../src/guestfs-actions.pod:3658
11179 "This call is intended for programs that want to efficiently list a directory "
11180 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
11181 "for a similarly efficient call for getting extended attributes. Very long "
11182 "directory listings might cause the protocol message size to be exceeded, "
11183 "causing this call to fail. The caller must split up such requests into "
11184 "smaller groups of names."
11188 #: ../src/guestfs-actions.pod:3666
11190 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
11191 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
11195 #: ../src/guestfs-actions.pod:3672
11196 msgid "guestfs_luks_add_key"
11200 #: ../src/guestfs-actions.pod:3674
11204 " guestfs_luks_add_key (guestfs_h *g,\n"
11205 " const char *device,\n"
11206 " const char *key,\n"
11207 " const char *newkey,\n"
11213 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2529
11215 "This command adds a new key on LUKS device C<device>. C<key> is any "
11216 "existing key, and is used to access the device. C<newkey> is the new key to "
11217 "add. C<keyslot> is the key slot that will be replaced."
11221 #: ../src/guestfs-actions.pod:3686
11223 "Note that if C<keyslot> already contains a key, then this command will "
11224 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
11228 #: ../src/guestfs-actions.pod:3692 ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:3755 ../src/guestfs-actions.pod:3775 ../src/guestfs-actions.pod:3807 ../src/guestfs-actions.pod:3826
11230 "This function takes a key or passphrase parameter which could contain "
11231 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
11236 #: ../src/guestfs-actions.pod:3696 ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3759 ../src/guestfs-actions.pod:3779
11237 msgid "(Added in 1.5.2)"
11241 #: ../src/guestfs-actions.pod:3698
11242 msgid "guestfs_luks_close"
11246 #: ../src/guestfs-actions.pod:3700
11250 " guestfs_luks_close (guestfs_h *g,\n"
11251 " const char *device);\n"
11256 #: ../src/guestfs-actions.pod:3704
11258 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
11259 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
11260 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
11261 "underlying block device."
11265 #: ../src/guestfs-actions.pod:3712 ../src/guestfs-actions.pod:3811 ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:3928
11266 msgid "(Added in 1.5.1)"
11270 #: ../src/guestfs-actions.pod:3714
11271 msgid "guestfs_luks_format"
11275 #: ../src/guestfs-actions.pod:3716
11279 " guestfs_luks_format (guestfs_h *g,\n"
11280 " const char *device,\n"
11281 " const char *key,\n"
11287 #: ../src/guestfs-actions.pod:3722 ../fish/guestfish-actions.pod:2555
11289 "This command erases existing data on C<device> and formats the device as a "
11290 "LUKS encrypted device. C<key> is the initial key, which is added to key "
11291 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
11295 #: ../src/guestfs-actions.pod:3729 ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3892 ../src/guestfs-actions.pod:4834 ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:6017 ../src/guestfs-actions.pod:6040 ../src/guestfs-actions.pod:6066 ../src/guestfs-actions.pod:7226 ../fish/guestfish-actions.pod:2563 ../fish/guestfish-actions.pod:2576 ../fish/guestfish-actions.pod:2660 ../fish/guestfish-actions.pod:3234 ../fish/guestfish-actions.pod:3754 ../fish/guestfish-actions.pod:4060 ../fish/guestfish-actions.pod:4076 ../fish/guestfish-actions.pod:4091 ../fish/guestfish-actions.pod:4806
11297 "B<This command is dangerous. Without careful use you can easily destroy all "
11302 #: ../src/guestfs-actions.pod:3738
11303 msgid "guestfs_luks_format_cipher"
11307 #: ../src/guestfs-actions.pod:3740
11311 " guestfs_luks_format_cipher (guestfs_h *g,\n"
11312 " const char *device,\n"
11313 " const char *key,\n"
11315 " const char *cipher);\n"
11320 #: ../src/guestfs-actions.pod:3747
11322 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11323 "set the C<cipher> used."
11327 #: ../src/guestfs-actions.pod:3761
11328 msgid "guestfs_luks_kill_slot"
11332 #: ../src/guestfs-actions.pod:3763
11336 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11337 " const char *device,\n"
11338 " const char *key,\n"
11344 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2583
11346 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11347 "device C<device>. C<key> must be one of the I<other> keys."
11351 #: ../src/guestfs-actions.pod:3781
11352 msgid "guestfs_luks_open"
11356 #: ../src/guestfs-actions.pod:3783
11360 " guestfs_luks_open (guestfs_h *g,\n"
11361 " const char *device,\n"
11362 " const char *key,\n"
11363 " const char *mapname);\n"
11368 #: ../src/guestfs-actions.pod:3789 ../fish/guestfish-actions.pod:2594
11370 "This command opens a block device which has been encrypted according to the "
11371 "Linux Unified Key Setup (LUKS) standard."
11375 #: ../src/guestfs-actions.pod:3792 ../fish/guestfish-actions.pod:2597
11376 msgid "C<device> is the encrypted block device or partition."
11380 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2599
11382 "The caller must supply one of the keys associated with the LUKS block "
11383 "device, in the C<key> parameter."
11387 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2602
11389 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11390 "writes to this block device are decrypted from and encrypted to the "
11391 "underlying C<device> respectively."
11395 #: ../src/guestfs-actions.pod:3801
11397 "If this block device contains LVM volume groups, then calling "
11398 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11403 #: ../src/guestfs-actions.pod:3813
11404 msgid "guestfs_luks_open_ro"
11408 #: ../src/guestfs-actions.pod:3815
11412 " guestfs_luks_open_ro (guestfs_h *g,\n"
11413 " const char *device,\n"
11414 " const char *key,\n"
11415 " const char *mapname);\n"
11420 #: ../src/guestfs-actions.pod:3821
11422 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11427 #: ../src/guestfs-actions.pod:3832
11428 msgid "guestfs_lvcreate"
11432 #: ../src/guestfs-actions.pod:3834
11436 " guestfs_lvcreate (guestfs_h *g,\n"
11437 " const char *logvol,\n"
11438 " const char *volgroup,\n"
11444 #: ../src/guestfs-actions.pod:3840 ../fish/guestfish-actions.pod:2627
11446 "This creates an LVM logical volume called C<logvol> on the volume group "
11447 "C<volgroup>, with C<size> megabytes."
11451 #: ../src/guestfs-actions.pod:3847
11452 msgid "guestfs_lvm_canonical_lv_name"
11456 #: ../src/guestfs-actions.pod:3849
11460 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11461 " const char *lvname);\n"
11466 #: ../src/guestfs-actions.pod:3853 ../fish/guestfish-actions.pod:2634
11468 "This converts alternative naming schemes for LVs that you might find to the "
11469 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11474 #: ../src/guestfs-actions.pod:3857 ../fish/guestfish-actions.pod:2638
11476 "This command returns an error if the C<lvname> parameter does not refer to a "
11481 #: ../src/guestfs-actions.pod:3860
11482 msgid "See also C<guestfs_is_lv>."
11486 #: ../src/guestfs-actions.pod:3865
11487 msgid "(Added in 1.5.24)"
11491 #: ../src/guestfs-actions.pod:3867
11492 msgid "guestfs_lvm_clear_filter"
11496 #: ../src/guestfs-actions.pod:3869
11500 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11505 #: ../src/guestfs-actions.pod:3872
11507 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11508 "see every block device."
11512 #: ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2650 ../fish/guestfish-actions.pod:2681
11513 msgid "This command also clears the LVM cache and performs a volume group scan."
11517 #: ../src/guestfs-actions.pod:3882
11518 msgid "guestfs_lvm_remove_all"
11522 #: ../src/guestfs-actions.pod:3884
11526 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11531 #: ../src/guestfs-actions.pod:3887 ../fish/guestfish-actions.pod:2657
11533 "This command removes all LVM logical volumes, volume groups and physical "
11538 #: ../src/guestfs-actions.pod:3897
11539 msgid "guestfs_lvm_set_filter"
11543 #: ../src/guestfs-actions.pod:3899
11547 " guestfs_lvm_set_filter (guestfs_h *g,\n"
11548 " char *const *devices);\n"
11553 #: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:2667
11555 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11556 "block devices in the list C<devices>, and will ignore all other attached "
11561 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2671
11563 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11564 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11565 "there are two types of duplication possible: either cloned PVs/VGs which "
11566 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11567 "same name. In normal operation you cannot create this situation, but you "
11568 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11569 "inside the LVM metadata."
11573 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2684
11574 msgid "You can filter whole block devices or individual partitions."
11578 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2686
11580 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11581 "filesystem), even if you are not filtering out that VG."
11585 #: ../src/guestfs-actions.pod:3930
11586 msgid "guestfs_lvremove"
11590 #: ../src/guestfs-actions.pod:3932
11594 " guestfs_lvremove (guestfs_h *g,\n"
11595 " const char *device);\n"
11600 #: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:2694
11602 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11603 "LV, such as C</dev/VG/LV>."
11607 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2697
11609 "You can also remove all LVs in a volume group by specifying the VG name, "
11614 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:5180 ../src/guestfs-actions.pod:6965
11615 msgid "(Added in 1.0.13)"
11619 #: ../src/guestfs-actions.pod:3946
11620 msgid "guestfs_lvrename"
11624 #: ../src/guestfs-actions.pod:3948
11628 " guestfs_lvrename (guestfs_h *g,\n"
11629 " const char *logvol,\n"
11630 " const char *newlogvol);\n"
11635 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:2704
11636 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11640 #: ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:6978
11641 msgid "(Added in 1.0.83)"
11645 #: ../src/guestfs-actions.pod:3959
11646 msgid "guestfs_lvresize"
11650 #: ../src/guestfs-actions.pod:3961
11654 " guestfs_lvresize (guestfs_h *g,\n"
11655 " const char *device,\n"
11661 #: ../src/guestfs-actions.pod:3966 ../fish/guestfish-actions.pod:2710
11663 "This resizes (expands or shrinks) an existing LVM logical volume to "
11664 "C<mbytes>. When reducing, data in the reduced part is lost."
11668 #: ../src/guestfs-actions.pod:3974
11669 msgid "guestfs_lvresize_free"
11673 #: ../src/guestfs-actions.pod:3976
11677 " guestfs_lvresize_free (guestfs_h *g,\n"
11678 " const char *lv,\n"
11684 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2718
11686 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11687 "remaining free space in the volume group. Commonly you would call this with "
11688 "pc = 100 which expands the logical volume as much as possible, using all "
11689 "remaining free space in the volume group."
11693 #: ../src/guestfs-actions.pod:3989
11694 msgid "(Added in 1.3.3)"
11698 #: ../src/guestfs-actions.pod:3991
11699 msgid "guestfs_lvs"
11703 #: ../src/guestfs-actions.pod:3993
11707 " guestfs_lvs (guestfs_h *g);\n"
11712 #: ../src/guestfs-actions.pod:3996 ../fish/guestfish-actions.pod:2728
11714 "List all the logical volumes detected. This is the equivalent of the "
11715 "L<lvs(8)> command."
11719 #: ../src/guestfs-actions.pod:3999 ../fish/guestfish-actions.pod:2731
11721 "This returns a list of the logical volume device names "
11722 "(eg. C</dev/VolGroup00/LogVol00>)."
11726 #: ../src/guestfs-actions.pod:4002
11727 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
11731 #: ../src/guestfs-actions.pod:4010
11732 msgid "guestfs_lvs_full"
11736 #: ../src/guestfs-actions.pod:4012
11739 " struct guestfs_lvm_lv_list *\n"
11740 " guestfs_lvs_full (guestfs_h *g);\n"
11745 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2740
11747 "List all the logical volumes detected. This is the equivalent of the "
11748 "L<lvs(8)> command. The \"full\" version includes all fields."
11752 #: ../src/guestfs-actions.pod:4018
11754 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
11755 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
11760 #: ../src/guestfs-actions.pod:4024
11761 msgid "guestfs_lvuuid"
11765 #: ../src/guestfs-actions.pod:4026
11769 " guestfs_lvuuid (guestfs_h *g,\n"
11770 " const char *device);\n"
11775 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2747
11776 msgid "This command returns the UUID of the LVM LV C<device>."
11780 #: ../src/guestfs-actions.pod:4037
11781 msgid "guestfs_lxattrlist"
11785 #: ../src/guestfs-actions.pod:4039
11788 " struct guestfs_xattr_list *\n"
11789 " guestfs_lxattrlist (guestfs_h *g,\n"
11790 " const char *path,\n"
11791 " char *const *names);\n"
11796 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2753
11798 "This call allows you to get the extended attributes of multiple files, where "
11799 "all files are in the directory C<path>. C<names> is the list of files from "
11804 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2757
11806 "On return you get a flat list of xattr structs which must be interpreted "
11807 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11808 "C<attrval> in this struct is zero-length to indicate there was an error "
11809 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11810 "number (the number of following attributes for this file, which could be "
11811 "C<\"0\">). Then after the first xattr struct are the zero or more "
11812 "attributes for the first named file. This repeats for the second and "
11813 "subsequent files."
11817 #: ../src/guestfs-actions.pod:4058
11819 "This call is intended for programs that want to efficiently list a directory "
11820 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11821 "a similarly efficient call for getting standard stats. Very long directory "
11822 "listings might cause the protocol message size to be exceeded, causing this "
11823 "call to fail. The caller must split up such requests into smaller groups of "
11828 #: ../src/guestfs-actions.pod:4072
11829 msgid "guestfs_mkdir"
11833 #: ../src/guestfs-actions.pod:4074
11837 " guestfs_mkdir (guestfs_h *g,\n"
11838 " const char *path);\n"
11843 #: ../src/guestfs-actions.pod:4078 ../fish/guestfish-actions.pod:2779
11844 msgid "Create a directory named C<path>."
11848 #: ../src/guestfs-actions.pod:4084
11849 msgid "guestfs_mkdir_mode"
11853 #: ../src/guestfs-actions.pod:4086
11857 " guestfs_mkdir_mode (guestfs_h *g,\n"
11858 " const char *path,\n"
11864 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2785
11866 "This command creates a directory, setting the initial permissions of the "
11867 "directory to C<mode>."
11871 #: ../src/guestfs-actions.pod:4094 ../fish/guestfish-actions.pod:2788
11873 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11874 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11879 #: ../src/guestfs-actions.pod:4098
11880 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11884 #: ../src/guestfs-actions.pod:4104
11885 msgid "guestfs_mkdir_p"
11889 #: ../src/guestfs-actions.pod:4106
11893 " guestfs_mkdir_p (guestfs_h *g,\n"
11894 " const char *path);\n"
11899 #: ../src/guestfs-actions.pod:4110 ../fish/guestfish-actions.pod:2798
11901 "Create a directory named C<path>, creating any parent directories as "
11902 "necessary. This is like the C<mkdir -p> shell command."
11906 #: ../src/guestfs-actions.pod:4117
11907 msgid "guestfs_mkdtemp"
11911 #: ../src/guestfs-actions.pod:4119
11915 " guestfs_mkdtemp (guestfs_h *g,\n"
11916 " const char *template);\n"
11921 #: ../src/guestfs-actions.pod:4123 ../fish/guestfish-actions.pod:2805
11923 "This command creates a temporary directory. The C<template> parameter "
11924 "should be a full pathname for the temporary directory name with the final "
11925 "six characters being \"XXXXXX\"."
11929 #: ../src/guestfs-actions.pod:4128 ../fish/guestfish-actions.pod:2810
11931 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11932 "being suitable for Windows filesystems."
11936 #: ../src/guestfs-actions.pod:4131 ../fish/guestfish-actions.pod:2813
11937 msgid "The name of the temporary directory that was created is returned."
11941 #: ../src/guestfs-actions.pod:4134 ../fish/guestfish-actions.pod:2816
11942 msgid "The temporary directory is created with mode 0700 and is owned by root."
11946 #: ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:2819
11948 "The caller is responsible for deleting the temporary directory and its "
11949 "contents after use."
11953 #: ../src/guestfs-actions.pod:4140 ../fish/guestfish-actions.pod:2822
11954 msgid "See also: L<mkdtemp(3)>"
11958 #: ../src/guestfs-actions.pod:4147
11959 msgid "guestfs_mke2fs_J"
11963 #: ../src/guestfs-actions.pod:4149
11967 " guestfs_mke2fs_J (guestfs_h *g,\n"
11968 " const char *fstype,\n"
11969 " int blocksize,\n"
11970 " const char *device,\n"
11971 " const char *journal);\n"
11976 #: ../src/guestfs-actions.pod:4156 ../fish/guestfish-actions.pod:2828
11978 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11979 "C<journal>. It is equivalent to the command:"
11983 #: ../src/guestfs-actions.pod:4160 ../fish/guestfish-actions.pod:2832
11986 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11991 #: ../src/guestfs-actions.pod:4162
11992 msgid "See also C<guestfs_mke2journal>."
11996 #: ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4184 ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4218 ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4246 ../src/guestfs-actions.pod:4305 ../src/guestfs-actions.pod:4570
11997 msgid "(Added in 1.0.68)"
12001 #: ../src/guestfs-actions.pod:4168
12002 msgid "guestfs_mke2fs_JL"
12006 #: ../src/guestfs-actions.pod:4170
12010 " guestfs_mke2fs_JL (guestfs_h *g,\n"
12011 " const char *fstype,\n"
12012 " int blocksize,\n"
12013 " const char *device,\n"
12014 " const char *label);\n"
12019 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2840
12021 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12022 "the journal labeled C<label>."
12026 #: ../src/guestfs-actions.pod:4180
12027 msgid "See also C<guestfs_mke2journal_L>."
12031 #: ../src/guestfs-actions.pod:4186
12032 msgid "guestfs_mke2fs_JU"
12036 #: ../src/guestfs-actions.pod:4188
12040 " guestfs_mke2fs_JU (guestfs_h *g,\n"
12041 " const char *fstype,\n"
12042 " int blocksize,\n"
12043 " const char *device,\n"
12044 " const char *uuid);\n"
12049 #: ../src/guestfs-actions.pod:4195 ../fish/guestfish-actions.pod:2849
12051 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12052 "the journal with UUID C<uuid>."
12056 #: ../src/guestfs-actions.pod:4198
12057 msgid "See also C<guestfs_mke2journal_U>."
12061 #: ../src/guestfs-actions.pod:4204
12062 msgid "guestfs_mke2journal"
12066 #: ../src/guestfs-actions.pod:4206
12070 " guestfs_mke2journal (guestfs_h *g,\n"
12071 " int blocksize,\n"
12072 " const char *device);\n"
12077 #: ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:2858
12079 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12084 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2861
12087 " mke2fs -O journal_dev -b blocksize device\n"
12092 #: ../src/guestfs-actions.pod:4220
12093 msgid "guestfs_mke2journal_L"
12097 #: ../src/guestfs-actions.pod:4222
12101 " guestfs_mke2journal_L (guestfs_h *g,\n"
12102 " int blocksize,\n"
12103 " const char *label,\n"
12104 " const char *device);\n"
12109 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2867
12110 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12114 #: ../src/guestfs-actions.pod:4234
12115 msgid "guestfs_mke2journal_U"
12119 #: ../src/guestfs-actions.pod:4236
12123 " guestfs_mke2journal_U (guestfs_h *g,\n"
12124 " int blocksize,\n"
12125 " const char *uuid,\n"
12126 " const char *device);\n"
12131 #: ../src/guestfs-actions.pod:4242 ../fish/guestfish-actions.pod:2873
12132 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12136 #: ../src/guestfs-actions.pod:4248
12137 msgid "guestfs_mkfifo"
12141 #: ../src/guestfs-actions.pod:4250
12145 " guestfs_mkfifo (guestfs_h *g,\n"
12147 " const char *path);\n"
12152 #: ../src/guestfs-actions.pod:4255
12154 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12155 "is just a convenient wrapper around C<guestfs_mknod>."
12159 #: ../src/guestfs-actions.pod:4265
12160 msgid "guestfs_mkfs"
12164 #: ../src/guestfs-actions.pod:4267
12168 " guestfs_mkfs (guestfs_h *g,\n"
12169 " const char *fstype,\n"
12170 " const char *device);\n"
12175 #: ../src/guestfs-actions.pod:4272 ../fish/guestfish-actions.pod:2889
12177 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12178 "volume). The filesystem type is C<fstype>, for example C<ext3>."
12182 #: ../src/guestfs-actions.pod:4280
12183 msgid "guestfs_mkfs_b"
12187 #: ../src/guestfs-actions.pod:4282
12191 " guestfs_mkfs_b (guestfs_h *g,\n"
12192 " const char *fstype,\n"
12193 " int blocksize,\n"
12194 " const char *device);\n"
12199 #: ../src/guestfs-actions.pod:4288
12201 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
12202 "block size of the resulting filesystem. Supported block sizes depend on the "
12203 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
12207 #: ../src/guestfs-actions.pod:4293 ../src/guestfs-actions.pod:4336 ../fish/guestfish-actions.pod:2902 ../fish/guestfish-actions.pod:2929
12209 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
12214 #: ../src/guestfs-actions.pod:4298 ../fish/guestfish-actions.pod:2905
12216 "This function is deprecated. In new code, use the C<mkfs_opts> call "
12221 #: ../src/guestfs-actions.pod:4307
12222 msgid "guestfs_mkfs_opts"
12226 #: ../src/guestfs-actions.pod:4309
12230 " guestfs_mkfs_opts (guestfs_h *g,\n"
12231 " const char *fstype,\n"
12232 " const char *device,\n"
12238 #: ../src/guestfs-actions.pod:4320
12241 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
12242 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
12247 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2916
12249 "This function creates a filesystem on C<device>. The filesystem type is "
12250 "C<fstype>, for example C<ext3>."
12254 #: ../src/guestfs-actions.pod:4330 ../fish/guestfish-actions.pod:2923
12255 msgid "C<blocksize>"
12259 #: ../src/guestfs-actions.pod:4332 ../fish/guestfish-actions.pod:2925
12261 "The filesystem block size. Supported block sizes depend on the filesystem "
12262 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
12267 #: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:2932
12268 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
12272 #: ../src/guestfs-actions.pod:4341 ../fish/guestfish-actions.pod:2934
12273 msgid "C<features>"
12277 #: ../src/guestfs-actions.pod:4343 ../fish/guestfish-actions.pod:2936
12278 msgid "This passes the C<-O> parameter to the external mkfs program."
12282 #: ../src/guestfs-actions.pod:4345 ../fish/guestfish-actions.pod:2938
12284 "For certain filesystem types, this allows extra filesystem features to be "
12285 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
12289 #: ../src/guestfs-actions.pod:4349 ../fish/guestfish-actions.pod:2942
12291 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
12296 #: ../src/guestfs-actions.pod:4356
12297 msgid "(Added in 1.7.19)"
12301 #: ../src/guestfs-actions.pod:4358
12302 msgid "guestfs_mkfs_opts_va"
12306 #: ../src/guestfs-actions.pod:4360
12310 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
12311 " const char *fstype,\n"
12312 " const char *device,\n"
12313 " va_list args);\n"
12318 #: ../src/guestfs-actions.pod:4366
12319 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
12323 #: ../src/guestfs-actions.pod:4370
12324 msgid "guestfs_mkfs_opts_argv"
12328 #: ../src/guestfs-actions.pod:4372
12332 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
12333 " const char *fstype,\n"
12334 " const char *device,\n"
12335 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12340 #: ../src/guestfs-actions.pod:4378
12341 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12345 #: ../src/guestfs-actions.pod:4382
12346 msgid "guestfs_mkmountpoint"
12350 #: ../src/guestfs-actions.pod:4384
12354 " guestfs_mkmountpoint (guestfs_h *g,\n"
12355 " const char *exemptpath);\n"
12360 #: ../src/guestfs-actions.pod:4388
12362 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12363 "that can be used to create extra mountpoints before mounting the first "
12368 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2957
12370 "These calls are I<only> necessary in some very limited circumstances, mainly "
12371 "the case where you want to mount a mix of unrelated and/or read-only "
12372 "filesystems together."
12376 #: ../src/guestfs-actions.pod:4396 ../fish/guestfish-actions.pod:2961
12378 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12379 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12380 "inside that. You can unpack this as follows in guestfish:"
12384 #: ../src/guestfs-actions.pod:4401 ../fish/guestfish-actions.pod:2966
12387 " add-ro Fedora-11-i686-Live.iso\n"
12389 " mkmountpoint /cd\n"
12390 " mkmountpoint /sqsh\n"
12391 " mkmountpoint /ext3fs\n"
12392 " mount /dev/sda /cd\n"
12393 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12394 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12399 #: ../src/guestfs-actions.pod:4410 ../fish/guestfish-actions.pod:2975
12400 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12404 #: ../src/guestfs-actions.pod:4412
12406 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12407 "may get unexpected errors if you try to mix these calls. It is safest to "
12408 "manually unmount filesystems and remove mountpoints after use."
12412 #: ../src/guestfs-actions.pod:4416
12414 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12415 "first, so for this to work for manual mountpoints, you must ensure that the "
12416 "innermost mountpoints have the longest pathnames, as in the example code "
12421 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:2986
12422 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12426 #: ../src/guestfs-actions.pod:4423
12428 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12429 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
12430 "can also trigger these issues."
12434 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:5598
12435 msgid "(Added in 1.0.62)"
12439 #: ../src/guestfs-actions.pod:4431
12440 msgid "guestfs_mknod"
12444 #: ../src/guestfs-actions.pod:4433
12448 " guestfs_mknod (guestfs_h *g,\n"
12452 " const char *path);\n"
12457 #: ../src/guestfs-actions.pod:4440 ../fish/guestfish-actions.pod:2996
12459 "This call creates block or character special devices, or named pipes "
12464 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:2999
12466 "The C<mode> parameter should be the mode, using the standard constants. "
12467 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12468 "used when creating block and character special devices."
12472 #: ../src/guestfs-actions.pod:4448
12474 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12475 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12476 "regular file). These constants are available in the standard Linux header "
12477 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12478 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12479 "the appropriate constant for you."
12483 #: ../src/guestfs-actions.pod:4462
12484 msgid "guestfs_mknod_b"
12488 #: ../src/guestfs-actions.pod:4464
12492 " guestfs_mknod_b (guestfs_h *g,\n"
12496 " const char *path);\n"
12501 #: ../src/guestfs-actions.pod:4471
12503 "This call creates a block device node called C<path> with mode C<mode> and "
12504 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12505 "wrapper around C<guestfs_mknod>."
12509 #: ../src/guestfs-actions.pod:4481
12510 msgid "guestfs_mknod_c"
12514 #: ../src/guestfs-actions.pod:4483
12518 " guestfs_mknod_c (guestfs_h *g,\n"
12522 " const char *path);\n"
12527 #: ../src/guestfs-actions.pod:4490
12529 "This call creates a char device node called C<path> with mode C<mode> and "
12530 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12531 "wrapper around C<guestfs_mknod>."
12535 #: ../src/guestfs-actions.pod:4500
12536 msgid "guestfs_mkswap"
12540 #: ../src/guestfs-actions.pod:4502
12544 " guestfs_mkswap (guestfs_h *g,\n"
12545 " const char *device);\n"
12550 #: ../src/guestfs-actions.pod:4506 ../fish/guestfish-actions.pod:3038
12551 msgid "Create a swap partition on C<device>."
12555 #: ../src/guestfs-actions.pod:4512
12556 msgid "guestfs_mkswap_L"
12560 #: ../src/guestfs-actions.pod:4514
12564 " guestfs_mkswap_L (guestfs_h *g,\n"
12565 " const char *label,\n"
12566 " const char *device);\n"
12571 #: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:3044
12572 msgid "Create a swap partition on C<device> with label C<label>."
12576 #: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:3046
12578 "Note that you cannot attach a swap label to a block device "
12579 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12580 "the kernel or swap tools."
12584 #: ../src/guestfs-actions.pod:4529
12585 msgid "guestfs_mkswap_U"
12589 #: ../src/guestfs-actions.pod:4531
12593 " guestfs_mkswap_U (guestfs_h *g,\n"
12594 " const char *uuid,\n"
12595 " const char *device);\n"
12600 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3054
12601 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12605 #: ../src/guestfs-actions.pod:4542
12606 msgid "guestfs_mkswap_file"
12610 #: ../src/guestfs-actions.pod:4544
12614 " guestfs_mkswap_file (guestfs_h *g,\n"
12615 " const char *path);\n"
12620 #: ../src/guestfs-actions.pod:4548 ../fish/guestfish-actions.pod:3060
12621 msgid "Create a swap file."
12625 #: ../src/guestfs-actions.pod:4550
12627 "This command just writes a swap file signature to an existing file. To "
12628 "create the file itself, use something like C<guestfs_fallocate>."
12632 #: ../src/guestfs-actions.pod:4557
12633 msgid "guestfs_modprobe"
12637 #: ../src/guestfs-actions.pod:4559
12641 " guestfs_modprobe (guestfs_h *g,\n"
12642 " const char *modulename);\n"
12647 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3069
12648 msgid "This loads a kernel module in the appliance."
12652 #: ../src/guestfs-actions.pod:4565 ../fish/guestfish-actions.pod:3071
12654 "The kernel module must have been whitelisted when libguestfs was built (see "
12655 "C<appliance/kmod.whitelist.in> in the source)."
12659 #: ../src/guestfs-actions.pod:4572
12660 msgid "guestfs_mount"
12664 #: ../src/guestfs-actions.pod:4574
12668 " guestfs_mount (guestfs_h *g,\n"
12669 " const char *device,\n"
12670 " const char *mountpoint);\n"
12675 #: ../src/guestfs-actions.pod:4579 ../fish/guestfish-actions.pod:3078
12677 "Mount a guest disk at a position in the filesystem. Block devices are named "
12678 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12679 "those block devices contain partitions, they will have the usual names "
12680 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12684 #: ../src/guestfs-actions.pod:4585 ../fish/guestfish-actions.pod:3084
12686 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12687 "mounted on C</> before others can be mounted. Other filesystems can only be "
12688 "mounted on directories which already exist."
12692 #: ../src/guestfs-actions.pod:4590 ../fish/guestfish-actions.pod:3089
12694 "The mounted filesystem is writable, if we have sufficient permissions on the "
12695 "underlying device."
12699 #: ../src/guestfs-actions.pod:4593
12701 "B<Important note:> When you use this call, the filesystem options C<sync> "
12702 "and C<noatime> are set implicitly. This was originally done because we "
12703 "thought it would improve reliability, but it turns out that I<-o sync> has a "
12704 "very large negative performance impact and negligible effect on "
12705 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
12706 "in any code that needs performance, and instead use C<guestfs_mount_options> "
12707 "(use an empty string for the first parameter if you don't want any options)."
12711 #: ../src/guestfs-actions.pod:4607
12712 msgid "guestfs_mount_loop"
12716 #: ../src/guestfs-actions.pod:4609
12720 " guestfs_mount_loop (guestfs_h *g,\n"
12721 " const char *file,\n"
12722 " const char *mountpoint);\n"
12727 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3106
12729 "This command lets you mount C<file> (a filesystem image in a file) on a "
12730 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12735 #: ../src/guestfs-actions.pod:4622
12736 msgid "guestfs_mount_options"
12740 #: ../src/guestfs-actions.pod:4624
12744 " guestfs_mount_options (guestfs_h *g,\n"
12745 " const char *options,\n"
12746 " const char *device,\n"
12747 " const char *mountpoint);\n"
12752 #: ../src/guestfs-actions.pod:4630
12754 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12755 "the mount options as for the L<mount(8)> I<-o> flag."
12759 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3118
12761 "If the C<options> parameter is an empty string, then no options are passed "
12762 "(all options default to whatever the filesystem uses)."
12766 #: ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4654 ../src/guestfs-actions.pod:4671
12767 msgid "(Added in 1.0.10)"
12771 #: ../src/guestfs-actions.pod:4642
12772 msgid "guestfs_mount_ro"
12776 #: ../src/guestfs-actions.pod:4644
12780 " guestfs_mount_ro (guestfs_h *g,\n"
12781 " const char *device,\n"
12782 " const char *mountpoint);\n"
12787 #: ../src/guestfs-actions.pod:4649
12789 "This is the same as the C<guestfs_mount> command, but it mounts the "
12790 "filesystem with the read-only (I<-o ro>) flag."
12794 #: ../src/guestfs-actions.pod:4656
12795 msgid "guestfs_mount_vfs"
12799 #: ../src/guestfs-actions.pod:4658
12803 " guestfs_mount_vfs (guestfs_h *g,\n"
12804 " const char *options,\n"
12805 " const char *vfstype,\n"
12806 " const char *device,\n"
12807 " const char *mountpoint);\n"
12812 #: ../src/guestfs-actions.pod:4665
12814 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12815 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
12820 #: ../src/guestfs-actions.pod:4673
12821 msgid "guestfs_mountpoints"
12825 #: ../src/guestfs-actions.pod:4675
12829 " guestfs_mountpoints (guestfs_h *g);\n"
12834 #: ../src/guestfs-actions.pod:4678
12836 "This call is similar to C<guestfs_mounts>. That call returns a list of "
12837 "devices. This one returns a hash table (map) of device name to directory "
12838 "where the device is mounted."
12842 #: ../src/guestfs-actions.pod:4690
12843 msgid "guestfs_mounts"
12847 #: ../src/guestfs-actions.pod:4692
12851 " guestfs_mounts (guestfs_h *g);\n"
12856 #: ../src/guestfs-actions.pod:4695 ../fish/guestfish-actions.pod:3149
12858 "This returns the list of currently mounted filesystems. It returns the list "
12859 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12863 #: ../src/guestfs-actions.pod:4698 ../fish/guestfish-actions.pod:3152
12864 msgid "Some internal mounts are not shown."
12868 #: ../src/guestfs-actions.pod:4700
12869 msgid "See also: C<guestfs_mountpoints>"
12873 #: ../src/guestfs-actions.pod:4708
12878 #: ../src/guestfs-actions.pod:4710
12882 " guestfs_mv (guestfs_h *g,\n"
12883 " const char *src,\n"
12884 " const char *dest);\n"
12889 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3160
12891 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12892 "destination filename or destination directory."
12896 #: ../src/guestfs-actions.pod:4722
12897 msgid "guestfs_ntfs_3g_probe"
12901 #: ../src/guestfs-actions.pod:4724
12905 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12907 " const char *device);\n"
12912 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3167
12914 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12915 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12916 "read-write, and some cannot be mounted at all)."
12920 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3171
12922 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12923 "can be mounted read-write. Set it to false if you want to test if the "
12924 "volume can be mounted read-only."
12928 #: ../src/guestfs-actions.pod:4737 ../fish/guestfish-actions.pod:3175
12930 "The return value is an integer which C<0> if the operation would succeed, or "
12931 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12935 #: ../src/guestfs-actions.pod:4743
12936 msgid "(Added in 1.0.43)"
12940 #: ../src/guestfs-actions.pod:4745
12941 msgid "guestfs_ntfsresize"
12945 #: ../src/guestfs-actions.pod:4747
12949 " guestfs_ntfsresize (guestfs_h *g,\n"
12950 " const char *device);\n"
12955 #: ../src/guestfs-actions.pod:4751 ../fish/guestfish-actions.pod:3183
12957 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12958 "size of the underlying device. See also L<ntfsresize(8)>."
12962 #: ../src/guestfs-actions.pod:4759
12963 msgid "guestfs_ntfsresize_size"
12967 #: ../src/guestfs-actions.pod:4761
12971 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12972 " const char *device,\n"
12973 " int64_t size);\n"
12978 #: ../src/guestfs-actions.pod:4766
12980 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12981 "to specify the new size (in bytes) explicitly."
12985 #: ../src/guestfs-actions.pod:4771 ../src/guestfs-actions.pod:5207 ../src/guestfs-actions.pod:5280 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:7113
12986 msgid "(Added in 1.3.14)"
12990 #: ../src/guestfs-actions.pod:4773
12991 msgid "guestfs_part_add"
12995 #: ../src/guestfs-actions.pod:4775
12999 " guestfs_part_add (guestfs_h *g,\n"
13000 " const char *device,\n"
13001 " const char *prlogex,\n"
13002 " int64_t startsect,\n"
13003 " int64_t endsect);\n"
13008 #: ../src/guestfs-actions.pod:4782
13010 "This command adds a partition to C<device>. If there is no partition table "
13011 "on the device, call C<guestfs_part_init> first."
13015 #: ../src/guestfs-actions.pod:4785 ../fish/guestfish-actions.pod:3201
13017 "The C<prlogex> parameter is the type of partition. Normally you should pass "
13018 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
13019 "C<logical>) and C<e> (or C<extended>) partition types."
13023 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3206
13025 "C<startsect> and C<endsect> are the start and end of the partition in "
13026 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
13027 "from the end of the disk (C<-1> is the last sector)."
13031 #: ../src/guestfs-actions.pod:4794
13033 "Creating a partition which covers the whole disk is not so easy. Use "
13034 "C<guestfs_part_disk> to do that."
13038 #: ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4968 ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5025 ../src/guestfs-actions.pod:5065
13039 msgid "(Added in 1.0.78)"
13043 #: ../src/guestfs-actions.pod:4801
13044 msgid "guestfs_part_del"
13048 #: ../src/guestfs-actions.pod:4803
13052 " guestfs_part_del (guestfs_h *g,\n"
13053 " const char *device,\n"
13059 #: ../src/guestfs-actions.pod:4808 ../fish/guestfish-actions.pod:3217
13060 msgid "This command deletes the partition numbered C<partnum> on C<device>."
13064 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3219
13066 "Note that in the case of MBR partitioning, deleting an extended partition "
13067 "also deletes any logical partitions it contains."
13071 #: ../src/guestfs-actions.pod:4818
13072 msgid "guestfs_part_disk"
13076 #: ../src/guestfs-actions.pod:4820
13080 " guestfs_part_disk (guestfs_h *g,\n"
13081 " const char *device,\n"
13082 " const char *parttype);\n"
13087 #: ../src/guestfs-actions.pod:4825
13089 "This command is simply a combination of C<guestfs_part_init> followed by "
13090 "C<guestfs_part_add> to create a single primary partition covering the whole "
13095 #: ../src/guestfs-actions.pod:4829
13097 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
13098 "possible values are described in C<guestfs_part_init>."
13102 #: ../src/guestfs-actions.pod:4839
13103 msgid "guestfs_part_get_bootable"
13107 #: ../src/guestfs-actions.pod:4841
13111 " guestfs_part_get_bootable (guestfs_h *g,\n"
13112 " const char *device,\n"
13118 #: ../src/guestfs-actions.pod:4846 ../fish/guestfish-actions.pod:3241
13120 "This command returns true if the partition C<partnum> on C<device> has the "
13121 "bootable flag set."
13125 #: ../src/guestfs-actions.pod:4849
13126 msgid "See also C<guestfs_part_set_bootable>."
13130 #: ../src/guestfs-actions.pod:4855
13131 msgid "guestfs_part_get_mbr_id"
13135 #: ../src/guestfs-actions.pod:4857
13139 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
13140 " const char *device,\n"
13146 #: ../src/guestfs-actions.pod:4862 ../fish/guestfish-actions.pod:3250
13148 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13149 "partition C<partnum>."
13153 #: ../src/guestfs-actions.pod:4865 ../src/guestfs-actions.pod:5041
13155 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
13156 "undefined results for other partition table types (see "
13157 "C<guestfs_part_get_parttype>)."
13161 #: ../src/guestfs-actions.pod:4873
13162 msgid "guestfs_part_get_parttype"
13166 #: ../src/guestfs-actions.pod:4875
13170 " guestfs_part_get_parttype (guestfs_h *g,\n"
13171 " const char *device);\n"
13176 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3261
13178 "This command examines the partition table on C<device> and returns the "
13179 "partition table type (format) being used."
13183 #: ../src/guestfs-actions.pod:4882
13185 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
13186 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
13187 "possible, although unusual. See C<guestfs_part_init> for a full list."
13191 #: ../src/guestfs-actions.pod:4892
13192 msgid "guestfs_part_init"
13196 #: ../src/guestfs-actions.pod:4894
13200 " guestfs_part_init (guestfs_h *g,\n"
13201 " const char *device,\n"
13202 " const char *parttype);\n"
13207 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3273
13209 "This creates an empty partition table on C<device> of one of the partition "
13210 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
13211 "(for large disks)."
13215 #: ../src/guestfs-actions.pod:4903
13217 "Initially there are no partitions. Following this, you should call "
13218 "C<guestfs_part_add> for each partition required."
13222 #: ../src/guestfs-actions.pod:4906 ../fish/guestfish-actions.pod:3280
13223 msgid "Possible values for C<parttype> are:"
13227 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3284
13228 msgid "B<efi> | B<gpt>"
13232 #: ../src/guestfs-actions.pod:4912 ../fish/guestfish-actions.pod:3286
13233 msgid "Intel EFI / GPT partition table."
13237 #: ../src/guestfs-actions.pod:4914 ../fish/guestfish-actions.pod:3288
13239 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
13240 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
13241 "the C<mbr> format."
13245 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3292
13246 msgid "B<mbr> | B<msdos>"
13250 #: ../src/guestfs-actions.pod:4920 ../fish/guestfish-actions.pod:3294
13252 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
13253 "Windows. This partition type will B<only> work for device sizes up to 2 "
13254 "TB. For large disks we recommend using C<gpt>."
13258 #: ../src/guestfs-actions.pod:4927 ../fish/guestfish-actions.pod:3301
13259 msgid "Other partition table types that may work but are not supported include:"
13263 #: ../src/guestfs-actions.pod:4932 ../fish/guestfish-actions.pod:3306
13268 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3308
13269 msgid "AIX disk labels."
13273 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3310
13274 msgid "B<amiga> | B<rdb>"
13278 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3312
13279 msgid "Amiga \"Rigid Disk Block\" format."
13283 #: ../src/guestfs-actions.pod:4940 ../fish/guestfish-actions.pod:3314
13288 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3316
13289 msgid "BSD disk labels."
13293 #: ../src/guestfs-actions.pod:4944 ../fish/guestfish-actions.pod:3318
13298 #: ../src/guestfs-actions.pod:4946 ../fish/guestfish-actions.pod:3320
13299 msgid "DASD, used on IBM mainframes."
13303 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3322
13308 #: ../src/guestfs-actions.pod:4950 ../fish/guestfish-actions.pod:3324
13309 msgid "MIPS/SGI volumes."
13313 #: ../src/guestfs-actions.pod:4952 ../fish/guestfish-actions.pod:3326
13318 #: ../src/guestfs-actions.pod:4954 ../fish/guestfish-actions.pod:3328
13319 msgid "Old Mac partition format. Modern Macs use C<gpt>."
13323 #: ../src/guestfs-actions.pod:4956 ../fish/guestfish-actions.pod:3330
13328 #: ../src/guestfs-actions.pod:4958 ../fish/guestfish-actions.pod:3332
13329 msgid "NEC PC-98 format, common in Japan apparently."
13333 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3334
13338 #: ../src/guestfs-actions.pod:4962 ../fish/guestfish-actions.pod:3336
13339 msgid "Sun disk labels."
13343 #: ../src/guestfs-actions.pod:4970
13344 msgid "guestfs_part_list"
13348 #: ../src/guestfs-actions.pod:4972
13351 " struct guestfs_partition_list *\n"
13352 " guestfs_part_list (guestfs_h *g,\n"
13353 " const char *device);\n"
13358 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3344
13360 "This command parses the partition table on C<device> and returns the list of "
13361 "partitions found."
13365 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3347
13366 msgid "The fields in the returned structure are:"
13370 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3351
13371 msgid "B<part_num>"
13375 #: ../src/guestfs-actions.pod:4985 ../fish/guestfish-actions.pod:3353
13376 msgid "Partition number, counting from 1."
13380 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3355
13381 msgid "B<part_start>"
13385 #: ../src/guestfs-actions.pod:4989
13387 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13388 "the device's sector size, see C<guestfs_blockdev_getss>."
13392 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3360
13393 msgid "B<part_end>"
13397 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3362
13398 msgid "End of the partition in bytes."
13402 #: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3364
13403 msgid "B<part_size>"
13407 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3366
13408 msgid "Size of the partition in bytes."
13412 #: ../src/guestfs-actions.pod:5002
13414 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13415 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13420 #: ../src/guestfs-actions.pod:5008
13421 msgid "guestfs_part_set_bootable"
13425 #: ../src/guestfs-actions.pod:5010
13429 " guestfs_part_set_bootable (guestfs_h *g,\n"
13430 " const char *device,\n"
13432 " int bootable);\n"
13437 #: ../src/guestfs-actions.pod:5016 ../fish/guestfish-actions.pod:3374
13439 "This sets the bootable flag on partition numbered C<partnum> on device "
13440 "C<device>. Note that partitions are numbered from 1."
13444 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3377
13446 "The bootable flag is used by some operating systems (notably Windows) to "
13447 "determine which partition to boot from. It is by no means universally "
13452 #: ../src/guestfs-actions.pod:5027
13453 msgid "guestfs_part_set_mbr_id"
13457 #: ../src/guestfs-actions.pod:5029
13461 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13462 " const char *device,\n"
13469 #: ../src/guestfs-actions.pod:5035 ../fish/guestfish-actions.pod:3385
13471 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13472 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13473 "documentation are in fact hexadecimal numbers, but usually documented "
13474 "without any leading \"0x\" which might be confusing."
13478 #: ../src/guestfs-actions.pod:5049
13479 msgid "guestfs_part_set_name"
13483 #: ../src/guestfs-actions.pod:5051
13487 " guestfs_part_set_name (guestfs_h *g,\n"
13488 " const char *device,\n"
13490 " const char *name);\n"
13495 #: ../src/guestfs-actions.pod:5057 ../fish/guestfish-actions.pod:3399
13497 "This sets the partition name on partition numbered C<partnum> on device "
13498 "C<device>. Note that partitions are numbered from 1."
13502 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3402
13504 "The partition name can only be set on certain types of partition table. "
13505 "This works on C<gpt> but not on C<mbr> partitions."
13509 #: ../src/guestfs-actions.pod:5067
13510 msgid "guestfs_part_to_dev"
13514 #: ../src/guestfs-actions.pod:5069
13518 " guestfs_part_to_dev (guestfs_h *g,\n"
13519 " const char *partition);\n"
13524 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3409
13526 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13527 "partition number, returning the device name (eg. \"/dev/sdb\")."
13531 #: ../src/guestfs-actions.pod:5077
13533 "The named partition must exist, for example as a string returned from "
13534 "C<guestfs_list_partitions>."
13538 #: ../src/guestfs-actions.pod:5085
13539 msgid "guestfs_ping_daemon"
13543 #: ../src/guestfs-actions.pod:5087
13547 " guestfs_ping_daemon (guestfs_h *g);\n"
13552 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3420
13554 "This is a test probe into the guestfs daemon running inside the qemu "
13555 "subprocess. Calling this function checks that the daemon responds to the "
13556 "ping message, without affecting the daemon or attached block device(s) in "
13561 #: ../src/guestfs-actions.pod:5099
13562 msgid "guestfs_pread"
13566 #: ../src/guestfs-actions.pod:5101
13570 " guestfs_pread (guestfs_h *g,\n"
13571 " const char *path,\n"
13573 " int64_t offset,\n"
13574 " size_t *size_r);\n"
13579 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3429
13581 "This command lets you read part of a file. It reads C<count> bytes of the "
13582 "file, starting at C<offset>, from file C<path>."
13586 #: ../src/guestfs-actions.pod:5111 ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3432 ../fish/guestfish-actions.pod:3447
13588 "This may read fewer bytes than requested. For further details see the "
13589 "L<pread(2)> system call."
13593 #: ../src/guestfs-actions.pod:5114
13594 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
13598 #: ../src/guestfs-actions.pod:5125
13599 msgid "guestfs_pread_device"
13603 #: ../src/guestfs-actions.pod:5127
13607 " guestfs_pread_device (guestfs_h *g,\n"
13608 " const char *device,\n"
13610 " int64_t offset,\n"
13611 " size_t *size_r);\n"
13616 #: ../src/guestfs-actions.pod:5134 ../fish/guestfish-actions.pod:3444
13618 "This command lets you read part of a file. It reads C<count> bytes of "
13619 "C<device>, starting at C<offset>."
13623 #: ../src/guestfs-actions.pod:5140
13624 msgid "See also C<guestfs_pread>."
13628 #: ../src/guestfs-actions.pod:5149
13629 msgid "(Added in 1.5.21)"
13633 #: ../src/guestfs-actions.pod:5151
13634 msgid "guestfs_pvcreate"
13638 #: ../src/guestfs-actions.pod:5153
13642 " guestfs_pvcreate (guestfs_h *g,\n"
13643 " const char *device);\n"
13648 #: ../src/guestfs-actions.pod:5157 ../fish/guestfish-actions.pod:3459
13650 "This creates an LVM physical volume on the named C<device>, where C<device> "
13651 "should usually be a partition name such as C</dev/sda1>."
13655 #: ../src/guestfs-actions.pod:5165
13656 msgid "guestfs_pvremove"
13660 #: ../src/guestfs-actions.pod:5167
13664 " guestfs_pvremove (guestfs_h *g,\n"
13665 " const char *device);\n"
13670 #: ../src/guestfs-actions.pod:5171 ../fish/guestfish-actions.pod:3467
13672 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13677 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3470
13679 "The implementation uses the C<pvremove> command which refuses to wipe "
13680 "physical volumes that contain any volume groups, so you have to remove those "
13685 #: ../src/guestfs-actions.pod:5182
13686 msgid "guestfs_pvresize"
13690 #: ../src/guestfs-actions.pod:5184
13694 " guestfs_pvresize (guestfs_h *g,\n"
13695 " const char *device);\n"
13700 #: ../src/guestfs-actions.pod:5188 ../fish/guestfish-actions.pod:3478
13702 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13703 "the new size of the underlying device."
13707 #: ../src/guestfs-actions.pod:5195
13708 msgid "guestfs_pvresize_size"
13712 #: ../src/guestfs-actions.pod:5197
13716 " guestfs_pvresize_size (guestfs_h *g,\n"
13717 " const char *device,\n"
13718 " int64_t size);\n"
13723 #: ../src/guestfs-actions.pod:5202
13725 "This command is the same as C<guestfs_pvresize> except that it allows you to "
13726 "specify the new size (in bytes) explicitly."
13730 #: ../src/guestfs-actions.pod:5209
13731 msgid "guestfs_pvs"
13735 #: ../src/guestfs-actions.pod:5211
13739 " guestfs_pvs (guestfs_h *g);\n"
13744 #: ../src/guestfs-actions.pod:5214 ../fish/guestfish-actions.pod:3492
13746 "List all the physical volumes detected. This is the equivalent of the "
13747 "L<pvs(8)> command."
13751 #: ../src/guestfs-actions.pod:5217 ../fish/guestfish-actions.pod:3495
13753 "This returns a list of just the device names that contain PVs "
13754 "(eg. C</dev/sda2>)."
13758 #: ../src/guestfs-actions.pod:5220
13759 msgid "See also C<guestfs_pvs_full>."
13763 #: ../src/guestfs-actions.pod:5228
13764 msgid "guestfs_pvs_full"
13768 #: ../src/guestfs-actions.pod:5230
13771 " struct guestfs_lvm_pv_list *\n"
13772 " guestfs_pvs_full (guestfs_h *g);\n"
13777 #: ../src/guestfs-actions.pod:5233 ../fish/guestfish-actions.pod:3504
13779 "List all the physical volumes detected. This is the equivalent of the "
13780 "L<pvs(8)> command. The \"full\" version includes all fields."
13784 #: ../src/guestfs-actions.pod:5236
13786 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
13787 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
13792 #: ../src/guestfs-actions.pod:5242
13793 msgid "guestfs_pvuuid"
13797 #: ../src/guestfs-actions.pod:5244
13801 " guestfs_pvuuid (guestfs_h *g,\n"
13802 " const char *device);\n"
13807 #: ../src/guestfs-actions.pod:5248 ../fish/guestfish-actions.pod:3511
13808 msgid "This command returns the UUID of the LVM PV C<device>."
13812 #: ../src/guestfs-actions.pod:5255
13813 msgid "guestfs_pwrite"
13817 #: ../src/guestfs-actions.pod:5257
13821 " guestfs_pwrite (guestfs_h *g,\n"
13822 " const char *path,\n"
13823 " const char *content,\n"
13824 " size_t content_size,\n"
13825 " int64_t offset);\n"
13830 #: ../src/guestfs-actions.pod:5264 ../fish/guestfish-actions.pod:3517
13832 "This command writes to part of a file. It writes the data buffer C<content> "
13833 "to the file C<path> starting at offset C<offset>."
13837 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3520
13839 "This command implements the L<pwrite(2)> system call, and like that system "
13840 "call it may not write the full data requested. The return value is the "
13841 "number of bytes that were actually written to the file. This could even be "
13842 "0, although short writes are unlikely for regular files in ordinary "
13847 #: ../src/guestfs-actions.pod:5273
13848 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
13852 #: ../src/guestfs-actions.pod:5282
13853 msgid "guestfs_pwrite_device"
13857 #: ../src/guestfs-actions.pod:5284
13861 " guestfs_pwrite_device (guestfs_h *g,\n"
13862 " const char *device,\n"
13863 " const char *content,\n"
13864 " size_t content_size,\n"
13865 " int64_t offset);\n"
13870 #: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3535
13872 "This command writes to part of a device. It writes the data buffer "
13873 "C<content> to C<device> starting at offset C<offset>."
13877 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3538
13879 "This command implements the L<pwrite(2)> system call, and like that system "
13880 "call it may not write the full data requested (although short writes to disk "
13881 "devices and partitions are probably impossible with standard Linux kernels)."
13885 #: ../src/guestfs-actions.pod:5299
13886 msgid "See also C<guestfs_pwrite>."
13890 #: ../src/guestfs-actions.pod:5306
13891 msgid "(Added in 1.5.20)"
13895 #: ../src/guestfs-actions.pod:5308
13896 msgid "guestfs_read_file"
13900 #: ../src/guestfs-actions.pod:5310
13904 " guestfs_read_file (guestfs_h *g,\n"
13905 " const char *path,\n"
13906 " size_t *size_r);\n"
13911 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3552
13912 msgid "This calls returns the contents of the file C<path> as a buffer."
13916 #: ../src/guestfs-actions.pod:5318
13918 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13919 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13920 "function is limited in the total size of file that can be handled."
13924 #: ../src/guestfs-actions.pod:5330
13925 msgid "(Added in 1.0.63)"
13929 #: ../src/guestfs-actions.pod:5332
13930 msgid "guestfs_read_lines"
13934 #: ../src/guestfs-actions.pod:5334
13938 " guestfs_read_lines (guestfs_h *g,\n"
13939 " const char *path);\n"
13944 #: ../src/guestfs-actions.pod:5340 ../fish/guestfish-actions.pod:3569
13946 "The file contents are returned as a list of lines. Trailing C<LF> and "
13947 "C<CRLF> character sequences are I<not> returned."
13951 #: ../src/guestfs-actions.pod:5343
13953 "Note that this function cannot correctly handle binary files (specifically, "
13954 "files containing C<\\0> character which is treated as end of line). For "
13955 "those you need to use the C<guestfs_read_file> function which has a more "
13956 "complex interface."
13960 #: ../src/guestfs-actions.pod:5354
13961 msgid "guestfs_readdir"
13965 #: ../src/guestfs-actions.pod:5356
13968 " struct guestfs_dirent_list *\n"
13969 " guestfs_readdir (guestfs_h *g,\n"
13970 " const char *dir);\n"
13975 #: ../src/guestfs-actions.pod:5360 ../fish/guestfish-actions.pod:3581
13976 msgid "This returns the list of directory entries in directory C<dir>."
13980 #: ../src/guestfs-actions.pod:5362 ../fish/guestfish-actions.pod:3583
13982 "All entries in the directory are returned, including C<.> and C<..>. The "
13983 "entries are I<not> sorted, but returned in the same order as the underlying "
13988 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3587
13990 "Also this call returns basic file type information about each file. The "
13991 "C<ftyp> field will contain one of the following characters:"
13995 #: ../src/guestfs-actions.pod:5371 ../fish/guestfish-actions.pod:3592
14000 #: ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:3594
14001 msgid "Block special"
14005 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3596
14010 #: ../src/guestfs-actions.pod:5377 ../fish/guestfish-actions.pod:3598
14011 msgid "Char special"
14015 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3600
14020 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3602
14025 #: ../src/guestfs-actions.pod:5383 ../fish/guestfish-actions.pod:3604
14030 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3606
14031 msgid "FIFO (named pipe)"
14035 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3608
14040 #: ../src/guestfs-actions.pod:5389 ../fish/guestfish-actions.pod:3610
14041 msgid "Symbolic link"
14045 #: ../src/guestfs-actions.pod:5391 ../fish/guestfish-actions.pod:3612
14050 #: ../src/guestfs-actions.pod:5393 ../fish/guestfish-actions.pod:3614
14051 msgid "Regular file"
14055 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3616
14060 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3618
14065 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3620
14070 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3622
14071 msgid "Unknown file type"
14075 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3624
14080 #: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3626
14081 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
14085 #: ../src/guestfs-actions.pod:5410
14087 "This function is primarily intended for use by programs. To get a simple "
14088 "list of names, use C<guestfs_ls>. To get a printable directory for human "
14089 "consumption, use C<guestfs_ll>."
14093 #: ../src/guestfs-actions.pod:5414
14095 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
14096 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
14101 #: ../src/guestfs-actions.pod:5420
14102 msgid "guestfs_readlink"
14106 #: ../src/guestfs-actions.pod:5422
14110 " guestfs_readlink (guestfs_h *g,\n"
14111 " const char *path);\n"
14116 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3639
14117 msgid "This command reads the target of a symbolic link."
14121 #: ../src/guestfs-actions.pod:5433
14122 msgid "guestfs_readlinklist"
14126 #: ../src/guestfs-actions.pod:5435
14130 " guestfs_readlinklist (guestfs_h *g,\n"
14131 " const char *path,\n"
14132 " char *const *names);\n"
14137 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3645
14139 "This call allows you to do a C<readlink> operation on multiple files, where "
14140 "all files are in the directory C<path>. C<names> is the list of files from "
14145 #: ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3649
14147 "On return you get a list of strings, with a one-to-one correspondence to the "
14148 "C<names> list. Each string is the value of the symbolic link."
14152 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3653
14154 "If the C<readlink(2)> operation fails on any name, then the corresponding "
14155 "result string is the empty string C<\"\">. However the whole operation is "
14156 "completed even if there were C<readlink(2)> errors, and so you can call this "
14157 "function with names where you don't know if they are symbolic links already "
14158 "(albeit slightly less efficient)."
14162 #: ../src/guestfs-actions.pod:5455 ../fish/guestfish-actions.pod:3660
14164 "This call is intended for programs that want to efficiently list a directory "
14165 "contents without making many round-trips. Very long directory listings "
14166 "might cause the protocol message size to be exceeded, causing this call to "
14167 "fail. The caller must split up such requests into smaller groups of names."
14171 #: ../src/guestfs-actions.pod:5468
14172 msgid "guestfs_realpath"
14176 #: ../src/guestfs-actions.pod:5470
14180 " guestfs_realpath (guestfs_h *g,\n"
14181 " const char *path);\n"
14186 #: ../src/guestfs-actions.pod:5474 ../fish/guestfish-actions.pod:3671
14188 "Return the canonicalized absolute pathname of C<path>. The returned path "
14189 "has no C<.>, C<..> or symbolic link path elements."
14193 #: ../src/guestfs-actions.pod:5482
14194 msgid "guestfs_removexattr"
14198 #: ../src/guestfs-actions.pod:5484
14202 " guestfs_removexattr (guestfs_h *g,\n"
14203 " const char *xattr,\n"
14204 " const char *path);\n"
14209 #: ../src/guestfs-actions.pod:5489 ../fish/guestfish-actions.pod:3678
14210 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
14214 #: ../src/guestfs-actions.pod:5492
14215 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
14219 #: ../src/guestfs-actions.pod:5498
14220 msgid "guestfs_resize2fs"
14224 #: ../src/guestfs-actions.pod:5500
14228 " guestfs_resize2fs (guestfs_h *g,\n"
14229 " const char *device);\n"
14234 #: ../src/guestfs-actions.pod:5504 ../fish/guestfish-actions.pod:3687
14236 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
14237 "underlying device."
14241 #: ../src/guestfs-actions.pod:5507
14243 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
14244 "C<device> before calling this command. For unknown reasons C<resize2fs> "
14245 "sometimes gives an error about this and sometimes not. In any case, it is "
14246 "always safe to call C<guestfs_e2fsck_f> before calling this function."
14250 #: ../src/guestfs-actions.pod:5517
14251 msgid "guestfs_resize2fs_M"
14255 #: ../src/guestfs-actions.pod:5519
14259 " guestfs_resize2fs_M (guestfs_h *g,\n"
14260 " const char *device);\n"
14265 #: ../src/guestfs-actions.pod:5523
14267 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
14268 "resized to its minimum size. This works like the C<-M> option to the "
14269 "C<resize2fs> command."
14273 #: ../src/guestfs-actions.pod:5527
14275 "To get the resulting size of the filesystem you should call "
14276 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
14277 "These two numbers, multiplied together, give the resulting size of the "
14278 "minimal filesystem in bytes."
14282 #: ../src/guestfs-actions.pod:5534
14283 msgid "guestfs_resize2fs_size"
14287 #: ../src/guestfs-actions.pod:5536
14291 " guestfs_resize2fs_size (guestfs_h *g,\n"
14292 " const char *device,\n"
14293 " int64_t size);\n"
14298 #: ../src/guestfs-actions.pod:5541
14300 "This command is the same as C<guestfs_resize2fs> except that it allows you "
14301 "to specify the new size (in bytes) explicitly."
14305 #: ../src/guestfs-actions.pod:5548
14310 #: ../src/guestfs-actions.pod:5550
14314 " guestfs_rm (guestfs_h *g,\n"
14315 " const char *path);\n"
14320 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3720
14321 msgid "Remove the single file C<path>."
14325 #: ../src/guestfs-actions.pod:5560
14326 msgid "guestfs_rm_rf"
14330 #: ../src/guestfs-actions.pod:5562
14334 " guestfs_rm_rf (guestfs_h *g,\n"
14335 " const char *path);\n"
14340 #: ../src/guestfs-actions.pod:5566 ../fish/guestfish-actions.pod:3726
14342 "Remove the file or directory C<path>, recursively removing the contents if "
14343 "its a directory. This is like the C<rm -rf> shell command."
14347 #: ../src/guestfs-actions.pod:5574
14348 msgid "guestfs_rmdir"
14352 #: ../src/guestfs-actions.pod:5576
14356 " guestfs_rmdir (guestfs_h *g,\n"
14357 " const char *path);\n"
14362 #: ../src/guestfs-actions.pod:5580 ../fish/guestfish-actions.pod:3734
14363 msgid "Remove the single directory C<path>."
14367 #: ../src/guestfs-actions.pod:5586
14368 msgid "guestfs_rmmountpoint"
14372 #: ../src/guestfs-actions.pod:5588
14376 " guestfs_rmmountpoint (guestfs_h *g,\n"
14377 " const char *exemptpath);\n"
14382 #: ../src/guestfs-actions.pod:5592
14384 "This calls removes a mountpoint that was previously created with "
14385 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14389 #: ../src/guestfs-actions.pod:5600
14390 msgid "guestfs_scrub_device"
14394 #: ../src/guestfs-actions.pod:5602
14398 " guestfs_scrub_device (guestfs_h *g,\n"
14399 " const char *device);\n"
14404 #: ../src/guestfs-actions.pod:5606 ../fish/guestfish-actions.pod:3748
14406 "This command writes patterns over C<device> to make data retrieval more "
14411 #: ../src/guestfs-actions.pod:5609 ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:5649 ../fish/guestfish-actions.pod:3751 ../fish/guestfish-actions.pod:3766 ../fish/guestfish-actions.pod:3779
14413 "It is an interface to the L<scrub(1)> program. See that manual page for "
14418 #: ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:5635 ../src/guestfs-actions.pod:5654
14419 msgid "(Added in 1.0.52)"
14423 #: ../src/guestfs-actions.pod:5619
14424 msgid "guestfs_scrub_file"
14428 #: ../src/guestfs-actions.pod:5621
14432 " guestfs_scrub_file (guestfs_h *g,\n"
14433 " const char *file);\n"
14438 #: ../src/guestfs-actions.pod:5625 ../fish/guestfish-actions.pod:3761
14440 "This command writes patterns over a file to make data retrieval more "
14445 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3764
14446 msgid "The file is I<removed> after scrubbing."
14450 #: ../src/guestfs-actions.pod:5637
14451 msgid "guestfs_scrub_freespace"
14455 #: ../src/guestfs-actions.pod:5639
14459 " guestfs_scrub_freespace (guestfs_h *g,\n"
14460 " const char *dir);\n"
14465 #: ../src/guestfs-actions.pod:5643
14467 "This command creates the directory C<dir> and then fills it with files until "
14468 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14469 "and deletes them. The intention is to scrub any free space on the partition "
14470 "containing C<dir>."
14474 #: ../src/guestfs-actions.pod:5656
14475 msgid "guestfs_set_append"
14479 #: ../src/guestfs-actions.pod:5658
14483 " guestfs_set_append (guestfs_h *g,\n"
14484 " const char *append);\n"
14489 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3788
14491 "This function is used to add additional options to the guest kernel command "
14496 #: ../src/guestfs-actions.pod:5665 ../fish/guestfish-actions.pod:3791
14498 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14499 "environment variable."
14503 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3794
14505 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14506 "(libguestfs always adds a few of its own)."
14510 #: ../src/guestfs-actions.pod:5675
14511 msgid "guestfs_set_attach_method"
14515 #: ../src/guestfs-actions.pod:5677
14519 " guestfs_set_attach_method (guestfs_h *g,\n"
14520 " const char *attachmethod);\n"
14525 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3803
14527 "Set the method that libguestfs uses to connect to the back end guestfsd "
14528 "daemon. Possible methods are:"
14532 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3810
14534 "Launch an appliance and connect to it. This is the ordinary method and the "
14539 #: ../src/guestfs-actions.pod:5691 ../fish/guestfish-actions.pod:3813
14540 msgid "C<unix:I<path>>"
14544 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3815
14545 msgid "Connect to the Unix domain socket I<path>."
14549 #: ../src/guestfs-actions.pod:5695 ../fish/guestfish-actions.pod:3817
14551 "This method lets you connect to an existing daemon or (using virtio-serial) "
14552 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
14553 "RUNNING DAEMONS>."
14557 #: ../src/guestfs-actions.pod:5703
14558 msgid "guestfs_set_autosync"
14562 #: ../src/guestfs-actions.pod:5705
14566 " guestfs_set_autosync (guestfs_h *g,\n"
14567 " int autosync);\n"
14572 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3829
14574 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14575 "effort attempt to make filesystems consistent and synchronized when the "
14576 "handle is closed (also if the program exits without closing handles)."
14580 #: ../src/guestfs-actions.pod:5714 ../fish/guestfish-actions.pod:3834
14582 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14583 "disabled by default)."
14587 #: ../src/guestfs-actions.pod:5721
14588 msgid "guestfs_set_direct"
14592 #: ../src/guestfs-actions.pod:5723
14596 " guestfs_set_direct (guestfs_h *g,\n"
14602 #: ../src/guestfs-actions.pod:5727 ../fish/guestfish-actions.pod:3843
14604 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14605 "passed directly through to the appliance once it is launched."
14609 #: ../src/guestfs-actions.pod:5731
14611 "One consequence of this is that log messages aren't caught by the library "
14612 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
14617 #: ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:3851
14618 msgid "You probably don't want to use this unless you know what you are doing."
14622 #: ../src/guestfs-actions.pod:5738 ../fish/guestfish-actions.pod:3854
14623 msgid "The default is disabled."
14627 #: ../src/guestfs-actions.pod:5744
14628 msgid "guestfs_set_e2label"
14632 #: ../src/guestfs-actions.pod:5746
14636 " guestfs_set_e2label (guestfs_h *g,\n"
14637 " const char *device,\n"
14638 " const char *label);\n"
14643 #: ../src/guestfs-actions.pod:5751 ../fish/guestfish-actions.pod:3860
14645 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14646 "C<label>. Filesystem labels are limited to 16 characters."
14650 #: ../src/guestfs-actions.pod:5755
14652 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
14653 "the existing label on a filesystem."
14657 #: ../src/guestfs-actions.pod:5762
14658 msgid "guestfs_set_e2uuid"
14662 #: ../src/guestfs-actions.pod:5764
14666 " guestfs_set_e2uuid (guestfs_h *g,\n"
14667 " const char *device,\n"
14668 " const char *uuid);\n"
14673 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3871
14675 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14676 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14677 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14681 #: ../src/guestfs-actions.pod:5774
14683 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
14684 "the existing UUID of a filesystem."
14688 #: ../src/guestfs-actions.pod:5781
14689 msgid "guestfs_set_memsize"
14693 #: ../src/guestfs-actions.pod:5783
14697 " guestfs_set_memsize (guestfs_h *g,\n"
14703 #: ../src/guestfs-actions.pod:5787
14705 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14706 "This only has any effect if called before C<guestfs_launch>."
14710 #: ../src/guestfs-actions.pod:5791 ../fish/guestfish-actions.pod:3889
14712 "You can also change this by setting the environment variable "
14713 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14717 #: ../src/guestfs-actions.pod:5802
14718 msgid "guestfs_set_network"
14722 #: ../src/guestfs-actions.pod:5804
14726 " guestfs_set_network (guestfs_h *g,\n"
14732 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3902
14734 "If C<network> is true, then the network is enabled in the libguestfs "
14735 "appliance. The default is false."
14739 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3905
14741 "This affects whether commands are able to access the network (see "
14742 "L<guestfs(3)/RUNNING COMMANDS>)."
14746 #: ../src/guestfs-actions.pod:5814
14748 "You must call this before calling C<guestfs_launch>, otherwise it has no "
14753 #: ../src/guestfs-actions.pod:5821
14754 msgid "guestfs_set_path"
14758 #: ../src/guestfs-actions.pod:5823
14762 " guestfs_set_path (guestfs_h *g,\n"
14763 " const char *searchpath);\n"
14768 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3917
14769 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14773 #: ../src/guestfs-actions.pod:5829 ../fish/guestfish-actions.pod:3919
14775 "The default is C<$libdir/guestfs> unless overridden by setting "
14776 "C<LIBGUESTFS_PATH> environment variable."
14780 #: ../src/guestfs-actions.pod:5832 ../fish/guestfish-actions.pod:3922
14781 msgid "Setting C<path> to C<NULL> restores the default path."
14785 #: ../src/guestfs-actions.pod:5838
14786 msgid "guestfs_set_qemu"
14790 #: ../src/guestfs-actions.pod:5840
14794 " guestfs_set_qemu (guestfs_h *g,\n"
14795 " const char *qemu);\n"
14800 #: ../src/guestfs-actions.pod:5844 ../fish/guestfish-actions.pod:3930
14801 msgid "Set the qemu binary that we will use."
14805 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3932
14806 msgid "The default is chosen when the library was compiled by the configure script."
14810 #: ../src/guestfs-actions.pod:5849 ../fish/guestfish-actions.pod:3935
14812 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14817 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3938
14818 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14822 #: ../src/guestfs-actions.pod:5854 ../fish/guestfish-actions.pod:3940
14824 "Note that you should call this function as early as possible after creating "
14825 "the handle. This is because some pre-launch operations depend on testing "
14826 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14827 "don't retest features, and so you might see inconsistent results. Using the "
14828 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14829 "the qemu binary at the same time as the handle is created."
14833 #: ../src/guestfs-actions.pod:5866
14834 msgid "guestfs_set_recovery_proc"
14838 #: ../src/guestfs-actions.pod:5868
14842 " guestfs_set_recovery_proc (guestfs_h *g,\n"
14843 " int recoveryproc);\n"
14848 #: ../src/guestfs-actions.pod:5872
14850 "If this is called with the parameter C<false> then C<guestfs_launch> does "
14851 "not create a recovery process. The purpose of the recovery process is to "
14852 "stop runaway qemu processes in the case where the main program aborts "
14857 #: ../src/guestfs-actions.pod:5877
14859 "This only has any effect if called before C<guestfs_launch>, and the default "
14864 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3962
14866 "About the only time when you would want to disable this is if the main "
14867 "process will fork itself into the background (\"daemonize\" itself). In "
14868 "this case the recovery process thinks that the main program has disappeared "
14869 "and so kills qemu, which is not very helpful."
14873 #: ../src/guestfs-actions.pod:5890
14874 msgid "guestfs_set_selinux"
14878 #: ../src/guestfs-actions.pod:5892
14882 " guestfs_set_selinux (guestfs_h *g,\n"
14888 #: ../src/guestfs-actions.pod:5896 ../fish/guestfish-actions.pod:3974
14890 "This sets the selinux flag that is passed to the appliance at boot time. "
14891 "The default is C<selinux=0> (disabled)."
14895 #: ../src/guestfs-actions.pod:5899 ../fish/guestfish-actions.pod:3977
14897 "Note that if SELinux is enabled, it is always in Permissive mode "
14898 "(C<enforcing=0>)."
14902 #: ../src/guestfs-actions.pod:5909
14903 msgid "guestfs_set_trace"
14907 #: ../src/guestfs-actions.pod:5911
14911 " guestfs_set_trace (guestfs_h *g,\n"
14917 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3989
14919 "If the command trace flag is set to 1, then commands are printed on stderr "
14920 "before they are executed in a format which is very similar to the one used "
14921 "by guestfish. In other words, you can run a program with this enabled, and "
14922 "you will get out a script which you can feed to guestfish to perform the "
14923 "same set of actions."
14927 #: ../src/guestfs-actions.pod:5922 ../fish/guestfish-actions.pod:3996
14929 "If you want to trace C API calls into libguestfs (and other libraries) then "
14930 "possibly a better way is to use the external ltrace(1) command."
14934 #: ../src/guestfs-actions.pod:5926 ../fish/guestfish-actions.pod:4000
14936 "Command traces are disabled unless the environment variable "
14937 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14941 #: ../src/guestfs-actions.pod:5933
14942 msgid "guestfs_set_verbose"
14946 #: ../src/guestfs-actions.pod:5935
14950 " guestfs_set_verbose (guestfs_h *g,\n"
14956 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:4009
14957 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
14961 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:4011
14963 "Verbose messages are disabled unless the environment variable "
14964 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14968 #: ../src/guestfs-actions.pod:5948
14969 msgid "guestfs_setcon"
14973 #: ../src/guestfs-actions.pod:5950
14977 " guestfs_setcon (guestfs_h *g,\n"
14978 " const char *context);\n"
14983 #: ../src/guestfs-actions.pod:5954 ../fish/guestfish-actions.pod:4018
14985 "This sets the SELinux security context of the daemon to the string "
14990 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4021
14991 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14995 #: ../src/guestfs-actions.pod:5963
14996 msgid "guestfs_setxattr"
15000 #: ../src/guestfs-actions.pod:5965
15004 " guestfs_setxattr (guestfs_h *g,\n"
15005 " const char *xattr,\n"
15006 " const char *val,\n"
15008 " const char *path);\n"
15013 #: ../src/guestfs-actions.pod:5972 ../fish/guestfish-actions.pod:4027
15015 "This call sets the extended attribute named C<xattr> of the file C<path> to "
15016 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
15020 #: ../src/guestfs-actions.pod:5976
15021 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
15025 #: ../src/guestfs-actions.pod:5982
15026 msgid "guestfs_sfdisk"
15030 #: ../src/guestfs-actions.pod:5984
15034 " guestfs_sfdisk (guestfs_h *g,\n"
15035 " const char *device,\n"
15039 " char *const *lines);\n"
15044 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4037
15046 "This is a direct interface to the L<sfdisk(8)> program for creating "
15047 "partitions on block devices."
15051 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4040
15052 msgid "C<device> should be a block device, for example C</dev/sda>."
15056 #: ../src/guestfs-actions.pod:5997 ../fish/guestfish-actions.pod:4042
15058 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
15059 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
15060 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
15061 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
15062 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
15063 "the kernel) cannot work out the right geometry and you will need to tell it."
15067 #: ../src/guestfs-actions.pod:6005 ../fish/guestfish-actions.pod:4050
15069 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
15070 "refer to the L<sfdisk(8)> manpage."
15074 #: ../src/guestfs-actions.pod:6008 ../fish/guestfish-actions.pod:4053
15076 "To create a single partition occupying the whole disk, you would pass "
15077 "C<lines> as a single element list, when the single element being the string "
15082 #: ../src/guestfs-actions.pod:6012
15083 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
15087 #: ../src/guestfs-actions.pod:6022
15088 msgid "guestfs_sfdiskM"
15092 #: ../src/guestfs-actions.pod:6024
15096 " guestfs_sfdiskM (guestfs_h *g,\n"
15097 " const char *device,\n"
15098 " char *const *lines);\n"
15103 #: ../src/guestfs-actions.pod:6029
15105 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
15106 "partition sizes are specified in megabytes only (rounded to the nearest "
15107 "cylinder) and you don't need to specify the cyls, heads and sectors "
15108 "parameters which were rarely if ever used anyway."
15112 #: ../src/guestfs-actions.pod:6035
15114 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
15115 "C<guestfs_part_disk>"
15119 #: ../src/guestfs-actions.pod:6045
15120 msgid "guestfs_sfdisk_N"
15124 #: ../src/guestfs-actions.pod:6047
15128 " guestfs_sfdisk_N (guestfs_h *g,\n"
15129 " const char *device,\n"
15134 " const char *line);\n"
15139 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4083
15141 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15142 "(note: C<n> counts from 1)."
15146 #: ../src/guestfs-actions.pod:6059
15148 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
15149 "for the cyls/heads/sectors parameters."
15153 #: ../src/guestfs-actions.pod:6062
15154 msgid "See also: C<guestfs_part_add>"
15158 #: ../src/guestfs-actions.pod:6071
15159 msgid "guestfs_sfdisk_disk_geometry"
15163 #: ../src/guestfs-actions.pod:6073
15167 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
15168 " const char *device);\n"
15173 #: ../src/guestfs-actions.pod:6077
15175 "This displays the disk geometry of C<device> read from the partition table. "
15176 "Especially in the case where the underlying block device has been resized, "
15177 "this can be different from the kernel's idea of the geometry (see "
15178 "C<guestfs_sfdisk_kernel_geometry>)."
15182 #: ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6098 ../fish/guestfish-actions.pod:4103 ../fish/guestfish-actions.pod:4112
15183 msgid "The result is in human-readable format, and not designed to be parsed."
15187 #: ../src/guestfs-actions.pod:6090
15188 msgid "guestfs_sfdisk_kernel_geometry"
15192 #: ../src/guestfs-actions.pod:6092
15196 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
15197 " const char *device);\n"
15202 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4110
15203 msgid "This displays the kernel's idea of the geometry of C<device>."
15207 #: ../src/guestfs-actions.pod:6106
15208 msgid "guestfs_sfdisk_l"
15212 #: ../src/guestfs-actions.pod:6108
15216 " guestfs_sfdisk_l (guestfs_h *g,\n"
15217 " const char *device);\n"
15222 #: ../src/guestfs-actions.pod:6112 ../fish/guestfish-actions.pod:4119
15224 "This displays the partition table on C<device>, in the human-readable output "
15225 "of the L<sfdisk(8)> command. It is not intended to be parsed."
15229 #: ../src/guestfs-actions.pod:6116
15230 msgid "See also: C<guestfs_part_list>"
15234 #: ../src/guestfs-actions.pod:6123
15239 #: ../src/guestfs-actions.pod:6125
15243 " guestfs_sh (guestfs_h *g,\n"
15244 " const char *command);\n"
15249 #: ../src/guestfs-actions.pod:6129 ../fish/guestfish-actions.pod:4129
15251 "This call runs a command from the guest filesystem via the guest's "
15256 #: ../src/guestfs-actions.pod:6132
15257 msgid "This is like C<guestfs_command>, but passes the command to:"
15261 #: ../src/guestfs-actions.pod:6134 ../fish/guestfish-actions.pod:4134
15264 " /bin/sh -c \"command\"\n"
15269 #: ../src/guestfs-actions.pod:6136 ../fish/guestfish-actions.pod:4136
15271 "Depending on the guest's shell, this usually results in wildcards being "
15272 "expanded, shell expressions being interpolated and so on."
15276 #: ../src/guestfs-actions.pod:6140
15277 msgid "All the provisos about C<guestfs_command> apply to this call."
15281 #: ../src/guestfs-actions.pod:6147
15282 msgid "guestfs_sh_lines"
15286 #: ../src/guestfs-actions.pod:6149
15290 " guestfs_sh_lines (guestfs_h *g,\n"
15291 " const char *command);\n"
15296 #: ../src/guestfs-actions.pod:6153
15298 "This is the same as C<guestfs_sh>, but splits the result into a list of "
15303 #: ../src/guestfs-actions.pod:6156
15304 msgid "See also: C<guestfs_command_lines>"
15308 #: ../src/guestfs-actions.pod:6164
15309 msgid "guestfs_sleep"
15313 #: ../src/guestfs-actions.pod:6166
15317 " guestfs_sleep (guestfs_h *g,\n"
15323 #: ../src/guestfs-actions.pod:6170 ../fish/guestfish-actions.pod:4155
15324 msgid "Sleep for C<secs> seconds."
15328 #: ../src/guestfs-actions.pod:6174
15329 msgid "(Added in 1.0.41)"
15333 #: ../src/guestfs-actions.pod:6176 ../src/guestfs-structs.pod:109
15334 msgid "guestfs_stat"
15338 #: ../src/guestfs-actions.pod:6178
15341 " struct guestfs_stat *\n"
15342 " guestfs_stat (guestfs_h *g,\n"
15343 " const char *path);\n"
15348 #: ../src/guestfs-actions.pod:6184 ../fish/guestfish-actions.pod:4163
15349 msgid "This is the same as the C<stat(2)> system call."
15353 #: ../src/guestfs-actions.pod:6192 ../src/guestfs-structs.pod:135
15354 msgid "guestfs_statvfs"
15358 #: ../src/guestfs-actions.pod:6194
15361 " struct guestfs_statvfs *\n"
15362 " guestfs_statvfs (guestfs_h *g,\n"
15363 " const char *path);\n"
15368 #: ../src/guestfs-actions.pod:6198 ../fish/guestfish-actions.pod:4169
15370 "Returns file system statistics for any mounted file system. C<path> should "
15371 "be a file or directory in the mounted file system (typically it is the mount "
15372 "point itself, but it doesn't need to be)."
15376 #: ../src/guestfs-actions.pod:6202 ../fish/guestfish-actions.pod:4173
15377 msgid "This is the same as the C<statvfs(2)> system call."
15381 #: ../src/guestfs-actions.pod:6204
15383 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
15384 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
15388 #: ../src/guestfs-actions.pod:6210
15389 msgid "guestfs_strings"
15393 #: ../src/guestfs-actions.pod:6212
15397 " guestfs_strings (guestfs_h *g,\n"
15398 " const char *path);\n"
15403 #: ../src/guestfs-actions.pod:6216 ../fish/guestfish-actions.pod:4179
15405 "This runs the L<strings(1)> command on a file and returns the list of "
15406 "printable strings found."
15410 #: ../src/guestfs-actions.pod:6228
15411 msgid "guestfs_strings_e"
15415 #: ../src/guestfs-actions.pod:6230
15419 " guestfs_strings_e (guestfs_h *g,\n"
15420 " const char *encoding,\n"
15421 " const char *path);\n"
15426 #: ../src/guestfs-actions.pod:6235
15428 "This is like the C<guestfs_strings> command, but allows you to specify the "
15429 "encoding of strings that are looked for in the source file C<path>."
15433 #: ../src/guestfs-actions.pod:6239 ../fish/guestfish-actions.pod:4193
15434 msgid "Allowed encodings are:"
15438 #: ../src/guestfs-actions.pod:6243 ../fish/guestfish-actions.pod:4197
15443 #: ../src/guestfs-actions.pod:6245
15445 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15446 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15450 #: ../src/guestfs-actions.pod:6248 ../fish/guestfish-actions.pod:4202
15455 #: ../src/guestfs-actions.pod:6250 ../fish/guestfish-actions.pod:4204
15456 msgid "Single 8-bit-byte characters."
15460 #: ../src/guestfs-actions.pod:6252 ../fish/guestfish-actions.pod:4206
15465 #: ../src/guestfs-actions.pod:6254 ../fish/guestfish-actions.pod:4208
15466 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15470 #: ../src/guestfs-actions.pod:6257 ../fish/guestfish-actions.pod:4211
15471 msgid "l (lower case letter L)"
15475 #: ../src/guestfs-actions.pod:6259 ../fish/guestfish-actions.pod:4213
15477 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15478 "examining binaries in Windows guests."
15482 #: ../src/guestfs-actions.pod:6262 ../fish/guestfish-actions.pod:4216
15487 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4218
15488 msgid "32-bit big endian such as UCS-4BE."
15492 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4220
15497 #: ../src/guestfs-actions.pod:6268 ../fish/guestfish-actions.pod:4222
15498 msgid "32-bit little endian such as UCS-4LE."
15502 #: ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:4226
15503 msgid "The returned strings are transcoded to UTF-8."
15507 #: ../src/guestfs-actions.pod:6283
15508 msgid "guestfs_swapoff_device"
15512 #: ../src/guestfs-actions.pod:6285
15516 " guestfs_swapoff_device (guestfs_h *g,\n"
15517 " const char *device);\n"
15522 #: ../src/guestfs-actions.pod:6289
15524 "This command disables the libguestfs appliance swap device or partition "
15525 "named C<device>. See C<guestfs_swapon_device>."
15529 #: ../src/guestfs-actions.pod:6297
15530 msgid "guestfs_swapoff_file"
15534 #: ../src/guestfs-actions.pod:6299
15538 " guestfs_swapoff_file (guestfs_h *g,\n"
15539 " const char *file);\n"
15544 #: ../src/guestfs-actions.pod:6303 ../fish/guestfish-actions.pod:4243
15545 msgid "This command disables the libguestfs appliance swap on file."
15549 #: ../src/guestfs-actions.pod:6309
15550 msgid "guestfs_swapoff_label"
15554 #: ../src/guestfs-actions.pod:6311
15558 " guestfs_swapoff_label (guestfs_h *g,\n"
15559 " const char *label);\n"
15564 #: ../src/guestfs-actions.pod:6315 ../fish/guestfish-actions.pod:4249
15566 "This command disables the libguestfs appliance swap on labeled swap "
15571 #: ../src/guestfs-actions.pod:6322
15572 msgid "guestfs_swapoff_uuid"
15576 #: ../src/guestfs-actions.pod:6324
15580 " guestfs_swapoff_uuid (guestfs_h *g,\n"
15581 " const char *uuid);\n"
15586 #: ../src/guestfs-actions.pod:6328 ../fish/guestfish-actions.pod:4256
15588 "This command disables the libguestfs appliance swap partition with the given "
15593 #: ../src/guestfs-actions.pod:6335
15594 msgid "guestfs_swapon_device"
15598 #: ../src/guestfs-actions.pod:6337
15602 " guestfs_swapon_device (guestfs_h *g,\n"
15603 " const char *device);\n"
15608 #: ../src/guestfs-actions.pod:6341
15610 "This command enables the libguestfs appliance to use the swap device or "
15611 "partition named C<device>. The increased memory is made available for all "
15612 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
15616 #: ../src/guestfs-actions.pod:6346 ../fish/guestfish-actions.pod:4268
15618 "Note that you should not swap to existing guest swap partitions unless you "
15619 "know what you are doing. They may contain hibernation information, or other "
15620 "information that the guest doesn't want you to trash. You also risk leaking "
15621 "information about the host to the guest this way. Instead, attach a new "
15622 "host device to the guest and swap on that."
15626 #: ../src/guestfs-actions.pod:6357
15627 msgid "guestfs_swapon_file"
15631 #: ../src/guestfs-actions.pod:6359
15635 " guestfs_swapon_file (guestfs_h *g,\n"
15636 " const char *file);\n"
15641 #: ../src/guestfs-actions.pod:6363
15643 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
15648 #: ../src/guestfs-actions.pod:6370
15649 msgid "guestfs_swapon_label"
15653 #: ../src/guestfs-actions.pod:6372
15657 " guestfs_swapon_label (guestfs_h *g,\n"
15658 " const char *label);\n"
15663 #: ../src/guestfs-actions.pod:6376
15665 "This command enables swap to a labeled swap partition. See "
15666 "C<guestfs_swapon_device> for other notes."
15670 #: ../src/guestfs-actions.pod:6383
15671 msgid "guestfs_swapon_uuid"
15675 #: ../src/guestfs-actions.pod:6385
15679 " guestfs_swapon_uuid (guestfs_h *g,\n"
15680 " const char *uuid);\n"
15685 #: ../src/guestfs-actions.pod:6389
15687 "This command enables swap to a swap partition with the given UUID. See "
15688 "C<guestfs_swapon_device> for other notes."
15692 #: ../src/guestfs-actions.pod:6396
15693 msgid "guestfs_sync"
15697 #: ../src/guestfs-actions.pod:6398
15701 " guestfs_sync (guestfs_h *g);\n"
15706 #: ../src/guestfs-actions.pod:6401 ../fish/guestfish-actions.pod:4300
15708 "This syncs the disk, so that any writes are flushed through to the "
15709 "underlying disk image."
15713 #: ../src/guestfs-actions.pod:6404 ../fish/guestfish-actions.pod:4303
15715 "You should always call this if you have modified a disk image, before "
15716 "closing the handle."
15720 #: ../src/guestfs-actions.pod:6411
15721 msgid "guestfs_tail"
15725 #: ../src/guestfs-actions.pod:6413
15729 " guestfs_tail (guestfs_h *g,\n"
15730 " const char *path);\n"
15735 #: ../src/guestfs-actions.pod:6417 ../fish/guestfish-actions.pod:4310
15736 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15740 #: ../src/guestfs-actions.pod:6429
15741 msgid "guestfs_tail_n"
15745 #: ../src/guestfs-actions.pod:6431
15749 " guestfs_tail_n (guestfs_h *g,\n"
15751 " const char *path);\n"
15756 #: ../src/guestfs-actions.pod:6436 ../fish/guestfish-actions.pod:4320
15758 "If the parameter C<nrlines> is a positive number, this returns the last "
15759 "C<nrlines> lines of the file C<path>."
15763 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4323
15765 "If the parameter C<nrlines> is a negative number, this returns lines from "
15766 "the file C<path>, starting with the C<-nrlines>th line."
15770 #: ../src/guestfs-actions.pod:6453
15771 msgid "guestfs_tar_in"
15775 #: ../src/guestfs-actions.pod:6455
15779 " guestfs_tar_in (guestfs_h *g,\n"
15780 " const char *tarfile,\n"
15781 " const char *directory);\n"
15786 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4335
15788 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15789 "tar file) into C<directory>."
15793 #: ../src/guestfs-actions.pod:6463
15794 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
15798 #: ../src/guestfs-actions.pod:6468 ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6501 ../src/guestfs-actions.pod:6517
15799 msgid "(Added in 1.0.3)"
15803 #: ../src/guestfs-actions.pod:6470
15804 msgid "guestfs_tar_out"
15808 #: ../src/guestfs-actions.pod:6472
15812 " guestfs_tar_out (guestfs_h *g,\n"
15813 " const char *directory,\n"
15814 " const char *tarfile);\n"
15819 #: ../src/guestfs-actions.pod:6477 ../fish/guestfish-actions.pod:4347
15821 "This command packs the contents of C<directory> and downloads it to local "
15826 #: ../src/guestfs-actions.pod:6480
15828 "To download a compressed tarball, use C<guestfs_tgz_out> or "
15829 "C<guestfs_txz_out>."
15833 #: ../src/guestfs-actions.pod:6487
15834 msgid "guestfs_tgz_in"
15838 #: ../src/guestfs-actions.pod:6489
15842 " guestfs_tgz_in (guestfs_h *g,\n"
15843 " const char *tarball,\n"
15844 " const char *directory);\n"
15849 #: ../src/guestfs-actions.pod:6494 ../fish/guestfish-actions.pod:4359
15851 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15852 "tar file) into C<directory>."
15856 #: ../src/guestfs-actions.pod:6497
15857 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
15861 #: ../src/guestfs-actions.pod:6503
15862 msgid "guestfs_tgz_out"
15866 #: ../src/guestfs-actions.pod:6505
15870 " guestfs_tgz_out (guestfs_h *g,\n"
15871 " const char *directory,\n"
15872 " const char *tarball);\n"
15877 #: ../src/guestfs-actions.pod:6510 ../fish/guestfish-actions.pod:4370
15879 "This command packs the contents of C<directory> and downloads it to local "
15884 #: ../src/guestfs-actions.pod:6513
15885 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
15889 #: ../src/guestfs-actions.pod:6519
15890 msgid "guestfs_touch"
15894 #: ../src/guestfs-actions.pod:6521
15898 " guestfs_touch (guestfs_h *g,\n"
15899 " const char *path);\n"
15904 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4381
15906 "Touch acts like the L<touch(1)> command. It can be used to update the "
15907 "timestamps on a file, or, if the file does not exist, to create a new "
15908 "zero-length file."
15912 #: ../src/guestfs-actions.pod:6529 ../fish/guestfish-actions.pod:4385
15914 "This command only works on regular files, and will fail on other file types "
15915 "such as directories, symbolic links, block special etc."
15919 #: ../src/guestfs-actions.pod:6536
15920 msgid "guestfs_truncate"
15924 #: ../src/guestfs-actions.pod:6538
15928 " guestfs_truncate (guestfs_h *g,\n"
15929 " const char *path);\n"
15934 #: ../src/guestfs-actions.pod:6542 ../fish/guestfish-actions.pod:4392
15936 "This command truncates C<path> to a zero-length file. The file must exist "
15941 #: ../src/guestfs-actions.pod:6549
15942 msgid "guestfs_truncate_size"
15946 #: ../src/guestfs-actions.pod:6551
15950 " guestfs_truncate_size (guestfs_h *g,\n"
15951 " const char *path,\n"
15952 " int64_t size);\n"
15957 #: ../src/guestfs-actions.pod:6556 ../fish/guestfish-actions.pod:4399
15959 "This command truncates C<path> to size C<size> bytes. The file must exist "
15964 #: ../src/guestfs-actions.pod:6559
15966 "If the current file size is less than C<size> then the file is extended to "
15967 "the required size with zero bytes. This creates a sparse file (ie. disk "
15968 "blocks are not allocated for the file until you write to it). To create a "
15969 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15973 #: ../src/guestfs-actions.pod:6569
15974 msgid "guestfs_tune2fs_l"
15978 #: ../src/guestfs-actions.pod:6571
15982 " guestfs_tune2fs_l (guestfs_h *g,\n"
15983 " const char *device);\n"
15988 #: ../src/guestfs-actions.pod:6575 ../fish/guestfish-actions.pod:4412
15990 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15995 #: ../src/guestfs-actions.pod:6578 ../fish/guestfish-actions.pod:4415
15997 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15998 "for more details. The list of fields returned isn't clearly defined, and "
15999 "depends on both the version of C<tune2fs> that libguestfs was built against, "
16000 "and the filesystem itself."
16004 #: ../src/guestfs-actions.pod:6591
16005 msgid "guestfs_txz_in"
16009 #: ../src/guestfs-actions.pod:6593
16013 " guestfs_txz_in (guestfs_h *g,\n"
16014 " const char *tarball,\n"
16015 " const char *directory);\n"
16020 #: ../src/guestfs-actions.pod:6598 ../fish/guestfish-actions.pod:4424
16022 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
16023 "tar file) into C<directory>."
16027 #: ../src/guestfs-actions.pod:6605
16028 msgid "guestfs_txz_out"
16032 #: ../src/guestfs-actions.pod:6607
16036 " guestfs_txz_out (guestfs_h *g,\n"
16037 " const char *directory,\n"
16038 " const char *tarball);\n"
16043 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4433
16045 "This command packs the contents of C<directory> and downloads it to local "
16046 "file C<tarball> (as an xz compressed tar archive)."
16050 #: ../src/guestfs-actions.pod:6619
16051 msgid "guestfs_umask"
16055 #: ../src/guestfs-actions.pod:6621
16059 " guestfs_umask (guestfs_h *g,\n"
16065 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4442
16067 "This function sets the mask used for creating new files and device nodes to "
16072 #: ../src/guestfs-actions.pod:6628 ../fish/guestfish-actions.pod:4445
16074 "Typical umask values would be C<022> which creates new files with "
16075 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
16076 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
16080 #: ../src/guestfs-actions.pod:6633 ../fish/guestfish-actions.pod:4450
16082 "The default umask is C<022>. This is important because it means that "
16083 "directories and device nodes will be created with C<0644> or C<0755> mode "
16084 "even if you specify C<0777>."
16088 #: ../src/guestfs-actions.pod:6637
16090 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
16091 "C<guestfs_mkdir>."
16095 #: ../src/guestfs-actions.pod:6640 ../fish/guestfish-actions.pod:4457
16096 msgid "This call returns the previous umask."
16100 #: ../src/guestfs-actions.pod:6646
16101 msgid "guestfs_umount"
16105 #: ../src/guestfs-actions.pod:6648
16109 " guestfs_umount (guestfs_h *g,\n"
16110 " const char *pathordevice);\n"
16115 #: ../src/guestfs-actions.pod:6652 ../fish/guestfish-actions.pod:4465
16117 "This unmounts the given filesystem. The filesystem may be specified either "
16118 "by its mountpoint (path) or the device which contains the filesystem."
16122 #: ../src/guestfs-actions.pod:6660
16123 msgid "guestfs_umount_all"
16127 #: ../src/guestfs-actions.pod:6662
16131 " guestfs_umount_all (guestfs_h *g);\n"
16136 #: ../src/guestfs-actions.pod:6665 ../fish/guestfish-actions.pod:4475
16137 msgid "This unmounts all mounted filesystems."
16141 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4477
16142 msgid "Some internal mounts are not unmounted by this call."
16146 #: ../src/guestfs-actions.pod:6673
16147 msgid "guestfs_upload"
16151 #: ../src/guestfs-actions.pod:6675
16155 " guestfs_upload (guestfs_h *g,\n"
16156 " const char *filename,\n"
16157 " const char *remotefilename);\n"
16162 #: ../src/guestfs-actions.pod:6680 ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4483 ../fish/guestfish-actions.pod:4496
16163 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
16167 #: ../src/guestfs-actions.pod:6685
16168 msgid "See also C<guestfs_download>."
16172 #: ../src/guestfs-actions.pod:6696
16173 msgid "guestfs_upload_offset"
16177 #: ../src/guestfs-actions.pod:6698
16181 " guestfs_upload_offset (guestfs_h *g,\n"
16182 " const char *filename,\n"
16183 " const char *remotefilename,\n"
16184 " int64_t offset);\n"
16189 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4499
16191 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
16192 "The intention is to overwrite parts of existing files or devices, although "
16193 "if a non-existant file is specified then it is created with a \"hole\" "
16194 "before C<offset>. The size of the data written is implicit in the size of "
16195 "the source C<filename>."
16199 #: ../src/guestfs-actions.pod:6714
16201 "Note that there is no limit on the amount of data that can be uploaded with "
16202 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
16203 "full amount unless an error occurs."
16207 #: ../src/guestfs-actions.pod:6719
16208 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
16212 #: ../src/guestfs-actions.pod:6730
16213 msgid "guestfs_utimens"
16217 #: ../src/guestfs-actions.pod:6732
16221 " guestfs_utimens (guestfs_h *g,\n"
16222 " const char *path,\n"
16223 " int64_t atsecs,\n"
16224 " int64_t atnsecs,\n"
16225 " int64_t mtsecs,\n"
16226 " int64_t mtnsecs);\n"
16231 #: ../src/guestfs-actions.pod:6740 ../fish/guestfish-actions.pod:4519
16232 msgid "This command sets the timestamps of a file with nanosecond precision."
16236 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4522
16238 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
16243 #: ../src/guestfs-actions.pod:6746 ../fish/guestfish-actions.pod:4525
16245 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
16246 "nanoseconds from the epoch."
16250 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4528
16252 "If the C<*nsecs> field contains the special value C<-1> then the "
16253 "corresponding timestamp is set to the current time. (The C<*secs> field is "
16254 "ignored in this case)."
16258 #: ../src/guestfs-actions.pod:6753 ../fish/guestfish-actions.pod:4532
16260 "If the C<*nsecs> field contains the special value C<-2> then the "
16261 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
16266 #: ../src/guestfs-actions.pod:6761 ../src/guestfs-structs.pod:175
16267 msgid "guestfs_version"
16271 #: ../src/guestfs-actions.pod:6763
16274 " struct guestfs_version *\n"
16275 " guestfs_version (guestfs_h *g);\n"
16280 #: ../src/guestfs-actions.pod:6766 ../fish/guestfish-actions.pod:4540
16281 msgid "Return the libguestfs version number that the program is linked against."
16285 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4543
16287 "Note that because of dynamic linking this is not necessarily the version of "
16288 "libguestfs that you compiled against. You can compile the program, and then "
16289 "at runtime dynamically link against a completely different C<libguestfs.so> "
16294 #: ../src/guestfs-actions.pod:6774 ../fish/guestfish-actions.pod:4548
16296 "This call was added in version C<1.0.58>. In previous versions of "
16297 "libguestfs there was no way to get the version number. From C code you can "
16298 "use dynamic linker functions to find out if this symbol exists (if it "
16299 "doesn't, then it's an earlier version)."
16303 #: ../src/guestfs-actions.pod:6780 ../fish/guestfish-actions.pod:4554
16305 "The call returns a structure with four elements. The first three (C<major>, "
16306 "C<minor> and C<release>) are numbers and correspond to the usual version "
16307 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
16308 "but may be used for distro-specific information."
16312 #: ../src/guestfs-actions.pod:6786 ../fish/guestfish-actions.pod:4560
16313 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
16317 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4563
16318 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
16322 #: ../src/guestfs-actions.pod:6791
16324 "I<Note:> Don't use this call to test for availability of features. In "
16325 "enterprise distributions we backport features from later versions into "
16326 "earlier versions, making this an unreliable way to test for features. Use "
16327 "C<guestfs_available> instead."
16331 #: ../src/guestfs-actions.pod:6797
16333 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
16334 "error. I<The caller must call C<guestfs_free_version> after use>."
16338 #: ../src/guestfs-actions.pod:6801
16339 msgid "(Added in 1.0.58)"
16343 #: ../src/guestfs-actions.pod:6803
16344 msgid "guestfs_vfs_label"
16348 #: ../src/guestfs-actions.pod:6805
16352 " guestfs_vfs_label (guestfs_h *g,\n"
16353 " const char *device);\n"
16358 #: ../src/guestfs-actions.pod:6809 ../fish/guestfish-actions.pod:4575
16359 msgid "This returns the filesystem label of the filesystem on C<device>."
16363 #: ../src/guestfs-actions.pod:6812 ../fish/guestfish-actions.pod:4578
16364 msgid "If the filesystem is unlabeled, this returns the empty string."
16368 #: ../src/guestfs-actions.pod:6814
16369 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
16373 #: ../src/guestfs-actions.pod:6819 ../src/guestfs-actions.pod:6856
16374 msgid "(Added in 1.3.18)"
16378 #: ../src/guestfs-actions.pod:6821
16379 msgid "guestfs_vfs_type"
16383 #: ../src/guestfs-actions.pod:6823
16387 " guestfs_vfs_type (guestfs_h *g,\n"
16388 " const char *device);\n"
16393 #: ../src/guestfs-actions.pod:6827 ../fish/guestfish-actions.pod:4586
16395 "This command gets the filesystem type corresponding to the filesystem on "
16400 #: ../src/guestfs-actions.pod:6830 ../fish/guestfish-actions.pod:4589
16402 "For most filesystems, the result is the name of the Linux VFS module which "
16403 "would be used to mount this filesystem if you mounted it without specifying "
16404 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
16408 #: ../src/guestfs-actions.pod:6840
16409 msgid "guestfs_vfs_uuid"
16413 #: ../src/guestfs-actions.pod:6842
16417 " guestfs_vfs_uuid (guestfs_h *g,\n"
16418 " const char *device);\n"
16423 #: ../src/guestfs-actions.pod:6846 ../fish/guestfish-actions.pod:4598
16424 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16428 #: ../src/guestfs-actions.pod:6849 ../fish/guestfish-actions.pod:4601
16429 msgid "If the filesystem does not have a UUID, this returns the empty string."
16433 #: ../src/guestfs-actions.pod:6851
16434 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16438 #: ../src/guestfs-actions.pod:6858
16439 msgid "guestfs_vg_activate"
16443 #: ../src/guestfs-actions.pod:6860
16447 " guestfs_vg_activate (guestfs_h *g,\n"
16449 " char *const *volgroups);\n"
16454 #: ../src/guestfs-actions.pod:6865 ../fish/guestfish-actions.pod:4609
16456 "This command activates or (if C<activate> is false) deactivates all logical "
16457 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16458 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16459 "deactivated, then those devices disappear."
16463 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4615
16464 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16468 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4617
16470 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16471 "activated or deactivated."
16475 #: ../src/guestfs-actions.pod:6880
16476 msgid "guestfs_vg_activate_all"
16480 #: ../src/guestfs-actions.pod:6882
16484 " guestfs_vg_activate_all (guestfs_h *g,\n"
16485 " int activate);\n"
16490 #: ../src/guestfs-actions.pod:6886 ../fish/guestfish-actions.pod:4624
16492 "This command activates or (if C<activate> is false) deactivates all logical "
16493 "volumes in all volume groups. If activated, then they are made known to the "
16494 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16495 "those devices disappear."
16499 #: ../src/guestfs-actions.pod:6892 ../fish/guestfish-actions.pod:4630
16500 msgid "This command is the same as running C<vgchange -a y|n>"
16504 #: ../src/guestfs-actions.pod:6898
16505 msgid "guestfs_vgcreate"
16509 #: ../src/guestfs-actions.pod:6900
16513 " guestfs_vgcreate (guestfs_h *g,\n"
16514 " const char *volgroup,\n"
16515 " char *const *physvols);\n"
16520 #: ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:4636
16522 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16523 "of physical volumes C<physvols>."
16527 #: ../src/guestfs-actions.pod:6912
16528 msgid "guestfs_vglvuuids"
16532 #: ../src/guestfs-actions.pod:6914
16536 " guestfs_vglvuuids (guestfs_h *g,\n"
16537 " const char *vgname);\n"
16542 #: ../src/guestfs-actions.pod:6918 ../fish/guestfish-actions.pod:4643
16544 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16545 "volumes created in this volume group."
16549 #: ../src/guestfs-actions.pod:6921
16551 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
16552 "associate logical volumes and volume groups."
16556 #: ../src/guestfs-actions.pod:6924
16557 msgid "See also C<guestfs_vgpvuuids>."
16561 #: ../src/guestfs-actions.pod:6932
16562 msgid "guestfs_vgpvuuids"
16566 #: ../src/guestfs-actions.pod:6934
16570 " guestfs_vgpvuuids (guestfs_h *g,\n"
16571 " const char *vgname);\n"
16576 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4655
16578 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16579 "volumes that this volume group resides on."
16583 #: ../src/guestfs-actions.pod:6941
16585 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
16586 "associate physical volumes and volume groups."
16590 #: ../src/guestfs-actions.pod:6944
16591 msgid "See also C<guestfs_vglvuuids>."
16595 #: ../src/guestfs-actions.pod:6952
16596 msgid "guestfs_vgremove"
16600 #: ../src/guestfs-actions.pod:6954
16604 " guestfs_vgremove (guestfs_h *g,\n"
16605 " const char *vgname);\n"
16610 #: ../src/guestfs-actions.pod:6958 ../fish/guestfish-actions.pod:4667
16611 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16615 #: ../src/guestfs-actions.pod:6960 ../fish/guestfish-actions.pod:4669
16616 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16620 #: ../src/guestfs-actions.pod:6967
16621 msgid "guestfs_vgrename"
16625 #: ../src/guestfs-actions.pod:6969
16629 " guestfs_vgrename (guestfs_h *g,\n"
16630 " const char *volgroup,\n"
16631 " const char *newvolgroup);\n"
16636 #: ../src/guestfs-actions.pod:6974 ../fish/guestfish-actions.pod:4676
16637 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16641 #: ../src/guestfs-actions.pod:6980
16642 msgid "guestfs_vgs"
16646 #: ../src/guestfs-actions.pod:6982
16650 " guestfs_vgs (guestfs_h *g);\n"
16655 #: ../src/guestfs-actions.pod:6985 ../fish/guestfish-actions.pod:4682
16657 "List all the volumes groups detected. This is the equivalent of the "
16658 "L<vgs(8)> command."
16662 #: ../src/guestfs-actions.pod:6988 ../fish/guestfish-actions.pod:4685
16664 "This returns a list of just the volume group names that were detected "
16665 "(eg. C<VolGroup00>)."
16669 #: ../src/guestfs-actions.pod:6991
16670 msgid "See also C<guestfs_vgs_full>."
16674 #: ../src/guestfs-actions.pod:6999
16675 msgid "guestfs_vgs_full"
16679 #: ../src/guestfs-actions.pod:7001
16682 " struct guestfs_lvm_vg_list *\n"
16683 " guestfs_vgs_full (guestfs_h *g);\n"
16688 #: ../src/guestfs-actions.pod:7004 ../fish/guestfish-actions.pod:4694
16690 "List all the volumes groups detected. This is the equivalent of the "
16691 "L<vgs(8)> command. The \"full\" version includes all fields."
16695 #: ../src/guestfs-actions.pod:7007
16697 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
16698 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
16703 #: ../src/guestfs-actions.pod:7013
16704 msgid "guestfs_vgscan"
16708 #: ../src/guestfs-actions.pod:7015
16712 " guestfs_vgscan (guestfs_h *g);\n"
16717 #: ../src/guestfs-actions.pod:7018 ../fish/guestfish-actions.pod:4701
16719 "This rescans all block devices and rebuilds the list of LVM physical "
16720 "volumes, volume groups and logical volumes."
16724 #: ../src/guestfs-actions.pod:7025
16725 msgid "guestfs_vguuid"
16729 #: ../src/guestfs-actions.pod:7027
16733 " guestfs_vguuid (guestfs_h *g,\n"
16734 " const char *vgname);\n"
16739 #: ../src/guestfs-actions.pod:7031 ../fish/guestfish-actions.pod:4708
16740 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16744 #: ../src/guestfs-actions.pod:7038
16745 msgid "guestfs_wait_ready"
16749 #: ../src/guestfs-actions.pod:7040
16753 " guestfs_wait_ready (guestfs_h *g);\n"
16758 #: ../src/guestfs-actions.pod:7043
16759 msgid "This function is a no op."
16763 #: ../src/guestfs-actions.pod:7045
16765 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
16766 "calling C<guestfs_launch> to wait for the launch to complete. However this "
16767 "is no longer necessary because C<guestfs_launch> now does the waiting."
16771 #: ../src/guestfs-actions.pod:7050
16773 "If you see any calls to this function in code then you can just remove them, "
16774 "unless you want to retain compatibility with older versions of the API."
16778 #: ../src/guestfs-actions.pod:7058
16779 msgid "guestfs_wc_c"
16783 #: ../src/guestfs-actions.pod:7060
16787 " guestfs_wc_c (guestfs_h *g,\n"
16788 " const char *path);\n"
16793 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4714
16795 "This command counts the characters in a file, using the C<wc -c> external "
16800 #: ../src/guestfs-actions.pod:7071
16801 msgid "guestfs_wc_l"
16805 #: ../src/guestfs-actions.pod:7073
16809 " guestfs_wc_l (guestfs_h *g,\n"
16810 " const char *path);\n"
16815 #: ../src/guestfs-actions.pod:7077 ../fish/guestfish-actions.pod:4721
16817 "This command counts the lines in a file, using the C<wc -l> external "
16822 #: ../src/guestfs-actions.pod:7084
16823 msgid "guestfs_wc_w"
16827 #: ../src/guestfs-actions.pod:7086
16831 " guestfs_wc_w (guestfs_h *g,\n"
16832 " const char *path);\n"
16837 #: ../src/guestfs-actions.pod:7090 ../fish/guestfish-actions.pod:4728
16839 "This command counts the words in a file, using the C<wc -w> external "
16844 #: ../src/guestfs-actions.pod:7097
16845 msgid "guestfs_write"
16849 #: ../src/guestfs-actions.pod:7099
16853 " guestfs_write (guestfs_h *g,\n"
16854 " const char *path,\n"
16855 " const char *content,\n"
16856 " size_t content_size);\n"
16861 #: ../src/guestfs-actions.pod:7105 ../fish/guestfish-actions.pod:4735
16863 "This call creates a file called C<path>. The content of the file is the "
16864 "string C<content> (which can contain any 8 bit data)."
16868 #: ../src/guestfs-actions.pod:7115
16869 msgid "guestfs_write_file"
16873 #: ../src/guestfs-actions.pod:7117
16877 " guestfs_write_file (guestfs_h *g,\n"
16878 " const char *path,\n"
16879 " const char *content,\n"
16885 #: ../src/guestfs-actions.pod:7123 ../fish/guestfish-actions.pod:4745
16887 "This call creates a file called C<path>. The contents of the file is the "
16888 "string C<content> (which can contain any 8 bit data), with length C<size>."
16892 #: ../src/guestfs-actions.pod:7127 ../fish/guestfish-actions.pod:4749
16894 "As a special case, if C<size> is C<0> then the length is calculated using "
16895 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16899 #: ../src/guestfs-actions.pod:7131 ../fish/guestfish-actions.pod:4753
16901 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16902 "I<not> work, even if the length is specified."
16906 #: ../src/guestfs-actions.pod:7139 ../fish/guestfish-actions.pod:4759
16907 msgid "This function is deprecated. In new code, use the C<write> call instead."
16911 #: ../src/guestfs-actions.pod:7148
16912 msgid "guestfs_zegrep"
16916 #: ../src/guestfs-actions.pod:7150
16920 " guestfs_zegrep (guestfs_h *g,\n"
16921 " const char *regex,\n"
16922 " const char *path);\n"
16927 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:4770
16928 msgid "This calls the external C<zegrep> program and returns the matching lines."
16932 #: ../src/guestfs-actions.pod:7167
16933 msgid "guestfs_zegrepi"
16937 #: ../src/guestfs-actions.pod:7169
16941 " guestfs_zegrepi (guestfs_h *g,\n"
16942 " const char *regex,\n"
16943 " const char *path);\n"
16948 #: ../src/guestfs-actions.pod:7174 ../fish/guestfish-actions.pod:4780
16949 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16953 #: ../src/guestfs-actions.pod:7186
16954 msgid "guestfs_zero"
16958 #: ../src/guestfs-actions.pod:7188
16962 " guestfs_zero (guestfs_h *g,\n"
16963 " const char *device);\n"
16968 #: ../src/guestfs-actions.pod:7192 ../fish/guestfish-actions.pod:4790
16969 msgid "This command writes zeroes over the first few blocks of C<device>."
16973 #: ../src/guestfs-actions.pod:7194 ../fish/guestfish-actions.pod:4792
16975 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16976 "securely wipe the device). It should be sufficient to remove any partition "
16977 "tables, filesystem superblocks and so on."
16981 #: ../src/guestfs-actions.pod:7198
16982 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16986 #: ../src/guestfs-actions.pod:7209
16987 msgid "guestfs_zero_device"
16991 #: ../src/guestfs-actions.pod:7211
16995 " guestfs_zero_device (guestfs_h *g,\n"
16996 " const char *device);\n"
17001 #: ../src/guestfs-actions.pod:7215
17003 "This command writes zeroes over the entire C<device>. Compare with "
17004 "C<guestfs_zero> which just zeroes the first few blocks of a device."
17008 #: ../src/guestfs-actions.pod:7229
17009 msgid "(Added in 1.3.1)"
17013 #: ../src/guestfs-actions.pod:7231
17014 msgid "guestfs_zerofree"
17018 #: ../src/guestfs-actions.pod:7233
17022 " guestfs_zerofree (guestfs_h *g,\n"
17023 " const char *device);\n"
17028 #: ../src/guestfs-actions.pod:7237 ../fish/guestfish-actions.pod:4813
17030 "This runs the I<zerofree> program on C<device>. This program claims to zero "
17031 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
17032 "possible to compress the filesystem more effectively."
17036 #: ../src/guestfs-actions.pod:7242 ../fish/guestfish-actions.pod:4818
17037 msgid "You should B<not> run this program if the filesystem is mounted."
17041 #: ../src/guestfs-actions.pod:7245 ../fish/guestfish-actions.pod:4821
17043 "It is possible that using this program can damage the filesystem or data on "
17048 #: ../src/guestfs-actions.pod:7252
17049 msgid "guestfs_zfgrep"
17053 #: ../src/guestfs-actions.pod:7254
17057 " guestfs_zfgrep (guestfs_h *g,\n"
17058 " const char *pattern,\n"
17059 " const char *path);\n"
17064 #: ../src/guestfs-actions.pod:7259 ../fish/guestfish-actions.pod:4828
17065 msgid "This calls the external C<zfgrep> program and returns the matching lines."
17069 #: ../src/guestfs-actions.pod:7271
17070 msgid "guestfs_zfgrepi"
17074 #: ../src/guestfs-actions.pod:7273
17078 " guestfs_zfgrepi (guestfs_h *g,\n"
17079 " const char *pattern,\n"
17080 " const char *path);\n"
17085 #: ../src/guestfs-actions.pod:7278 ../fish/guestfish-actions.pod:4838
17086 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
17090 #: ../src/guestfs-actions.pod:7290
17091 msgid "guestfs_zfile"
17095 #: ../src/guestfs-actions.pod:7292
17099 " guestfs_zfile (guestfs_h *g,\n"
17100 " const char *meth,\n"
17101 " const char *path);\n"
17106 #: ../src/guestfs-actions.pod:7297 ../fish/guestfish-actions.pod:4848
17107 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
17111 #: ../src/guestfs-actions.pod:7300 ../fish/guestfish-actions.pod:4851
17112 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
17116 #: ../src/guestfs-actions.pod:7302
17118 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
17123 #: ../src/guestfs-actions.pod:7308 ../fish/guestfish-actions.pod:4856
17124 msgid "This function is deprecated. In new code, use the C<file> call instead."
17128 #: ../src/guestfs-actions.pod:7317
17129 msgid "guestfs_zgrep"
17133 #: ../src/guestfs-actions.pod:7319
17137 " guestfs_zgrep (guestfs_h *g,\n"
17138 " const char *regex,\n"
17139 " const char *path);\n"
17144 #: ../src/guestfs-actions.pod:7324 ../fish/guestfish-actions.pod:4867
17145 msgid "This calls the external C<zgrep> program and returns the matching lines."
17149 #: ../src/guestfs-actions.pod:7336
17150 msgid "guestfs_zgrepi"
17154 #: ../src/guestfs-actions.pod:7338
17158 " guestfs_zgrepi (guestfs_h *g,\n"
17159 " const char *regex,\n"
17160 " const char *path);\n"
17165 #: ../src/guestfs-actions.pod:7343 ../fish/guestfish-actions.pod:4877
17166 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
17170 #: ../src/guestfs-availability.pod:3
17175 #: ../src/guestfs-availability.pod:5
17177 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
17178 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
17179 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
17180 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
17181 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
17185 #: ../src/guestfs-availability.pod:21
17190 #: ../src/guestfs-availability.pod:23
17192 "The following functions: L</guestfs_inotify_add_watch> "
17193 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
17194 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
17198 #: ../src/guestfs-availability.pod:31
17199 msgid "B<linuxfsuuid>"
17203 #: ../src/guestfs-availability.pod:33
17205 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
17206 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
17210 #: ../src/guestfs-availability.pod:40
17211 msgid "B<linuxmodules>"
17215 #: ../src/guestfs-availability.pod:42
17216 msgid "The following functions: L</guestfs_modprobe>"
17220 #: ../src/guestfs-availability.pod:45
17221 msgid "B<linuxxattrs>"
17225 #: ../src/guestfs-availability.pod:47
17227 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
17228 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
17229 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
17230 "L</guestfs_setxattr>"
17234 #: ../src/guestfs-availability.pod:58
17239 #: ../src/guestfs-availability.pod:60
17241 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
17242 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
17243 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
17247 #: ../src/guestfs-availability.pod:69
17252 #: ../src/guestfs-availability.pod:71
17254 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
17255 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
17256 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
17257 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
17258 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
17259 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
17260 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
17261 "L</guestfs_vgs_full>"
17265 #: ../src/guestfs-availability.pod:94
17270 #: ../src/guestfs-availability.pod:96
17272 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
17273 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
17277 #: ../src/guestfs-availability.pod:102
17282 #: ../src/guestfs-availability.pod:104
17283 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
17287 #: ../src/guestfs-availability.pod:107
17288 msgid "B<ntfsprogs>"
17292 #: ../src/guestfs-availability.pod:109
17293 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
17297 #: ../src/guestfs-availability.pod:113
17298 msgid "B<realpath>"
17302 #: ../src/guestfs-availability.pod:115
17303 msgid "The following functions: L</guestfs_realpath>"
17307 #: ../src/guestfs-availability.pod:118
17312 #: ../src/guestfs-availability.pod:120
17314 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
17315 "L</guestfs_scrub_freespace>"
17319 #: ../src/guestfs-availability.pod:125
17324 #: ../src/guestfs-availability.pod:127
17325 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
17329 #: ../src/guestfs-availability.pod:131
17334 #: ../src/guestfs-availability.pod:133
17335 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
17339 #: ../src/guestfs-availability.pod:137
17340 msgid "B<zerofree>"
17344 #: ../src/guestfs-availability.pod:139
17345 msgid "The following functions: L</guestfs_zerofree>"
17349 #: ../src/guestfs-structs.pod:1
17350 msgid "guestfs_int_bool"
17354 #: ../src/guestfs-structs.pod:3
17357 " struct guestfs_int_bool {\n"
17365 #: ../src/guestfs-structs.pod:8
17368 " struct guestfs_int_bool_list {\n"
17369 " uint32_t len; /* Number of elements in list. */\n"
17370 " struct guestfs_int_bool *val; /* Elements. */\n"
17376 #: ../src/guestfs-structs.pod:13
17379 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
17380 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
17385 #: ../src/guestfs-structs.pod:16
17386 msgid "guestfs_lvm_pv"
17390 #: ../src/guestfs-structs.pod:18
17393 " struct guestfs_lvm_pv {\n"
17394 " char *pv_name;\n"
17395 " /* The next field is NOT nul-terminated, be careful when printing it: "
17397 " char pv_uuid[32];\n"
17399 " uint64_t pv_size;\n"
17400 " uint64_t dev_size;\n"
17401 " uint64_t pv_free;\n"
17402 " uint64_t pv_used;\n"
17403 " char *pv_attr;\n"
17404 " int64_t pv_pe_count;\n"
17405 " int64_t pv_pe_alloc_count;\n"
17406 " char *pv_tags;\n"
17407 " uint64_t pe_start;\n"
17408 " int64_t pv_mda_count;\n"
17409 " uint64_t pv_mda_free;\n"
17415 #: ../src/guestfs-structs.pod:36
17418 " struct guestfs_lvm_pv_list {\n"
17419 " uint32_t len; /* Number of elements in list. */\n"
17420 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17426 #: ../src/guestfs-structs.pod:41
17429 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17430 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17435 #: ../src/guestfs-structs.pod:44
17436 msgid "guestfs_lvm_vg"
17440 #: ../src/guestfs-structs.pod:46
17443 " struct guestfs_lvm_vg {\n"
17444 " char *vg_name;\n"
17445 " /* The next field is NOT nul-terminated, be careful when printing it: "
17447 " char vg_uuid[32];\n"
17449 " char *vg_attr;\n"
17450 " uint64_t vg_size;\n"
17451 " uint64_t vg_free;\n"
17452 " char *vg_sysid;\n"
17453 " uint64_t vg_extent_size;\n"
17454 " int64_t vg_extent_count;\n"
17455 " int64_t vg_free_count;\n"
17456 " int64_t max_lv;\n"
17457 " int64_t max_pv;\n"
17458 " int64_t pv_count;\n"
17459 " int64_t lv_count;\n"
17460 " int64_t snap_count;\n"
17461 " int64_t vg_seqno;\n"
17462 " char *vg_tags;\n"
17463 " int64_t vg_mda_count;\n"
17464 " uint64_t vg_mda_free;\n"
17470 #: ../src/guestfs-structs.pod:69
17473 " struct guestfs_lvm_vg_list {\n"
17474 " uint32_t len; /* Number of elements in list. */\n"
17475 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17481 #: ../src/guestfs-structs.pod:74
17484 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17485 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17490 #: ../src/guestfs-structs.pod:77
17491 msgid "guestfs_lvm_lv"
17495 #: ../src/guestfs-structs.pod:79
17498 " struct guestfs_lvm_lv {\n"
17499 " char *lv_name;\n"
17500 " /* The next field is NOT nul-terminated, be careful when printing it: "
17502 " char lv_uuid[32];\n"
17503 " char *lv_attr;\n"
17504 " int64_t lv_major;\n"
17505 " int64_t lv_minor;\n"
17506 " int64_t lv_kernel_major;\n"
17507 " int64_t lv_kernel_minor;\n"
17508 " uint64_t lv_size;\n"
17509 " int64_t seg_count;\n"
17511 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17512 " float snap_percent;\n"
17513 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17514 " float copy_percent;\n"
17515 " char *move_pv;\n"
17516 " char *lv_tags;\n"
17517 " char *mirror_log;\n"
17518 " char *modules;\n"
17524 #: ../src/guestfs-structs.pod:101
17527 " struct guestfs_lvm_lv_list {\n"
17528 " uint32_t len; /* Number of elements in list. */\n"
17529 " struct guestfs_lvm_lv *val; /* Elements. */\n"
17535 #: ../src/guestfs-structs.pod:106
17538 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
17539 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
17544 #: ../src/guestfs-structs.pod:111
17547 " struct guestfs_stat {\n"
17551 " int64_t nlink;\n"
17556 " int64_t blksize;\n"
17557 " int64_t blocks;\n"
17558 " int64_t atime;\n"
17559 " int64_t mtime;\n"
17560 " int64_t ctime;\n"
17566 #: ../src/guestfs-structs.pod:127
17569 " struct guestfs_stat_list {\n"
17570 " uint32_t len; /* Number of elements in list. */\n"
17571 " struct guestfs_stat *val; /* Elements. */\n"
17577 #: ../src/guestfs-structs.pod:132
17580 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
17581 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
17586 #: ../src/guestfs-structs.pod:137
17589 " struct guestfs_statvfs {\n"
17590 " int64_t bsize;\n"
17591 " int64_t frsize;\n"
17592 " int64_t blocks;\n"
17593 " int64_t bfree;\n"
17594 " int64_t bavail;\n"
17595 " int64_t files;\n"
17596 " int64_t ffree;\n"
17597 " int64_t favail;\n"
17600 " int64_t namemax;\n"
17606 #: ../src/guestfs-structs.pod:151
17609 " struct guestfs_statvfs_list {\n"
17610 " uint32_t len; /* Number of elements in list. */\n"
17611 " struct guestfs_statvfs *val; /* Elements. */\n"
17617 #: ../src/guestfs-structs.pod:156
17620 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
17621 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
17626 #: ../src/guestfs-structs.pod:159
17627 msgid "guestfs_dirent"
17631 #: ../src/guestfs-structs.pod:161
17634 " struct guestfs_dirent {\n"
17643 #: ../src/guestfs-structs.pod:167
17646 " struct guestfs_dirent_list {\n"
17647 " uint32_t len; /* Number of elements in list. */\n"
17648 " struct guestfs_dirent *val; /* Elements. */\n"
17654 #: ../src/guestfs-structs.pod:172
17657 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
17658 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
17663 #: ../src/guestfs-structs.pod:177
17666 " struct guestfs_version {\n"
17667 " int64_t major;\n"
17668 " int64_t minor;\n"
17669 " int64_t release;\n"
17676 #: ../src/guestfs-structs.pod:184
17679 " struct guestfs_version_list {\n"
17680 " uint32_t len; /* Number of elements in list. */\n"
17681 " struct guestfs_version *val; /* Elements. */\n"
17687 #: ../src/guestfs-structs.pod:189
17690 " void guestfs_free_version (struct guestfs_free_version *);\n"
17691 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
17696 #: ../src/guestfs-structs.pod:192
17697 msgid "guestfs_xattr"
17701 #: ../src/guestfs-structs.pod:194
17704 " struct guestfs_xattr {\n"
17705 " char *attrname;\n"
17706 " /* The next two fields describe a byte array. */\n"
17707 " uint32_t attrval_len;\n"
17708 " char *attrval;\n"
17714 #: ../src/guestfs-structs.pod:201
17717 " struct guestfs_xattr_list {\n"
17718 " uint32_t len; /* Number of elements in list. */\n"
17719 " struct guestfs_xattr *val; /* Elements. */\n"
17725 #: ../src/guestfs-structs.pod:206
17728 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
17729 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
17734 #: ../src/guestfs-structs.pod:209
17735 msgid "guestfs_inotify_event"
17739 #: ../src/guestfs-structs.pod:211
17742 " struct guestfs_inotify_event {\n"
17743 " int64_t in_wd;\n"
17744 " uint32_t in_mask;\n"
17745 " uint32_t in_cookie;\n"
17746 " char *in_name;\n"
17752 #: ../src/guestfs-structs.pod:218
17755 " struct guestfs_inotify_event_list {\n"
17756 " uint32_t len; /* Number of elements in list. */\n"
17757 " struct guestfs_inotify_event *val; /* Elements. */\n"
17763 #: ../src/guestfs-structs.pod:223
17766 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
17767 " void guestfs_free_inotify_event_list (struct "
17768 "guestfs_free_inotify_event_list *);\n"
17773 #: ../src/guestfs-structs.pod:226
17774 msgid "guestfs_partition"
17778 #: ../src/guestfs-structs.pod:228
17781 " struct guestfs_partition {\n"
17782 " int32_t part_num;\n"
17783 " uint64_t part_start;\n"
17784 " uint64_t part_end;\n"
17785 " uint64_t part_size;\n"
17791 #: ../src/guestfs-structs.pod:235
17794 " struct guestfs_partition_list {\n"
17795 " uint32_t len; /* Number of elements in list. */\n"
17796 " struct guestfs_partition *val; /* Elements. */\n"
17802 #: ../src/guestfs-structs.pod:240
17805 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
17806 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
17811 #: ../src/guestfs-structs.pod:243
17812 msgid "guestfs_application"
17816 #: ../src/guestfs-structs.pod:245
17819 " struct guestfs_application {\n"
17820 " char *app_name;\n"
17821 " char *app_display_name;\n"
17822 " int32_t app_epoch;\n"
17823 " char *app_version;\n"
17824 " char *app_release;\n"
17825 " char *app_install_path;\n"
17826 " char *app_trans_path;\n"
17827 " char *app_publisher;\n"
17828 " char *app_url;\n"
17829 " char *app_source_package;\n"
17830 " char *app_summary;\n"
17831 " char *app_description;\n"
17837 #: ../src/guestfs-structs.pod:260
17840 " struct guestfs_application_list {\n"
17841 " uint32_t len; /* Number of elements in list. */\n"
17842 " struct guestfs_application *val; /* Elements. */\n"
17848 #: ../src/guestfs-structs.pod:265
17851 " void guestfs_free_application (struct guestfs_free_application *);\n"
17852 " void guestfs_free_application_list (struct guestfs_free_application_list "
17858 #: ../fish/guestfish.pod:5
17859 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17863 #: ../fish/guestfish.pod:9
17866 " guestfish [--options] [commands]\n"
17871 #: ../fish/guestfish.pod:11
17879 #: ../fish/guestfish.pod:13
17882 " guestfish [--ro|--rw] -a disk.img\n"
17887 #: ../fish/guestfish.pod:15
17890 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17895 #: ../fish/guestfish.pod:17
17898 " guestfish -d libvirt-domain\n"
17903 #: ../fish/guestfish.pod:19
17906 " guestfish [--ro|--rw] -a disk.img -i\n"
17911 #: ../fish/guestfish.pod:21
17914 " guestfish -d libvirt-domain -i\n"
17919 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
17924 #: ../fish/guestfish.pod:25
17926 "Using guestfish in read/write mode on live virtual machines can be "
17927 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17928 "option to use guestfish safely if the disk image or virtual machine might be "
17933 #: ../fish/guestfish.pod:32
17935 "Guestfish is a shell and command-line tool for examining and modifying "
17936 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17937 "functionality of the guestfs API, see L<guestfs(3)>."
17941 #: ../fish/guestfish.pod:36
17943 "Guestfish gives you structured access to the libguestfs API, from shell "
17944 "scripts or the command line or interactively. If you want to rescue a "
17945 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17950 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:928 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
17955 #: ../fish/guestfish.pod:43
17956 msgid "As an interactive shell"
17960 #: ../fish/guestfish.pod:45
17968 #: ../fish/guestfish.pod:47
17971 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17972 " editing virtual machine filesystems.\n"
17977 #: ../fish/guestfish.pod:50
17980 " Type: 'help' for a list of commands\n"
17981 " 'man' to read the manual\n"
17982 " 'quit' to quit the shell\n"
17987 #: ../fish/guestfish.pod:54
17990 " ><fs> add-ro disk.img\n"
17992 " ><fs> list-filesystems\n"
17993 " /dev/sda1: ext4\n"
17994 " /dev/vg_guest/lv_root: ext4\n"
17995 " /dev/vg_guest/lv_swap: swap\n"
17996 " ><fs> mount /dev/vg_guest/lv_root /\n"
17997 " ><fs> cat /etc/fstab\n"
17999 " # Created by anaconda\n"
18006 #: ../fish/guestfish.pod:67
18007 msgid "From shell scripts"
18011 #: ../fish/guestfish.pod:69
18012 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18016 #: ../fish/guestfish.pod:71
18019 " guestfish <<_EOF_\n"
18022 " mount /dev/vg_guest/lv_root /\n"
18023 " write /etc/motd \"Welcome, new users\"\n"
18029 #: ../fish/guestfish.pod:78
18030 msgid "List the LVM logical volumes in a disk image:"
18034 #: ../fish/guestfish.pod:80
18037 " guestfish -a disk.img --ro <<_EOF_\n"
18045 #: ../fish/guestfish.pod:85
18046 msgid "List all the filesystems in a disk image:"
18050 #: ../fish/guestfish.pod:87
18053 " guestfish -a disk.img --ro <<_EOF_\n"
18055 " list-filesystems\n"
18061 #: ../fish/guestfish.pod:92
18062 msgid "On one command line"
18066 #: ../fish/guestfish.pod:94
18067 msgid "Update C</etc/resolv.conf> in a guest:"
18071 #: ../fish/guestfish.pod:96
18075 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
18076 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
18081 #: ../fish/guestfish.pod:100
18082 msgid "Edit C</boot/grub/grub.conf> interactively:"
18086 #: ../fish/guestfish.pod:102
18089 " guestfish --rw --add disk.img \\\n"
18090 " --mount /dev/vg_guest/lv_root \\\n"
18091 " --mount /dev/sda1:/boot \\\n"
18092 " edit /boot/grub/grub.conf\n"
18097 #: ../fish/guestfish.pod:107
18098 msgid "Mount disks automatically"
18102 #: ../fish/guestfish.pod:109
18104 "Use the I<-i> option to automatically mount the disks from a virtual "
18109 #: ../fish/guestfish.pod:112
18112 " guestfish --ro -a disk.img -i cat /etc/group\n"
18117 #: ../fish/guestfish.pod:114
18120 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
18125 #: ../fish/guestfish.pod:116
18126 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
18130 #: ../fish/guestfish.pod:118
18133 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
18138 #: ../fish/guestfish.pod:120
18139 msgid "As a script interpreter"
18143 #: ../fish/guestfish.pod:122
18144 msgid "Create a 100MB disk containing an ext2-formatted partition:"
18148 #: ../fish/guestfish.pod:124
18151 " #!/usr/bin/guestfish -f\n"
18152 " sparse test1.img 100M\n"
18154 " part-disk /dev/sda mbr\n"
18155 " mkfs ext2 /dev/sda1\n"
18160 #: ../fish/guestfish.pod:130
18161 msgid "Start with a prepared disk"
18165 #: ../fish/guestfish.pod:132
18167 "An alternate way to create a 100MB disk called C<test1.img> containing a "
18168 "single ext2-formatted partition:"
18172 #: ../fish/guestfish.pod:135
18175 " guestfish -N fs\n"
18180 #: ../fish/guestfish.pod:137
18181 msgid "To list what is available do:"
18185 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:919
18188 " guestfish -N help | less\n"
18193 #: ../fish/guestfish.pod:141
18194 msgid "Remote control"
18198 #: ../fish/guestfish.pod:143
18201 " eval \"`guestfish --listen`\"\n"
18202 " guestfish --remote add-ro disk.img\n"
18203 " guestfish --remote run\n"
18204 " guestfish --remote lvs\n"
18209 #: ../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
18214 #: ../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
18219 #: ../fish/guestfish.pod:154
18220 msgid "Displays general help on options."
18224 #: ../fish/guestfish.pod:156
18229 #: ../fish/guestfish.pod:158
18230 msgid "B<--cmd-help>"
18234 #: ../fish/guestfish.pod:160
18235 msgid "Lists all available guestfish commands."
18239 #: ../fish/guestfish.pod:162
18244 #: ../fish/guestfish.pod:164
18245 msgid "B<--cmd-help cmd>"
18249 #: ../fish/guestfish.pod:166
18250 msgid "Displays detailed help on a single command C<cmd>."
18254 #: ../fish/guestfish.pod:168
18255 msgid "B<-a image>"
18259 #: ../fish/guestfish.pod:170
18260 msgid "B<--add image>"
18264 #: ../fish/guestfish.pod:172
18265 msgid "Add a block device or virtual machine image to the shell."
18269 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
18271 "The format of the disk image is auto-detected. To override this and force a "
18272 "particular format use the I<--format=..> option."
18276 #: ../fish/guestfish.pod:177
18278 "Using this flag is mostly equivalent to using the C<add> command, with "
18279 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
18280 "the I<--format:...> flag was given."
18284 #: ../fish/guestfish.pod:181
18289 #: ../fish/guestfish.pod:183
18290 msgid "B<--connect URI>"
18294 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
18296 "When used in conjunction with the I<-d> option, this specifies the libvirt "
18297 "URI to use. The default is to use the default libvirt connection."
18301 #: ../fish/guestfish.pod:189
18306 #: ../fish/guestfish.pod:191
18308 "If using the I<--listen> option and a csh-like shell, use this option. See "
18309 "section L</REMOTE CONTROL AND CSH> below."
18313 #: ../fish/guestfish.pod:194
18314 msgid "B<-d libvirt-domain>"
18318 #: ../fish/guestfish.pod:196
18319 msgid "B<--domain libvirt-domain>"
18323 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
18325 "Add disks from the named libvirt domain. If the I<--ro> option is also "
18326 "used, then any libvirt domain can be used. However in write mode, only "
18327 "libvirt domains which are shut down can be named here."
18331 #: ../fish/guestfish.pod:202
18333 "Using this flag is mostly equivalent to using the C<add-domain> command, "
18334 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
18335 "if the I<--format:...> flag was given."
18339 #: ../fish/guestfish.pod:206
18344 #: ../fish/guestfish.pod:208
18345 msgid "B<--no-dest-paths>"
18349 #: ../fish/guestfish.pod:210
18351 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
18352 "to hit the tab key to complete paths on the guest filesystem, but this "
18353 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
18354 "allow this feature to be disabled."
18358 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
18359 msgid "B<--echo-keys>"
18363 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
18365 "When prompting for keys and passphrases, guestfish normally turns echoing "
18366 "off so you cannot see what you are typing. If you are not worried about "
18367 "Tempest attacks and there is no one else in the room you can specify this "
18368 "flag to see what you are typing."
18372 #: ../fish/guestfish.pod:222
18377 #: ../fish/guestfish.pod:224
18378 msgid "B<--file file>"
18382 #: ../fish/guestfish.pod:226
18383 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
18387 #: ../fish/guestfish.pod:229
18390 " #!/usr/bin/guestfish -f\n"
18395 #: ../fish/guestfish.pod:231
18396 msgid "B<--format=raw|qcow2|..>"
18400 #: ../fish/guestfish.pod:233
18401 msgid "B<--format>"
18405 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
18407 "The default for the I<-a> option is to auto-detect the format of the disk "
18408 "image. Using this forces the disk format for I<-a> options which follow on "
18409 "the command line. Using I<--format> with no argument switches back to "
18410 "auto-detection for subsequent I<-a> options."
18414 #: ../fish/guestfish.pod:242
18417 " guestfish --format=raw -a disk.img\n"
18422 #: ../fish/guestfish.pod:244
18423 msgid "forces raw format (no auto-detection) for C<disk.img>."
18427 #: ../fish/guestfish.pod:246
18430 " guestfish --format=raw -a disk.img --format -a another.img\n"
18435 #: ../fish/guestfish.pod:248
18437 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18438 "auto-detection for C<another.img>."
18442 #: ../fish/guestfish.pod:251
18444 "If you have untrusted raw-format guest disk images, you should use this "
18445 "option to specify the disk format. This avoids a possible security problem "
18446 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18450 #: ../fish/guestfish.pod:256
18455 #: ../fish/guestfish.pod:258
18456 msgid "B<--inspector>"
18460 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18462 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18463 "system and mount filesystems as they would be mounted on the real virtual "
18468 #: ../fish/guestfish.pod:264
18469 msgid "Typical usage is either:"
18473 #: ../fish/guestfish.pod:266
18476 " guestfish -d myguest -i\n"
18481 #: ../fish/guestfish.pod:268
18482 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18486 #: ../fish/guestfish.pod:270
18489 " guestfish --ro -d myguest -i\n"
18494 #: ../fish/guestfish.pod:272
18495 msgid "(for active domains, readonly), or specify the block device directly:"
18499 #: ../fish/guestfish.pod:274
18502 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18507 #: ../fish/guestfish.pod:276
18509 "Note that the command line syntax changed slightly over older versions of "
18510 "guestfish. You can still use the old syntax:"
18514 #: ../fish/guestfish.pod:279
18517 " guestfish [--ro] -i disk.img\n"
18522 #: ../fish/guestfish.pod:281
18525 " guestfish [--ro] -i libvirt-domain\n"
18530 #: ../fish/guestfish.pod:283
18532 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
18533 "then using other commands to mount the filesystems that were found."
18537 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
18538 msgid "B<--keys-from-stdin>"
18542 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
18544 "Read key or passphrase parameters from stdin. The default is to try to read "
18545 "passphrases from the user by opening C</dev/tty>."
18549 #: ../fish/guestfish.pod:292
18550 msgid "B<--listen>"
18554 #: ../fish/guestfish.pod:294
18556 "Fork into the background and listen for remote commands. See section "
18557 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18561 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
18566 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
18568 "Connect to a live virtual machine. (Experimental, see "
18569 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
18573 #: ../fish/guestfish.pod:302
18574 msgid "B<-m dev[:mountpoint]>"
18578 #: ../fish/guestfish.pod:304
18579 msgid "B<--mount dev[:mountpoint]>"
18583 #: ../fish/guestfish.pod:306
18584 msgid "Mount the named partition or logical volume on the given mountpoint."
18588 #: ../fish/guestfish.pod:308
18589 msgid "If the mountpoint is omitted, it defaults to C</>."
18593 #: ../fish/guestfish.pod:310
18594 msgid "You have to mount something on C</> before most commands will work."
18598 #: ../fish/guestfish.pod:312
18600 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18605 #: ../fish/guestfish.pod:315
18607 "If you don't know what filesystems a disk image contains, you can either run "
18608 "guestfish without this option, then list the partitions, filesystems and LVs "
18609 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18610 "commands), or you can use the L<virt-filesystems(1)> program."
18614 #: ../fish/guestfish.pod:321
18616 "Using this flag is mostly equivalent to using the C<mount-options> command "
18617 "or the C<mount-ro> command if the I<--ro> flag was given."
18621 #: ../fish/guestfish.pod:324
18626 #: ../fish/guestfish.pod:326
18627 msgid "B<--no-sync>"
18631 #: ../fish/guestfish.pod:328
18633 "Disable autosync. This is enabled by default. See the discussion of "
18634 "autosync in the L<guestfs(3)> manpage."
18638 #: ../fish/guestfish.pod:331
18643 #: ../fish/guestfish.pod:333
18644 msgid "B<--new type>"
18648 #: ../fish/guestfish.pod:335
18653 #: ../fish/guestfish.pod:337
18655 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18656 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18657 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18662 #: ../fish/guestfish.pod:342
18663 msgid "B<--progress-bars>"
18667 #: ../fish/guestfish.pod:344
18668 msgid "Enable progress bars, even when guestfish is used non-interactively."
18672 #: ../fish/guestfish.pod:346
18674 "Progress bars are enabled by default when guestfish is used as an "
18675 "interactive shell."
18679 #: ../fish/guestfish.pod:349
18680 msgid "B<--no-progress-bars>"
18684 #: ../fish/guestfish.pod:351
18685 msgid "Disable progress bars."
18689 #: ../fish/guestfish.pod:353
18690 msgid "B<--remote[=pid]>"
18694 #: ../fish/guestfish.pod:355
18696 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18697 "CONTROL GUESTFISH OVER A SOCKET> below."
18701 #: ../fish/guestfish.pod:358
18706 #: ../fish/guestfish.pod:360
18711 #: ../fish/guestfish.pod:362
18713 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18714 "mounts are done read-only."
18718 #: ../fish/guestfish.pod:365
18720 "The option must always be used if the disk image or virtual machine might be "
18721 "running, and is generally recommended in cases where you don't need write "
18722 "access to the disk."
18726 #: ../fish/guestfish.pod:369
18728 "Note that prepared disk images created with I<-N> are not affected by this "
18729 "option. Also commands like C<add> are not affected - you have to specify "
18730 "the C<readonly:true> option explicitly if you need it."
18734 #: ../fish/guestfish.pod:373
18735 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18739 #: ../fish/guestfish.pod:375 ../fuse/guestmount.pod:213
18740 msgid "B<--selinux>"
18744 #: ../fish/guestfish.pod:377
18745 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18749 #: ../fish/guestfish.pod:379
18754 #: ../fish/guestfish.pod:381
18755 msgid "B<--verbose>"
18759 #: ../fish/guestfish.pod:383
18761 "Enable very verbose messages. This is particularly useful if you find a "
18766 #: ../fish/guestfish.pod:386
18771 #: ../fish/guestfish.pod:388 ../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
18772 msgid "B<--version>"
18776 #: ../fish/guestfish.pod:390
18777 msgid "Display the guestfish / libguestfs version number and exit."
18781 #: ../fish/guestfish.pod:392
18786 #: ../fish/guestfish.pod:394
18791 #: ../fish/guestfish.pod:396
18793 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
18798 #: ../fish/guestfish.pod:399
18803 #: ../fish/guestfish.pod:401
18804 msgid "Echo each command before executing it."
18808 #: ../fish/guestfish.pod:405
18809 msgid "COMMANDS ON COMMAND LINE"
18813 #: ../fish/guestfish.pod:407
18814 msgid "Any additional (non-option) arguments are treated as commands to execute."
18818 #: ../fish/guestfish.pod:410
18820 "Commands to execute should be separated by a colon (C<:>), where the colon "
18821 "is a separate parameter. Thus:"
18825 #: ../fish/guestfish.pod:413
18828 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18833 #: ../fish/guestfish.pod:415
18835 "If there are no additional arguments, then we enter a shell, either an "
18836 "interactive shell with a prompt (if the input is a terminal) or a "
18837 "non-interactive shell."
18841 #: ../fish/guestfish.pod:419
18843 "In either command line mode or non-interactive shell, the first command that "
18844 "gives an error causes the whole shell to exit. In interactive mode (with a "
18845 "prompt) if a command fails, you can continue to enter commands."
18849 #: ../fish/guestfish.pod:424
18850 msgid "USING launch (OR run)"
18854 #: ../fish/guestfish.pod:426
18856 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18857 "then launch it, then mount any disks you need, and finally issue "
18858 "actions/commands. So the general order of the day is:"
18862 #: ../fish/guestfish.pod:434
18863 msgid "add or -a/--add"
18867 #: ../fish/guestfish.pod:438
18868 msgid "launch (aka run)"
18872 #: ../fish/guestfish.pod:442
18873 msgid "mount or -m/--mount"
18877 #: ../fish/guestfish.pod:446
18878 msgid "any other commands"
18882 #: ../fish/guestfish.pod:450
18884 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18885 "guest before mounting or performing any other commands."
18889 #: ../fish/guestfish.pod:453
18891 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18892 "I<--new> options were given then C<run> is done automatically, simply "
18893 "because guestfish can't perform the action you asked for without doing this."
18897 #: ../fish/guestfish.pod:458
18898 msgid "OPENING DISKS FOR READ AND WRITE"
18902 #: ../fish/guestfish.pod:460
18904 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
18905 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
18906 "open disk images read-only or for writing."
18910 #: ../fish/guestfish.pod:464
18912 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
18913 "disk images supplied on the command line for write. To open a disk image "
18914 "read-only you have to do I<-a image --ro>."
18918 #: ../fish/guestfish.pod:468
18920 "This matters: If you accidentally open a live VM disk image writable then "
18921 "you will cause irreversible disk corruption."
18925 #: ../fish/guestfish.pod:471
18927 "By libguestfs 1.10 we intend to change the default the other way. Disk "
18928 "images will be opened read-only. You will have to either specify "
18929 "I<guestfish --rw> or change a configuration file in order to get write "
18930 "access for disk images specified by those other command line options."
18934 #: ../fish/guestfish.pod:476
18936 "This version of guestfish has a I<--rw> option which does nothing (it is "
18937 "already the default). However it is highly recommended that you use this "
18938 "option to indicate that guestfish needs write access, and to prepare your "
18939 "scripts for the day when this option will be required for write access."
18943 #: ../fish/guestfish.pod:482
18945 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18946 "other libguestfs program apart from guestfish and guestmount."
18950 #: ../fish/guestfish.pod:485
18955 #: ../fish/guestfish.pod:487
18957 "You can quote ordinary parameters using either single or double quotes. For "
18962 #: ../fish/guestfish.pod:490
18965 " add \"file with a space.img\"\n"
18970 #: ../fish/guestfish.pod:492
18973 " rm '/file name'\n"
18978 #: ../fish/guestfish.pod:494
18986 #: ../fish/guestfish.pod:496
18988 "A few commands require a list of strings to be passed. For these, use a "
18989 "whitespace-separated list, enclosed in quotes. Strings containing "
18990 "whitespace to be passed through must be enclosed in single quotes. A "
18991 "literal single quote must be escaped with a backslash."
18995 #: ../fish/guestfish.pod:501
18998 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18999 " command \"/bin/echo 'foo bar'\"\n"
19000 " command \"/bin/echo \\'foo\\'\"\n"
19005 #: ../fish/guestfish.pod:505
19006 msgid "OPTIONAL ARGUMENTS"
19010 #: ../fish/guestfish.pod:507
19012 "Some commands take optional arguments. These arguments appear in this "
19013 "documentation as C<[argname:..]>. You can use them as in these examples:"
19017 #: ../fish/guestfish.pod:511
19020 " add-drive-opts filename\n"
19025 #: ../fish/guestfish.pod:513
19028 " add-drive-opts filename readonly:true\n"
19033 #: ../fish/guestfish.pod:515
19036 " add-drive-opts filename format:qcow2 readonly:false\n"
19041 #: ../fish/guestfish.pod:517
19043 "Each optional argument can appear at most once. All optional arguments must "
19044 "appear after the required ones."
19048 #: ../fish/guestfish.pod:520
19053 #: ../fish/guestfish.pod:522
19054 msgid "This section applies to all commands which can take integers as parameters."
19058 #: ../fish/guestfish.pod:525
19059 msgid "SIZE SUFFIX"
19063 #: ../fish/guestfish.pod:527
19065 "When the command takes a parameter measured in bytes, you can use one of the "
19066 "following suffixes to specify kilobytes, megabytes and larger sizes:"
19070 #: ../fish/guestfish.pod:533
19071 msgid "B<k> or B<K> or B<KiB>"
19075 #: ../fish/guestfish.pod:535
19076 msgid "The size in kilobytes (multiplied by 1024)."
19080 #: ../fish/guestfish.pod:537
19085 #: ../fish/guestfish.pod:539
19086 msgid "The size in SI 1000 byte units."
19090 #: ../fish/guestfish.pod:541
19091 msgid "B<M> or B<MiB>"
19095 #: ../fish/guestfish.pod:543
19096 msgid "The size in megabytes (multiplied by 1048576)."
19100 #: ../fish/guestfish.pod:545
19105 #: ../fish/guestfish.pod:547
19106 msgid "The size in SI 1000000 byte units."
19110 #: ../fish/guestfish.pod:549
19111 msgid "B<G> or B<GiB>"
19115 #: ../fish/guestfish.pod:551
19116 msgid "The size in gigabytes (multiplied by 2**30)."
19120 #: ../fish/guestfish.pod:553
19125 #: ../fish/guestfish.pod:555
19126 msgid "The size in SI 10**9 byte units."
19130 #: ../fish/guestfish.pod:557
19131 msgid "B<T> or B<TiB>"
19135 #: ../fish/guestfish.pod:559
19136 msgid "The size in terabytes (multiplied by 2**40)."
19140 #: ../fish/guestfish.pod:561
19145 #: ../fish/guestfish.pod:563
19146 msgid "The size in SI 10**12 byte units."
19150 #: ../fish/guestfish.pod:565
19151 msgid "B<P> or B<PiB>"
19155 #: ../fish/guestfish.pod:567
19156 msgid "The size in petabytes (multiplied by 2**50)."
19160 #: ../fish/guestfish.pod:569
19165 #: ../fish/guestfish.pod:571
19166 msgid "The size in SI 10**15 byte units."
19170 #: ../fish/guestfish.pod:573
19171 msgid "B<E> or B<EiB>"
19175 #: ../fish/guestfish.pod:575
19176 msgid "The size in exabytes (multiplied by 2**60)."
19180 #: ../fish/guestfish.pod:577
19185 #: ../fish/guestfish.pod:579
19186 msgid "The size in SI 10**18 byte units."
19190 #: ../fish/guestfish.pod:581
19191 msgid "B<Z> or B<ZiB>"
19195 #: ../fish/guestfish.pod:583
19196 msgid "The size in zettabytes (multiplied by 2**70)."
19200 #: ../fish/guestfish.pod:585
19205 #: ../fish/guestfish.pod:587
19206 msgid "The size in SI 10**21 byte units."
19210 #: ../fish/guestfish.pod:589
19211 msgid "B<Y> or B<YiB>"
19215 #: ../fish/guestfish.pod:591
19216 msgid "The size in yottabytes (multiplied by 2**80)."
19220 #: ../fish/guestfish.pod:593
19225 #: ../fish/guestfish.pod:595
19226 msgid "The size in SI 10**24 byte units."
19230 #: ../fish/guestfish.pod:601
19233 " truncate-size /file 1G\n"
19238 #: ../fish/guestfish.pod:603
19239 msgid "would truncate the file to 1 gigabyte."
19243 #: ../fish/guestfish.pod:605
19245 "Be careful because a few commands take sizes in kilobytes or megabytes "
19246 "(eg. the parameter to L</memsize> is specified in megabytes already). "
19247 "Adding a suffix will probably not do what you expect."
19251 #: ../fish/guestfish.pod:609
19252 msgid "OCTAL AND HEXADECIMAL NUMBERS"
19256 #: ../fish/guestfish.pod:611
19258 "For specifying the radix (base) use the C convention: C<0> to prefix an "
19259 "octal number or C<0x> to prefix a hexadecimal number. For example:"
19263 #: ../fish/guestfish.pod:614
19266 " 1234 decimal number 1234\n"
19267 " 02322 octal number, equivalent to decimal 1234\n"
19268 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
19273 #: ../fish/guestfish.pod:618
19275 "When using the C<chmod> command, you almost always want to specify an octal "
19276 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
19277 "L<chmod(1)> program):"
19281 #: ../fish/guestfish.pod:622
19284 " chmod 0777 /public # OK\n"
19285 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
19290 #: ../fish/guestfish.pod:625
19292 "Commands that return numbers usually print them in decimal, but some "
19293 "commands print numbers in other radices (eg. C<umask> prints the mode in "
19294 "octal, preceeded by C<0>)."
19298 #: ../fish/guestfish.pod:629
19299 msgid "WILDCARDS AND GLOBBING"
19303 #: ../fish/guestfish.pod:631
19305 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
19306 "(globbing) by default. So for example the following will not do what you "
19311 #: ../fish/guestfish.pod:635
19319 #: ../fish/guestfish.pod:637
19321 "Assuming you don't have a directory called literally C</home/*> then the "
19322 "above command will return an error."
19326 #: ../fish/guestfish.pod:640
19327 msgid "To perform wildcard expansion, use the C<glob> command."
19331 #: ../fish/guestfish.pod:642
19334 " glob rm-rf /home/*\n"
19339 #: ../fish/guestfish.pod:644
19341 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
19342 "many times), equivalent to:"
19346 #: ../fish/guestfish.pod:647
19349 " rm-rf /home/jim\n"
19350 " rm-rf /home/joe\n"
19351 " rm-rf /home/mary\n"
19356 #: ../fish/guestfish.pod:651
19357 msgid "C<glob> only works on simple guest paths and not on device names."
19361 #: ../fish/guestfish.pod:653
19363 "If you have several parameters, each containing a wildcard, then glob will "
19364 "perform a Cartesian product."
19368 #: ../fish/guestfish.pod:656
19373 #: ../fish/guestfish.pod:658
19375 "Any line which starts with a I<#> character is treated as a comment and "
19376 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
19377 "a command. For example:"
19381 #: ../fish/guestfish.pod:662
19384 " # this is a comment\n"
19385 " # this is a comment\n"
19386 " foo # NOT a comment\n"
19391 #: ../fish/guestfish.pod:666
19392 msgid "Blank lines are also ignored."
19396 #: ../fish/guestfish.pod:668
19397 msgid "RUNNING COMMANDS LOCALLY"
19401 #: ../fish/guestfish.pod:670
19403 "Any line which starts with a I<!> character is treated as a command sent to "
19404 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
19408 #: ../fish/guestfish.pod:674
19412 " tgz-out /remote local/remote-data.tar.gz\n"
19417 #: ../fish/guestfish.pod:677
19419 "will create a directory C<local> on the host, and then export the contents "
19420 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
19421 "(See C<tgz-out>)."
19425 #: ../fish/guestfish.pod:681
19427 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
19428 "effect, due to the way that subprocesses work in Unix."
19432 #: ../fish/guestfish.pod:684
19433 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
19437 #: ../fish/guestfish.pod:686
19439 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
19440 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
19441 "and executed as guestfish commands."
19445 #: ../fish/guestfish.pod:690
19447 "Thus you can use shell script to construct arbitrary guestfish commands "
19448 "which are then parsed by guestfish."
19452 #: ../fish/guestfish.pod:693
19454 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
19455 "through C</foo.100>) using guestfish commands alone. However this is simple "
19456 "if we use a shell script to create the guestfish commands for us:"
19460 #: ../fish/guestfish.pod:698
19463 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
19468 #: ../fish/guestfish.pod:700
19469 msgid "or with names like C</foo.001>:"
19473 #: ../fish/guestfish.pod:702
19476 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
19481 #: ../fish/guestfish.pod:704
19483 "When using guestfish interactively it can be helpful to just run the shell "
19484 "script first (ie. remove the initial C<E<lt>> character so it is just an "
19485 "ordinary I<!> local command), see what guestfish commands it would run, and "
19486 "when you are happy with those prepend the C<E<lt>> character to run the "
19487 "guestfish commands for real."
19491 #: ../fish/guestfish.pod:710
19496 #: ../fish/guestfish.pod:712
19498 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19499 "command (a guestfish command) to the second command (any host command). For "
19504 #: ../fish/guestfish.pod:716
19507 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19512 #: ../fish/guestfish.pod:718
19514 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19515 "program). The above command would list all accounts in the guest filesystem "
19516 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19520 #: ../fish/guestfish.pod:723
19523 " hexdump /bin/ls | head\n"
19524 " list-devices | tail -1\n"
19525 " tgz-out / - | tar ztf -\n"
19530 #: ../fish/guestfish.pod:727
19532 "The space before the pipe symbol is required, any space after the pipe "
19533 "symbol is optional. Everything after the pipe symbol is just passed "
19534 "straight to the host shell, so it can contain redirections, globs and "
19535 "anything else that makes sense on the host side."
19539 #: ../fish/guestfish.pod:732
19541 "To use a literal argument which begins with a pipe symbol, you have to quote "
19546 #: ../fish/guestfish.pod:735
19554 #: ../fish/guestfish.pod:737
19555 msgid "HOME DIRECTORIES"
19559 #: ../fish/guestfish.pod:739
19561 "If a parameter starts with the character C<~> then the tilde may be expanded "
19562 "as a home directory path (either C<~> for the current user's home directory, "
19563 "or C<~user> for another user)."
19567 #: ../fish/guestfish.pod:743
19569 "Note that home directory expansion happens for users known I<on the host>, "
19570 "not in the guest filesystem."
19574 #: ../fish/guestfish.pod:746
19576 "To use a literal argument which begins with a tilde, you have to quote it, "
19581 #: ../fish/guestfish.pod:749
19589 #: ../fish/guestfish.pod:753
19591 "Libguestfs has some support for Linux guests encrypted according to the "
19592 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19593 "disk encryption systems used by modern Linux guests. Currently only "
19594 "LVM-on-LUKS is supported."
19598 #: ../fish/guestfish.pod:758
19599 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19603 #: ../fish/guestfish.pod:760
19606 " ><fs> vfs-type /dev/sda2\n"
19612 #: ../fish/guestfish.pod:763
19614 "Then open those devices using L</luks-open>. This creates a device-mapper "
19615 "device called C</dev/mapper/luksdev>."
19619 #: ../fish/guestfish.pod:766
19622 " ><fs> luks-open /dev/sda2 luksdev\n"
19623 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19628 #: ../fish/guestfish.pod:769
19630 "Finally you have to tell LVM to scan for volume groups on the newly created "
19635 #: ../fish/guestfish.pod:772
19639 " vg-activate-all true\n"
19644 #: ../fish/guestfish.pod:775
19645 msgid "The logical volume(s) can now be mounted in the usual way."
19649 #: ../fish/guestfish.pod:777
19651 "Before closing a LUKS device you must unmount any logical volumes on it and "
19652 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19653 "one. Then you can close the mapper device:"
19657 #: ../fish/guestfish.pod:781
19660 " vg-activate false /dev/VG\n"
19661 " luks-close /dev/mapper/luksdev\n"
19666 #: ../fish/guestfish.pod:784
19667 msgid "WINDOWS PATHS"
19671 #: ../fish/guestfish.pod:786
19673 "If a path is prefixed with C<win:> then you can use Windows-style paths "
19674 "(with some limitations). The following commands are equivalent:"
19678 #: ../fish/guestfish.pod:789
19681 " file /WINDOWS/system32/config/system.LOG\n"
19686 #: ../fish/guestfish.pod:791
19689 " file win:/windows/system32/config/system.log\n"
19694 #: ../fish/guestfish.pod:793
19697 " file win:\\windows\\system32\\config\\system.log\n"
19702 #: ../fish/guestfish.pod:795
19705 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
19710 #: ../fish/guestfish.pod:797
19712 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
19713 "handles case insensitivity like Windows would. This only works in argument "
19714 "positions that expect a path."
19718 #: ../fish/guestfish.pod:801
19719 msgid "UPLOADING AND DOWNLOADING FILES"
19723 #: ../fish/guestfish.pod:803
19725 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19726 "others which upload from or download to a local file, you can use the "
19727 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19731 #: ../fish/guestfish.pod:807
19739 #: ../fish/guestfish.pod:809
19740 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19744 #: ../fish/guestfish.pod:812
19747 " tar-out /etc - | tar tf -\n"
19752 #: ../fish/guestfish.pod:814
19754 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19755 "command (see L</PIPES>)."
19759 #: ../fish/guestfish.pod:817
19761 "When using C<-> to read from stdin, the input is read up to the end of "
19762 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19763 "some arbitrary end marker:"
19767 #: ../fish/guestfish.pod:821
19770 " upload -<<END /foo\n"
19779 #: ../fish/guestfish.pod:827
19781 "Any string of characters can be used instead of C<END>. The end marker must "
19782 "appear on a line of its own, without any preceeding or following characters "
19783 "(not even spaces)."
19787 #: ../fish/guestfish.pod:831
19789 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19790 "upload local files (so-called \"FileIn\" parameters in the generator)."
19794 #: ../fish/guestfish.pod:834
19795 msgid "EXIT ON ERROR BEHAVIOUR"
19799 #: ../fish/guestfish.pod:836
19801 "By default, guestfish will ignore any errors when in interactive mode "
19802 "(ie. taking commands from a human over a tty), and will exit on the first "
19803 "error in non-interactive mode (scripts, commands given on the command line)."
19807 #: ../fish/guestfish.pod:841
19809 "If you prefix a command with a I<-> character, then that command will not "
19810 "cause guestfish to exit, even if that (one) command returns an error."
19814 #: ../fish/guestfish.pod:845
19815 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19819 #: ../fish/guestfish.pod:847
19821 "Guestfish can be remote-controlled over a socket. This is useful "
19822 "particularly in shell scripts where you want to make several different "
19823 "changes to a filesystem, but you don't want the overhead of starting up a "
19824 "guestfish process each time."
19828 #: ../fish/guestfish.pod:852
19829 msgid "Start a guestfish server process using:"
19833 #: ../fish/guestfish.pod:854
19836 " eval \"`guestfish --listen`\"\n"
19841 #: ../fish/guestfish.pod:856
19842 msgid "and then send it commands by doing:"
19846 #: ../fish/guestfish.pod:858
19849 " guestfish --remote cmd [...]\n"
19854 #: ../fish/guestfish.pod:860
19855 msgid "To cause the server to exit, send it the exit command:"
19859 #: ../fish/guestfish.pod:862
19862 " guestfish --remote exit\n"
19867 #: ../fish/guestfish.pod:864
19869 "Note that the server will normally exit if there is an error in a command. "
19870 "You can change this in the usual way. See section L</EXIT ON ERROR "
19875 #: ../fish/guestfish.pod:868
19876 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19880 #: ../fish/guestfish.pod:870
19882 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19883 "is how the I<--remote> option knows where to send the commands. You can "
19884 "have several guestfish listener processes running using:"
19888 #: ../fish/guestfish.pod:874
19891 " eval \"`guestfish --listen`\"\n"
19892 " pid1=$GUESTFISH_PID\n"
19893 " eval \"`guestfish --listen`\"\n"
19894 " pid2=$GUESTFISH_PID\n"
19896 " guestfish --remote=$pid1 cmd\n"
19897 " guestfish --remote=$pid2 cmd\n"
19902 #: ../fish/guestfish.pod:882
19903 msgid "REMOTE CONTROL AND CSH"
19907 #: ../fish/guestfish.pod:884
19909 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19914 #: ../fish/guestfish.pod:887
19917 " eval \"`guestfish --listen --csh`\"\n"
19922 #: ../fish/guestfish.pod:889
19923 msgid "REMOTE CONTROL DETAILS"
19927 #: ../fish/guestfish.pod:891
19929 "Remote control happens over a Unix domain socket called "
19930 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19931 "of the process, and C<$PID> is the process ID of the server."
19935 #: ../fish/guestfish.pod:895
19936 msgid "Guestfish client and server versions must match exactly."
19940 #: ../fish/guestfish.pod:897
19941 msgid "PREPARED DISK IMAGES"
19945 #: ../fish/guestfish.pod:899
19947 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19948 "preformatted disk images that guestfish can make for you to save typing. "
19949 "This is particularly useful for testing purposes. This option is used "
19950 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19951 "can be mixed with I<-a>)."
19955 #: ../fish/guestfish.pod:905
19957 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19958 "the second and so on. Existing files in the current directory are "
19963 #: ../fish/guestfish.pod:909
19965 "The type briefly describes how the disk should be sized, partitioned, how "
19966 "filesystem(s) should be created, and how content should be added. "
19967 "Optionally the type can be followed by extra parameters, separated by C<:> "
19968 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19969 "sparsely-allocated disk, containing a single partition, with the partition "
19970 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19971 "on a 1GB disk instead."
19975 #: ../fish/guestfish.pod:917
19976 msgid "To list the available types and any extra parameters they take, run:"
19980 #: ../fish/guestfish.pod:921
19982 "Note that the prepared filesystem is not mounted. You would usually have to "
19983 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19987 #: ../fish/guestfish.pod:925
19989 "If any I<-N> or I<--new> options are given, the guest is automatically "
19994 #: ../fish/guestfish.pod:930
19995 msgid "Create a 100MB disk with an ext4-formatted partition:"
19999 #: ../fish/guestfish.pod:932
20002 " guestfish -N fs:ext4\n"
20007 #: ../fish/guestfish.pod:934
20008 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
20012 #: ../fish/guestfish.pod:936
20015 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
20020 #: ../fish/guestfish.pod:938
20021 msgid "Create a blank 200MB disk:"
20025 #: ../fish/guestfish.pod:940
20028 " guestfish -N disk:200M\n"
20033 #: ../fish/guestfish.pod:942
20034 msgid "PROGRESS BARS"
20038 #: ../fish/guestfish.pod:944
20040 "Some (not all) long-running commands send progress notification messages as "
20041 "they are running. Guestfish turns these messages into progress bars."
20045 #: ../fish/guestfish.pod:948
20047 "When a command that supports progress bars takes longer than two seconds to "
20048 "run, and if progress bars are enabled, then you will see one appearing below "
20053 #: ../fish/guestfish.pod:952
20056 " ><fs> copy-size /large-file /another-file 2048M\n"
20057 " / 10% [#####-----------------------------------------] 00:30\n"
20062 #: ../fish/guestfish.pod:955
20064 "The spinner on the left hand side moves round once for every progress "
20065 "notification received from the backend. This is a (reasonably) golden "
20066 "assurance that the command is \"doing something\" even if the progress bar "
20067 "is not moving, because the command is able to send the progress "
20068 "notifications. When the bar reaches 100% and the command finishes, the "
20069 "spinner disappears."
20073 #: ../fish/guestfish.pod:962
20075 "Progress bars are enabled by default when guestfish is used interactively. "
20076 "You can enable them even for non-interactive modes using I<--progress-bars>, "
20077 "and you can disable them completely using I<--no-progress-bars>."
20081 #: ../fish/guestfish.pod:967
20082 msgid "GUESTFISH COMMANDS"
20086 #: ../fish/guestfish.pod:969
20088 "The commands in this section are guestfish convenience commands, in other "
20089 "words, they are not part of the L<guestfs(3)> API."
20093 #: ../fish/guestfish.pod:972
20098 #: ../fish/guestfish.pod:974
20107 #: ../fish/guestfish.pod:977
20108 msgid "Without any parameter, this provides general help."
20112 #: ../fish/guestfish.pod:979
20113 msgid "With a C<cmd> parameter, this displays detailed help for that command."
20117 #: ../fish/guestfish.pod:981
20118 msgid "quit | exit"
20122 #: ../fish/guestfish.pod:983
20123 msgid "This exits guestfish. You can also use C<^D> key."
20127 #: ../fish/guestfish.pod:985
20128 msgid "@FISH_COMMANDS@"
20132 #: ../fish/guestfish.pod:987
20137 #: ../fish/guestfish.pod:991 ../test-tool/libguestfs-test-tool.pod:83
20142 #: ../fish/guestfish.pod:993
20144 "guestfish returns 0 if the commands completed without error, or 1 if there "
20149 #: ../fish/guestfish.pod:1000
20154 #: ../fish/guestfish.pod:1002
20156 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
20161 #: ../fish/guestfish.pod:1005
20162 msgid "GUESTFISH_PID"
20166 #: ../fish/guestfish.pod:1007
20168 "Used with the I<--remote> option to specify the remote guestfish process to "
20169 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
20173 #: ../fish/guestfish.pod:1011
20178 #: ../fish/guestfish.pod:1013
20180 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
20181 "not specified, the external L<hexedit(1)> program is used."
20185 #: ../fish/guestfish.pod:1017
20190 #: ../fish/guestfish.pod:1019
20192 "If compiled with GNU readline support, various files in the home directory "
20193 "can be used. See L</FILES>."
20197 #: ../fish/guestfish.pod:1028
20199 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
20200 "effect as using the B<-v> option."
20204 #: ../fish/guestfish.pod:1040
20206 "Set the path that guestfish uses to search for kernel and initrd.img. See "
20207 "the discussion of paths in L<guestfs(3)>."
20211 #: ../fish/guestfish.pod:1051
20212 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
20216 #: ../fish/guestfish.pod:1053
20221 #: ../fish/guestfish.pod:1055
20223 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
20228 #: ../fish/guestfish.pod:1071 ../test-tool/libguestfs-test-tool.pod:88
20233 #: ../fish/guestfish.pod:1075
20234 msgid "$HOME/.guestfish"
20238 #: ../fish/guestfish.pod:1077
20240 "If compiled with GNU readline support, then the command history is saved in "
20245 #: ../fish/guestfish.pod:1080
20246 msgid "$HOME/.inputrc"
20250 #: ../fish/guestfish.pod:1082
20251 msgid "/etc/inputrc"
20255 #: ../fish/guestfish.pod:1084
20257 "If compiled with GNU readline support, then these files can be used to "
20258 "configure readline. For further information, please see "
20259 "L<readline(3)/INITIALIZATION FILE>."
20263 #: ../fish/guestfish.pod:1088
20264 msgid "To write rules which only apply to guestfish, use:"
20268 #: ../fish/guestfish.pod:1090
20278 #: ../fish/guestfish.pod:1094
20280 "Variables that you can set in inputrc that change the behaviour of guestfish "
20281 "in useful ways include:"
20285 #: ../fish/guestfish.pod:1099
20286 msgid "completion-ignore-case (default: on)"
20290 #: ../fish/guestfish.pod:1101
20292 "By default, guestfish will ignore case when tab-completing paths on the "
20297 #: ../fish/guestfish.pod:1104
20300 " set completion-ignore-case off\n"
20305 #: ../fish/guestfish.pod:1106
20306 msgid "to make guestfish case sensitive."
20310 #: ../fish/guestfish.pod:1110
20315 #: ../fish/guestfish.pod:1112
20316 msgid "test2.img (etc)"
20320 #: ../fish/guestfish.pod:1114
20322 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
20323 "will be created in the file C<test1.img> in the current directory. The "
20324 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
20325 "the same name will be overwritten."
20329 #: ../fish/guestfish.pod:1123
20331 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
20332 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
20333 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
20334 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
20335 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
20336 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
20340 #: ../fish/guestfish.pod:1153 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:258 ../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:572 ../tools/virt-list-partitions.pl:277
20342 "This program is free software; you can redistribute it and/or modify it "
20343 "under the terms of the GNU General Public License as published by the Free "
20344 "Software Foundation; either version 2 of the License, or (at your option) "
20345 "any later version."
20349 #: ../fish/guestfish.pod:1158 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:263 ../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:577 ../tools/virt-list-partitions.pl:282
20351 "This program is distributed in the hope that it will be useful, but WITHOUT "
20352 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
20353 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
20358 #: ../fish/guestfish.pod:1163 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:268 ../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:582 ../tools/virt-list-partitions.pl:287
20360 "You should have received a copy of the GNU General Public License along with "
20361 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
20362 "Ave, Cambridge, MA 02139, USA."
20366 #: ../fish/guestfish-actions.pod:1
20371 #: ../fish/guestfish-actions.pod:3
20374 " add-cdrom filename\n"
20379 #: ../fish/guestfish-actions.pod:15
20381 "This call checks for the existence of C<filename>. This stops you from "
20382 "specifying other types of drive which are supported by qemu such as C<nbd:> "
20383 "and C<http:> URLs. To specify those, use the general L</config> call "
20388 #: ../fish/guestfish-actions.pod:22
20390 "If you just want to add an ISO file (often you use this as an efficient way "
20391 "to transfer large files into the guest), then you should probably use "
20392 "L</add-drive-ro> instead."
20396 #: ../fish/guestfish-actions.pod:35
20401 #: ../fish/guestfish-actions.pod:37
20406 #: ../fish/guestfish-actions.pod:39
20409 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
20414 #: ../fish/guestfish-actions.pod:41
20416 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
20417 "It works by connecting to libvirt, requesting the domain and domain XML from "
20418 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
20422 #: ../fish/guestfish-actions.pod:71
20424 "The other optional parameters are passed directly through to "
20425 "L</add-drive-opts>."
20429 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138 ../fish/guestfish-actions.pod:2947
20431 "This command has one or more optional arguments. See L</OPTIONAL "
20436 #: ../fish/guestfish-actions.pod:76
20441 #: ../fish/guestfish-actions.pod:78
20444 " add-drive filename\n"
20449 #: ../fish/guestfish-actions.pod:80
20451 "This function is the equivalent of calling L</add-drive-opts> with no "
20452 "optional parameters, so the disk is added writable, with the format being "
20453 "detected automatically."
20457 #: ../fish/guestfish-actions.pod:84
20459 "Automatic detection of the format opens you up to a potential security hole "
20460 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
20461 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
20462 "you should think about replacing calls to this function with calls to "
20463 "L</add-drive-opts>, and specifying the format."
20467 #: ../fish/guestfish-actions.pod:91
20468 msgid "add-drive-opts"
20472 #: ../fish/guestfish-actions.pod:93
20477 #: ../fish/guestfish-actions.pod:95
20480 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
20485 #: ../fish/guestfish-actions.pod:122
20487 "This forces the image format. If you omit this (or use L</add-drive> or "
20488 "L</add-drive-ro>) then the format is automatically detected. Possible "
20489 "formats include C<raw> and C<qcow2>."
20493 #: ../fish/guestfish-actions.pod:133
20495 "This rarely-used option lets you emulate the behaviour of the deprecated "
20496 "L</add-drive-with-if> call (q.v.)"
20500 #: ../fish/guestfish-actions.pod:140
20501 msgid "add-drive-ro"
20505 #: ../fish/guestfish-actions.pod:142
20510 #: ../fish/guestfish-actions.pod:144
20513 " add-drive-ro filename\n"
20518 #: ../fish/guestfish-actions.pod:146
20520 "This function is the equivalent of calling L</add-drive-opts> with the "
20521 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20522 "is added read-only, with the format being detected automatically."
20526 #: ../fish/guestfish-actions.pod:151
20527 msgid "add-drive-ro-with-if"
20531 #: ../fish/guestfish-actions.pod:153
20534 " add-drive-ro-with-if filename iface\n"
20539 #: ../fish/guestfish-actions.pod:155
20541 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
20542 "interface emulation to use at run time."
20546 #: ../fish/guestfish-actions.pod:165
20547 msgid "add-drive-with-if"
20551 #: ../fish/guestfish-actions.pod:167
20554 " add-drive-with-if filename iface\n"
20559 #: ../fish/guestfish-actions.pod:169
20561 "This is the same as L</add-drive> but it allows you to specify the QEMU "
20562 "interface emulation to use at run time."
20566 #: ../fish/guestfish-actions.pod:179
20571 #: ../fish/guestfish-actions.pod:181
20574 " aug-clear augpath\n"
20579 #: ../fish/guestfish-actions.pod:186
20584 #: ../fish/guestfish-actions.pod:188
20592 #: ../fish/guestfish-actions.pod:190
20594 "Close the current Augeas handle and free up any resources used by it. After "
20595 "calling this, you have to call L</aug-init> again before you can use any "
20596 "other Augeas functions."
20600 #: ../fish/guestfish-actions.pod:195
20601 msgid "aug-defnode"
20605 #: ../fish/guestfish-actions.pod:197
20608 " aug-defnode name expr val\n"
20613 #: ../fish/guestfish-actions.pod:202
20615 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
20616 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
20617 "containing that single node."
20621 #: ../fish/guestfish-actions.pod:210
20626 #: ../fish/guestfish-actions.pod:212
20629 " aug-defvar name expr\n"
20634 #: ../fish/guestfish-actions.pod:221
20639 #: ../fish/guestfish-actions.pod:223
20642 " aug-get augpath\n"
20647 #: ../fish/guestfish-actions.pod:228
20652 #: ../fish/guestfish-actions.pod:230
20655 " aug-init root flags\n"
20660 #: ../fish/guestfish-actions.pod:236
20661 msgid "You must call this before using any other L</aug-*> commands."
20665 #: ../fish/guestfish-actions.pod:271
20666 msgid "Do not load the tree in L</aug-init>."
20670 #: ../fish/guestfish-actions.pod:275
20671 msgid "To close the handle, you can call L</aug-close>."
20675 #: ../fish/guestfish-actions.pod:279
20680 #: ../fish/guestfish-actions.pod:281
20683 " aug-insert augpath label true|false\n"
20688 #: ../fish/guestfish-actions.pod:291
20693 #: ../fish/guestfish-actions.pod:293
20701 #: ../fish/guestfish-actions.pod:300
20706 #: ../fish/guestfish-actions.pod:302
20709 " aug-ls augpath\n"
20714 #: ../fish/guestfish-actions.pod:304
20716 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
20717 "resulting nodes into alphabetical order."
20721 #: ../fish/guestfish-actions.pod:307
20726 #: ../fish/guestfish-actions.pod:309
20729 " aug-match augpath\n"
20734 #: ../fish/guestfish-actions.pod:315
20739 #: ../fish/guestfish-actions.pod:317
20742 " aug-mv src dest\n"
20747 #: ../fish/guestfish-actions.pod:322
20752 #: ../fish/guestfish-actions.pod:324
20755 " aug-rm augpath\n"
20760 #: ../fish/guestfish-actions.pod:330
20765 #: ../fish/guestfish-actions.pod:332
20773 #: ../fish/guestfish-actions.pod:336
20775 "The flags which were passed to L</aug-init> affect exactly how files are "
20780 #: ../fish/guestfish-actions.pod:339
20785 #: ../fish/guestfish-actions.pod:341
20788 " aug-set augpath val\n"
20793 #: ../fish/guestfish-actions.pod:345
20795 "In the Augeas API, it is possible to clear a node by setting the value to "
20796 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
20797 "this call. Instead you must use the L</aug-clear> call."
20801 #: ../fish/guestfish-actions.pod:350
20806 #: ../fish/guestfish-actions.pod:352
20809 " available 'groups ...'\n"
20814 #: ../fish/guestfish-actions.pod:358
20816 "The libguestfs groups, and the functions that those groups correspond to, "
20817 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
20818 "runtime by calling L</available-all-groups>."
20822 #: ../fish/guestfish-actions.pod:382
20823 msgid "You must call L</launch> before calling this function."
20827 #: ../fish/guestfish-actions.pod:404
20829 "This call was added in version C<1.0.80>. In previous versions of "
20830 "libguestfs all you could do would be to speculatively execute a command to "
20831 "find out if the daemon implemented it. See also L</version>."
20835 #: ../fish/guestfish-actions.pod:411
20836 msgid "available-all-groups"
20840 #: ../fish/guestfish-actions.pod:413
20843 " available-all-groups\n"
20848 #: ../fish/guestfish-actions.pod:415
20850 "This command returns a list of all optional groups that this daemon knows "
20851 "about. Note this returns both supported and unsupported groups. To find "
20852 "out which ones the daemon can actually support you have to call "
20853 "L</available> on each member of the returned list."
20857 #: ../fish/guestfish-actions.pod:421
20858 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
20862 #: ../fish/guestfish-actions.pod:423
20867 #: ../fish/guestfish-actions.pod:425
20870 " base64-in (base64file|-) filename\n"
20875 #: ../fish/guestfish-actions.pod:430 ../fish/guestfish-actions.pod:439 ../fish/guestfish-actions.pod:663 ../fish/guestfish-actions.pod:832 ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1228 ../fish/guestfish-actions.pod:4341 ../fish/guestfish-actions.pod:4353 ../fish/guestfish-actions.pod:4364 ../fish/guestfish-actions.pod:4375 ../fish/guestfish-actions.pod:4427 ../fish/guestfish-actions.pod:4436 ../fish/guestfish-actions.pod:4490 ../fish/guestfish-actions.pod:4513
20876 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
20880 #: ../fish/guestfish-actions.pod:432
20885 #: ../fish/guestfish-actions.pod:434
20888 " base64-out filename (base64file|-)\n"
20893 #: ../fish/guestfish-actions.pod:441
20894 msgid "blockdev-flushbufs"
20898 #: ../fish/guestfish-actions.pod:443
20901 " blockdev-flushbufs device\n"
20906 #: ../fish/guestfish-actions.pod:450
20907 msgid "blockdev-getbsz"
20911 #: ../fish/guestfish-actions.pod:452
20914 " blockdev-getbsz device\n"
20919 #: ../fish/guestfish-actions.pod:461
20920 msgid "blockdev-getro"
20924 #: ../fish/guestfish-actions.pod:463
20927 " blockdev-getro device\n"
20932 #: ../fish/guestfish-actions.pod:470
20933 msgid "blockdev-getsize64"
20937 #: ../fish/guestfish-actions.pod:472
20940 " blockdev-getsize64 device\n"
20945 #: ../fish/guestfish-actions.pod:476
20946 msgid "See also L</blockdev-getsz>."
20950 #: ../fish/guestfish-actions.pod:480
20951 msgid "blockdev-getss"
20955 #: ../fish/guestfish-actions.pod:482
20958 " blockdev-getss device\n"
20963 #: ../fish/guestfish-actions.pod:487
20964 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
20968 #: ../fish/guestfish-actions.pod:492
20969 msgid "blockdev-getsz"
20973 #: ../fish/guestfish-actions.pod:494
20976 " blockdev-getsz device\n"
20981 #: ../fish/guestfish-actions.pod:499
20983 "See also L</blockdev-getss> for the real sector size of the device, and "
20984 "L</blockdev-getsize64> for the more useful I<size in bytes>."
20988 #: ../fish/guestfish-actions.pod:505
20989 msgid "blockdev-rereadpt"
20993 #: ../fish/guestfish-actions.pod:507
20996 " blockdev-rereadpt device\n"
21001 #: ../fish/guestfish-actions.pod:513
21002 msgid "blockdev-setbsz"
21006 #: ../fish/guestfish-actions.pod:515
21009 " blockdev-setbsz device blocksize\n"
21014 #: ../fish/guestfish-actions.pod:524
21015 msgid "blockdev-setro"
21019 #: ../fish/guestfish-actions.pod:526
21022 " blockdev-setro device\n"
21027 #: ../fish/guestfish-actions.pod:532
21028 msgid "blockdev-setrw"
21032 #: ../fish/guestfish-actions.pod:534
21035 " blockdev-setrw device\n"
21040 #: ../fish/guestfish-actions.pod:540
21041 msgid "case-sensitive-path"
21045 #: ../fish/guestfish-actions.pod:542
21048 " case-sensitive-path path\n"
21053 #: ../fish/guestfish-actions.pod:566
21055 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
21056 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
21057 "how the directories were originally created under Windows)."
21061 #: ../fish/guestfish-actions.pod:574
21062 msgid "See also L</realpath>."
21066 #: ../fish/guestfish-actions.pod:576
21071 #: ../fish/guestfish-actions.pod:578
21079 #: ../fish/guestfish-actions.pod:582
21081 "Note that this function cannot correctly handle binary files (specifically, "
21082 "files containing C<\\0> character which is treated as end of string). For "
21083 "those you need to use the L</read-file> or L</download> functions which have "
21084 "a more complex interface."
21088 #: ../fish/guestfish-actions.pod:590
21093 #: ../fish/guestfish-actions.pod:592
21096 " checksum csumtype path\n"
21101 #: ../fish/guestfish-actions.pod:635
21102 msgid "To get the checksum for a device, use L</checksum-device>."
21106 #: ../fish/guestfish-actions.pod:637
21107 msgid "To get the checksums for many files, use L</checksums-out>."
21111 #: ../fish/guestfish-actions.pod:639
21112 msgid "checksum-device"
21116 #: ../fish/guestfish-actions.pod:641
21119 " checksum-device csumtype device\n"
21124 #: ../fish/guestfish-actions.pod:643
21126 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
21127 "device named C<device>. For the types of checksums supported see the "
21128 "L</checksum> command."
21132 #: ../fish/guestfish-actions.pod:647
21133 msgid "checksums-out"
21137 #: ../fish/guestfish-actions.pod:649
21140 " checksums-out csumtype directory (sumsfile|-)\n"
21145 #: ../fish/guestfish-actions.pod:665
21150 #: ../fish/guestfish-actions.pod:667
21153 " chmod mode path\n"
21158 #: ../fish/guestfish-actions.pod:678
21163 #: ../fish/guestfish-actions.pod:680
21166 " chown owner group path\n"
21171 #: ../fish/guestfish-actions.pod:688
21176 #: ../fish/guestfish-actions.pod:690
21179 " command 'arguments ...'\n"
21184 #: ../fish/guestfish-actions.pod:697
21186 "The single parameter is an argv-style list of arguments. The first element "
21187 "is the name of the program to run. Subsequent elements are parameters. The "
21188 "list must be non-empty (ie. must contain a program name). Note that the "
21189 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
21193 #: ../fish/guestfish-actions.pod:725
21194 msgid "command-lines"
21198 #: ../fish/guestfish-actions.pod:727
21201 " command-lines 'arguments ...'\n"
21206 #: ../fish/guestfish-actions.pod:729
21207 msgid "This is the same as L</command>, but splits the result into a list of lines."
21211 #: ../fish/guestfish-actions.pod:732
21212 msgid "See also: L</sh-lines>"
21216 #: ../fish/guestfish-actions.pod:737
21221 #: ../fish/guestfish-actions.pod:739
21224 " config qemuparam qemuvalue\n"
21229 #: ../fish/guestfish-actions.pod:750
21234 #: ../fish/guestfish-actions.pod:752
21237 " copy-size src dest size\n"
21242 #: ../fish/guestfish-actions.pod:760
21247 #: ../fish/guestfish-actions.pod:762
21255 #: ../fish/guestfish-actions.pod:767
21260 #: ../fish/guestfish-actions.pod:769
21268 #: ../fish/guestfish-actions.pod:774
21273 #: ../fish/guestfish-actions.pod:776
21281 #: ../fish/guestfish-actions.pod:783
21283 "If the destination is a device, it must be as large or larger than the "
21284 "source file or device, otherwise the copy will fail. This command cannot do "
21285 "partial copies (see L</copy-size>)."
21289 #: ../fish/guestfish-actions.pod:787
21294 #: ../fish/guestfish-actions.pod:789
21302 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
21304 "This command is mostly useful for interactive sessions. It is I<not> "
21305 "intended that you try to parse the output string. Use L</statvfs> from "
21310 #: ../fish/guestfish-actions.pod:797
21315 #: ../fish/guestfish-actions.pod:799
21323 #: ../fish/guestfish-actions.pod:808
21328 #: ../fish/guestfish-actions.pod:810
21336 #: ../fish/guestfish-actions.pod:816
21338 "Another way to get the same information is to enable verbose messages with "
21339 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
21340 "before running the program."
21344 #: ../fish/guestfish-actions.pod:821
21349 #: ../fish/guestfish-actions.pod:823
21352 " download remotefilename (filename|-)\n"
21357 #: ../fish/guestfish-actions.pod:830
21358 msgid "See also L</upload>, L</cat>."
21362 #: ../fish/guestfish-actions.pod:834
21363 msgid "download-offset"
21367 #: ../fish/guestfish-actions.pod:836
21370 " download-offset remotefilename (filename|-) offset size\n"
21375 #: ../fish/guestfish-actions.pod:844
21377 "Note that there is no limit on the amount of data that can be downloaded "
21378 "with this call, unlike with L</pread>, and this call always reads the full "
21379 "amount unless an error occurs."
21383 #: ../fish/guestfish-actions.pod:849
21384 msgid "See also L</download>, L</pread>."
21388 #: ../fish/guestfish-actions.pod:853
21389 msgid "drop-caches"
21393 #: ../fish/guestfish-actions.pod:855
21396 " drop-caches whattodrop\n"
21401 #: ../fish/guestfish-actions.pod:867
21406 #: ../fish/guestfish-actions.pod:869
21414 #: ../fish/guestfish-actions.pod:881
21419 #: ../fish/guestfish-actions.pod:883
21422 " e2fsck-f device\n"
21427 #: ../fish/guestfish-actions.pod:889
21429 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
21430 "should use L</fsck>."
21434 #: ../fish/guestfish-actions.pod:892
21435 msgid "echo-daemon"
21439 #: ../fish/guestfish-actions.pod:894
21442 " echo-daemon 'words ...'\n"
21447 #: ../fish/guestfish-actions.pod:901
21448 msgid "See also L</ping-daemon>."
21452 #: ../fish/guestfish-actions.pod:903
21457 #: ../fish/guestfish-actions.pod:905
21460 " egrep regex path\n"
21465 #: ../fish/guestfish-actions.pod:913
21470 #: ../fish/guestfish-actions.pod:915
21473 " egrepi regex path\n"
21478 #: ../fish/guestfish-actions.pod:923
21483 #: ../fish/guestfish-actions.pod:925
21486 " equal file1 file2\n"
21491 #: ../fish/guestfish-actions.pod:932
21496 #: ../fish/guestfish-actions.pod:934
21504 #: ../fish/guestfish-actions.pod:939
21505 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21509 #: ../fish/guestfish-actions.pod:941
21514 #: ../fish/guestfish-actions.pod:943
21517 " fallocate path len\n"
21522 #: ../fish/guestfish-actions.pod:960
21523 msgid "fallocate64"
21527 #: ../fish/guestfish-actions.pod:962
21530 " fallocate64 path len\n"
21535 #: ../fish/guestfish-actions.pod:968
21537 "Note that this call allocates disk blocks for the file. To create a sparse "
21538 "file use L</truncate-size> instead."
21542 #: ../fish/guestfish-actions.pod:971
21544 "The deprecated call L</fallocate> does the same, but owing to an oversight "
21545 "it only allowed 30 bit lengths to be specified, effectively limiting the "
21546 "maximum size of files created through that call to 1GB."
21550 #: ../fish/guestfish-actions.pod:980
21555 #: ../fish/guestfish-actions.pod:982
21558 " fgrep pattern path\n"
21563 #: ../fish/guestfish-actions.pod:990
21568 #: ../fish/guestfish-actions.pod:992
21571 " fgrepi pattern path\n"
21576 #: ../fish/guestfish-actions.pod:1000
21581 #: ../fish/guestfish-actions.pod:1002
21589 #: ../fish/guestfish-actions.pod:1014
21591 "This command can also be used on C</dev/> devices (and partitions, LV "
21592 "names). You can for example use this to determine if a device contains a "
21593 "filesystem, although it's usually better to use L</vfs-type>."
21597 #: ../fish/guestfish-actions.pod:1024
21598 msgid "file-architecture"
21602 #: ../fish/guestfish-actions.pod:1026
21605 " file-architecture filename\n"
21610 #: ../fish/guestfish-actions.pod:1129
21615 #: ../fish/guestfish-actions.pod:1131
21623 #: ../fish/guestfish-actions.pod:1135
21625 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
21626 "L</is-file> etc. To get the size of block devices, use "
21627 "L</blockdev-getsize64>."
21631 #: ../fish/guestfish-actions.pod:1139
21636 #: ../fish/guestfish-actions.pod:1141
21639 " fill c len path\n"
21644 #: ../fish/guestfish-actions.pod:1147
21646 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
21647 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
21648 "L</fill-pattern>."
21652 #: ../fish/guestfish-actions.pod:1152
21653 msgid "fill-pattern"
21657 #: ../fish/guestfish-actions.pod:1154
21660 " fill-pattern pattern len path\n"
21665 #: ../fish/guestfish-actions.pod:1156
21667 "This function is like L</fill> except that it creates a new file of length "
21668 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
21669 "is truncated if necessary to ensure the length of the file is exactly C<len> "
21674 #: ../fish/guestfish-actions.pod:1161
21679 #: ../fish/guestfish-actions.pod:1163
21682 " find directory\n"
21687 #: ../fish/guestfish-actions.pod:1177
21688 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
21692 #: ../fish/guestfish-actions.pod:1190
21693 msgid "See also L</find0>."
21697 #: ../fish/guestfish-actions.pod:1195
21702 #: ../fish/guestfish-actions.pod:1197
21705 " find0 directory (files|-)\n"
21710 #: ../fish/guestfish-actions.pod:1203
21711 msgid "This command works the same way as L</find> with the following exceptions:"
21715 #: ../fish/guestfish-actions.pod:1230
21716 msgid "findfs-label"
21720 #: ../fish/guestfish-actions.pod:1232
21723 " findfs-label label\n"
21728 #: ../fish/guestfish-actions.pod:1238
21729 msgid "To find the label of a filesystem, use L</vfs-label>."
21733 #: ../fish/guestfish-actions.pod:1240
21734 msgid "findfs-uuid"
21738 #: ../fish/guestfish-actions.pod:1242
21741 " findfs-uuid uuid\n"
21746 #: ../fish/guestfish-actions.pod:1248
21747 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
21751 #: ../fish/guestfish-actions.pod:1250
21756 #: ../fish/guestfish-actions.pod:1252
21759 " fsck fstype device\n"
21764 #: ../fish/guestfish-actions.pod:1282
21769 #: ../fish/guestfish-actions.pod:1284
21777 #: ../fish/guestfish-actions.pod:1291
21778 msgid "get-attach-method"
21782 #: ../fish/guestfish-actions.pod:1293
21785 " get-attach-method\n"
21790 #: ../fish/guestfish-actions.pod:1295
21791 msgid "Return the current attach method. See L</set-attach-method>."
21795 #: ../fish/guestfish-actions.pod:1297
21796 msgid "get-autosync"
21800 #: ../fish/guestfish-actions.pod:1299
21808 #: ../fish/guestfish-actions.pod:1303
21813 #: ../fish/guestfish-actions.pod:1305
21821 #: ../fish/guestfish-actions.pod:1309
21822 msgid "get-e2label"
21826 #: ../fish/guestfish-actions.pod:1311
21829 " get-e2label device\n"
21834 #: ../fish/guestfish-actions.pod:1323
21839 #: ../fish/guestfish-actions.pod:1325
21842 " get-e2uuid device\n"
21847 #: ../fish/guestfish-actions.pod:1337
21848 msgid "get-memsize"
21852 #: ../fish/guestfish-actions.pod:1339
21860 #: ../fish/guestfish-actions.pod:1344
21862 "If L</set-memsize> was not called on this handle, and if "
21863 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
21864 "value for memsize."
21868 #: ../fish/guestfish-actions.pod:1351
21869 msgid "get-network"
21873 #: ../fish/guestfish-actions.pod:1353
21881 #: ../fish/guestfish-actions.pod:1357
21886 #: ../fish/guestfish-actions.pod:1359
21894 #: ../fish/guestfish-actions.pod:1366
21899 #: ../fish/guestfish-actions.pod:1368
21904 #: ../fish/guestfish-actions.pod:1370
21912 #: ../fish/guestfish-actions.pod:1377
21917 #: ../fish/guestfish-actions.pod:1379
21925 #: ../fish/guestfish-actions.pod:1386
21926 msgid "get-recovery-proc"
21930 #: ../fish/guestfish-actions.pod:1388
21933 " get-recovery-proc\n"
21938 #: ../fish/guestfish-actions.pod:1392
21939 msgid "get-selinux"
21943 #: ../fish/guestfish-actions.pod:1394
21951 #: ../fish/guestfish-actions.pod:1396
21953 "This returns the current setting of the selinux flag which is passed to the "
21954 "appliance at boot time. See L</set-selinux>."
21958 #: ../fish/guestfish-actions.pod:1402
21963 #: ../fish/guestfish-actions.pod:1404
21971 #: ../fish/guestfish-actions.pod:1411
21976 #: ../fish/guestfish-actions.pod:1413
21984 #: ../fish/guestfish-actions.pod:1417
21989 #: ../fish/guestfish-actions.pod:1419
21997 #: ../fish/guestfish-actions.pod:1421
21999 "Return the current umask. By default the umask is C<022> unless it has been "
22000 "set by calling L</umask>."
22004 #: ../fish/guestfish-actions.pod:1424
22005 msgid "get-verbose"
22009 #: ../fish/guestfish-actions.pod:1426
22017 #: ../fish/guestfish-actions.pod:1430
22022 #: ../fish/guestfish-actions.pod:1432
22030 #: ../fish/guestfish-actions.pod:1436
22031 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
22035 #: ../fish/guestfish-actions.pod:1439
22040 #: ../fish/guestfish-actions.pod:1441
22043 " getxattr path name\n"
22048 #: ../fish/guestfish-actions.pod:1443
22050 "Get a single extended attribute from file C<path> named C<name>. This call "
22051 "follows symlinks. If you want to lookup an extended attribute for the "
22052 "symlink itself, use L</lgetxattr>."
22056 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2353
22058 "Normally it is better to get all extended attributes from a file in one go "
22059 "by calling L</getxattrs>. However some Linux filesystem implementations are "
22060 "buggy and do not provide a way to list out attributes. For these "
22061 "filesystems (notably ntfs-3g) you have to know the names of the extended "
22062 "attributes you want in advance and call this function."
22066 #: ../fish/guestfish-actions.pod:1457
22067 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
22071 #: ../fish/guestfish-actions.pod:1459
22076 #: ../fish/guestfish-actions.pod:1461
22079 " getxattrs path\n"
22084 #: ../fish/guestfish-actions.pod:1469
22085 msgid "See also: L</lgetxattrs>, L<attr(5)>."
22089 #: ../fish/guestfish-actions.pod:1471
22090 msgid "glob-expand"
22094 #: ../fish/guestfish-actions.pod:1473
22097 " glob-expand pattern\n"
22102 #: ../fish/guestfish-actions.pod:1486
22107 #: ../fish/guestfish-actions.pod:1488
22110 " grep regex path\n"
22115 #: ../fish/guestfish-actions.pod:1496
22120 #: ../fish/guestfish-actions.pod:1498
22123 " grepi regex path\n"
22128 #: ../fish/guestfish-actions.pod:1506
22129 msgid "grub-install"
22133 #: ../fish/guestfish-actions.pod:1508
22136 " grub-install root device\n"
22141 #: ../fish/guestfish-actions.pod:1524
22146 #: ../fish/guestfish-actions.pod:1526
22154 #: ../fish/guestfish-actions.pod:1534
22159 #: ../fish/guestfish-actions.pod:1536
22162 " head-n nrlines path\n"
22167 #: ../fish/guestfish-actions.pod:1549
22172 #: ../fish/guestfish-actions.pod:1551
22180 #: ../fish/guestfish-actions.pod:1559
22185 #: ../fish/guestfish-actions.pod:1561
22188 " initrd-cat initrdpath filename\n"
22193 #: ../fish/guestfish-actions.pod:1573
22194 msgid "See also L</initrd-list>."
22198 #: ../fish/guestfish-actions.pod:1578
22199 msgid "initrd-list"
22203 #: ../fish/guestfish-actions.pod:1580
22206 " initrd-list path\n"
22211 #: ../fish/guestfish-actions.pod:1592
22212 msgid "inotify-add-watch"
22216 #: ../fish/guestfish-actions.pod:1594
22219 " inotify-add-watch path mask\n"
22224 #: ../fish/guestfish-actions.pod:1606
22225 msgid "inotify-close"
22229 #: ../fish/guestfish-actions.pod:1608
22237 #: ../fish/guestfish-actions.pod:1614
22238 msgid "inotify-files"
22242 #: ../fish/guestfish-actions.pod:1616
22250 #: ../fish/guestfish-actions.pod:1618
22252 "This function is a helpful wrapper around L</inotify-read> which just "
22253 "returns a list of pathnames of objects that were touched. The returned "
22254 "pathnames are sorted and deduplicated."
22258 #: ../fish/guestfish-actions.pod:1622
22259 msgid "inotify-init"
22263 #: ../fish/guestfish-actions.pod:1624
22266 " inotify-init maxevents\n"
22271 #: ../fish/guestfish-actions.pod:1630
22273 "C<maxevents> is the maximum number of events which will be queued up between "
22274 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
22275 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
22276 "default was 16384 events. Beyond this limit, the kernel throws away events, "
22277 "but records the fact that it threw them away by setting a flag "
22278 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
22282 #: ../fish/guestfish-actions.pod:1640
22284 "Before any events are generated, you have to add some watches to the "
22285 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
22286 "L</inotify-watch-all>."
22290 #: ../fish/guestfish-actions.pod:1646
22292 "Queued up events should be read periodically by calling L</inotify-read> (or "
22293 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
22294 "If you don't read the events out often enough then you risk the internal "
22295 "queue overflowing."
22299 #: ../fish/guestfish-actions.pod:1653
22301 "The handle should be closed after use by calling L</inotify-close>. This "
22302 "also removes any watches automatically."
22306 #: ../fish/guestfish-actions.pod:1662
22307 msgid "inotify-read"
22311 #: ../fish/guestfish-actions.pod:1664
22319 #: ../fish/guestfish-actions.pod:1677
22320 msgid "inotify-rm-watch"
22324 #: ../fish/guestfish-actions.pod:1679
22327 " inotify-rm-watch wd\n"
22332 #: ../fish/guestfish-actions.pod:1681
22333 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
22337 #: ../fish/guestfish-actions.pod:1684
22338 msgid "inspect-get-arch"
22342 #: ../fish/guestfish-actions.pod:1686
22345 " inspect-get-arch root\n"
22350 #: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1704 ../fish/guestfish-actions.pod:1778 ../fish/guestfish-actions.pod:1796 ../fish/guestfish-actions.pod:1830 ../fish/guestfish-actions.pod:1845 ../fish/guestfish-actions.pod:1866 ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1930 ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2035 ../fish/guestfish-actions.pod:2048 ../fish/guestfish-actions.pod:2061 ../fish/guestfish-actions.pod:2076
22352 "This function should only be called with a root device string as returned by "
22357 #: ../fish/guestfish-actions.pod:1691
22359 "This returns the architecture of the inspected operating system. The "
22360 "possible return values are listed under L</file-architecture>."
22364 #: ../fish/guestfish-actions.pod:1700
22365 msgid "inspect-get-distro"
22369 #: ../fish/guestfish-actions.pod:1702
22372 " inspect-get-distro root\n"
22377 #: ../fish/guestfish-actions.pod:1774
22378 msgid "inspect-get-filesystems"
22382 #: ../fish/guestfish-actions.pod:1776
22385 " inspect-get-filesystems root\n"
22390 #: ../fish/guestfish-actions.pod:1789
22392 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22393 "L</inspect-get-mountpoints>."
22397 #: ../fish/guestfish-actions.pod:1792
22398 msgid "inspect-get-format"
22402 #: ../fish/guestfish-actions.pod:1794
22405 " inspect-get-format root\n"
22410 #: ../fish/guestfish-actions.pod:1826
22411 msgid "inspect-get-hostname"
22415 #: ../fish/guestfish-actions.pod:1828
22418 " inspect-get-hostname root\n"
22423 #: ../fish/guestfish-actions.pod:1841
22424 msgid "inspect-get-major-version"
22428 #: ../fish/guestfish-actions.pod:1843
22431 " inspect-get-major-version root\n"
22436 #: ../fish/guestfish-actions.pod:1862
22437 msgid "inspect-get-minor-version"
22441 #: ../fish/guestfish-actions.pod:1864
22444 " inspect-get-minor-version root\n"
22449 #: ../fish/guestfish-actions.pod:1874
22451 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22452 "L</inspect-get-major-version>."
22456 #: ../fish/guestfish-actions.pod:1877
22457 msgid "inspect-get-mountpoints"
22461 #: ../fish/guestfish-actions.pod:1879
22464 " inspect-get-mountpoints root\n"
22469 #: ../fish/guestfish-actions.pod:1901
22471 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22472 "L</inspect-get-filesystems>."
22476 #: ../fish/guestfish-actions.pod:1904
22477 msgid "inspect-get-package-format"
22481 #: ../fish/guestfish-actions.pod:1906
22484 " inspect-get-package-format root\n"
22489 #: ../fish/guestfish-actions.pod:1911
22491 "This function and L</inspect-get-package-management> return the package "
22492 "format and package management tool used by the inspected operating system. "
22493 "For example for Fedora these functions would return C<rpm> (package format) "
22494 "and C<yum> (package management)."
22498 #: ../fish/guestfish-actions.pod:1926
22499 msgid "inspect-get-package-management"
22503 #: ../fish/guestfish-actions.pod:1928
22506 " inspect-get-package-management root\n"
22511 #: ../fish/guestfish-actions.pod:1933
22513 "L</inspect-get-package-format> and this function return the package format "
22514 "and package management tool used by the inspected operating system. For "
22515 "example for Fedora these functions would return C<rpm> (package format) and "
22516 "C<yum> (package management)."
22520 #: ../fish/guestfish-actions.pod:1950
22521 msgid "inspect-get-product-name"
22525 #: ../fish/guestfish-actions.pod:1952
22528 " inspect-get-product-name root\n"
22533 #: ../fish/guestfish-actions.pod:1967
22534 msgid "inspect-get-roots"
22538 #: ../fish/guestfish-actions.pod:1969
22541 " inspect-get-roots\n"
22546 #: ../fish/guestfish-actions.pod:1971
22548 "This function is a convenient way to get the list of root devices, as "
22549 "returned from a previous call to L</inspect-os>, but without redoing the "
22550 "whole inspection process."
22554 #: ../fish/guestfish-actions.pod:1975
22556 "This returns an empty list if either no root devices were found or the "
22557 "caller has not called L</inspect-os>."
22561 #: ../fish/guestfish-actions.pod:1980
22562 msgid "inspect-get-type"
22566 #: ../fish/guestfish-actions.pod:1982
22569 " inspect-get-type root\n"
22574 #: ../fish/guestfish-actions.pod:2015
22575 msgid "inspect-get-windows-systemroot"
22579 #: ../fish/guestfish-actions.pod:2017
22582 " inspect-get-windows-systemroot root\n"
22587 #: ../fish/guestfish-actions.pod:2031
22588 msgid "inspect-is-live"
22592 #: ../fish/guestfish-actions.pod:2033
22595 " inspect-is-live root\n"
22600 #: ../fish/guestfish-actions.pod:2038
22602 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
22603 "then this returns true if a live image was detected on the disk."
22607 #: ../fish/guestfish-actions.pod:2044
22608 msgid "inspect-is-multipart"
22612 #: ../fish/guestfish-actions.pod:2046
22615 " inspect-is-multipart root\n"
22620 #: ../fish/guestfish-actions.pod:2051
22622 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
22623 "then this returns true if the disk is part of a set."
22627 #: ../fish/guestfish-actions.pod:2057
22628 msgid "inspect-is-netinst"
22632 #: ../fish/guestfish-actions.pod:2059
22635 " inspect-is-netinst root\n"
22640 #: ../fish/guestfish-actions.pod:2064
22642 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
22643 "then this returns true if the disk is a network installer, ie. not a "
22644 "self-contained install CD but one which is likely to require network access "
22645 "to complete the install."
22649 #: ../fish/guestfish-actions.pod:2072
22650 msgid "inspect-list-applications"
22654 #: ../fish/guestfish-actions.pod:2074
22657 " inspect-list-applications root\n"
22662 #: ../fish/guestfish-actions.pod:2081
22664 "I<Note:> This call works differently from other parts of the inspection "
22665 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
22666 "then mount up the disks, before calling this. Listing applications is a "
22667 "significantly more difficult operation which requires access to the full "
22668 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
22669 "are just returning data cached in the libguestfs handle, this call actually "
22670 "reads parts of the mounted filesystems during the call."
22674 #: ../fish/guestfish-actions.pod:2171
22679 #: ../fish/guestfish-actions.pod:2173
22687 #: ../fish/guestfish-actions.pod:2188
22689 "You can pass the root string(s) returned to other L</inspect-get-*> "
22690 "functions in order to query further information about each operating system, "
22691 "such as the name and version."
22695 #: ../fish/guestfish-actions.pod:2193
22697 "This function uses other libguestfs features such as L</mount-ro> and "
22698 "L</umount-all> in order to mount and unmount filesystems and look at the "
22699 "contents. This should be called with no disks currently mounted. The "
22700 "function may also use Augeas, so any existing Augeas handle will be closed."
22704 #: ../fish/guestfish-actions.pod:2205 ../fish/guestfish-actions.pod:2381 ../fish/guestfish-actions.pod:2427
22705 msgid "See also L</list-filesystems>."
22709 #: ../fish/guestfish-actions.pod:2207
22710 msgid "is-blockdev"
22714 #: ../fish/guestfish-actions.pod:2209
22717 " is-blockdev path\n"
22722 #: ../fish/guestfish-actions.pod:2214 ../fish/guestfish-actions.pod:2232 ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2260 ../fish/guestfish-actions.pod:2270 ../fish/guestfish-actions.pod:2304 ../fish/guestfish-actions.pod:2313
22723 msgid "See also L</stat>."
22727 #: ../fish/guestfish-actions.pod:2216
22732 #: ../fish/guestfish-actions.pod:2218
22740 #: ../fish/guestfish-actions.pod:2225
22745 #: ../fish/guestfish-actions.pod:2227
22748 " is-chardev path\n"
22753 #: ../fish/guestfish-actions.pod:2234
22758 #: ../fish/guestfish-actions.pod:2236
22766 #: ../fish/guestfish-actions.pod:2243
22771 #: ../fish/guestfish-actions.pod:2245
22779 #: ../fish/guestfish-actions.pod:2253
22784 #: ../fish/guestfish-actions.pod:2255
22792 #: ../fish/guestfish-actions.pod:2262
22797 #: ../fish/guestfish-actions.pod:2264
22805 #: ../fish/guestfish-actions.pod:2272
22806 msgid "is-launching"
22810 #: ../fish/guestfish-actions.pod:2274
22818 #: ../fish/guestfish-actions.pod:2281
22823 #: ../fish/guestfish-actions.pod:2283
22831 #: ../fish/guestfish-actions.pod:2288
22836 #: ../fish/guestfish-actions.pod:2290
22844 #: ../fish/guestfish-actions.pod:2297
22849 #: ../fish/guestfish-actions.pod:2299
22852 " is-socket path\n"
22857 #: ../fish/guestfish-actions.pod:2306
22862 #: ../fish/guestfish-actions.pod:2308
22865 " is-symlink path\n"
22870 #: ../fish/guestfish-actions.pod:2315
22871 msgid "kill-subprocess"
22875 #: ../fish/guestfish-actions.pod:2317
22878 " kill-subprocess\n"
22883 #: ../fish/guestfish-actions.pod:2321
22888 #: ../fish/guestfish-actions.pod:2323
22893 #: ../fish/guestfish-actions.pod:2325
22901 #: ../fish/guestfish-actions.pod:2333
22906 #: ../fish/guestfish-actions.pod:2335
22909 " lchown owner group path\n"
22914 #: ../fish/guestfish-actions.pod:2337
22916 "Change the file owner to C<owner> and group to C<group>. This is like "
22917 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
22922 #: ../fish/guestfish-actions.pod:2345
22927 #: ../fish/guestfish-actions.pod:2347
22930 " lgetxattr path name\n"
22935 #: ../fish/guestfish-actions.pod:2363
22936 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
22940 #: ../fish/guestfish-actions.pod:2365
22945 #: ../fish/guestfish-actions.pod:2367
22948 " lgetxattrs path\n"
22953 #: ../fish/guestfish-actions.pod:2369
22955 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
22956 "it returns the extended attributes of the link itself."
22960 #: ../fish/guestfish-actions.pod:2373
22961 msgid "list-devices"
22965 #: ../fish/guestfish-actions.pod:2375
22973 #: ../fish/guestfish-actions.pod:2383
22974 msgid "list-filesystems"
22978 #: ../fish/guestfish-actions.pod:2385
22981 " list-filesystems\n"
22986 #: ../fish/guestfish-actions.pod:2404
22988 "This command runs other libguestfs commands, which might include L</mount> "
22989 "and L</umount>, and therefore you should use this soon after launch and only "
22990 "when nothing is mounted."
22994 #: ../fish/guestfish-actions.pod:2408
22996 "Not all of the filesystems returned will be mountable. In particular, swap "
22997 "partitions are returned in the list. Also this command does not check that "
22998 "each filesystem found is valid and mountable, and some filesystems might be "
22999 "mountable but require special options. Filesystems may not all belong to a "
23000 "single logical operating system (use L</inspect-os> to look for OSes)."
23004 #: ../fish/guestfish-actions.pod:2416
23005 msgid "list-partitions"
23009 #: ../fish/guestfish-actions.pod:2418
23012 " list-partitions\n"
23017 #: ../fish/guestfish-actions.pod:2424
23019 "This does not return logical volumes. For that you will need to call "
23024 #: ../fish/guestfish-actions.pod:2429
23029 #: ../fish/guestfish-actions.pod:2431
23037 #: ../fish/guestfish-actions.pod:2439
23042 #: ../fish/guestfish-actions.pod:2441
23045 " ln target linkname\n"
23050 #: ../fish/guestfish-actions.pod:2445
23055 #: ../fish/guestfish-actions.pod:2447
23058 " ln-f target linkname\n"
23063 #: ../fish/guestfish-actions.pod:2452
23068 #: ../fish/guestfish-actions.pod:2454
23071 " ln-s target linkname\n"
23076 #: ../fish/guestfish-actions.pod:2458
23081 #: ../fish/guestfish-actions.pod:2460
23084 " ln-sf target linkname\n"
23089 #: ../fish/guestfish-actions.pod:2465
23090 msgid "lremovexattr"
23094 #: ../fish/guestfish-actions.pod:2467
23097 " lremovexattr xattr path\n"
23102 #: ../fish/guestfish-actions.pod:2469
23104 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
23105 "it removes an extended attribute of the link itself."
23109 #: ../fish/guestfish-actions.pod:2473
23114 #: ../fish/guestfish-actions.pod:2475
23122 #: ../fish/guestfish-actions.pod:2481
23124 "This command is mostly useful for interactive sessions. Programs should "
23125 "probably use L</readdir> instead."
23129 #: ../fish/guestfish-actions.pod:2484
23134 #: ../fish/guestfish-actions.pod:2486
23137 " lsetxattr xattr val vallen path\n"
23142 #: ../fish/guestfish-actions.pod:2488
23144 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
23145 "sets an extended attribute of the link itself."
23149 #: ../fish/guestfish-actions.pod:2492
23154 #: ../fish/guestfish-actions.pod:2494
23162 #: ../fish/guestfish-actions.pod:2498
23164 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
23165 "the link is stat-ed, not the file it refers to."
23169 #: ../fish/guestfish-actions.pod:2504
23174 #: ../fish/guestfish-actions.pod:2506
23177 " lstatlist path 'names ...'\n"
23182 #: ../fish/guestfish-actions.pod:2508
23184 "This call allows you to perform the L</lstat> operation on multiple files, "
23185 "where all files are in the directory C<path>. C<names> is the list of files "
23186 "from this directory."
23190 #: ../fish/guestfish-actions.pod:2517
23192 "This call is intended for programs that want to efficiently list a directory "
23193 "contents without making many round-trips. See also L</lxattrlist> for a "
23194 "similarly efficient call for getting extended attributes. Very long "
23195 "directory listings might cause the protocol message size to be exceeded, "
23196 "causing this call to fail. The caller must split up such requests into "
23197 "smaller groups of names."
23201 #: ../fish/guestfish-actions.pod:2525
23202 msgid "luks-add-key"
23206 #: ../fish/guestfish-actions.pod:2527
23209 " luks-add-key device keyslot\n"
23214 #: ../fish/guestfish-actions.pod:2534
23216 "Note that if C<keyslot> already contains a key, then this command will "
23217 "fail. You have to use L</luks-kill-slot> first to remove that key."
23221 #: ../fish/guestfish-actions.pod:2538 ../fish/guestfish-actions.pod:2560 ../fish/guestfish-actions.pod:2573 ../fish/guestfish-actions.pod:2587 ../fish/guestfish-actions.pod:2610 ../fish/guestfish-actions.pod:2620
23223 "This command has one or more key or passphrase parameters. Guestfish will "
23224 "prompt for these separately."
23228 #: ../fish/guestfish-actions.pod:2541
23233 #: ../fish/guestfish-actions.pod:2543
23236 " luks-close device\n"
23241 #: ../fish/guestfish-actions.pod:2545
23243 "This closes a LUKS device that was created earlier by L</luks-open> or "
23244 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
23245 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
23246 "underlying block device."
23250 #: ../fish/guestfish-actions.pod:2551
23251 msgid "luks-format"
23255 #: ../fish/guestfish-actions.pod:2553
23258 " luks-format device keyslot\n"
23263 #: ../fish/guestfish-actions.pod:2566
23264 msgid "luks-format-cipher"
23268 #: ../fish/guestfish-actions.pod:2568
23271 " luks-format-cipher device keyslot cipher\n"
23276 #: ../fish/guestfish-actions.pod:2570
23278 "This command is the same as L</luks-format> but it also allows you to set "
23279 "the C<cipher> used."
23283 #: ../fish/guestfish-actions.pod:2579
23284 msgid "luks-kill-slot"
23288 #: ../fish/guestfish-actions.pod:2581
23291 " luks-kill-slot device keyslot\n"
23296 #: ../fish/guestfish-actions.pod:2590
23301 #: ../fish/guestfish-actions.pod:2592
23304 " luks-open device mapname\n"
23309 #: ../fish/guestfish-actions.pod:2606
23311 "If this block device contains LVM volume groups, then calling L</vgscan> "
23312 "followed by L</vg-activate-all> will make them visible."
23316 #: ../fish/guestfish-actions.pod:2613
23317 msgid "luks-open-ro"
23321 #: ../fish/guestfish-actions.pod:2615
23324 " luks-open-ro device mapname\n"
23329 #: ../fish/guestfish-actions.pod:2617
23331 "This is the same as L</luks-open> except that a read-only mapping is "
23336 #: ../fish/guestfish-actions.pod:2623
23341 #: ../fish/guestfish-actions.pod:2625
23344 " lvcreate logvol volgroup mbytes\n"
23349 #: ../fish/guestfish-actions.pod:2630
23350 msgid "lvm-canonical-lv-name"
23354 #: ../fish/guestfish-actions.pod:2632
23357 " lvm-canonical-lv-name lvname\n"
23362 #: ../fish/guestfish-actions.pod:2641
23363 msgid "See also L</is-lv>."
23367 #: ../fish/guestfish-actions.pod:2643
23368 msgid "lvm-clear-filter"
23372 #: ../fish/guestfish-actions.pod:2645
23375 " lvm-clear-filter\n"
23380 #: ../fish/guestfish-actions.pod:2647
23382 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
23387 #: ../fish/guestfish-actions.pod:2653
23388 msgid "lvm-remove-all"
23392 #: ../fish/guestfish-actions.pod:2655
23395 " lvm-remove-all\n"
23400 #: ../fish/guestfish-actions.pod:2663
23401 msgid "lvm-set-filter"
23405 #: ../fish/guestfish-actions.pod:2665
23408 " lvm-set-filter 'devices ...'\n"
23413 #: ../fish/guestfish-actions.pod:2690
23418 #: ../fish/guestfish-actions.pod:2692
23421 " lvremove device\n"
23426 #: ../fish/guestfish-actions.pod:2700
23431 #: ../fish/guestfish-actions.pod:2702
23434 " lvrename logvol newlogvol\n"
23439 #: ../fish/guestfish-actions.pod:2706
23444 #: ../fish/guestfish-actions.pod:2708
23447 " lvresize device mbytes\n"
23452 #: ../fish/guestfish-actions.pod:2714
23453 msgid "lvresize-free"
23457 #: ../fish/guestfish-actions.pod:2716
23460 " lvresize-free lv percent\n"
23465 #: ../fish/guestfish-actions.pod:2724
23470 #: ../fish/guestfish-actions.pod:2726
23478 #: ../fish/guestfish-actions.pod:2734
23479 msgid "See also L</lvs-full>, L</list-filesystems>."
23483 #: ../fish/guestfish-actions.pod:2736
23488 #: ../fish/guestfish-actions.pod:2738
23496 #: ../fish/guestfish-actions.pod:2743
23501 #: ../fish/guestfish-actions.pod:2745
23509 #: ../fish/guestfish-actions.pod:2749
23514 #: ../fish/guestfish-actions.pod:2751
23517 " lxattrlist path 'names ...'\n"
23522 #: ../fish/guestfish-actions.pod:2767
23524 "This call is intended for programs that want to efficiently list a directory "
23525 "contents without making many round-trips. See also L</lstatlist> for a "
23526 "similarly efficient call for getting standard stats. Very long directory "
23527 "listings might cause the protocol message size to be exceeded, causing this "
23528 "call to fail. The caller must split up such requests into smaller groups of "
23533 #: ../fish/guestfish-actions.pod:2775
23538 #: ../fish/guestfish-actions.pod:2777
23546 #: ../fish/guestfish-actions.pod:2781
23551 #: ../fish/guestfish-actions.pod:2783
23554 " mkdir-mode path mode\n"
23559 #: ../fish/guestfish-actions.pod:2792
23560 msgid "See also L</mkdir>, L</umask>"
23564 #: ../fish/guestfish-actions.pod:2794
23569 #: ../fish/guestfish-actions.pod:2796
23577 #: ../fish/guestfish-actions.pod:2801
23582 #: ../fish/guestfish-actions.pod:2803
23585 " mkdtemp template\n"
23590 #: ../fish/guestfish-actions.pod:2824
23595 #: ../fish/guestfish-actions.pod:2826
23598 " mke2fs-J fstype blocksize device journal\n"
23603 #: ../fish/guestfish-actions.pod:2834
23604 msgid "See also L</mke2journal>."
23608 #: ../fish/guestfish-actions.pod:2836
23613 #: ../fish/guestfish-actions.pod:2838
23616 " mke2fs-JL fstype blocksize device label\n"
23621 #: ../fish/guestfish-actions.pod:2843
23622 msgid "See also L</mke2journal-L>."
23626 #: ../fish/guestfish-actions.pod:2845
23631 #: ../fish/guestfish-actions.pod:2847
23634 " mke2fs-JU fstype blocksize device uuid\n"
23639 #: ../fish/guestfish-actions.pod:2852
23640 msgid "See also L</mke2journal-U>."
23644 #: ../fish/guestfish-actions.pod:2854
23645 msgid "mke2journal"
23649 #: ../fish/guestfish-actions.pod:2856
23652 " mke2journal blocksize device\n"
23657 #: ../fish/guestfish-actions.pod:2863
23658 msgid "mke2journal-L"
23662 #: ../fish/guestfish-actions.pod:2865
23665 " mke2journal-L blocksize label device\n"
23670 #: ../fish/guestfish-actions.pod:2869
23671 msgid "mke2journal-U"
23675 #: ../fish/guestfish-actions.pod:2871
23678 " mke2journal-U blocksize uuid device\n"
23683 #: ../fish/guestfish-actions.pod:2875
23688 #: ../fish/guestfish-actions.pod:2877
23691 " mkfifo mode path\n"
23696 #: ../fish/guestfish-actions.pod:2879
23698 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
23699 "is just a convenient wrapper around L</mknod>."
23703 #: ../fish/guestfish-actions.pod:2885
23708 #: ../fish/guestfish-actions.pod:2887
23711 " mkfs fstype device\n"
23716 #: ../fish/guestfish-actions.pod:2893
23721 #: ../fish/guestfish-actions.pod:2895
23724 " mkfs-b fstype blocksize device\n"
23729 #: ../fish/guestfish-actions.pod:2897
23731 "This call is similar to L</mkfs>, but it allows you to control the block "
23732 "size of the resulting filesystem. Supported block sizes depend on the "
23733 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
23737 #: ../fish/guestfish-actions.pod:2912
23742 #: ../fish/guestfish-actions.pod:2914
23745 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
23750 #: ../fish/guestfish-actions.pod:2949
23751 msgid "mkmountpoint"
23755 #: ../fish/guestfish-actions.pod:2951
23758 " mkmountpoint exemptpath\n"
23763 #: ../fish/guestfish-actions.pod:2953
23765 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
23766 "to create extra mountpoints before mounting the first filesystem."
23770 #: ../fish/guestfish-actions.pod:2977
23772 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
23773 "unexpected errors if you try to mix these calls. It is safest to manually "
23774 "unmount filesystems and remove mountpoints after use."
23778 #: ../fish/guestfish-actions.pod:2981
23780 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
23781 "for this to work for manual mountpoints, you must ensure that the innermost "
23782 "mountpoints have the longest pathnames, as in the example code above."
23786 #: ../fish/guestfish-actions.pod:2988
23788 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
23789 "L</umount-all> to be called when the handle is closed which can also trigger "
23794 #: ../fish/guestfish-actions.pod:2992
23799 #: ../fish/guestfish-actions.pod:2994
23802 " mknod mode devmajor devminor path\n"
23807 #: ../fish/guestfish-actions.pod:3004
23809 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
23810 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
23811 "regular file). These constants are available in the standard Linux header "
23812 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
23813 "wrappers around this command which bitwise OR in the appropriate constant "
23818 #: ../fish/guestfish-actions.pod:3014
23823 #: ../fish/guestfish-actions.pod:3016
23826 " mknod-b mode devmajor devminor path\n"
23831 #: ../fish/guestfish-actions.pod:3018
23833 "This call creates a block device node called C<path> with mode C<mode> and "
23834 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23835 "wrapper around L</mknod>."
23839 #: ../fish/guestfish-actions.pod:3024
23844 #: ../fish/guestfish-actions.pod:3026
23847 " mknod-c mode devmajor devminor path\n"
23852 #: ../fish/guestfish-actions.pod:3028
23854 "This call creates a char device node called C<path> with mode C<mode> and "
23855 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23856 "wrapper around L</mknod>."
23860 #: ../fish/guestfish-actions.pod:3034
23865 #: ../fish/guestfish-actions.pod:3036
23873 #: ../fish/guestfish-actions.pod:3040
23878 #: ../fish/guestfish-actions.pod:3042
23881 " mkswap-L label device\n"
23886 #: ../fish/guestfish-actions.pod:3050
23891 #: ../fish/guestfish-actions.pod:3052
23894 " mkswap-U uuid device\n"
23899 #: ../fish/guestfish-actions.pod:3056
23900 msgid "mkswap-file"
23904 #: ../fish/guestfish-actions.pod:3058
23907 " mkswap-file path\n"
23912 #: ../fish/guestfish-actions.pod:3062
23914 "This command just writes a swap file signature to an existing file. To "
23915 "create the file itself, use something like L</fallocate>."
23919 #: ../fish/guestfish-actions.pod:3065
23924 #: ../fish/guestfish-actions.pod:3067
23927 " modprobe modulename\n"
23932 #: ../fish/guestfish-actions.pod:3074
23937 #: ../fish/guestfish-actions.pod:3076
23940 " mount device mountpoint\n"
23945 #: ../fish/guestfish-actions.pod:3092
23947 "B<Important note:> When you use this call, the filesystem options C<sync> "
23948 "and C<noatime> are set implicitly. This was originally done because we "
23949 "thought it would improve reliability, but it turns out that I<-o sync> has a "
23950 "very large negative performance impact and negligible effect on "
23951 "reliability. Therefore we recommend that you avoid using L</mount> in any "
23952 "code that needs performance, and instead use L</mount-options> (use an empty "
23953 "string for the first parameter if you don't want any options)."
23957 #: ../fish/guestfish-actions.pod:3102
23962 #: ../fish/guestfish-actions.pod:3104
23965 " mount-loop file mountpoint\n"
23970 #: ../fish/guestfish-actions.pod:3110
23971 msgid "mount-options"
23975 #: ../fish/guestfish-actions.pod:3112
23978 " mount-options options device mountpoint\n"
23983 #: ../fish/guestfish-actions.pod:3114
23985 "This is the same as the L</mount> command, but it allows you to set the "
23986 "mount options as for the L<mount(8)> I<-o> flag."
23990 #: ../fish/guestfish-actions.pod:3122
23995 #: ../fish/guestfish-actions.pod:3124
23998 " mount-ro device mountpoint\n"
24003 #: ../fish/guestfish-actions.pod:3126
24005 "This is the same as the L</mount> command, but it mounts the filesystem with "
24006 "the read-only (I<-o ro>) flag."
24010 #: ../fish/guestfish-actions.pod:3129
24015 #: ../fish/guestfish-actions.pod:3131
24018 " mount-vfs options vfstype device mountpoint\n"
24023 #: ../fish/guestfish-actions.pod:3133
24025 "This is the same as the L</mount> command, but it allows you to set both the "
24026 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
24030 #: ../fish/guestfish-actions.pod:3137
24031 msgid "mountpoints"
24035 #: ../fish/guestfish-actions.pod:3139
24043 #: ../fish/guestfish-actions.pod:3141
24045 "This call is similar to L</mounts>. That call returns a list of devices. "
24046 "This one returns a hash table (map) of device name to directory where the "
24047 "device is mounted."
24051 #: ../fish/guestfish-actions.pod:3145
24056 #: ../fish/guestfish-actions.pod:3147
24064 #: ../fish/guestfish-actions.pod:3154
24065 msgid "See also: L</mountpoints>"
24069 #: ../fish/guestfish-actions.pod:3156
24074 #: ../fish/guestfish-actions.pod:3158
24082 #: ../fish/guestfish-actions.pod:3163
24083 msgid "ntfs-3g-probe"
24087 #: ../fish/guestfish-actions.pod:3165
24090 " ntfs-3g-probe true|false device\n"
24095 #: ../fish/guestfish-actions.pod:3179
24100 #: ../fish/guestfish-actions.pod:3181
24103 " ntfsresize device\n"
24108 #: ../fish/guestfish-actions.pod:3187
24109 msgid "ntfsresize-size"
24113 #: ../fish/guestfish-actions.pod:3189
24116 " ntfsresize-size device size\n"
24121 #: ../fish/guestfish-actions.pod:3191
24123 "This command is the same as L</ntfsresize> except that it allows you to "
24124 "specify the new size (in bytes) explicitly."
24128 #: ../fish/guestfish-actions.pod:3194
24133 #: ../fish/guestfish-actions.pod:3196
24136 " part-add device prlogex startsect endsect\n"
24141 #: ../fish/guestfish-actions.pod:3198
24143 "This command adds a partition to C<device>. If there is no partition table "
24144 "on the device, call L</part-init> first."
24148 #: ../fish/guestfish-actions.pod:3210
24150 "Creating a partition which covers the whole disk is not so easy. Use "
24151 "L</part-disk> to do that."
24155 #: ../fish/guestfish-actions.pod:3213
24160 #: ../fish/guestfish-actions.pod:3215
24163 " part-del device partnum\n"
24168 #: ../fish/guestfish-actions.pod:3223
24173 #: ../fish/guestfish-actions.pod:3225
24176 " part-disk device parttype\n"
24181 #: ../fish/guestfish-actions.pod:3227
24183 "This command is simply a combination of L</part-init> followed by "
24184 "L</part-add> to create a single primary partition covering the whole disk."
24188 #: ../fish/guestfish-actions.pod:3231
24190 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
24191 "possible values are described in L</part-init>."
24195 #: ../fish/guestfish-actions.pod:3237
24196 msgid "part-get-bootable"
24200 #: ../fish/guestfish-actions.pod:3239
24203 " part-get-bootable device partnum\n"
24208 #: ../fish/guestfish-actions.pod:3244
24209 msgid "See also L</part-set-bootable>."
24213 #: ../fish/guestfish-actions.pod:3246
24214 msgid "part-get-mbr-id"
24218 #: ../fish/guestfish-actions.pod:3248
24221 " part-get-mbr-id device partnum\n"
24226 #: ../fish/guestfish-actions.pod:3253 ../fish/guestfish-actions.pod:3391
24228 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
24229 "undefined results for other partition table types (see "
24230 "L</part-get-parttype>)."
24234 #: ../fish/guestfish-actions.pod:3257
24235 msgid "part-get-parttype"
24239 #: ../fish/guestfish-actions.pod:3259
24242 " part-get-parttype device\n"
24247 #: ../fish/guestfish-actions.pod:3264
24249 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
24250 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
24251 "possible, although unusual. See L</part-init> for a full list."
24255 #: ../fish/guestfish-actions.pod:3269
24260 #: ../fish/guestfish-actions.pod:3271
24263 " part-init device parttype\n"
24268 #: ../fish/guestfish-actions.pod:3277
24270 "Initially there are no partitions. Following this, you should call "
24271 "L</part-add> for each partition required."
24275 #: ../fish/guestfish-actions.pod:3340
24280 #: ../fish/guestfish-actions.pod:3342
24283 " part-list device\n"
24288 #: ../fish/guestfish-actions.pod:3357
24290 "Start of the partition I<in bytes>. To get sectors you have to divide by "
24291 "the device's sector size, see L</blockdev-getss>."
24295 #: ../fish/guestfish-actions.pod:3370
24296 msgid "part-set-bootable"
24300 #: ../fish/guestfish-actions.pod:3372
24303 " part-set-bootable device partnum true|false\n"
24308 #: ../fish/guestfish-actions.pod:3381
24309 msgid "part-set-mbr-id"
24313 #: ../fish/guestfish-actions.pod:3383
24316 " part-set-mbr-id device partnum idbyte\n"
24321 #: ../fish/guestfish-actions.pod:3395
24322 msgid "part-set-name"
24326 #: ../fish/guestfish-actions.pod:3397
24329 " part-set-name device partnum name\n"
24334 #: ../fish/guestfish-actions.pod:3405
24335 msgid "part-to-dev"
24339 #: ../fish/guestfish-actions.pod:3407
24342 " part-to-dev partition\n"
24347 #: ../fish/guestfish-actions.pod:3413
24349 "The named partition must exist, for example as a string returned from "
24350 "L</list-partitions>."
24354 #: ../fish/guestfish-actions.pod:3416
24355 msgid "ping-daemon"
24359 #: ../fish/guestfish-actions.pod:3418
24367 #: ../fish/guestfish-actions.pod:3425
24372 #: ../fish/guestfish-actions.pod:3427
24375 " pread path count offset\n"
24380 #: ../fish/guestfish-actions.pod:3435
24381 msgid "See also L</pwrite>, L</pread-device>."
24385 #: ../fish/guestfish-actions.pod:3440
24386 msgid "pread-device"
24390 #: ../fish/guestfish-actions.pod:3442
24393 " pread-device device count offset\n"
24398 #: ../fish/guestfish-actions.pod:3450
24399 msgid "See also L</pread>."
24403 #: ../fish/guestfish-actions.pod:3455
24408 #: ../fish/guestfish-actions.pod:3457
24411 " pvcreate device\n"
24416 #: ../fish/guestfish-actions.pod:3463
24421 #: ../fish/guestfish-actions.pod:3465
24424 " pvremove device\n"
24429 #: ../fish/guestfish-actions.pod:3474
24434 #: ../fish/guestfish-actions.pod:3476
24437 " pvresize device\n"
24442 #: ../fish/guestfish-actions.pod:3481
24443 msgid "pvresize-size"
24447 #: ../fish/guestfish-actions.pod:3483
24450 " pvresize-size device size\n"
24455 #: ../fish/guestfish-actions.pod:3485
24457 "This command is the same as L</pvresize> except that it allows you to "
24458 "specify the new size (in bytes) explicitly."
24462 #: ../fish/guestfish-actions.pod:3488
24467 #: ../fish/guestfish-actions.pod:3490
24475 #: ../fish/guestfish-actions.pod:3498
24476 msgid "See also L</pvs-full>."
24480 #: ../fish/guestfish-actions.pod:3500
24485 #: ../fish/guestfish-actions.pod:3502
24493 #: ../fish/guestfish-actions.pod:3507
24498 #: ../fish/guestfish-actions.pod:3509
24506 #: ../fish/guestfish-actions.pod:3513
24511 #: ../fish/guestfish-actions.pod:3515
24514 " pwrite path content offset\n"
24519 #: ../fish/guestfish-actions.pod:3526
24520 msgid "See also L</pread>, L</pwrite-device>."
24524 #: ../fish/guestfish-actions.pod:3531
24525 msgid "pwrite-device"
24529 #: ../fish/guestfish-actions.pod:3533
24532 " pwrite-device device content offset\n"
24537 #: ../fish/guestfish-actions.pod:3543
24538 msgid "See also L</pwrite>."
24542 #: ../fish/guestfish-actions.pod:3548
24547 #: ../fish/guestfish-actions.pod:3550
24550 " read-file path\n"
24555 #: ../fish/guestfish-actions.pod:3555
24557 "Unlike L</cat>, this function can correctly handle files that contain "
24558 "embedded ASCII NUL characters. However unlike L</download>, this function "
24559 "is limited in the total size of file that can be handled."
24563 #: ../fish/guestfish-actions.pod:3563
24568 #: ../fish/guestfish-actions.pod:3565
24571 " read-lines path\n"
24576 #: ../fish/guestfish-actions.pod:3572
24578 "Note that this function cannot correctly handle binary files (specifically, "
24579 "files containing C<\\0> character which is treated as end of line). For "
24580 "those you need to use the L</read-file> function which has a more complex "
24585 #: ../fish/guestfish-actions.pod:3577
24590 #: ../fish/guestfish-actions.pod:3579
24598 #: ../fish/guestfish-actions.pod:3631
24600 "This function is primarily intended for use by programs. To get a simple "
24601 "list of names, use L</ls>. To get a printable directory for human "
24602 "consumption, use L</ll>."
24606 #: ../fish/guestfish-actions.pod:3635
24611 #: ../fish/guestfish-actions.pod:3637
24619 #: ../fish/guestfish-actions.pod:3641
24620 msgid "readlinklist"
24624 #: ../fish/guestfish-actions.pod:3643
24627 " readlinklist path 'names ...'\n"
24632 #: ../fish/guestfish-actions.pod:3667
24637 #: ../fish/guestfish-actions.pod:3669
24645 #: ../fish/guestfish-actions.pod:3674
24646 msgid "removexattr"
24650 #: ../fish/guestfish-actions.pod:3676
24653 " removexattr xattr path\n"
24658 #: ../fish/guestfish-actions.pod:3681
24659 msgid "See also: L</lremovexattr>, L<attr(5)>."
24663 #: ../fish/guestfish-actions.pod:3683
24668 #: ../fish/guestfish-actions.pod:3685
24671 " resize2fs device\n"
24676 #: ../fish/guestfish-actions.pod:3690
24678 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
24679 "before calling this command. For unknown reasons C<resize2fs> sometimes "
24680 "gives an error about this and sometimes not. In any case, it is always safe "
24681 "to call L</e2fsck-f> before calling this function."
24685 #: ../fish/guestfish-actions.pod:3696
24686 msgid "resize2fs-M"
24690 #: ../fish/guestfish-actions.pod:3698
24693 " resize2fs-M device\n"
24698 #: ../fish/guestfish-actions.pod:3700
24700 "This command is the same as L</resize2fs>, but the filesystem is resized to "
24701 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
24706 #: ../fish/guestfish-actions.pod:3704
24708 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
24709 "and read the C<Block size> and C<Block count> values. These two numbers, "
24710 "multiplied together, give the resulting size of the minimal filesystem in "
24715 #: ../fish/guestfish-actions.pod:3709
24716 msgid "resize2fs-size"
24720 #: ../fish/guestfish-actions.pod:3711
24723 " resize2fs-size device size\n"
24728 #: ../fish/guestfish-actions.pod:3713
24730 "This command is the same as L</resize2fs> except that it allows you to "
24731 "specify the new size (in bytes) explicitly."
24735 #: ../fish/guestfish-actions.pod:3716
24740 #: ../fish/guestfish-actions.pod:3718
24748 #: ../fish/guestfish-actions.pod:3722
24753 #: ../fish/guestfish-actions.pod:3724
24761 #: ../fish/guestfish-actions.pod:3730
24766 #: ../fish/guestfish-actions.pod:3732
24774 #: ../fish/guestfish-actions.pod:3736
24775 msgid "rmmountpoint"
24779 #: ../fish/guestfish-actions.pod:3738
24782 " rmmountpoint exemptpath\n"
24787 #: ../fish/guestfish-actions.pod:3740
24789 "This calls removes a mountpoint that was previously created with "
24790 "L</mkmountpoint>. See L</mkmountpoint> for full details."
24794 #: ../fish/guestfish-actions.pod:3744
24795 msgid "scrub-device"
24799 #: ../fish/guestfish-actions.pod:3746
24802 " scrub-device device\n"
24807 #: ../fish/guestfish-actions.pod:3757
24812 #: ../fish/guestfish-actions.pod:3759
24815 " scrub-file file\n"
24820 #: ../fish/guestfish-actions.pod:3769
24821 msgid "scrub-freespace"
24825 #: ../fish/guestfish-actions.pod:3771
24828 " scrub-freespace dir\n"
24833 #: ../fish/guestfish-actions.pod:3773
24835 "This command creates the directory C<dir> and then fills it with files until "
24836 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
24837 "deletes them. The intention is to scrub any free space on the partition "
24838 "containing C<dir>."
24842 #: ../fish/guestfish-actions.pod:3782
24847 #: ../fish/guestfish-actions.pod:3784
24852 #: ../fish/guestfish-actions.pod:3786
24855 " set-append append\n"
24860 #: ../fish/guestfish-actions.pod:3797
24861 msgid "set-attach-method"
24865 #: ../fish/guestfish-actions.pod:3799
24866 msgid "attach-method"
24870 #: ../fish/guestfish-actions.pod:3801
24873 " set-attach-method attachmethod\n"
24878 #: ../fish/guestfish-actions.pod:3823
24879 msgid "set-autosync"
24883 #: ../fish/guestfish-actions.pod:3825
24888 #: ../fish/guestfish-actions.pod:3827
24891 " set-autosync true|false\n"
24896 #: ../fish/guestfish-actions.pod:3837
24901 #: ../fish/guestfish-actions.pod:3839
24906 #: ../fish/guestfish-actions.pod:3841
24909 " set-direct true|false\n"
24914 #: ../fish/guestfish-actions.pod:3847
24916 "One consequence of this is that log messages aren't caught by the library "
24917 "and handled by L</set-log-message-callback>, but go straight to stdout."
24921 #: ../fish/guestfish-actions.pod:3856
24922 msgid "set-e2label"
24926 #: ../fish/guestfish-actions.pod:3858
24929 " set-e2label device label\n"
24934 #: ../fish/guestfish-actions.pod:3864
24936 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
24937 "label on a filesystem."
24941 #: ../fish/guestfish-actions.pod:3867
24946 #: ../fish/guestfish-actions.pod:3869
24949 " set-e2uuid device uuid\n"
24954 #: ../fish/guestfish-actions.pod:3876
24956 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
24957 "UUID of a filesystem."
24961 #: ../fish/guestfish-actions.pod:3879
24962 msgid "set-memsize"
24966 #: ../fish/guestfish-actions.pod:3881
24971 #: ../fish/guestfish-actions.pod:3883
24974 " set-memsize memsize\n"
24979 #: ../fish/guestfish-actions.pod:3885
24981 "This sets the memory size in megabytes allocated to the qemu subprocess. "
24982 "This only has any effect if called before L</launch>."
24986 #: ../fish/guestfish-actions.pod:3896
24987 msgid "set-network"
24991 #: ../fish/guestfish-actions.pod:3898
24996 #: ../fish/guestfish-actions.pod:3900
24999 " set-network true|false\n"
25004 #: ../fish/guestfish-actions.pod:3908
25005 msgid "You must call this before calling L</launch>, otherwise it has no effect."
25009 #: ../fish/guestfish-actions.pod:3911
25014 #: ../fish/guestfish-actions.pod:3913
25019 #: ../fish/guestfish-actions.pod:3915
25022 " set-path searchpath\n"
25027 #: ../fish/guestfish-actions.pod:3924
25032 #: ../fish/guestfish-actions.pod:3926
25037 #: ../fish/guestfish-actions.pod:3928
25045 #: ../fish/guestfish-actions.pod:3948
25046 msgid "set-recovery-proc"
25050 #: ../fish/guestfish-actions.pod:3950
25051 msgid "recovery-proc"
25055 #: ../fish/guestfish-actions.pod:3952
25058 " set-recovery-proc true|false\n"
25063 #: ../fish/guestfish-actions.pod:3954
25065 "If this is called with the parameter C<false> then L</launch> does not "
25066 "create a recovery process. The purpose of the recovery process is to stop "
25067 "runaway qemu processes in the case where the main program aborts abruptly."
25071 #: ../fish/guestfish-actions.pod:3959
25073 "This only has any effect if called before L</launch>, and the default is "
25078 #: ../fish/guestfish-actions.pod:3968
25079 msgid "set-selinux"
25083 #: ../fish/guestfish-actions.pod:3970
25088 #: ../fish/guestfish-actions.pod:3972
25091 " set-selinux true|false\n"
25096 #: ../fish/guestfish-actions.pod:3983
25101 #: ../fish/guestfish-actions.pod:3985
25106 #: ../fish/guestfish-actions.pod:3987
25109 " set-trace true|false\n"
25114 #: ../fish/guestfish-actions.pod:4003
25115 msgid "set-verbose"
25119 #: ../fish/guestfish-actions.pod:4005
25124 #: ../fish/guestfish-actions.pod:4007
25127 " set-verbose true|false\n"
25132 #: ../fish/guestfish-actions.pod:4014
25137 #: ../fish/guestfish-actions.pod:4016
25140 " setcon context\n"
25145 #: ../fish/guestfish-actions.pod:4023
25150 #: ../fish/guestfish-actions.pod:4025
25153 " setxattr xattr val vallen path\n"
25158 #: ../fish/guestfish-actions.pod:4031
25159 msgid "See also: L</lsetxattr>, L<attr(5)>."
25163 #: ../fish/guestfish-actions.pod:4033
25168 #: ../fish/guestfish-actions.pod:4035
25171 " sfdisk device cyls heads sectors 'lines ...'\n"
25176 #: ../fish/guestfish-actions.pod:4057
25177 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
25181 #: ../fish/guestfish-actions.pod:4063
25186 #: ../fish/guestfish-actions.pod:4065
25189 " sfdiskM device 'lines ...'\n"
25194 #: ../fish/guestfish-actions.pod:4067
25196 "This is a simplified interface to the L</sfdisk> command, where partition "
25197 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
25198 "you don't need to specify the cyls, heads and sectors parameters which were "
25199 "rarely if ever used anyway."
25203 #: ../fish/guestfish-actions.pod:4073
25204 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
25208 #: ../fish/guestfish-actions.pod:4079
25213 #: ../fish/guestfish-actions.pod:4081
25216 " sfdisk-N device partnum cyls heads sectors line\n"
25221 #: ../fish/guestfish-actions.pod:4086
25223 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
25224 "cyls/heads/sectors parameters."
25228 #: ../fish/guestfish-actions.pod:4089
25229 msgid "See also: L</part-add>"
25233 #: ../fish/guestfish-actions.pod:4094
25234 msgid "sfdisk-disk-geometry"
25238 #: ../fish/guestfish-actions.pod:4096
25241 " sfdisk-disk-geometry device\n"
25246 #: ../fish/guestfish-actions.pod:4098
25248 "This displays the disk geometry of C<device> read from the partition table. "
25249 "Especially in the case where the underlying block device has been resized, "
25250 "this can be different from the kernel's idea of the geometry (see "
25251 "L</sfdisk-kernel-geometry>)."
25255 #: ../fish/guestfish-actions.pod:4106
25256 msgid "sfdisk-kernel-geometry"
25260 #: ../fish/guestfish-actions.pod:4108
25263 " sfdisk-kernel-geometry device\n"
25268 #: ../fish/guestfish-actions.pod:4115
25273 #: ../fish/guestfish-actions.pod:4117
25276 " sfdisk-l device\n"
25281 #: ../fish/guestfish-actions.pod:4123
25282 msgid "See also: L</part-list>"
25286 #: ../fish/guestfish-actions.pod:4125
25291 #: ../fish/guestfish-actions.pod:4127
25299 #: ../fish/guestfish-actions.pod:4132
25300 msgid "This is like L</command>, but passes the command to:"
25304 #: ../fish/guestfish-actions.pod:4140
25305 msgid "All the provisos about L</command> apply to this call."
25309 #: ../fish/guestfish-actions.pod:4142
25314 #: ../fish/guestfish-actions.pod:4144
25317 " sh-lines command\n"
25322 #: ../fish/guestfish-actions.pod:4146
25323 msgid "This is the same as L</sh>, but splits the result into a list of lines."
25327 #: ../fish/guestfish-actions.pod:4149
25328 msgid "See also: L</command-lines>"
25332 #: ../fish/guestfish-actions.pod:4151
25337 #: ../fish/guestfish-actions.pod:4153
25345 #: ../fish/guestfish-actions.pod:4157
25350 #: ../fish/guestfish-actions.pod:4159
25358 #: ../fish/guestfish-actions.pod:4165
25363 #: ../fish/guestfish-actions.pod:4167
25371 #: ../fish/guestfish-actions.pod:4175
25376 #: ../fish/guestfish-actions.pod:4177
25384 #: ../fish/guestfish-actions.pod:4185
25389 #: ../fish/guestfish-actions.pod:4187
25392 " strings-e encoding path\n"
25397 #: ../fish/guestfish-actions.pod:4189
25399 "This is like the L</strings> command, but allows you to specify the encoding "
25400 "of strings that are looked for in the source file C<path>."
25404 #: ../fish/guestfish-actions.pod:4199
25406 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
25407 "ISO-8859-X (this is what L</strings> uses)."
25411 #: ../fish/guestfish-actions.pod:4231
25412 msgid "swapoff-device"
25416 #: ../fish/guestfish-actions.pod:4233
25419 " swapoff-device device\n"
25424 #: ../fish/guestfish-actions.pod:4235
25426 "This command disables the libguestfs appliance swap device or partition "
25427 "named C<device>. See L</swapon-device>."
25431 #: ../fish/guestfish-actions.pod:4239
25432 msgid "swapoff-file"
25436 #: ../fish/guestfish-actions.pod:4241
25439 " swapoff-file file\n"
25444 #: ../fish/guestfish-actions.pod:4245
25445 msgid "swapoff-label"
25449 #: ../fish/guestfish-actions.pod:4247
25452 " swapoff-label label\n"
25457 #: ../fish/guestfish-actions.pod:4252
25458 msgid "swapoff-uuid"
25462 #: ../fish/guestfish-actions.pod:4254
25465 " swapoff-uuid uuid\n"
25470 #: ../fish/guestfish-actions.pod:4259
25471 msgid "swapon-device"
25475 #: ../fish/guestfish-actions.pod:4261
25478 " swapon-device device\n"
25483 #: ../fish/guestfish-actions.pod:4263
25485 "This command enables the libguestfs appliance to use the swap device or "
25486 "partition named C<device>. The increased memory is made available for all "
25487 "commands, for example those run using L</command> or L</sh>."
25491 #: ../fish/guestfish-actions.pod:4275
25492 msgid "swapon-file"
25496 #: ../fish/guestfish-actions.pod:4277
25499 " swapon-file file\n"
25504 #: ../fish/guestfish-actions.pod:4279
25505 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
25509 #: ../fish/guestfish-actions.pod:4282
25510 msgid "swapon-label"
25514 #: ../fish/guestfish-actions.pod:4284
25517 " swapon-label label\n"
25522 #: ../fish/guestfish-actions.pod:4286
25524 "This command enables swap to a labeled swap partition. See "
25525 "L</swapon-device> for other notes."
25529 #: ../fish/guestfish-actions.pod:4289
25530 msgid "swapon-uuid"
25534 #: ../fish/guestfish-actions.pod:4291
25537 " swapon-uuid uuid\n"
25542 #: ../fish/guestfish-actions.pod:4293
25544 "This command enables swap to a swap partition with the given UUID. See "
25545 "L</swapon-device> for other notes."
25549 #: ../fish/guestfish-actions.pod:4296
25554 #: ../fish/guestfish-actions.pod:4298
25562 #: ../fish/guestfish-actions.pod:4306
25567 #: ../fish/guestfish-actions.pod:4308
25575 #: ../fish/guestfish-actions.pod:4316
25580 #: ../fish/guestfish-actions.pod:4318
25583 " tail-n nrlines path\n"
25588 #: ../fish/guestfish-actions.pod:4331
25593 #: ../fish/guestfish-actions.pod:4333
25596 " tar-in (tarfile|-) directory\n"
25601 #: ../fish/guestfish-actions.pod:4338
25602 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
25606 #: ../fish/guestfish-actions.pod:4343
25611 #: ../fish/guestfish-actions.pod:4345
25614 " tar-out directory (tarfile|-)\n"
25619 #: ../fish/guestfish-actions.pod:4350
25620 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
25624 #: ../fish/guestfish-actions.pod:4355
25629 #: ../fish/guestfish-actions.pod:4357
25632 " tgz-in (tarball|-) directory\n"
25637 #: ../fish/guestfish-actions.pod:4362
25638 msgid "To upload an uncompressed tarball, use L</tar-in>."
25642 #: ../fish/guestfish-actions.pod:4366
25647 #: ../fish/guestfish-actions.pod:4368
25650 " tgz-out directory (tarball|-)\n"
25655 #: ../fish/guestfish-actions.pod:4373
25656 msgid "To download an uncompressed tarball, use L</tar-out>."
25660 #: ../fish/guestfish-actions.pod:4377
25665 #: ../fish/guestfish-actions.pod:4379
25673 #: ../fish/guestfish-actions.pod:4388
25678 #: ../fish/guestfish-actions.pod:4390
25686 #: ../fish/guestfish-actions.pod:4395
25687 msgid "truncate-size"
25691 #: ../fish/guestfish-actions.pod:4397
25694 " truncate-size path size\n"
25699 #: ../fish/guestfish-actions.pod:4402
25701 "If the current file size is less than C<size> then the file is extended to "
25702 "the required size with zero bytes. This creates a sparse file (ie. disk "
25703 "blocks are not allocated for the file until you write to it). To create a "
25704 "non-sparse file of zeroes, use L</fallocate64> instead."
25708 #: ../fish/guestfish-actions.pod:4408
25713 #: ../fish/guestfish-actions.pod:4410
25716 " tune2fs-l device\n"
25721 #: ../fish/guestfish-actions.pod:4420
25726 #: ../fish/guestfish-actions.pod:4422
25729 " txz-in (tarball|-) directory\n"
25734 #: ../fish/guestfish-actions.pod:4429
25739 #: ../fish/guestfish-actions.pod:4431
25742 " txz-out directory (tarball|-)\n"
25747 #: ../fish/guestfish-actions.pod:4438
25752 #: ../fish/guestfish-actions.pod:4440
25760 #: ../fish/guestfish-actions.pod:4454
25761 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
25765 #: ../fish/guestfish-actions.pod:4459
25770 #: ../fish/guestfish-actions.pod:4461
25775 #: ../fish/guestfish-actions.pod:4463
25778 " umount pathordevice\n"
25783 #: ../fish/guestfish-actions.pod:4469
25788 #: ../fish/guestfish-actions.pod:4471
25789 msgid "unmount-all"
25793 #: ../fish/guestfish-actions.pod:4473
25801 #: ../fish/guestfish-actions.pod:4479
25806 #: ../fish/guestfish-actions.pod:4481
25809 " upload (filename|-) remotefilename\n"
25814 #: ../fish/guestfish-actions.pod:4488
25815 msgid "See also L</download>."
25819 #: ../fish/guestfish-actions.pod:4492
25820 msgid "upload-offset"
25824 #: ../fish/guestfish-actions.pod:4494
25827 " upload-offset (filename|-) remotefilename offset\n"
25832 #: ../fish/guestfish-actions.pod:4506
25834 "Note that there is no limit on the amount of data that can be uploaded with "
25835 "this call, unlike with L</pwrite>, and this call always writes the full "
25836 "amount unless an error occurs."
25840 #: ../fish/guestfish-actions.pod:4511
25841 msgid "See also L</upload>, L</pwrite>."
25845 #: ../fish/guestfish-actions.pod:4515
25850 #: ../fish/guestfish-actions.pod:4517
25853 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
25858 #: ../fish/guestfish-actions.pod:4536
25863 #: ../fish/guestfish-actions.pod:4538
25871 #: ../fish/guestfish-actions.pod:4565
25873 "I<Note:> Don't use this call to test for availability of features. In "
25874 "enterprise distributions we backport features from later versions into "
25875 "earlier versions, making this an unreliable way to test for features. Use "
25876 "L</available> instead."
25880 #: ../fish/guestfish-actions.pod:4571
25885 #: ../fish/guestfish-actions.pod:4573
25888 " vfs-label device\n"
25893 #: ../fish/guestfish-actions.pod:4580
25894 msgid "To find a filesystem from the label, use L</findfs-label>."
25898 #: ../fish/guestfish-actions.pod:4582
25903 #: ../fish/guestfish-actions.pod:4584
25906 " vfs-type device\n"
25911 #: ../fish/guestfish-actions.pod:4594
25916 #: ../fish/guestfish-actions.pod:4596
25919 " vfs-uuid device\n"
25924 #: ../fish/guestfish-actions.pod:4603
25925 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
25929 #: ../fish/guestfish-actions.pod:4605
25930 msgid "vg-activate"
25934 #: ../fish/guestfish-actions.pod:4607
25937 " vg-activate true|false 'volgroups ...'\n"
25942 #: ../fish/guestfish-actions.pod:4620
25943 msgid "vg-activate-all"
25947 #: ../fish/guestfish-actions.pod:4622
25950 " vg-activate-all true|false\n"
25955 #: ../fish/guestfish-actions.pod:4632
25960 #: ../fish/guestfish-actions.pod:4634
25963 " vgcreate volgroup 'physvols ...'\n"
25968 #: ../fish/guestfish-actions.pod:4639
25973 #: ../fish/guestfish-actions.pod:4641
25976 " vglvuuids vgname\n"
25981 #: ../fish/guestfish-actions.pod:4646
25983 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
25984 "logical volumes and volume groups."
25988 #: ../fish/guestfish-actions.pod:4649
25989 msgid "See also L</vgpvuuids>."
25993 #: ../fish/guestfish-actions.pod:4651
25998 #: ../fish/guestfish-actions.pod:4653
26001 " vgpvuuids vgname\n"
26006 #: ../fish/guestfish-actions.pod:4658
26008 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
26009 "physical volumes and volume groups."
26013 #: ../fish/guestfish-actions.pod:4661
26014 msgid "See also L</vglvuuids>."
26018 #: ../fish/guestfish-actions.pod:4663
26023 #: ../fish/guestfish-actions.pod:4665
26026 " vgremove vgname\n"
26031 #: ../fish/guestfish-actions.pod:4672
26036 #: ../fish/guestfish-actions.pod:4674
26039 " vgrename volgroup newvolgroup\n"
26044 #: ../fish/guestfish-actions.pod:4678
26049 #: ../fish/guestfish-actions.pod:4680
26057 #: ../fish/guestfish-actions.pod:4688
26058 msgid "See also L</vgs-full>."
26062 #: ../fish/guestfish-actions.pod:4690
26067 #: ../fish/guestfish-actions.pod:4692
26075 #: ../fish/guestfish-actions.pod:4697
26080 #: ../fish/guestfish-actions.pod:4699
26088 #: ../fish/guestfish-actions.pod:4704
26093 #: ../fish/guestfish-actions.pod:4706
26101 #: ../fish/guestfish-actions.pod:4710
26106 #: ../fish/guestfish-actions.pod:4712
26114 #: ../fish/guestfish-actions.pod:4717
26119 #: ../fish/guestfish-actions.pod:4719
26127 #: ../fish/guestfish-actions.pod:4724
26132 #: ../fish/guestfish-actions.pod:4726
26140 #: ../fish/guestfish-actions.pod:4731
26145 #: ../fish/guestfish-actions.pod:4733
26148 " write path content\n"
26153 #: ../fish/guestfish-actions.pod:4741
26158 #: ../fish/guestfish-actions.pod:4743
26161 " write-file path content size\n"
26166 #: ../fish/guestfish-actions.pod:4766
26171 #: ../fish/guestfish-actions.pod:4768
26174 " zegrep regex path\n"
26179 #: ../fish/guestfish-actions.pod:4776
26184 #: ../fish/guestfish-actions.pod:4778
26187 " zegrepi regex path\n"
26192 #: ../fish/guestfish-actions.pod:4786
26197 #: ../fish/guestfish-actions.pod:4788
26205 #: ../fish/guestfish-actions.pod:4796
26206 msgid "See also: L</zero-device>, L</scrub-device>."
26210 #: ../fish/guestfish-actions.pod:4798
26211 msgid "zero-device"
26215 #: ../fish/guestfish-actions.pod:4800
26218 " zero-device device\n"
26223 #: ../fish/guestfish-actions.pod:4802
26225 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
26226 "which just zeroes the first few blocks of a device."
26230 #: ../fish/guestfish-actions.pod:4809
26235 #: ../fish/guestfish-actions.pod:4811
26238 " zerofree device\n"
26243 #: ../fish/guestfish-actions.pod:4824
26248 #: ../fish/guestfish-actions.pod:4826
26251 " zfgrep pattern path\n"
26256 #: ../fish/guestfish-actions.pod:4834
26261 #: ../fish/guestfish-actions.pod:4836
26264 " zfgrepi pattern path\n"
26269 #: ../fish/guestfish-actions.pod:4844
26274 #: ../fish/guestfish-actions.pod:4846
26277 " zfile meth path\n"
26282 #: ../fish/guestfish-actions.pod:4853
26283 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
26287 #: ../fish/guestfish-actions.pod:4863
26292 #: ../fish/guestfish-actions.pod:4865
26295 " zgrep regex path\n"
26300 #: ../fish/guestfish-actions.pod:4873
26305 #: ../fish/guestfish-actions.pod:4875
26308 " zgrepi regex path\n"
26313 #: ../fish/guestfish-commands.pod:1
26318 #: ../fish/guestfish-commands.pod:3
26323 #: ../fish/guestfish-commands.pod:5
26326 " alloc filename size\n"
26331 #: ../fish/guestfish-commands.pod:7
26333 "This creates an empty (zeroed) file of the given size, and then adds so it "
26334 "can be further examined."
26338 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
26339 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
26343 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
26344 msgid "Size can be specified using standard suffixes, eg. C<1M>."
26348 #: ../fish/guestfish-commands.pod:14
26350 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
26351 "image, see L</PREPARED DISK IMAGES>."
26355 #: ../fish/guestfish-commands.pod:17
26360 #: ../fish/guestfish-commands.pod:19
26363 " copy-in local [local ...] /remotedir\n"
26368 #: ../fish/guestfish-commands.pod:21
26370 "C<copy-in> copies local files or directories recursively into the disk "
26371 "image, placing them in the directory called C</remotedir> (which must "
26372 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
26373 "other commands as necessary."
26377 #: ../fish/guestfish-commands.pod:26
26379 "Multiple local files and directories can be specified, but the last "
26380 "parameter must always be a remote directory. Wildcards cannot be used."
26384 #: ../fish/guestfish-commands.pod:30
26389 #: ../fish/guestfish-commands.pod:32
26392 " copy-out remote [remote ...] localdir\n"
26397 #: ../fish/guestfish-commands.pod:34
26399 "C<copy-out> copies remote files or directories recursively out of the disk "
26400 "image, placing them on the host disk in a local directory called C<localdir> "
26401 "(which must exist). This guestfish meta-command turns into a sequence of "
26402 "L</download>, L</tar-out> and other commands as necessary."
26406 #: ../fish/guestfish-commands.pod:40
26408 "Multiple remote files and directories can be specified, but the last "
26409 "parameter must always be a local directory. To download to the current "
26410 "directory, use C<.> as in:"
26414 #: ../fish/guestfish-commands.pod:44
26417 " copy-out /home .\n"
26422 #: ../fish/guestfish-commands.pod:46
26424 "Wildcards cannot be used in the ordinary command, but you can use them with "
26425 "the help of L</glob> like this:"
26429 #: ../fish/guestfish-commands.pod:49
26432 " glob copy-out /home/* .\n"
26437 #: ../fish/guestfish-commands.pod:51
26442 #: ../fish/guestfish-commands.pod:53
26445 " echo [params ...]\n"
26450 #: ../fish/guestfish-commands.pod:55
26451 msgid "This echos the parameters to the terminal."
26455 #: ../fish/guestfish-commands.pod:57
26460 #: ../fish/guestfish-commands.pod:59
26465 #: ../fish/guestfish-commands.pod:61
26470 #: ../fish/guestfish-commands.pod:63
26478 #: ../fish/guestfish-commands.pod:65
26480 "This is used to edit a file. It downloads the file, edits it locally using "
26481 "your editor, then uploads the result."
26485 #: ../fish/guestfish-commands.pod:68
26487 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
26488 "or C<emacs> you will get those corresponding editors."
26492 #: ../fish/guestfish-commands.pod:72
26497 #: ../fish/guestfish-commands.pod:74
26500 " glob command args...\n"
26505 #: ../fish/guestfish-commands.pod:76
26507 "Expand wildcards in any paths in the args list, and run C<command> "
26508 "repeatedly on each matching path."
26512 #: ../fish/guestfish-commands.pod:79
26513 msgid "See L</WILDCARDS AND GLOBBING>."
26517 #: ../fish/guestfish-commands.pod:81
26522 #: ../fish/guestfish-commands.pod:83
26525 " hexedit <filename|device>\n"
26526 " hexedit <filename|device> <max>\n"
26527 " hexedit <filename|device> <start> <max>\n"
26532 #: ../fish/guestfish-commands.pod:87
26534 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
26539 #: ../fish/guestfish-commands.pod:90
26541 "This command works by downloading potentially the whole file or device, "
26542 "editing it locally, then uploading it. If the file or device is large, you "
26543 "have to specify which part you wish to edit by using C<max> and/or C<start> "
26544 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
26545 "usual modifiers allowed such as C<1M> (1 megabyte)."
26549 #: ../fish/guestfish-commands.pod:97
26550 msgid "For example to edit the first few sectors of a disk you might do:"
26554 #: ../fish/guestfish-commands.pod:100
26557 " hexedit /dev/sda 1M\n"
26562 #: ../fish/guestfish-commands.pod:102
26564 "which would allow you to edit anywhere within the first megabyte of the "
26569 #: ../fish/guestfish-commands.pod:105
26570 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
26574 #: ../fish/guestfish-commands.pod:107
26577 " hexedit /dev/sda1 0x400 0x400\n"
26582 #: ../fish/guestfish-commands.pod:109
26583 msgid "(assuming the superblock is in the standard location)."
26587 #: ../fish/guestfish-commands.pod:111
26589 "This command requires the external L<hexedit(1)> program. You can specify "
26590 "another program to use by setting the C<HEXEDITOR> environment variable."
26594 #: ../fish/guestfish-commands.pod:115
26595 msgid "See also L</hexdump>."
26599 #: ../fish/guestfish-commands.pod:117
26604 #: ../fish/guestfish-commands.pod:119
26612 #: ../fish/guestfish-commands.pod:121
26613 msgid "Change the local directory, ie. the current directory of guestfish itself."
26617 #: ../fish/guestfish-commands.pod:124
26618 msgid "Note that C<!cd> won't do what you might expect."
26622 #: ../fish/guestfish-commands.pod:126
26627 #: ../fish/guestfish-commands.pod:128
26632 #: ../fish/guestfish-commands.pod:130
26640 #: ../fish/guestfish-commands.pod:132
26641 msgid "Opens the manual page for guestfish."
26645 #: ../fish/guestfish-commands.pod:134
26650 #: ../fish/guestfish-commands.pod:136
26655 #: ../fish/guestfish-commands.pod:138
26663 #: ../fish/guestfish-commands.pod:140
26671 #: ../fish/guestfish-commands.pod:142
26672 msgid "This is used to view a file."
26676 #: ../fish/guestfish-commands.pod:144
26678 "The default viewer is C<$PAGER>. However if you use the alternate command "
26679 "C<less> you will get the C<less> command specifically."
26683 #: ../fish/guestfish-commands.pod:147
26688 #: ../fish/guestfish-commands.pod:149
26696 #: ../fish/guestfish-commands.pod:151
26698 "Close and reopen the libguestfs handle. It is not necessary to use this "
26699 "normally, because the handle is closed properly when guestfish exits. "
26700 "However this is occasionally useful for testing."
26704 #: ../fish/guestfish-commands.pod:155
26709 #: ../fish/guestfish-commands.pod:157
26712 " sparse filename size\n"
26717 #: ../fish/guestfish-commands.pod:159
26719 "This creates an empty sparse file of the given size, and then adds so it can "
26720 "be further examined."
26724 #: ../fish/guestfish-commands.pod:162
26726 "In all respects it works the same as the L</alloc> command, except that the "
26727 "image file is allocated sparsely, which means that disk blocks are not "
26728 "assigned to the file until they are needed. Sparse disk files only use "
26729 "space when written to, but they are slower and there is a danger you could "
26730 "run out of real disk space during a write operation."
26734 #: ../fish/guestfish-commands.pod:172
26739 #: ../fish/guestfish-commands.pod:174
26747 #: ../fish/guestfish-commands.pod:176
26749 "This command returns a list of the optional groups known to the daemon, and "
26750 "indicates which ones are supported by this build of the libguestfs "
26755 #: ../fish/guestfish-commands.pod:180
26756 msgid "See also L<guestfs(3)/AVAILABILITY>."
26760 #: ../fish/guestfish-commands.pod:182
26765 #: ../fish/guestfish-commands.pod:184
26768 " time command args...\n"
26773 #: ../fish/guestfish-commands.pod:186
26775 "Run the command as usual, but print the elapsed time afterwards. This can "
26776 "be useful for benchmarking operations."
26780 #: ../test-tool/libguestfs-test-tool.pod:5
26781 msgid "libguestfs-test-tool - End user tests for libguestfs"
26785 #: ../test-tool/libguestfs-test-tool.pod:9
26788 " libguestfs-test-tool [--options]\n"
26793 #: ../test-tool/libguestfs-test-tool.pod:13
26795 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
26796 "and developers, to allow them to check basic libguestfs functionality is "
26797 "working. This is needed because libguestfs occasionally breaks for reasons "
26798 "beyond our control: usually because of changes in the underlying qemu or "
26799 "kernel packages, or the host environment."
26803 #: ../test-tool/libguestfs-test-tool.pod:20
26804 msgid "If you suspect a problem in libguestfs, then just run:"
26808 #: ../test-tool/libguestfs-test-tool.pod:22
26811 " libguestfs-test-tool\n"
26816 #: ../test-tool/libguestfs-test-tool.pod:24
26817 msgid "It will print lots of diagnostic messages."
26821 #: ../test-tool/libguestfs-test-tool.pod:26
26822 msgid "If it runs to completion successfully, you will see this near the end:"
26826 #: ../test-tool/libguestfs-test-tool.pod:28
26829 " ===== TEST FINISHED OK =====\n"
26834 #: ../test-tool/libguestfs-test-tool.pod:30
26835 msgid "and the test tool will exit with code 0."
26839 #: ../test-tool/libguestfs-test-tool.pod:32
26841 "If it fails (and/or exits with non-zero error code), please paste the "
26842 "B<complete, unedited> output of the test tool into a bug report. More "
26843 "information about reporting bugs can be found on the "
26844 "L<http://libguestfs.org/> website."
26848 #: ../test-tool/libguestfs-test-tool.pod:41
26853 #: ../test-tool/libguestfs-test-tool.pod:43
26854 msgid "Display short usage information and exit."
26858 #: ../test-tool/libguestfs-test-tool.pod:45
26859 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
26863 #: ../test-tool/libguestfs-test-tool.pod:47
26865 "Pass an alternate name for the helper program. libguestfs-test-tool will "
26866 "normally look in the C<$libexec> directory that was configured when the tool "
26871 #: ../test-tool/libguestfs-test-tool.pod:51
26872 msgid "I<--qemu qemu_binary>"
26876 #: ../test-tool/libguestfs-test-tool.pod:53
26878 "If you have downloaded another qemu binary, point this option at the full "
26879 "path of the binary to try it."
26883 #: ../test-tool/libguestfs-test-tool.pod:56
26884 msgid "I<--qemudir qemu_source_dir>"
26888 #: ../test-tool/libguestfs-test-tool.pod:58
26890 "If you have compiled qemu from source, point this option at the source "
26891 "directory to try it."
26895 #: ../test-tool/libguestfs-test-tool.pod:61
26896 msgid "I<--timeout N>"
26900 #: ../test-tool/libguestfs-test-tool.pod:63
26902 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
26903 "does not usually need to be adjusted unless your machine is very slow."
26907 #: ../test-tool/libguestfs-test-tool.pod:69
26908 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
26912 #: ../test-tool/libguestfs-test-tool.pod:71
26914 "If you have compiled another version of qemu from source and would like to "
26915 "try that, then you can use the I<--qemudir> option to point to the qemu "
26916 "source directory."
26920 #: ../test-tool/libguestfs-test-tool.pod:75
26922 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
26923 "option to point to the binary."
26927 #: ../test-tool/libguestfs-test-tool.pod:78
26929 "When using an alternate qemu with libguestfs, usually you would need to "
26930 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
26931 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
26932 "when you use either of the I<--qemudir> or I<--qemu> options."
26936 #: ../test-tool/libguestfs-test-tool.pod:85
26938 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
26939 "I<1> if there was an error."
26943 #: ../test-tool/libguestfs-test-tool.pod:92
26944 msgid "/usr/libexec/libguestfs-test-tool-helper"
26948 #: ../test-tool/libguestfs-test-tool.pod:94
26950 "This helper program is run inside the appliance and provides additional "
26955 #: ../test-tool/libguestfs-test-tool.pod:97
26956 msgid "/usr/bin/mkisofs"
26960 #: ../test-tool/libguestfs-test-tool.pod:99
26962 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
26963 "which is used as part of the tests."
26967 #: ../test-tool/libguestfs-test-tool.pod:106
26969 "For the full list of environment variables which may affect libguestfs, "
26970 "please see the L<guestfs(3)> manual page."
26974 #: ../test-tool/libguestfs-test-tool.pod:111
26975 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
26979 #: ../test-tool/libguestfs-test-tool.pod:121
26980 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
26984 #: ../fuse/guestmount.pod:5
26985 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
26989 #: ../fuse/guestmount.pod:9
26992 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
26997 #: ../fuse/guestmount.pod:11
27000 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
27005 #: ../fuse/guestmount.pod:13
27008 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
27013 #: ../fuse/guestmount.pod:17
27015 "You must I<not> use C<guestmount> in read-write mode on live virtual "
27016 "machines. If you do this, you risk disk corruption in the VM."
27020 #: ../fuse/guestmount.pod:22
27022 "The guestmount program can be used to mount virtual machine filesystems and "
27023 "other disk images on the host. It uses libguestfs for access to the guest "
27024 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
27025 "a mountable device."
27029 #: ../fuse/guestmount.pod:27
27031 "Along with other options, you have to give at least one device (I<-a> "
27032 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
27033 "option) or use the I<-i> inspection option. How this works is better "
27034 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
27039 #: ../fuse/guestmount.pod:33
27041 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
27042 "by you, and the filesystem will not be visible to any other users unless you "
27043 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
27044 "the filesystem, use the C<fusermount -u> command."
27048 #: ../fuse/guestmount.pod:41
27050 "For a typical Windows guest which has its main filesystem on the first "
27055 #: ../fuse/guestmount.pod:44
27058 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
27063 #: ../fuse/guestmount.pod:46
27065 "For a typical Linux guest which has a /boot filesystem on the first "
27066 "partition, and the root filesystem on a logical volume:"
27070 #: ../fuse/guestmount.pod:49
27073 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
27078 #: ../fuse/guestmount.pod:51
27079 msgid "To get libguestfs to detect guest mountpoints for you:"
27083 #: ../fuse/guestmount.pod:53
27086 " guestmount -a guest.img -i --ro /mnt\n"
27091 #: ../fuse/guestmount.pod:55
27092 msgid "For a libvirt guest called \"Guest\" you could do:"
27096 #: ../fuse/guestmount.pod:57
27099 " guestmount -d Guest -i --ro /mnt\n"
27104 #: ../fuse/guestmount.pod:59
27106 "If you don't know what filesystems are contained in a guest or disk image, "
27107 "use L<virt-filesystems(1)> first:"
27111 #: ../fuse/guestmount.pod:62
27114 " virt-filesystems MyGuest\n"
27119 #: ../fuse/guestmount.pod:64
27121 "If you want to trace the libguestfs calls but without excessive debugging "
27122 "information, we recommend:"
27126 #: ../fuse/guestmount.pod:67
27129 " guestmount [...] --trace /mnt\n"
27134 #: ../fuse/guestmount.pod:69
27135 msgid "If you want to debug the program, we recommend:"
27139 #: ../fuse/guestmount.pod:71
27142 " guestmount [...] --trace --verbose /mnt\n"
27147 #: ../fuse/guestmount.pod:77
27148 msgid "B<-a image> | B<--add image>"
27152 #: ../fuse/guestmount.pod:79
27153 msgid "Add a block device or virtual machine image."
27157 #: ../fuse/guestmount.pod:84
27158 msgid "B<-c URI> | B<--connect URI>"
27162 #: ../fuse/guestmount.pod:90
27163 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
27167 #: ../fuse/guestmount.pod:96
27168 msgid "B<--dir-cache-timeout N>"
27172 #: ../fuse/guestmount.pod:98
27174 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
27175 "seconds. The readdir cache [actually, there are several semi-independent "
27176 "caches] is populated after a readdir(2) call with the stat and extended "
27177 "attributes of the files in the directory, in anticipation that they will be "
27178 "requested soon after."
27182 #: ../fuse/guestmount.pod:104
27184 "There is also a different attribute cache implemented by FUSE (see the FUSE "
27185 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
27186 "requests, only cache existing ones."
27190 #: ../fuse/guestmount.pod:115
27191 msgid "B<--format=raw|qcow2|..> | B<--format>"
27195 #: ../fuse/guestmount.pod:122
27197 "If you have untrusted raw-format guest disk images, you should use this "
27198 "option to specify the disk format. This avoids a possible security problem "
27199 "with malicious guests (CVE-2010-3851). See also "
27200 "L<guestfs(3)/guestfs_add_drive_opts>."
27204 #: ../fuse/guestmount.pod:127
27205 msgid "B<--fuse-help>"
27209 #: ../fuse/guestmount.pod:129
27210 msgid "Display help on special FUSE options (see I<-o> below)."
27214 #: ../fuse/guestmount.pod:133
27215 msgid "Display brief help and exit."
27219 #: ../fuse/guestmount.pod:135
27220 msgid "B<-i> | B<--inspector>"
27224 #: ../fuse/guestmount.pod:151
27225 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
27229 #: ../fuse/guestmount.pod:153
27231 "Mount the named partition or logical volume on the given mountpoint B<in the "
27232 "guest> (this has nothing to do with mountpoints in the host)."
27236 #: ../fuse/guestmount.pod:156
27238 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
27239 "something on C</>."
27243 #: ../fuse/guestmount.pod:159
27244 msgid "B<-n> | B<--no-sync>"
27248 #: ../fuse/guestmount.pod:161
27250 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
27251 "unmounted. If you specify this option, then we don't attempt to sync the "
27252 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
27256 #: ../fuse/guestmount.pod:166
27257 msgid "B<-o option> | B<--option option>"
27261 #: ../fuse/guestmount.pod:168
27262 msgid "Pass extra options to FUSE."
27266 #: ../fuse/guestmount.pod:170
27268 "To get a list of all the extra options supported by FUSE, use the command "
27269 "below. Note that only the FUSE I<-o> options can be passed, and only some "
27270 "of them are a good idea."
27274 #: ../fuse/guestmount.pod:174
27277 " guestmount --fuse-help\n"
27282 #: ../fuse/guestmount.pod:176
27283 msgid "Some potentially useful FUSE options:"
27287 #: ../fuse/guestmount.pod:180
27288 msgid "B<-o allow_other>"
27292 #: ../fuse/guestmount.pod:182
27293 msgid "Allow other users to see the filesystem."
27297 #: ../fuse/guestmount.pod:184
27298 msgid "B<-o attr_timeout=N>"
27302 #: ../fuse/guestmount.pod:186
27303 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
27307 #: ../fuse/guestmount.pod:188
27308 msgid "B<-o kernel_cache>"
27312 #: ../fuse/guestmount.pod:190
27314 "Allow the kernel to cache files (reduces the number of reads that have to go "
27315 "through the L<guestfs(3)> API). This is generally a good idea if you can "
27316 "afford the extra memory usage."
27320 #: ../fuse/guestmount.pod:194
27321 msgid "B<-o uid=N> B<-o gid=N>"
27325 #: ../fuse/guestmount.pod:196
27327 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
27328 "the chosen values."
27332 #: ../fuse/guestmount.pod:201
27333 msgid "B<-r> | B<--ro>"
27337 #: ../fuse/guestmount.pod:203
27339 "Add devices and mount everything read-only. Also disallow writes and make "
27340 "the disk appear read-only to FUSE."
27344 #: ../fuse/guestmount.pod:206
27346 "This is highly recommended if you are not going to edit the guest disk. If "
27347 "the guest is running and this option is I<not> supplied, then there is a "
27348 "strong risk of disk corruption in the guest. We try to prevent this from "
27349 "happening, but it is not always possible."
27353 #: ../fuse/guestmount.pod:211
27354 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
27358 #: ../fuse/guestmount.pod:215
27359 msgid "Enable SELinux support for the guest."
27363 #: ../fuse/guestmount.pod:217
27364 msgid "B<-v> | B<--verbose>"
27368 #: ../fuse/guestmount.pod:219
27369 msgid "Enable verbose messages from underlying libguestfs."
27373 #: ../fuse/guestmount.pod:221
27374 msgid "B<-V> | B<--version>"
27378 #: ../fuse/guestmount.pod:223
27379 msgid "Display the program version and exit."
27383 #: ../fuse/guestmount.pod:225
27384 msgid "B<-w> | B<--rw>"
27388 #: ../fuse/guestmount.pod:227
27390 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
27391 "FOR READ AND WRITE>."
27395 #: ../fuse/guestmount.pod:230
27396 msgid "B<-x> | B<--trace>"
27400 #: ../fuse/guestmount.pod:232
27401 msgid "Trace libguestfs calls and entry into each FUSE function."
27405 #: ../fuse/guestmount.pod:234
27406 msgid "This also stops the daemon from forking into the background."
27410 #: ../fuse/guestmount.pod:240
27412 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
27413 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
27414 "L<http://fuse.sf.net/>."
27418 #: ../tools/virt-edit.pl:34
27419 msgid "virt-edit - Edit a file in a virtual machine"
27423 #: ../tools/virt-edit.pl:38
27426 " virt-edit [--options] domname file\n"
27431 #: ../tools/virt-edit.pl:40
27434 " virt-edit [--options] disk.img [disk.img ...] file\n"
27439 #: ../tools/virt-edit.pl:42
27442 " virt-edit [domname|disk.img] file -e 'expr'\n"
27447 #: ../tools/virt-edit.pl:46
27449 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
27450 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
27451 "doing this, but doesn't catch all cases."
27455 #: ../tools/virt-edit.pl:52
27457 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
27458 "the named virtual machine (or disk image)."
27462 #: ../tools/virt-edit.pl:55
27464 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
27465 "you should look at the L<guestfish(1)> tool."
27469 #: ../tools/virt-edit.pl:60
27470 msgid "Edit the named files interactively:"
27474 #: ../tools/virt-edit.pl:62
27477 " virt-edit mydomain /boot/grub/grub.conf\n"
27482 #: ../tools/virt-edit.pl:64
27485 " virt-edit mydomain /etc/passwd\n"
27490 #: ../tools/virt-edit.pl:66
27492 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
27493 "below). To change the init default level to 5:"
27497 #: ../tools/virt-edit.pl:70
27500 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
27505 #: ../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
27506 msgid "Display brief help."
27510 #: ../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
27511 msgid "Display version number and exit."
27515 #: ../tools/virt-edit.pl:96
27516 msgid "B<--backup extension> | B<-b extension>"
27520 #: ../tools/virt-edit.pl:98
27522 "Create a backup of the original file I<in the guest disk image>. The backup "
27523 "has the original filename with C<extension> added."
27527 #: ../tools/virt-edit.pl:101
27529 "Usually the first character of C<extension> would be a dot C<.> so you would "
27534 #: ../tools/virt-edit.pl:104
27537 " virt-edit -b .orig [etc]\n"
27542 #: ../tools/virt-edit.pl:106
27543 msgid "By default, no backup file is made."
27547 #: ../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
27548 msgid "B<--connect URI> | B<-c URI>"
27552 #: ../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
27554 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
27555 "to the default libvirt hypervisor."
27559 #: ../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
27561 "If you specify guest block devices directly, then libvirt is not used at "
27566 #: ../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
27567 msgid "B<--format> raw"
27571 #: ../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
27573 "Specify the format of disk images given on the command line. If this is "
27574 "omitted then the format is autodetected from the content of the disk image."
27578 #: ../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
27580 "If disk images are requested from libvirt, then this program asks libvirt "
27581 "for this information. In this case, the value of the format parameter is "
27586 #: ../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
27588 "If working with untrusted raw-format guest disk images, you should ensure "
27589 "the format is always specified."
27593 #: ../tools/virt-edit.pl:141
27594 msgid "B<--expr EXPR> | B<-e EXPR>"
27598 #: ../tools/virt-edit.pl:143
27600 "Instead of launching the external editor, non-interactively apply the Perl "
27601 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
27606 #: ../tools/virt-edit.pl:147
27608 "Be careful to properly quote the expression to prevent it from being altered "
27613 #: ../tools/virt-edit.pl:268
27614 msgid "NON-INTERACTIVE EDITING"
27618 #: ../tools/virt-edit.pl:270
27620 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
27621 "administrator can interactively edit the file."
27625 #: ../tools/virt-edit.pl:273
27627 "There are two ways also to use C<virt-edit> from scripts in order to make "
27628 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
27629 "like this, it's less error-prone to write scripts directly using the "
27630 "libguestfs API and Augeas for configuration file editing.)"
27634 #: ../tools/virt-edit.pl:279
27636 "The first method is to temporarily set C<$EDITOR> to any script or program "
27637 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
27638 "update C<tmpfile> in place however it likes."
27642 #: ../tools/virt-edit.pl:283
27644 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
27645 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
27646 "instances of C<foo> with C<bar> in a file:"
27650 #: ../tools/virt-edit.pl:287
27653 " virt-edit domname filename -e 's/foo/bar/'\n"
27658 #: ../tools/virt-edit.pl:289
27660 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
27661 "For example to delete root's password you could do:"
27665 #: ../tools/virt-edit.pl:292
27668 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
27673 #: ../tools/virt-edit.pl:294
27675 "What really happens is that the snippet is evaluated as a Perl expression "
27676 "for each line of the file. The line, including the final C<\\n>, is passed "
27677 "in C<$_> and the expression should update C<$_> or leave it unchanged."
27681 #: ../tools/virt-edit.pl:299
27683 "To delete a line, set C<$_> to the empty string. For example, to delete the "
27684 "C<apache> user account from the password file you can do:"
27688 #: ../tools/virt-edit.pl:302
27691 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
27696 #: ../tools/virt-edit.pl:304
27698 "To insert a line, prepend or append it to C<$_>. However appending lines to "
27699 "the end of the file is rather difficult this way since there is no concept "
27700 "of \"last line of the file\" - your expression just doesn't get called "
27701 "again. You might want to use the first method (setting C<$EDITOR>) if you "
27706 #: ../tools/virt-edit.pl:310
27708 "The variable C<$lineno> contains the current line number. As is "
27709 "traditional, the first line in the file is number C<1>."
27713 #: ../tools/virt-edit.pl:313
27715 "The return value from the expression is ignored, but the expression may call "
27716 "C<die> in order to abort the whole program, leaving the original file "
27721 #: ../tools/virt-edit.pl:317
27723 "Remember when matching the end of a line that C<$_> may contain the final "
27724 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
27725 "newline then neither of these. Thus to match or substitute some text at the "
27726 "end of a line, use this regular expression:"
27730 #: ../tools/virt-edit.pl:322
27733 " /some text(\\r?\\n)?$/\n"
27738 #: ../tools/virt-edit.pl:324
27740 "Alternately, use the perl C<chomp> function, being careful not to chomp "
27741 "C<$_> itself (since that would remove all newlines from the file):"
27745 #: ../tools/virt-edit.pl:328
27748 " my $m = $_; chomp $m; $m =~ /some text$/\n"
27753 #: ../tools/virt-edit.pl:334
27758 #: ../tools/virt-edit.pl:336
27760 "If set, this string is used as the editor. It may contain arguments, "
27761 "eg. C<\"emacs -nw\">"
27765 #: ../tools/virt-edit.pl:339
27766 msgid "If not set, C<vi> is used."
27770 #: ../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:532 ../tools/virt-list-partitions.pl:250
27771 msgid "SHELL QUOTING"
27775 #: ../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:534 ../tools/virt-list-partitions.pl:252
27777 "Libvirt guest names can contain arbitrary characters, some of which have "
27778 "meaning to the shell such as C<#> and space. You may need to quote or "
27779 "escape these characters on the command line. See the shell manual page "
27780 "L<sh(1)> for details."
27784 #: ../tools/virt-edit.pl:352
27786 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
27787 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27788 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
27792 #: ../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:564 ../tools/virt-list-partitions.pl:269
27797 #: ../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:566 ../tools/virt-list-partitions.pl:271
27798 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
27802 #: ../tools/virt-edit.pl:370 ../tools/virt-list-partitions.pl:275
27803 msgid "Copyright (C) 2009-2010 Red Hat Inc."
27807 #: ../tools/virt-win-reg.pl:37
27809 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
27814 #: ../tools/virt-win-reg.pl:41
27817 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
27822 #: ../tools/virt-win-reg.pl:43
27825 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
27830 #: ../tools/virt-win-reg.pl:45
27833 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
27838 #: ../tools/virt-win-reg.pl:47
27841 " virt-win-reg --merge domname [input.reg ...]\n"
27846 #: ../tools/virt-win-reg.pl:49
27849 " virt-win-reg [--options] disk.img ... # instead of domname\n"
27854 #: ../tools/virt-win-reg.pl:53
27856 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
27857 "virtual machines. If you do this, you I<will> get irreversible disk "
27858 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
27859 "but doesn't catch all cases."
27863 #: ../tools/virt-win-reg.pl:58
27865 "Modifying the Windows Registry is an inherently risky operation. The format "
27866 "is deliberately obscure and undocumented, and Registry changes can leave the "
27867 "system unbootable. Therefore when using the C<--merge> option, make sure "
27868 "you have a reliable backup first."
27872 #: ../tools/virt-win-reg.pl:65
27874 "This program can export and merge Windows Registry entries from a Windows "
27879 #: ../tools/virt-win-reg.pl:68
27881 "The first parameter is the libvirt guest name or the raw disk image of a "
27886 #: ../tools/virt-win-reg.pl:71
27888 "If C<--merge> is I<not> specified, then the chosen registry key is "
27889 "displayed/exported (recursively). For example:"
27893 #: ../tools/virt-win-reg.pl:74
27896 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
27901 #: ../tools/virt-win-reg.pl:76
27902 msgid "You can also display single values from within registry keys, for example:"
27906 #: ../tools/virt-win-reg.pl:79
27909 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
27910 " $ virt-win-reg Windows7 $cvkey ProductName\n"
27911 " Windows 7 Enterprise\n"
27916 #: ../tools/virt-win-reg.pl:83
27918 "With C<--merge>, you can merge a textual regedit file into the Windows "
27923 #: ../tools/virt-win-reg.pl:86
27926 " $ virt-win-reg --merge Windows7 changes.reg\n"
27931 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
27936 #: ../tools/virt-win-reg.pl:90
27938 "This program is only meant for simple access to the registry. If you want "
27939 "to do complicated things with the registry, we suggest you download the "
27940 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27941 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27942 "L<hivexregedit(1)>."
27946 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
27951 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
27952 msgid "Enable debugging messages."
27956 #: ../tools/virt-win-reg.pl:157
27961 #: ../tools/virt-win-reg.pl:159
27963 "In merge mode, this merges a textual regedit file into the Windows Registry "
27964 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27965 "displays or exports Registry entries instead."
27969 #: ../tools/virt-win-reg.pl:163
27971 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27972 "result in disk corruption. However exporting (without this flag) is always "
27977 #: ../tools/virt-win-reg.pl:171
27978 msgid "B<--encoding> UTF-16LE|ASCII"
27982 #: ../tools/virt-win-reg.pl:173
27984 "When merging (only), you may need to specify the encoding for strings to be "
27985 "used in the hive file. This is explained in detail in "
27986 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
27990 #: ../tools/virt-win-reg.pl:177
27992 "The default is to use UTF-16LE, which should work with recent versions of "
27997 #: ../tools/virt-win-reg.pl:402
27998 msgid "SUPPORTED SYSTEMS"
28002 #: ../tools/virt-win-reg.pl:404
28004 "The program currently supports Windows NT-derived guests starting with "
28005 "Windows XP through to at least Windows 7."
28009 #: ../tools/virt-win-reg.pl:407
28011 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
28012 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
28013 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
28017 #: ../tools/virt-win-reg.pl:411
28019 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
28024 #: ../tools/virt-win-reg.pl:414
28026 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
28031 #: ../tools/virt-win-reg.pl:417
28036 #: ../tools/virt-win-reg.pl:419
28038 "C<virt-win-reg> expects that regedit files have already been reencoded in "
28039 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
28040 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
28041 "with Windows-style line endings, you may need to reencode the whole file "
28042 "before or after processing."
28046 #: ../tools/virt-win-reg.pl:425
28048 "To reencode a file from Windows format to Linux (before processing it with "
28049 "the C<--merge> option), you would do something like this:"
28053 #: ../tools/virt-win-reg.pl:428
28056 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
28061 #: ../tools/virt-win-reg.pl:430
28063 "To go in the opposite direction, after exporting and before sending the file "
28064 "to a Windows user, do something like this:"
28068 #: ../tools/virt-win-reg.pl:433
28071 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
28076 #: ../tools/virt-win-reg.pl:435
28077 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
28081 #: ../tools/virt-win-reg.pl:437
28083 "If you are unsure about the current encoding, use the L<file(1)> command. "
28084 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
28085 "Windows-style (CRLF) line endings, like this:"
28089 #: ../tools/virt-win-reg.pl:441
28092 " $ file software.reg\n"
28093 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
28094 " with CRLF line terminators\n"
28099 #: ../tools/virt-win-reg.pl:445
28100 msgid "This file would need conversion before you could C<--merge> it."
28104 #: ../tools/virt-win-reg.pl:447
28105 msgid "CurrentControlSet etc."
28109 #: ../tools/virt-win-reg.pl:449
28111 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
28112 "Registry at the level of the hive file, and therefore you cannot modify "
28117 #: ../tools/virt-win-reg.pl:453
28119 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
28120 "circumstances it might refer to another control set. The way to find out is "
28121 "to look at the C<HKLM\\SYSTEM\\Select> key:"
28125 #: ../tools/virt-win-reg.pl:457
28128 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
28129 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
28130 " \"Current\"=dword:00000001\n"
28131 " \"Default\"=dword:00000001\n"
28132 " \"Failed\"=dword:00000000\n"
28133 " \"LastKnownGood\"=dword:00000002\n"
28138 #: ../tools/virt-win-reg.pl:464
28139 msgid "\"Current\" is the one which Windows will choose when it boots."
28143 #: ../tools/virt-win-reg.pl:466
28144 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
28148 #: ../tools/virt-win-reg.pl:469
28149 msgid "WINDOWS TIPS"
28153 #: ../tools/virt-win-reg.pl:471
28155 "Note that some of these tips modify the guest disk image. The guest I<must> "
28156 "be shut off, else you will get disk corruption."
28160 #: ../tools/virt-win-reg.pl:474
28161 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
28165 #: ../tools/virt-win-reg.pl:476
28167 "Prepare a DOS batch script, VBScript or executable. Upload this using "
28168 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
28169 "is uploaded into C<C:\\>:"
28173 #: ../tools/virt-win-reg.pl:480
28176 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
28181 #: ../tools/virt-win-reg.pl:482
28182 msgid "Prepare a regedit file containing the registry change:"
28186 #: ../tools/virt-win-reg.pl:484
28189 " cat > test.reg <<'EOF'\n"
28190 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
28191 " \"Test\"=\"c:\\\\test.bat\"\n"
28197 #: ../tools/virt-win-reg.pl:489
28199 "In this example we use the key C<RunOnce> which means that the script will "
28200 "run precisely once when the first user logs in. If you want it to run every "
28201 "time a user logs in, replace C<RunOnce> with C<Run>."
28205 #: ../tools/virt-win-reg.pl:493
28206 msgid "Now update the registry:"
28210 #: ../tools/virt-win-reg.pl:495
28213 " virt-win-reg --merge WindowsGuest test.reg\n"
28218 #: ../tools/virt-win-reg.pl:497
28219 msgid "INSTALLING A SERVICE"
28223 #: ../tools/virt-win-reg.pl:499
28225 "This section assumes you are familiar with Windows services, and you either "
28226 "have a program which handles the Windows Service Control Protocol directly "
28227 "or you want to run any program using a service wrapper like SrvAny or the "
28232 #: ../tools/virt-win-reg.pl:504
28234 "First upload the program and optionally the service wrapper. In this case "
28235 "the test program is called C<test.exe> and we are using the RHSrvAny "
28240 #: ../tools/virt-win-reg.pl:508
28243 " guestfish -i -d WindowsGuest <<EOF\n"
28244 " upload rhsrvany.exe /rhsrvany.exe\n"
28245 " upload test.exe /test.exe\n"
28251 #: ../tools/virt-win-reg.pl:513
28253 "Prepare a regedit file containing the registry changes. In this example, "
28254 "the first registry change is needed for the service itself or the service "
28255 "wrapper (if used). The second registry change is only needed because I am "
28256 "using the RHSrvAny service wrapper."
28260 #: ../tools/virt-win-reg.pl:518
28263 " cat > service.reg <<'EOF'\n"
28264 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
28265 " \"Type\"=dword:00000010\n"
28266 " \"Start\"=dword:00000002\n"
28267 " \"ErrorControl\"=dword:00000001\n"
28268 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
28269 " \"DisplayName\"=\"RHSrvAny\"\n"
28270 " \"ObjectName\"=\"NetworkService\"\n"
28275 #: ../tools/virt-win-reg.pl:527
28278 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
28279 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
28280 " \"PWD\"=\"c:\\\\Temp\"\n"
28286 #: ../tools/virt-win-reg.pl:538
28288 "For use of C<ControlSet001> see the section above in this manual page. You "
28289 "may need to adjust this according to the control set that is in use by the "
28294 #: ../tools/virt-win-reg.pl:544
28296 "C<\"ObjectName\"> controls the privileges that the service will have. An "
28297 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
28298 "privileged account."
28302 #: ../tools/virt-win-reg.pl:550
28304 "For the meaning of the magic numbers, see this Microsoft KB article: "
28305 "L<http://support.microsoft.com/kb/103000>."
28309 #: ../tools/virt-win-reg.pl:555
28310 msgid "Update the registry:"
28314 #: ../tools/virt-win-reg.pl:557
28317 " virt-win-reg --merge WindowsGuest service.reg\n"
28322 #: ../tools/virt-win-reg.pl:561
28324 "Be careful when passing parameters containing C<\\> (backslash) in the "
28325 "shell. Usually you will have to use 'single quotes' or double backslashes "
28326 "(but not both) to protect them from the shell."
28330 #: ../tools/virt-win-reg.pl:565
28331 msgid "Paths and value names are case-insensitive."
28335 #: ../tools/virt-win-reg.pl:574
28337 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
28338 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
28339 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
28340 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28344 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
28346 "When reporting bugs, please enable debugging and capture the I<complete> "
28351 #: ../tools/virt-win-reg.pl:592
28354 " export LIBGUESTFS_DEBUG=1\n"
28355 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
28360 #: ../tools/virt-win-reg.pl:595
28362 "Attach /tmp/virt-win-reg.log to a new bug report at "
28363 "L<https://bugzilla.redhat.com/>"
28367 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:570
28368 msgid "Copyright (C) 2010 Red Hat Inc."
28372 #: ../tools/virt-resize.pl:42
28373 msgid "virt-resize - Resize a virtual machine disk"
28377 #: ../tools/virt-resize.pl:46
28380 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
28381 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
28382 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
28387 #: ../tools/virt-resize.pl:52
28389 "Virt-resize is a tool which can resize a virtual machine disk, making it "
28390 "larger or smaller overall, and resizing or deleting any partitions contained "
28395 #: ../tools/virt-resize.pl:56
28397 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
28398 "not> be used on live virtual machines - for consistent results, shut the "
28399 "virtual machine down before resizing it."
28403 #: ../tools/virt-resize.pl:60
28405 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
28406 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
28410 #: ../tools/virt-resize.pl:66
28412 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
28413 "fill the extra 5GB of space."
28417 #: ../tools/virt-resize.pl:69
28420 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
28421 " virt-filesystems --long -h --all -a olddisk\n"
28422 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
28423 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
28428 #: ../tools/virt-resize.pl:74
28430 "As above, but make the /boot partition 200MB bigger, while giving the "
28431 "remaining space to /dev/sda2:"
28435 #: ../tools/virt-resize.pl:77
28438 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
28443 #: ../tools/virt-resize.pl:79
28444 msgid "As above, but the output format will be uncompressed qcow2:"
28448 #: ../tools/virt-resize.pl:81
28451 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
28452 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
28457 #: ../tools/virt-resize.pl:84
28458 msgid "DETAILED USAGE"
28462 #: ../tools/virt-resize.pl:86
28463 msgid "EXPANDING A VIRTUAL MACHINE DISK"
28467 #: ../tools/virt-resize.pl:90
28468 msgid "1. Shut down the virtual machine"
28472 #: ../tools/virt-resize.pl:92
28473 msgid "2. Locate input disk image"
28477 #: ../tools/virt-resize.pl:94
28479 "Locate the input disk image (ie. the file or device on the host containing "
28480 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
28481 "dumpxml> like this to find the disk image name:"
28485 #: ../tools/virt-resize.pl:98
28488 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
28489 " Found 1 nodes:\n"
28491 " <source dev=\"/dev/vg/lv_guest\" />\n"
28496 #: ../tools/virt-resize.pl:103
28497 msgid "3. Look at current sizing"
28501 #: ../tools/virt-resize.pl:105
28502 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
28506 #: ../tools/virt-resize.pl:108
28509 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
28510 " Name Type Size Parent\n"
28511 " /dev/sda1 partition 101M /dev/sda\n"
28512 " /dev/sda2 partition 7.9G /dev/sda\n"
28513 " /dev/sda device 8.0G -\n"
28518 #: ../tools/virt-resize.pl:114
28520 "(This example is a virtual machine with an 8 GB disk which we would like to "
28521 "expand up to 10 GB)."
28525 #: ../tools/virt-resize.pl:117
28526 msgid "4. Create output disk"
28530 #: ../tools/virt-resize.pl:119
28532 "Virt-resize cannot do in-place disk modifications. You have to have space "
28533 "to store the resized output disk."
28537 #: ../tools/virt-resize.pl:122
28538 msgid "To store the resized disk image in a file, create a file of a suitable size:"
28542 #: ../tools/virt-resize.pl:125
28545 " # rm -f outdisk\n"
28546 " # truncate -s 10G outdisk\n"
28551 #: ../tools/virt-resize.pl:128
28552 msgid "Or use L<lvcreate(1)> to create a logical volume:"
28556 #: ../tools/virt-resize.pl:130
28559 " # lvcreate -L 10G -n lv_name vg_name\n"
28564 #: ../tools/virt-resize.pl:132
28565 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
28569 #: ../tools/virt-resize.pl:134
28572 " # virsh pool-list\n"
28573 " # virsh vol-create-as poolname newvol 10G\n"
28578 #: ../tools/virt-resize.pl:137
28583 #: ../tools/virt-resize.pl:139
28585 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
28586 "file) and the output disk. The output disk is the one created in the "
28591 #: ../tools/virt-resize.pl:143
28594 " # virt-resize indisk outdisk\n"
28599 #: ../tools/virt-resize.pl:145
28601 "This command just copies disk image C<indisk> to disk image C<outdisk> "
28602 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
28603 "larger, then an extra, empty partition is created at the end of the disk "
28604 "covering the extra space. If C<outdisk> is smaller, then it will give an "
28609 #: ../tools/virt-resize.pl:151
28611 "More realistically you'd want to expand existing partitions in the disk "
28612 "image by passing extra options (for the full list see the L</OPTIONS> "
28617 #: ../tools/virt-resize.pl:155
28619 "L</--expand> is the most useful option. It expands the named partition "
28620 "within the disk to fill any extra space:"
28624 #: ../tools/virt-resize.pl:158
28627 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
28632 #: ../tools/virt-resize.pl:160
28634 "(In this case, an extra partition is I<not> created at the end of the disk, "
28635 "because there will be no unused space)."
28639 #: ../tools/virt-resize.pl:163
28641 "L</--resize> is the other commonly used option. The following would "
28642 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
28643 "rest of the available space:"
28647 #: ../tools/virt-resize.pl:167
28650 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
28651 " indisk outdisk\n"
28656 #: ../tools/virt-resize.pl:170
28658 "If the expanded partition in the image contains a filesystem or LVM PV, then "
28659 "if virt-resize knows how, it will resize the contents, the equivalent of "
28660 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
28661 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
28662 "filesystems, so you would have to online resize them after booting the "
28667 #: ../tools/virt-resize.pl:177
28668 msgid "Other options are covered below."
28672 #: ../tools/virt-resize.pl:179
28677 #: ../tools/virt-resize.pl:181
28678 msgid "Thoroughly test the new disk image I<before> discarding the old one."
28682 #: ../tools/virt-resize.pl:183
28683 msgid "If you are using libvirt, edit the XML to point at the new disk:"
28687 #: ../tools/virt-resize.pl:185
28690 " # virsh edit guestname\n"
28695 #: ../tools/virt-resize.pl:187
28697 "Change E<lt>source ...E<gt>, see "
28698 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
28702 #: ../tools/virt-resize.pl:190
28703 msgid "Then start up the domain with the new, resized disk:"
28707 #: ../tools/virt-resize.pl:192
28710 " # virsh start guestname\n"
28715 #: ../tools/virt-resize.pl:194
28717 "and check that it still works. See also the L</NOTES> section below for "
28718 "additional information."
28722 #: ../tools/virt-resize.pl:197
28723 msgid "7. Resize LVs etc inside the guest"
28727 #: ../tools/virt-resize.pl:199
28728 msgid "(This can also be done offline using L<guestfish(1)>)"
28732 #: ../tools/virt-resize.pl:201
28734 "Once the guest has booted you should see the new space available, at least "
28735 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
28736 "may need to resize LVs inside PVs, and also resize filesystem types that "
28737 "virt-resize does not know how to expand."
28741 #: ../tools/virt-resize.pl:208
28742 msgid "SHRINKING A VIRTUAL MACHINE DISK"
28746 #: ../tools/virt-resize.pl:210
28748 "Shrinking is somewhat more complex than expanding, and only an overview is "
28753 #: ../tools/virt-resize.pl:213
28755 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
28756 "filesystems). The user has to shrink content before passing the disk image "
28757 "to virt-resize, and virt-resize will check that the content has been shrunk "
28762 #: ../tools/virt-resize.pl:218
28763 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28767 #: ../tools/virt-resize.pl:220
28769 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28770 "steps 3 and 4 above to allocate a new disk image."
28774 #: ../tools/virt-resize.pl:223
28775 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28779 #: ../tools/virt-resize.pl:226
28780 msgid "IGNORING OR DELETING PARTITIONS"
28784 #: ../tools/virt-resize.pl:228
28786 "virt-resize also gives a convenient way to ignore or delete partitions when "
28787 "copying from the input disk to the output disk. Ignoring a partition speeds "
28788 "up the copy where you don't care about the existing contents of a "
28789 "partition. Deleting a partition removes it completely, but note that it "
28790 "also renumbers any partitions after the one which is deleted, which can "
28791 "leave some guests unbootable."
28795 #: ../tools/virt-resize.pl:235
28796 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28800 #: ../tools/virt-resize.pl:237
28802 "If the input disk is in qcow2 format, then you may prefer that the output is "
28803 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28804 "the fly. The output format is simply determined by the format of the empty "
28805 "output container that you provide. Thus to create qcow2 output, use:"
28809 #: ../tools/virt-resize.pl:243
28812 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28817 #: ../tools/virt-resize.pl:245
28818 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28822 #: ../tools/virt-resize.pl:247
28823 msgid "Similarly, to get non-sparse raw output use:"
28827 #: ../tools/virt-resize.pl:249
28830 " fallocate -l size outdisk\n"
28835 #: ../tools/virt-resize.pl:251
28837 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
28838 "if=/dev/zero of=outdisk bs=1M count=..>)"
28842 #: ../tools/virt-resize.pl:264
28843 msgid "Display help."
28847 #: ../tools/virt-resize.pl:278
28848 msgid "B<--resize part=size>"
28852 #: ../tools/virt-resize.pl:280
28854 "Resize the named partition (expanding or shrinking it) so that it has the "
28859 #: ../tools/virt-resize.pl:283
28861 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28862 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28863 "Exabytes; or as a percentage of the current size; or as a relative number or "
28864 "percentage. For example:"
28868 #: ../tools/virt-resize.pl:288
28871 " --resize /dev/sda2=10G\n"
28876 #: ../tools/virt-resize.pl:290
28879 " --resize /dev/sda4=90%\n"
28884 #: ../tools/virt-resize.pl:292
28887 " --resize /dev/sda2=+1G\n"
28892 #: ../tools/virt-resize.pl:294
28895 " --resize /dev/sda2=-200M\n"
28900 #: ../tools/virt-resize.pl:296
28903 " --resize /dev/sda1=+128K\n"
28908 #: ../tools/virt-resize.pl:298
28911 " --resize /dev/sda1=+10%\n"
28916 #: ../tools/virt-resize.pl:300
28919 " --resize /dev/sda1=-10%\n"
28924 #: ../tools/virt-resize.pl:302
28926 "You can increase the size of any partition. Virt-resize will expand the "
28927 "direct content of the partition if it knows how (see C<--expand> below)."
28931 #: ../tools/virt-resize.pl:306
28933 "You can only I<decrease> the size of partitions that contain filesystems or "
28934 "PVs which have already been shrunk. Virt-resize will check this has been "
28935 "done before proceeding, or else will print an error (see also "
28936 "C<--resize-force>)."
28940 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
28941 msgid "You can give this option multiple times."
28945 #: ../tools/virt-resize.pl:317
28946 msgid "B<--resize-force part=size>"
28950 #: ../tools/virt-resize.pl:319
28952 "This is the same as C<--resize> except that it will let you decrease the "
28953 "size of any partition. Generally this means you will lose any data which "
28954 "was at the end of the partition you shrink, but you may not care about that "
28955 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28956 "as a swap partition)."
28960 #: ../tools/virt-resize.pl:325
28961 msgid "See also the C<--ignore> option."
28965 #: ../tools/virt-resize.pl:331
28966 msgid "B<--expand part>"
28970 #: ../tools/virt-resize.pl:333
28972 "Expand the named partition so it uses up all extra space (space left over "
28973 "after any other resize changes that you request have been done)."
28977 #: ../tools/virt-resize.pl:336
28979 "If virt-resize knows how, it will expand the direct content of the "
28980 "partition. For example, if the partition is an LVM PV, it will expand the "
28981 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28982 "content it doesn't know about alone."
28986 #: ../tools/virt-resize.pl:341
28987 msgid "Currently virt-resize can resize:"
28991 #: ../tools/virt-resize.pl:347
28993 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28998 #: ../tools/virt-resize.pl:352
29000 "NTFS filesystems contained directly in a partition, if libguestfs was "
29001 "compiled with support for NTFS."
29005 #: ../tools/virt-resize.pl:355
29007 "The filesystem must have been shut down consistently last time it was used. "
29008 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
29009 "consistency check, so at the first boot after resizing Windows will check "
29014 #: ../tools/virt-resize.pl:362
29016 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
29017 "inside the PV, but see the C<--LV-expand> option. The user could also "
29018 "resize LVs as desired after boot."
29022 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
29023 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
29027 #: ../tools/virt-resize.pl:374
29028 msgid "B<--shrink part>"
29032 #: ../tools/virt-resize.pl:376
29034 "Shrink the named partition until the overall disk image fits in the "
29035 "destination. The named partition B<must> contain a filesystem or PV which "
29036 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
29037 "online tools). Virt-resize will check this and give an error if it has not "
29042 #: ../tools/virt-resize.pl:382
29044 "The amount by which the overall disk must be shrunk (after carrying out all "
29045 "other operations requested by the user) is called the \"deficit\". For "
29046 "example, a straight copy (assume no other operations) from a 5GB disk image "
29047 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
29048 "would give an error unless the user specified a partition to shrink and that "
29049 "partition had more than a gigabyte of free space."
29053 #: ../tools/virt-resize.pl:396
29054 msgid "B<--ignore part>"
29058 #: ../tools/virt-resize.pl:398
29060 "Ignore the named partition. Effectively this means the partition is "
29061 "allocated on the destination disk, but the content is not copied across from "
29062 "the source disk. The content of the partition will be blank (all zero "
29067 #: ../tools/virt-resize.pl:409
29068 msgid "B<--delete part>"
29072 #: ../tools/virt-resize.pl:411
29074 "Delete the named partition. It would be more accurate to describe this as "
29075 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
29076 "the original disk image is left intact."
29080 #: ../tools/virt-resize.pl:415
29082 "Note that when you delete a partition, then anything contained in the "
29083 "partition is also deleted. Furthermore, this causes any partitions that "
29084 "come after to be I<renumbered>, which can easily make your guest unbootable."
29088 #: ../tools/virt-resize.pl:426
29089 msgid "B<--LV-expand logvol>"
29093 #: ../tools/virt-resize.pl:428
29095 "This takes the logical volume and, as a final step, expands it to fill all "
29096 "the space available in its volume group. A typical usage, assuming a Linux "
29097 "guest with a single PV C</dev/sda2> and a root device called "
29098 "C</dev/vg_guest/lv_root> would be:"
29102 #: ../tools/virt-resize.pl:433
29105 " virt-resize indisk outdisk \\\n"
29106 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
29111 #: ../tools/virt-resize.pl:436
29113 "This would first expand the partition (and PV), and then expand the root "
29114 "device to fill the extra space in the PV."
29118 #: ../tools/virt-resize.pl:439
29120 "The contents of the LV are also resized if virt-resize knows how to do "
29121 "that. You can stop virt-resize from trying to expand the content by using "
29122 "the option C<--no-expand-content>."
29126 #: ../tools/virt-resize.pl:443
29127 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
29131 #: ../tools/virt-resize.pl:446
29133 "You can give this option multiple times, I<but> it doesn't make sense to do "
29134 "this unless the logical volumes you specify are all in different volume "
29139 #: ../tools/virt-resize.pl:454
29140 msgid "B<--no-copy-boot-loader>"
29144 #: ../tools/virt-resize.pl:456
29146 "By default, virt-resize copies over some sectors at the start of the disk "
29147 "(up to the beginning of the first partition). Commonly these sectors "
29148 "contain the Master Boot Record (MBR) and the boot loader, and are required "
29149 "in order for the guest to boot correctly."
29153 #: ../tools/virt-resize.pl:461
29155 "If you specify this flag, then this initial copy is not done. You may need "
29156 "to reinstall the boot loader in this case."
29160 #: ../tools/virt-resize.pl:469
29161 msgid "B<--no-extra-partition>"
29165 #: ../tools/virt-resize.pl:471
29167 "By default, virt-resize creates an extra partition if there is any extra, "
29168 "unused space after all resizing has happened. Use this option to prevent "
29169 "the extra partition from being created. If you do this then the extra space "
29170 "will be inaccessible until you run fdisk, parted, or some other partitioning "
29171 "tool in the guest."
29175 #: ../tools/virt-resize.pl:477
29177 "Note that if the surplus space is smaller than 10 MB, no extra partition "
29182 #: ../tools/virt-resize.pl:484
29183 msgid "B<--no-expand-content>"
29187 #: ../tools/virt-resize.pl:486
29189 "By default, virt-resize will try to expand the direct contents of "
29190 "partitions, if it knows how (see C<--expand> option above)."
29194 #: ../tools/virt-resize.pl:489
29196 "If you give the C<--no-expand-content> option then virt-resize will not "
29201 #: ../tools/virt-resize.pl:496
29202 msgid "B<-d> | B<--debug>"
29206 #: ../tools/virt-resize.pl:504
29207 msgid "B<-n> | B<--dryrun>"
29211 #: ../tools/virt-resize.pl:506
29212 msgid "Print a summary of what would be done, but don't do anything."
29216 #: ../tools/virt-resize.pl:512
29217 msgid "B<-q> | B<--quiet>"
29221 #: ../tools/virt-resize.pl:514
29222 msgid "Don't print the summary."
29226 #: ../tools/virt-resize.pl:522
29228 "Specify the format of the input disk image. If this flag is not given then "
29229 "it is auto-detected from the image itself."
29233 #: ../tools/virt-resize.pl:528
29235 "Note that this option I<does not> affect the output format. See L</QCOW2 "
29236 "AND NON-SPARSE RAW FORMATS>."
29240 #: ../tools/virt-resize.pl:535
29241 msgid "B<--output-format> raw"
29245 #: ../tools/virt-resize.pl:537
29247 "Specify the format of the output disk image. If this flag is not given then "
29248 "it is auto-detected from the image itself."
29252 #: ../tools/virt-resize.pl:543
29254 "Note that you still need to create the output disk with the right format. "
29255 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
29259 #: ../tools/virt-resize.pl:1419
29264 #: ../tools/virt-resize.pl:1421
29265 msgid "\"Partition 1 does not end on cylinder boundary.\""
29269 #: ../tools/virt-resize.pl:1423
29271 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
29272 "means the partitions will not be aligned to the ancient CHS geometry. "
29273 "However CHS geometry is meaningless for disks manufactured since the early "
29274 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
29275 "cylinders is not required by any modern operating system."
29279 #: ../tools/virt-resize.pl:1430
29280 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
29284 #: ../tools/virt-resize.pl:1432
29286 "In Windows Vista and later versions, Microsoft switched to using a separate "
29287 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
29288 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
29289 "the boot partition. Doing so seems to break the guest completely. However "
29290 "expanding the second partition (ie. C: drive) should work."
29294 #: ../tools/virt-resize.pl:1439
29296 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
29297 "NTFS partitions have been expanded. This is just a safety check and (unless "
29298 "it find errors) is nothing to worry about."
29302 #: ../tools/virt-resize.pl:1443
29303 msgid "GUEST BOOT STUCK AT \"GRUB\""
29307 #: ../tools/virt-resize.pl:1445
29309 "If a Linux guest does not boot after resizing, and the boot is stuck after "
29310 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
29311 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
29312 "although we think is to do with partition alignment."
29316 #: ../tools/virt-resize.pl:1450
29319 " guestfish -i -a newdisk\n"
29320 " ><fs> cat /boot/grub/device.map\n"
29321 " # check the contents of this file are sensible or\n"
29322 " # edit the file if necessary\n"
29323 " ><fs> grub-install / /dev/vda\n"
29329 #: ../tools/virt-resize.pl:1457
29331 "For more flexible guest reconfiguration, including if you need to specify "
29332 "other parameters to grub-install, use L<virt-rescue(1)>."
29336 #: ../tools/virt-resize.pl:1460
29337 msgid "ALTERNATIVE TOOLS"
29341 #: ../tools/virt-resize.pl:1462
29343 "There are several proprietary tools for resizing partitions. We won't "
29344 "mention any here."
29348 #: ../tools/virt-resize.pl:1465
29350 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
29351 "operations on disk images. They can resize and move partitions, but I don't "
29352 "think they can do anything with the contents, and they certainly don't "
29357 #: ../tools/virt-resize.pl:1470
29359 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
29360 "but at a much lower level. You will probably end up hand-calculating sector "
29361 "offsets, which is something that virt-resize was designed to avoid. If you "
29362 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
29367 #: ../tools/virt-resize.pl:1485
29369 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
29370 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
29371 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
29372 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
29373 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29377 #: ../tools/virt-list-filesystems.pl:32
29378 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29382 #: ../tools/virt-list-filesystems.pl:36
29385 " virt-list-filesystems [--options] domname\n"
29390 #: ../tools/virt-list-filesystems.pl:38
29393 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29398 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29400 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29405 #: ../tools/virt-list-filesystems.pl:45
29407 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29408 "are contained in a virtual machine or disk image."
29412 #: ../tools/virt-list-filesystems.pl:49
29414 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29415 "functionality. For more complex cases you should look at the "
29416 "L<guestfish(1)> tool."
29420 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29421 msgid "B<-l> | B<--long>"
29425 #: ../tools/virt-list-filesystems.pl:108
29427 "With this option, C<virt-list-filesystems> displays the type of each "
29428 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29432 #: ../tools/virt-list-filesystems.pl:115
29433 msgid "B<-a> | B<--all>"
29437 #: ../tools/virt-list-filesystems.pl:117
29439 "Normally we only show mountable filesystems. If this option is given then "
29440 "swap devices are shown too."
29444 #: ../tools/virt-list-filesystems.pl:191
29446 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29447 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29448 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29452 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29453 msgid "Copyright (C) 2009 Red Hat Inc."
29457 #: ../tools/virt-tar.pl:33
29458 msgid "virt-tar - Extract or upload files to a virtual machine"
29462 #: ../tools/virt-tar.pl:37
29465 " virt-tar [--options] -x domname directory tarball\n"
29470 #: ../tools/virt-tar.pl:39
29473 " virt-tar [--options] -u domname tarball directory\n"
29478 #: ../tools/virt-tar.pl:41
29481 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29486 #: ../tools/virt-tar.pl:43
29489 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29494 #: ../tools/virt-tar.pl:47
29496 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29497 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29501 #: ../tools/virt-tar.pl:52
29502 msgid "Download C</home> from the VM into a local tarball:"
29506 #: ../tools/virt-tar.pl:54
29509 " virt-tar -x domname /home home.tar\n"
29514 #: ../tools/virt-tar.pl:56
29517 " virt-tar -zx domname /home home.tar.gz\n"
29522 #: ../tools/virt-tar.pl:58
29523 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29527 #: ../tools/virt-tar.pl:60
29530 " virt-tar -u domname uploadstuff.tar /tmp\n"
29535 #: ../tools/virt-tar.pl:62
29538 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29543 #: ../tools/virt-tar.pl:66
29545 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
29546 "virtual machines. If you do this, you risk disk corruption in the VM. "
29547 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29551 #: ../tools/virt-tar.pl:71
29553 "You can use C<-x> (extract) on live virtual machines, but you might get "
29554 "inconsistent results or errors if there is filesystem activity inside the "
29555 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29556 "work, but the only way to guarantee consistent results is if the virtual "
29557 "machine is shut down."
29561 #: ../tools/virt-tar.pl:79
29563 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29564 "parts of a guest filesystem. There are many possibilities: making backups, "
29565 "uploading data files, snooping on guest activity, fixing or customizing "
29570 #: ../tools/virt-tar.pl:84
29572 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29573 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29574 "should look at the L<guestfish(1)> tool."
29578 #: ../tools/virt-tar.pl:88
29580 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
29581 "its contents (recursively) from the virtual machine into a local tarball. "
29582 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
29583 "virtual machine. You cannot use these two options together."
29587 #: ../tools/virt-tar.pl:94
29589 "In addition, you may need to use the C<-z> (gZip) option to enable "
29590 "compression. When uploading, you have to specify C<-z> if the upload file "
29591 "is compressed because virt-tar won't detect this on its own."
29595 #: ../tools/virt-tar.pl:98
29597 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29598 "example it cannot do PKZip files or bzip2 compression. If you want that "
29599 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29600 "the L<libguestfs(3)> API)."
29604 #: ../tools/virt-tar.pl:156
29605 msgid "B<-x> | B<--extract> | B<--download>"
29609 #: ../tools/virt-tar.pl:158
29610 msgid "B<-u> | B<--upload>"
29614 #: ../tools/virt-tar.pl:160
29616 "Use C<-x> to extract (download) a directory from a virtual machine to a "
29621 #: ../tools/virt-tar.pl:163
29623 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
29624 "Please read the L</WARNING> section above before using this option."
29628 #: ../tools/virt-tar.pl:167
29629 msgid "You must specify exactly one of these options."
29633 #: ../tools/virt-tar.pl:173
29634 msgid "B<-z> | B<--gzip>"
29638 #: ../tools/virt-tar.pl:175
29639 msgid "Specify that the input or output tarball is gzip-compressed."
29643 #: ../tools/virt-tar.pl:288
29645 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29646 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29647 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29648 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29652 #: ../tools/virt-make-fs.pl:37
29653 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29657 #: ../tools/virt-make-fs.pl:41
29660 " virt-make-fs [--options] input.tar output.img\n"
29665 #: ../tools/virt-make-fs.pl:43
29668 " virt-make-fs [--options] input.tar.gz output.img\n"
29673 #: ../tools/virt-make-fs.pl:45
29676 " virt-make-fs [--options] directory output.img\n"
29681 #: ../tools/virt-make-fs.pl:49
29683 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29684 "archive or some files in a directory. It is similar to tools like "
29685 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29686 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29687 "useful if you want to attach these filesystems to existing virtual machines "
29688 "(eg. to import large amounts of read-only data to a VM)."
29692 #: ../tools/virt-make-fs.pl:57
29693 msgid "Basic usage is:"
29697 #: ../tools/virt-make-fs.pl:59
29700 " virt-make-fs input output\n"
29705 #: ../tools/virt-make-fs.pl:61
29707 "where C<input> is either a directory containing files that you want to add, "
29708 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29709 "C<output> is a disk image. The input type is detected automatically. The "
29710 "output disk image defaults to a raw ext2 image unless you specify extra "
29711 "flags (see L</OPTIONS> below)."
29715 #: ../tools/virt-make-fs.pl:67
29716 msgid "EXTRA SPACE"
29720 #: ../tools/virt-make-fs.pl:69
29722 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29723 "the files that it contains, but might have extra space. Depending on how "
29724 "you are going to use the output, you might think this extra space is wasted "
29725 "and want to minimize it, or you might want to leave space so that more files "
29726 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29727 "but you can use the C<--size> flag to leave space in the filesystem if you "
29732 #: ../tools/virt-make-fs.pl:77
29734 "An alternative way to leave extra space but not make the output image any "
29735 "bigger is to use an alternative disk image format (instead of the default "
29736 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29737 "image format (check your hypervisor supports this before using it). This "
29738 "allows you to choose a large C<--size> but the extra space won't actually be "
29739 "allocated in the image until you try to store something in it."
29743 #: ../tools/virt-make-fs.pl:85
29745 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29746 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29747 "to build another image from scratch."
29751 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29756 #: ../tools/virt-make-fs.pl:91
29759 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29764 #: ../tools/virt-make-fs.pl:93
29765 msgid "FILESYSTEM TYPE"
29769 #: ../tools/virt-make-fs.pl:95
29771 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29772 "libguestfs supports can be used (but I<not> read-only formats like "
29773 "ISO9660). Here are some of the more common choices:"
29777 #: ../tools/virt-make-fs.pl:101
29782 #: ../tools/virt-make-fs.pl:103
29784 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29785 "you are not going to use the filesystem in a way that requires the journal, "
29786 "then this is just wasted overhead."
29790 #: ../tools/virt-make-fs.pl:107
29791 msgid "I<ntfs> or I<vfat>"
29795 #: ../tools/virt-make-fs.pl:109
29796 msgid "Useful if exporting data to a Windows guest."
29800 #: ../tools/virt-make-fs.pl:111
29802 "I<Note for vfat>: The tar archive or local directory must only contain files "
29803 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29804 "program running within libguestfs is unable to change the ownership of "
29805 "non-root files, since vfat itself does not support this."
29809 #: ../tools/virt-make-fs.pl:116
29814 #: ../tools/virt-make-fs.pl:118
29816 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29817 "total filesystem size."
29821 #: ../tools/virt-make-fs.pl:125
29824 " virt-make-fs --type=minix input minixfs.img\n"
29829 #: ../tools/virt-make-fs.pl:127
29830 msgid "TO PARTITION OR NOT TO PARTITION"
29834 #: ../tools/virt-make-fs.pl:129
29835 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29839 #: ../tools/virt-make-fs.pl:131
29841 "Adding a partition can make the disk image more compatible with certain "
29842 "virtualized operating systems which don't expect to see a filesystem "
29843 "directly located on a block device (Linux doesn't care and will happily "
29844 "handle both types)."
29848 #: ../tools/virt-make-fs.pl:136
29850 "On the other hand, if you have a partition table then the output image is no "
29851 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29852 "directly on a partitioned disk image. (However libguestfs tools such as "
29853 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29857 #: ../tools/virt-make-fs.pl:144
29858 msgid "Add an MBR partition:"
29862 #: ../tools/virt-make-fs.pl:146
29865 " virt-make-fs --partition -- input disk.img\n"
29870 #: ../tools/virt-make-fs.pl:148
29872 "If the output disk image could be terabyte-sized or larger, it's better to "
29873 "use an EFI/GPT-compatible partition table:"
29877 #: ../tools/virt-make-fs.pl:151
29880 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29885 #: ../tools/virt-make-fs.pl:179
29886 msgid "Enable debugging information."
29890 #: ../tools/virt-make-fs.pl:185
29891 msgid "B<--size=E<lt>NE<gt>>"
29895 #: ../tools/virt-make-fs.pl:187
29896 msgid "B<--size=+E<lt>NE<gt>>"
29900 #: ../tools/virt-make-fs.pl:189
29901 msgid "B<-s E<lt>NE<gt>>"
29905 #: ../tools/virt-make-fs.pl:191
29906 msgid "B<-s +E<lt>NE<gt>>"
29910 #: ../tools/virt-make-fs.pl:193
29911 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29915 #: ../tools/virt-make-fs.pl:196
29917 "If this option is I<not> given, then the output image will be just large "
29918 "enough to contain all the files, with not much wasted space."
29922 #: ../tools/virt-make-fs.pl:199
29924 "To choose a fixed size output disk, specify an absolute number followed by "
29925 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29926 "Petabytes or Exabytes. This must be large enough to contain all the input "
29927 "files, else you will get an error."
29931 #: ../tools/virt-make-fs.pl:204
29933 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29934 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29935 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29936 "the input files, and (approximately) an extra 200 MB free space."
29940 #: ../tools/virt-make-fs.pl:210
29942 "Note that virt-make-fs estimates free space, and therefore will not produce "
29943 "filesystems containing precisely the free space requested. (It is much more "
29944 "expensive and time-consuming to produce a filesystem which has precisely the "
29945 "desired free space)."
29949 #: ../tools/virt-make-fs.pl:219
29950 msgid "B<--format=E<lt>fmtE<gt>>"
29954 #: ../tools/virt-make-fs.pl:221
29955 msgid "B<-F E<lt>fmtE<gt>>"
29959 #: ../tools/virt-make-fs.pl:223
29960 msgid "Choose the output disk image format."
29964 #: ../tools/virt-make-fs.pl:225
29965 msgid "The default is C<raw> (raw disk image)."
29969 #: ../tools/virt-make-fs.pl:227
29971 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29972 "that would really make sense here is C<qcow2>."
29976 #: ../tools/virt-make-fs.pl:234
29977 msgid "B<--type=E<lt>fsE<gt>>"
29981 #: ../tools/virt-make-fs.pl:236
29982 msgid "B<-t E<lt>fsE<gt>>"
29986 #: ../tools/virt-make-fs.pl:238
29987 msgid "Choose the output filesystem type."
29991 #: ../tools/virt-make-fs.pl:240
29992 msgid "The default is C<ext2>."
29996 #: ../tools/virt-make-fs.pl:242
29997 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30001 #: ../tools/virt-make-fs.pl:249
30002 msgid "B<--partition>"
30006 #: ../tools/virt-make-fs.pl:251
30007 msgid "B<--partition=E<lt>parttypeE<gt>>"
30011 #: ../tools/virt-make-fs.pl:253
30013 "If specified, this flag adds an MBR partition table to the output disk "
30018 #: ../tools/virt-make-fs.pl:256
30020 "You can change the partition table type, eg. C<--partition=gpt> for large "
30025 #: ../tools/virt-make-fs.pl:259
30027 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
30028 "might consider the next parameter to be the partition type. For example:"
30032 #: ../tools/virt-make-fs.pl:263
30035 " virt-make-fs --partition input.tar ...\n"
30040 #: ../tools/virt-make-fs.pl:265
30042 "would cause virt-make-fs to think you wanted to use a partition type of "
30043 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
30044 "dash) between options and the input file argument:"
30048 #: ../tools/virt-make-fs.pl:269
30051 " virt-make-fs --partition -- input.tar ...\n"
30056 #: ../tools/virt-make-fs.pl:541
30058 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30059 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30060 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30064 #: ../tools/virt-make-fs.pl:558
30067 " export LIBGUESTFS_DEBUG=1\n"
30068 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30073 #: ../tools/virt-make-fs.pl:561
30075 "Attach /tmp/virt-make-fs.log to a new bug report at "
30076 "L<https://bugzilla.redhat.com/>"
30080 #: ../tools/virt-list-partitions.pl:32
30081 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
30085 #: ../tools/virt-list-partitions.pl:36
30088 " virt-list-partitions [--options] domname\n"
30093 #: ../tools/virt-list-partitions.pl:38
30096 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30101 #: ../tools/virt-list-partitions.pl:45
30103 "C<virt-list-partitions> is a command line tool to list the partitions that "
30104 "are contained in a virtual machine or disk image. It is mainly useful as a "
30105 "first step to using L<virt-resize(1)>."
30109 #: ../tools/virt-list-partitions.pl:50
30111 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30112 "functionality. For more complex cases you should look at the "
30113 "L<guestfish(1)> tool."
30117 #: ../tools/virt-list-partitions.pl:107
30118 msgid "B<-h> | B<--human-readable>"
30122 #: ../tools/virt-list-partitions.pl:109
30123 msgid "Show sizes in human-readable form (eg. \"1G\")."
30127 #: ../tools/virt-list-partitions.pl:117
30129 "With this option, C<virt-list-partitions> displays the type and size of each "
30130 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30134 #: ../tools/virt-list-partitions.pl:124
30135 msgid "B<-t> | B<--total>"
30139 #: ../tools/virt-list-partitions.pl:126
30140 msgid "Display the total size of each block device (as a separate row or rows)."
30144 #: ../tools/virt-list-partitions.pl:259
30146 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
30147 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
30148 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."