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.13\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-03-24 12:04+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:1770 ../src/guestfs.pod:1775 ../src/guestfs.pod:1779 ../src/guestfs.pod:2008 ../src/guestfs.pod:2013 ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381 ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398 ../src/guestfs.pod:2863 ../src/guestfs.pod:2867 ../src/guestfs.pod:2871 ../src/guestfs.pod:2875 ../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:2426
941 #: ../src/guestfs.pod:471
942 msgid "Before launching, do:"
946 #: ../src/guestfs.pod:473
949 " guestfs_set_selinux (g, 1);\n"
954 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1285 ../src/guestfs.pod:1416 ../src/guestfs.pod:2451
959 #: ../src/guestfs.pod:477
961 "After mounting the guest's filesystem(s), load the policy. This is best "
962 "done by running the L<load_policy(8)> command in the guest itself:"
966 #: ../src/guestfs.pod:481
969 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
974 #: ../src/guestfs.pod:483
976 "(Older versions of C<load_policy> require you to specify the name of the "
981 #: ../src/guestfs.pod:486 ../src/guestfs.pod: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 supermin appliance, 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 "B<Note:> This section documents the generic event mechanism introduced in "
3289 "libguestfs 1.10, which you should use in new code if possible. The old "
3290 "functions C<guestfs_set_log_message_callback>, "
3291 "C<guestfs_set_subprocess_quit_callback>, "
3292 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3293 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3298 #: ../src/guestfs.pod:1694
3300 "Handles generate events when certain things happen, such as log messages "
3301 "being generated, progress messages during long-running operations, or the "
3302 "handle being closed. The API calls described below let you register a "
3303 "callback to be called when events happen. You can register multiple "
3304 "callbacks (for the same, different or overlapping sets of events), and "
3305 "individually remove callbacks. If callbacks are not removed, then they "
3306 "remain in force until the handle is closed."
3310 #: ../src/guestfs.pod:1702
3312 "In the current implementation, events are only generated synchronously: that "
3313 "means that events (and hence callbacks) can only happen while you are in the "
3314 "middle of making another libguestfs call. The callback is called in the "
3319 #: ../src/guestfs.pod:1707
3321 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3322 "unsigned integers, or a message buffer. Payloads are discussed later on."
3326 #: ../src/guestfs.pod:1711
3327 msgid "CLASSES OF EVENTS"
3331 #: ../src/guestfs.pod:1715
3332 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3336 #: ../src/guestfs.pod:1718
3338 "The callback function will be called while the handle is being closed "
3339 "(synchronously from L</guestfs_close>)."
3343 #: ../src/guestfs.pod:1721
3345 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3346 "handles that are open when the program exits. This means that this callback "
3347 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3348 "problems in higher-level languages (eg. if your HLL interpreter has already "
3349 "been cleaned up by the time this is called, and if your callback then jumps "
3350 "into some HLL function)."
3354 #: ../src/guestfs.pod:1728
3356 "If no callback is registered: the handle is closed without any callback "
3361 #: ../src/guestfs.pod:1731
3362 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3366 #: ../src/guestfs.pod:1734
3368 "The callback function will be called when the child process quits, either "
3369 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3370 "corresponds to a transition from any state to the CONFIG state)."
3374 #: ../src/guestfs.pod:1738 ../src/guestfs.pod:1747
3375 msgid "If no callback is registered: the event is ignored."
3379 #: ../src/guestfs.pod:1740
3380 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3384 #: ../src/guestfs.pod:1743
3386 "The callback function will be called when the child process becomes ready "
3387 "first time after it has been launched. (This corresponds to a transition "
3388 "from LAUNCHING to the READY state)."
3392 #: ../src/guestfs.pod:1749
3393 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3397 #: ../src/guestfs.pod:1752
3399 "Some long-running operations can generate progress messages. If this "
3400 "callback is registered, then it will be called each time a progress message "
3401 "is generated (usually two seconds after the operation started, and three "
3402 "times per second thereafter until it completes, although the frequency may "
3403 "change in future versions)."
3407 #: ../src/guestfs.pod:1758
3409 "The callback receives in the payload four unsigned 64 bit numbers which are "
3410 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3414 #: ../src/guestfs.pod:1761
3416 "The units of C<total> are not defined, although for some operations C<total> "
3417 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3418 "or megabytes), and C<position> may be the portion which has been "
3423 #: ../src/guestfs.pod:1766
3424 msgid "The only defined and stable parts of the API are:"
3428 #: ../src/guestfs.pod:1772
3430 "The callback can display to the user some type of progress bar or indicator "
3431 "which shows the ratio of C<position>:C<total>."
3435 #: ../src/guestfs.pod:1777
3436 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3440 #: ../src/guestfs.pod:1781
3442 "If any progress notification is sent during a call, then a final progress "
3443 "notification is always sent when C<position> = C<total>."
3447 #: ../src/guestfs.pod:1784
3449 "This is to simplify caller code, so callers can easily set the progress "
3450 "indicator to \"100%\" at the end of the operation, without requiring special "
3451 "code to detect this case."
3455 #: ../src/guestfs.pod:1790
3457 "The callback also receives the procedure number (C<proc_nr>) and serial "
3458 "number (C<serial>) of the call. These are only useful for debugging "
3459 "protocol issues, and the callback can normally ignore them. The callback "
3460 "may want to print these numbers in error messages or debugging messages."
3464 #: ../src/guestfs.pod:1796
3465 msgid "If no callback is registered: progress messages are discarded."
3469 #: ../src/guestfs.pod:1798
3470 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3474 #: ../src/guestfs.pod:1801
3476 "The callback function is called whenever a log message is generated by qemu, "
3477 "the appliance kernel, guestfsd (daemon), or utility programs."
3481 #: ../src/guestfs.pod:1804
3483 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
3484 "(L</guestfs_launch>) then additional debug messages are generated."
3488 #: ../src/guestfs.pod:1807 ../src/guestfs.pod:1821
3490 "If no callback is registered: the messages are discarded unless the verbose "
3491 "flag is set in which case they are sent to stderr. You can override the "
3492 "printing of verbose messages to stderr by setting up a callback."
3496 #: ../src/guestfs.pod:1812
3497 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3501 #: ../src/guestfs.pod:1815
3503 "The callback function is called whenever a log message is generated by the "
3504 "library part of libguestfs."
3508 #: ../src/guestfs.pod:1818
3510 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3511 "messages are generated."
3515 #: ../src/guestfs.pod:1826
3516 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3520 #: ../src/guestfs.pod:1829
3522 "The callback function is called whenever a trace message is generated. This "
3523 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3527 #: ../src/guestfs.pod:1832
3529 "If no callback is registered: the messages are sent to stderr. You can "
3530 "override the printing of trace messages to stderr by setting up a callback."
3534 #: ../src/guestfs.pod:1838
3535 msgid "guestfs_set_event_callback"
3539 #: ../src/guestfs.pod:1840
3542 " int guestfs_set_event_callback (guestfs_h *g,\n"
3543 " guestfs_event_callback cb,\n"
3544 " uint64_t event_bitmask,\n"
3551 #: ../src/guestfs.pod:1846
3553 "This function registers a callback (C<cb>) for all event classes in the "
3558 #: ../src/guestfs.pod:1849
3560 "For example, to register for all log message events, you could call this "
3561 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3562 "To register a single callback for all possible classes of events, use "
3563 "C<GUESTFS_EVENT_ALL>."
3567 #: ../src/guestfs.pod:1855
3568 msgid "C<flags> should always be passed as 0."
3572 #: ../src/guestfs.pod:1857
3574 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3575 "it for any purpose."
3579 #: ../src/guestfs.pod:1860
3581 "The return value is the event handle (an integer) which you can use to "
3582 "delete the callback (see below)."
3586 #: ../src/guestfs.pod:1863
3588 "If there is an error, this function returns C<-1>, and sets the error in the "
3589 "handle in the usual way (see L</guestfs_last_error> etc.)"
3593 #: ../src/guestfs.pod:1866
3595 "Callbacks remain in effect until they are deleted, or until the handle is "
3600 #: ../src/guestfs.pod:1869
3602 "In the case where multiple callbacks are registered for a particular event "
3603 "class, all of the callbacks are called. The order in which multiple "
3604 "callbacks are called is not defined."
3608 #: ../src/guestfs.pod:1873
3609 msgid "guestfs_delete_event_callback"
3613 #: ../src/guestfs.pod:1875
3616 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3621 #: ../src/guestfs.pod:1877
3623 "Delete a callback that was previously registered. C<event_handle> should be "
3624 "the integer that was returned by a previous call to "
3625 "C<guestfs_set_event_callback> on the same handle."
3629 #: ../src/guestfs.pod:1881
3630 msgid "guestfs_event_callback"
3634 #: ../src/guestfs.pod:1883
3637 " typedef void (*guestfs_event_callback) (\n"
3640 " uint64_t event,\n"
3641 " int event_handle,\n"
3643 " const char *buf, size_t buf_len,\n"
3644 " const uint64_t *array, size_t array_len);\n"
3649 #: ../src/guestfs.pod:1892
3650 msgid "This is the type of the event callback function that you have to provide."
3654 #: ../src/guestfs.pod:1895
3656 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3657 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3658 "handle, and C<flags> which in the current API you should ignore."
3662 #: ../src/guestfs.pod:1899
3664 "The remaining parameters contain the event payload (if any). Each event may "
3665 "contain a payload, which usually relates to the event class, but for future "
3666 "proofing your code should be written to handle any payload for any event "
3671 #: ../src/guestfs.pod:1904
3673 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3674 "there is no message buffer). Note that this message buffer can contain "
3675 "arbitrary 8 bit data, including NUL bytes."
3679 #: ../src/guestfs.pod:1908
3681 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3682 "moment this is only used for progress messages."
3686 #: ../src/guestfs.pod:1911
3687 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3691 #: ../src/guestfs.pod:1913
3693 "One motivation for the generic event API was to allow GUI programs to "
3694 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3695 "unconditionally to C<stderr>."
3699 #: ../src/guestfs.pod:1917
3701 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3702 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3703 "messages are not events; you must capture error messages separately)."
3707 #: ../src/guestfs.pod:1922
3709 "Programs have to set up a callback to capture the classes of events of "
3714 #: ../src/guestfs.pod:1925
3718 " guestfs_set_event_callback\n"
3719 " (g, message_callback,\n"
3720 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3721 " GUESTFS_EVENT_TRACE,\n"
3722 " 0, NULL) == -1)\n"
3723 " if (eh == -1) {\n"
3724 " // handle error in the usual way\n"
3730 #: ../src/guestfs.pod:1935
3732 "The callback can then direct messages to the appropriate place. In this "
3733 "example, messages are directed to syslog:"
3737 #: ../src/guestfs.pod:1938
3741 " message_callback (\n"
3744 " uint64_t event,\n"
3745 " int event_handle,\n"
3747 " const char *buf, size_t buf_len,\n"
3748 " const uint64_t *array, size_t array_len)\n"
3750 " const int priority = LOG_USER|LOG_INFO;\n"
3751 " if (buf_len > 0)\n"
3752 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3758 #: ../src/guestfs.pod:1953
3759 msgid "PRIVATE DATA AREA"
3763 #: ../src/guestfs.pod:1955
3765 "You can attach named pieces of private data to the libguestfs handle, fetch "
3766 "them by name, and walk over them, for the lifetime of the handle. This is "
3767 "called the private data area and is only available from the C API."
3771 #: ../src/guestfs.pod:1960
3772 msgid "To attach a named piece of data, use the following call:"
3776 #: ../src/guestfs.pod:1962
3779 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3784 #: ../src/guestfs.pod:1964
3786 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3787 "pointer (which can be C<NULL>). Any previous item with the same name is "
3792 #: ../src/guestfs.pod:1968
3794 "You can use any C<key> you want, but names beginning with an underscore "
3795 "character are reserved for internal libguestfs purposes (for implementing "
3796 "language bindings). It is recommended to prefix the name with some unique "
3797 "string to avoid collisions with other users."
3801 #: ../src/guestfs.pod:1973
3802 msgid "To retrieve the pointer, use:"
3806 #: ../src/guestfs.pod:1975
3809 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3814 #: ../src/guestfs.pod:1977
3816 "This function returns C<NULL> if either no data is found associated with "
3817 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3822 #: ../src/guestfs.pod:1981
3824 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3825 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3826 "all. In particular, libguestfs does I<not> try to free the data when the "
3827 "handle is closed. If the data must be freed, then the caller must either "
3828 "free it before calling L</guestfs_close> or must set up a close callback to "
3829 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3833 #: ../src/guestfs.pod:1988
3834 msgid "To walk over all entries, use these two functions:"
3838 #: ../src/guestfs.pod:1990
3841 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3846 #: ../src/guestfs.pod:1992
3849 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3854 #: ../src/guestfs.pod:1994
3856 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3857 "not have any particular meaning -- keys are not returned in any defined "
3858 "order). A pointer to the key is returned in C<*key_rtn> and the "
3859 "corresponding data pointer is returned from the function. C<NULL> is "
3860 "returned if there are no keys stored in the handle."
3864 #: ../src/guestfs.pod:2000
3866 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3867 "value of this function is also C<NULL> is there are no further entries to "
3872 #: ../src/guestfs.pod:2004
3873 msgid "Notes about walking over entries:"
3877 #: ../src/guestfs.pod:2010
3878 msgid "You must not call C<guestfs_set_private> while walking over the entries."
3882 #: ../src/guestfs.pod:2015
3884 "The handle maintains an internal iterator which is reset when you call "
3885 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3886 "call C<guestfs_set_private>."
3890 #: ../src/guestfs.pod:2021
3891 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3895 #: ../src/guestfs.pod:2023
3898 " guestfs_set_private (g, key, NULL);\n"
3903 #: ../src/guestfs.pod:2025
3904 msgid "then that C<key> is not returned when walking."
3908 #: ../src/guestfs.pod:2029
3910 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
3911 "C<guestfs_next_private> or C<guestfs_set_private>."
3915 #: ../src/guestfs.pod:2035
3917 "The following example code shows how to print all keys and data pointers "
3918 "that are associated with the handle C<g>:"
3922 #: ../src/guestfs.pod:2038
3925 " const char *key;\n"
3926 " void *data = guestfs_first_private (g, &key);\n"
3927 " while (data != NULL)\n"
3929 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3930 " data = guestfs_next_private (g, &key);\n"
3936 #: ../src/guestfs.pod:2046
3938 "More commonly you are only interested in keys that begin with an "
3939 "application-specific prefix C<foo_>. Modify the loop like so:"
3943 #: ../src/guestfs.pod:2049
3946 " const char *key;\n"
3947 " void *data = guestfs_first_private (g, &key);\n"
3948 " while (data != NULL)\n"
3950 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3951 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3952 " data = guestfs_next_private (g, &key);\n"
3958 #: ../src/guestfs.pod:2058
3960 "If you need to modify keys while walking, then you have to jump back to the "
3961 "beginning of the loop. For example, to delete all keys prefixed with "
3966 #: ../src/guestfs.pod:2062
3969 " const char *key;\n"
3972 " data = guestfs_first_private (g, &key);\n"
3973 " while (data != NULL)\n"
3975 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3977 " guestfs_set_private (g, key, NULL);\n"
3978 " /* note that 'key' pointer is now invalid, and so is\n"
3979 " the internal iterator */\n"
3982 " data = guestfs_next_private (g, &key);\n"
3988 #: ../src/guestfs.pod:2078
3990 "Note that the above loop is guaranteed to terminate because the keys are "
3991 "being deleted, but other manipulations of keys within the loop might not "
3992 "terminate unless you also maintain an indication of which keys have been "
3997 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4002 #: ../src/guestfs.pod:2085
4004 "<!-- old anchor for the next section --> <a "
4005 "name=\"state_machine_and_low_level_event_api\"/>"
4009 #: ../src/guestfs.pod:2090
4010 msgid "ARCHITECTURE"
4014 #: ../src/guestfs.pod:2092
4016 "Internally, libguestfs is implemented by running an appliance (a special "
4017 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4018 "process of the main program."
4022 #: ../src/guestfs.pod:2096
4025 " ___________________\n"
4027 " | main program |\n"
4029 " | | child process / appliance\n"
4030 " | | __________________________\n"
4032 " +-------------------+ RPC | +-----------------+ |\n"
4033 " | libguestfs <--------------------> guestfsd | |\n"
4034 " | | | +-----------------+ |\n"
4035 " \\___________________/ | | Linux kernel | |\n"
4036 " | +--^--------------+ |\n"
4037 " \\_________|________________/\n"
4043 " \\______________/\n"
4048 #: ../src/guestfs.pod:2116
4050 "The library, linked to the main program, creates the child process and hence "
4051 "the appliance in the L</guestfs_launch> function."
4055 #: ../src/guestfs.pod:2119
4057 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4058 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4059 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4060 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4061 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4062 "attached to the qemu process which translates device access by the "
4063 "appliance's Linux kernel into accesses to the image."
4067 #: ../src/guestfs.pod:2128
4069 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4070 "Although the disk image you are attached to might also be used by some "
4071 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4072 "care if both libguestfs's qemu process and your virtual machine are trying "
4073 "to update the disk image at the same time, since these usually results in "
4074 "massive disk corruption)."
4078 #: ../src/guestfs.pod:2135
4079 msgid "STATE MACHINE"
4083 #: ../src/guestfs.pod:2137
4084 msgid "libguestfs uses a state machine to model the child process:"
4088 #: ../src/guestfs.pod:2139
4100 " / | \\ \\ guestfs_launch\n"
4101 " / | _\\__V______\n"
4103 " / | | LAUNCHING |\n"
4104 " / | \\___________/\n"
4106 " / | guestfs_launch\n"
4108 " ______ / __|____V\n"
4109 " / \\ ------> / \\\n"
4110 " | BUSY | | READY |\n"
4111 " \\______/ <------ \\________/\n"
4116 #: ../src/guestfs.pod:2161
4118 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4119 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4120 "(3) alternating between READY and BUSY as commands are issued to, and "
4121 "carried out by, the child process."
4125 #: ../src/guestfs.pod:2166
4127 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4128 "asynchronously at any time (eg. due to some internal error), and that causes "
4129 "the state to transition back to CONFIG."
4133 #: ../src/guestfs.pod:2170
4135 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4136 "issued when in the CONFIG state."
4140 #: ../src/guestfs.pod:2173
4142 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4143 "L</guestfs_launch> blocks until the child process is READY to accept "
4144 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4145 "moves the state from CONFIG to LAUNCHING while it is running."
4149 #: ../src/guestfs.pod:2179
4151 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4152 "state. These API calls block waiting for the command to be carried out "
4153 "(ie. the state to transition to BUSY and then back to READY). There are no "
4154 "non-blocking versions, and no way to issue more than one command per handle "
4159 #: ../src/guestfs.pod:2185
4161 "Finally, the child process sends asynchronous messages back to the main "
4162 "program, such as kernel log messages. You can register a callback to "
4163 "receive these messages."
4167 #: ../src/guestfs.pod:2189
4172 #: ../src/guestfs.pod:2191
4173 msgid "COMMUNICATION PROTOCOL"
4177 #: ../src/guestfs.pod:2193
4179 "Don't rely on using this protocol directly. This section documents how it "
4180 "currently works, but it may change at any time."
4184 #: ../src/guestfs.pod:2196
4186 "The protocol used to talk between the library and the daemon running inside "
4187 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4188 "1014, RFC 1832, RFC 4506)."
4192 #: ../src/guestfs.pod:2200
4194 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4195 "this file is automatically generated)."
4199 #: ../src/guestfs.pod:2203
4201 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4202 "and C<FileOut> parameters, which are handled with very simple request/reply "
4203 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4204 "parameters, which use the same request and reply messages, but they may also "
4205 "be followed by files sent using a chunked encoding."
4209 #: ../src/guestfs.pod:2210
4210 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4214 #: ../src/guestfs.pod:2212
4215 msgid "For ordinary functions, the request message is:"
4219 #: ../src/guestfs.pod:2214
4222 " total length (header + arguments,\n"
4223 " but not including the length word itself)\n"
4224 " struct guestfs_message_header (encoded as XDR)\n"
4225 " struct guestfs_<foo>_args (encoded as XDR)\n"
4230 #: ../src/guestfs.pod:2219
4232 "The total length field allows the daemon to allocate a fixed size buffer "
4233 "into which it slurps the rest of the message. As a result, the total length "
4234 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4235 "effective size of any request is limited to somewhere under this size."
4239 #: ../src/guestfs.pod:2225
4241 "Note also that many functions don't take any arguments, in which case the "
4242 "C<guestfs_I<foo>_args> is completely omitted."
4246 #: ../src/guestfs.pod:2228
4248 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4249 "receiver knows what type of args structure to expect, or none at all."
4253 #: ../src/guestfs.pod:2232
4255 "For functions that take optional arguments, the optional arguments are "
4256 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4257 "arguments. A bitmask in the header indicates which optional arguments are "
4258 "meaningful. The bitmask is also checked to see if it contains bits set "
4259 "which the daemon does not know about (eg. if more optional arguments were "
4260 "added in a later version of the library), and this causes the call to be "
4265 #: ../src/guestfs.pod:2240
4266 msgid "The reply message for ordinary functions is:"
4270 #: ../src/guestfs.pod:2242
4273 " total length (header + ret,\n"
4274 " but not including the length word itself)\n"
4275 " struct guestfs_message_header (encoded as XDR)\n"
4276 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4281 #: ../src/guestfs.pod:2247
4283 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4284 "functions that return no formal return values."
4288 #: ../src/guestfs.pod:2250
4289 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4293 #: ../src/guestfs.pod:2253
4295 "In the case of an error, a flag is set in the header, and the reply message "
4296 "is slightly changed:"
4300 #: ../src/guestfs.pod:2256
4303 " total length (header + error,\n"
4304 " but not including the length word itself)\n"
4305 " struct guestfs_message_header (encoded as XDR)\n"
4306 " struct guestfs_message_error (encoded as XDR)\n"
4311 #: ../src/guestfs.pod:2261
4313 "The C<guestfs_message_error> structure contains the error message as a "
4318 #: ../src/guestfs.pod:2264
4319 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4323 #: ../src/guestfs.pod:2266
4325 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4326 "The normal request message is sent (see above). However this is followed by "
4327 "a sequence of file chunks."
4331 #: ../src/guestfs.pod:2270
4334 " total length (header + arguments,\n"
4335 " but not including the length word itself,\n"
4336 " and not including the chunks)\n"
4337 " struct guestfs_message_header (encoded as XDR)\n"
4338 " struct guestfs_<foo>_args (encoded as XDR)\n"
4339 " sequence of chunks for FileIn param #0\n"
4340 " sequence of chunks for FileIn param #1 etc.\n"
4345 #: ../src/guestfs.pod:2278
4346 msgid "The \"sequence of chunks\" is:"
4350 #: ../src/guestfs.pod:2280
4353 " length of chunk (not including length word itself)\n"
4354 " struct guestfs_chunk (encoded as XDR)\n"
4355 " length of chunk\n"
4356 " struct guestfs_chunk (encoded as XDR)\n"
4358 " length of chunk\n"
4359 " struct guestfs_chunk (with data.data_len == 0)\n"
4364 #: ../src/guestfs.pod:2288
4366 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4367 "is set in the final chunk to indicate either successful completion or early "
4372 #: ../src/guestfs.pod:2292
4374 "At time of writing there are no functions that have more than one FileIn "
4375 "parameter. However this is (theoretically) supported, by sending the "
4376 "sequence of chunks for each FileIn parameter one after another (from left to "
4381 #: ../src/guestfs.pod:2297
4383 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4384 "transfer. The library does this by sending a chunk with a special flag set "
4385 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4386 "RPC, does I<not> send any reply, and goes back to reading the next request."
4390 #: ../src/guestfs.pod:2303
4392 "The daemon may also cancel. It does this by writing a special word "
4393 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4394 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4395 "cancel chunk). The special word is chosen so that even if cancellation "
4396 "happens right at the end of the transfer (after the library has finished "
4397 "writing and has started listening for the reply), the \"spurious\" cancel "
4398 "flag will not be confused with the reply message."
4402 #: ../src/guestfs.pod:2312
4404 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4405 "limit), and also files where the size is not known in advance (eg. from "
4406 "pipes or sockets). However the chunks are rather small "
4407 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4408 "to keep much in memory."
4412 #: ../src/guestfs.pod:2318
4413 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4417 #: ../src/guestfs.pod:2320
4419 "The protocol for FileOut parameters is exactly the same as for FileIn "
4420 "parameters, but with the roles of daemon and library reversed."
4424 #: ../src/guestfs.pod:2323
4427 " total length (header + ret,\n"
4428 " but not including the length word itself,\n"
4429 " and not including the chunks)\n"
4430 " struct guestfs_message_header (encoded as XDR)\n"
4431 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4432 " sequence of chunks for FileOut param #0\n"
4433 " sequence of chunks for FileOut param #1 etc.\n"
4438 #: ../src/guestfs.pod:2331
4439 msgid "INITIAL MESSAGE"
4443 #: ../src/guestfs.pod:2333
4445 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4446 "which indicates that the guest and daemon is alive. This is what "
4447 "L</guestfs_launch> waits for."
4451 #: ../src/guestfs.pod:2337
4452 msgid "PROGRESS NOTIFICATION MESSAGES"
4456 #: ../src/guestfs.pod:2339
4458 "The daemon may send progress notification messages at any time. These are "
4459 "distinguished by the normal length word being replaced by "
4460 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4464 #: ../src/guestfs.pod:2343
4466 "The library turns them into progress callbacks (see "
4467 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4472 #: ../src/guestfs.pod:2347
4474 "The daemon self-limits the frequency of progress messages it sends (see "
4475 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4480 #: ../src/guestfs.pod:2351
4481 msgid "LIBGUESTFS VERSION NUMBERS"
4485 #: ../src/guestfs.pod:2353
4487 "Since April 2010, libguestfs has started to make separate development and "
4488 "stable releases, along with corresponding branches in our git repository. "
4489 "These separate releases can be identified by version number:"
4493 #: ../src/guestfs.pod:2358
4496 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4497 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4503 " | `-------- sub-version\n"
4505 " `------ always '1' because we don't change the ABI\n"
4510 #: ../src/guestfs.pod:2369
4511 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4515 #: ../src/guestfs.pod:2371
4517 "As time passes we cherry pick fixes from the development branch and backport "
4518 "those into the stable branch, the effect being that the stable branch should "
4519 "get more stable and less buggy over time. So the stable releases are ideal "
4520 "for people who don't need new features but would just like the software to "
4525 #: ../src/guestfs.pod:2377
4526 msgid "Our criteria for backporting changes are:"
4530 #: ../src/guestfs.pod:2383
4532 "Documentation changes which don't affect any code are backported unless the "
4533 "documentation refers to a future feature which is not in stable."
4537 #: ../src/guestfs.pod:2389
4539 "Bug fixes which are not controversial, fix obvious problems, and have been "
4540 "well tested are backported."
4544 #: ../src/guestfs.pod:2394
4546 "Simple rearrangements of code which shouldn't affect how it works get "
4547 "backported. This is so that the code in the two branches doesn't get too "
4548 "far out of step, allowing us to backport future fixes more easily."
4552 #: ../src/guestfs.pod:2400
4554 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4555 "exceptional case: the new feature is required in order to implement an "
4556 "important bug fix."
4560 #: ../src/guestfs.pod:2406
4562 "A new stable branch starts when we think the new features in development are "
4563 "substantial and compelling enough over the current stable branch to warrant "
4564 "it. When that happens we create new stable and development versions 1.N.0 "
4565 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4566 "stable at this point, but by backporting fixes from development, that branch "
4567 "will stabilize over time."
4571 #: ../src/guestfs.pod:2414
4572 msgid "EXTENDING LIBGUESTFS"
4576 #: ../src/guestfs.pod:2416
4577 msgid "ADDING A NEW API ACTION"
4581 #: ../src/guestfs.pod:2418
4583 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4584 "documentation) are generated, and this makes it easy to extend the "
4589 #: ../src/guestfs.pod:2422
4590 msgid "To add a new API action there are two changes:"
4594 #: ../src/guestfs.pod:2428
4596 "You need to add a description of the call (name, parameters, return type, "
4597 "tests, documentation) to C<generator/generator_actions.ml>."
4601 #: ../src/guestfs.pod:2431
4603 "There are two sorts of API action, depending on whether the call goes "
4604 "through to the daemon in the appliance, or is serviced entirely by the "
4605 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4606 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4607 "an example of the latter, since a trace flag is maintained in the handle and "
4608 "all tracing is done on the library side."
4612 #: ../src/guestfs.pod:2439
4614 "Most new actions are of the first type, and get added to the "
4615 "C<daemon_functions> list. Each function has a unique procedure number used "
4616 "in the RPC protocol which is assigned to that action when we publish "
4617 "libguestfs and cannot be reused. Take the latest procedure number and "
4622 #: ../src/guestfs.pod:2445
4624 "For library-only actions of the second type, add to the "
4625 "C<non_daemon_functions> list. Since these functions are serviced by the "
4626 "library and do not travel over the RPC mechanism to the daemon, these "
4627 "functions do not need a procedure number, and so the procedure number is set "
4632 #: ../src/guestfs.pod:2453
4633 msgid "Implement the action (in C):"
4637 #: ../src/guestfs.pod:2455
4639 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4640 "C<daemon/> directory."
4644 #: ../src/guestfs.pod:2458
4646 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4647 "(note: double underscore) in the C<src/> directory."
4651 #: ../src/guestfs.pod:2461
4652 msgid "In either case, use another function as an example of what to do."
4656 #: ../src/guestfs.pod:2465
4657 msgid "After making these changes, use C<make> to compile."
4661 #: ../src/guestfs.pod:2467
4663 "Note that you don't need to implement the RPC, language bindings, manual "
4664 "pages or anything else. It's all automatically generated from the OCaml "
4669 #: ../src/guestfs.pod:2471
4670 msgid "ADDING TESTS FOR AN API ACTION"
4674 #: ../src/guestfs.pod:2473
4676 "You can supply zero or as many tests as you want per API call. The tests "
4677 "can either be added as part of the API description "
4678 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4679 "drop a script into C<regressions/>. Note that adding a script to "
4680 "C<regressions/> is slower, so if possible use the first method."
4684 #: ../src/guestfs.pod:2479
4686 "The following describes the test environment used when you add an API test "
4687 "in C<generator_actions.ml>."
4691 #: ../src/guestfs.pod:2482
4692 msgid "The test environment has 4 block devices:"
4696 #: ../src/guestfs.pod:2486
4697 msgid "C</dev/sda> 500MB"
4701 #: ../src/guestfs.pod:2488
4702 msgid "General block device for testing."
4706 #: ../src/guestfs.pod:2490
4707 msgid "C</dev/sdb> 50MB"
4711 #: ../src/guestfs.pod:2492
4713 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4718 #: ../src/guestfs.pod:2495
4719 msgid "C</dev/sdc> 10MB"
4723 #: ../src/guestfs.pod:2497
4724 msgid "Used in a few tests where two block devices are needed."
4728 #: ../src/guestfs.pod:2499
4733 #: ../src/guestfs.pod:2501
4734 msgid "ISO with fixed content (see C<images/test.iso>)."
4738 #: ../src/guestfs.pod:2505
4740 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4741 "appliance and block devices are reused between tests. So don't try testing "
4742 "L</guestfs_kill_subprocess> :-x"
4746 #: ../src/guestfs.pod:2509
4748 "Each test starts with an initial scenario, selected using one of the "
4749 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4750 "initialize the disks mentioned above in a particular way as documented in "
4751 "C<generator_types.ml>. You should not assume anything about the previous "
4752 "contents of other disks that are not initialized."
4756 #: ../src/guestfs.pod:2515
4758 "You can add a prerequisite clause to any individual test. This is a "
4759 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4760 "if testing a command which might not work on all variations of libguestfs "
4761 "builds. A test that has prerequisite of C<Always> means to run "
4766 #: ../src/guestfs.pod:2521
4768 "In addition, packagers can skip individual tests by setting environment "
4769 "variables before running C<make check>."
4773 #: ../src/guestfs.pod:2524
4776 " SKIP_TEST_<CMD>_<NUM>=1\n"
4781 #: ../src/guestfs.pod:2526
4782 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4786 #: ../src/guestfs.pod:2528
4791 #: ../src/guestfs.pod:2530
4794 " SKIP_TEST_<CMD>=1\n"
4799 #: ../src/guestfs.pod:2532
4800 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4804 #: ../src/guestfs.pod:2534
4805 msgid "Packagers can run only certain tests by setting for example:"
4809 #: ../src/guestfs.pod:2536
4812 " TEST_ONLY=\"vfs_type zerofree\"\n"
4817 #: ../src/guestfs.pod:2538
4819 "See C<capitests/tests.c> for more details of how these environment variables "
4824 #: ../src/guestfs.pod:2541
4825 msgid "DEBUGGING NEW API ACTIONS"
4829 #: ../src/guestfs.pod:2543
4830 msgid "Test new actions work before submitting them."
4834 #: ../src/guestfs.pod:2545
4835 msgid "You can use guestfish to try out new commands."
4839 #: ../src/guestfs.pod:2547
4841 "Debugging the daemon is a problem because it runs inside a minimal "
4842 "environment. However you can fprintf messages in the daemon to stderr, and "
4843 "they will show up if you use C<guestfish -v>."
4847 #: ../src/guestfs.pod:2551
4848 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4852 #: ../src/guestfs.pod:2553
4854 "Our C source code generally adheres to some basic code-formatting "
4855 "conventions. The existing code base is not totally consistent on this "
4856 "front, but we do prefer that contributed code be formatted similarly. In "
4857 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4858 "indentation level, and other than that, follow the K&R style."
4862 #: ../src/guestfs.pod:2559
4864 "If you use Emacs, add the following to one of one of your start-up files "
4865 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4869 #: ../src/guestfs.pod:2562
4872 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4873 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4874 " (add-hook 'find-file-hook\n"
4875 " '(lambda () (if (and buffer-file-name\n"
4876 " (string-match \"/libguestfs\\\\>\"\n"
4877 " (buffer-file-name))\n"
4878 " (not (string-equal mode-name \"Change Log\"))\n"
4879 " (not (string-equal mode-name \"Makefile\")))\n"
4880 " (setq indent-tabs-mode nil))))\n"
4885 #: ../src/guestfs.pod:2572
4888 " ;;; When editing C sources in libguestfs, use this style.\n"
4889 " (defun libguestfs-c-mode ()\n"
4890 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4892 " (c-set-style \"K&R\")\n"
4893 " (setq c-indent-level 2)\n"
4894 " (setq c-basic-offset 2))\n"
4895 " (add-hook 'c-mode-hook\n"
4896 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4897 " (buffer-file-name))\n"
4898 " (libguestfs-c-mode))))\n"
4903 #: ../src/guestfs.pod:2584
4904 msgid "Enable warnings when compiling (and fix any problems this finds):"
4908 #: ../src/guestfs.pod:2587
4911 " ./configure --enable-gcc-warnings\n"
4916 #: ../src/guestfs.pod:2589
4917 msgid "Useful targets are:"
4921 #: ../src/guestfs.pod:2591
4924 " make syntax-check # checks the syntax of the C code\n"
4925 " make check # runs the test suite\n"
4930 #: ../src/guestfs.pod:2594
4931 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4935 #: ../src/guestfs.pod:2596
4937 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4938 "which are used to do shell quoting."
4942 #: ../src/guestfs.pod:2601
4947 #: ../src/guestfs.pod:2603
4949 "Simple shell quoted string. Any spaces or other shell characters are "
4954 #: ../src/guestfs.pod:2606
4959 #: ../src/guestfs.pod:2608
4961 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4966 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:240 ../fish/guestfish.pod:599
4967 msgid "For example:"
4971 #: ../src/guestfs.pod:2615
4974 " asprintf (&cmd, \"cat %R\", path);\n"
4979 #: ../src/guestfs.pod:2617
4980 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4984 #: ../src/guestfs.pod:2619
4986 "I<Note:> Do I<not> use these when you are passing parameters to the "
4987 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4988 "because they are not passed via the shell (instead, straight to exec). You "
4989 "probably want to use the C<sysroot_path()> function however."
4993 #: ../src/guestfs.pod:2625
4994 msgid "SUBMITTING YOUR NEW API ACTIONS"
4998 #: ../src/guestfs.pod:2627
5000 "Submit patches to the mailing list: "
5001 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5002 "L<rjones@redhat.com>."
5006 #: ../src/guestfs.pod:2631
5007 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5011 #: ../src/guestfs.pod:2633
5012 msgid "We support i18n (gettext anyhow) in the library."
5016 #: ../src/guestfs.pod:2635
5018 "However many messages come from the daemon, and we don't translate those at "
5019 "the moment. One reason is that the appliance generally has all locale files "
5020 "removed from it, because they take up a lot of space. So we'd have to readd "
5021 "some of those, as well as copying our PO files into the appliance."
5025 #: ../src/guestfs.pod:2641
5027 "Debugging messages are never translated, since they are intended for the "
5032 #: ../src/guestfs.pod:2644
5033 msgid "SOURCE CODE SUBDIRECTORIES"
5037 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5721 ../fish/guestfish-actions.pod:3838
5038 msgid "C<appliance>"
5042 #: ../src/guestfs.pod:2650
5043 msgid "The libguestfs appliance, build scripts and so on."
5047 #: ../src/guestfs.pod:2652
5048 msgid "C<capitests>"
5052 #: ../src/guestfs.pod:2654
5053 msgid "Automated tests of the C API."
5057 #: ../src/guestfs.pod:2656
5062 #: ../src/guestfs.pod:2658
5064 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5069 #: ../src/guestfs.pod:2661
5074 #: ../src/guestfs.pod:2663
5075 msgid "Outside contributions, experimental parts."
5079 #: ../src/guestfs.pod:2665
5084 #: ../src/guestfs.pod:2667
5086 "The daemon that runs inside the libguestfs appliance and carries out "
5091 #: ../src/guestfs.pod:2670
5096 #: ../src/guestfs.pod:2672
5097 msgid "L<virt-df(1)> command and documentation."
5101 #: ../src/guestfs.pod:2674
5106 #: ../src/guestfs.pod:2676
5107 msgid "C API example code."
5111 #: ../src/guestfs.pod:2678
5116 #: ../src/guestfs.pod:2680
5118 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5119 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5120 "L<virt-tar-out(1)>."
5124 #: ../src/guestfs.pod:2684
5129 #: ../src/guestfs.pod:2686
5130 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5134 #: ../src/guestfs.pod:2688
5135 msgid "C<generator>"
5139 #: ../src/guestfs.pod:2690
5141 "The crucially important generator, used to automatically generate large "
5142 "amounts of boilerplate C code for things like RPC and bindings."
5146 #: ../src/guestfs.pod:2693
5151 #: ../src/guestfs.pod:2695
5152 msgid "Files used by the test suite."
5156 #: ../src/guestfs.pod:2697
5157 msgid "Some \"phony\" guest images which we test against."
5161 #: ../src/guestfs.pod:2699
5162 msgid "C<inspector>"
5166 #: ../src/guestfs.pod:2701
5167 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5171 #: ../src/guestfs.pod:2703
5176 #: ../src/guestfs.pod:2705
5177 msgid "Logo used on the website. The fish is called Arthur by the way."
5181 #: ../src/guestfs.pod:2707
5186 #: ../src/guestfs.pod:2709
5187 msgid "M4 macros used by autoconf."
5191 #: ../src/guestfs.pod:2711
5196 #: ../src/guestfs.pod:2713
5197 msgid "Translations of simple gettext strings."
5201 #: ../src/guestfs.pod:2715
5206 #: ../src/guestfs.pod:2717
5208 "The build infrastructure and PO files for translations of manpages and POD "
5209 "files. Eventually this will be combined with the C<po> directory, but that "
5210 "is rather complicated."
5214 #: ../src/guestfs.pod:2721
5215 msgid "C<regressions>"
5219 #: ../src/guestfs.pod:2723
5220 msgid "Regression tests."
5224 #: ../src/guestfs.pod:2725
5229 #: ../src/guestfs.pod:2727
5230 msgid "L<virt-rescue(1)> command and documentation."
5234 #: ../src/guestfs.pod:2729
5239 #: ../src/guestfs.pod:2731
5240 msgid "Source code to the C library."
5244 #: ../src/guestfs.pod:2733
5249 #: ../src/guestfs.pod:2735
5250 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5254 #: ../src/guestfs.pod:2737
5255 msgid "C<test-tool>"
5259 #: ../src/guestfs.pod:2739
5261 "Test tool for end users to test if their qemu/kernel combination will work "
5266 #: ../src/guestfs.pod:2742
5271 #: ../src/guestfs.pod:2744
5276 #: ../src/guestfs.pod:2746
5281 #: ../src/guestfs.pod:2748
5286 #: ../src/guestfs.pod:2750
5291 #: ../src/guestfs.pod:2752
5296 #: ../src/guestfs.pod:2754
5301 #: ../src/guestfs.pod:2756
5306 #: ../src/guestfs.pod:2758
5307 msgid "Language bindings."
5311 #: ../src/guestfs.pod:2762 ../fish/guestfish.pod:996 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
5312 msgid "ENVIRONMENT VARIABLES"
5316 #: ../src/guestfs.pod:2766 ../fish/guestfish.pod:1022
5317 msgid "LIBGUESTFS_APPEND"
5321 #: ../src/guestfs.pod:2768 ../fish/guestfish.pod:1024
5322 msgid "Pass additional options to the guest kernel."
5326 #: ../src/guestfs.pod:2770 ../fish/guestfish.pod:1026
5327 msgid "LIBGUESTFS_DEBUG"
5331 #: ../src/guestfs.pod:2772
5333 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5334 "effect as calling C<guestfs_set_verbose (g, 1)>."
5338 #: ../src/guestfs.pod:2775 ../fish/guestfish.pod:1031
5339 msgid "LIBGUESTFS_MEMSIZE"
5343 #: ../src/guestfs.pod:2777 ../fish/guestfish.pod:1033
5344 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5348 #: ../src/guestfs.pod:2780 ../fish/guestfish.pod:1036
5351 " LIBGUESTFS_MEMSIZE=700\n"
5356 #: ../src/guestfs.pod:2782 ../fish/guestfish.pod:1038
5357 msgid "LIBGUESTFS_PATH"
5361 #: ../src/guestfs.pod:2784
5363 "Set the path that libguestfs uses to search for a supermin appliance. See "
5364 "the discussion of paths in section L</PATH> above."
5368 #: ../src/guestfs.pod:2787 ../fish/guestfish.pod:1043
5369 msgid "LIBGUESTFS_QEMU"
5373 #: ../src/guestfs.pod:2789 ../fish/guestfish.pod:1045
5375 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5376 "which was found at compile time by the configure script is used."
5380 #: ../src/guestfs.pod:2793
5381 msgid "See also L</QEMU WRAPPERS> above."
5385 #: ../src/guestfs.pod:2795 ../fish/guestfish.pod:1049
5386 msgid "LIBGUESTFS_TRACE"
5390 #: ../src/guestfs.pod:2797
5392 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5393 "effect as calling C<guestfs_set_trace (g, 1)>."
5397 #: ../src/guestfs.pod:2800 ../fish/guestfish.pod:1058
5402 #: ../src/guestfs.pod:2802 ../fish/guestfish.pod:1060
5404 "Location of temporary directory, defaults to C</tmp> except for the cached "
5405 "supermin appliance which defaults to C</var/tmp>."
5409 #: ../src/guestfs.pod:2805 ../fish/guestfish.pod:1063
5411 "If libguestfs was compiled to use the supermin appliance then the real "
5412 "appliance is cached in this directory, shared between all handles belonging "
5413 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5414 "use in case C</var/tmp> is not large enough."
5418 #: ../src/guestfs.pod:2813 ../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:1489 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5423 #: ../src/guestfs.pod:2815
5425 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5426 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5427 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5428 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5429 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5430 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5431 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5432 "L<http://libguestfs.org/>."
5436 #: ../src/guestfs.pod:2842
5438 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5439 "L<lvm(8)>, L<disktype(1)>."
5443 #: ../src/guestfs.pod:2849 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
5448 #: ../src/guestfs.pod:2851
5449 msgid "To get a list of bugs against libguestfs use this link:"
5453 #: ../src/guestfs.pod:2853
5454 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5458 #: ../src/guestfs.pod:2855
5459 msgid "To report a new bug against libguestfs use this link:"
5463 #: ../src/guestfs.pod:2857
5464 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5468 #: ../src/guestfs.pod:2859
5469 msgid "When reporting a bug, please check:"
5473 #: ../src/guestfs.pod:2865
5474 msgid "That the bug hasn't been reported already."
5478 #: ../src/guestfs.pod:2869
5479 msgid "That you are testing a recent version."
5483 #: ../src/guestfs.pod:2873
5484 msgid "Describe the bug accurately, and give a way to reproduce it."
5488 #: ../src/guestfs.pod:2877
5490 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5495 #: ../src/guestfs.pod:2882 ../fish/guestfish.pod:1144 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:249
5500 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1146 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:251
5501 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5505 #: ../src/guestfs.pod:2886 ../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:1514 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5510 #: ../src/guestfs.pod:2888 ../fish/guestfish.pod:1150 ../fuse/guestmount.pod:255
5511 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
5515 #: ../src/guestfs.pod:2891
5517 "This library is free software; you can redistribute it and/or modify it "
5518 "under the terms of the GNU Lesser General Public License as published by the "
5519 "Free Software Foundation; either version 2 of the License, or (at your "
5520 "option) any later version."
5524 #: ../src/guestfs.pod:2896
5526 "This library is distributed in the hope that it will be useful, but WITHOUT "
5527 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5528 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5533 #: ../src/guestfs.pod:2901
5535 "You should have received a copy of the GNU Lesser General Public License "
5536 "along with this library; if not, write to the Free Software Foundation, "
5537 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5541 #: ../src/guestfs-actions.pod:1
5542 msgid "guestfs_add_cdrom"
5546 #: ../src/guestfs-actions.pod:3
5550 " guestfs_add_cdrom (guestfs_h *g,\n"
5551 " const char *filename);\n"
5556 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5557 msgid "This function adds a virtual CD-ROM disk image to the guest."
5561 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5562 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5566 #: ../src/guestfs-actions.pod:17
5568 "This call checks for the existence of C<filename>. This stops you from "
5569 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5570 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5575 #: ../src/guestfs-actions.pod:24
5577 "If you just want to add an ISO file (often you use this as an efficient way "
5578 "to transfer large files into the guest), then you should probably use "
5579 "C<guestfs_add_drive_ro> instead."
5583 #: ../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:3371 ../src/guestfs-actions.pod:3386 ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3561 ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3588 ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:3617 ../src/guestfs-actions.pod:3653 ../src/guestfs-actions.pod:3725 ../src/guestfs-actions.pod:3745 ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:3808 ../src/guestfs-actions.pod:3840 ../src/guestfs-actions.pod:3859 ../src/guestfs-actions.pod:3878 ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:3990 ../src/guestfs-actions.pod:4005 ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:4115 ../src/guestfs-actions.pod:4135 ../src/guestfs-actions.pod:4148 ../src/guestfs-actions.pod:4199 ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:4235 ../src/guestfs-actions.pod:4251 ../src/guestfs-actions.pod:4265 ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4311 ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4462 ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4512 ../src/guestfs-actions.pod:4531 ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:4573 ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4638 ../src/guestfs-actions.pod:4653 ../src/guestfs-actions.pod:4673 ../src/guestfs-actions.pod:4687 ../src/guestfs-actions.pod:4704 ../src/guestfs-actions.pod:4753 ../src/guestfs-actions.pod:4790 ../src/guestfs-actions.pod:4804 ../src/guestfs-actions.pod:4832 ../src/guestfs-actions.pod:4849 ../src/guestfs-actions.pod:4867 ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5058 ../src/guestfs-actions.pod:5080 ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5130 ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5213 ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5529 ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5567 ../src/guestfs-actions.pod:5579 ../src/guestfs-actions.pod:5591 ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:5631 ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5668 ../src/guestfs-actions.pod:5687 ../src/guestfs-actions.pod:5706 ../src/guestfs-actions.pod:5736 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5775 ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:5812 ../src/guestfs-actions.pod:5833 ../src/guestfs-actions.pod:5852 ../src/guestfs-actions.pod:5869 ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:5921 ../src/guestfs-actions.pod:5940 ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:5983 ../src/guestfs-actions.pod:5998 ../src/guestfs-actions.pod:6017 ../src/guestfs-actions.pod:6054 ../src/guestfs-actions.pod:6077 ../src/guestfs-actions.pod:6103 ../src/guestfs-actions.pod:6211 ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6344 ../src/guestfs-actions.pod:6357 ../src/guestfs-actions.pod:6370 ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6418 ../src/guestfs-actions.pod:6431 ../src/guestfs-actions.pod:6446 ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6522 ../src/guestfs-actions.pod:6538 ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6584 ../src/guestfs-actions.pod:6604 ../src/guestfs-actions.pod:6640 ../src/guestfs-actions.pod:6654 ../src/guestfs-actions.pod:6695 ../src/guestfs-actions.pod:6708 ../src/guestfs-actions.pod:6726 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6915 ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6947 ../src/guestfs-actions.pod:7002 ../src/guestfs-actions.pod:7015 ../src/guestfs-actions.pod:7060 ../src/guestfs-actions.pod:7093 ../src/guestfs-actions.pod:7147 ../src/guestfs-actions.pod:7173 ../src/guestfs-actions.pod:7239 ../src/guestfs-actions.pod:7258 ../src/guestfs-actions.pod:7287
5584 msgid "This function returns 0 on success or -1 on error."
5588 #: ../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
5590 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5595 #: ../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:4336 ../src/guestfs-actions.pod:7181 ../src/guestfs-actions.pod:7350 ../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:2938 ../fish/guestfish-actions.pod:4796 ../fish/guestfish-actions.pod:4893
5597 "Deprecated functions will not be removed from the API, but the fact that "
5598 "they are deprecated indicates that there are problems with correct use of "
5603 #: ../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:3373 ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:5754 ../src/guestfs-actions.pod:5871 ../src/guestfs-actions.pod:5985 ../src/guestfs-actions.pod:6448 ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:7095
5604 msgid "(Added in 0.3)"
5608 #: ../src/guestfs-actions.pod:41
5609 msgid "guestfs_add_domain"
5613 #: ../src/guestfs-actions.pod:43
5617 " guestfs_add_domain (guestfs_h *g,\n"
5618 " const char *dom,\n"
5624 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:145 ../src/guestfs-actions.pod:4350
5626 "You may supply a list of optional arguments to this call. Use zero or more "
5627 "of the following pairs of parameters, and terminate the list with C<-1> on "
5628 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5632 #: ../src/guestfs-actions.pod:53
5635 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5636 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5637 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5638 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5643 #: ../src/guestfs-actions.pod:58
5645 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5646 "It works by connecting to libvirt, requesting the domain and domain XML from "
5647 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5652 #: ../src/guestfs-actions.pod:63 ../fish/guestfish-actions.pod:46
5654 "The number of disks added is returned. This operation is atomic: if an "
5655 "error is returned, then no disks are added."
5659 #: ../src/guestfs-actions.pod:66 ../fish/guestfish-actions.pod:49
5661 "This function does some minimal checks to make sure the libvirt domain is "
5662 "not running (unless C<readonly> is true). In a future version we will try "
5663 "to acquire the libvirt lock on each disk."
5667 #: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:53
5669 "Disks must be accessible locally. This often means that adding disks from a "
5670 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5671 "unless those disks are accessible via the same device path locally too."
5675 #: ../src/guestfs-actions.pod:75 ../fish/guestfish-actions.pod:58
5677 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5678 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5679 "default libvirt URI (or one set through an environment variable, see the "
5680 "libvirt documentation for full details)."
5684 #: ../src/guestfs-actions.pod:81 ../fish/guestfish-actions.pod:64
5686 "The optional C<live> flag controls whether this call will try to connect to "
5687 "a running virtual machine C<guestfsd> process if it sees a suitable "
5688 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5689 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5690 "DAEMONS> for more information."
5694 #: ../src/guestfs-actions.pod:88
5696 "The other optional parameters are passed directly through to "
5697 "C<guestfs_add_drive_opts>."
5701 #: ../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:4776 ../src/guestfs-actions.pod:4904 ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5336 ../src/guestfs-actions.pod:6681 ../src/guestfs-actions.pod:7106 ../src/guestfs-actions.pod:7119 ../src/guestfs-actions.pod:7132
5702 msgid "On error this function returns -1."
5706 #: ../src/guestfs-actions.pod:93
5707 msgid "(Added in 1.7.4)"
5711 #: ../src/guestfs-actions.pod:95
5712 msgid "guestfs_add_domain_va"
5716 #: ../src/guestfs-actions.pod:97
5720 " guestfs_add_domain_va (guestfs_h *g,\n"
5721 " const char *dom,\n"
5727 #: ../src/guestfs-actions.pod:102
5728 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5732 #: ../src/guestfs-actions.pod:104 ../src/guestfs-actions.pod:115 ../src/guestfs-actions.pod:208 ../src/guestfs-actions.pod:219 ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4415
5733 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5737 #: ../src/guestfs-actions.pod:106
5738 msgid "guestfs_add_domain_argv"
5742 #: ../src/guestfs-actions.pod:108
5746 " guestfs_add_domain_argv (guestfs_h *g,\n"
5747 " const char *dom,\n"
5748 " const struct guestfs_add_domain_argv *optargs);\n"
5753 #: ../src/guestfs-actions.pod:113
5754 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5758 #: ../src/guestfs-actions.pod:117
5759 msgid "guestfs_add_drive"
5763 #: ../src/guestfs-actions.pod:119
5767 " guestfs_add_drive (guestfs_h *g,\n"
5768 " const char *filename);\n"
5773 #: ../src/guestfs-actions.pod:123
5775 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5776 "optional parameters, so the disk is added writable, with the format being "
5777 "detected automatically."
5781 #: ../src/guestfs-actions.pod:127
5783 "Automatic detection of the format opens you up to a potential security hole "
5784 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5785 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5786 "you should think about replacing calls to this function with calls to "
5787 "C<guestfs_add_drive_opts>, and specifying the format."
5791 #: ../src/guestfs-actions.pod:138
5792 msgid "guestfs_add_drive_opts"
5796 #: ../src/guestfs-actions.pod:140
5800 " guestfs_add_drive_opts (guestfs_h *g,\n"
5801 " const char *filename,\n"
5807 #: ../src/guestfs-actions.pod:150
5810 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5811 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5812 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5817 #: ../src/guestfs-actions.pod:154 ../fish/guestfish-actions.pod:97
5819 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5820 "The first time you call this function, the disk appears as C</dev/sda>, the "
5821 "second time as C</dev/sdb>, and so on."
5825 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:102
5827 "You don't necessarily need to be root when using libguestfs. However you "
5828 "obviously do need sufficient permissions to access the filename for whatever "
5829 "operations you want to perform (ie. read access if you just want to read the "
5830 "image or write access if you want to modify the image)."
5834 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:108
5835 msgid "This call checks that C<filename> exists."
5839 #: ../src/guestfs-actions.pod:167 ../src/guestfs-actions.pod:4361 ../fish/guestfish-actions.pod:110 ../fish/guestfish-actions.pod:2949
5840 msgid "The optional arguments are:"
5844 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:114
5849 #: ../src/guestfs-actions.pod:173 ../fish/guestfish-actions.pod:116
5851 "If true then the image is treated as read-only. Writes are still allowed, "
5852 "but they are stored in a temporary snapshot overlay which is discarded at "
5853 "the end. The disk that you add is not modified."
5857 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:120
5862 #: ../src/guestfs-actions.pod:179
5864 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5865 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5866 "Possible formats include C<raw> and C<qcow2>."
5870 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:126
5872 "Automatic detection of the format opens you up to a potential security hole "
5873 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5874 "RHBZ#642934. Specifying the format closes this security hole."
5878 #: ../src/guestfs-actions.pod:188 ../fish/guestfish-actions.pod:131
5883 #: ../src/guestfs-actions.pod:190
5885 "This rarely-used option lets you emulate the behaviour of the deprecated "
5886 "C<guestfs_add_drive_with_if> call (q.v.)"
5890 #: ../src/guestfs-actions.pod:197
5891 msgid "(Added in 1.5.23)"
5895 #: ../src/guestfs-actions.pod:199
5896 msgid "guestfs_add_drive_opts_va"
5900 #: ../src/guestfs-actions.pod:201
5904 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5905 " const char *filename,\n"
5911 #: ../src/guestfs-actions.pod:206
5912 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5916 #: ../src/guestfs-actions.pod:210
5917 msgid "guestfs_add_drive_opts_argv"
5921 #: ../src/guestfs-actions.pod:212
5925 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5926 " const char *filename,\n"
5927 " const struct guestfs_add_drive_opts_argv "
5933 #: ../src/guestfs-actions.pod:217
5934 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5938 #: ../src/guestfs-actions.pod:221
5939 msgid "guestfs_add_drive_ro"
5943 #: ../src/guestfs-actions.pod:223
5947 " guestfs_add_drive_ro (guestfs_h *g,\n"
5948 " const char *filename);\n"
5953 #: ../src/guestfs-actions.pod:227
5955 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5956 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5957 "disk is added read-only, with the format being detected automatically."
5961 #: ../src/guestfs-actions.pod:234
5962 msgid "(Added in 1.0.38)"
5966 #: ../src/guestfs-actions.pod:236
5967 msgid "guestfs_add_drive_ro_with_if"
5971 #: ../src/guestfs-actions.pod:238
5975 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
5976 " const char *filename,\n"
5977 " const char *iface);\n"
5982 #: ../src/guestfs-actions.pod:243
5984 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
5985 "QEMU interface emulation to use at run time."
5989 #: ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:2351
5990 msgid "(Added in 1.0.84)"
5994 #: ../src/guestfs-actions.pod:257
5995 msgid "guestfs_add_drive_with_if"
5999 #: ../src/guestfs-actions.pod:259
6003 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6004 " const char *filename,\n"
6005 " const char *iface);\n"
6010 #: ../src/guestfs-actions.pod:264
6012 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6013 "QEMU interface emulation to use at run time."
6017 #: ../src/guestfs-actions.pod:278
6018 msgid "guestfs_aug_clear"
6022 #: ../src/guestfs-actions.pod:280
6026 " guestfs_aug_clear (guestfs_h *g,\n"
6027 " const char *augpath);\n"
6032 #: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:183
6034 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6035 "L<augtool(1)> C<clear> command."
6039 #: ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:2101
6040 msgid "(Added in 1.3.4)"
6044 #: ../src/guestfs-actions.pod:291
6045 msgid "guestfs_aug_close"
6049 #: ../src/guestfs-actions.pod:293
6053 " guestfs_aug_close (guestfs_h *g);\n"
6058 #: ../src/guestfs-actions.pod:296
6060 "Close the current Augeas handle and free up any resources used by it. After "
6061 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6062 "any other Augeas functions."
6066 #: ../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:5387
6067 msgid "(Added in 0.7)"
6071 #: ../src/guestfs-actions.pod:305
6072 msgid "guestfs_aug_defnode"
6076 #: ../src/guestfs-actions.pod:307
6079 " struct guestfs_int_bool *\n"
6080 " guestfs_aug_defnode (guestfs_h *g,\n"
6081 " const char *name,\n"
6082 " const char *expr,\n"
6083 " const char *val);\n"
6088 #: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:199
6089 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6093 #: ../src/guestfs-actions.pod:316
6095 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6096 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6097 "containing that single node."
6101 #: ../src/guestfs-actions.pod:320 ../fish/guestfish-actions.pod:206
6103 "On success this returns a pair containing the number of nodes in the "
6104 "nodeset, and a boolean flag if a node was created."
6108 #: ../src/guestfs-actions.pod:324
6110 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6111 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6115 #: ../src/guestfs-actions.pod:330
6116 msgid "guestfs_aug_defvar"
6120 #: ../src/guestfs-actions.pod:332
6124 " guestfs_aug_defvar (guestfs_h *g,\n"
6125 " const char *name,\n"
6126 " const char *expr);\n"
6131 #: ../src/guestfs-actions.pod:337 ../fish/guestfish-actions.pod:214
6133 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6134 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6138 #: ../src/guestfs-actions.pod:341 ../fish/guestfish-actions.pod:218
6140 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6141 "evaluates to something which is not a nodeset."
6145 #: ../src/guestfs-actions.pod:348
6146 msgid "guestfs_aug_get"
6150 #: ../src/guestfs-actions.pod:350
6154 " guestfs_aug_get (guestfs_h *g,\n"
6155 " const char *augpath);\n"
6160 #: ../src/guestfs-actions.pod:354 ../fish/guestfish-actions.pod:225
6162 "Look up the value associated with C<path>. If C<path> matches exactly one "
6163 "node, the C<value> is returned."
6167 #: ../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:2897 ../src/guestfs-actions.pod:2957 ../src/guestfs-actions.pod:2980 ../src/guestfs-actions.pod:3547 ../src/guestfs-actions.pod:3897 ../src/guestfs-actions.pod:4067 ../src/guestfs-actions.pod:4177 ../src/guestfs-actions.pod:4922 ../src/guestfs-actions.pod:5115 ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5512 ../src/guestfs-actions.pod:6124 ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6181 ../src/guestfs-actions.pod:6855 ../src/guestfs-actions.pod:6874 ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:7072 ../src/guestfs-actions.pod:7344
6169 "This function returns a string, or NULL on error. I<The caller must free "
6170 "the returned string after use>."
6174 #: ../src/guestfs-actions.pod:362
6175 msgid "guestfs_aug_init"
6179 #: ../src/guestfs-actions.pod:364
6183 " guestfs_aug_init (guestfs_h *g,\n"
6184 " const char *root,\n"
6190 #: ../src/guestfs-actions.pod:369 ../fish/guestfish-actions.pod:232
6192 "Create a new Augeas handle for editing configuration files. If there was "
6193 "any previous Augeas handle associated with this guestfs session, then it is "
6198 #: ../src/guestfs-actions.pod:373
6199 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6203 #: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:239
6204 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6208 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:242
6210 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6211 "logical I<or> of the following integers:"
6215 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:248
6216 msgid "C<AUG_SAVE_BACKUP> = 1"
6220 #: ../src/guestfs-actions.pod:387 ../fish/guestfish-actions.pod:250
6221 msgid "Keep the original file with a C<.augsave> extension."
6225 #: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:252
6226 msgid "C<AUG_SAVE_NEWFILE> = 2"
6230 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:254
6232 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6233 "original. Overrides C<AUG_SAVE_BACKUP>."
6237 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:257
6238 msgid "C<AUG_TYPE_CHECK> = 4"
6242 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:259
6243 msgid "Typecheck lenses (can be expensive)."
6247 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:261
6248 msgid "C<AUG_NO_STDINC> = 8"
6252 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:263
6253 msgid "Do not use standard load path for modules."
6257 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:265
6258 msgid "C<AUG_SAVE_NOOP> = 16"
6262 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:267
6263 msgid "Make save a no-op, just record what would have been changed."
6267 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:269
6268 msgid "C<AUG_NO_LOAD> = 32"
6272 #: ../src/guestfs-actions.pod:408
6273 msgid "Do not load the tree in C<guestfs_aug_init>."
6277 #: ../src/guestfs-actions.pod:412
6278 msgid "To close the handle, you can call C<guestfs_aug_close>."
6282 #: ../src/guestfs-actions.pod:414 ../fish/guestfish-actions.pod:277
6283 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6287 #: ../src/guestfs-actions.pod:420
6288 msgid "guestfs_aug_insert"
6292 #: ../src/guestfs-actions.pod:422
6296 " guestfs_aug_insert (guestfs_h *g,\n"
6297 " const char *augpath,\n"
6298 " const char *label,\n"
6304 #: ../src/guestfs-actions.pod:428 ../fish/guestfish-actions.pod:283
6306 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6307 "or after C<path> (depending on the boolean flag C<before>)."
6311 #: ../src/guestfs-actions.pod:432 ../fish/guestfish-actions.pod:287
6313 "C<path> must match exactly one existing node in the tree, and C<label> must "
6314 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6318 #: ../src/guestfs-actions.pod:440
6319 msgid "guestfs_aug_load"
6323 #: ../src/guestfs-actions.pod:442
6327 " guestfs_aug_load (guestfs_h *g);\n"
6332 #: ../src/guestfs-actions.pod:445 ../fish/guestfish-actions.pod:295
6333 msgid "Load files into the tree."
6337 #: ../src/guestfs-actions.pod:447 ../fish/guestfish-actions.pod:297
6338 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6342 #: ../src/guestfs-actions.pod:454
6343 msgid "guestfs_aug_ls"
6347 #: ../src/guestfs-actions.pod:456
6351 " guestfs_aug_ls (guestfs_h *g,\n"
6352 " const char *augpath);\n"
6357 #: ../src/guestfs-actions.pod:460
6359 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6360 "sorting the resulting nodes into alphabetical order."
6364 #: ../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:2914 ../src/guestfs-actions.pod:3182 ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:4039 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5497 ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6313 ../src/guestfs-actions.pod:6459 ../src/guestfs-actions.pod:6483 ../src/guestfs-actions.pod:6965 ../src/guestfs-actions.pod:6985 ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7197 ../src/guestfs-actions.pod:7216 ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7320 ../src/guestfs-actions.pod:7366 ../src/guestfs-actions.pod:7385
6366 "This function returns a NULL-terminated array of strings (like "
6367 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6368 "strings and the array after use>."
6372 #: ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1421 ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:4117 ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:4313 ../src/guestfs-actions.pod:4741 ../src/guestfs-actions.pod:5198 ../src/guestfs-actions.pod:5593 ../src/guestfs-actions.pod:5607 ../src/guestfs-actions.pod:5619 ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6697 ../src/guestfs-actions.pod:6710 ../src/guestfs-actions.pod:6949 ../src/guestfs-actions.pod:7185
6373 msgid "(Added in 0.8)"
6377 #: ../src/guestfs-actions.pod:469
6378 msgid "guestfs_aug_match"
6382 #: ../src/guestfs-actions.pod:471
6386 " guestfs_aug_match (guestfs_h *g,\n"
6387 " const char *augpath);\n"
6392 #: ../src/guestfs-actions.pod:475 ../fish/guestfish-actions.pod:311
6394 "Returns a list of paths which match the path expression C<path>. The "
6395 "returned paths are sufficiently qualified so that they match exactly one "
6396 "node in the current tree."
6400 #: ../src/guestfs-actions.pod:485
6401 msgid "guestfs_aug_mv"
6405 #: ../src/guestfs-actions.pod:487
6409 " guestfs_aug_mv (guestfs_h *g,\n"
6410 " const char *src,\n"
6411 " const char *dest);\n"
6416 #: ../src/guestfs-actions.pod:492 ../fish/guestfish-actions.pod:319
6418 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6419 "C<dest> is overwritten if it exists."
6423 #: ../src/guestfs-actions.pod:499
6424 msgid "guestfs_aug_rm"
6428 #: ../src/guestfs-actions.pod:501
6432 " guestfs_aug_rm (guestfs_h *g,\n"
6433 " const char *augpath);\n"
6438 #: ../src/guestfs-actions.pod:505 ../fish/guestfish-actions.pod:326
6439 msgid "Remove C<path> and all of its children."
6443 #: ../src/guestfs-actions.pod:507 ../fish/guestfish-actions.pod:328
6444 msgid "On success this returns the number of entries which were removed."
6448 #: ../src/guestfs-actions.pod:513
6449 msgid "guestfs_aug_save"
6453 #: ../src/guestfs-actions.pod:515
6457 " guestfs_aug_save (guestfs_h *g);\n"
6462 #: ../src/guestfs-actions.pod:518 ../fish/guestfish-actions.pod:334
6463 msgid "This writes all pending changes to disk."
6467 #: ../src/guestfs-actions.pod:520
6469 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6474 #: ../src/guestfs-actions.pod:527
6475 msgid "guestfs_aug_set"
6479 #: ../src/guestfs-actions.pod:529
6483 " guestfs_aug_set (guestfs_h *g,\n"
6484 " const char *augpath,\n"
6485 " const char *val);\n"
6490 #: ../src/guestfs-actions.pod:534 ../fish/guestfish-actions.pod:343
6491 msgid "Set the value associated with C<path> to C<val>."
6495 #: ../src/guestfs-actions.pod:536
6497 "In the Augeas API, it is possible to clear a node by setting the value to "
6498 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6499 "this call. Instead you must use the C<guestfs_aug_clear> call."
6503 #: ../src/guestfs-actions.pod:545
6504 msgid "guestfs_available"
6508 #: ../src/guestfs-actions.pod:547
6512 " guestfs_available (guestfs_h *g,\n"
6513 " char *const *groups);\n"
6518 #: ../src/guestfs-actions.pod:551 ../fish/guestfish-actions.pod:354
6520 "This command is used to check the availability of some groups of "
6521 "functionality in the appliance, which not all builds of the libguestfs "
6522 "appliance will be able to provide."
6526 #: ../src/guestfs-actions.pod:555
6528 "The libguestfs groups, and the functions that those groups correspond to, "
6529 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6530 "runtime by calling C<guestfs_available_all_groups>."
6534 #: ../src/guestfs-actions.pod:560 ../fish/guestfish-actions.pod:363
6536 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6537 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6538 "and Augeas (configuration file editing) functions."
6542 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:368
6543 msgid "The command returns no error if I<all> requested groups are available."
6547 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:370
6549 "It fails with an error if one or more of the requested groups is unavailable "
6554 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:373
6556 "If an unknown group name is included in the list of groups then an error is "
6561 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:376
6566 #: ../src/guestfs-actions.pod:579
6567 msgid "You must call C<guestfs_launch> before calling this function."
6571 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:384
6573 "The reason is because we don't know what groups are supported by the "
6574 "appliance/daemon until it is running and can be queried."
6578 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:390
6580 "If a group of functions is available, this does not necessarily mean that "
6581 "they will work. You still have to check for errors when calling individual "
6582 "API functions even if they are available."
6586 #: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:397
6588 "It is usually the job of distro packagers to build complete functionality "
6589 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6590 "with all requirements satisfied, will support everything."
6594 #: ../src/guestfs-actions.pod:601
6596 "This call was added in version C<1.0.80>. In previous versions of "
6597 "libguestfs all you could do would be to speculatively execute a command to "
6598 "find out if the daemon implemented it. See also C<guestfs_version>."
6602 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1171
6603 msgid "(Added in 1.0.80)"
6607 #: ../src/guestfs-actions.pod:612
6608 msgid "guestfs_available_all_groups"
6612 #: ../src/guestfs-actions.pod:614
6616 " guestfs_available_all_groups (guestfs_h *g);\n"
6621 #: ../src/guestfs-actions.pod:617
6623 "This command returns a list of all optional groups that this daemon knows "
6624 "about. Note this returns both supported and unsupported groups. To find "
6625 "out which ones the daemon can actually support you have to call "
6626 "C<guestfs_available> on each member of the returned list."
6630 #: ../src/guestfs-actions.pod:623
6631 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6635 #: ../src/guestfs-actions.pod:629
6636 msgid "(Added in 1.3.15)"
6640 #: ../src/guestfs-actions.pod:631
6641 msgid "guestfs_base64_in"
6645 #: ../src/guestfs-actions.pod:633
6649 " guestfs_base64_in (guestfs_h *g,\n"
6650 " const char *base64file,\n"
6651 " const char *filename);\n"
6656 #: ../src/guestfs-actions.pod:638 ../fish/guestfish-actions.pod:427
6657 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6661 #: ../src/guestfs-actions.pod:643 ../src/guestfs-actions.pod:657
6662 msgid "(Added in 1.3.5)"
6666 #: ../src/guestfs-actions.pod:645
6667 msgid "guestfs_base64_out"
6671 #: ../src/guestfs-actions.pod:647
6675 " guestfs_base64_out (guestfs_h *g,\n"
6676 " const char *filename,\n"
6677 " const char *base64file);\n"
6682 #: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:436
6684 "This command downloads the contents of C<filename>, writing it out to local "
6685 "file C<base64file> encoded as base64."
6689 #: ../src/guestfs-actions.pod:659
6690 msgid "guestfs_blockdev_flushbufs"
6694 #: ../src/guestfs-actions.pod:661
6698 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6699 " const char *device);\n"
6704 #: ../src/guestfs-actions.pod:665 ../fish/guestfish-actions.pod:445
6705 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6709 #: ../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
6710 msgid "This uses the L<blockdev(8)> command."
6714 #: ../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
6715 msgid "(Added in 0.9.3)"
6719 #: ../src/guestfs-actions.pod:674
6720 msgid "guestfs_blockdev_getbsz"
6724 #: ../src/guestfs-actions.pod:676
6728 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6729 " const char *device);\n"
6734 #: ../src/guestfs-actions.pod:680 ../fish/guestfish-actions.pod:454
6735 msgid "This returns the block size of a device."
6739 #: ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:782 ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:519
6741 "(Note this is different from both I<size in blocks> and I<filesystem block "
6746 #: ../src/guestfs-actions.pod:691
6747 msgid "guestfs_blockdev_getro"
6751 #: ../src/guestfs-actions.pod:693
6755 " guestfs_blockdev_getro (guestfs_h *g,\n"
6756 " const char *device);\n"
6761 #: ../src/guestfs-actions.pod:697 ../fish/guestfish-actions.pod:465
6763 "Returns a boolean indicating if the block device is read-only (true if "
6764 "read-only, false if not)."
6768 #: ../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:3000 ../src/guestfs-actions.pod:3017 ../src/guestfs-actions.pod:3036 ../src/guestfs-actions.pod:3199 ../src/guestfs-actions.pod:3213 ../src/guestfs-actions.pod:3228 ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3273 ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:3303 ../src/guestfs-actions.pod:3316 ../src/guestfs-actions.pod:3330 ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:4886
6769 msgid "This function returns a C truth value on success or -1 on error."
6773 #: ../src/guestfs-actions.pod:706
6774 msgid "guestfs_blockdev_getsize64"
6778 #: ../src/guestfs-actions.pod:708
6782 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6783 " const char *device);\n"
6788 #: ../src/guestfs-actions.pod:712 ../fish/guestfish-actions.pod:474
6789 msgid "This returns the size of the device in bytes."
6793 #: ../src/guestfs-actions.pod:714
6794 msgid "See also C<guestfs_blockdev_getsz>."
6798 #: ../src/guestfs-actions.pod:722
6799 msgid "guestfs_blockdev_getss"
6803 #: ../src/guestfs-actions.pod:724
6807 " guestfs_blockdev_getss (guestfs_h *g,\n"
6808 " const char *device);\n"
6813 #: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:484
6815 "This returns the size of sectors on a block device. Usually 512, but can be "
6816 "larger for modern devices."
6820 #: ../src/guestfs-actions.pod:731
6822 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6827 #: ../src/guestfs-actions.pod:740
6828 msgid "guestfs_blockdev_getsz"
6832 #: ../src/guestfs-actions.pod:742
6836 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6837 " const char *device);\n"
6842 #: ../src/guestfs-actions.pod:746 ../fish/guestfish-actions.pod:496
6844 "This returns the size of the device in units of 512-byte sectors (even if "
6845 "the sectorsize isn't 512 bytes ... weird)."
6849 #: ../src/guestfs-actions.pod:749
6851 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6852 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6856 #: ../src/guestfs-actions.pod:759
6857 msgid "guestfs_blockdev_rereadpt"
6861 #: ../src/guestfs-actions.pod:761
6865 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6866 " const char *device);\n"
6871 #: ../src/guestfs-actions.pod:765 ../fish/guestfish-actions.pod:509
6872 msgid "Reread the partition table on C<device>."
6876 #: ../src/guestfs-actions.pod:773
6877 msgid "guestfs_blockdev_setbsz"
6881 #: ../src/guestfs-actions.pod:775
6885 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6886 " const char *device,\n"
6887 " int blocksize);\n"
6892 #: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:517
6893 msgid "This sets the block size of a device."
6897 #: ../src/guestfs-actions.pod:791
6898 msgid "guestfs_blockdev_setro"
6902 #: ../src/guestfs-actions.pod:793
6906 " guestfs_blockdev_setro (guestfs_h *g,\n"
6907 " const char *device);\n"
6912 #: ../src/guestfs-actions.pod:797 ../fish/guestfish-actions.pod:528
6913 msgid "Sets the block device named C<device> to read-only."
6917 #: ../src/guestfs-actions.pod:805
6918 msgid "guestfs_blockdev_setrw"
6922 #: ../src/guestfs-actions.pod:807
6926 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6927 " const char *device);\n"
6932 #: ../src/guestfs-actions.pod:811 ../fish/guestfish-actions.pod:536
6933 msgid "Sets the block device named C<device> to read-write."
6937 #: ../src/guestfs-actions.pod:819
6938 msgid "guestfs_case_sensitive_path"
6942 #: ../src/guestfs-actions.pod:821
6946 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6947 " const char *path);\n"
6952 #: ../src/guestfs-actions.pod:825 ../fish/guestfish-actions.pod:544
6954 "This can be used to resolve case insensitive paths on a filesystem which is "
6955 "case sensitive. The use case is to resolve paths which you have read from "
6956 "Windows configuration files or the Windows Registry, to the true path."
6960 #: ../src/guestfs-actions.pod:830 ../fish/guestfish-actions.pod:549
6962 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6963 "(and probably others), which is that although the underlying filesystem is "
6964 "case-insensitive, the driver exports the filesystem to Linux as "
6969 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:554
6971 "One consequence of this is that special directories such as C<c:\\windows> "
6972 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6973 "precise details of how they were created. In Windows itself this would not "
6978 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:560
6980 "Bug or feature? You decide: "
6981 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6985 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:563
6987 "This function resolves the true case of each element in the path and returns "
6988 "the case-sensitive path."
6992 #: ../src/guestfs-actions.pod:847
6994 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
6995 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6996 "how the directories were originally created under Windows)."
7000 #: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:571
7001 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7005 #: ../src/guestfs-actions.pod:855
7006 msgid "See also C<guestfs_realpath>."
7010 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:6877
7011 msgid "(Added in 1.0.75)"
7015 #: ../src/guestfs-actions.pod:862
7020 #: ../src/guestfs-actions.pod:864
7024 " guestfs_cat (guestfs_h *g,\n"
7025 " const char *path);\n"
7030 #: ../src/guestfs-actions.pod:868 ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:3597
7031 msgid "Return the contents of the file named C<path>."
7035 #: ../src/guestfs-actions.pod:870
7037 "Note that this function cannot correctly handle binary files (specifically, "
7038 "files containing C<\\0> character which is treated as end of string). For "
7039 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7040 "functions which have a more complex interface."
7044 #: ../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:5155 ../src/guestfs-actions.pod:5181 ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5338 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:6262 ../src/guestfs-actions.pod:6317 ../src/guestfs-actions.pod:6463 ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:7149 ../src/guestfs-actions.pod:7175 ../src/guestfs-actions.pod:7201 ../src/guestfs-actions.pod:7220 ../src/guestfs-actions.pod:7305 ../src/guestfs-actions.pod:7324 ../src/guestfs-actions.pod:7370 ../src/guestfs-actions.pod:7389 ../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:3467 ../fish/guestfish-actions.pod:3482 ../fish/guestfish-actions.pod:3558 ../fish/guestfish-actions.pod:3575 ../fish/guestfish-actions.pod:3590 ../fish/guestfish-actions.pod:4216 ../fish/guestfish-actions.pod:4262 ../fish/guestfish-actions.pod:4347 ../fish/guestfish-actions.pod:4362 ../fish/guestfish-actions.pod:4772 ../fish/guestfish-actions.pod:4790 ../fish/guestfish-actions.pod:4807 ../fish/guestfish-actions.pod:4817 ../fish/guestfish-actions.pod:4865 ../fish/guestfish-actions.pod:4875 ../fish/guestfish-actions.pod:4904 ../fish/guestfish-actions.pod:4914
7046 "Because of the message protocol, there is a transfer limit of somewhere "
7047 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7051 #: ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3638 ../src/guestfs-actions.pod:4043 ../src/guestfs-actions.pod:4057 ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:7036 ../src/guestfs-actions.pod:7050
7052 msgid "(Added in 0.4)"
7056 #: ../src/guestfs-actions.pod:883
7057 msgid "guestfs_checksum"
7061 #: ../src/guestfs-actions.pod:885
7065 " guestfs_checksum (guestfs_h *g,\n"
7066 " const char *csumtype,\n"
7067 " const char *path);\n"
7072 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:594
7073 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7077 #: ../src/guestfs-actions.pod:893 ../fish/guestfish-actions.pod:597
7079 "The type of checksum to compute is given by the C<csumtype> parameter which "
7080 "must have one of the following values:"
7084 #: ../src/guestfs-actions.pod:898 ../fish/guestfish-actions.pod:602
7089 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:604
7091 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7096 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:607
7101 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:609
7102 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7106 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:611
7111 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:613
7112 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7116 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:615
7121 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:617
7122 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7126 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:619
7131 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:621
7132 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7136 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:623
7141 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:625
7142 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7146 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:627
7151 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:629
7152 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7156 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:633
7157 msgid "The checksum is returned as a printable string."
7161 #: ../src/guestfs-actions.pod:931
7162 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7166 #: ../src/guestfs-actions.pod:933
7167 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7171 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:1246 ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:3215 ../src/guestfs-actions.pod:3244 ../src/guestfs-actions.pod:3305 ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:6733
7172 msgid "(Added in 1.0.2)"
7176 #: ../src/guestfs-actions.pod:940
7177 msgid "guestfs_checksum_device"
7181 #: ../src/guestfs-actions.pod:942
7185 " guestfs_checksum_device (guestfs_h *g,\n"
7186 " const char *csumtype,\n"
7187 " const char *device);\n"
7192 #: ../src/guestfs-actions.pod:947
7194 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7195 "device named C<device>. For the types of checksums supported see the "
7196 "C<guestfs_checksum> command."
7200 #: ../src/guestfs-actions.pod:954 ../src/guestfs-actions.pod:4792 ../src/guestfs-actions.pod:4851 ../src/guestfs-actions.pod:4888 ../src/guestfs-actions.pod:4906 ../src/guestfs-actions.pod:5082 ../src/guestfs-actions.pod:6642 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:7062
7201 msgid "(Added in 1.3.2)"
7205 #: ../src/guestfs-actions.pod:956
7206 msgid "guestfs_checksums_out"
7210 #: ../src/guestfs-actions.pod:958
7214 " guestfs_checksums_out (guestfs_h *g,\n"
7215 " const char *csumtype,\n"
7216 " const char *directory,\n"
7217 " const char *sumsfile);\n"
7222 #: ../src/guestfs-actions.pod:964 ../fish/guestfish-actions.pod:651
7224 "This command computes the checksums of all regular files in C<directory> and "
7225 "then emits a list of those checksums to the local output file C<sumsfile>."
7229 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:655
7231 "This can be used for verifying the integrity of a virtual machine. However "
7232 "to be properly secure you should pay attention to the output of the checksum "
7233 "command (it uses the ones from GNU coreutils). In particular when the "
7234 "filename is not printable, coreutils uses a special backslash syntax. For "
7235 "more information, see the GNU coreutils info file."
7239 #: ../src/guestfs-actions.pod:978
7240 msgid "(Added in 1.3.7)"
7244 #: ../src/guestfs-actions.pod:980
7245 msgid "guestfs_chmod"
7249 #: ../src/guestfs-actions.pod:982
7253 " guestfs_chmod (guestfs_h *g,\n"
7255 " const char *path);\n"
7260 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:669
7262 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7267 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:672
7269 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7270 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7275 #: ../src/guestfs-actions.pod:994 ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4510 ../src/guestfs-actions.pod:4529 ../fish/guestfish-actions.pod:676 ../fish/guestfish-actions.pod:2913 ../fish/guestfish-actions.pod:3042 ../fish/guestfish-actions.pod:3052 ../fish/guestfish-actions.pod:3062
7276 msgid "The mode actually set is affected by the umask."
7280 #: ../src/guestfs-actions.pod:1000
7281 msgid "guestfs_chown"
7285 #: ../src/guestfs-actions.pod:1002
7289 " guestfs_chown (guestfs_h *g,\n"
7292 " const char *path);\n"
7297 #: ../src/guestfs-actions.pod:1008 ../fish/guestfish-actions.pod:682
7298 msgid "Change the file owner to C<owner> and group to C<group>."
7302 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:3402 ../fish/guestfish-actions.pod:684 ../fish/guestfish-actions.pod:2371
7304 "Only numeric uid and gid are supported. If you want to use names, you will "
7305 "need to locate and parse the password file yourself (Augeas support makes "
7306 "this relatively easy)."
7310 #: ../src/guestfs-actions.pod:1018
7311 msgid "guestfs_command"
7315 #: ../src/guestfs-actions.pod:1020
7319 " guestfs_command (guestfs_h *g,\n"
7320 " char *const *arguments);\n"
7325 #: ../src/guestfs-actions.pod:1024 ../fish/guestfish-actions.pod:692
7327 "This call runs a command from the guest filesystem. The filesystem must be "
7328 "mounted, and must contain a compatible operating system (ie. something "
7329 "Linux, with the same or compatible processor architecture)."
7333 #: ../src/guestfs-actions.pod:1029
7335 "The single parameter is an argv-style list of arguments. The first element "
7336 "is the name of the program to run. Subsequent elements are parameters. The "
7337 "list must be non-empty (ie. must contain a program name). Note that the "
7338 "command runs directly, and is I<not> invoked via the shell (see "
7343 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:704
7344 msgid "The return value is anything printed to I<stdout> by the command."
7348 #: ../src/guestfs-actions.pod:1039 ../fish/guestfish-actions.pod:707
7350 "If the command returns a non-zero exit status, then this function returns an "
7351 "error message. The error message string is the content of I<stderr> from "
7356 #: ../src/guestfs-actions.pod:1043 ../fish/guestfish-actions.pod:711
7358 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7359 "C</bin>. If you require a program from another location, you should provide "
7360 "the full path in the first parameter."
7364 #: ../src/guestfs-actions.pod:1048 ../fish/guestfish-actions.pod:716
7366 "Shared libraries and data files required by the program must be available on "
7367 "filesystems which are mounted in the correct places. It is the caller's "
7368 "responsibility to ensure all filesystems that are needed are mounted at the "
7373 #: ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:1543
7374 msgid "(Added in 0.9.1)"
7378 #: ../src/guestfs-actions.pod:1062
7379 msgid "guestfs_command_lines"
7383 #: ../src/guestfs-actions.pod:1064
7387 " guestfs_command_lines (guestfs_h *g,\n"
7388 " char *const *arguments);\n"
7393 #: ../src/guestfs-actions.pod:1068
7395 "This is the same as C<guestfs_command>, but splits the result into a list of "
7400 #: ../src/guestfs-actions.pod:1071
7401 msgid "See also: C<guestfs_sh_lines>"
7405 #: ../src/guestfs-actions.pod:1082
7406 msgid "guestfs_config"
7410 #: ../src/guestfs-actions.pod:1084
7414 " guestfs_config (guestfs_h *g,\n"
7415 " const char *qemuparam,\n"
7416 " const char *qemuvalue);\n"
7421 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:741
7423 "This can be used to add arbitrary qemu command line parameters of the form "
7424 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
7425 "setting some parameters which would interfere with parameters that we use."
7429 #: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:746
7430 msgid "The first character of C<param> string must be a C<-> (dash)."
7434 #: ../src/guestfs-actions.pod:1096 ../fish/guestfish-actions.pod:748
7435 msgid "C<value> can be NULL."
7439 #: ../src/guestfs-actions.pod:1102
7440 msgid "guestfs_copy_size"
7444 #: ../src/guestfs-actions.pod:1104
7448 " guestfs_copy_size (guestfs_h *g,\n"
7449 " const char *src,\n"
7450 " const char *dest,\n"
7456 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:754
7458 "This command copies exactly C<size> bytes from one source device or file "
7459 "C<src> to another destination device or file C<dest>."
7463 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:757
7465 "Note this will fail if the source is too short or if the destination is not "
7470 #: ../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:6728 ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:7241 ../src/guestfs-actions.pod:7260
7472 "This long-running command can generate progress notification messages so "
7473 "that the caller can display a progress bar or indicator. To receive these "
7474 "messages, the caller must register a progress callback. See "
7475 "L<guestfs(3)/guestfs_set_progress_callback>."
7479 #: ../src/guestfs-actions.pod:1123 ../src/guestfs-actions.pod:4070 ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6989 ../src/guestfs-actions.pod:7075
7480 msgid "(Added in 1.0.87)"
7484 #: ../src/guestfs-actions.pod:1125
7489 #: ../src/guestfs-actions.pod:1127
7493 " guestfs_cp (guestfs_h *g,\n"
7494 " const char *src,\n"
7495 " const char *dest);\n"
7500 #: ../src/guestfs-actions.pod:1132 ../fish/guestfish-actions.pod:764
7502 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7503 "destination filename or destination directory."
7507 #: ../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:4755 ../src/guestfs-actions.pod:5132
7508 msgid "(Added in 1.0.18)"
7512 #: ../src/guestfs-actions.pod:1139
7513 msgid "guestfs_cp_a"
7517 #: ../src/guestfs-actions.pod:1141
7521 " guestfs_cp_a (guestfs_h *g,\n"
7522 " const char *src,\n"
7523 " const char *dest);\n"
7528 #: ../src/guestfs-actions.pod:1146 ../fish/guestfish-actions.pod:771
7530 "This copies a file or directory from C<src> to C<dest> recursively using the "
7535 #: ../src/guestfs-actions.pod:1153
7540 #: ../src/guestfs-actions.pod:1155
7544 " guestfs_dd (guestfs_h *g,\n"
7545 " const char *src,\n"
7546 " const char *dest);\n"
7551 #: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:778
7553 "This command copies from one source device or file C<src> to another "
7554 "destination device or file C<dest>. Normally you would use this to copy to "
7555 "or from a device or partition, for example to duplicate a filesystem."
7559 #: ../src/guestfs-actions.pod:1165
7561 "If the destination is a device, it must be as large or larger than the "
7562 "source file or device, otherwise the copy will fail. This command cannot do "
7563 "partial copies (see C<guestfs_copy_size>)."
7567 #: ../src/guestfs-actions.pod:1173
7572 #: ../src/guestfs-actions.pod:1175
7576 " guestfs_df (guestfs_h *g);\n"
7581 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:791
7582 msgid "This command runs the C<df> command to report disk space used."
7586 #: ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1197
7588 "This command is mostly useful for interactive sessions. It is I<not> "
7589 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7594 #: ../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:4180 ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:6466 ../src/guestfs-actions.pod:6490 ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7121 ../src/guestfs-actions.pod:7134
7595 msgid "(Added in 1.0.54)"
7599 #: ../src/guestfs-actions.pod:1189
7600 msgid "guestfs_df_h"
7604 #: ../src/guestfs-actions.pod:1191
7608 " guestfs_df_h (guestfs_h *g);\n"
7613 #: ../src/guestfs-actions.pod:1194 ../fish/guestfish-actions.pod:801
7615 "This command runs the C<df -h> command to report disk space used in "
7616 "human-readable format."
7620 #: ../src/guestfs-actions.pod:1206
7621 msgid "guestfs_dmesg"
7625 #: ../src/guestfs-actions.pod:1208
7629 " guestfs_dmesg (guestfs_h *g);\n"
7634 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:812
7636 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7637 "This is sometimes useful for extended debugging of problems."
7641 #: ../src/guestfs-actions.pod:1215
7643 "Another way to get the same information is to enable verbose messages with "
7644 "C<guestfs_set_verbose> or by setting the environment variable "
7645 "C<LIBGUESTFS_DEBUG=1> before running the program."
7649 #: ../src/guestfs-actions.pod:1225
7650 msgid "guestfs_download"
7654 #: ../src/guestfs-actions.pod:1227
7658 " guestfs_download (guestfs_h *g,\n"
7659 " const char *remotefilename,\n"
7660 " const char *filename);\n"
7665 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:838
7667 "Download file C<remotefilename> and save it as C<filename> on the local "
7672 #: ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:4520
7673 msgid "C<filename> can also be a named pipe."
7677 #: ../src/guestfs-actions.pod:1237
7678 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7682 #: ../src/guestfs-actions.pod:1248
7683 msgid "guestfs_download_offset"
7687 #: ../src/guestfs-actions.pod:1250
7691 " guestfs_download_offset (guestfs_h *g,\n"
7692 " const char *remotefilename,\n"
7693 " const char *filename,\n"
7694 " int64_t offset,\n"
7700 #: ../src/guestfs-actions.pod:1260 ../fish/guestfish-actions.pod:841
7702 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7703 "region must be within the file or device)."
7707 #: ../src/guestfs-actions.pod:1263
7709 "Note that there is no limit on the amount of data that can be downloaded "
7710 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7711 "full amount unless an error occurs."
7715 #: ../src/guestfs-actions.pod:1268
7716 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7720 #: ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:6767
7721 msgid "(Added in 1.5.17)"
7725 #: ../src/guestfs-actions.pod:1279
7726 msgid "guestfs_drop_caches"
7730 #: ../src/guestfs-actions.pod:1281
7734 " guestfs_drop_caches (guestfs_h *g,\n"
7735 " int whattodrop);\n"
7740 #: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:857
7742 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7743 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7744 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7748 #: ../src/guestfs-actions.pod:1290 ../fish/guestfish-actions.pod:862
7749 msgid "Setting C<whattodrop> to 3 should drop everything."
7753 #: ../src/guestfs-actions.pod:1292 ../fish/guestfish-actions.pod:864
7755 "This automatically calls L<sync(2)> before the operation, so that the "
7756 "maximum guest memory is freed."
7760 #: ../src/guestfs-actions.pod:1299
7765 #: ../src/guestfs-actions.pod:1301
7769 " guestfs_du (guestfs_h *g,\n"
7770 " const char *path);\n"
7775 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:871
7777 "This command runs the C<du -s> command to estimate file space usage for "
7782 #: ../src/guestfs-actions.pod:1308 ../fish/guestfish-actions.pod:874
7784 "C<path> can be a file or a directory. If C<path> is a directory then the "
7785 "estimate includes the contents of the directory and all subdirectories "
7790 #: ../src/guestfs-actions.pod:1312 ../fish/guestfish-actions.pod:878
7791 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7795 #: ../src/guestfs-actions.pod:1319
7796 msgid "guestfs_e2fsck_f"
7800 #: ../src/guestfs-actions.pod:1321
7804 " guestfs_e2fsck_f (guestfs_h *g,\n"
7805 " const char *device);\n"
7810 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:885
7812 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7813 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7818 #: ../src/guestfs-actions.pod:1329
7820 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7821 "Normally you should use C<guestfs_fsck>."
7825 #: ../src/guestfs-actions.pod:1334
7826 msgid "(Added in 1.0.29)"
7830 #: ../src/guestfs-actions.pod:1336
7831 msgid "guestfs_echo_daemon"
7835 #: ../src/guestfs-actions.pod:1338
7839 " guestfs_echo_daemon (guestfs_h *g,\n"
7840 " char *const *words);\n"
7845 #: ../src/guestfs-actions.pod:1342 ../fish/guestfish-actions.pod:896
7847 "This command concatenates the list of C<words> passed with single spaces "
7848 "between them and returns the resulting string."
7852 #: ../src/guestfs-actions.pod:1345 ../fish/guestfish-actions.pod:899
7853 msgid "You can use this command to test the connection through to the daemon."
7857 #: ../src/guestfs-actions.pod:1347
7858 msgid "See also C<guestfs_ping_daemon>."
7862 #: ../src/guestfs-actions.pod:1352 ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:5966
7863 msgid "(Added in 1.0.69)"
7867 #: ../src/guestfs-actions.pod:1354
7868 msgid "guestfs_egrep"
7872 #: ../src/guestfs-actions.pod:1356
7876 " guestfs_egrep (guestfs_h *g,\n"
7877 " const char *regex,\n"
7878 " const char *path);\n"
7883 #: ../src/guestfs-actions.pod:1361 ../fish/guestfish-actions.pod:907
7884 msgid "This calls the external C<egrep> program and returns the matching lines."
7888 #: ../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:3563 ../src/guestfs-actions.pod:3577 ../src/guestfs-actions.pod:3590 ../src/guestfs-actions.pod:3604 ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5515 ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6359 ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6394 ../src/guestfs-actions.pod:6407 ../src/guestfs-actions.pod:6420 ../src/guestfs-actions.pod:6433 ../src/guestfs-actions.pod:7204 ../src/guestfs-actions.pod:7223 ../src/guestfs-actions.pod:7308 ../src/guestfs-actions.pod:7327 ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7392
7889 msgid "(Added in 1.0.66)"
7893 #: ../src/guestfs-actions.pod:1373
7894 msgid "guestfs_egrepi"
7898 #: ../src/guestfs-actions.pod:1375
7902 " guestfs_egrepi (guestfs_h *g,\n"
7903 " const char *regex,\n"
7904 " const char *path);\n"
7909 #: ../src/guestfs-actions.pod:1380 ../fish/guestfish-actions.pod:917
7910 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7914 #: ../src/guestfs-actions.pod:1392
7915 msgid "guestfs_equal"
7919 #: ../src/guestfs-actions.pod:1394
7923 " guestfs_equal (guestfs_h *g,\n"
7924 " const char *file1,\n"
7925 " const char *file2);\n"
7930 #: ../src/guestfs-actions.pod:1399 ../fish/guestfish-actions.pod:927
7932 "This compares the two files C<file1> and C<file2> and returns true if their "
7933 "content is exactly equal, or false otherwise."
7937 #: ../src/guestfs-actions.pod:1402 ../fish/guestfish-actions.pod:930
7938 msgid "The external L<cmp(1)> program is used for the comparison."
7942 #: ../src/guestfs-actions.pod:1408
7943 msgid "guestfs_exists"
7947 #: ../src/guestfs-actions.pod:1410
7951 " guestfs_exists (guestfs_h *g,\n"
7952 " const char *path);\n"
7957 #: ../src/guestfs-actions.pod:1414 ../fish/guestfish-actions.pod:936
7959 "This returns C<true> if and only if there is a file, directory (or anything) "
7960 "with the given C<path> name."
7964 #: ../src/guestfs-actions.pod:1417
7965 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7969 #: ../src/guestfs-actions.pod:1423
7970 msgid "guestfs_fallocate"
7974 #: ../src/guestfs-actions.pod:1425
7978 " guestfs_fallocate (guestfs_h *g,\n"
7979 " const char *path,\n"
7985 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1456 ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:964
7987 "This command preallocates a file (containing zero bytes) named C<path> of "
7988 "size C<len> bytes. If the file exists already, it is overwritten."
7992 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:949
7994 "Do not confuse this with the guestfish-specific C<alloc> command which "
7995 "allocates a file in the host and attaches it as a device."
7999 #: ../src/guestfs-actions.pod:1440 ../fish/guestfish-actions.pod:953
8001 "This function is deprecated. In new code, use the C<fallocate64> call "
8006 #: ../src/guestfs-actions.pod:1449
8007 msgid "guestfs_fallocate64"
8011 #: ../src/guestfs-actions.pod:1451
8015 " guestfs_fallocate64 (guestfs_h *g,\n"
8016 " const char *path,\n"
8022 #: ../src/guestfs-actions.pod:1460
8024 "Note that this call allocates disk blocks for the file. To create a sparse "
8025 "file use C<guestfs_truncate_size> instead."
8029 #: ../src/guestfs-actions.pod:1463
8031 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8032 "oversight it only allowed 30 bit lengths to be specified, effectively "
8033 "limiting the maximum size of files created through that call to 1GB."
8037 #: ../src/guestfs-actions.pod:1468 ../fish/guestfish-actions.pod:976
8039 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8040 "commands which create a file in the host and attach it as a device."
8044 #: ../src/guestfs-actions.pod:1474
8045 msgid "(Added in 1.3.17)"
8049 #: ../src/guestfs-actions.pod:1476
8050 msgid "guestfs_fgrep"
8054 #: ../src/guestfs-actions.pod:1478
8058 " guestfs_fgrep (guestfs_h *g,\n"
8059 " const char *pattern,\n"
8060 " const char *path);\n"
8065 #: ../src/guestfs-actions.pod:1483 ../fish/guestfish-actions.pod:984
8066 msgid "This calls the external C<fgrep> program and returns the matching lines."
8070 #: ../src/guestfs-actions.pod:1495
8071 msgid "guestfs_fgrepi"
8075 #: ../src/guestfs-actions.pod:1497
8079 " guestfs_fgrepi (guestfs_h *g,\n"
8080 " const char *pattern,\n"
8081 " const char *path);\n"
8086 #: ../src/guestfs-actions.pod:1502 ../fish/guestfish-actions.pod:994
8087 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8091 #: ../src/guestfs-actions.pod:1514
8092 msgid "guestfs_file"
8096 #: ../src/guestfs-actions.pod:1516
8100 " guestfs_file (guestfs_h *g,\n"
8101 " const char *path);\n"
8106 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1004
8108 "This call uses the standard L<file(1)> command to determine the type or "
8109 "contents of the file."
8113 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1007
8115 "This call will also transparently look inside various types of compressed "
8120 #: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1010
8122 "The exact command which runs is C<file -zb path>. Note in particular that "
8123 "the filename is not prepended to the output (the C<-b> option)."
8127 #: ../src/guestfs-actions.pod:1530
8129 "This command can also be used on C</dev/> devices (and partitions, LV "
8130 "names). You can for example use this to determine if a device contains a "
8131 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
8135 #: ../src/guestfs-actions.pod:1535 ../fish/guestfish-actions.pod:1019
8137 "If the C<path> does not begin with C</dev/> then this command only works for "
8138 "the content of regular files. For other file types (directory, symbolic "
8139 "link etc) it will just return the string C<directory> etc."
8143 #: ../src/guestfs-actions.pod:1545
8144 msgid "guestfs_file_architecture"
8148 #: ../src/guestfs-actions.pod:1547
8152 " guestfs_file_architecture (guestfs_h *g,\n"
8153 " const char *filename);\n"
8158 #: ../src/guestfs-actions.pod:1551 ../fish/guestfish-actions.pod:1028
8160 "This detects the architecture of the binary C<filename>, and returns it if "
8165 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1031
8166 msgid "Currently defined architectures are:"
8170 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1035
8175 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1037
8177 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8178 "irrespective of the precise processor requirements of the binary."
8182 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1040
8187 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1042
8188 msgid "64 bit x86-64."
8192 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1044
8197 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1046
8198 msgid "32 bit SPARC."
8202 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1048
8207 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1050
8208 msgid "64 bit SPARC V9 and above."
8212 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1052
8217 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1054
8218 msgid "Intel Itanium."
8222 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1056
8227 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1058
8228 msgid "32 bit Power PC."
8232 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1060
8237 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1062
8238 msgid "64 bit Power PC."
8242 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1066
8243 msgid "Libguestfs may return other architecture strings in future."
8247 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1068
8248 msgid "The function works on at least the following types of files:"
8252 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1074
8253 msgid "many types of Un*x and Linux binary"
8257 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1078
8258 msgid "many types of Un*x and Linux shared library"
8262 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1082
8263 msgid "Windows Win32 and Win64 binaries"
8267 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1086
8268 msgid "Windows Win32 and Win64 DLLs"
8272 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1088
8273 msgid "Win32 binaries and DLLs return C<i386>."
8277 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1090
8278 msgid "Win64 binaries and DLLs return C<x86_64>."
8282 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1094
8283 msgid "Linux kernel modules"
8287 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1098
8288 msgid "Linux new-style initrd images"
8292 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1102
8293 msgid "some non-x86 Linux vmlinuz kernels"
8297 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1106
8298 msgid "What it can't do currently:"
8302 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1112
8303 msgid "static libraries (libfoo.a)"
8307 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1116
8308 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8312 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1120
8313 msgid "x86 Linux vmlinuz kernels"
8317 #: ../src/guestfs-actions.pod:1645 ../fish/guestfish-actions.pod:1122
8319 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8320 "compressed code, and are horribly hard to unpack. If you want to find the "
8321 "architecture of a kernel, use the architecture of the associated initrd or "
8322 "kernel module(s) instead."
8326 #: ../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:2960 ../src/guestfs-actions.pod:3186 ../src/guestfs-actions.pod:3318
8327 msgid "(Added in 1.5.3)"
8331 #: ../src/guestfs-actions.pod:1657
8332 msgid "guestfs_filesize"
8336 #: ../src/guestfs-actions.pod:1659
8340 " guestfs_filesize (guestfs_h *g,\n"
8341 " const char *file);\n"
8346 #: ../src/guestfs-actions.pod:1663 ../fish/guestfish-actions.pod:1133
8347 msgid "This command returns the size of C<file> in bytes."
8351 #: ../src/guestfs-actions.pod:1665
8353 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8354 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8355 "devices, use C<guestfs_blockdev_getsize64>."
8359 #: ../src/guestfs-actions.pod:1671
8360 msgid "(Added in 1.0.82)"
8364 #: ../src/guestfs-actions.pod:1673
8365 msgid "guestfs_fill"
8369 #: ../src/guestfs-actions.pod:1675
8373 " guestfs_fill (guestfs_h *g,\n"
8376 " const char *path);\n"
8381 #: ../src/guestfs-actions.pod:1681 ../fish/guestfish-actions.pod:1143
8383 "This command creates a new file called C<path>. The initial content of the "
8384 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8389 #: ../src/guestfs-actions.pod:1685
8391 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8392 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8393 "bytes use C<guestfs_fill_pattern>."
8397 #: ../src/guestfs-actions.pod:1697
8398 msgid "(Added in 1.0.79)"
8402 #: ../src/guestfs-actions.pod:1699
8403 msgid "guestfs_fill_pattern"
8407 #: ../src/guestfs-actions.pod:1701
8411 " guestfs_fill_pattern (guestfs_h *g,\n"
8412 " const char *pattern,\n"
8414 " const char *path);\n"
8419 #: ../src/guestfs-actions.pod:1707
8421 "This function is like C<guestfs_fill> except that it creates a new file of "
8422 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8423 "pattern is truncated if necessary to ensure the length of the file is "
8424 "exactly C<len> bytes."
8428 #: ../src/guestfs-actions.pod:1719
8429 msgid "(Added in 1.3.12)"
8433 #: ../src/guestfs-actions.pod:1721
8434 msgid "guestfs_find"
8438 #: ../src/guestfs-actions.pod:1723
8442 " guestfs_find (guestfs_h *g,\n"
8443 " const char *directory);\n"
8448 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1165
8450 "This command lists out all files and directories, recursively, starting at "
8451 "C<directory>. It is essentially equivalent to running the shell command "
8452 "C<find directory -print> but some post-processing happens on the output, "
8457 #: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1170
8459 "This returns a list of strings I<without any prefix>. Thus if the directory "
8464 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1173
8474 #: ../src/guestfs-actions.pod:1739
8475 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8479 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1180
8490 #: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1185
8491 msgid "If C<directory> is not a directory, then this command returns an error."
8495 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1188
8496 msgid "The returned list is sorted."
8500 #: ../src/guestfs-actions.pod:1752
8501 msgid "See also C<guestfs_find0>."
8505 #: ../src/guestfs-actions.pod:1761 ../src/guestfs-actions.pod:4007 ../src/guestfs-actions.pod:5550
8506 msgid "(Added in 1.0.27)"
8510 #: ../src/guestfs-actions.pod:1763
8511 msgid "guestfs_find0"
8515 #: ../src/guestfs-actions.pod:1765
8519 " guestfs_find0 (guestfs_h *g,\n"
8520 " const char *directory,\n"
8521 " const char *files);\n"
8526 #: ../src/guestfs-actions.pod:1770 ../fish/guestfish-actions.pod:1199
8528 "This command lists out all files and directories, recursively, starting at "
8529 "C<directory>, placing the resulting list in the external file called "
8534 #: ../src/guestfs-actions.pod:1774
8536 "This command works the same way as C<guestfs_find> with the following "
8541 #: ../src/guestfs-actions.pod:1781 ../fish/guestfish-actions.pod:1210
8542 msgid "The resulting list is written to an external file."
8546 #: ../src/guestfs-actions.pod:1785 ../fish/guestfish-actions.pod:1214
8548 "Items (filenames) in the result are separated by C<\\0> characters. See "
8549 "L<find(1)> option I<-print0>."
8553 #: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1219
8554 msgid "This command is not limited in the number of names that it can return."
8558 #: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1224
8559 msgid "The result list is not sorted."
8563 #: ../src/guestfs-actions.pod:1801
8564 msgid "(Added in 1.0.74)"
8568 #: ../src/guestfs-actions.pod:1803
8569 msgid "guestfs_findfs_label"
8573 #: ../src/guestfs-actions.pod:1805
8577 " guestfs_findfs_label (guestfs_h *g,\n"
8578 " const char *label);\n"
8583 #: ../src/guestfs-actions.pod:1809 ../fish/guestfish-actions.pod:1234
8585 "This command searches the filesystems and returns the one which has the "
8586 "given label. An error is returned if no such filesystem can be found."
8590 #: ../src/guestfs-actions.pod:1813
8591 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8595 #: ../src/guestfs-actions.pod:1820
8596 msgid "guestfs_findfs_uuid"
8600 #: ../src/guestfs-actions.pod:1822
8604 " guestfs_findfs_uuid (guestfs_h *g,\n"
8605 " const char *uuid);\n"
8610 #: ../src/guestfs-actions.pod:1826 ../fish/guestfish-actions.pod:1244
8612 "This command searches the filesystems and returns the one which has the "
8613 "given UUID. An error is returned if no such filesystem can be found."
8617 #: ../src/guestfs-actions.pod:1830
8618 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8622 #: ../src/guestfs-actions.pod:1837
8623 msgid "guestfs_fsck"
8627 #: ../src/guestfs-actions.pod:1839
8631 " guestfs_fsck (guestfs_h *g,\n"
8632 " const char *fstype,\n"
8633 " const char *device);\n"
8638 #: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:1254
8640 "This runs the filesystem checker (fsck) on C<device> which should have "
8641 "filesystem type C<fstype>."
8645 #: ../src/guestfs-actions.pod:1847 ../fish/guestfish-actions.pod:1257
8647 "The returned integer is the status. See L<fsck(8)> for the list of status "
8648 "codes from C<fsck>."
8652 #: ../src/guestfs-actions.pod:1856 ../fish/guestfish-actions.pod:1266
8653 msgid "Multiple status codes can be summed together."
8657 #: ../src/guestfs-actions.pod:1860 ../fish/guestfish-actions.pod:1270
8659 "A non-zero return code can mean \"success\", for example if errors have been "
8660 "corrected on the filesystem."
8664 #: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1275
8665 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8669 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1280
8670 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8674 #: ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:7246
8675 msgid "(Added in 1.0.16)"
8679 #: ../src/guestfs-actions.pod:1876
8680 msgid "guestfs_get_append"
8684 #: ../src/guestfs-actions.pod:1878
8688 " guestfs_get_append (guestfs_h *g);\n"
8693 #: ../src/guestfs-actions.pod:1881 ../fish/guestfish-actions.pod:1286
8695 "Return the additional kernel options which are added to the guest kernel "
8700 #: ../src/guestfs-actions.pod:1884 ../fish/guestfish-actions.pod:1289
8701 msgid "If C<NULL> then no options are added."
8705 #: ../src/guestfs-actions.pod:1886
8707 "This function returns a string which may be NULL. There is no way to return "
8708 "an error from this function. The string is owned by the guest handle and "
8709 "must I<not> be freed."
8713 #: ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:5228 ../src/guestfs-actions.pod:5708 ../src/guestfs-actions.pod:6108 ../src/guestfs-actions.pod:6127 ../src/guestfs-actions.pod:6143 ../src/guestfs-actions.pod:6160 ../src/guestfs-actions.pod:6917 ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:7289
8714 msgid "(Added in 1.0.26)"
8718 #: ../src/guestfs-actions.pod:1892
8719 msgid "guestfs_get_attach_method"
8723 #: ../src/guestfs-actions.pod:1894
8727 " guestfs_get_attach_method (guestfs_h *g);\n"
8732 #: ../src/guestfs-actions.pod:1897
8733 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8737 #: ../src/guestfs-actions.pod:1902
8738 msgid "guestfs_get_autosync"
8742 #: ../src/guestfs-actions.pod:1904
8746 " guestfs_get_autosync (guestfs_h *g);\n"
8751 #: ../src/guestfs-actions.pod:1907 ../fish/guestfish-actions.pod:1301
8752 msgid "Get the autosync flag."
8756 #: ../src/guestfs-actions.pod:1913
8757 msgid "guestfs_get_direct"
8761 #: ../src/guestfs-actions.pod:1915
8765 " guestfs_get_direct (guestfs_h *g);\n"
8770 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1307
8771 msgid "Return the direct appliance mode flag."
8775 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:5777
8776 msgid "(Added in 1.0.72)"
8780 #: ../src/guestfs-actions.pod:1924
8781 msgid "guestfs_get_e2label"
8785 #: ../src/guestfs-actions.pod:1926
8789 " guestfs_get_e2label (guestfs_h *g,\n"
8790 " const char *device);\n"
8795 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1313
8796 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8800 #: ../src/guestfs-actions.pod:1936 ../fish/guestfish-actions.pod:1316
8802 "This function is deprecated. In new code, use the C<vfs_label> call "
8807 #: ../src/guestfs-actions.pod:1943 ../src/guestfs-actions.pod:1964 ../src/guestfs-actions.pod:5795 ../src/guestfs-actions.pod:5814
8808 msgid "(Added in 1.0.15)"
8812 #: ../src/guestfs-actions.pod:1945
8813 msgid "guestfs_get_e2uuid"
8817 #: ../src/guestfs-actions.pod:1947
8821 " guestfs_get_e2uuid (guestfs_h *g,\n"
8822 " const char *device);\n"
8827 #: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1327
8828 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8832 #: ../src/guestfs-actions.pod:1957 ../fish/guestfish-actions.pod:1330
8833 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
8837 #: ../src/guestfs-actions.pod:1966
8838 msgid "guestfs_get_memsize"
8842 #: ../src/guestfs-actions.pod:1968
8846 " guestfs_get_memsize (guestfs_h *g);\n"
8851 #: ../src/guestfs-actions.pod:1971 ../fish/guestfish-actions.pod:1341
8852 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8856 #: ../src/guestfs-actions.pod:1974
8858 "If C<guestfs_set_memsize> was not called on this handle, and if "
8859 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8860 "value for memsize."
8864 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:2059 ../src/guestfs-actions.pod:5830 ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399 ../fish/guestfish-actions.pod:3923 ../fish/guestfish-actions.pod:4010
8865 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8869 #: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:4495 ../src/guestfs-actions.pod:4514 ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4545 ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4575 ../src/guestfs-actions.pod:5453 ../src/guestfs-actions.pod:5835 ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6683
8870 msgid "(Added in 1.0.55)"
8874 #: ../src/guestfs-actions.pod:1985
8875 msgid "guestfs_get_network"
8879 #: ../src/guestfs-actions.pod:1987
8883 " guestfs_get_network (guestfs_h *g);\n"
8888 #: ../src/guestfs-actions.pod:1990 ../fish/guestfish-actions.pod:1355
8889 msgid "This returns the enable network flag."
8893 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:5854
8894 msgid "(Added in 1.5.4)"
8898 #: ../src/guestfs-actions.pod:1996
8899 msgid "guestfs_get_path"
8903 #: ../src/guestfs-actions.pod:1998
8907 " guestfs_get_path (guestfs_h *g);\n"
8912 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1361
8913 msgid "Return the current search path."
8917 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1363
8919 "This is always non-NULL. If it wasn't set already, then this will return "
8924 #: ../src/guestfs-actions.pod:2006 ../src/guestfs-actions.pod:2035
8926 "This function returns a string, or NULL on error. The string is owned by "
8927 "the guest handle and must I<not> be freed."
8931 #: ../src/guestfs-actions.pod:2011
8932 msgid "guestfs_get_pid"
8936 #: ../src/guestfs-actions.pod:2013
8940 " guestfs_get_pid (guestfs_h *g);\n"
8945 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
8947 "Return the process ID of the qemu subprocess. If there is no qemu "
8948 "subprocess, then this will return an error."
8952 #: ../src/guestfs-actions.pod:2019 ../fish/guestfish-actions.pod:1375
8953 msgid "This is an internal call used for debugging and testing."
8957 #: ../src/guestfs-actions.pod:2023
8958 msgid "(Added in 1.0.56)"
8962 #: ../src/guestfs-actions.pod:2025
8963 msgid "guestfs_get_qemu"
8967 #: ../src/guestfs-actions.pod:2027
8971 " guestfs_get_qemu (guestfs_h *g);\n"
8976 #: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1381
8977 msgid "Return the current qemu binary."
8981 #: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1383
8983 "This is always non-NULL. If it wasn't set already, then this will return "
8984 "the default qemu binary name."
8988 #: ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:5899
8989 msgid "(Added in 1.0.6)"
8993 #: ../src/guestfs-actions.pod:2040
8994 msgid "guestfs_get_recovery_proc"
8998 #: ../src/guestfs-actions.pod:2042
9002 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9007 #: ../src/guestfs-actions.pod:2045 ../fish/guestfish-actions.pod:1390
9008 msgid "Return the recovery process enabled flag."
9012 #: ../src/guestfs-actions.pod:2049 ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3705 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:4137 ../src/guestfs-actions.pod:5158 ../src/guestfs-actions.pod:5501 ../src/guestfs-actions.pod:5923 ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:6606 ../src/guestfs-actions.pod:6798
9013 msgid "(Added in 1.0.77)"
9017 #: ../src/guestfs-actions.pod:2051
9018 msgid "guestfs_get_selinux"
9022 #: ../src/guestfs-actions.pod:2053
9026 " guestfs_get_selinux (guestfs_h *g);\n"
9031 #: ../src/guestfs-actions.pod:2056
9033 "This returns the current setting of the selinux flag which is passed to the "
9034 "appliance at boot time. See C<guestfs_set_selinux>."
9038 #: ../src/guestfs-actions.pod:2064 ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:5942 ../src/guestfs-actions.pod:6000
9039 msgid "(Added in 1.0.67)"
9043 #: ../src/guestfs-actions.pod:2066
9044 msgid "guestfs_get_state"
9048 #: ../src/guestfs-actions.pod:2068
9052 " guestfs_get_state (guestfs_h *g);\n"
9057 #: ../src/guestfs-actions.pod:2071 ../fish/guestfish-actions.pod:1406
9059 "This returns the current state as an opaque integer. This is only useful "
9060 "for printing debug and internal error messages."
9064 #: ../src/guestfs-actions.pod:2074 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3328 ../fish/guestfish-actions.pod:1409 ../fish/guestfish-actions.pod:2253 ../fish/guestfish-actions.pod:2271 ../fish/guestfish-actions.pod:2309 ../fish/guestfish-actions.pod:2325
9065 msgid "For more information on states, see L<guestfs(3)>."
9069 #: ../src/guestfs-actions.pod:2080
9070 msgid "guestfs_get_trace"
9074 #: ../src/guestfs-actions.pod:2082
9078 " guestfs_get_trace (guestfs_h *g);\n"
9083 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1415
9084 msgid "Return the command trace flag."
9088 #: ../src/guestfs-actions.pod:2091
9089 msgid "guestfs_get_umask"
9093 #: ../src/guestfs-actions.pod:2093
9097 " guestfs_get_umask (guestfs_h *g);\n"
9102 #: ../src/guestfs-actions.pod:2096
9104 "Return the current umask. By default the umask is C<022> unless it has been "
9105 "set by calling C<guestfs_umask>."
9109 #: ../src/guestfs-actions.pod:2103
9110 msgid "guestfs_get_verbose"
9114 #: ../src/guestfs-actions.pod:2105
9118 " guestfs_get_verbose (guestfs_h *g);\n"
9123 #: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1428
9124 msgid "This returns the verbose messages flag."
9128 #: ../src/guestfs-actions.pod:2114
9129 msgid "guestfs_getcon"
9133 #: ../src/guestfs-actions.pod:2116
9137 " guestfs_getcon (guestfs_h *g);\n"
9142 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1434
9143 msgid "This gets the SELinux security context of the daemon."
9147 #: ../src/guestfs-actions.pod:2121
9148 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9152 #: ../src/guestfs-actions.pod:2129
9153 msgid "guestfs_getxattr"
9157 #: ../src/guestfs-actions.pod:2131
9161 " guestfs_getxattr (guestfs_h *g,\n"
9162 " const char *path,\n"
9163 " const char *name,\n"
9164 " size_t *size_r);\n"
9169 #: ../src/guestfs-actions.pod:2137
9171 "Get a single extended attribute from file C<path> named C<name>. This call "
9172 "follows symlinks. If you want to lookup an extended attribute for the "
9173 "symlink itself, use C<guestfs_lgetxattr>."
9177 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3422
9179 "Normally it is better to get all extended attributes from a file in one go "
9180 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9181 "implementations are buggy and do not provide a way to list out attributes. "
9182 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9183 "extended attributes you want in advance and call this function."
9187 #: ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:3429 ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2390
9189 "Extended attribute values are blobs of binary data. If there is no extended "
9190 "attribute named C<name>, this returns an error."
9194 #: ../src/guestfs-actions.pod:2151
9195 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9199 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:5151 ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5358
9201 "This function returns a buffer, or NULL on error. The size of the returned "
9202 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9207 #: ../src/guestfs-actions.pod:2157 ../src/guestfs-actions.pod:3438
9208 msgid "(Added in 1.7.24)"
9212 #: ../src/guestfs-actions.pod:2159
9213 msgid "guestfs_getxattrs"
9217 #: ../src/guestfs-actions.pod:2161
9220 " struct guestfs_xattr_list *\n"
9221 " guestfs_getxattrs (guestfs_h *g,\n"
9222 " const char *path);\n"
9227 #: ../src/guestfs-actions.pod:2165 ../fish/guestfish-actions.pod:1463
9228 msgid "This call lists the extended attributes of the file or directory C<path>."
9232 #: ../src/guestfs-actions.pod:2168 ../fish/guestfish-actions.pod:1466
9234 "At the system call level, this is a combination of the L<listxattr(2)> and "
9235 "L<getxattr(2)> calls."
9239 #: ../src/guestfs-actions.pod:2171
9240 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9244 #: ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:3450 ../src/guestfs-actions.pod:4101
9246 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9247 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9251 #: ../src/guestfs-actions.pod:2177 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3655 ../src/guestfs-actions.pod:5531 ../src/guestfs-actions.pod:6019 ../src/guestfs-actions.pod:7354
9252 msgid "(Added in 1.0.59)"
9256 #: ../src/guestfs-actions.pod:2179
9257 msgid "guestfs_glob_expand"
9261 #: ../src/guestfs-actions.pod:2181
9265 " guestfs_glob_expand (guestfs_h *g,\n"
9266 " const char *pattern);\n"
9271 #: ../src/guestfs-actions.pod:2185 ../fish/guestfish-actions.pod:1475
9273 "This command searches for all the pathnames matching C<pattern> according to "
9274 "the wildcard expansion rules used by the shell."
9278 #: ../src/guestfs-actions.pod:2189 ../fish/guestfish-actions.pod:1479
9279 msgid "If no paths match, then this returns an empty list (note: not an error)."
9283 #: ../src/guestfs-actions.pod:2192 ../fish/guestfish-actions.pod:1482
9285 "It is just a wrapper around the C L<glob(3)> function with flags "
9286 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9290 #: ../src/guestfs-actions.pod:2200 ../src/guestfs-actions.pod:6184 ../src/guestfs-actions.pod:6201
9291 msgid "(Added in 1.0.50)"
9295 #: ../src/guestfs-actions.pod:2202
9296 msgid "guestfs_grep"
9300 #: ../src/guestfs-actions.pod:2204
9304 " guestfs_grep (guestfs_h *g,\n"
9305 " const char *regex,\n"
9306 " const char *path);\n"
9311 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1490
9312 msgid "This calls the external C<grep> program and returns the matching lines."
9316 #: ../src/guestfs-actions.pod:2221
9317 msgid "guestfs_grepi"
9321 #: ../src/guestfs-actions.pod:2223
9325 " guestfs_grepi (guestfs_h *g,\n"
9326 " const char *regex,\n"
9327 " const char *path);\n"
9332 #: ../src/guestfs-actions.pod:2228 ../fish/guestfish-actions.pod:1500
9333 msgid "This calls the external C<grep -i> program and returns the matching lines."
9337 #: ../src/guestfs-actions.pod:2240
9338 msgid "guestfs_grub_install"
9342 #: ../src/guestfs-actions.pod:2242
9346 " guestfs_grub_install (guestfs_h *g,\n"
9347 " const char *root,\n"
9348 " const char *device);\n"
9353 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
9355 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9356 "the root directory being C<root>."
9360 #: ../src/guestfs-actions.pod:2250 ../fish/guestfish-actions.pod:1513
9362 "Note: If grub-install reports the error \"No suitable drive was found in the "
9363 "generated device map.\" it may be that you need to create a "
9364 "C</boot/grub/device.map> file first that contains the mapping between grub "
9365 "device names and Linux device names. It is usually sufficient to create a "
9370 #: ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1520
9378 #: ../src/guestfs-actions.pod:2259 ../fish/guestfish-actions.pod:1522
9379 msgid "replacing C</dev/vda> with the name of the installation device."
9383 #: ../src/guestfs-actions.pod:2263
9384 msgid "(Added in 1.0.17)"
9388 #: ../src/guestfs-actions.pod:2265
9389 msgid "guestfs_head"
9393 #: ../src/guestfs-actions.pod:2267
9397 " guestfs_head (guestfs_h *g,\n"
9398 " const char *path);\n"
9403 #: ../src/guestfs-actions.pod:2271 ../fish/guestfish-actions.pod:1528
9405 "This command returns up to the first 10 lines of a file as a list of "
9410 #: ../src/guestfs-actions.pod:2283
9411 msgid "guestfs_head_n"
9415 #: ../src/guestfs-actions.pod:2285
9419 " guestfs_head_n (guestfs_h *g,\n"
9421 " const char *path);\n"
9426 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1538
9428 "If the parameter C<nrlines> is a positive number, this returns the first "
9429 "C<nrlines> lines of the file C<path>."
9433 #: ../src/guestfs-actions.pod:2293 ../fish/guestfish-actions.pod:1541
9435 "If the parameter C<nrlines> is a negative number, this returns lines from "
9436 "the file C<path>, excluding the last C<nrlines> lines."
9440 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:6481 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4360
9441 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9445 #: ../src/guestfs-actions.pod:2307
9446 msgid "guestfs_hexdump"
9450 #: ../src/guestfs-actions.pod:2309
9454 " guestfs_hexdump (guestfs_h *g,\n"
9455 " const char *path);\n"
9460 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
9462 "This runs C<hexdump -C> on the given C<path>. The result is the "
9463 "human-readable, canonical hex dump of the file."
9467 #: ../src/guestfs-actions.pod:2322 ../src/guestfs-actions.pod:6265 ../src/guestfs-actions.pod:6320
9468 msgid "(Added in 1.0.22)"
9472 #: ../src/guestfs-actions.pod:2324
9473 msgid "guestfs_initrd_cat"
9477 #: ../src/guestfs-actions.pod:2326
9481 " guestfs_initrd_cat (guestfs_h *g,\n"
9482 " const char *initrdpath,\n"
9483 " const char *filename,\n"
9484 " size_t *size_r);\n"
9489 #: ../src/guestfs-actions.pod:2332 ../fish/guestfish-actions.pod:1563
9491 "This command unpacks the file C<filename> from the initrd file called "
9492 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9497 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
9499 "For example, in guestfish you could use the following command to examine the "
9500 "boot script (usually called C</init>) contained in a Linux initrd or "
9505 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
9508 " initrd-cat /boot/initrd-<version>.img init\n"
9513 #: ../src/guestfs-actions.pod:2342
9514 msgid "See also C<guestfs_initrd_list>."
9518 #: ../src/guestfs-actions.pod:2353
9519 msgid "guestfs_initrd_list"
9523 #: ../src/guestfs-actions.pod:2355
9527 " guestfs_initrd_list (guestfs_h *g,\n"
9528 " const char *path);\n"
9533 #: ../src/guestfs-actions.pod:2359 ../fish/guestfish-actions.pod:1582
9534 msgid "This command lists out files contained in an initrd."
9538 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1584
9540 "The files are listed without any initial C</> character. The files are "
9541 "listed in the order they appear (not necessarily alphabetical). Directory "
9542 "names are listed as separate items."
9546 #: ../src/guestfs-actions.pod:2365 ../fish/guestfish-actions.pod:1588
9548 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9549 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9554 #: ../src/guestfs-actions.pod:2375
9555 msgid "guestfs_inotify_add_watch"
9559 #: ../src/guestfs-actions.pod:2377
9563 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9564 " const char *path,\n"
9570 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1596
9571 msgid "Watch C<path> for the events listed in C<mask>."
9575 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1598
9577 "Note that if C<path> is a directory then events within that directory are "
9578 "watched, but this does I<not> happen recursively (in subdirectories)."
9582 #: ../src/guestfs-actions.pod:2388 ../fish/guestfish-actions.pod:1602
9584 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9585 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9589 #: ../src/guestfs-actions.pod:2396
9590 msgid "guestfs_inotify_close"
9594 #: ../src/guestfs-actions.pod:2398
9598 " guestfs_inotify_close (guestfs_h *g);\n"
9603 #: ../src/guestfs-actions.pod:2401 ../fish/guestfish-actions.pod:1610
9605 "This closes the inotify handle which was previously opened by inotify_init. "
9606 "It removes all watches, throws away any pending events, and deallocates all "
9611 #: ../src/guestfs-actions.pod:2409
9612 msgid "guestfs_inotify_files"
9616 #: ../src/guestfs-actions.pod:2411
9620 " guestfs_inotify_files (guestfs_h *g);\n"
9625 #: ../src/guestfs-actions.pod:2414
9627 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9628 "returns a list of pathnames of objects that were touched. The returned "
9629 "pathnames are sorted and deduplicated."
9633 #: ../src/guestfs-actions.pod:2424
9634 msgid "guestfs_inotify_init"
9638 #: ../src/guestfs-actions.pod:2426
9642 " guestfs_inotify_init (guestfs_h *g,\n"
9643 " int maxevents);\n"
9648 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1626
9650 "This command creates a new inotify handle. The inotify subsystem can be "
9651 "used to notify events which happen to objects in the guest filesystem."
9655 #: ../src/guestfs-actions.pod:2434
9657 "C<maxevents> is the maximum number of events which will be queued up between "
9658 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9659 "passed as C<0>, then the kernel (or previously set) default is used. For "
9660 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9661 "throws away events, but records the fact that it threw them away by setting "
9662 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9663 "C<guestfs_inotify_read>)."
9667 #: ../src/guestfs-actions.pod:2444
9669 "Before any events are generated, you have to add some watches to the "
9670 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9671 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9675 #: ../src/guestfs-actions.pod:2450
9677 "Queued up events should be read periodically by calling "
9678 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9679 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9680 "often enough then you risk the internal queue overflowing."
9684 #: ../src/guestfs-actions.pod:2457
9686 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9687 "This also removes any watches automatically."
9691 #: ../src/guestfs-actions.pod:2461 ../fish/guestfish-actions.pod:1657
9693 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9694 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9695 "that there is one global inotify handle per libguestfs instance."
9699 #: ../src/guestfs-actions.pod:2470
9700 msgid "guestfs_inotify_read"
9704 #: ../src/guestfs-actions.pod:2472
9707 " struct guestfs_inotify_event_list *\n"
9708 " guestfs_inotify_read (guestfs_h *g);\n"
9713 #: ../src/guestfs-actions.pod:2475 ../fish/guestfish-actions.pod:1666
9715 "Return the complete queue of events that have happened since the previous "
9720 #: ../src/guestfs-actions.pod:2478 ../fish/guestfish-actions.pod:1669
9721 msgid "If no events have happened, this returns an empty list."
9725 #: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1671
9727 "I<Note>: In order to make sure that all events have been read, you must call "
9728 "this function repeatedly until it returns an empty list. The reason is that "
9729 "the call will read events up to the maximum appliance-to-host message size "
9730 "and leave remaining events in the queue."
9734 #: ../src/guestfs-actions.pod:2486
9736 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9737 "there was an error. I<The caller must call "
9738 "C<guestfs_free_inotify_event_list> after use>."
9742 #: ../src/guestfs-actions.pod:2492
9743 msgid "guestfs_inotify_rm_watch"
9747 #: ../src/guestfs-actions.pod:2494
9751 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9757 #: ../src/guestfs-actions.pod:2498
9759 "Remove a previously defined inotify watch. See "
9760 "C<guestfs_inotify_add_watch>."
9764 #: ../src/guestfs-actions.pod:2505
9765 msgid "guestfs_inspect_get_arch"
9769 #: ../src/guestfs-actions.pod:2507
9773 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9774 " const char *root);\n"
9779 #: ../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:2871 ../src/guestfs-actions.pod:2926 ../src/guestfs-actions.pod:2968 ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3008 ../src/guestfs-actions.pod:3025 ../src/guestfs-actions.pod:3044
9781 "This function should only be called with a root device string as returned by "
9782 "C<guestfs_inspect_os>."
9786 #: ../src/guestfs-actions.pod:2514
9788 "This returns the architecture of the inspected operating system. The "
9789 "possible return values are listed under C<guestfs_file_architecture>."
9793 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1695
9795 "If the architecture could not be determined, then the string C<unknown> is "
9800 #: ../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:2912 ../src/guestfs-actions.pod:2955 ../src/guestfs-actions.pod:2978 ../src/guestfs-actions.pod:2998 ../src/guestfs-actions.pod:3015 ../src/guestfs-actions.pod:3034 ../src/guestfs-actions.pod:3137 ../src/guestfs-actions.pod:3178 ../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:2008 ../fish/guestfish-actions.pod:2043 ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2072 ../fish/guestfish-actions.pod:2085 ../fish/guestfish-actions.pod:2100 ../fish/guestfish-actions.pod:2199 ../fish/guestfish-actions.pod:2233
9801 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9805 #: ../src/guestfs-actions.pod:2528
9806 msgid "guestfs_inspect_get_distro"
9810 #: ../src/guestfs-actions.pod:2530
9814 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9815 " const char *root);\n"
9820 #: ../src/guestfs-actions.pod:2537 ../fish/guestfish-actions.pod:1707
9821 msgid "This returns the distro (distribution) of the inspected operating system."
9825 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1710
9826 msgid "Currently defined distros are:"
9830 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1714
9831 msgid "\"archlinux\""
9835 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1716
9840 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1718
9845 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1720
9850 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1722
9855 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1724
9860 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1726
9865 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1728
9870 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1730
9871 msgid "\"linuxmint\""
9875 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1732
9880 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1734
9881 msgid "\"mandriva\""
9885 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1736
9890 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1738
9895 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1740
9900 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1742
9905 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1744
9910 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1746
9911 msgid "\"redhat-based\""
9915 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1748
9916 msgid "Some Red Hat-derived distro."
9920 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1750
9925 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1752
9926 msgid "Red Hat Enterprise Linux and some derivatives."
9930 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1754
9935 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1756
9940 #: ../src/guestfs-actions.pod:2588 ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:1758 ../fish/guestfish-actions.pod:1815 ../fish/guestfish-actions.pod:2034
9945 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1760
9946 msgid "The distro could not be determined."
9950 #: ../src/guestfs-actions.pod:2592 ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:1762 ../fish/guestfish-actions.pod:2026
9955 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1764
9957 "Windows does not have distributions. This string is returned if the OS type "
9962 #: ../src/guestfs-actions.pod:2599 ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:1769 ../fish/guestfish-actions.pod:1821 ../fish/guestfish-actions.pod:2040
9964 "Future versions of libguestfs may return other strings here. The caller "
9965 "should be prepared to handle any string."
9969 #: ../src/guestfs-actions.pod:2609
9970 msgid "guestfs_inspect_get_filesystems"
9974 #: ../src/guestfs-actions.pod:2611
9978 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9979 " const char *root);\n"
9984 #: ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1781
9986 "This returns a list of all the filesystems that we think are associated with "
9987 "this operating system. This includes the root filesystem, other ordinary "
9988 "filesystems, and non-mounted devices like swap partitions."
9992 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1786
9994 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9995 "to be shared between operating systems."
9999 #: ../src/guestfs-actions.pod:2626
10001 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10002 "C<guestfs_inspect_get_mountpoints>."
10006 #: ../src/guestfs-actions.pod:2635
10007 msgid "guestfs_inspect_get_format"
10011 #: ../src/guestfs-actions.pod:2637
10015 " guestfs_inspect_get_format (guestfs_h *g,\n"
10016 " const char *root);\n"
10021 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1799
10023 "This returns the format of the inspected operating system. You can use it "
10024 "to detect install images, live CDs and similar."
10028 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1802
10029 msgid "Currently defined formats are:"
10033 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1806
10034 msgid "\"installed\""
10038 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1808
10039 msgid "This is an installed operating system."
10043 #: ../src/guestfs-actions.pod:2655 ../fish/guestfish-actions.pod:1810
10044 msgid "\"installer\""
10048 #: ../src/guestfs-actions.pod:2657 ../fish/guestfish-actions.pod:1812
10050 "The disk image being inspected is not an installed operating system, but a "
10051 "I<bootable> install disk, live CD, or similar."
10055 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1817
10056 msgid "The format of this disk image is not known."
10060 #: ../src/guestfs-actions.pod:2674
10061 msgid "guestfs_inspect_get_hostname"
10065 #: ../src/guestfs-actions.pod:2676
10069 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10070 " const char *root);\n"
10075 #: ../src/guestfs-actions.pod:2683 ../fish/guestfish-actions.pod:1833
10077 "This function returns the hostname of the operating system as found by "
10078 "inspection of the guest's configuration files."
10082 #: ../src/guestfs-actions.pod:2686 ../fish/guestfish-actions.pod:1836
10084 "If the hostname could not be determined, then the string C<unknown> is "
10089 #: ../src/guestfs-actions.pod:2694
10090 msgid "(Added in 1.7.9)"
10094 #: ../src/guestfs-actions.pod:2696
10095 msgid "guestfs_inspect_get_major_version"
10099 #: ../src/guestfs-actions.pod:2698
10103 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10104 " const char *root);\n"
10109 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1848
10110 msgid "This returns the major version number of the inspected operating system."
10114 #: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1851
10116 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10117 "popular public names used by the operating system. Notably the operating "
10118 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10119 "1). You can find out the real versions corresponding to releases of Windows "
10120 "by consulting Wikipedia or MSDN."
10124 #: ../src/guestfs-actions.pod:2715 ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:1858 ../fish/guestfish-actions.pod:1872
10125 msgid "If the version could not be determined, then C<0> is returned."
10129 #: ../src/guestfs-actions.pod:2723
10130 msgid "guestfs_inspect_get_minor_version"
10134 #: ../src/guestfs-actions.pod:2725
10138 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10139 " const char *root);\n"
10144 #: ../src/guestfs-actions.pod:2732 ../fish/guestfish-actions.pod:1869
10145 msgid "This returns the minor version number of the inspected operating system."
10149 #: ../src/guestfs-actions.pod:2737
10151 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10152 "C<guestfs_inspect_get_major_version>."
10156 #: ../src/guestfs-actions.pod:2744
10157 msgid "guestfs_inspect_get_mountpoints"
10161 #: ../src/guestfs-actions.pod:2746
10165 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10166 " const char *root);\n"
10171 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1884
10173 "This returns a hash of where we think the filesystems associated with this "
10174 "operating system should be mounted. Callers should note that this is at "
10175 "best an educated guess made by reading configuration files such as "
10176 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10177 "are non-existent or not mountable and callers should be prepared to handle "
10178 "or ignore failures if they try to mount them."
10182 #: ../src/guestfs-actions.pod:2762 ../fish/guestfish-actions.pod:1893
10184 "Each element in the returned hashtable has a key which is the path of the "
10185 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10186 "mounted there (eg. C</dev/sda1>)."
10190 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1898
10191 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10195 #: ../src/guestfs-actions.pod:2770
10197 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10198 "C<guestfs_inspect_get_filesystems>."
10202 #: ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:3507 ../src/guestfs-actions.pod:4717 ../src/guestfs-actions.pod:6622
10204 "This function returns a NULL-terminated array of strings, or NULL if there "
10205 "was an error. The array of strings will always have length C<2n+1>, where "
10206 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10207 "caller must free the strings and the array after use>."
10211 #: ../src/guestfs-actions.pod:2781
10212 msgid "guestfs_inspect_get_package_format"
10216 #: ../src/guestfs-actions.pod:2783
10220 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10221 " const char *root);\n"
10226 #: ../src/guestfs-actions.pod:2790
10228 "This function and C<guestfs_inspect_get_package_management> return the "
10229 "package format and package management tool used by the inspected operating "
10230 "system. For example for Fedora these functions would return C<rpm> (package "
10231 "format) and C<yum> (package management)."
10235 #: ../src/guestfs-actions.pod:2796 ../fish/guestfish-actions.pod:1917
10237 "This returns the string C<unknown> if we could not determine the package "
10238 "format I<or> if the operating system does not have a real packaging system "
10243 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1921
10245 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10246 "Future versions of libguestfs may return other strings."
10250 #: ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2839
10251 msgid "(Added in 1.7.5)"
10255 #: ../src/guestfs-actions.pod:2810
10256 msgid "guestfs_inspect_get_package_management"
10260 #: ../src/guestfs-actions.pod:2812
10264 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10265 " const char *root);\n"
10270 #: ../src/guestfs-actions.pod:2819
10272 "C<guestfs_inspect_get_package_format> and this function return the package "
10273 "format and package management tool used by the inspected operating system. "
10274 "For example for Fedora these functions would return C<rpm> (package format) "
10275 "and C<yum> (package management)."
10279 #: ../src/guestfs-actions.pod:2825 ../fish/guestfish-actions.pod:1939
10281 "This returns the string C<unknown> if we could not determine the package "
10282 "management tool I<or> if the operating system does not have a real packaging "
10283 "system (eg. Windows)."
10287 #: ../src/guestfs-actions.pod:2829 ../fish/guestfish-actions.pod:1943
10289 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10290 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10291 "libguestfs may return other strings."
10295 #: ../src/guestfs-actions.pod:2841
10296 msgid "guestfs_inspect_get_product_name"
10300 #: ../src/guestfs-actions.pod:2843
10304 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10305 " const char *root);\n"
10310 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1957
10312 "This returns the product name of the inspected operating system. The "
10313 "product name is generally some freeform string which can be displayed to the "
10314 "user, but should not be parsed by programs."
10318 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1962
10320 "If the product name could not be determined, then the string C<unknown> is "
10325 #: ../src/guestfs-actions.pod:2865
10326 msgid "guestfs_inspect_get_product_variant"
10330 #: ../src/guestfs-actions.pod:2867
10334 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10335 " const char *root);\n"
10340 #: ../src/guestfs-actions.pod:2874 ../fish/guestfish-actions.pod:1974
10341 msgid "This returns the product variant of the inspected operating system."
10345 #: ../src/guestfs-actions.pod:2877 ../fish/guestfish-actions.pod:1977
10347 "For Windows guests, this returns the contents of the Registry key "
10348 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10349 "which is usually a string such as C<Client> or C<Server> (other values are "
10350 "possible). This can be used to distinguish consumer and enterprise versions "
10351 "of Windows that have the same version number (for example, Windows 7 and "
10352 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10353 "the latter is C<Server>)."
10357 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1986
10359 "For enterprise Linux guests, in future we intend this to return the product "
10360 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10361 "implemented at present."
10365 #: ../src/guestfs-actions.pod:2890 ../fish/guestfish-actions.pod:1990
10367 "If the product variant could not be determined, then the string C<unknown> "
10372 #: ../src/guestfs-actions.pod:2893
10374 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10375 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10379 #: ../src/guestfs-actions.pod:2900
10380 msgid "guestfs_inspect_get_roots"
10384 #: ../src/guestfs-actions.pod:2902
10388 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10393 #: ../src/guestfs-actions.pod:2905
10395 "This function is a convenient way to get the list of root devices, as "
10396 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10397 "the whole inspection process."
10401 #: ../src/guestfs-actions.pod:2909
10403 "This returns an empty list if either no root devices were found or the "
10404 "caller has not called C<guestfs_inspect_os>."
10408 #: ../src/guestfs-actions.pod:2918
10409 msgid "(Added in 1.7.3)"
10413 #: ../src/guestfs-actions.pod:2920
10414 msgid "guestfs_inspect_get_type"
10418 #: ../src/guestfs-actions.pod:2922
10422 " guestfs_inspect_get_type (guestfs_h *g,\n"
10423 " const char *root);\n"
10428 #: ../src/guestfs-actions.pod:2929 ../fish/guestfish-actions.pod:2017
10430 "This returns the type of the inspected operating system. Currently defined "
10435 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2022
10440 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2024
10441 msgid "Any Linux-based operating system."
10445 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2028
10446 msgid "Any Microsoft Windows operating system."
10450 #: ../src/guestfs-actions.pod:2942 ../fish/guestfish-actions.pod:2030
10451 msgid "\"freebsd\""
10455 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2032
10460 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2036
10461 msgid "The operating system type could not be determined."
10465 #: ../src/guestfs-actions.pod:2962
10466 msgid "guestfs_inspect_get_windows_systemroot"
10470 #: ../src/guestfs-actions.pod:2964
10474 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10475 " const char *root);\n"
10480 #: ../src/guestfs-actions.pod:2971 ../fish/guestfish-actions.pod:2052
10482 "This returns the Windows systemroot of the inspected guest. The systemroot "
10483 "is a directory path such as C</WINDOWS>."
10487 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2055
10489 "This call assumes that the guest is Windows and that the systemroot could be "
10490 "determined by inspection. If this is not the case then an error is "
10495 #: ../src/guestfs-actions.pod:2983
10496 msgid "(Added in 1.5.25)"
10500 #: ../src/guestfs-actions.pod:2985
10501 msgid "guestfs_inspect_is_live"
10505 #: ../src/guestfs-actions.pod:2987
10509 " guestfs_inspect_is_live (guestfs_h *g,\n"
10510 " const char *root);\n"
10515 #: ../src/guestfs-actions.pod:2994
10517 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10518 "disk), then this returns true if a live image was detected on the disk."
10522 #: ../src/guestfs-actions.pod:3002
10523 msgid "guestfs_inspect_is_multipart"
10527 #: ../src/guestfs-actions.pod:3004
10531 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
10532 " const char *root);\n"
10537 #: ../src/guestfs-actions.pod:3011
10539 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10540 "disk), then this returns true if the disk is part of a set."
10544 #: ../src/guestfs-actions.pod:3019
10545 msgid "guestfs_inspect_is_netinst"
10549 #: ../src/guestfs-actions.pod:3021
10553 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
10554 " const char *root);\n"
10559 #: ../src/guestfs-actions.pod:3028
10561 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
10562 "disk), then this returns true if the disk is a network installer, ie. not a "
10563 "self-contained install CD but one which is likely to require network access "
10564 "to complete the install."
10568 #: ../src/guestfs-actions.pod:3038
10569 msgid "guestfs_inspect_list_applications"
10573 #: ../src/guestfs-actions.pod:3040
10576 " struct guestfs_application_list *\n"
10577 " guestfs_inspect_list_applications (guestfs_h *g,\n"
10578 " const char *root);\n"
10583 #: ../src/guestfs-actions.pod:3047 ../fish/guestfish-actions.pod:2109
10584 msgid "Return the list of applications installed in the operating system."
10588 #: ../src/guestfs-actions.pod:3049
10590 "I<Note:> This call works differently from other parts of the inspection "
10591 "API. You have to call C<guestfs_inspect_os>, then "
10592 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
10593 "this. Listing applications is a significantly more difficult operation "
10594 "which requires access to the full filesystem. Also note that unlike the "
10595 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
10596 "the libguestfs handle, this call actually reads parts of the mounted "
10597 "filesystems during the call."
10601 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2121
10603 "This returns an empty list if the inspection code was not able to determine "
10604 "the list of applications."
10608 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2124
10609 msgid "The application structure contains the following fields:"
10613 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2128
10614 msgid "C<app_name>"
10618 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2130
10620 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10621 "guests, this is the package name."
10625 #: ../src/guestfs-actions.pod:3071 ../fish/guestfish-actions.pod:2133
10626 msgid "C<app_display_name>"
10630 #: ../src/guestfs-actions.pod:3073 ../fish/guestfish-actions.pod:2135
10632 "The display name of the application, sometimes localized to the install "
10633 "language of the guest operating system."
10637 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2138
10639 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10640 "to display something can use C<app_name> instead."
10644 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2141
10645 msgid "C<app_epoch>"
10649 #: ../src/guestfs-actions.pod:3081 ../fish/guestfish-actions.pod:2143
10651 "For package managers which use epochs, this contains the epoch of the "
10652 "package (an integer). If unavailable, this is returned as C<0>."
10656 #: ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:2146
10657 msgid "C<app_version>"
10661 #: ../src/guestfs-actions.pod:3086 ../fish/guestfish-actions.pod:2148
10663 "The version string of the application or package. If unavailable this is "
10664 "returned as an empty string C<\"\">."
10668 #: ../src/guestfs-actions.pod:3089 ../fish/guestfish-actions.pod:2151
10669 msgid "C<app_release>"
10673 #: ../src/guestfs-actions.pod:3091 ../fish/guestfish-actions.pod:2153
10675 "The release string of the application or package, for package managers that "
10676 "use this. If unavailable this is returned as an empty string C<\"\">."
10680 #: ../src/guestfs-actions.pod:3095 ../fish/guestfish-actions.pod:2157
10681 msgid "C<app_install_path>"
10685 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2159
10687 "The installation path of the application (on operating systems such as "
10688 "Windows which use installation paths). This path is in the format used by "
10689 "the guest operating system, it is not a libguestfs path."
10693 #: ../src/guestfs-actions.pod:3102 ../fish/guestfish-actions.pod:2164
10694 msgid "If unavailable this is returned as an empty string C<\"\">."
10698 #: ../src/guestfs-actions.pod:3104 ../fish/guestfish-actions.pod:2166
10699 msgid "C<app_trans_path>"
10703 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2168
10705 "The install path translated into a libguestfs path. If unavailable this is "
10706 "returned as an empty string C<\"\">."
10710 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2171
10711 msgid "C<app_publisher>"
10715 #: ../src/guestfs-actions.pod:3111 ../fish/guestfish-actions.pod:2173
10717 "The name of the publisher of the application, for package managers that use "
10718 "this. If unavailable this is returned as an empty string C<\"\">."
10722 #: ../src/guestfs-actions.pod:3115 ../fish/guestfish-actions.pod:2177
10727 #: ../src/guestfs-actions.pod:3117 ../fish/guestfish-actions.pod:2179
10729 "The URL (eg. upstream URL) of the application. If unavailable this is "
10730 "returned as an empty string C<\"\">."
10734 #: ../src/guestfs-actions.pod:3120 ../fish/guestfish-actions.pod:2182
10735 msgid "C<app_source_package>"
10739 #: ../src/guestfs-actions.pod:3122 ../fish/guestfish-actions.pod:2184
10741 "For packaging systems which support this, the name of the source package. "
10742 "If unavailable this is returned as an empty string C<\"\">."
10746 #: ../src/guestfs-actions.pod:3125 ../fish/guestfish-actions.pod:2187
10747 msgid "C<app_summary>"
10751 #: ../src/guestfs-actions.pod:3127 ../fish/guestfish-actions.pod:2189
10753 "A short (usually one line) description of the application or package. If "
10754 "unavailable this is returned as an empty string C<\"\">."
10758 #: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2192
10759 msgid "C<app_description>"
10763 #: ../src/guestfs-actions.pod:3132 ../fish/guestfish-actions.pod:2194
10765 "A longer description of the application or package. If unavailable this is "
10766 "returned as an empty string C<\"\">."
10770 #: ../src/guestfs-actions.pod:3139
10772 "This function returns a C<struct guestfs_application_list *>, or NULL if "
10773 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10778 #: ../src/guestfs-actions.pod:3143
10779 msgid "(Added in 1.7.8)"
10783 #: ../src/guestfs-actions.pod:3145
10784 msgid "guestfs_inspect_os"
10788 #: ../src/guestfs-actions.pod:3147
10792 " guestfs_inspect_os (guestfs_h *g);\n"
10797 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2205
10799 "This function uses other libguestfs functions and certain heuristics to "
10800 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10801 "for operating systems."
10805 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2209
10806 msgid "The list returned is empty if no operating systems were found."
10810 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2211
10812 "If one operating system was found, then this returns a list with a single "
10813 "element, which is the name of the root filesystem of this operating system. "
10814 "It is also possible for this function to return a list containing more than "
10815 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10816 "element being the root filesystem of one of the operating systems."
10820 #: ../src/guestfs-actions.pod:3163
10822 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10823 "functions in order to query further information about each operating system, "
10824 "such as the name and version."
10828 #: ../src/guestfs-actions.pod:3168
10830 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10831 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10832 "the contents. This should be called with no disks currently mounted. The "
10833 "function may also use Augeas, so any existing Augeas handle will be closed."
10837 #: ../src/guestfs-actions.pod:3174 ../fish/guestfish-actions.pod:2229
10839 "This function cannot decrypt encrypted disks. The caller must do that first "
10840 "(supplying the necessary keys) if the disk is encrypted."
10844 #: ../src/guestfs-actions.pod:3180 ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3527
10845 msgid "See also C<guestfs_list_filesystems>."
10849 #: ../src/guestfs-actions.pod:3188
10850 msgid "guestfs_is_blockdev"
10854 #: ../src/guestfs-actions.pod:3190
10858 " guestfs_is_blockdev (guestfs_h *g,\n"
10859 " const char *path);\n"
10864 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2241
10866 "This returns C<true> if and only if there is a block device with the given "
10871 #: ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3226 ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3271 ../src/guestfs-actions.pod:3287 ../src/guestfs-actions.pod:3343 ../src/guestfs-actions.pod:3358
10872 msgid "See also C<guestfs_stat>."
10876 #: ../src/guestfs-actions.pod:3201 ../src/guestfs-actions.pod:3230 ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3347 ../src/guestfs-actions.pod:3362
10877 msgid "(Added in 1.5.10)"
10881 #: ../src/guestfs-actions.pod:3203
10882 msgid "guestfs_is_busy"
10886 #: ../src/guestfs-actions.pod:3205
10890 " guestfs_is_busy (guestfs_h *g);\n"
10895 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2250
10897 "This returns true iff this handle is busy processing a command (in the "
10902 #: ../src/guestfs-actions.pod:3217
10903 msgid "guestfs_is_chardev"
10907 #: ../src/guestfs-actions.pod:3219
10911 " guestfs_is_chardev (guestfs_h *g,\n"
10912 " const char *path);\n"
10917 #: ../src/guestfs-actions.pod:3223 ../fish/guestfish-actions.pod:2259
10919 "This returns C<true> if and only if there is a character device with the "
10920 "given C<path> name."
10924 #: ../src/guestfs-actions.pod:3232
10925 msgid "guestfs_is_config"
10929 #: ../src/guestfs-actions.pod:3234
10933 " guestfs_is_config (guestfs_h *g);\n"
10938 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2268
10940 "This returns true iff this handle is being configured (in the C<CONFIG> "
10945 #: ../src/guestfs-actions.pod:3246
10946 msgid "guestfs_is_dir"
10950 #: ../src/guestfs-actions.pod:3248
10954 " guestfs_is_dir (guestfs_h *g,\n"
10955 " const char *path);\n"
10960 #: ../src/guestfs-actions.pod:3252 ../fish/guestfish-actions.pod:2277
10962 "This returns C<true> if and only if there is a directory with the given "
10963 "C<path> name. Note that it returns false for other objects like files."
10967 #: ../src/guestfs-actions.pod:3262
10968 msgid "guestfs_is_fifo"
10972 #: ../src/guestfs-actions.pod:3264
10976 " guestfs_is_fifo (guestfs_h *g,\n"
10977 " const char *path);\n"
10982 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2287
10984 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10985 "given C<path> name."
10989 #: ../src/guestfs-actions.pod:3277
10990 msgid "guestfs_is_file"
10994 #: ../src/guestfs-actions.pod:3279
10998 " guestfs_is_file (guestfs_h *g,\n"
10999 " const char *path);\n"
11004 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2296
11006 "This returns C<true> if and only if there is a regular file with the given "
11007 "C<path> name. Note that it returns false for other objects like "
11012 #: ../src/guestfs-actions.pod:3293
11013 msgid "guestfs_is_launching"
11017 #: ../src/guestfs-actions.pod:3295
11021 " guestfs_is_launching (guestfs_h *g);\n"
11026 #: ../src/guestfs-actions.pod:3298 ../fish/guestfish-actions.pod:2306
11028 "This returns true iff this handle is launching the subprocess (in the "
11029 "C<LAUNCHING> state)."
11033 #: ../src/guestfs-actions.pod:3307
11034 msgid "guestfs_is_lv"
11038 #: ../src/guestfs-actions.pod:3309
11042 " guestfs_is_lv (guestfs_h *g,\n"
11043 " const char *device);\n"
11048 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2315
11050 "This command tests whether C<device> is a logical volume, and returns true "
11051 "iff this is the case."
11055 #: ../src/guestfs-actions.pod:3320
11056 msgid "guestfs_is_ready"
11060 #: ../src/guestfs-actions.pod:3322
11064 " guestfs_is_ready (guestfs_h *g);\n"
11069 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2322
11071 "This returns true iff this handle is ready to accept commands (in the "
11076 #: ../src/guestfs-actions.pod:3334
11077 msgid "guestfs_is_socket"
11081 #: ../src/guestfs-actions.pod:3336
11085 " guestfs_is_socket (guestfs_h *g,\n"
11086 " const char *path);\n"
11091 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2331
11093 "This returns C<true> if and only if there is a Unix domain socket with the "
11094 "given C<path> name."
11098 #: ../src/guestfs-actions.pod:3349
11099 msgid "guestfs_is_symlink"
11103 #: ../src/guestfs-actions.pod:3351
11107 " guestfs_is_symlink (guestfs_h *g,\n"
11108 " const char *path);\n"
11113 #: ../src/guestfs-actions.pod:3355 ../fish/guestfish-actions.pod:2340
11115 "This returns C<true> if and only if there is a symbolic link with the given "
11120 #: ../src/guestfs-actions.pod:3364
11121 msgid "guestfs_kill_subprocess"
11125 #: ../src/guestfs-actions.pod:3366
11129 " guestfs_kill_subprocess (guestfs_h *g);\n"
11134 #: ../src/guestfs-actions.pod:3369 ../fish/guestfish-actions.pod:2349
11135 msgid "This kills the qemu subprocess. You should never need to call this."
11139 #: ../src/guestfs-actions.pod:3375
11140 msgid "guestfs_launch"
11144 #: ../src/guestfs-actions.pod:3377
11148 " guestfs_launch (guestfs_h *g);\n"
11153 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2357
11155 "Internally libguestfs is implemented by running a virtual machine using "
11160 #: ../src/guestfs-actions.pod:3383 ../fish/guestfish-actions.pod:2360
11162 "You should call this after configuring the handle (eg. adding drives) but "
11163 "before performing any actions."
11167 #: ../src/guestfs-actions.pod:3390
11168 msgid "guestfs_lchown"
11172 #: ../src/guestfs-actions.pod:3392
11176 " guestfs_lchown (guestfs_h *g,\n"
11179 " const char *path);\n"
11184 #: ../src/guestfs-actions.pod:3398
11186 "Change the file owner to C<owner> and group to C<group>. This is like "
11187 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11188 "changed, not the target."
11192 #: ../src/guestfs-actions.pod:3410
11193 msgid "guestfs_lgetxattr"
11197 #: ../src/guestfs-actions.pod:3412
11201 " guestfs_lgetxattr (guestfs_h *g,\n"
11202 " const char *path,\n"
11203 " const char *name,\n"
11204 " size_t *size_r);\n"
11209 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:2379
11211 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11212 "is a symlink, then this call returns an extended attribute from the symlink."
11216 #: ../src/guestfs-actions.pod:3432
11217 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11221 #: ../src/guestfs-actions.pod:3440
11222 msgid "guestfs_lgetxattrs"
11226 #: ../src/guestfs-actions.pod:3442
11229 " struct guestfs_xattr_list *\n"
11230 " guestfs_lgetxattrs (guestfs_h *g,\n"
11231 " const char *path);\n"
11236 #: ../src/guestfs-actions.pod:3446
11238 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11239 "then it returns the extended attributes of the link itself."
11243 #: ../src/guestfs-actions.pod:3456
11244 msgid "guestfs_list_devices"
11248 #: ../src/guestfs-actions.pod:3458
11252 " guestfs_list_devices (guestfs_h *g);\n"
11257 #: ../src/guestfs-actions.pod:3461 ../fish/guestfish-actions.pod:2407
11258 msgid "List all the block devices."
11262 #: ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:2409
11263 msgid "The full block device names are returned, eg. C</dev/sda>."
11267 #: ../src/guestfs-actions.pod:3473
11268 msgid "guestfs_list_filesystems"
11272 #: ../src/guestfs-actions.pod:3475
11276 " guestfs_list_filesystems (guestfs_h *g);\n"
11281 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2417
11283 "This inspection command looks for filesystems on partitions, block devices "
11284 "and logical volumes, returning a list of devices containing filesystems and "
11289 #: ../src/guestfs-actions.pod:3482 ../fish/guestfish-actions.pod:2421
11291 "The return value is a hash, where the keys are the devices containing "
11292 "filesystems, and the values are the filesystem types. For example:"
11296 #: ../src/guestfs-actions.pod:3486 ../fish/guestfish-actions.pod:2425
11299 " \"/dev/sda1\" => \"ntfs\"\n"
11300 " \"/dev/sda2\" => \"ext2\"\n"
11301 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11302 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11307 #: ../src/guestfs-actions.pod:3491 ../fish/guestfish-actions.pod:2430
11309 "The value can have the special value \"unknown\", meaning the content of the "
11310 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11314 #: ../src/guestfs-actions.pod:3495
11316 "This command runs other libguestfs commands, which might include "
11317 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11318 "soon after launch and only when nothing is mounted."
11322 #: ../src/guestfs-actions.pod:3499
11324 "Not all of the filesystems returned will be mountable. In particular, swap "
11325 "partitions are returned in the list. Also this command does not check that "
11326 "each filesystem found is valid and mountable, and some filesystems might be "
11327 "mountable but require special options. Filesystems may not all belong to a "
11328 "single logical operating system (use C<guestfs_inspect_os> to look for "
11333 #: ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:5118
11334 msgid "(Added in 1.5.15)"
11338 #: ../src/guestfs-actions.pod:3515
11339 msgid "guestfs_list_partitions"
11343 #: ../src/guestfs-actions.pod:3517
11347 " guestfs_list_partitions (guestfs_h *g);\n"
11352 #: ../src/guestfs-actions.pod:3520 ../fish/guestfish-actions.pod:2450
11353 msgid "List all the partitions detected on all block devices."
11357 #: ../src/guestfs-actions.pod:3522 ../fish/guestfish-actions.pod:2452
11358 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11362 #: ../src/guestfs-actions.pod:3524
11364 "This does not return logical volumes. For that you will need to call "
11369 #: ../src/guestfs-actions.pod:3535
11374 #: ../src/guestfs-actions.pod:3537
11378 " guestfs_ll (guestfs_h *g,\n"
11379 " const char *directory);\n"
11384 #: ../src/guestfs-actions.pod:3541 ../fish/guestfish-actions.pod:2463
11386 "List the files in C<directory> (relative to the root directory, there is no "
11387 "cwd) in the format of 'ls -la'."
11391 #: ../src/guestfs-actions.pod:3544 ../fish/guestfish-actions.pod:2466
11393 "This command is mostly useful for interactive sessions. It is I<not> "
11394 "intended that you try to parse the output string."
11398 #: ../src/guestfs-actions.pod:3552
11403 #: ../src/guestfs-actions.pod:3554
11407 " guestfs_ln (guestfs_h *g,\n"
11408 " const char *target,\n"
11409 " const char *linkname);\n"
11414 #: ../src/guestfs-actions.pod:3559 ../fish/guestfish-actions.pod:2473
11415 msgid "This command creates a hard link using the C<ln> command."
11419 #: ../src/guestfs-actions.pod:3565
11420 msgid "guestfs_ln_f"
11424 #: ../src/guestfs-actions.pod:3567
11428 " guestfs_ln_f (guestfs_h *g,\n"
11429 " const char *target,\n"
11430 " const char *linkname);\n"
11435 #: ../src/guestfs-actions.pod:3572 ../fish/guestfish-actions.pod:2479
11437 "This command creates a hard link using the C<ln -f> command. The C<-f> "
11438 "option removes the link (C<linkname>) if it exists already."
11442 #: ../src/guestfs-actions.pod:3579
11443 msgid "guestfs_ln_s"
11447 #: ../src/guestfs-actions.pod:3581
11451 " guestfs_ln_s (guestfs_h *g,\n"
11452 " const char *target,\n"
11453 " const char *linkname);\n"
11458 #: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2486
11459 msgid "This command creates a symbolic link using the C<ln -s> command."
11463 #: ../src/guestfs-actions.pod:3592
11464 msgid "guestfs_ln_sf"
11468 #: ../src/guestfs-actions.pod:3594
11472 " guestfs_ln_sf (guestfs_h *g,\n"
11473 " const char *target,\n"
11474 " const char *linkname);\n"
11479 #: ../src/guestfs-actions.pod:3599 ../fish/guestfish-actions.pod:2492
11481 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
11482 "option removes the link (C<linkname>) if it exists already."
11486 #: ../src/guestfs-actions.pod:3606
11487 msgid "guestfs_lremovexattr"
11491 #: ../src/guestfs-actions.pod:3608
11495 " guestfs_lremovexattr (guestfs_h *g,\n"
11496 " const char *xattr,\n"
11497 " const char *path);\n"
11502 #: ../src/guestfs-actions.pod:3613
11504 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
11505 "link, then it removes an extended attribute of the link itself."
11509 #: ../src/guestfs-actions.pod:3621
11514 #: ../src/guestfs-actions.pod:3623
11518 " guestfs_ls (guestfs_h *g,\n"
11519 " const char *directory);\n"
11524 #: ../src/guestfs-actions.pod:3627 ../fish/guestfish-actions.pod:2507
11526 "List the files in C<directory> (relative to the root directory, there is no "
11527 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11532 #: ../src/guestfs-actions.pod:3631
11534 "This command is mostly useful for interactive sessions. Programs should "
11535 "probably use C<guestfs_readdir> instead."
11539 #: ../src/guestfs-actions.pod:3640
11540 msgid "guestfs_lsetxattr"
11544 #: ../src/guestfs-actions.pod:3642
11548 " guestfs_lsetxattr (guestfs_h *g,\n"
11549 " const char *xattr,\n"
11550 " const char *val,\n"
11552 " const char *path);\n"
11557 #: ../src/guestfs-actions.pod:3649
11559 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
11560 "then it sets an extended attribute of the link itself."
11564 #: ../src/guestfs-actions.pod:3657
11565 msgid "guestfs_lstat"
11569 #: ../src/guestfs-actions.pod:3659
11572 " struct guestfs_stat *\n"
11573 " guestfs_lstat (guestfs_h *g,\n"
11574 " const char *path);\n"
11579 #: ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:6221 ../fish/guestfish-actions.pod:2526 ../fish/guestfish-actions.pod:4195
11580 msgid "Returns file information for the given C<path>."
11584 #: ../src/guestfs-actions.pod:3665
11586 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
11587 "link, then the link is stat-ed, not the file it refers to."
11591 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2532
11592 msgid "This is the same as the C<lstat(2)> system call."
11596 #: ../src/guestfs-actions.pod:3671 ../src/guestfs-actions.pod:6225
11598 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
11599 "error. I<The caller must call C<guestfs_free_stat> after use>."
11603 #: ../src/guestfs-actions.pod:3675 ../src/guestfs-actions.pod:6229 ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6628
11604 msgid "(Added in 0.9.2)"
11608 #: ../src/guestfs-actions.pod:3677
11609 msgid "guestfs_lstatlist"
11613 #: ../src/guestfs-actions.pod:3679
11616 " struct guestfs_stat_list *\n"
11617 " guestfs_lstatlist (guestfs_h *g,\n"
11618 " const char *path,\n"
11619 " char *const *names);\n"
11624 #: ../src/guestfs-actions.pod:3684
11626 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
11627 "files, where all files are in the directory C<path>. C<names> is the list "
11628 "of files from this directory."
11632 #: ../src/guestfs-actions.pod:3688 ../fish/guestfish-actions.pod:2542
11634 "On return you get a list of stat structs, with a one-to-one correspondence "
11635 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11636 "then the C<ino> field of that structure is set to C<-1>."
11640 #: ../src/guestfs-actions.pod:3693
11642 "This call is intended for programs that want to efficiently list a directory "
11643 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
11644 "for a similarly efficient call for getting extended attributes. Very long "
11645 "directory listings might cause the protocol message size to be exceeded, "
11646 "causing this call to fail. The caller must split up such requests into "
11647 "smaller groups of names."
11651 #: ../src/guestfs-actions.pod:3701
11653 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
11654 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
11658 #: ../src/guestfs-actions.pod:3707
11659 msgid "guestfs_luks_add_key"
11663 #: ../src/guestfs-actions.pod:3709
11667 " guestfs_luks_add_key (guestfs_h *g,\n"
11668 " const char *device,\n"
11669 " const char *key,\n"
11670 " const char *newkey,\n"
11676 #: ../src/guestfs-actions.pod:3716 ../fish/guestfish-actions.pod:2559
11678 "This command adds a new key on LUKS device C<device>. C<key> is any "
11679 "existing key, and is used to access the device. C<newkey> is the new key to "
11680 "add. C<keyslot> is the key slot that will be replaced."
11684 #: ../src/guestfs-actions.pod:3721
11686 "Note that if C<keyslot> already contains a key, then this command will "
11687 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
11691 #: ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3767 ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:3842 ../src/guestfs-actions.pod:3861
11693 "This function takes a key or passphrase parameter which could contain "
11694 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
11699 #: ../src/guestfs-actions.pod:3731 ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:3814
11700 msgid "(Added in 1.5.2)"
11704 #: ../src/guestfs-actions.pod:3733
11705 msgid "guestfs_luks_close"
11709 #: ../src/guestfs-actions.pod:3735
11713 " guestfs_luks_close (guestfs_h *g,\n"
11714 " const char *device);\n"
11719 #: ../src/guestfs-actions.pod:3739
11721 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
11722 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
11723 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
11724 "underlying block device."
11728 #: ../src/guestfs-actions.pod:3747 ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:3865 ../src/guestfs-actions.pod:3915 ../src/guestfs-actions.pod:3963
11729 msgid "(Added in 1.5.1)"
11733 #: ../src/guestfs-actions.pod:3749
11734 msgid "guestfs_luks_format"
11738 #: ../src/guestfs-actions.pod:3751
11742 " guestfs_luks_format (guestfs_h *g,\n"
11743 " const char *device,\n"
11744 " const char *key,\n"
11750 #: ../src/guestfs-actions.pod:3757 ../fish/guestfish-actions.pod:2585
11752 "This command erases existing data on C<device> and formats the device as a "
11753 "LUKS encrypted device. C<key> is the initial key, which is added to key "
11754 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
11758 #: ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:5649 ../src/guestfs-actions.pod:6056 ../src/guestfs-actions.pod:6079 ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:7265 ../fish/guestfish-actions.pod:2593 ../fish/guestfish-actions.pod:2606 ../fish/guestfish-actions.pod:2690 ../fish/guestfish-actions.pod:3264 ../fish/guestfish-actions.pod:3784 ../fish/guestfish-actions.pod:4094 ../fish/guestfish-actions.pod:4110 ../fish/guestfish-actions.pod:4125 ../fish/guestfish-actions.pod:4840
11760 "B<This command is dangerous. Without careful use you can easily destroy all "
11765 #: ../src/guestfs-actions.pod:3773
11766 msgid "guestfs_luks_format_cipher"
11770 #: ../src/guestfs-actions.pod:3775
11774 " guestfs_luks_format_cipher (guestfs_h *g,\n"
11775 " const char *device,\n"
11776 " const char *key,\n"
11778 " const char *cipher);\n"
11783 #: ../src/guestfs-actions.pod:3782
11785 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11786 "set the C<cipher> used."
11790 #: ../src/guestfs-actions.pod:3796
11791 msgid "guestfs_luks_kill_slot"
11795 #: ../src/guestfs-actions.pod:3798
11799 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11800 " const char *device,\n"
11801 " const char *key,\n"
11807 #: ../src/guestfs-actions.pod:3804 ../fish/guestfish-actions.pod:2613
11809 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11810 "device C<device>. C<key> must be one of the I<other> keys."
11814 #: ../src/guestfs-actions.pod:3816
11815 msgid "guestfs_luks_open"
11819 #: ../src/guestfs-actions.pod:3818
11823 " guestfs_luks_open (guestfs_h *g,\n"
11824 " const char *device,\n"
11825 " const char *key,\n"
11826 " const char *mapname);\n"
11831 #: ../src/guestfs-actions.pod:3824 ../fish/guestfish-actions.pod:2624
11833 "This command opens a block device which has been encrypted according to the "
11834 "Linux Unified Key Setup (LUKS) standard."
11838 #: ../src/guestfs-actions.pod:3827 ../fish/guestfish-actions.pod:2627
11839 msgid "C<device> is the encrypted block device or partition."
11843 #: ../src/guestfs-actions.pod:3829 ../fish/guestfish-actions.pod:2629
11845 "The caller must supply one of the keys associated with the LUKS block "
11846 "device, in the C<key> parameter."
11850 #: ../src/guestfs-actions.pod:3832 ../fish/guestfish-actions.pod:2632
11852 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11853 "writes to this block device are decrypted from and encrypted to the "
11854 "underlying C<device> respectively."
11858 #: ../src/guestfs-actions.pod:3836
11860 "If this block device contains LVM volume groups, then calling "
11861 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11866 #: ../src/guestfs-actions.pod:3848
11867 msgid "guestfs_luks_open_ro"
11871 #: ../src/guestfs-actions.pod:3850
11875 " guestfs_luks_open_ro (guestfs_h *g,\n"
11876 " const char *device,\n"
11877 " const char *key,\n"
11878 " const char *mapname);\n"
11883 #: ../src/guestfs-actions.pod:3856
11885 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11890 #: ../src/guestfs-actions.pod:3867
11891 msgid "guestfs_lvcreate"
11895 #: ../src/guestfs-actions.pod:3869
11899 " guestfs_lvcreate (guestfs_h *g,\n"
11900 " const char *logvol,\n"
11901 " const char *volgroup,\n"
11907 #: ../src/guestfs-actions.pod:3875 ../fish/guestfish-actions.pod:2657
11909 "This creates an LVM logical volume called C<logvol> on the volume group "
11910 "C<volgroup>, with C<size> megabytes."
11914 #: ../src/guestfs-actions.pod:3882
11915 msgid "guestfs_lvm_canonical_lv_name"
11919 #: ../src/guestfs-actions.pod:3884
11923 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11924 " const char *lvname);\n"
11929 #: ../src/guestfs-actions.pod:3888 ../fish/guestfish-actions.pod:2664
11931 "This converts alternative naming schemes for LVs that you might find to the "
11932 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11937 #: ../src/guestfs-actions.pod:3892 ../fish/guestfish-actions.pod:2668
11939 "This command returns an error if the C<lvname> parameter does not refer to a "
11944 #: ../src/guestfs-actions.pod:3895
11945 msgid "See also C<guestfs_is_lv>."
11949 #: ../src/guestfs-actions.pod:3900
11950 msgid "(Added in 1.5.24)"
11954 #: ../src/guestfs-actions.pod:3902
11955 msgid "guestfs_lvm_clear_filter"
11959 #: ../src/guestfs-actions.pod:3904
11963 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11968 #: ../src/guestfs-actions.pod:3907
11970 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11971 "see every block device."
11975 #: ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:3952 ../fish/guestfish-actions.pod:2680 ../fish/guestfish-actions.pod:2711
11976 msgid "This command also clears the LVM cache and performs a volume group scan."
11980 #: ../src/guestfs-actions.pod:3917
11981 msgid "guestfs_lvm_remove_all"
11985 #: ../src/guestfs-actions.pod:3919
11989 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11994 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2687
11996 "This command removes all LVM logical volumes, volume groups and physical "
12001 #: ../src/guestfs-actions.pod:3932
12002 msgid "guestfs_lvm_set_filter"
12006 #: ../src/guestfs-actions.pod:3934
12010 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12011 " char *const *devices);\n"
12016 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2697
12018 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12019 "block devices in the list C<devices>, and will ignore all other attached "
12024 #: ../src/guestfs-actions.pod:3942 ../fish/guestfish-actions.pod:2701
12026 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12027 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12028 "there are two types of duplication possible: either cloned PVs/VGs which "
12029 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12030 "same name. In normal operation you cannot create this situation, but you "
12031 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12032 "inside the LVM metadata."
12036 #: ../src/guestfs-actions.pod:3955 ../fish/guestfish-actions.pod:2714
12037 msgid "You can filter whole block devices or individual partitions."
12041 #: ../src/guestfs-actions.pod:3957 ../fish/guestfish-actions.pod:2716
12043 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12044 "filesystem), even if you are not filtering out that VG."
12048 #: ../src/guestfs-actions.pod:3965
12049 msgid "guestfs_lvremove"
12053 #: ../src/guestfs-actions.pod:3967
12057 " guestfs_lvremove (guestfs_h *g,\n"
12058 " const char *device);\n"
12063 #: ../src/guestfs-actions.pod:3971 ../fish/guestfish-actions.pod:2724
12065 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12066 "LV, such as C</dev/VG/LV>."
12070 #: ../src/guestfs-actions.pod:3974 ../fish/guestfish-actions.pod:2727
12072 "You can also remove all LVs in a volume group by specifying the VG name, "
12077 #: ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:7004
12078 msgid "(Added in 1.0.13)"
12082 #: ../src/guestfs-actions.pod:3981
12083 msgid "guestfs_lvrename"
12087 #: ../src/guestfs-actions.pod:3983
12091 " guestfs_lvrename (guestfs_h *g,\n"
12092 " const char *logvol,\n"
12093 " const char *newlogvol);\n"
12098 #: ../src/guestfs-actions.pod:3988 ../fish/guestfish-actions.pod:2734
12099 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12103 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:7017
12104 msgid "(Added in 1.0.83)"
12108 #: ../src/guestfs-actions.pod:3994
12109 msgid "guestfs_lvresize"
12113 #: ../src/guestfs-actions.pod:3996
12117 " guestfs_lvresize (guestfs_h *g,\n"
12118 " const char *device,\n"
12124 #: ../src/guestfs-actions.pod:4001 ../fish/guestfish-actions.pod:2740
12126 "This resizes (expands or shrinks) an existing LVM logical volume to "
12127 "C<mbytes>. When reducing, data in the reduced part is lost."
12131 #: ../src/guestfs-actions.pod:4009
12132 msgid "guestfs_lvresize_free"
12136 #: ../src/guestfs-actions.pod:4011
12140 " guestfs_lvresize_free (guestfs_h *g,\n"
12141 " const char *lv,\n"
12147 #: ../src/guestfs-actions.pod:4016 ../fish/guestfish-actions.pod:2748
12149 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12150 "remaining free space in the volume group. Commonly you would call this with "
12151 "pc = 100 which expands the logical volume as much as possible, using all "
12152 "remaining free space in the volume group."
12156 #: ../src/guestfs-actions.pod:4024
12157 msgid "(Added in 1.3.3)"
12161 #: ../src/guestfs-actions.pod:4026
12162 msgid "guestfs_lvs"
12166 #: ../src/guestfs-actions.pod:4028
12170 " guestfs_lvs (guestfs_h *g);\n"
12175 #: ../src/guestfs-actions.pod:4031 ../fish/guestfish-actions.pod:2758
12177 "List all the logical volumes detected. This is the equivalent of the "
12178 "L<lvs(8)> command."
12182 #: ../src/guestfs-actions.pod:4034 ../fish/guestfish-actions.pod:2761
12184 "This returns a list of the logical volume device names "
12185 "(eg. C</dev/VolGroup00/LogVol00>)."
12189 #: ../src/guestfs-actions.pod:4037
12190 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12194 #: ../src/guestfs-actions.pod:4045
12195 msgid "guestfs_lvs_full"
12199 #: ../src/guestfs-actions.pod:4047
12202 " struct guestfs_lvm_lv_list *\n"
12203 " guestfs_lvs_full (guestfs_h *g);\n"
12208 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2770
12210 "List all the logical volumes detected. This is the equivalent of the "
12211 "L<lvs(8)> command. The \"full\" version includes all fields."
12215 #: ../src/guestfs-actions.pod:4053
12217 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12218 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12223 #: ../src/guestfs-actions.pod:4059
12224 msgid "guestfs_lvuuid"
12228 #: ../src/guestfs-actions.pod:4061
12232 " guestfs_lvuuid (guestfs_h *g,\n"
12233 " const char *device);\n"
12238 #: ../src/guestfs-actions.pod:4065 ../fish/guestfish-actions.pod:2777
12239 msgid "This command returns the UUID of the LVM LV C<device>."
12243 #: ../src/guestfs-actions.pod:4072
12244 msgid "guestfs_lxattrlist"
12248 #: ../src/guestfs-actions.pod:4074
12251 " struct guestfs_xattr_list *\n"
12252 " guestfs_lxattrlist (guestfs_h *g,\n"
12253 " const char *path,\n"
12254 " char *const *names);\n"
12259 #: ../src/guestfs-actions.pod:4079 ../fish/guestfish-actions.pod:2783
12261 "This call allows you to get the extended attributes of multiple files, where "
12262 "all files are in the directory C<path>. C<names> is the list of files from "
12267 #: ../src/guestfs-actions.pod:4083 ../fish/guestfish-actions.pod:2787
12269 "On return you get a flat list of xattr structs which must be interpreted "
12270 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12271 "C<attrval> in this struct is zero-length to indicate there was an error "
12272 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12273 "number (the number of following attributes for this file, which could be "
12274 "C<\"0\">). Then after the first xattr struct are the zero or more "
12275 "attributes for the first named file. This repeats for the second and "
12276 "subsequent files."
12280 #: ../src/guestfs-actions.pod:4093
12282 "This call is intended for programs that want to efficiently list a directory "
12283 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12284 "a similarly efficient call for getting standard stats. Very long directory "
12285 "listings might cause the protocol message size to be exceeded, causing this "
12286 "call to fail. The caller must split up such requests into smaller groups of "
12291 #: ../src/guestfs-actions.pod:4107
12292 msgid "guestfs_mkdir"
12296 #: ../src/guestfs-actions.pod:4109
12300 " guestfs_mkdir (guestfs_h *g,\n"
12301 " const char *path);\n"
12306 #: ../src/guestfs-actions.pod:4113 ../fish/guestfish-actions.pod:2809
12307 msgid "Create a directory named C<path>."
12311 #: ../src/guestfs-actions.pod:4119
12312 msgid "guestfs_mkdir_mode"
12316 #: ../src/guestfs-actions.pod:4121
12320 " guestfs_mkdir_mode (guestfs_h *g,\n"
12321 " const char *path,\n"
12327 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2815
12329 "This command creates a directory, setting the initial permissions of the "
12330 "directory to C<mode>."
12334 #: ../src/guestfs-actions.pod:4129 ../fish/guestfish-actions.pod:2818
12336 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12337 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12342 #: ../src/guestfs-actions.pod:4133
12343 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12347 #: ../src/guestfs-actions.pod:4139
12348 msgid "guestfs_mkdir_p"
12352 #: ../src/guestfs-actions.pod:4141
12356 " guestfs_mkdir_p (guestfs_h *g,\n"
12357 " const char *path);\n"
12362 #: ../src/guestfs-actions.pod:4145 ../fish/guestfish-actions.pod:2828
12364 "Create a directory named C<path>, creating any parent directories as "
12365 "necessary. This is like the C<mkdir -p> shell command."
12369 #: ../src/guestfs-actions.pod:4152
12370 msgid "guestfs_mkdtemp"
12374 #: ../src/guestfs-actions.pod:4154
12378 " guestfs_mkdtemp (guestfs_h *g,\n"
12379 " const char *template);\n"
12384 #: ../src/guestfs-actions.pod:4158 ../fish/guestfish-actions.pod:2835
12386 "This command creates a temporary directory. The C<template> parameter "
12387 "should be a full pathname for the temporary directory name with the final "
12388 "six characters being \"XXXXXX\"."
12392 #: ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:2840
12394 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12395 "being suitable for Windows filesystems."
12399 #: ../src/guestfs-actions.pod:4166 ../fish/guestfish-actions.pod:2843
12400 msgid "The name of the temporary directory that was created is returned."
12404 #: ../src/guestfs-actions.pod:4169 ../fish/guestfish-actions.pod:2846
12405 msgid "The temporary directory is created with mode 0700 and is owned by root."
12409 #: ../src/guestfs-actions.pod:4172 ../fish/guestfish-actions.pod:2849
12411 "The caller is responsible for deleting the temporary directory and its "
12412 "contents after use."
12416 #: ../src/guestfs-actions.pod:4175 ../fish/guestfish-actions.pod:2852
12417 msgid "See also: L<mkdtemp(3)>"
12421 #: ../src/guestfs-actions.pod:4182
12422 msgid "guestfs_mke2fs_J"
12426 #: ../src/guestfs-actions.pod:4184
12430 " guestfs_mke2fs_J (guestfs_h *g,\n"
12431 " const char *fstype,\n"
12432 " int blocksize,\n"
12433 " const char *device,\n"
12434 " const char *journal);\n"
12439 #: ../src/guestfs-actions.pod:4191 ../fish/guestfish-actions.pod:2858
12441 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12442 "C<journal>. It is equivalent to the command:"
12446 #: ../src/guestfs-actions.pod:4195 ../fish/guestfish-actions.pod:2862
12449 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
12454 #: ../src/guestfs-actions.pod:4197
12455 msgid "See also C<guestfs_mke2journal>."
12459 #: ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4219 ../src/guestfs-actions.pod:4237 ../src/guestfs-actions.pod:4253 ../src/guestfs-actions.pod:4267 ../src/guestfs-actions.pod:4281 ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:4605
12460 msgid "(Added in 1.0.68)"
12464 #: ../src/guestfs-actions.pod:4203
12465 msgid "guestfs_mke2fs_JL"
12469 #: ../src/guestfs-actions.pod:4205
12473 " guestfs_mke2fs_JL (guestfs_h *g,\n"
12474 " const char *fstype,\n"
12475 " int blocksize,\n"
12476 " const char *device,\n"
12477 " const char *label);\n"
12482 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2870
12484 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12485 "the journal labeled C<label>."
12489 #: ../src/guestfs-actions.pod:4215
12490 msgid "See also C<guestfs_mke2journal_L>."
12494 #: ../src/guestfs-actions.pod:4221
12495 msgid "guestfs_mke2fs_JU"
12499 #: ../src/guestfs-actions.pod:4223
12503 " guestfs_mke2fs_JU (guestfs_h *g,\n"
12504 " const char *fstype,\n"
12505 " int blocksize,\n"
12506 " const char *device,\n"
12507 " const char *uuid);\n"
12512 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2879
12514 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
12515 "the journal with UUID C<uuid>."
12519 #: ../src/guestfs-actions.pod:4233
12520 msgid "See also C<guestfs_mke2journal_U>."
12524 #: ../src/guestfs-actions.pod:4239
12525 msgid "guestfs_mke2journal"
12529 #: ../src/guestfs-actions.pod:4241
12533 " guestfs_mke2journal (guestfs_h *g,\n"
12534 " int blocksize,\n"
12535 " const char *device);\n"
12540 #: ../src/guestfs-actions.pod:4246 ../fish/guestfish-actions.pod:2888
12542 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12547 #: ../src/guestfs-actions.pod:4249 ../fish/guestfish-actions.pod:2891
12550 " mke2fs -O journal_dev -b blocksize device\n"
12555 #: ../src/guestfs-actions.pod:4255
12556 msgid "guestfs_mke2journal_L"
12560 #: ../src/guestfs-actions.pod:4257
12564 " guestfs_mke2journal_L (guestfs_h *g,\n"
12565 " int blocksize,\n"
12566 " const char *label,\n"
12567 " const char *device);\n"
12572 #: ../src/guestfs-actions.pod:4263 ../fish/guestfish-actions.pod:2897
12573 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12577 #: ../src/guestfs-actions.pod:4269
12578 msgid "guestfs_mke2journal_U"
12582 #: ../src/guestfs-actions.pod:4271
12586 " guestfs_mke2journal_U (guestfs_h *g,\n"
12587 " int blocksize,\n"
12588 " const char *uuid,\n"
12589 " const char *device);\n"
12594 #: ../src/guestfs-actions.pod:4277 ../fish/guestfish-actions.pod:2903
12595 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12599 #: ../src/guestfs-actions.pod:4283
12600 msgid "guestfs_mkfifo"
12604 #: ../src/guestfs-actions.pod:4285
12608 " guestfs_mkfifo (guestfs_h *g,\n"
12610 " const char *path);\n"
12615 #: ../src/guestfs-actions.pod:4290
12617 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12618 "is just a convenient wrapper around C<guestfs_mknod>."
12622 #: ../src/guestfs-actions.pod:4300
12623 msgid "guestfs_mkfs"
12627 #: ../src/guestfs-actions.pod:4302
12631 " guestfs_mkfs (guestfs_h *g,\n"
12632 " const char *fstype,\n"
12633 " const char *device);\n"
12638 #: ../src/guestfs-actions.pod:4307 ../fish/guestfish-actions.pod:2919
12640 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12641 "volume). The filesystem type is C<fstype>, for example C<ext3>."
12645 #: ../src/guestfs-actions.pod:4315
12646 msgid "guestfs_mkfs_b"
12650 #: ../src/guestfs-actions.pod:4317
12654 " guestfs_mkfs_b (guestfs_h *g,\n"
12655 " const char *fstype,\n"
12656 " int blocksize,\n"
12657 " const char *device);\n"
12662 #: ../src/guestfs-actions.pod:4323
12664 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
12665 "block size of the resulting filesystem. Supported block sizes depend on the "
12666 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
12670 #: ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4371 ../fish/guestfish-actions.pod:2932 ../fish/guestfish-actions.pod:2959
12672 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
12677 #: ../src/guestfs-actions.pod:4333 ../fish/guestfish-actions.pod:2935
12679 "This function is deprecated. In new code, use the C<mkfs_opts> call "
12684 #: ../src/guestfs-actions.pod:4342
12685 msgid "guestfs_mkfs_opts"
12689 #: ../src/guestfs-actions.pod:4344
12693 " guestfs_mkfs_opts (guestfs_h *g,\n"
12694 " const char *fstype,\n"
12695 " const char *device,\n"
12701 #: ../src/guestfs-actions.pod:4355
12704 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
12705 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
12710 #: ../src/guestfs-actions.pod:4358 ../fish/guestfish-actions.pod:2946
12712 "This function creates a filesystem on C<device>. The filesystem type is "
12713 "C<fstype>, for example C<ext3>."
12717 #: ../src/guestfs-actions.pod:4365 ../fish/guestfish-actions.pod:2953
12718 msgid "C<blocksize>"
12722 #: ../src/guestfs-actions.pod:4367 ../fish/guestfish-actions.pod:2955
12724 "The filesystem block size. Supported block sizes depend on the filesystem "
12725 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
12730 #: ../src/guestfs-actions.pod:4374 ../fish/guestfish-actions.pod:2962
12731 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
12735 #: ../src/guestfs-actions.pod:4376 ../fish/guestfish-actions.pod:2964
12736 msgid "C<features>"
12740 #: ../src/guestfs-actions.pod:4378 ../fish/guestfish-actions.pod:2966
12741 msgid "This passes the C<-O> parameter to the external mkfs program."
12745 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2968
12747 "For certain filesystem types, this allows extra filesystem features to be "
12748 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
12752 #: ../src/guestfs-actions.pod:4384 ../fish/guestfish-actions.pod:2972
12754 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
12759 #: ../src/guestfs-actions.pod:4391
12760 msgid "(Added in 1.7.19)"
12764 #: ../src/guestfs-actions.pod:4393
12765 msgid "guestfs_mkfs_opts_va"
12769 #: ../src/guestfs-actions.pod:4395
12773 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
12774 " const char *fstype,\n"
12775 " const char *device,\n"
12776 " va_list args);\n"
12781 #: ../src/guestfs-actions.pod:4401
12782 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
12786 #: ../src/guestfs-actions.pod:4405
12787 msgid "guestfs_mkfs_opts_argv"
12791 #: ../src/guestfs-actions.pod:4407
12795 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
12796 " const char *fstype,\n"
12797 " const char *device,\n"
12798 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12803 #: ../src/guestfs-actions.pod:4413
12804 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12808 #: ../src/guestfs-actions.pod:4417
12809 msgid "guestfs_mkmountpoint"
12813 #: ../src/guestfs-actions.pod:4419
12817 " guestfs_mkmountpoint (guestfs_h *g,\n"
12818 " const char *exemptpath);\n"
12823 #: ../src/guestfs-actions.pod:4423
12825 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12826 "that can be used to create extra mountpoints before mounting the first "
12831 #: ../src/guestfs-actions.pod:4427 ../fish/guestfish-actions.pod:2987
12833 "These calls are I<only> necessary in some very limited circumstances, mainly "
12834 "the case where you want to mount a mix of unrelated and/or read-only "
12835 "filesystems together."
12839 #: ../src/guestfs-actions.pod:4431 ../fish/guestfish-actions.pod:2991
12841 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12842 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12843 "inside that. You can unpack this as follows in guestfish:"
12847 #: ../src/guestfs-actions.pod:4436 ../fish/guestfish-actions.pod:2996
12850 " add-ro Fedora-11-i686-Live.iso\n"
12852 " mkmountpoint /cd\n"
12853 " mkmountpoint /sqsh\n"
12854 " mkmountpoint /ext3fs\n"
12855 " mount /dev/sda /cd\n"
12856 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12857 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12862 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:3005
12863 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12867 #: ../src/guestfs-actions.pod:4447
12869 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12870 "may get unexpected errors if you try to mix these calls. It is safest to "
12871 "manually unmount filesystems and remove mountpoints after use."
12875 #: ../src/guestfs-actions.pod:4451
12877 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12878 "first, so for this to work for manual mountpoints, you must ensure that the "
12879 "innermost mountpoints have the longest pathnames, as in the example code "
12884 #: ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:3016
12885 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12889 #: ../src/guestfs-actions.pod:4458
12891 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12892 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
12893 "can also trigger these issues."
12897 #: ../src/guestfs-actions.pod:4464 ../src/guestfs-actions.pod:4723 ../src/guestfs-actions.pod:5633
12898 msgid "(Added in 1.0.62)"
12902 #: ../src/guestfs-actions.pod:4466
12903 msgid "guestfs_mknod"
12907 #: ../src/guestfs-actions.pod:4468
12911 " guestfs_mknod (guestfs_h *g,\n"
12915 " const char *path);\n"
12920 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:3026
12922 "This call creates block or character special devices, or named pipes "
12927 #: ../src/guestfs-actions.pod:4478 ../fish/guestfish-actions.pod:3029
12929 "The C<mode> parameter should be the mode, using the standard constants. "
12930 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12931 "used when creating block and character special devices."
12935 #: ../src/guestfs-actions.pod:4483
12937 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12938 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12939 "regular file). These constants are available in the standard Linux header "
12940 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12941 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12942 "the appropriate constant for you."
12946 #: ../src/guestfs-actions.pod:4497
12947 msgid "guestfs_mknod_b"
12951 #: ../src/guestfs-actions.pod:4499
12955 " guestfs_mknod_b (guestfs_h *g,\n"
12959 " const char *path);\n"
12964 #: ../src/guestfs-actions.pod:4506
12966 "This call creates a block device node called C<path> with mode C<mode> and "
12967 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12968 "wrapper around C<guestfs_mknod>."
12972 #: ../src/guestfs-actions.pod:4516
12973 msgid "guestfs_mknod_c"
12977 #: ../src/guestfs-actions.pod:4518
12981 " guestfs_mknod_c (guestfs_h *g,\n"
12985 " const char *path);\n"
12990 #: ../src/guestfs-actions.pod:4525
12992 "This call creates a char device node called C<path> with mode C<mode> and "
12993 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12994 "wrapper around C<guestfs_mknod>."
12998 #: ../src/guestfs-actions.pod:4535
12999 msgid "guestfs_mkswap"
13003 #: ../src/guestfs-actions.pod:4537
13007 " guestfs_mkswap (guestfs_h *g,\n"
13008 " const char *device);\n"
13013 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3068
13014 msgid "Create a swap partition on C<device>."
13018 #: ../src/guestfs-actions.pod:4547
13019 msgid "guestfs_mkswap_L"
13023 #: ../src/guestfs-actions.pod:4549
13027 " guestfs_mkswap_L (guestfs_h *g,\n"
13028 " const char *label,\n"
13029 " const char *device);\n"
13034 #: ../src/guestfs-actions.pod:4554 ../fish/guestfish-actions.pod:3074
13035 msgid "Create a swap partition on C<device> with label C<label>."
13039 #: ../src/guestfs-actions.pod:4556 ../fish/guestfish-actions.pod:3076
13041 "Note that you cannot attach a swap label to a block device "
13042 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13043 "the kernel or swap tools."
13047 #: ../src/guestfs-actions.pod:4564
13048 msgid "guestfs_mkswap_U"
13052 #: ../src/guestfs-actions.pod:4566
13056 " guestfs_mkswap_U (guestfs_h *g,\n"
13057 " const char *uuid,\n"
13058 " const char *device);\n"
13063 #: ../src/guestfs-actions.pod:4571 ../fish/guestfish-actions.pod:3084
13064 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13068 #: ../src/guestfs-actions.pod:4577
13069 msgid "guestfs_mkswap_file"
13073 #: ../src/guestfs-actions.pod:4579
13077 " guestfs_mkswap_file (guestfs_h *g,\n"
13078 " const char *path);\n"
13083 #: ../src/guestfs-actions.pod:4583 ../fish/guestfish-actions.pod:3090
13084 msgid "Create a swap file."
13088 #: ../src/guestfs-actions.pod:4585
13090 "This command just writes a swap file signature to an existing file. To "
13091 "create the file itself, use something like C<guestfs_fallocate>."
13095 #: ../src/guestfs-actions.pod:4592
13096 msgid "guestfs_modprobe"
13100 #: ../src/guestfs-actions.pod:4594
13104 " guestfs_modprobe (guestfs_h *g,\n"
13105 " const char *modulename);\n"
13110 #: ../src/guestfs-actions.pod:4598 ../fish/guestfish-actions.pod:3099
13111 msgid "This loads a kernel module in the appliance."
13115 #: ../src/guestfs-actions.pod:4600 ../fish/guestfish-actions.pod:3101
13117 "The kernel module must have been whitelisted when libguestfs was built (see "
13118 "C<appliance/kmod.whitelist.in> in the source)."
13122 #: ../src/guestfs-actions.pod:4607
13123 msgid "guestfs_mount"
13127 #: ../src/guestfs-actions.pod:4609
13131 " guestfs_mount (guestfs_h *g,\n"
13132 " const char *device,\n"
13133 " const char *mountpoint);\n"
13138 #: ../src/guestfs-actions.pod:4614 ../fish/guestfish-actions.pod:3108
13140 "Mount a guest disk at a position in the filesystem. Block devices are named "
13141 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13142 "those block devices contain partitions, they will have the usual names "
13143 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13147 #: ../src/guestfs-actions.pod:4620 ../fish/guestfish-actions.pod:3114
13149 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13150 "mounted on C</> before others can be mounted. Other filesystems can only be "
13151 "mounted on directories which already exist."
13155 #: ../src/guestfs-actions.pod:4625 ../fish/guestfish-actions.pod:3119
13157 "The mounted filesystem is writable, if we have sufficient permissions on the "
13158 "underlying device."
13162 #: ../src/guestfs-actions.pod:4628
13164 "B<Important note:> When you use this call, the filesystem options C<sync> "
13165 "and C<noatime> are set implicitly. This was originally done because we "
13166 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13167 "very large negative performance impact and negligible effect on "
13168 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13169 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13170 "(use an empty string for the first parameter if you don't want any options)."
13174 #: ../src/guestfs-actions.pod:4642
13175 msgid "guestfs_mount_loop"
13179 #: ../src/guestfs-actions.pod:4644
13183 " guestfs_mount_loop (guestfs_h *g,\n"
13184 " const char *file,\n"
13185 " const char *mountpoint);\n"
13190 #: ../src/guestfs-actions.pod:4649 ../fish/guestfish-actions.pod:3136
13192 "This command lets you mount C<file> (a filesystem image in a file) on a "
13193 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13198 #: ../src/guestfs-actions.pod:4657
13199 msgid "guestfs_mount_options"
13203 #: ../src/guestfs-actions.pod:4659
13207 " guestfs_mount_options (guestfs_h *g,\n"
13208 " const char *options,\n"
13209 " const char *device,\n"
13210 " const char *mountpoint);\n"
13215 #: ../src/guestfs-actions.pod:4665
13217 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13218 "the mount options as for the L<mount(8)> I<-o> flag."
13222 #: ../src/guestfs-actions.pod:4669 ../fish/guestfish-actions.pod:3148
13224 "If the C<options> parameter is an empty string, then no options are passed "
13225 "(all options default to whatever the filesystem uses)."
13229 #: ../src/guestfs-actions.pod:4675 ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:4706
13230 msgid "(Added in 1.0.10)"
13234 #: ../src/guestfs-actions.pod:4677
13235 msgid "guestfs_mount_ro"
13239 #: ../src/guestfs-actions.pod:4679
13243 " guestfs_mount_ro (guestfs_h *g,\n"
13244 " const char *device,\n"
13245 " const char *mountpoint);\n"
13250 #: ../src/guestfs-actions.pod:4684
13252 "This is the same as the C<guestfs_mount> command, but it mounts the "
13253 "filesystem with the read-only (I<-o ro>) flag."
13257 #: ../src/guestfs-actions.pod:4691
13258 msgid "guestfs_mount_vfs"
13262 #: ../src/guestfs-actions.pod:4693
13266 " guestfs_mount_vfs (guestfs_h *g,\n"
13267 " const char *options,\n"
13268 " const char *vfstype,\n"
13269 " const char *device,\n"
13270 " const char *mountpoint);\n"
13275 #: ../src/guestfs-actions.pod:4700
13277 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13278 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13283 #: ../src/guestfs-actions.pod:4708
13284 msgid "guestfs_mountpoints"
13288 #: ../src/guestfs-actions.pod:4710
13292 " guestfs_mountpoints (guestfs_h *g);\n"
13297 #: ../src/guestfs-actions.pod:4713
13299 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13300 "devices. This one returns a hash table (map) of device name to directory "
13301 "where the device is mounted."
13305 #: ../src/guestfs-actions.pod:4725
13306 msgid "guestfs_mounts"
13310 #: ../src/guestfs-actions.pod:4727
13314 " guestfs_mounts (guestfs_h *g);\n"
13319 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3179
13321 "This returns the list of currently mounted filesystems. It returns the list "
13322 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13326 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3182
13327 msgid "Some internal mounts are not shown."
13331 #: ../src/guestfs-actions.pod:4735
13332 msgid "See also: C<guestfs_mountpoints>"
13336 #: ../src/guestfs-actions.pod:4743
13341 #: ../src/guestfs-actions.pod:4745
13345 " guestfs_mv (guestfs_h *g,\n"
13346 " const char *src,\n"
13347 " const char *dest);\n"
13352 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3190
13354 "This moves a file from C<src> to C<dest> where C<dest> is either a "
13355 "destination filename or destination directory."
13359 #: ../src/guestfs-actions.pod:4757
13360 msgid "guestfs_ntfs_3g_probe"
13364 #: ../src/guestfs-actions.pod:4759
13368 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
13370 " const char *device);\n"
13375 #: ../src/guestfs-actions.pod:4764 ../fish/guestfish-actions.pod:3197
13377 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
13378 "C<device> for mountability. (Not all NTFS volumes can be mounted "
13379 "read-write, and some cannot be mounted at all)."
13383 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3201
13385 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
13386 "can be mounted read-write. Set it to false if you want to test if the "
13387 "volume can be mounted read-only."
13391 #: ../src/guestfs-actions.pod:4772 ../fish/guestfish-actions.pod:3205
13393 "The return value is an integer which C<0> if the operation would succeed, or "
13394 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
13398 #: ../src/guestfs-actions.pod:4778
13399 msgid "(Added in 1.0.43)"
13403 #: ../src/guestfs-actions.pod:4780
13404 msgid "guestfs_ntfsresize"
13408 #: ../src/guestfs-actions.pod:4782
13412 " guestfs_ntfsresize (guestfs_h *g,\n"
13413 " const char *device);\n"
13418 #: ../src/guestfs-actions.pod:4786 ../fish/guestfish-actions.pod:3213
13420 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
13421 "size of the underlying device. See also L<ntfsresize(8)>."
13425 #: ../src/guestfs-actions.pod:4794
13426 msgid "guestfs_ntfsresize_size"
13430 #: ../src/guestfs-actions.pod:4796
13434 " guestfs_ntfsresize_size (guestfs_h *g,\n"
13435 " const char *device,\n"
13436 " int64_t size);\n"
13441 #: ../src/guestfs-actions.pod:4801
13443 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
13444 "to specify the new size (in bytes) explicitly."
13448 #: ../src/guestfs-actions.pod:4806 ../src/guestfs-actions.pod:5242 ../src/guestfs-actions.pod:5315 ../src/guestfs-actions.pod:5581 ../src/guestfs-actions.pod:7152
13449 msgid "(Added in 1.3.14)"
13453 #: ../src/guestfs-actions.pod:4808
13454 msgid "guestfs_part_add"
13458 #: ../src/guestfs-actions.pod:4810
13462 " guestfs_part_add (guestfs_h *g,\n"
13463 " const char *device,\n"
13464 " const char *prlogex,\n"
13465 " int64_t startsect,\n"
13466 " int64_t endsect);\n"
13471 #: ../src/guestfs-actions.pod:4817
13473 "This command adds a partition to C<device>. If there is no partition table "
13474 "on the device, call C<guestfs_part_init> first."
13478 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:3231
13480 "The C<prlogex> parameter is the type of partition. Normally you should pass "
13481 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
13482 "C<logical>) and C<e> (or C<extended>) partition types."
13486 #: ../src/guestfs-actions.pod:4825 ../fish/guestfish-actions.pod:3236
13488 "C<startsect> and C<endsect> are the start and end of the partition in "
13489 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
13490 "from the end of the disk (C<-1> is the last sector)."
13494 #: ../src/guestfs-actions.pod:4829
13496 "Creating a partition which covers the whole disk is not so easy. Use "
13497 "C<guestfs_part_disk> to do that."
13501 #: ../src/guestfs-actions.pod:4834 ../src/guestfs-actions.pod:4872 ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5060 ../src/guestfs-actions.pod:5100
13502 msgid "(Added in 1.0.78)"
13506 #: ../src/guestfs-actions.pod:4836
13507 msgid "guestfs_part_del"
13511 #: ../src/guestfs-actions.pod:4838
13515 " guestfs_part_del (guestfs_h *g,\n"
13516 " const char *device,\n"
13522 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3247
13523 msgid "This command deletes the partition numbered C<partnum> on C<device>."
13527 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3249
13529 "Note that in the case of MBR partitioning, deleting an extended partition "
13530 "also deletes any logical partitions it contains."
13534 #: ../src/guestfs-actions.pod:4853
13535 msgid "guestfs_part_disk"
13539 #: ../src/guestfs-actions.pod:4855
13543 " guestfs_part_disk (guestfs_h *g,\n"
13544 " const char *device,\n"
13545 " const char *parttype);\n"
13550 #: ../src/guestfs-actions.pod:4860
13552 "This command is simply a combination of C<guestfs_part_init> followed by "
13553 "C<guestfs_part_add> to create a single primary partition covering the whole "
13558 #: ../src/guestfs-actions.pod:4864
13560 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
13561 "possible values are described in C<guestfs_part_init>."
13565 #: ../src/guestfs-actions.pod:4874
13566 msgid "guestfs_part_get_bootable"
13570 #: ../src/guestfs-actions.pod:4876
13574 " guestfs_part_get_bootable (guestfs_h *g,\n"
13575 " const char *device,\n"
13581 #: ../src/guestfs-actions.pod:4881 ../fish/guestfish-actions.pod:3271
13583 "This command returns true if the partition C<partnum> on C<device> has the "
13584 "bootable flag set."
13588 #: ../src/guestfs-actions.pod:4884
13589 msgid "See also C<guestfs_part_set_bootable>."
13593 #: ../src/guestfs-actions.pod:4890
13594 msgid "guestfs_part_get_mbr_id"
13598 #: ../src/guestfs-actions.pod:4892
13602 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
13603 " const char *device,\n"
13609 #: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3280
13611 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13612 "partition C<partnum>."
13616 #: ../src/guestfs-actions.pod:4900 ../src/guestfs-actions.pod:5076
13618 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
13619 "undefined results for other partition table types (see "
13620 "C<guestfs_part_get_parttype>)."
13624 #: ../src/guestfs-actions.pod:4908
13625 msgid "guestfs_part_get_parttype"
13629 #: ../src/guestfs-actions.pod:4910
13633 " guestfs_part_get_parttype (guestfs_h *g,\n"
13634 " const char *device);\n"
13639 #: ../src/guestfs-actions.pod:4914 ../fish/guestfish-actions.pod:3291
13641 "This command examines the partition table on C<device> and returns the "
13642 "partition table type (format) being used."
13646 #: ../src/guestfs-actions.pod:4917
13648 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
13649 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
13650 "possible, although unusual. See C<guestfs_part_init> for a full list."
13654 #: ../src/guestfs-actions.pod:4927
13655 msgid "guestfs_part_init"
13659 #: ../src/guestfs-actions.pod:4929
13663 " guestfs_part_init (guestfs_h *g,\n"
13664 " const char *device,\n"
13665 " const char *parttype);\n"
13670 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3303
13672 "This creates an empty partition table on C<device> of one of the partition "
13673 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
13674 "(for large disks)."
13678 #: ../src/guestfs-actions.pod:4938
13680 "Initially there are no partitions. Following this, you should call "
13681 "C<guestfs_part_add> for each partition required."
13685 #: ../src/guestfs-actions.pod:4941 ../fish/guestfish-actions.pod:3310
13686 msgid "Possible values for C<parttype> are:"
13690 #: ../src/guestfs-actions.pod:4945 ../fish/guestfish-actions.pod:3314
13691 msgid "B<efi> | B<gpt>"
13695 #: ../src/guestfs-actions.pod:4947 ../fish/guestfish-actions.pod:3316
13696 msgid "Intel EFI / GPT partition table."
13700 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3318
13702 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
13703 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
13704 "the C<mbr> format."
13708 #: ../src/guestfs-actions.pod:4953 ../fish/guestfish-actions.pod:3322
13709 msgid "B<mbr> | B<msdos>"
13713 #: ../src/guestfs-actions.pod:4955 ../fish/guestfish-actions.pod:3324
13715 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
13716 "Windows. This partition type will B<only> work for device sizes up to 2 "
13717 "TB. For large disks we recommend using C<gpt>."
13721 #: ../src/guestfs-actions.pod:4962 ../fish/guestfish-actions.pod:3331
13722 msgid "Other partition table types that may work but are not supported include:"
13726 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3336
13731 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3338
13732 msgid "AIX disk labels."
13736 #: ../src/guestfs-actions.pod:4971 ../fish/guestfish-actions.pod:3340
13737 msgid "B<amiga> | B<rdb>"
13741 #: ../src/guestfs-actions.pod:4973 ../fish/guestfish-actions.pod:3342
13742 msgid "Amiga \"Rigid Disk Block\" format."
13746 #: ../src/guestfs-actions.pod:4975 ../fish/guestfish-actions.pod:3344
13751 #: ../src/guestfs-actions.pod:4977 ../fish/guestfish-actions.pod:3346
13752 msgid "BSD disk labels."
13756 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3348
13761 #: ../src/guestfs-actions.pod:4981 ../fish/guestfish-actions.pod:3350
13762 msgid "DASD, used on IBM mainframes."
13766 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3352
13771 #: ../src/guestfs-actions.pod:4985 ../fish/guestfish-actions.pod:3354
13772 msgid "MIPS/SGI volumes."
13776 #: ../src/guestfs-actions.pod:4987 ../fish/guestfish-actions.pod:3356
13781 #: ../src/guestfs-actions.pod:4989 ../fish/guestfish-actions.pod:3358
13782 msgid "Old Mac partition format. Modern Macs use C<gpt>."
13786 #: ../src/guestfs-actions.pod:4991 ../fish/guestfish-actions.pod:3360
13791 #: ../src/guestfs-actions.pod:4993 ../fish/guestfish-actions.pod:3362
13792 msgid "NEC PC-98 format, common in Japan apparently."
13796 #: ../src/guestfs-actions.pod:4995 ../fish/guestfish-actions.pod:3364
13801 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3366
13802 msgid "Sun disk labels."
13806 #: ../src/guestfs-actions.pod:5005
13807 msgid "guestfs_part_list"
13811 #: ../src/guestfs-actions.pod:5007
13814 " struct guestfs_partition_list *\n"
13815 " guestfs_part_list (guestfs_h *g,\n"
13816 " const char *device);\n"
13821 #: ../src/guestfs-actions.pod:5011 ../fish/guestfish-actions.pod:3374
13823 "This command parses the partition table on C<device> and returns the list of "
13824 "partitions found."
13828 #: ../src/guestfs-actions.pod:5014 ../fish/guestfish-actions.pod:3377
13829 msgid "The fields in the returned structure are:"
13833 #: ../src/guestfs-actions.pod:5018 ../fish/guestfish-actions.pod:3381
13834 msgid "B<part_num>"
13838 #: ../src/guestfs-actions.pod:5020 ../fish/guestfish-actions.pod:3383
13839 msgid "Partition number, counting from 1."
13843 #: ../src/guestfs-actions.pod:5022 ../fish/guestfish-actions.pod:3385
13844 msgid "B<part_start>"
13848 #: ../src/guestfs-actions.pod:5024
13850 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13851 "the device's sector size, see C<guestfs_blockdev_getss>."
13855 #: ../src/guestfs-actions.pod:5027 ../fish/guestfish-actions.pod:3390
13856 msgid "B<part_end>"
13860 #: ../src/guestfs-actions.pod:5029 ../fish/guestfish-actions.pod:3392
13861 msgid "End of the partition in bytes."
13865 #: ../src/guestfs-actions.pod:5031 ../fish/guestfish-actions.pod:3394
13866 msgid "B<part_size>"
13870 #: ../src/guestfs-actions.pod:5033 ../fish/guestfish-actions.pod:3396
13871 msgid "Size of the partition in bytes."
13875 #: ../src/guestfs-actions.pod:5037
13877 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13878 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13883 #: ../src/guestfs-actions.pod:5043
13884 msgid "guestfs_part_set_bootable"
13888 #: ../src/guestfs-actions.pod:5045
13892 " guestfs_part_set_bootable (guestfs_h *g,\n"
13893 " const char *device,\n"
13895 " int bootable);\n"
13900 #: ../src/guestfs-actions.pod:5051 ../fish/guestfish-actions.pod:3404
13902 "This sets the bootable flag on partition numbered C<partnum> on device "
13903 "C<device>. Note that partitions are numbered from 1."
13907 #: ../src/guestfs-actions.pod:5054 ../fish/guestfish-actions.pod:3407
13909 "The bootable flag is used by some operating systems (notably Windows) to "
13910 "determine which partition to boot from. It is by no means universally "
13915 #: ../src/guestfs-actions.pod:5062
13916 msgid "guestfs_part_set_mbr_id"
13920 #: ../src/guestfs-actions.pod:5064
13924 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13925 " const char *device,\n"
13932 #: ../src/guestfs-actions.pod:5070 ../fish/guestfish-actions.pod:3415
13934 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13935 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13936 "documentation are in fact hexadecimal numbers, but usually documented "
13937 "without any leading \"0x\" which might be confusing."
13941 #: ../src/guestfs-actions.pod:5084
13942 msgid "guestfs_part_set_name"
13946 #: ../src/guestfs-actions.pod:5086
13950 " guestfs_part_set_name (guestfs_h *g,\n"
13951 " const char *device,\n"
13953 " const char *name);\n"
13958 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3429
13960 "This sets the partition name on partition numbered C<partnum> on device "
13961 "C<device>. Note that partitions are numbered from 1."
13965 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3432
13967 "The partition name can only be set on certain types of partition table. "
13968 "This works on C<gpt> but not on C<mbr> partitions."
13972 #: ../src/guestfs-actions.pod:5102
13973 msgid "guestfs_part_to_dev"
13977 #: ../src/guestfs-actions.pod:5104
13981 " guestfs_part_to_dev (guestfs_h *g,\n"
13982 " const char *partition);\n"
13987 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3439
13989 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13990 "partition number, returning the device name (eg. \"/dev/sdb\")."
13994 #: ../src/guestfs-actions.pod:5112
13996 "The named partition must exist, for example as a string returned from "
13997 "C<guestfs_list_partitions>."
14001 #: ../src/guestfs-actions.pod:5120
14002 msgid "guestfs_ping_daemon"
14006 #: ../src/guestfs-actions.pod:5122
14010 " guestfs_ping_daemon (guestfs_h *g);\n"
14015 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3450
14017 "This is a test probe into the guestfs daemon running inside the qemu "
14018 "subprocess. Calling this function checks that the daemon responds to the "
14019 "ping message, without affecting the daemon or attached block device(s) in "
14024 #: ../src/guestfs-actions.pod:5134
14025 msgid "guestfs_pread"
14029 #: ../src/guestfs-actions.pod:5136
14033 " guestfs_pread (guestfs_h *g,\n"
14034 " const char *path,\n"
14036 " int64_t offset,\n"
14037 " size_t *size_r);\n"
14042 #: ../src/guestfs-actions.pod:5143 ../fish/guestfish-actions.pod:3459
14044 "This command lets you read part of a file. It reads C<count> bytes of the "
14045 "file, starting at C<offset>, from file C<path>."
14049 #: ../src/guestfs-actions.pod:5146 ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3462 ../fish/guestfish-actions.pod:3477
14051 "This may read fewer bytes than requested. For further details see the "
14052 "L<pread(2)> system call."
14056 #: ../src/guestfs-actions.pod:5149
14057 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14061 #: ../src/guestfs-actions.pod:5160
14062 msgid "guestfs_pread_device"
14066 #: ../src/guestfs-actions.pod:5162
14070 " guestfs_pread_device (guestfs_h *g,\n"
14071 " const char *device,\n"
14073 " int64_t offset,\n"
14074 " size_t *size_r);\n"
14079 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3474
14081 "This command lets you read part of a file. It reads C<count> bytes of "
14082 "C<device>, starting at C<offset>."
14086 #: ../src/guestfs-actions.pod:5175
14087 msgid "See also C<guestfs_pread>."
14091 #: ../src/guestfs-actions.pod:5184
14092 msgid "(Added in 1.5.21)"
14096 #: ../src/guestfs-actions.pod:5186
14097 msgid "guestfs_pvcreate"
14101 #: ../src/guestfs-actions.pod:5188
14105 " guestfs_pvcreate (guestfs_h *g,\n"
14106 " const char *device);\n"
14111 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3489
14113 "This creates an LVM physical volume on the named C<device>, where C<device> "
14114 "should usually be a partition name such as C</dev/sda1>."
14118 #: ../src/guestfs-actions.pod:5200
14119 msgid "guestfs_pvremove"
14123 #: ../src/guestfs-actions.pod:5202
14127 " guestfs_pvremove (guestfs_h *g,\n"
14128 " const char *device);\n"
14133 #: ../src/guestfs-actions.pod:5206 ../fish/guestfish-actions.pod:3497
14135 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14140 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3500
14142 "The implementation uses the C<pvremove> command which refuses to wipe "
14143 "physical volumes that contain any volume groups, so you have to remove those "
14148 #: ../src/guestfs-actions.pod:5217
14149 msgid "guestfs_pvresize"
14153 #: ../src/guestfs-actions.pod:5219
14157 " guestfs_pvresize (guestfs_h *g,\n"
14158 " const char *device);\n"
14163 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3508
14165 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14166 "the new size of the underlying device."
14170 #: ../src/guestfs-actions.pod:5230
14171 msgid "guestfs_pvresize_size"
14175 #: ../src/guestfs-actions.pod:5232
14179 " guestfs_pvresize_size (guestfs_h *g,\n"
14180 " const char *device,\n"
14181 " int64_t size);\n"
14186 #: ../src/guestfs-actions.pod:5237
14188 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14189 "specify the new size (in bytes) explicitly."
14193 #: ../src/guestfs-actions.pod:5244
14194 msgid "guestfs_pvs"
14198 #: ../src/guestfs-actions.pod:5246
14202 " guestfs_pvs (guestfs_h *g);\n"
14207 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3522
14209 "List all the physical volumes detected. This is the equivalent of the "
14210 "L<pvs(8)> command."
14214 #: ../src/guestfs-actions.pod:5252 ../fish/guestfish-actions.pod:3525
14216 "This returns a list of just the device names that contain PVs "
14217 "(eg. C</dev/sda2>)."
14221 #: ../src/guestfs-actions.pod:5255
14222 msgid "See also C<guestfs_pvs_full>."
14226 #: ../src/guestfs-actions.pod:5263
14227 msgid "guestfs_pvs_full"
14231 #: ../src/guestfs-actions.pod:5265
14234 " struct guestfs_lvm_pv_list *\n"
14235 " guestfs_pvs_full (guestfs_h *g);\n"
14240 #: ../src/guestfs-actions.pod:5268 ../fish/guestfish-actions.pod:3534
14242 "List all the physical volumes detected. This is the equivalent of the "
14243 "L<pvs(8)> command. The \"full\" version includes all fields."
14247 #: ../src/guestfs-actions.pod:5271
14249 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14250 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14255 #: ../src/guestfs-actions.pod:5277
14256 msgid "guestfs_pvuuid"
14260 #: ../src/guestfs-actions.pod:5279
14264 " guestfs_pvuuid (guestfs_h *g,\n"
14265 " const char *device);\n"
14270 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3541
14271 msgid "This command returns the UUID of the LVM PV C<device>."
14275 #: ../src/guestfs-actions.pod:5290
14276 msgid "guestfs_pwrite"
14280 #: ../src/guestfs-actions.pod:5292
14284 " guestfs_pwrite (guestfs_h *g,\n"
14285 " const char *path,\n"
14286 " const char *content,\n"
14287 " size_t content_size,\n"
14288 " int64_t offset);\n"
14293 #: ../src/guestfs-actions.pod:5299 ../fish/guestfish-actions.pod:3547
14295 "This command writes to part of a file. It writes the data buffer C<content> "
14296 "to the file C<path> starting at offset C<offset>."
14300 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3550
14302 "This command implements the L<pwrite(2)> system call, and like that system "
14303 "call it may not write the full data requested. The return value is the "
14304 "number of bytes that were actually written to the file. This could even be "
14305 "0, although short writes are unlikely for regular files in ordinary "
14310 #: ../src/guestfs-actions.pod:5308
14311 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14315 #: ../src/guestfs-actions.pod:5317
14316 msgid "guestfs_pwrite_device"
14320 #: ../src/guestfs-actions.pod:5319
14324 " guestfs_pwrite_device (guestfs_h *g,\n"
14325 " const char *device,\n"
14326 " const char *content,\n"
14327 " size_t content_size,\n"
14328 " int64_t offset);\n"
14333 #: ../src/guestfs-actions.pod:5326 ../fish/guestfish-actions.pod:3565
14335 "This command writes to part of a device. It writes the data buffer "
14336 "C<content> to C<device> starting at offset C<offset>."
14340 #: ../src/guestfs-actions.pod:5329 ../fish/guestfish-actions.pod:3568
14342 "This command implements the L<pwrite(2)> system call, and like that system "
14343 "call it may not write the full data requested (although short writes to disk "
14344 "devices and partitions are probably impossible with standard Linux kernels)."
14348 #: ../src/guestfs-actions.pod:5334
14349 msgid "See also C<guestfs_pwrite>."
14353 #: ../src/guestfs-actions.pod:5341
14354 msgid "(Added in 1.5.20)"
14358 #: ../src/guestfs-actions.pod:5343
14359 msgid "guestfs_read_file"
14363 #: ../src/guestfs-actions.pod:5345
14367 " guestfs_read_file (guestfs_h *g,\n"
14368 " const char *path,\n"
14369 " size_t *size_r);\n"
14374 #: ../src/guestfs-actions.pod:5350 ../fish/guestfish-actions.pod:3582
14375 msgid "This calls returns the contents of the file C<path> as a buffer."
14379 #: ../src/guestfs-actions.pod:5353
14381 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
14382 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
14383 "function is limited in the total size of file that can be handled."
14387 #: ../src/guestfs-actions.pod:5365
14388 msgid "(Added in 1.0.63)"
14392 #: ../src/guestfs-actions.pod:5367
14393 msgid "guestfs_read_lines"
14397 #: ../src/guestfs-actions.pod:5369
14401 " guestfs_read_lines (guestfs_h *g,\n"
14402 " const char *path);\n"
14407 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3599
14409 "The file contents are returned as a list of lines. Trailing C<LF> and "
14410 "C<CRLF> character sequences are I<not> returned."
14414 #: ../src/guestfs-actions.pod:5378
14416 "Note that this function cannot correctly handle binary files (specifically, "
14417 "files containing C<\\0> character which is treated as end of line). For "
14418 "those you need to use the C<guestfs_read_file> function which has a more "
14419 "complex interface."
14423 #: ../src/guestfs-actions.pod:5389
14424 msgid "guestfs_readdir"
14428 #: ../src/guestfs-actions.pod:5391
14431 " struct guestfs_dirent_list *\n"
14432 " guestfs_readdir (guestfs_h *g,\n"
14433 " const char *dir);\n"
14438 #: ../src/guestfs-actions.pod:5395 ../fish/guestfish-actions.pod:3611
14439 msgid "This returns the list of directory entries in directory C<dir>."
14443 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3613
14445 "All entries in the directory are returned, including C<.> and C<..>. The "
14446 "entries are I<not> sorted, but returned in the same order as the underlying "
14451 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3617
14453 "Also this call returns basic file type information about each file. The "
14454 "C<ftyp> field will contain one of the following characters:"
14458 #: ../src/guestfs-actions.pod:5406 ../fish/guestfish-actions.pod:3622
14463 #: ../src/guestfs-actions.pod:5408 ../fish/guestfish-actions.pod:3624
14464 msgid "Block special"
14468 #: ../src/guestfs-actions.pod:5410 ../fish/guestfish-actions.pod:3626
14473 #: ../src/guestfs-actions.pod:5412 ../fish/guestfish-actions.pod:3628
14474 msgid "Char special"
14478 #: ../src/guestfs-actions.pod:5414 ../fish/guestfish-actions.pod:3630
14483 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3632
14488 #: ../src/guestfs-actions.pod:5418 ../fish/guestfish-actions.pod:3634
14493 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3636
14494 msgid "FIFO (named pipe)"
14498 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3638
14503 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3640
14504 msgid "Symbolic link"
14508 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3642
14513 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3644
14514 msgid "Regular file"
14518 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3646
14523 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3648
14528 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3650
14533 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3652
14534 msgid "Unknown file type"
14538 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3654
14543 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3656
14544 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
14548 #: ../src/guestfs-actions.pod:5445
14550 "This function is primarily intended for use by programs. To get a simple "
14551 "list of names, use C<guestfs_ls>. To get a printable directory for human "
14552 "consumption, use C<guestfs_ll>."
14556 #: ../src/guestfs-actions.pod:5449
14558 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
14559 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
14564 #: ../src/guestfs-actions.pod:5455
14565 msgid "guestfs_readlink"
14569 #: ../src/guestfs-actions.pod:5457
14573 " guestfs_readlink (guestfs_h *g,\n"
14574 " const char *path);\n"
14579 #: ../src/guestfs-actions.pod:5461 ../fish/guestfish-actions.pod:3669
14580 msgid "This command reads the target of a symbolic link."
14584 #: ../src/guestfs-actions.pod:5468
14585 msgid "guestfs_readlinklist"
14589 #: ../src/guestfs-actions.pod:5470
14593 " guestfs_readlinklist (guestfs_h *g,\n"
14594 " const char *path,\n"
14595 " char *const *names);\n"
14600 #: ../src/guestfs-actions.pod:5475 ../fish/guestfish-actions.pod:3675
14602 "This call allows you to do a C<readlink> operation on multiple files, where "
14603 "all files are in the directory C<path>. C<names> is the list of files from "
14608 #: ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:3679
14610 "On return you get a list of strings, with a one-to-one correspondence to the "
14611 "C<names> list. Each string is the value of the symbolic link."
14615 #: ../src/guestfs-actions.pod:5483 ../fish/guestfish-actions.pod:3683
14617 "If the C<readlink(2)> operation fails on any name, then the corresponding "
14618 "result string is the empty string C<\"\">. However the whole operation is "
14619 "completed even if there were C<readlink(2)> errors, and so you can call this "
14620 "function with names where you don't know if they are symbolic links already "
14621 "(albeit slightly less efficient)."
14625 #: ../src/guestfs-actions.pod:5490 ../fish/guestfish-actions.pod:3690
14627 "This call is intended for programs that want to efficiently list a directory "
14628 "contents without making many round-trips. Very long directory listings "
14629 "might cause the protocol message size to be exceeded, causing this call to "
14630 "fail. The caller must split up such requests into smaller groups of names."
14634 #: ../src/guestfs-actions.pod:5503
14635 msgid "guestfs_realpath"
14639 #: ../src/guestfs-actions.pod:5505
14643 " guestfs_realpath (guestfs_h *g,\n"
14644 " const char *path);\n"
14649 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3701
14651 "Return the canonicalized absolute pathname of C<path>. The returned path "
14652 "has no C<.>, C<..> or symbolic link path elements."
14656 #: ../src/guestfs-actions.pod:5517
14657 msgid "guestfs_removexattr"
14661 #: ../src/guestfs-actions.pod:5519
14665 " guestfs_removexattr (guestfs_h *g,\n"
14666 " const char *xattr,\n"
14667 " const char *path);\n"
14672 #: ../src/guestfs-actions.pod:5524 ../fish/guestfish-actions.pod:3708
14673 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
14677 #: ../src/guestfs-actions.pod:5527
14678 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
14682 #: ../src/guestfs-actions.pod:5533
14683 msgid "guestfs_resize2fs"
14687 #: ../src/guestfs-actions.pod:5535
14691 " guestfs_resize2fs (guestfs_h *g,\n"
14692 " const char *device);\n"
14697 #: ../src/guestfs-actions.pod:5539 ../fish/guestfish-actions.pod:3717
14699 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
14700 "underlying device."
14704 #: ../src/guestfs-actions.pod:5542
14706 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
14707 "C<device> before calling this command. For unknown reasons C<resize2fs> "
14708 "sometimes gives an error about this and sometimes not. In any case, it is "
14709 "always safe to call C<guestfs_e2fsck_f> before calling this function."
14713 #: ../src/guestfs-actions.pod:5552
14714 msgid "guestfs_resize2fs_M"
14718 #: ../src/guestfs-actions.pod:5554
14722 " guestfs_resize2fs_M (guestfs_h *g,\n"
14723 " const char *device);\n"
14728 #: ../src/guestfs-actions.pod:5558
14730 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
14731 "resized to its minimum size. This works like the C<-M> option to the "
14732 "C<resize2fs> command."
14736 #: ../src/guestfs-actions.pod:5562
14738 "To get the resulting size of the filesystem you should call "
14739 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
14740 "These two numbers, multiplied together, give the resulting size of the "
14741 "minimal filesystem in bytes."
14745 #: ../src/guestfs-actions.pod:5569
14746 msgid "guestfs_resize2fs_size"
14750 #: ../src/guestfs-actions.pod:5571
14754 " guestfs_resize2fs_size (guestfs_h *g,\n"
14755 " const char *device,\n"
14756 " int64_t size);\n"
14761 #: ../src/guestfs-actions.pod:5576
14763 "This command is the same as C<guestfs_resize2fs> except that it allows you "
14764 "to specify the new size (in bytes) explicitly."
14768 #: ../src/guestfs-actions.pod:5583
14773 #: ../src/guestfs-actions.pod:5585
14777 " guestfs_rm (guestfs_h *g,\n"
14778 " const char *path);\n"
14783 #: ../src/guestfs-actions.pod:5589 ../fish/guestfish-actions.pod:3750
14784 msgid "Remove the single file C<path>."
14788 #: ../src/guestfs-actions.pod:5595
14789 msgid "guestfs_rm_rf"
14793 #: ../src/guestfs-actions.pod:5597
14797 " guestfs_rm_rf (guestfs_h *g,\n"
14798 " const char *path);\n"
14803 #: ../src/guestfs-actions.pod:5601 ../fish/guestfish-actions.pod:3756
14805 "Remove the file or directory C<path>, recursively removing the contents if "
14806 "its a directory. This is like the C<rm -rf> shell command."
14810 #: ../src/guestfs-actions.pod:5609
14811 msgid "guestfs_rmdir"
14815 #: ../src/guestfs-actions.pod:5611
14819 " guestfs_rmdir (guestfs_h *g,\n"
14820 " const char *path);\n"
14825 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3764
14826 msgid "Remove the single directory C<path>."
14830 #: ../src/guestfs-actions.pod:5621
14831 msgid "guestfs_rmmountpoint"
14835 #: ../src/guestfs-actions.pod:5623
14839 " guestfs_rmmountpoint (guestfs_h *g,\n"
14840 " const char *exemptpath);\n"
14845 #: ../src/guestfs-actions.pod:5627
14847 "This calls removes a mountpoint that was previously created with "
14848 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14852 #: ../src/guestfs-actions.pod:5635
14853 msgid "guestfs_scrub_device"
14857 #: ../src/guestfs-actions.pod:5637
14861 " guestfs_scrub_device (guestfs_h *g,\n"
14862 " const char *device);\n"
14867 #: ../src/guestfs-actions.pod:5641 ../fish/guestfish-actions.pod:3778
14869 "This command writes patterns over C<device> to make data retrieval more "
14874 #: ../src/guestfs-actions.pod:5644 ../src/guestfs-actions.pod:5665 ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3781 ../fish/guestfish-actions.pod:3796 ../fish/guestfish-actions.pod:3809
14876 "It is an interface to the L<scrub(1)> program. See that manual page for "
14881 #: ../src/guestfs-actions.pod:5652 ../src/guestfs-actions.pod:5670 ../src/guestfs-actions.pod:5689
14882 msgid "(Added in 1.0.52)"
14886 #: ../src/guestfs-actions.pod:5654
14887 msgid "guestfs_scrub_file"
14891 #: ../src/guestfs-actions.pod:5656
14895 " guestfs_scrub_file (guestfs_h *g,\n"
14896 " const char *file);\n"
14901 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3791
14903 "This command writes patterns over a file to make data retrieval more "
14908 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3794
14909 msgid "The file is I<removed> after scrubbing."
14913 #: ../src/guestfs-actions.pod:5672
14914 msgid "guestfs_scrub_freespace"
14918 #: ../src/guestfs-actions.pod:5674
14922 " guestfs_scrub_freespace (guestfs_h *g,\n"
14923 " const char *dir);\n"
14928 #: ../src/guestfs-actions.pod:5678
14930 "This command creates the directory C<dir> and then fills it with files until "
14931 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14932 "and deletes them. The intention is to scrub any free space on the partition "
14933 "containing C<dir>."
14937 #: ../src/guestfs-actions.pod:5691
14938 msgid "guestfs_set_append"
14942 #: ../src/guestfs-actions.pod:5693
14946 " guestfs_set_append (guestfs_h *g,\n"
14947 " const char *append);\n"
14952 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3818
14954 "This function is used to add additional options to the guest kernel command "
14959 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3821
14961 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14962 "environment variable."
14966 #: ../src/guestfs-actions.pod:5703 ../fish/guestfish-actions.pod:3824
14968 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14969 "(libguestfs always adds a few of its own)."
14973 #: ../src/guestfs-actions.pod:5710
14974 msgid "guestfs_set_attach_method"
14978 #: ../src/guestfs-actions.pod:5712
14982 " guestfs_set_attach_method (guestfs_h *g,\n"
14983 " const char *attachmethod);\n"
14988 #: ../src/guestfs-actions.pod:5716 ../fish/guestfish-actions.pod:3833
14990 "Set the method that libguestfs uses to connect to the back end guestfsd "
14991 "daemon. Possible methods are:"
14995 #: ../src/guestfs-actions.pod:5723 ../fish/guestfish-actions.pod:3840
14997 "Launch an appliance and connect to it. This is the ordinary method and the "
15002 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3843
15003 msgid "C<unix:I<path>>"
15007 #: ../src/guestfs-actions.pod:5728 ../fish/guestfish-actions.pod:3845
15008 msgid "Connect to the Unix domain socket I<path>."
15012 #: ../src/guestfs-actions.pod:5730 ../fish/guestfish-actions.pod:3847
15014 "This method lets you connect to an existing daemon or (using virtio-serial) "
15015 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15016 "RUNNING DAEMONS>."
15020 #: ../src/guestfs-actions.pod:5738
15021 msgid "guestfs_set_autosync"
15025 #: ../src/guestfs-actions.pod:5740
15029 " guestfs_set_autosync (guestfs_h *g,\n"
15030 " int autosync);\n"
15035 #: ../src/guestfs-actions.pod:5744 ../fish/guestfish-actions.pod:3859
15037 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15038 "effort attempt to make filesystems consistent and synchronized when the "
15039 "handle is closed (also if the program exits without closing handles)."
15043 #: ../src/guestfs-actions.pod:5749 ../fish/guestfish-actions.pod:3864
15045 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15046 "disabled by default)."
15050 #: ../src/guestfs-actions.pod:5756
15051 msgid "guestfs_set_direct"
15055 #: ../src/guestfs-actions.pod:5758
15059 " guestfs_set_direct (guestfs_h *g,\n"
15065 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3873
15067 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15068 "passed directly through to the appliance once it is launched."
15072 #: ../src/guestfs-actions.pod:5766
15074 "One consequence of this is that log messages aren't caught by the library "
15075 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15080 #: ../src/guestfs-actions.pod:5770 ../fish/guestfish-actions.pod:3881
15081 msgid "You probably don't want to use this unless you know what you are doing."
15085 #: ../src/guestfs-actions.pod:5773 ../fish/guestfish-actions.pod:3884
15086 msgid "The default is disabled."
15090 #: ../src/guestfs-actions.pod:5779
15091 msgid "guestfs_set_e2label"
15095 #: ../src/guestfs-actions.pod:5781
15099 " guestfs_set_e2label (guestfs_h *g,\n"
15100 " const char *device,\n"
15101 " const char *label);\n"
15106 #: ../src/guestfs-actions.pod:5786 ../fish/guestfish-actions.pod:3890
15108 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15109 "C<label>. Filesystem labels are limited to 16 characters."
15113 #: ../src/guestfs-actions.pod:5790
15115 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15116 "the existing label on a filesystem."
15120 #: ../src/guestfs-actions.pod:5797
15121 msgid "guestfs_set_e2uuid"
15125 #: ../src/guestfs-actions.pod:5799
15129 " guestfs_set_e2uuid (guestfs_h *g,\n"
15130 " const char *device,\n"
15131 " const char *uuid);\n"
15136 #: ../src/guestfs-actions.pod:5804 ../fish/guestfish-actions.pod:3901
15138 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15139 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15140 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15144 #: ../src/guestfs-actions.pod:5809
15146 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15147 "the existing UUID of a filesystem."
15151 #: ../src/guestfs-actions.pod:5816
15152 msgid "guestfs_set_memsize"
15156 #: ../src/guestfs-actions.pod:5818
15160 " guestfs_set_memsize (guestfs_h *g,\n"
15166 #: ../src/guestfs-actions.pod:5822
15168 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15169 "This only has any effect if called before C<guestfs_launch>."
15173 #: ../src/guestfs-actions.pod:5826 ../fish/guestfish-actions.pod:3919
15175 "You can also change this by setting the environment variable "
15176 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15180 #: ../src/guestfs-actions.pod:5837
15181 msgid "guestfs_set_network"
15185 #: ../src/guestfs-actions.pod:5839
15189 " guestfs_set_network (guestfs_h *g,\n"
15195 #: ../src/guestfs-actions.pod:5843 ../fish/guestfish-actions.pod:3932
15197 "If C<network> is true, then the network is enabled in the libguestfs "
15198 "appliance. The default is false."
15202 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3935
15204 "This affects whether commands are able to access the network (see "
15205 "L<guestfs(3)/RUNNING COMMANDS>)."
15209 #: ../src/guestfs-actions.pod:5849
15211 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15216 #: ../src/guestfs-actions.pod:5856
15217 msgid "guestfs_set_path"
15221 #: ../src/guestfs-actions.pod:5858
15225 " guestfs_set_path (guestfs_h *g,\n"
15226 " const char *searchpath);\n"
15231 #: ../src/guestfs-actions.pod:5862 ../fish/guestfish-actions.pod:3947
15232 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15236 #: ../src/guestfs-actions.pod:5864 ../fish/guestfish-actions.pod:3949
15238 "The default is C<$libdir/guestfs> unless overridden by setting "
15239 "C<LIBGUESTFS_PATH> environment variable."
15243 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3952
15244 msgid "Setting C<path> to C<NULL> restores the default path."
15248 #: ../src/guestfs-actions.pod:5873
15249 msgid "guestfs_set_qemu"
15253 #: ../src/guestfs-actions.pod:5875
15257 " guestfs_set_qemu (guestfs_h *g,\n"
15258 " const char *qemu);\n"
15263 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3960
15264 msgid "Set the qemu binary that we will use."
15268 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3962
15269 msgid "The default is chosen when the library was compiled by the configure script."
15273 #: ../src/guestfs-actions.pod:5884 ../fish/guestfish-actions.pod:3965
15275 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15280 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3968
15281 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15285 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3970
15287 "Note that you should call this function as early as possible after creating "
15288 "the handle. This is because some pre-launch operations depend on testing "
15289 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15290 "don't retest features, and so you might see inconsistent results. Using the "
15291 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15292 "the qemu binary at the same time as the handle is created."
15296 #: ../src/guestfs-actions.pod:5901
15297 msgid "guestfs_set_recovery_proc"
15301 #: ../src/guestfs-actions.pod:5903
15305 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15306 " int recoveryproc);\n"
15311 #: ../src/guestfs-actions.pod:5907
15313 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15314 "not create a recovery process. The purpose of the recovery process is to "
15315 "stop runaway qemu processes in the case where the main program aborts "
15320 #: ../src/guestfs-actions.pod:5912
15322 "This only has any effect if called before C<guestfs_launch>, and the default "
15327 #: ../src/guestfs-actions.pod:5915 ../fish/guestfish-actions.pod:3992
15329 "About the only time when you would want to disable this is if the main "
15330 "process will fork itself into the background (\"daemonize\" itself). In "
15331 "this case the recovery process thinks that the main program has disappeared "
15332 "and so kills qemu, which is not very helpful."
15336 #: ../src/guestfs-actions.pod:5925
15337 msgid "guestfs_set_selinux"
15341 #: ../src/guestfs-actions.pod:5927
15345 " guestfs_set_selinux (guestfs_h *g,\n"
15351 #: ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:4004
15353 "This sets the selinux flag that is passed to the appliance at boot time. "
15354 "The default is C<selinux=0> (disabled)."
15358 #: ../src/guestfs-actions.pod:5934 ../fish/guestfish-actions.pod:4007
15360 "Note that if SELinux is enabled, it is always in Permissive mode "
15361 "(C<enforcing=0>)."
15365 #: ../src/guestfs-actions.pod:5944
15366 msgid "guestfs_set_trace"
15370 #: ../src/guestfs-actions.pod:5946
15374 " guestfs_set_trace (guestfs_h *g,\n"
15380 #: ../src/guestfs-actions.pod:5950 ../fish/guestfish-actions.pod:4019
15382 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
15383 "return values are traced."
15387 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:4022
15389 "If you want to trace C API calls into libguestfs (and other libraries) then "
15390 "possibly a better way is to use the external ltrace(1) command."
15394 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4026
15396 "Command traces are disabled unless the environment variable "
15397 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
15401 #: ../src/guestfs-actions.pod:5960
15403 "Trace messages are normally sent to C<stderr>, unless you register a "
15404 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15408 #: ../src/guestfs-actions.pod:5968
15409 msgid "guestfs_set_verbose"
15413 #: ../src/guestfs-actions.pod:5970
15417 " guestfs_set_verbose (guestfs_h *g,\n"
15423 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:4039
15424 msgid "If C<verbose> is true, this turns on verbose messages."
15428 #: ../src/guestfs-actions.pod:5976 ../fish/guestfish-actions.pod:4041
15430 "Verbose messages are disabled unless the environment variable "
15431 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
15435 #: ../src/guestfs-actions.pod:5979
15437 "Verbose messages are normally sent to C<stderr>, unless you register a "
15438 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
15442 #: ../src/guestfs-actions.pod:5987
15443 msgid "guestfs_setcon"
15447 #: ../src/guestfs-actions.pod:5989
15451 " guestfs_setcon (guestfs_h *g,\n"
15452 " const char *context);\n"
15457 #: ../src/guestfs-actions.pod:5993 ../fish/guestfish-actions.pod:4052
15459 "This sets the SELinux security context of the daemon to the string "
15464 #: ../src/guestfs-actions.pod:5996 ../fish/guestfish-actions.pod:4055
15465 msgid "See the documentation about SELINUX in L<guestfs(3)>."
15469 #: ../src/guestfs-actions.pod:6002
15470 msgid "guestfs_setxattr"
15474 #: ../src/guestfs-actions.pod:6004
15478 " guestfs_setxattr (guestfs_h *g,\n"
15479 " const char *xattr,\n"
15480 " const char *val,\n"
15482 " const char *path);\n"
15487 #: ../src/guestfs-actions.pod:6011 ../fish/guestfish-actions.pod:4061
15489 "This call sets the extended attribute named C<xattr> of the file C<path> to "
15490 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
15494 #: ../src/guestfs-actions.pod:6015
15495 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
15499 #: ../src/guestfs-actions.pod:6021
15500 msgid "guestfs_sfdisk"
15504 #: ../src/guestfs-actions.pod:6023
15508 " guestfs_sfdisk (guestfs_h *g,\n"
15509 " const char *device,\n"
15513 " char *const *lines);\n"
15518 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:4071
15520 "This is a direct interface to the L<sfdisk(8)> program for creating "
15521 "partitions on block devices."
15525 #: ../src/guestfs-actions.pod:6034 ../fish/guestfish-actions.pod:4074
15526 msgid "C<device> should be a block device, for example C</dev/sda>."
15530 #: ../src/guestfs-actions.pod:6036 ../fish/guestfish-actions.pod:4076
15532 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
15533 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
15534 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
15535 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
15536 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
15537 "the kernel) cannot work out the right geometry and you will need to tell it."
15541 #: ../src/guestfs-actions.pod:6044 ../fish/guestfish-actions.pod:4084
15543 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
15544 "refer to the L<sfdisk(8)> manpage."
15548 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4087
15550 "To create a single partition occupying the whole disk, you would pass "
15551 "C<lines> as a single element list, when the single element being the string "
15556 #: ../src/guestfs-actions.pod:6051
15557 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
15561 #: ../src/guestfs-actions.pod:6061
15562 msgid "guestfs_sfdiskM"
15566 #: ../src/guestfs-actions.pod:6063
15570 " guestfs_sfdiskM (guestfs_h *g,\n"
15571 " const char *device,\n"
15572 " char *const *lines);\n"
15577 #: ../src/guestfs-actions.pod:6068
15579 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
15580 "partition sizes are specified in megabytes only (rounded to the nearest "
15581 "cylinder) and you don't need to specify the cyls, heads and sectors "
15582 "parameters which were rarely if ever used anyway."
15586 #: ../src/guestfs-actions.pod:6074
15588 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
15589 "C<guestfs_part_disk>"
15593 #: ../src/guestfs-actions.pod:6084
15594 msgid "guestfs_sfdisk_N"
15598 #: ../src/guestfs-actions.pod:6086
15602 " guestfs_sfdisk_N (guestfs_h *g,\n"
15603 " const char *device,\n"
15608 " const char *line);\n"
15613 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4117
15615 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15616 "(note: C<n> counts from 1)."
15620 #: ../src/guestfs-actions.pod:6098
15622 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
15623 "for the cyls/heads/sectors parameters."
15627 #: ../src/guestfs-actions.pod:6101
15628 msgid "See also: C<guestfs_part_add>"
15632 #: ../src/guestfs-actions.pod:6110
15633 msgid "guestfs_sfdisk_disk_geometry"
15637 #: ../src/guestfs-actions.pod:6112
15641 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
15642 " const char *device);\n"
15647 #: ../src/guestfs-actions.pod:6116
15649 "This displays the disk geometry of C<device> read from the partition table. "
15650 "Especially in the case where the underlying block device has been resized, "
15651 "this can be different from the kernel's idea of the geometry (see "
15652 "C<guestfs_sfdisk_kernel_geometry>)."
15656 #: ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4137 ../fish/guestfish-actions.pod:4146
15657 msgid "The result is in human-readable format, and not designed to be parsed."
15661 #: ../src/guestfs-actions.pod:6129
15662 msgid "guestfs_sfdisk_kernel_geometry"
15666 #: ../src/guestfs-actions.pod:6131
15670 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
15671 " const char *device);\n"
15676 #: ../src/guestfs-actions.pod:6135 ../fish/guestfish-actions.pod:4144
15677 msgid "This displays the kernel's idea of the geometry of C<device>."
15681 #: ../src/guestfs-actions.pod:6145
15682 msgid "guestfs_sfdisk_l"
15686 #: ../src/guestfs-actions.pod:6147
15690 " guestfs_sfdisk_l (guestfs_h *g,\n"
15691 " const char *device);\n"
15696 #: ../src/guestfs-actions.pod:6151 ../fish/guestfish-actions.pod:4153
15698 "This displays the partition table on C<device>, in the human-readable output "
15699 "of the L<sfdisk(8)> command. It is not intended to be parsed."
15703 #: ../src/guestfs-actions.pod:6155
15704 msgid "See also: C<guestfs_part_list>"
15708 #: ../src/guestfs-actions.pod:6162
15713 #: ../src/guestfs-actions.pod:6164
15717 " guestfs_sh (guestfs_h *g,\n"
15718 " const char *command);\n"
15723 #: ../src/guestfs-actions.pod:6168 ../fish/guestfish-actions.pod:4163
15725 "This call runs a command from the guest filesystem via the guest's "
15730 #: ../src/guestfs-actions.pod:6171
15731 msgid "This is like C<guestfs_command>, but passes the command to:"
15735 #: ../src/guestfs-actions.pod:6173 ../fish/guestfish-actions.pod:4168
15738 " /bin/sh -c \"command\"\n"
15743 #: ../src/guestfs-actions.pod:6175 ../fish/guestfish-actions.pod:4170
15745 "Depending on the guest's shell, this usually results in wildcards being "
15746 "expanded, shell expressions being interpolated and so on."
15750 #: ../src/guestfs-actions.pod:6179
15751 msgid "All the provisos about C<guestfs_command> apply to this call."
15755 #: ../src/guestfs-actions.pod:6186
15756 msgid "guestfs_sh_lines"
15760 #: ../src/guestfs-actions.pod:6188
15764 " guestfs_sh_lines (guestfs_h *g,\n"
15765 " const char *command);\n"
15770 #: ../src/guestfs-actions.pod:6192
15772 "This is the same as C<guestfs_sh>, but splits the result into a list of "
15777 #: ../src/guestfs-actions.pod:6195
15778 msgid "See also: C<guestfs_command_lines>"
15782 #: ../src/guestfs-actions.pod:6203
15783 msgid "guestfs_sleep"
15787 #: ../src/guestfs-actions.pod:6205
15791 " guestfs_sleep (guestfs_h *g,\n"
15797 #: ../src/guestfs-actions.pod:6209 ../fish/guestfish-actions.pod:4189
15798 msgid "Sleep for C<secs> seconds."
15802 #: ../src/guestfs-actions.pod:6213
15803 msgid "(Added in 1.0.41)"
15807 #: ../src/guestfs-actions.pod:6215 ../src/guestfs-structs.pod:109
15808 msgid "guestfs_stat"
15812 #: ../src/guestfs-actions.pod:6217
15815 " struct guestfs_stat *\n"
15816 " guestfs_stat (guestfs_h *g,\n"
15817 " const char *path);\n"
15822 #: ../src/guestfs-actions.pod:6223 ../fish/guestfish-actions.pod:4197
15823 msgid "This is the same as the C<stat(2)> system call."
15827 #: ../src/guestfs-actions.pod:6231 ../src/guestfs-structs.pod:135
15828 msgid "guestfs_statvfs"
15832 #: ../src/guestfs-actions.pod:6233
15835 " struct guestfs_statvfs *\n"
15836 " guestfs_statvfs (guestfs_h *g,\n"
15837 " const char *path);\n"
15842 #: ../src/guestfs-actions.pod:6237 ../fish/guestfish-actions.pod:4203
15844 "Returns file system statistics for any mounted file system. C<path> should "
15845 "be a file or directory in the mounted file system (typically it is the mount "
15846 "point itself, but it doesn't need to be)."
15850 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4207
15851 msgid "This is the same as the C<statvfs(2)> system call."
15855 #: ../src/guestfs-actions.pod:6243
15857 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
15858 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
15862 #: ../src/guestfs-actions.pod:6249
15863 msgid "guestfs_strings"
15867 #: ../src/guestfs-actions.pod:6251
15871 " guestfs_strings (guestfs_h *g,\n"
15872 " const char *path);\n"
15877 #: ../src/guestfs-actions.pod:6255 ../fish/guestfish-actions.pod:4213
15879 "This runs the L<strings(1)> command on a file and returns the list of "
15880 "printable strings found."
15884 #: ../src/guestfs-actions.pod:6267
15885 msgid "guestfs_strings_e"
15889 #: ../src/guestfs-actions.pod:6269
15893 " guestfs_strings_e (guestfs_h *g,\n"
15894 " const char *encoding,\n"
15895 " const char *path);\n"
15900 #: ../src/guestfs-actions.pod:6274
15902 "This is like the C<guestfs_strings> command, but allows you to specify the "
15903 "encoding of strings that are looked for in the source file C<path>."
15907 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4227
15908 msgid "Allowed encodings are:"
15912 #: ../src/guestfs-actions.pod:6282 ../fish/guestfish-actions.pod:4231
15917 #: ../src/guestfs-actions.pod:6284
15919 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15920 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15924 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4236
15929 #: ../src/guestfs-actions.pod:6289 ../fish/guestfish-actions.pod:4238
15930 msgid "Single 8-bit-byte characters."
15934 #: ../src/guestfs-actions.pod:6291 ../fish/guestfish-actions.pod:4240
15939 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4242
15940 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15944 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4245
15945 msgid "l (lower case letter L)"
15949 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4247
15951 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15952 "examining binaries in Windows guests."
15956 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4250
15961 #: ../src/guestfs-actions.pod:6303 ../fish/guestfish-actions.pod:4252
15962 msgid "32-bit big endian such as UCS-4BE."
15966 #: ../src/guestfs-actions.pod:6305 ../fish/guestfish-actions.pod:4254
15971 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4256
15972 msgid "32-bit little endian such as UCS-4LE."
15976 #: ../src/guestfs-actions.pod:6311 ../fish/guestfish-actions.pod:4260
15977 msgid "The returned strings are transcoded to UTF-8."
15981 #: ../src/guestfs-actions.pod:6322
15982 msgid "guestfs_swapoff_device"
15986 #: ../src/guestfs-actions.pod:6324
15990 " guestfs_swapoff_device (guestfs_h *g,\n"
15991 " const char *device);\n"
15996 #: ../src/guestfs-actions.pod:6328
15998 "This command disables the libguestfs appliance swap device or partition "
15999 "named C<device>. See C<guestfs_swapon_device>."
16003 #: ../src/guestfs-actions.pod:6336
16004 msgid "guestfs_swapoff_file"
16008 #: ../src/guestfs-actions.pod:6338
16012 " guestfs_swapoff_file (guestfs_h *g,\n"
16013 " const char *file);\n"
16018 #: ../src/guestfs-actions.pod:6342 ../fish/guestfish-actions.pod:4277
16019 msgid "This command disables the libguestfs appliance swap on file."
16023 #: ../src/guestfs-actions.pod:6348
16024 msgid "guestfs_swapoff_label"
16028 #: ../src/guestfs-actions.pod:6350
16032 " guestfs_swapoff_label (guestfs_h *g,\n"
16033 " const char *label);\n"
16038 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4283
16040 "This command disables the libguestfs appliance swap on labeled swap "
16045 #: ../src/guestfs-actions.pod:6361
16046 msgid "guestfs_swapoff_uuid"
16050 #: ../src/guestfs-actions.pod:6363
16054 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16055 " const char *uuid);\n"
16060 #: ../src/guestfs-actions.pod:6367 ../fish/guestfish-actions.pod:4290
16062 "This command disables the libguestfs appliance swap partition with the given "
16067 #: ../src/guestfs-actions.pod:6374
16068 msgid "guestfs_swapon_device"
16072 #: ../src/guestfs-actions.pod:6376
16076 " guestfs_swapon_device (guestfs_h *g,\n"
16077 " const char *device);\n"
16082 #: ../src/guestfs-actions.pod:6380
16084 "This command enables the libguestfs appliance to use the swap device or "
16085 "partition named C<device>. The increased memory is made available for all "
16086 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16090 #: ../src/guestfs-actions.pod:6385 ../fish/guestfish-actions.pod:4302
16092 "Note that you should not swap to existing guest swap partitions unless you "
16093 "know what you are doing. They may contain hibernation information, or other "
16094 "information that the guest doesn't want you to trash. You also risk leaking "
16095 "information about the host to the guest this way. Instead, attach a new "
16096 "host device to the guest and swap on that."
16100 #: ../src/guestfs-actions.pod:6396
16101 msgid "guestfs_swapon_file"
16105 #: ../src/guestfs-actions.pod:6398
16109 " guestfs_swapon_file (guestfs_h *g,\n"
16110 " const char *file);\n"
16115 #: ../src/guestfs-actions.pod:6402
16117 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16122 #: ../src/guestfs-actions.pod:6409
16123 msgid "guestfs_swapon_label"
16127 #: ../src/guestfs-actions.pod:6411
16131 " guestfs_swapon_label (guestfs_h *g,\n"
16132 " const char *label);\n"
16137 #: ../src/guestfs-actions.pod:6415
16139 "This command enables swap to a labeled swap partition. See "
16140 "C<guestfs_swapon_device> for other notes."
16144 #: ../src/guestfs-actions.pod:6422
16145 msgid "guestfs_swapon_uuid"
16149 #: ../src/guestfs-actions.pod:6424
16153 " guestfs_swapon_uuid (guestfs_h *g,\n"
16154 " const char *uuid);\n"
16159 #: ../src/guestfs-actions.pod:6428
16161 "This command enables swap to a swap partition with the given UUID. See "
16162 "C<guestfs_swapon_device> for other notes."
16166 #: ../src/guestfs-actions.pod:6435
16167 msgid "guestfs_sync"
16171 #: ../src/guestfs-actions.pod:6437
16175 " guestfs_sync (guestfs_h *g);\n"
16180 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4334
16182 "This syncs the disk, so that any writes are flushed through to the "
16183 "underlying disk image."
16187 #: ../src/guestfs-actions.pod:6443 ../fish/guestfish-actions.pod:4337
16189 "You should always call this if you have modified a disk image, before "
16190 "closing the handle."
16194 #: ../src/guestfs-actions.pod:6450
16195 msgid "guestfs_tail"
16199 #: ../src/guestfs-actions.pod:6452
16203 " guestfs_tail (guestfs_h *g,\n"
16204 " const char *path);\n"
16209 #: ../src/guestfs-actions.pod:6456 ../fish/guestfish-actions.pod:4344
16210 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16214 #: ../src/guestfs-actions.pod:6468
16215 msgid "guestfs_tail_n"
16219 #: ../src/guestfs-actions.pod:6470
16223 " guestfs_tail_n (guestfs_h *g,\n"
16225 " const char *path);\n"
16230 #: ../src/guestfs-actions.pod:6475 ../fish/guestfish-actions.pod:4354
16232 "If the parameter C<nrlines> is a positive number, this returns the last "
16233 "C<nrlines> lines of the file C<path>."
16237 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4357
16239 "If the parameter C<nrlines> is a negative number, this returns lines from "
16240 "the file C<path>, starting with the C<-nrlines>th line."
16244 #: ../src/guestfs-actions.pod:6492
16245 msgid "guestfs_tar_in"
16249 #: ../src/guestfs-actions.pod:6494
16253 " guestfs_tar_in (guestfs_h *g,\n"
16254 " const char *tarfile,\n"
16255 " const char *directory);\n"
16260 #: ../src/guestfs-actions.pod:6499 ../fish/guestfish-actions.pod:4369
16262 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16263 "tar file) into C<directory>."
16267 #: ../src/guestfs-actions.pod:6502
16268 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16272 #: ../src/guestfs-actions.pod:6507 ../src/guestfs-actions.pod:6524 ../src/guestfs-actions.pod:6540 ../src/guestfs-actions.pod:6556
16273 msgid "(Added in 1.0.3)"
16277 #: ../src/guestfs-actions.pod:6509
16278 msgid "guestfs_tar_out"
16282 #: ../src/guestfs-actions.pod:6511
16286 " guestfs_tar_out (guestfs_h *g,\n"
16287 " const char *directory,\n"
16288 " const char *tarfile);\n"
16293 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4381
16295 "This command packs the contents of C<directory> and downloads it to local "
16300 #: ../src/guestfs-actions.pod:6519
16302 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16303 "C<guestfs_txz_out>."
16307 #: ../src/guestfs-actions.pod:6526
16308 msgid "guestfs_tgz_in"
16312 #: ../src/guestfs-actions.pod:6528
16316 " guestfs_tgz_in (guestfs_h *g,\n"
16317 " const char *tarball,\n"
16318 " const char *directory);\n"
16323 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4393
16325 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
16326 "tar file) into C<directory>."
16330 #: ../src/guestfs-actions.pod:6536
16331 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
16335 #: ../src/guestfs-actions.pod:6542
16336 msgid "guestfs_tgz_out"
16340 #: ../src/guestfs-actions.pod:6544
16344 " guestfs_tgz_out (guestfs_h *g,\n"
16345 " const char *directory,\n"
16346 " const char *tarball);\n"
16351 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4404
16353 "This command packs the contents of C<directory> and downloads it to local "
16358 #: ../src/guestfs-actions.pod:6552
16359 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
16363 #: ../src/guestfs-actions.pod:6558
16364 msgid "guestfs_touch"
16368 #: ../src/guestfs-actions.pod:6560
16372 " guestfs_touch (guestfs_h *g,\n"
16373 " const char *path);\n"
16378 #: ../src/guestfs-actions.pod:6564 ../fish/guestfish-actions.pod:4415
16380 "Touch acts like the L<touch(1)> command. It can be used to update the "
16381 "timestamps on a file, or, if the file does not exist, to create a new "
16382 "zero-length file."
16386 #: ../src/guestfs-actions.pod:6568 ../fish/guestfish-actions.pod:4419
16388 "This command only works on regular files, and will fail on other file types "
16389 "such as directories, symbolic links, block special etc."
16393 #: ../src/guestfs-actions.pod:6575
16394 msgid "guestfs_truncate"
16398 #: ../src/guestfs-actions.pod:6577
16402 " guestfs_truncate (guestfs_h *g,\n"
16403 " const char *path);\n"
16408 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4426
16410 "This command truncates C<path> to a zero-length file. The file must exist "
16415 #: ../src/guestfs-actions.pod:6588
16416 msgid "guestfs_truncate_size"
16420 #: ../src/guestfs-actions.pod:6590
16424 " guestfs_truncate_size (guestfs_h *g,\n"
16425 " const char *path,\n"
16426 " int64_t size);\n"
16431 #: ../src/guestfs-actions.pod:6595 ../fish/guestfish-actions.pod:4433
16433 "This command truncates C<path> to size C<size> bytes. The file must exist "
16438 #: ../src/guestfs-actions.pod:6598
16440 "If the current file size is less than C<size> then the file is extended to "
16441 "the required size with zero bytes. This creates a sparse file (ie. disk "
16442 "blocks are not allocated for the file until you write to it). To create a "
16443 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
16447 #: ../src/guestfs-actions.pod:6608
16448 msgid "guestfs_tune2fs_l"
16452 #: ../src/guestfs-actions.pod:6610
16456 " guestfs_tune2fs_l (guestfs_h *g,\n"
16457 " const char *device);\n"
16462 #: ../src/guestfs-actions.pod:6614 ../fish/guestfish-actions.pod:4446
16464 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
16469 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4449
16471 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
16472 "for more details. The list of fields returned isn't clearly defined, and "
16473 "depends on both the version of C<tune2fs> that libguestfs was built against, "
16474 "and the filesystem itself."
16478 #: ../src/guestfs-actions.pod:6630
16479 msgid "guestfs_txz_in"
16483 #: ../src/guestfs-actions.pod:6632
16487 " guestfs_txz_in (guestfs_h *g,\n"
16488 " const char *tarball,\n"
16489 " const char *directory);\n"
16494 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4458
16496 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
16497 "tar file) into C<directory>."
16501 #: ../src/guestfs-actions.pod:6644
16502 msgid "guestfs_txz_out"
16506 #: ../src/guestfs-actions.pod:6646
16510 " guestfs_txz_out (guestfs_h *g,\n"
16511 " const char *directory,\n"
16512 " const char *tarball);\n"
16517 #: ../src/guestfs-actions.pod:6651 ../fish/guestfish-actions.pod:4467
16519 "This command packs the contents of C<directory> and downloads it to local "
16520 "file C<tarball> (as an xz compressed tar archive)."
16524 #: ../src/guestfs-actions.pod:6658
16525 msgid "guestfs_umask"
16529 #: ../src/guestfs-actions.pod:6660
16533 " guestfs_umask (guestfs_h *g,\n"
16539 #: ../src/guestfs-actions.pod:6664 ../fish/guestfish-actions.pod:4476
16541 "This function sets the mask used for creating new files and device nodes to "
16546 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4479
16548 "Typical umask values would be C<022> which creates new files with "
16549 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
16550 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
16554 #: ../src/guestfs-actions.pod:6672 ../fish/guestfish-actions.pod:4484
16556 "The default umask is C<022>. This is important because it means that "
16557 "directories and device nodes will be created with C<0644> or C<0755> mode "
16558 "even if you specify C<0777>."
16562 #: ../src/guestfs-actions.pod:6676
16564 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
16565 "C<guestfs_mkdir>."
16569 #: ../src/guestfs-actions.pod:6679 ../fish/guestfish-actions.pod:4491
16570 msgid "This call returns the previous umask."
16574 #: ../src/guestfs-actions.pod:6685
16575 msgid "guestfs_umount"
16579 #: ../src/guestfs-actions.pod:6687
16583 " guestfs_umount (guestfs_h *g,\n"
16584 " const char *pathordevice);\n"
16589 #: ../src/guestfs-actions.pod:6691 ../fish/guestfish-actions.pod:4499
16591 "This unmounts the given filesystem. The filesystem may be specified either "
16592 "by its mountpoint (path) or the device which contains the filesystem."
16596 #: ../src/guestfs-actions.pod:6699
16597 msgid "guestfs_umount_all"
16601 #: ../src/guestfs-actions.pod:6701
16605 " guestfs_umount_all (guestfs_h *g);\n"
16610 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4509
16611 msgid "This unmounts all mounted filesystems."
16615 #: ../src/guestfs-actions.pod:6706 ../fish/guestfish-actions.pod:4511
16616 msgid "Some internal mounts are not unmounted by this call."
16620 #: ../src/guestfs-actions.pod:6712
16621 msgid "guestfs_upload"
16625 #: ../src/guestfs-actions.pod:6714
16629 " guestfs_upload (guestfs_h *g,\n"
16630 " const char *filename,\n"
16631 " const char *remotefilename);\n"
16636 #: ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4517 ../fish/guestfish-actions.pod:4530
16637 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
16641 #: ../src/guestfs-actions.pod:6724
16642 msgid "See also C<guestfs_download>."
16646 #: ../src/guestfs-actions.pod:6735
16647 msgid "guestfs_upload_offset"
16651 #: ../src/guestfs-actions.pod:6737
16655 " guestfs_upload_offset (guestfs_h *g,\n"
16656 " const char *filename,\n"
16657 " const char *remotefilename,\n"
16658 " int64_t offset);\n"
16663 #: ../src/guestfs-actions.pod:6746 ../fish/guestfish-actions.pod:4533
16665 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
16666 "The intention is to overwrite parts of existing files or devices, although "
16667 "if a non-existant file is specified then it is created with a \"hole\" "
16668 "before C<offset>. The size of the data written is implicit in the size of "
16669 "the source C<filename>."
16673 #: ../src/guestfs-actions.pod:6753
16675 "Note that there is no limit on the amount of data that can be uploaded with "
16676 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
16677 "full amount unless an error occurs."
16681 #: ../src/guestfs-actions.pod:6758
16682 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
16686 #: ../src/guestfs-actions.pod:6769
16687 msgid "guestfs_utimens"
16691 #: ../src/guestfs-actions.pod:6771
16695 " guestfs_utimens (guestfs_h *g,\n"
16696 " const char *path,\n"
16697 " int64_t atsecs,\n"
16698 " int64_t atnsecs,\n"
16699 " int64_t mtsecs,\n"
16700 " int64_t mtnsecs);\n"
16705 #: ../src/guestfs-actions.pod:6779 ../fish/guestfish-actions.pod:4553
16706 msgid "This command sets the timestamps of a file with nanosecond precision."
16710 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4556
16712 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
16717 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4559
16719 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
16720 "nanoseconds from the epoch."
16724 #: ../src/guestfs-actions.pod:6788 ../fish/guestfish-actions.pod:4562
16726 "If the C<*nsecs> field contains the special value C<-1> then the "
16727 "corresponding timestamp is set to the current time. (The C<*secs> field is "
16728 "ignored in this case)."
16732 #: ../src/guestfs-actions.pod:6792 ../fish/guestfish-actions.pod:4566
16734 "If the C<*nsecs> field contains the special value C<-2> then the "
16735 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
16740 #: ../src/guestfs-actions.pod:6800 ../src/guestfs-structs.pod:175
16741 msgid "guestfs_version"
16745 #: ../src/guestfs-actions.pod:6802
16748 " struct guestfs_version *\n"
16749 " guestfs_version (guestfs_h *g);\n"
16754 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4574
16755 msgid "Return the libguestfs version number that the program is linked against."
16759 #: ../src/guestfs-actions.pod:6808 ../fish/guestfish-actions.pod:4577
16761 "Note that because of dynamic linking this is not necessarily the version of "
16762 "libguestfs that you compiled against. You can compile the program, and then "
16763 "at runtime dynamically link against a completely different C<libguestfs.so> "
16768 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4582
16770 "This call was added in version C<1.0.58>. In previous versions of "
16771 "libguestfs there was no way to get the version number. From C code you can "
16772 "use dynamic linker functions to find out if this symbol exists (if it "
16773 "doesn't, then it's an earlier version)."
16777 #: ../src/guestfs-actions.pod:6819 ../fish/guestfish-actions.pod:4588
16779 "The call returns a structure with four elements. The first three (C<major>, "
16780 "C<minor> and C<release>) are numbers and correspond to the usual version "
16781 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
16782 "but may be used for distro-specific information."
16786 #: ../src/guestfs-actions.pod:6825 ../fish/guestfish-actions.pod:4594
16787 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
16791 #: ../src/guestfs-actions.pod:6828 ../fish/guestfish-actions.pod:4597
16792 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
16796 #: ../src/guestfs-actions.pod:6830
16798 "I<Note:> Don't use this call to test for availability of features. In "
16799 "enterprise distributions we backport features from later versions into "
16800 "earlier versions, making this an unreliable way to test for features. Use "
16801 "C<guestfs_available> instead."
16805 #: ../src/guestfs-actions.pod:6836
16807 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
16808 "error. I<The caller must call C<guestfs_free_version> after use>."
16812 #: ../src/guestfs-actions.pod:6840
16813 msgid "(Added in 1.0.58)"
16817 #: ../src/guestfs-actions.pod:6842
16818 msgid "guestfs_vfs_label"
16822 #: ../src/guestfs-actions.pod:6844
16826 " guestfs_vfs_label (guestfs_h *g,\n"
16827 " const char *device);\n"
16832 #: ../src/guestfs-actions.pod:6848 ../fish/guestfish-actions.pod:4609
16833 msgid "This returns the filesystem label of the filesystem on C<device>."
16837 #: ../src/guestfs-actions.pod:6851 ../fish/guestfish-actions.pod:4612
16838 msgid "If the filesystem is unlabeled, this returns the empty string."
16842 #: ../src/guestfs-actions.pod:6853
16843 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
16847 #: ../src/guestfs-actions.pod:6858 ../src/guestfs-actions.pod:6895
16848 msgid "(Added in 1.3.18)"
16852 #: ../src/guestfs-actions.pod:6860
16853 msgid "guestfs_vfs_type"
16857 #: ../src/guestfs-actions.pod:6862
16861 " guestfs_vfs_type (guestfs_h *g,\n"
16862 " const char *device);\n"
16867 #: ../src/guestfs-actions.pod:6866 ../fish/guestfish-actions.pod:4620
16869 "This command gets the filesystem type corresponding to the filesystem on "
16874 #: ../src/guestfs-actions.pod:6869 ../fish/guestfish-actions.pod:4623
16876 "For most filesystems, the result is the name of the Linux VFS module which "
16877 "would be used to mount this filesystem if you mounted it without specifying "
16878 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
16882 #: ../src/guestfs-actions.pod:6879
16883 msgid "guestfs_vfs_uuid"
16887 #: ../src/guestfs-actions.pod:6881
16891 " guestfs_vfs_uuid (guestfs_h *g,\n"
16892 " const char *device);\n"
16897 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4632
16898 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16902 #: ../src/guestfs-actions.pod:6888 ../fish/guestfish-actions.pod:4635
16903 msgid "If the filesystem does not have a UUID, this returns the empty string."
16907 #: ../src/guestfs-actions.pod:6890
16908 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16912 #: ../src/guestfs-actions.pod:6897
16913 msgid "guestfs_vg_activate"
16917 #: ../src/guestfs-actions.pod:6899
16921 " guestfs_vg_activate (guestfs_h *g,\n"
16923 " char *const *volgroups);\n"
16928 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4643
16930 "This command activates or (if C<activate> is false) deactivates all logical "
16931 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16932 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16933 "deactivated, then those devices disappear."
16937 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4649
16938 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16942 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4651
16944 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16945 "activated or deactivated."
16949 #: ../src/guestfs-actions.pod:6919
16950 msgid "guestfs_vg_activate_all"
16954 #: ../src/guestfs-actions.pod:6921
16958 " guestfs_vg_activate_all (guestfs_h *g,\n"
16959 " int activate);\n"
16964 #: ../src/guestfs-actions.pod:6925 ../fish/guestfish-actions.pod:4658
16966 "This command activates or (if C<activate> is false) deactivates all logical "
16967 "volumes in all volume groups. If activated, then they are made known to the "
16968 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16969 "those devices disappear."
16973 #: ../src/guestfs-actions.pod:6931 ../fish/guestfish-actions.pod:4664
16974 msgid "This command is the same as running C<vgchange -a y|n>"
16978 #: ../src/guestfs-actions.pod:6937
16979 msgid "guestfs_vgcreate"
16983 #: ../src/guestfs-actions.pod:6939
16987 " guestfs_vgcreate (guestfs_h *g,\n"
16988 " const char *volgroup,\n"
16989 " char *const *physvols);\n"
16994 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4670
16996 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16997 "of physical volumes C<physvols>."
17001 #: ../src/guestfs-actions.pod:6951
17002 msgid "guestfs_vglvuuids"
17006 #: ../src/guestfs-actions.pod:6953
17010 " guestfs_vglvuuids (guestfs_h *g,\n"
17011 " const char *vgname);\n"
17016 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4677
17018 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17019 "volumes created in this volume group."
17023 #: ../src/guestfs-actions.pod:6960
17025 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17026 "associate logical volumes and volume groups."
17030 #: ../src/guestfs-actions.pod:6963
17031 msgid "See also C<guestfs_vgpvuuids>."
17035 #: ../src/guestfs-actions.pod:6971
17036 msgid "guestfs_vgpvuuids"
17040 #: ../src/guestfs-actions.pod:6973
17044 " guestfs_vgpvuuids (guestfs_h *g,\n"
17045 " const char *vgname);\n"
17050 #: ../src/guestfs-actions.pod:6977 ../fish/guestfish-actions.pod:4689
17052 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17053 "volumes that this volume group resides on."
17057 #: ../src/guestfs-actions.pod:6980
17059 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17060 "associate physical volumes and volume groups."
17064 #: ../src/guestfs-actions.pod:6983
17065 msgid "See also C<guestfs_vglvuuids>."
17069 #: ../src/guestfs-actions.pod:6991
17070 msgid "guestfs_vgremove"
17074 #: ../src/guestfs-actions.pod:6993
17078 " guestfs_vgremove (guestfs_h *g,\n"
17079 " const char *vgname);\n"
17084 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4701
17085 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17089 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4703
17090 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17094 #: ../src/guestfs-actions.pod:7006
17095 msgid "guestfs_vgrename"
17099 #: ../src/guestfs-actions.pod:7008
17103 " guestfs_vgrename (guestfs_h *g,\n"
17104 " const char *volgroup,\n"
17105 " const char *newvolgroup);\n"
17110 #: ../src/guestfs-actions.pod:7013 ../fish/guestfish-actions.pod:4710
17111 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17115 #: ../src/guestfs-actions.pod:7019
17116 msgid "guestfs_vgs"
17120 #: ../src/guestfs-actions.pod:7021
17124 " guestfs_vgs (guestfs_h *g);\n"
17129 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4716
17131 "List all the volumes groups detected. This is the equivalent of the "
17132 "L<vgs(8)> command."
17136 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4719
17138 "This returns a list of just the volume group names that were detected "
17139 "(eg. C<VolGroup00>)."
17143 #: ../src/guestfs-actions.pod:7030
17144 msgid "See also C<guestfs_vgs_full>."
17148 #: ../src/guestfs-actions.pod:7038
17149 msgid "guestfs_vgs_full"
17153 #: ../src/guestfs-actions.pod:7040
17156 " struct guestfs_lvm_vg_list *\n"
17157 " guestfs_vgs_full (guestfs_h *g);\n"
17162 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4728
17164 "List all the volumes groups detected. This is the equivalent of the "
17165 "L<vgs(8)> command. The \"full\" version includes all fields."
17169 #: ../src/guestfs-actions.pod:7046
17171 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17172 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17177 #: ../src/guestfs-actions.pod:7052
17178 msgid "guestfs_vgscan"
17182 #: ../src/guestfs-actions.pod:7054
17186 " guestfs_vgscan (guestfs_h *g);\n"
17191 #: ../src/guestfs-actions.pod:7057 ../fish/guestfish-actions.pod:4735
17193 "This rescans all block devices and rebuilds the list of LVM physical "
17194 "volumes, volume groups and logical volumes."
17198 #: ../src/guestfs-actions.pod:7064
17199 msgid "guestfs_vguuid"
17203 #: ../src/guestfs-actions.pod:7066
17207 " guestfs_vguuid (guestfs_h *g,\n"
17208 " const char *vgname);\n"
17213 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4742
17214 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17218 #: ../src/guestfs-actions.pod:7077
17219 msgid "guestfs_wait_ready"
17223 #: ../src/guestfs-actions.pod:7079
17227 " guestfs_wait_ready (guestfs_h *g);\n"
17232 #: ../src/guestfs-actions.pod:7082
17233 msgid "This function is a no op."
17237 #: ../src/guestfs-actions.pod:7084
17239 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17240 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17241 "is no longer necessary because C<guestfs_launch> now does the waiting."
17245 #: ../src/guestfs-actions.pod:7089
17247 "If you see any calls to this function in code then you can just remove them, "
17248 "unless you want to retain compatibility with older versions of the API."
17252 #: ../src/guestfs-actions.pod:7097
17253 msgid "guestfs_wc_c"
17257 #: ../src/guestfs-actions.pod:7099
17261 " guestfs_wc_c (guestfs_h *g,\n"
17262 " const char *path);\n"
17267 #: ../src/guestfs-actions.pod:7103 ../fish/guestfish-actions.pod:4748
17269 "This command counts the characters in a file, using the C<wc -c> external "
17274 #: ../src/guestfs-actions.pod:7110
17275 msgid "guestfs_wc_l"
17279 #: ../src/guestfs-actions.pod:7112
17283 " guestfs_wc_l (guestfs_h *g,\n"
17284 " const char *path);\n"
17289 #: ../src/guestfs-actions.pod:7116 ../fish/guestfish-actions.pod:4755
17291 "This command counts the lines in a file, using the C<wc -l> external "
17296 #: ../src/guestfs-actions.pod:7123
17297 msgid "guestfs_wc_w"
17301 #: ../src/guestfs-actions.pod:7125
17305 " guestfs_wc_w (guestfs_h *g,\n"
17306 " const char *path);\n"
17311 #: ../src/guestfs-actions.pod:7129 ../fish/guestfish-actions.pod:4762
17313 "This command counts the words in a file, using the C<wc -w> external "
17318 #: ../src/guestfs-actions.pod:7136
17319 msgid "guestfs_write"
17323 #: ../src/guestfs-actions.pod:7138
17327 " guestfs_write (guestfs_h *g,\n"
17328 " const char *path,\n"
17329 " const char *content,\n"
17330 " size_t content_size);\n"
17335 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:4769
17337 "This call creates a file called C<path>. The content of the file is the "
17338 "string C<content> (which can contain any 8 bit data)."
17342 #: ../src/guestfs-actions.pod:7154
17343 msgid "guestfs_write_file"
17347 #: ../src/guestfs-actions.pod:7156
17351 " guestfs_write_file (guestfs_h *g,\n"
17352 " const char *path,\n"
17353 " const char *content,\n"
17359 #: ../src/guestfs-actions.pod:7162 ../fish/guestfish-actions.pod:4779
17361 "This call creates a file called C<path>. The contents of the file is the "
17362 "string C<content> (which can contain any 8 bit data), with length C<size>."
17366 #: ../src/guestfs-actions.pod:7166 ../fish/guestfish-actions.pod:4783
17368 "As a special case, if C<size> is C<0> then the length is calculated using "
17369 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
17373 #: ../src/guestfs-actions.pod:7170 ../fish/guestfish-actions.pod:4787
17375 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
17376 "I<not> work, even if the length is specified."
17380 #: ../src/guestfs-actions.pod:7178 ../fish/guestfish-actions.pod:4793
17381 msgid "This function is deprecated. In new code, use the C<write> call instead."
17385 #: ../src/guestfs-actions.pod:7187
17386 msgid "guestfs_zegrep"
17390 #: ../src/guestfs-actions.pod:7189
17394 " guestfs_zegrep (guestfs_h *g,\n"
17395 " const char *regex,\n"
17396 " const char *path);\n"
17401 #: ../src/guestfs-actions.pod:7194 ../fish/guestfish-actions.pod:4804
17402 msgid "This calls the external C<zegrep> program and returns the matching lines."
17406 #: ../src/guestfs-actions.pod:7206
17407 msgid "guestfs_zegrepi"
17411 #: ../src/guestfs-actions.pod:7208
17415 " guestfs_zegrepi (guestfs_h *g,\n"
17416 " const char *regex,\n"
17417 " const char *path);\n"
17422 #: ../src/guestfs-actions.pod:7213 ../fish/guestfish-actions.pod:4814
17423 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
17427 #: ../src/guestfs-actions.pod:7225
17428 msgid "guestfs_zero"
17432 #: ../src/guestfs-actions.pod:7227
17436 " guestfs_zero (guestfs_h *g,\n"
17437 " const char *device);\n"
17442 #: ../src/guestfs-actions.pod:7231 ../fish/guestfish-actions.pod:4824
17443 msgid "This command writes zeroes over the first few blocks of C<device>."
17447 #: ../src/guestfs-actions.pod:7233 ../fish/guestfish-actions.pod:4826
17449 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
17450 "securely wipe the device). It should be sufficient to remove any partition "
17451 "tables, filesystem superblocks and so on."
17455 #: ../src/guestfs-actions.pod:7237
17456 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
17460 #: ../src/guestfs-actions.pod:7248
17461 msgid "guestfs_zero_device"
17465 #: ../src/guestfs-actions.pod:7250
17469 " guestfs_zero_device (guestfs_h *g,\n"
17470 " const char *device);\n"
17475 #: ../src/guestfs-actions.pod:7254
17477 "This command writes zeroes over the entire C<device>. Compare with "
17478 "C<guestfs_zero> which just zeroes the first few blocks of a device."
17482 #: ../src/guestfs-actions.pod:7268
17483 msgid "(Added in 1.3.1)"
17487 #: ../src/guestfs-actions.pod:7270
17488 msgid "guestfs_zerofree"
17492 #: ../src/guestfs-actions.pod:7272
17496 " guestfs_zerofree (guestfs_h *g,\n"
17497 " const char *device);\n"
17502 #: ../src/guestfs-actions.pod:7276 ../fish/guestfish-actions.pod:4847
17504 "This runs the I<zerofree> program on C<device>. This program claims to zero "
17505 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
17506 "possible to compress the filesystem more effectively."
17510 #: ../src/guestfs-actions.pod:7281 ../fish/guestfish-actions.pod:4852
17511 msgid "You should B<not> run this program if the filesystem is mounted."
17515 #: ../src/guestfs-actions.pod:7284 ../fish/guestfish-actions.pod:4855
17517 "It is possible that using this program can damage the filesystem or data on "
17522 #: ../src/guestfs-actions.pod:7291
17523 msgid "guestfs_zfgrep"
17527 #: ../src/guestfs-actions.pod:7293
17531 " guestfs_zfgrep (guestfs_h *g,\n"
17532 " const char *pattern,\n"
17533 " const char *path);\n"
17538 #: ../src/guestfs-actions.pod:7298 ../fish/guestfish-actions.pod:4862
17539 msgid "This calls the external C<zfgrep> program and returns the matching lines."
17543 #: ../src/guestfs-actions.pod:7310
17544 msgid "guestfs_zfgrepi"
17548 #: ../src/guestfs-actions.pod:7312
17552 " guestfs_zfgrepi (guestfs_h *g,\n"
17553 " const char *pattern,\n"
17554 " const char *path);\n"
17559 #: ../src/guestfs-actions.pod:7317 ../fish/guestfish-actions.pod:4872
17560 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
17564 #: ../src/guestfs-actions.pod:7329
17565 msgid "guestfs_zfile"
17569 #: ../src/guestfs-actions.pod:7331
17573 " guestfs_zfile (guestfs_h *g,\n"
17574 " const char *meth,\n"
17575 " const char *path);\n"
17580 #: ../src/guestfs-actions.pod:7336 ../fish/guestfish-actions.pod:4882
17581 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
17585 #: ../src/guestfs-actions.pod:7339 ../fish/guestfish-actions.pod:4885
17586 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
17590 #: ../src/guestfs-actions.pod:7341
17592 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
17597 #: ../src/guestfs-actions.pod:7347 ../fish/guestfish-actions.pod:4890
17598 msgid "This function is deprecated. In new code, use the C<file> call instead."
17602 #: ../src/guestfs-actions.pod:7356
17603 msgid "guestfs_zgrep"
17607 #: ../src/guestfs-actions.pod:7358
17611 " guestfs_zgrep (guestfs_h *g,\n"
17612 " const char *regex,\n"
17613 " const char *path);\n"
17618 #: ../src/guestfs-actions.pod:7363 ../fish/guestfish-actions.pod:4901
17619 msgid "This calls the external C<zgrep> program and returns the matching lines."
17623 #: ../src/guestfs-actions.pod:7375
17624 msgid "guestfs_zgrepi"
17628 #: ../src/guestfs-actions.pod:7377
17632 " guestfs_zgrepi (guestfs_h *g,\n"
17633 " const char *regex,\n"
17634 " const char *path);\n"
17639 #: ../src/guestfs-actions.pod:7382 ../fish/guestfish-actions.pod:4911
17640 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
17644 #: ../src/guestfs-availability.pod:3
17649 #: ../src/guestfs-availability.pod:5
17651 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
17652 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
17653 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
17654 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
17655 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
17659 #: ../src/guestfs-availability.pod:21
17664 #: ../src/guestfs-availability.pod:23
17666 "The following functions: L</guestfs_inotify_add_watch> "
17667 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
17668 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
17672 #: ../src/guestfs-availability.pod:31
17673 msgid "B<linuxfsuuid>"
17677 #: ../src/guestfs-availability.pod:33
17679 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
17680 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
17684 #: ../src/guestfs-availability.pod:40
17685 msgid "B<linuxmodules>"
17689 #: ../src/guestfs-availability.pod:42
17690 msgid "The following functions: L</guestfs_modprobe>"
17694 #: ../src/guestfs-availability.pod:45
17695 msgid "B<linuxxattrs>"
17699 #: ../src/guestfs-availability.pod:47
17701 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
17702 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
17703 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
17704 "L</guestfs_setxattr>"
17708 #: ../src/guestfs-availability.pod:58
17713 #: ../src/guestfs-availability.pod:60
17715 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
17716 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
17717 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
17721 #: ../src/guestfs-availability.pod:69
17726 #: ../src/guestfs-availability.pod:71
17728 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
17729 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
17730 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
17731 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
17732 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
17733 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
17734 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
17735 "L</guestfs_vgs_full>"
17739 #: ../src/guestfs-availability.pod:94
17744 #: ../src/guestfs-availability.pod:96
17746 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
17747 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
17751 #: ../src/guestfs-availability.pod:102
17756 #: ../src/guestfs-availability.pod:104
17757 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
17761 #: ../src/guestfs-availability.pod:107
17762 msgid "B<ntfsprogs>"
17766 #: ../src/guestfs-availability.pod:109
17767 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
17771 #: ../src/guestfs-availability.pod:113
17772 msgid "B<realpath>"
17776 #: ../src/guestfs-availability.pod:115
17777 msgid "The following functions: L</guestfs_realpath>"
17781 #: ../src/guestfs-availability.pod:118
17786 #: ../src/guestfs-availability.pod:120
17788 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
17789 "L</guestfs_scrub_freespace>"
17793 #: ../src/guestfs-availability.pod:125
17798 #: ../src/guestfs-availability.pod:127
17799 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
17803 #: ../src/guestfs-availability.pod:131
17808 #: ../src/guestfs-availability.pod:133
17809 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
17813 #: ../src/guestfs-availability.pod:137
17814 msgid "B<zerofree>"
17818 #: ../src/guestfs-availability.pod:139
17819 msgid "The following functions: L</guestfs_zerofree>"
17823 #: ../src/guestfs-structs.pod:1
17824 msgid "guestfs_int_bool"
17828 #: ../src/guestfs-structs.pod:3
17831 " struct guestfs_int_bool {\n"
17839 #: ../src/guestfs-structs.pod:8
17842 " struct guestfs_int_bool_list {\n"
17843 " uint32_t len; /* Number of elements in list. */\n"
17844 " struct guestfs_int_bool *val; /* Elements. */\n"
17850 #: ../src/guestfs-structs.pod:13
17853 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
17854 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
17859 #: ../src/guestfs-structs.pod:16
17860 msgid "guestfs_lvm_pv"
17864 #: ../src/guestfs-structs.pod:18
17867 " struct guestfs_lvm_pv {\n"
17868 " char *pv_name;\n"
17869 " /* The next field is NOT nul-terminated, be careful when printing it: "
17871 " char pv_uuid[32];\n"
17873 " uint64_t pv_size;\n"
17874 " uint64_t dev_size;\n"
17875 " uint64_t pv_free;\n"
17876 " uint64_t pv_used;\n"
17877 " char *pv_attr;\n"
17878 " int64_t pv_pe_count;\n"
17879 " int64_t pv_pe_alloc_count;\n"
17880 " char *pv_tags;\n"
17881 " uint64_t pe_start;\n"
17882 " int64_t pv_mda_count;\n"
17883 " uint64_t pv_mda_free;\n"
17889 #: ../src/guestfs-structs.pod:36
17892 " struct guestfs_lvm_pv_list {\n"
17893 " uint32_t len; /* Number of elements in list. */\n"
17894 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17900 #: ../src/guestfs-structs.pod:41
17903 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17904 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17909 #: ../src/guestfs-structs.pod:44
17910 msgid "guestfs_lvm_vg"
17914 #: ../src/guestfs-structs.pod:46
17917 " struct guestfs_lvm_vg {\n"
17918 " char *vg_name;\n"
17919 " /* The next field is NOT nul-terminated, be careful when printing it: "
17921 " char vg_uuid[32];\n"
17923 " char *vg_attr;\n"
17924 " uint64_t vg_size;\n"
17925 " uint64_t vg_free;\n"
17926 " char *vg_sysid;\n"
17927 " uint64_t vg_extent_size;\n"
17928 " int64_t vg_extent_count;\n"
17929 " int64_t vg_free_count;\n"
17930 " int64_t max_lv;\n"
17931 " int64_t max_pv;\n"
17932 " int64_t pv_count;\n"
17933 " int64_t lv_count;\n"
17934 " int64_t snap_count;\n"
17935 " int64_t vg_seqno;\n"
17936 " char *vg_tags;\n"
17937 " int64_t vg_mda_count;\n"
17938 " uint64_t vg_mda_free;\n"
17944 #: ../src/guestfs-structs.pod:69
17947 " struct guestfs_lvm_vg_list {\n"
17948 " uint32_t len; /* Number of elements in list. */\n"
17949 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17955 #: ../src/guestfs-structs.pod:74
17958 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17959 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17964 #: ../src/guestfs-structs.pod:77
17965 msgid "guestfs_lvm_lv"
17969 #: ../src/guestfs-structs.pod:79
17972 " struct guestfs_lvm_lv {\n"
17973 " char *lv_name;\n"
17974 " /* The next field is NOT nul-terminated, be careful when printing it: "
17976 " char lv_uuid[32];\n"
17977 " char *lv_attr;\n"
17978 " int64_t lv_major;\n"
17979 " int64_t lv_minor;\n"
17980 " int64_t lv_kernel_major;\n"
17981 " int64_t lv_kernel_minor;\n"
17982 " uint64_t lv_size;\n"
17983 " int64_t seg_count;\n"
17985 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17986 " float snap_percent;\n"
17987 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17988 " float copy_percent;\n"
17989 " char *move_pv;\n"
17990 " char *lv_tags;\n"
17991 " char *mirror_log;\n"
17992 " char *modules;\n"
17998 #: ../src/guestfs-structs.pod:101
18001 " struct guestfs_lvm_lv_list {\n"
18002 " uint32_t len; /* Number of elements in list. */\n"
18003 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18009 #: ../src/guestfs-structs.pod:106
18012 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18013 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18018 #: ../src/guestfs-structs.pod:111
18021 " struct guestfs_stat {\n"
18025 " int64_t nlink;\n"
18030 " int64_t blksize;\n"
18031 " int64_t blocks;\n"
18032 " int64_t atime;\n"
18033 " int64_t mtime;\n"
18034 " int64_t ctime;\n"
18040 #: ../src/guestfs-structs.pod:127
18043 " struct guestfs_stat_list {\n"
18044 " uint32_t len; /* Number of elements in list. */\n"
18045 " struct guestfs_stat *val; /* Elements. */\n"
18051 #: ../src/guestfs-structs.pod:132
18054 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18055 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18060 #: ../src/guestfs-structs.pod:137
18063 " struct guestfs_statvfs {\n"
18064 " int64_t bsize;\n"
18065 " int64_t frsize;\n"
18066 " int64_t blocks;\n"
18067 " int64_t bfree;\n"
18068 " int64_t bavail;\n"
18069 " int64_t files;\n"
18070 " int64_t ffree;\n"
18071 " int64_t favail;\n"
18074 " int64_t namemax;\n"
18080 #: ../src/guestfs-structs.pod:151
18083 " struct guestfs_statvfs_list {\n"
18084 " uint32_t len; /* Number of elements in list. */\n"
18085 " struct guestfs_statvfs *val; /* Elements. */\n"
18091 #: ../src/guestfs-structs.pod:156
18094 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18095 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18100 #: ../src/guestfs-structs.pod:159
18101 msgid "guestfs_dirent"
18105 #: ../src/guestfs-structs.pod:161
18108 " struct guestfs_dirent {\n"
18117 #: ../src/guestfs-structs.pod:167
18120 " struct guestfs_dirent_list {\n"
18121 " uint32_t len; /* Number of elements in list. */\n"
18122 " struct guestfs_dirent *val; /* Elements. */\n"
18128 #: ../src/guestfs-structs.pod:172
18131 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18132 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18137 #: ../src/guestfs-structs.pod:177
18140 " struct guestfs_version {\n"
18141 " int64_t major;\n"
18142 " int64_t minor;\n"
18143 " int64_t release;\n"
18150 #: ../src/guestfs-structs.pod:184
18153 " struct guestfs_version_list {\n"
18154 " uint32_t len; /* Number of elements in list. */\n"
18155 " struct guestfs_version *val; /* Elements. */\n"
18161 #: ../src/guestfs-structs.pod:189
18164 " void guestfs_free_version (struct guestfs_free_version *);\n"
18165 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18170 #: ../src/guestfs-structs.pod:192
18171 msgid "guestfs_xattr"
18175 #: ../src/guestfs-structs.pod:194
18178 " struct guestfs_xattr {\n"
18179 " char *attrname;\n"
18180 " /* The next two fields describe a byte array. */\n"
18181 " uint32_t attrval_len;\n"
18182 " char *attrval;\n"
18188 #: ../src/guestfs-structs.pod:201
18191 " struct guestfs_xattr_list {\n"
18192 " uint32_t len; /* Number of elements in list. */\n"
18193 " struct guestfs_xattr *val; /* Elements. */\n"
18199 #: ../src/guestfs-structs.pod:206
18202 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18203 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18208 #: ../src/guestfs-structs.pod:209
18209 msgid "guestfs_inotify_event"
18213 #: ../src/guestfs-structs.pod:211
18216 " struct guestfs_inotify_event {\n"
18217 " int64_t in_wd;\n"
18218 " uint32_t in_mask;\n"
18219 " uint32_t in_cookie;\n"
18220 " char *in_name;\n"
18226 #: ../src/guestfs-structs.pod:218
18229 " struct guestfs_inotify_event_list {\n"
18230 " uint32_t len; /* Number of elements in list. */\n"
18231 " struct guestfs_inotify_event *val; /* Elements. */\n"
18237 #: ../src/guestfs-structs.pod:223
18240 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18241 " void guestfs_free_inotify_event_list (struct "
18242 "guestfs_free_inotify_event_list *);\n"
18247 #: ../src/guestfs-structs.pod:226
18248 msgid "guestfs_partition"
18252 #: ../src/guestfs-structs.pod:228
18255 " struct guestfs_partition {\n"
18256 " int32_t part_num;\n"
18257 " uint64_t part_start;\n"
18258 " uint64_t part_end;\n"
18259 " uint64_t part_size;\n"
18265 #: ../src/guestfs-structs.pod:235
18268 " struct guestfs_partition_list {\n"
18269 " uint32_t len; /* Number of elements in list. */\n"
18270 " struct guestfs_partition *val; /* Elements. */\n"
18276 #: ../src/guestfs-structs.pod:240
18279 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18280 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18285 #: ../src/guestfs-structs.pod:243
18286 msgid "guestfs_application"
18290 #: ../src/guestfs-structs.pod:245
18293 " struct guestfs_application {\n"
18294 " char *app_name;\n"
18295 " char *app_display_name;\n"
18296 " int32_t app_epoch;\n"
18297 " char *app_version;\n"
18298 " char *app_release;\n"
18299 " char *app_install_path;\n"
18300 " char *app_trans_path;\n"
18301 " char *app_publisher;\n"
18302 " char *app_url;\n"
18303 " char *app_source_package;\n"
18304 " char *app_summary;\n"
18305 " char *app_description;\n"
18311 #: ../src/guestfs-structs.pod:260
18314 " struct guestfs_application_list {\n"
18315 " uint32_t len; /* Number of elements in list. */\n"
18316 " struct guestfs_application *val; /* Elements. */\n"
18322 #: ../src/guestfs-structs.pod:265
18325 " void guestfs_free_application (struct guestfs_free_application *);\n"
18326 " void guestfs_free_application_list (struct guestfs_free_application_list "
18332 #: ../fish/guestfish.pod:5
18333 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18337 #: ../fish/guestfish.pod:9
18340 " guestfish [--options] [commands]\n"
18345 #: ../fish/guestfish.pod:11
18353 #: ../fish/guestfish.pod:13
18356 " guestfish [--ro|--rw] -a disk.img\n"
18361 #: ../fish/guestfish.pod:15
18364 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18369 #: ../fish/guestfish.pod:17
18372 " guestfish -d libvirt-domain\n"
18377 #: ../fish/guestfish.pod:19
18380 " guestfish [--ro|--rw] -a disk.img -i\n"
18385 #: ../fish/guestfish.pod:21
18388 " guestfish -d libvirt-domain -i\n"
18393 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
18398 #: ../fish/guestfish.pod:25
18400 "Using guestfish in read/write mode on live virtual machines can be "
18401 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18402 "option to use guestfish safely if the disk image or virtual machine might be "
18407 #: ../fish/guestfish.pod:32
18409 "Guestfish is a shell and command-line tool for examining and modifying "
18410 "virtual machine filesystems. It uses libguestfs and exposes all of the "
18411 "functionality of the guestfs API, see L<guestfs(3)>."
18415 #: ../fish/guestfish.pod:36
18417 "Guestfish gives you structured access to the libguestfs API, from shell "
18418 "scripts or the command line or interactively. If you want to rescue a "
18419 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
18424 #: ../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
18429 #: ../fish/guestfish.pod:43
18430 msgid "As an interactive shell"
18434 #: ../fish/guestfish.pod:45
18442 #: ../fish/guestfish.pod:47
18445 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
18446 " editing virtual machine filesystems.\n"
18451 #: ../fish/guestfish.pod:50
18454 " Type: 'help' for a list of commands\n"
18455 " 'man' to read the manual\n"
18456 " 'quit' to quit the shell\n"
18461 #: ../fish/guestfish.pod:54
18464 " ><fs> add-ro disk.img\n"
18466 " ><fs> list-filesystems\n"
18467 " /dev/sda1: ext4\n"
18468 " /dev/vg_guest/lv_root: ext4\n"
18469 " /dev/vg_guest/lv_swap: swap\n"
18470 " ><fs> mount /dev/vg_guest/lv_root /\n"
18471 " ><fs> cat /etc/fstab\n"
18473 " # Created by anaconda\n"
18480 #: ../fish/guestfish.pod:67
18481 msgid "From shell scripts"
18485 #: ../fish/guestfish.pod:69
18486 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18490 #: ../fish/guestfish.pod:71
18493 " guestfish <<_EOF_\n"
18496 " mount /dev/vg_guest/lv_root /\n"
18497 " write /etc/motd \"Welcome, new users\"\n"
18503 #: ../fish/guestfish.pod:78
18504 msgid "List the LVM logical volumes in a disk image:"
18508 #: ../fish/guestfish.pod:80
18511 " guestfish -a disk.img --ro <<_EOF_\n"
18519 #: ../fish/guestfish.pod:85
18520 msgid "List all the filesystems in a disk image:"
18524 #: ../fish/guestfish.pod:87
18527 " guestfish -a disk.img --ro <<_EOF_\n"
18529 " list-filesystems\n"
18535 #: ../fish/guestfish.pod:92
18536 msgid "On one command line"
18540 #: ../fish/guestfish.pod:94
18541 msgid "Update C</etc/resolv.conf> in a guest:"
18545 #: ../fish/guestfish.pod:96
18549 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
18550 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
18555 #: ../fish/guestfish.pod:100
18556 msgid "Edit C</boot/grub/grub.conf> interactively:"
18560 #: ../fish/guestfish.pod:102
18563 " guestfish --rw --add disk.img \\\n"
18564 " --mount /dev/vg_guest/lv_root \\\n"
18565 " --mount /dev/sda1:/boot \\\n"
18566 " edit /boot/grub/grub.conf\n"
18571 #: ../fish/guestfish.pod:107
18572 msgid "Mount disks automatically"
18576 #: ../fish/guestfish.pod:109
18578 "Use the I<-i> option to automatically mount the disks from a virtual "
18583 #: ../fish/guestfish.pod:112
18586 " guestfish --ro -a disk.img -i cat /etc/group\n"
18591 #: ../fish/guestfish.pod:114
18594 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
18599 #: ../fish/guestfish.pod:116
18600 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
18604 #: ../fish/guestfish.pod:118
18607 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
18612 #: ../fish/guestfish.pod:120
18613 msgid "As a script interpreter"
18617 #: ../fish/guestfish.pod:122
18618 msgid "Create a 100MB disk containing an ext2-formatted partition:"
18622 #: ../fish/guestfish.pod:124
18625 " #!/usr/bin/guestfish -f\n"
18626 " sparse test1.img 100M\n"
18628 " part-disk /dev/sda mbr\n"
18629 " mkfs ext2 /dev/sda1\n"
18634 #: ../fish/guestfish.pod:130
18635 msgid "Start with a prepared disk"
18639 #: ../fish/guestfish.pod:132
18641 "An alternate way to create a 100MB disk called C<test1.img> containing a "
18642 "single ext2-formatted partition:"
18646 #: ../fish/guestfish.pod:135
18649 " guestfish -N fs\n"
18654 #: ../fish/guestfish.pod:137
18655 msgid "To list what is available do:"
18659 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:919
18662 " guestfish -N help | less\n"
18667 #: ../fish/guestfish.pod:141
18668 msgid "Remote control"
18672 #: ../fish/guestfish.pod:143
18675 " eval \"`guestfish --listen`\"\n"
18676 " guestfish --remote add-ro disk.img\n"
18677 " guestfish --remote run\n"
18678 " guestfish --remote lvs\n"
18683 #: ../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
18688 #: ../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
18693 #: ../fish/guestfish.pod:154
18694 msgid "Displays general help on options."
18698 #: ../fish/guestfish.pod:156
18703 #: ../fish/guestfish.pod:158
18704 msgid "B<--cmd-help>"
18708 #: ../fish/guestfish.pod:160
18709 msgid "Lists all available guestfish commands."
18713 #: ../fish/guestfish.pod:162
18718 #: ../fish/guestfish.pod:164
18719 msgid "B<--cmd-help cmd>"
18723 #: ../fish/guestfish.pod:166
18724 msgid "Displays detailed help on a single command C<cmd>."
18728 #: ../fish/guestfish.pod:168
18729 msgid "B<-a image>"
18733 #: ../fish/guestfish.pod:170
18734 msgid "B<--add image>"
18738 #: ../fish/guestfish.pod:172
18739 msgid "Add a block device or virtual machine image to the shell."
18743 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
18745 "The format of the disk image is auto-detected. To override this and force a "
18746 "particular format use the I<--format=..> option."
18750 #: ../fish/guestfish.pod:177
18752 "Using this flag is mostly equivalent to using the C<add> command, with "
18753 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
18754 "the I<--format:...> flag was given."
18758 #: ../fish/guestfish.pod:181
18763 #: ../fish/guestfish.pod:183
18764 msgid "B<--connect URI>"
18768 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
18770 "When used in conjunction with the I<-d> option, this specifies the libvirt "
18771 "URI to use. The default is to use the default libvirt connection."
18775 #: ../fish/guestfish.pod:189
18780 #: ../fish/guestfish.pod:191
18782 "If using the I<--listen> option and a csh-like shell, use this option. See "
18783 "section L</REMOTE CONTROL AND CSH> below."
18787 #: ../fish/guestfish.pod:194
18788 msgid "B<-d libvirt-domain>"
18792 #: ../fish/guestfish.pod:196
18793 msgid "B<--domain libvirt-domain>"
18797 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
18799 "Add disks from the named libvirt domain. If the I<--ro> option is also "
18800 "used, then any libvirt domain can be used. However in write mode, only "
18801 "libvirt domains which are shut down can be named here."
18805 #: ../fish/guestfish.pod:202
18807 "Using this flag is mostly equivalent to using the C<add-domain> command, "
18808 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
18809 "if the I<--format:...> flag was given."
18813 #: ../fish/guestfish.pod:206
18818 #: ../fish/guestfish.pod:208
18819 msgid "B<--no-dest-paths>"
18823 #: ../fish/guestfish.pod:210
18825 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
18826 "to hit the tab key to complete paths on the guest filesystem, but this "
18827 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
18828 "allow this feature to be disabled."
18832 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
18833 msgid "B<--echo-keys>"
18837 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
18839 "When prompting for keys and passphrases, guestfish normally turns echoing "
18840 "off so you cannot see what you are typing. If you are not worried about "
18841 "Tempest attacks and there is no one else in the room you can specify this "
18842 "flag to see what you are typing."
18846 #: ../fish/guestfish.pod:222
18851 #: ../fish/guestfish.pod:224
18852 msgid "B<--file file>"
18856 #: ../fish/guestfish.pod:226
18857 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
18861 #: ../fish/guestfish.pod:229
18864 " #!/usr/bin/guestfish -f\n"
18869 #: ../fish/guestfish.pod:231
18870 msgid "B<--format=raw|qcow2|..>"
18874 #: ../fish/guestfish.pod:233
18875 msgid "B<--format>"
18879 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
18881 "The default for the I<-a> option is to auto-detect the format of the disk "
18882 "image. Using this forces the disk format for I<-a> options which follow on "
18883 "the command line. Using I<--format> with no argument switches back to "
18884 "auto-detection for subsequent I<-a> options."
18888 #: ../fish/guestfish.pod:242
18891 " guestfish --format=raw -a disk.img\n"
18896 #: ../fish/guestfish.pod:244
18897 msgid "forces raw format (no auto-detection) for C<disk.img>."
18901 #: ../fish/guestfish.pod:246
18904 " guestfish --format=raw -a disk.img --format -a another.img\n"
18909 #: ../fish/guestfish.pod:248
18911 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18912 "auto-detection for C<another.img>."
18916 #: ../fish/guestfish.pod:251
18918 "If you have untrusted raw-format guest disk images, you should use this "
18919 "option to specify the disk format. This avoids a possible security problem "
18920 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18924 #: ../fish/guestfish.pod:256
18929 #: ../fish/guestfish.pod:258
18930 msgid "B<--inspector>"
18934 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18936 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18937 "system and mount filesystems as they would be mounted on the real virtual "
18942 #: ../fish/guestfish.pod:264
18943 msgid "Typical usage is either:"
18947 #: ../fish/guestfish.pod:266
18950 " guestfish -d myguest -i\n"
18955 #: ../fish/guestfish.pod:268
18956 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18960 #: ../fish/guestfish.pod:270
18963 " guestfish --ro -d myguest -i\n"
18968 #: ../fish/guestfish.pod:272
18969 msgid "(for active domains, readonly), or specify the block device directly:"
18973 #: ../fish/guestfish.pod:274
18976 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18981 #: ../fish/guestfish.pod:276
18983 "Note that the command line syntax changed slightly over older versions of "
18984 "guestfish. You can still use the old syntax:"
18988 #: ../fish/guestfish.pod:279
18991 " guestfish [--ro] -i disk.img\n"
18996 #: ../fish/guestfish.pod:281
18999 " guestfish [--ro] -i libvirt-domain\n"
19004 #: ../fish/guestfish.pod:283
19006 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19007 "then using other commands to mount the filesystems that were found."
19011 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
19012 msgid "B<--keys-from-stdin>"
19016 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
19018 "Read key or passphrase parameters from stdin. The default is to try to read "
19019 "passphrases from the user by opening C</dev/tty>."
19023 #: ../fish/guestfish.pod:292
19024 msgid "B<--listen>"
19028 #: ../fish/guestfish.pod:294
19030 "Fork into the background and listen for remote commands. See section "
19031 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19035 #: ../fish/guestfish.pod:297 ../fuse/guestmount.pod:146
19040 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:148
19042 "Connect to a live virtual machine. (Experimental, see "
19043 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19047 #: ../fish/guestfish.pod:302
19048 msgid "B<-m dev[:mountpoint]>"
19052 #: ../fish/guestfish.pod:304
19053 msgid "B<--mount dev[:mountpoint]>"
19057 #: ../fish/guestfish.pod:306
19058 msgid "Mount the named partition or logical volume on the given mountpoint."
19062 #: ../fish/guestfish.pod:308
19063 msgid "If the mountpoint is omitted, it defaults to C</>."
19067 #: ../fish/guestfish.pod:310
19068 msgid "You have to mount something on C</> before most commands will work."
19072 #: ../fish/guestfish.pod:312
19074 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19079 #: ../fish/guestfish.pod:315
19081 "If you don't know what filesystems a disk image contains, you can either run "
19082 "guestfish without this option, then list the partitions, filesystems and LVs "
19083 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19084 "commands), or you can use the L<virt-filesystems(1)> program."
19088 #: ../fish/guestfish.pod:321
19090 "Using this flag is mostly equivalent to using the C<mount-options> command "
19091 "or the C<mount-ro> command if the I<--ro> flag was given."
19095 #: ../fish/guestfish.pod:324
19100 #: ../fish/guestfish.pod:326
19101 msgid "B<--no-sync>"
19105 #: ../fish/guestfish.pod:328
19107 "Disable autosync. This is enabled by default. See the discussion of "
19108 "autosync in the L<guestfs(3)> manpage."
19112 #: ../fish/guestfish.pod:331
19117 #: ../fish/guestfish.pod:333
19118 msgid "B<--new type>"
19122 #: ../fish/guestfish.pod:335
19127 #: ../fish/guestfish.pod:337
19129 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19130 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19131 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19136 #: ../fish/guestfish.pod:342
19137 msgid "B<--progress-bars>"
19141 #: ../fish/guestfish.pod:344
19142 msgid "Enable progress bars, even when guestfish is used non-interactively."
19146 #: ../fish/guestfish.pod:346
19148 "Progress bars are enabled by default when guestfish is used as an "
19149 "interactive shell."
19153 #: ../fish/guestfish.pod:349
19154 msgid "B<--no-progress-bars>"
19158 #: ../fish/guestfish.pod:351
19159 msgid "Disable progress bars."
19163 #: ../fish/guestfish.pod:353
19164 msgid "B<--remote[=pid]>"
19168 #: ../fish/guestfish.pod:355
19170 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19171 "CONTROL GUESTFISH OVER A SOCKET> below."
19175 #: ../fish/guestfish.pod:358
19180 #: ../fish/guestfish.pod:360
19185 #: ../fish/guestfish.pod:362
19187 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19188 "mounts are done read-only."
19192 #: ../fish/guestfish.pod:365
19194 "The option must always be used if the disk image or virtual machine might be "
19195 "running, and is generally recommended in cases where you don't need write "
19196 "access to the disk."
19200 #: ../fish/guestfish.pod:369
19202 "Note that prepared disk images created with I<-N> are not affected by this "
19203 "option. Also commands like C<add> are not affected - you have to specify "
19204 "the C<readonly:true> option explicitly if you need it."
19208 #: ../fish/guestfish.pod:373
19209 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19213 #: ../fish/guestfish.pod:375 ../fuse/guestmount.pod:213
19214 msgid "B<--selinux>"
19218 #: ../fish/guestfish.pod:377
19219 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19223 #: ../fish/guestfish.pod:379
19228 #: ../fish/guestfish.pod:381
19229 msgid "B<--verbose>"
19233 #: ../fish/guestfish.pod:383
19235 "Enable very verbose messages. This is particularly useful if you find a "
19240 #: ../fish/guestfish.pod:386
19245 #: ../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
19246 msgid "B<--version>"
19250 #: ../fish/guestfish.pod:390
19251 msgid "Display the guestfish / libguestfs version number and exit."
19255 #: ../fish/guestfish.pod:392
19260 #: ../fish/guestfish.pod:394
19265 #: ../fish/guestfish.pod:396
19267 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
19272 #: ../fish/guestfish.pod:399
19277 #: ../fish/guestfish.pod:401
19278 msgid "Echo each command before executing it."
19282 #: ../fish/guestfish.pod:405
19283 msgid "COMMANDS ON COMMAND LINE"
19287 #: ../fish/guestfish.pod:407
19288 msgid "Any additional (non-option) arguments are treated as commands to execute."
19292 #: ../fish/guestfish.pod:410
19294 "Commands to execute should be separated by a colon (C<:>), where the colon "
19295 "is a separate parameter. Thus:"
19299 #: ../fish/guestfish.pod:413
19302 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19307 #: ../fish/guestfish.pod:415
19309 "If there are no additional arguments, then we enter a shell, either an "
19310 "interactive shell with a prompt (if the input is a terminal) or a "
19311 "non-interactive shell."
19315 #: ../fish/guestfish.pod:419
19317 "In either command line mode or non-interactive shell, the first command that "
19318 "gives an error causes the whole shell to exit. In interactive mode (with a "
19319 "prompt) if a command fails, you can continue to enter commands."
19323 #: ../fish/guestfish.pod:424
19324 msgid "USING launch (OR run)"
19328 #: ../fish/guestfish.pod:426
19330 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19331 "then launch it, then mount any disks you need, and finally issue "
19332 "actions/commands. So the general order of the day is:"
19336 #: ../fish/guestfish.pod:434
19337 msgid "add or -a/--add"
19341 #: ../fish/guestfish.pod:438
19342 msgid "launch (aka run)"
19346 #: ../fish/guestfish.pod:442
19347 msgid "mount or -m/--mount"
19351 #: ../fish/guestfish.pod:446
19352 msgid "any other commands"
19356 #: ../fish/guestfish.pod:450
19358 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19359 "guest before mounting or performing any other commands."
19363 #: ../fish/guestfish.pod:453
19365 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19366 "I<--new> options were given then C<run> is done automatically, simply "
19367 "because guestfish can't perform the action you asked for without doing this."
19371 #: ../fish/guestfish.pod:458
19372 msgid "OPENING DISKS FOR READ AND WRITE"
19376 #: ../fish/guestfish.pod:460
19378 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
19379 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
19380 "open disk images read-only or for writing."
19384 #: ../fish/guestfish.pod:464
19386 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
19387 "disk images supplied on the command line for write. To open a disk image "
19388 "read-only you have to do I<-a image --ro>."
19392 #: ../fish/guestfish.pod:468
19394 "This matters: If you accidentally open a live VM disk image writable then "
19395 "you will cause irreversible disk corruption."
19399 #: ../fish/guestfish.pod:471
19401 "By libguestfs 1.10 we intend to change the default the other way. Disk "
19402 "images will be opened read-only. You will have to either specify "
19403 "I<guestfish --rw> or change a configuration file in order to get write "
19404 "access for disk images specified by those other command line options."
19408 #: ../fish/guestfish.pod:476
19410 "This version of guestfish has a I<--rw> option which does nothing (it is "
19411 "already the default). However it is highly recommended that you use this "
19412 "option to indicate that guestfish needs write access, and to prepare your "
19413 "scripts for the day when this option will be required for write access."
19417 #: ../fish/guestfish.pod:482
19419 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
19420 "other libguestfs program apart from guestfish and guestmount."
19424 #: ../fish/guestfish.pod:485
19429 #: ../fish/guestfish.pod:487
19431 "You can quote ordinary parameters using either single or double quotes. For "
19436 #: ../fish/guestfish.pod:490
19439 " add \"file with a space.img\"\n"
19444 #: ../fish/guestfish.pod:492
19447 " rm '/file name'\n"
19452 #: ../fish/guestfish.pod:494
19460 #: ../fish/guestfish.pod:496
19462 "A few commands require a list of strings to be passed. For these, use a "
19463 "whitespace-separated list, enclosed in quotes. Strings containing "
19464 "whitespace to be passed through must be enclosed in single quotes. A "
19465 "literal single quote must be escaped with a backslash."
19469 #: ../fish/guestfish.pod:501
19472 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
19473 " command \"/bin/echo 'foo bar'\"\n"
19474 " command \"/bin/echo \\'foo\\'\"\n"
19479 #: ../fish/guestfish.pod:505
19480 msgid "OPTIONAL ARGUMENTS"
19484 #: ../fish/guestfish.pod:507
19486 "Some commands take optional arguments. These arguments appear in this "
19487 "documentation as C<[argname:..]>. You can use them as in these examples:"
19491 #: ../fish/guestfish.pod:511
19494 " add-drive-opts filename\n"
19499 #: ../fish/guestfish.pod:513
19502 " add-drive-opts filename readonly:true\n"
19507 #: ../fish/guestfish.pod:515
19510 " add-drive-opts filename format:qcow2 readonly:false\n"
19515 #: ../fish/guestfish.pod:517
19517 "Each optional argument can appear at most once. All optional arguments must "
19518 "appear after the required ones."
19522 #: ../fish/guestfish.pod:520
19527 #: ../fish/guestfish.pod:522
19528 msgid "This section applies to all commands which can take integers as parameters."
19532 #: ../fish/guestfish.pod:525
19533 msgid "SIZE SUFFIX"
19537 #: ../fish/guestfish.pod:527
19539 "When the command takes a parameter measured in bytes, you can use one of the "
19540 "following suffixes to specify kilobytes, megabytes and larger sizes:"
19544 #: ../fish/guestfish.pod:533
19545 msgid "B<k> or B<K> or B<KiB>"
19549 #: ../fish/guestfish.pod:535
19550 msgid "The size in kilobytes (multiplied by 1024)."
19554 #: ../fish/guestfish.pod:537
19559 #: ../fish/guestfish.pod:539
19560 msgid "The size in SI 1000 byte units."
19564 #: ../fish/guestfish.pod:541
19565 msgid "B<M> or B<MiB>"
19569 #: ../fish/guestfish.pod:543
19570 msgid "The size in megabytes (multiplied by 1048576)."
19574 #: ../fish/guestfish.pod:545
19579 #: ../fish/guestfish.pod:547
19580 msgid "The size in SI 1000000 byte units."
19584 #: ../fish/guestfish.pod:549
19585 msgid "B<G> or B<GiB>"
19589 #: ../fish/guestfish.pod:551
19590 msgid "The size in gigabytes (multiplied by 2**30)."
19594 #: ../fish/guestfish.pod:553
19599 #: ../fish/guestfish.pod:555
19600 msgid "The size in SI 10**9 byte units."
19604 #: ../fish/guestfish.pod:557
19605 msgid "B<T> or B<TiB>"
19609 #: ../fish/guestfish.pod:559
19610 msgid "The size in terabytes (multiplied by 2**40)."
19614 #: ../fish/guestfish.pod:561
19619 #: ../fish/guestfish.pod:563
19620 msgid "The size in SI 10**12 byte units."
19624 #: ../fish/guestfish.pod:565
19625 msgid "B<P> or B<PiB>"
19629 #: ../fish/guestfish.pod:567
19630 msgid "The size in petabytes (multiplied by 2**50)."
19634 #: ../fish/guestfish.pod:569
19639 #: ../fish/guestfish.pod:571
19640 msgid "The size in SI 10**15 byte units."
19644 #: ../fish/guestfish.pod:573
19645 msgid "B<E> or B<EiB>"
19649 #: ../fish/guestfish.pod:575
19650 msgid "The size in exabytes (multiplied by 2**60)."
19654 #: ../fish/guestfish.pod:577
19659 #: ../fish/guestfish.pod:579
19660 msgid "The size in SI 10**18 byte units."
19664 #: ../fish/guestfish.pod:581
19665 msgid "B<Z> or B<ZiB>"
19669 #: ../fish/guestfish.pod:583
19670 msgid "The size in zettabytes (multiplied by 2**70)."
19674 #: ../fish/guestfish.pod:585
19679 #: ../fish/guestfish.pod:587
19680 msgid "The size in SI 10**21 byte units."
19684 #: ../fish/guestfish.pod:589
19685 msgid "B<Y> or B<YiB>"
19689 #: ../fish/guestfish.pod:591
19690 msgid "The size in yottabytes (multiplied by 2**80)."
19694 #: ../fish/guestfish.pod:593
19699 #: ../fish/guestfish.pod:595
19700 msgid "The size in SI 10**24 byte units."
19704 #: ../fish/guestfish.pod:601
19707 " truncate-size /file 1G\n"
19712 #: ../fish/guestfish.pod:603
19713 msgid "would truncate the file to 1 gigabyte."
19717 #: ../fish/guestfish.pod:605
19719 "Be careful because a few commands take sizes in kilobytes or megabytes "
19720 "(eg. the parameter to L</memsize> is specified in megabytes already). "
19721 "Adding a suffix will probably not do what you expect."
19725 #: ../fish/guestfish.pod:609
19726 msgid "OCTAL AND HEXADECIMAL NUMBERS"
19730 #: ../fish/guestfish.pod:611
19732 "For specifying the radix (base) use the C convention: C<0> to prefix an "
19733 "octal number or C<0x> to prefix a hexadecimal number. For example:"
19737 #: ../fish/guestfish.pod:614
19740 " 1234 decimal number 1234\n"
19741 " 02322 octal number, equivalent to decimal 1234\n"
19742 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
19747 #: ../fish/guestfish.pod:618
19749 "When using the C<chmod> command, you almost always want to specify an octal "
19750 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
19751 "L<chmod(1)> program):"
19755 #: ../fish/guestfish.pod:622
19758 " chmod 0777 /public # OK\n"
19759 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
19764 #: ../fish/guestfish.pod:625
19766 "Commands that return numbers usually print them in decimal, but some "
19767 "commands print numbers in other radices (eg. C<umask> prints the mode in "
19768 "octal, preceeded by C<0>)."
19772 #: ../fish/guestfish.pod:629
19773 msgid "WILDCARDS AND GLOBBING"
19777 #: ../fish/guestfish.pod:631
19779 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
19780 "(globbing) by default. So for example the following will not do what you "
19785 #: ../fish/guestfish.pod:635
19793 #: ../fish/guestfish.pod:637
19795 "Assuming you don't have a directory called literally C</home/*> then the "
19796 "above command will return an error."
19800 #: ../fish/guestfish.pod:640
19801 msgid "To perform wildcard expansion, use the C<glob> command."
19805 #: ../fish/guestfish.pod:642
19808 " glob rm-rf /home/*\n"
19813 #: ../fish/guestfish.pod:644
19815 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
19816 "many times), equivalent to:"
19820 #: ../fish/guestfish.pod:647
19823 " rm-rf /home/jim\n"
19824 " rm-rf /home/joe\n"
19825 " rm-rf /home/mary\n"
19830 #: ../fish/guestfish.pod:651
19831 msgid "C<glob> only works on simple guest paths and not on device names."
19835 #: ../fish/guestfish.pod:653
19837 "If you have several parameters, each containing a wildcard, then glob will "
19838 "perform a Cartesian product."
19842 #: ../fish/guestfish.pod:656
19847 #: ../fish/guestfish.pod:658
19849 "Any line which starts with a I<#> character is treated as a comment and "
19850 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
19851 "a command. For example:"
19855 #: ../fish/guestfish.pod:662
19858 " # this is a comment\n"
19859 " # this is a comment\n"
19860 " foo # NOT a comment\n"
19865 #: ../fish/guestfish.pod:666
19866 msgid "Blank lines are also ignored."
19870 #: ../fish/guestfish.pod:668
19871 msgid "RUNNING COMMANDS LOCALLY"
19875 #: ../fish/guestfish.pod:670
19877 "Any line which starts with a I<!> character is treated as a command sent to "
19878 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
19882 #: ../fish/guestfish.pod:674
19886 " tgz-out /remote local/remote-data.tar.gz\n"
19891 #: ../fish/guestfish.pod:677
19893 "will create a directory C<local> on the host, and then export the contents "
19894 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
19895 "(See C<tgz-out>)."
19899 #: ../fish/guestfish.pod:681
19901 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
19902 "effect, due to the way that subprocesses work in Unix."
19906 #: ../fish/guestfish.pod:684
19907 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
19911 #: ../fish/guestfish.pod:686
19913 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
19914 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
19915 "and executed as guestfish commands."
19919 #: ../fish/guestfish.pod:690
19921 "Thus you can use shell script to construct arbitrary guestfish commands "
19922 "which are then parsed by guestfish."
19926 #: ../fish/guestfish.pod:693
19928 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
19929 "through C</foo.100>) using guestfish commands alone. However this is simple "
19930 "if we use a shell script to create the guestfish commands for us:"
19934 #: ../fish/guestfish.pod:698
19937 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
19942 #: ../fish/guestfish.pod:700
19943 msgid "or with names like C</foo.001>:"
19947 #: ../fish/guestfish.pod:702
19950 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
19955 #: ../fish/guestfish.pod:704
19957 "When using guestfish interactively it can be helpful to just run the shell "
19958 "script first (ie. remove the initial C<E<lt>> character so it is just an "
19959 "ordinary I<!> local command), see what guestfish commands it would run, and "
19960 "when you are happy with those prepend the C<E<lt>> character to run the "
19961 "guestfish commands for real."
19965 #: ../fish/guestfish.pod:710
19970 #: ../fish/guestfish.pod:712
19972 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19973 "command (a guestfish command) to the second command (any host command). For "
19978 #: ../fish/guestfish.pod:716
19981 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19986 #: ../fish/guestfish.pod:718
19988 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19989 "program). The above command would list all accounts in the guest filesystem "
19990 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19994 #: ../fish/guestfish.pod:723
19997 " hexdump /bin/ls | head\n"
19998 " list-devices | tail -1\n"
19999 " tgz-out / - | tar ztf -\n"
20004 #: ../fish/guestfish.pod:727
20006 "The space before the pipe symbol is required, any space after the pipe "
20007 "symbol is optional. Everything after the pipe symbol is just passed "
20008 "straight to the host shell, so it can contain redirections, globs and "
20009 "anything else that makes sense on the host side."
20013 #: ../fish/guestfish.pod:732
20015 "To use a literal argument which begins with a pipe symbol, you have to quote "
20020 #: ../fish/guestfish.pod:735
20028 #: ../fish/guestfish.pod:737
20029 msgid "HOME DIRECTORIES"
20033 #: ../fish/guestfish.pod:739
20035 "If a parameter starts with the character C<~> then the tilde may be expanded "
20036 "as a home directory path (either C<~> for the current user's home directory, "
20037 "or C<~user> for another user)."
20041 #: ../fish/guestfish.pod:743
20043 "Note that home directory expansion happens for users known I<on the host>, "
20044 "not in the guest filesystem."
20048 #: ../fish/guestfish.pod:746
20050 "To use a literal argument which begins with a tilde, you have to quote it, "
20055 #: ../fish/guestfish.pod:749
20063 #: ../fish/guestfish.pod:753
20065 "Libguestfs has some support for Linux guests encrypted according to the "
20066 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20067 "disk encryption systems used by modern Linux guests. Currently only "
20068 "LVM-on-LUKS is supported."
20072 #: ../fish/guestfish.pod:758
20073 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20077 #: ../fish/guestfish.pod:760
20080 " ><fs> vfs-type /dev/sda2\n"
20086 #: ../fish/guestfish.pod:763
20088 "Then open those devices using L</luks-open>. This creates a device-mapper "
20089 "device called C</dev/mapper/luksdev>."
20093 #: ../fish/guestfish.pod:766
20096 " ><fs> luks-open /dev/sda2 luksdev\n"
20097 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20102 #: ../fish/guestfish.pod:769
20104 "Finally you have to tell LVM to scan for volume groups on the newly created "
20109 #: ../fish/guestfish.pod:772
20113 " vg-activate-all true\n"
20118 #: ../fish/guestfish.pod:775
20119 msgid "The logical volume(s) can now be mounted in the usual way."
20123 #: ../fish/guestfish.pod:777
20125 "Before closing a LUKS device you must unmount any logical volumes on it and "
20126 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20127 "one. Then you can close the mapper device:"
20131 #: ../fish/guestfish.pod:781
20134 " vg-activate false /dev/VG\n"
20135 " luks-close /dev/mapper/luksdev\n"
20140 #: ../fish/guestfish.pod:784
20141 msgid "WINDOWS PATHS"
20145 #: ../fish/guestfish.pod:786
20147 "If a path is prefixed with C<win:> then you can use Windows-style paths "
20148 "(with some limitations). The following commands are equivalent:"
20152 #: ../fish/guestfish.pod:789
20155 " file /WINDOWS/system32/config/system.LOG\n"
20160 #: ../fish/guestfish.pod:791
20163 " file win:/windows/system32/config/system.log\n"
20168 #: ../fish/guestfish.pod:793
20171 " file win:\\windows\\system32\\config\\system.log\n"
20176 #: ../fish/guestfish.pod:795
20179 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
20184 #: ../fish/guestfish.pod:797
20186 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
20187 "handles case insensitivity like Windows would. This only works in argument "
20188 "positions that expect a path."
20192 #: ../fish/guestfish.pod:801
20193 msgid "UPLOADING AND DOWNLOADING FILES"
20197 #: ../fish/guestfish.pod:803
20199 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20200 "others which upload from or download to a local file, you can use the "
20201 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20205 #: ../fish/guestfish.pod:807
20213 #: ../fish/guestfish.pod:809
20214 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20218 #: ../fish/guestfish.pod:812
20221 " tar-out /etc - | tar tf -\n"
20226 #: ../fish/guestfish.pod:814
20228 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20229 "command (see L</PIPES>)."
20233 #: ../fish/guestfish.pod:817
20235 "When using C<-> to read from stdin, the input is read up to the end of "
20236 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20237 "some arbitrary end marker:"
20241 #: ../fish/guestfish.pod:821
20244 " upload -<<END /foo\n"
20253 #: ../fish/guestfish.pod:827
20255 "Any string of characters can be used instead of C<END>. The end marker must "
20256 "appear on a line of its own, without any preceeding or following characters "
20257 "(not even spaces)."
20261 #: ../fish/guestfish.pod:831
20263 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20264 "upload local files (so-called \"FileIn\" parameters in the generator)."
20268 #: ../fish/guestfish.pod:834
20269 msgid "EXIT ON ERROR BEHAVIOUR"
20273 #: ../fish/guestfish.pod:836
20275 "By default, guestfish will ignore any errors when in interactive mode "
20276 "(ie. taking commands from a human over a tty), and will exit on the first "
20277 "error in non-interactive mode (scripts, commands given on the command line)."
20281 #: ../fish/guestfish.pod:841
20283 "If you prefix a command with a I<-> character, then that command will not "
20284 "cause guestfish to exit, even if that (one) command returns an error."
20288 #: ../fish/guestfish.pod:845
20289 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20293 #: ../fish/guestfish.pod:847
20295 "Guestfish can be remote-controlled over a socket. This is useful "
20296 "particularly in shell scripts where you want to make several different "
20297 "changes to a filesystem, but you don't want the overhead of starting up a "
20298 "guestfish process each time."
20302 #: ../fish/guestfish.pod:852
20303 msgid "Start a guestfish server process using:"
20307 #: ../fish/guestfish.pod:854
20310 " eval \"`guestfish --listen`\"\n"
20315 #: ../fish/guestfish.pod:856
20316 msgid "and then send it commands by doing:"
20320 #: ../fish/guestfish.pod:858
20323 " guestfish --remote cmd [...]\n"
20328 #: ../fish/guestfish.pod:860
20329 msgid "To cause the server to exit, send it the exit command:"
20333 #: ../fish/guestfish.pod:862
20336 " guestfish --remote exit\n"
20341 #: ../fish/guestfish.pod:864
20343 "Note that the server will normally exit if there is an error in a command. "
20344 "You can change this in the usual way. See section L</EXIT ON ERROR "
20349 #: ../fish/guestfish.pod:868
20350 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20354 #: ../fish/guestfish.pod:870
20356 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20357 "is how the I<--remote> option knows where to send the commands. You can "
20358 "have several guestfish listener processes running using:"
20362 #: ../fish/guestfish.pod:874
20365 " eval \"`guestfish --listen`\"\n"
20366 " pid1=$GUESTFISH_PID\n"
20367 " eval \"`guestfish --listen`\"\n"
20368 " pid2=$GUESTFISH_PID\n"
20370 " guestfish --remote=$pid1 cmd\n"
20371 " guestfish --remote=$pid2 cmd\n"
20376 #: ../fish/guestfish.pod:882
20377 msgid "REMOTE CONTROL AND CSH"
20381 #: ../fish/guestfish.pod:884
20383 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
20388 #: ../fish/guestfish.pod:887
20391 " eval \"`guestfish --listen --csh`\"\n"
20396 #: ../fish/guestfish.pod:889
20397 msgid "REMOTE CONTROL DETAILS"
20401 #: ../fish/guestfish.pod:891
20403 "Remote control happens over a Unix domain socket called "
20404 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
20405 "of the process, and C<$PID> is the process ID of the server."
20409 #: ../fish/guestfish.pod:895
20410 msgid "Guestfish client and server versions must match exactly."
20414 #: ../fish/guestfish.pod:897
20415 msgid "PREPARED DISK IMAGES"
20419 #: ../fish/guestfish.pod:899
20421 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
20422 "preformatted disk images that guestfish can make for you to save typing. "
20423 "This is particularly useful for testing purposes. This option is used "
20424 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
20425 "can be mixed with I<-a>)."
20429 #: ../fish/guestfish.pod:905
20431 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
20432 "the second and so on. Existing files in the current directory are "
20437 #: ../fish/guestfish.pod:909
20439 "The type briefly describes how the disk should be sized, partitioned, how "
20440 "filesystem(s) should be created, and how content should be added. "
20441 "Optionally the type can be followed by extra parameters, separated by C<:> "
20442 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
20443 "sparsely-allocated disk, containing a single partition, with the partition "
20444 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
20445 "on a 1GB disk instead."
20449 #: ../fish/guestfish.pod:917
20450 msgid "To list the available types and any extra parameters they take, run:"
20454 #: ../fish/guestfish.pod:921
20456 "Note that the prepared filesystem is not mounted. You would usually have to "
20457 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
20461 #: ../fish/guestfish.pod:925
20463 "If any I<-N> or I<--new> options are given, the guest is automatically "
20468 #: ../fish/guestfish.pod:930
20469 msgid "Create a 100MB disk with an ext4-formatted partition:"
20473 #: ../fish/guestfish.pod:932
20476 " guestfish -N fs:ext4\n"
20481 #: ../fish/guestfish.pod:934
20482 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
20486 #: ../fish/guestfish.pod:936
20489 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
20494 #: ../fish/guestfish.pod:938
20495 msgid "Create a blank 200MB disk:"
20499 #: ../fish/guestfish.pod:940
20502 " guestfish -N disk:200M\n"
20507 #: ../fish/guestfish.pod:942
20508 msgid "PROGRESS BARS"
20512 #: ../fish/guestfish.pod:944
20514 "Some (not all) long-running commands send progress notification messages as "
20515 "they are running. Guestfish turns these messages into progress bars."
20519 #: ../fish/guestfish.pod:948
20521 "When a command that supports progress bars takes longer than two seconds to "
20522 "run, and if progress bars are enabled, then you will see one appearing below "
20527 #: ../fish/guestfish.pod:952
20530 " ><fs> copy-size /large-file /another-file 2048M\n"
20531 " / 10% [#####-----------------------------------------] 00:30\n"
20536 #: ../fish/guestfish.pod:955
20538 "The spinner on the left hand side moves round once for every progress "
20539 "notification received from the backend. This is a (reasonably) golden "
20540 "assurance that the command is \"doing something\" even if the progress bar "
20541 "is not moving, because the command is able to send the progress "
20542 "notifications. When the bar reaches 100% and the command finishes, the "
20543 "spinner disappears."
20547 #: ../fish/guestfish.pod:962
20549 "Progress bars are enabled by default when guestfish is used interactively. "
20550 "You can enable them even for non-interactive modes using I<--progress-bars>, "
20551 "and you can disable them completely using I<--no-progress-bars>."
20555 #: ../fish/guestfish.pod:967
20556 msgid "GUESTFISH COMMANDS"
20560 #: ../fish/guestfish.pod:969
20562 "The commands in this section are guestfish convenience commands, in other "
20563 "words, they are not part of the L<guestfs(3)> API."
20567 #: ../fish/guestfish.pod:972
20572 #: ../fish/guestfish.pod:974
20581 #: ../fish/guestfish.pod:977
20582 msgid "Without any parameter, this provides general help."
20586 #: ../fish/guestfish.pod:979
20587 msgid "With a C<cmd> parameter, this displays detailed help for that command."
20591 #: ../fish/guestfish.pod:981
20592 msgid "quit | exit"
20596 #: ../fish/guestfish.pod:983
20597 msgid "This exits guestfish. You can also use C<^D> key."
20601 #: ../fish/guestfish.pod:985
20602 msgid "@FISH_COMMANDS@"
20606 #: ../fish/guestfish.pod:987
20611 #: ../fish/guestfish.pod:991 ../test-tool/libguestfs-test-tool.pod:83
20616 #: ../fish/guestfish.pod:993
20618 "guestfish returns 0 if the commands completed without error, or 1 if there "
20623 #: ../fish/guestfish.pod:1000
20628 #: ../fish/guestfish.pod:1002
20630 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
20635 #: ../fish/guestfish.pod:1005
20636 msgid "GUESTFISH_PID"
20640 #: ../fish/guestfish.pod:1007
20642 "Used with the I<--remote> option to specify the remote guestfish process to "
20643 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
20647 #: ../fish/guestfish.pod:1011
20652 #: ../fish/guestfish.pod:1013
20654 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
20655 "not specified, the external L<hexedit(1)> program is used."
20659 #: ../fish/guestfish.pod:1017
20664 #: ../fish/guestfish.pod:1019
20666 "If compiled with GNU readline support, various files in the home directory "
20667 "can be used. See L</FILES>."
20671 #: ../fish/guestfish.pod:1028
20673 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
20674 "effect as using the B<-v> option."
20678 #: ../fish/guestfish.pod:1040
20680 "Set the path that guestfish uses to search for kernel and initrd.img. See "
20681 "the discussion of paths in L<guestfs(3)>."
20685 #: ../fish/guestfish.pod:1051
20686 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
20690 #: ../fish/guestfish.pod:1053
20695 #: ../fish/guestfish.pod:1055
20697 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
20702 #: ../fish/guestfish.pod:1071 ../test-tool/libguestfs-test-tool.pod:88
20707 #: ../fish/guestfish.pod:1075
20708 msgid "$HOME/.guestfish"
20712 #: ../fish/guestfish.pod:1077
20714 "If compiled with GNU readline support, then the command history is saved in "
20719 #: ../fish/guestfish.pod:1080
20720 msgid "$HOME/.inputrc"
20724 #: ../fish/guestfish.pod:1082
20725 msgid "/etc/inputrc"
20729 #: ../fish/guestfish.pod:1084
20731 "If compiled with GNU readline support, then these files can be used to "
20732 "configure readline. For further information, please see "
20733 "L<readline(3)/INITIALIZATION FILE>."
20737 #: ../fish/guestfish.pod:1088
20738 msgid "To write rules which only apply to guestfish, use:"
20742 #: ../fish/guestfish.pod:1090
20752 #: ../fish/guestfish.pod:1094
20754 "Variables that you can set in inputrc that change the behaviour of guestfish "
20755 "in useful ways include:"
20759 #: ../fish/guestfish.pod:1099
20760 msgid "completion-ignore-case (default: on)"
20764 #: ../fish/guestfish.pod:1101
20766 "By default, guestfish will ignore case when tab-completing paths on the "
20771 #: ../fish/guestfish.pod:1104
20774 " set completion-ignore-case off\n"
20779 #: ../fish/guestfish.pod:1106
20780 msgid "to make guestfish case sensitive."
20784 #: ../fish/guestfish.pod:1110
20789 #: ../fish/guestfish.pod:1112
20790 msgid "test2.img (etc)"
20794 #: ../fish/guestfish.pod:1114
20796 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
20797 "will be created in the file C<test1.img> in the current directory. The "
20798 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
20799 "the same name will be overwritten."
20803 #: ../fish/guestfish.pod:1123
20805 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
20806 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
20807 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
20808 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
20809 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
20810 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
20814 #: ../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:1518 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
20816 "This program is free software; you can redistribute it and/or modify it "
20817 "under the terms of the GNU General Public License as published by the Free "
20818 "Software Foundation; either version 2 of the License, or (at your option) "
20819 "any later version."
20823 #: ../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:1523 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
20825 "This program is distributed in the hope that it will be useful, but WITHOUT "
20826 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
20827 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
20832 #: ../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:1528 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
20834 "You should have received a copy of the GNU General Public License along with "
20835 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
20836 "Ave, Cambridge, MA 02139, USA."
20840 #: ../fish/guestfish-actions.pod:1
20845 #: ../fish/guestfish-actions.pod:3
20848 " add-cdrom filename\n"
20853 #: ../fish/guestfish-actions.pod:15
20855 "This call checks for the existence of C<filename>. This stops you from "
20856 "specifying other types of drive which are supported by qemu such as C<nbd:> "
20857 "and C<http:> URLs. To specify those, use the general L</config> call "
20862 #: ../fish/guestfish-actions.pod:22
20864 "If you just want to add an ISO file (often you use this as an efficient way "
20865 "to transfer large files into the guest), then you should probably use "
20866 "L</add-drive-ro> instead."
20870 #: ../fish/guestfish-actions.pod:35
20875 #: ../fish/guestfish-actions.pod:37
20880 #: ../fish/guestfish-actions.pod:39
20883 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..]\n"
20888 #: ../fish/guestfish-actions.pod:41
20890 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
20891 "It works by connecting to libvirt, requesting the domain and domain XML from "
20892 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
20896 #: ../fish/guestfish-actions.pod:71
20898 "The other optional parameters are passed directly through to "
20899 "L</add-drive-opts>."
20903 #: ../fish/guestfish-actions.pod:74 ../fish/guestfish-actions.pod:138 ../fish/guestfish-actions.pod:2977
20905 "This command has one or more optional arguments. See L</OPTIONAL "
20910 #: ../fish/guestfish-actions.pod:76
20915 #: ../fish/guestfish-actions.pod:78
20918 " add-drive filename\n"
20923 #: ../fish/guestfish-actions.pod:80
20925 "This function is the equivalent of calling L</add-drive-opts> with no "
20926 "optional parameters, so the disk is added writable, with the format being "
20927 "detected automatically."
20931 #: ../fish/guestfish-actions.pod:84
20933 "Automatic detection of the format opens you up to a potential security hole "
20934 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
20935 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
20936 "you should think about replacing calls to this function with calls to "
20937 "L</add-drive-opts>, and specifying the format."
20941 #: ../fish/guestfish-actions.pod:91
20942 msgid "add-drive-opts"
20946 #: ../fish/guestfish-actions.pod:93
20951 #: ../fish/guestfish-actions.pod:95
20954 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
20959 #: ../fish/guestfish-actions.pod:122
20961 "This forces the image format. If you omit this (or use L</add-drive> or "
20962 "L</add-drive-ro>) then the format is automatically detected. Possible "
20963 "formats include C<raw> and C<qcow2>."
20967 #: ../fish/guestfish-actions.pod:133
20969 "This rarely-used option lets you emulate the behaviour of the deprecated "
20970 "L</add-drive-with-if> call (q.v.)"
20974 #: ../fish/guestfish-actions.pod:140
20975 msgid "add-drive-ro"
20979 #: ../fish/guestfish-actions.pod:142
20984 #: ../fish/guestfish-actions.pod:144
20987 " add-drive-ro filename\n"
20992 #: ../fish/guestfish-actions.pod:146
20994 "This function is the equivalent of calling L</add-drive-opts> with the "
20995 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20996 "is added read-only, with the format being detected automatically."
21000 #: ../fish/guestfish-actions.pod:151
21001 msgid "add-drive-ro-with-if"
21005 #: ../fish/guestfish-actions.pod:153
21008 " add-drive-ro-with-if filename iface\n"
21013 #: ../fish/guestfish-actions.pod:155
21015 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21016 "interface emulation to use at run time."
21020 #: ../fish/guestfish-actions.pod:165
21021 msgid "add-drive-with-if"
21025 #: ../fish/guestfish-actions.pod:167
21028 " add-drive-with-if filename iface\n"
21033 #: ../fish/guestfish-actions.pod:169
21035 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21036 "interface emulation to use at run time."
21040 #: ../fish/guestfish-actions.pod:179
21045 #: ../fish/guestfish-actions.pod:181
21048 " aug-clear augpath\n"
21053 #: ../fish/guestfish-actions.pod:186
21058 #: ../fish/guestfish-actions.pod:188
21066 #: ../fish/guestfish-actions.pod:190
21068 "Close the current Augeas handle and free up any resources used by it. After "
21069 "calling this, you have to call L</aug-init> again before you can use any "
21070 "other Augeas functions."
21074 #: ../fish/guestfish-actions.pod:195
21075 msgid "aug-defnode"
21079 #: ../fish/guestfish-actions.pod:197
21082 " aug-defnode name expr val\n"
21087 #: ../fish/guestfish-actions.pod:202
21089 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21090 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21091 "containing that single node."
21095 #: ../fish/guestfish-actions.pod:210
21100 #: ../fish/guestfish-actions.pod:212
21103 " aug-defvar name expr\n"
21108 #: ../fish/guestfish-actions.pod:221
21113 #: ../fish/guestfish-actions.pod:223
21116 " aug-get augpath\n"
21121 #: ../fish/guestfish-actions.pod:228
21126 #: ../fish/guestfish-actions.pod:230
21129 " aug-init root flags\n"
21134 #: ../fish/guestfish-actions.pod:236
21135 msgid "You must call this before using any other L</aug-*> commands."
21139 #: ../fish/guestfish-actions.pod:271
21140 msgid "Do not load the tree in L</aug-init>."
21144 #: ../fish/guestfish-actions.pod:275
21145 msgid "To close the handle, you can call L</aug-close>."
21149 #: ../fish/guestfish-actions.pod:279
21154 #: ../fish/guestfish-actions.pod:281
21157 " aug-insert augpath label true|false\n"
21162 #: ../fish/guestfish-actions.pod:291
21167 #: ../fish/guestfish-actions.pod:293
21175 #: ../fish/guestfish-actions.pod:300
21180 #: ../fish/guestfish-actions.pod:302
21183 " aug-ls augpath\n"
21188 #: ../fish/guestfish-actions.pod:304
21190 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21191 "resulting nodes into alphabetical order."
21195 #: ../fish/guestfish-actions.pod:307
21200 #: ../fish/guestfish-actions.pod:309
21203 " aug-match augpath\n"
21208 #: ../fish/guestfish-actions.pod:315
21213 #: ../fish/guestfish-actions.pod:317
21216 " aug-mv src dest\n"
21221 #: ../fish/guestfish-actions.pod:322
21226 #: ../fish/guestfish-actions.pod:324
21229 " aug-rm augpath\n"
21234 #: ../fish/guestfish-actions.pod:330
21239 #: ../fish/guestfish-actions.pod:332
21247 #: ../fish/guestfish-actions.pod:336
21249 "The flags which were passed to L</aug-init> affect exactly how files are "
21254 #: ../fish/guestfish-actions.pod:339
21259 #: ../fish/guestfish-actions.pod:341
21262 " aug-set augpath val\n"
21267 #: ../fish/guestfish-actions.pod:345
21269 "In the Augeas API, it is possible to clear a node by setting the value to "
21270 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21271 "this call. Instead you must use the L</aug-clear> call."
21275 #: ../fish/guestfish-actions.pod:350
21280 #: ../fish/guestfish-actions.pod:352
21283 " available 'groups ...'\n"
21288 #: ../fish/guestfish-actions.pod:358
21290 "The libguestfs groups, and the functions that those groups correspond to, "
21291 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21292 "runtime by calling L</available-all-groups>."
21296 #: ../fish/guestfish-actions.pod:382
21297 msgid "You must call L</launch> before calling this function."
21301 #: ../fish/guestfish-actions.pod:404
21303 "This call was added in version C<1.0.80>. In previous versions of "
21304 "libguestfs all you could do would be to speculatively execute a command to "
21305 "find out if the daemon implemented it. See also L</version>."
21309 #: ../fish/guestfish-actions.pod:411
21310 msgid "available-all-groups"
21314 #: ../fish/guestfish-actions.pod:413
21317 " available-all-groups\n"
21322 #: ../fish/guestfish-actions.pod:415
21324 "This command returns a list of all optional groups that this daemon knows "
21325 "about. Note this returns both supported and unsupported groups. To find "
21326 "out which ones the daemon can actually support you have to call "
21327 "L</available> on each member of the returned list."
21331 #: ../fish/guestfish-actions.pod:421
21332 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
21336 #: ../fish/guestfish-actions.pod:423
21341 #: ../fish/guestfish-actions.pod:425
21344 " base64-in (base64file|-) filename\n"
21349 #: ../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:4375 ../fish/guestfish-actions.pod:4387 ../fish/guestfish-actions.pod:4398 ../fish/guestfish-actions.pod:4409 ../fish/guestfish-actions.pod:4461 ../fish/guestfish-actions.pod:4470 ../fish/guestfish-actions.pod:4524 ../fish/guestfish-actions.pod:4547
21350 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
21354 #: ../fish/guestfish-actions.pod:432
21359 #: ../fish/guestfish-actions.pod:434
21362 " base64-out filename (base64file|-)\n"
21367 #: ../fish/guestfish-actions.pod:441
21368 msgid "blockdev-flushbufs"
21372 #: ../fish/guestfish-actions.pod:443
21375 " blockdev-flushbufs device\n"
21380 #: ../fish/guestfish-actions.pod:450
21381 msgid "blockdev-getbsz"
21385 #: ../fish/guestfish-actions.pod:452
21388 " blockdev-getbsz device\n"
21393 #: ../fish/guestfish-actions.pod:461
21394 msgid "blockdev-getro"
21398 #: ../fish/guestfish-actions.pod:463
21401 " blockdev-getro device\n"
21406 #: ../fish/guestfish-actions.pod:470
21407 msgid "blockdev-getsize64"
21411 #: ../fish/guestfish-actions.pod:472
21414 " blockdev-getsize64 device\n"
21419 #: ../fish/guestfish-actions.pod:476
21420 msgid "See also L</blockdev-getsz>."
21424 #: ../fish/guestfish-actions.pod:480
21425 msgid "blockdev-getss"
21429 #: ../fish/guestfish-actions.pod:482
21432 " blockdev-getss device\n"
21437 #: ../fish/guestfish-actions.pod:487
21438 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
21442 #: ../fish/guestfish-actions.pod:492
21443 msgid "blockdev-getsz"
21447 #: ../fish/guestfish-actions.pod:494
21450 " blockdev-getsz device\n"
21455 #: ../fish/guestfish-actions.pod:499
21457 "See also L</blockdev-getss> for the real sector size of the device, and "
21458 "L</blockdev-getsize64> for the more useful I<size in bytes>."
21462 #: ../fish/guestfish-actions.pod:505
21463 msgid "blockdev-rereadpt"
21467 #: ../fish/guestfish-actions.pod:507
21470 " blockdev-rereadpt device\n"
21475 #: ../fish/guestfish-actions.pod:513
21476 msgid "blockdev-setbsz"
21480 #: ../fish/guestfish-actions.pod:515
21483 " blockdev-setbsz device blocksize\n"
21488 #: ../fish/guestfish-actions.pod:524
21489 msgid "blockdev-setro"
21493 #: ../fish/guestfish-actions.pod:526
21496 " blockdev-setro device\n"
21501 #: ../fish/guestfish-actions.pod:532
21502 msgid "blockdev-setrw"
21506 #: ../fish/guestfish-actions.pod:534
21509 " blockdev-setrw device\n"
21514 #: ../fish/guestfish-actions.pod:540
21515 msgid "case-sensitive-path"
21519 #: ../fish/guestfish-actions.pod:542
21522 " case-sensitive-path path\n"
21527 #: ../fish/guestfish-actions.pod:566
21529 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
21530 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
21531 "how the directories were originally created under Windows)."
21535 #: ../fish/guestfish-actions.pod:574
21536 msgid "See also L</realpath>."
21540 #: ../fish/guestfish-actions.pod:576
21545 #: ../fish/guestfish-actions.pod:578
21553 #: ../fish/guestfish-actions.pod:582
21555 "Note that this function cannot correctly handle binary files (specifically, "
21556 "files containing C<\\0> character which is treated as end of string). For "
21557 "those you need to use the L</read-file> or L</download> functions which have "
21558 "a more complex interface."
21562 #: ../fish/guestfish-actions.pod:590
21567 #: ../fish/guestfish-actions.pod:592
21570 " checksum csumtype path\n"
21575 #: ../fish/guestfish-actions.pod:635
21576 msgid "To get the checksum for a device, use L</checksum-device>."
21580 #: ../fish/guestfish-actions.pod:637
21581 msgid "To get the checksums for many files, use L</checksums-out>."
21585 #: ../fish/guestfish-actions.pod:639
21586 msgid "checksum-device"
21590 #: ../fish/guestfish-actions.pod:641
21593 " checksum-device csumtype device\n"
21598 #: ../fish/guestfish-actions.pod:643
21600 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
21601 "device named C<device>. For the types of checksums supported see the "
21602 "L</checksum> command."
21606 #: ../fish/guestfish-actions.pod:647
21607 msgid "checksums-out"
21611 #: ../fish/guestfish-actions.pod:649
21614 " checksums-out csumtype directory (sumsfile|-)\n"
21619 #: ../fish/guestfish-actions.pod:665
21624 #: ../fish/guestfish-actions.pod:667
21627 " chmod mode path\n"
21632 #: ../fish/guestfish-actions.pod:678
21637 #: ../fish/guestfish-actions.pod:680
21640 " chown owner group path\n"
21645 #: ../fish/guestfish-actions.pod:688
21650 #: ../fish/guestfish-actions.pod:690
21653 " command 'arguments ...'\n"
21658 #: ../fish/guestfish-actions.pod:697
21660 "The single parameter is an argv-style list of arguments. The first element "
21661 "is the name of the program to run. Subsequent elements are parameters. The "
21662 "list must be non-empty (ie. must contain a program name). Note that the "
21663 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
21667 #: ../fish/guestfish-actions.pod:725
21668 msgid "command-lines"
21672 #: ../fish/guestfish-actions.pod:727
21675 " command-lines 'arguments ...'\n"
21680 #: ../fish/guestfish-actions.pod:729
21681 msgid "This is the same as L</command>, but splits the result into a list of lines."
21685 #: ../fish/guestfish-actions.pod:732
21686 msgid "See also: L</sh-lines>"
21690 #: ../fish/guestfish-actions.pod:737
21695 #: ../fish/guestfish-actions.pod:739
21698 " config qemuparam qemuvalue\n"
21703 #: ../fish/guestfish-actions.pod:750
21708 #: ../fish/guestfish-actions.pod:752
21711 " copy-size src dest size\n"
21716 #: ../fish/guestfish-actions.pod:760
21721 #: ../fish/guestfish-actions.pod:762
21729 #: ../fish/guestfish-actions.pod:767
21734 #: ../fish/guestfish-actions.pod:769
21742 #: ../fish/guestfish-actions.pod:774
21747 #: ../fish/guestfish-actions.pod:776
21755 #: ../fish/guestfish-actions.pod:783
21757 "If the destination is a device, it must be as large or larger than the "
21758 "source file or device, otherwise the copy will fail. This command cannot do "
21759 "partial copies (see L</copy-size>)."
21763 #: ../fish/guestfish-actions.pod:787
21768 #: ../fish/guestfish-actions.pod:789
21776 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:804
21778 "This command is mostly useful for interactive sessions. It is I<not> "
21779 "intended that you try to parse the output string. Use L</statvfs> from "
21784 #: ../fish/guestfish-actions.pod:797
21789 #: ../fish/guestfish-actions.pod:799
21797 #: ../fish/guestfish-actions.pod:808
21802 #: ../fish/guestfish-actions.pod:810
21810 #: ../fish/guestfish-actions.pod:816
21812 "Another way to get the same information is to enable verbose messages with "
21813 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
21814 "before running the program."
21818 #: ../fish/guestfish-actions.pod:821
21823 #: ../fish/guestfish-actions.pod:823
21826 " download remotefilename (filename|-)\n"
21831 #: ../fish/guestfish-actions.pod:830
21832 msgid "See also L</upload>, L</cat>."
21836 #: ../fish/guestfish-actions.pod:834
21837 msgid "download-offset"
21841 #: ../fish/guestfish-actions.pod:836
21844 " download-offset remotefilename (filename|-) offset size\n"
21849 #: ../fish/guestfish-actions.pod:844
21851 "Note that there is no limit on the amount of data that can be downloaded "
21852 "with this call, unlike with L</pread>, and this call always reads the full "
21853 "amount unless an error occurs."
21857 #: ../fish/guestfish-actions.pod:849
21858 msgid "See also L</download>, L</pread>."
21862 #: ../fish/guestfish-actions.pod:853
21863 msgid "drop-caches"
21867 #: ../fish/guestfish-actions.pod:855
21870 " drop-caches whattodrop\n"
21875 #: ../fish/guestfish-actions.pod:867
21880 #: ../fish/guestfish-actions.pod:869
21888 #: ../fish/guestfish-actions.pod:881
21893 #: ../fish/guestfish-actions.pod:883
21896 " e2fsck-f device\n"
21901 #: ../fish/guestfish-actions.pod:889
21903 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
21904 "should use L</fsck>."
21908 #: ../fish/guestfish-actions.pod:892
21909 msgid "echo-daemon"
21913 #: ../fish/guestfish-actions.pod:894
21916 " echo-daemon 'words ...'\n"
21921 #: ../fish/guestfish-actions.pod:901
21922 msgid "See also L</ping-daemon>."
21926 #: ../fish/guestfish-actions.pod:903
21931 #: ../fish/guestfish-actions.pod:905
21934 " egrep regex path\n"
21939 #: ../fish/guestfish-actions.pod:913
21944 #: ../fish/guestfish-actions.pod:915
21947 " egrepi regex path\n"
21952 #: ../fish/guestfish-actions.pod:923
21957 #: ../fish/guestfish-actions.pod:925
21960 " equal file1 file2\n"
21965 #: ../fish/guestfish-actions.pod:932
21970 #: ../fish/guestfish-actions.pod:934
21978 #: ../fish/guestfish-actions.pod:939
21979 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21983 #: ../fish/guestfish-actions.pod:941
21988 #: ../fish/guestfish-actions.pod:943
21991 " fallocate path len\n"
21996 #: ../fish/guestfish-actions.pod:960
21997 msgid "fallocate64"
22001 #: ../fish/guestfish-actions.pod:962
22004 " fallocate64 path len\n"
22009 #: ../fish/guestfish-actions.pod:968
22011 "Note that this call allocates disk blocks for the file. To create a sparse "
22012 "file use L</truncate-size> instead."
22016 #: ../fish/guestfish-actions.pod:971
22018 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22019 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22020 "maximum size of files created through that call to 1GB."
22024 #: ../fish/guestfish-actions.pod:980
22029 #: ../fish/guestfish-actions.pod:982
22032 " fgrep pattern path\n"
22037 #: ../fish/guestfish-actions.pod:990
22042 #: ../fish/guestfish-actions.pod:992
22045 " fgrepi pattern path\n"
22050 #: ../fish/guestfish-actions.pod:1000
22055 #: ../fish/guestfish-actions.pod:1002
22063 #: ../fish/guestfish-actions.pod:1014
22065 "This command can also be used on C</dev/> devices (and partitions, LV "
22066 "names). You can for example use this to determine if a device contains a "
22067 "filesystem, although it's usually better to use L</vfs-type>."
22071 #: ../fish/guestfish-actions.pod:1024
22072 msgid "file-architecture"
22076 #: ../fish/guestfish-actions.pod:1026
22079 " file-architecture filename\n"
22084 #: ../fish/guestfish-actions.pod:1129
22089 #: ../fish/guestfish-actions.pod:1131
22097 #: ../fish/guestfish-actions.pod:1135
22099 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22100 "L</is-file> etc. To get the size of block devices, use "
22101 "L</blockdev-getsize64>."
22105 #: ../fish/guestfish-actions.pod:1139
22110 #: ../fish/guestfish-actions.pod:1141
22113 " fill c len path\n"
22118 #: ../fish/guestfish-actions.pod:1147
22120 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22121 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22122 "L</fill-pattern>."
22126 #: ../fish/guestfish-actions.pod:1152
22127 msgid "fill-pattern"
22131 #: ../fish/guestfish-actions.pod:1154
22134 " fill-pattern pattern len path\n"
22139 #: ../fish/guestfish-actions.pod:1156
22141 "This function is like L</fill> except that it creates a new file of length "
22142 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22143 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22148 #: ../fish/guestfish-actions.pod:1161
22153 #: ../fish/guestfish-actions.pod:1163
22156 " find directory\n"
22161 #: ../fish/guestfish-actions.pod:1177
22162 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22166 #: ../fish/guestfish-actions.pod:1190
22167 msgid "See also L</find0>."
22171 #: ../fish/guestfish-actions.pod:1195
22176 #: ../fish/guestfish-actions.pod:1197
22179 " find0 directory (files|-)\n"
22184 #: ../fish/guestfish-actions.pod:1203
22185 msgid "This command works the same way as L</find> with the following exceptions:"
22189 #: ../fish/guestfish-actions.pod:1230
22190 msgid "findfs-label"
22194 #: ../fish/guestfish-actions.pod:1232
22197 " findfs-label label\n"
22202 #: ../fish/guestfish-actions.pod:1238
22203 msgid "To find the label of a filesystem, use L</vfs-label>."
22207 #: ../fish/guestfish-actions.pod:1240
22208 msgid "findfs-uuid"
22212 #: ../fish/guestfish-actions.pod:1242
22215 " findfs-uuid uuid\n"
22220 #: ../fish/guestfish-actions.pod:1248
22221 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22225 #: ../fish/guestfish-actions.pod:1250
22230 #: ../fish/guestfish-actions.pod:1252
22233 " fsck fstype device\n"
22238 #: ../fish/guestfish-actions.pod:1282
22243 #: ../fish/guestfish-actions.pod:1284
22251 #: ../fish/guestfish-actions.pod:1291
22252 msgid "get-attach-method"
22256 #: ../fish/guestfish-actions.pod:1293
22259 " get-attach-method\n"
22264 #: ../fish/guestfish-actions.pod:1295
22265 msgid "Return the current attach method. See L</set-attach-method>."
22269 #: ../fish/guestfish-actions.pod:1297
22270 msgid "get-autosync"
22274 #: ../fish/guestfish-actions.pod:1299
22282 #: ../fish/guestfish-actions.pod:1303
22287 #: ../fish/guestfish-actions.pod:1305
22295 #: ../fish/guestfish-actions.pod:1309
22296 msgid "get-e2label"
22300 #: ../fish/guestfish-actions.pod:1311
22303 " get-e2label device\n"
22308 #: ../fish/guestfish-actions.pod:1323
22313 #: ../fish/guestfish-actions.pod:1325
22316 " get-e2uuid device\n"
22321 #: ../fish/guestfish-actions.pod:1337
22322 msgid "get-memsize"
22326 #: ../fish/guestfish-actions.pod:1339
22334 #: ../fish/guestfish-actions.pod:1344
22336 "If L</set-memsize> was not called on this handle, and if "
22337 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
22338 "value for memsize."
22342 #: ../fish/guestfish-actions.pod:1351
22343 msgid "get-network"
22347 #: ../fish/guestfish-actions.pod:1353
22355 #: ../fish/guestfish-actions.pod:1357
22360 #: ../fish/guestfish-actions.pod:1359
22368 #: ../fish/guestfish-actions.pod:1366
22373 #: ../fish/guestfish-actions.pod:1368
22378 #: ../fish/guestfish-actions.pod:1370
22386 #: ../fish/guestfish-actions.pod:1377
22391 #: ../fish/guestfish-actions.pod:1379
22399 #: ../fish/guestfish-actions.pod:1386
22400 msgid "get-recovery-proc"
22404 #: ../fish/guestfish-actions.pod:1388
22407 " get-recovery-proc\n"
22412 #: ../fish/guestfish-actions.pod:1392
22413 msgid "get-selinux"
22417 #: ../fish/guestfish-actions.pod:1394
22425 #: ../fish/guestfish-actions.pod:1396
22427 "This returns the current setting of the selinux flag which is passed to the "
22428 "appliance at boot time. See L</set-selinux>."
22432 #: ../fish/guestfish-actions.pod:1402
22437 #: ../fish/guestfish-actions.pod:1404
22445 #: ../fish/guestfish-actions.pod:1411
22450 #: ../fish/guestfish-actions.pod:1413
22458 #: ../fish/guestfish-actions.pod:1417
22463 #: ../fish/guestfish-actions.pod:1419
22471 #: ../fish/guestfish-actions.pod:1421
22473 "Return the current umask. By default the umask is C<022> unless it has been "
22474 "set by calling L</umask>."
22478 #: ../fish/guestfish-actions.pod:1424
22479 msgid "get-verbose"
22483 #: ../fish/guestfish-actions.pod:1426
22491 #: ../fish/guestfish-actions.pod:1430
22496 #: ../fish/guestfish-actions.pod:1432
22504 #: ../fish/guestfish-actions.pod:1436
22505 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
22509 #: ../fish/guestfish-actions.pod:1439
22514 #: ../fish/guestfish-actions.pod:1441
22517 " getxattr path name\n"
22522 #: ../fish/guestfish-actions.pod:1443
22524 "Get a single extended attribute from file C<path> named C<name>. This call "
22525 "follows symlinks. If you want to lookup an extended attribute for the "
22526 "symlink itself, use L</lgetxattr>."
22530 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2383
22532 "Normally it is better to get all extended attributes from a file in one go "
22533 "by calling L</getxattrs>. However some Linux filesystem implementations are "
22534 "buggy and do not provide a way to list out attributes. For these "
22535 "filesystems (notably ntfs-3g) you have to know the names of the extended "
22536 "attributes you want in advance and call this function."
22540 #: ../fish/guestfish-actions.pod:1457
22541 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
22545 #: ../fish/guestfish-actions.pod:1459
22550 #: ../fish/guestfish-actions.pod:1461
22553 " getxattrs path\n"
22558 #: ../fish/guestfish-actions.pod:1469
22559 msgid "See also: L</lgetxattrs>, L<attr(5)>."
22563 #: ../fish/guestfish-actions.pod:1471
22564 msgid "glob-expand"
22568 #: ../fish/guestfish-actions.pod:1473
22571 " glob-expand pattern\n"
22576 #: ../fish/guestfish-actions.pod:1486
22581 #: ../fish/guestfish-actions.pod:1488
22584 " grep regex path\n"
22589 #: ../fish/guestfish-actions.pod:1496
22594 #: ../fish/guestfish-actions.pod:1498
22597 " grepi regex path\n"
22602 #: ../fish/guestfish-actions.pod:1506
22603 msgid "grub-install"
22607 #: ../fish/guestfish-actions.pod:1508
22610 " grub-install root device\n"
22615 #: ../fish/guestfish-actions.pod:1524
22620 #: ../fish/guestfish-actions.pod:1526
22628 #: ../fish/guestfish-actions.pod:1534
22633 #: ../fish/guestfish-actions.pod:1536
22636 " head-n nrlines path\n"
22641 #: ../fish/guestfish-actions.pod:1549
22646 #: ../fish/guestfish-actions.pod:1551
22654 #: ../fish/guestfish-actions.pod:1559
22659 #: ../fish/guestfish-actions.pod:1561
22662 " initrd-cat initrdpath filename\n"
22667 #: ../fish/guestfish-actions.pod:1573
22668 msgid "See also L</initrd-list>."
22672 #: ../fish/guestfish-actions.pod:1578
22673 msgid "initrd-list"
22677 #: ../fish/guestfish-actions.pod:1580
22680 " initrd-list path\n"
22685 #: ../fish/guestfish-actions.pod:1592
22686 msgid "inotify-add-watch"
22690 #: ../fish/guestfish-actions.pod:1594
22693 " inotify-add-watch path mask\n"
22698 #: ../fish/guestfish-actions.pod:1606
22699 msgid "inotify-close"
22703 #: ../fish/guestfish-actions.pod:1608
22711 #: ../fish/guestfish-actions.pod:1614
22712 msgid "inotify-files"
22716 #: ../fish/guestfish-actions.pod:1616
22724 #: ../fish/guestfish-actions.pod:1618
22726 "This function is a helpful wrapper around L</inotify-read> which just "
22727 "returns a list of pathnames of objects that were touched. The returned "
22728 "pathnames are sorted and deduplicated."
22732 #: ../fish/guestfish-actions.pod:1622
22733 msgid "inotify-init"
22737 #: ../fish/guestfish-actions.pod:1624
22740 " inotify-init maxevents\n"
22745 #: ../fish/guestfish-actions.pod:1630
22747 "C<maxevents> is the maximum number of events which will be queued up between "
22748 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
22749 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
22750 "default was 16384 events. Beyond this limit, the kernel throws away events, "
22751 "but records the fact that it threw them away by setting a flag "
22752 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
22756 #: ../fish/guestfish-actions.pod:1640
22758 "Before any events are generated, you have to add some watches to the "
22759 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
22760 "L</inotify-watch-all>."
22764 #: ../fish/guestfish-actions.pod:1646
22766 "Queued up events should be read periodically by calling L</inotify-read> (or "
22767 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
22768 "If you don't read the events out often enough then you risk the internal "
22769 "queue overflowing."
22773 #: ../fish/guestfish-actions.pod:1653
22775 "The handle should be closed after use by calling L</inotify-close>. This "
22776 "also removes any watches automatically."
22780 #: ../fish/guestfish-actions.pod:1662
22781 msgid "inotify-read"
22785 #: ../fish/guestfish-actions.pod:1664
22793 #: ../fish/guestfish-actions.pod:1677
22794 msgid "inotify-rm-watch"
22798 #: ../fish/guestfish-actions.pod:1679
22801 " inotify-rm-watch wd\n"
22806 #: ../fish/guestfish-actions.pod:1681
22807 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
22811 #: ../fish/guestfish-actions.pod:1684
22812 msgid "inspect-get-arch"
22816 #: ../fish/guestfish-actions.pod:1686
22819 " inspect-get-arch root\n"
22824 #: ../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:1971 ../fish/guestfish-actions.pod:2014 ../fish/guestfish-actions.pod:2049 ../fish/guestfish-actions.pod:2065 ../fish/guestfish-actions.pod:2078 ../fish/guestfish-actions.pod:2091 ../fish/guestfish-actions.pod:2106
22826 "This function should only be called with a root device string as returned by "
22831 #: ../fish/guestfish-actions.pod:1691
22833 "This returns the architecture of the inspected operating system. The "
22834 "possible return values are listed under L</file-architecture>."
22838 #: ../fish/guestfish-actions.pod:1700
22839 msgid "inspect-get-distro"
22843 #: ../fish/guestfish-actions.pod:1702
22846 " inspect-get-distro root\n"
22851 #: ../fish/guestfish-actions.pod:1774
22852 msgid "inspect-get-filesystems"
22856 #: ../fish/guestfish-actions.pod:1776
22859 " inspect-get-filesystems root\n"
22864 #: ../fish/guestfish-actions.pod:1789
22866 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22867 "L</inspect-get-mountpoints>."
22871 #: ../fish/guestfish-actions.pod:1792
22872 msgid "inspect-get-format"
22876 #: ../fish/guestfish-actions.pod:1794
22879 " inspect-get-format root\n"
22884 #: ../fish/guestfish-actions.pod:1826
22885 msgid "inspect-get-hostname"
22889 #: ../fish/guestfish-actions.pod:1828
22892 " inspect-get-hostname root\n"
22897 #: ../fish/guestfish-actions.pod:1841
22898 msgid "inspect-get-major-version"
22902 #: ../fish/guestfish-actions.pod:1843
22905 " inspect-get-major-version root\n"
22910 #: ../fish/guestfish-actions.pod:1862
22911 msgid "inspect-get-minor-version"
22915 #: ../fish/guestfish-actions.pod:1864
22918 " inspect-get-minor-version root\n"
22923 #: ../fish/guestfish-actions.pod:1874
22925 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22926 "L</inspect-get-major-version>."
22930 #: ../fish/guestfish-actions.pod:1877
22931 msgid "inspect-get-mountpoints"
22935 #: ../fish/guestfish-actions.pod:1879
22938 " inspect-get-mountpoints root\n"
22943 #: ../fish/guestfish-actions.pod:1901
22945 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22946 "L</inspect-get-filesystems>."
22950 #: ../fish/guestfish-actions.pod:1904
22951 msgid "inspect-get-package-format"
22955 #: ../fish/guestfish-actions.pod:1906
22958 " inspect-get-package-format root\n"
22963 #: ../fish/guestfish-actions.pod:1911
22965 "This function and L</inspect-get-package-management> return the package "
22966 "format and package management tool used by the inspected operating system. "
22967 "For example for Fedora these functions would return C<rpm> (package format) "
22968 "and C<yum> (package management)."
22972 #: ../fish/guestfish-actions.pod:1926
22973 msgid "inspect-get-package-management"
22977 #: ../fish/guestfish-actions.pod:1928
22980 " inspect-get-package-management root\n"
22985 #: ../fish/guestfish-actions.pod:1933
22987 "L</inspect-get-package-format> and this function return the package format "
22988 "and package management tool used by the inspected operating system. For "
22989 "example for Fedora these functions would return C<rpm> (package format) and "
22990 "C<yum> (package management)."
22994 #: ../fish/guestfish-actions.pod:1950
22995 msgid "inspect-get-product-name"
22999 #: ../fish/guestfish-actions.pod:1952
23002 " inspect-get-product-name root\n"
23007 #: ../fish/guestfish-actions.pod:1967
23008 msgid "inspect-get-product-variant"
23012 #: ../fish/guestfish-actions.pod:1969
23015 " inspect-get-product-variant root\n"
23020 #: ../fish/guestfish-actions.pod:1993
23022 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23023 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23027 #: ../fish/guestfish-actions.pod:1997
23028 msgid "inspect-get-roots"
23032 #: ../fish/guestfish-actions.pod:1999
23035 " inspect-get-roots\n"
23040 #: ../fish/guestfish-actions.pod:2001
23042 "This function is a convenient way to get the list of root devices, as "
23043 "returned from a previous call to L</inspect-os>, but without redoing the "
23044 "whole inspection process."
23048 #: ../fish/guestfish-actions.pod:2005
23050 "This returns an empty list if either no root devices were found or the "
23051 "caller has not called L</inspect-os>."
23055 #: ../fish/guestfish-actions.pod:2010
23056 msgid "inspect-get-type"
23060 #: ../fish/guestfish-actions.pod:2012
23063 " inspect-get-type root\n"
23068 #: ../fish/guestfish-actions.pod:2045
23069 msgid "inspect-get-windows-systemroot"
23073 #: ../fish/guestfish-actions.pod:2047
23076 " inspect-get-windows-systemroot root\n"
23081 #: ../fish/guestfish-actions.pod:2061
23082 msgid "inspect-is-live"
23086 #: ../fish/guestfish-actions.pod:2063
23089 " inspect-is-live root\n"
23094 #: ../fish/guestfish-actions.pod:2068
23096 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23097 "then this returns true if a live image was detected on the disk."
23101 #: ../fish/guestfish-actions.pod:2074
23102 msgid "inspect-is-multipart"
23106 #: ../fish/guestfish-actions.pod:2076
23109 " inspect-is-multipart root\n"
23114 #: ../fish/guestfish-actions.pod:2081
23116 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23117 "then this returns true if the disk is part of a set."
23121 #: ../fish/guestfish-actions.pod:2087
23122 msgid "inspect-is-netinst"
23126 #: ../fish/guestfish-actions.pod:2089
23129 " inspect-is-netinst root\n"
23134 #: ../fish/guestfish-actions.pod:2094
23136 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23137 "then this returns true if the disk is a network installer, ie. not a "
23138 "self-contained install CD but one which is likely to require network access "
23139 "to complete the install."
23143 #: ../fish/guestfish-actions.pod:2102
23144 msgid "inspect-list-applications"
23148 #: ../fish/guestfish-actions.pod:2104
23151 " inspect-list-applications root\n"
23156 #: ../fish/guestfish-actions.pod:2111
23158 "I<Note:> This call works differently from other parts of the inspection "
23159 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23160 "then mount up the disks, before calling this. Listing applications is a "
23161 "significantly more difficult operation which requires access to the full "
23162 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23163 "are just returning data cached in the libguestfs handle, this call actually "
23164 "reads parts of the mounted filesystems during the call."
23168 #: ../fish/guestfish-actions.pod:2201
23173 #: ../fish/guestfish-actions.pod:2203
23181 #: ../fish/guestfish-actions.pod:2218
23183 "You can pass the root string(s) returned to other L</inspect-get-*> "
23184 "functions in order to query further information about each operating system, "
23185 "such as the name and version."
23189 #: ../fish/guestfish-actions.pod:2223
23191 "This function uses other libguestfs features such as L</mount-ro> and "
23192 "L</umount-all> in order to mount and unmount filesystems and look at the "
23193 "contents. This should be called with no disks currently mounted. The "
23194 "function may also use Augeas, so any existing Augeas handle will be closed."
23198 #: ../fish/guestfish-actions.pod:2235 ../fish/guestfish-actions.pod:2411 ../fish/guestfish-actions.pod:2457
23199 msgid "See also L</list-filesystems>."
23203 #: ../fish/guestfish-actions.pod:2237
23204 msgid "is-blockdev"
23208 #: ../fish/guestfish-actions.pod:2239
23211 " is-blockdev path\n"
23216 #: ../fish/guestfish-actions.pod:2244 ../fish/guestfish-actions.pod:2262 ../fish/guestfish-actions.pod:2281 ../fish/guestfish-actions.pod:2290 ../fish/guestfish-actions.pod:2300 ../fish/guestfish-actions.pod:2334 ../fish/guestfish-actions.pod:2343
23217 msgid "See also L</stat>."
23221 #: ../fish/guestfish-actions.pod:2246
23226 #: ../fish/guestfish-actions.pod:2248
23234 #: ../fish/guestfish-actions.pod:2255
23239 #: ../fish/guestfish-actions.pod:2257
23242 " is-chardev path\n"
23247 #: ../fish/guestfish-actions.pod:2264
23252 #: ../fish/guestfish-actions.pod:2266
23260 #: ../fish/guestfish-actions.pod:2273
23265 #: ../fish/guestfish-actions.pod:2275
23273 #: ../fish/guestfish-actions.pod:2283
23278 #: ../fish/guestfish-actions.pod:2285
23286 #: ../fish/guestfish-actions.pod:2292
23291 #: ../fish/guestfish-actions.pod:2294
23299 #: ../fish/guestfish-actions.pod:2302
23300 msgid "is-launching"
23304 #: ../fish/guestfish-actions.pod:2304
23312 #: ../fish/guestfish-actions.pod:2311
23317 #: ../fish/guestfish-actions.pod:2313
23325 #: ../fish/guestfish-actions.pod:2318
23330 #: ../fish/guestfish-actions.pod:2320
23338 #: ../fish/guestfish-actions.pod:2327
23343 #: ../fish/guestfish-actions.pod:2329
23346 " is-socket path\n"
23351 #: ../fish/guestfish-actions.pod:2336
23356 #: ../fish/guestfish-actions.pod:2338
23359 " is-symlink path\n"
23364 #: ../fish/guestfish-actions.pod:2345
23365 msgid "kill-subprocess"
23369 #: ../fish/guestfish-actions.pod:2347
23372 " kill-subprocess\n"
23377 #: ../fish/guestfish-actions.pod:2351
23382 #: ../fish/guestfish-actions.pod:2353
23387 #: ../fish/guestfish-actions.pod:2355
23395 #: ../fish/guestfish-actions.pod:2363
23400 #: ../fish/guestfish-actions.pod:2365
23403 " lchown owner group path\n"
23408 #: ../fish/guestfish-actions.pod:2367
23410 "Change the file owner to C<owner> and group to C<group>. This is like "
23411 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
23416 #: ../fish/guestfish-actions.pod:2375
23421 #: ../fish/guestfish-actions.pod:2377
23424 " lgetxattr path name\n"
23429 #: ../fish/guestfish-actions.pod:2393
23430 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
23434 #: ../fish/guestfish-actions.pod:2395
23439 #: ../fish/guestfish-actions.pod:2397
23442 " lgetxattrs path\n"
23447 #: ../fish/guestfish-actions.pod:2399
23449 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
23450 "it returns the extended attributes of the link itself."
23454 #: ../fish/guestfish-actions.pod:2403
23455 msgid "list-devices"
23459 #: ../fish/guestfish-actions.pod:2405
23467 #: ../fish/guestfish-actions.pod:2413
23468 msgid "list-filesystems"
23472 #: ../fish/guestfish-actions.pod:2415
23475 " list-filesystems\n"
23480 #: ../fish/guestfish-actions.pod:2434
23482 "This command runs other libguestfs commands, which might include L</mount> "
23483 "and L</umount>, and therefore you should use this soon after launch and only "
23484 "when nothing is mounted."
23488 #: ../fish/guestfish-actions.pod:2438
23490 "Not all of the filesystems returned will be mountable. In particular, swap "
23491 "partitions are returned in the list. Also this command does not check that "
23492 "each filesystem found is valid and mountable, and some filesystems might be "
23493 "mountable but require special options. Filesystems may not all belong to a "
23494 "single logical operating system (use L</inspect-os> to look for OSes)."
23498 #: ../fish/guestfish-actions.pod:2446
23499 msgid "list-partitions"
23503 #: ../fish/guestfish-actions.pod:2448
23506 " list-partitions\n"
23511 #: ../fish/guestfish-actions.pod:2454
23513 "This does not return logical volumes. For that you will need to call "
23518 #: ../fish/guestfish-actions.pod:2459
23523 #: ../fish/guestfish-actions.pod:2461
23531 #: ../fish/guestfish-actions.pod:2469
23536 #: ../fish/guestfish-actions.pod:2471
23539 " ln target linkname\n"
23544 #: ../fish/guestfish-actions.pod:2475
23549 #: ../fish/guestfish-actions.pod:2477
23552 " ln-f target linkname\n"
23557 #: ../fish/guestfish-actions.pod:2482
23562 #: ../fish/guestfish-actions.pod:2484
23565 " ln-s target linkname\n"
23570 #: ../fish/guestfish-actions.pod:2488
23575 #: ../fish/guestfish-actions.pod:2490
23578 " ln-sf target linkname\n"
23583 #: ../fish/guestfish-actions.pod:2495
23584 msgid "lremovexattr"
23588 #: ../fish/guestfish-actions.pod:2497
23591 " lremovexattr xattr path\n"
23596 #: ../fish/guestfish-actions.pod:2499
23598 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
23599 "it removes an extended attribute of the link itself."
23603 #: ../fish/guestfish-actions.pod:2503
23608 #: ../fish/guestfish-actions.pod:2505
23616 #: ../fish/guestfish-actions.pod:2511
23618 "This command is mostly useful for interactive sessions. Programs should "
23619 "probably use L</readdir> instead."
23623 #: ../fish/guestfish-actions.pod:2514
23628 #: ../fish/guestfish-actions.pod:2516
23631 " lsetxattr xattr val vallen path\n"
23636 #: ../fish/guestfish-actions.pod:2518
23638 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
23639 "sets an extended attribute of the link itself."
23643 #: ../fish/guestfish-actions.pod:2522
23648 #: ../fish/guestfish-actions.pod:2524
23656 #: ../fish/guestfish-actions.pod:2528
23658 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
23659 "the link is stat-ed, not the file it refers to."
23663 #: ../fish/guestfish-actions.pod:2534
23668 #: ../fish/guestfish-actions.pod:2536
23671 " lstatlist path 'names ...'\n"
23676 #: ../fish/guestfish-actions.pod:2538
23678 "This call allows you to perform the L</lstat> operation on multiple files, "
23679 "where all files are in the directory C<path>. C<names> is the list of files "
23680 "from this directory."
23684 #: ../fish/guestfish-actions.pod:2547
23686 "This call is intended for programs that want to efficiently list a directory "
23687 "contents without making many round-trips. See also L</lxattrlist> for a "
23688 "similarly efficient call for getting extended attributes. Very long "
23689 "directory listings might cause the protocol message size to be exceeded, "
23690 "causing this call to fail. The caller must split up such requests into "
23691 "smaller groups of names."
23695 #: ../fish/guestfish-actions.pod:2555
23696 msgid "luks-add-key"
23700 #: ../fish/guestfish-actions.pod:2557
23703 " luks-add-key device keyslot\n"
23708 #: ../fish/guestfish-actions.pod:2564
23710 "Note that if C<keyslot> already contains a key, then this command will "
23711 "fail. You have to use L</luks-kill-slot> first to remove that key."
23715 #: ../fish/guestfish-actions.pod:2568 ../fish/guestfish-actions.pod:2590 ../fish/guestfish-actions.pod:2603 ../fish/guestfish-actions.pod:2617 ../fish/guestfish-actions.pod:2640 ../fish/guestfish-actions.pod:2650
23717 "This command has one or more key or passphrase parameters. Guestfish will "
23718 "prompt for these separately."
23722 #: ../fish/guestfish-actions.pod:2571
23727 #: ../fish/guestfish-actions.pod:2573
23730 " luks-close device\n"
23735 #: ../fish/guestfish-actions.pod:2575
23737 "This closes a LUKS device that was created earlier by L</luks-open> or "
23738 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
23739 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
23740 "underlying block device."
23744 #: ../fish/guestfish-actions.pod:2581
23745 msgid "luks-format"
23749 #: ../fish/guestfish-actions.pod:2583
23752 " luks-format device keyslot\n"
23757 #: ../fish/guestfish-actions.pod:2596
23758 msgid "luks-format-cipher"
23762 #: ../fish/guestfish-actions.pod:2598
23765 " luks-format-cipher device keyslot cipher\n"
23770 #: ../fish/guestfish-actions.pod:2600
23772 "This command is the same as L</luks-format> but it also allows you to set "
23773 "the C<cipher> used."
23777 #: ../fish/guestfish-actions.pod:2609
23778 msgid "luks-kill-slot"
23782 #: ../fish/guestfish-actions.pod:2611
23785 " luks-kill-slot device keyslot\n"
23790 #: ../fish/guestfish-actions.pod:2620
23795 #: ../fish/guestfish-actions.pod:2622
23798 " luks-open device mapname\n"
23803 #: ../fish/guestfish-actions.pod:2636
23805 "If this block device contains LVM volume groups, then calling L</vgscan> "
23806 "followed by L</vg-activate-all> will make them visible."
23810 #: ../fish/guestfish-actions.pod:2643
23811 msgid "luks-open-ro"
23815 #: ../fish/guestfish-actions.pod:2645
23818 " luks-open-ro device mapname\n"
23823 #: ../fish/guestfish-actions.pod:2647
23825 "This is the same as L</luks-open> except that a read-only mapping is "
23830 #: ../fish/guestfish-actions.pod:2653
23835 #: ../fish/guestfish-actions.pod:2655
23838 " lvcreate logvol volgroup mbytes\n"
23843 #: ../fish/guestfish-actions.pod:2660
23844 msgid "lvm-canonical-lv-name"
23848 #: ../fish/guestfish-actions.pod:2662
23851 " lvm-canonical-lv-name lvname\n"
23856 #: ../fish/guestfish-actions.pod:2671
23857 msgid "See also L</is-lv>."
23861 #: ../fish/guestfish-actions.pod:2673
23862 msgid "lvm-clear-filter"
23866 #: ../fish/guestfish-actions.pod:2675
23869 " lvm-clear-filter\n"
23874 #: ../fish/guestfish-actions.pod:2677
23876 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
23881 #: ../fish/guestfish-actions.pod:2683
23882 msgid "lvm-remove-all"
23886 #: ../fish/guestfish-actions.pod:2685
23889 " lvm-remove-all\n"
23894 #: ../fish/guestfish-actions.pod:2693
23895 msgid "lvm-set-filter"
23899 #: ../fish/guestfish-actions.pod:2695
23902 " lvm-set-filter 'devices ...'\n"
23907 #: ../fish/guestfish-actions.pod:2720
23912 #: ../fish/guestfish-actions.pod:2722
23915 " lvremove device\n"
23920 #: ../fish/guestfish-actions.pod:2730
23925 #: ../fish/guestfish-actions.pod:2732
23928 " lvrename logvol newlogvol\n"
23933 #: ../fish/guestfish-actions.pod:2736
23938 #: ../fish/guestfish-actions.pod:2738
23941 " lvresize device mbytes\n"
23946 #: ../fish/guestfish-actions.pod:2744
23947 msgid "lvresize-free"
23951 #: ../fish/guestfish-actions.pod:2746
23954 " lvresize-free lv percent\n"
23959 #: ../fish/guestfish-actions.pod:2754
23964 #: ../fish/guestfish-actions.pod:2756
23972 #: ../fish/guestfish-actions.pod:2764
23973 msgid "See also L</lvs-full>, L</list-filesystems>."
23977 #: ../fish/guestfish-actions.pod:2766
23982 #: ../fish/guestfish-actions.pod:2768
23990 #: ../fish/guestfish-actions.pod:2773
23995 #: ../fish/guestfish-actions.pod:2775
24003 #: ../fish/guestfish-actions.pod:2779
24008 #: ../fish/guestfish-actions.pod:2781
24011 " lxattrlist path 'names ...'\n"
24016 #: ../fish/guestfish-actions.pod:2797
24018 "This call is intended for programs that want to efficiently list a directory "
24019 "contents without making many round-trips. See also L</lstatlist> for a "
24020 "similarly efficient call for getting standard stats. Very long directory "
24021 "listings might cause the protocol message size to be exceeded, causing this "
24022 "call to fail. The caller must split up such requests into smaller groups of "
24027 #: ../fish/guestfish-actions.pod:2805
24032 #: ../fish/guestfish-actions.pod:2807
24040 #: ../fish/guestfish-actions.pod:2811
24045 #: ../fish/guestfish-actions.pod:2813
24048 " mkdir-mode path mode\n"
24053 #: ../fish/guestfish-actions.pod:2822
24054 msgid "See also L</mkdir>, L</umask>"
24058 #: ../fish/guestfish-actions.pod:2824
24063 #: ../fish/guestfish-actions.pod:2826
24071 #: ../fish/guestfish-actions.pod:2831
24076 #: ../fish/guestfish-actions.pod:2833
24079 " mkdtemp template\n"
24084 #: ../fish/guestfish-actions.pod:2854
24089 #: ../fish/guestfish-actions.pod:2856
24092 " mke2fs-J fstype blocksize device journal\n"
24097 #: ../fish/guestfish-actions.pod:2864
24098 msgid "See also L</mke2journal>."
24102 #: ../fish/guestfish-actions.pod:2866
24107 #: ../fish/guestfish-actions.pod:2868
24110 " mke2fs-JL fstype blocksize device label\n"
24115 #: ../fish/guestfish-actions.pod:2873
24116 msgid "See also L</mke2journal-L>."
24120 #: ../fish/guestfish-actions.pod:2875
24125 #: ../fish/guestfish-actions.pod:2877
24128 " mke2fs-JU fstype blocksize device uuid\n"
24133 #: ../fish/guestfish-actions.pod:2882
24134 msgid "See also L</mke2journal-U>."
24138 #: ../fish/guestfish-actions.pod:2884
24139 msgid "mke2journal"
24143 #: ../fish/guestfish-actions.pod:2886
24146 " mke2journal blocksize device\n"
24151 #: ../fish/guestfish-actions.pod:2893
24152 msgid "mke2journal-L"
24156 #: ../fish/guestfish-actions.pod:2895
24159 " mke2journal-L blocksize label device\n"
24164 #: ../fish/guestfish-actions.pod:2899
24165 msgid "mke2journal-U"
24169 #: ../fish/guestfish-actions.pod:2901
24172 " mke2journal-U blocksize uuid device\n"
24177 #: ../fish/guestfish-actions.pod:2905
24182 #: ../fish/guestfish-actions.pod:2907
24185 " mkfifo mode path\n"
24190 #: ../fish/guestfish-actions.pod:2909
24192 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
24193 "is just a convenient wrapper around L</mknod>."
24197 #: ../fish/guestfish-actions.pod:2915
24202 #: ../fish/guestfish-actions.pod:2917
24205 " mkfs fstype device\n"
24210 #: ../fish/guestfish-actions.pod:2923
24215 #: ../fish/guestfish-actions.pod:2925
24218 " mkfs-b fstype blocksize device\n"
24223 #: ../fish/guestfish-actions.pod:2927
24225 "This call is similar to L</mkfs>, but it allows you to control the block "
24226 "size of the resulting filesystem. Supported block sizes depend on the "
24227 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
24231 #: ../fish/guestfish-actions.pod:2942
24236 #: ../fish/guestfish-actions.pod:2944
24239 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
24244 #: ../fish/guestfish-actions.pod:2979
24245 msgid "mkmountpoint"
24249 #: ../fish/guestfish-actions.pod:2981
24252 " mkmountpoint exemptpath\n"
24257 #: ../fish/guestfish-actions.pod:2983
24259 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
24260 "to create extra mountpoints before mounting the first filesystem."
24264 #: ../fish/guestfish-actions.pod:3007
24266 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
24267 "unexpected errors if you try to mix these calls. It is safest to manually "
24268 "unmount filesystems and remove mountpoints after use."
24272 #: ../fish/guestfish-actions.pod:3011
24274 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
24275 "for this to work for manual mountpoints, you must ensure that the innermost "
24276 "mountpoints have the longest pathnames, as in the example code above."
24280 #: ../fish/guestfish-actions.pod:3018
24282 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
24283 "L</umount-all> to be called when the handle is closed which can also trigger "
24288 #: ../fish/guestfish-actions.pod:3022
24293 #: ../fish/guestfish-actions.pod:3024
24296 " mknod mode devmajor devminor path\n"
24301 #: ../fish/guestfish-actions.pod:3034
24303 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
24304 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
24305 "regular file). These constants are available in the standard Linux header "
24306 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
24307 "wrappers around this command which bitwise OR in the appropriate constant "
24312 #: ../fish/guestfish-actions.pod:3044
24317 #: ../fish/guestfish-actions.pod:3046
24320 " mknod-b mode devmajor devminor path\n"
24325 #: ../fish/guestfish-actions.pod:3048
24327 "This call creates a block device node called C<path> with mode C<mode> and "
24328 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24329 "wrapper around L</mknod>."
24333 #: ../fish/guestfish-actions.pod:3054
24338 #: ../fish/guestfish-actions.pod:3056
24341 " mknod-c mode devmajor devminor path\n"
24346 #: ../fish/guestfish-actions.pod:3058
24348 "This call creates a char device node called C<path> with mode C<mode> and "
24349 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
24350 "wrapper around L</mknod>."
24354 #: ../fish/guestfish-actions.pod:3064
24359 #: ../fish/guestfish-actions.pod:3066
24367 #: ../fish/guestfish-actions.pod:3070
24372 #: ../fish/guestfish-actions.pod:3072
24375 " mkswap-L label device\n"
24380 #: ../fish/guestfish-actions.pod:3080
24385 #: ../fish/guestfish-actions.pod:3082
24388 " mkswap-U uuid device\n"
24393 #: ../fish/guestfish-actions.pod:3086
24394 msgid "mkswap-file"
24398 #: ../fish/guestfish-actions.pod:3088
24401 " mkswap-file path\n"
24406 #: ../fish/guestfish-actions.pod:3092
24408 "This command just writes a swap file signature to an existing file. To "
24409 "create the file itself, use something like L</fallocate>."
24413 #: ../fish/guestfish-actions.pod:3095
24418 #: ../fish/guestfish-actions.pod:3097
24421 " modprobe modulename\n"
24426 #: ../fish/guestfish-actions.pod:3104
24431 #: ../fish/guestfish-actions.pod:3106
24434 " mount device mountpoint\n"
24439 #: ../fish/guestfish-actions.pod:3122
24441 "B<Important note:> When you use this call, the filesystem options C<sync> "
24442 "and C<noatime> are set implicitly. This was originally done because we "
24443 "thought it would improve reliability, but it turns out that I<-o sync> has a "
24444 "very large negative performance impact and negligible effect on "
24445 "reliability. Therefore we recommend that you avoid using L</mount> in any "
24446 "code that needs performance, and instead use L</mount-options> (use an empty "
24447 "string for the first parameter if you don't want any options)."
24451 #: ../fish/guestfish-actions.pod:3132
24456 #: ../fish/guestfish-actions.pod:3134
24459 " mount-loop file mountpoint\n"
24464 #: ../fish/guestfish-actions.pod:3140
24465 msgid "mount-options"
24469 #: ../fish/guestfish-actions.pod:3142
24472 " mount-options options device mountpoint\n"
24477 #: ../fish/guestfish-actions.pod:3144
24479 "This is the same as the L</mount> command, but it allows you to set the "
24480 "mount options as for the L<mount(8)> I<-o> flag."
24484 #: ../fish/guestfish-actions.pod:3152
24489 #: ../fish/guestfish-actions.pod:3154
24492 " mount-ro device mountpoint\n"
24497 #: ../fish/guestfish-actions.pod:3156
24499 "This is the same as the L</mount> command, but it mounts the filesystem with "
24500 "the read-only (I<-o ro>) flag."
24504 #: ../fish/guestfish-actions.pod:3159
24509 #: ../fish/guestfish-actions.pod:3161
24512 " mount-vfs options vfstype device mountpoint\n"
24517 #: ../fish/guestfish-actions.pod:3163
24519 "This is the same as the L</mount> command, but it allows you to set both the "
24520 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
24524 #: ../fish/guestfish-actions.pod:3167
24525 msgid "mountpoints"
24529 #: ../fish/guestfish-actions.pod:3169
24537 #: ../fish/guestfish-actions.pod:3171
24539 "This call is similar to L</mounts>. That call returns a list of devices. "
24540 "This one returns a hash table (map) of device name to directory where the "
24541 "device is mounted."
24545 #: ../fish/guestfish-actions.pod:3175
24550 #: ../fish/guestfish-actions.pod:3177
24558 #: ../fish/guestfish-actions.pod:3184
24559 msgid "See also: L</mountpoints>"
24563 #: ../fish/guestfish-actions.pod:3186
24568 #: ../fish/guestfish-actions.pod:3188
24576 #: ../fish/guestfish-actions.pod:3193
24577 msgid "ntfs-3g-probe"
24581 #: ../fish/guestfish-actions.pod:3195
24584 " ntfs-3g-probe true|false device\n"
24589 #: ../fish/guestfish-actions.pod:3209
24594 #: ../fish/guestfish-actions.pod:3211
24597 " ntfsresize device\n"
24602 #: ../fish/guestfish-actions.pod:3217
24603 msgid "ntfsresize-size"
24607 #: ../fish/guestfish-actions.pod:3219
24610 " ntfsresize-size device size\n"
24615 #: ../fish/guestfish-actions.pod:3221
24617 "This command is the same as L</ntfsresize> except that it allows you to "
24618 "specify the new size (in bytes) explicitly."
24622 #: ../fish/guestfish-actions.pod:3224
24627 #: ../fish/guestfish-actions.pod:3226
24630 " part-add device prlogex startsect endsect\n"
24635 #: ../fish/guestfish-actions.pod:3228
24637 "This command adds a partition to C<device>. If there is no partition table "
24638 "on the device, call L</part-init> first."
24642 #: ../fish/guestfish-actions.pod:3240
24644 "Creating a partition which covers the whole disk is not so easy. Use "
24645 "L</part-disk> to do that."
24649 #: ../fish/guestfish-actions.pod:3243
24654 #: ../fish/guestfish-actions.pod:3245
24657 " part-del device partnum\n"
24662 #: ../fish/guestfish-actions.pod:3253
24667 #: ../fish/guestfish-actions.pod:3255
24670 " part-disk device parttype\n"
24675 #: ../fish/guestfish-actions.pod:3257
24677 "This command is simply a combination of L</part-init> followed by "
24678 "L</part-add> to create a single primary partition covering the whole disk."
24682 #: ../fish/guestfish-actions.pod:3261
24684 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
24685 "possible values are described in L</part-init>."
24689 #: ../fish/guestfish-actions.pod:3267
24690 msgid "part-get-bootable"
24694 #: ../fish/guestfish-actions.pod:3269
24697 " part-get-bootable device partnum\n"
24702 #: ../fish/guestfish-actions.pod:3274
24703 msgid "See also L</part-set-bootable>."
24707 #: ../fish/guestfish-actions.pod:3276
24708 msgid "part-get-mbr-id"
24712 #: ../fish/guestfish-actions.pod:3278
24715 " part-get-mbr-id device partnum\n"
24720 #: ../fish/guestfish-actions.pod:3283 ../fish/guestfish-actions.pod:3421
24722 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
24723 "undefined results for other partition table types (see "
24724 "L</part-get-parttype>)."
24728 #: ../fish/guestfish-actions.pod:3287
24729 msgid "part-get-parttype"
24733 #: ../fish/guestfish-actions.pod:3289
24736 " part-get-parttype device\n"
24741 #: ../fish/guestfish-actions.pod:3294
24743 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
24744 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
24745 "possible, although unusual. See L</part-init> for a full list."
24749 #: ../fish/guestfish-actions.pod:3299
24754 #: ../fish/guestfish-actions.pod:3301
24757 " part-init device parttype\n"
24762 #: ../fish/guestfish-actions.pod:3307
24764 "Initially there are no partitions. Following this, you should call "
24765 "L</part-add> for each partition required."
24769 #: ../fish/guestfish-actions.pod:3370
24774 #: ../fish/guestfish-actions.pod:3372
24777 " part-list device\n"
24782 #: ../fish/guestfish-actions.pod:3387
24784 "Start of the partition I<in bytes>. To get sectors you have to divide by "
24785 "the device's sector size, see L</blockdev-getss>."
24789 #: ../fish/guestfish-actions.pod:3400
24790 msgid "part-set-bootable"
24794 #: ../fish/guestfish-actions.pod:3402
24797 " part-set-bootable device partnum true|false\n"
24802 #: ../fish/guestfish-actions.pod:3411
24803 msgid "part-set-mbr-id"
24807 #: ../fish/guestfish-actions.pod:3413
24810 " part-set-mbr-id device partnum idbyte\n"
24815 #: ../fish/guestfish-actions.pod:3425
24816 msgid "part-set-name"
24820 #: ../fish/guestfish-actions.pod:3427
24823 " part-set-name device partnum name\n"
24828 #: ../fish/guestfish-actions.pod:3435
24829 msgid "part-to-dev"
24833 #: ../fish/guestfish-actions.pod:3437
24836 " part-to-dev partition\n"
24841 #: ../fish/guestfish-actions.pod:3443
24843 "The named partition must exist, for example as a string returned from "
24844 "L</list-partitions>."
24848 #: ../fish/guestfish-actions.pod:3446
24849 msgid "ping-daemon"
24853 #: ../fish/guestfish-actions.pod:3448
24861 #: ../fish/guestfish-actions.pod:3455
24866 #: ../fish/guestfish-actions.pod:3457
24869 " pread path count offset\n"
24874 #: ../fish/guestfish-actions.pod:3465
24875 msgid "See also L</pwrite>, L</pread-device>."
24879 #: ../fish/guestfish-actions.pod:3470
24880 msgid "pread-device"
24884 #: ../fish/guestfish-actions.pod:3472
24887 " pread-device device count offset\n"
24892 #: ../fish/guestfish-actions.pod:3480
24893 msgid "See also L</pread>."
24897 #: ../fish/guestfish-actions.pod:3485
24902 #: ../fish/guestfish-actions.pod:3487
24905 " pvcreate device\n"
24910 #: ../fish/guestfish-actions.pod:3493
24915 #: ../fish/guestfish-actions.pod:3495
24918 " pvremove device\n"
24923 #: ../fish/guestfish-actions.pod:3504
24928 #: ../fish/guestfish-actions.pod:3506
24931 " pvresize device\n"
24936 #: ../fish/guestfish-actions.pod:3511
24937 msgid "pvresize-size"
24941 #: ../fish/guestfish-actions.pod:3513
24944 " pvresize-size device size\n"
24949 #: ../fish/guestfish-actions.pod:3515
24951 "This command is the same as L</pvresize> except that it allows you to "
24952 "specify the new size (in bytes) explicitly."
24956 #: ../fish/guestfish-actions.pod:3518
24961 #: ../fish/guestfish-actions.pod:3520
24969 #: ../fish/guestfish-actions.pod:3528
24970 msgid "See also L</pvs-full>."
24974 #: ../fish/guestfish-actions.pod:3530
24979 #: ../fish/guestfish-actions.pod:3532
24987 #: ../fish/guestfish-actions.pod:3537
24992 #: ../fish/guestfish-actions.pod:3539
25000 #: ../fish/guestfish-actions.pod:3543
25005 #: ../fish/guestfish-actions.pod:3545
25008 " pwrite path content offset\n"
25013 #: ../fish/guestfish-actions.pod:3556
25014 msgid "See also L</pread>, L</pwrite-device>."
25018 #: ../fish/guestfish-actions.pod:3561
25019 msgid "pwrite-device"
25023 #: ../fish/guestfish-actions.pod:3563
25026 " pwrite-device device content offset\n"
25031 #: ../fish/guestfish-actions.pod:3573
25032 msgid "See also L</pwrite>."
25036 #: ../fish/guestfish-actions.pod:3578
25041 #: ../fish/guestfish-actions.pod:3580
25044 " read-file path\n"
25049 #: ../fish/guestfish-actions.pod:3585
25051 "Unlike L</cat>, this function can correctly handle files that contain "
25052 "embedded ASCII NUL characters. However unlike L</download>, this function "
25053 "is limited in the total size of file that can be handled."
25057 #: ../fish/guestfish-actions.pod:3593
25062 #: ../fish/guestfish-actions.pod:3595
25065 " read-lines path\n"
25070 #: ../fish/guestfish-actions.pod:3602
25072 "Note that this function cannot correctly handle binary files (specifically, "
25073 "files containing C<\\0> character which is treated as end of line). For "
25074 "those you need to use the L</read-file> function which has a more complex "
25079 #: ../fish/guestfish-actions.pod:3607
25084 #: ../fish/guestfish-actions.pod:3609
25092 #: ../fish/guestfish-actions.pod:3661
25094 "This function is primarily intended for use by programs. To get a simple "
25095 "list of names, use L</ls>. To get a printable directory for human "
25096 "consumption, use L</ll>."
25100 #: ../fish/guestfish-actions.pod:3665
25105 #: ../fish/guestfish-actions.pod:3667
25113 #: ../fish/guestfish-actions.pod:3671
25114 msgid "readlinklist"
25118 #: ../fish/guestfish-actions.pod:3673
25121 " readlinklist path 'names ...'\n"
25126 #: ../fish/guestfish-actions.pod:3697
25131 #: ../fish/guestfish-actions.pod:3699
25139 #: ../fish/guestfish-actions.pod:3704
25140 msgid "removexattr"
25144 #: ../fish/guestfish-actions.pod:3706
25147 " removexattr xattr path\n"
25152 #: ../fish/guestfish-actions.pod:3711
25153 msgid "See also: L</lremovexattr>, L<attr(5)>."
25157 #: ../fish/guestfish-actions.pod:3713
25162 #: ../fish/guestfish-actions.pod:3715
25165 " resize2fs device\n"
25170 #: ../fish/guestfish-actions.pod:3720
25172 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
25173 "before calling this command. For unknown reasons C<resize2fs> sometimes "
25174 "gives an error about this and sometimes not. In any case, it is always safe "
25175 "to call L</e2fsck-f> before calling this function."
25179 #: ../fish/guestfish-actions.pod:3726
25180 msgid "resize2fs-M"
25184 #: ../fish/guestfish-actions.pod:3728
25187 " resize2fs-M device\n"
25192 #: ../fish/guestfish-actions.pod:3730
25194 "This command is the same as L</resize2fs>, but the filesystem is resized to "
25195 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
25200 #: ../fish/guestfish-actions.pod:3734
25202 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
25203 "and read the C<Block size> and C<Block count> values. These two numbers, "
25204 "multiplied together, give the resulting size of the minimal filesystem in "
25209 #: ../fish/guestfish-actions.pod:3739
25210 msgid "resize2fs-size"
25214 #: ../fish/guestfish-actions.pod:3741
25217 " resize2fs-size device size\n"
25222 #: ../fish/guestfish-actions.pod:3743
25224 "This command is the same as L</resize2fs> except that it allows you to "
25225 "specify the new size (in bytes) explicitly."
25229 #: ../fish/guestfish-actions.pod:3746
25234 #: ../fish/guestfish-actions.pod:3748
25242 #: ../fish/guestfish-actions.pod:3752
25247 #: ../fish/guestfish-actions.pod:3754
25255 #: ../fish/guestfish-actions.pod:3760
25260 #: ../fish/guestfish-actions.pod:3762
25268 #: ../fish/guestfish-actions.pod:3766
25269 msgid "rmmountpoint"
25273 #: ../fish/guestfish-actions.pod:3768
25276 " rmmountpoint exemptpath\n"
25281 #: ../fish/guestfish-actions.pod:3770
25283 "This calls removes a mountpoint that was previously created with "
25284 "L</mkmountpoint>. See L</mkmountpoint> for full details."
25288 #: ../fish/guestfish-actions.pod:3774
25289 msgid "scrub-device"
25293 #: ../fish/guestfish-actions.pod:3776
25296 " scrub-device device\n"
25301 #: ../fish/guestfish-actions.pod:3787
25306 #: ../fish/guestfish-actions.pod:3789
25309 " scrub-file file\n"
25314 #: ../fish/guestfish-actions.pod:3799
25315 msgid "scrub-freespace"
25319 #: ../fish/guestfish-actions.pod:3801
25322 " scrub-freespace dir\n"
25327 #: ../fish/guestfish-actions.pod:3803
25329 "This command creates the directory C<dir> and then fills it with files until "
25330 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
25331 "deletes them. The intention is to scrub any free space on the partition "
25332 "containing C<dir>."
25336 #: ../fish/guestfish-actions.pod:3812
25341 #: ../fish/guestfish-actions.pod:3814
25346 #: ../fish/guestfish-actions.pod:3816
25349 " set-append append\n"
25354 #: ../fish/guestfish-actions.pod:3827
25355 msgid "set-attach-method"
25359 #: ../fish/guestfish-actions.pod:3829
25360 msgid "attach-method"
25364 #: ../fish/guestfish-actions.pod:3831
25367 " set-attach-method attachmethod\n"
25372 #: ../fish/guestfish-actions.pod:3853
25373 msgid "set-autosync"
25377 #: ../fish/guestfish-actions.pod:3855
25382 #: ../fish/guestfish-actions.pod:3857
25385 " set-autosync true|false\n"
25390 #: ../fish/guestfish-actions.pod:3867
25395 #: ../fish/guestfish-actions.pod:3869
25400 #: ../fish/guestfish-actions.pod:3871
25403 " set-direct true|false\n"
25408 #: ../fish/guestfish-actions.pod:3877
25410 "One consequence of this is that log messages aren't caught by the library "
25411 "and handled by L</set-log-message-callback>, but go straight to stdout."
25415 #: ../fish/guestfish-actions.pod:3886
25416 msgid "set-e2label"
25420 #: ../fish/guestfish-actions.pod:3888
25423 " set-e2label device label\n"
25428 #: ../fish/guestfish-actions.pod:3894
25430 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
25431 "label on a filesystem."
25435 #: ../fish/guestfish-actions.pod:3897
25440 #: ../fish/guestfish-actions.pod:3899
25443 " set-e2uuid device uuid\n"
25448 #: ../fish/guestfish-actions.pod:3906
25450 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
25451 "UUID of a filesystem."
25455 #: ../fish/guestfish-actions.pod:3909
25456 msgid "set-memsize"
25460 #: ../fish/guestfish-actions.pod:3911
25465 #: ../fish/guestfish-actions.pod:3913
25468 " set-memsize memsize\n"
25473 #: ../fish/guestfish-actions.pod:3915
25475 "This sets the memory size in megabytes allocated to the qemu subprocess. "
25476 "This only has any effect if called before L</launch>."
25480 #: ../fish/guestfish-actions.pod:3926
25481 msgid "set-network"
25485 #: ../fish/guestfish-actions.pod:3928
25490 #: ../fish/guestfish-actions.pod:3930
25493 " set-network true|false\n"
25498 #: ../fish/guestfish-actions.pod:3938
25499 msgid "You must call this before calling L</launch>, otherwise it has no effect."
25503 #: ../fish/guestfish-actions.pod:3941
25508 #: ../fish/guestfish-actions.pod:3943
25513 #: ../fish/guestfish-actions.pod:3945
25516 " set-path searchpath\n"
25521 #: ../fish/guestfish-actions.pod:3954
25526 #: ../fish/guestfish-actions.pod:3956
25531 #: ../fish/guestfish-actions.pod:3958
25539 #: ../fish/guestfish-actions.pod:3978
25540 msgid "set-recovery-proc"
25544 #: ../fish/guestfish-actions.pod:3980
25545 msgid "recovery-proc"
25549 #: ../fish/guestfish-actions.pod:3982
25552 " set-recovery-proc true|false\n"
25557 #: ../fish/guestfish-actions.pod:3984
25559 "If this is called with the parameter C<false> then L</launch> does not "
25560 "create a recovery process. The purpose of the recovery process is to stop "
25561 "runaway qemu processes in the case where the main program aborts abruptly."
25565 #: ../fish/guestfish-actions.pod:3989
25567 "This only has any effect if called before L</launch>, and the default is "
25572 #: ../fish/guestfish-actions.pod:3998
25573 msgid "set-selinux"
25577 #: ../fish/guestfish-actions.pod:4000
25582 #: ../fish/guestfish-actions.pod:4002
25585 " set-selinux true|false\n"
25590 #: ../fish/guestfish-actions.pod:4013
25595 #: ../fish/guestfish-actions.pod:4015
25600 #: ../fish/guestfish-actions.pod:4017
25603 " set-trace true|false\n"
25608 #: ../fish/guestfish-actions.pod:4029
25610 "Trace messages are normally sent to C<stderr>, unless you register a "
25611 "callback to send them somewhere else (see L</set-event-callback>)."
25615 #: ../fish/guestfish-actions.pod:4033
25616 msgid "set-verbose"
25620 #: ../fish/guestfish-actions.pod:4035
25625 #: ../fish/guestfish-actions.pod:4037
25628 " set-verbose true|false\n"
25633 #: ../fish/guestfish-actions.pod:4044
25635 "Verbose messages are normally sent to C<stderr>, unless you register a "
25636 "callback to send them somewhere else (see L</set-event-callback>)."
25640 #: ../fish/guestfish-actions.pod:4048
25645 #: ../fish/guestfish-actions.pod:4050
25648 " setcon context\n"
25653 #: ../fish/guestfish-actions.pod:4057
25658 #: ../fish/guestfish-actions.pod:4059
25661 " setxattr xattr val vallen path\n"
25666 #: ../fish/guestfish-actions.pod:4065
25667 msgid "See also: L</lsetxattr>, L<attr(5)>."
25671 #: ../fish/guestfish-actions.pod:4067
25676 #: ../fish/guestfish-actions.pod:4069
25679 " sfdisk device cyls heads sectors 'lines ...'\n"
25684 #: ../fish/guestfish-actions.pod:4091
25685 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
25689 #: ../fish/guestfish-actions.pod:4097
25694 #: ../fish/guestfish-actions.pod:4099
25697 " sfdiskM device 'lines ...'\n"
25702 #: ../fish/guestfish-actions.pod:4101
25704 "This is a simplified interface to the L</sfdisk> command, where partition "
25705 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
25706 "you don't need to specify the cyls, heads and sectors parameters which were "
25707 "rarely if ever used anyway."
25711 #: ../fish/guestfish-actions.pod:4107
25712 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
25716 #: ../fish/guestfish-actions.pod:4113
25721 #: ../fish/guestfish-actions.pod:4115
25724 " sfdisk-N device partnum cyls heads sectors line\n"
25729 #: ../fish/guestfish-actions.pod:4120
25731 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
25732 "cyls/heads/sectors parameters."
25736 #: ../fish/guestfish-actions.pod:4123
25737 msgid "See also: L</part-add>"
25741 #: ../fish/guestfish-actions.pod:4128
25742 msgid "sfdisk-disk-geometry"
25746 #: ../fish/guestfish-actions.pod:4130
25749 " sfdisk-disk-geometry device\n"
25754 #: ../fish/guestfish-actions.pod:4132
25756 "This displays the disk geometry of C<device> read from the partition table. "
25757 "Especially in the case where the underlying block device has been resized, "
25758 "this can be different from the kernel's idea of the geometry (see "
25759 "L</sfdisk-kernel-geometry>)."
25763 #: ../fish/guestfish-actions.pod:4140
25764 msgid "sfdisk-kernel-geometry"
25768 #: ../fish/guestfish-actions.pod:4142
25771 " sfdisk-kernel-geometry device\n"
25776 #: ../fish/guestfish-actions.pod:4149
25781 #: ../fish/guestfish-actions.pod:4151
25784 " sfdisk-l device\n"
25789 #: ../fish/guestfish-actions.pod:4157
25790 msgid "See also: L</part-list>"
25794 #: ../fish/guestfish-actions.pod:4159
25799 #: ../fish/guestfish-actions.pod:4161
25807 #: ../fish/guestfish-actions.pod:4166
25808 msgid "This is like L</command>, but passes the command to:"
25812 #: ../fish/guestfish-actions.pod:4174
25813 msgid "All the provisos about L</command> apply to this call."
25817 #: ../fish/guestfish-actions.pod:4176
25822 #: ../fish/guestfish-actions.pod:4178
25825 " sh-lines command\n"
25830 #: ../fish/guestfish-actions.pod:4180
25831 msgid "This is the same as L</sh>, but splits the result into a list of lines."
25835 #: ../fish/guestfish-actions.pod:4183
25836 msgid "See also: L</command-lines>"
25840 #: ../fish/guestfish-actions.pod:4185
25845 #: ../fish/guestfish-actions.pod:4187
25853 #: ../fish/guestfish-actions.pod:4191
25858 #: ../fish/guestfish-actions.pod:4193
25866 #: ../fish/guestfish-actions.pod:4199
25871 #: ../fish/guestfish-actions.pod:4201
25879 #: ../fish/guestfish-actions.pod:4209
25884 #: ../fish/guestfish-actions.pod:4211
25892 #: ../fish/guestfish-actions.pod:4219
25897 #: ../fish/guestfish-actions.pod:4221
25900 " strings-e encoding path\n"
25905 #: ../fish/guestfish-actions.pod:4223
25907 "This is like the L</strings> command, but allows you to specify the encoding "
25908 "of strings that are looked for in the source file C<path>."
25912 #: ../fish/guestfish-actions.pod:4233
25914 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
25915 "ISO-8859-X (this is what L</strings> uses)."
25919 #: ../fish/guestfish-actions.pod:4265
25920 msgid "swapoff-device"
25924 #: ../fish/guestfish-actions.pod:4267
25927 " swapoff-device device\n"
25932 #: ../fish/guestfish-actions.pod:4269
25934 "This command disables the libguestfs appliance swap device or partition "
25935 "named C<device>. See L</swapon-device>."
25939 #: ../fish/guestfish-actions.pod:4273
25940 msgid "swapoff-file"
25944 #: ../fish/guestfish-actions.pod:4275
25947 " swapoff-file file\n"
25952 #: ../fish/guestfish-actions.pod:4279
25953 msgid "swapoff-label"
25957 #: ../fish/guestfish-actions.pod:4281
25960 " swapoff-label label\n"
25965 #: ../fish/guestfish-actions.pod:4286
25966 msgid "swapoff-uuid"
25970 #: ../fish/guestfish-actions.pod:4288
25973 " swapoff-uuid uuid\n"
25978 #: ../fish/guestfish-actions.pod:4293
25979 msgid "swapon-device"
25983 #: ../fish/guestfish-actions.pod:4295
25986 " swapon-device device\n"
25991 #: ../fish/guestfish-actions.pod:4297
25993 "This command enables the libguestfs appliance to use the swap device or "
25994 "partition named C<device>. The increased memory is made available for all "
25995 "commands, for example those run using L</command> or L</sh>."
25999 #: ../fish/guestfish-actions.pod:4309
26000 msgid "swapon-file"
26004 #: ../fish/guestfish-actions.pod:4311
26007 " swapon-file file\n"
26012 #: ../fish/guestfish-actions.pod:4313
26013 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26017 #: ../fish/guestfish-actions.pod:4316
26018 msgid "swapon-label"
26022 #: ../fish/guestfish-actions.pod:4318
26025 " swapon-label label\n"
26030 #: ../fish/guestfish-actions.pod:4320
26032 "This command enables swap to a labeled swap partition. See "
26033 "L</swapon-device> for other notes."
26037 #: ../fish/guestfish-actions.pod:4323
26038 msgid "swapon-uuid"
26042 #: ../fish/guestfish-actions.pod:4325
26045 " swapon-uuid uuid\n"
26050 #: ../fish/guestfish-actions.pod:4327
26052 "This command enables swap to a swap partition with the given UUID. See "
26053 "L</swapon-device> for other notes."
26057 #: ../fish/guestfish-actions.pod:4330
26062 #: ../fish/guestfish-actions.pod:4332
26070 #: ../fish/guestfish-actions.pod:4340
26075 #: ../fish/guestfish-actions.pod:4342
26083 #: ../fish/guestfish-actions.pod:4350
26088 #: ../fish/guestfish-actions.pod:4352
26091 " tail-n nrlines path\n"
26096 #: ../fish/guestfish-actions.pod:4365
26101 #: ../fish/guestfish-actions.pod:4367
26104 " tar-in (tarfile|-) directory\n"
26109 #: ../fish/guestfish-actions.pod:4372
26110 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26114 #: ../fish/guestfish-actions.pod:4377
26119 #: ../fish/guestfish-actions.pod:4379
26122 " tar-out directory (tarfile|-)\n"
26127 #: ../fish/guestfish-actions.pod:4384
26128 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26132 #: ../fish/guestfish-actions.pod:4389
26137 #: ../fish/guestfish-actions.pod:4391
26140 " tgz-in (tarball|-) directory\n"
26145 #: ../fish/guestfish-actions.pod:4396
26146 msgid "To upload an uncompressed tarball, use L</tar-in>."
26150 #: ../fish/guestfish-actions.pod:4400
26155 #: ../fish/guestfish-actions.pod:4402
26158 " tgz-out directory (tarball|-)\n"
26163 #: ../fish/guestfish-actions.pod:4407
26164 msgid "To download an uncompressed tarball, use L</tar-out>."
26168 #: ../fish/guestfish-actions.pod:4411
26173 #: ../fish/guestfish-actions.pod:4413
26181 #: ../fish/guestfish-actions.pod:4422
26186 #: ../fish/guestfish-actions.pod:4424
26194 #: ../fish/guestfish-actions.pod:4429
26195 msgid "truncate-size"
26199 #: ../fish/guestfish-actions.pod:4431
26202 " truncate-size path size\n"
26207 #: ../fish/guestfish-actions.pod:4436
26209 "If the current file size is less than C<size> then the file is extended to "
26210 "the required size with zero bytes. This creates a sparse file (ie. disk "
26211 "blocks are not allocated for the file until you write to it). To create a "
26212 "non-sparse file of zeroes, use L</fallocate64> instead."
26216 #: ../fish/guestfish-actions.pod:4442
26221 #: ../fish/guestfish-actions.pod:4444
26224 " tune2fs-l device\n"
26229 #: ../fish/guestfish-actions.pod:4454
26234 #: ../fish/guestfish-actions.pod:4456
26237 " txz-in (tarball|-) directory\n"
26242 #: ../fish/guestfish-actions.pod:4463
26247 #: ../fish/guestfish-actions.pod:4465
26250 " txz-out directory (tarball|-)\n"
26255 #: ../fish/guestfish-actions.pod:4472
26260 #: ../fish/guestfish-actions.pod:4474
26268 #: ../fish/guestfish-actions.pod:4488
26269 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
26273 #: ../fish/guestfish-actions.pod:4493
26278 #: ../fish/guestfish-actions.pod:4495
26283 #: ../fish/guestfish-actions.pod:4497
26286 " umount pathordevice\n"
26291 #: ../fish/guestfish-actions.pod:4503
26296 #: ../fish/guestfish-actions.pod:4505
26297 msgid "unmount-all"
26301 #: ../fish/guestfish-actions.pod:4507
26309 #: ../fish/guestfish-actions.pod:4513
26314 #: ../fish/guestfish-actions.pod:4515
26317 " upload (filename|-) remotefilename\n"
26322 #: ../fish/guestfish-actions.pod:4522
26323 msgid "See also L</download>."
26327 #: ../fish/guestfish-actions.pod:4526
26328 msgid "upload-offset"
26332 #: ../fish/guestfish-actions.pod:4528
26335 " upload-offset (filename|-) remotefilename offset\n"
26340 #: ../fish/guestfish-actions.pod:4540
26342 "Note that there is no limit on the amount of data that can be uploaded with "
26343 "this call, unlike with L</pwrite>, and this call always writes the full "
26344 "amount unless an error occurs."
26348 #: ../fish/guestfish-actions.pod:4545
26349 msgid "See also L</upload>, L</pwrite>."
26353 #: ../fish/guestfish-actions.pod:4549
26358 #: ../fish/guestfish-actions.pod:4551
26361 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
26366 #: ../fish/guestfish-actions.pod:4570
26371 #: ../fish/guestfish-actions.pod:4572
26379 #: ../fish/guestfish-actions.pod:4599
26381 "I<Note:> Don't use this call to test for availability of features. In "
26382 "enterprise distributions we backport features from later versions into "
26383 "earlier versions, making this an unreliable way to test for features. Use "
26384 "L</available> instead."
26388 #: ../fish/guestfish-actions.pod:4605
26393 #: ../fish/guestfish-actions.pod:4607
26396 " vfs-label device\n"
26401 #: ../fish/guestfish-actions.pod:4614
26402 msgid "To find a filesystem from the label, use L</findfs-label>."
26406 #: ../fish/guestfish-actions.pod:4616
26411 #: ../fish/guestfish-actions.pod:4618
26414 " vfs-type device\n"
26419 #: ../fish/guestfish-actions.pod:4628
26424 #: ../fish/guestfish-actions.pod:4630
26427 " vfs-uuid device\n"
26432 #: ../fish/guestfish-actions.pod:4637
26433 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
26437 #: ../fish/guestfish-actions.pod:4639
26438 msgid "vg-activate"
26442 #: ../fish/guestfish-actions.pod:4641
26445 " vg-activate true|false 'volgroups ...'\n"
26450 #: ../fish/guestfish-actions.pod:4654
26451 msgid "vg-activate-all"
26455 #: ../fish/guestfish-actions.pod:4656
26458 " vg-activate-all true|false\n"
26463 #: ../fish/guestfish-actions.pod:4666
26468 #: ../fish/guestfish-actions.pod:4668
26471 " vgcreate volgroup 'physvols ...'\n"
26476 #: ../fish/guestfish-actions.pod:4673
26481 #: ../fish/guestfish-actions.pod:4675
26484 " vglvuuids vgname\n"
26489 #: ../fish/guestfish-actions.pod:4680
26491 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
26492 "logical volumes and volume groups."
26496 #: ../fish/guestfish-actions.pod:4683
26497 msgid "See also L</vgpvuuids>."
26501 #: ../fish/guestfish-actions.pod:4685
26506 #: ../fish/guestfish-actions.pod:4687
26509 " vgpvuuids vgname\n"
26514 #: ../fish/guestfish-actions.pod:4692
26516 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
26517 "physical volumes and volume groups."
26521 #: ../fish/guestfish-actions.pod:4695
26522 msgid "See also L</vglvuuids>."
26526 #: ../fish/guestfish-actions.pod:4697
26531 #: ../fish/guestfish-actions.pod:4699
26534 " vgremove vgname\n"
26539 #: ../fish/guestfish-actions.pod:4706
26544 #: ../fish/guestfish-actions.pod:4708
26547 " vgrename volgroup newvolgroup\n"
26552 #: ../fish/guestfish-actions.pod:4712
26557 #: ../fish/guestfish-actions.pod:4714
26565 #: ../fish/guestfish-actions.pod:4722
26566 msgid "See also L</vgs-full>."
26570 #: ../fish/guestfish-actions.pod:4724
26575 #: ../fish/guestfish-actions.pod:4726
26583 #: ../fish/guestfish-actions.pod:4731
26588 #: ../fish/guestfish-actions.pod:4733
26596 #: ../fish/guestfish-actions.pod:4738
26601 #: ../fish/guestfish-actions.pod:4740
26609 #: ../fish/guestfish-actions.pod:4744
26614 #: ../fish/guestfish-actions.pod:4746
26622 #: ../fish/guestfish-actions.pod:4751
26627 #: ../fish/guestfish-actions.pod:4753
26635 #: ../fish/guestfish-actions.pod:4758
26640 #: ../fish/guestfish-actions.pod:4760
26648 #: ../fish/guestfish-actions.pod:4765
26653 #: ../fish/guestfish-actions.pod:4767
26656 " write path content\n"
26661 #: ../fish/guestfish-actions.pod:4775
26666 #: ../fish/guestfish-actions.pod:4777
26669 " write-file path content size\n"
26674 #: ../fish/guestfish-actions.pod:4800
26679 #: ../fish/guestfish-actions.pod:4802
26682 " zegrep regex path\n"
26687 #: ../fish/guestfish-actions.pod:4810
26692 #: ../fish/guestfish-actions.pod:4812
26695 " zegrepi regex path\n"
26700 #: ../fish/guestfish-actions.pod:4820
26705 #: ../fish/guestfish-actions.pod:4822
26713 #: ../fish/guestfish-actions.pod:4830
26714 msgid "See also: L</zero-device>, L</scrub-device>."
26718 #: ../fish/guestfish-actions.pod:4832
26719 msgid "zero-device"
26723 #: ../fish/guestfish-actions.pod:4834
26726 " zero-device device\n"
26731 #: ../fish/guestfish-actions.pod:4836
26733 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
26734 "which just zeroes the first few blocks of a device."
26738 #: ../fish/guestfish-actions.pod:4843
26743 #: ../fish/guestfish-actions.pod:4845
26746 " zerofree device\n"
26751 #: ../fish/guestfish-actions.pod:4858
26756 #: ../fish/guestfish-actions.pod:4860
26759 " zfgrep pattern path\n"
26764 #: ../fish/guestfish-actions.pod:4868
26769 #: ../fish/guestfish-actions.pod:4870
26772 " zfgrepi pattern path\n"
26777 #: ../fish/guestfish-actions.pod:4878
26782 #: ../fish/guestfish-actions.pod:4880
26785 " zfile meth path\n"
26790 #: ../fish/guestfish-actions.pod:4887
26791 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
26795 #: ../fish/guestfish-actions.pod:4897
26800 #: ../fish/guestfish-actions.pod:4899
26803 " zgrep regex path\n"
26808 #: ../fish/guestfish-actions.pod:4907
26813 #: ../fish/guestfish-actions.pod:4909
26816 " zgrepi regex path\n"
26821 #: ../fish/guestfish-commands.pod:1
26826 #: ../fish/guestfish-commands.pod:3
26831 #: ../fish/guestfish-commands.pod:5
26834 " alloc filename size\n"
26839 #: ../fish/guestfish-commands.pod:7
26841 "This creates an empty (zeroed) file of the given size, and then adds so it "
26842 "can be further examined."
26846 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
26847 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
26851 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
26852 msgid "Size can be specified using standard suffixes, eg. C<1M>."
26856 #: ../fish/guestfish-commands.pod:14
26858 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
26859 "image, see L</PREPARED DISK IMAGES>."
26863 #: ../fish/guestfish-commands.pod:17
26868 #: ../fish/guestfish-commands.pod:19
26871 " copy-in local [local ...] /remotedir\n"
26876 #: ../fish/guestfish-commands.pod:21
26878 "C<copy-in> copies local files or directories recursively into the disk "
26879 "image, placing them in the directory called C</remotedir> (which must "
26880 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
26881 "other commands as necessary."
26885 #: ../fish/guestfish-commands.pod:26
26887 "Multiple local files and directories can be specified, but the last "
26888 "parameter must always be a remote directory. Wildcards cannot be used."
26892 #: ../fish/guestfish-commands.pod:30
26897 #: ../fish/guestfish-commands.pod:32
26900 " copy-out remote [remote ...] localdir\n"
26905 #: ../fish/guestfish-commands.pod:34
26907 "C<copy-out> copies remote files or directories recursively out of the disk "
26908 "image, placing them on the host disk in a local directory called C<localdir> "
26909 "(which must exist). This guestfish meta-command turns into a sequence of "
26910 "L</download>, L</tar-out> and other commands as necessary."
26914 #: ../fish/guestfish-commands.pod:40
26916 "Multiple remote files and directories can be specified, but the last "
26917 "parameter must always be a local directory. To download to the current "
26918 "directory, use C<.> as in:"
26922 #: ../fish/guestfish-commands.pod:44
26925 " copy-out /home .\n"
26930 #: ../fish/guestfish-commands.pod:46
26932 "Wildcards cannot be used in the ordinary command, but you can use them with "
26933 "the help of L</glob> like this:"
26937 #: ../fish/guestfish-commands.pod:49
26940 " glob copy-out /home/* .\n"
26945 #: ../fish/guestfish-commands.pod:51
26950 #: ../fish/guestfish-commands.pod:53
26953 " echo [params ...]\n"
26958 #: ../fish/guestfish-commands.pod:55
26959 msgid "This echos the parameters to the terminal."
26963 #: ../fish/guestfish-commands.pod:57
26968 #: ../fish/guestfish-commands.pod:59
26973 #: ../fish/guestfish-commands.pod:61
26978 #: ../fish/guestfish-commands.pod:63
26986 #: ../fish/guestfish-commands.pod:65
26988 "This is used to edit a file. It downloads the file, edits it locally using "
26989 "your editor, then uploads the result."
26993 #: ../fish/guestfish-commands.pod:68
26995 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
26996 "or C<emacs> you will get those corresponding editors."
27000 #: ../fish/guestfish-commands.pod:72
27005 #: ../fish/guestfish-commands.pod:74
27008 " glob command args...\n"
27013 #: ../fish/guestfish-commands.pod:76
27015 "Expand wildcards in any paths in the args list, and run C<command> "
27016 "repeatedly on each matching path."
27020 #: ../fish/guestfish-commands.pod:79
27021 msgid "See L</WILDCARDS AND GLOBBING>."
27025 #: ../fish/guestfish-commands.pod:81
27030 #: ../fish/guestfish-commands.pod:83
27033 " hexedit <filename|device>\n"
27034 " hexedit <filename|device> <max>\n"
27035 " hexedit <filename|device> <start> <max>\n"
27040 #: ../fish/guestfish-commands.pod:87
27042 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27047 #: ../fish/guestfish-commands.pod:90
27049 "This command works by downloading potentially the whole file or device, "
27050 "editing it locally, then uploading it. If the file or device is large, you "
27051 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27052 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27053 "usual modifiers allowed such as C<1M> (1 megabyte)."
27057 #: ../fish/guestfish-commands.pod:97
27058 msgid "For example to edit the first few sectors of a disk you might do:"
27062 #: ../fish/guestfish-commands.pod:100
27065 " hexedit /dev/sda 1M\n"
27070 #: ../fish/guestfish-commands.pod:102
27072 "which would allow you to edit anywhere within the first megabyte of the "
27077 #: ../fish/guestfish-commands.pod:105
27078 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27082 #: ../fish/guestfish-commands.pod:107
27085 " hexedit /dev/sda1 0x400 0x400\n"
27090 #: ../fish/guestfish-commands.pod:109
27091 msgid "(assuming the superblock is in the standard location)."
27095 #: ../fish/guestfish-commands.pod:111
27097 "This command requires the external L<hexedit(1)> program. You can specify "
27098 "another program to use by setting the C<HEXEDITOR> environment variable."
27102 #: ../fish/guestfish-commands.pod:115
27103 msgid "See also L</hexdump>."
27107 #: ../fish/guestfish-commands.pod:117
27112 #: ../fish/guestfish-commands.pod:119
27120 #: ../fish/guestfish-commands.pod:121
27121 msgid "Change the local directory, ie. the current directory of guestfish itself."
27125 #: ../fish/guestfish-commands.pod:124
27126 msgid "Note that C<!cd> won't do what you might expect."
27130 #: ../fish/guestfish-commands.pod:126
27135 #: ../fish/guestfish-commands.pod:128
27140 #: ../fish/guestfish-commands.pod:130
27148 #: ../fish/guestfish-commands.pod:132
27149 msgid "Opens the manual page for guestfish."
27153 #: ../fish/guestfish-commands.pod:134
27158 #: ../fish/guestfish-commands.pod:136
27163 #: ../fish/guestfish-commands.pod:138
27171 #: ../fish/guestfish-commands.pod:140
27179 #: ../fish/guestfish-commands.pod:142
27180 msgid "This is used to view a file."
27184 #: ../fish/guestfish-commands.pod:144
27186 "The default viewer is C<$PAGER>. However if you use the alternate command "
27187 "C<less> you will get the C<less> command specifically."
27191 #: ../fish/guestfish-commands.pod:147
27196 #: ../fish/guestfish-commands.pod:149
27204 #: ../fish/guestfish-commands.pod:151
27206 "Close and reopen the libguestfs handle. It is not necessary to use this "
27207 "normally, because the handle is closed properly when guestfish exits. "
27208 "However this is occasionally useful for testing."
27212 #: ../fish/guestfish-commands.pod:155
27217 #: ../fish/guestfish-commands.pod:157
27220 " sparse filename size\n"
27225 #: ../fish/guestfish-commands.pod:159
27227 "This creates an empty sparse file of the given size, and then adds so it can "
27228 "be further examined."
27232 #: ../fish/guestfish-commands.pod:162
27234 "In all respects it works the same as the L</alloc> command, except that the "
27235 "image file is allocated sparsely, which means that disk blocks are not "
27236 "assigned to the file until they are needed. Sparse disk files only use "
27237 "space when written to, but they are slower and there is a danger you could "
27238 "run out of real disk space during a write operation."
27242 #: ../fish/guestfish-commands.pod:172
27247 #: ../fish/guestfish-commands.pod:174
27255 #: ../fish/guestfish-commands.pod:176
27257 "This command returns a list of the optional groups known to the daemon, and "
27258 "indicates which ones are supported by this build of the libguestfs "
27263 #: ../fish/guestfish-commands.pod:180
27264 msgid "See also L<guestfs(3)/AVAILABILITY>."
27268 #: ../fish/guestfish-commands.pod:182
27273 #: ../fish/guestfish-commands.pod:184
27276 " time command args...\n"
27281 #: ../fish/guestfish-commands.pod:186
27283 "Run the command as usual, but print the elapsed time afterwards. This can "
27284 "be useful for benchmarking operations."
27288 #: ../test-tool/libguestfs-test-tool.pod:5
27289 msgid "libguestfs-test-tool - End user tests for libguestfs"
27293 #: ../test-tool/libguestfs-test-tool.pod:9
27296 " libguestfs-test-tool [--options]\n"
27301 #: ../test-tool/libguestfs-test-tool.pod:13
27303 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
27304 "and developers, to allow them to check basic libguestfs functionality is "
27305 "working. This is needed because libguestfs occasionally breaks for reasons "
27306 "beyond our control: usually because of changes in the underlying qemu or "
27307 "kernel packages, or the host environment."
27311 #: ../test-tool/libguestfs-test-tool.pod:20
27312 msgid "If you suspect a problem in libguestfs, then just run:"
27316 #: ../test-tool/libguestfs-test-tool.pod:22
27319 " libguestfs-test-tool\n"
27324 #: ../test-tool/libguestfs-test-tool.pod:24
27325 msgid "It will print lots of diagnostic messages."
27329 #: ../test-tool/libguestfs-test-tool.pod:26
27330 msgid "If it runs to completion successfully, you will see this near the end:"
27334 #: ../test-tool/libguestfs-test-tool.pod:28
27337 " ===== TEST FINISHED OK =====\n"
27342 #: ../test-tool/libguestfs-test-tool.pod:30
27343 msgid "and the test tool will exit with code 0."
27347 #: ../test-tool/libguestfs-test-tool.pod:32
27349 "If it fails (and/or exits with non-zero error code), please paste the "
27350 "B<complete, unedited> output of the test tool into a bug report. More "
27351 "information about reporting bugs can be found on the "
27352 "L<http://libguestfs.org/> website."
27356 #: ../test-tool/libguestfs-test-tool.pod:41
27361 #: ../test-tool/libguestfs-test-tool.pod:43
27362 msgid "Display short usage information and exit."
27366 #: ../test-tool/libguestfs-test-tool.pod:45
27367 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
27371 #: ../test-tool/libguestfs-test-tool.pod:47
27373 "Pass an alternate name for the helper program. libguestfs-test-tool will "
27374 "normally look in the C<$libexec> directory that was configured when the tool "
27379 #: ../test-tool/libguestfs-test-tool.pod:51
27380 msgid "I<--qemu qemu_binary>"
27384 #: ../test-tool/libguestfs-test-tool.pod:53
27386 "If you have downloaded another qemu binary, point this option at the full "
27387 "path of the binary to try it."
27391 #: ../test-tool/libguestfs-test-tool.pod:56
27392 msgid "I<--qemudir qemu_source_dir>"
27396 #: ../test-tool/libguestfs-test-tool.pod:58
27398 "If you have compiled qemu from source, point this option at the source "
27399 "directory to try it."
27403 #: ../test-tool/libguestfs-test-tool.pod:61
27404 msgid "I<--timeout N>"
27408 #: ../test-tool/libguestfs-test-tool.pod:63
27410 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
27411 "does not usually need to be adjusted unless your machine is very slow."
27415 #: ../test-tool/libguestfs-test-tool.pod:69
27416 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
27420 #: ../test-tool/libguestfs-test-tool.pod:71
27422 "If you have compiled another version of qemu from source and would like to "
27423 "try that, then you can use the I<--qemudir> option to point to the qemu "
27424 "source directory."
27428 #: ../test-tool/libguestfs-test-tool.pod:75
27430 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
27431 "option to point to the binary."
27435 #: ../test-tool/libguestfs-test-tool.pod:78
27437 "When using an alternate qemu with libguestfs, usually you would need to "
27438 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
27439 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
27440 "when you use either of the I<--qemudir> or I<--qemu> options."
27444 #: ../test-tool/libguestfs-test-tool.pod:85
27446 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
27447 "I<1> if there was an error."
27451 #: ../test-tool/libguestfs-test-tool.pod:92
27452 msgid "/usr/libexec/libguestfs-test-tool-helper"
27456 #: ../test-tool/libguestfs-test-tool.pod:94
27458 "This helper program is run inside the appliance and provides additional "
27463 #: ../test-tool/libguestfs-test-tool.pod:97
27464 msgid "/usr/bin/mkisofs"
27468 #: ../test-tool/libguestfs-test-tool.pod:99
27470 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
27471 "which is used as part of the tests."
27475 #: ../test-tool/libguestfs-test-tool.pod:106
27477 "For the full list of environment variables which may affect libguestfs, "
27478 "please see the L<guestfs(3)> manual page."
27482 #: ../test-tool/libguestfs-test-tool.pod:111
27483 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
27487 #: ../test-tool/libguestfs-test-tool.pod:121
27488 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
27492 #: ../fuse/guestmount.pod:5
27493 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
27497 #: ../fuse/guestmount.pod:9
27500 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
27505 #: ../fuse/guestmount.pod:11
27508 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
27513 #: ../fuse/guestmount.pod:13
27516 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
27521 #: ../fuse/guestmount.pod:17
27523 "You must I<not> use C<guestmount> in read-write mode on live virtual "
27524 "machines. If you do this, you risk disk corruption in the VM."
27528 #: ../fuse/guestmount.pod:22
27530 "The guestmount program can be used to mount virtual machine filesystems and "
27531 "other disk images on the host. It uses libguestfs for access to the guest "
27532 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
27533 "a mountable device."
27537 #: ../fuse/guestmount.pod:27
27539 "Along with other options, you have to give at least one device (I<-a> "
27540 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
27541 "option) or use the I<-i> inspection option. How this works is better "
27542 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
27547 #: ../fuse/guestmount.pod:33
27549 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
27550 "by you, and the filesystem will not be visible to any other users unless you "
27551 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
27552 "the filesystem, use the C<fusermount -u> command."
27556 #: ../fuse/guestmount.pod:41
27558 "For a typical Windows guest which has its main filesystem on the first "
27563 #: ../fuse/guestmount.pod:44
27566 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
27571 #: ../fuse/guestmount.pod:46
27573 "For a typical Linux guest which has a /boot filesystem on the first "
27574 "partition, and the root filesystem on a logical volume:"
27578 #: ../fuse/guestmount.pod:49
27581 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
27586 #: ../fuse/guestmount.pod:51
27587 msgid "To get libguestfs to detect guest mountpoints for you:"
27591 #: ../fuse/guestmount.pod:53
27594 " guestmount -a guest.img -i --ro /mnt\n"
27599 #: ../fuse/guestmount.pod:55
27600 msgid "For a libvirt guest called \"Guest\" you could do:"
27604 #: ../fuse/guestmount.pod:57
27607 " guestmount -d Guest -i --ro /mnt\n"
27612 #: ../fuse/guestmount.pod:59
27614 "If you don't know what filesystems are contained in a guest or disk image, "
27615 "use L<virt-filesystems(1)> first:"
27619 #: ../fuse/guestmount.pod:62
27622 " virt-filesystems MyGuest\n"
27627 #: ../fuse/guestmount.pod:64
27629 "If you want to trace the libguestfs calls but without excessive debugging "
27630 "information, we recommend:"
27634 #: ../fuse/guestmount.pod:67
27637 " guestmount [...] --trace /mnt\n"
27642 #: ../fuse/guestmount.pod:69
27643 msgid "If you want to debug the program, we recommend:"
27647 #: ../fuse/guestmount.pod:71
27650 " guestmount [...] --trace --verbose /mnt\n"
27655 #: ../fuse/guestmount.pod:77
27656 msgid "B<-a image> | B<--add image>"
27660 #: ../fuse/guestmount.pod:79
27661 msgid "Add a block device or virtual machine image."
27665 #: ../fuse/guestmount.pod:84
27666 msgid "B<-c URI> | B<--connect URI>"
27670 #: ../fuse/guestmount.pod:90
27671 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
27675 #: ../fuse/guestmount.pod:96
27676 msgid "B<--dir-cache-timeout N>"
27680 #: ../fuse/guestmount.pod:98
27682 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
27683 "seconds. The readdir cache [actually, there are several semi-independent "
27684 "caches] is populated after a readdir(2) call with the stat and extended "
27685 "attributes of the files in the directory, in anticipation that they will be "
27686 "requested soon after."
27690 #: ../fuse/guestmount.pod:104
27692 "There is also a different attribute cache implemented by FUSE (see the FUSE "
27693 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
27694 "requests, only cache existing ones."
27698 #: ../fuse/guestmount.pod:115
27699 msgid "B<--format=raw|qcow2|..> | B<--format>"
27703 #: ../fuse/guestmount.pod:122
27705 "If you have untrusted raw-format guest disk images, you should use this "
27706 "option to specify the disk format. This avoids a possible security problem "
27707 "with malicious guests (CVE-2010-3851). See also "
27708 "L<guestfs(3)/guestfs_add_drive_opts>."
27712 #: ../fuse/guestmount.pod:127
27713 msgid "B<--fuse-help>"
27717 #: ../fuse/guestmount.pod:129
27718 msgid "Display help on special FUSE options (see I<-o> below)."
27722 #: ../fuse/guestmount.pod:133
27723 msgid "Display brief help and exit."
27727 #: ../fuse/guestmount.pod:135
27728 msgid "B<-i> | B<--inspector>"
27732 #: ../fuse/guestmount.pod:151
27733 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
27737 #: ../fuse/guestmount.pod:153
27739 "Mount the named partition or logical volume on the given mountpoint B<in the "
27740 "guest> (this has nothing to do with mountpoints in the host)."
27744 #: ../fuse/guestmount.pod:156
27746 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
27747 "something on C</>."
27751 #: ../fuse/guestmount.pod:159
27752 msgid "B<-n> | B<--no-sync>"
27756 #: ../fuse/guestmount.pod:161
27758 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
27759 "unmounted. If you specify this option, then we don't attempt to sync the "
27760 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
27764 #: ../fuse/guestmount.pod:166
27765 msgid "B<-o option> | B<--option option>"
27769 #: ../fuse/guestmount.pod:168
27770 msgid "Pass extra options to FUSE."
27774 #: ../fuse/guestmount.pod:170
27776 "To get a list of all the extra options supported by FUSE, use the command "
27777 "below. Note that only the FUSE I<-o> options can be passed, and only some "
27778 "of them are a good idea."
27782 #: ../fuse/guestmount.pod:174
27785 " guestmount --fuse-help\n"
27790 #: ../fuse/guestmount.pod:176
27791 msgid "Some potentially useful FUSE options:"
27795 #: ../fuse/guestmount.pod:180
27796 msgid "B<-o allow_other>"
27800 #: ../fuse/guestmount.pod:182
27801 msgid "Allow other users to see the filesystem."
27805 #: ../fuse/guestmount.pod:184
27806 msgid "B<-o attr_timeout=N>"
27810 #: ../fuse/guestmount.pod:186
27811 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
27815 #: ../fuse/guestmount.pod:188
27816 msgid "B<-o kernel_cache>"
27820 #: ../fuse/guestmount.pod:190
27822 "Allow the kernel to cache files (reduces the number of reads that have to go "
27823 "through the L<guestfs(3)> API). This is generally a good idea if you can "
27824 "afford the extra memory usage."
27828 #: ../fuse/guestmount.pod:194
27829 msgid "B<-o uid=N> B<-o gid=N>"
27833 #: ../fuse/guestmount.pod:196
27835 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
27836 "the chosen values."
27840 #: ../fuse/guestmount.pod:201
27841 msgid "B<-r> | B<--ro>"
27845 #: ../fuse/guestmount.pod:203
27847 "Add devices and mount everything read-only. Also disallow writes and make "
27848 "the disk appear read-only to FUSE."
27852 #: ../fuse/guestmount.pod:206
27854 "This is highly recommended if you are not going to edit the guest disk. If "
27855 "the guest is running and this option is I<not> supplied, then there is a "
27856 "strong risk of disk corruption in the guest. We try to prevent this from "
27857 "happening, but it is not always possible."
27861 #: ../fuse/guestmount.pod:211
27862 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
27866 #: ../fuse/guestmount.pod:215
27867 msgid "Enable SELinux support for the guest."
27871 #: ../fuse/guestmount.pod:217
27872 msgid "B<-v> | B<--verbose>"
27876 #: ../fuse/guestmount.pod:219
27877 msgid "Enable verbose messages from underlying libguestfs."
27881 #: ../fuse/guestmount.pod:221
27882 msgid "B<-V> | B<--version>"
27886 #: ../fuse/guestmount.pod:223
27887 msgid "Display the program version and exit."
27891 #: ../fuse/guestmount.pod:225
27892 msgid "B<-w> | B<--rw>"
27896 #: ../fuse/guestmount.pod:227
27898 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
27899 "FOR READ AND WRITE>."
27903 #: ../fuse/guestmount.pod:230
27904 msgid "B<-x> | B<--trace>"
27908 #: ../fuse/guestmount.pod:232
27909 msgid "Trace libguestfs calls and entry into each FUSE function."
27913 #: ../fuse/guestmount.pod:234
27914 msgid "This also stops the daemon from forking into the background."
27918 #: ../fuse/guestmount.pod:240
27920 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
27921 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
27922 "L<http://fuse.sf.net/>."
27926 #: ../tools/virt-edit.pl:34
27927 msgid "virt-edit - Edit a file in a virtual machine"
27931 #: ../tools/virt-edit.pl:38
27934 " virt-edit [--options] domname file\n"
27939 #: ../tools/virt-edit.pl:40
27942 " virt-edit [--options] disk.img [disk.img ...] file\n"
27947 #: ../tools/virt-edit.pl:42
27950 " virt-edit [domname|disk.img] file -e 'expr'\n"
27955 #: ../tools/virt-edit.pl:46
27957 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
27958 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
27959 "doing this, but doesn't catch all cases."
27963 #: ../tools/virt-edit.pl:52
27965 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
27966 "the named virtual machine (or disk image)."
27970 #: ../tools/virt-edit.pl:55
27972 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
27973 "you should look at the L<guestfish(1)> tool."
27977 #: ../tools/virt-edit.pl:60
27978 msgid "Edit the named files interactively:"
27982 #: ../tools/virt-edit.pl:62
27985 " virt-edit mydomain /boot/grub/grub.conf\n"
27990 #: ../tools/virt-edit.pl:64
27993 " virt-edit mydomain /etc/passwd\n"
27998 #: ../tools/virt-edit.pl:66
28000 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
28001 "below). To change the init default level to 5:"
28005 #: ../tools/virt-edit.pl:70
28008 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
28013 #: ../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
28014 msgid "Display brief help."
28018 #: ../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
28019 msgid "Display version number and exit."
28023 #: ../tools/virt-edit.pl:96
28024 msgid "B<--backup extension> | B<-b extension>"
28028 #: ../tools/virt-edit.pl:98
28030 "Create a backup of the original file I<in the guest disk image>. The backup "
28031 "has the original filename with C<extension> added."
28035 #: ../tools/virt-edit.pl:101
28037 "Usually the first character of C<extension> would be a dot C<.> so you would "
28042 #: ../tools/virt-edit.pl:104
28045 " virt-edit -b .orig [etc]\n"
28050 #: ../tools/virt-edit.pl:106
28051 msgid "By default, no backup file is made."
28055 #: ../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
28056 msgid "B<--connect URI> | B<-c URI>"
28060 #: ../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
28062 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28063 "to the default libvirt hypervisor."
28067 #: ../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
28069 "If you specify guest block devices directly, then libvirt is not used at "
28074 #: ../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
28075 msgid "B<--format> raw"
28079 #: ../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
28081 "Specify the format of disk images given on the command line. If this is "
28082 "omitted then the format is autodetected from the content of the disk image."
28086 #: ../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
28088 "If disk images are requested from libvirt, then this program asks libvirt "
28089 "for this information. In this case, the value of the format parameter is "
28094 #: ../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
28096 "If working with untrusted raw-format guest disk images, you should ensure "
28097 "the format is always specified."
28101 #: ../tools/virt-edit.pl:141
28102 msgid "B<--expr EXPR> | B<-e EXPR>"
28106 #: ../tools/virt-edit.pl:143
28108 "Instead of launching the external editor, non-interactively apply the Perl "
28109 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
28114 #: ../tools/virt-edit.pl:147
28116 "Be careful to properly quote the expression to prevent it from being altered "
28121 #: ../tools/virt-edit.pl:268
28122 msgid "NON-INTERACTIVE EDITING"
28126 #: ../tools/virt-edit.pl:270
28128 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
28129 "administrator can interactively edit the file."
28133 #: ../tools/virt-edit.pl:273
28135 "There are two ways also to use C<virt-edit> from scripts in order to make "
28136 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
28137 "like this, it's less error-prone to write scripts directly using the "
28138 "libguestfs API and Augeas for configuration file editing.)"
28142 #: ../tools/virt-edit.pl:279
28144 "The first method is to temporarily set C<$EDITOR> to any script or program "
28145 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
28146 "update C<tmpfile> in place however it likes."
28150 #: ../tools/virt-edit.pl:283
28152 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
28153 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
28154 "instances of C<foo> with C<bar> in a file:"
28158 #: ../tools/virt-edit.pl:287
28161 " virt-edit domname filename -e 's/foo/bar/'\n"
28166 #: ../tools/virt-edit.pl:289
28168 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
28169 "For example to delete root's password you could do:"
28173 #: ../tools/virt-edit.pl:292
28176 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
28181 #: ../tools/virt-edit.pl:294
28183 "What really happens is that the snippet is evaluated as a Perl expression "
28184 "for each line of the file. The line, including the final C<\\n>, is passed "
28185 "in C<$_> and the expression should update C<$_> or leave it unchanged."
28189 #: ../tools/virt-edit.pl:299
28191 "To delete a line, set C<$_> to the empty string. For example, to delete the "
28192 "C<apache> user account from the password file you can do:"
28196 #: ../tools/virt-edit.pl:302
28199 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
28204 #: ../tools/virt-edit.pl:304
28206 "To insert a line, prepend or append it to C<$_>. However appending lines to "
28207 "the end of the file is rather difficult this way since there is no concept "
28208 "of \"last line of the file\" - your expression just doesn't get called "
28209 "again. You might want to use the first method (setting C<$EDITOR>) if you "
28214 #: ../tools/virt-edit.pl:310
28216 "The variable C<$lineno> contains the current line number. As is "
28217 "traditional, the first line in the file is number C<1>."
28221 #: ../tools/virt-edit.pl:313
28223 "The return value from the expression is ignored, but the expression may call "
28224 "C<die> in order to abort the whole program, leaving the original file "
28229 #: ../tools/virt-edit.pl:317
28231 "Remember when matching the end of a line that C<$_> may contain the final "
28232 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
28233 "newline then neither of these. Thus to match or substitute some text at the "
28234 "end of a line, use this regular expression:"
28238 #: ../tools/virt-edit.pl:322
28241 " /some text(\\r?\\n)?$/\n"
28246 #: ../tools/virt-edit.pl:324
28248 "Alternately, use the perl C<chomp> function, being careful not to chomp "
28249 "C<$_> itself (since that would remove all newlines from the file):"
28253 #: ../tools/virt-edit.pl:328
28256 " my $m = $_; chomp $m; $m =~ /some text$/\n"
28261 #: ../tools/virt-edit.pl:334
28266 #: ../tools/virt-edit.pl:336
28268 "If set, this string is used as the editor. It may contain arguments, "
28269 "eg. C<\"emacs -nw\">"
28273 #: ../tools/virt-edit.pl:339
28274 msgid "If not set, C<vi> is used."
28278 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559 ../tools/virt-resize.pl:1482 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
28279 msgid "SHELL QUOTING"
28283 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567 ../tools/virt-resize.pl:1484 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
28285 "Libvirt guest names can contain arbitrary characters, some of which have "
28286 "meaning to the shell such as C<#> and space. You may need to quote or "
28287 "escape these characters on the command line. See the shell manual page "
28288 "L<sh(1)> for details."
28292 #: ../tools/virt-edit.pl:352
28294 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
28295 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
28296 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
28300 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:598 ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
28305 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:600 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
28306 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
28310 #: ../tools/virt-edit.pl:370 ../tools/virt-list-partitions.pl:275
28311 msgid "Copyright (C) 2009-2010 Red Hat Inc."
28315 #: ../tools/virt-win-reg.pl:37
28317 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
28322 #: ../tools/virt-win-reg.pl:41
28325 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28330 #: ../tools/virt-win-reg.pl:43
28333 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28338 #: ../tools/virt-win-reg.pl:45
28341 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28346 #: ../tools/virt-win-reg.pl:47
28349 " virt-win-reg --merge domname [input.reg ...]\n"
28354 #: ../tools/virt-win-reg.pl:49
28357 " virt-win-reg [--options] disk.img ... # instead of domname\n"
28362 #: ../tools/virt-win-reg.pl:53
28364 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
28365 "virtual machines. If you do this, you I<will> get irreversible disk "
28366 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
28367 "but doesn't catch all cases."
28371 #: ../tools/virt-win-reg.pl:58
28373 "Modifying the Windows Registry is an inherently risky operation. The format "
28374 "is deliberately obscure and undocumented, and Registry changes can leave the "
28375 "system unbootable. Therefore when using the C<--merge> option, make sure "
28376 "you have a reliable backup first."
28380 #: ../tools/virt-win-reg.pl:65
28382 "This program can export and merge Windows Registry entries from a Windows "
28387 #: ../tools/virt-win-reg.pl:68
28389 "The first parameter is the libvirt guest name or the raw disk image of a "
28394 #: ../tools/virt-win-reg.pl:71
28396 "If C<--merge> is I<not> specified, then the chosen registry key is "
28397 "displayed/exported (recursively). For example:"
28401 #: ../tools/virt-win-reg.pl:74
28404 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
28409 #: ../tools/virt-win-reg.pl:76
28410 msgid "You can also display single values from within registry keys, for example:"
28414 #: ../tools/virt-win-reg.pl:79
28417 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
28418 " $ virt-win-reg Windows7 $cvkey ProductName\n"
28419 " Windows 7 Enterprise\n"
28424 #: ../tools/virt-win-reg.pl:83
28426 "With C<--merge>, you can merge a textual regedit file into the Windows "
28431 #: ../tools/virt-win-reg.pl:86
28434 " $ virt-win-reg --merge Windows7 changes.reg\n"
28439 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
28444 #: ../tools/virt-win-reg.pl:90
28446 "This program is only meant for simple access to the registry. If you want "
28447 "to do complicated things with the registry, we suggest you download the "
28448 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
28449 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
28450 "L<hivexregedit(1)>."
28454 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
28459 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
28460 msgid "Enable debugging messages."
28464 #: ../tools/virt-win-reg.pl:157
28469 #: ../tools/virt-win-reg.pl:159
28471 "In merge mode, this merges a textual regedit file into the Windows Registry "
28472 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
28473 "displays or exports Registry entries instead."
28477 #: ../tools/virt-win-reg.pl:163
28479 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
28480 "result in disk corruption. However exporting (without this flag) is always "
28485 #: ../tools/virt-win-reg.pl:171
28486 msgid "B<--encoding> UTF-16LE|ASCII"
28490 #: ../tools/virt-win-reg.pl:173
28492 "When merging (only), you may need to specify the encoding for strings to be "
28493 "used in the hive file. This is explained in detail in "
28494 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
28498 #: ../tools/virt-win-reg.pl:177
28500 "The default is to use UTF-16LE, which should work with recent versions of "
28505 #: ../tools/virt-win-reg.pl:402
28506 msgid "SUPPORTED SYSTEMS"
28510 #: ../tools/virt-win-reg.pl:404
28512 "The program currently supports Windows NT-derived guests starting with "
28513 "Windows XP through to at least Windows 7."
28517 #: ../tools/virt-win-reg.pl:407
28519 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
28520 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
28521 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
28525 #: ../tools/virt-win-reg.pl:411
28527 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
28532 #: ../tools/virt-win-reg.pl:414
28534 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
28539 #: ../tools/virt-win-reg.pl:417
28544 #: ../tools/virt-win-reg.pl:419
28546 "C<virt-win-reg> expects that regedit files have already been reencoded in "
28547 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
28548 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
28549 "with Windows-style line endings, you may need to reencode the whole file "
28550 "before or after processing."
28554 #: ../tools/virt-win-reg.pl:425
28556 "To reencode a file from Windows format to Linux (before processing it with "
28557 "the C<--merge> option), you would do something like this:"
28561 #: ../tools/virt-win-reg.pl:428
28564 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
28569 #: ../tools/virt-win-reg.pl:430
28571 "To go in the opposite direction, after exporting and before sending the file "
28572 "to a Windows user, do something like this:"
28576 #: ../tools/virt-win-reg.pl:433
28579 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
28584 #: ../tools/virt-win-reg.pl:435
28585 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
28589 #: ../tools/virt-win-reg.pl:437
28591 "If you are unsure about the current encoding, use the L<file(1)> command. "
28592 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
28593 "Windows-style (CRLF) line endings, like this:"
28597 #: ../tools/virt-win-reg.pl:441
28600 " $ file software.reg\n"
28601 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
28602 " with CRLF line terminators\n"
28607 #: ../tools/virt-win-reg.pl:445
28608 msgid "This file would need conversion before you could C<--merge> it."
28612 #: ../tools/virt-win-reg.pl:447
28613 msgid "CurrentControlSet etc."
28617 #: ../tools/virt-win-reg.pl:449
28619 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
28620 "Registry at the level of the hive file, and therefore you cannot modify "
28625 #: ../tools/virt-win-reg.pl:453
28627 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
28628 "circumstances it might refer to another control set. The way to find out is "
28629 "to look at the C<HKLM\\SYSTEM\\Select> key:"
28633 #: ../tools/virt-win-reg.pl:457
28636 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
28637 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
28638 " \"Current\"=dword:00000001\n"
28639 " \"Default\"=dword:00000001\n"
28640 " \"Failed\"=dword:00000000\n"
28641 " \"LastKnownGood\"=dword:00000002\n"
28646 #: ../tools/virt-win-reg.pl:464
28647 msgid "\"Current\" is the one which Windows will choose when it boots."
28651 #: ../tools/virt-win-reg.pl:466
28652 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
28656 #: ../tools/virt-win-reg.pl:469
28657 msgid "WINDOWS TIPS"
28661 #: ../tools/virt-win-reg.pl:471
28663 "Note that some of these tips modify the guest disk image. The guest I<must> "
28664 "be shut off, else you will get disk corruption."
28668 #: ../tools/virt-win-reg.pl:474
28669 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
28673 #: ../tools/virt-win-reg.pl:476
28675 "Prepare a DOS batch script, VBScript or executable. Upload this using "
28676 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
28677 "is uploaded into C<C:\\>:"
28681 #: ../tools/virt-win-reg.pl:480
28684 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
28689 #: ../tools/virt-win-reg.pl:482
28690 msgid "Prepare a regedit file containing the registry change:"
28694 #: ../tools/virt-win-reg.pl:484
28697 " cat > test.reg <<'EOF'\n"
28698 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
28699 " \"Test\"=\"c:\\\\test.bat\"\n"
28705 #: ../tools/virt-win-reg.pl:489
28707 "In this example we use the key C<RunOnce> which means that the script will "
28708 "run precisely once when the first user logs in. If you want it to run every "
28709 "time a user logs in, replace C<RunOnce> with C<Run>."
28713 #: ../tools/virt-win-reg.pl:493
28714 msgid "Now update the registry:"
28718 #: ../tools/virt-win-reg.pl:495
28721 " virt-win-reg --merge WindowsGuest test.reg\n"
28726 #: ../tools/virt-win-reg.pl:497
28727 msgid "INSTALLING A SERVICE"
28731 #: ../tools/virt-win-reg.pl:499
28733 "This section assumes you are familiar with Windows services, and you either "
28734 "have a program which handles the Windows Service Control Protocol directly "
28735 "or you want to run any program using a service wrapper like SrvAny or the "
28740 #: ../tools/virt-win-reg.pl:504
28742 "First upload the program and optionally the service wrapper. In this case "
28743 "the test program is called C<test.exe> and we are using the RHSrvAny "
28748 #: ../tools/virt-win-reg.pl:508
28751 " guestfish -i -d WindowsGuest <<EOF\n"
28752 " upload rhsrvany.exe /rhsrvany.exe\n"
28753 " upload test.exe /test.exe\n"
28759 #: ../tools/virt-win-reg.pl:513
28761 "Prepare a regedit file containing the registry changes. In this example, "
28762 "the first registry change is needed for the service itself or the service "
28763 "wrapper (if used). The second registry change is only needed because I am "
28764 "using the RHSrvAny service wrapper."
28768 #: ../tools/virt-win-reg.pl:518
28771 " cat > service.reg <<'EOF'\n"
28772 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
28773 " \"Type\"=dword:00000010\n"
28774 " \"Start\"=dword:00000002\n"
28775 " \"ErrorControl\"=dword:00000001\n"
28776 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
28777 " \"DisplayName\"=\"RHSrvAny\"\n"
28778 " \"ObjectName\"=\"NetworkService\"\n"
28783 #: ../tools/virt-win-reg.pl:527
28786 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
28787 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
28788 " \"PWD\"=\"c:\\\\Temp\"\n"
28794 #: ../tools/virt-win-reg.pl:538
28796 "For use of C<ControlSet001> see the section above in this manual page. You "
28797 "may need to adjust this according to the control set that is in use by the "
28802 #: ../tools/virt-win-reg.pl:544
28804 "C<\"ObjectName\"> controls the privileges that the service will have. An "
28805 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
28806 "privileged account."
28810 #: ../tools/virt-win-reg.pl:550
28812 "For the meaning of the magic numbers, see this Microsoft KB article: "
28813 "L<http://support.microsoft.com/kb/103000>."
28817 #: ../tools/virt-win-reg.pl:555
28818 msgid "Update the registry:"
28822 #: ../tools/virt-win-reg.pl:557
28825 " virt-win-reg --merge WindowsGuest service.reg\n"
28830 #: ../tools/virt-win-reg.pl:561
28832 "Be careful when passing parameters containing C<\\> (backslash) in the "
28833 "shell. Usually you will have to use 'single quotes' or double backslashes "
28834 "(but not both) to protect them from the shell."
28838 #: ../tools/virt-win-reg.pl:565
28839 msgid "Paths and value names are case-insensitive."
28843 #: ../tools/virt-win-reg.pl:574
28845 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
28846 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
28847 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
28848 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28852 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
28854 "When reporting bugs, please enable debugging and capture the I<complete> "
28859 #: ../tools/virt-win-reg.pl:592
28862 " export LIBGUESTFS_DEBUG=1\n"
28863 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
28868 #: ../tools/virt-win-reg.pl:595
28870 "Attach /tmp/virt-win-reg.log to a new bug report at "
28871 "L<https://bugzilla.redhat.com/>"
28875 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1516 ../tools/virt-make-fs.pl:570
28876 msgid "Copyright (C) 2010 Red Hat Inc."
28880 #: ../tools/virt-resize.pl:42
28881 msgid "virt-resize - Resize a virtual machine disk"
28885 #: ../tools/virt-resize.pl:46
28888 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
28889 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
28890 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
28895 #: ../tools/virt-resize.pl:52
28897 "Virt-resize is a tool which can resize a virtual machine disk, making it "
28898 "larger or smaller overall, and resizing or deleting any partitions contained "
28903 #: ../tools/virt-resize.pl:56
28905 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
28906 "not> be used on live virtual machines - for consistent results, shut the "
28907 "virtual machine down before resizing it."
28911 #: ../tools/virt-resize.pl:60
28913 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
28914 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
28918 #: ../tools/virt-resize.pl:66
28920 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
28921 "fill the extra 5GB of space."
28925 #: ../tools/virt-resize.pl:69
28928 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
28929 " virt-filesystems --long -h --all -a olddisk\n"
28930 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
28931 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
28936 #: ../tools/virt-resize.pl:74
28938 "As above, but make the /boot partition 200MB bigger, while giving the "
28939 "remaining space to /dev/sda2:"
28943 #: ../tools/virt-resize.pl:77
28946 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
28951 #: ../tools/virt-resize.pl:79
28952 msgid "As above, but the output format will be uncompressed qcow2:"
28956 #: ../tools/virt-resize.pl:81
28959 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
28960 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
28965 #: ../tools/virt-resize.pl:84
28966 msgid "DETAILED USAGE"
28970 #: ../tools/virt-resize.pl:86
28971 msgid "EXPANDING A VIRTUAL MACHINE DISK"
28975 #: ../tools/virt-resize.pl:90
28976 msgid "1. Shut down the virtual machine"
28980 #: ../tools/virt-resize.pl:92
28981 msgid "2. Locate input disk image"
28985 #: ../tools/virt-resize.pl:94
28987 "Locate the input disk image (ie. the file or device on the host containing "
28988 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
28989 "dumpxml> like this to find the disk image name:"
28993 #: ../tools/virt-resize.pl:98
28996 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
28997 " Found 1 nodes:\n"
28999 " <source dev=\"/dev/vg/lv_guest\" />\n"
29004 #: ../tools/virt-resize.pl:103
29005 msgid "3. Look at current sizing"
29009 #: ../tools/virt-resize.pl:105
29010 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
29014 #: ../tools/virt-resize.pl:108
29017 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
29018 " Name Type Size Parent\n"
29019 " /dev/sda1 partition 101M /dev/sda\n"
29020 " /dev/sda2 partition 7.9G /dev/sda\n"
29021 " /dev/sda device 8.0G -\n"
29026 #: ../tools/virt-resize.pl:114
29028 "(This example is a virtual machine with an 8 GB disk which we would like to "
29029 "expand up to 10 GB)."
29033 #: ../tools/virt-resize.pl:117
29034 msgid "4. Create output disk"
29038 #: ../tools/virt-resize.pl:119
29040 "Virt-resize cannot do in-place disk modifications. You have to have space "
29041 "to store the resized output disk."
29045 #: ../tools/virt-resize.pl:122
29046 msgid "To store the resized disk image in a file, create a file of a suitable size:"
29050 #: ../tools/virt-resize.pl:125
29053 " # rm -f outdisk\n"
29054 " # truncate -s 10G outdisk\n"
29059 #: ../tools/virt-resize.pl:128
29060 msgid "Or use L<lvcreate(1)> to create a logical volume:"
29064 #: ../tools/virt-resize.pl:130
29067 " # lvcreate -L 10G -n lv_name vg_name\n"
29072 #: ../tools/virt-resize.pl:132
29073 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
29077 #: ../tools/virt-resize.pl:134
29080 " # virsh pool-list\n"
29081 " # virsh vol-create-as poolname newvol 10G\n"
29086 #: ../tools/virt-resize.pl:137
29091 #: ../tools/virt-resize.pl:139
29093 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
29094 "file) and the output disk. The output disk is the one created in the "
29099 #: ../tools/virt-resize.pl:143
29102 " # virt-resize indisk outdisk\n"
29107 #: ../tools/virt-resize.pl:145
29109 "This command just copies disk image C<indisk> to disk image C<outdisk> "
29110 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
29111 "larger, then an extra, empty partition is created at the end of the disk "
29112 "covering the extra space. If C<outdisk> is smaller, then it will give an "
29117 #: ../tools/virt-resize.pl:151
29119 "More realistically you'd want to expand existing partitions in the disk "
29120 "image by passing extra options (for the full list see the L</OPTIONS> "
29125 #: ../tools/virt-resize.pl:155
29127 "L</--expand> is the most useful option. It expands the named partition "
29128 "within the disk to fill any extra space:"
29132 #: ../tools/virt-resize.pl:158
29135 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
29140 #: ../tools/virt-resize.pl:160
29142 "(In this case, an extra partition is I<not> created at the end of the disk, "
29143 "because there will be no unused space)."
29147 #: ../tools/virt-resize.pl:163
29149 "L</--resize> is the other commonly used option. The following would "
29150 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
29151 "rest of the available space:"
29155 #: ../tools/virt-resize.pl:167
29158 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
29159 " indisk outdisk\n"
29164 #: ../tools/virt-resize.pl:170
29166 "If the expanded partition in the image contains a filesystem or LVM PV, then "
29167 "if virt-resize knows how, it will resize the contents, the equivalent of "
29168 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
29169 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
29170 "filesystems, so you would have to online resize them after booting the "
29175 #: ../tools/virt-resize.pl:177
29176 msgid "Other options are covered below."
29180 #: ../tools/virt-resize.pl:179
29185 #: ../tools/virt-resize.pl:181
29186 msgid "Thoroughly test the new disk image I<before> discarding the old one."
29190 #: ../tools/virt-resize.pl:183
29191 msgid "If you are using libvirt, edit the XML to point at the new disk:"
29195 #: ../tools/virt-resize.pl:185
29198 " # virsh edit guestname\n"
29203 #: ../tools/virt-resize.pl:187
29205 "Change E<lt>source ...E<gt>, see "
29206 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
29210 #: ../tools/virt-resize.pl:190
29211 msgid "Then start up the domain with the new, resized disk:"
29215 #: ../tools/virt-resize.pl:192
29218 " # virsh start guestname\n"
29223 #: ../tools/virt-resize.pl:194
29225 "and check that it still works. See also the L</NOTES> section below for "
29226 "additional information."
29230 #: ../tools/virt-resize.pl:197
29231 msgid "7. Resize LVs etc inside the guest"
29235 #: ../tools/virt-resize.pl:199
29236 msgid "(This can also be done offline using L<guestfish(1)>)"
29240 #: ../tools/virt-resize.pl:201
29242 "Once the guest has booted you should see the new space available, at least "
29243 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
29244 "may need to resize LVs inside PVs, and also resize filesystem types that "
29245 "virt-resize does not know how to expand."
29249 #: ../tools/virt-resize.pl:208
29250 msgid "SHRINKING A VIRTUAL MACHINE DISK"
29254 #: ../tools/virt-resize.pl:210
29256 "Shrinking is somewhat more complex than expanding, and only an overview is "
29261 #: ../tools/virt-resize.pl:213
29263 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
29264 "filesystems). The user has to shrink content before passing the disk image "
29265 "to virt-resize, and virt-resize will check that the content has been shrunk "
29270 #: ../tools/virt-resize.pl:218
29271 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
29275 #: ../tools/virt-resize.pl:220
29277 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
29278 "steps 3 and 4 above to allocate a new disk image."
29282 #: ../tools/virt-resize.pl:223
29283 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
29287 #: ../tools/virt-resize.pl:226
29288 msgid "IGNORING OR DELETING PARTITIONS"
29292 #: ../tools/virt-resize.pl:228
29294 "virt-resize also gives a convenient way to ignore or delete partitions when "
29295 "copying from the input disk to the output disk. Ignoring a partition speeds "
29296 "up the copy where you don't care about the existing contents of a "
29297 "partition. Deleting a partition removes it completely, but note that it "
29298 "also renumbers any partitions after the one which is deleted, which can "
29299 "leave some guests unbootable."
29303 #: ../tools/virt-resize.pl:235
29304 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
29308 #: ../tools/virt-resize.pl:237
29310 "If the input disk is in qcow2 format, then you may prefer that the output is "
29311 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
29312 "the fly. The output format is simply determined by the format of the empty "
29313 "output container that you provide. Thus to create qcow2 output, use:"
29317 #: ../tools/virt-resize.pl:243
29320 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
29325 #: ../tools/virt-resize.pl:245
29326 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
29330 #: ../tools/virt-resize.pl:247
29331 msgid "Similarly, to get non-sparse raw output use:"
29335 #: ../tools/virt-resize.pl:249
29338 " fallocate -l size outdisk\n"
29343 #: ../tools/virt-resize.pl:251
29345 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
29346 "if=/dev/zero of=outdisk bs=1M count=..>)"
29350 #: ../tools/virt-resize.pl:264
29351 msgid "Display help."
29355 #: ../tools/virt-resize.pl:278
29356 msgid "B<--resize part=size>"
29360 #: ../tools/virt-resize.pl:280
29362 "Resize the named partition (expanding or shrinking it) so that it has the "
29367 #: ../tools/virt-resize.pl:283
29369 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
29370 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
29371 "Exabytes; or as a percentage of the current size; or as a relative number or "
29372 "percentage. For example:"
29376 #: ../tools/virt-resize.pl:288
29379 " --resize /dev/sda2=10G\n"
29384 #: ../tools/virt-resize.pl:290
29387 " --resize /dev/sda4=90%\n"
29392 #: ../tools/virt-resize.pl:292
29395 " --resize /dev/sda2=+1G\n"
29400 #: ../tools/virt-resize.pl:294
29403 " --resize /dev/sda2=-200M\n"
29408 #: ../tools/virt-resize.pl:296
29411 " --resize /dev/sda1=+128K\n"
29416 #: ../tools/virt-resize.pl:298
29419 " --resize /dev/sda1=+10%\n"
29424 #: ../tools/virt-resize.pl:300
29427 " --resize /dev/sda1=-10%\n"
29432 #: ../tools/virt-resize.pl:302
29434 "You can increase the size of any partition. Virt-resize will expand the "
29435 "direct content of the partition if it knows how (see C<--expand> below)."
29439 #: ../tools/virt-resize.pl:306
29441 "You can only I<decrease> the size of partitions that contain filesystems or "
29442 "PVs which have already been shrunk. Virt-resize will check this has been "
29443 "done before proceeding, or else will print an error (see also "
29444 "C<--resize-force>)."
29448 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
29449 msgid "You can give this option multiple times."
29453 #: ../tools/virt-resize.pl:317
29454 msgid "B<--resize-force part=size>"
29458 #: ../tools/virt-resize.pl:319
29460 "This is the same as C<--resize> except that it will let you decrease the "
29461 "size of any partition. Generally this means you will lose any data which "
29462 "was at the end of the partition you shrink, but you may not care about that "
29463 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
29464 "as a swap partition)."
29468 #: ../tools/virt-resize.pl:325
29469 msgid "See also the C<--ignore> option."
29473 #: ../tools/virt-resize.pl:331
29474 msgid "B<--expand part>"
29478 #: ../tools/virt-resize.pl:333
29480 "Expand the named partition so it uses up all extra space (space left over "
29481 "after any other resize changes that you request have been done)."
29485 #: ../tools/virt-resize.pl:336
29487 "If virt-resize knows how, it will expand the direct content of the "
29488 "partition. For example, if the partition is an LVM PV, it will expand the "
29489 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
29490 "content it doesn't know about alone."
29494 #: ../tools/virt-resize.pl:341
29495 msgid "Currently virt-resize can resize:"
29499 #: ../tools/virt-resize.pl:347
29501 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
29506 #: ../tools/virt-resize.pl:352
29508 "NTFS filesystems contained directly in a partition, if libguestfs was "
29509 "compiled with support for NTFS."
29513 #: ../tools/virt-resize.pl:355
29515 "The filesystem must have been shut down consistently last time it was used. "
29516 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
29517 "consistency check, so at the first boot after resizing Windows will check "
29522 #: ../tools/virt-resize.pl:362
29524 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
29525 "inside the PV, but see the C<--LV-expand> option. The user could also "
29526 "resize LVs as desired after boot."
29530 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
29531 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
29535 #: ../tools/virt-resize.pl:374
29536 msgid "B<--shrink part>"
29540 #: ../tools/virt-resize.pl:376
29542 "Shrink the named partition until the overall disk image fits in the "
29543 "destination. The named partition B<must> contain a filesystem or PV which "
29544 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
29545 "online tools). Virt-resize will check this and give an error if it has not "
29550 #: ../tools/virt-resize.pl:382
29552 "The amount by which the overall disk must be shrunk (after carrying out all "
29553 "other operations requested by the user) is called the \"deficit\". For "
29554 "example, a straight copy (assume no other operations) from a 5GB disk image "
29555 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
29556 "would give an error unless the user specified a partition to shrink and that "
29557 "partition had more than a gigabyte of free space."
29561 #: ../tools/virt-resize.pl:396
29562 msgid "B<--ignore part>"
29566 #: ../tools/virt-resize.pl:398
29568 "Ignore the named partition. Effectively this means the partition is "
29569 "allocated on the destination disk, but the content is not copied across from "
29570 "the source disk. The content of the partition will be blank (all zero "
29575 #: ../tools/virt-resize.pl:409
29576 msgid "B<--delete part>"
29580 #: ../tools/virt-resize.pl:411
29582 "Delete the named partition. It would be more accurate to describe this as "
29583 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
29584 "the original disk image is left intact."
29588 #: ../tools/virt-resize.pl:415
29590 "Note that when you delete a partition, then anything contained in the "
29591 "partition is also deleted. Furthermore, this causes any partitions that "
29592 "come after to be I<renumbered>, which can easily make your guest unbootable."
29596 #: ../tools/virt-resize.pl:426
29597 msgid "B<--LV-expand logvol>"
29601 #: ../tools/virt-resize.pl:428
29603 "This takes the logical volume and, as a final step, expands it to fill all "
29604 "the space available in its volume group. A typical usage, assuming a Linux "
29605 "guest with a single PV C</dev/sda2> and a root device called "
29606 "C</dev/vg_guest/lv_root> would be:"
29610 #: ../tools/virt-resize.pl:433
29613 " virt-resize indisk outdisk \\\n"
29614 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
29619 #: ../tools/virt-resize.pl:436
29621 "This would first expand the partition (and PV), and then expand the root "
29622 "device to fill the extra space in the PV."
29626 #: ../tools/virt-resize.pl:439
29628 "The contents of the LV are also resized if virt-resize knows how to do "
29629 "that. You can stop virt-resize from trying to expand the content by using "
29630 "the option C<--no-expand-content>."
29634 #: ../tools/virt-resize.pl:443
29635 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
29639 #: ../tools/virt-resize.pl:446
29641 "You can give this option multiple times, I<but> it doesn't make sense to do "
29642 "this unless the logical volumes you specify are all in different volume "
29647 #: ../tools/virt-resize.pl:454
29648 msgid "B<--no-copy-boot-loader>"
29652 #: ../tools/virt-resize.pl:456
29654 "By default, virt-resize copies over some sectors at the start of the disk "
29655 "(up to the beginning of the first partition). Commonly these sectors "
29656 "contain the Master Boot Record (MBR) and the boot loader, and are required "
29657 "in order for the guest to boot correctly."
29661 #: ../tools/virt-resize.pl:461
29663 "If you specify this flag, then this initial copy is not done. You may need "
29664 "to reinstall the boot loader in this case."
29668 #: ../tools/virt-resize.pl:469
29669 msgid "B<--no-extra-partition>"
29673 #: ../tools/virt-resize.pl:471
29675 "By default, virt-resize creates an extra partition if there is any extra, "
29676 "unused space after all resizing has happened. Use this option to prevent "
29677 "the extra partition from being created. If you do this then the extra space "
29678 "will be inaccessible until you run fdisk, parted, or some other partitioning "
29679 "tool in the guest."
29683 #: ../tools/virt-resize.pl:477
29685 "Note that if the surplus space is smaller than 10 MB, no extra partition "
29690 #: ../tools/virt-resize.pl:484
29691 msgid "B<--no-expand-content>"
29695 #: ../tools/virt-resize.pl:486
29697 "By default, virt-resize will try to expand the direct contents of "
29698 "partitions, if it knows how (see C<--expand> option above)."
29702 #: ../tools/virt-resize.pl:489
29704 "If you give the C<--no-expand-content> option then virt-resize will not "
29709 #: ../tools/virt-resize.pl:496
29710 msgid "B<-d> | B<--debug>"
29714 #: ../tools/virt-resize.pl:504
29715 msgid "B<-n> | B<--dryrun>"
29719 #: ../tools/virt-resize.pl:506
29720 msgid "Print a summary of what would be done, but don't do anything."
29724 #: ../tools/virt-resize.pl:512
29725 msgid "B<-q> | B<--quiet>"
29729 #: ../tools/virt-resize.pl:514
29730 msgid "Don't print the summary."
29734 #: ../tools/virt-resize.pl:522
29736 "Specify the format of the input disk image. If this flag is not given then "
29737 "it is auto-detected from the image itself."
29741 #: ../tools/virt-resize.pl:528
29743 "Note that this option I<does not> affect the output format. See L</QCOW2 "
29744 "AND NON-SPARSE RAW FORMATS>."
29748 #: ../tools/virt-resize.pl:535
29749 msgid "B<--output-format> raw"
29753 #: ../tools/virt-resize.pl:537
29755 "Specify the format of the output disk image. If this flag is not given then "
29756 "it is auto-detected from the image itself."
29760 #: ../tools/virt-resize.pl:543
29762 "Note that you still need to create the output disk with the right format. "
29763 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
29767 #: ../tools/virt-resize.pl:1425
29772 #: ../tools/virt-resize.pl:1427
29773 msgid "\"Partition 1 does not end on cylinder boundary.\""
29777 #: ../tools/virt-resize.pl:1429
29779 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
29780 "means the partitions will not be aligned to the ancient CHS geometry. "
29781 "However CHS geometry is meaningless for disks manufactured since the early "
29782 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
29783 "cylinders is not required by any modern operating system."
29787 #: ../tools/virt-resize.pl:1436
29788 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
29792 #: ../tools/virt-resize.pl:1438
29794 "In Windows Vista and later versions, Microsoft switched to using a separate "
29795 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
29796 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
29797 "the boot partition. Doing so seems to break the guest completely. However "
29798 "expanding the second partition (ie. C: drive) should work."
29802 #: ../tools/virt-resize.pl:1445
29804 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
29805 "NTFS partitions have been expanded. This is just a safety check and (unless "
29806 "it find errors) is nothing to worry about."
29810 #: ../tools/virt-resize.pl:1449
29811 msgid "GUEST BOOT STUCK AT \"GRUB\""
29815 #: ../tools/virt-resize.pl:1451
29817 "If a Linux guest does not boot after resizing, and the boot is stuck after "
29818 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
29819 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
29820 "although we think is to do with partition alignment."
29824 #: ../tools/virt-resize.pl:1456
29827 " guestfish -i -a newdisk\n"
29828 " ><fs> cat /boot/grub/device.map\n"
29829 " # check the contents of this file are sensible or\n"
29830 " # edit the file if necessary\n"
29831 " ><fs> grub-install / /dev/vda\n"
29837 #: ../tools/virt-resize.pl:1463
29839 "For more flexible guest reconfiguration, including if you need to specify "
29840 "other parameters to grub-install, use L<virt-rescue(1)>."
29844 #: ../tools/virt-resize.pl:1466
29845 msgid "ALTERNATIVE TOOLS"
29849 #: ../tools/virt-resize.pl:1468
29851 "There are several proprietary tools for resizing partitions. We won't "
29852 "mention any here."
29856 #: ../tools/virt-resize.pl:1471
29858 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
29859 "operations on disk images. They can resize and move partitions, but I don't "
29860 "think they can do anything with the contents, and they certainly don't "
29865 #: ../tools/virt-resize.pl:1476
29867 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
29868 "but at a much lower level. You will probably end up hand-calculating sector "
29869 "offsets, which is something that virt-resize was designed to avoid. If you "
29870 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
29875 #: ../tools/virt-resize.pl:1491
29877 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
29878 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
29879 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
29880 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
29881 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29885 #: ../tools/virt-list-filesystems.pl:32
29886 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29890 #: ../tools/virt-list-filesystems.pl:36
29893 " virt-list-filesystems [--options] domname\n"
29898 #: ../tools/virt-list-filesystems.pl:38
29901 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29906 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29908 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29913 #: ../tools/virt-list-filesystems.pl:45
29915 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29916 "are contained in a virtual machine or disk image."
29920 #: ../tools/virt-list-filesystems.pl:49
29922 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29923 "functionality. For more complex cases you should look at the "
29924 "L<guestfish(1)> tool."
29928 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29929 msgid "B<-l> | B<--long>"
29933 #: ../tools/virt-list-filesystems.pl:108
29935 "With this option, C<virt-list-filesystems> displays the type of each "
29936 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29940 #: ../tools/virt-list-filesystems.pl:115
29941 msgid "B<-a> | B<--all>"
29945 #: ../tools/virt-list-filesystems.pl:117
29947 "Normally we only show mountable filesystems. If this option is given then "
29948 "swap devices are shown too."
29952 #: ../tools/virt-list-filesystems.pl:191
29954 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29955 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29956 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29960 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29961 msgid "Copyright (C) 2009 Red Hat Inc."
29965 #: ../tools/virt-tar.pl:33
29966 msgid "virt-tar - Extract or upload files to a virtual machine"
29970 #: ../tools/virt-tar.pl:37
29973 " virt-tar [--options] -x domname directory tarball\n"
29978 #: ../tools/virt-tar.pl:39
29981 " virt-tar [--options] -u domname tarball directory\n"
29986 #: ../tools/virt-tar.pl:41
29989 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29994 #: ../tools/virt-tar.pl:43
29997 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30002 #: ../tools/virt-tar.pl:47
30004 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
30005 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
30009 #: ../tools/virt-tar.pl:52
30010 msgid "Download C</home> from the VM into a local tarball:"
30014 #: ../tools/virt-tar.pl:54
30017 " virt-tar -x domname /home home.tar\n"
30022 #: ../tools/virt-tar.pl:56
30025 " virt-tar -zx domname /home home.tar.gz\n"
30030 #: ../tools/virt-tar.pl:58
30031 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30035 #: ../tools/virt-tar.pl:60
30038 " virt-tar -u domname uploadstuff.tar /tmp\n"
30043 #: ../tools/virt-tar.pl:62
30046 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30051 #: ../tools/virt-tar.pl:66
30053 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
30054 "virtual machines. If you do this, you risk disk corruption in the VM. "
30055 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30059 #: ../tools/virt-tar.pl:71
30061 "You can use C<-x> (extract) on live virtual machines, but you might get "
30062 "inconsistent results or errors if there is filesystem activity inside the "
30063 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30064 "work, but the only way to guarantee consistent results is if the virtual "
30065 "machine is shut down."
30069 #: ../tools/virt-tar.pl:79
30071 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30072 "parts of a guest filesystem. There are many possibilities: making backups, "
30073 "uploading data files, snooping on guest activity, fixing or customizing "
30078 #: ../tools/virt-tar.pl:84
30080 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30081 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30082 "should look at the L<guestfish(1)> tool."
30086 #: ../tools/virt-tar.pl:88
30088 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
30089 "its contents (recursively) from the virtual machine into a local tarball. "
30090 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
30091 "virtual machine. You cannot use these two options together."
30095 #: ../tools/virt-tar.pl:94
30097 "In addition, you may need to use the C<-z> (gZip) option to enable "
30098 "compression. When uploading, you have to specify C<-z> if the upload file "
30099 "is compressed because virt-tar won't detect this on its own."
30103 #: ../tools/virt-tar.pl:98
30105 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30106 "example it cannot do PKZip files or bzip2 compression. If you want that "
30107 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30108 "the L<libguestfs(3)> API)."
30112 #: ../tools/virt-tar.pl:156
30113 msgid "B<-x> | B<--extract> | B<--download>"
30117 #: ../tools/virt-tar.pl:158
30118 msgid "B<-u> | B<--upload>"
30122 #: ../tools/virt-tar.pl:160
30124 "Use C<-x> to extract (download) a directory from a virtual machine to a "
30129 #: ../tools/virt-tar.pl:163
30131 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
30132 "Please read the L</WARNING> section above before using this option."
30136 #: ../tools/virt-tar.pl:167
30137 msgid "You must specify exactly one of these options."
30141 #: ../tools/virt-tar.pl:173
30142 msgid "B<-z> | B<--gzip>"
30146 #: ../tools/virt-tar.pl:175
30147 msgid "Specify that the input or output tarball is gzip-compressed."
30151 #: ../tools/virt-tar.pl:288
30153 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
30154 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
30155 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
30156 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30160 #: ../tools/virt-make-fs.pl:37
30161 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30165 #: ../tools/virt-make-fs.pl:41
30168 " virt-make-fs [--options] input.tar output.img\n"
30173 #: ../tools/virt-make-fs.pl:43
30176 " virt-make-fs [--options] input.tar.gz output.img\n"
30181 #: ../tools/virt-make-fs.pl:45
30184 " virt-make-fs [--options] directory output.img\n"
30189 #: ../tools/virt-make-fs.pl:49
30191 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30192 "archive or some files in a directory. It is similar to tools like "
30193 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
30194 "it can create common filesystem types like ext2/3 or NTFS, which can be "
30195 "useful if you want to attach these filesystems to existing virtual machines "
30196 "(eg. to import large amounts of read-only data to a VM)."
30200 #: ../tools/virt-make-fs.pl:57
30201 msgid "Basic usage is:"
30205 #: ../tools/virt-make-fs.pl:59
30208 " virt-make-fs input output\n"
30213 #: ../tools/virt-make-fs.pl:61
30215 "where C<input> is either a directory containing files that you want to add, "
30216 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30217 "C<output> is a disk image. The input type is detected automatically. The "
30218 "output disk image defaults to a raw ext2 image unless you specify extra "
30219 "flags (see L</OPTIONS> below)."
30223 #: ../tools/virt-make-fs.pl:67
30224 msgid "EXTRA SPACE"
30228 #: ../tools/virt-make-fs.pl:69
30230 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30231 "the files that it contains, but might have extra space. Depending on how "
30232 "you are going to use the output, you might think this extra space is wasted "
30233 "and want to minimize it, or you might want to leave space so that more files "
30234 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30235 "but you can use the C<--size> flag to leave space in the filesystem if you "
30240 #: ../tools/virt-make-fs.pl:77
30242 "An alternative way to leave extra space but not make the output image any "
30243 "bigger is to use an alternative disk image format (instead of the default "
30244 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
30245 "image format (check your hypervisor supports this before using it). This "
30246 "allows you to choose a large C<--size> but the extra space won't actually be "
30247 "allocated in the image until you try to store something in it."
30251 #: ../tools/virt-make-fs.pl:85
30253 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30254 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30255 "to build another image from scratch."
30259 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
30264 #: ../tools/virt-make-fs.pl:91
30267 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30272 #: ../tools/virt-make-fs.pl:93
30273 msgid "FILESYSTEM TYPE"
30277 #: ../tools/virt-make-fs.pl:95
30279 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30280 "libguestfs supports can be used (but I<not> read-only formats like "
30281 "ISO9660). Here are some of the more common choices:"
30285 #: ../tools/virt-make-fs.pl:101
30290 #: ../tools/virt-make-fs.pl:103
30292 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30293 "you are not going to use the filesystem in a way that requires the journal, "
30294 "then this is just wasted overhead."
30298 #: ../tools/virt-make-fs.pl:107
30299 msgid "I<ntfs> or I<vfat>"
30303 #: ../tools/virt-make-fs.pl:109
30304 msgid "Useful if exporting data to a Windows guest."
30308 #: ../tools/virt-make-fs.pl:111
30310 "I<Note for vfat>: The tar archive or local directory must only contain files "
30311 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30312 "program running within libguestfs is unable to change the ownership of "
30313 "non-root files, since vfat itself does not support this."
30317 #: ../tools/virt-make-fs.pl:116
30322 #: ../tools/virt-make-fs.pl:118
30324 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30325 "total filesystem size."
30329 #: ../tools/virt-make-fs.pl:125
30332 " virt-make-fs --type=minix input minixfs.img\n"
30337 #: ../tools/virt-make-fs.pl:127
30338 msgid "TO PARTITION OR NOT TO PARTITION"
30342 #: ../tools/virt-make-fs.pl:129
30343 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30347 #: ../tools/virt-make-fs.pl:131
30349 "Adding a partition can make the disk image more compatible with certain "
30350 "virtualized operating systems which don't expect to see a filesystem "
30351 "directly located on a block device (Linux doesn't care and will happily "
30352 "handle both types)."
30356 #: ../tools/virt-make-fs.pl:136
30358 "On the other hand, if you have a partition table then the output image is no "
30359 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30360 "directly on a partitioned disk image. (However libguestfs tools such as "
30361 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30365 #: ../tools/virt-make-fs.pl:144
30366 msgid "Add an MBR partition:"
30370 #: ../tools/virt-make-fs.pl:146
30373 " virt-make-fs --partition -- input disk.img\n"
30378 #: ../tools/virt-make-fs.pl:148
30380 "If the output disk image could be terabyte-sized or larger, it's better to "
30381 "use an EFI/GPT-compatible partition table:"
30385 #: ../tools/virt-make-fs.pl:151
30388 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30393 #: ../tools/virt-make-fs.pl:179
30394 msgid "Enable debugging information."
30398 #: ../tools/virt-make-fs.pl:185
30399 msgid "B<--size=E<lt>NE<gt>>"
30403 #: ../tools/virt-make-fs.pl:187
30404 msgid "B<--size=+E<lt>NE<gt>>"
30408 #: ../tools/virt-make-fs.pl:189
30409 msgid "B<-s E<lt>NE<gt>>"
30413 #: ../tools/virt-make-fs.pl:191
30414 msgid "B<-s +E<lt>NE<gt>>"
30418 #: ../tools/virt-make-fs.pl:193
30419 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
30423 #: ../tools/virt-make-fs.pl:196
30425 "If this option is I<not> given, then the output image will be just large "
30426 "enough to contain all the files, with not much wasted space."
30430 #: ../tools/virt-make-fs.pl:199
30432 "To choose a fixed size output disk, specify an absolute number followed by "
30433 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30434 "Petabytes or Exabytes. This must be large enough to contain all the input "
30435 "files, else you will get an error."
30439 #: ../tools/virt-make-fs.pl:204
30441 "To leave extra space, specify C<+> (plus sign) and a number followed by "
30442 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30443 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
30444 "the input files, and (approximately) an extra 200 MB free space."
30448 #: ../tools/virt-make-fs.pl:210
30450 "Note that virt-make-fs estimates free space, and therefore will not produce "
30451 "filesystems containing precisely the free space requested. (It is much more "
30452 "expensive and time-consuming to produce a filesystem which has precisely the "
30453 "desired free space)."
30457 #: ../tools/virt-make-fs.pl:219
30458 msgid "B<--format=E<lt>fmtE<gt>>"
30462 #: ../tools/virt-make-fs.pl:221
30463 msgid "B<-F E<lt>fmtE<gt>>"
30467 #: ../tools/virt-make-fs.pl:223
30468 msgid "Choose the output disk image format."
30472 #: ../tools/virt-make-fs.pl:225
30473 msgid "The default is C<raw> (raw disk image)."
30477 #: ../tools/virt-make-fs.pl:227
30479 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30480 "that would really make sense here is C<qcow2>."
30484 #: ../tools/virt-make-fs.pl:234
30485 msgid "B<--type=E<lt>fsE<gt>>"
30489 #: ../tools/virt-make-fs.pl:236
30490 msgid "B<-t E<lt>fsE<gt>>"
30494 #: ../tools/virt-make-fs.pl:238
30495 msgid "Choose the output filesystem type."
30499 #: ../tools/virt-make-fs.pl:240
30500 msgid "The default is C<ext2>."
30504 #: ../tools/virt-make-fs.pl:242
30505 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30509 #: ../tools/virt-make-fs.pl:249
30510 msgid "B<--partition>"
30514 #: ../tools/virt-make-fs.pl:251
30515 msgid "B<--partition=E<lt>parttypeE<gt>>"
30519 #: ../tools/virt-make-fs.pl:253
30521 "If specified, this flag adds an MBR partition table to the output disk "
30526 #: ../tools/virt-make-fs.pl:256
30528 "You can change the partition table type, eg. C<--partition=gpt> for large "
30533 #: ../tools/virt-make-fs.pl:259
30535 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
30536 "might consider the next parameter to be the partition type. For example:"
30540 #: ../tools/virt-make-fs.pl:263
30543 " virt-make-fs --partition input.tar ...\n"
30548 #: ../tools/virt-make-fs.pl:265
30550 "would cause virt-make-fs to think you wanted to use a partition type of "
30551 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
30552 "dash) between options and the input file argument:"
30556 #: ../tools/virt-make-fs.pl:269
30559 " virt-make-fs --partition -- input.tar ...\n"
30564 #: ../tools/virt-make-fs.pl:541
30566 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30567 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30568 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30572 #: ../tools/virt-make-fs.pl:558
30575 " export LIBGUESTFS_DEBUG=1\n"
30576 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30581 #: ../tools/virt-make-fs.pl:561
30583 "Attach /tmp/virt-make-fs.log to a new bug report at "
30584 "L<https://bugzilla.redhat.com/>"
30588 #: ../tools/virt-list-partitions.pl:32
30589 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
30593 #: ../tools/virt-list-partitions.pl:36
30596 " virt-list-partitions [--options] domname\n"
30601 #: ../tools/virt-list-partitions.pl:38
30604 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30609 #: ../tools/virt-list-partitions.pl:45
30611 "C<virt-list-partitions> is a command line tool to list the partitions that "
30612 "are contained in a virtual machine or disk image. It is mainly useful as a "
30613 "first step to using L<virt-resize(1)>."
30617 #: ../tools/virt-list-partitions.pl:50
30619 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30620 "functionality. For more complex cases you should look at the "
30621 "L<guestfish(1)> tool."
30625 #: ../tools/virt-list-partitions.pl:107
30626 msgid "B<-h> | B<--human-readable>"
30630 #: ../tools/virt-list-partitions.pl:109
30631 msgid "Show sizes in human-readable form (eg. \"1G\")."
30635 #: ../tools/virt-list-partitions.pl:117
30637 "With this option, C<virt-list-partitions> displays the type and size of each "
30638 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30642 #: ../tools/virt-list-partitions.pl:124
30643 msgid "B<-t> | B<--total>"
30647 #: ../tools/virt-list-partitions.pl:126
30648 msgid "Display the total size of each block device (as a separate row or rows)."
30652 #: ../tools/virt-list-partitions.pl:259
30654 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
30655 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
30656 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."