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.7\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-01-30 23:51+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:1031 ../src/guestfs.pod:1035 ../src/guestfs.pod:1039 ../src/guestfs.pod:1044 ../src/guestfs.pod:1052 ../src/guestfs.pod:1071 ../src/guestfs.pod:1079 ../src/guestfs.pod:1101 ../src/guestfs.pod:1105 ../src/guestfs.pod:1109 ../src/guestfs.pod:1113 ../src/guestfs.pod:1117 ../src/guestfs.pod:1121 ../src/guestfs.pod:1603 ../src/guestfs.pod:1608 ../src/guestfs.pod:1612 ../src/guestfs.pod:1722 ../src/guestfs.pod:1727 ../src/guestfs.pod:1731 ../src/guestfs.pod:2083 ../src/guestfs.pod:2089 ../src/guestfs.pod:2094 ../src/guestfs.pod:2100 ../src/guestfs.pod:2565 ../src/guestfs.pod:2569 ../src/guestfs.pod:2573 ../src/guestfs.pod:2577 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373 ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073 ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257 ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1224 ../src/guestfs.pod:1355 ../src/guestfs.pod:2128
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:1228 ../src/guestfs.pod:1359 ../src/guestfs.pod:2153
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:1365
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:746
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems, an install CD or a live CD. (These APIs used to "
1112 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1113 "version 1.5.3 the most frequently used part of this library has been "
1114 "rewritten in C and moved into the core code)."
1118 #: ../src/guestfs.pod:559
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:562
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:571
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:577
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:584
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:588
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:591
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:595
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:599
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:603
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:612
1213 msgid "INSPECTING INSTALL DISKS"
1217 #: ../src/guestfs.pod:614
1219 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1224 #: ../src/guestfs.pod:617
1226 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1227 "system, which currently can be C<installed> (a regular operating system) or "
1228 "C<installer> (some sort of install disk)."
1232 #: ../src/guestfs.pod:621
1234 "Further information is available about the operating system that can be "
1235 "installed using the regular inspection APIs like "
1236 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1241 #: ../src/guestfs.pod:626
1243 "Some additional information specific to installer disks is also available "
1244 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1245 "L</guestfs_inspect_is_multipart> calls."
1249 #: ../src/guestfs.pod:631
1250 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1254 #: ../src/guestfs.pod:633
1256 "Libguestfs can mount NTFS partitions. It does this using the "
1257 "L<http://www.ntfs-3g.org/> driver."
1261 #: ../src/guestfs.pod:636
1262 msgid "DRIVE LETTERS AND PATHS"
1266 #: ../src/guestfs.pod:638
1268 "DOS and Windows still use drive letters, and the filesystems are always "
1269 "treated as case insensitive by Windows itself, and therefore you might find "
1270 "a Windows configuration file referring to a path like "
1271 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1272 "that directory might be referred to as C</WINDOWS/System32>."
1276 #: ../src/guestfs.pod:644
1278 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1279 "libguestfs to read the appropriate Windows Registry and configuration files, "
1280 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1281 "L<virt-inspector(1)>)."
1285 #: ../src/guestfs.pod:649
1287 "Replacing backslash characters with forward slash characters is also outside "
1288 "the scope of libguestfs, but something that you can easily do."
1292 #: ../src/guestfs.pod:652
1294 "Where we can help is in resolving the case insensitivity of paths. For "
1295 "this, call L</guestfs_case_sensitive_path>."
1299 #: ../src/guestfs.pod:655
1300 msgid "ACCESSING THE WINDOWS REGISTRY"
1304 #: ../src/guestfs.pod:657
1306 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1307 "files, through the library C<hivex> which is part of the libguestfs project "
1308 "although ships as a separate tarball. You have to locate and download the "
1309 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1310 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1311 "L<virt-win-reg(1)> for more help on this issue."
1315 #: ../src/guestfs.pod:665
1316 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1320 #: ../src/guestfs.pod:667
1322 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1323 "provide something which looks like a Linux symlink. The way it tries to do "
1324 "the rewriting is described here:"
1328 #: ../src/guestfs.pod:671
1329 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1333 #: ../src/guestfs.pod:673
1335 "The essential problem is that ntfs-3g simply does not have enough "
1336 "information to do a correct job. NTFS links can contain drive letters and "
1337 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1338 "It is almost certainly the case that libguestfs callers should ignore what "
1339 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1343 #: ../src/guestfs.pod:680
1345 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1346 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1347 "attribute, and read the raw reparse data from that (you can find the format "
1348 "documented in various places around the web)."
1352 #: ../src/guestfs.pod:685
1353 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1357 #: ../src/guestfs.pod:687
1359 "There are other useful extended attributes that can be read from ntfs-3g "
1360 "filesystems (using L</guestfs_getxattr>). See:"
1364 #: ../src/guestfs.pod:690
1365 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1369 #: ../src/guestfs.pod:692
1370 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1374 #: ../src/guestfs.pod:694
1376 "Although we don't want to discourage you from using the C API, we will "
1377 "mention here that the same API is also available in other languages."
1381 #: ../src/guestfs.pod:697
1383 "The API is broadly identical in all supported languages. This means that "
1384 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1385 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1386 "OCaml. In other words, a straightforward, predictable isomorphism between "
1391 #: ../src/guestfs.pod:703
1393 "Error messages are automatically transformed into exceptions if the language "
1398 #: ../src/guestfs.pod:706
1400 "We don't try to \"object orientify\" parts of the API in OO languages, "
1401 "although contributors are welcome to write higher level APIs above what we "
1402 "provide in their favourite languages if they wish."
1406 #: ../src/guestfs.pod:712
1411 #: ../src/guestfs.pod:714
1413 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1414 "identical to the C API. C++ classes and exceptions are not used."
1418 #: ../src/guestfs.pod:718
1423 #: ../src/guestfs.pod:720
1425 "The C# bindings are highly experimental. Please read the warnings at the "
1426 "top of C<csharp/Libguestfs.cs>."
1430 #: ../src/guestfs.pod:723
1435 #: ../src/guestfs.pod:725
1437 "This is the only language binding that is working but incomplete. Only "
1438 "calls which return simple integers have been bound in Haskell, and we are "
1439 "looking for help to complete this binding."
1443 #: ../src/guestfs.pod:729
1448 #: ../src/guestfs.pod:731
1450 "Full documentation is contained in the Javadoc which is distributed with "
1455 #: ../src/guestfs.pod:734
1460 #: ../src/guestfs.pod:736
1461 msgid "See L<guestfs-ocaml(3)>."
1465 #: ../src/guestfs.pod:738
1470 #: ../src/guestfs.pod:740
1471 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1475 #: ../src/guestfs.pod:742
1480 #: ../src/guestfs.pod:744
1482 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1483 "the php-libguestfs package for your distribution."
1487 #: ../src/guestfs.pod:747
1488 msgid "The PHP binding only works correctly on 64 bit machines."
1492 #: ../src/guestfs.pod:749
1497 #: ../src/guestfs.pod:751
1498 msgid "See L<guestfs-python(3)>."
1502 #: ../src/guestfs.pod:753
1507 #: ../src/guestfs.pod:755
1508 msgid "See L<guestfs-ruby(3)>."
1512 #: ../src/guestfs.pod:757
1513 msgid "B<shell scripts>"
1517 #: ../src/guestfs.pod:759
1518 msgid "See L<guestfish(1)>."
1522 #: ../src/guestfs.pod:763
1523 msgid "LIBGUESTFS GOTCHAS"
1527 #: ../src/guestfs.pod:765
1529 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1530 "system [...] that works in the way it is documented but is counterintuitive "
1531 "and almost invites mistakes.\""
1535 #: ../src/guestfs.pod:769
1537 "Since we developed libguestfs and the associated tools, there are several "
1538 "things we would have designed differently, but are now stuck with for "
1539 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1540 "release, you can expect these to change. Beware of them."
1544 #: ../src/guestfs.pod:777
1545 msgid "Autosync / forgetting to sync."
1549 #: ../src/guestfs.pod:779
1551 "When modifying a filesystem from C or another language, you B<must> unmount "
1552 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1553 "libguestfs handle. You can also call:"
1557 #: ../src/guestfs.pod:783
1560 " guestfs_set_autosync (g, 1);\n"
1565 #: ../src/guestfs.pod:785
1567 "to have the unmount/sync done automatically for you when the handle 'g' is "
1568 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1573 #: ../src/guestfs.pod:789
1575 "If you forget to do this, then it is entirely possible that your changes "
1576 "won't be written out, or will be partially written, or (very rarely) that "
1577 "you'll get disk corruption."
1581 #: ../src/guestfs.pod:793
1583 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1584 "guestfish scripts that forget to sync will work just fine, which can make "
1585 "this very puzzling if you are trying to debug a problem."
1589 #: ../src/guestfs.pod:797
1591 "Update: Autosync is enabled by default for all API users starting from "
1592 "libguestfs 1.5.24."
1596 #: ../src/guestfs.pod:800
1597 msgid "Mount option C<-o sync> should not be the default."
1601 #: ../src/guestfs.pod:802
1603 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1604 "However C<-o sync> does not add any reliability benefit, but does have a "
1605 "very large performance impact."
1609 #: ../src/guestfs.pod:806
1611 "The work around is to use L</guestfs_mount_options> and set the mount "
1612 "options that you actually want to use."
1616 #: ../src/guestfs.pod:809
1617 msgid "Read-only should be the default."
1621 #: ../src/guestfs.pod:811
1623 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1624 "specify I<--rw> if you want to make changes to the image."
1628 #: ../src/guestfs.pod:814
1629 msgid "This would reduce the potential to corrupt live VM images."
1633 #: ../src/guestfs.pod:816
1635 "Note that many filesystems change the disk when you just mount and unmount, "
1636 "even if you didn't perform any writes. You need to use "
1637 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1641 #: ../src/guestfs.pod:820
1642 msgid "guestfish command line is hard to use."
1646 #: ../src/guestfs.pod:822
1648 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1649 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1650 "exist, so it fails. In earlier versions of guestfish the error message was "
1651 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1652 "we should have used C<guestfish -c command> to run commands."
1656 #: ../src/guestfs.pod:829
1657 msgid "guestfish megabyte modifiers don't work right on all commands"
1661 #: ../src/guestfs.pod:831
1663 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1664 "other modifiers). What guestfish actually does is to multiply the number "
1665 "part by the modifier part and pass the result to the C API. However this "
1666 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1667 "expecting some other unit (eg. megabytes)."
1671 #: ../src/guestfs.pod:838
1672 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1676 #: ../src/guestfs.pod:840
1679 " lvcreate LV VG 100M\n"
1684 #: ../src/guestfs.pod:842
1686 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1687 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1688 "megabytes * megabytes) logical volume. The error message you get from this "
1689 "is also a little obscure."
1693 #: ../src/guestfs.pod:847
1695 "This could be fixed in the generator by specially marking parameters and "
1696 "return values which take bytes or other units."
1700 #: ../src/guestfs.pod:850
1701 msgid "Ambiguity between devices and paths"
1705 #: ../src/guestfs.pod:852
1707 "There is a subtle ambiguity in the API between a device name "
1708 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1709 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1713 #: ../src/guestfs.pod:857
1715 "In the current API we usually resolve this ambiguity by having two separate "
1716 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1717 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1718 "detecting if the path supplied begins with C</dev/>."
1722 #: ../src/guestfs.pod:863
1724 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1725 "make paths/devices into structured names. One way to do this would be to "
1726 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1727 "aspect of grub. Another way would be to use a structured type, equivalent "
1728 "to this OCaml type:"
1732 #: ../src/guestfs.pod:869
1735 " type path = Path of string | Device of int | Partition of int * int\n"
1740 #: ../src/guestfs.pod:871
1741 msgid "which would allow you to pass arguments like:"
1745 #: ../src/guestfs.pod:873
1748 " Path \"/foo/bar\"\n"
1749 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1750 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1751 " Path \"/dev/sdb2\" (* not a device *)\n"
1756 #: ../src/guestfs.pod:878
1758 "As you can see there are still problems to resolve even with this "
1759 "representation. Also consider how it might work in guestfish."
1763 #: ../src/guestfs.pod:883
1764 msgid "PROTOCOL LIMITS"
1768 #: ../src/guestfs.pod:885
1770 "Internally libguestfs uses a message-based protocol to pass API calls and "
1771 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1772 "plenty more detail about this). The maximum message size used by the "
1773 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1774 "aware of this limit. The API calls which may be affected are individually "
1775 "documented, with a link back to this section of the documentation."
1779 #: ../src/guestfs.pod:893
1781 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1782 "a simple string. Because this string is at some point internally encoded as "
1783 "a message, the maximum size that it can return is slightly under 4 MB. If "
1784 "the requested file is larger than this then you will get an error."
1788 #: ../src/guestfs.pod:899
1790 "In order to transfer large files into and out of the guest filesystem, you "
1791 "need to use particular calls that support this. The sections L</UPLOADING> "
1792 "and L</DOWNLOADING> document how to do this."
1796 #: ../src/guestfs.pod:903
1798 "You might also consider mounting the disk image using our FUSE filesystem "
1799 "support (L<guestmount(1)>)."
1803 #: ../src/guestfs.pod:906
1804 msgid "KEYS AND PASSPHRASES"
1808 #: ../src/guestfs.pod:908
1810 "Certain libguestfs calls take a parameter that contains sensitive key "
1811 "material, passed in as a C string."
1815 #: ../src/guestfs.pod:911
1817 "In the future we would hope to change the libguestfs implementation so that "
1818 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1819 "swap. However this is I<not> done at the moment, because of the complexity "
1820 "of such an implementation."
1824 #: ../src/guestfs.pod:916
1826 "Therefore you should be aware that any key parameter you pass to libguestfs "
1827 "might end up being written out to the swap partition. If this is a concern, "
1828 "scrub the swap partition or don't use libguestfs on encrypted devices."
1832 #: ../src/guestfs.pod:921
1833 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1837 #: ../src/guestfs.pod:923
1839 "All high-level libguestfs actions are synchronous. If you want to use "
1840 "libguestfs asynchronously then you must create a thread."
1844 #: ../src/guestfs.pod:926
1846 "Only use the handle from a single thread. Either use the handle exclusively "
1847 "from one thread, or provide your own mutex so that two threads cannot issue "
1848 "calls on the same handle at the same time."
1852 #: ../src/guestfs.pod:930
1854 "See the graphical program guestfs-browser for one possible architecture for "
1855 "multithreaded programs using libvirt and libguestfs."
1859 #: ../src/guestfs.pod:933
1864 #: ../src/guestfs.pod:935
1866 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1871 #: ../src/guestfs.pod:938
1873 "By default it looks for these in the directory C<$libdir/guestfs> "
1874 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1878 #: ../src/guestfs.pod:941
1880 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1881 "to change the directories that libguestfs will search in. The value is a "
1882 "colon-separated list of paths. The current directory is I<not> searched "
1883 "unless the path contains an empty element or C<.>. For example "
1884 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1885 "then C</usr/lib/guestfs>."
1889 #: ../src/guestfs.pod:948
1890 msgid "QEMU WRAPPERS"
1894 #: ../src/guestfs.pod:950
1896 "If you want to compile your own qemu, run qemu from a non-standard location, "
1897 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1902 #: ../src/guestfs.pod:954
1904 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1905 "last command in the shell script (so that qemu replaces the shell and "
1906 "becomes the direct child of the libguestfs-using program). If you don't do "
1907 "this, then the qemu process won't be cleaned up correctly."
1911 #: ../src/guestfs.pod:959
1913 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1918 #: ../src/guestfs.pod:962
1922 " qemudir=/home/rjones/d/qemu\n"
1923 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1929 #: ../src/guestfs.pod:966
1931 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1932 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1937 #: ../src/guestfs.pod:970
1940 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1945 #: ../src/guestfs.pod:972
1947 "Note that libguestfs also calls qemu with the -help and -version options in "
1948 "order to determine features."
1952 #: ../src/guestfs.pod:975
1953 msgid "ABI GUARANTEE"
1957 #: ../src/guestfs.pod:977
1959 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1960 "actions as outlined in this section. Although we will deprecate some "
1961 "actions, for example if they get replaced by newer calls, we will keep the "
1962 "old actions forever. This allows you the developer to program in confidence "
1963 "against the libguestfs API."
1967 #: ../src/guestfs.pod:983
1968 msgid "BLOCK DEVICE NAMING"
1972 #: ../src/guestfs.pod:985
1974 "In the kernel there is now quite a profusion of schemata for naming block "
1975 "devices (in this context, by I<block device> I mean a physical or virtual "
1976 "hard drive). The original Linux IDE driver used names starting with "
1977 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1978 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1979 "replacement for the old IDE driver (particularly for SATA devices) those "
1980 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1981 "machines with paravirtualized drivers. This has created several different "
1982 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1987 #: ../src/guestfs.pod:997
1989 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1990 "Linux kernel to access block devices. We can run a variety of appliances "
1991 "based on a variety of Linux kernels."
1995 #: ../src/guestfs.pod:1001
1997 "This causes a problem for libguestfs because many API calls use device or "
1998 "partition names. Working scripts and the recipe (example) scripts that we "
1999 "make available over the internet could fail if the naming scheme changes."
2003 #: ../src/guestfs.pod:1006
2005 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2006 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2007 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2008 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2012 #: ../src/guestfs.pod:1012
2014 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2015 "L</guestfs_list_partitions> and similar calls return the true names of the "
2016 "devices and partitions as known to the appliance."
2020 #: ../src/guestfs.pod:1017
2021 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2025 #: ../src/guestfs.pod:1019
2027 "Usually this translation is transparent. However in some (very rare) cases "
2028 "you may need to know the exact algorithm. Such cases include where you use "
2029 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2030 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2035 #: ../src/guestfs.pod:1025
2037 "The algorithm is applied only to I<parameters> which are known to be either "
2038 "device or partition names. Return values from functions such as "
2039 "L</guestfs_list_devices> are never changed."
2043 #: ../src/guestfs.pod:1033
2044 msgid "Is the string a parameter which is a device or partition name?"
2048 #: ../src/guestfs.pod:1037
2049 msgid "Does the string begin with C</dev/sd>?"
2053 #: ../src/guestfs.pod:1041
2055 "Does the named device exist? If so, we use that device. However if I<not> "
2056 "then we continue with this algorithm."
2060 #: ../src/guestfs.pod:1046
2061 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2065 #: ../src/guestfs.pod:1048
2066 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2070 #: ../src/guestfs.pod:1050
2071 msgid "If that named device exists, use it. If not, continue."
2075 #: ../src/guestfs.pod:1054
2076 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2080 #: ../src/guestfs.pod:1056
2081 msgid "If that named device exists, use it. If not, return an error."
2085 #: ../src/guestfs.pod:1060
2086 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2090 #: ../src/guestfs.pod:1062
2092 "Although the standard naming scheme and automatic translation is useful for "
2093 "simple programs and guestfish scripts, for larger programs it is best not to "
2094 "rely on this mechanism."
2098 #: ../src/guestfs.pod:1066
2100 "Where possible for maximum future portability programs using libguestfs "
2101 "should use these future-proof techniques:"
2105 #: ../src/guestfs.pod:1073
2107 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2108 "device names, and then use those names directly."
2112 #: ../src/guestfs.pod:1076
2113 msgid "Since those device names exist by definition, they will never be translated."
2117 #: ../src/guestfs.pod:1081
2119 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2120 "filesystem labels."
2124 #: ../src/guestfs.pod:1086
2129 #: ../src/guestfs.pod:1088
2131 "This section discusses security implications of using libguestfs, "
2132 "particularly with untrusted or malicious guests or disk images."
2136 #: ../src/guestfs.pod:1091
2137 msgid "GENERAL SECURITY CONSIDERATIONS"
2141 #: ../src/guestfs.pod:1093
2143 "Be careful with any files or data that you download from a guest (by "
2144 "\"download\" we mean not just the L</guestfs_download> command but any "
2145 "command that reads files, filenames, directories or anything else from a "
2146 "disk image). An attacker could manipulate the data to fool your program "
2147 "into doing the wrong thing. Consider cases such as:"
2151 #: ../src/guestfs.pod:1103
2152 msgid "the data (file etc) not being present"
2156 #: ../src/guestfs.pod:1107
2157 msgid "being present but empty"
2161 #: ../src/guestfs.pod:1111
2162 msgid "being much larger than normal"
2166 #: ../src/guestfs.pod:1115
2167 msgid "containing arbitrary 8 bit data"
2171 #: ../src/guestfs.pod:1119
2172 msgid "being in an unexpected character encoding"
2176 #: ../src/guestfs.pod:1123
2177 msgid "containing homoglyphs."
2181 #: ../src/guestfs.pod:1127
2182 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2186 #: ../src/guestfs.pod:1129
2188 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2189 "(VFS) module can sometimes be escalated into exploits by deliberately "
2190 "creating a malicious, malformed filesystem. These exploits are very severe "
2191 "for two reasons. Firstly there are very many filesystem drivers in the "
2192 "kernel, and many of them are infrequently used and not much developer "
2193 "attention has been paid to the code. Linux userspace helps potential "
2194 "crackers by detecting the filesystem type and automatically choosing the "
2195 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2196 "the administrator. Secondly, a kernel-level exploit is like a local root "
2197 "exploit (worse in some ways), giving immediate and total access to the "
2198 "system right down to the hardware level."
2202 #: ../src/guestfs.pod:1142
2204 "That explains why you should never mount a filesystem from an untrusted "
2205 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2206 "inside a qemu virtual machine, usually running as a non-root user. The "
2207 "attacker would need to write a filesystem which first exploited the kernel, "
2208 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2209 "the libguestfs protocol, and finally to be as serious as the host kernel "
2210 "exploit it would need to escalate its privileges to root. This multi-step "
2211 "escalation, performed by a static piece of data, is thought to be extremely "
2212 "hard to do, although we never say 'never' about security issues."
2216 #: ../src/guestfs.pod:1153
2218 "In any case callers can reduce the attack surface by forcing the filesystem "
2219 "type when mounting (use L</guestfs_mount_vfs>)."
2223 #: ../src/guestfs.pod:1156
2224 msgid "PROTOCOL SECURITY"
2228 #: ../src/guestfs.pod:1158
2230 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2231 "defined upper message size. However a program that uses libguestfs must "
2232 "also take care - for example you can write a program that downloads a binary "
2233 "from a disk image and executes it locally, and no amount of protocol "
2234 "security will save you from the consequences."
2238 #: ../src/guestfs.pod:1164
2239 msgid "INSPECTION SECURITY"
2243 #: ../src/guestfs.pod:1166
2245 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2246 "directly from the guest, and these could contain any 8 bit data. Callers "
2247 "should be careful to escape these before printing them to a structured file "
2248 "(for example, use HTML escaping if creating a web page)."
2252 #: ../src/guestfs.pod:1172
2254 "Guest configuration may be altered in unusual ways by the administrator of "
2255 "the virtual machine, and may not reflect reality (particularly for untrusted "
2256 "or actively malicious guests). For example we parse the hostname from "
2257 "configuration files like C</etc/sysconfig/network> that we find in the "
2258 "guest, but the guest administrator can easily manipulate these files to "
2259 "provide the wrong hostname."
2263 #: ../src/guestfs.pod:1180
2265 "The inspection API parses guest configuration using two external libraries: "
2266 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2267 "designed to be robust in the face of malicious data, although denial of "
2268 "service attacks are still possible, for example with oversized configuration "
2273 #: ../src/guestfs.pod:1186
2274 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2278 #: ../src/guestfs.pod:1188
2280 "Be very cautious about running commands from the guest. By running a "
2281 "command in the guest, you are giving CPU time to a binary that you do not "
2282 "control, under the same user account as the library, albeit wrapped in qemu "
2283 "virtualization. More information and alternatives can be found in the "
2284 "section L</RUNNING COMMANDS>."
2288 #: ../src/guestfs.pod:1194
2289 msgid "CVE-2010-3851"
2293 #: ../src/guestfs.pod:1196
2294 msgid "https://bugzilla.redhat.com/642934"
2298 #: ../src/guestfs.pod:1198
2300 "This security bug concerns the automatic disk format detection that qemu "
2301 "does on disk images."
2305 #: ../src/guestfs.pod:1201
2307 "A raw disk image is just the raw bytes, there is no header. Other disk "
2308 "images like qcow2 contain a special header. Qemu deals with this by looking "
2309 "for one of the known headers, and if none is found then assuming the disk "
2310 "image must be raw."
2314 #: ../src/guestfs.pod:1206
2316 "This allows a guest which has been given a raw disk image to write some "
2317 "other header. At next boot (or when the disk image is accessed by "
2318 "libguestfs) qemu would do autodetection and think the disk image format was, "
2319 "say, qcow2 based on the header written by the guest."
2323 #: ../src/guestfs.pod:1211
2325 "This in itself would not be a problem, but qcow2 offers many features, one "
2326 "of which is to allow a disk image to refer to another image (called the "
2327 "\"backing disk\"). It does this by placing the path to the backing disk "
2328 "into the qcow2 header. This path is not validated and could point to any "
2329 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2330 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2331 "control of the attacker."
2335 #: ../src/guestfs.pod:1219
2336 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2340 #: ../src/guestfs.pod:1226
2341 msgid "You have enabled the network or have opened the disk in write mode."
2345 #: ../src/guestfs.pod:1230
2347 "You are also running untrusted code from the guest (see L</RUNNING "
2352 #: ../src/guestfs.pod:1235
2354 "The way to avoid this is to specify the expected disk format when adding "
2355 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2356 "should always do this if the disk is raw format, and it's a good idea for "
2361 #: ../src/guestfs.pod:1240
2363 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2364 "format is fetched from libvirt and passed through."
2368 #: ../src/guestfs.pod:1243
2370 "For libguestfs tools, use the I<--format> command line parameter as "
2375 #: ../src/guestfs.pod:1246
2376 msgid "CONNECTION MANAGEMENT"
2380 #: ../src/guestfs.pod:1248
2385 #: ../src/guestfs.pod:1250
2387 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2388 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2389 "handle and release all resources used."
2393 #: ../src/guestfs.pod:1254
2395 "For information on using multiple handles and threads, see the section "
2396 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2400 #: ../src/guestfs.pod:1257
2401 msgid "guestfs_create"
2405 #: ../src/guestfs.pod:1259
2408 " guestfs_h *guestfs_create (void);\n"
2413 #: ../src/guestfs.pod:1261
2414 msgid "Create a connection handle."
2418 #: ../src/guestfs.pod:1263
2420 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2421 "on the handle at least once."
2425 #: ../src/guestfs.pod:1266
2427 "This function returns a non-NULL pointer to a handle on success or NULL on "
2432 #: ../src/guestfs.pod:1269
2433 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2437 #: ../src/guestfs.pod:1271
2439 "You may also want to configure error handling for the handle. See L</ERROR "
2440 "HANDLING> section below."
2444 #: ../src/guestfs.pod:1274
2445 msgid "guestfs_close"
2449 #: ../src/guestfs.pod:1276
2452 " void guestfs_close (guestfs_h *g);\n"
2457 #: ../src/guestfs.pod:1278
2458 msgid "This closes the connection handle and frees up all resources used."
2462 #: ../src/guestfs.pod:1280
2463 msgid "ERROR HANDLING"
2467 #: ../src/guestfs.pod:1282
2469 "API functions can return errors. For example, almost all functions that "
2470 "return C<int> will return C<-1> to indicate an error."
2474 #: ../src/guestfs.pod:1285
2476 "Additional information is available for errors: an error message string and "
2477 "optionally an error number (errno) if the thing that failed was a system "
2482 #: ../src/guestfs.pod:1289
2484 "You can get at the additional information about the last error on the handle "
2485 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2486 "up an error handler with L</guestfs_set_error_handler>."
2490 #: ../src/guestfs.pod:1294
2492 "When the handle is created, a default error handler is installed which "
2493 "prints the error message string to C<stderr>. For small short-running "
2494 "command line programs it is sufficient to do:"
2498 #: ../src/guestfs.pod:1298
2501 " if (guestfs_launch (g) == -1)\n"
2502 " exit (EXIT_FAILURE);\n"
2507 #: ../src/guestfs.pod:1301
2509 "since the default error handler will ensure that an error message has been "
2510 "printed to C<stderr> before the program exits."
2514 #: ../src/guestfs.pod:1304
2516 "For other programs the caller will almost certainly want to install an "
2517 "alternate error handler or do error handling in-line like this:"
2521 #: ../src/guestfs.pod:1307
2524 " g = guestfs_create ();\n"
2529 #: ../src/guestfs.pod:1309
2532 " /* This disables the default behaviour of printing errors\n"
2534 " guestfs_set_error_handler (g, NULL, NULL);\n"
2539 #: ../src/guestfs.pod:1313
2542 " if (guestfs_launch (g) == -1) {\n"
2543 " /* Examine the error message and print it etc. */\n"
2544 " char *msg = guestfs_last_error (g);\n"
2545 " int errnum = guestfs_last_errno (g);\n"
2546 " fprintf (stderr, \"%s\\n\", msg);\n"
2553 #: ../src/guestfs.pod:1321
2555 "Out of memory errors are handled differently. The default action is to call "
2556 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2557 "L</guestfs_set_out_of_memory_handler>."
2561 #: ../src/guestfs.pod:1325
2563 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2564 "because there is no handle if this happens there is no way to get additional "
2565 "error information. However L</guestfs_create> is supposed to be a "
2566 "lightweight operation which can only fail because of insufficient memory (it "
2567 "returns NULL in this case)."
2571 #: ../src/guestfs.pod:1331
2572 msgid "guestfs_last_error"
2576 #: ../src/guestfs.pod:1333
2579 " const char *guestfs_last_error (guestfs_h *g);\n"
2584 #: ../src/guestfs.pod:1335
2586 "This returns the last error message that happened on C<g>. If there has not "
2587 "been an error since the handle was created, then this returns C<NULL>."
2591 #: ../src/guestfs.pod:1339
2593 "The lifetime of the returned string is until the next error occurs, or "
2594 "L</guestfs_close> is called."
2598 #: ../src/guestfs.pod:1342
2599 msgid "guestfs_last_errno"
2603 #: ../src/guestfs.pod:1344
2606 " int guestfs_last_errno (guestfs_h *g);\n"
2611 #: ../src/guestfs.pod:1346
2612 msgid "This returns the last error number (errno) that happened on C<g>."
2616 #: ../src/guestfs.pod:1348
2617 msgid "If successful, an errno integer not equal to zero is returned."
2621 #: ../src/guestfs.pod:1350
2622 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2626 #: ../src/guestfs.pod:1357
2627 msgid "There has not been any error on the handle."
2631 #: ../src/guestfs.pod:1361
2633 "There has been an error but the errno was meaningless. This corresponds to "
2634 "the case where the error did not come from a failed system call, but for "
2635 "some other reason."
2639 #: ../src/guestfs.pod:1367
2641 "There was an error from a failed system call, but for some reason the errno "
2642 "was not captured and returned. This usually indicates a bug in libguestfs."
2646 #: ../src/guestfs.pod:1373
2648 "Libguestfs tries to convert the errno from inside the applicance into a "
2649 "corresponding errno for the caller (not entirely trivial: the appliance "
2650 "might be running a completely different operating system from the library "
2651 "and error numbers are not standardized across Un*xen). If this could not be "
2652 "done, then the error is translated to C<EINVAL>. In practice this should "
2653 "only happen in very rare circumstances."
2657 #: ../src/guestfs.pod:1381
2658 msgid "guestfs_set_error_handler"
2662 #: ../src/guestfs.pod:1383
2665 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2667 " const char *msg);\n"
2668 " void guestfs_set_error_handler (guestfs_h *g,\n"
2669 " guestfs_error_handler_cb cb,\n"
2675 #: ../src/guestfs.pod:1390
2677 "The callback C<cb> will be called if there is an error. The parameters "
2678 "passed to the callback are an opaque data pointer and the error message "
2683 #: ../src/guestfs.pod:1394
2685 "C<errno> is not passed to the callback. To get that the callback must call "
2686 "L</guestfs_last_errno>."
2690 #: ../src/guestfs.pod:1397
2692 "Note that the message string C<msg> is freed as soon as the callback "
2693 "function returns, so if you want to stash it somewhere you must make your "
2698 #: ../src/guestfs.pod:1401
2699 msgid "The default handler prints messages on C<stderr>."
2703 #: ../src/guestfs.pod:1403
2704 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2708 #: ../src/guestfs.pod:1405
2709 msgid "guestfs_get_error_handler"
2713 #: ../src/guestfs.pod:1407
2716 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2717 " void **opaque_rtn);\n"
2722 #: ../src/guestfs.pod:1410
2723 msgid "Returns the current error handler callback."
2727 #: ../src/guestfs.pod:1412
2728 msgid "guestfs_set_out_of_memory_handler"
2732 #: ../src/guestfs.pod:1414
2735 " typedef void (*guestfs_abort_cb) (void);\n"
2736 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2737 " guestfs_abort_cb);\n"
2742 #: ../src/guestfs.pod:1418
2744 "The callback C<cb> will be called if there is an out of memory situation. "
2745 "I<Note this callback must not return>."
2749 #: ../src/guestfs.pod:1421
2750 msgid "The default is to call L<abort(3)>."
2754 #: ../src/guestfs.pod:1423
2755 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2759 #: ../src/guestfs.pod:1426
2760 msgid "guestfs_get_out_of_memory_handler"
2764 #: ../src/guestfs.pod:1428
2767 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2772 #: ../src/guestfs.pod:1430
2773 msgid "This returns the current out of memory handler."
2777 #: ../src/guestfs.pod:1432
2782 #: ../src/guestfs.pod:1434 ../fish/guestfish.pod:984
2787 #: ../src/guestfs.pod:1436
2792 #: ../src/guestfs.pod:1438
2797 #: ../src/guestfs.pod:1440
2798 msgid "AVAILABILITY"
2802 #: ../src/guestfs.pod:1442
2803 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2807 #: ../src/guestfs.pod:1444
2809 "Using L</guestfs_available> you can test availability of the following "
2810 "groups of functions. This test queries the appliance to see if the "
2811 "appliance you are currently using supports the functionality."
2815 #: ../src/guestfs.pod:1449
2816 msgid "@AVAILABILITY@"
2820 #: ../src/guestfs.pod:1451
2821 msgid "GUESTFISH supported COMMAND"
2825 #: ../src/guestfs.pod:1453
2827 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2828 "prints out the available groups and whether they are supported by this build "
2829 "of libguestfs. Note however that you have to do C<run> first."
2833 #: ../src/guestfs.pod:1458
2834 msgid "SINGLE CALLS AT COMPILE TIME"
2838 #: ../src/guestfs.pod:1460
2840 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2841 "function, such as:"
2845 #: ../src/guestfs.pod:1463
2848 " #define LIBGUESTFS_HAVE_DD 1\n"
2853 #: ../src/guestfs.pod:1465
2854 msgid "if L</guestfs_dd> is available."
2858 #: ../src/guestfs.pod:1467
2860 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2861 "function is available at compile time, we recommended using build tools such "
2862 "as autoconf or cmake. For example in autotools you could use:"
2866 #: ../src/guestfs.pod:1472
2869 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2870 " AC_CHECK_FUNCS([guestfs_dd])\n"
2875 #: ../src/guestfs.pod:1475
2877 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2882 #: ../src/guestfs.pod:1478
2883 msgid "SINGLE CALLS AT RUN TIME"
2887 #: ../src/guestfs.pod:1480
2889 "Testing at compile time doesn't guarantee that a function really exists in "
2890 "the library. The reason is that you might be dynamically linked against a "
2891 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2892 "This situation unfortunately results in a segmentation fault, which is a "
2893 "shortcoming of the C dynamic linking system itself."
2897 #: ../src/guestfs.pod:1487
2899 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2900 "in this example program (note that you still need the compile time check as "
2905 #: ../src/guestfs.pod:1491
2908 " #include <stdio.h>\n"
2909 " #include <stdlib.h>\n"
2910 " #include <unistd.h>\n"
2911 " #include <dlfcn.h>\n"
2912 " #include <guestfs.h>\n"
2917 #: ../src/guestfs.pod:1497
2922 " #ifdef LIBGUESTFS_HAVE_DD\n"
2924 " int has_function;\n"
2929 #: ../src/guestfs.pod:1503
2932 " /* Test if the function guestfs_dd is really available. */\n"
2933 " dl = dlopen (NULL, RTLD_LAZY);\n"
2935 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2936 " exit (EXIT_FAILURE);\n"
2938 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2944 #: ../src/guestfs.pod:1512
2947 " if (!has_function)\n"
2948 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2950 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2951 " /* Now it's safe to call\n"
2952 " guestfs_dd (g, \"foo\", \"bar\");\n"
2956 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2963 #: ../src/guestfs.pod:1525
2965 "You may think the above is an awful lot of hassle, and it is. There are "
2966 "other ways outside of the C linking system to ensure that this kind of "
2967 "incompatibility never arises, such as using package versioning:"
2971 #: ../src/guestfs.pod:1530
2974 " Requires: libguestfs >= 1.0.80\n"
2979 #: ../src/guestfs.pod:1532
2980 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2984 #: ../src/guestfs.pod:1534
2986 "A recent feature of the API is the introduction of calls which take optional "
2987 "arguments. In C these are declared 3 ways. The main way is as a call which "
2988 "takes variable arguments (ie. C<...>), as in this example:"
2992 #: ../src/guestfs.pod:1539
2995 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3000 #: ../src/guestfs.pod:1541
3002 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3003 "call with no optional arguments specified:"
3007 #: ../src/guestfs.pod:1544
3010 " guestfs_add_drive_opts (g, filename, -1);\n"
3015 #: ../src/guestfs.pod:1546
3016 msgid "With a single optional argument:"
3020 #: ../src/guestfs.pod:1548
3023 " guestfs_add_drive_opts (g, filename,\n"
3024 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3030 #: ../src/guestfs.pod:1552
3035 #: ../src/guestfs.pod:1554
3038 " guestfs_add_drive_opts (g, filename,\n"
3039 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3040 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3046 #: ../src/guestfs.pod:1559
3048 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3053 #: ../src/guestfs.pod:1562
3054 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3058 #: ../src/guestfs.pod:1564
3060 "The second variant has the same name with the suffix C<_va>, which works the "
3061 "same way but takes a C<va_list>. See the C manual for details. For the "
3062 "example function, this is declared:"
3066 #: ../src/guestfs.pod:1568
3069 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3075 #: ../src/guestfs.pod:1571
3076 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3080 #: ../src/guestfs.pod:1573
3082 "The third variant is useful where you need to construct these calls. You "
3083 "pass in a structure where you fill in the optional fields. The structure "
3084 "has a bitmask as the first element which you must set to indicate which "
3085 "fields you have filled in. For our example function the structure and call "
3090 #: ../src/guestfs.pod:1579
3093 " struct guestfs_add_drive_opts_argv {\n"
3094 " uint64_t bitmask;\n"
3096 " const char *format;\n"
3099 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3100 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3105 #: ../src/guestfs.pod:1588
3106 msgid "You could call it like this:"
3110 #: ../src/guestfs.pod:1590
3113 " struct guestfs_add_drive_opts_argv optargs = {\n"
3114 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3115 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3117 " .format = \"qcow2\"\n"
3123 #: ../src/guestfs.pod:1597
3126 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3131 #: ../src/guestfs.pod:1599 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1253 ../tools/virt-win-reg.pl:532
3136 #: ../src/guestfs.pod:1605
3137 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3141 #: ../src/guestfs.pod:1610
3142 msgid "You do not need to fill in all fields of the structure."
3146 #: ../src/guestfs.pod:1614
3148 "There must be a one-to-one correspondence between fields of the structure "
3149 "that are filled in, and bits set in the bitmask."
3153 #: ../src/guestfs.pod:1619
3154 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3158 #: ../src/guestfs.pod:1621
3160 "In other languages, optional arguments are expressed in the way that is "
3161 "natural for that language. We refer you to the language-specific "
3162 "documentation for more details on that."
3166 #: ../src/guestfs.pod:1625
3167 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3171 #: ../src/guestfs.pod:1627
3172 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3176 #: ../src/guestfs.pod:1629
3178 "The child process generates events in some situations. Current events "
3179 "include: receiving a log message, the child process exits."
3183 #: ../src/guestfs.pod:1632
3185 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3190 #: ../src/guestfs.pod:1635
3192 "Only I<one callback of each type> can be registered for each handle. "
3193 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3194 "that type. Cancel all callbacks of this type by calling this function with "
3195 "C<cb> set to C<NULL>."
3199 #: ../src/guestfs.pod:1640
3200 msgid "guestfs_set_log_message_callback"
3204 #: ../src/guestfs.pod:1642
3207 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3208 " char *buf, int len);\n"
3209 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3210 " guestfs_log_message_cb cb,\n"
3216 #: ../src/guestfs.pod:1648
3218 "The callback function C<cb> will be called whenever qemu or the guest writes "
3219 "anything to the console."
3223 #: ../src/guestfs.pod:1651
3224 msgid "Use this function to capture kernel messages and similar."
3228 #: ../src/guestfs.pod:1653
3230 "Normally there is no log message handler, and log messages are just "
3235 #: ../src/guestfs.pod:1656
3236 msgid "guestfs_set_subprocess_quit_callback"
3240 #: ../src/guestfs.pod:1658
3243 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3244 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3245 " guestfs_subprocess_quit_cb cb,\n"
3251 #: ../src/guestfs.pod:1663
3253 "The callback function C<cb> will be called when the child process quits, "
3254 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3255 "corresponds to a transition from any state to the CONFIG state)."
3259 #: ../src/guestfs.pod:1668
3260 msgid "guestfs_set_launch_done_callback"
3264 #: ../src/guestfs.pod:1670
3267 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3268 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3269 " guestfs_launch_done_cb cb,\n"
3275 #: ../src/guestfs.pod:1675
3277 "The callback function C<cb> will be called when the child process becomes "
3278 "ready first time after it has been launched. (This corresponds to a "
3279 "transition from LAUNCHING to the READY state)."
3283 #: ../src/guestfs.pod:1679
3284 msgid "guestfs_set_close_callback"
3288 #: ../src/guestfs.pod:1681
3291 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3292 " void guestfs_set_close_callback (guestfs_h *g,\n"
3293 " guestfs_close_cb cb,\n"
3299 #: ../src/guestfs.pod:1686
3301 "The callback function C<cb> will be called while the handle is being closed "
3302 "(synchronously from L</guestfs_close>)."
3306 #: ../src/guestfs.pod:1689
3308 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3309 "handles that are open when the program exits. This means that this callback "
3310 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3311 "problems in higher-level languages (eg. if your HLL interpreter has already "
3312 "been cleaned up by the time this is called, and if your callback then jumps "
3313 "into some HLL function)."
3317 #: ../src/guestfs.pod:1697
3318 msgid "guestfs_set_progress_callback"
3322 #: ../src/guestfs.pod:1699
3325 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3326 " int proc_nr, int serial,\n"
3327 " uint64_t position, uint64_t total);\n"
3328 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3329 " guestfs_progress_cb cb,\n"
3335 #: ../src/guestfs.pod:1706
3337 "Some long-running operations can generate progress messages. If this "
3338 "callback is registered, then it will be called each time a progress message "
3339 "is generated (usually two seconds after the operation started, and three "
3340 "times per second thereafter until it completes, although the frequency may "
3341 "change in future versions)."
3345 #: ../src/guestfs.pod:1712
3347 "The callback receives two numbers: C<position> and C<total>. The units of "
3348 "C<total> are not defined, although for some operations C<total> may relate "
3349 "in some way to the amount of data to be transferred (eg. in bytes or "
3350 "megabytes), and C<position> may be the portion which has been transferred."
3354 #: ../src/guestfs.pod:1718
3355 msgid "The only defined and stable parts of the API are:"
3359 #: ../src/guestfs.pod:1724
3361 "The callback can display to the user some type of progress bar or indicator "
3362 "which shows the ratio of C<position>:C<total>."
3366 #: ../src/guestfs.pod:1729
3367 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3371 #: ../src/guestfs.pod:1733
3373 "If any progress notification is sent during a call, then a final progress "
3374 "notification is always sent when C<position> = C<total>."
3378 #: ../src/guestfs.pod:1736
3380 "This is to simplify caller code, so callers can easily set the progress "
3381 "indicator to \"100%\" at the end of the operation, without requiring special "
3382 "code to detect this case."
3386 #: ../src/guestfs.pod:1742
3388 "The callback also receives the procedure number and serial number of the "
3389 "call. These are only useful for debugging protocol issues, and the callback "
3390 "can normally ignore them. The callback may want to print these numbers in "
3391 "error messages or debugging messages."
3395 #: ../src/guestfs.pod:1747
3396 msgid "PRIVATE DATA AREA"
3400 #: ../src/guestfs.pod:1749
3402 "You can attach named pieces of private data to the libguestfs handle, and "
3403 "fetch them by name for the lifetime of the handle. This is called the "
3404 "private data area and is only available from the C API."
3408 #: ../src/guestfs.pod:1753
3409 msgid "To attach a named piece of data, use the following call:"
3413 #: ../src/guestfs.pod:1755
3416 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3421 #: ../src/guestfs.pod:1757
3423 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3424 "pointer (which can be C<NULL>). Any previous item with the same name is "
3429 #: ../src/guestfs.pod:1761
3431 "You can use any C<key> you want, but names beginning with an underscore "
3432 "character are reserved for internal libguestfs purposes (for implementing "
3433 "language bindings). It is recommended to prefix the name with some unique "
3434 "string to avoid collisions with other users."
3438 #: ../src/guestfs.pod:1766
3439 msgid "To retrieve the pointer, use:"
3443 #: ../src/guestfs.pod:1768
3446 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3451 #: ../src/guestfs.pod:1770
3453 "This function returns C<NULL> if either no data is found associated with "
3454 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3459 #: ../src/guestfs.pod:1774
3461 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3462 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3463 "all. In particular, libguestfs does I<not> try to free the data when the "
3464 "handle is closed. If the data must be freed, then the caller must either "
3465 "free it before calling L</guestfs_close> or must set up a close callback to "
3466 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3467 "can be registered for a handle)."
3471 #: ../src/guestfs.pod:1782
3473 "The private data area is implemented using a hash table, and should be "
3474 "reasonably efficient for moderate numbers of keys."
3478 #: ../src/guestfs.pod:1785 ../src/guestfs.pod:1790
3483 #: ../src/guestfs.pod:1787
3485 "<!-- old anchor for the next section --> <a "
3486 "name=\"state_machine_and_low_level_event_api\"/>"
3490 #: ../src/guestfs.pod:1792
3491 msgid "ARCHITECTURE"
3495 #: ../src/guestfs.pod:1794
3497 "Internally, libguestfs is implemented by running an appliance (a special "
3498 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3499 "process of the main program."
3503 #: ../src/guestfs.pod:1798
3506 " ___________________\n"
3508 " | main program |\n"
3510 " | | child process / appliance\n"
3511 " | | __________________________\n"
3513 " +-------------------+ RPC | +-----------------+ |\n"
3514 " | libguestfs <--------------------> guestfsd | |\n"
3515 " | | | +-----------------+ |\n"
3516 " \\___________________/ | | Linux kernel | |\n"
3517 " | +--^--------------+ |\n"
3518 " \\_________|________________/\n"
3524 " \\______________/\n"
3529 #: ../src/guestfs.pod:1818
3531 "The library, linked to the main program, creates the child process and hence "
3532 "the appliance in the L</guestfs_launch> function."
3536 #: ../src/guestfs.pod:1821
3538 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3539 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3540 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3541 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3542 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3543 "attached to the qemu process which translates device access by the "
3544 "appliance's Linux kernel into accesses to the image."
3548 #: ../src/guestfs.pod:1830
3550 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3551 "Although the disk image you are attached to might also be used by some "
3552 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3553 "care if both libguestfs's qemu process and your virtual machine are trying "
3554 "to update the disk image at the same time, since these usually results in "
3555 "massive disk corruption)."
3559 #: ../src/guestfs.pod:1837
3560 msgid "STATE MACHINE"
3564 #: ../src/guestfs.pod:1839
3565 msgid "libguestfs uses a state machine to model the child process:"
3569 #: ../src/guestfs.pod:1841
3581 " / | \\ \\ guestfs_launch\n"
3582 " / | _\\__V______\n"
3584 " / | | LAUNCHING |\n"
3585 " / | \\___________/\n"
3587 " / | guestfs_launch\n"
3589 " ______ / __|____V\n"
3590 " / \\ ------> / \\\n"
3591 " | BUSY | | READY |\n"
3592 " \\______/ <------ \\________/\n"
3597 #: ../src/guestfs.pod:1863
3599 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3600 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3601 "(3) alternating between READY and BUSY as commands are issued to, and "
3602 "carried out by, the child process."
3606 #: ../src/guestfs.pod:1868
3608 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3609 "asynchronously at any time (eg. due to some internal error), and that causes "
3610 "the state to transition back to CONFIG."
3614 #: ../src/guestfs.pod:1872
3616 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3617 "issued when in the CONFIG state."
3621 #: ../src/guestfs.pod:1875
3623 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3624 "L</guestfs_launch> blocks until the child process is READY to accept "
3625 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3626 "moves the state from CONFIG to LAUNCHING while it is running."
3630 #: ../src/guestfs.pod:1881
3632 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3633 "state. These API calls block waiting for the command to be carried out "
3634 "(ie. the state to transition to BUSY and then back to READY). There are no "
3635 "non-blocking versions, and no way to issue more than one command per handle "
3640 #: ../src/guestfs.pod:1887
3642 "Finally, the child process sends asynchronous messages back to the main "
3643 "program, such as kernel log messages. You can register a callback to "
3644 "receive these messages."
3648 #: ../src/guestfs.pod:1891
3653 #: ../src/guestfs.pod:1893
3654 msgid "COMMUNICATION PROTOCOL"
3658 #: ../src/guestfs.pod:1895
3660 "Don't rely on using this protocol directly. This section documents how it "
3661 "currently works, but it may change at any time."
3665 #: ../src/guestfs.pod:1898
3667 "The protocol used to talk between the library and the daemon running inside "
3668 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3669 "1014, RFC 1832, RFC 4506)."
3673 #: ../src/guestfs.pod:1902
3675 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3676 "this file is automatically generated)."
3680 #: ../src/guestfs.pod:1905
3682 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3683 "and C<FileOut> parameters, which are handled with very simple request/reply "
3684 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3685 "parameters, which use the same request and reply messages, but they may also "
3686 "be followed by files sent using a chunked encoding."
3690 #: ../src/guestfs.pod:1912
3691 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3695 #: ../src/guestfs.pod:1914
3696 msgid "For ordinary functions, the request message is:"
3700 #: ../src/guestfs.pod:1916
3703 " total length (header + arguments,\n"
3704 " but not including the length word itself)\n"
3705 " struct guestfs_message_header (encoded as XDR)\n"
3706 " struct guestfs_<foo>_args (encoded as XDR)\n"
3711 #: ../src/guestfs.pod:1921
3713 "The total length field allows the daemon to allocate a fixed size buffer "
3714 "into which it slurps the rest of the message. As a result, the total length "
3715 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3716 "effective size of any request is limited to somewhere under this size."
3720 #: ../src/guestfs.pod:1927
3722 "Note also that many functions don't take any arguments, in which case the "
3723 "C<guestfs_I<foo>_args> is completely omitted."
3727 #: ../src/guestfs.pod:1930
3729 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3730 "receiver knows what type of args structure to expect, or none at all."
3734 #: ../src/guestfs.pod:1934
3736 "For functions that take optional arguments, the optional arguments are "
3737 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3738 "arguments. A bitmask in the header indicates which optional arguments are "
3739 "meaningful. The bitmask is also checked to see if it contains bits set "
3740 "which the daemon does not know about (eg. if more optional arguments were "
3741 "added in a later version of the library), and this causes the call to be "
3746 #: ../src/guestfs.pod:1942
3747 msgid "The reply message for ordinary functions is:"
3751 #: ../src/guestfs.pod:1944
3754 " total length (header + ret,\n"
3755 " but not including the length word itself)\n"
3756 " struct guestfs_message_header (encoded as XDR)\n"
3757 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3762 #: ../src/guestfs.pod:1949
3764 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3765 "functions that return no formal return values."
3769 #: ../src/guestfs.pod:1952
3770 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3774 #: ../src/guestfs.pod:1955
3776 "In the case of an error, a flag is set in the header, and the reply message "
3777 "is slightly changed:"
3781 #: ../src/guestfs.pod:1958
3784 " total length (header + error,\n"
3785 " but not including the length word itself)\n"
3786 " struct guestfs_message_header (encoded as XDR)\n"
3787 " struct guestfs_message_error (encoded as XDR)\n"
3792 #: ../src/guestfs.pod:1963
3794 "The C<guestfs_message_error> structure contains the error message as a "
3799 #: ../src/guestfs.pod:1966
3800 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3804 #: ../src/guestfs.pod:1968
3806 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3807 "The normal request message is sent (see above). However this is followed by "
3808 "a sequence of file chunks."
3812 #: ../src/guestfs.pod:1972
3815 " total length (header + arguments,\n"
3816 " but not including the length word itself,\n"
3817 " and not including the chunks)\n"
3818 " struct guestfs_message_header (encoded as XDR)\n"
3819 " struct guestfs_<foo>_args (encoded as XDR)\n"
3820 " sequence of chunks for FileIn param #0\n"
3821 " sequence of chunks for FileIn param #1 etc.\n"
3826 #: ../src/guestfs.pod:1980
3827 msgid "The \"sequence of chunks\" is:"
3831 #: ../src/guestfs.pod:1982
3834 " length of chunk (not including length word itself)\n"
3835 " struct guestfs_chunk (encoded as XDR)\n"
3836 " length of chunk\n"
3837 " struct guestfs_chunk (encoded as XDR)\n"
3839 " length of chunk\n"
3840 " struct guestfs_chunk (with data.data_len == 0)\n"
3845 #: ../src/guestfs.pod:1990
3847 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3848 "is set in the final chunk to indicate either successful completion or early "
3853 #: ../src/guestfs.pod:1994
3855 "At time of writing there are no functions that have more than one FileIn "
3856 "parameter. However this is (theoretically) supported, by sending the "
3857 "sequence of chunks for each FileIn parameter one after another (from left to "
3862 #: ../src/guestfs.pod:1999
3864 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3865 "transfer. The library does this by sending a chunk with a special flag set "
3866 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3867 "RPC, does I<not> send any reply, and goes back to reading the next request."
3871 #: ../src/guestfs.pod:2005
3873 "The daemon may also cancel. It does this by writing a special word "
3874 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3875 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3876 "cancel chunk). The special word is chosen so that even if cancellation "
3877 "happens right at the end of the transfer (after the library has finished "
3878 "writing and has started listening for the reply), the \"spurious\" cancel "
3879 "flag will not be confused with the reply message."
3883 #: ../src/guestfs.pod:2014
3885 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3886 "limit), and also files where the size is not known in advance (eg. from "
3887 "pipes or sockets). However the chunks are rather small "
3888 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3889 "to keep much in memory."
3893 #: ../src/guestfs.pod:2020
3894 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3898 #: ../src/guestfs.pod:2022
3900 "The protocol for FileOut parameters is exactly the same as for FileIn "
3901 "parameters, but with the roles of daemon and library reversed."
3905 #: ../src/guestfs.pod:2025
3908 " total length (header + ret,\n"
3909 " but not including the length word itself,\n"
3910 " and not including the chunks)\n"
3911 " struct guestfs_message_header (encoded as XDR)\n"
3912 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3913 " sequence of chunks for FileOut param #0\n"
3914 " sequence of chunks for FileOut param #1 etc.\n"
3919 #: ../src/guestfs.pod:2033
3920 msgid "INITIAL MESSAGE"
3924 #: ../src/guestfs.pod:2035
3926 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3927 "which indicates that the guest and daemon is alive. This is what "
3928 "L</guestfs_launch> waits for."
3932 #: ../src/guestfs.pod:2039
3933 msgid "PROGRESS NOTIFICATION MESSAGES"
3937 #: ../src/guestfs.pod:2041
3939 "The daemon may send progress notification messages at any time. These are "
3940 "distinguished by the normal length word being replaced by "
3941 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3945 #: ../src/guestfs.pod:2045
3947 "The library turns them into progress callbacks (see "
3948 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3949 "discards them if not."
3953 #: ../src/guestfs.pod:2049
3955 "The daemon self-limits the frequency of progress messages it sends (see "
3956 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3961 #: ../src/guestfs.pod:2053
3962 msgid "LIBGUESTFS VERSION NUMBERS"
3966 #: ../src/guestfs.pod:2055
3968 "Since April 2010, libguestfs has started to make separate development and "
3969 "stable releases, along with corresponding branches in our git repository. "
3970 "These separate releases can be identified by version number:"
3974 #: ../src/guestfs.pod:2060
3977 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3978 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3984 " | `-------- sub-version\n"
3986 " `------ always '1' because we don't change the ABI\n"
3991 #: ../src/guestfs.pod:2071
3992 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3996 #: ../src/guestfs.pod:2073
3998 "As time passes we cherry pick fixes from the development branch and backport "
3999 "those into the stable branch, the effect being that the stable branch should "
4000 "get more stable and less buggy over time. So the stable releases are ideal "
4001 "for people who don't need new features but would just like the software to "
4006 #: ../src/guestfs.pod:2079
4007 msgid "Our criteria for backporting changes are:"
4011 #: ../src/guestfs.pod:2085
4013 "Documentation changes which don't affect any code are backported unless the "
4014 "documentation refers to a future feature which is not in stable."
4018 #: ../src/guestfs.pod:2091
4020 "Bug fixes which are not controversial, fix obvious problems, and have been "
4021 "well tested are backported."
4025 #: ../src/guestfs.pod:2096
4027 "Simple rearrangements of code which shouldn't affect how it works get "
4028 "backported. This is so that the code in the two branches doesn't get too "
4029 "far out of step, allowing us to backport future fixes more easily."
4033 #: ../src/guestfs.pod:2102
4035 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4036 "exceptional case: the new feature is required in order to implement an "
4037 "important bug fix."
4041 #: ../src/guestfs.pod:2108
4043 "A new stable branch starts when we think the new features in development are "
4044 "substantial and compelling enough over the current stable branch to warrant "
4045 "it. When that happens we create new stable and development versions 1.N.0 "
4046 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4047 "stable at this point, but by backporting fixes from development, that branch "
4048 "will stabilize over time."
4052 #: ../src/guestfs.pod:2116
4053 msgid "EXTENDING LIBGUESTFS"
4057 #: ../src/guestfs.pod:2118
4058 msgid "ADDING A NEW API ACTION"
4062 #: ../src/guestfs.pod:2120
4064 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4065 "documentation) are generated, and this makes it easy to extend the "
4070 #: ../src/guestfs.pod:2124
4071 msgid "To add a new API action there are two changes:"
4075 #: ../src/guestfs.pod:2130
4077 "You need to add a description of the call (name, parameters, return type, "
4078 "tests, documentation) to C<generator/generator_actions.ml>."
4082 #: ../src/guestfs.pod:2133
4084 "There are two sorts of API action, depending on whether the call goes "
4085 "through to the daemon in the appliance, or is serviced entirely by the "
4086 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4087 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4088 "an example of the latter, since a trace flag is maintained in the handle and "
4089 "all tracing is done on the library side."
4093 #: ../src/guestfs.pod:2141
4095 "Most new actions are of the first type, and get added to the "
4096 "C<daemon_functions> list. Each function has a unique procedure number used "
4097 "in the RPC protocol which is assigned to that action when we publish "
4098 "libguestfs and cannot be reused. Take the latest procedure number and "
4103 #: ../src/guestfs.pod:2147
4105 "For library-only actions of the second type, add to the "
4106 "C<non_daemon_functions> list. Since these functions are serviced by the "
4107 "library and do not travel over the RPC mechanism to the daemon, these "
4108 "functions do not need a procedure number, and so the procedure number is set "
4113 #: ../src/guestfs.pod:2155
4114 msgid "Implement the action (in C):"
4118 #: ../src/guestfs.pod:2157
4120 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4121 "C<daemon/> directory."
4125 #: ../src/guestfs.pod:2160
4127 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4128 "(note: double underscore) in the C<src/> directory."
4132 #: ../src/guestfs.pod:2163
4133 msgid "In either case, use another function as an example of what to do."
4137 #: ../src/guestfs.pod:2167
4138 msgid "After making these changes, use C<make> to compile."
4142 #: ../src/guestfs.pod:2169
4144 "Note that you don't need to implement the RPC, language bindings, manual "
4145 "pages or anything else. It's all automatically generated from the OCaml "
4150 #: ../src/guestfs.pod:2173
4151 msgid "ADDING TESTS FOR AN API ACTION"
4155 #: ../src/guestfs.pod:2175
4157 "You can supply zero or as many tests as you want per API call. The tests "
4158 "can either be added as part of the API description "
4159 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4160 "drop a script into C<regressions/>. Note that adding a script to "
4161 "C<regressions/> is slower, so if possible use the first method."
4165 #: ../src/guestfs.pod:2181
4167 "The following describes the test environment used when you add an API test "
4168 "in C<generator_actions.ml>."
4172 #: ../src/guestfs.pod:2184
4173 msgid "The test environment has 4 block devices:"
4177 #: ../src/guestfs.pod:2188
4178 msgid "C</dev/sda> 500MB"
4182 #: ../src/guestfs.pod:2190
4183 msgid "General block device for testing."
4187 #: ../src/guestfs.pod:2192
4188 msgid "C</dev/sdb> 50MB"
4192 #: ../src/guestfs.pod:2194
4194 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4199 #: ../src/guestfs.pod:2197
4200 msgid "C</dev/sdc> 10MB"
4204 #: ../src/guestfs.pod:2199
4205 msgid "Used in a few tests where two block devices are needed."
4209 #: ../src/guestfs.pod:2201
4214 #: ../src/guestfs.pod:2203
4215 msgid "ISO with fixed content (see C<images/test.iso>)."
4219 #: ../src/guestfs.pod:2207
4221 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4222 "appliance and block devices are reused between tests. So don't try testing "
4223 "L</guestfs_kill_subprocess> :-x"
4227 #: ../src/guestfs.pod:2211
4229 "Each test starts with an initial scenario, selected using one of the "
4230 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4231 "initialize the disks mentioned above in a particular way as documented in "
4232 "C<generator_types.ml>. You should not assume anything about the previous "
4233 "contents of other disks that are not initialized."
4237 #: ../src/guestfs.pod:2217
4239 "You can add a prerequisite clause to any individual test. This is a "
4240 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4241 "if testing a command which might not work on all variations of libguestfs "
4242 "builds. A test that has prerequisite of C<Always> means to run "
4247 #: ../src/guestfs.pod:2223
4249 "In addition, packagers can skip individual tests by setting environment "
4250 "variables before running C<make check>."
4254 #: ../src/guestfs.pod:2226
4257 " SKIP_TEST_<CMD>_<NUM>=1\n"
4262 #: ../src/guestfs.pod:2228
4263 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4267 #: ../src/guestfs.pod:2230
4272 #: ../src/guestfs.pod:2232
4275 " SKIP_TEST_<CMD>=1\n"
4280 #: ../src/guestfs.pod:2234
4281 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4285 #: ../src/guestfs.pod:2236
4286 msgid "Packagers can run only certain tests by setting for example:"
4290 #: ../src/guestfs.pod:2238
4293 " TEST_ONLY=\"vfs_type zerofree\"\n"
4298 #: ../src/guestfs.pod:2240
4300 "See C<capitests/tests.c> for more details of how these environment variables "
4305 #: ../src/guestfs.pod:2243
4306 msgid "DEBUGGING NEW API ACTIONS"
4310 #: ../src/guestfs.pod:2245
4311 msgid "Test new actions work before submitting them."
4315 #: ../src/guestfs.pod:2247
4316 msgid "You can use guestfish to try out new commands."
4320 #: ../src/guestfs.pod:2249
4322 "Debugging the daemon is a problem because it runs inside a minimal "
4323 "environment. However you can fprintf messages in the daemon to stderr, and "
4324 "they will show up if you use C<guestfish -v>."
4328 #: ../src/guestfs.pod:2253
4329 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4333 #: ../src/guestfs.pod:2255
4335 "Our C source code generally adheres to some basic code-formatting "
4336 "conventions. The existing code base is not totally consistent on this "
4337 "front, but we do prefer that contributed code be formatted similarly. In "
4338 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4339 "indentation level, and other than that, follow the K&R style."
4343 #: ../src/guestfs.pod:2261
4345 "If you use Emacs, add the following to one of one of your start-up files "
4346 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4350 #: ../src/guestfs.pod:2264
4353 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4354 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4355 " (add-hook 'find-file-hook\n"
4356 " '(lambda () (if (and buffer-file-name\n"
4357 " (string-match \"/libguestfs\\\\>\"\n"
4358 " (buffer-file-name))\n"
4359 " (not (string-equal mode-name \"Change Log\"))\n"
4360 " (not (string-equal mode-name \"Makefile\")))\n"
4361 " (setq indent-tabs-mode nil))))\n"
4366 #: ../src/guestfs.pod:2274
4369 " ;;; When editing C sources in libguestfs, use this style.\n"
4370 " (defun libguestfs-c-mode ()\n"
4371 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4373 " (c-set-style \"K&R\")\n"
4374 " (setq c-indent-level 2)\n"
4375 " (setq c-basic-offset 2))\n"
4376 " (add-hook 'c-mode-hook\n"
4377 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4378 " (buffer-file-name))\n"
4379 " (libguestfs-c-mode))))\n"
4384 #: ../src/guestfs.pod:2286
4385 msgid "Enable warnings when compiling (and fix any problems this finds):"
4389 #: ../src/guestfs.pod:2289
4392 " ./configure --enable-gcc-warnings\n"
4397 #: ../src/guestfs.pod:2291
4398 msgid "Useful targets are:"
4402 #: ../src/guestfs.pod:2293
4405 " make syntax-check # checks the syntax of the C code\n"
4406 " make check # runs the test suite\n"
4411 #: ../src/guestfs.pod:2296
4412 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4416 #: ../src/guestfs.pod:2298
4418 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4419 "which are used to do shell quoting."
4423 #: ../src/guestfs.pod:2303
4428 #: ../src/guestfs.pod:2305
4430 "Simple shell quoted string. Any spaces or other shell characters are "
4435 #: ../src/guestfs.pod:2308
4440 #: ../src/guestfs.pod:2310
4442 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4447 #: ../src/guestfs.pod:2315 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4448 msgid "For example:"
4452 #: ../src/guestfs.pod:2317
4455 " asprintf (&cmd, \"cat %R\", path);\n"
4460 #: ../src/guestfs.pod:2319
4461 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4465 #: ../src/guestfs.pod:2321
4467 "I<Note:> Do I<not> use these when you are passing parameters to the "
4468 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4469 "because they are not passed via the shell (instead, straight to exec). You "
4470 "probably want to use the C<sysroot_path()> function however."
4474 #: ../src/guestfs.pod:2327
4475 msgid "SUBMITTING YOUR NEW API ACTIONS"
4479 #: ../src/guestfs.pod:2329
4481 "Submit patches to the mailing list: "
4482 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
4483 "L<rjones@redhat.com>."
4487 #: ../src/guestfs.pod:2333
4488 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
4492 #: ../src/guestfs.pod:2335
4493 msgid "We support i18n (gettext anyhow) in the library."
4497 #: ../src/guestfs.pod:2337
4499 "However many messages come from the daemon, and we don't translate those at "
4500 "the moment. One reason is that the appliance generally has all locale files "
4501 "removed from it, because they take up a lot of space. So we'd have to readd "
4502 "some of those, as well as copying our PO files into the appliance."
4506 #: ../src/guestfs.pod:2343
4508 "Debugging messages are never translated, since they are intended for the "
4513 #: ../src/guestfs.pod:2346
4514 msgid "SOURCE CODE SUBDIRECTORIES"
4518 #: ../src/guestfs.pod:2350
4519 msgid "C<appliance>"
4523 #: ../src/guestfs.pod:2352
4524 msgid "The libguestfs appliance, build scripts and so on."
4528 #: ../src/guestfs.pod:2354
4529 msgid "C<capitests>"
4533 #: ../src/guestfs.pod:2356
4534 msgid "Automated tests of the C API."
4538 #: ../src/guestfs.pod:2358
4543 #: ../src/guestfs.pod:2360
4545 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
4550 #: ../src/guestfs.pod:2363
4555 #: ../src/guestfs.pod:2365
4556 msgid "Outside contributions, experimental parts."
4560 #: ../src/guestfs.pod:2367
4565 #: ../src/guestfs.pod:2369
4567 "The daemon that runs inside the libguestfs appliance and carries out "
4572 #: ../src/guestfs.pod:2372
4577 #: ../src/guestfs.pod:2374
4578 msgid "L<virt-df(1)> command and documentation."
4582 #: ../src/guestfs.pod:2376
4587 #: ../src/guestfs.pod:2378
4588 msgid "C API example code."
4592 #: ../src/guestfs.pod:2380
4597 #: ../src/guestfs.pod:2382
4599 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
4600 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
4601 "L<virt-tar-out(1)>."
4605 #: ../src/guestfs.pod:2386
4610 #: ../src/guestfs.pod:2388
4611 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
4615 #: ../src/guestfs.pod:2390
4616 msgid "C<generator>"
4620 #: ../src/guestfs.pod:2392
4622 "The crucially important generator, used to automatically generate large "
4623 "amounts of boilerplate C code for things like RPC and bindings."
4627 #: ../src/guestfs.pod:2395
4632 #: ../src/guestfs.pod:2397
4633 msgid "Files used by the test suite."
4637 #: ../src/guestfs.pod:2399
4638 msgid "Some \"phony\" guest images which we test against."
4642 #: ../src/guestfs.pod:2401
4643 msgid "C<inspector>"
4647 #: ../src/guestfs.pod:2403
4648 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
4652 #: ../src/guestfs.pod:2405
4657 #: ../src/guestfs.pod:2407
4658 msgid "Logo used on the website. The fish is called Arthur by the way."
4662 #: ../src/guestfs.pod:2409
4667 #: ../src/guestfs.pod:2411
4668 msgid "M4 macros used by autoconf."
4672 #: ../src/guestfs.pod:2413
4677 #: ../src/guestfs.pod:2415
4678 msgid "Translations of simple gettext strings."
4682 #: ../src/guestfs.pod:2417
4687 #: ../src/guestfs.pod:2419
4689 "The build infrastructure and PO files for translations of manpages and POD "
4690 "files. Eventually this will be combined with the C<po> directory, but that "
4691 "is rather complicated."
4695 #: ../src/guestfs.pod:2423
4696 msgid "C<regressions>"
4700 #: ../src/guestfs.pod:2425
4701 msgid "Regression tests."
4705 #: ../src/guestfs.pod:2427
4710 #: ../src/guestfs.pod:2429
4711 msgid "L<virt-rescue(1)> command and documentation."
4715 #: ../src/guestfs.pod:2431
4720 #: ../src/guestfs.pod:2433
4721 msgid "Source code to the C library."
4725 #: ../src/guestfs.pod:2435
4730 #: ../src/guestfs.pod:2437
4731 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
4735 #: ../src/guestfs.pod:2439
4736 msgid "C<test-tool>"
4740 #: ../src/guestfs.pod:2441
4742 "Test tool for end users to test if their qemu/kernel combination will work "
4747 #: ../src/guestfs.pod:2444
4752 #: ../src/guestfs.pod:2446
4757 #: ../src/guestfs.pod:2448
4762 #: ../src/guestfs.pod:2450
4767 #: ../src/guestfs.pod:2452
4772 #: ../src/guestfs.pod:2454
4777 #: ../src/guestfs.pod:2456
4782 #: ../src/guestfs.pod:2458
4787 #: ../src/guestfs.pod:2460
4788 msgid "Language bindings."
4792 #: ../src/guestfs.pod:2464 ../fish/guestfish.pod:991 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
4793 msgid "ENVIRONMENT VARIABLES"
4797 #: ../src/guestfs.pod:2468 ../fish/guestfish.pod:1017
4798 msgid "LIBGUESTFS_APPEND"
4802 #: ../src/guestfs.pod:2470 ../fish/guestfish.pod:1019
4803 msgid "Pass additional options to the guest kernel."
4807 #: ../src/guestfs.pod:2472 ../fish/guestfish.pod:1021
4808 msgid "LIBGUESTFS_DEBUG"
4812 #: ../src/guestfs.pod:2474
4814 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
4815 "effect as calling C<guestfs_set_verbose (g, 1)>."
4819 #: ../src/guestfs.pod:2477 ../fish/guestfish.pod:1026
4820 msgid "LIBGUESTFS_MEMSIZE"
4824 #: ../src/guestfs.pod:2479 ../fish/guestfish.pod:1028
4825 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
4829 #: ../src/guestfs.pod:2482 ../fish/guestfish.pod:1031
4832 " LIBGUESTFS_MEMSIZE=700\n"
4837 #: ../src/guestfs.pod:2484 ../fish/guestfish.pod:1033
4838 msgid "LIBGUESTFS_PATH"
4842 #: ../src/guestfs.pod:2486
4844 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
4845 "the discussion of paths in section PATH above."
4849 #: ../src/guestfs.pod:2489 ../fish/guestfish.pod:1038
4850 msgid "LIBGUESTFS_QEMU"
4854 #: ../src/guestfs.pod:2491 ../fish/guestfish.pod:1040
4856 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4857 "which was found at compile time by the configure script is used."
4861 #: ../src/guestfs.pod:2495
4862 msgid "See also L</QEMU WRAPPERS> above."
4866 #: ../src/guestfs.pod:2497 ../fish/guestfish.pod:1044
4867 msgid "LIBGUESTFS_TRACE"
4871 #: ../src/guestfs.pod:2499
4873 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4874 "effect as calling C<guestfs_set_trace (g, 1)>."
4878 #: ../src/guestfs.pod:2502 ../fish/guestfish.pod:1053
4883 #: ../src/guestfs.pod:2504 ../fish/guestfish.pod:1055
4885 "Location of temporary directory, defaults to C</tmp> except for the cached "
4886 "supermin appliance which defaults to C</var/tmp>."
4890 #: ../src/guestfs.pod:2507 ../fish/guestfish.pod:1058
4892 "If libguestfs was compiled to use the supermin appliance then the real "
4893 "appliance is cached in this directory, shared between all handles belonging "
4894 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4895 "use in case C</var/tmp> is not large enough."
4899 #: ../src/guestfs.pod:2515 ../fish/guestfish.pod:1116 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572 ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
4904 #: ../src/guestfs.pod:2517
4906 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4907 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4908 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
4909 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4910 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4911 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
4912 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
4913 "L<http://libguestfs.org/>."
4917 #: ../src/guestfs.pod:2544
4919 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4920 "L<lvm(8)>, L<disktype(1)>."
4924 #: ../src/guestfs.pod:2551 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:548
4929 #: ../src/guestfs.pod:2553
4930 msgid "To get a list of bugs against libguestfs use this link:"
4934 #: ../src/guestfs.pod:2555
4935 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4939 #: ../src/guestfs.pod:2557
4940 msgid "To report a new bug against libguestfs use this link:"
4944 #: ../src/guestfs.pod:2559
4945 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4949 #: ../src/guestfs.pod:2561
4950 msgid "When reporting a bug, please check:"
4954 #: ../src/guestfs.pod:2567
4955 msgid "That the bug hasn't been reported already."
4959 #: ../src/guestfs.pod:2571
4960 msgid "That you are testing a recent version."
4964 #: ../src/guestfs.pod:2575
4965 msgid "Describe the bug accurately, and give a way to reproduce it."
4969 #: ../src/guestfs.pod:2579
4971 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4976 #: ../src/guestfs.pod:2584 ../fish/guestfish.pod:1139 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4981 #: ../src/guestfs.pod:2586 ../fish/guestfish.pod:1141 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4982 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4986 #: ../src/guestfs.pod:2588 ../fish/guestfish.pod:1143 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:368 ../tools/virt-win-reg.pl:602 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
4991 #: ../src/guestfs.pod:2590 ../fish/guestfish.pod:1145 ../fuse/guestmount.pod:250
4992 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4996 #: ../src/guestfs.pod:2593
4998 "This library is free software; you can redistribute it and/or modify it "
4999 "under the terms of the GNU Lesser General Public License as published by the "
5000 "Free Software Foundation; either version 2 of the License, or (at your "
5001 "option) any later version."
5005 #: ../src/guestfs.pod:2598
5007 "This library is distributed in the hope that it will be useful, but WITHOUT "
5008 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5009 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5014 #: ../src/guestfs.pod:2603
5016 "You should have received a copy of the GNU Lesser General Public License "
5017 "along with this library; if not, write to the Free Software Foundation, "
5018 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5022 #: ../src/guestfs-actions.pod:1
5023 msgid "guestfs_add_cdrom"
5027 #: ../src/guestfs-actions.pod:3
5031 " guestfs_add_cdrom (guestfs_h *g,\n"
5032 " const char *filename);\n"
5037 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5038 msgid "This function adds a virtual CD-ROM disk image to the guest."
5042 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5043 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5047 #: ../src/guestfs-actions.pod:17
5049 "This call checks for the existence of C<filename>. This stops you from "
5050 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5051 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5056 #: ../src/guestfs-actions.pod:24
5058 "If you just want to add an ISO file (often you use this as an efficient way "
5059 "to transfer large files into the guest), then you should probably use "
5060 "C<guestfs_add_drive_ro> instead."
5064 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262 ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448 ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3318 ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3522 ../src/guestfs-actions.pod:3535 ../src/guestfs-actions.pod:3549 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:3672 ../src/guestfs-actions.pod:3692 ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:3755 ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3806 ../src/guestfs-actions.pod:3825 ../src/guestfs-actions.pod:3860 ../src/guestfs-actions.pod:3872 ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:3937 ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:4062 ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:4095 ../src/guestfs-actions.pod:4146 ../src/guestfs-actions.pod:4164 ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:4198 ../src/guestfs-actions.pod:4212 ../src/guestfs-actions.pod:4226 ../src/guestfs-actions.pod:4243 ../src/guestfs-actions.pod:4258 ../src/guestfs-actions.pod:4278 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4409 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4459 ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:4490 ../src/guestfs-actions.pod:4507 ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4535 ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4585 ../src/guestfs-actions.pod:4600 ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4634 ../src/guestfs-actions.pod:4651 ../src/guestfs-actions.pod:4700 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:4751 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4796 ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4948 ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5027 ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5077 ../src/guestfs-actions.pod:5143 ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5173 ../src/guestfs-actions.pod:5187 ../src/guestfs-actions.pod:5476 ../src/guestfs-actions.pod:5495 ../src/guestfs-actions.pod:5514 ../src/guestfs-actions.pod:5526 ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5552 ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:5578 ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5615 ../src/guestfs-actions.pod:5634 ../src/guestfs-actions.pod:5653 ../src/guestfs-actions.pod:5671 ../src/guestfs-actions.pod:5694 ../src/guestfs-actions.pod:5712 ../src/guestfs-actions.pod:5731 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5788 ../src/guestfs-actions.pod:5816 ../src/guestfs-actions.pod:5840 ../src/guestfs-actions.pod:5859 ../src/guestfs-actions.pod:5883 ../src/guestfs-actions.pod:5898 ../src/guestfs-actions.pod:5913 ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:5969 ../src/guestfs-actions.pod:5992 ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6126 ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6259 ../src/guestfs-actions.pod:6272 ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6333 ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6361 ../src/guestfs-actions.pod:6420 ../src/guestfs-actions.pod:6437 ../src/guestfs-actions.pod:6453 ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:6486 ../src/guestfs-actions.pod:6499 ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6569 ../src/guestfs-actions.pod:6610 ../src/guestfs-actions.pod:6623 ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:6675 ../src/guestfs-actions.pod:6711 ../src/guestfs-actions.pod:6830 ../src/guestfs-actions.pod:6848 ../src/guestfs-actions.pod:6862 ../src/guestfs-actions.pod:6917 ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:6975 ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7062 ../src/guestfs-actions.pod:7088 ../src/guestfs-actions.pod:7154 ../src/guestfs-actions.pod:7173 ../src/guestfs-actions.pod:7202
5065 msgid "This function returns 0 on success or -1 on error."
5069 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
5071 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5076 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942 ../src/guestfs-actions.pod:4283 ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7265 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168 ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1306 ../fish/guestfish-actions.pod:1320 ../fish/guestfish-actions.pod:2895 ../fish/guestfish-actions.pod:4723 ../fish/guestfish-actions.pod:4820
5078 "Deprecated functions will not be removed from the API, but the fact that "
5079 "they are deprecated indicates that there are problems with correct use of "
5084 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:4587 ../src/guestfs-actions.pod:5673 ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5900 ../src/guestfs-actions.pod:6363 ../src/guestfs-actions.pod:6488 ../src/guestfs-actions.pod:7010
5085 msgid "(Added in 0.3)"
5089 #: ../src/guestfs-actions.pod:41
5090 msgid "guestfs_add_domain"
5094 #: ../src/guestfs-actions.pod:43
5098 " guestfs_add_domain (guestfs_h *g,\n"
5099 " const char *dom,\n"
5105 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137 ../src/guestfs-actions.pod:4297
5107 "You may supply a list of optional arguments to this call. Use zero or more "
5108 "of the following pairs of parameters, and terminate the list with C<-1> on "
5109 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5113 #: ../src/guestfs-actions.pod:53
5116 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5117 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5118 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5123 #: ../src/guestfs-actions.pod:57
5125 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5126 "It works by connecting to libvirt, requesting the domain and domain XML from "
5127 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5132 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5134 "The number of disks added is returned. This operation is atomic: if an "
5135 "error is returned, then no disks are added."
5139 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5141 "This function does some minimal checks to make sure the libvirt domain is "
5142 "not running (unless C<readonly> is true). In a future version we will try "
5143 "to acquire the libvirt lock on each disk."
5147 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5149 "Disks must be accessible locally. This often means that adding disks from a "
5150 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5151 "unless those disks are accessible via the same device path locally too."
5155 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5157 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5158 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5159 "default libvirt URI (or one set through an environment variable, see the "
5160 "libvirt documentation for full details)."
5164 #: ../src/guestfs-actions.pod:80
5166 "The other optional parameters are passed directly through to "
5167 "C<guestfs_add_drive_opts>."
5171 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003 ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2701 ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:4723 ../src/guestfs-actions.pod:4851 ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:6596 ../src/guestfs-actions.pod:7021 ../src/guestfs-actions.pod:7034 ../src/guestfs-actions.pod:7047
5172 msgid "On error this function returns -1."
5176 #: ../src/guestfs-actions.pod:85
5177 msgid "(Added in 1.7.4)"
5181 #: ../src/guestfs-actions.pod:87
5182 msgid "guestfs_add_domain_va"
5186 #: ../src/guestfs-actions.pod:89
5190 " guestfs_add_domain_va (guestfs_h *g,\n"
5191 " const char *dom,\n"
5197 #: ../src/guestfs-actions.pod:94
5198 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5202 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4362
5203 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5207 #: ../src/guestfs-actions.pod:98
5208 msgid "guestfs_add_domain_argv"
5212 #: ../src/guestfs-actions.pod:100
5216 " guestfs_add_domain_argv (guestfs_h *g,\n"
5217 " const char *dom,\n"
5218 " const struct guestfs_add_domain_argv *optargs);\n"
5223 #: ../src/guestfs-actions.pod:105
5224 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5228 #: ../src/guestfs-actions.pod:109
5229 msgid "guestfs_add_drive"
5233 #: ../src/guestfs-actions.pod:111
5237 " guestfs_add_drive (guestfs_h *g,\n"
5238 " const char *filename);\n"
5243 #: ../src/guestfs-actions.pod:115
5245 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5246 "optional parameters, so the disk is added writable, with the format being "
5247 "detected automatically."
5251 #: ../src/guestfs-actions.pod:119
5253 "Automatic detection of the format opens you up to a potential security hole "
5254 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5255 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5256 "you should think about replacing calls to this function with calls to "
5257 "C<guestfs_add_drive_opts>, and specifying the format."
5261 #: ../src/guestfs-actions.pod:130
5262 msgid "guestfs_add_drive_opts"
5266 #: ../src/guestfs-actions.pod:132
5270 " guestfs_add_drive_opts (guestfs_h *g,\n"
5271 " const char *filename,\n"
5277 #: ../src/guestfs-actions.pod:142
5280 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5281 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5282 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5287 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
5289 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5290 "The first time you call this function, the disk appears as C</dev/sda>, the "
5291 "second time as C</dev/sdb>, and so on."
5295 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
5297 "You don't necessarily need to be root when using libguestfs. However you "
5298 "obviously do need sufficient permissions to access the filename for whatever "
5299 "operations you want to perform (ie. read access if you just want to read the "
5300 "image or write access if you want to modify the image)."
5304 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
5305 msgid "This call checks that C<filename> exists."
5309 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4308 ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2906
5310 msgid "The optional arguments are:"
5314 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
5319 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
5321 "If true then the image is treated as read-only. Writes are still allowed, "
5322 "but they are stored in a temporary snapshot overlay which is discarded at "
5323 "the end. The disk that you add is not modified."
5327 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
5332 #: ../src/guestfs-actions.pod:171
5334 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5335 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5336 "Possible formats include C<raw> and C<qcow2>."
5340 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
5342 "Automatic detection of the format opens you up to a potential security hole "
5343 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5344 "RHBZ#642934. Specifying the format closes this security hole."
5348 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
5353 #: ../src/guestfs-actions.pod:182
5355 "This rarely-used option lets you emulate the behaviour of the deprecated "
5356 "C<guestfs_add_drive_with_if> call (q.v.)"
5360 #: ../src/guestfs-actions.pod:189
5361 msgid "(Added in 1.5.23)"
5365 #: ../src/guestfs-actions.pod:191
5366 msgid "guestfs_add_drive_opts_va"
5370 #: ../src/guestfs-actions.pod:193
5374 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5375 " const char *filename,\n"
5381 #: ../src/guestfs-actions.pod:198
5382 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5386 #: ../src/guestfs-actions.pod:202
5387 msgid "guestfs_add_drive_opts_argv"
5391 #: ../src/guestfs-actions.pod:204
5395 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5396 " const char *filename,\n"
5397 " const struct guestfs_add_drive_opts_argv "
5403 #: ../src/guestfs-actions.pod:209
5404 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5408 #: ../src/guestfs-actions.pod:213
5409 msgid "guestfs_add_drive_ro"
5413 #: ../src/guestfs-actions.pod:215
5417 " guestfs_add_drive_ro (guestfs_h *g,\n"
5418 " const char *filename);\n"
5423 #: ../src/guestfs-actions.pod:219
5425 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5426 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5427 "disk is added read-only, with the format being detected automatically."
5431 #: ../src/guestfs-actions.pod:226
5432 msgid "(Added in 1.0.38)"
5436 #: ../src/guestfs-actions.pod:228
5437 msgid "guestfs_add_drive_ro_with_if"
5441 #: ../src/guestfs-actions.pod:230
5445 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
5446 " const char *filename,\n"
5447 " const char *iface);\n"
5452 #: ../src/guestfs-actions.pod:235
5454 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
5455 "QEMU interface emulation to use at run time."
5459 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2333
5460 msgid "(Added in 1.0.84)"
5464 #: ../src/guestfs-actions.pod:249
5465 msgid "guestfs_add_drive_with_if"
5469 #: ../src/guestfs-actions.pod:251
5473 " guestfs_add_drive_with_if (guestfs_h *g,\n"
5474 " const char *filename,\n"
5475 " const char *iface);\n"
5480 #: ../src/guestfs-actions.pod:256
5482 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
5483 "QEMU interface emulation to use at run time."
5487 #: ../src/guestfs-actions.pod:270
5488 msgid "guestfs_aug_clear"
5492 #: ../src/guestfs-actions.pod:272
5496 " guestfs_aug_clear (guestfs_h *g,\n"
5497 " const char *augpath);\n"
5502 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
5504 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5505 "L<augtool(1)> C<clear> command."
5509 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
5510 msgid "(Added in 1.3.4)"
5514 #: ../src/guestfs-actions.pod:283
5515 msgid "guestfs_aug_close"
5519 #: ../src/guestfs-actions.pod:285
5523 " guestfs_aug_close (guestfs_h *g);\n"
5528 #: ../src/guestfs-actions.pod:288
5530 "Close the current Augeas handle and free up any resources used by it. After "
5531 "calling this, you have to call C<guestfs_aug_init> again before you can use "
5532 "any other Augeas functions."
5536 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:5334
5537 msgid "(Added in 0.7)"
5541 #: ../src/guestfs-actions.pod:297
5542 msgid "guestfs_aug_defnode"
5546 #: ../src/guestfs-actions.pod:299
5549 " struct guestfs_int_bool *\n"
5550 " guestfs_aug_defnode (guestfs_h *g,\n"
5551 " const char *name,\n"
5552 " const char *expr,\n"
5553 " const char *val);\n"
5558 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
5559 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5563 #: ../src/guestfs-actions.pod:308
5565 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5566 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
5567 "containing that single node."
5571 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
5573 "On success this returns a pair containing the number of nodes in the "
5574 "nodeset, and a boolean flag if a node was created."
5578 #: ../src/guestfs-actions.pod:316
5580 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
5581 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
5585 #: ../src/guestfs-actions.pod:322
5586 msgid "guestfs_aug_defvar"
5590 #: ../src/guestfs-actions.pod:324
5594 " guestfs_aug_defvar (guestfs_h *g,\n"
5595 " const char *name,\n"
5596 " const char *expr);\n"
5601 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
5603 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5604 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5608 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
5610 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5611 "evaluates to something which is not a nodeset."
5615 #: ../src/guestfs-actions.pod:340
5616 msgid "guestfs_aug_get"
5620 #: ../src/guestfs-actions.pod:342
5624 " guestfs_aug_get (guestfs_h *g,\n"
5625 " const char *augpath);\n"
5630 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
5632 "Look up the value associated with C<path>. If C<path> matches exactly one "
5633 "node, the C<value> is returned."
5637 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341 ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2653 ../src/guestfs-actions.pod:2673 ../src/guestfs-actions.pod:2787 ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:2842 ../src/guestfs-actions.pod:2904 ../src/guestfs-actions.pod:2927 ../src/guestfs-actions.pod:3494 ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5410 ../src/guestfs-actions.pod:5459 ../src/guestfs-actions.pod:6039 ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6072 ../src/guestfs-actions.pod:6096 ../src/guestfs-actions.pod:6770 ../src/guestfs-actions.pod:6789 ../src/guestfs-actions.pod:6807 ../src/guestfs-actions.pod:6987 ../src/guestfs-actions.pod:7259
5639 "This function returns a string, or NULL on error. I<The caller must free "
5640 "the returned string after use>."
5644 #: ../src/guestfs-actions.pod:354
5645 msgid "guestfs_aug_init"
5649 #: ../src/guestfs-actions.pod:356
5653 " guestfs_aug_init (guestfs_h *g,\n"
5654 " const char *root,\n"
5660 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
5662 "Create a new Augeas handle for editing configuration files. If there was "
5663 "any previous Augeas handle associated with this guestfs session, then it is "
5668 #: ../src/guestfs-actions.pod:365
5669 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5673 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
5674 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5678 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
5680 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5681 "logical I<or> of the following integers:"
5685 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
5686 msgid "C<AUG_SAVE_BACKUP> = 1"
5690 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
5691 msgid "Keep the original file with a C<.augsave> extension."
5695 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
5696 msgid "C<AUG_SAVE_NEWFILE> = 2"
5700 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
5702 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5703 "original. Overrides C<AUG_SAVE_BACKUP>."
5707 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
5708 msgid "C<AUG_TYPE_CHECK> = 4"
5712 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
5713 msgid "Typecheck lenses (can be expensive)."
5717 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
5718 msgid "C<AUG_NO_STDINC> = 8"
5722 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
5723 msgid "Do not use standard load path for modules."
5727 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
5728 msgid "C<AUG_SAVE_NOOP> = 16"
5732 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
5733 msgid "Make save a no-op, just record what would have been changed."
5737 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
5738 msgid "C<AUG_NO_LOAD> = 32"
5742 #: ../src/guestfs-actions.pod:400
5743 msgid "Do not load the tree in C<guestfs_aug_init>."
5747 #: ../src/guestfs-actions.pod:404
5748 msgid "To close the handle, you can call C<guestfs_aug_close>."
5752 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:270
5753 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5757 #: ../src/guestfs-actions.pod:412
5758 msgid "guestfs_aug_insert"
5762 #: ../src/guestfs-actions.pod:414
5766 " guestfs_aug_insert (guestfs_h *g,\n"
5767 " const char *augpath,\n"
5768 " const char *label,\n"
5774 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:276
5776 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5777 "or after C<path> (depending on the boolean flag C<before>)."
5781 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:280
5783 "C<path> must match exactly one existing node in the tree, and C<label> must "
5784 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5788 #: ../src/guestfs-actions.pod:432
5789 msgid "guestfs_aug_load"
5793 #: ../src/guestfs-actions.pod:434
5797 " guestfs_aug_load (guestfs_h *g);\n"
5802 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:288
5803 msgid "Load files into the tree."
5807 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
5808 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5812 #: ../src/guestfs-actions.pod:446
5813 msgid "guestfs_aug_ls"
5817 #: ../src/guestfs-actions.pod:448
5821 " guestfs_aug_ls (guestfs_h *g,\n"
5822 " const char *augpath);\n"
5827 #: ../src/guestfs-actions.pod:452
5829 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5830 "sorting the resulting nodes into alphabetical order."
5834 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471 ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:2194 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2351 ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2861 ../src/guestfs-actions.pod:3129 ../src/guestfs-actions.pod:3414 ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:3581 ../src/guestfs-actions.pod:3986 ../src/guestfs-actions.pod:4684 ../src/guestfs-actions.pod:5204 ../src/guestfs-actions.pod:5330 ../src/guestfs-actions.pod:5444 ../src/guestfs-actions.pod:6112 ../src/guestfs-actions.pod:6173 ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6374 ../src/guestfs-actions.pod:6398 ../src/guestfs-actions.pod:6880 ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6947 ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7131 ../src/guestfs-actions.pod:7216 ../src/guestfs-actions.pod:7235 ../src/guestfs-actions.pod:7281 ../src/guestfs-actions.pod:7300
5836 "This function returns a NULL-terminated array of strings (like "
5837 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
5838 "strings and the array after use>."
5842 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:3207 ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:4064 ../src/guestfs-actions.pod:4097 ../src/guestfs-actions.pod:4260 ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5554 ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:5974 ../src/guestfs-actions.pod:6612 ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6864 ../src/guestfs-actions.pod:7100
5843 msgid "(Added in 0.8)"
5847 #: ../src/guestfs-actions.pod:461
5848 msgid "guestfs_aug_match"
5852 #: ../src/guestfs-actions.pod:463
5856 " guestfs_aug_match (guestfs_h *g,\n"
5857 " const char *augpath);\n"
5862 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:304
5864 "Returns a list of paths which match the path expression C<path>. The "
5865 "returned paths are sufficiently qualified so that they match exactly one "
5866 "node in the current tree."
5870 #: ../src/guestfs-actions.pod:477
5871 msgid "guestfs_aug_mv"
5875 #: ../src/guestfs-actions.pod:479
5879 " guestfs_aug_mv (guestfs_h *g,\n"
5880 " const char *src,\n"
5881 " const char *dest);\n"
5886 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:312
5888 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5889 "C<dest> is overwritten if it exists."
5893 #: ../src/guestfs-actions.pod:491
5894 msgid "guestfs_aug_rm"
5898 #: ../src/guestfs-actions.pod:493
5902 " guestfs_aug_rm (guestfs_h *g,\n"
5903 " const char *augpath);\n"
5908 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:319
5909 msgid "Remove C<path> and all of its children."
5913 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5914 msgid "On success this returns the number of entries which were removed."
5918 #: ../src/guestfs-actions.pod:505
5919 msgid "guestfs_aug_save"
5923 #: ../src/guestfs-actions.pod:507
5927 " guestfs_aug_save (guestfs_h *g);\n"
5932 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:327
5933 msgid "This writes all pending changes to disk."
5937 #: ../src/guestfs-actions.pod:512
5939 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5944 #: ../src/guestfs-actions.pod:519
5945 msgid "guestfs_aug_set"
5949 #: ../src/guestfs-actions.pod:521
5953 " guestfs_aug_set (guestfs_h *g,\n"
5954 " const char *augpath,\n"
5955 " const char *val);\n"
5960 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:336
5961 msgid "Set the value associated with C<path> to C<val>."
5965 #: ../src/guestfs-actions.pod:528
5967 "In the Augeas API, it is possible to clear a node by setting the value to "
5968 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5969 "this call. Instead you must use the C<guestfs_aug_clear> call."
5973 #: ../src/guestfs-actions.pod:537
5974 msgid "guestfs_available"
5978 #: ../src/guestfs-actions.pod:539
5982 " guestfs_available (guestfs_h *g,\n"
5983 " char *const *groups);\n"
5988 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:347
5990 "This command is used to check the availability of some groups of "
5991 "functionality in the appliance, which not all builds of the libguestfs "
5992 "appliance will be able to provide."
5996 #: ../src/guestfs-actions.pod:547
5998 "The libguestfs groups, and the functions that those groups correspond to, "
5999 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6000 "runtime by calling C<guestfs_available_all_groups>."
6004 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:356
6006 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6007 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6008 "and Augeas (configuration file editing) functions."
6012 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
6013 msgid "The command returns no error if I<all> requested groups are available."
6017 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
6019 "It fails with an error if one or more of the requested groups is unavailable "
6024 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
6026 "If an unknown group name is included in the list of groups then an error is "
6031 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:369
6036 #: ../src/guestfs-actions.pod:571
6037 msgid "You must call C<guestfs_launch> before calling this function."
6041 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:377
6043 "The reason is because we don't know what groups are supported by the "
6044 "appliance/daemon until it is running and can be queried."
6048 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:383
6050 "If a group of functions is available, this does not necessarily mean that "
6051 "they will work. You still have to check for errors when calling individual "
6052 "API functions even if they are available."
6056 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:390
6058 "It is usually the job of distro packagers to build complete functionality "
6059 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6060 "with all requirements satisfied, will support everything."
6064 #: ../src/guestfs-actions.pod:593
6066 "This call was added in version C<1.0.80>. In previous versions of "
6067 "libguestfs all you could do would be to speculatively execute a command to "
6068 "find out if the daemon implemented it. See also C<guestfs_version>."
6072 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
6073 msgid "(Added in 1.0.80)"
6077 #: ../src/guestfs-actions.pod:604
6078 msgid "guestfs_available_all_groups"
6082 #: ../src/guestfs-actions.pod:606
6086 " guestfs_available_all_groups (guestfs_h *g);\n"
6091 #: ../src/guestfs-actions.pod:609
6093 "This command returns a list of all optional groups that this daemon knows "
6094 "about. Note this returns both supported and unsupported groups. To find "
6095 "out which ones the daemon can actually support you have to call "
6096 "C<guestfs_available> on each member of the returned list."
6100 #: ../src/guestfs-actions.pod:615
6101 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6105 #: ../src/guestfs-actions.pod:621
6106 msgid "(Added in 1.3.15)"
6110 #: ../src/guestfs-actions.pod:623
6111 msgid "guestfs_base64_in"
6115 #: ../src/guestfs-actions.pod:625
6119 " guestfs_base64_in (guestfs_h *g,\n"
6120 " const char *base64file,\n"
6121 " const char *filename);\n"
6126 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:420
6127 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6131 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
6132 msgid "(Added in 1.3.5)"
6136 #: ../src/guestfs-actions.pod:637
6137 msgid "guestfs_base64_out"
6141 #: ../src/guestfs-actions.pod:639
6145 " guestfs_base64_out (guestfs_h *g,\n"
6146 " const char *filename,\n"
6147 " const char *base64file);\n"
6152 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:429
6154 "This command downloads the contents of C<filename>, writing it out to local "
6155 "file C<base64file> encoded as base64."
6159 #: ../src/guestfs-actions.pod:651
6160 msgid "guestfs_blockdev_flushbufs"
6164 #: ../src/guestfs-actions.pod:653
6168 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6169 " const char *device);\n"
6174 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:438
6175 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6179 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:441 ../fish/guestfish-actions.pod:452 ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:471 ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:496 ../fish/guestfish-actions.pod:504 ../fish/guestfish-actions.pod:515 ../fish/guestfish-actions.pod:523 ../fish/guestfish-actions.pod:531
6180 msgid "This uses the L<blockdev(8)> command."
6184 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
6185 msgid "(Added in 0.9.3)"
6189 #: ../src/guestfs-actions.pod:666
6190 msgid "guestfs_blockdev_getbsz"
6194 #: ../src/guestfs-actions.pod:668
6198 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6199 " const char *device);\n"
6204 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:447
6205 msgid "This returns the block size of a device."
6209 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:512
6211 "(Note this is different from both I<size in blocks> and I<filesystem block "
6216 #: ../src/guestfs-actions.pod:683
6217 msgid "guestfs_blockdev_getro"
6221 #: ../src/guestfs-actions.pod:685
6225 " guestfs_blockdev_getro (guestfs_h *g,\n"
6226 " const char *device);\n"
6231 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:458
6233 "Returns a boolean indicating if the block device is read-only (true if "
6234 "read-only, false if not)."
6238 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2947 ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3160 ../src/guestfs-actions.pod:3175 ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3220 ../src/guestfs-actions.pod:3236 ../src/guestfs-actions.pod:3250 ../src/guestfs-actions.pod:3263 ../src/guestfs-actions.pod:3277 ../src/guestfs-actions.pod:3292 ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:4833
6239 msgid "This function returns a C truth value on success or -1 on error."
6243 #: ../src/guestfs-actions.pod:698
6244 msgid "guestfs_blockdev_getsize64"
6248 #: ../src/guestfs-actions.pod:700
6252 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6253 " const char *device);\n"
6258 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:467
6259 msgid "This returns the size of the device in bytes."
6263 #: ../src/guestfs-actions.pod:706
6264 msgid "See also C<guestfs_blockdev_getsz>."
6268 #: ../src/guestfs-actions.pod:714
6269 msgid "guestfs_blockdev_getss"
6273 #: ../src/guestfs-actions.pod:716
6277 " guestfs_blockdev_getss (guestfs_h *g,\n"
6278 " const char *device);\n"
6283 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:477
6285 "This returns the size of sectors on a block device. Usually 512, but can be "
6286 "larger for modern devices."
6290 #: ../src/guestfs-actions.pod:723
6292 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6297 #: ../src/guestfs-actions.pod:732
6298 msgid "guestfs_blockdev_getsz"
6302 #: ../src/guestfs-actions.pod:734
6306 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6307 " const char *device);\n"
6312 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:489
6314 "This returns the size of the device in units of 512-byte sectors (even if "
6315 "the sectorsize isn't 512 bytes ... weird)."
6319 #: ../src/guestfs-actions.pod:741
6321 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6322 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6326 #: ../src/guestfs-actions.pod:751
6327 msgid "guestfs_blockdev_rereadpt"
6331 #: ../src/guestfs-actions.pod:753
6335 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6336 " const char *device);\n"
6341 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:502
6342 msgid "Reread the partition table on C<device>."
6346 #: ../src/guestfs-actions.pod:765
6347 msgid "guestfs_blockdev_setbsz"
6351 #: ../src/guestfs-actions.pod:767
6355 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6356 " const char *device,\n"
6357 " int blocksize);\n"
6362 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:510
6363 msgid "This sets the block size of a device."
6367 #: ../src/guestfs-actions.pod:783
6368 msgid "guestfs_blockdev_setro"
6372 #: ../src/guestfs-actions.pod:785
6376 " guestfs_blockdev_setro (guestfs_h *g,\n"
6377 " const char *device);\n"
6382 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:521
6383 msgid "Sets the block device named C<device> to read-only."
6387 #: ../src/guestfs-actions.pod:797
6388 msgid "guestfs_blockdev_setrw"
6392 #: ../src/guestfs-actions.pod:799
6396 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6397 " const char *device);\n"
6402 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:529
6403 msgid "Sets the block device named C<device> to read-write."
6407 #: ../src/guestfs-actions.pod:811
6408 msgid "guestfs_case_sensitive_path"
6412 #: ../src/guestfs-actions.pod:813
6416 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6417 " const char *path);\n"
6422 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:537
6424 "This can be used to resolve case insensitive paths on a filesystem which is "
6425 "case sensitive. The use case is to resolve paths which you have read from "
6426 "Windows configuration files or the Windows Registry, to the true path."
6430 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
6432 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6433 "(and probably others), which is that although the underlying filesystem is "
6434 "case-insensitive, the driver exports the filesystem to Linux as "
6439 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
6441 "One consequence of this is that special directories such as C<c:\\windows> "
6442 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6443 "precise details of how they were created. In Windows itself this would not "
6448 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:553
6450 "Bug or feature? You decide: "
6451 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6455 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:556
6457 "This function resolves the true case of each element in the path and returns "
6458 "the case-sensitive path."
6462 #: ../src/guestfs-actions.pod:839
6464 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
6465 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6466 "how the directories were originally created under Windows)."
6470 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:564
6471 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6475 #: ../src/guestfs-actions.pod:847
6476 msgid "See also C<guestfs_realpath>."
6480 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6792
6481 msgid "(Added in 1.0.75)"
6485 #: ../src/guestfs-actions.pod:854
6490 #: ../src/guestfs-actions.pod:856
6494 " guestfs_cat (guestfs_h *g,\n"
6495 " const char *path);\n"
6500 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:3554
6501 msgid "Return the contents of the file named C<path>."
6505 #: ../src/guestfs-actions.pod:862
6507 "Note that this function cannot correctly handle binary files (specifically, "
6508 "files containing C<\\0> character which is treated as end of string). For "
6509 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
6510 "functions which have a more complex interface."
6514 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2260 ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5128 ../src/guestfs-actions.pod:5259 ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:6177 ../src/guestfs-actions.pod:6232 ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6402 ../src/guestfs-actions.pod:7064 ../src/guestfs-actions.pod:7090 ../src/guestfs-actions.pod:7116 ../src/guestfs-actions.pod:7135 ../src/guestfs-actions.pod:7220 ../src/guestfs-actions.pod:7239 ../src/guestfs-actions.pod:7285 ../src/guestfs-actions.pod:7304 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:715 ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:913 ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990 ../fish/guestfish-actions.pod:1185 ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:1490 ../fish/guestfish-actions.pod:1518 ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:1543 ../fish/guestfish-actions.pod:1562 ../fish/guestfish-actions.pod:3424 ../fish/guestfish-actions.pod:3439 ../fish/guestfish-actions.pod:3515 ../fish/guestfish-actions.pod:3532 ../fish/guestfish-actions.pod:3547 ../fish/guestfish-actions.pod:4143 ../fish/guestfish-actions.pod:4189 ../fish/guestfish-actions.pod:4274 ../fish/guestfish-actions.pod:4289 ../fish/guestfish-actions.pod:4699 ../fish/guestfish-actions.pod:4717 ../fish/guestfish-actions.pod:4734 ../fish/guestfish-actions.pod:4744 ../fish/guestfish-actions.pod:4792 ../fish/guestfish-actions.pod:4802 ../fish/guestfish-actions.pod:4831 ../fish/guestfish-actions.pod:4841
6516 "Because of the message protocol, there is a transfer limit of somewhere "
6517 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6521 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3497 ../src/guestfs-actions.pod:3585 ../src/guestfs-actions.pod:3990 ../src/guestfs-actions.pod:4004 ../src/guestfs-actions.pod:5208 ../src/guestfs-actions.pod:5222 ../src/guestfs-actions.pod:6951 ../src/guestfs-actions.pod:6965
6522 msgid "(Added in 0.4)"
6526 #: ../src/guestfs-actions.pod:875
6527 msgid "guestfs_checksum"
6531 #: ../src/guestfs-actions.pod:877
6535 " guestfs_checksum (guestfs_h *g,\n"
6536 " const char *csumtype,\n"
6537 " const char *path);\n"
6542 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:587
6543 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6547 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:590
6549 "The type of checksum to compute is given by the C<csumtype> parameter which "
6550 "must have one of the following values:"
6554 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
6559 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
6561 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6566 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
6571 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
6572 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6576 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
6581 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
6582 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6586 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
6591 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
6592 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6596 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
6601 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
6602 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6606 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
6611 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
6612 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6616 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
6621 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
6622 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6626 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:626
6627 msgid "The checksum is returned as a printable string."
6631 #: ../src/guestfs-actions.pod:923
6632 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6636 #: ../src/guestfs-actions.pod:925
6637 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6641 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3162 ../src/guestfs-actions.pod:3191 ../src/guestfs-actions.pod:3252 ../src/guestfs-actions.pod:3279 ../src/guestfs-actions.pod:6648
6642 msgid "(Added in 1.0.2)"
6646 #: ../src/guestfs-actions.pod:932
6647 msgid "guestfs_checksum_device"
6651 #: ../src/guestfs-actions.pod:934
6655 " guestfs_checksum_device (guestfs_h *g,\n"
6656 " const char *csumtype,\n"
6657 " const char *device);\n"
6662 #: ../src/guestfs-actions.pod:939
6664 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6665 "device named C<device>. For the types of checksums supported see the "
6666 "C<guestfs_checksum> command."
6670 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4739 ../src/guestfs-actions.pod:4798 ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4853 ../src/guestfs-actions.pod:5029 ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6977
6671 msgid "(Added in 1.3.2)"
6675 #: ../src/guestfs-actions.pod:948
6676 msgid "guestfs_checksums_out"
6680 #: ../src/guestfs-actions.pod:950
6684 " guestfs_checksums_out (guestfs_h *g,\n"
6685 " const char *csumtype,\n"
6686 " const char *directory,\n"
6687 " const char *sumsfile);\n"
6692 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:644
6694 "This command computes the checksums of all regular files in C<directory> and "
6695 "then emits a list of those checksums to the local output file C<sumsfile>."
6699 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:648
6701 "This can be used for verifying the integrity of a virtual machine. However "
6702 "to be properly secure you should pay attention to the output of the checksum "
6703 "command (it uses the ones from GNU coreutils). In particular when the "
6704 "filename is not printable, coreutils uses a special backslash syntax. For "
6705 "more information, see the GNU coreutils info file."
6709 #: ../src/guestfs-actions.pod:970
6710 msgid "(Added in 1.3.7)"
6714 #: ../src/guestfs-actions.pod:972
6715 msgid "guestfs_chmod"
6719 #: ../src/guestfs-actions.pod:974
6723 " guestfs_chmod (guestfs_h *g,\n"
6725 " const char *path);\n"
6730 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:662
6732 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6737 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:665
6739 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6740 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6745 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4457 ../src/guestfs-actions.pod:4476 ../fish/guestfish-actions.pod:669 ../fish/guestfish-actions.pod:2870 ../fish/guestfish-actions.pod:2999 ../fish/guestfish-actions.pod:3009 ../fish/guestfish-actions.pod:3019
6746 msgid "The mode actually set is affected by the umask."
6750 #: ../src/guestfs-actions.pod:992
6751 msgid "guestfs_chown"
6755 #: ../src/guestfs-actions.pod:994
6759 " guestfs_chown (guestfs_h *g,\n"
6762 " const char *path);\n"
6767 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:675
6768 msgid "Change the file owner to C<owner> and group to C<group>."
6772 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3349 ../fish/guestfish-actions.pod:677 ../fish/guestfish-actions.pod:2328
6774 "Only numeric uid and gid are supported. If you want to use names, you will "
6775 "need to locate and parse the password file yourself (Augeas support makes "
6776 "this relatively easy)."
6780 #: ../src/guestfs-actions.pod:1010
6781 msgid "guestfs_command"
6785 #: ../src/guestfs-actions.pod:1012
6789 " guestfs_command (guestfs_h *g,\n"
6790 " char *const *arguments);\n"
6795 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:685
6797 "This call runs a command from the guest filesystem. The filesystem must be "
6798 "mounted, and must contain a compatible operating system (ie. something "
6799 "Linux, with the same or compatible processor architecture)."
6803 #: ../src/guestfs-actions.pod:1021
6805 "The single parameter is an argv-style list of arguments. The first element "
6806 "is the name of the program to run. Subsequent elements are parameters. The "
6807 "list must be non-empty (ie. must contain a program name). Note that the "
6808 "command runs directly, and is I<not> invoked via the shell (see "
6813 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:697
6814 msgid "The return value is anything printed to I<stdout> by the command."
6818 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:700
6820 "If the command returns a non-zero exit status, then this function returns an "
6821 "error message. The error message string is the content of I<stderr> from "
6826 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:704
6828 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6829 "C</bin>. If you require a program from another location, you should provide "
6830 "the full path in the first parameter."
6834 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
6836 "Shared libraries and data files required by the program must be available on "
6837 "filesystems which are mounted in the correct places. It is the caller's "
6838 "responsibility to ensure all filesystems that are needed are mounted at the "
6843 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072 ../src/guestfs-actions.pod:1535
6844 msgid "(Added in 0.9.1)"
6848 #: ../src/guestfs-actions.pod:1054
6849 msgid "guestfs_command_lines"
6853 #: ../src/guestfs-actions.pod:1056
6857 " guestfs_command_lines (guestfs_h *g,\n"
6858 " char *const *arguments);\n"
6863 #: ../src/guestfs-actions.pod:1060
6865 "This is the same as C<guestfs_command>, but splits the result into a list of "
6870 #: ../src/guestfs-actions.pod:1063
6871 msgid "See also: C<guestfs_sh_lines>"
6875 #: ../src/guestfs-actions.pod:1074
6876 msgid "guestfs_config"
6880 #: ../src/guestfs-actions.pod:1076
6884 " guestfs_config (guestfs_h *g,\n"
6885 " const char *qemuparam,\n"
6886 " const char *qemuvalue);\n"
6891 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:734
6893 "This can be used to add arbitrary qemu command line parameters of the form "
6894 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6895 "setting some parameters which would interfere with parameters that we use."
6899 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
6900 msgid "The first character of C<param> string must be a C<-> (dash)."
6904 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
6905 msgid "C<value> can be NULL."
6909 #: ../src/guestfs-actions.pod:1094
6910 msgid "guestfs_copy_size"
6914 #: ../src/guestfs-actions.pod:1096
6918 " guestfs_copy_size (guestfs_h *g,\n"
6919 " const char *src,\n"
6920 " const char *dest,\n"
6926 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:747
6928 "This command copies exactly C<size> bytes from one source device or file "
6929 "C<src> to another destination device or file C<dest>."
6933 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:750
6935 "Note this will fail if the source is too short or if the destination is not "
6940 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6643 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:7156 ../src/guestfs-actions.pod:7175
6942 "This long-running command can generate progress notification messages so "
6943 "that the caller can display a progress bar or indicator. To receive these "
6944 "messages, the caller must register a progress callback. See "
6945 "L<guestfs(3)/guestfs_set_progress_callback>."
6949 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:4017 ../src/guestfs-actions.pod:5235 ../src/guestfs-actions.pod:6884 ../src/guestfs-actions.pod:6904 ../src/guestfs-actions.pod:6990
6950 msgid "(Added in 1.0.87)"
6954 #: ../src/guestfs-actions.pod:1117
6959 #: ../src/guestfs-actions.pod:1119
6963 " guestfs_cp (guestfs_h *g,\n"
6964 " const char *src,\n"
6965 " const char *dest);\n"
6970 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:757
6972 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6973 "destination filename or destination directory."
6977 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:5079
6978 msgid "(Added in 1.0.18)"
6982 #: ../src/guestfs-actions.pod:1131
6983 msgid "guestfs_cp_a"
6987 #: ../src/guestfs-actions.pod:1133
6991 " guestfs_cp_a (guestfs_h *g,\n"
6992 " const char *src,\n"
6993 " const char *dest);\n"
6998 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:764
7000 "This copies a file or directory from C<src> to C<dest> recursively using the "
7005 #: ../src/guestfs-actions.pod:1145
7010 #: ../src/guestfs-actions.pod:1147
7014 " guestfs_dd (guestfs_h *g,\n"
7015 " const char *src,\n"
7016 " const char *dest);\n"
7021 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
7023 "This command copies from one source device or file C<src> to another "
7024 "destination device or file C<dest>. Normally you would use this to copy to "
7025 "or from a device or partition, for example to duplicate a filesystem."
7029 #: ../src/guestfs-actions.pod:1157
7031 "If the destination is a device, it must be as large or larger than the "
7032 "source file or device, otherwise the copy will fail. This command cannot do "
7033 "partial copies (see C<guestfs_copy_size>)."
7037 #: ../src/guestfs-actions.pod:1165
7042 #: ../src/guestfs-actions.pod:1167
7046 " guestfs_df (guestfs_h *g);\n"
7051 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:784
7052 msgid "This command runs the C<df> command to report disk space used."
7056 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
7058 "This command is mostly useful for interactive sessions. It is I<not> "
7059 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7064 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2263 ../src/guestfs-actions.pod:2287 ../src/guestfs-actions.pod:2355 ../src/guestfs-actions.pod:4127 ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:7023 ../src/guestfs-actions.pod:7036 ../src/guestfs-actions.pod:7049
7065 msgid "(Added in 1.0.54)"
7069 #: ../src/guestfs-actions.pod:1181
7070 msgid "guestfs_df_h"
7074 #: ../src/guestfs-actions.pod:1183
7078 " guestfs_df_h (guestfs_h *g);\n"
7083 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:794
7085 "This command runs the C<df -h> command to report disk space used in "
7086 "human-readable format."
7090 #: ../src/guestfs-actions.pod:1198
7091 msgid "guestfs_dmesg"
7095 #: ../src/guestfs-actions.pod:1200
7099 " guestfs_dmesg (guestfs_h *g);\n"
7104 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:805
7106 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7107 "This is sometimes useful for extended debugging of problems."
7111 #: ../src/guestfs-actions.pod:1207
7113 "Another way to get the same information is to enable verbose messages with "
7114 "C<guestfs_set_verbose> or by setting the environment variable "
7115 "C<LIBGUESTFS_DEBUG=1> before running the program."
7119 #: ../src/guestfs-actions.pod:1217
7120 msgid "guestfs_download"
7124 #: ../src/guestfs-actions.pod:1219
7128 " guestfs_download (guestfs_h *g,\n"
7129 " const char *remotefilename,\n"
7130 " const char *filename);\n"
7135 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249 ../fish/guestfish-actions.pod:818 ../fish/guestfish-actions.pod:831
7137 "Download file C<remotefilename> and save it as C<filename> on the local "
7142 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:821 ../fish/guestfish-actions.pod:4447
7143 msgid "C<filename> can also be a named pipe."
7147 #: ../src/guestfs-actions.pod:1229
7148 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7152 #: ../src/guestfs-actions.pod:1240
7153 msgid "guestfs_download_offset"
7157 #: ../src/guestfs-actions.pod:1242
7161 " guestfs_download_offset (guestfs_h *g,\n"
7162 " const char *remotefilename,\n"
7163 " const char *filename,\n"
7164 " int64_t offset,\n"
7170 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:834
7172 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7173 "region must be within the file or device)."
7177 #: ../src/guestfs-actions.pod:1255
7179 "Note that there is no limit on the amount of data that can be downloaded "
7180 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7181 "full amount unless an error occurs."
7185 #: ../src/guestfs-actions.pod:1260
7186 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7190 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6682
7191 msgid "(Added in 1.5.17)"
7195 #: ../src/guestfs-actions.pod:1271
7196 msgid "guestfs_drop_caches"
7200 #: ../src/guestfs-actions.pod:1273
7204 " guestfs_drop_caches (guestfs_h *g,\n"
7205 " int whattodrop);\n"
7210 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:850
7212 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7213 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7214 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7218 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
7219 msgid "Setting C<whattodrop> to 3 should drop everything."
7223 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
7225 "This automatically calls L<sync(2)> before the operation, so that the "
7226 "maximum guest memory is freed."
7230 #: ../src/guestfs-actions.pod:1291
7235 #: ../src/guestfs-actions.pod:1293
7239 " guestfs_du (guestfs_h *g,\n"
7240 " const char *path);\n"
7245 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:864
7247 "This command runs the C<du -s> command to estimate file space usage for "
7252 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:867
7254 "C<path> can be a file or a directory. If C<path> is a directory then the "
7255 "estimate includes the contents of the directory and all subdirectories "
7260 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:871
7261 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7265 #: ../src/guestfs-actions.pod:1311
7266 msgid "guestfs_e2fsck_f"
7270 #: ../src/guestfs-actions.pod:1313
7274 " guestfs_e2fsck_f (guestfs_h *g,\n"
7275 " const char *device);\n"
7280 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:878
7282 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7283 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7288 #: ../src/guestfs-actions.pod:1321
7290 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7291 "Normally you should use C<guestfs_fsck>."
7295 #: ../src/guestfs-actions.pod:1326
7296 msgid "(Added in 1.0.29)"
7300 #: ../src/guestfs-actions.pod:1328
7301 msgid "guestfs_echo_daemon"
7305 #: ../src/guestfs-actions.pod:1330
7309 " guestfs_echo_daemon (guestfs_h *g,\n"
7310 " char *const *words);\n"
7315 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:889
7317 "This command concatenates the list of C<words> passed with single spaces "
7318 "between them and returns the resulting string."
7322 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:892
7323 msgid "You can use this command to test the connection through to the daemon."
7327 #: ../src/guestfs-actions.pod:1339
7328 msgid "See also C<guestfs_ping_daemon>."
7332 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:5885
7333 msgid "(Added in 1.0.69)"
7337 #: ../src/guestfs-actions.pod:1346
7338 msgid "guestfs_egrep"
7342 #: ../src/guestfs-actions.pod:1348
7346 " guestfs_egrep (guestfs_h *g,\n"
7347 " const char *regex,\n"
7348 " const char *path);\n"
7353 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:900
7354 msgid "This calls the external C<egrep> program and returns the matching lines."
7358 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2201 ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:2404 ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3551 ../src/guestfs-actions.pod:4537 ../src/guestfs-actions.pod:5413 ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:6249 ../src/guestfs-actions.pod:6261 ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6287 ../src/guestfs-actions.pod:6309 ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6335 ../src/guestfs-actions.pod:6348 ../src/guestfs-actions.pod:7119 ../src/guestfs-actions.pod:7138 ../src/guestfs-actions.pod:7223 ../src/guestfs-actions.pod:7242 ../src/guestfs-actions.pod:7288 ../src/guestfs-actions.pod:7307
7359 msgid "(Added in 1.0.66)"
7363 #: ../src/guestfs-actions.pod:1365
7364 msgid "guestfs_egrepi"
7368 #: ../src/guestfs-actions.pod:1367
7372 " guestfs_egrepi (guestfs_h *g,\n"
7373 " const char *regex,\n"
7374 " const char *path);\n"
7379 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:910
7380 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7384 #: ../src/guestfs-actions.pod:1384
7385 msgid "guestfs_equal"
7389 #: ../src/guestfs-actions.pod:1386
7393 " guestfs_equal (guestfs_h *g,\n"
7394 " const char *file1,\n"
7395 " const char *file2);\n"
7400 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:920
7402 "This compares the two files C<file1> and C<file2> and returns true if their "
7403 "content is exactly equal, or false otherwise."
7407 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:923
7408 msgid "The external L<cmp(1)> program is used for the comparison."
7412 #: ../src/guestfs-actions.pod:1400
7413 msgid "guestfs_exists"
7417 #: ../src/guestfs-actions.pod:1402
7421 " guestfs_exists (guestfs_h *g,\n"
7422 " const char *path);\n"
7427 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:929
7429 "This returns C<true> if and only if there is a file, directory (or anything) "
7430 "with the given C<path> name."
7434 #: ../src/guestfs-actions.pod:1409
7435 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7439 #: ../src/guestfs-actions.pod:1415
7440 msgid "guestfs_fallocate"
7444 #: ../src/guestfs-actions.pod:1417
7448 " guestfs_fallocate (guestfs_h *g,\n"
7449 " const char *path,\n"
7455 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:957
7457 "This command preallocates a file (containing zero bytes) named C<path> of "
7458 "size C<len> bytes. If the file exists already, it is overwritten."
7462 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:942
7464 "Do not confuse this with the guestfish-specific C<alloc> command which "
7465 "allocates a file in the host and attaches it as a device."
7469 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:946
7471 "This function is deprecated. In new code, use the C<fallocate64> call "
7476 #: ../src/guestfs-actions.pod:1441
7477 msgid "guestfs_fallocate64"
7481 #: ../src/guestfs-actions.pod:1443
7485 " guestfs_fallocate64 (guestfs_h *g,\n"
7486 " const char *path,\n"
7492 #: ../src/guestfs-actions.pod:1452
7494 "Note that this call allocates disk blocks for the file. To create a sparse "
7495 "file use C<guestfs_truncate_size> instead."
7499 #: ../src/guestfs-actions.pod:1455
7501 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
7502 "oversight it only allowed 30 bit lengths to be specified, effectively "
7503 "limiting the maximum size of files created through that call to 1GB."
7507 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:969
7509 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7510 "commands which create a file in the host and attach it as a device."
7514 #: ../src/guestfs-actions.pod:1466
7515 msgid "(Added in 1.3.17)"
7519 #: ../src/guestfs-actions.pod:1468
7520 msgid "guestfs_fgrep"
7524 #: ../src/guestfs-actions.pod:1470
7528 " guestfs_fgrep (guestfs_h *g,\n"
7529 " const char *pattern,\n"
7530 " const char *path);\n"
7535 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:977
7536 msgid "This calls the external C<fgrep> program and returns the matching lines."
7540 #: ../src/guestfs-actions.pod:1487
7541 msgid "guestfs_fgrepi"
7545 #: ../src/guestfs-actions.pod:1489
7549 " guestfs_fgrepi (guestfs_h *g,\n"
7550 " const char *pattern,\n"
7551 " const char *path);\n"
7556 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:987
7557 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7561 #: ../src/guestfs-actions.pod:1506
7562 msgid "guestfs_file"
7566 #: ../src/guestfs-actions.pod:1508
7570 " guestfs_file (guestfs_h *g,\n"
7571 " const char *path);\n"
7576 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:997
7578 "This call uses the standard L<file(1)> command to determine the type or "
7579 "contents of the file."
7583 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1000
7585 "This call will also transparently look inside various types of compressed "
7590 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1003
7592 "The exact command which runs is C<file -zb path>. Note in particular that "
7593 "the filename is not prepended to the output (the C<-b> option)."
7597 #: ../src/guestfs-actions.pod:1522
7599 "This command can also be used on C</dev/> devices (and partitions, LV "
7600 "names). You can for example use this to determine if a device contains a "
7601 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7605 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1012
7607 "If the C<path> does not begin with C</dev/> then this command only works for "
7608 "the content of regular files. For other file types (directory, symbolic "
7609 "link etc) it will just return the string C<directory> etc."
7613 #: ../src/guestfs-actions.pod:1537
7614 msgid "guestfs_file_architecture"
7618 #: ../src/guestfs-actions.pod:1539
7622 " guestfs_file_architecture (guestfs_h *g,\n"
7623 " const char *filename);\n"
7628 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1021
7630 "This detects the architecture of the binary C<filename>, and returns it if "
7635 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
7636 msgid "Currently defined architectures are:"
7640 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1028
7645 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7647 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7648 "irrespective of the precise processor requirements of the binary."
7652 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1033
7657 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
7658 msgid "64 bit x86-64."
7662 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
7667 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
7668 msgid "32 bit SPARC."
7672 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
7677 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
7678 msgid "64 bit SPARC V9 and above."
7682 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
7687 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
7688 msgid "Intel Itanium."
7692 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
7697 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
7698 msgid "32 bit Power PC."
7702 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
7707 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
7708 msgid "64 bit Power PC."
7712 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1059
7713 msgid "Libguestfs may return other architecture strings in future."
7717 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
7718 msgid "The function works on at least the following types of files:"
7722 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1067
7723 msgid "many types of Un*x and Linux binary"
7727 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1071
7728 msgid "many types of Un*x and Linux shared library"
7732 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1075
7733 msgid "Windows Win32 and Win64 binaries"
7737 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1079
7738 msgid "Windows Win32 and Win64 DLLs"
7742 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
7743 msgid "Win32 binaries and DLLs return C<i386>."
7747 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
7748 msgid "Win64 binaries and DLLs return C<x86_64>."
7752 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1087
7753 msgid "Linux kernel modules"
7757 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1091
7758 msgid "Linux new-style initrd images"
7762 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1095
7763 msgid "some non-x86 Linux vmlinuz kernels"
7767 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1099
7768 msgid "What it can't do currently:"
7772 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1105
7773 msgid "static libraries (libfoo.a)"
7777 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1109
7778 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7782 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1113
7783 msgid "x86 Linux vmlinuz kernels"
7787 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
7789 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7790 "compressed code, and are horribly hard to unpack. If you want to find the "
7791 "architecture of a kernel, use the architecture of the associated initrd or "
7792 "kernel module(s) instead."
7796 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:2589 ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2703 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2845 ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:3133 ../src/guestfs-actions.pod:3265
7797 msgid "(Added in 1.5.3)"
7801 #: ../src/guestfs-actions.pod:1649
7802 msgid "guestfs_filesize"
7806 #: ../src/guestfs-actions.pod:1651
7810 " guestfs_filesize (guestfs_h *g,\n"
7811 " const char *file);\n"
7816 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1126
7817 msgid "This command returns the size of C<file> in bytes."
7821 #: ../src/guestfs-actions.pod:1657
7823 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7824 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7825 "devices, use C<guestfs_blockdev_getsize64>."
7829 #: ../src/guestfs-actions.pod:1663
7830 msgid "(Added in 1.0.82)"
7834 #: ../src/guestfs-actions.pod:1665
7835 msgid "guestfs_fill"
7839 #: ../src/guestfs-actions.pod:1667
7843 " guestfs_fill (guestfs_h *g,\n"
7846 " const char *path);\n"
7851 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1136
7853 "This command creates a new file called C<path>. The initial content of the "
7854 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7859 #: ../src/guestfs-actions.pod:1677
7861 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7862 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7863 "bytes use C<guestfs_fill_pattern>."
7867 #: ../src/guestfs-actions.pod:1689
7868 msgid "(Added in 1.0.79)"
7872 #: ../src/guestfs-actions.pod:1691
7873 msgid "guestfs_fill_pattern"
7877 #: ../src/guestfs-actions.pod:1693
7881 " guestfs_fill_pattern (guestfs_h *g,\n"
7882 " const char *pattern,\n"
7884 " const char *path);\n"
7889 #: ../src/guestfs-actions.pod:1699
7891 "This function is like C<guestfs_fill> except that it creates a new file of "
7892 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7893 "pattern is truncated if necessary to ensure the length of the file is "
7894 "exactly C<len> bytes."
7898 #: ../src/guestfs-actions.pod:1711
7899 msgid "(Added in 1.3.12)"
7903 #: ../src/guestfs-actions.pod:1713
7904 msgid "guestfs_find"
7908 #: ../src/guestfs-actions.pod:1715
7912 " guestfs_find (guestfs_h *g,\n"
7913 " const char *directory);\n"
7918 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1158
7920 "This command lists out all files and directories, recursively, starting at "
7921 "C<directory>. It is essentially equivalent to running the shell command "
7922 "C<find directory -print> but some post-processing happens on the output, "
7927 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1163
7929 "This returns a list of strings I<without any prefix>. Thus if the directory "
7934 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1166
7944 #: ../src/guestfs-actions.pod:1731
7945 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7949 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1173
7960 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1178
7961 msgid "If C<directory> is not a directory, then this command returns an error."
7965 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1181
7966 msgid "The returned list is sorted."
7970 #: ../src/guestfs-actions.pod:1744
7971 msgid "See also C<guestfs_find0>."
7975 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3954 ../src/guestfs-actions.pod:5497
7976 msgid "(Added in 1.0.27)"
7980 #: ../src/guestfs-actions.pod:1755
7981 msgid "guestfs_find0"
7985 #: ../src/guestfs-actions.pod:1757
7989 " guestfs_find0 (guestfs_h *g,\n"
7990 " const char *directory,\n"
7991 " const char *files);\n"
7996 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1192
7998 "This command lists out all files and directories, recursively, starting at "
7999 "C<directory>, placing the resulting list in the external file called "
8004 #: ../src/guestfs-actions.pod:1766
8006 "This command works the same way as C<guestfs_find> with the following "
8011 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1203
8012 msgid "The resulting list is written to an external file."
8016 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1207
8018 "Items (filenames) in the result are separated by C<\\0> characters. See "
8019 "L<find(1)> option I<-print0>."
8023 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1212
8024 msgid "This command is not limited in the number of names that it can return."
8028 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1217
8029 msgid "The result list is not sorted."
8033 #: ../src/guestfs-actions.pod:1793
8034 msgid "(Added in 1.0.74)"
8038 #: ../src/guestfs-actions.pod:1795
8039 msgid "guestfs_findfs_label"
8043 #: ../src/guestfs-actions.pod:1797
8047 " guestfs_findfs_label (guestfs_h *g,\n"
8048 " const char *label);\n"
8053 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1227
8055 "This command searches the filesystems and returns the one which has the "
8056 "given label. An error is returned if no such filesystem can be found."
8060 #: ../src/guestfs-actions.pod:1805
8061 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8065 #: ../src/guestfs-actions.pod:1812
8066 msgid "guestfs_findfs_uuid"
8070 #: ../src/guestfs-actions.pod:1814
8074 " guestfs_findfs_uuid (guestfs_h *g,\n"
8075 " const char *uuid);\n"
8080 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1237
8082 "This command searches the filesystems and returns the one which has the "
8083 "given UUID. An error is returned if no such filesystem can be found."
8087 #: ../src/guestfs-actions.pod:1822
8088 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8092 #: ../src/guestfs-actions.pod:1829
8093 msgid "guestfs_fsck"
8097 #: ../src/guestfs-actions.pod:1831
8101 " guestfs_fsck (guestfs_h *g,\n"
8102 " const char *fstype,\n"
8103 " const char *device);\n"
8108 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1247
8110 "This runs the filesystem checker (fsck) on C<device> which should have "
8111 "filesystem type C<fstype>."
8115 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1250
8117 "The returned integer is the status. See L<fsck(8)> for the list of status "
8118 "codes from C<fsck>."
8122 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1259
8123 msgid "Multiple status codes can be summed together."
8127 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1263
8129 "A non-zero return code can mean \"success\", for example if errors have been "
8130 "corrected on the filesystem."
8134 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1268
8135 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8139 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1273
8140 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8144 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:7161
8145 msgid "(Added in 1.0.16)"
8149 #: ../src/guestfs-actions.pod:1868
8150 msgid "guestfs_get_append"
8154 #: ../src/guestfs-actions.pod:1870
8158 " guestfs_get_append (guestfs_h *g);\n"
8163 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1279
8165 "Return the additional kernel options which are added to the guest kernel "
8170 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1282
8171 msgid "If C<NULL> then no options are added."
8175 #: ../src/guestfs-actions.pod:1878
8177 "This function returns a string which may be NULL. There is no way to return "
8178 "an error from this function. The string is owned by the guest handle and "
8179 "must I<not> be freed."
8183 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:5175 ../src/guestfs-actions.pod:5655 ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:6042 ../src/guestfs-actions.pod:6058 ../src/guestfs-actions.pod:6075 ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6850 ../src/guestfs-actions.pod:7204
8184 msgid "(Added in 1.0.26)"
8188 #: ../src/guestfs-actions.pod:1884
8189 msgid "guestfs_get_autosync"
8193 #: ../src/guestfs-actions.pod:1886
8197 " guestfs_get_autosync (guestfs_h *g);\n"
8202 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
8203 msgid "Get the autosync flag."
8207 #: ../src/guestfs-actions.pod:1895
8208 msgid "guestfs_get_direct"
8212 #: ../src/guestfs-actions.pod:1897
8216 " guestfs_get_direct (guestfs_h *g);\n"
8221 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1294
8222 msgid "Return the direct appliance mode flag."
8226 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5696
8227 msgid "(Added in 1.0.72)"
8231 #: ../src/guestfs-actions.pod:1906
8232 msgid "guestfs_get_e2label"
8236 #: ../src/guestfs-actions.pod:1908
8240 " guestfs_get_e2label (guestfs_h *g,\n"
8241 " const char *device);\n"
8246 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1300
8247 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8251 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1303
8253 "This function is deprecated. In new code, use the C<vfs_label> call "
8258 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:5714 ../src/guestfs-actions.pod:5733
8259 msgid "(Added in 1.0.15)"
8263 #: ../src/guestfs-actions.pod:1927
8264 msgid "guestfs_get_e2uuid"
8268 #: ../src/guestfs-actions.pod:1929
8272 " guestfs_get_e2uuid (guestfs_h *g,\n"
8273 " const char *device);\n"
8278 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1314
8279 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8283 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1317
8284 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
8288 #: ../src/guestfs-actions.pod:1948
8289 msgid "guestfs_get_memsize"
8293 #: ../src/guestfs-actions.pod:1950
8297 " guestfs_get_memsize (guestfs_h *g);\n"
8302 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1328
8303 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8307 #: ../src/guestfs-actions.pod:1956
8309 "If C<guestfs_set_memsize> was not called on this handle, and if "
8310 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8311 "value for memsize."
8315 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:5749 ../src/guestfs-actions.pod:5856 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:1386 ../fish/guestfish-actions.pod:3854 ../fish/guestfish-actions.pod:3941
8316 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8320 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4245 ../src/guestfs-actions.pod:4442 ../src/guestfs-actions.pod:4461 ../src/guestfs-actions.pod:4480 ../src/guestfs-actions.pod:4492 ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:4522 ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5754 ../src/guestfs-actions.pod:5997 ../src/guestfs-actions.pod:6598
8321 msgid "(Added in 1.0.55)"
8325 #: ../src/guestfs-actions.pod:1967
8326 msgid "guestfs_get_network"
8330 #: ../src/guestfs-actions.pod:1969
8334 " guestfs_get_network (guestfs_h *g);\n"
8339 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1342
8340 msgid "This returns the enable network flag."
8344 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5773
8345 msgid "(Added in 1.5.4)"
8349 #: ../src/guestfs-actions.pod:1978
8350 msgid "guestfs_get_path"
8354 #: ../src/guestfs-actions.pod:1980
8358 " guestfs_get_path (guestfs_h *g);\n"
8363 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1348
8364 msgid "Return the current search path."
8368 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
8370 "This is always non-NULL. If it wasn't set already, then this will return "
8375 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
8377 "This function returns a string, or NULL on error. The string is owned by "
8378 "the guest handle and must I<not> be freed."
8382 #: ../src/guestfs-actions.pod:1993
8383 msgid "guestfs_get_pid"
8387 #: ../src/guestfs-actions.pod:1995
8391 " guestfs_get_pid (guestfs_h *g);\n"
8396 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1359
8398 "Return the process ID of the qemu subprocess. If there is no qemu "
8399 "subprocess, then this will return an error."
8403 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1362
8404 msgid "This is an internal call used for debugging and testing."
8408 #: ../src/guestfs-actions.pod:2005
8409 msgid "(Added in 1.0.56)"
8413 #: ../src/guestfs-actions.pod:2007
8414 msgid "guestfs_get_qemu"
8418 #: ../src/guestfs-actions.pod:2009
8422 " guestfs_get_qemu (guestfs_h *g);\n"
8427 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1368
8428 msgid "Return the current qemu binary."
8432 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
8434 "This is always non-NULL. If it wasn't set already, then this will return "
8435 "the default qemu binary name."
8439 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5818
8440 msgid "(Added in 1.0.6)"
8444 #: ../src/guestfs-actions.pod:2022
8445 msgid "guestfs_get_recovery_proc"
8449 #: ../src/guestfs-actions.pod:2024
8453 " guestfs_get_recovery_proc (guestfs_h *g);\n"
8458 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
8459 msgid "Return the recovery process enabled flag."
8463 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3355 ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:4052 ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:5105 ../src/guestfs-actions.pod:5448 ../src/guestfs-actions.pod:5842 ../src/guestfs-actions.pod:6501 ../src/guestfs-actions.pod:6521 ../src/guestfs-actions.pod:6713
8464 msgid "(Added in 1.0.77)"
8468 #: ../src/guestfs-actions.pod:2033
8469 msgid "guestfs_get_selinux"
8473 #: ../src/guestfs-actions.pod:2035
8477 " guestfs_get_selinux (guestfs_h *g);\n"
8482 #: ../src/guestfs-actions.pod:2038
8484 "This returns the current setting of the selinux flag which is passed to the "
8485 "appliance at boot time. See C<guestfs_set_selinux>."
8489 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5915
8490 msgid "(Added in 1.0.67)"
8494 #: ../src/guestfs-actions.pod:2048
8495 msgid "guestfs_get_state"
8499 #: ../src/guestfs-actions.pod:2050
8503 " guestfs_get_state (guestfs_h *g);\n"
8508 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1393
8510 "This returns the current state as an opaque integer. This is only useful "
8511 "for printing debug and internal error messages."
8515 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3158 ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:3248 ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:1396 ../fish/guestfish-actions.pod:2210 ../fish/guestfish-actions.pod:2228 ../fish/guestfish-actions.pod:2266 ../fish/guestfish-actions.pod:2282
8516 msgid "For more information on states, see L<guestfs(3)>."
8520 #: ../src/guestfs-actions.pod:2062
8521 msgid "guestfs_get_trace"
8525 #: ../src/guestfs-actions.pod:2064
8529 " guestfs_get_trace (guestfs_h *g);\n"
8534 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1402
8535 msgid "Return the command trace flag."
8539 #: ../src/guestfs-actions.pod:2073
8540 msgid "guestfs_get_umask"
8544 #: ../src/guestfs-actions.pod:2075
8548 " guestfs_get_umask (guestfs_h *g);\n"
8553 #: ../src/guestfs-actions.pod:2078
8555 "Return the current umask. By default the umask is C<022> unless it has been "
8556 "set by calling C<guestfs_umask>."
8560 #: ../src/guestfs-actions.pod:2085
8561 msgid "guestfs_get_verbose"
8565 #: ../src/guestfs-actions.pod:2087
8569 " guestfs_get_verbose (guestfs_h *g);\n"
8574 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
8575 msgid "This returns the verbose messages flag."
8579 #: ../src/guestfs-actions.pod:2096
8580 msgid "guestfs_getcon"
8584 #: ../src/guestfs-actions.pod:2098
8588 " guestfs_getcon (guestfs_h *g);\n"
8593 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1421
8594 msgid "This gets the SELinux security context of the daemon."
8598 #: ../src/guestfs-actions.pod:2103
8599 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8603 #: ../src/guestfs-actions.pod:2111
8604 msgid "guestfs_getxattr"
8608 #: ../src/guestfs-actions.pod:2113
8612 " guestfs_getxattr (guestfs_h *g,\n"
8613 " const char *path,\n"
8614 " const char *name,\n"
8615 " size_t *size_r);\n"
8620 #: ../src/guestfs-actions.pod:2119
8622 "Get a single extended attribute from file C<path> named C<name>. This call "
8623 "follows symlinks. If you want to lookup an extended attribute for the "
8624 "symlink itself, use C<guestfs_lgetxattr>."
8628 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:3369
8630 "Normally it is better to get all extended attributes from a file in one go "
8631 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
8632 "implementations are buggy and do not provide a way to list out attributes. "
8633 "For these filesystems (notably ntfs-3g) you have to know the names of the "
8634 "extended attributes you want in advance and call this function."
8638 #: ../src/guestfs-actions.pod:2130 ../src/guestfs-actions.pod:3376 ../fish/guestfish-actions.pod:1441 ../fish/guestfish-actions.pod:2347
8640 "Extended attribute values are blobs of binary data. If there is no extended "
8641 "attribute named C<name>, this returns an error."
8645 #: ../src/guestfs-actions.pod:2133
8646 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
8650 #: ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5124 ../src/guestfs-actions.pod:5305
8652 "This function returns a buffer, or NULL on error. The size of the returned "
8653 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8658 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:3385
8659 msgid "(Added in 1.7.24)"
8663 #: ../src/guestfs-actions.pod:2141
8664 msgid "guestfs_getxattrs"
8668 #: ../src/guestfs-actions.pod:2143
8671 " struct guestfs_xattr_list *\n"
8672 " guestfs_getxattrs (guestfs_h *g,\n"
8673 " const char *path);\n"
8678 #: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1450
8679 msgid "This call lists the extended attributes of the file or directory C<path>."
8683 #: ../src/guestfs-actions.pod:2150 ../fish/guestfish-actions.pod:1453
8685 "At the system call level, this is a combination of the L<listxattr(2)> and "
8686 "L<getxattr(2)> calls."
8690 #: ../src/guestfs-actions.pod:2153
8691 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8695 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:4048
8697 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8698 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8702 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:5934 ../src/guestfs-actions.pod:7269
8703 msgid "(Added in 1.0.59)"
8707 #: ../src/guestfs-actions.pod:2161
8708 msgid "guestfs_glob_expand"
8712 #: ../src/guestfs-actions.pod:2163
8716 " guestfs_glob_expand (guestfs_h *g,\n"
8717 " const char *pattern);\n"
8722 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1462
8724 "This command searches for all the pathnames matching C<pattern> according to "
8725 "the wildcard expansion rules used by the shell."
8729 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1466
8730 msgid "If no paths match, then this returns an empty list (note: not an error)."
8734 #: ../src/guestfs-actions.pod:2174 ../fish/guestfish-actions.pod:1469
8736 "It is just a wrapper around the C L<glob(3)> function with flags "
8737 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8741 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:6099 ../src/guestfs-actions.pod:6116
8742 msgid "(Added in 1.0.50)"
8746 #: ../src/guestfs-actions.pod:2184
8747 msgid "guestfs_grep"
8751 #: ../src/guestfs-actions.pod:2186
8755 " guestfs_grep (guestfs_h *g,\n"
8756 " const char *regex,\n"
8757 " const char *path);\n"
8762 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1477
8763 msgid "This calls the external C<grep> program and returns the matching lines."
8767 #: ../src/guestfs-actions.pod:2203
8768 msgid "guestfs_grepi"
8772 #: ../src/guestfs-actions.pod:2205
8776 " guestfs_grepi (guestfs_h *g,\n"
8777 " const char *regex,\n"
8778 " const char *path);\n"
8783 #: ../src/guestfs-actions.pod:2210 ../fish/guestfish-actions.pod:1487
8784 msgid "This calls the external C<grep -i> program and returns the matching lines."
8788 #: ../src/guestfs-actions.pod:2222
8789 msgid "guestfs_grub_install"
8793 #: ../src/guestfs-actions.pod:2224
8797 " guestfs_grub_install (guestfs_h *g,\n"
8798 " const char *root,\n"
8799 " const char *device);\n"
8804 #: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1497
8806 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8807 "the root directory being C<root>."
8811 #: ../src/guestfs-actions.pod:2232 ../fish/guestfish-actions.pod:1500
8813 "Note: If grub-install reports the error \"No suitable drive was found in the "
8814 "generated device map.\" it may be that you need to create a "
8815 "C</boot/grub/device.map> file first that contains the mapping between grub "
8816 "device names and Linux device names. It is usually sufficient to create a "
8821 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1507
8829 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1509
8830 msgid "replacing C</dev/vda> with the name of the installation device."
8834 #: ../src/guestfs-actions.pod:2245
8835 msgid "(Added in 1.0.17)"
8839 #: ../src/guestfs-actions.pod:2247
8840 msgid "guestfs_head"
8844 #: ../src/guestfs-actions.pod:2249
8848 " guestfs_head (guestfs_h *g,\n"
8849 " const char *path);\n"
8854 #: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1515
8856 "This command returns up to the first 10 lines of a file as a list of "
8861 #: ../src/guestfs-actions.pod:2265
8862 msgid "guestfs_head_n"
8866 #: ../src/guestfs-actions.pod:2267
8870 " guestfs_head_n (guestfs_h *g,\n"
8872 " const char *path);\n"
8877 #: ../src/guestfs-actions.pod:2272 ../fish/guestfish-actions.pod:1525
8879 "If the parameter C<nrlines> is a positive number, this returns the first "
8880 "C<nrlines> lines of the file C<path>."
8884 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish-actions.pod:1528
8886 "If the parameter C<nrlines> is a negative number, this returns lines from "
8887 "the file C<path>, excluding the last C<nrlines> lines."
8891 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6396 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:4287
8892 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8896 #: ../src/guestfs-actions.pod:2289
8897 msgid "guestfs_hexdump"
8901 #: ../src/guestfs-actions.pod:2291
8905 " guestfs_hexdump (guestfs_h *g,\n"
8906 " const char *path);\n"
8911 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1540
8913 "This runs C<hexdump -C> on the given C<path>. The result is the "
8914 "human-readable, canonical hex dump of the file."
8918 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6180 ../src/guestfs-actions.pod:6235
8919 msgid "(Added in 1.0.22)"
8923 #: ../src/guestfs-actions.pod:2306
8924 msgid "guestfs_initrd_cat"
8928 #: ../src/guestfs-actions.pod:2308
8932 " guestfs_initrd_cat (guestfs_h *g,\n"
8933 " const char *initrdpath,\n"
8934 " const char *filename,\n"
8935 " size_t *size_r);\n"
8940 #: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1550
8942 "This command unpacks the file C<filename> from the initrd file called "
8943 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8948 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1554
8950 "For example, in guestfish you could use the following command to examine the "
8951 "boot script (usually called C</init>) contained in a Linux initrd or "
8956 #: ../src/guestfs-actions.pod:2322 ../fish/guestfish-actions.pod:1558
8959 " initrd-cat /boot/initrd-<version>.img init\n"
8964 #: ../src/guestfs-actions.pod:2324
8965 msgid "See also C<guestfs_initrd_list>."
8969 #: ../src/guestfs-actions.pod:2335
8970 msgid "guestfs_initrd_list"
8974 #: ../src/guestfs-actions.pod:2337
8978 " guestfs_initrd_list (guestfs_h *g,\n"
8979 " const char *path);\n"
8984 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1569
8985 msgid "This command lists out files contained in an initrd."
8989 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1571
8991 "The files are listed without any initial C</> character. The files are "
8992 "listed in the order they appear (not necessarily alphabetical). Directory "
8993 "names are listed as separate items."
8997 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1575
8999 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9000 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9005 #: ../src/guestfs-actions.pod:2357
9006 msgid "guestfs_inotify_add_watch"
9010 #: ../src/guestfs-actions.pod:2359
9014 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9015 " const char *path,\n"
9021 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1583
9022 msgid "Watch C<path> for the events listed in C<mask>."
9026 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1585
9028 "Note that if C<path> is a directory then events within that directory are "
9029 "watched, but this does I<not> happen recursively (in subdirectories)."
9033 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1589
9035 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9036 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9040 #: ../src/guestfs-actions.pod:2378
9041 msgid "guestfs_inotify_close"
9045 #: ../src/guestfs-actions.pod:2380
9049 " guestfs_inotify_close (guestfs_h *g);\n"
9054 #: ../src/guestfs-actions.pod:2383 ../fish/guestfish-actions.pod:1597
9056 "This closes the inotify handle which was previously opened by inotify_init. "
9057 "It removes all watches, throws away any pending events, and deallocates all "
9062 #: ../src/guestfs-actions.pod:2391
9063 msgid "guestfs_inotify_files"
9067 #: ../src/guestfs-actions.pod:2393
9071 " guestfs_inotify_files (guestfs_h *g);\n"
9076 #: ../src/guestfs-actions.pod:2396
9078 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9079 "returns a list of pathnames of objects that were touched. The returned "
9080 "pathnames are sorted and deduplicated."
9084 #: ../src/guestfs-actions.pod:2406
9085 msgid "guestfs_inotify_init"
9089 #: ../src/guestfs-actions.pod:2408
9093 " guestfs_inotify_init (guestfs_h *g,\n"
9094 " int maxevents);\n"
9099 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1613
9101 "This command creates a new inotify handle. The inotify subsystem can be "
9102 "used to notify events which happen to objects in the guest filesystem."
9106 #: ../src/guestfs-actions.pod:2416
9108 "C<maxevents> is the maximum number of events which will be queued up between "
9109 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9110 "passed as C<0>, then the kernel (or previously set) default is used. For "
9111 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9112 "throws away events, but records the fact that it threw them away by setting "
9113 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9114 "C<guestfs_inotify_read>)."
9118 #: ../src/guestfs-actions.pod:2426
9120 "Before any events are generated, you have to add some watches to the "
9121 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9122 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9126 #: ../src/guestfs-actions.pod:2432
9128 "Queued up events should be read periodically by calling "
9129 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9130 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9131 "often enough then you risk the internal queue overflowing."
9135 #: ../src/guestfs-actions.pod:2439
9137 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9138 "This also removes any watches automatically."
9142 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1644
9144 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9145 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9146 "that there is one global inotify handle per libguestfs instance."
9150 #: ../src/guestfs-actions.pod:2452
9151 msgid "guestfs_inotify_read"
9155 #: ../src/guestfs-actions.pod:2454
9158 " struct guestfs_inotify_event_list *\n"
9159 " guestfs_inotify_read (guestfs_h *g);\n"
9164 #: ../src/guestfs-actions.pod:2457 ../fish/guestfish-actions.pod:1653
9166 "Return the complete queue of events that have happened since the previous "
9171 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1656
9172 msgid "If no events have happened, this returns an empty list."
9176 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1658
9178 "I<Note>: In order to make sure that all events have been read, you must call "
9179 "this function repeatedly until it returns an empty list. The reason is that "
9180 "the call will read events up to the maximum appliance-to-host message size "
9181 "and leave remaining events in the queue."
9185 #: ../src/guestfs-actions.pod:2468
9187 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9188 "there was an error. I<The caller must call "
9189 "C<guestfs_free_inotify_event_list> after use>."
9193 #: ../src/guestfs-actions.pod:2474
9194 msgid "guestfs_inotify_rm_watch"
9198 #: ../src/guestfs-actions.pod:2476
9202 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9208 #: ../src/guestfs-actions.pod:2480
9210 "Remove a previously defined inotify watch. See "
9211 "C<guestfs_inotify_add_watch>."
9215 #: ../src/guestfs-actions.pod:2487
9216 msgid "guestfs_inspect_get_arch"
9220 #: ../src/guestfs-actions.pod:2489
9224 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9225 " const char *root);\n"
9230 #: ../src/guestfs-actions.pod:2493 ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2662 ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:2711 ../src/guestfs-actions.pod:2732 ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:2829 ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2915 ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2955 ../src/guestfs-actions.pod:2972 ../src/guestfs-actions.pod:2991
9232 "This function should only be called with a root device string as returned by "
9233 "C<guestfs_inspect_os>."
9237 #: ../src/guestfs-actions.pod:2496
9239 "This returns the architecture of the inspected operating system. The "
9240 "possible return values are listed under C<guestfs_file_architecture>."
9244 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1682
9246 "If the architecture could not be determined, then the string C<unknown> is "
9251 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:2584 ../src/guestfs-actions.pod:2651 ../src/guestfs-actions.pod:2671 ../src/guestfs-actions.pod:2699 ../src/guestfs-actions.pod:2785 ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2859 ../src/guestfs-actions.pod:2902 ../src/guestfs-actions.pod:2925 ../src/guestfs-actions.pod:2945 ../src/guestfs-actions.pod:2962 ../src/guestfs-actions.pod:2981 ../src/guestfs-actions.pod:3084 ../src/guestfs-actions.pod:3125 ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1826 ../fish/guestfish-actions.pod:1847 ../fish/guestfish-actions.pod:1911 ../fish/guestfish-actions.pod:1935 ../fish/guestfish-actions.pod:1952 ../fish/guestfish-actions.pod:1965 ../fish/guestfish-actions.pod:2000 ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2029 ../fish/guestfish-actions.pod:2042 ../fish/guestfish-actions.pod:2057 ../fish/guestfish-actions.pod:2156 ../fish/guestfish-actions.pod:2190
9252 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9256 #: ../src/guestfs-actions.pod:2510
9257 msgid "guestfs_inspect_get_distro"
9261 #: ../src/guestfs-actions.pod:2512
9265 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9266 " const char *root);\n"
9271 #: ../src/guestfs-actions.pod:2519 ../fish/guestfish-actions.pod:1694
9272 msgid "This returns the distro (distribution) of the inspected operating system."
9276 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1697
9277 msgid "Currently defined distros are:"
9281 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1701
9282 msgid "\"archlinux\""
9286 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1703
9291 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1705
9296 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1707
9301 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1709
9306 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1711
9311 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1713
9316 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1715
9321 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1717
9322 msgid "\"linuxmint\""
9326 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1719
9331 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1721
9332 msgid "\"mandriva\""
9336 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1723
9341 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1725
9346 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1727
9351 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1729
9356 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1731
9361 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1733
9362 msgid "\"redhat-based\""
9366 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1735
9367 msgid "Some Red Hat-derived distro."
9371 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1737
9376 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1739
9377 msgid "Red Hat Enterprise Linux and some derivatives."
9381 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1741
9386 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1743
9391 #: ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2642 ../src/guestfs-actions.pod:2893 ../fish/guestfish-actions.pod:1745 ../fish/guestfish-actions.pod:1802 ../fish/guestfish-actions.pod:1991
9396 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1747
9397 msgid "The distro could not be determined."
9401 #: ../src/guestfs-actions.pod:2574 ../src/guestfs-actions.pod:2885 ../fish/guestfish-actions.pod:1749 ../fish/guestfish-actions.pod:1983
9406 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1751
9408 "Windows does not have distributions. This string is returned if the OS type "
9413 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2648 ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1756 ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1997
9415 "Future versions of libguestfs may return other strings here. The caller "
9416 "should be prepared to handle any string."
9420 #: ../src/guestfs-actions.pod:2591
9421 msgid "guestfs_inspect_get_filesystems"
9425 #: ../src/guestfs-actions.pod:2593
9429 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9430 " const char *root);\n"
9435 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1768
9437 "This returns a list of all the filesystems that we think are associated with "
9438 "this operating system. This includes the root filesystem, other ordinary "
9439 "filesystems, and non-mounted devices like swap partitions."
9443 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1773
9445 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9446 "to be shared between operating systems."
9450 #: ../src/guestfs-actions.pod:2608
9452 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9453 "C<guestfs_inspect_get_mountpoints>."
9457 #: ../src/guestfs-actions.pod:2617
9458 msgid "guestfs_inspect_get_format"
9462 #: ../src/guestfs-actions.pod:2619
9466 " guestfs_inspect_get_format (guestfs_h *g,\n"
9467 " const char *root);\n"
9472 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1786
9474 "This returns the format of the inspected operating system. You can use it "
9475 "to detect install images, live CDs and similar."
9479 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1789
9480 msgid "Currently defined formats are:"
9484 #: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1793
9485 msgid "\"installed\""
9489 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1795
9490 msgid "This is an installed operating system."
9494 #: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1797
9495 msgid "\"installer\""
9499 #: ../src/guestfs-actions.pod:2639 ../fish/guestfish-actions.pod:1799
9501 "The disk image being inspected is not an installed operating system, but a "
9502 "I<bootable> install disk, live CD, or similar."
9506 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1804
9507 msgid "The format of this disk image is not known."
9511 #: ../src/guestfs-actions.pod:2656
9512 msgid "guestfs_inspect_get_hostname"
9516 #: ../src/guestfs-actions.pod:2658
9520 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
9521 " const char *root);\n"
9526 #: ../src/guestfs-actions.pod:2665 ../fish/guestfish-actions.pod:1820
9528 "This function returns the hostname of the operating system as found by "
9529 "inspection of the guest's configuration files."
9533 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1823
9535 "If the hostname could not be determined, then the string C<unknown> is "
9540 #: ../src/guestfs-actions.pod:2676
9541 msgid "(Added in 1.7.9)"
9545 #: ../src/guestfs-actions.pod:2678
9546 msgid "guestfs_inspect_get_major_version"
9550 #: ../src/guestfs-actions.pod:2680
9554 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
9555 " const char *root);\n"
9560 #: ../src/guestfs-actions.pod:2687 ../fish/guestfish-actions.pod:1835
9561 msgid "This returns the major version number of the inspected operating system."
9565 #: ../src/guestfs-actions.pod:2690 ../fish/guestfish-actions.pod:1838
9567 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9568 "popular public names used by the operating system. Notably the operating "
9569 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9570 "1). You can find out the real versions corresponding to releases of Windows "
9571 "by consulting Wikipedia or MSDN."
9575 #: ../src/guestfs-actions.pod:2697 ../src/guestfs-actions.pod:2717 ../fish/guestfish-actions.pod:1845 ../fish/guestfish-actions.pod:1859
9576 msgid "If the version could not be determined, then C<0> is returned."
9580 #: ../src/guestfs-actions.pod:2705
9581 msgid "guestfs_inspect_get_minor_version"
9585 #: ../src/guestfs-actions.pod:2707
9589 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9590 " const char *root);\n"
9595 #: ../src/guestfs-actions.pod:2714 ../fish/guestfish-actions.pod:1856
9596 msgid "This returns the minor version number of the inspected operating system."
9600 #: ../src/guestfs-actions.pod:2719
9602 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9603 "C<guestfs_inspect_get_major_version>."
9607 #: ../src/guestfs-actions.pod:2726
9608 msgid "guestfs_inspect_get_mountpoints"
9612 #: ../src/guestfs-actions.pod:2728
9616 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9617 " const char *root);\n"
9622 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:1871
9624 "This returns a hash of where we think the filesystems associated with this "
9625 "operating system should be mounted. Callers should note that this is at "
9626 "best an educated guess made by reading configuration files such as "
9627 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
9628 "are non-existent or not mountable and callers should be prepared to handle "
9629 "or ignore failures if they try to mount them."
9633 #: ../src/guestfs-actions.pod:2744 ../fish/guestfish-actions.pod:1880
9635 "Each element in the returned hashtable has a key which is the path of the "
9636 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9637 "mounted there (eg. C</dev/sda1>)."
9641 #: ../src/guestfs-actions.pod:2749 ../fish/guestfish-actions.pod:1885
9642 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9646 #: ../src/guestfs-actions.pod:2752
9648 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9649 "C<guestfs_inspect_get_filesystems>."
9653 #: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:4664 ../src/guestfs-actions.pod:6537
9655 "This function returns a NULL-terminated array of strings, or NULL if there "
9656 "was an error. The array of strings will always have length C<2n+1>, where "
9657 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9658 "caller must free the strings and the array after use>."
9662 #: ../src/guestfs-actions.pod:2763
9663 msgid "guestfs_inspect_get_package_format"
9667 #: ../src/guestfs-actions.pod:2765
9671 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9672 " const char *root);\n"
9677 #: ../src/guestfs-actions.pod:2772
9679 "This function and C<guestfs_inspect_get_package_management> return the "
9680 "package format and package management tool used by the inspected operating "
9681 "system. For example for Fedora these functions would return C<rpm> (package "
9682 "format) and C<yum> (package management)."
9686 #: ../src/guestfs-actions.pod:2778 ../fish/guestfish-actions.pod:1904
9688 "This returns the string C<unknown> if we could not determine the package "
9689 "format I<or> if the operating system does not have a real packaging system "
9694 #: ../src/guestfs-actions.pod:2782 ../fish/guestfish-actions.pod:1908
9696 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9697 "Future versions of libguestfs may return other strings."
9701 #: ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2821
9702 msgid "(Added in 1.7.5)"
9706 #: ../src/guestfs-actions.pod:2792
9707 msgid "guestfs_inspect_get_package_management"
9711 #: ../src/guestfs-actions.pod:2794
9715 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9716 " const char *root);\n"
9721 #: ../src/guestfs-actions.pod:2801
9723 "C<guestfs_inspect_get_package_format> and this function return the package "
9724 "format and package management tool used by the inspected operating system. "
9725 "For example for Fedora these functions would return C<rpm> (package format) "
9726 "and C<yum> (package management)."
9730 #: ../src/guestfs-actions.pod:2807 ../fish/guestfish-actions.pod:1926
9732 "This returns the string C<unknown> if we could not determine the package "
9733 "management tool I<or> if the operating system does not have a real packaging "
9734 "system (eg. Windows)."
9738 #: ../src/guestfs-actions.pod:2811 ../fish/guestfish-actions.pod:1930
9740 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9741 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9742 "libguestfs may return other strings."
9746 #: ../src/guestfs-actions.pod:2823
9747 msgid "guestfs_inspect_get_product_name"
9751 #: ../src/guestfs-actions.pod:2825
9755 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9756 " const char *root);\n"
9761 #: ../src/guestfs-actions.pod:2832 ../fish/guestfish-actions.pod:1944
9763 "This returns the product name of the inspected operating system. The "
9764 "product name is generally some freeform string which can be displayed to the "
9765 "user, but should not be parsed by programs."
9769 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1949
9771 "If the product name could not be determined, then the string C<unknown> is "
9776 #: ../src/guestfs-actions.pod:2847
9777 msgid "guestfs_inspect_get_roots"
9781 #: ../src/guestfs-actions.pod:2849
9785 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9790 #: ../src/guestfs-actions.pod:2852
9792 "This function is a convenient way to get the list of root devices, as "
9793 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9794 "the whole inspection process."
9798 #: ../src/guestfs-actions.pod:2856
9800 "This returns an empty list if either no root devices were found or the "
9801 "caller has not called C<guestfs_inspect_os>."
9805 #: ../src/guestfs-actions.pod:2865
9806 msgid "(Added in 1.7.3)"
9810 #: ../src/guestfs-actions.pod:2867
9811 msgid "guestfs_inspect_get_type"
9815 #: ../src/guestfs-actions.pod:2869
9819 " guestfs_inspect_get_type (guestfs_h *g,\n"
9820 " const char *root);\n"
9825 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1974
9827 "This returns the type of the inspected operating system. Currently defined "
9832 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1979
9837 #: ../src/guestfs-actions.pod:2883 ../fish/guestfish-actions.pod:1981
9838 msgid "Any Linux-based operating system."
9842 #: ../src/guestfs-actions.pod:2887 ../fish/guestfish-actions.pod:1985
9843 msgid "Any Microsoft Windows operating system."
9847 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1987
9852 #: ../src/guestfs-actions.pod:2891 ../fish/guestfish-actions.pod:1989
9857 #: ../src/guestfs-actions.pod:2895 ../fish/guestfish-actions.pod:1993
9858 msgid "The operating system type could not be determined."
9862 #: ../src/guestfs-actions.pod:2909
9863 msgid "guestfs_inspect_get_windows_systemroot"
9867 #: ../src/guestfs-actions.pod:2911
9871 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9872 " const char *root);\n"
9877 #: ../src/guestfs-actions.pod:2918 ../fish/guestfish-actions.pod:2009
9879 "This returns the Windows systemroot of the inspected guest. The systemroot "
9880 "is a directory path such as C</WINDOWS>."
9884 #: ../src/guestfs-actions.pod:2921 ../fish/guestfish-actions.pod:2012
9886 "This call assumes that the guest is Windows and that the systemroot could be "
9887 "determined by inspection. If this is not the case then an error is "
9892 #: ../src/guestfs-actions.pod:2930
9893 msgid "(Added in 1.5.25)"
9897 #: ../src/guestfs-actions.pod:2932
9898 msgid "guestfs_inspect_is_live"
9902 #: ../src/guestfs-actions.pod:2934
9906 " guestfs_inspect_is_live (guestfs_h *g,\n"
9907 " const char *root);\n"
9912 #: ../src/guestfs-actions.pod:2941
9914 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
9915 "disk), then this returns true if a live image was detected on the disk."
9919 #: ../src/guestfs-actions.pod:2949
9920 msgid "guestfs_inspect_is_multipart"
9924 #: ../src/guestfs-actions.pod:2951
9928 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
9929 " const char *root);\n"
9934 #: ../src/guestfs-actions.pod:2958
9936 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
9937 "disk), then this returns true if the disk is part of a set."
9941 #: ../src/guestfs-actions.pod:2966
9942 msgid "guestfs_inspect_is_netinst"
9946 #: ../src/guestfs-actions.pod:2968
9950 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
9951 " const char *root);\n"
9956 #: ../src/guestfs-actions.pod:2975
9958 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
9959 "disk), then this returns true if the disk is a network installer, ie. not a "
9960 "self-contained install CD but one which is likely to require network access "
9961 "to complete the install."
9965 #: ../src/guestfs-actions.pod:2985
9966 msgid "guestfs_inspect_list_applications"
9970 #: ../src/guestfs-actions.pod:2987
9973 " struct guestfs_application_list *\n"
9974 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9975 " const char *root);\n"
9980 #: ../src/guestfs-actions.pod:2994 ../fish/guestfish-actions.pod:2066
9981 msgid "Return the list of applications installed in the operating system."
9985 #: ../src/guestfs-actions.pod:2996
9987 "I<Note:> This call works differently from other parts of the inspection "
9988 "API. You have to call C<guestfs_inspect_os>, then "
9989 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9990 "this. Listing applications is a significantly more difficult operation "
9991 "which requires access to the full filesystem. Also note that unlike the "
9992 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9993 "the libguestfs handle, this call actually reads parts of the mounted "
9994 "filesystems during the call."
9998 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2078
10000 "This returns an empty list if the inspection code was not able to determine "
10001 "the list of applications."
10005 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2081
10006 msgid "The application structure contains the following fields:"
10010 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2085
10011 msgid "C<app_name>"
10015 #: ../src/guestfs-actions.pod:3015 ../fish/guestfish-actions.pod:2087
10017 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10018 "guests, this is the package name."
10022 #: ../src/guestfs-actions.pod:3018 ../fish/guestfish-actions.pod:2090
10023 msgid "C<app_display_name>"
10027 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2092
10029 "The display name of the application, sometimes localized to the install "
10030 "language of the guest operating system."
10034 #: ../src/guestfs-actions.pod:3023 ../fish/guestfish-actions.pod:2095
10036 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10037 "to display something can use C<app_name> instead."
10041 #: ../src/guestfs-actions.pod:3026 ../fish/guestfish-actions.pod:2098
10042 msgid "C<app_epoch>"
10046 #: ../src/guestfs-actions.pod:3028 ../fish/guestfish-actions.pod:2100
10048 "For package managers which use epochs, this contains the epoch of the "
10049 "package (an integer). If unavailable, this is returned as C<0>."
10053 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2103
10054 msgid "C<app_version>"
10058 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2105
10060 "The version string of the application or package. If unavailable this is "
10061 "returned as an empty string C<\"\">."
10065 #: ../src/guestfs-actions.pod:3036 ../fish/guestfish-actions.pod:2108
10066 msgid "C<app_release>"
10070 #: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2110
10072 "The release string of the application or package, for package managers that "
10073 "use this. If unavailable this is returned as an empty string C<\"\">."
10077 #: ../src/guestfs-actions.pod:3042 ../fish/guestfish-actions.pod:2114
10078 msgid "C<app_install_path>"
10082 #: ../src/guestfs-actions.pod:3044 ../fish/guestfish-actions.pod:2116
10084 "The installation path of the application (on operating systems such as "
10085 "Windows which use installation paths). This path is in the format used by "
10086 "the guest operating system, it is not a libguestfs path."
10090 #: ../src/guestfs-actions.pod:3049 ../fish/guestfish-actions.pod:2121
10091 msgid "If unavailable this is returned as an empty string C<\"\">."
10095 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2123
10096 msgid "C<app_trans_path>"
10100 #: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2125
10102 "The install path translated into a libguestfs path. If unavailable this is "
10103 "returned as an empty string C<\"\">."
10107 #: ../src/guestfs-actions.pod:3056 ../fish/guestfish-actions.pod:2128
10108 msgid "C<app_publisher>"
10112 #: ../src/guestfs-actions.pod:3058 ../fish/guestfish-actions.pod:2130
10114 "The name of the publisher of the application, for package managers that use "
10115 "this. If unavailable this is returned as an empty string C<\"\">."
10119 #: ../src/guestfs-actions.pod:3062 ../fish/guestfish-actions.pod:2134
10124 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2136
10126 "The URL (eg. upstream URL) of the application. If unavailable this is "
10127 "returned as an empty string C<\"\">."
10131 #: ../src/guestfs-actions.pod:3067 ../fish/guestfish-actions.pod:2139
10132 msgid "C<app_source_package>"
10136 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2141
10138 "For packaging systems which support this, the name of the source package. "
10139 "If unavailable this is returned as an empty string C<\"\">."
10143 #: ../src/guestfs-actions.pod:3072 ../fish/guestfish-actions.pod:2144
10144 msgid "C<app_summary>"
10148 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2146
10150 "A short (usually one line) description of the application or package. If "
10151 "unavailable this is returned as an empty string C<\"\">."
10155 #: ../src/guestfs-actions.pod:3077 ../fish/guestfish-actions.pod:2149
10156 msgid "C<app_description>"
10160 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2151
10162 "A longer description of the application or package. If unavailable this is "
10163 "returned as an empty string C<\"\">."
10167 #: ../src/guestfs-actions.pod:3086
10169 "This function returns a C<struct guestfs_application_list *>, or NULL if "
10170 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10175 #: ../src/guestfs-actions.pod:3090
10176 msgid "(Added in 1.7.8)"
10180 #: ../src/guestfs-actions.pod:3092
10181 msgid "guestfs_inspect_os"
10185 #: ../src/guestfs-actions.pod:3094
10189 " guestfs_inspect_os (guestfs_h *g);\n"
10194 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2162
10196 "This function uses other libguestfs functions and certain heuristics to "
10197 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10198 "for operating systems."
10202 #: ../src/guestfs-actions.pod:3101 ../fish/guestfish-actions.pod:2166
10203 msgid "The list returned is empty if no operating systems were found."
10207 #: ../src/guestfs-actions.pod:3103 ../fish/guestfish-actions.pod:2168
10209 "If one operating system was found, then this returns a list with a single "
10210 "element, which is the name of the root filesystem of this operating system. "
10211 "It is also possible for this function to return a list containing more than "
10212 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10213 "element being the root filesystem of one of the operating systems."
10217 #: ../src/guestfs-actions.pod:3110
10219 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10220 "functions in order to query further information about each operating system, "
10221 "such as the name and version."
10225 #: ../src/guestfs-actions.pod:3115
10227 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10228 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10229 "the contents. This should be called with no disks currently mounted. The "
10230 "function may also use Augeas, so any existing Augeas handle will be closed."
10234 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2186
10236 "This function cannot decrypt encrypted disks. The caller must do that first "
10237 "(supplying the necessary keys) if the disk is encrypted."
10241 #: ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:3474
10242 msgid "See also C<guestfs_list_filesystems>."
10246 #: ../src/guestfs-actions.pod:3135
10247 msgid "guestfs_is_blockdev"
10251 #: ../src/guestfs-actions.pod:3137
10255 " guestfs_is_blockdev (guestfs_h *g,\n"
10256 " const char *path);\n"
10261 #: ../src/guestfs-actions.pod:3141 ../fish/guestfish-actions.pod:2198
10263 "This returns C<true> if and only if there is a block device with the given "
10268 #: ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3173 ../src/guestfs-actions.pod:3203 ../src/guestfs-actions.pod:3218 ../src/guestfs-actions.pod:3234 ../src/guestfs-actions.pod:3290 ../src/guestfs-actions.pod:3305
10269 msgid "See also C<guestfs_stat>."
10273 #: ../src/guestfs-actions.pod:3148 ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:3309
10274 msgid "(Added in 1.5.10)"
10278 #: ../src/guestfs-actions.pod:3150
10279 msgid "guestfs_is_busy"
10283 #: ../src/guestfs-actions.pod:3152
10287 " guestfs_is_busy (guestfs_h *g);\n"
10292 #: ../src/guestfs-actions.pod:3155 ../fish/guestfish-actions.pod:2207
10294 "This returns true iff this handle is busy processing a command (in the "
10299 #: ../src/guestfs-actions.pod:3164
10300 msgid "guestfs_is_chardev"
10304 #: ../src/guestfs-actions.pod:3166
10308 " guestfs_is_chardev (guestfs_h *g,\n"
10309 " const char *path);\n"
10314 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2216
10316 "This returns C<true> if and only if there is a character device with the "
10317 "given C<path> name."
10321 #: ../src/guestfs-actions.pod:3179
10322 msgid "guestfs_is_config"
10326 #: ../src/guestfs-actions.pod:3181
10330 " guestfs_is_config (guestfs_h *g);\n"
10335 #: ../src/guestfs-actions.pod:3184 ../fish/guestfish-actions.pod:2225
10337 "This returns true iff this handle is being configured (in the C<CONFIG> "
10342 #: ../src/guestfs-actions.pod:3193
10343 msgid "guestfs_is_dir"
10347 #: ../src/guestfs-actions.pod:3195
10351 " guestfs_is_dir (guestfs_h *g,\n"
10352 " const char *path);\n"
10357 #: ../src/guestfs-actions.pod:3199 ../fish/guestfish-actions.pod:2234
10359 "This returns C<true> if and only if there is a directory with the given "
10360 "C<path> name. Note that it returns false for other objects like files."
10364 #: ../src/guestfs-actions.pod:3209
10365 msgid "guestfs_is_fifo"
10369 #: ../src/guestfs-actions.pod:3211
10373 " guestfs_is_fifo (guestfs_h *g,\n"
10374 " const char *path);\n"
10379 #: ../src/guestfs-actions.pod:3215 ../fish/guestfish-actions.pod:2244
10381 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10382 "given C<path> name."
10386 #: ../src/guestfs-actions.pod:3224
10387 msgid "guestfs_is_file"
10391 #: ../src/guestfs-actions.pod:3226
10395 " guestfs_is_file (guestfs_h *g,\n"
10396 " const char *path);\n"
10401 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2253
10403 "This returns C<true> if and only if there is a regular file with the given "
10404 "C<path> name. Note that it returns false for other objects like "
10409 #: ../src/guestfs-actions.pod:3240
10410 msgid "guestfs_is_launching"
10414 #: ../src/guestfs-actions.pod:3242
10418 " guestfs_is_launching (guestfs_h *g);\n"
10423 #: ../src/guestfs-actions.pod:3245 ../fish/guestfish-actions.pod:2263
10425 "This returns true iff this handle is launching the subprocess (in the "
10426 "C<LAUNCHING> state)."
10430 #: ../src/guestfs-actions.pod:3254
10431 msgid "guestfs_is_lv"
10435 #: ../src/guestfs-actions.pod:3256
10439 " guestfs_is_lv (guestfs_h *g,\n"
10440 " const char *device);\n"
10445 #: ../src/guestfs-actions.pod:3260 ../fish/guestfish-actions.pod:2272
10447 "This command tests whether C<device> is a logical volume, and returns true "
10448 "iff this is the case."
10452 #: ../src/guestfs-actions.pod:3267
10453 msgid "guestfs_is_ready"
10457 #: ../src/guestfs-actions.pod:3269
10461 " guestfs_is_ready (guestfs_h *g);\n"
10466 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2279
10468 "This returns true iff this handle is ready to accept commands (in the "
10473 #: ../src/guestfs-actions.pod:3281
10474 msgid "guestfs_is_socket"
10478 #: ../src/guestfs-actions.pod:3283
10482 " guestfs_is_socket (guestfs_h *g,\n"
10483 " const char *path);\n"
10488 #: ../src/guestfs-actions.pod:3287 ../fish/guestfish-actions.pod:2288
10490 "This returns C<true> if and only if there is a Unix domain socket with the "
10491 "given C<path> name."
10495 #: ../src/guestfs-actions.pod:3296
10496 msgid "guestfs_is_symlink"
10500 #: ../src/guestfs-actions.pod:3298
10504 " guestfs_is_symlink (guestfs_h *g,\n"
10505 " const char *path);\n"
10510 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2297
10512 "This returns C<true> if and only if there is a symbolic link with the given "
10517 #: ../src/guestfs-actions.pod:3311
10518 msgid "guestfs_kill_subprocess"
10522 #: ../src/guestfs-actions.pod:3313
10526 " guestfs_kill_subprocess (guestfs_h *g);\n"
10531 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2306
10532 msgid "This kills the qemu subprocess. You should never need to call this."
10536 #: ../src/guestfs-actions.pod:3322
10537 msgid "guestfs_launch"
10541 #: ../src/guestfs-actions.pod:3324
10545 " guestfs_launch (guestfs_h *g);\n"
10550 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2314
10552 "Internally libguestfs is implemented by running a virtual machine using "
10557 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2317
10559 "You should call this after configuring the handle (eg. adding drives) but "
10560 "before performing any actions."
10564 #: ../src/guestfs-actions.pod:3337
10565 msgid "guestfs_lchown"
10569 #: ../src/guestfs-actions.pod:3339
10573 " guestfs_lchown (guestfs_h *g,\n"
10576 " const char *path);\n"
10581 #: ../src/guestfs-actions.pod:3345
10583 "Change the file owner to C<owner> and group to C<group>. This is like "
10584 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
10585 "changed, not the target."
10589 #: ../src/guestfs-actions.pod:3357
10590 msgid "guestfs_lgetxattr"
10594 #: ../src/guestfs-actions.pod:3359
10598 " guestfs_lgetxattr (guestfs_h *g,\n"
10599 " const char *path,\n"
10600 " const char *name,\n"
10601 " size_t *size_r);\n"
10606 #: ../src/guestfs-actions.pod:3365 ../fish/guestfish-actions.pod:2336
10608 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10609 "is a symlink, then this call returns an extended attribute from the symlink."
10613 #: ../src/guestfs-actions.pod:3379
10614 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
10618 #: ../src/guestfs-actions.pod:3387
10619 msgid "guestfs_lgetxattrs"
10623 #: ../src/guestfs-actions.pod:3389
10626 " struct guestfs_xattr_list *\n"
10627 " guestfs_lgetxattrs (guestfs_h *g,\n"
10628 " const char *path);\n"
10633 #: ../src/guestfs-actions.pod:3393
10635 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
10636 "then it returns the extended attributes of the link itself."
10640 #: ../src/guestfs-actions.pod:3403
10641 msgid "guestfs_list_devices"
10645 #: ../src/guestfs-actions.pod:3405
10649 " guestfs_list_devices (guestfs_h *g);\n"
10654 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:2364
10655 msgid "List all the block devices."
10659 #: ../src/guestfs-actions.pod:3410 ../fish/guestfish-actions.pod:2366
10660 msgid "The full block device names are returned, eg. C</dev/sda>."
10664 #: ../src/guestfs-actions.pod:3420
10665 msgid "guestfs_list_filesystems"
10669 #: ../src/guestfs-actions.pod:3422
10673 " guestfs_list_filesystems (guestfs_h *g);\n"
10678 #: ../src/guestfs-actions.pod:3425 ../fish/guestfish-actions.pod:2374
10680 "This inspection command looks for filesystems on partitions, block devices "
10681 "and logical volumes, returning a list of devices containing filesystems and "
10686 #: ../src/guestfs-actions.pod:3429 ../fish/guestfish-actions.pod:2378
10688 "The return value is a hash, where the keys are the devices containing "
10689 "filesystems, and the values are the filesystem types. For example:"
10693 #: ../src/guestfs-actions.pod:3433 ../fish/guestfish-actions.pod:2382
10696 " \"/dev/sda1\" => \"ntfs\"\n"
10697 " \"/dev/sda2\" => \"ext2\"\n"
10698 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10699 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10704 #: ../src/guestfs-actions.pod:3438 ../fish/guestfish-actions.pod:2387
10706 "The value can have the special value \"unknown\", meaning the content of the "
10707 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10711 #: ../src/guestfs-actions.pod:3442
10713 "This command runs other libguestfs commands, which might include "
10714 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10715 "soon after launch and only when nothing is mounted."
10719 #: ../src/guestfs-actions.pod:3446
10721 "Not all of the filesystems returned will be mountable. In particular, swap "
10722 "partitions are returned in the list. Also this command does not check that "
10723 "each filesystem found is valid and mountable, and some filesystems might be "
10724 "mountable but require special options. Filesystems may not all belong to a "
10725 "single logical operating system (use C<guestfs_inspect_os> to look for "
10730 #: ../src/guestfs-actions.pod:3460 ../src/guestfs-actions.pod:5065
10731 msgid "(Added in 1.5.15)"
10735 #: ../src/guestfs-actions.pod:3462
10736 msgid "guestfs_list_partitions"
10740 #: ../src/guestfs-actions.pod:3464
10744 " guestfs_list_partitions (guestfs_h *g);\n"
10749 #: ../src/guestfs-actions.pod:3467 ../fish/guestfish-actions.pod:2407
10750 msgid "List all the partitions detected on all block devices."
10754 #: ../src/guestfs-actions.pod:3469 ../fish/guestfish-actions.pod:2409
10755 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10759 #: ../src/guestfs-actions.pod:3471
10761 "This does not return logical volumes. For that you will need to call "
10766 #: ../src/guestfs-actions.pod:3482
10771 #: ../src/guestfs-actions.pod:3484
10775 " guestfs_ll (guestfs_h *g,\n"
10776 " const char *directory);\n"
10781 #: ../src/guestfs-actions.pod:3488 ../fish/guestfish-actions.pod:2420
10783 "List the files in C<directory> (relative to the root directory, there is no "
10784 "cwd) in the format of 'ls -la'."
10788 #: ../src/guestfs-actions.pod:3491 ../fish/guestfish-actions.pod:2423
10790 "This command is mostly useful for interactive sessions. It is I<not> "
10791 "intended that you try to parse the output string."
10795 #: ../src/guestfs-actions.pod:3499
10800 #: ../src/guestfs-actions.pod:3501
10804 " guestfs_ln (guestfs_h *g,\n"
10805 " const char *target,\n"
10806 " const char *linkname);\n"
10811 #: ../src/guestfs-actions.pod:3506 ../fish/guestfish-actions.pod:2430
10812 msgid "This command creates a hard link using the C<ln> command."
10816 #: ../src/guestfs-actions.pod:3512
10817 msgid "guestfs_ln_f"
10821 #: ../src/guestfs-actions.pod:3514
10825 " guestfs_ln_f (guestfs_h *g,\n"
10826 " const char *target,\n"
10827 " const char *linkname);\n"
10832 #: ../src/guestfs-actions.pod:3519 ../fish/guestfish-actions.pod:2436
10834 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10835 "option removes the link (C<linkname>) if it exists already."
10839 #: ../src/guestfs-actions.pod:3526
10840 msgid "guestfs_ln_s"
10844 #: ../src/guestfs-actions.pod:3528
10848 " guestfs_ln_s (guestfs_h *g,\n"
10849 " const char *target,\n"
10850 " const char *linkname);\n"
10855 #: ../src/guestfs-actions.pod:3533 ../fish/guestfish-actions.pod:2443
10856 msgid "This command creates a symbolic link using the C<ln -s> command."
10860 #: ../src/guestfs-actions.pod:3539
10861 msgid "guestfs_ln_sf"
10865 #: ../src/guestfs-actions.pod:3541
10869 " guestfs_ln_sf (guestfs_h *g,\n"
10870 " const char *target,\n"
10871 " const char *linkname);\n"
10876 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2449
10878 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10879 "option removes the link (C<linkname>) if it exists already."
10883 #: ../src/guestfs-actions.pod:3553
10884 msgid "guestfs_lremovexattr"
10888 #: ../src/guestfs-actions.pod:3555
10892 " guestfs_lremovexattr (guestfs_h *g,\n"
10893 " const char *xattr,\n"
10894 " const char *path);\n"
10899 #: ../src/guestfs-actions.pod:3560
10901 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10902 "link, then it removes an extended attribute of the link itself."
10906 #: ../src/guestfs-actions.pod:3568
10911 #: ../src/guestfs-actions.pod:3570
10915 " guestfs_ls (guestfs_h *g,\n"
10916 " const char *directory);\n"
10921 #: ../src/guestfs-actions.pod:3574 ../fish/guestfish-actions.pod:2464
10923 "List the files in C<directory> (relative to the root directory, there is no "
10924 "cwd). The '.' and '..' entries are not returned, but hidden files are "
10929 #: ../src/guestfs-actions.pod:3578
10931 "This command is mostly useful for interactive sessions. Programs should "
10932 "probably use C<guestfs_readdir> instead."
10936 #: ../src/guestfs-actions.pod:3587
10937 msgid "guestfs_lsetxattr"
10941 #: ../src/guestfs-actions.pod:3589
10945 " guestfs_lsetxattr (guestfs_h *g,\n"
10946 " const char *xattr,\n"
10947 " const char *val,\n"
10949 " const char *path);\n"
10954 #: ../src/guestfs-actions.pod:3596
10956 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10957 "then it sets an extended attribute of the link itself."
10961 #: ../src/guestfs-actions.pod:3604
10962 msgid "guestfs_lstat"
10966 #: ../src/guestfs-actions.pod:3606
10969 " struct guestfs_stat *\n"
10970 " guestfs_lstat (guestfs_h *g,\n"
10971 " const char *path);\n"
10976 #: ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:6136 ../fish/guestfish-actions.pod:2483 ../fish/guestfish-actions.pod:4122
10977 msgid "Returns file information for the given C<path>."
10981 #: ../src/guestfs-actions.pod:3612
10983 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10984 "link, then the link is stat-ed, not the file it refers to."
10988 #: ../src/guestfs-actions.pod:3616 ../fish/guestfish-actions.pod:2489
10989 msgid "This is the same as the C<lstat(2)> system call."
10993 #: ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:6140
10995 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10996 "error. I<The caller must call C<guestfs_free_stat> after use>."
11000 #: ../src/guestfs-actions.pod:3622 ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6162 ../src/guestfs-actions.pod:6543
11001 msgid "(Added in 0.9.2)"
11005 #: ../src/guestfs-actions.pod:3624
11006 msgid "guestfs_lstatlist"
11010 #: ../src/guestfs-actions.pod:3626
11013 " struct guestfs_stat_list *\n"
11014 " guestfs_lstatlist (guestfs_h *g,\n"
11015 " const char *path,\n"
11016 " char *const *names);\n"
11021 #: ../src/guestfs-actions.pod:3631
11023 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
11024 "files, where all files are in the directory C<path>. C<names> is the list "
11025 "of files from this directory."
11029 #: ../src/guestfs-actions.pod:3635 ../fish/guestfish-actions.pod:2499
11031 "On return you get a list of stat structs, with a one-to-one correspondence "
11032 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11033 "then the C<ino> field of that structure is set to C<-1>."
11037 #: ../src/guestfs-actions.pod:3640
11039 "This call is intended for programs that want to efficiently list a directory "
11040 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
11041 "for a similarly efficient call for getting extended attributes. Very long "
11042 "directory listings might cause the protocol message size to be exceeded, "
11043 "causing this call to fail. The caller must split up such requests into "
11044 "smaller groups of names."
11048 #: ../src/guestfs-actions.pod:3648
11050 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
11051 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
11055 #: ../src/guestfs-actions.pod:3654
11056 msgid "guestfs_luks_add_key"
11060 #: ../src/guestfs-actions.pod:3656
11064 " guestfs_luks_add_key (guestfs_h *g,\n"
11065 " const char *device,\n"
11066 " const char *key,\n"
11067 " const char *newkey,\n"
11073 #: ../src/guestfs-actions.pod:3663 ../fish/guestfish-actions.pod:2516
11075 "This command adds a new key on LUKS device C<device>. C<key> is any "
11076 "existing key, and is used to access the device. C<newkey> is the new key to "
11077 "add. C<keyslot> is the key slot that will be replaced."
11081 #: ../src/guestfs-actions.pod:3668
11083 "Note that if C<keyslot> already contains a key, then this command will "
11084 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
11088 #: ../src/guestfs-actions.pod:3674 ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3737 ../src/guestfs-actions.pod:3757 ../src/guestfs-actions.pod:3789 ../src/guestfs-actions.pod:3808
11090 "This function takes a key or passphrase parameter which could contain "
11091 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
11096 #: ../src/guestfs-actions.pod:3678 ../src/guestfs-actions.pod:3718 ../src/guestfs-actions.pod:3741 ../src/guestfs-actions.pod:3761
11097 msgid "(Added in 1.5.2)"
11101 #: ../src/guestfs-actions.pod:3680
11102 msgid "guestfs_luks_close"
11106 #: ../src/guestfs-actions.pod:3682
11110 " guestfs_luks_close (guestfs_h *g,\n"
11111 " const char *device);\n"
11116 #: ../src/guestfs-actions.pod:3686
11118 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
11119 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
11120 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
11121 "underlying block device."
11125 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3793 ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:3910
11126 msgid "(Added in 1.5.1)"
11130 #: ../src/guestfs-actions.pod:3696
11131 msgid "guestfs_luks_format"
11135 #: ../src/guestfs-actions.pod:3698
11139 " guestfs_luks_format (guestfs_h *g,\n"
11140 " const char *device,\n"
11141 " const char *key,\n"
11147 #: ../src/guestfs-actions.pod:3704 ../fish/guestfish-actions.pod:2542
11149 "This command erases existing data on C<device> and formats the device as a "
11150 "LUKS encrypted device. C<key> is the initial key, which is added to key "
11151 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
11155 #: ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3874 ../src/guestfs-actions.pod:4816 ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:7180 ../fish/guestfish-actions.pod:2550 ../fish/guestfish-actions.pod:2563 ../fish/guestfish-actions.pod:2647 ../fish/guestfish-actions.pod:3221 ../fish/guestfish-actions.pod:3741 ../fish/guestfish-actions.pod:4021 ../fish/guestfish-actions.pod:4037 ../fish/guestfish-actions.pod:4052 ../fish/guestfish-actions.pod:4767
11157 "B<This command is dangerous. Without careful use you can easily destroy all "
11162 #: ../src/guestfs-actions.pod:3720
11163 msgid "guestfs_luks_format_cipher"
11167 #: ../src/guestfs-actions.pod:3722
11171 " guestfs_luks_format_cipher (guestfs_h *g,\n"
11172 " const char *device,\n"
11173 " const char *key,\n"
11175 " const char *cipher);\n"
11180 #: ../src/guestfs-actions.pod:3729
11182 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11183 "set the C<cipher> used."
11187 #: ../src/guestfs-actions.pod:3743
11188 msgid "guestfs_luks_kill_slot"
11192 #: ../src/guestfs-actions.pod:3745
11196 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11197 " const char *device,\n"
11198 " const char *key,\n"
11204 #: ../src/guestfs-actions.pod:3751 ../fish/guestfish-actions.pod:2570
11206 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11207 "device C<device>. C<key> must be one of the I<other> keys."
11211 #: ../src/guestfs-actions.pod:3763
11212 msgid "guestfs_luks_open"
11216 #: ../src/guestfs-actions.pod:3765
11220 " guestfs_luks_open (guestfs_h *g,\n"
11221 " const char *device,\n"
11222 " const char *key,\n"
11223 " const char *mapname);\n"
11228 #: ../src/guestfs-actions.pod:3771 ../fish/guestfish-actions.pod:2581
11230 "This command opens a block device which has been encrypted according to the "
11231 "Linux Unified Key Setup (LUKS) standard."
11235 #: ../src/guestfs-actions.pod:3774 ../fish/guestfish-actions.pod:2584
11236 msgid "C<device> is the encrypted block device or partition."
11240 #: ../src/guestfs-actions.pod:3776 ../fish/guestfish-actions.pod:2586
11242 "The caller must supply one of the keys associated with the LUKS block "
11243 "device, in the C<key> parameter."
11247 #: ../src/guestfs-actions.pod:3779 ../fish/guestfish-actions.pod:2589
11249 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11250 "writes to this block device are decrypted from and encrypted to the "
11251 "underlying C<device> respectively."
11255 #: ../src/guestfs-actions.pod:3783
11257 "If this block device contains LVM volume groups, then calling "
11258 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11263 #: ../src/guestfs-actions.pod:3795
11264 msgid "guestfs_luks_open_ro"
11268 #: ../src/guestfs-actions.pod:3797
11272 " guestfs_luks_open_ro (guestfs_h *g,\n"
11273 " const char *device,\n"
11274 " const char *key,\n"
11275 " const char *mapname);\n"
11280 #: ../src/guestfs-actions.pod:3803
11282 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11287 #: ../src/guestfs-actions.pod:3814
11288 msgid "guestfs_lvcreate"
11292 #: ../src/guestfs-actions.pod:3816
11296 " guestfs_lvcreate (guestfs_h *g,\n"
11297 " const char *logvol,\n"
11298 " const char *volgroup,\n"
11304 #: ../src/guestfs-actions.pod:3822 ../fish/guestfish-actions.pod:2614
11306 "This creates an LVM logical volume called C<logvol> on the volume group "
11307 "C<volgroup>, with C<size> megabytes."
11311 #: ../src/guestfs-actions.pod:3829
11312 msgid "guestfs_lvm_canonical_lv_name"
11316 #: ../src/guestfs-actions.pod:3831
11320 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11321 " const char *lvname);\n"
11326 #: ../src/guestfs-actions.pod:3835 ../fish/guestfish-actions.pod:2621
11328 "This converts alternative naming schemes for LVs that you might find to the "
11329 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11334 #: ../src/guestfs-actions.pod:3839 ../fish/guestfish-actions.pod:2625
11336 "This command returns an error if the C<lvname> parameter does not refer to a "
11341 #: ../src/guestfs-actions.pod:3842
11342 msgid "See also C<guestfs_is_lv>."
11346 #: ../src/guestfs-actions.pod:3847
11347 msgid "(Added in 1.5.24)"
11351 #: ../src/guestfs-actions.pod:3849
11352 msgid "guestfs_lvm_clear_filter"
11356 #: ../src/guestfs-actions.pod:3851
11360 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11365 #: ../src/guestfs-actions.pod:3854
11367 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11368 "see every block device."
11372 #: ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3899 ../fish/guestfish-actions.pod:2637 ../fish/guestfish-actions.pod:2668
11373 msgid "This command also clears the LVM cache and performs a volume group scan."
11377 #: ../src/guestfs-actions.pod:3864
11378 msgid "guestfs_lvm_remove_all"
11382 #: ../src/guestfs-actions.pod:3866
11386 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11391 #: ../src/guestfs-actions.pod:3869 ../fish/guestfish-actions.pod:2644
11393 "This command removes all LVM logical volumes, volume groups and physical "
11398 #: ../src/guestfs-actions.pod:3879
11399 msgid "guestfs_lvm_set_filter"
11403 #: ../src/guestfs-actions.pod:3881
11407 " guestfs_lvm_set_filter (guestfs_h *g,\n"
11408 " char *const *devices);\n"
11413 #: ../src/guestfs-actions.pod:3885 ../fish/guestfish-actions.pod:2654
11415 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11416 "block devices in the list C<devices>, and will ignore all other attached "
11421 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2658
11423 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11424 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11425 "there are two types of duplication possible: either cloned PVs/VGs which "
11426 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11427 "same name. In normal operation you cannot create this situation, but you "
11428 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11429 "inside the LVM metadata."
11433 #: ../src/guestfs-actions.pod:3902 ../fish/guestfish-actions.pod:2671
11434 msgid "You can filter whole block devices or individual partitions."
11438 #: ../src/guestfs-actions.pod:3904 ../fish/guestfish-actions.pod:2673
11440 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11441 "filesystem), even if you are not filtering out that VG."
11445 #: ../src/guestfs-actions.pod:3912
11446 msgid "guestfs_lvremove"
11450 #: ../src/guestfs-actions.pod:3914
11454 " guestfs_lvremove (guestfs_h *g,\n"
11455 " const char *device);\n"
11460 #: ../src/guestfs-actions.pod:3918 ../fish/guestfish-actions.pod:2681
11462 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11463 "LV, such as C</dev/VG/LV>."
11467 #: ../src/guestfs-actions.pod:3921 ../fish/guestfish-actions.pod:2684
11469 "You can also remove all LVs in a volume group by specifying the VG name, "
11474 #: ../src/guestfs-actions.pod:3926 ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:6919
11475 msgid "(Added in 1.0.13)"
11479 #: ../src/guestfs-actions.pod:3928
11480 msgid "guestfs_lvrename"
11484 #: ../src/guestfs-actions.pod:3930
11488 " guestfs_lvrename (guestfs_h *g,\n"
11489 " const char *logvol,\n"
11490 " const char *newlogvol);\n"
11495 #: ../src/guestfs-actions.pod:3935 ../fish/guestfish-actions.pod:2691
11496 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11500 #: ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:6932
11501 msgid "(Added in 1.0.83)"
11505 #: ../src/guestfs-actions.pod:3941
11506 msgid "guestfs_lvresize"
11510 #: ../src/guestfs-actions.pod:3943
11514 " guestfs_lvresize (guestfs_h *g,\n"
11515 " const char *device,\n"
11521 #: ../src/guestfs-actions.pod:3948 ../fish/guestfish-actions.pod:2697
11523 "This resizes (expands or shrinks) an existing LVM logical volume to "
11524 "C<mbytes>. When reducing, data in the reduced part is lost."
11528 #: ../src/guestfs-actions.pod:3956
11529 msgid "guestfs_lvresize_free"
11533 #: ../src/guestfs-actions.pod:3958
11537 " guestfs_lvresize_free (guestfs_h *g,\n"
11538 " const char *lv,\n"
11544 #: ../src/guestfs-actions.pod:3963 ../fish/guestfish-actions.pod:2705
11546 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11547 "remaining free space in the volume group. Commonly you would call this with "
11548 "pc = 100 which expands the logical volume as much as possible, using all "
11549 "remaining free space in the volume group."
11553 #: ../src/guestfs-actions.pod:3971
11554 msgid "(Added in 1.3.3)"
11558 #: ../src/guestfs-actions.pod:3973
11559 msgid "guestfs_lvs"
11563 #: ../src/guestfs-actions.pod:3975
11567 " guestfs_lvs (guestfs_h *g);\n"
11572 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2715
11574 "List all the logical volumes detected. This is the equivalent of the "
11575 "L<lvs(8)> command."
11579 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2718
11581 "This returns a list of the logical volume device names "
11582 "(eg. C</dev/VolGroup00/LogVol00>)."
11586 #: ../src/guestfs-actions.pod:3984
11587 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
11591 #: ../src/guestfs-actions.pod:3992
11592 msgid "guestfs_lvs_full"
11596 #: ../src/guestfs-actions.pod:3994
11599 " struct guestfs_lvm_lv_list *\n"
11600 " guestfs_lvs_full (guestfs_h *g);\n"
11605 #: ../src/guestfs-actions.pod:3997 ../fish/guestfish-actions.pod:2727
11607 "List all the logical volumes detected. This is the equivalent of the "
11608 "L<lvs(8)> command. The \"full\" version includes all fields."
11612 #: ../src/guestfs-actions.pod:4000
11614 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
11615 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
11620 #: ../src/guestfs-actions.pod:4006
11621 msgid "guestfs_lvuuid"
11625 #: ../src/guestfs-actions.pod:4008
11629 " guestfs_lvuuid (guestfs_h *g,\n"
11630 " const char *device);\n"
11635 #: ../src/guestfs-actions.pod:4012 ../fish/guestfish-actions.pod:2734
11636 msgid "This command returns the UUID of the LVM LV C<device>."
11640 #: ../src/guestfs-actions.pod:4019
11641 msgid "guestfs_lxattrlist"
11645 #: ../src/guestfs-actions.pod:4021
11648 " struct guestfs_xattr_list *\n"
11649 " guestfs_lxattrlist (guestfs_h *g,\n"
11650 " const char *path,\n"
11651 " char *const *names);\n"
11656 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2740
11658 "This call allows you to get the extended attributes of multiple files, where "
11659 "all files are in the directory C<path>. C<names> is the list of files from "
11664 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2744
11666 "On return you get a flat list of xattr structs which must be interpreted "
11667 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11668 "C<attrval> in this struct is zero-length to indicate there was an error "
11669 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11670 "number (the number of following attributes for this file, which could be "
11671 "C<\"0\">). Then after the first xattr struct are the zero or more "
11672 "attributes for the first named file. This repeats for the second and "
11673 "subsequent files."
11677 #: ../src/guestfs-actions.pod:4040
11679 "This call is intended for programs that want to efficiently list a directory "
11680 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11681 "a similarly efficient call for getting standard stats. Very long directory "
11682 "listings might cause the protocol message size to be exceeded, causing this "
11683 "call to fail. The caller must split up such requests into smaller groups of "
11688 #: ../src/guestfs-actions.pod:4054
11689 msgid "guestfs_mkdir"
11693 #: ../src/guestfs-actions.pod:4056
11697 " guestfs_mkdir (guestfs_h *g,\n"
11698 " const char *path);\n"
11703 #: ../src/guestfs-actions.pod:4060 ../fish/guestfish-actions.pod:2766
11704 msgid "Create a directory named C<path>."
11708 #: ../src/guestfs-actions.pod:4066
11709 msgid "guestfs_mkdir_mode"
11713 #: ../src/guestfs-actions.pod:4068
11717 " guestfs_mkdir_mode (guestfs_h *g,\n"
11718 " const char *path,\n"
11724 #: ../src/guestfs-actions.pod:4073 ../fish/guestfish-actions.pod:2772
11726 "This command creates a directory, setting the initial permissions of the "
11727 "directory to C<mode>."
11731 #: ../src/guestfs-actions.pod:4076 ../fish/guestfish-actions.pod:2775
11733 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11734 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11739 #: ../src/guestfs-actions.pod:4080
11740 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11744 #: ../src/guestfs-actions.pod:4086
11745 msgid "guestfs_mkdir_p"
11749 #: ../src/guestfs-actions.pod:4088
11753 " guestfs_mkdir_p (guestfs_h *g,\n"
11754 " const char *path);\n"
11759 #: ../src/guestfs-actions.pod:4092 ../fish/guestfish-actions.pod:2785
11761 "Create a directory named C<path>, creating any parent directories as "
11762 "necessary. This is like the C<mkdir -p> shell command."
11766 #: ../src/guestfs-actions.pod:4099
11767 msgid "guestfs_mkdtemp"
11771 #: ../src/guestfs-actions.pod:4101
11775 " guestfs_mkdtemp (guestfs_h *g,\n"
11776 " const char *template);\n"
11781 #: ../src/guestfs-actions.pod:4105 ../fish/guestfish-actions.pod:2792
11783 "This command creates a temporary directory. The C<template> parameter "
11784 "should be a full pathname for the temporary directory name with the final "
11785 "six characters being \"XXXXXX\"."
11789 #: ../src/guestfs-actions.pod:4110 ../fish/guestfish-actions.pod:2797
11791 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11792 "being suitable for Windows filesystems."
11796 #: ../src/guestfs-actions.pod:4113 ../fish/guestfish-actions.pod:2800
11797 msgid "The name of the temporary directory that was created is returned."
11801 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2803
11802 msgid "The temporary directory is created with mode 0700 and is owned by root."
11806 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2806
11808 "The caller is responsible for deleting the temporary directory and its "
11809 "contents after use."
11813 #: ../src/guestfs-actions.pod:4122 ../fish/guestfish-actions.pod:2809
11814 msgid "See also: L<mkdtemp(3)>"
11818 #: ../src/guestfs-actions.pod:4129
11819 msgid "guestfs_mke2fs_J"
11823 #: ../src/guestfs-actions.pod:4131
11827 " guestfs_mke2fs_J (guestfs_h *g,\n"
11828 " const char *fstype,\n"
11829 " int blocksize,\n"
11830 " const char *device,\n"
11831 " const char *journal);\n"
11836 #: ../src/guestfs-actions.pod:4138 ../fish/guestfish-actions.pod:2815
11838 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11839 "C<journal>. It is equivalent to the command:"
11843 #: ../src/guestfs-actions.pod:4142 ../fish/guestfish-actions.pod:2819
11846 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11851 #: ../src/guestfs-actions.pod:4144
11852 msgid "See also C<guestfs_mke2journal>."
11856 #: ../src/guestfs-actions.pod:4148 ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4184 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4214 ../src/guestfs-actions.pod:4228 ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4552
11857 msgid "(Added in 1.0.68)"
11861 #: ../src/guestfs-actions.pod:4150
11862 msgid "guestfs_mke2fs_JL"
11866 #: ../src/guestfs-actions.pod:4152
11870 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11871 " const char *fstype,\n"
11872 " int blocksize,\n"
11873 " const char *device,\n"
11874 " const char *label);\n"
11879 #: ../src/guestfs-actions.pod:4159 ../fish/guestfish-actions.pod:2827
11881 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11882 "the journal labeled C<label>."
11886 #: ../src/guestfs-actions.pod:4162
11887 msgid "See also C<guestfs_mke2journal_L>."
11891 #: ../src/guestfs-actions.pod:4168
11892 msgid "guestfs_mke2fs_JU"
11896 #: ../src/guestfs-actions.pod:4170
11900 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11901 " const char *fstype,\n"
11902 " int blocksize,\n"
11903 " const char *device,\n"
11904 " const char *uuid);\n"
11909 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2836
11911 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11912 "the journal with UUID C<uuid>."
11916 #: ../src/guestfs-actions.pod:4180
11917 msgid "See also C<guestfs_mke2journal_U>."
11921 #: ../src/guestfs-actions.pod:4186
11922 msgid "guestfs_mke2journal"
11926 #: ../src/guestfs-actions.pod:4188
11930 " guestfs_mke2journal (guestfs_h *g,\n"
11931 " int blocksize,\n"
11932 " const char *device);\n"
11937 #: ../src/guestfs-actions.pod:4193 ../fish/guestfish-actions.pod:2845
11939 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11944 #: ../src/guestfs-actions.pod:4196 ../fish/guestfish-actions.pod:2848
11947 " mke2fs -O journal_dev -b blocksize device\n"
11952 #: ../src/guestfs-actions.pod:4202
11953 msgid "guestfs_mke2journal_L"
11957 #: ../src/guestfs-actions.pod:4204
11961 " guestfs_mke2journal_L (guestfs_h *g,\n"
11962 " int blocksize,\n"
11963 " const char *label,\n"
11964 " const char *device);\n"
11969 #: ../src/guestfs-actions.pod:4210 ../fish/guestfish-actions.pod:2854
11970 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11974 #: ../src/guestfs-actions.pod:4216
11975 msgid "guestfs_mke2journal_U"
11979 #: ../src/guestfs-actions.pod:4218
11983 " guestfs_mke2journal_U (guestfs_h *g,\n"
11984 " int blocksize,\n"
11985 " const char *uuid,\n"
11986 " const char *device);\n"
11991 #: ../src/guestfs-actions.pod:4224 ../fish/guestfish-actions.pod:2860
11992 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11996 #: ../src/guestfs-actions.pod:4230
11997 msgid "guestfs_mkfifo"
12001 #: ../src/guestfs-actions.pod:4232
12005 " guestfs_mkfifo (guestfs_h *g,\n"
12007 " const char *path);\n"
12012 #: ../src/guestfs-actions.pod:4237
12014 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12015 "is just a convenient wrapper around C<guestfs_mknod>."
12019 #: ../src/guestfs-actions.pod:4247
12020 msgid "guestfs_mkfs"
12024 #: ../src/guestfs-actions.pod:4249
12028 " guestfs_mkfs (guestfs_h *g,\n"
12029 " const char *fstype,\n"
12030 " const char *device);\n"
12035 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2876
12037 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12038 "volume). The filesystem type is C<fstype>, for example C<ext3>."
12042 #: ../src/guestfs-actions.pod:4262
12043 msgid "guestfs_mkfs_b"
12047 #: ../src/guestfs-actions.pod:4264
12051 " guestfs_mkfs_b (guestfs_h *g,\n"
12052 " const char *fstype,\n"
12053 " int blocksize,\n"
12054 " const char *device);\n"
12059 #: ../src/guestfs-actions.pod:4270
12061 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
12062 "block size of the resulting filesystem. Supported block sizes depend on the "
12063 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
12067 #: ../src/guestfs-actions.pod:4275 ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:2889 ../fish/guestfish-actions.pod:2916
12069 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
12074 #: ../src/guestfs-actions.pod:4280 ../fish/guestfish-actions.pod:2892
12076 "This function is deprecated. In new code, use the C<mkfs_opts> call "
12081 #: ../src/guestfs-actions.pod:4289
12082 msgid "guestfs_mkfs_opts"
12086 #: ../src/guestfs-actions.pod:4291
12090 " guestfs_mkfs_opts (guestfs_h *g,\n"
12091 " const char *fstype,\n"
12092 " const char *device,\n"
12098 #: ../src/guestfs-actions.pod:4302
12101 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
12102 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
12107 #: ../src/guestfs-actions.pod:4305 ../fish/guestfish-actions.pod:2903
12109 "This function creates a filesystem on C<device>. The filesystem type is "
12110 "C<fstype>, for example C<ext3>."
12114 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:2910
12115 msgid "C<blocksize>"
12119 #: ../src/guestfs-actions.pod:4314 ../fish/guestfish-actions.pod:2912
12121 "The filesystem block size. Supported block sizes depend on the filesystem "
12122 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
12127 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2919
12128 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
12132 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2921
12133 msgid "C<features>"
12137 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2923
12138 msgid "This passes the C<-O> parameter to the external mkfs program."
12142 #: ../src/guestfs-actions.pod:4327 ../fish/guestfish-actions.pod:2925
12144 "For certain filesystem types, this allows extra filesystem features to be "
12145 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
12149 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2929
12151 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
12156 #: ../src/guestfs-actions.pod:4338
12157 msgid "(Added in 1.7.19)"
12161 #: ../src/guestfs-actions.pod:4340
12162 msgid "guestfs_mkfs_opts_va"
12166 #: ../src/guestfs-actions.pod:4342
12170 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
12171 " const char *fstype,\n"
12172 " const char *device,\n"
12173 " va_list args);\n"
12178 #: ../src/guestfs-actions.pod:4348
12179 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
12183 #: ../src/guestfs-actions.pod:4352
12184 msgid "guestfs_mkfs_opts_argv"
12188 #: ../src/guestfs-actions.pod:4354
12192 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
12193 " const char *fstype,\n"
12194 " const char *device,\n"
12195 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12200 #: ../src/guestfs-actions.pod:4360
12201 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12205 #: ../src/guestfs-actions.pod:4364
12206 msgid "guestfs_mkmountpoint"
12210 #: ../src/guestfs-actions.pod:4366
12214 " guestfs_mkmountpoint (guestfs_h *g,\n"
12215 " const char *exemptpath);\n"
12220 #: ../src/guestfs-actions.pod:4370
12222 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12223 "that can be used to create extra mountpoints before mounting the first "
12228 #: ../src/guestfs-actions.pod:4374 ../fish/guestfish-actions.pod:2944
12230 "These calls are I<only> necessary in some very limited circumstances, mainly "
12231 "the case where you want to mount a mix of unrelated and/or read-only "
12232 "filesystems together."
12236 #: ../src/guestfs-actions.pod:4378 ../fish/guestfish-actions.pod:2948
12238 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12239 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12240 "inside that. You can unpack this as follows in guestfish:"
12244 #: ../src/guestfs-actions.pod:4383 ../fish/guestfish-actions.pod:2953
12247 " add-ro Fedora-11-i686-Live.iso\n"
12249 " mkmountpoint /cd\n"
12250 " mkmountpoint /sqsh\n"
12251 " mkmountpoint /ext3fs\n"
12252 " mount /dev/sda /cd\n"
12253 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12254 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12259 #: ../src/guestfs-actions.pod:4392 ../fish/guestfish-actions.pod:2962
12260 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12264 #: ../src/guestfs-actions.pod:4394
12266 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12267 "may get unexpected errors if you try to mix these calls. It is safest to "
12268 "manually unmount filesystems and remove mountpoints after use."
12272 #: ../src/guestfs-actions.pod:4398
12274 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12275 "first, so for this to work for manual mountpoints, you must ensure that the "
12276 "innermost mountpoints have the longest pathnames, as in the example code "
12281 #: ../src/guestfs-actions.pod:4403 ../fish/guestfish-actions.pod:2973
12282 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12286 #: ../src/guestfs-actions.pod:4405
12288 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12289 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
12290 "can also trigger these issues."
12294 #: ../src/guestfs-actions.pod:4411 ../src/guestfs-actions.pod:4670 ../src/guestfs-actions.pod:5580
12295 msgid "(Added in 1.0.62)"
12299 #: ../src/guestfs-actions.pod:4413
12300 msgid "guestfs_mknod"
12304 #: ../src/guestfs-actions.pod:4415
12308 " guestfs_mknod (guestfs_h *g,\n"
12312 " const char *path);\n"
12317 #: ../src/guestfs-actions.pod:4422 ../fish/guestfish-actions.pod:2983
12319 "This call creates block or character special devices, or named pipes "
12324 #: ../src/guestfs-actions.pod:4425 ../fish/guestfish-actions.pod:2986
12326 "The C<mode> parameter should be the mode, using the standard constants. "
12327 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12328 "used when creating block and character special devices."
12332 #: ../src/guestfs-actions.pod:4430
12334 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12335 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12336 "regular file). These constants are available in the standard Linux header "
12337 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12338 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12339 "the appropriate constant for you."
12343 #: ../src/guestfs-actions.pod:4444
12344 msgid "guestfs_mknod_b"
12348 #: ../src/guestfs-actions.pod:4446
12352 " guestfs_mknod_b (guestfs_h *g,\n"
12356 " const char *path);\n"
12361 #: ../src/guestfs-actions.pod:4453
12363 "This call creates a block device node called C<path> with mode C<mode> and "
12364 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12365 "wrapper around C<guestfs_mknod>."
12369 #: ../src/guestfs-actions.pod:4463
12370 msgid "guestfs_mknod_c"
12374 #: ../src/guestfs-actions.pod:4465
12378 " guestfs_mknod_c (guestfs_h *g,\n"
12382 " const char *path);\n"
12387 #: ../src/guestfs-actions.pod:4472
12389 "This call creates a char device node called C<path> with mode C<mode> and "
12390 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12391 "wrapper around C<guestfs_mknod>."
12395 #: ../src/guestfs-actions.pod:4482
12396 msgid "guestfs_mkswap"
12400 #: ../src/guestfs-actions.pod:4484
12404 " guestfs_mkswap (guestfs_h *g,\n"
12405 " const char *device);\n"
12410 #: ../src/guestfs-actions.pod:4488 ../fish/guestfish-actions.pod:3025
12411 msgid "Create a swap partition on C<device>."
12415 #: ../src/guestfs-actions.pod:4494
12416 msgid "guestfs_mkswap_L"
12420 #: ../src/guestfs-actions.pod:4496
12424 " guestfs_mkswap_L (guestfs_h *g,\n"
12425 " const char *label,\n"
12426 " const char *device);\n"
12431 #: ../src/guestfs-actions.pod:4501 ../fish/guestfish-actions.pod:3031
12432 msgid "Create a swap partition on C<device> with label C<label>."
12436 #: ../src/guestfs-actions.pod:4503 ../fish/guestfish-actions.pod:3033
12438 "Note that you cannot attach a swap label to a block device "
12439 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12440 "the kernel or swap tools."
12444 #: ../src/guestfs-actions.pod:4511
12445 msgid "guestfs_mkswap_U"
12449 #: ../src/guestfs-actions.pod:4513
12453 " guestfs_mkswap_U (guestfs_h *g,\n"
12454 " const char *uuid,\n"
12455 " const char *device);\n"
12460 #: ../src/guestfs-actions.pod:4518 ../fish/guestfish-actions.pod:3041
12461 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12465 #: ../src/guestfs-actions.pod:4524
12466 msgid "guestfs_mkswap_file"
12470 #: ../src/guestfs-actions.pod:4526
12474 " guestfs_mkswap_file (guestfs_h *g,\n"
12475 " const char *path);\n"
12480 #: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3047
12481 msgid "Create a swap file."
12485 #: ../src/guestfs-actions.pod:4532
12487 "This command just writes a swap file signature to an existing file. To "
12488 "create the file itself, use something like C<guestfs_fallocate>."
12492 #: ../src/guestfs-actions.pod:4539
12493 msgid "guestfs_modprobe"
12497 #: ../src/guestfs-actions.pod:4541
12501 " guestfs_modprobe (guestfs_h *g,\n"
12502 " const char *modulename);\n"
12507 #: ../src/guestfs-actions.pod:4545 ../fish/guestfish-actions.pod:3056
12508 msgid "This loads a kernel module in the appliance."
12512 #: ../src/guestfs-actions.pod:4547 ../fish/guestfish-actions.pod:3058
12514 "The kernel module must have been whitelisted when libguestfs was built (see "
12515 "C<appliance/kmod.whitelist.in> in the source)."
12519 #: ../src/guestfs-actions.pod:4554
12520 msgid "guestfs_mount"
12524 #: ../src/guestfs-actions.pod:4556
12528 " guestfs_mount (guestfs_h *g,\n"
12529 " const char *device,\n"
12530 " const char *mountpoint);\n"
12535 #: ../src/guestfs-actions.pod:4561 ../fish/guestfish-actions.pod:3065
12537 "Mount a guest disk at a position in the filesystem. Block devices are named "
12538 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12539 "those block devices contain partitions, they will have the usual names "
12540 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12544 #: ../src/guestfs-actions.pod:4567 ../fish/guestfish-actions.pod:3071
12546 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12547 "mounted on C</> before others can be mounted. Other filesystems can only be "
12548 "mounted on directories which already exist."
12552 #: ../src/guestfs-actions.pod:4572 ../fish/guestfish-actions.pod:3076
12554 "The mounted filesystem is writable, if we have sufficient permissions on the "
12555 "underlying device."
12559 #: ../src/guestfs-actions.pod:4575
12561 "B<Important note:> When you use this call, the filesystem options C<sync> "
12562 "and C<noatime> are set implicitly. This was originally done because we "
12563 "thought it would improve reliability, but it turns out that I<-o sync> has a "
12564 "very large negative performance impact and negligible effect on "
12565 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
12566 "in any code that needs performance, and instead use C<guestfs_mount_options> "
12567 "(use an empty string for the first parameter if you don't want any options)."
12571 #: ../src/guestfs-actions.pod:4589
12572 msgid "guestfs_mount_loop"
12576 #: ../src/guestfs-actions.pod:4591
12580 " guestfs_mount_loop (guestfs_h *g,\n"
12581 " const char *file,\n"
12582 " const char *mountpoint);\n"
12587 #: ../src/guestfs-actions.pod:4596 ../fish/guestfish-actions.pod:3093
12589 "This command lets you mount C<file> (a filesystem image in a file) on a "
12590 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12595 #: ../src/guestfs-actions.pod:4604
12596 msgid "guestfs_mount_options"
12600 #: ../src/guestfs-actions.pod:4606
12604 " guestfs_mount_options (guestfs_h *g,\n"
12605 " const char *options,\n"
12606 " const char *device,\n"
12607 " const char *mountpoint);\n"
12612 #: ../src/guestfs-actions.pod:4612
12614 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12615 "the mount options as for the L<mount(8)> I<-o> flag."
12619 #: ../src/guestfs-actions.pod:4616 ../fish/guestfish-actions.pod:3105
12621 "If the C<options> parameter is an empty string, then no options are passed "
12622 "(all options default to whatever the filesystem uses)."
12626 #: ../src/guestfs-actions.pod:4622 ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4653
12627 msgid "(Added in 1.0.10)"
12631 #: ../src/guestfs-actions.pod:4624
12632 msgid "guestfs_mount_ro"
12636 #: ../src/guestfs-actions.pod:4626
12640 " guestfs_mount_ro (guestfs_h *g,\n"
12641 " const char *device,\n"
12642 " const char *mountpoint);\n"
12647 #: ../src/guestfs-actions.pod:4631
12649 "This is the same as the C<guestfs_mount> command, but it mounts the "
12650 "filesystem with the read-only (I<-o ro>) flag."
12654 #: ../src/guestfs-actions.pod:4638
12655 msgid "guestfs_mount_vfs"
12659 #: ../src/guestfs-actions.pod:4640
12663 " guestfs_mount_vfs (guestfs_h *g,\n"
12664 " const char *options,\n"
12665 " const char *vfstype,\n"
12666 " const char *device,\n"
12667 " const char *mountpoint);\n"
12672 #: ../src/guestfs-actions.pod:4647
12674 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12675 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
12680 #: ../src/guestfs-actions.pod:4655
12681 msgid "guestfs_mountpoints"
12685 #: ../src/guestfs-actions.pod:4657
12689 " guestfs_mountpoints (guestfs_h *g);\n"
12694 #: ../src/guestfs-actions.pod:4660
12696 "This call is similar to C<guestfs_mounts>. That call returns a list of "
12697 "devices. This one returns a hash table (map) of device name to directory "
12698 "where the device is mounted."
12702 #: ../src/guestfs-actions.pod:4672
12703 msgid "guestfs_mounts"
12707 #: ../src/guestfs-actions.pod:4674
12711 " guestfs_mounts (guestfs_h *g);\n"
12716 #: ../src/guestfs-actions.pod:4677 ../fish/guestfish-actions.pod:3136
12718 "This returns the list of currently mounted filesystems. It returns the list "
12719 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12723 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3139
12724 msgid "Some internal mounts are not shown."
12728 #: ../src/guestfs-actions.pod:4682
12729 msgid "See also: C<guestfs_mountpoints>"
12733 #: ../src/guestfs-actions.pod:4690
12738 #: ../src/guestfs-actions.pod:4692
12742 " guestfs_mv (guestfs_h *g,\n"
12743 " const char *src,\n"
12744 " const char *dest);\n"
12749 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3147
12751 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12752 "destination filename or destination directory."
12756 #: ../src/guestfs-actions.pod:4704
12757 msgid "guestfs_ntfs_3g_probe"
12761 #: ../src/guestfs-actions.pod:4706
12765 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12767 " const char *device);\n"
12772 #: ../src/guestfs-actions.pod:4711 ../fish/guestfish-actions.pod:3154
12774 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12775 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12776 "read-write, and some cannot be mounted at all)."
12780 #: ../src/guestfs-actions.pod:4715 ../fish/guestfish-actions.pod:3158
12782 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12783 "can be mounted read-write. Set it to false if you want to test if the "
12784 "volume can be mounted read-only."
12788 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3162
12790 "The return value is an integer which C<0> if the operation would succeed, or "
12791 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12795 #: ../src/guestfs-actions.pod:4725
12796 msgid "(Added in 1.0.43)"
12800 #: ../src/guestfs-actions.pod:4727
12801 msgid "guestfs_ntfsresize"
12805 #: ../src/guestfs-actions.pod:4729
12809 " guestfs_ntfsresize (guestfs_h *g,\n"
12810 " const char *device);\n"
12815 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3170
12817 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12818 "size of the underlying device. See also L<ntfsresize(8)>."
12822 #: ../src/guestfs-actions.pod:4741
12823 msgid "guestfs_ntfsresize_size"
12827 #: ../src/guestfs-actions.pod:4743
12831 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12832 " const char *device,\n"
12833 " int64_t size);\n"
12838 #: ../src/guestfs-actions.pod:4748
12840 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12841 "to specify the new size (in bytes) explicitly."
12845 #: ../src/guestfs-actions.pod:4753 ../src/guestfs-actions.pod:5189 ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5528 ../src/guestfs-actions.pod:7067
12846 msgid "(Added in 1.3.14)"
12850 #: ../src/guestfs-actions.pod:4755
12851 msgid "guestfs_part_add"
12855 #: ../src/guestfs-actions.pod:4757
12859 " guestfs_part_add (guestfs_h *g,\n"
12860 " const char *device,\n"
12861 " const char *prlogex,\n"
12862 " int64_t startsect,\n"
12863 " int64_t endsect);\n"
12868 #: ../src/guestfs-actions.pod:4764
12870 "This command adds a partition to C<device>. If there is no partition table "
12871 "on the device, call C<guestfs_part_init> first."
12875 #: ../src/guestfs-actions.pod:4767 ../fish/guestfish-actions.pod:3188
12877 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12878 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12879 "C<logical>) and C<e> (or C<extended>) partition types."
12883 #: ../src/guestfs-actions.pod:4772 ../fish/guestfish-actions.pod:3193
12885 "C<startsect> and C<endsect> are the start and end of the partition in "
12886 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12887 "from the end of the disk (C<-1> is the last sector)."
12891 #: ../src/guestfs-actions.pod:4776
12893 "Creating a partition which covers the whole disk is not so easy. Use "
12894 "C<guestfs_part_disk> to do that."
12898 #: ../src/guestfs-actions.pod:4781 ../src/guestfs-actions.pod:4819 ../src/guestfs-actions.pod:4872 ../src/guestfs-actions.pod:4950 ../src/guestfs-actions.pod:4988 ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5047
12899 msgid "(Added in 1.0.78)"
12903 #: ../src/guestfs-actions.pod:4783
12904 msgid "guestfs_part_del"
12908 #: ../src/guestfs-actions.pod:4785
12912 " guestfs_part_del (guestfs_h *g,\n"
12913 " const char *device,\n"
12919 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3204
12920 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12924 #: ../src/guestfs-actions.pod:4792 ../fish/guestfish-actions.pod:3206
12926 "Note that in the case of MBR partitioning, deleting an extended partition "
12927 "also deletes any logical partitions it contains."
12931 #: ../src/guestfs-actions.pod:4800
12932 msgid "guestfs_part_disk"
12936 #: ../src/guestfs-actions.pod:4802
12940 " guestfs_part_disk (guestfs_h *g,\n"
12941 " const char *device,\n"
12942 " const char *parttype);\n"
12947 #: ../src/guestfs-actions.pod:4807
12949 "This command is simply a combination of C<guestfs_part_init> followed by "
12950 "C<guestfs_part_add> to create a single primary partition covering the whole "
12955 #: ../src/guestfs-actions.pod:4811
12957 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12958 "possible values are described in C<guestfs_part_init>."
12962 #: ../src/guestfs-actions.pod:4821
12963 msgid "guestfs_part_get_bootable"
12967 #: ../src/guestfs-actions.pod:4823
12971 " guestfs_part_get_bootable (guestfs_h *g,\n"
12972 " const char *device,\n"
12978 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3228
12980 "This command returns true if the partition C<partnum> on C<device> has the "
12981 "bootable flag set."
12985 #: ../src/guestfs-actions.pod:4831
12986 msgid "See also C<guestfs_part_set_bootable>."
12990 #: ../src/guestfs-actions.pod:4837
12991 msgid "guestfs_part_get_mbr_id"
12995 #: ../src/guestfs-actions.pod:4839
12999 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
13000 " const char *device,\n"
13006 #: ../src/guestfs-actions.pod:4844 ../fish/guestfish-actions.pod:3237
13008 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13009 "partition C<partnum>."
13013 #: ../src/guestfs-actions.pod:4847 ../src/guestfs-actions.pod:5023
13015 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
13016 "undefined results for other partition table types (see "
13017 "C<guestfs_part_get_parttype>)."
13021 #: ../src/guestfs-actions.pod:4855
13022 msgid "guestfs_part_get_parttype"
13026 #: ../src/guestfs-actions.pod:4857
13030 " guestfs_part_get_parttype (guestfs_h *g,\n"
13031 " const char *device);\n"
13036 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3248
13038 "This command examines the partition table on C<device> and returns the "
13039 "partition table type (format) being used."
13043 #: ../src/guestfs-actions.pod:4864
13045 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
13046 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
13047 "possible, although unusual. See C<guestfs_part_init> for a full list."
13051 #: ../src/guestfs-actions.pod:4874
13052 msgid "guestfs_part_init"
13056 #: ../src/guestfs-actions.pod:4876
13060 " guestfs_part_init (guestfs_h *g,\n"
13061 " const char *device,\n"
13062 " const char *parttype);\n"
13067 #: ../src/guestfs-actions.pod:4881 ../fish/guestfish-actions.pod:3260
13069 "This creates an empty partition table on C<device> of one of the partition "
13070 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
13071 "(for large disks)."
13075 #: ../src/guestfs-actions.pod:4885
13077 "Initially there are no partitions. Following this, you should call "
13078 "C<guestfs_part_add> for each partition required."
13082 #: ../src/guestfs-actions.pod:4888 ../fish/guestfish-actions.pod:3267
13083 msgid "Possible values for C<parttype> are:"
13087 #: ../src/guestfs-actions.pod:4892 ../fish/guestfish-actions.pod:3271
13088 msgid "B<efi> | B<gpt>"
13092 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3273
13093 msgid "Intel EFI / GPT partition table."
13097 #: ../src/guestfs-actions.pod:4896 ../fish/guestfish-actions.pod:3275
13099 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
13100 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
13101 "the C<mbr> format."
13105 #: ../src/guestfs-actions.pod:4900 ../fish/guestfish-actions.pod:3279
13106 msgid "B<mbr> | B<msdos>"
13110 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3281
13112 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
13113 "Windows. This partition type will B<only> work for device sizes up to 2 "
13114 "TB. For large disks we recommend using C<gpt>."
13118 #: ../src/guestfs-actions.pod:4909 ../fish/guestfish-actions.pod:3288
13119 msgid "Other partition table types that may work but are not supported include:"
13123 #: ../src/guestfs-actions.pod:4914 ../fish/guestfish-actions.pod:3293
13128 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3295
13129 msgid "AIX disk labels."
13133 #: ../src/guestfs-actions.pod:4918 ../fish/guestfish-actions.pod:3297
13134 msgid "B<amiga> | B<rdb>"
13138 #: ../src/guestfs-actions.pod:4920 ../fish/guestfish-actions.pod:3299
13139 msgid "Amiga \"Rigid Disk Block\" format."
13143 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3301
13148 #: ../src/guestfs-actions.pod:4924 ../fish/guestfish-actions.pod:3303
13149 msgid "BSD disk labels."
13153 #: ../src/guestfs-actions.pod:4926 ../fish/guestfish-actions.pod:3305
13158 #: ../src/guestfs-actions.pod:4928 ../fish/guestfish-actions.pod:3307
13159 msgid "DASD, used on IBM mainframes."
13163 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3309
13168 #: ../src/guestfs-actions.pod:4932 ../fish/guestfish-actions.pod:3311
13169 msgid "MIPS/SGI volumes."
13173 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3313
13178 #: ../src/guestfs-actions.pod:4936 ../fish/guestfish-actions.pod:3315
13179 msgid "Old Mac partition format. Modern Macs use C<gpt>."
13183 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3317
13188 #: ../src/guestfs-actions.pod:4940 ../fish/guestfish-actions.pod:3319
13189 msgid "NEC PC-98 format, common in Japan apparently."
13193 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3321
13198 #: ../src/guestfs-actions.pod:4944 ../fish/guestfish-actions.pod:3323
13199 msgid "Sun disk labels."
13203 #: ../src/guestfs-actions.pod:4952
13204 msgid "guestfs_part_list"
13208 #: ../src/guestfs-actions.pod:4954
13211 " struct guestfs_partition_list *\n"
13212 " guestfs_part_list (guestfs_h *g,\n"
13213 " const char *device);\n"
13218 #: ../src/guestfs-actions.pod:4958 ../fish/guestfish-actions.pod:3331
13220 "This command parses the partition table on C<device> and returns the list of "
13221 "partitions found."
13225 #: ../src/guestfs-actions.pod:4961 ../fish/guestfish-actions.pod:3334
13226 msgid "The fields in the returned structure are:"
13230 #: ../src/guestfs-actions.pod:4965 ../fish/guestfish-actions.pod:3338
13231 msgid "B<part_num>"
13235 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3340
13236 msgid "Partition number, counting from 1."
13240 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3342
13241 msgid "B<part_start>"
13245 #: ../src/guestfs-actions.pod:4971
13247 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13248 "the device's sector size, see C<guestfs_blockdev_getss>."
13252 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3347
13253 msgid "B<part_end>"
13257 #: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3349
13258 msgid "End of the partition in bytes."
13262 #: ../src/guestfs-actions.pod:4978 ../fish/guestfish-actions.pod:3351
13263 msgid "B<part_size>"
13267 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3353
13268 msgid "Size of the partition in bytes."
13272 #: ../src/guestfs-actions.pod:4984
13274 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13275 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13280 #: ../src/guestfs-actions.pod:4990
13281 msgid "guestfs_part_set_bootable"
13285 #: ../src/guestfs-actions.pod:4992
13289 " guestfs_part_set_bootable (guestfs_h *g,\n"
13290 " const char *device,\n"
13292 " int bootable);\n"
13297 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3361
13299 "This sets the bootable flag on partition numbered C<partnum> on device "
13300 "C<device>. Note that partitions are numbered from 1."
13304 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3364
13306 "The bootable flag is used by some operating systems (notably Windows) to "
13307 "determine which partition to boot from. It is by no means universally "
13312 #: ../src/guestfs-actions.pod:5009
13313 msgid "guestfs_part_set_mbr_id"
13317 #: ../src/guestfs-actions.pod:5011
13321 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13322 " const char *device,\n"
13329 #: ../src/guestfs-actions.pod:5017 ../fish/guestfish-actions.pod:3372
13331 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13332 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13333 "documentation are in fact hexadecimal numbers, but usually documented "
13334 "without any leading \"0x\" which might be confusing."
13338 #: ../src/guestfs-actions.pod:5031
13339 msgid "guestfs_part_set_name"
13343 #: ../src/guestfs-actions.pod:5033
13347 " guestfs_part_set_name (guestfs_h *g,\n"
13348 " const char *device,\n"
13350 " const char *name);\n"
13355 #: ../src/guestfs-actions.pod:5039 ../fish/guestfish-actions.pod:3386
13357 "This sets the partition name on partition numbered C<partnum> on device "
13358 "C<device>. Note that partitions are numbered from 1."
13362 #: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3389
13364 "The partition name can only be set on certain types of partition table. "
13365 "This works on C<gpt> but not on C<mbr> partitions."
13369 #: ../src/guestfs-actions.pod:5049
13370 msgid "guestfs_part_to_dev"
13374 #: ../src/guestfs-actions.pod:5051
13378 " guestfs_part_to_dev (guestfs_h *g,\n"
13379 " const char *partition);\n"
13384 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3396
13386 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13387 "partition number, returning the device name (eg. \"/dev/sdb\")."
13391 #: ../src/guestfs-actions.pod:5059
13393 "The named partition must exist, for example as a string returned from "
13394 "C<guestfs_list_partitions>."
13398 #: ../src/guestfs-actions.pod:5067
13399 msgid "guestfs_ping_daemon"
13403 #: ../src/guestfs-actions.pod:5069
13407 " guestfs_ping_daemon (guestfs_h *g);\n"
13412 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3407
13414 "This is a test probe into the guestfs daemon running inside the qemu "
13415 "subprocess. Calling this function checks that the daemon responds to the "
13416 "ping message, without affecting the daemon or attached block device(s) in "
13421 #: ../src/guestfs-actions.pod:5081
13422 msgid "guestfs_pread"
13426 #: ../src/guestfs-actions.pod:5083
13430 " guestfs_pread (guestfs_h *g,\n"
13431 " const char *path,\n"
13433 " int64_t offset,\n"
13434 " size_t *size_r);\n"
13439 #: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3416
13441 "This command lets you read part of a file. It reads C<count> bytes of the "
13442 "file, starting at C<offset>, from file C<path>."
13446 #: ../src/guestfs-actions.pod:5093 ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3419 ../fish/guestfish-actions.pod:3434
13448 "This may read fewer bytes than requested. For further details see the "
13449 "L<pread(2)> system call."
13453 #: ../src/guestfs-actions.pod:5096
13454 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
13458 #: ../src/guestfs-actions.pod:5107
13459 msgid "guestfs_pread_device"
13463 #: ../src/guestfs-actions.pod:5109
13467 " guestfs_pread_device (guestfs_h *g,\n"
13468 " const char *device,\n"
13470 " int64_t offset,\n"
13471 " size_t *size_r);\n"
13476 #: ../src/guestfs-actions.pod:5116 ../fish/guestfish-actions.pod:3431
13478 "This command lets you read part of a file. It reads C<count> bytes of "
13479 "C<device>, starting at C<offset>."
13483 #: ../src/guestfs-actions.pod:5122
13484 msgid "See also C<guestfs_pread>."
13488 #: ../src/guestfs-actions.pod:5131
13489 msgid "(Added in 1.5.21)"
13493 #: ../src/guestfs-actions.pod:5133
13494 msgid "guestfs_pvcreate"
13498 #: ../src/guestfs-actions.pod:5135
13502 " guestfs_pvcreate (guestfs_h *g,\n"
13503 " const char *device);\n"
13508 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3446
13510 "This creates an LVM physical volume on the named C<device>, where C<device> "
13511 "should usually be a partition name such as C</dev/sda1>."
13515 #: ../src/guestfs-actions.pod:5147
13516 msgid "guestfs_pvremove"
13520 #: ../src/guestfs-actions.pod:5149
13524 " guestfs_pvremove (guestfs_h *g,\n"
13525 " const char *device);\n"
13530 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3454
13532 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13537 #: ../src/guestfs-actions.pod:5156 ../fish/guestfish-actions.pod:3457
13539 "The implementation uses the C<pvremove> command which refuses to wipe "
13540 "physical volumes that contain any volume groups, so you have to remove those "
13545 #: ../src/guestfs-actions.pod:5164
13546 msgid "guestfs_pvresize"
13550 #: ../src/guestfs-actions.pod:5166
13554 " guestfs_pvresize (guestfs_h *g,\n"
13555 " const char *device);\n"
13560 #: ../src/guestfs-actions.pod:5170 ../fish/guestfish-actions.pod:3465
13562 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13563 "the new size of the underlying device."
13567 #: ../src/guestfs-actions.pod:5177
13568 msgid "guestfs_pvresize_size"
13572 #: ../src/guestfs-actions.pod:5179
13576 " guestfs_pvresize_size (guestfs_h *g,\n"
13577 " const char *device,\n"
13578 " int64_t size);\n"
13583 #: ../src/guestfs-actions.pod:5184
13585 "This command is the same as C<guestfs_pvresize> except that it allows you to "
13586 "specify the new size (in bytes) explicitly."
13590 #: ../src/guestfs-actions.pod:5191
13591 msgid "guestfs_pvs"
13595 #: ../src/guestfs-actions.pod:5193
13599 " guestfs_pvs (guestfs_h *g);\n"
13604 #: ../src/guestfs-actions.pod:5196 ../fish/guestfish-actions.pod:3479
13606 "List all the physical volumes detected. This is the equivalent of the "
13607 "L<pvs(8)> command."
13611 #: ../src/guestfs-actions.pod:5199 ../fish/guestfish-actions.pod:3482
13613 "This returns a list of just the device names that contain PVs "
13614 "(eg. C</dev/sda2>)."
13618 #: ../src/guestfs-actions.pod:5202
13619 msgid "See also C<guestfs_pvs_full>."
13623 #: ../src/guestfs-actions.pod:5210
13624 msgid "guestfs_pvs_full"
13628 #: ../src/guestfs-actions.pod:5212
13631 " struct guestfs_lvm_pv_list *\n"
13632 " guestfs_pvs_full (guestfs_h *g);\n"
13637 #: ../src/guestfs-actions.pod:5215 ../fish/guestfish-actions.pod:3491
13639 "List all the physical volumes detected. This is the equivalent of the "
13640 "L<pvs(8)> command. The \"full\" version includes all fields."
13644 #: ../src/guestfs-actions.pod:5218
13646 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
13647 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
13652 #: ../src/guestfs-actions.pod:5224
13653 msgid "guestfs_pvuuid"
13657 #: ../src/guestfs-actions.pod:5226
13661 " guestfs_pvuuid (guestfs_h *g,\n"
13662 " const char *device);\n"
13667 #: ../src/guestfs-actions.pod:5230 ../fish/guestfish-actions.pod:3498
13668 msgid "This command returns the UUID of the LVM PV C<device>."
13672 #: ../src/guestfs-actions.pod:5237
13673 msgid "guestfs_pwrite"
13677 #: ../src/guestfs-actions.pod:5239
13681 " guestfs_pwrite (guestfs_h *g,\n"
13682 " const char *path,\n"
13683 " const char *content,\n"
13684 " size_t content_size,\n"
13685 " int64_t offset);\n"
13690 #: ../src/guestfs-actions.pod:5246 ../fish/guestfish-actions.pod:3504
13692 "This command writes to part of a file. It writes the data buffer C<content> "
13693 "to the file C<path> starting at offset C<offset>."
13697 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3507
13699 "This command implements the L<pwrite(2)> system call, and like that system "
13700 "call it may not write the full data requested. The return value is the "
13701 "number of bytes that were actually written to the file. This could even be "
13702 "0, although short writes are unlikely for regular files in ordinary "
13707 #: ../src/guestfs-actions.pod:5255
13708 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
13712 #: ../src/guestfs-actions.pod:5264
13713 msgid "guestfs_pwrite_device"
13717 #: ../src/guestfs-actions.pod:5266
13721 " guestfs_pwrite_device (guestfs_h *g,\n"
13722 " const char *device,\n"
13723 " const char *content,\n"
13724 " size_t content_size,\n"
13725 " int64_t offset);\n"
13730 #: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:3522
13732 "This command writes to part of a device. It writes the data buffer "
13733 "C<content> to C<device> starting at offset C<offset>."
13737 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3525
13739 "This command implements the L<pwrite(2)> system call, and like that system "
13740 "call it may not write the full data requested (although short writes to disk "
13741 "devices and partitions are probably impossible with standard Linux kernels)."
13745 #: ../src/guestfs-actions.pod:5281
13746 msgid "See also C<guestfs_pwrite>."
13750 #: ../src/guestfs-actions.pod:5288
13751 msgid "(Added in 1.5.20)"
13755 #: ../src/guestfs-actions.pod:5290
13756 msgid "guestfs_read_file"
13760 #: ../src/guestfs-actions.pod:5292
13764 " guestfs_read_file (guestfs_h *g,\n"
13765 " const char *path,\n"
13766 " size_t *size_r);\n"
13771 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3539
13772 msgid "This calls returns the contents of the file C<path> as a buffer."
13776 #: ../src/guestfs-actions.pod:5300
13778 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13779 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13780 "function is limited in the total size of file that can be handled."
13784 #: ../src/guestfs-actions.pod:5312
13785 msgid "(Added in 1.0.63)"
13789 #: ../src/guestfs-actions.pod:5314
13790 msgid "guestfs_read_lines"
13794 #: ../src/guestfs-actions.pod:5316
13798 " guestfs_read_lines (guestfs_h *g,\n"
13799 " const char *path);\n"
13804 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3556
13806 "The file contents are returned as a list of lines. Trailing C<LF> and "
13807 "C<CRLF> character sequences are I<not> returned."
13811 #: ../src/guestfs-actions.pod:5325
13813 "Note that this function cannot correctly handle binary files (specifically, "
13814 "files containing C<\\0> character which is treated as end of line). For "
13815 "those you need to use the C<guestfs_read_file> function which has a more "
13816 "complex interface."
13820 #: ../src/guestfs-actions.pod:5336
13821 msgid "guestfs_readdir"
13825 #: ../src/guestfs-actions.pod:5338
13828 " struct guestfs_dirent_list *\n"
13829 " guestfs_readdir (guestfs_h *g,\n"
13830 " const char *dir);\n"
13835 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3568
13836 msgid "This returns the list of directory entries in directory C<dir>."
13840 #: ../src/guestfs-actions.pod:5344 ../fish/guestfish-actions.pod:3570
13842 "All entries in the directory are returned, including C<.> and C<..>. The "
13843 "entries are I<not> sorted, but returned in the same order as the underlying "
13848 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3574
13850 "Also this call returns basic file type information about each file. The "
13851 "C<ftyp> field will contain one of the following characters:"
13855 #: ../src/guestfs-actions.pod:5353 ../fish/guestfish-actions.pod:3579
13860 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3581
13861 msgid "Block special"
13865 #: ../src/guestfs-actions.pod:5357 ../fish/guestfish-actions.pod:3583
13870 #: ../src/guestfs-actions.pod:5359 ../fish/guestfish-actions.pod:3585
13871 msgid "Char special"
13875 #: ../src/guestfs-actions.pod:5361 ../fish/guestfish-actions.pod:3587
13880 #: ../src/guestfs-actions.pod:5363 ../fish/guestfish-actions.pod:3589
13885 #: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:3591
13890 #: ../src/guestfs-actions.pod:5367 ../fish/guestfish-actions.pod:3593
13891 msgid "FIFO (named pipe)"
13895 #: ../src/guestfs-actions.pod:5369 ../fish/guestfish-actions.pod:3595
13900 #: ../src/guestfs-actions.pod:5371 ../fish/guestfish-actions.pod:3597
13901 msgid "Symbolic link"
13905 #: ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:3599
13910 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3601
13911 msgid "Regular file"
13915 #: ../src/guestfs-actions.pod:5377 ../fish/guestfish-actions.pod:3603
13920 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3605
13925 #: ../src/guestfs-actions.pod:5381 ../fish/guestfish-actions.pod:3607
13930 #: ../src/guestfs-actions.pod:5383 ../fish/guestfish-actions.pod:3609
13931 msgid "Unknown file type"
13935 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3611
13940 #: ../src/guestfs-actions.pod:5387 ../fish/guestfish-actions.pod:3613
13941 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13945 #: ../src/guestfs-actions.pod:5392
13947 "This function is primarily intended for use by programs. To get a simple "
13948 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13949 "consumption, use C<guestfs_ll>."
13953 #: ../src/guestfs-actions.pod:5396
13955 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13956 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
13961 #: ../src/guestfs-actions.pod:5402
13962 msgid "guestfs_readlink"
13966 #: ../src/guestfs-actions.pod:5404
13970 " guestfs_readlink (guestfs_h *g,\n"
13971 " const char *path);\n"
13976 #: ../src/guestfs-actions.pod:5408 ../fish/guestfish-actions.pod:3626
13977 msgid "This command reads the target of a symbolic link."
13981 #: ../src/guestfs-actions.pod:5415
13982 msgid "guestfs_readlinklist"
13986 #: ../src/guestfs-actions.pod:5417
13990 " guestfs_readlinklist (guestfs_h *g,\n"
13991 " const char *path,\n"
13992 " char *const *names);\n"
13997 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3632
13999 "This call allows you to do a C<readlink> operation on multiple files, where "
14000 "all files are in the directory C<path>. C<names> is the list of files from "
14005 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3636
14007 "On return you get a list of strings, with a one-to-one correspondence to the "
14008 "C<names> list. Each string is the value of the symbolic link."
14012 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3640
14014 "If the C<readlink(2)> operation fails on any name, then the corresponding "
14015 "result string is the empty string C<\"\">. However the whole operation is "
14016 "completed even if there were C<readlink(2)> errors, and so you can call this "
14017 "function with names where you don't know if they are symbolic links already "
14018 "(albeit slightly less efficient)."
14022 #: ../src/guestfs-actions.pod:5437 ../fish/guestfish-actions.pod:3647
14024 "This call is intended for programs that want to efficiently list a directory "
14025 "contents without making many round-trips. Very long directory listings "
14026 "might cause the protocol message size to be exceeded, causing this call to "
14027 "fail. The caller must split up such requests into smaller groups of names."
14031 #: ../src/guestfs-actions.pod:5450
14032 msgid "guestfs_realpath"
14036 #: ../src/guestfs-actions.pod:5452
14040 " guestfs_realpath (guestfs_h *g,\n"
14041 " const char *path);\n"
14046 #: ../src/guestfs-actions.pod:5456 ../fish/guestfish-actions.pod:3658
14048 "Return the canonicalized absolute pathname of C<path>. The returned path "
14049 "has no C<.>, C<..> or symbolic link path elements."
14053 #: ../src/guestfs-actions.pod:5464
14054 msgid "guestfs_removexattr"
14058 #: ../src/guestfs-actions.pod:5466
14062 " guestfs_removexattr (guestfs_h *g,\n"
14063 " const char *xattr,\n"
14064 " const char *path);\n"
14069 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3665
14070 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
14074 #: ../src/guestfs-actions.pod:5474
14075 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
14079 #: ../src/guestfs-actions.pod:5480
14080 msgid "guestfs_resize2fs"
14084 #: ../src/guestfs-actions.pod:5482
14088 " guestfs_resize2fs (guestfs_h *g,\n"
14089 " const char *device);\n"
14094 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3674
14096 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
14097 "underlying device."
14101 #: ../src/guestfs-actions.pod:5489
14103 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
14104 "C<device> before calling this command. For unknown reasons C<resize2fs> "
14105 "sometimes gives an error about this and sometimes not. In any case, it is "
14106 "always safe to call C<guestfs_e2fsck_f> before calling this function."
14110 #: ../src/guestfs-actions.pod:5499
14111 msgid "guestfs_resize2fs_M"
14115 #: ../src/guestfs-actions.pod:5501
14119 " guestfs_resize2fs_M (guestfs_h *g,\n"
14120 " const char *device);\n"
14125 #: ../src/guestfs-actions.pod:5505
14127 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
14128 "resized to its minimum size. This works like the C<-M> option to the "
14129 "C<resize2fs> command."
14133 #: ../src/guestfs-actions.pod:5509
14135 "To get the resulting size of the filesystem you should call "
14136 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
14137 "These two numbers, multiplied together, give the resulting size of the "
14138 "minimal filesystem in bytes."
14142 #: ../src/guestfs-actions.pod:5516
14143 msgid "guestfs_resize2fs_size"
14147 #: ../src/guestfs-actions.pod:5518
14151 " guestfs_resize2fs_size (guestfs_h *g,\n"
14152 " const char *device,\n"
14153 " int64_t size);\n"
14158 #: ../src/guestfs-actions.pod:5523
14160 "This command is the same as C<guestfs_resize2fs> except that it allows you "
14161 "to specify the new size (in bytes) explicitly."
14165 #: ../src/guestfs-actions.pod:5530
14170 #: ../src/guestfs-actions.pod:5532
14174 " guestfs_rm (guestfs_h *g,\n"
14175 " const char *path);\n"
14180 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3707
14181 msgid "Remove the single file C<path>."
14185 #: ../src/guestfs-actions.pod:5542
14186 msgid "guestfs_rm_rf"
14190 #: ../src/guestfs-actions.pod:5544
14194 " guestfs_rm_rf (guestfs_h *g,\n"
14195 " const char *path);\n"
14200 #: ../src/guestfs-actions.pod:5548 ../fish/guestfish-actions.pod:3713
14202 "Remove the file or directory C<path>, recursively removing the contents if "
14203 "its a directory. This is like the C<rm -rf> shell command."
14207 #: ../src/guestfs-actions.pod:5556
14208 msgid "guestfs_rmdir"
14212 #: ../src/guestfs-actions.pod:5558
14216 " guestfs_rmdir (guestfs_h *g,\n"
14217 " const char *path);\n"
14222 #: ../src/guestfs-actions.pod:5562 ../fish/guestfish-actions.pod:3721
14223 msgid "Remove the single directory C<path>."
14227 #: ../src/guestfs-actions.pod:5568
14228 msgid "guestfs_rmmountpoint"
14232 #: ../src/guestfs-actions.pod:5570
14236 " guestfs_rmmountpoint (guestfs_h *g,\n"
14237 " const char *exemptpath);\n"
14242 #: ../src/guestfs-actions.pod:5574
14244 "This calls removes a mountpoint that was previously created with "
14245 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14249 #: ../src/guestfs-actions.pod:5582
14250 msgid "guestfs_scrub_device"
14254 #: ../src/guestfs-actions.pod:5584
14258 " guestfs_scrub_device (guestfs_h *g,\n"
14259 " const char *device);\n"
14264 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3735
14266 "This command writes patterns over C<device> to make data retrieval more "
14271 #: ../src/guestfs-actions.pod:5591 ../src/guestfs-actions.pod:5612 ../src/guestfs-actions.pod:5631 ../fish/guestfish-actions.pod:3738 ../fish/guestfish-actions.pod:3753 ../fish/guestfish-actions.pod:3766
14273 "It is an interface to the L<scrub(1)> program. See that manual page for "
14278 #: ../src/guestfs-actions.pod:5599 ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:5636
14279 msgid "(Added in 1.0.52)"
14283 #: ../src/guestfs-actions.pod:5601
14284 msgid "guestfs_scrub_file"
14288 #: ../src/guestfs-actions.pod:5603
14292 " guestfs_scrub_file (guestfs_h *g,\n"
14293 " const char *file);\n"
14298 #: ../src/guestfs-actions.pod:5607 ../fish/guestfish-actions.pod:3748
14300 "This command writes patterns over a file to make data retrieval more "
14305 #: ../src/guestfs-actions.pod:5610 ../fish/guestfish-actions.pod:3751
14306 msgid "The file is I<removed> after scrubbing."
14310 #: ../src/guestfs-actions.pod:5619
14311 msgid "guestfs_scrub_freespace"
14315 #: ../src/guestfs-actions.pod:5621
14319 " guestfs_scrub_freespace (guestfs_h *g,\n"
14320 " const char *dir);\n"
14325 #: ../src/guestfs-actions.pod:5625
14327 "This command creates the directory C<dir> and then fills it with files until "
14328 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14329 "and deletes them. The intention is to scrub any free space on the partition "
14330 "containing C<dir>."
14334 #: ../src/guestfs-actions.pod:5638
14335 msgid "guestfs_set_append"
14339 #: ../src/guestfs-actions.pod:5640
14343 " guestfs_set_append (guestfs_h *g,\n"
14344 " const char *append);\n"
14349 #: ../src/guestfs-actions.pod:5644 ../fish/guestfish-actions.pod:3775
14351 "This function is used to add additional options to the guest kernel command "
14356 #: ../src/guestfs-actions.pod:5647 ../fish/guestfish-actions.pod:3778
14358 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14359 "environment variable."
14363 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3781
14365 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14366 "(libguestfs always adds a few of its own)."
14370 #: ../src/guestfs-actions.pod:5657
14371 msgid "guestfs_set_autosync"
14375 #: ../src/guestfs-actions.pod:5659
14379 " guestfs_set_autosync (guestfs_h *g,\n"
14380 " int autosync);\n"
14385 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3790
14387 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14388 "effort attempt to make filesystems consistent and synchronized when the "
14389 "handle is closed (also if the program exits without closing handles)."
14393 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3795
14395 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14396 "disabled by default)."
14400 #: ../src/guestfs-actions.pod:5675
14401 msgid "guestfs_set_direct"
14405 #: ../src/guestfs-actions.pod:5677
14409 " guestfs_set_direct (guestfs_h *g,\n"
14415 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3804
14417 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14418 "passed directly through to the appliance once it is launched."
14422 #: ../src/guestfs-actions.pod:5685
14424 "One consequence of this is that log messages aren't caught by the library "
14425 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
14430 #: ../src/guestfs-actions.pod:5689 ../fish/guestfish-actions.pod:3812
14431 msgid "You probably don't want to use this unless you know what you are doing."
14435 #: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3815
14436 msgid "The default is disabled."
14440 #: ../src/guestfs-actions.pod:5698
14441 msgid "guestfs_set_e2label"
14445 #: ../src/guestfs-actions.pod:5700
14449 " guestfs_set_e2label (guestfs_h *g,\n"
14450 " const char *device,\n"
14451 " const char *label);\n"
14456 #: ../src/guestfs-actions.pod:5705 ../fish/guestfish-actions.pod:3821
14458 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14459 "C<label>. Filesystem labels are limited to 16 characters."
14463 #: ../src/guestfs-actions.pod:5709
14465 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
14466 "the existing label on a filesystem."
14470 #: ../src/guestfs-actions.pod:5716
14471 msgid "guestfs_set_e2uuid"
14475 #: ../src/guestfs-actions.pod:5718
14479 " guestfs_set_e2uuid (guestfs_h *g,\n"
14480 " const char *device,\n"
14481 " const char *uuid);\n"
14486 #: ../src/guestfs-actions.pod:5723 ../fish/guestfish-actions.pod:3832
14488 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14489 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14490 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14494 #: ../src/guestfs-actions.pod:5728
14496 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
14497 "the existing UUID of a filesystem."
14501 #: ../src/guestfs-actions.pod:5735
14502 msgid "guestfs_set_memsize"
14506 #: ../src/guestfs-actions.pod:5737
14510 " guestfs_set_memsize (guestfs_h *g,\n"
14516 #: ../src/guestfs-actions.pod:5741
14518 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14519 "This only has any effect if called before C<guestfs_launch>."
14523 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3850
14525 "You can also change this by setting the environment variable "
14526 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14530 #: ../src/guestfs-actions.pod:5756
14531 msgid "guestfs_set_network"
14535 #: ../src/guestfs-actions.pod:5758
14539 " guestfs_set_network (guestfs_h *g,\n"
14545 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3863
14547 "If C<network> is true, then the network is enabled in the libguestfs "
14548 "appliance. The default is false."
14552 #: ../src/guestfs-actions.pod:5765 ../fish/guestfish-actions.pod:3866
14554 "This affects whether commands are able to access the network (see "
14555 "L<guestfs(3)/RUNNING COMMANDS>)."
14559 #: ../src/guestfs-actions.pod:5768
14561 "You must call this before calling C<guestfs_launch>, otherwise it has no "
14566 #: ../src/guestfs-actions.pod:5775
14567 msgid "guestfs_set_path"
14571 #: ../src/guestfs-actions.pod:5777
14575 " guestfs_set_path (guestfs_h *g,\n"
14576 " const char *searchpath);\n"
14581 #: ../src/guestfs-actions.pod:5781 ../fish/guestfish-actions.pod:3878
14582 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14586 #: ../src/guestfs-actions.pod:5783 ../fish/guestfish-actions.pod:3880
14588 "The default is C<$libdir/guestfs> unless overridden by setting "
14589 "C<LIBGUESTFS_PATH> environment variable."
14593 #: ../src/guestfs-actions.pod:5786 ../fish/guestfish-actions.pod:3883
14594 msgid "Setting C<path> to C<NULL> restores the default path."
14598 #: ../src/guestfs-actions.pod:5792
14599 msgid "guestfs_set_qemu"
14603 #: ../src/guestfs-actions.pod:5794
14607 " guestfs_set_qemu (guestfs_h *g,\n"
14608 " const char *qemu);\n"
14613 #: ../src/guestfs-actions.pod:5798 ../fish/guestfish-actions.pod:3891
14614 msgid "Set the qemu binary that we will use."
14618 #: ../src/guestfs-actions.pod:5800 ../fish/guestfish-actions.pod:3893
14619 msgid "The default is chosen when the library was compiled by the configure script."
14623 #: ../src/guestfs-actions.pod:5803 ../fish/guestfish-actions.pod:3896
14625 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14630 #: ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3899
14631 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14635 #: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3901
14637 "Note that you should call this function as early as possible after creating "
14638 "the handle. This is because some pre-launch operations depend on testing "
14639 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14640 "don't retest features, and so you might see inconsistent results. Using the "
14641 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14642 "the qemu binary at the same time as the handle is created."
14646 #: ../src/guestfs-actions.pod:5820
14647 msgid "guestfs_set_recovery_proc"
14651 #: ../src/guestfs-actions.pod:5822
14655 " guestfs_set_recovery_proc (guestfs_h *g,\n"
14656 " int recoveryproc);\n"
14661 #: ../src/guestfs-actions.pod:5826
14663 "If this is called with the parameter C<false> then C<guestfs_launch> does "
14664 "not create a recovery process. The purpose of the recovery process is to "
14665 "stop runaway qemu processes in the case where the main program aborts "
14670 #: ../src/guestfs-actions.pod:5831
14672 "This only has any effect if called before C<guestfs_launch>, and the default "
14677 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3923
14679 "About the only time when you would want to disable this is if the main "
14680 "process will fork itself into the background (\"daemonize\" itself). In "
14681 "this case the recovery process thinks that the main program has disappeared "
14682 "and so kills qemu, which is not very helpful."
14686 #: ../src/guestfs-actions.pod:5844
14687 msgid "guestfs_set_selinux"
14691 #: ../src/guestfs-actions.pod:5846
14695 " guestfs_set_selinux (guestfs_h *g,\n"
14701 #: ../src/guestfs-actions.pod:5850 ../fish/guestfish-actions.pod:3935
14703 "This sets the selinux flag that is passed to the appliance at boot time. "
14704 "The default is C<selinux=0> (disabled)."
14708 #: ../src/guestfs-actions.pod:5853 ../fish/guestfish-actions.pod:3938
14710 "Note that if SELinux is enabled, it is always in Permissive mode "
14711 "(C<enforcing=0>)."
14715 #: ../src/guestfs-actions.pod:5863
14716 msgid "guestfs_set_trace"
14720 #: ../src/guestfs-actions.pod:5865
14724 " guestfs_set_trace (guestfs_h *g,\n"
14730 #: ../src/guestfs-actions.pod:5869 ../fish/guestfish-actions.pod:3950
14732 "If the command trace flag is set to 1, then commands are printed on stderr "
14733 "before they are executed in a format which is very similar to the one used "
14734 "by guestfish. In other words, you can run a program with this enabled, and "
14735 "you will get out a script which you can feed to guestfish to perform the "
14736 "same set of actions."
14740 #: ../src/guestfs-actions.pod:5876 ../fish/guestfish-actions.pod:3957
14742 "If you want to trace C API calls into libguestfs (and other libraries) then "
14743 "possibly a better way is to use the external ltrace(1) command."
14747 #: ../src/guestfs-actions.pod:5880 ../fish/guestfish-actions.pod:3961
14749 "Command traces are disabled unless the environment variable "
14750 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14754 #: ../src/guestfs-actions.pod:5887
14755 msgid "guestfs_set_verbose"
14759 #: ../src/guestfs-actions.pod:5889
14763 " guestfs_set_verbose (guestfs_h *g,\n"
14769 #: ../src/guestfs-actions.pod:5893 ../fish/guestfish-actions.pod:3970
14770 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
14774 #: ../src/guestfs-actions.pod:5895 ../fish/guestfish-actions.pod:3972
14776 "Verbose messages are disabled unless the environment variable "
14777 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14781 #: ../src/guestfs-actions.pod:5902
14782 msgid "guestfs_setcon"
14786 #: ../src/guestfs-actions.pod:5904
14790 " guestfs_setcon (guestfs_h *g,\n"
14791 " const char *context);\n"
14796 #: ../src/guestfs-actions.pod:5908 ../fish/guestfish-actions.pod:3979
14798 "This sets the SELinux security context of the daemon to the string "
14803 #: ../src/guestfs-actions.pod:5911 ../fish/guestfish-actions.pod:3982
14804 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14808 #: ../src/guestfs-actions.pod:5917
14809 msgid "guestfs_setxattr"
14813 #: ../src/guestfs-actions.pod:5919
14817 " guestfs_setxattr (guestfs_h *g,\n"
14818 " const char *xattr,\n"
14819 " const char *val,\n"
14821 " const char *path);\n"
14826 #: ../src/guestfs-actions.pod:5926 ../fish/guestfish-actions.pod:3988
14828 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14829 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14833 #: ../src/guestfs-actions.pod:5930
14834 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14838 #: ../src/guestfs-actions.pod:5936
14839 msgid "guestfs_sfdisk"
14843 #: ../src/guestfs-actions.pod:5938
14847 " guestfs_sfdisk (guestfs_h *g,\n"
14848 " const char *device,\n"
14852 " char *const *lines);\n"
14857 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3998
14859 "This is a direct interface to the L<sfdisk(8)> program for creating "
14860 "partitions on block devices."
14864 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:4001
14865 msgid "C<device> should be a block device, for example C</dev/sda>."
14869 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:4003
14871 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14872 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14873 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14874 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14875 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14876 "the kernel) cannot work out the right geometry and you will need to tell it."
14880 #: ../src/guestfs-actions.pod:5959 ../fish/guestfish-actions.pod:4011
14882 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14883 "refer to the L<sfdisk(8)> manpage."
14887 #: ../src/guestfs-actions.pod:5962 ../fish/guestfish-actions.pod:4014
14889 "To create a single partition occupying the whole disk, you would pass "
14890 "C<lines> as a single element list, when the single element being the string "
14895 #: ../src/guestfs-actions.pod:5966
14896 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14900 #: ../src/guestfs-actions.pod:5976
14901 msgid "guestfs_sfdiskM"
14905 #: ../src/guestfs-actions.pod:5978
14909 " guestfs_sfdiskM (guestfs_h *g,\n"
14910 " const char *device,\n"
14911 " char *const *lines);\n"
14916 #: ../src/guestfs-actions.pod:5983
14918 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14919 "partition sizes are specified in megabytes only (rounded to the nearest "
14920 "cylinder) and you don't need to specify the cyls, heads and sectors "
14921 "parameters which were rarely if ever used anyway."
14925 #: ../src/guestfs-actions.pod:5989
14927 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14928 "C<guestfs_part_disk>"
14932 #: ../src/guestfs-actions.pod:5999
14933 msgid "guestfs_sfdisk_N"
14937 #: ../src/guestfs-actions.pod:6001
14941 " guestfs_sfdisk_N (guestfs_h *g,\n"
14942 " const char *device,\n"
14947 " const char *line);\n"
14952 #: ../src/guestfs-actions.pod:6010 ../fish/guestfish-actions.pod:4044
14954 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14955 "(note: C<n> counts from 1)."
14959 #: ../src/guestfs-actions.pod:6013
14961 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14962 "for the cyls/heads/sectors parameters."
14966 #: ../src/guestfs-actions.pod:6016
14967 msgid "See also: C<guestfs_part_add>"
14971 #: ../src/guestfs-actions.pod:6025
14972 msgid "guestfs_sfdisk_disk_geometry"
14976 #: ../src/guestfs-actions.pod:6027
14980 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14981 " const char *device);\n"
14986 #: ../src/guestfs-actions.pod:6031
14988 "This displays the disk geometry of C<device> read from the partition table. "
14989 "Especially in the case where the underlying block device has been resized, "
14990 "this can be different from the kernel's idea of the geometry (see "
14991 "C<guestfs_sfdisk_kernel_geometry>)."
14995 #: ../src/guestfs-actions.pod:6036 ../src/guestfs-actions.pod:6052 ../fish/guestfish-actions.pod:4064 ../fish/guestfish-actions.pod:4073
14996 msgid "The result is in human-readable format, and not designed to be parsed."
15000 #: ../src/guestfs-actions.pod:6044
15001 msgid "guestfs_sfdisk_kernel_geometry"
15005 #: ../src/guestfs-actions.pod:6046
15009 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
15010 " const char *device);\n"
15015 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4071
15016 msgid "This displays the kernel's idea of the geometry of C<device>."
15020 #: ../src/guestfs-actions.pod:6060
15021 msgid "guestfs_sfdisk_l"
15025 #: ../src/guestfs-actions.pod:6062
15029 " guestfs_sfdisk_l (guestfs_h *g,\n"
15030 " const char *device);\n"
15035 #: ../src/guestfs-actions.pod:6066 ../fish/guestfish-actions.pod:4080
15037 "This displays the partition table on C<device>, in the human-readable output "
15038 "of the L<sfdisk(8)> command. It is not intended to be parsed."
15042 #: ../src/guestfs-actions.pod:6070
15043 msgid "See also: C<guestfs_part_list>"
15047 #: ../src/guestfs-actions.pod:6077
15052 #: ../src/guestfs-actions.pod:6079
15056 " guestfs_sh (guestfs_h *g,\n"
15057 " const char *command);\n"
15062 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4090
15064 "This call runs a command from the guest filesystem via the guest's "
15069 #: ../src/guestfs-actions.pod:6086
15070 msgid "This is like C<guestfs_command>, but passes the command to:"
15074 #: ../src/guestfs-actions.pod:6088 ../fish/guestfish-actions.pod:4095
15077 " /bin/sh -c \"command\"\n"
15082 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4097
15084 "Depending on the guest's shell, this usually results in wildcards being "
15085 "expanded, shell expressions being interpolated and so on."
15089 #: ../src/guestfs-actions.pod:6094
15090 msgid "All the provisos about C<guestfs_command> apply to this call."
15094 #: ../src/guestfs-actions.pod:6101
15095 msgid "guestfs_sh_lines"
15099 #: ../src/guestfs-actions.pod:6103
15103 " guestfs_sh_lines (guestfs_h *g,\n"
15104 " const char *command);\n"
15109 #: ../src/guestfs-actions.pod:6107
15111 "This is the same as C<guestfs_sh>, but splits the result into a list of "
15116 #: ../src/guestfs-actions.pod:6110
15117 msgid "See also: C<guestfs_command_lines>"
15121 #: ../src/guestfs-actions.pod:6118
15122 msgid "guestfs_sleep"
15126 #: ../src/guestfs-actions.pod:6120
15130 " guestfs_sleep (guestfs_h *g,\n"
15136 #: ../src/guestfs-actions.pod:6124 ../fish/guestfish-actions.pod:4116
15137 msgid "Sleep for C<secs> seconds."
15141 #: ../src/guestfs-actions.pod:6128
15142 msgid "(Added in 1.0.41)"
15146 #: ../src/guestfs-actions.pod:6130 ../src/guestfs-structs.pod:109
15147 msgid "guestfs_stat"
15151 #: ../src/guestfs-actions.pod:6132
15154 " struct guestfs_stat *\n"
15155 " guestfs_stat (guestfs_h *g,\n"
15156 " const char *path);\n"
15161 #: ../src/guestfs-actions.pod:6138 ../fish/guestfish-actions.pod:4124
15162 msgid "This is the same as the C<stat(2)> system call."
15166 #: ../src/guestfs-actions.pod:6146 ../src/guestfs-structs.pod:135
15167 msgid "guestfs_statvfs"
15171 #: ../src/guestfs-actions.pod:6148
15174 " struct guestfs_statvfs *\n"
15175 " guestfs_statvfs (guestfs_h *g,\n"
15176 " const char *path);\n"
15181 #: ../src/guestfs-actions.pod:6152 ../fish/guestfish-actions.pod:4130
15183 "Returns file system statistics for any mounted file system. C<path> should "
15184 "be a file or directory in the mounted file system (typically it is the mount "
15185 "point itself, but it doesn't need to be)."
15189 #: ../src/guestfs-actions.pod:6156 ../fish/guestfish-actions.pod:4134
15190 msgid "This is the same as the C<statvfs(2)> system call."
15194 #: ../src/guestfs-actions.pod:6158
15196 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
15197 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
15201 #: ../src/guestfs-actions.pod:6164
15202 msgid "guestfs_strings"
15206 #: ../src/guestfs-actions.pod:6166
15210 " guestfs_strings (guestfs_h *g,\n"
15211 " const char *path);\n"
15216 #: ../src/guestfs-actions.pod:6170 ../fish/guestfish-actions.pod:4140
15218 "This runs the L<strings(1)> command on a file and returns the list of "
15219 "printable strings found."
15223 #: ../src/guestfs-actions.pod:6182
15224 msgid "guestfs_strings_e"
15228 #: ../src/guestfs-actions.pod:6184
15232 " guestfs_strings_e (guestfs_h *g,\n"
15233 " const char *encoding,\n"
15234 " const char *path);\n"
15239 #: ../src/guestfs-actions.pod:6189
15241 "This is like the C<guestfs_strings> command, but allows you to specify the "
15242 "encoding of strings that are looked for in the source file C<path>."
15246 #: ../src/guestfs-actions.pod:6193 ../fish/guestfish-actions.pod:4154
15247 msgid "Allowed encodings are:"
15251 #: ../src/guestfs-actions.pod:6197 ../fish/guestfish-actions.pod:4158
15256 #: ../src/guestfs-actions.pod:6199
15258 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15259 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15263 #: ../src/guestfs-actions.pod:6202 ../fish/guestfish-actions.pod:4163
15268 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4165
15269 msgid "Single 8-bit-byte characters."
15273 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4167
15278 #: ../src/guestfs-actions.pod:6208 ../fish/guestfish-actions.pod:4169
15279 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15283 #: ../src/guestfs-actions.pod:6211 ../fish/guestfish-actions.pod:4172
15284 msgid "l (lower case letter L)"
15288 #: ../src/guestfs-actions.pod:6213 ../fish/guestfish-actions.pod:4174
15290 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15291 "examining binaries in Windows guests."
15295 #: ../src/guestfs-actions.pod:6216 ../fish/guestfish-actions.pod:4177
15300 #: ../src/guestfs-actions.pod:6218 ../fish/guestfish-actions.pod:4179
15301 msgid "32-bit big endian such as UCS-4BE."
15305 #: ../src/guestfs-actions.pod:6220 ../fish/guestfish-actions.pod:4181
15310 #: ../src/guestfs-actions.pod:6222 ../fish/guestfish-actions.pod:4183
15311 msgid "32-bit little endian such as UCS-4LE."
15315 #: ../src/guestfs-actions.pod:6226 ../fish/guestfish-actions.pod:4187
15316 msgid "The returned strings are transcoded to UTF-8."
15320 #: ../src/guestfs-actions.pod:6237
15321 msgid "guestfs_swapoff_device"
15325 #: ../src/guestfs-actions.pod:6239
15329 " guestfs_swapoff_device (guestfs_h *g,\n"
15330 " const char *device);\n"
15335 #: ../src/guestfs-actions.pod:6243
15337 "This command disables the libguestfs appliance swap device or partition "
15338 "named C<device>. See C<guestfs_swapon_device>."
15342 #: ../src/guestfs-actions.pod:6251
15343 msgid "guestfs_swapoff_file"
15347 #: ../src/guestfs-actions.pod:6253
15351 " guestfs_swapoff_file (guestfs_h *g,\n"
15352 " const char *file);\n"
15357 #: ../src/guestfs-actions.pod:6257 ../fish/guestfish-actions.pod:4204
15358 msgid "This command disables the libguestfs appliance swap on file."
15362 #: ../src/guestfs-actions.pod:6263
15363 msgid "guestfs_swapoff_label"
15367 #: ../src/guestfs-actions.pod:6265
15371 " guestfs_swapoff_label (guestfs_h *g,\n"
15372 " const char *label);\n"
15377 #: ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4210
15379 "This command disables the libguestfs appliance swap on labeled swap "
15384 #: ../src/guestfs-actions.pod:6276
15385 msgid "guestfs_swapoff_uuid"
15389 #: ../src/guestfs-actions.pod:6278
15393 " guestfs_swapoff_uuid (guestfs_h *g,\n"
15394 " const char *uuid);\n"
15399 #: ../src/guestfs-actions.pod:6282 ../fish/guestfish-actions.pod:4217
15401 "This command disables the libguestfs appliance swap partition with the given "
15406 #: ../src/guestfs-actions.pod:6289
15407 msgid "guestfs_swapon_device"
15411 #: ../src/guestfs-actions.pod:6291
15415 " guestfs_swapon_device (guestfs_h *g,\n"
15416 " const char *device);\n"
15421 #: ../src/guestfs-actions.pod:6295
15423 "This command enables the libguestfs appliance to use the swap device or "
15424 "partition named C<device>. The increased memory is made available for all "
15425 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
15429 #: ../src/guestfs-actions.pod:6300 ../fish/guestfish-actions.pod:4229
15431 "Note that you should not swap to existing guest swap partitions unless you "
15432 "know what you are doing. They may contain hibernation information, or other "
15433 "information that the guest doesn't want you to trash. You also risk leaking "
15434 "information about the host to the guest this way. Instead, attach a new "
15435 "host device to the guest and swap on that."
15439 #: ../src/guestfs-actions.pod:6311
15440 msgid "guestfs_swapon_file"
15444 #: ../src/guestfs-actions.pod:6313
15448 " guestfs_swapon_file (guestfs_h *g,\n"
15449 " const char *file);\n"
15454 #: ../src/guestfs-actions.pod:6317
15456 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
15461 #: ../src/guestfs-actions.pod:6324
15462 msgid "guestfs_swapon_label"
15466 #: ../src/guestfs-actions.pod:6326
15470 " guestfs_swapon_label (guestfs_h *g,\n"
15471 " const char *label);\n"
15476 #: ../src/guestfs-actions.pod:6330
15478 "This command enables swap to a labeled swap partition. See "
15479 "C<guestfs_swapon_device> for other notes."
15483 #: ../src/guestfs-actions.pod:6337
15484 msgid "guestfs_swapon_uuid"
15488 #: ../src/guestfs-actions.pod:6339
15492 " guestfs_swapon_uuid (guestfs_h *g,\n"
15493 " const char *uuid);\n"
15498 #: ../src/guestfs-actions.pod:6343
15500 "This command enables swap to a swap partition with the given UUID. See "
15501 "C<guestfs_swapon_device> for other notes."
15505 #: ../src/guestfs-actions.pod:6350
15506 msgid "guestfs_sync"
15510 #: ../src/guestfs-actions.pod:6352
15514 " guestfs_sync (guestfs_h *g);\n"
15519 #: ../src/guestfs-actions.pod:6355 ../fish/guestfish-actions.pod:4261
15521 "This syncs the disk, so that any writes are flushed through to the "
15522 "underlying disk image."
15526 #: ../src/guestfs-actions.pod:6358 ../fish/guestfish-actions.pod:4264
15528 "You should always call this if you have modified a disk image, before "
15529 "closing the handle."
15533 #: ../src/guestfs-actions.pod:6365
15534 msgid "guestfs_tail"
15538 #: ../src/guestfs-actions.pod:6367
15542 " guestfs_tail (guestfs_h *g,\n"
15543 " const char *path);\n"
15548 #: ../src/guestfs-actions.pod:6371 ../fish/guestfish-actions.pod:4271
15549 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15553 #: ../src/guestfs-actions.pod:6383
15554 msgid "guestfs_tail_n"
15558 #: ../src/guestfs-actions.pod:6385
15562 " guestfs_tail_n (guestfs_h *g,\n"
15564 " const char *path);\n"
15569 #: ../src/guestfs-actions.pod:6390 ../fish/guestfish-actions.pod:4281
15571 "If the parameter C<nrlines> is a positive number, this returns the last "
15572 "C<nrlines> lines of the file C<path>."
15576 #: ../src/guestfs-actions.pod:6393 ../fish/guestfish-actions.pod:4284
15578 "If the parameter C<nrlines> is a negative number, this returns lines from "
15579 "the file C<path>, starting with the C<-nrlines>th line."
15583 #: ../src/guestfs-actions.pod:6407
15584 msgid "guestfs_tar_in"
15588 #: ../src/guestfs-actions.pod:6409
15592 " guestfs_tar_in (guestfs_h *g,\n"
15593 " const char *tarfile,\n"
15594 " const char *directory);\n"
15599 #: ../src/guestfs-actions.pod:6414 ../fish/guestfish-actions.pod:4296
15601 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15602 "tar file) into C<directory>."
15606 #: ../src/guestfs-actions.pod:6417
15607 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
15611 #: ../src/guestfs-actions.pod:6422 ../src/guestfs-actions.pod:6439 ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6471
15612 msgid "(Added in 1.0.3)"
15616 #: ../src/guestfs-actions.pod:6424
15617 msgid "guestfs_tar_out"
15621 #: ../src/guestfs-actions.pod:6426
15625 " guestfs_tar_out (guestfs_h *g,\n"
15626 " const char *directory,\n"
15627 " const char *tarfile);\n"
15632 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4308
15634 "This command packs the contents of C<directory> and downloads it to local "
15639 #: ../src/guestfs-actions.pod:6434
15641 "To download a compressed tarball, use C<guestfs_tgz_out> or "
15642 "C<guestfs_txz_out>."
15646 #: ../src/guestfs-actions.pod:6441
15647 msgid "guestfs_tgz_in"
15651 #: ../src/guestfs-actions.pod:6443
15655 " guestfs_tgz_in (guestfs_h *g,\n"
15656 " const char *tarball,\n"
15657 " const char *directory);\n"
15662 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4320
15664 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15665 "tar file) into C<directory>."
15669 #: ../src/guestfs-actions.pod:6451
15670 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
15674 #: ../src/guestfs-actions.pod:6457
15675 msgid "guestfs_tgz_out"
15679 #: ../src/guestfs-actions.pod:6459
15683 " guestfs_tgz_out (guestfs_h *g,\n"
15684 " const char *directory,\n"
15685 " const char *tarball);\n"
15690 #: ../src/guestfs-actions.pod:6464 ../fish/guestfish-actions.pod:4331
15692 "This command packs the contents of C<directory> and downloads it to local "
15697 #: ../src/guestfs-actions.pod:6467
15698 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
15702 #: ../src/guestfs-actions.pod:6473
15703 msgid "guestfs_touch"
15707 #: ../src/guestfs-actions.pod:6475
15711 " guestfs_touch (guestfs_h *g,\n"
15712 " const char *path);\n"
15717 #: ../src/guestfs-actions.pod:6479 ../fish/guestfish-actions.pod:4342
15719 "Touch acts like the L<touch(1)> command. It can be used to update the "
15720 "timestamps on a file, or, if the file does not exist, to create a new "
15721 "zero-length file."
15725 #: ../src/guestfs-actions.pod:6483 ../fish/guestfish-actions.pod:4346
15727 "This command only works on regular files, and will fail on other file types "
15728 "such as directories, symbolic links, block special etc."
15732 #: ../src/guestfs-actions.pod:6490
15733 msgid "guestfs_truncate"
15737 #: ../src/guestfs-actions.pod:6492
15741 " guestfs_truncate (guestfs_h *g,\n"
15742 " const char *path);\n"
15747 #: ../src/guestfs-actions.pod:6496 ../fish/guestfish-actions.pod:4353
15749 "This command truncates C<path> to a zero-length file. The file must exist "
15754 #: ../src/guestfs-actions.pod:6503
15755 msgid "guestfs_truncate_size"
15759 #: ../src/guestfs-actions.pod:6505
15763 " guestfs_truncate_size (guestfs_h *g,\n"
15764 " const char *path,\n"
15765 " int64_t size);\n"
15770 #: ../src/guestfs-actions.pod:6510 ../fish/guestfish-actions.pod:4360
15772 "This command truncates C<path> to size C<size> bytes. The file must exist "
15777 #: ../src/guestfs-actions.pod:6513
15779 "If the current file size is less than C<size> then the file is extended to "
15780 "the required size with zero bytes. This creates a sparse file (ie. disk "
15781 "blocks are not allocated for the file until you write to it). To create a "
15782 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15786 #: ../src/guestfs-actions.pod:6523
15787 msgid "guestfs_tune2fs_l"
15791 #: ../src/guestfs-actions.pod:6525
15795 " guestfs_tune2fs_l (guestfs_h *g,\n"
15796 " const char *device);\n"
15801 #: ../src/guestfs-actions.pod:6529 ../fish/guestfish-actions.pod:4373
15803 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15808 #: ../src/guestfs-actions.pod:6532 ../fish/guestfish-actions.pod:4376
15810 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15811 "for more details. The list of fields returned isn't clearly defined, and "
15812 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15813 "and the filesystem itself."
15817 #: ../src/guestfs-actions.pod:6545
15818 msgid "guestfs_txz_in"
15822 #: ../src/guestfs-actions.pod:6547
15826 " guestfs_txz_in (guestfs_h *g,\n"
15827 " const char *tarball,\n"
15828 " const char *directory);\n"
15833 #: ../src/guestfs-actions.pod:6552 ../fish/guestfish-actions.pod:4385
15835 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15836 "tar file) into C<directory>."
15840 #: ../src/guestfs-actions.pod:6559
15841 msgid "guestfs_txz_out"
15845 #: ../src/guestfs-actions.pod:6561
15849 " guestfs_txz_out (guestfs_h *g,\n"
15850 " const char *directory,\n"
15851 " const char *tarball);\n"
15856 #: ../src/guestfs-actions.pod:6566 ../fish/guestfish-actions.pod:4394
15858 "This command packs the contents of C<directory> and downloads it to local "
15859 "file C<tarball> (as an xz compressed tar archive)."
15863 #: ../src/guestfs-actions.pod:6573
15864 msgid "guestfs_umask"
15868 #: ../src/guestfs-actions.pod:6575
15872 " guestfs_umask (guestfs_h *g,\n"
15878 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4403
15880 "This function sets the mask used for creating new files and device nodes to "
15885 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4406
15887 "Typical umask values would be C<022> which creates new files with "
15888 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15889 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15893 #: ../src/guestfs-actions.pod:6587 ../fish/guestfish-actions.pod:4411
15895 "The default umask is C<022>. This is important because it means that "
15896 "directories and device nodes will be created with C<0644> or C<0755> mode "
15897 "even if you specify C<0777>."
15901 #: ../src/guestfs-actions.pod:6591
15903 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15904 "C<guestfs_mkdir>."
15908 #: ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4418
15909 msgid "This call returns the previous umask."
15913 #: ../src/guestfs-actions.pod:6600
15914 msgid "guestfs_umount"
15918 #: ../src/guestfs-actions.pod:6602
15922 " guestfs_umount (guestfs_h *g,\n"
15923 " const char *pathordevice);\n"
15928 #: ../src/guestfs-actions.pod:6606 ../fish/guestfish-actions.pod:4426
15930 "This unmounts the given filesystem. The filesystem may be specified either "
15931 "by its mountpoint (path) or the device which contains the filesystem."
15935 #: ../src/guestfs-actions.pod:6614
15936 msgid "guestfs_umount_all"
15940 #: ../src/guestfs-actions.pod:6616
15944 " guestfs_umount_all (guestfs_h *g);\n"
15949 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4436
15950 msgid "This unmounts all mounted filesystems."
15954 #: ../src/guestfs-actions.pod:6621 ../fish/guestfish-actions.pod:4438
15955 msgid "Some internal mounts are not unmounted by this call."
15959 #: ../src/guestfs-actions.pod:6627
15960 msgid "guestfs_upload"
15964 #: ../src/guestfs-actions.pod:6629
15968 " guestfs_upload (guestfs_h *g,\n"
15969 " const char *filename,\n"
15970 " const char *remotefilename);\n"
15975 #: ../src/guestfs-actions.pod:6634 ../src/guestfs-actions.pod:6658 ../fish/guestfish-actions.pod:4444 ../fish/guestfish-actions.pod:4457
15976 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15980 #: ../src/guestfs-actions.pod:6639
15981 msgid "See also C<guestfs_download>."
15985 #: ../src/guestfs-actions.pod:6650
15986 msgid "guestfs_upload_offset"
15990 #: ../src/guestfs-actions.pod:6652
15994 " guestfs_upload_offset (guestfs_h *g,\n"
15995 " const char *filename,\n"
15996 " const char *remotefilename,\n"
15997 " int64_t offset);\n"
16002 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4460
16004 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
16005 "The intention is to overwrite parts of existing files or devices, although "
16006 "if a non-existant file is specified then it is created with a \"hole\" "
16007 "before C<offset>. The size of the data written is implicit in the size of "
16008 "the source C<filename>."
16012 #: ../src/guestfs-actions.pod:6668
16014 "Note that there is no limit on the amount of data that can be uploaded with "
16015 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
16016 "full amount unless an error occurs."
16020 #: ../src/guestfs-actions.pod:6673
16021 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
16025 #: ../src/guestfs-actions.pod:6684
16026 msgid "guestfs_utimens"
16030 #: ../src/guestfs-actions.pod:6686
16034 " guestfs_utimens (guestfs_h *g,\n"
16035 " const char *path,\n"
16036 " int64_t atsecs,\n"
16037 " int64_t atnsecs,\n"
16038 " int64_t mtsecs,\n"
16039 " int64_t mtnsecs);\n"
16044 #: ../src/guestfs-actions.pod:6694 ../fish/guestfish-actions.pod:4480
16045 msgid "This command sets the timestamps of a file with nanosecond precision."
16049 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4483
16051 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
16056 #: ../src/guestfs-actions.pod:6700 ../fish/guestfish-actions.pod:4486
16058 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
16059 "nanoseconds from the epoch."
16063 #: ../src/guestfs-actions.pod:6703 ../fish/guestfish-actions.pod:4489
16065 "If the C<*nsecs> field contains the special value C<-1> then the "
16066 "corresponding timestamp is set to the current time. (The C<*secs> field is "
16067 "ignored in this case)."
16071 #: ../src/guestfs-actions.pod:6707 ../fish/guestfish-actions.pod:4493
16073 "If the C<*nsecs> field contains the special value C<-2> then the "
16074 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
16079 #: ../src/guestfs-actions.pod:6715 ../src/guestfs-structs.pod:175
16080 msgid "guestfs_version"
16084 #: ../src/guestfs-actions.pod:6717
16087 " struct guestfs_version *\n"
16088 " guestfs_version (guestfs_h *g);\n"
16093 #: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4501
16094 msgid "Return the libguestfs version number that the program is linked against."
16098 #: ../src/guestfs-actions.pod:6723 ../fish/guestfish-actions.pod:4504
16100 "Note that because of dynamic linking this is not necessarily the version of "
16101 "libguestfs that you compiled against. You can compile the program, and then "
16102 "at runtime dynamically link against a completely different C<libguestfs.so> "
16107 #: ../src/guestfs-actions.pod:6728 ../fish/guestfish-actions.pod:4509
16109 "This call was added in version C<1.0.58>. In previous versions of "
16110 "libguestfs there was no way to get the version number. From C code you can "
16111 "use dynamic linker functions to find out if this symbol exists (if it "
16112 "doesn't, then it's an earlier version)."
16116 #: ../src/guestfs-actions.pod:6734 ../fish/guestfish-actions.pod:4515
16118 "The call returns a structure with four elements. The first three (C<major>, "
16119 "C<minor> and C<release>) are numbers and correspond to the usual version "
16120 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
16121 "but may be used for distro-specific information."
16125 #: ../src/guestfs-actions.pod:6740 ../fish/guestfish-actions.pod:4521
16126 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
16130 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4524
16131 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
16135 #: ../src/guestfs-actions.pod:6745
16137 "I<Note:> Don't use this call to test for availability of features. In "
16138 "enterprise distributions we backport features from later versions into "
16139 "earlier versions, making this an unreliable way to test for features. Use "
16140 "C<guestfs_available> instead."
16144 #: ../src/guestfs-actions.pod:6751
16146 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
16147 "error. I<The caller must call C<guestfs_free_version> after use>."
16151 #: ../src/guestfs-actions.pod:6755
16152 msgid "(Added in 1.0.58)"
16156 #: ../src/guestfs-actions.pod:6757
16157 msgid "guestfs_vfs_label"
16161 #: ../src/guestfs-actions.pod:6759
16165 " guestfs_vfs_label (guestfs_h *g,\n"
16166 " const char *device);\n"
16171 #: ../src/guestfs-actions.pod:6763 ../fish/guestfish-actions.pod:4536
16172 msgid "This returns the filesystem label of the filesystem on C<device>."
16176 #: ../src/guestfs-actions.pod:6766 ../fish/guestfish-actions.pod:4539
16177 msgid "If the filesystem is unlabeled, this returns the empty string."
16181 #: ../src/guestfs-actions.pod:6768
16182 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
16186 #: ../src/guestfs-actions.pod:6773 ../src/guestfs-actions.pod:6810
16187 msgid "(Added in 1.3.18)"
16191 #: ../src/guestfs-actions.pod:6775
16192 msgid "guestfs_vfs_type"
16196 #: ../src/guestfs-actions.pod:6777
16200 " guestfs_vfs_type (guestfs_h *g,\n"
16201 " const char *device);\n"
16206 #: ../src/guestfs-actions.pod:6781 ../fish/guestfish-actions.pod:4547
16208 "This command gets the filesystem type corresponding to the filesystem on "
16213 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4550
16215 "For most filesystems, the result is the name of the Linux VFS module which "
16216 "would be used to mount this filesystem if you mounted it without specifying "
16217 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
16221 #: ../src/guestfs-actions.pod:6794
16222 msgid "guestfs_vfs_uuid"
16226 #: ../src/guestfs-actions.pod:6796
16230 " guestfs_vfs_uuid (guestfs_h *g,\n"
16231 " const char *device);\n"
16236 #: ../src/guestfs-actions.pod:6800 ../fish/guestfish-actions.pod:4559
16237 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16241 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4562
16242 msgid "If the filesystem does not have a UUID, this returns the empty string."
16246 #: ../src/guestfs-actions.pod:6805
16247 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16251 #: ../src/guestfs-actions.pod:6812
16252 msgid "guestfs_vg_activate"
16256 #: ../src/guestfs-actions.pod:6814
16260 " guestfs_vg_activate (guestfs_h *g,\n"
16262 " char *const *volgroups);\n"
16267 #: ../src/guestfs-actions.pod:6819 ../fish/guestfish-actions.pod:4570
16269 "This command activates or (if C<activate> is false) deactivates all logical "
16270 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16271 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16272 "deactivated, then those devices disappear."
16276 #: ../src/guestfs-actions.pod:6825 ../fish/guestfish-actions.pod:4576
16277 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16281 #: ../src/guestfs-actions.pod:6827 ../fish/guestfish-actions.pod:4578
16283 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16284 "activated or deactivated."
16288 #: ../src/guestfs-actions.pod:6834
16289 msgid "guestfs_vg_activate_all"
16293 #: ../src/guestfs-actions.pod:6836
16297 " guestfs_vg_activate_all (guestfs_h *g,\n"
16298 " int activate);\n"
16303 #: ../src/guestfs-actions.pod:6840 ../fish/guestfish-actions.pod:4585
16305 "This command activates or (if C<activate> is false) deactivates all logical "
16306 "volumes in all volume groups. If activated, then they are made known to the "
16307 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16308 "those devices disappear."
16312 #: ../src/guestfs-actions.pod:6846 ../fish/guestfish-actions.pod:4591
16313 msgid "This command is the same as running C<vgchange -a y|n>"
16317 #: ../src/guestfs-actions.pod:6852
16318 msgid "guestfs_vgcreate"
16322 #: ../src/guestfs-actions.pod:6854
16326 " guestfs_vgcreate (guestfs_h *g,\n"
16327 " const char *volgroup,\n"
16328 " char *const *physvols);\n"
16333 #: ../src/guestfs-actions.pod:6859 ../fish/guestfish-actions.pod:4597
16335 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16336 "of physical volumes C<physvols>."
16340 #: ../src/guestfs-actions.pod:6866
16341 msgid "guestfs_vglvuuids"
16345 #: ../src/guestfs-actions.pod:6868
16349 " guestfs_vglvuuids (guestfs_h *g,\n"
16350 " const char *vgname);\n"
16355 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4604
16357 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16358 "volumes created in this volume group."
16362 #: ../src/guestfs-actions.pod:6875
16364 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
16365 "associate logical volumes and volume groups."
16369 #: ../src/guestfs-actions.pod:6878
16370 msgid "See also C<guestfs_vgpvuuids>."
16374 #: ../src/guestfs-actions.pod:6886
16375 msgid "guestfs_vgpvuuids"
16379 #: ../src/guestfs-actions.pod:6888
16383 " guestfs_vgpvuuids (guestfs_h *g,\n"
16384 " const char *vgname);\n"
16389 #: ../src/guestfs-actions.pod:6892 ../fish/guestfish-actions.pod:4616
16391 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16392 "volumes that this volume group resides on."
16396 #: ../src/guestfs-actions.pod:6895
16398 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
16399 "associate physical volumes and volume groups."
16403 #: ../src/guestfs-actions.pod:6898
16404 msgid "See also C<guestfs_vglvuuids>."
16408 #: ../src/guestfs-actions.pod:6906
16409 msgid "guestfs_vgremove"
16413 #: ../src/guestfs-actions.pod:6908
16417 " guestfs_vgremove (guestfs_h *g,\n"
16418 " const char *vgname);\n"
16423 #: ../src/guestfs-actions.pod:6912 ../fish/guestfish-actions.pod:4628
16424 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16428 #: ../src/guestfs-actions.pod:6914 ../fish/guestfish-actions.pod:4630
16429 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16433 #: ../src/guestfs-actions.pod:6921
16434 msgid "guestfs_vgrename"
16438 #: ../src/guestfs-actions.pod:6923
16442 " guestfs_vgrename (guestfs_h *g,\n"
16443 " const char *volgroup,\n"
16444 " const char *newvolgroup);\n"
16449 #: ../src/guestfs-actions.pod:6928 ../fish/guestfish-actions.pod:4637
16450 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16454 #: ../src/guestfs-actions.pod:6934
16455 msgid "guestfs_vgs"
16459 #: ../src/guestfs-actions.pod:6936
16463 " guestfs_vgs (guestfs_h *g);\n"
16468 #: ../src/guestfs-actions.pod:6939 ../fish/guestfish-actions.pod:4643
16470 "List all the volumes groups detected. This is the equivalent of the "
16471 "L<vgs(8)> command."
16475 #: ../src/guestfs-actions.pod:6942 ../fish/guestfish-actions.pod:4646
16477 "This returns a list of just the volume group names that were detected "
16478 "(eg. C<VolGroup00>)."
16482 #: ../src/guestfs-actions.pod:6945
16483 msgid "See also C<guestfs_vgs_full>."
16487 #: ../src/guestfs-actions.pod:6953
16488 msgid "guestfs_vgs_full"
16492 #: ../src/guestfs-actions.pod:6955
16495 " struct guestfs_lvm_vg_list *\n"
16496 " guestfs_vgs_full (guestfs_h *g);\n"
16501 #: ../src/guestfs-actions.pod:6958 ../fish/guestfish-actions.pod:4655
16503 "List all the volumes groups detected. This is the equivalent of the "
16504 "L<vgs(8)> command. The \"full\" version includes all fields."
16508 #: ../src/guestfs-actions.pod:6961
16510 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
16511 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
16516 #: ../src/guestfs-actions.pod:6967
16517 msgid "guestfs_vgscan"
16521 #: ../src/guestfs-actions.pod:6969
16525 " guestfs_vgscan (guestfs_h *g);\n"
16530 #: ../src/guestfs-actions.pod:6972 ../fish/guestfish-actions.pod:4662
16532 "This rescans all block devices and rebuilds the list of LVM physical "
16533 "volumes, volume groups and logical volumes."
16537 #: ../src/guestfs-actions.pod:6979
16538 msgid "guestfs_vguuid"
16542 #: ../src/guestfs-actions.pod:6981
16546 " guestfs_vguuid (guestfs_h *g,\n"
16547 " const char *vgname);\n"
16552 #: ../src/guestfs-actions.pod:6985 ../fish/guestfish-actions.pod:4669
16553 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16557 #: ../src/guestfs-actions.pod:6992
16558 msgid "guestfs_wait_ready"
16562 #: ../src/guestfs-actions.pod:6994
16566 " guestfs_wait_ready (guestfs_h *g);\n"
16571 #: ../src/guestfs-actions.pod:6997
16572 msgid "This function is a no op."
16576 #: ../src/guestfs-actions.pod:6999
16578 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
16579 "calling C<guestfs_launch> to wait for the launch to complete. However this "
16580 "is no longer necessary because C<guestfs_launch> now does the waiting."
16584 #: ../src/guestfs-actions.pod:7004
16586 "If you see any calls to this function in code then you can just remove them, "
16587 "unless you want to retain compatibility with older versions of the API."
16591 #: ../src/guestfs-actions.pod:7012
16592 msgid "guestfs_wc_c"
16596 #: ../src/guestfs-actions.pod:7014
16600 " guestfs_wc_c (guestfs_h *g,\n"
16601 " const char *path);\n"
16606 #: ../src/guestfs-actions.pod:7018 ../fish/guestfish-actions.pod:4675
16608 "This command counts the characters in a file, using the C<wc -c> external "
16613 #: ../src/guestfs-actions.pod:7025
16614 msgid "guestfs_wc_l"
16618 #: ../src/guestfs-actions.pod:7027
16622 " guestfs_wc_l (guestfs_h *g,\n"
16623 " const char *path);\n"
16628 #: ../src/guestfs-actions.pod:7031 ../fish/guestfish-actions.pod:4682
16630 "This command counts the lines in a file, using the C<wc -l> external "
16635 #: ../src/guestfs-actions.pod:7038
16636 msgid "guestfs_wc_w"
16640 #: ../src/guestfs-actions.pod:7040
16644 " guestfs_wc_w (guestfs_h *g,\n"
16645 " const char *path);\n"
16650 #: ../src/guestfs-actions.pod:7044 ../fish/guestfish-actions.pod:4689
16652 "This command counts the words in a file, using the C<wc -w> external "
16657 #: ../src/guestfs-actions.pod:7051
16658 msgid "guestfs_write"
16662 #: ../src/guestfs-actions.pod:7053
16666 " guestfs_write (guestfs_h *g,\n"
16667 " const char *path,\n"
16668 " const char *content,\n"
16669 " size_t content_size);\n"
16674 #: ../src/guestfs-actions.pod:7059 ../fish/guestfish-actions.pod:4696
16676 "This call creates a file called C<path>. The content of the file is the "
16677 "string C<content> (which can contain any 8 bit data)."
16681 #: ../src/guestfs-actions.pod:7069
16682 msgid "guestfs_write_file"
16686 #: ../src/guestfs-actions.pod:7071
16690 " guestfs_write_file (guestfs_h *g,\n"
16691 " const char *path,\n"
16692 " const char *content,\n"
16698 #: ../src/guestfs-actions.pod:7077 ../fish/guestfish-actions.pod:4706
16700 "This call creates a file called C<path>. The contents of the file is the "
16701 "string C<content> (which can contain any 8 bit data), with length C<size>."
16705 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4710
16707 "As a special case, if C<size> is C<0> then the length is calculated using "
16708 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16712 #: ../src/guestfs-actions.pod:7085 ../fish/guestfish-actions.pod:4714
16714 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16715 "I<not> work, even if the length is specified."
16719 #: ../src/guestfs-actions.pod:7093 ../fish/guestfish-actions.pod:4720
16720 msgid "This function is deprecated. In new code, use the C<write> call instead."
16724 #: ../src/guestfs-actions.pod:7102
16725 msgid "guestfs_zegrep"
16729 #: ../src/guestfs-actions.pod:7104
16733 " guestfs_zegrep (guestfs_h *g,\n"
16734 " const char *regex,\n"
16735 " const char *path);\n"
16740 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4731
16741 msgid "This calls the external C<zegrep> program and returns the matching lines."
16745 #: ../src/guestfs-actions.pod:7121
16746 msgid "guestfs_zegrepi"
16750 #: ../src/guestfs-actions.pod:7123
16754 " guestfs_zegrepi (guestfs_h *g,\n"
16755 " const char *regex,\n"
16756 " const char *path);\n"
16761 #: ../src/guestfs-actions.pod:7128 ../fish/guestfish-actions.pod:4741
16762 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16766 #: ../src/guestfs-actions.pod:7140
16767 msgid "guestfs_zero"
16771 #: ../src/guestfs-actions.pod:7142
16775 " guestfs_zero (guestfs_h *g,\n"
16776 " const char *device);\n"
16781 #: ../src/guestfs-actions.pod:7146 ../fish/guestfish-actions.pod:4751
16782 msgid "This command writes zeroes over the first few blocks of C<device>."
16786 #: ../src/guestfs-actions.pod:7148 ../fish/guestfish-actions.pod:4753
16788 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16789 "securely wipe the device). It should be sufficient to remove any partition "
16790 "tables, filesystem superblocks and so on."
16794 #: ../src/guestfs-actions.pod:7152
16795 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16799 #: ../src/guestfs-actions.pod:7163
16800 msgid "guestfs_zero_device"
16804 #: ../src/guestfs-actions.pod:7165
16808 " guestfs_zero_device (guestfs_h *g,\n"
16809 " const char *device);\n"
16814 #: ../src/guestfs-actions.pod:7169
16816 "This command writes zeroes over the entire C<device>. Compare with "
16817 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16821 #: ../src/guestfs-actions.pod:7183
16822 msgid "(Added in 1.3.1)"
16826 #: ../src/guestfs-actions.pod:7185
16827 msgid "guestfs_zerofree"
16831 #: ../src/guestfs-actions.pod:7187
16835 " guestfs_zerofree (guestfs_h *g,\n"
16836 " const char *device);\n"
16841 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4774
16843 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16844 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16845 "possible to compress the filesystem more effectively."
16849 #: ../src/guestfs-actions.pod:7196 ../fish/guestfish-actions.pod:4779
16850 msgid "You should B<not> run this program if the filesystem is mounted."
16854 #: ../src/guestfs-actions.pod:7199 ../fish/guestfish-actions.pod:4782
16856 "It is possible that using this program can damage the filesystem or data on "
16861 #: ../src/guestfs-actions.pod:7206
16862 msgid "guestfs_zfgrep"
16866 #: ../src/guestfs-actions.pod:7208
16870 " guestfs_zfgrep (guestfs_h *g,\n"
16871 " const char *pattern,\n"
16872 " const char *path);\n"
16877 #: ../src/guestfs-actions.pod:7213 ../fish/guestfish-actions.pod:4789
16878 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16882 #: ../src/guestfs-actions.pod:7225
16883 msgid "guestfs_zfgrepi"
16887 #: ../src/guestfs-actions.pod:7227
16891 " guestfs_zfgrepi (guestfs_h *g,\n"
16892 " const char *pattern,\n"
16893 " const char *path);\n"
16898 #: ../src/guestfs-actions.pod:7232 ../fish/guestfish-actions.pod:4799
16899 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16903 #: ../src/guestfs-actions.pod:7244
16904 msgid "guestfs_zfile"
16908 #: ../src/guestfs-actions.pod:7246
16912 " guestfs_zfile (guestfs_h *g,\n"
16913 " const char *meth,\n"
16914 " const char *path);\n"
16919 #: ../src/guestfs-actions.pod:7251 ../fish/guestfish-actions.pod:4809
16920 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16924 #: ../src/guestfs-actions.pod:7254 ../fish/guestfish-actions.pod:4812
16925 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16929 #: ../src/guestfs-actions.pod:7256
16931 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16936 #: ../src/guestfs-actions.pod:7262 ../fish/guestfish-actions.pod:4817
16937 msgid "This function is deprecated. In new code, use the C<file> call instead."
16941 #: ../src/guestfs-actions.pod:7271
16942 msgid "guestfs_zgrep"
16946 #: ../src/guestfs-actions.pod:7273
16950 " guestfs_zgrep (guestfs_h *g,\n"
16951 " const char *regex,\n"
16952 " const char *path);\n"
16957 #: ../src/guestfs-actions.pod:7278 ../fish/guestfish-actions.pod:4828
16958 msgid "This calls the external C<zgrep> program and returns the matching lines."
16962 #: ../src/guestfs-actions.pod:7290
16963 msgid "guestfs_zgrepi"
16967 #: ../src/guestfs-actions.pod:7292
16971 " guestfs_zgrepi (guestfs_h *g,\n"
16972 " const char *regex,\n"
16973 " const char *path);\n"
16978 #: ../src/guestfs-actions.pod:7297 ../fish/guestfish-actions.pod:4838
16979 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16983 #: ../src/guestfs-availability.pod:3
16988 #: ../src/guestfs-availability.pod:5
16990 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
16991 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
16992 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
16993 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
16994 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
16998 #: ../src/guestfs-availability.pod:21
17003 #: ../src/guestfs-availability.pod:23
17005 "The following functions: L</guestfs_inotify_add_watch> "
17006 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
17007 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
17011 #: ../src/guestfs-availability.pod:31
17012 msgid "B<linuxfsuuid>"
17016 #: ../src/guestfs-availability.pod:33
17018 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
17019 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
17023 #: ../src/guestfs-availability.pod:40
17024 msgid "B<linuxmodules>"
17028 #: ../src/guestfs-availability.pod:42
17029 msgid "The following functions: L</guestfs_modprobe>"
17033 #: ../src/guestfs-availability.pod:45
17034 msgid "B<linuxxattrs>"
17038 #: ../src/guestfs-availability.pod:47
17040 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
17041 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
17042 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
17043 "L</guestfs_setxattr>"
17047 #: ../src/guestfs-availability.pod:58
17052 #: ../src/guestfs-availability.pod:60
17054 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
17055 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
17056 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
17060 #: ../src/guestfs-availability.pod:69
17065 #: ../src/guestfs-availability.pod:71
17067 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
17068 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
17069 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
17070 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
17071 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
17072 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
17073 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
17074 "L</guestfs_vgs_full>"
17078 #: ../src/guestfs-availability.pod:94
17083 #: ../src/guestfs-availability.pod:96
17085 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
17086 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
17090 #: ../src/guestfs-availability.pod:102
17095 #: ../src/guestfs-availability.pod:104
17096 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
17100 #: ../src/guestfs-availability.pod:107
17101 msgid "B<ntfsprogs>"
17105 #: ../src/guestfs-availability.pod:109
17106 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
17110 #: ../src/guestfs-availability.pod:113
17111 msgid "B<realpath>"
17115 #: ../src/guestfs-availability.pod:115
17116 msgid "The following functions: L</guestfs_realpath>"
17120 #: ../src/guestfs-availability.pod:118
17125 #: ../src/guestfs-availability.pod:120
17127 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
17128 "L</guestfs_scrub_freespace>"
17132 #: ../src/guestfs-availability.pod:125
17137 #: ../src/guestfs-availability.pod:127
17138 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
17142 #: ../src/guestfs-availability.pod:131
17147 #: ../src/guestfs-availability.pod:133
17148 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
17152 #: ../src/guestfs-availability.pod:137
17153 msgid "B<zerofree>"
17157 #: ../src/guestfs-availability.pod:139
17158 msgid "The following functions: L</guestfs_zerofree>"
17162 #: ../src/guestfs-structs.pod:1
17163 msgid "guestfs_int_bool"
17167 #: ../src/guestfs-structs.pod:3
17170 " struct guestfs_int_bool {\n"
17178 #: ../src/guestfs-structs.pod:8
17181 " struct guestfs_int_bool_list {\n"
17182 " uint32_t len; /* Number of elements in list. */\n"
17183 " struct guestfs_int_bool *val; /* Elements. */\n"
17189 #: ../src/guestfs-structs.pod:13
17192 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
17193 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
17198 #: ../src/guestfs-structs.pod:16
17199 msgid "guestfs_lvm_pv"
17203 #: ../src/guestfs-structs.pod:18
17206 " struct guestfs_lvm_pv {\n"
17207 " char *pv_name;\n"
17208 " /* The next field is NOT nul-terminated, be careful when printing it: "
17210 " char pv_uuid[32];\n"
17212 " uint64_t pv_size;\n"
17213 " uint64_t dev_size;\n"
17214 " uint64_t pv_free;\n"
17215 " uint64_t pv_used;\n"
17216 " char *pv_attr;\n"
17217 " int64_t pv_pe_count;\n"
17218 " int64_t pv_pe_alloc_count;\n"
17219 " char *pv_tags;\n"
17220 " uint64_t pe_start;\n"
17221 " int64_t pv_mda_count;\n"
17222 " uint64_t pv_mda_free;\n"
17228 #: ../src/guestfs-structs.pod:36
17231 " struct guestfs_lvm_pv_list {\n"
17232 " uint32_t len; /* Number of elements in list. */\n"
17233 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17239 #: ../src/guestfs-structs.pod:41
17242 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17243 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17248 #: ../src/guestfs-structs.pod:44
17249 msgid "guestfs_lvm_vg"
17253 #: ../src/guestfs-structs.pod:46
17256 " struct guestfs_lvm_vg {\n"
17257 " char *vg_name;\n"
17258 " /* The next field is NOT nul-terminated, be careful when printing it: "
17260 " char vg_uuid[32];\n"
17262 " char *vg_attr;\n"
17263 " uint64_t vg_size;\n"
17264 " uint64_t vg_free;\n"
17265 " char *vg_sysid;\n"
17266 " uint64_t vg_extent_size;\n"
17267 " int64_t vg_extent_count;\n"
17268 " int64_t vg_free_count;\n"
17269 " int64_t max_lv;\n"
17270 " int64_t max_pv;\n"
17271 " int64_t pv_count;\n"
17272 " int64_t lv_count;\n"
17273 " int64_t snap_count;\n"
17274 " int64_t vg_seqno;\n"
17275 " char *vg_tags;\n"
17276 " int64_t vg_mda_count;\n"
17277 " uint64_t vg_mda_free;\n"
17283 #: ../src/guestfs-structs.pod:69
17286 " struct guestfs_lvm_vg_list {\n"
17287 " uint32_t len; /* Number of elements in list. */\n"
17288 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17294 #: ../src/guestfs-structs.pod:74
17297 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17298 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17303 #: ../src/guestfs-structs.pod:77
17304 msgid "guestfs_lvm_lv"
17308 #: ../src/guestfs-structs.pod:79
17311 " struct guestfs_lvm_lv {\n"
17312 " char *lv_name;\n"
17313 " /* The next field is NOT nul-terminated, be careful when printing it: "
17315 " char lv_uuid[32];\n"
17316 " char *lv_attr;\n"
17317 " int64_t lv_major;\n"
17318 " int64_t lv_minor;\n"
17319 " int64_t lv_kernel_major;\n"
17320 " int64_t lv_kernel_minor;\n"
17321 " uint64_t lv_size;\n"
17322 " int64_t seg_count;\n"
17324 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17325 " float snap_percent;\n"
17326 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17327 " float copy_percent;\n"
17328 " char *move_pv;\n"
17329 " char *lv_tags;\n"
17330 " char *mirror_log;\n"
17331 " char *modules;\n"
17337 #: ../src/guestfs-structs.pod:101
17340 " struct guestfs_lvm_lv_list {\n"
17341 " uint32_t len; /* Number of elements in list. */\n"
17342 " struct guestfs_lvm_lv *val; /* Elements. */\n"
17348 #: ../src/guestfs-structs.pod:106
17351 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
17352 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
17357 #: ../src/guestfs-structs.pod:111
17360 " struct guestfs_stat {\n"
17364 " int64_t nlink;\n"
17369 " int64_t blksize;\n"
17370 " int64_t blocks;\n"
17371 " int64_t atime;\n"
17372 " int64_t mtime;\n"
17373 " int64_t ctime;\n"
17379 #: ../src/guestfs-structs.pod:127
17382 " struct guestfs_stat_list {\n"
17383 " uint32_t len; /* Number of elements in list. */\n"
17384 " struct guestfs_stat *val; /* Elements. */\n"
17390 #: ../src/guestfs-structs.pod:132
17393 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
17394 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
17399 #: ../src/guestfs-structs.pod:137
17402 " struct guestfs_statvfs {\n"
17403 " int64_t bsize;\n"
17404 " int64_t frsize;\n"
17405 " int64_t blocks;\n"
17406 " int64_t bfree;\n"
17407 " int64_t bavail;\n"
17408 " int64_t files;\n"
17409 " int64_t ffree;\n"
17410 " int64_t favail;\n"
17413 " int64_t namemax;\n"
17419 #: ../src/guestfs-structs.pod:151
17422 " struct guestfs_statvfs_list {\n"
17423 " uint32_t len; /* Number of elements in list. */\n"
17424 " struct guestfs_statvfs *val; /* Elements. */\n"
17430 #: ../src/guestfs-structs.pod:156
17433 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
17434 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
17439 #: ../src/guestfs-structs.pod:159
17440 msgid "guestfs_dirent"
17444 #: ../src/guestfs-structs.pod:161
17447 " struct guestfs_dirent {\n"
17456 #: ../src/guestfs-structs.pod:167
17459 " struct guestfs_dirent_list {\n"
17460 " uint32_t len; /* Number of elements in list. */\n"
17461 " struct guestfs_dirent *val; /* Elements. */\n"
17467 #: ../src/guestfs-structs.pod:172
17470 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
17471 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
17476 #: ../src/guestfs-structs.pod:177
17479 " struct guestfs_version {\n"
17480 " int64_t major;\n"
17481 " int64_t minor;\n"
17482 " int64_t release;\n"
17489 #: ../src/guestfs-structs.pod:184
17492 " struct guestfs_version_list {\n"
17493 " uint32_t len; /* Number of elements in list. */\n"
17494 " struct guestfs_version *val; /* Elements. */\n"
17500 #: ../src/guestfs-structs.pod:189
17503 " void guestfs_free_version (struct guestfs_free_version *);\n"
17504 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
17509 #: ../src/guestfs-structs.pod:192
17510 msgid "guestfs_xattr"
17514 #: ../src/guestfs-structs.pod:194
17517 " struct guestfs_xattr {\n"
17518 " char *attrname;\n"
17519 " /* The next two fields describe a byte array. */\n"
17520 " uint32_t attrval_len;\n"
17521 " char *attrval;\n"
17527 #: ../src/guestfs-structs.pod:201
17530 " struct guestfs_xattr_list {\n"
17531 " uint32_t len; /* Number of elements in list. */\n"
17532 " struct guestfs_xattr *val; /* Elements. */\n"
17538 #: ../src/guestfs-structs.pod:206
17541 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
17542 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
17547 #: ../src/guestfs-structs.pod:209
17548 msgid "guestfs_inotify_event"
17552 #: ../src/guestfs-structs.pod:211
17555 " struct guestfs_inotify_event {\n"
17556 " int64_t in_wd;\n"
17557 " uint32_t in_mask;\n"
17558 " uint32_t in_cookie;\n"
17559 " char *in_name;\n"
17565 #: ../src/guestfs-structs.pod:218
17568 " struct guestfs_inotify_event_list {\n"
17569 " uint32_t len; /* Number of elements in list. */\n"
17570 " struct guestfs_inotify_event *val; /* Elements. */\n"
17576 #: ../src/guestfs-structs.pod:223
17579 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
17580 " void guestfs_free_inotify_event_list (struct "
17581 "guestfs_free_inotify_event_list *);\n"
17586 #: ../src/guestfs-structs.pod:226
17587 msgid "guestfs_partition"
17591 #: ../src/guestfs-structs.pod:228
17594 " struct guestfs_partition {\n"
17595 " int32_t part_num;\n"
17596 " uint64_t part_start;\n"
17597 " uint64_t part_end;\n"
17598 " uint64_t part_size;\n"
17604 #: ../src/guestfs-structs.pod:235
17607 " struct guestfs_partition_list {\n"
17608 " uint32_t len; /* Number of elements in list. */\n"
17609 " struct guestfs_partition *val; /* Elements. */\n"
17615 #: ../src/guestfs-structs.pod:240
17618 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
17619 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
17624 #: ../src/guestfs-structs.pod:243
17625 msgid "guestfs_application"
17629 #: ../src/guestfs-structs.pod:245
17632 " struct guestfs_application {\n"
17633 " char *app_name;\n"
17634 " char *app_display_name;\n"
17635 " int32_t app_epoch;\n"
17636 " char *app_version;\n"
17637 " char *app_release;\n"
17638 " char *app_install_path;\n"
17639 " char *app_trans_path;\n"
17640 " char *app_publisher;\n"
17641 " char *app_url;\n"
17642 " char *app_source_package;\n"
17643 " char *app_summary;\n"
17644 " char *app_description;\n"
17650 #: ../src/guestfs-structs.pod:260
17653 " struct guestfs_application_list {\n"
17654 " uint32_t len; /* Number of elements in list. */\n"
17655 " struct guestfs_application *val; /* Elements. */\n"
17661 #: ../src/guestfs-structs.pod:265
17664 " void guestfs_free_application (struct guestfs_free_application *);\n"
17665 " void guestfs_free_application_list (struct guestfs_free_application_list "
17671 #: ../fish/guestfish.pod:5
17672 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17676 #: ../fish/guestfish.pod:9
17679 " guestfish [--options] [commands]\n"
17684 #: ../fish/guestfish.pod:11
17692 #: ../fish/guestfish.pod:13
17695 " guestfish [--ro|--rw] -a disk.img\n"
17700 #: ../fish/guestfish.pod:15
17703 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17708 #: ../fish/guestfish.pod:17
17711 " guestfish -d libvirt-domain\n"
17716 #: ../fish/guestfish.pod:19
17719 " guestfish [--ro|--rw] -a disk.img -i\n"
17724 #: ../fish/guestfish.pod:21
17727 " guestfish -d libvirt-domain -i\n"
17732 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
17737 #: ../fish/guestfish.pod:25
17739 "Using guestfish in read/write mode on live virtual machines can be "
17740 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17741 "option to use guestfish safely if the disk image or virtual machine might be "
17746 #: ../fish/guestfish.pod:32
17748 "Guestfish is a shell and command-line tool for examining and modifying "
17749 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17750 "functionality of the guestfs API, see L<guestfs(3)>."
17754 #: ../fish/guestfish.pod:36
17756 "Guestfish gives you structured access to the libguestfs API, from shell "
17757 "scripts or the command line or interactively. If you want to rescue a "
17758 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17763 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:923 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:50
17768 #: ../fish/guestfish.pod:43
17769 msgid "As an interactive shell"
17773 #: ../fish/guestfish.pod:45
17781 #: ../fish/guestfish.pod:47
17784 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17785 " editing virtual machine filesystems.\n"
17790 #: ../fish/guestfish.pod:50
17793 " Type: 'help' for a list of commands\n"
17794 " 'man' to read the manual\n"
17795 " 'quit' to quit the shell\n"
17800 #: ../fish/guestfish.pod:54
17803 " ><fs> add-ro disk.img\n"
17805 " ><fs> list-filesystems\n"
17806 " /dev/sda1: ext4\n"
17807 " /dev/vg_guest/lv_root: ext4\n"
17808 " /dev/vg_guest/lv_swap: swap\n"
17809 " ><fs> mount /dev/vg_guest/lv_root /\n"
17810 " ><fs> cat /etc/fstab\n"
17812 " # Created by anaconda\n"
17819 #: ../fish/guestfish.pod:67
17820 msgid "From shell scripts"
17824 #: ../fish/guestfish.pod:69
17825 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17829 #: ../fish/guestfish.pod:71
17832 " guestfish <<_EOF_\n"
17835 " mount /dev/vg_guest/lv_root /\n"
17836 " write /etc/motd \"Welcome, new users\"\n"
17842 #: ../fish/guestfish.pod:78
17843 msgid "List the LVM logical volumes in a disk image:"
17847 #: ../fish/guestfish.pod:80
17850 " guestfish -a disk.img --ro <<_EOF_\n"
17858 #: ../fish/guestfish.pod:85
17859 msgid "List all the filesystems in a disk image:"
17863 #: ../fish/guestfish.pod:87
17866 " guestfish -a disk.img --ro <<_EOF_\n"
17868 " list-filesystems\n"
17874 #: ../fish/guestfish.pod:92
17875 msgid "On one command line"
17879 #: ../fish/guestfish.pod:94
17880 msgid "Update C</etc/resolv.conf> in a guest:"
17884 #: ../fish/guestfish.pod:96
17888 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17889 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17894 #: ../fish/guestfish.pod:100
17895 msgid "Edit C</boot/grub/grub.conf> interactively:"
17899 #: ../fish/guestfish.pod:102
17902 " guestfish --rw --add disk.img \\\n"
17903 " --mount /dev/vg_guest/lv_root \\\n"
17904 " --mount /dev/sda1:/boot \\\n"
17905 " edit /boot/grub/grub.conf\n"
17910 #: ../fish/guestfish.pod:107
17911 msgid "Mount disks automatically"
17915 #: ../fish/guestfish.pod:109
17917 "Use the I<-i> option to automatically mount the disks from a virtual "
17922 #: ../fish/guestfish.pod:112
17925 " guestfish --ro -a disk.img -i cat /etc/group\n"
17930 #: ../fish/guestfish.pod:114
17933 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17938 #: ../fish/guestfish.pod:116
17939 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17943 #: ../fish/guestfish.pod:118
17946 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17951 #: ../fish/guestfish.pod:120
17952 msgid "As a script interpreter"
17956 #: ../fish/guestfish.pod:122
17957 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17961 #: ../fish/guestfish.pod:124
17964 " #!/usr/bin/guestfish -f\n"
17965 " sparse test1.img 100M\n"
17967 " part-disk /dev/sda mbr\n"
17968 " mkfs ext2 /dev/sda1\n"
17973 #: ../fish/guestfish.pod:130
17974 msgid "Start with a prepared disk"
17978 #: ../fish/guestfish.pod:132
17980 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17981 "single ext2-formatted partition:"
17985 #: ../fish/guestfish.pod:135
17988 " guestfish -N fs\n"
17993 #: ../fish/guestfish.pod:137
17994 msgid "To list what is available do:"
17998 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:914
18001 " guestfish -N help | less\n"
18006 #: ../fish/guestfish.pod:141
18007 msgid "Remote control"
18011 #: ../fish/guestfish.pod:143
18014 " eval \"`guestfish --listen`\"\n"
18015 " guestfish --remote add-ro disk.img\n"
18016 " guestfish --remote run\n"
18017 " guestfish --remote lvs\n"
18022 #: ../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
18027 #: ../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
18032 #: ../fish/guestfish.pod:154
18033 msgid "Displays general help on options."
18037 #: ../fish/guestfish.pod:156
18042 #: ../fish/guestfish.pod:158
18043 msgid "B<--cmd-help>"
18047 #: ../fish/guestfish.pod:160
18048 msgid "Lists all available guestfish commands."
18052 #: ../fish/guestfish.pod:162
18057 #: ../fish/guestfish.pod:164
18058 msgid "B<--cmd-help cmd>"
18062 #: ../fish/guestfish.pod:166
18063 msgid "Displays detailed help on a single command C<cmd>."
18067 #: ../fish/guestfish.pod:168
18068 msgid "B<-a image>"
18072 #: ../fish/guestfish.pod:170
18073 msgid "B<--add image>"
18077 #: ../fish/guestfish.pod:172
18078 msgid "Add a block device or virtual machine image to the shell."
18082 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
18084 "The format of the disk image is auto-detected. To override this and force a "
18085 "particular format use the I<--format=..> option."
18089 #: ../fish/guestfish.pod:177
18091 "Using this flag is mostly equivalent to using the C<add> command, with "
18092 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
18093 "the I<--format:...> flag was given."
18097 #: ../fish/guestfish.pod:181
18102 #: ../fish/guestfish.pod:183
18103 msgid "B<--connect URI>"
18107 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
18109 "When used in conjunction with the I<-d> option, this specifies the libvirt "
18110 "URI to use. The default is to use the default libvirt connection."
18114 #: ../fish/guestfish.pod:189
18119 #: ../fish/guestfish.pod:191
18121 "If using the I<--listen> option and a csh-like shell, use this option. See "
18122 "section L</REMOTE CONTROL AND CSH> below."
18126 #: ../fish/guestfish.pod:194
18127 msgid "B<-d libvirt-domain>"
18131 #: ../fish/guestfish.pod:196
18132 msgid "B<--domain libvirt-domain>"
18136 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
18138 "Add disks from the named libvirt domain. If the I<--ro> option is also "
18139 "used, then any libvirt domain can be used. However in write mode, only "
18140 "libvirt domains which are shut down can be named here."
18144 #: ../fish/guestfish.pod:202
18146 "Using this flag is mostly equivalent to using the C<add-domain> command, "
18147 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
18148 "if the I<--format:...> flag was given."
18152 #: ../fish/guestfish.pod:206
18157 #: ../fish/guestfish.pod:208
18158 msgid "B<--no-dest-paths>"
18162 #: ../fish/guestfish.pod:210
18164 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
18165 "to hit the tab key to complete paths on the guest filesystem, but this "
18166 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
18167 "allow this feature to be disabled."
18171 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
18172 msgid "B<--echo-keys>"
18176 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
18178 "When prompting for keys and passphrases, guestfish normally turns echoing "
18179 "off so you cannot see what you are typing. If you are not worried about "
18180 "Tempest attacks and there is no one else in the room you can specify this "
18181 "flag to see what you are typing."
18185 #: ../fish/guestfish.pod:222
18190 #: ../fish/guestfish.pod:224
18191 msgid "B<--file file>"
18195 #: ../fish/guestfish.pod:226
18196 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
18200 #: ../fish/guestfish.pod:229
18203 " #!/usr/bin/guestfish -f\n"
18208 #: ../fish/guestfish.pod:231
18209 msgid "B<--format=raw|qcow2|..>"
18213 #: ../fish/guestfish.pod:233
18214 msgid "B<--format>"
18218 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
18220 "The default for the I<-a> option is to auto-detect the format of the disk "
18221 "image. Using this forces the disk format for I<-a> options which follow on "
18222 "the command line. Using I<--format> with no argument switches back to "
18223 "auto-detection for subsequent I<-a> options."
18227 #: ../fish/guestfish.pod:242
18230 " guestfish --format=raw -a disk.img\n"
18235 #: ../fish/guestfish.pod:244
18236 msgid "forces raw format (no auto-detection) for C<disk.img>."
18240 #: ../fish/guestfish.pod:246
18243 " guestfish --format=raw -a disk.img --format -a another.img\n"
18248 #: ../fish/guestfish.pod:248
18250 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18251 "auto-detection for C<another.img>."
18255 #: ../fish/guestfish.pod:251
18257 "If you have untrusted raw-format guest disk images, you should use this "
18258 "option to specify the disk format. This avoids a possible security problem "
18259 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18263 #: ../fish/guestfish.pod:256
18268 #: ../fish/guestfish.pod:258
18269 msgid "B<--inspector>"
18273 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18275 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18276 "system and mount filesystems as they would be mounted on the real virtual "
18281 #: ../fish/guestfish.pod:264
18282 msgid "Typical usage is either:"
18286 #: ../fish/guestfish.pod:266
18289 " guestfish -d myguest -i\n"
18294 #: ../fish/guestfish.pod:268
18295 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18299 #: ../fish/guestfish.pod:270
18302 " guestfish --ro -d myguest -i\n"
18307 #: ../fish/guestfish.pod:272
18308 msgid "(for active domains, readonly), or specify the block device directly:"
18312 #: ../fish/guestfish.pod:274
18315 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18320 #: ../fish/guestfish.pod:276
18322 "Note that the command line syntax changed slightly over older versions of "
18323 "guestfish. You can still use the old syntax:"
18327 #: ../fish/guestfish.pod:279
18330 " guestfish [--ro] -i disk.img\n"
18335 #: ../fish/guestfish.pod:281
18338 " guestfish [--ro] -i libvirt-domain\n"
18343 #: ../fish/guestfish.pod:283
18345 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
18346 "then using other commands to mount the filesystems that were found."
18350 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
18351 msgid "B<--keys-from-stdin>"
18355 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
18357 "Read key or passphrase parameters from stdin. The default is to try to read "
18358 "passphrases from the user by opening C</dev/tty>."
18362 #: ../fish/guestfish.pod:292
18363 msgid "B<--listen>"
18367 #: ../fish/guestfish.pod:294
18369 "Fork into the background and listen for remote commands. See section "
18370 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18374 #: ../fish/guestfish.pod:297
18375 msgid "B<-m dev[:mountpoint]>"
18379 #: ../fish/guestfish.pod:299
18380 msgid "B<--mount dev[:mountpoint]>"
18384 #: ../fish/guestfish.pod:301
18385 msgid "Mount the named partition or logical volume on the given mountpoint."
18389 #: ../fish/guestfish.pod:303
18390 msgid "If the mountpoint is omitted, it defaults to C</>."
18394 #: ../fish/guestfish.pod:305
18395 msgid "You have to mount something on C</> before most commands will work."
18399 #: ../fish/guestfish.pod:307
18401 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18406 #: ../fish/guestfish.pod:310
18408 "If you don't know what filesystems a disk image contains, you can either run "
18409 "guestfish without this option, then list the partitions, filesystems and LVs "
18410 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18411 "commands), or you can use the L<virt-filesystems(1)> program."
18415 #: ../fish/guestfish.pod:316
18417 "Using this flag is mostly equivalent to using the C<mount-options> command "
18418 "or the C<mount-ro> command if the I<--ro> flag was given."
18422 #: ../fish/guestfish.pod:319
18427 #: ../fish/guestfish.pod:321
18428 msgid "B<--no-sync>"
18432 #: ../fish/guestfish.pod:323
18434 "Disable autosync. This is enabled by default. See the discussion of "
18435 "autosync in the L<guestfs(3)> manpage."
18439 #: ../fish/guestfish.pod:326
18444 #: ../fish/guestfish.pod:328
18445 msgid "B<--new type>"
18449 #: ../fish/guestfish.pod:330
18454 #: ../fish/guestfish.pod:332
18456 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18457 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18458 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18463 #: ../fish/guestfish.pod:337
18464 msgid "B<--progress-bars>"
18468 #: ../fish/guestfish.pod:339
18469 msgid "Enable progress bars, even when guestfish is used non-interactively."
18473 #: ../fish/guestfish.pod:341
18475 "Progress bars are enabled by default when guestfish is used as an "
18476 "interactive shell."
18480 #: ../fish/guestfish.pod:344
18481 msgid "B<--no-progress-bars>"
18485 #: ../fish/guestfish.pod:346
18486 msgid "Disable progress bars."
18490 #: ../fish/guestfish.pod:348
18491 msgid "B<--remote[=pid]>"
18495 #: ../fish/guestfish.pod:350
18497 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18498 "CONTROL GUESTFISH OVER A SOCKET> below."
18502 #: ../fish/guestfish.pod:353
18507 #: ../fish/guestfish.pod:355
18512 #: ../fish/guestfish.pod:357
18514 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18515 "mounts are done read-only."
18519 #: ../fish/guestfish.pod:360
18521 "The option must always be used if the disk image or virtual machine might be "
18522 "running, and is generally recommended in cases where you don't need write "
18523 "access to the disk."
18527 #: ../fish/guestfish.pod:364
18529 "Note that prepared disk images created with I<-N> are not affected by this "
18530 "option. Also commands like C<add> are not affected - you have to specify "
18531 "the C<readonly:true> option explicitly if you need it."
18535 #: ../fish/guestfish.pod:368
18536 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18540 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
18541 msgid "B<--selinux>"
18545 #: ../fish/guestfish.pod:372
18546 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18550 #: ../fish/guestfish.pod:374
18555 #: ../fish/guestfish.pod:376
18556 msgid "B<--verbose>"
18560 #: ../fish/guestfish.pod:378
18562 "Enable very verbose messages. This is particularly useful if you find a "
18567 #: ../fish/guestfish.pod:381
18572 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
18573 msgid "B<--version>"
18577 #: ../fish/guestfish.pod:385
18578 msgid "Display the guestfish / libguestfs version number and exit."
18582 #: ../fish/guestfish.pod:387
18587 #: ../fish/guestfish.pod:389
18592 #: ../fish/guestfish.pod:391
18594 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
18599 #: ../fish/guestfish.pod:394
18604 #: ../fish/guestfish.pod:396
18605 msgid "Echo each command before executing it."
18609 #: ../fish/guestfish.pod:400
18610 msgid "COMMANDS ON COMMAND LINE"
18614 #: ../fish/guestfish.pod:402
18615 msgid "Any additional (non-option) arguments are treated as commands to execute."
18619 #: ../fish/guestfish.pod:405
18621 "Commands to execute should be separated by a colon (C<:>), where the colon "
18622 "is a separate parameter. Thus:"
18626 #: ../fish/guestfish.pod:408
18629 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18634 #: ../fish/guestfish.pod:410
18636 "If there are no additional arguments, then we enter a shell, either an "
18637 "interactive shell with a prompt (if the input is a terminal) or a "
18638 "non-interactive shell."
18642 #: ../fish/guestfish.pod:414
18644 "In either command line mode or non-interactive shell, the first command that "
18645 "gives an error causes the whole shell to exit. In interactive mode (with a "
18646 "prompt) if a command fails, you can continue to enter commands."
18650 #: ../fish/guestfish.pod:419
18651 msgid "USING launch (OR run)"
18655 #: ../fish/guestfish.pod:421
18657 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18658 "then launch it, then mount any disks you need, and finally issue "
18659 "actions/commands. So the general order of the day is:"
18663 #: ../fish/guestfish.pod:429
18664 msgid "add or -a/--add"
18668 #: ../fish/guestfish.pod:433
18669 msgid "launch (aka run)"
18673 #: ../fish/guestfish.pod:437
18674 msgid "mount or -m/--mount"
18678 #: ../fish/guestfish.pod:441
18679 msgid "any other commands"
18683 #: ../fish/guestfish.pod:445
18685 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18686 "guest before mounting or performing any other commands."
18690 #: ../fish/guestfish.pod:448
18692 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18693 "I<--new> options were given then C<run> is done automatically, simply "
18694 "because guestfish can't perform the action you asked for without doing this."
18698 #: ../fish/guestfish.pod:453
18699 msgid "OPENING DISKS FOR READ AND WRITE"
18703 #: ../fish/guestfish.pod:455
18705 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
18706 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
18707 "open disk images read-only or for writing."
18711 #: ../fish/guestfish.pod:459
18713 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
18714 "disk images supplied on the command line for write. To open a disk image "
18715 "read-only you have to do I<-a image --ro>."
18719 #: ../fish/guestfish.pod:463
18721 "This matters: If you accidentally open a live VM disk image writable then "
18722 "you will cause irreversible disk corruption."
18726 #: ../fish/guestfish.pod:466
18728 "By libguestfs 1.10 we intend to change the default the other way. Disk "
18729 "images will be opened read-only. You will have to either specify "
18730 "I<guestfish --rw> or change a configuration file in order to get write "
18731 "access for disk images specified by those other command line options."
18735 #: ../fish/guestfish.pod:471
18737 "This version of guestfish has a I<--rw> option which does nothing (it is "
18738 "already the default). However it is highly recommended that you use this "
18739 "option to indicate that guestfish needs write access, and to prepare your "
18740 "scripts for the day when this option will be required for write access."
18744 #: ../fish/guestfish.pod:477
18746 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18747 "other libguestfs program apart from guestfish and guestmount."
18751 #: ../fish/guestfish.pod:480
18756 #: ../fish/guestfish.pod:482
18758 "You can quote ordinary parameters using either single or double quotes. For "
18763 #: ../fish/guestfish.pod:485
18766 " add \"file with a space.img\"\n"
18771 #: ../fish/guestfish.pod:487
18774 " rm '/file name'\n"
18779 #: ../fish/guestfish.pod:489
18787 #: ../fish/guestfish.pod:491
18789 "A few commands require a list of strings to be passed. For these, use a "
18790 "whitespace-separated list, enclosed in quotes. Strings containing "
18791 "whitespace to be passed through must be enclosed in single quotes. A "
18792 "literal single quote must be escaped with a backslash."
18796 #: ../fish/guestfish.pod:496
18799 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18800 " command \"/bin/echo 'foo bar'\"\n"
18801 " command \"/bin/echo \\'foo\\'\"\n"
18806 #: ../fish/guestfish.pod:500
18807 msgid "OPTIONAL ARGUMENTS"
18811 #: ../fish/guestfish.pod:502
18813 "Some commands take optional arguments. These arguments appear in this "
18814 "documentation as C<[argname:..]>. You can use them as in these examples:"
18818 #: ../fish/guestfish.pod:506
18821 " add-drive-opts filename\n"
18826 #: ../fish/guestfish.pod:508
18829 " add-drive-opts filename readonly:true\n"
18834 #: ../fish/guestfish.pod:510
18837 " add-drive-opts filename format:qcow2 readonly:false\n"
18842 #: ../fish/guestfish.pod:512
18844 "Each optional argument can appear at most once. All optional arguments must "
18845 "appear after the required ones."
18849 #: ../fish/guestfish.pod:515
18854 #: ../fish/guestfish.pod:517
18855 msgid "This section applies to all commands which can take integers as parameters."
18859 #: ../fish/guestfish.pod:520
18860 msgid "SIZE SUFFIX"
18864 #: ../fish/guestfish.pod:522
18866 "When the command takes a parameter measured in bytes, you can use one of the "
18867 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18871 #: ../fish/guestfish.pod:528
18872 msgid "B<k> or B<K> or B<KiB>"
18876 #: ../fish/guestfish.pod:530
18877 msgid "The size in kilobytes (multiplied by 1024)."
18881 #: ../fish/guestfish.pod:532
18886 #: ../fish/guestfish.pod:534
18887 msgid "The size in SI 1000 byte units."
18891 #: ../fish/guestfish.pod:536
18892 msgid "B<M> or B<MiB>"
18896 #: ../fish/guestfish.pod:538
18897 msgid "The size in megabytes (multiplied by 1048576)."
18901 #: ../fish/guestfish.pod:540
18906 #: ../fish/guestfish.pod:542
18907 msgid "The size in SI 1000000 byte units."
18911 #: ../fish/guestfish.pod:544
18912 msgid "B<G> or B<GiB>"
18916 #: ../fish/guestfish.pod:546
18917 msgid "The size in gigabytes (multiplied by 2**30)."
18921 #: ../fish/guestfish.pod:548
18926 #: ../fish/guestfish.pod:550
18927 msgid "The size in SI 10**9 byte units."
18931 #: ../fish/guestfish.pod:552
18932 msgid "B<T> or B<TiB>"
18936 #: ../fish/guestfish.pod:554
18937 msgid "The size in terabytes (multiplied by 2**40)."
18941 #: ../fish/guestfish.pod:556
18946 #: ../fish/guestfish.pod:558
18947 msgid "The size in SI 10**12 byte units."
18951 #: ../fish/guestfish.pod:560
18952 msgid "B<P> or B<PiB>"
18956 #: ../fish/guestfish.pod:562
18957 msgid "The size in petabytes (multiplied by 2**50)."
18961 #: ../fish/guestfish.pod:564
18966 #: ../fish/guestfish.pod:566
18967 msgid "The size in SI 10**15 byte units."
18971 #: ../fish/guestfish.pod:568
18972 msgid "B<E> or B<EiB>"
18976 #: ../fish/guestfish.pod:570
18977 msgid "The size in exabytes (multiplied by 2**60)."
18981 #: ../fish/guestfish.pod:572
18986 #: ../fish/guestfish.pod:574
18987 msgid "The size in SI 10**18 byte units."
18991 #: ../fish/guestfish.pod:576
18992 msgid "B<Z> or B<ZiB>"
18996 #: ../fish/guestfish.pod:578
18997 msgid "The size in zettabytes (multiplied by 2**70)."
19001 #: ../fish/guestfish.pod:580
19006 #: ../fish/guestfish.pod:582
19007 msgid "The size in SI 10**21 byte units."
19011 #: ../fish/guestfish.pod:584
19012 msgid "B<Y> or B<YiB>"
19016 #: ../fish/guestfish.pod:586
19017 msgid "The size in yottabytes (multiplied by 2**80)."
19021 #: ../fish/guestfish.pod:588
19026 #: ../fish/guestfish.pod:590
19027 msgid "The size in SI 10**24 byte units."
19031 #: ../fish/guestfish.pod:596
19034 " truncate-size /file 1G\n"
19039 #: ../fish/guestfish.pod:598
19040 msgid "would truncate the file to 1 gigabyte."
19044 #: ../fish/guestfish.pod:600
19046 "Be careful because a few commands take sizes in kilobytes or megabytes "
19047 "(eg. the parameter to L</memsize> is specified in megabytes already). "
19048 "Adding a suffix will probably not do what you expect."
19052 #: ../fish/guestfish.pod:604
19053 msgid "OCTAL AND HEXADECIMAL NUMBERS"
19057 #: ../fish/guestfish.pod:606
19059 "For specifying the radix (base) use the C convention: C<0> to prefix an "
19060 "octal number or C<0x> to prefix a hexadecimal number. For example:"
19064 #: ../fish/guestfish.pod:609
19067 " 1234 decimal number 1234\n"
19068 " 02322 octal number, equivalent to decimal 1234\n"
19069 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
19074 #: ../fish/guestfish.pod:613
19076 "When using the C<chmod> command, you almost always want to specify an octal "
19077 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
19078 "L<chmod(1)> program):"
19082 #: ../fish/guestfish.pod:617
19085 " chmod 0777 /public # OK\n"
19086 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
19091 #: ../fish/guestfish.pod:620
19093 "Commands that return numbers usually print them in decimal, but some "
19094 "commands print numbers in other radices (eg. C<umask> prints the mode in "
19095 "octal, preceeded by C<0>)."
19099 #: ../fish/guestfish.pod:624
19100 msgid "WILDCARDS AND GLOBBING"
19104 #: ../fish/guestfish.pod:626
19106 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
19107 "(globbing) by default. So for example the following will not do what you "
19112 #: ../fish/guestfish.pod:630
19120 #: ../fish/guestfish.pod:632
19122 "Assuming you don't have a directory called literally C</home/*> then the "
19123 "above command will return an error."
19127 #: ../fish/guestfish.pod:635
19128 msgid "To perform wildcard expansion, use the C<glob> command."
19132 #: ../fish/guestfish.pod:637
19135 " glob rm-rf /home/*\n"
19140 #: ../fish/guestfish.pod:639
19142 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
19143 "many times), equivalent to:"
19147 #: ../fish/guestfish.pod:642
19150 " rm-rf /home/jim\n"
19151 " rm-rf /home/joe\n"
19152 " rm-rf /home/mary\n"
19157 #: ../fish/guestfish.pod:646
19158 msgid "C<glob> only works on simple guest paths and not on device names."
19162 #: ../fish/guestfish.pod:648
19164 "If you have several parameters, each containing a wildcard, then glob will "
19165 "perform a Cartesian product."
19169 #: ../fish/guestfish.pod:651
19174 #: ../fish/guestfish.pod:653
19176 "Any line which starts with a I<#> character is treated as a comment and "
19177 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
19178 "a command. For example:"
19182 #: ../fish/guestfish.pod:657
19185 " # this is a comment\n"
19186 " # this is a comment\n"
19187 " foo # NOT a comment\n"
19192 #: ../fish/guestfish.pod:661
19193 msgid "Blank lines are also ignored."
19197 #: ../fish/guestfish.pod:663
19198 msgid "RUNNING COMMANDS LOCALLY"
19202 #: ../fish/guestfish.pod:665
19204 "Any line which starts with a I<!> character is treated as a command sent to "
19205 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
19209 #: ../fish/guestfish.pod:669
19213 " tgz-out /remote local/remote-data.tar.gz\n"
19218 #: ../fish/guestfish.pod:672
19220 "will create a directory C<local> on the host, and then export the contents "
19221 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
19222 "(See C<tgz-out>)."
19226 #: ../fish/guestfish.pod:676
19228 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
19229 "effect, due to the way that subprocesses work in Unix."
19233 #: ../fish/guestfish.pod:679
19234 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
19238 #: ../fish/guestfish.pod:681
19240 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
19241 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
19242 "and executed as guestfish commands."
19246 #: ../fish/guestfish.pod:685
19248 "Thus you can use shell script to construct arbitrary guestfish commands "
19249 "which are then parsed by guestfish."
19253 #: ../fish/guestfish.pod:688
19255 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
19256 "through C</foo.100>) using guestfish commands alone. However this is simple "
19257 "if we use a shell script to create the guestfish commands for us:"
19261 #: ../fish/guestfish.pod:693
19264 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
19269 #: ../fish/guestfish.pod:695
19270 msgid "or with names like C</foo.001>:"
19274 #: ../fish/guestfish.pod:697
19277 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
19282 #: ../fish/guestfish.pod:699
19284 "When using guestfish interactively it can be helpful to just run the shell "
19285 "script first (ie. remove the initial C<E<lt>> character so it is just an "
19286 "ordinary I<!> local command), see what guestfish commands it would run, and "
19287 "when you are happy with those prepend the C<E<lt>> character to run the "
19288 "guestfish commands for real."
19292 #: ../fish/guestfish.pod:705
19297 #: ../fish/guestfish.pod:707
19299 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19300 "command (a guestfish command) to the second command (any host command). For "
19305 #: ../fish/guestfish.pod:711
19308 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19313 #: ../fish/guestfish.pod:713
19315 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19316 "program). The above command would list all accounts in the guest filesystem "
19317 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19321 #: ../fish/guestfish.pod:718
19324 " hexdump /bin/ls | head\n"
19325 " list-devices | tail -1\n"
19326 " tgz-out / - | tar ztf -\n"
19331 #: ../fish/guestfish.pod:722
19333 "The space before the pipe symbol is required, any space after the pipe "
19334 "symbol is optional. Everything after the pipe symbol is just passed "
19335 "straight to the host shell, so it can contain redirections, globs and "
19336 "anything else that makes sense on the host side."
19340 #: ../fish/guestfish.pod:727
19342 "To use a literal argument which begins with a pipe symbol, you have to quote "
19347 #: ../fish/guestfish.pod:730
19355 #: ../fish/guestfish.pod:732
19356 msgid "HOME DIRECTORIES"
19360 #: ../fish/guestfish.pod:734
19362 "If a parameter starts with the character C<~> then the tilde may be expanded "
19363 "as a home directory path (either C<~> for the current user's home directory, "
19364 "or C<~user> for another user)."
19368 #: ../fish/guestfish.pod:738
19370 "Note that home directory expansion happens for users known I<on the host>, "
19371 "not in the guest filesystem."
19375 #: ../fish/guestfish.pod:741
19377 "To use a literal argument which begins with a tilde, you have to quote it, "
19382 #: ../fish/guestfish.pod:744
19390 #: ../fish/guestfish.pod:748
19392 "Libguestfs has some support for Linux guests encrypted according to the "
19393 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19394 "disk encryption systems used by modern Linux guests. Currently only "
19395 "LVM-on-LUKS is supported."
19399 #: ../fish/guestfish.pod:753
19400 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19404 #: ../fish/guestfish.pod:755
19407 " ><fs> vfs-type /dev/sda2\n"
19413 #: ../fish/guestfish.pod:758
19415 "Then open those devices using L</luks-open>. This creates a device-mapper "
19416 "device called C</dev/mapper/luksdev>."
19420 #: ../fish/guestfish.pod:761
19423 " ><fs> luks-open /dev/sda2 luksdev\n"
19424 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19429 #: ../fish/guestfish.pod:764
19431 "Finally you have to tell LVM to scan for volume groups on the newly created "
19436 #: ../fish/guestfish.pod:767
19440 " vg-activate-all true\n"
19445 #: ../fish/guestfish.pod:770
19446 msgid "The logical volume(s) can now be mounted in the usual way."
19450 #: ../fish/guestfish.pod:772
19452 "Before closing a LUKS device you must unmount any logical volumes on it and "
19453 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19454 "one. Then you can close the mapper device:"
19458 #: ../fish/guestfish.pod:776
19461 " vg-activate false /dev/VG\n"
19462 " luks-close /dev/mapper/luksdev\n"
19467 #: ../fish/guestfish.pod:779
19468 msgid "WINDOWS PATHS"
19472 #: ../fish/guestfish.pod:781
19474 "If a path is prefixed with C<win:> then you can use Windows-style paths "
19475 "(with some limitations). The following commands are equivalent:"
19479 #: ../fish/guestfish.pod:784
19482 " file /WINDOWS/system32/config/system.LOG\n"
19487 #: ../fish/guestfish.pod:786
19490 " file win:/windows/system32/config/system.log\n"
19495 #: ../fish/guestfish.pod:788
19498 " file win:\\windows\\system32\\config\\system.log\n"
19503 #: ../fish/guestfish.pod:790
19506 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
19511 #: ../fish/guestfish.pod:792
19513 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
19514 "handles case insensitivity like Windows would. This only works in argument "
19515 "positions that expect a path."
19519 #: ../fish/guestfish.pod:796
19520 msgid "UPLOADING AND DOWNLOADING FILES"
19524 #: ../fish/guestfish.pod:798
19526 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19527 "others which upload from or download to a local file, you can use the "
19528 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19532 #: ../fish/guestfish.pod:802
19540 #: ../fish/guestfish.pod:804
19541 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19545 #: ../fish/guestfish.pod:807
19548 " tar-out /etc - | tar tf -\n"
19553 #: ../fish/guestfish.pod:809
19555 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19556 "command (see L</PIPES>)."
19560 #: ../fish/guestfish.pod:812
19562 "When using C<-> to read from stdin, the input is read up to the end of "
19563 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19564 "some arbitrary end marker:"
19568 #: ../fish/guestfish.pod:816
19571 " upload -<<END /foo\n"
19580 #: ../fish/guestfish.pod:822
19582 "Any string of characters can be used instead of C<END>. The end marker must "
19583 "appear on a line of its own, without any preceeding or following characters "
19584 "(not even spaces)."
19588 #: ../fish/guestfish.pod:826
19590 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19591 "upload local files (so-called \"FileIn\" parameters in the generator)."
19595 #: ../fish/guestfish.pod:829
19596 msgid "EXIT ON ERROR BEHAVIOUR"
19600 #: ../fish/guestfish.pod:831
19602 "By default, guestfish will ignore any errors when in interactive mode "
19603 "(ie. taking commands from a human over a tty), and will exit on the first "
19604 "error in non-interactive mode (scripts, commands given on the command line)."
19608 #: ../fish/guestfish.pod:836
19610 "If you prefix a command with a I<-> character, then that command will not "
19611 "cause guestfish to exit, even if that (one) command returns an error."
19615 #: ../fish/guestfish.pod:840
19616 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19620 #: ../fish/guestfish.pod:842
19622 "Guestfish can be remote-controlled over a socket. This is useful "
19623 "particularly in shell scripts where you want to make several different "
19624 "changes to a filesystem, but you don't want the overhead of starting up a "
19625 "guestfish process each time."
19629 #: ../fish/guestfish.pod:847
19630 msgid "Start a guestfish server process using:"
19634 #: ../fish/guestfish.pod:849
19637 " eval \"`guestfish --listen`\"\n"
19642 #: ../fish/guestfish.pod:851
19643 msgid "and then send it commands by doing:"
19647 #: ../fish/guestfish.pod:853
19650 " guestfish --remote cmd [...]\n"
19655 #: ../fish/guestfish.pod:855
19656 msgid "To cause the server to exit, send it the exit command:"
19660 #: ../fish/guestfish.pod:857
19663 " guestfish --remote exit\n"
19668 #: ../fish/guestfish.pod:859
19670 "Note that the server will normally exit if there is an error in a command. "
19671 "You can change this in the usual way. See section L</EXIT ON ERROR "
19676 #: ../fish/guestfish.pod:863
19677 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19681 #: ../fish/guestfish.pod:865
19683 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19684 "is how the I<--remote> option knows where to send the commands. You can "
19685 "have several guestfish listener processes running using:"
19689 #: ../fish/guestfish.pod:869
19692 " eval \"`guestfish --listen`\"\n"
19693 " pid1=$GUESTFISH_PID\n"
19694 " eval \"`guestfish --listen`\"\n"
19695 " pid2=$GUESTFISH_PID\n"
19697 " guestfish --remote=$pid1 cmd\n"
19698 " guestfish --remote=$pid2 cmd\n"
19703 #: ../fish/guestfish.pod:877
19704 msgid "REMOTE CONTROL AND CSH"
19708 #: ../fish/guestfish.pod:879
19710 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19715 #: ../fish/guestfish.pod:882
19718 " eval \"`guestfish --listen --csh`\"\n"
19723 #: ../fish/guestfish.pod:884
19724 msgid "REMOTE CONTROL DETAILS"
19728 #: ../fish/guestfish.pod:886
19730 "Remote control happens over a Unix domain socket called "
19731 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19732 "of the process, and C<$PID> is the process ID of the server."
19736 #: ../fish/guestfish.pod:890
19737 msgid "Guestfish client and server versions must match exactly."
19741 #: ../fish/guestfish.pod:892
19742 msgid "PREPARED DISK IMAGES"
19746 #: ../fish/guestfish.pod:894
19748 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19749 "preformatted disk images that guestfish can make for you to save typing. "
19750 "This is particularly useful for testing purposes. This option is used "
19751 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19752 "can be mixed with I<-a>)."
19756 #: ../fish/guestfish.pod:900
19758 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19759 "the second and so on. Existing files in the current directory are "
19764 #: ../fish/guestfish.pod:904
19766 "The type briefly describes how the disk should be sized, partitioned, how "
19767 "filesystem(s) should be created, and how content should be added. "
19768 "Optionally the type can be followed by extra parameters, separated by C<:> "
19769 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19770 "sparsely-allocated disk, containing a single partition, with the partition "
19771 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19772 "on a 1GB disk instead."
19776 #: ../fish/guestfish.pod:912
19777 msgid "To list the available types and any extra parameters they take, run:"
19781 #: ../fish/guestfish.pod:916
19783 "Note that the prepared filesystem is not mounted. You would usually have to "
19784 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19788 #: ../fish/guestfish.pod:920
19790 "If any I<-N> or I<--new> options are given, the guest is automatically "
19795 #: ../fish/guestfish.pod:925
19796 msgid "Create a 100MB disk with an ext4-formatted partition:"
19800 #: ../fish/guestfish.pod:927
19803 " guestfish -N fs:ext4\n"
19808 #: ../fish/guestfish.pod:929
19809 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19813 #: ../fish/guestfish.pod:931
19816 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19821 #: ../fish/guestfish.pod:933
19822 msgid "Create a blank 200MB disk:"
19826 #: ../fish/guestfish.pod:935
19829 " guestfish -N disk:200M\n"
19834 #: ../fish/guestfish.pod:937
19835 msgid "PROGRESS BARS"
19839 #: ../fish/guestfish.pod:939
19841 "Some (not all) long-running commands send progress notification messages as "
19842 "they are running. Guestfish turns these messages into progress bars."
19846 #: ../fish/guestfish.pod:943
19848 "When a command that supports progress bars takes longer than two seconds to "
19849 "run, and if progress bars are enabled, then you will see one appearing below "
19854 #: ../fish/guestfish.pod:947
19857 " ><fs> copy-size /large-file /another-file 2048M\n"
19858 " / 10% [#####-----------------------------------------] 00:30\n"
19863 #: ../fish/guestfish.pod:950
19865 "The spinner on the left hand side moves round once for every progress "
19866 "notification received from the backend. This is a (reasonably) golden "
19867 "assurance that the command is \"doing something\" even if the progress bar "
19868 "is not moving, because the command is able to send the progress "
19869 "notifications. When the bar reaches 100% and the command finishes, the "
19870 "spinner disappears."
19874 #: ../fish/guestfish.pod:957
19876 "Progress bars are enabled by default when guestfish is used interactively. "
19877 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19878 "and you can disable them completely using I<--no-progress-bars>."
19882 #: ../fish/guestfish.pod:962
19883 msgid "GUESTFISH COMMANDS"
19887 #: ../fish/guestfish.pod:964
19889 "The commands in this section are guestfish convenience commands, in other "
19890 "words, they are not part of the L<guestfs(3)> API."
19894 #: ../fish/guestfish.pod:967
19899 #: ../fish/guestfish.pod:969
19908 #: ../fish/guestfish.pod:972
19909 msgid "Without any parameter, this provides general help."
19913 #: ../fish/guestfish.pod:974
19914 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19918 #: ../fish/guestfish.pod:976
19919 msgid "quit | exit"
19923 #: ../fish/guestfish.pod:978
19924 msgid "This exits guestfish. You can also use C<^D> key."
19928 #: ../fish/guestfish.pod:980
19929 msgid "@FISH_COMMANDS@"
19933 #: ../fish/guestfish.pod:982
19938 #: ../fish/guestfish.pod:986 ../test-tool/libguestfs-test-tool.pod:83
19943 #: ../fish/guestfish.pod:988
19945 "guestfish returns 0 if the commands completed without error, or 1 if there "
19950 #: ../fish/guestfish.pod:995
19955 #: ../fish/guestfish.pod:997
19957 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19962 #: ../fish/guestfish.pod:1000
19963 msgid "GUESTFISH_PID"
19967 #: ../fish/guestfish.pod:1002
19969 "Used with the I<--remote> option to specify the remote guestfish process to "
19970 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19974 #: ../fish/guestfish.pod:1006
19979 #: ../fish/guestfish.pod:1008
19981 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19982 "not specified, the external L<hexedit(1)> program is used."
19986 #: ../fish/guestfish.pod:1012
19991 #: ../fish/guestfish.pod:1014
19993 "If compiled with GNU readline support, various files in the home directory "
19994 "can be used. See L</FILES>."
19998 #: ../fish/guestfish.pod:1023
20000 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
20001 "effect as using the B<-v> option."
20005 #: ../fish/guestfish.pod:1035
20007 "Set the path that guestfish uses to search for kernel and initrd.img. See "
20008 "the discussion of paths in L<guestfs(3)>."
20012 #: ../fish/guestfish.pod:1046
20013 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
20017 #: ../fish/guestfish.pod:1048
20022 #: ../fish/guestfish.pod:1050
20024 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
20029 #: ../fish/guestfish.pod:1066 ../test-tool/libguestfs-test-tool.pod:88
20034 #: ../fish/guestfish.pod:1070
20035 msgid "$HOME/.guestfish"
20039 #: ../fish/guestfish.pod:1072
20041 "If compiled with GNU readline support, then the command history is saved in "
20046 #: ../fish/guestfish.pod:1075
20047 msgid "$HOME/.inputrc"
20051 #: ../fish/guestfish.pod:1077
20052 msgid "/etc/inputrc"
20056 #: ../fish/guestfish.pod:1079
20058 "If compiled with GNU readline support, then these files can be used to "
20059 "configure readline. For further information, please see "
20060 "L<readline(3)/INITIALIZATION FILE>."
20064 #: ../fish/guestfish.pod:1083
20065 msgid "To write rules which only apply to guestfish, use:"
20069 #: ../fish/guestfish.pod:1085
20079 #: ../fish/guestfish.pod:1089
20081 "Variables that you can set in inputrc that change the behaviour of guestfish "
20082 "in useful ways include:"
20086 #: ../fish/guestfish.pod:1094
20087 msgid "completion-ignore-case (default: on)"
20091 #: ../fish/guestfish.pod:1096
20093 "By default, guestfish will ignore case when tab-completing paths on the "
20098 #: ../fish/guestfish.pod:1099
20101 " set completion-ignore-case off\n"
20106 #: ../fish/guestfish.pod:1101
20107 msgid "to make guestfish case sensitive."
20111 #: ../fish/guestfish.pod:1105
20116 #: ../fish/guestfish.pod:1107
20117 msgid "test2.img (etc)"
20121 #: ../fish/guestfish.pod:1109
20123 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
20124 "will be created in the file C<test1.img> in the current directory. The "
20125 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
20126 "the same name will be overwritten."
20130 #: ../fish/guestfish.pod:1118
20132 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
20133 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
20134 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
20135 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
20136 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
20137 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
20141 #: ../fish/guestfish.pod:1148 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:372 ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
20143 "This program is free software; you can redistribute it and/or modify it "
20144 "under the terms of the GNU General Public License as published by the Free "
20145 "Software Foundation; either version 2 of the License, or (at your option) "
20146 "any later version."
20150 #: ../fish/guestfish.pod:1153 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:377 ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1517 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
20152 "This program is distributed in the hope that it will be useful, but WITHOUT "
20153 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
20154 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
20159 #: ../fish/guestfish.pod:1158 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:382 ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1522 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
20161 "You should have received a copy of the GNU General Public License along with "
20162 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
20163 "Ave, Cambridge, MA 02139, USA."
20167 #: ../fish/guestfish-actions.pod:1
20172 #: ../fish/guestfish-actions.pod:3
20175 " add-cdrom filename\n"
20180 #: ../fish/guestfish-actions.pod:15
20182 "This call checks for the existence of C<filename>. This stops you from "
20183 "specifying other types of drive which are supported by qemu such as C<nbd:> "
20184 "and C<http:> URLs. To specify those, use the general L</config> call "
20189 #: ../fish/guestfish-actions.pod:22
20191 "If you just want to add an ISO file (often you use this as an efficient way "
20192 "to transfer large files into the guest), then you should probably use "
20193 "L</add-drive-ro> instead."
20197 #: ../fish/guestfish-actions.pod:35
20202 #: ../fish/guestfish-actions.pod:37
20207 #: ../fish/guestfish-actions.pod:39
20210 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
20215 #: ../fish/guestfish-actions.pod:41
20217 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
20218 "It works by connecting to libvirt, requesting the domain and domain XML from "
20219 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
20223 #: ../fish/guestfish-actions.pod:64
20225 "The other optional parameters are passed directly through to "
20226 "L</add-drive-opts>."
20230 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131 ../fish/guestfish-actions.pod:2934
20232 "This command has one or more optional arguments. See L</OPTIONAL "
20237 #: ../fish/guestfish-actions.pod:69
20242 #: ../fish/guestfish-actions.pod:71
20245 " add-drive filename\n"
20250 #: ../fish/guestfish-actions.pod:73
20252 "This function is the equivalent of calling L</add-drive-opts> with no "
20253 "optional parameters, so the disk is added writable, with the format being "
20254 "detected automatically."
20258 #: ../fish/guestfish-actions.pod:77
20260 "Automatic detection of the format opens you up to a potential security hole "
20261 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
20262 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
20263 "you should think about replacing calls to this function with calls to "
20264 "L</add-drive-opts>, and specifying the format."
20268 #: ../fish/guestfish-actions.pod:84
20269 msgid "add-drive-opts"
20273 #: ../fish/guestfish-actions.pod:86
20278 #: ../fish/guestfish-actions.pod:88
20281 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
20286 #: ../fish/guestfish-actions.pod:115
20288 "This forces the image format. If you omit this (or use L</add-drive> or "
20289 "L</add-drive-ro>) then the format is automatically detected. Possible "
20290 "formats include C<raw> and C<qcow2>."
20294 #: ../fish/guestfish-actions.pod:126
20296 "This rarely-used option lets you emulate the behaviour of the deprecated "
20297 "L</add-drive-with-if> call (q.v.)"
20301 #: ../fish/guestfish-actions.pod:133
20302 msgid "add-drive-ro"
20306 #: ../fish/guestfish-actions.pod:135
20311 #: ../fish/guestfish-actions.pod:137
20314 " add-drive-ro filename\n"
20319 #: ../fish/guestfish-actions.pod:139
20321 "This function is the equivalent of calling L</add-drive-opts> with the "
20322 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20323 "is added read-only, with the format being detected automatically."
20327 #: ../fish/guestfish-actions.pod:144
20328 msgid "add-drive-ro-with-if"
20332 #: ../fish/guestfish-actions.pod:146
20335 " add-drive-ro-with-if filename iface\n"
20340 #: ../fish/guestfish-actions.pod:148
20342 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
20343 "interface emulation to use at run time."
20347 #: ../fish/guestfish-actions.pod:158
20348 msgid "add-drive-with-if"
20352 #: ../fish/guestfish-actions.pod:160
20355 " add-drive-with-if filename iface\n"
20360 #: ../fish/guestfish-actions.pod:162
20362 "This is the same as L</add-drive> but it allows you to specify the QEMU "
20363 "interface emulation to use at run time."
20367 #: ../fish/guestfish-actions.pod:172
20372 #: ../fish/guestfish-actions.pod:174
20375 " aug-clear augpath\n"
20380 #: ../fish/guestfish-actions.pod:179
20385 #: ../fish/guestfish-actions.pod:181
20393 #: ../fish/guestfish-actions.pod:183
20395 "Close the current Augeas handle and free up any resources used by it. After "
20396 "calling this, you have to call L</aug-init> again before you can use any "
20397 "other Augeas functions."
20401 #: ../fish/guestfish-actions.pod:188
20402 msgid "aug-defnode"
20406 #: ../fish/guestfish-actions.pod:190
20409 " aug-defnode name expr val\n"
20414 #: ../fish/guestfish-actions.pod:195
20416 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
20417 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
20418 "containing that single node."
20422 #: ../fish/guestfish-actions.pod:203
20427 #: ../fish/guestfish-actions.pod:205
20430 " aug-defvar name expr\n"
20435 #: ../fish/guestfish-actions.pod:214
20440 #: ../fish/guestfish-actions.pod:216
20443 " aug-get augpath\n"
20448 #: ../fish/guestfish-actions.pod:221
20453 #: ../fish/guestfish-actions.pod:223
20456 " aug-init root flags\n"
20461 #: ../fish/guestfish-actions.pod:229
20462 msgid "You must call this before using any other L</aug-*> commands."
20466 #: ../fish/guestfish-actions.pod:264
20467 msgid "Do not load the tree in L</aug-init>."
20471 #: ../fish/guestfish-actions.pod:268
20472 msgid "To close the handle, you can call L</aug-close>."
20476 #: ../fish/guestfish-actions.pod:272
20481 #: ../fish/guestfish-actions.pod:274
20484 " aug-insert augpath label true|false\n"
20489 #: ../fish/guestfish-actions.pod:284
20494 #: ../fish/guestfish-actions.pod:286
20502 #: ../fish/guestfish-actions.pod:293
20507 #: ../fish/guestfish-actions.pod:295
20510 " aug-ls augpath\n"
20515 #: ../fish/guestfish-actions.pod:297
20517 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
20518 "resulting nodes into alphabetical order."
20522 #: ../fish/guestfish-actions.pod:300
20527 #: ../fish/guestfish-actions.pod:302
20530 " aug-match augpath\n"
20535 #: ../fish/guestfish-actions.pod:308
20540 #: ../fish/guestfish-actions.pod:310
20543 " aug-mv src dest\n"
20548 #: ../fish/guestfish-actions.pod:315
20553 #: ../fish/guestfish-actions.pod:317
20556 " aug-rm augpath\n"
20561 #: ../fish/guestfish-actions.pod:323
20566 #: ../fish/guestfish-actions.pod:325
20574 #: ../fish/guestfish-actions.pod:329
20576 "The flags which were passed to L</aug-init> affect exactly how files are "
20581 #: ../fish/guestfish-actions.pod:332
20586 #: ../fish/guestfish-actions.pod:334
20589 " aug-set augpath val\n"
20594 #: ../fish/guestfish-actions.pod:338
20596 "In the Augeas API, it is possible to clear a node by setting the value to "
20597 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
20598 "this call. Instead you must use the L</aug-clear> call."
20602 #: ../fish/guestfish-actions.pod:343
20607 #: ../fish/guestfish-actions.pod:345
20610 " available 'groups ...'\n"
20615 #: ../fish/guestfish-actions.pod:351
20617 "The libguestfs groups, and the functions that those groups correspond to, "
20618 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
20619 "runtime by calling L</available-all-groups>."
20623 #: ../fish/guestfish-actions.pod:375
20624 msgid "You must call L</launch> before calling this function."
20628 #: ../fish/guestfish-actions.pod:397
20630 "This call was added in version C<1.0.80>. In previous versions of "
20631 "libguestfs all you could do would be to speculatively execute a command to "
20632 "find out if the daemon implemented it. See also L</version>."
20636 #: ../fish/guestfish-actions.pod:404
20637 msgid "available-all-groups"
20641 #: ../fish/guestfish-actions.pod:406
20644 " available-all-groups\n"
20649 #: ../fish/guestfish-actions.pod:408
20651 "This command returns a list of all optional groups that this daemon knows "
20652 "about. Note this returns both supported and unsupported groups. To find "
20653 "out which ones the daemon can actually support you have to call "
20654 "L</available> on each member of the returned list."
20658 #: ../fish/guestfish-actions.pod:414
20659 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
20663 #: ../fish/guestfish-actions.pod:416
20668 #: ../fish/guestfish-actions.pod:418
20671 " base64-in (base64file|-) filename\n"
20676 #: ../fish/guestfish-actions.pod:423 ../fish/guestfish-actions.pod:432 ../fish/guestfish-actions.pod:656 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:844 ../fish/guestfish-actions.pod:1221 ../fish/guestfish-actions.pod:4302 ../fish/guestfish-actions.pod:4314 ../fish/guestfish-actions.pod:4325 ../fish/guestfish-actions.pod:4336 ../fish/guestfish-actions.pod:4388 ../fish/guestfish-actions.pod:4397 ../fish/guestfish-actions.pod:4451 ../fish/guestfish-actions.pod:4474
20677 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
20681 #: ../fish/guestfish-actions.pod:425
20686 #: ../fish/guestfish-actions.pod:427
20689 " base64-out filename (base64file|-)\n"
20694 #: ../fish/guestfish-actions.pod:434
20695 msgid "blockdev-flushbufs"
20699 #: ../fish/guestfish-actions.pod:436
20702 " blockdev-flushbufs device\n"
20707 #: ../fish/guestfish-actions.pod:443
20708 msgid "blockdev-getbsz"
20712 #: ../fish/guestfish-actions.pod:445
20715 " blockdev-getbsz device\n"
20720 #: ../fish/guestfish-actions.pod:454
20721 msgid "blockdev-getro"
20725 #: ../fish/guestfish-actions.pod:456
20728 " blockdev-getro device\n"
20733 #: ../fish/guestfish-actions.pod:463
20734 msgid "blockdev-getsize64"
20738 #: ../fish/guestfish-actions.pod:465
20741 " blockdev-getsize64 device\n"
20746 #: ../fish/guestfish-actions.pod:469
20747 msgid "See also L</blockdev-getsz>."
20751 #: ../fish/guestfish-actions.pod:473
20752 msgid "blockdev-getss"
20756 #: ../fish/guestfish-actions.pod:475
20759 " blockdev-getss device\n"
20764 #: ../fish/guestfish-actions.pod:480
20765 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
20769 #: ../fish/guestfish-actions.pod:485
20770 msgid "blockdev-getsz"
20774 #: ../fish/guestfish-actions.pod:487
20777 " blockdev-getsz device\n"
20782 #: ../fish/guestfish-actions.pod:492
20784 "See also L</blockdev-getss> for the real sector size of the device, and "
20785 "L</blockdev-getsize64> for the more useful I<size in bytes>."
20789 #: ../fish/guestfish-actions.pod:498
20790 msgid "blockdev-rereadpt"
20794 #: ../fish/guestfish-actions.pod:500
20797 " blockdev-rereadpt device\n"
20802 #: ../fish/guestfish-actions.pod:506
20803 msgid "blockdev-setbsz"
20807 #: ../fish/guestfish-actions.pod:508
20810 " blockdev-setbsz device blocksize\n"
20815 #: ../fish/guestfish-actions.pod:517
20816 msgid "blockdev-setro"
20820 #: ../fish/guestfish-actions.pod:519
20823 " blockdev-setro device\n"
20828 #: ../fish/guestfish-actions.pod:525
20829 msgid "blockdev-setrw"
20833 #: ../fish/guestfish-actions.pod:527
20836 " blockdev-setrw device\n"
20841 #: ../fish/guestfish-actions.pod:533
20842 msgid "case-sensitive-path"
20846 #: ../fish/guestfish-actions.pod:535
20849 " case-sensitive-path path\n"
20854 #: ../fish/guestfish-actions.pod:559
20856 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
20857 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
20858 "how the directories were originally created under Windows)."
20862 #: ../fish/guestfish-actions.pod:567
20863 msgid "See also L</realpath>."
20867 #: ../fish/guestfish-actions.pod:569
20872 #: ../fish/guestfish-actions.pod:571
20880 #: ../fish/guestfish-actions.pod:575
20882 "Note that this function cannot correctly handle binary files (specifically, "
20883 "files containing C<\\0> character which is treated as end of string). For "
20884 "those you need to use the L</read-file> or L</download> functions which have "
20885 "a more complex interface."
20889 #: ../fish/guestfish-actions.pod:583
20894 #: ../fish/guestfish-actions.pod:585
20897 " checksum csumtype path\n"
20902 #: ../fish/guestfish-actions.pod:628
20903 msgid "To get the checksum for a device, use L</checksum-device>."
20907 #: ../fish/guestfish-actions.pod:630
20908 msgid "To get the checksums for many files, use L</checksums-out>."
20912 #: ../fish/guestfish-actions.pod:632
20913 msgid "checksum-device"
20917 #: ../fish/guestfish-actions.pod:634
20920 " checksum-device csumtype device\n"
20925 #: ../fish/guestfish-actions.pod:636
20927 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20928 "device named C<device>. For the types of checksums supported see the "
20929 "L</checksum> command."
20933 #: ../fish/guestfish-actions.pod:640
20934 msgid "checksums-out"
20938 #: ../fish/guestfish-actions.pod:642
20941 " checksums-out csumtype directory (sumsfile|-)\n"
20946 #: ../fish/guestfish-actions.pod:658
20951 #: ../fish/guestfish-actions.pod:660
20954 " chmod mode path\n"
20959 #: ../fish/guestfish-actions.pod:671
20964 #: ../fish/guestfish-actions.pod:673
20967 " chown owner group path\n"
20972 #: ../fish/guestfish-actions.pod:681
20977 #: ../fish/guestfish-actions.pod:683
20980 " command 'arguments ...'\n"
20985 #: ../fish/guestfish-actions.pod:690
20987 "The single parameter is an argv-style list of arguments. The first element "
20988 "is the name of the program to run. Subsequent elements are parameters. The "
20989 "list must be non-empty (ie. must contain a program name). Note that the "
20990 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20994 #: ../fish/guestfish-actions.pod:718
20995 msgid "command-lines"
20999 #: ../fish/guestfish-actions.pod:720
21002 " command-lines 'arguments ...'\n"
21007 #: ../fish/guestfish-actions.pod:722
21008 msgid "This is the same as L</command>, but splits the result into a list of lines."
21012 #: ../fish/guestfish-actions.pod:725
21013 msgid "See also: L</sh-lines>"
21017 #: ../fish/guestfish-actions.pod:730
21022 #: ../fish/guestfish-actions.pod:732
21025 " config qemuparam qemuvalue\n"
21030 #: ../fish/guestfish-actions.pod:743
21035 #: ../fish/guestfish-actions.pod:745
21038 " copy-size src dest size\n"
21043 #: ../fish/guestfish-actions.pod:753
21048 #: ../fish/guestfish-actions.pod:755
21056 #: ../fish/guestfish-actions.pod:760
21061 #: ../fish/guestfish-actions.pod:762
21069 #: ../fish/guestfish-actions.pod:767
21074 #: ../fish/guestfish-actions.pod:769
21082 #: ../fish/guestfish-actions.pod:776
21084 "If the destination is a device, it must be as large or larger than the "
21085 "source file or device, otherwise the copy will fail. This command cannot do "
21086 "partial copies (see L</copy-size>)."
21090 #: ../fish/guestfish-actions.pod:780
21095 #: ../fish/guestfish-actions.pod:782
21103 #: ../fish/guestfish-actions.pod:786 ../fish/guestfish-actions.pod:797
21105 "This command is mostly useful for interactive sessions. It is I<not> "
21106 "intended that you try to parse the output string. Use L</statvfs> from "
21111 #: ../fish/guestfish-actions.pod:790
21116 #: ../fish/guestfish-actions.pod:792
21124 #: ../fish/guestfish-actions.pod:801
21129 #: ../fish/guestfish-actions.pod:803
21137 #: ../fish/guestfish-actions.pod:809
21139 "Another way to get the same information is to enable verbose messages with "
21140 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
21141 "before running the program."
21145 #: ../fish/guestfish-actions.pod:814
21150 #: ../fish/guestfish-actions.pod:816
21153 " download remotefilename (filename|-)\n"
21158 #: ../fish/guestfish-actions.pod:823
21159 msgid "See also L</upload>, L</cat>."
21163 #: ../fish/guestfish-actions.pod:827
21164 msgid "download-offset"
21168 #: ../fish/guestfish-actions.pod:829
21171 " download-offset remotefilename (filename|-) offset size\n"
21176 #: ../fish/guestfish-actions.pod:837
21178 "Note that there is no limit on the amount of data that can be downloaded "
21179 "with this call, unlike with L</pread>, and this call always reads the full "
21180 "amount unless an error occurs."
21184 #: ../fish/guestfish-actions.pod:842
21185 msgid "See also L</download>, L</pread>."
21189 #: ../fish/guestfish-actions.pod:846
21190 msgid "drop-caches"
21194 #: ../fish/guestfish-actions.pod:848
21197 " drop-caches whattodrop\n"
21202 #: ../fish/guestfish-actions.pod:860
21207 #: ../fish/guestfish-actions.pod:862
21215 #: ../fish/guestfish-actions.pod:874
21220 #: ../fish/guestfish-actions.pod:876
21223 " e2fsck-f device\n"
21228 #: ../fish/guestfish-actions.pod:882
21230 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
21231 "should use L</fsck>."
21235 #: ../fish/guestfish-actions.pod:885
21236 msgid "echo-daemon"
21240 #: ../fish/guestfish-actions.pod:887
21243 " echo-daemon 'words ...'\n"
21248 #: ../fish/guestfish-actions.pod:894
21249 msgid "See also L</ping-daemon>."
21253 #: ../fish/guestfish-actions.pod:896
21258 #: ../fish/guestfish-actions.pod:898
21261 " egrep regex path\n"
21266 #: ../fish/guestfish-actions.pod:906
21271 #: ../fish/guestfish-actions.pod:908
21274 " egrepi regex path\n"
21279 #: ../fish/guestfish-actions.pod:916
21284 #: ../fish/guestfish-actions.pod:918
21287 " equal file1 file2\n"
21292 #: ../fish/guestfish-actions.pod:925
21297 #: ../fish/guestfish-actions.pod:927
21305 #: ../fish/guestfish-actions.pod:932
21306 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21310 #: ../fish/guestfish-actions.pod:934
21315 #: ../fish/guestfish-actions.pod:936
21318 " fallocate path len\n"
21323 #: ../fish/guestfish-actions.pod:953
21324 msgid "fallocate64"
21328 #: ../fish/guestfish-actions.pod:955
21331 " fallocate64 path len\n"
21336 #: ../fish/guestfish-actions.pod:961
21338 "Note that this call allocates disk blocks for the file. To create a sparse "
21339 "file use L</truncate-size> instead."
21343 #: ../fish/guestfish-actions.pod:964
21345 "The deprecated call L</fallocate> does the same, but owing to an oversight "
21346 "it only allowed 30 bit lengths to be specified, effectively limiting the "
21347 "maximum size of files created through that call to 1GB."
21351 #: ../fish/guestfish-actions.pod:973
21356 #: ../fish/guestfish-actions.pod:975
21359 " fgrep pattern path\n"
21364 #: ../fish/guestfish-actions.pod:983
21369 #: ../fish/guestfish-actions.pod:985
21372 " fgrepi pattern path\n"
21377 #: ../fish/guestfish-actions.pod:993
21382 #: ../fish/guestfish-actions.pod:995
21390 #: ../fish/guestfish-actions.pod:1007
21392 "This command can also be used on C</dev/> devices (and partitions, LV "
21393 "names). You can for example use this to determine if a device contains a "
21394 "filesystem, although it's usually better to use L</vfs-type>."
21398 #: ../fish/guestfish-actions.pod:1017
21399 msgid "file-architecture"
21403 #: ../fish/guestfish-actions.pod:1019
21406 " file-architecture filename\n"
21411 #: ../fish/guestfish-actions.pod:1122
21416 #: ../fish/guestfish-actions.pod:1124
21424 #: ../fish/guestfish-actions.pod:1128
21426 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
21427 "L</is-file> etc. To get the size of block devices, use "
21428 "L</blockdev-getsize64>."
21432 #: ../fish/guestfish-actions.pod:1132
21437 #: ../fish/guestfish-actions.pod:1134
21440 " fill c len path\n"
21445 #: ../fish/guestfish-actions.pod:1140
21447 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
21448 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
21449 "L</fill-pattern>."
21453 #: ../fish/guestfish-actions.pod:1145
21454 msgid "fill-pattern"
21458 #: ../fish/guestfish-actions.pod:1147
21461 " fill-pattern pattern len path\n"
21466 #: ../fish/guestfish-actions.pod:1149
21468 "This function is like L</fill> except that it creates a new file of length "
21469 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
21470 "is truncated if necessary to ensure the length of the file is exactly C<len> "
21475 #: ../fish/guestfish-actions.pod:1154
21480 #: ../fish/guestfish-actions.pod:1156
21483 " find directory\n"
21488 #: ../fish/guestfish-actions.pod:1170
21489 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
21493 #: ../fish/guestfish-actions.pod:1183
21494 msgid "See also L</find0>."
21498 #: ../fish/guestfish-actions.pod:1188
21503 #: ../fish/guestfish-actions.pod:1190
21506 " find0 directory (files|-)\n"
21511 #: ../fish/guestfish-actions.pod:1196
21512 msgid "This command works the same way as L</find> with the following exceptions:"
21516 #: ../fish/guestfish-actions.pod:1223
21517 msgid "findfs-label"
21521 #: ../fish/guestfish-actions.pod:1225
21524 " findfs-label label\n"
21529 #: ../fish/guestfish-actions.pod:1231
21530 msgid "To find the label of a filesystem, use L</vfs-label>."
21534 #: ../fish/guestfish-actions.pod:1233
21535 msgid "findfs-uuid"
21539 #: ../fish/guestfish-actions.pod:1235
21542 " findfs-uuid uuid\n"
21547 #: ../fish/guestfish-actions.pod:1241
21548 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
21552 #: ../fish/guestfish-actions.pod:1243
21557 #: ../fish/guestfish-actions.pod:1245
21560 " fsck fstype device\n"
21565 #: ../fish/guestfish-actions.pod:1275
21570 #: ../fish/guestfish-actions.pod:1277
21578 #: ../fish/guestfish-actions.pod:1284
21579 msgid "get-autosync"
21583 #: ../fish/guestfish-actions.pod:1286
21591 #: ../fish/guestfish-actions.pod:1290
21596 #: ../fish/guestfish-actions.pod:1292
21604 #: ../fish/guestfish-actions.pod:1296
21605 msgid "get-e2label"
21609 #: ../fish/guestfish-actions.pod:1298
21612 " get-e2label device\n"
21617 #: ../fish/guestfish-actions.pod:1310
21622 #: ../fish/guestfish-actions.pod:1312
21625 " get-e2uuid device\n"
21630 #: ../fish/guestfish-actions.pod:1324
21631 msgid "get-memsize"
21635 #: ../fish/guestfish-actions.pod:1326
21643 #: ../fish/guestfish-actions.pod:1331
21645 "If L</set-memsize> was not called on this handle, and if "
21646 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
21647 "value for memsize."
21651 #: ../fish/guestfish-actions.pod:1338
21652 msgid "get-network"
21656 #: ../fish/guestfish-actions.pod:1340
21664 #: ../fish/guestfish-actions.pod:1344
21669 #: ../fish/guestfish-actions.pod:1346
21677 #: ../fish/guestfish-actions.pod:1353
21682 #: ../fish/guestfish-actions.pod:1355
21687 #: ../fish/guestfish-actions.pod:1357
21695 #: ../fish/guestfish-actions.pod:1364
21700 #: ../fish/guestfish-actions.pod:1366
21708 #: ../fish/guestfish-actions.pod:1373
21709 msgid "get-recovery-proc"
21713 #: ../fish/guestfish-actions.pod:1375
21716 " get-recovery-proc\n"
21721 #: ../fish/guestfish-actions.pod:1379
21722 msgid "get-selinux"
21726 #: ../fish/guestfish-actions.pod:1381
21734 #: ../fish/guestfish-actions.pod:1383
21736 "This returns the current setting of the selinux flag which is passed to the "
21737 "appliance at boot time. See L</set-selinux>."
21741 #: ../fish/guestfish-actions.pod:1389
21746 #: ../fish/guestfish-actions.pod:1391
21754 #: ../fish/guestfish-actions.pod:1398
21759 #: ../fish/guestfish-actions.pod:1400
21767 #: ../fish/guestfish-actions.pod:1404
21772 #: ../fish/guestfish-actions.pod:1406
21780 #: ../fish/guestfish-actions.pod:1408
21782 "Return the current umask. By default the umask is C<022> unless it has been "
21783 "set by calling L</umask>."
21787 #: ../fish/guestfish-actions.pod:1411
21788 msgid "get-verbose"
21792 #: ../fish/guestfish-actions.pod:1413
21800 #: ../fish/guestfish-actions.pod:1417
21805 #: ../fish/guestfish-actions.pod:1419
21813 #: ../fish/guestfish-actions.pod:1423
21814 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
21818 #: ../fish/guestfish-actions.pod:1426
21823 #: ../fish/guestfish-actions.pod:1428
21826 " getxattr path name\n"
21831 #: ../fish/guestfish-actions.pod:1430
21833 "Get a single extended attribute from file C<path> named C<name>. This call "
21834 "follows symlinks. If you want to lookup an extended attribute for the "
21835 "symlink itself, use L</lgetxattr>."
21839 #: ../fish/guestfish-actions.pod:1434 ../fish/guestfish-actions.pod:2340
21841 "Normally it is better to get all extended attributes from a file in one go "
21842 "by calling L</getxattrs>. However some Linux filesystem implementations are "
21843 "buggy and do not provide a way to list out attributes. For these "
21844 "filesystems (notably ntfs-3g) you have to know the names of the extended "
21845 "attributes you want in advance and call this function."
21849 #: ../fish/guestfish-actions.pod:1444
21850 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
21854 #: ../fish/guestfish-actions.pod:1446
21859 #: ../fish/guestfish-actions.pod:1448
21862 " getxattrs path\n"
21867 #: ../fish/guestfish-actions.pod:1456
21868 msgid "See also: L</lgetxattrs>, L<attr(5)>."
21872 #: ../fish/guestfish-actions.pod:1458
21873 msgid "glob-expand"
21877 #: ../fish/guestfish-actions.pod:1460
21880 " glob-expand pattern\n"
21885 #: ../fish/guestfish-actions.pod:1473
21890 #: ../fish/guestfish-actions.pod:1475
21893 " grep regex path\n"
21898 #: ../fish/guestfish-actions.pod:1483
21903 #: ../fish/guestfish-actions.pod:1485
21906 " grepi regex path\n"
21911 #: ../fish/guestfish-actions.pod:1493
21912 msgid "grub-install"
21916 #: ../fish/guestfish-actions.pod:1495
21919 " grub-install root device\n"
21924 #: ../fish/guestfish-actions.pod:1511
21929 #: ../fish/guestfish-actions.pod:1513
21937 #: ../fish/guestfish-actions.pod:1521
21942 #: ../fish/guestfish-actions.pod:1523
21945 " head-n nrlines path\n"
21950 #: ../fish/guestfish-actions.pod:1536
21955 #: ../fish/guestfish-actions.pod:1538
21963 #: ../fish/guestfish-actions.pod:1546
21968 #: ../fish/guestfish-actions.pod:1548
21971 " initrd-cat initrdpath filename\n"
21976 #: ../fish/guestfish-actions.pod:1560
21977 msgid "See also L</initrd-list>."
21981 #: ../fish/guestfish-actions.pod:1565
21982 msgid "initrd-list"
21986 #: ../fish/guestfish-actions.pod:1567
21989 " initrd-list path\n"
21994 #: ../fish/guestfish-actions.pod:1579
21995 msgid "inotify-add-watch"
21999 #: ../fish/guestfish-actions.pod:1581
22002 " inotify-add-watch path mask\n"
22007 #: ../fish/guestfish-actions.pod:1593
22008 msgid "inotify-close"
22012 #: ../fish/guestfish-actions.pod:1595
22020 #: ../fish/guestfish-actions.pod:1601
22021 msgid "inotify-files"
22025 #: ../fish/guestfish-actions.pod:1603
22033 #: ../fish/guestfish-actions.pod:1605
22035 "This function is a helpful wrapper around L</inotify-read> which just "
22036 "returns a list of pathnames of objects that were touched. The returned "
22037 "pathnames are sorted and deduplicated."
22041 #: ../fish/guestfish-actions.pod:1609
22042 msgid "inotify-init"
22046 #: ../fish/guestfish-actions.pod:1611
22049 " inotify-init maxevents\n"
22054 #: ../fish/guestfish-actions.pod:1617
22056 "C<maxevents> is the maximum number of events which will be queued up between "
22057 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
22058 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
22059 "default was 16384 events. Beyond this limit, the kernel throws away events, "
22060 "but records the fact that it threw them away by setting a flag "
22061 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
22065 #: ../fish/guestfish-actions.pod:1627
22067 "Before any events are generated, you have to add some watches to the "
22068 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
22069 "L</inotify-watch-all>."
22073 #: ../fish/guestfish-actions.pod:1633
22075 "Queued up events should be read periodically by calling L</inotify-read> (or "
22076 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
22077 "If you don't read the events out often enough then you risk the internal "
22078 "queue overflowing."
22082 #: ../fish/guestfish-actions.pod:1640
22084 "The handle should be closed after use by calling L</inotify-close>. This "
22085 "also removes any watches automatically."
22089 #: ../fish/guestfish-actions.pod:1649
22090 msgid "inotify-read"
22094 #: ../fish/guestfish-actions.pod:1651
22102 #: ../fish/guestfish-actions.pod:1664
22103 msgid "inotify-rm-watch"
22107 #: ../fish/guestfish-actions.pod:1666
22110 " inotify-rm-watch wd\n"
22115 #: ../fish/guestfish-actions.pod:1668
22116 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
22120 #: ../fish/guestfish-actions.pod:1671
22121 msgid "inspect-get-arch"
22125 #: ../fish/guestfish-actions.pod:1673
22128 " inspect-get-arch root\n"
22133 #: ../fish/guestfish-actions.pod:1675 ../fish/guestfish-actions.pod:1691 ../fish/guestfish-actions.pod:1765 ../fish/guestfish-actions.pod:1783 ../fish/guestfish-actions.pod:1817 ../fish/guestfish-actions.pod:1832 ../fish/guestfish-actions.pod:1853 ../fish/guestfish-actions.pod:1868 ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1917 ../fish/guestfish-actions.pod:1941 ../fish/guestfish-actions.pod:1971 ../fish/guestfish-actions.pod:2006 ../fish/guestfish-actions.pod:2022 ../fish/guestfish-actions.pod:2035 ../fish/guestfish-actions.pod:2048 ../fish/guestfish-actions.pod:2063
22135 "This function should only be called with a root device string as returned by "
22140 #: ../fish/guestfish-actions.pod:1678
22142 "This returns the architecture of the inspected operating system. The "
22143 "possible return values are listed under L</file-architecture>."
22147 #: ../fish/guestfish-actions.pod:1687
22148 msgid "inspect-get-distro"
22152 #: ../fish/guestfish-actions.pod:1689
22155 " inspect-get-distro root\n"
22160 #: ../fish/guestfish-actions.pod:1761
22161 msgid "inspect-get-filesystems"
22165 #: ../fish/guestfish-actions.pod:1763
22168 " inspect-get-filesystems root\n"
22173 #: ../fish/guestfish-actions.pod:1776
22175 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22176 "L</inspect-get-mountpoints>."
22180 #: ../fish/guestfish-actions.pod:1779
22181 msgid "inspect-get-format"
22185 #: ../fish/guestfish-actions.pod:1781
22188 " inspect-get-format root\n"
22193 #: ../fish/guestfish-actions.pod:1813
22194 msgid "inspect-get-hostname"
22198 #: ../fish/guestfish-actions.pod:1815
22201 " inspect-get-hostname root\n"
22206 #: ../fish/guestfish-actions.pod:1828
22207 msgid "inspect-get-major-version"
22211 #: ../fish/guestfish-actions.pod:1830
22214 " inspect-get-major-version root\n"
22219 #: ../fish/guestfish-actions.pod:1849
22220 msgid "inspect-get-minor-version"
22224 #: ../fish/guestfish-actions.pod:1851
22227 " inspect-get-minor-version root\n"
22232 #: ../fish/guestfish-actions.pod:1861
22234 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22235 "L</inspect-get-major-version>."
22239 #: ../fish/guestfish-actions.pod:1864
22240 msgid "inspect-get-mountpoints"
22244 #: ../fish/guestfish-actions.pod:1866
22247 " inspect-get-mountpoints root\n"
22252 #: ../fish/guestfish-actions.pod:1888
22254 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22255 "L</inspect-get-filesystems>."
22259 #: ../fish/guestfish-actions.pod:1891
22260 msgid "inspect-get-package-format"
22264 #: ../fish/guestfish-actions.pod:1893
22267 " inspect-get-package-format root\n"
22272 #: ../fish/guestfish-actions.pod:1898
22274 "This function and L</inspect-get-package-management> return the package "
22275 "format and package management tool used by the inspected operating system. "
22276 "For example for Fedora these functions would return C<rpm> (package format) "
22277 "and C<yum> (package management)."
22281 #: ../fish/guestfish-actions.pod:1913
22282 msgid "inspect-get-package-management"
22286 #: ../fish/guestfish-actions.pod:1915
22289 " inspect-get-package-management root\n"
22294 #: ../fish/guestfish-actions.pod:1920
22296 "L</inspect-get-package-format> and this function return the package format "
22297 "and package management tool used by the inspected operating system. For "
22298 "example for Fedora these functions would return C<rpm> (package format) and "
22299 "C<yum> (package management)."
22303 #: ../fish/guestfish-actions.pod:1937
22304 msgid "inspect-get-product-name"
22308 #: ../fish/guestfish-actions.pod:1939
22311 " inspect-get-product-name root\n"
22316 #: ../fish/guestfish-actions.pod:1954
22317 msgid "inspect-get-roots"
22321 #: ../fish/guestfish-actions.pod:1956
22324 " inspect-get-roots\n"
22329 #: ../fish/guestfish-actions.pod:1958
22331 "This function is a convenient way to get the list of root devices, as "
22332 "returned from a previous call to L</inspect-os>, but without redoing the "
22333 "whole inspection process."
22337 #: ../fish/guestfish-actions.pod:1962
22339 "This returns an empty list if either no root devices were found or the "
22340 "caller has not called L</inspect-os>."
22344 #: ../fish/guestfish-actions.pod:1967
22345 msgid "inspect-get-type"
22349 #: ../fish/guestfish-actions.pod:1969
22352 " inspect-get-type root\n"
22357 #: ../fish/guestfish-actions.pod:2002
22358 msgid "inspect-get-windows-systemroot"
22362 #: ../fish/guestfish-actions.pod:2004
22365 " inspect-get-windows-systemroot root\n"
22370 #: ../fish/guestfish-actions.pod:2018
22371 msgid "inspect-is-live"
22375 #: ../fish/guestfish-actions.pod:2020
22378 " inspect-is-live root\n"
22383 #: ../fish/guestfish-actions.pod:2025
22385 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
22386 "then this returns true if a live image was detected on the disk."
22390 #: ../fish/guestfish-actions.pod:2031
22391 msgid "inspect-is-multipart"
22395 #: ../fish/guestfish-actions.pod:2033
22398 " inspect-is-multipart root\n"
22403 #: ../fish/guestfish-actions.pod:2038
22405 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
22406 "then this returns true if the disk is part of a set."
22410 #: ../fish/guestfish-actions.pod:2044
22411 msgid "inspect-is-netinst"
22415 #: ../fish/guestfish-actions.pod:2046
22418 " inspect-is-netinst root\n"
22423 #: ../fish/guestfish-actions.pod:2051
22425 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
22426 "then this returns true if the disk is a network installer, ie. not a "
22427 "self-contained install CD but one which is likely to require network access "
22428 "to complete the install."
22432 #: ../fish/guestfish-actions.pod:2059
22433 msgid "inspect-list-applications"
22437 #: ../fish/guestfish-actions.pod:2061
22440 " inspect-list-applications root\n"
22445 #: ../fish/guestfish-actions.pod:2068
22447 "I<Note:> This call works differently from other parts of the inspection "
22448 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
22449 "then mount up the disks, before calling this. Listing applications is a "
22450 "significantly more difficult operation which requires access to the full "
22451 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
22452 "are just returning data cached in the libguestfs handle, this call actually "
22453 "reads parts of the mounted filesystems during the call."
22457 #: ../fish/guestfish-actions.pod:2158
22462 #: ../fish/guestfish-actions.pod:2160
22470 #: ../fish/guestfish-actions.pod:2175
22472 "You can pass the root string(s) returned to other L</inspect-get-*> "
22473 "functions in order to query further information about each operating system, "
22474 "such as the name and version."
22478 #: ../fish/guestfish-actions.pod:2180
22480 "This function uses other libguestfs features such as L</mount-ro> and "
22481 "L</umount-all> in order to mount and unmount filesystems and look at the "
22482 "contents. This should be called with no disks currently mounted. The "
22483 "function may also use Augeas, so any existing Augeas handle will be closed."
22487 #: ../fish/guestfish-actions.pod:2192 ../fish/guestfish-actions.pod:2368 ../fish/guestfish-actions.pod:2414
22488 msgid "See also L</list-filesystems>."
22492 #: ../fish/guestfish-actions.pod:2194
22493 msgid "is-blockdev"
22497 #: ../fish/guestfish-actions.pod:2196
22500 " is-blockdev path\n"
22505 #: ../fish/guestfish-actions.pod:2201 ../fish/guestfish-actions.pod:2219 ../fish/guestfish-actions.pod:2238 ../fish/guestfish-actions.pod:2247 ../fish/guestfish-actions.pod:2257 ../fish/guestfish-actions.pod:2291 ../fish/guestfish-actions.pod:2300
22506 msgid "See also L</stat>."
22510 #: ../fish/guestfish-actions.pod:2203
22515 #: ../fish/guestfish-actions.pod:2205
22523 #: ../fish/guestfish-actions.pod:2212
22528 #: ../fish/guestfish-actions.pod:2214
22531 " is-chardev path\n"
22536 #: ../fish/guestfish-actions.pod:2221
22541 #: ../fish/guestfish-actions.pod:2223
22549 #: ../fish/guestfish-actions.pod:2230
22554 #: ../fish/guestfish-actions.pod:2232
22562 #: ../fish/guestfish-actions.pod:2240
22567 #: ../fish/guestfish-actions.pod:2242
22575 #: ../fish/guestfish-actions.pod:2249
22580 #: ../fish/guestfish-actions.pod:2251
22588 #: ../fish/guestfish-actions.pod:2259
22589 msgid "is-launching"
22593 #: ../fish/guestfish-actions.pod:2261
22601 #: ../fish/guestfish-actions.pod:2268
22606 #: ../fish/guestfish-actions.pod:2270
22614 #: ../fish/guestfish-actions.pod:2275
22619 #: ../fish/guestfish-actions.pod:2277
22627 #: ../fish/guestfish-actions.pod:2284
22632 #: ../fish/guestfish-actions.pod:2286
22635 " is-socket path\n"
22640 #: ../fish/guestfish-actions.pod:2293
22645 #: ../fish/guestfish-actions.pod:2295
22648 " is-symlink path\n"
22653 #: ../fish/guestfish-actions.pod:2302
22654 msgid "kill-subprocess"
22658 #: ../fish/guestfish-actions.pod:2304
22661 " kill-subprocess\n"
22666 #: ../fish/guestfish-actions.pod:2308
22671 #: ../fish/guestfish-actions.pod:2310
22676 #: ../fish/guestfish-actions.pod:2312
22684 #: ../fish/guestfish-actions.pod:2320
22689 #: ../fish/guestfish-actions.pod:2322
22692 " lchown owner group path\n"
22697 #: ../fish/guestfish-actions.pod:2324
22699 "Change the file owner to C<owner> and group to C<group>. This is like "
22700 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
22705 #: ../fish/guestfish-actions.pod:2332
22710 #: ../fish/guestfish-actions.pod:2334
22713 " lgetxattr path name\n"
22718 #: ../fish/guestfish-actions.pod:2350
22719 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
22723 #: ../fish/guestfish-actions.pod:2352
22728 #: ../fish/guestfish-actions.pod:2354
22731 " lgetxattrs path\n"
22736 #: ../fish/guestfish-actions.pod:2356
22738 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
22739 "it returns the extended attributes of the link itself."
22743 #: ../fish/guestfish-actions.pod:2360
22744 msgid "list-devices"
22748 #: ../fish/guestfish-actions.pod:2362
22756 #: ../fish/guestfish-actions.pod:2370
22757 msgid "list-filesystems"
22761 #: ../fish/guestfish-actions.pod:2372
22764 " list-filesystems\n"
22769 #: ../fish/guestfish-actions.pod:2391
22771 "This command runs other libguestfs commands, which might include L</mount> "
22772 "and L</umount>, and therefore you should use this soon after launch and only "
22773 "when nothing is mounted."
22777 #: ../fish/guestfish-actions.pod:2395
22779 "Not all of the filesystems returned will be mountable. In particular, swap "
22780 "partitions are returned in the list. Also this command does not check that "
22781 "each filesystem found is valid and mountable, and some filesystems might be "
22782 "mountable but require special options. Filesystems may not all belong to a "
22783 "single logical operating system (use L</inspect-os> to look for OSes)."
22787 #: ../fish/guestfish-actions.pod:2403
22788 msgid "list-partitions"
22792 #: ../fish/guestfish-actions.pod:2405
22795 " list-partitions\n"
22800 #: ../fish/guestfish-actions.pod:2411
22802 "This does not return logical volumes. For that you will need to call "
22807 #: ../fish/guestfish-actions.pod:2416
22812 #: ../fish/guestfish-actions.pod:2418
22820 #: ../fish/guestfish-actions.pod:2426
22825 #: ../fish/guestfish-actions.pod:2428
22828 " ln target linkname\n"
22833 #: ../fish/guestfish-actions.pod:2432
22838 #: ../fish/guestfish-actions.pod:2434
22841 " ln-f target linkname\n"
22846 #: ../fish/guestfish-actions.pod:2439
22851 #: ../fish/guestfish-actions.pod:2441
22854 " ln-s target linkname\n"
22859 #: ../fish/guestfish-actions.pod:2445
22864 #: ../fish/guestfish-actions.pod:2447
22867 " ln-sf target linkname\n"
22872 #: ../fish/guestfish-actions.pod:2452
22873 msgid "lremovexattr"
22877 #: ../fish/guestfish-actions.pod:2454
22880 " lremovexattr xattr path\n"
22885 #: ../fish/guestfish-actions.pod:2456
22887 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
22888 "it removes an extended attribute of the link itself."
22892 #: ../fish/guestfish-actions.pod:2460
22897 #: ../fish/guestfish-actions.pod:2462
22905 #: ../fish/guestfish-actions.pod:2468
22907 "This command is mostly useful for interactive sessions. Programs should "
22908 "probably use L</readdir> instead."
22912 #: ../fish/guestfish-actions.pod:2471
22917 #: ../fish/guestfish-actions.pod:2473
22920 " lsetxattr xattr val vallen path\n"
22925 #: ../fish/guestfish-actions.pod:2475
22927 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
22928 "sets an extended attribute of the link itself."
22932 #: ../fish/guestfish-actions.pod:2479
22937 #: ../fish/guestfish-actions.pod:2481
22945 #: ../fish/guestfish-actions.pod:2485
22947 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
22948 "the link is stat-ed, not the file it refers to."
22952 #: ../fish/guestfish-actions.pod:2491
22957 #: ../fish/guestfish-actions.pod:2493
22960 " lstatlist path 'names ...'\n"
22965 #: ../fish/guestfish-actions.pod:2495
22967 "This call allows you to perform the L</lstat> operation on multiple files, "
22968 "where all files are in the directory C<path>. C<names> is the list of files "
22969 "from this directory."
22973 #: ../fish/guestfish-actions.pod:2504
22975 "This call is intended for programs that want to efficiently list a directory "
22976 "contents without making many round-trips. See also L</lxattrlist> for a "
22977 "similarly efficient call for getting extended attributes. Very long "
22978 "directory listings might cause the protocol message size to be exceeded, "
22979 "causing this call to fail. The caller must split up such requests into "
22980 "smaller groups of names."
22984 #: ../fish/guestfish-actions.pod:2512
22985 msgid "luks-add-key"
22989 #: ../fish/guestfish-actions.pod:2514
22992 " luks-add-key device keyslot\n"
22997 #: ../fish/guestfish-actions.pod:2521
22999 "Note that if C<keyslot> already contains a key, then this command will "
23000 "fail. You have to use L</luks-kill-slot> first to remove that key."
23004 #: ../fish/guestfish-actions.pod:2525 ../fish/guestfish-actions.pod:2547 ../fish/guestfish-actions.pod:2560 ../fish/guestfish-actions.pod:2574 ../fish/guestfish-actions.pod:2597 ../fish/guestfish-actions.pod:2607
23006 "This command has one or more key or passphrase parameters. Guestfish will "
23007 "prompt for these separately."
23011 #: ../fish/guestfish-actions.pod:2528
23016 #: ../fish/guestfish-actions.pod:2530
23019 " luks-close device\n"
23024 #: ../fish/guestfish-actions.pod:2532
23026 "This closes a LUKS device that was created earlier by L</luks-open> or "
23027 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
23028 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
23029 "underlying block device."
23033 #: ../fish/guestfish-actions.pod:2538
23034 msgid "luks-format"
23038 #: ../fish/guestfish-actions.pod:2540
23041 " luks-format device keyslot\n"
23046 #: ../fish/guestfish-actions.pod:2553
23047 msgid "luks-format-cipher"
23051 #: ../fish/guestfish-actions.pod:2555
23054 " luks-format-cipher device keyslot cipher\n"
23059 #: ../fish/guestfish-actions.pod:2557
23061 "This command is the same as L</luks-format> but it also allows you to set "
23062 "the C<cipher> used."
23066 #: ../fish/guestfish-actions.pod:2566
23067 msgid "luks-kill-slot"
23071 #: ../fish/guestfish-actions.pod:2568
23074 " luks-kill-slot device keyslot\n"
23079 #: ../fish/guestfish-actions.pod:2577
23084 #: ../fish/guestfish-actions.pod:2579
23087 " luks-open device mapname\n"
23092 #: ../fish/guestfish-actions.pod:2593
23094 "If this block device contains LVM volume groups, then calling L</vgscan> "
23095 "followed by L</vg-activate-all> will make them visible."
23099 #: ../fish/guestfish-actions.pod:2600
23100 msgid "luks-open-ro"
23104 #: ../fish/guestfish-actions.pod:2602
23107 " luks-open-ro device mapname\n"
23112 #: ../fish/guestfish-actions.pod:2604
23114 "This is the same as L</luks-open> except that a read-only mapping is "
23119 #: ../fish/guestfish-actions.pod:2610
23124 #: ../fish/guestfish-actions.pod:2612
23127 " lvcreate logvol volgroup mbytes\n"
23132 #: ../fish/guestfish-actions.pod:2617
23133 msgid "lvm-canonical-lv-name"
23137 #: ../fish/guestfish-actions.pod:2619
23140 " lvm-canonical-lv-name lvname\n"
23145 #: ../fish/guestfish-actions.pod:2628
23146 msgid "See also L</is-lv>."
23150 #: ../fish/guestfish-actions.pod:2630
23151 msgid "lvm-clear-filter"
23155 #: ../fish/guestfish-actions.pod:2632
23158 " lvm-clear-filter\n"
23163 #: ../fish/guestfish-actions.pod:2634
23165 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
23170 #: ../fish/guestfish-actions.pod:2640
23171 msgid "lvm-remove-all"
23175 #: ../fish/guestfish-actions.pod:2642
23178 " lvm-remove-all\n"
23183 #: ../fish/guestfish-actions.pod:2650
23184 msgid "lvm-set-filter"
23188 #: ../fish/guestfish-actions.pod:2652
23191 " lvm-set-filter 'devices ...'\n"
23196 #: ../fish/guestfish-actions.pod:2677
23201 #: ../fish/guestfish-actions.pod:2679
23204 " lvremove device\n"
23209 #: ../fish/guestfish-actions.pod:2687
23214 #: ../fish/guestfish-actions.pod:2689
23217 " lvrename logvol newlogvol\n"
23222 #: ../fish/guestfish-actions.pod:2693
23227 #: ../fish/guestfish-actions.pod:2695
23230 " lvresize device mbytes\n"
23235 #: ../fish/guestfish-actions.pod:2701
23236 msgid "lvresize-free"
23240 #: ../fish/guestfish-actions.pod:2703
23243 " lvresize-free lv percent\n"
23248 #: ../fish/guestfish-actions.pod:2711
23253 #: ../fish/guestfish-actions.pod:2713
23261 #: ../fish/guestfish-actions.pod:2721
23262 msgid "See also L</lvs-full>, L</list-filesystems>."
23266 #: ../fish/guestfish-actions.pod:2723
23271 #: ../fish/guestfish-actions.pod:2725
23279 #: ../fish/guestfish-actions.pod:2730
23284 #: ../fish/guestfish-actions.pod:2732
23292 #: ../fish/guestfish-actions.pod:2736
23297 #: ../fish/guestfish-actions.pod:2738
23300 " lxattrlist path 'names ...'\n"
23305 #: ../fish/guestfish-actions.pod:2754
23307 "This call is intended for programs that want to efficiently list a directory "
23308 "contents without making many round-trips. See also L</lstatlist> for a "
23309 "similarly efficient call for getting standard stats. Very long directory "
23310 "listings might cause the protocol message size to be exceeded, causing this "
23311 "call to fail. The caller must split up such requests into smaller groups of "
23316 #: ../fish/guestfish-actions.pod:2762
23321 #: ../fish/guestfish-actions.pod:2764
23329 #: ../fish/guestfish-actions.pod:2768
23334 #: ../fish/guestfish-actions.pod:2770
23337 " mkdir-mode path mode\n"
23342 #: ../fish/guestfish-actions.pod:2779
23343 msgid "See also L</mkdir>, L</umask>"
23347 #: ../fish/guestfish-actions.pod:2781
23352 #: ../fish/guestfish-actions.pod:2783
23360 #: ../fish/guestfish-actions.pod:2788
23365 #: ../fish/guestfish-actions.pod:2790
23368 " mkdtemp template\n"
23373 #: ../fish/guestfish-actions.pod:2811
23378 #: ../fish/guestfish-actions.pod:2813
23381 " mke2fs-J fstype blocksize device journal\n"
23386 #: ../fish/guestfish-actions.pod:2821
23387 msgid "See also L</mke2journal>."
23391 #: ../fish/guestfish-actions.pod:2823
23396 #: ../fish/guestfish-actions.pod:2825
23399 " mke2fs-JL fstype blocksize device label\n"
23404 #: ../fish/guestfish-actions.pod:2830
23405 msgid "See also L</mke2journal-L>."
23409 #: ../fish/guestfish-actions.pod:2832
23414 #: ../fish/guestfish-actions.pod:2834
23417 " mke2fs-JU fstype blocksize device uuid\n"
23422 #: ../fish/guestfish-actions.pod:2839
23423 msgid "See also L</mke2journal-U>."
23427 #: ../fish/guestfish-actions.pod:2841
23428 msgid "mke2journal"
23432 #: ../fish/guestfish-actions.pod:2843
23435 " mke2journal blocksize device\n"
23440 #: ../fish/guestfish-actions.pod:2850
23441 msgid "mke2journal-L"
23445 #: ../fish/guestfish-actions.pod:2852
23448 " mke2journal-L blocksize label device\n"
23453 #: ../fish/guestfish-actions.pod:2856
23454 msgid "mke2journal-U"
23458 #: ../fish/guestfish-actions.pod:2858
23461 " mke2journal-U blocksize uuid device\n"
23466 #: ../fish/guestfish-actions.pod:2862
23471 #: ../fish/guestfish-actions.pod:2864
23474 " mkfifo mode path\n"
23479 #: ../fish/guestfish-actions.pod:2866
23481 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
23482 "is just a convenient wrapper around L</mknod>."
23486 #: ../fish/guestfish-actions.pod:2872
23491 #: ../fish/guestfish-actions.pod:2874
23494 " mkfs fstype device\n"
23499 #: ../fish/guestfish-actions.pod:2880
23504 #: ../fish/guestfish-actions.pod:2882
23507 " mkfs-b fstype blocksize device\n"
23512 #: ../fish/guestfish-actions.pod:2884
23514 "This call is similar to L</mkfs>, but it allows you to control the block "
23515 "size of the resulting filesystem. Supported block sizes depend on the "
23516 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
23520 #: ../fish/guestfish-actions.pod:2899
23525 #: ../fish/guestfish-actions.pod:2901
23528 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
23533 #: ../fish/guestfish-actions.pod:2936
23534 msgid "mkmountpoint"
23538 #: ../fish/guestfish-actions.pod:2938
23541 " mkmountpoint exemptpath\n"
23546 #: ../fish/guestfish-actions.pod:2940
23548 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
23549 "to create extra mountpoints before mounting the first filesystem."
23553 #: ../fish/guestfish-actions.pod:2964
23555 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
23556 "unexpected errors if you try to mix these calls. It is safest to manually "
23557 "unmount filesystems and remove mountpoints after use."
23561 #: ../fish/guestfish-actions.pod:2968
23563 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
23564 "for this to work for manual mountpoints, you must ensure that the innermost "
23565 "mountpoints have the longest pathnames, as in the example code above."
23569 #: ../fish/guestfish-actions.pod:2975
23571 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
23572 "L</umount-all> to be called when the handle is closed which can also trigger "
23577 #: ../fish/guestfish-actions.pod:2979
23582 #: ../fish/guestfish-actions.pod:2981
23585 " mknod mode devmajor devminor path\n"
23590 #: ../fish/guestfish-actions.pod:2991
23592 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
23593 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
23594 "regular file). These constants are available in the standard Linux header "
23595 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
23596 "wrappers around this command which bitwise OR in the appropriate constant "
23601 #: ../fish/guestfish-actions.pod:3001
23606 #: ../fish/guestfish-actions.pod:3003
23609 " mknod-b mode devmajor devminor path\n"
23614 #: ../fish/guestfish-actions.pod:3005
23616 "This call creates a block device node called C<path> with mode C<mode> and "
23617 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23618 "wrapper around L</mknod>."
23622 #: ../fish/guestfish-actions.pod:3011
23627 #: ../fish/guestfish-actions.pod:3013
23630 " mknod-c mode devmajor devminor path\n"
23635 #: ../fish/guestfish-actions.pod:3015
23637 "This call creates a char device node called C<path> with mode C<mode> and "
23638 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23639 "wrapper around L</mknod>."
23643 #: ../fish/guestfish-actions.pod:3021
23648 #: ../fish/guestfish-actions.pod:3023
23656 #: ../fish/guestfish-actions.pod:3027
23661 #: ../fish/guestfish-actions.pod:3029
23664 " mkswap-L label device\n"
23669 #: ../fish/guestfish-actions.pod:3037
23674 #: ../fish/guestfish-actions.pod:3039
23677 " mkswap-U uuid device\n"
23682 #: ../fish/guestfish-actions.pod:3043
23683 msgid "mkswap-file"
23687 #: ../fish/guestfish-actions.pod:3045
23690 " mkswap-file path\n"
23695 #: ../fish/guestfish-actions.pod:3049
23697 "This command just writes a swap file signature to an existing file. To "
23698 "create the file itself, use something like L</fallocate>."
23702 #: ../fish/guestfish-actions.pod:3052
23707 #: ../fish/guestfish-actions.pod:3054
23710 " modprobe modulename\n"
23715 #: ../fish/guestfish-actions.pod:3061
23720 #: ../fish/guestfish-actions.pod:3063
23723 " mount device mountpoint\n"
23728 #: ../fish/guestfish-actions.pod:3079
23730 "B<Important note:> When you use this call, the filesystem options C<sync> "
23731 "and C<noatime> are set implicitly. This was originally done because we "
23732 "thought it would improve reliability, but it turns out that I<-o sync> has a "
23733 "very large negative performance impact and negligible effect on "
23734 "reliability. Therefore we recommend that you avoid using L</mount> in any "
23735 "code that needs performance, and instead use L</mount-options> (use an empty "
23736 "string for the first parameter if you don't want any options)."
23740 #: ../fish/guestfish-actions.pod:3089
23745 #: ../fish/guestfish-actions.pod:3091
23748 " mount-loop file mountpoint\n"
23753 #: ../fish/guestfish-actions.pod:3097
23754 msgid "mount-options"
23758 #: ../fish/guestfish-actions.pod:3099
23761 " mount-options options device mountpoint\n"
23766 #: ../fish/guestfish-actions.pod:3101
23768 "This is the same as the L</mount> command, but it allows you to set the "
23769 "mount options as for the L<mount(8)> I<-o> flag."
23773 #: ../fish/guestfish-actions.pod:3109
23778 #: ../fish/guestfish-actions.pod:3111
23781 " mount-ro device mountpoint\n"
23786 #: ../fish/guestfish-actions.pod:3113
23788 "This is the same as the L</mount> command, but it mounts the filesystem with "
23789 "the read-only (I<-o ro>) flag."
23793 #: ../fish/guestfish-actions.pod:3116
23798 #: ../fish/guestfish-actions.pod:3118
23801 " mount-vfs options vfstype device mountpoint\n"
23806 #: ../fish/guestfish-actions.pod:3120
23808 "This is the same as the L</mount> command, but it allows you to set both the "
23809 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
23813 #: ../fish/guestfish-actions.pod:3124
23814 msgid "mountpoints"
23818 #: ../fish/guestfish-actions.pod:3126
23826 #: ../fish/guestfish-actions.pod:3128
23828 "This call is similar to L</mounts>. That call returns a list of devices. "
23829 "This one returns a hash table (map) of device name to directory where the "
23830 "device is mounted."
23834 #: ../fish/guestfish-actions.pod:3132
23839 #: ../fish/guestfish-actions.pod:3134
23847 #: ../fish/guestfish-actions.pod:3141
23848 msgid "See also: L</mountpoints>"
23852 #: ../fish/guestfish-actions.pod:3143
23857 #: ../fish/guestfish-actions.pod:3145
23865 #: ../fish/guestfish-actions.pod:3150
23866 msgid "ntfs-3g-probe"
23870 #: ../fish/guestfish-actions.pod:3152
23873 " ntfs-3g-probe true|false device\n"
23878 #: ../fish/guestfish-actions.pod:3166
23883 #: ../fish/guestfish-actions.pod:3168
23886 " ntfsresize device\n"
23891 #: ../fish/guestfish-actions.pod:3174
23892 msgid "ntfsresize-size"
23896 #: ../fish/guestfish-actions.pod:3176
23899 " ntfsresize-size device size\n"
23904 #: ../fish/guestfish-actions.pod:3178
23906 "This command is the same as L</ntfsresize> except that it allows you to "
23907 "specify the new size (in bytes) explicitly."
23911 #: ../fish/guestfish-actions.pod:3181
23916 #: ../fish/guestfish-actions.pod:3183
23919 " part-add device prlogex startsect endsect\n"
23924 #: ../fish/guestfish-actions.pod:3185
23926 "This command adds a partition to C<device>. If there is no partition table "
23927 "on the device, call L</part-init> first."
23931 #: ../fish/guestfish-actions.pod:3197
23933 "Creating a partition which covers the whole disk is not so easy. Use "
23934 "L</part-disk> to do that."
23938 #: ../fish/guestfish-actions.pod:3200
23943 #: ../fish/guestfish-actions.pod:3202
23946 " part-del device partnum\n"
23951 #: ../fish/guestfish-actions.pod:3210
23956 #: ../fish/guestfish-actions.pod:3212
23959 " part-disk device parttype\n"
23964 #: ../fish/guestfish-actions.pod:3214
23966 "This command is simply a combination of L</part-init> followed by "
23967 "L</part-add> to create a single primary partition covering the whole disk."
23971 #: ../fish/guestfish-actions.pod:3218
23973 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
23974 "possible values are described in L</part-init>."
23978 #: ../fish/guestfish-actions.pod:3224
23979 msgid "part-get-bootable"
23983 #: ../fish/guestfish-actions.pod:3226
23986 " part-get-bootable device partnum\n"
23991 #: ../fish/guestfish-actions.pod:3231
23992 msgid "See also L</part-set-bootable>."
23996 #: ../fish/guestfish-actions.pod:3233
23997 msgid "part-get-mbr-id"
24001 #: ../fish/guestfish-actions.pod:3235
24004 " part-get-mbr-id device partnum\n"
24009 #: ../fish/guestfish-actions.pod:3240 ../fish/guestfish-actions.pod:3378
24011 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
24012 "undefined results for other partition table types (see "
24013 "L</part-get-parttype>)."
24017 #: ../fish/guestfish-actions.pod:3244
24018 msgid "part-get-parttype"
24022 #: ../fish/guestfish-actions.pod:3246
24025 " part-get-parttype device\n"
24030 #: ../fish/guestfish-actions.pod:3251
24032 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
24033 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
24034 "possible, although unusual. See L</part-init> for a full list."
24038 #: ../fish/guestfish-actions.pod:3256
24043 #: ../fish/guestfish-actions.pod:3258
24046 " part-init device parttype\n"
24051 #: ../fish/guestfish-actions.pod:3264
24053 "Initially there are no partitions. Following this, you should call "
24054 "L</part-add> for each partition required."
24058 #: ../fish/guestfish-actions.pod:3327
24063 #: ../fish/guestfish-actions.pod:3329
24066 " part-list device\n"
24071 #: ../fish/guestfish-actions.pod:3344
24073 "Start of the partition I<in bytes>. To get sectors you have to divide by "
24074 "the device's sector size, see L</blockdev-getss>."
24078 #: ../fish/guestfish-actions.pod:3357
24079 msgid "part-set-bootable"
24083 #: ../fish/guestfish-actions.pod:3359
24086 " part-set-bootable device partnum true|false\n"
24091 #: ../fish/guestfish-actions.pod:3368
24092 msgid "part-set-mbr-id"
24096 #: ../fish/guestfish-actions.pod:3370
24099 " part-set-mbr-id device partnum idbyte\n"
24104 #: ../fish/guestfish-actions.pod:3382
24105 msgid "part-set-name"
24109 #: ../fish/guestfish-actions.pod:3384
24112 " part-set-name device partnum name\n"
24117 #: ../fish/guestfish-actions.pod:3392
24118 msgid "part-to-dev"
24122 #: ../fish/guestfish-actions.pod:3394
24125 " part-to-dev partition\n"
24130 #: ../fish/guestfish-actions.pod:3400
24132 "The named partition must exist, for example as a string returned from "
24133 "L</list-partitions>."
24137 #: ../fish/guestfish-actions.pod:3403
24138 msgid "ping-daemon"
24142 #: ../fish/guestfish-actions.pod:3405
24150 #: ../fish/guestfish-actions.pod:3412
24155 #: ../fish/guestfish-actions.pod:3414
24158 " pread path count offset\n"
24163 #: ../fish/guestfish-actions.pod:3422
24164 msgid "See also L</pwrite>, L</pread-device>."
24168 #: ../fish/guestfish-actions.pod:3427
24169 msgid "pread-device"
24173 #: ../fish/guestfish-actions.pod:3429
24176 " pread-device device count offset\n"
24181 #: ../fish/guestfish-actions.pod:3437
24182 msgid "See also L</pread>."
24186 #: ../fish/guestfish-actions.pod:3442
24191 #: ../fish/guestfish-actions.pod:3444
24194 " pvcreate device\n"
24199 #: ../fish/guestfish-actions.pod:3450
24204 #: ../fish/guestfish-actions.pod:3452
24207 " pvremove device\n"
24212 #: ../fish/guestfish-actions.pod:3461
24217 #: ../fish/guestfish-actions.pod:3463
24220 " pvresize device\n"
24225 #: ../fish/guestfish-actions.pod:3468
24226 msgid "pvresize-size"
24230 #: ../fish/guestfish-actions.pod:3470
24233 " pvresize-size device size\n"
24238 #: ../fish/guestfish-actions.pod:3472
24240 "This command is the same as L</pvresize> except that it allows you to "
24241 "specify the new size (in bytes) explicitly."
24245 #: ../fish/guestfish-actions.pod:3475
24250 #: ../fish/guestfish-actions.pod:3477
24258 #: ../fish/guestfish-actions.pod:3485
24259 msgid "See also L</pvs-full>."
24263 #: ../fish/guestfish-actions.pod:3487
24268 #: ../fish/guestfish-actions.pod:3489
24276 #: ../fish/guestfish-actions.pod:3494
24281 #: ../fish/guestfish-actions.pod:3496
24289 #: ../fish/guestfish-actions.pod:3500
24294 #: ../fish/guestfish-actions.pod:3502
24297 " pwrite path content offset\n"
24302 #: ../fish/guestfish-actions.pod:3513
24303 msgid "See also L</pread>, L</pwrite-device>."
24307 #: ../fish/guestfish-actions.pod:3518
24308 msgid "pwrite-device"
24312 #: ../fish/guestfish-actions.pod:3520
24315 " pwrite-device device content offset\n"
24320 #: ../fish/guestfish-actions.pod:3530
24321 msgid "See also L</pwrite>."
24325 #: ../fish/guestfish-actions.pod:3535
24330 #: ../fish/guestfish-actions.pod:3537
24333 " read-file path\n"
24338 #: ../fish/guestfish-actions.pod:3542
24340 "Unlike L</cat>, this function can correctly handle files that contain "
24341 "embedded ASCII NUL characters. However unlike L</download>, this function "
24342 "is limited in the total size of file that can be handled."
24346 #: ../fish/guestfish-actions.pod:3550
24351 #: ../fish/guestfish-actions.pod:3552
24354 " read-lines path\n"
24359 #: ../fish/guestfish-actions.pod:3559
24361 "Note that this function cannot correctly handle binary files (specifically, "
24362 "files containing C<\\0> character which is treated as end of line). For "
24363 "those you need to use the L</read-file> function which has a more complex "
24368 #: ../fish/guestfish-actions.pod:3564
24373 #: ../fish/guestfish-actions.pod:3566
24381 #: ../fish/guestfish-actions.pod:3618
24383 "This function is primarily intended for use by programs. To get a simple "
24384 "list of names, use L</ls>. To get a printable directory for human "
24385 "consumption, use L</ll>."
24389 #: ../fish/guestfish-actions.pod:3622
24394 #: ../fish/guestfish-actions.pod:3624
24402 #: ../fish/guestfish-actions.pod:3628
24403 msgid "readlinklist"
24407 #: ../fish/guestfish-actions.pod:3630
24410 " readlinklist path 'names ...'\n"
24415 #: ../fish/guestfish-actions.pod:3654
24420 #: ../fish/guestfish-actions.pod:3656
24428 #: ../fish/guestfish-actions.pod:3661
24429 msgid "removexattr"
24433 #: ../fish/guestfish-actions.pod:3663
24436 " removexattr xattr path\n"
24441 #: ../fish/guestfish-actions.pod:3668
24442 msgid "See also: L</lremovexattr>, L<attr(5)>."
24446 #: ../fish/guestfish-actions.pod:3670
24451 #: ../fish/guestfish-actions.pod:3672
24454 " resize2fs device\n"
24459 #: ../fish/guestfish-actions.pod:3677
24461 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
24462 "before calling this command. For unknown reasons C<resize2fs> sometimes "
24463 "gives an error about this and sometimes not. In any case, it is always safe "
24464 "to call L</e2fsck-f> before calling this function."
24468 #: ../fish/guestfish-actions.pod:3683
24469 msgid "resize2fs-M"
24473 #: ../fish/guestfish-actions.pod:3685
24476 " resize2fs-M device\n"
24481 #: ../fish/guestfish-actions.pod:3687
24483 "This command is the same as L</resize2fs>, but the filesystem is resized to "
24484 "its minimum size. This works like the C<-M> option to the C<resize2fs> "
24489 #: ../fish/guestfish-actions.pod:3691
24491 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
24492 "and read the C<Block size> and C<Block count> values. These two numbers, "
24493 "multiplied together, give the resulting size of the minimal filesystem in "
24498 #: ../fish/guestfish-actions.pod:3696
24499 msgid "resize2fs-size"
24503 #: ../fish/guestfish-actions.pod:3698
24506 " resize2fs-size device size\n"
24511 #: ../fish/guestfish-actions.pod:3700
24513 "This command is the same as L</resize2fs> except that it allows you to "
24514 "specify the new size (in bytes) explicitly."
24518 #: ../fish/guestfish-actions.pod:3703
24523 #: ../fish/guestfish-actions.pod:3705
24531 #: ../fish/guestfish-actions.pod:3709
24536 #: ../fish/guestfish-actions.pod:3711
24544 #: ../fish/guestfish-actions.pod:3717
24549 #: ../fish/guestfish-actions.pod:3719
24557 #: ../fish/guestfish-actions.pod:3723
24558 msgid "rmmountpoint"
24562 #: ../fish/guestfish-actions.pod:3725
24565 " rmmountpoint exemptpath\n"
24570 #: ../fish/guestfish-actions.pod:3727
24572 "This calls removes a mountpoint that was previously created with "
24573 "L</mkmountpoint>. See L</mkmountpoint> for full details."
24577 #: ../fish/guestfish-actions.pod:3731
24578 msgid "scrub-device"
24582 #: ../fish/guestfish-actions.pod:3733
24585 " scrub-device device\n"
24590 #: ../fish/guestfish-actions.pod:3744
24595 #: ../fish/guestfish-actions.pod:3746
24598 " scrub-file file\n"
24603 #: ../fish/guestfish-actions.pod:3756
24604 msgid "scrub-freespace"
24608 #: ../fish/guestfish-actions.pod:3758
24611 " scrub-freespace dir\n"
24616 #: ../fish/guestfish-actions.pod:3760
24618 "This command creates the directory C<dir> and then fills it with files until "
24619 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
24620 "deletes them. The intention is to scrub any free space on the partition "
24621 "containing C<dir>."
24625 #: ../fish/guestfish-actions.pod:3769
24630 #: ../fish/guestfish-actions.pod:3771
24635 #: ../fish/guestfish-actions.pod:3773
24638 " set-append append\n"
24643 #: ../fish/guestfish-actions.pod:3784
24644 msgid "set-autosync"
24648 #: ../fish/guestfish-actions.pod:3786
24653 #: ../fish/guestfish-actions.pod:3788
24656 " set-autosync true|false\n"
24661 #: ../fish/guestfish-actions.pod:3798
24666 #: ../fish/guestfish-actions.pod:3800
24671 #: ../fish/guestfish-actions.pod:3802
24674 " set-direct true|false\n"
24679 #: ../fish/guestfish-actions.pod:3808
24681 "One consequence of this is that log messages aren't caught by the library "
24682 "and handled by L</set-log-message-callback>, but go straight to stdout."
24686 #: ../fish/guestfish-actions.pod:3817
24687 msgid "set-e2label"
24691 #: ../fish/guestfish-actions.pod:3819
24694 " set-e2label device label\n"
24699 #: ../fish/guestfish-actions.pod:3825
24701 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
24702 "label on a filesystem."
24706 #: ../fish/guestfish-actions.pod:3828
24711 #: ../fish/guestfish-actions.pod:3830
24714 " set-e2uuid device uuid\n"
24719 #: ../fish/guestfish-actions.pod:3837
24721 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
24722 "UUID of a filesystem."
24726 #: ../fish/guestfish-actions.pod:3840
24727 msgid "set-memsize"
24731 #: ../fish/guestfish-actions.pod:3842
24736 #: ../fish/guestfish-actions.pod:3844
24739 " set-memsize memsize\n"
24744 #: ../fish/guestfish-actions.pod:3846
24746 "This sets the memory size in megabytes allocated to the qemu subprocess. "
24747 "This only has any effect if called before L</launch>."
24751 #: ../fish/guestfish-actions.pod:3857
24752 msgid "set-network"
24756 #: ../fish/guestfish-actions.pod:3859
24761 #: ../fish/guestfish-actions.pod:3861
24764 " set-network true|false\n"
24769 #: ../fish/guestfish-actions.pod:3869
24770 msgid "You must call this before calling L</launch>, otherwise it has no effect."
24774 #: ../fish/guestfish-actions.pod:3872
24779 #: ../fish/guestfish-actions.pod:3874
24784 #: ../fish/guestfish-actions.pod:3876
24787 " set-path searchpath\n"
24792 #: ../fish/guestfish-actions.pod:3885
24797 #: ../fish/guestfish-actions.pod:3887
24802 #: ../fish/guestfish-actions.pod:3889
24810 #: ../fish/guestfish-actions.pod:3909
24811 msgid "set-recovery-proc"
24815 #: ../fish/guestfish-actions.pod:3911
24816 msgid "recovery-proc"
24820 #: ../fish/guestfish-actions.pod:3913
24823 " set-recovery-proc true|false\n"
24828 #: ../fish/guestfish-actions.pod:3915
24830 "If this is called with the parameter C<false> then L</launch> does not "
24831 "create a recovery process. The purpose of the recovery process is to stop "
24832 "runaway qemu processes in the case where the main program aborts abruptly."
24836 #: ../fish/guestfish-actions.pod:3920
24838 "This only has any effect if called before L</launch>, and the default is "
24843 #: ../fish/guestfish-actions.pod:3929
24844 msgid "set-selinux"
24848 #: ../fish/guestfish-actions.pod:3931
24853 #: ../fish/guestfish-actions.pod:3933
24856 " set-selinux true|false\n"
24861 #: ../fish/guestfish-actions.pod:3944
24866 #: ../fish/guestfish-actions.pod:3946
24871 #: ../fish/guestfish-actions.pod:3948
24874 " set-trace true|false\n"
24879 #: ../fish/guestfish-actions.pod:3964
24880 msgid "set-verbose"
24884 #: ../fish/guestfish-actions.pod:3966
24889 #: ../fish/guestfish-actions.pod:3968
24892 " set-verbose true|false\n"
24897 #: ../fish/guestfish-actions.pod:3975
24902 #: ../fish/guestfish-actions.pod:3977
24905 " setcon context\n"
24910 #: ../fish/guestfish-actions.pod:3984
24915 #: ../fish/guestfish-actions.pod:3986
24918 " setxattr xattr val vallen path\n"
24923 #: ../fish/guestfish-actions.pod:3992
24924 msgid "See also: L</lsetxattr>, L<attr(5)>."
24928 #: ../fish/guestfish-actions.pod:3994
24933 #: ../fish/guestfish-actions.pod:3996
24936 " sfdisk device cyls heads sectors 'lines ...'\n"
24941 #: ../fish/guestfish-actions.pod:4018
24942 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
24946 #: ../fish/guestfish-actions.pod:4024
24951 #: ../fish/guestfish-actions.pod:4026
24954 " sfdiskM device 'lines ...'\n"
24959 #: ../fish/guestfish-actions.pod:4028
24961 "This is a simplified interface to the L</sfdisk> command, where partition "
24962 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
24963 "you don't need to specify the cyls, heads and sectors parameters which were "
24964 "rarely if ever used anyway."
24968 #: ../fish/guestfish-actions.pod:4034
24969 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
24973 #: ../fish/guestfish-actions.pod:4040
24978 #: ../fish/guestfish-actions.pod:4042
24981 " sfdisk-N device partnum cyls heads sectors line\n"
24986 #: ../fish/guestfish-actions.pod:4047
24988 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
24989 "cyls/heads/sectors parameters."
24993 #: ../fish/guestfish-actions.pod:4050
24994 msgid "See also: L</part-add>"
24998 #: ../fish/guestfish-actions.pod:4055
24999 msgid "sfdisk-disk-geometry"
25003 #: ../fish/guestfish-actions.pod:4057
25006 " sfdisk-disk-geometry device\n"
25011 #: ../fish/guestfish-actions.pod:4059
25013 "This displays the disk geometry of C<device> read from the partition table. "
25014 "Especially in the case where the underlying block device has been resized, "
25015 "this can be different from the kernel's idea of the geometry (see "
25016 "L</sfdisk-kernel-geometry>)."
25020 #: ../fish/guestfish-actions.pod:4067
25021 msgid "sfdisk-kernel-geometry"
25025 #: ../fish/guestfish-actions.pod:4069
25028 " sfdisk-kernel-geometry device\n"
25033 #: ../fish/guestfish-actions.pod:4076
25038 #: ../fish/guestfish-actions.pod:4078
25041 " sfdisk-l device\n"
25046 #: ../fish/guestfish-actions.pod:4084
25047 msgid "See also: L</part-list>"
25051 #: ../fish/guestfish-actions.pod:4086
25056 #: ../fish/guestfish-actions.pod:4088
25064 #: ../fish/guestfish-actions.pod:4093
25065 msgid "This is like L</command>, but passes the command to:"
25069 #: ../fish/guestfish-actions.pod:4101
25070 msgid "All the provisos about L</command> apply to this call."
25074 #: ../fish/guestfish-actions.pod:4103
25079 #: ../fish/guestfish-actions.pod:4105
25082 " sh-lines command\n"
25087 #: ../fish/guestfish-actions.pod:4107
25088 msgid "This is the same as L</sh>, but splits the result into a list of lines."
25092 #: ../fish/guestfish-actions.pod:4110
25093 msgid "See also: L</command-lines>"
25097 #: ../fish/guestfish-actions.pod:4112
25102 #: ../fish/guestfish-actions.pod:4114
25110 #: ../fish/guestfish-actions.pod:4118
25115 #: ../fish/guestfish-actions.pod:4120
25123 #: ../fish/guestfish-actions.pod:4126
25128 #: ../fish/guestfish-actions.pod:4128
25136 #: ../fish/guestfish-actions.pod:4136
25141 #: ../fish/guestfish-actions.pod:4138
25149 #: ../fish/guestfish-actions.pod:4146
25154 #: ../fish/guestfish-actions.pod:4148
25157 " strings-e encoding path\n"
25162 #: ../fish/guestfish-actions.pod:4150
25164 "This is like the L</strings> command, but allows you to specify the encoding "
25165 "of strings that are looked for in the source file C<path>."
25169 #: ../fish/guestfish-actions.pod:4160
25171 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
25172 "ISO-8859-X (this is what L</strings> uses)."
25176 #: ../fish/guestfish-actions.pod:4192
25177 msgid "swapoff-device"
25181 #: ../fish/guestfish-actions.pod:4194
25184 " swapoff-device device\n"
25189 #: ../fish/guestfish-actions.pod:4196
25191 "This command disables the libguestfs appliance swap device or partition "
25192 "named C<device>. See L</swapon-device>."
25196 #: ../fish/guestfish-actions.pod:4200
25197 msgid "swapoff-file"
25201 #: ../fish/guestfish-actions.pod:4202
25204 " swapoff-file file\n"
25209 #: ../fish/guestfish-actions.pod:4206
25210 msgid "swapoff-label"
25214 #: ../fish/guestfish-actions.pod:4208
25217 " swapoff-label label\n"
25222 #: ../fish/guestfish-actions.pod:4213
25223 msgid "swapoff-uuid"
25227 #: ../fish/guestfish-actions.pod:4215
25230 " swapoff-uuid uuid\n"
25235 #: ../fish/guestfish-actions.pod:4220
25236 msgid "swapon-device"
25240 #: ../fish/guestfish-actions.pod:4222
25243 " swapon-device device\n"
25248 #: ../fish/guestfish-actions.pod:4224
25250 "This command enables the libguestfs appliance to use the swap device or "
25251 "partition named C<device>. The increased memory is made available for all "
25252 "commands, for example those run using L</command> or L</sh>."
25256 #: ../fish/guestfish-actions.pod:4236
25257 msgid "swapon-file"
25261 #: ../fish/guestfish-actions.pod:4238
25264 " swapon-file file\n"
25269 #: ../fish/guestfish-actions.pod:4240
25270 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
25274 #: ../fish/guestfish-actions.pod:4243
25275 msgid "swapon-label"
25279 #: ../fish/guestfish-actions.pod:4245
25282 " swapon-label label\n"
25287 #: ../fish/guestfish-actions.pod:4247
25289 "This command enables swap to a labeled swap partition. See "
25290 "L</swapon-device> for other notes."
25294 #: ../fish/guestfish-actions.pod:4250
25295 msgid "swapon-uuid"
25299 #: ../fish/guestfish-actions.pod:4252
25302 " swapon-uuid uuid\n"
25307 #: ../fish/guestfish-actions.pod:4254
25309 "This command enables swap to a swap partition with the given UUID. See "
25310 "L</swapon-device> for other notes."
25314 #: ../fish/guestfish-actions.pod:4257
25319 #: ../fish/guestfish-actions.pod:4259
25327 #: ../fish/guestfish-actions.pod:4267
25332 #: ../fish/guestfish-actions.pod:4269
25340 #: ../fish/guestfish-actions.pod:4277
25345 #: ../fish/guestfish-actions.pod:4279
25348 " tail-n nrlines path\n"
25353 #: ../fish/guestfish-actions.pod:4292
25358 #: ../fish/guestfish-actions.pod:4294
25361 " tar-in (tarfile|-) directory\n"
25366 #: ../fish/guestfish-actions.pod:4299
25367 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
25371 #: ../fish/guestfish-actions.pod:4304
25376 #: ../fish/guestfish-actions.pod:4306
25379 " tar-out directory (tarfile|-)\n"
25384 #: ../fish/guestfish-actions.pod:4311
25385 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
25389 #: ../fish/guestfish-actions.pod:4316
25394 #: ../fish/guestfish-actions.pod:4318
25397 " tgz-in (tarball|-) directory\n"
25402 #: ../fish/guestfish-actions.pod:4323
25403 msgid "To upload an uncompressed tarball, use L</tar-in>."
25407 #: ../fish/guestfish-actions.pod:4327
25412 #: ../fish/guestfish-actions.pod:4329
25415 " tgz-out directory (tarball|-)\n"
25420 #: ../fish/guestfish-actions.pod:4334
25421 msgid "To download an uncompressed tarball, use L</tar-out>."
25425 #: ../fish/guestfish-actions.pod:4338
25430 #: ../fish/guestfish-actions.pod:4340
25438 #: ../fish/guestfish-actions.pod:4349
25443 #: ../fish/guestfish-actions.pod:4351
25451 #: ../fish/guestfish-actions.pod:4356
25452 msgid "truncate-size"
25456 #: ../fish/guestfish-actions.pod:4358
25459 " truncate-size path size\n"
25464 #: ../fish/guestfish-actions.pod:4363
25466 "If the current file size is less than C<size> then the file is extended to "
25467 "the required size with zero bytes. This creates a sparse file (ie. disk "
25468 "blocks are not allocated for the file until you write to it). To create a "
25469 "non-sparse file of zeroes, use L</fallocate64> instead."
25473 #: ../fish/guestfish-actions.pod:4369
25478 #: ../fish/guestfish-actions.pod:4371
25481 " tune2fs-l device\n"
25486 #: ../fish/guestfish-actions.pod:4381
25491 #: ../fish/guestfish-actions.pod:4383
25494 " txz-in (tarball|-) directory\n"
25499 #: ../fish/guestfish-actions.pod:4390
25504 #: ../fish/guestfish-actions.pod:4392
25507 " txz-out directory (tarball|-)\n"
25512 #: ../fish/guestfish-actions.pod:4399
25517 #: ../fish/guestfish-actions.pod:4401
25525 #: ../fish/guestfish-actions.pod:4415
25526 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
25530 #: ../fish/guestfish-actions.pod:4420
25535 #: ../fish/guestfish-actions.pod:4422
25540 #: ../fish/guestfish-actions.pod:4424
25543 " umount pathordevice\n"
25548 #: ../fish/guestfish-actions.pod:4430
25553 #: ../fish/guestfish-actions.pod:4432
25554 msgid "unmount-all"
25558 #: ../fish/guestfish-actions.pod:4434
25566 #: ../fish/guestfish-actions.pod:4440
25571 #: ../fish/guestfish-actions.pod:4442
25574 " upload (filename|-) remotefilename\n"
25579 #: ../fish/guestfish-actions.pod:4449
25580 msgid "See also L</download>."
25584 #: ../fish/guestfish-actions.pod:4453
25585 msgid "upload-offset"
25589 #: ../fish/guestfish-actions.pod:4455
25592 " upload-offset (filename|-) remotefilename offset\n"
25597 #: ../fish/guestfish-actions.pod:4467
25599 "Note that there is no limit on the amount of data that can be uploaded with "
25600 "this call, unlike with L</pwrite>, and this call always writes the full "
25601 "amount unless an error occurs."
25605 #: ../fish/guestfish-actions.pod:4472
25606 msgid "See also L</upload>, L</pwrite>."
25610 #: ../fish/guestfish-actions.pod:4476
25615 #: ../fish/guestfish-actions.pod:4478
25618 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
25623 #: ../fish/guestfish-actions.pod:4497
25628 #: ../fish/guestfish-actions.pod:4499
25636 #: ../fish/guestfish-actions.pod:4526
25638 "I<Note:> Don't use this call to test for availability of features. In "
25639 "enterprise distributions we backport features from later versions into "
25640 "earlier versions, making this an unreliable way to test for features. Use "
25641 "L</available> instead."
25645 #: ../fish/guestfish-actions.pod:4532
25650 #: ../fish/guestfish-actions.pod:4534
25653 " vfs-label device\n"
25658 #: ../fish/guestfish-actions.pod:4541
25659 msgid "To find a filesystem from the label, use L</findfs-label>."
25663 #: ../fish/guestfish-actions.pod:4543
25668 #: ../fish/guestfish-actions.pod:4545
25671 " vfs-type device\n"
25676 #: ../fish/guestfish-actions.pod:4555
25681 #: ../fish/guestfish-actions.pod:4557
25684 " vfs-uuid device\n"
25689 #: ../fish/guestfish-actions.pod:4564
25690 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
25694 #: ../fish/guestfish-actions.pod:4566
25695 msgid "vg-activate"
25699 #: ../fish/guestfish-actions.pod:4568
25702 " vg-activate true|false 'volgroups ...'\n"
25707 #: ../fish/guestfish-actions.pod:4581
25708 msgid "vg-activate-all"
25712 #: ../fish/guestfish-actions.pod:4583
25715 " vg-activate-all true|false\n"
25720 #: ../fish/guestfish-actions.pod:4593
25725 #: ../fish/guestfish-actions.pod:4595
25728 " vgcreate volgroup 'physvols ...'\n"
25733 #: ../fish/guestfish-actions.pod:4600
25738 #: ../fish/guestfish-actions.pod:4602
25741 " vglvuuids vgname\n"
25746 #: ../fish/guestfish-actions.pod:4607
25748 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
25749 "logical volumes and volume groups."
25753 #: ../fish/guestfish-actions.pod:4610
25754 msgid "See also L</vgpvuuids>."
25758 #: ../fish/guestfish-actions.pod:4612
25763 #: ../fish/guestfish-actions.pod:4614
25766 " vgpvuuids vgname\n"
25771 #: ../fish/guestfish-actions.pod:4619
25773 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
25774 "physical volumes and volume groups."
25778 #: ../fish/guestfish-actions.pod:4622
25779 msgid "See also L</vglvuuids>."
25783 #: ../fish/guestfish-actions.pod:4624
25788 #: ../fish/guestfish-actions.pod:4626
25791 " vgremove vgname\n"
25796 #: ../fish/guestfish-actions.pod:4633
25801 #: ../fish/guestfish-actions.pod:4635
25804 " vgrename volgroup newvolgroup\n"
25809 #: ../fish/guestfish-actions.pod:4639
25814 #: ../fish/guestfish-actions.pod:4641
25822 #: ../fish/guestfish-actions.pod:4649
25823 msgid "See also L</vgs-full>."
25827 #: ../fish/guestfish-actions.pod:4651
25832 #: ../fish/guestfish-actions.pod:4653
25840 #: ../fish/guestfish-actions.pod:4658
25845 #: ../fish/guestfish-actions.pod:4660
25853 #: ../fish/guestfish-actions.pod:4665
25858 #: ../fish/guestfish-actions.pod:4667
25866 #: ../fish/guestfish-actions.pod:4671
25871 #: ../fish/guestfish-actions.pod:4673
25879 #: ../fish/guestfish-actions.pod:4678
25884 #: ../fish/guestfish-actions.pod:4680
25892 #: ../fish/guestfish-actions.pod:4685
25897 #: ../fish/guestfish-actions.pod:4687
25905 #: ../fish/guestfish-actions.pod:4692
25910 #: ../fish/guestfish-actions.pod:4694
25913 " write path content\n"
25918 #: ../fish/guestfish-actions.pod:4702
25923 #: ../fish/guestfish-actions.pod:4704
25926 " write-file path content size\n"
25931 #: ../fish/guestfish-actions.pod:4727
25936 #: ../fish/guestfish-actions.pod:4729
25939 " zegrep regex path\n"
25944 #: ../fish/guestfish-actions.pod:4737
25949 #: ../fish/guestfish-actions.pod:4739
25952 " zegrepi regex path\n"
25957 #: ../fish/guestfish-actions.pod:4747
25962 #: ../fish/guestfish-actions.pod:4749
25970 #: ../fish/guestfish-actions.pod:4757
25971 msgid "See also: L</zero-device>, L</scrub-device>."
25975 #: ../fish/guestfish-actions.pod:4759
25976 msgid "zero-device"
25980 #: ../fish/guestfish-actions.pod:4761
25983 " zero-device device\n"
25988 #: ../fish/guestfish-actions.pod:4763
25990 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
25991 "which just zeroes the first few blocks of a device."
25995 #: ../fish/guestfish-actions.pod:4770
26000 #: ../fish/guestfish-actions.pod:4772
26003 " zerofree device\n"
26008 #: ../fish/guestfish-actions.pod:4785
26013 #: ../fish/guestfish-actions.pod:4787
26016 " zfgrep pattern path\n"
26021 #: ../fish/guestfish-actions.pod:4795
26026 #: ../fish/guestfish-actions.pod:4797
26029 " zfgrepi pattern path\n"
26034 #: ../fish/guestfish-actions.pod:4805
26039 #: ../fish/guestfish-actions.pod:4807
26042 " zfile meth path\n"
26047 #: ../fish/guestfish-actions.pod:4814
26048 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
26052 #: ../fish/guestfish-actions.pod:4824
26057 #: ../fish/guestfish-actions.pod:4826
26060 " zgrep regex path\n"
26065 #: ../fish/guestfish-actions.pod:4834
26070 #: ../fish/guestfish-actions.pod:4836
26073 " zgrepi regex path\n"
26078 #: ../fish/guestfish-commands.pod:1
26083 #: ../fish/guestfish-commands.pod:3
26088 #: ../fish/guestfish-commands.pod:5
26091 " alloc filename size\n"
26096 #: ../fish/guestfish-commands.pod:7
26098 "This creates an empty (zeroed) file of the given size, and then adds so it "
26099 "can be further examined."
26103 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
26104 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
26108 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
26109 msgid "Size can be specified using standard suffixes, eg. C<1M>."
26113 #: ../fish/guestfish-commands.pod:14
26115 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
26116 "image, see L</PREPARED DISK IMAGES>."
26120 #: ../fish/guestfish-commands.pod:17
26125 #: ../fish/guestfish-commands.pod:19
26128 " copy-in local [local ...] /remotedir\n"
26133 #: ../fish/guestfish-commands.pod:21
26135 "C<copy-in> copies local files or directories recursively into the disk "
26136 "image, placing them in the directory called C</remotedir> (which must "
26137 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
26138 "other commands as necessary."
26142 #: ../fish/guestfish-commands.pod:26
26144 "Multiple local files and directories can be specified, but the last "
26145 "parameter must always be a remote directory. Wildcards cannot be used."
26149 #: ../fish/guestfish-commands.pod:30
26154 #: ../fish/guestfish-commands.pod:32
26157 " copy-out remote [remote ...] localdir\n"
26162 #: ../fish/guestfish-commands.pod:34
26164 "C<copy-out> copies remote files or directories recursively out of the disk "
26165 "image, placing them on the host disk in a local directory called C<localdir> "
26166 "(which must exist). This guestfish meta-command turns into a sequence of "
26167 "L</download>, L</tar-out> and other commands as necessary."
26171 #: ../fish/guestfish-commands.pod:40
26173 "Multiple remote files and directories can be specified, but the last "
26174 "parameter must always be a local directory. To download to the current "
26175 "directory, use C<.> as in:"
26179 #: ../fish/guestfish-commands.pod:44
26182 " copy-out /home .\n"
26187 #: ../fish/guestfish-commands.pod:46
26189 "Wildcards cannot be used in the ordinary command, but you can use them with "
26190 "the help of L</glob> like this:"
26194 #: ../fish/guestfish-commands.pod:49
26197 " glob copy-out /home/* .\n"
26202 #: ../fish/guestfish-commands.pod:51
26207 #: ../fish/guestfish-commands.pod:53
26210 " echo [params ...]\n"
26215 #: ../fish/guestfish-commands.pod:55
26216 msgid "This echos the parameters to the terminal."
26220 #: ../fish/guestfish-commands.pod:57
26225 #: ../fish/guestfish-commands.pod:59
26230 #: ../fish/guestfish-commands.pod:61
26235 #: ../fish/guestfish-commands.pod:63
26243 #: ../fish/guestfish-commands.pod:65
26245 "This is used to edit a file. It downloads the file, edits it locally using "
26246 "your editor, then uploads the result."
26250 #: ../fish/guestfish-commands.pod:68
26252 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
26253 "or C<emacs> you will get those corresponding editors."
26257 #: ../fish/guestfish-commands.pod:72
26262 #: ../fish/guestfish-commands.pod:74
26265 " glob command args...\n"
26270 #: ../fish/guestfish-commands.pod:76
26272 "Expand wildcards in any paths in the args list, and run C<command> "
26273 "repeatedly on each matching path."
26277 #: ../fish/guestfish-commands.pod:79
26278 msgid "See L</WILDCARDS AND GLOBBING>."
26282 #: ../fish/guestfish-commands.pod:81
26287 #: ../fish/guestfish-commands.pod:83
26290 " hexedit <filename|device>\n"
26291 " hexedit <filename|device> <max>\n"
26292 " hexedit <filename|device> <start> <max>\n"
26297 #: ../fish/guestfish-commands.pod:87
26299 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
26304 #: ../fish/guestfish-commands.pod:90
26306 "This command works by downloading potentially the whole file or device, "
26307 "editing it locally, then uploading it. If the file or device is large, you "
26308 "have to specify which part you wish to edit by using C<max> and/or C<start> "
26309 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
26310 "usual modifiers allowed such as C<1M> (1 megabyte)."
26314 #: ../fish/guestfish-commands.pod:97
26315 msgid "For example to edit the first few sectors of a disk you might do:"
26319 #: ../fish/guestfish-commands.pod:100
26322 " hexedit /dev/sda 1M\n"
26327 #: ../fish/guestfish-commands.pod:102
26329 "which would allow you to edit anywhere within the first megabyte of the "
26334 #: ../fish/guestfish-commands.pod:105
26335 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
26339 #: ../fish/guestfish-commands.pod:107
26342 " hexedit /dev/sda1 0x400 0x400\n"
26347 #: ../fish/guestfish-commands.pod:109
26348 msgid "(assuming the superblock is in the standard location)."
26352 #: ../fish/guestfish-commands.pod:111
26354 "This command requires the external L<hexedit(1)> program. You can specify "
26355 "another program to use by setting the C<HEXEDITOR> environment variable."
26359 #: ../fish/guestfish-commands.pod:115
26360 msgid "See also L</hexdump>."
26364 #: ../fish/guestfish-commands.pod:117
26369 #: ../fish/guestfish-commands.pod:119
26377 #: ../fish/guestfish-commands.pod:121
26378 msgid "Change the local directory, ie. the current directory of guestfish itself."
26382 #: ../fish/guestfish-commands.pod:124
26383 msgid "Note that C<!cd> won't do what you might expect."
26387 #: ../fish/guestfish-commands.pod:126
26392 #: ../fish/guestfish-commands.pod:128
26397 #: ../fish/guestfish-commands.pod:130
26405 #: ../fish/guestfish-commands.pod:132
26406 msgid "Opens the manual page for guestfish."
26410 #: ../fish/guestfish-commands.pod:134
26415 #: ../fish/guestfish-commands.pod:136
26420 #: ../fish/guestfish-commands.pod:138
26428 #: ../fish/guestfish-commands.pod:140
26436 #: ../fish/guestfish-commands.pod:142
26437 msgid "This is used to view a file."
26441 #: ../fish/guestfish-commands.pod:144
26443 "The default viewer is C<$PAGER>. However if you use the alternate command "
26444 "C<less> you will get the C<less> command specifically."
26448 #: ../fish/guestfish-commands.pod:147
26453 #: ../fish/guestfish-commands.pod:149
26461 #: ../fish/guestfish-commands.pod:151
26463 "Close and reopen the libguestfs handle. It is not necessary to use this "
26464 "normally, because the handle is closed properly when guestfish exits. "
26465 "However this is occasionally useful for testing."
26469 #: ../fish/guestfish-commands.pod:155
26474 #: ../fish/guestfish-commands.pod:157
26477 " sparse filename size\n"
26482 #: ../fish/guestfish-commands.pod:159
26484 "This creates an empty sparse file of the given size, and then adds so it can "
26485 "be further examined."
26489 #: ../fish/guestfish-commands.pod:162
26491 "In all respects it works the same as the L</alloc> command, except that the "
26492 "image file is allocated sparsely, which means that disk blocks are not "
26493 "assigned to the file until they are needed. Sparse disk files only use "
26494 "space when written to, but they are slower and there is a danger you could "
26495 "run out of real disk space during a write operation."
26499 #: ../fish/guestfish-commands.pod:172
26504 #: ../fish/guestfish-commands.pod:174
26512 #: ../fish/guestfish-commands.pod:176
26514 "This command returns a list of the optional groups known to the daemon, and "
26515 "indicates which ones are supported by this build of the libguestfs "
26520 #: ../fish/guestfish-commands.pod:180
26521 msgid "See also L<guestfs(3)/AVAILABILITY>."
26525 #: ../fish/guestfish-commands.pod:182
26530 #: ../fish/guestfish-commands.pod:184
26533 " time command args...\n"
26538 #: ../fish/guestfish-commands.pod:186
26540 "Run the command as usual, but print the elapsed time afterwards. This can "
26541 "be useful for benchmarking operations."
26545 #: ../test-tool/libguestfs-test-tool.pod:5
26546 msgid "libguestfs-test-tool - End user tests for libguestfs"
26550 #: ../test-tool/libguestfs-test-tool.pod:9
26553 " libguestfs-test-tool [--options]\n"
26558 #: ../test-tool/libguestfs-test-tool.pod:13
26560 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
26561 "and developers, to allow them to check basic libguestfs functionality is "
26562 "working. This is needed because libguestfs occasionally breaks for reasons "
26563 "beyond our control: usually because of changes in the underlying qemu or "
26564 "kernel packages, or the host environment."
26568 #: ../test-tool/libguestfs-test-tool.pod:20
26569 msgid "If you suspect a problem in libguestfs, then just run:"
26573 #: ../test-tool/libguestfs-test-tool.pod:22
26576 " libguestfs-test-tool\n"
26581 #: ../test-tool/libguestfs-test-tool.pod:24
26582 msgid "It will print lots of diagnostic messages."
26586 #: ../test-tool/libguestfs-test-tool.pod:26
26587 msgid "If it runs to completion successfully, you will see this near the end:"
26591 #: ../test-tool/libguestfs-test-tool.pod:28
26594 " ===== TEST FINISHED OK =====\n"
26599 #: ../test-tool/libguestfs-test-tool.pod:30
26600 msgid "and the test tool will exit with code 0."
26604 #: ../test-tool/libguestfs-test-tool.pod:32
26606 "If it fails (and/or exits with non-zero error code), please paste the "
26607 "B<complete, unedited> output of the test tool into a bug report. More "
26608 "information about reporting bugs can be found on the "
26609 "L<http://libguestfs.org/> website."
26613 #: ../test-tool/libguestfs-test-tool.pod:41
26618 #: ../test-tool/libguestfs-test-tool.pod:43
26619 msgid "Display short usage information and exit."
26623 #: ../test-tool/libguestfs-test-tool.pod:45
26624 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
26628 #: ../test-tool/libguestfs-test-tool.pod:47
26630 "Pass an alternate name for the helper program. libguestfs-test-tool will "
26631 "normally look in the C<$libexec> directory that was configured when the tool "
26636 #: ../test-tool/libguestfs-test-tool.pod:51
26637 msgid "I<--qemu qemu_binary>"
26641 #: ../test-tool/libguestfs-test-tool.pod:53
26643 "If you have downloaded another qemu binary, point this option at the full "
26644 "path of the binary to try it."
26648 #: ../test-tool/libguestfs-test-tool.pod:56
26649 msgid "I<--qemudir qemu_source_dir>"
26653 #: ../test-tool/libguestfs-test-tool.pod:58
26655 "If you have compiled qemu from source, point this option at the source "
26656 "directory to try it."
26660 #: ../test-tool/libguestfs-test-tool.pod:61
26661 msgid "I<--timeout N>"
26665 #: ../test-tool/libguestfs-test-tool.pod:63
26667 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
26668 "does not usually need to be adjusted unless your machine is very slow."
26672 #: ../test-tool/libguestfs-test-tool.pod:69
26673 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
26677 #: ../test-tool/libguestfs-test-tool.pod:71
26679 "If you have compiled another version of qemu from source and would like to "
26680 "try that, then you can use the I<--qemudir> option to point to the qemu "
26681 "source directory."
26685 #: ../test-tool/libguestfs-test-tool.pod:75
26687 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
26688 "option to point to the binary."
26692 #: ../test-tool/libguestfs-test-tool.pod:78
26694 "When using an alternate qemu with libguestfs, usually you would need to "
26695 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
26696 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
26697 "when you use either of the I<--qemudir> or I<--qemu> options."
26701 #: ../test-tool/libguestfs-test-tool.pod:85
26703 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
26704 "I<1> if there was an error."
26708 #: ../test-tool/libguestfs-test-tool.pod:92
26709 msgid "/usr/libexec/libguestfs-test-tool-helper"
26713 #: ../test-tool/libguestfs-test-tool.pod:94
26715 "This helper program is run inside the appliance and provides additional "
26720 #: ../test-tool/libguestfs-test-tool.pod:97
26721 msgid "/usr/bin/mkisofs"
26725 #: ../test-tool/libguestfs-test-tool.pod:99
26727 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
26728 "which is used as part of the tests."
26732 #: ../test-tool/libguestfs-test-tool.pod:106
26734 "For the full list of environment variables which may affect libguestfs, "
26735 "please see the L<guestfs(3)> manual page."
26739 #: ../test-tool/libguestfs-test-tool.pod:111
26740 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
26744 #: ../test-tool/libguestfs-test-tool.pod:121
26745 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
26749 #: ../fuse/guestmount.pod:5
26750 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
26754 #: ../fuse/guestmount.pod:9
26757 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
26762 #: ../fuse/guestmount.pod:11
26765 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
26770 #: ../fuse/guestmount.pod:13
26773 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
26778 #: ../fuse/guestmount.pod:17
26780 "You must I<not> use C<guestmount> in read-write mode on live virtual "
26781 "machines. If you do this, you risk disk corruption in the VM."
26785 #: ../fuse/guestmount.pod:22
26787 "The guestmount program can be used to mount virtual machine filesystems and "
26788 "other disk images on the host. It uses libguestfs for access to the guest "
26789 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
26790 "a mountable device."
26794 #: ../fuse/guestmount.pod:27
26796 "Along with other options, you have to give at least one device (I<-a> "
26797 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
26798 "option) or use the I<-i> inspection option. How this works is better "
26799 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
26804 #: ../fuse/guestmount.pod:33
26806 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
26807 "by you, and the filesystem will not be visible to any other users unless you "
26808 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
26809 "the filesystem, use the C<fusermount -u> command."
26813 #: ../fuse/guestmount.pod:41
26815 "For a typical Windows guest which has its main filesystem on the first "
26820 #: ../fuse/guestmount.pod:44
26823 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
26828 #: ../fuse/guestmount.pod:46
26830 "For a typical Linux guest which has a /boot filesystem on the first "
26831 "partition, and the root filesystem on a logical volume:"
26835 #: ../fuse/guestmount.pod:49
26838 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
26843 #: ../fuse/guestmount.pod:51
26844 msgid "To get libguestfs to detect guest mountpoints for you:"
26848 #: ../fuse/guestmount.pod:53
26851 " guestmount -a guest.img -i --ro /mnt\n"
26856 #: ../fuse/guestmount.pod:55
26857 msgid "For a libvirt guest called \"Guest\" you could do:"
26861 #: ../fuse/guestmount.pod:57
26864 " guestmount -d Guest -i --ro /mnt\n"
26869 #: ../fuse/guestmount.pod:59
26871 "If you don't know what filesystems are contained in a guest or disk image, "
26872 "use L<virt-filesystems(1)> first:"
26876 #: ../fuse/guestmount.pod:62
26879 " virt-filesystems MyGuest\n"
26884 #: ../fuse/guestmount.pod:64
26886 "If you want to trace the libguestfs calls but without excessive debugging "
26887 "information, we recommend:"
26891 #: ../fuse/guestmount.pod:67
26894 " guestmount [...] --trace /mnt\n"
26899 #: ../fuse/guestmount.pod:69
26900 msgid "If you want to debug the program, we recommend:"
26904 #: ../fuse/guestmount.pod:71
26907 " guestmount [...] --trace --verbose /mnt\n"
26912 #: ../fuse/guestmount.pod:77
26913 msgid "B<-a image> | B<--add image>"
26917 #: ../fuse/guestmount.pod:79
26918 msgid "Add a block device or virtual machine image."
26922 #: ../fuse/guestmount.pod:84
26923 msgid "B<-c URI> | B<--connect URI>"
26927 #: ../fuse/guestmount.pod:90
26928 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
26932 #: ../fuse/guestmount.pod:96
26933 msgid "B<--dir-cache-timeout N>"
26937 #: ../fuse/guestmount.pod:98
26939 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
26940 "seconds. The readdir cache [actually, there are several semi-independent "
26941 "caches] is populated after a readdir(2) call with the stat and extended "
26942 "attributes of the files in the directory, in anticipation that they will be "
26943 "requested soon after."
26947 #: ../fuse/guestmount.pod:104
26949 "There is also a different attribute cache implemented by FUSE (see the FUSE "
26950 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
26951 "requests, only cache existing ones."
26955 #: ../fuse/guestmount.pod:115
26956 msgid "B<--format=raw|qcow2|..> | B<--format>"
26960 #: ../fuse/guestmount.pod:122
26962 "If you have untrusted raw-format guest disk images, you should use this "
26963 "option to specify the disk format. This avoids a possible security problem "
26964 "with malicious guests (CVE-2010-3851). See also "
26965 "L<guestfs(3)/guestfs_add_drive_opts>."
26969 #: ../fuse/guestmount.pod:127
26970 msgid "B<--fuse-help>"
26974 #: ../fuse/guestmount.pod:129
26975 msgid "Display help on special FUSE options (see I<-o> below)."
26979 #: ../fuse/guestmount.pod:133
26980 msgid "Display brief help and exit."
26984 #: ../fuse/guestmount.pod:135
26985 msgid "B<-i> | B<--inspector>"
26989 #: ../fuse/guestmount.pod:146
26990 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
26994 #: ../fuse/guestmount.pod:148
26996 "Mount the named partition or logical volume on the given mountpoint B<in the "
26997 "guest> (this has nothing to do with mountpoints in the host)."
27001 #: ../fuse/guestmount.pod:151
27003 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
27004 "something on C</>."
27008 #: ../fuse/guestmount.pod:154
27009 msgid "B<-n> | B<--no-sync>"
27013 #: ../fuse/guestmount.pod:156
27015 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
27016 "unmounted. If you specify this option, then we don't attempt to sync the "
27017 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
27021 #: ../fuse/guestmount.pod:161
27022 msgid "B<-o option> | B<--option option>"
27026 #: ../fuse/guestmount.pod:163
27027 msgid "Pass extra options to FUSE."
27031 #: ../fuse/guestmount.pod:165
27033 "To get a list of all the extra options supported by FUSE, use the command "
27034 "below. Note that only the FUSE I<-o> options can be passed, and only some "
27035 "of them are a good idea."
27039 #: ../fuse/guestmount.pod:169
27042 " guestmount --fuse-help\n"
27047 #: ../fuse/guestmount.pod:171
27048 msgid "Some potentially useful FUSE options:"
27052 #: ../fuse/guestmount.pod:175
27053 msgid "B<-o allow_other>"
27057 #: ../fuse/guestmount.pod:177
27058 msgid "Allow other users to see the filesystem."
27062 #: ../fuse/guestmount.pod:179
27063 msgid "B<-o attr_timeout=N>"
27067 #: ../fuse/guestmount.pod:181
27068 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
27072 #: ../fuse/guestmount.pod:183
27073 msgid "B<-o kernel_cache>"
27077 #: ../fuse/guestmount.pod:185
27079 "Allow the kernel to cache files (reduces the number of reads that have to go "
27080 "through the L<guestfs(3)> API). This is generally a good idea if you can "
27081 "afford the extra memory usage."
27085 #: ../fuse/guestmount.pod:189
27086 msgid "B<-o uid=N> B<-o gid=N>"
27090 #: ../fuse/guestmount.pod:191
27092 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
27093 "the chosen values."
27097 #: ../fuse/guestmount.pod:196
27098 msgid "B<-r> | B<--ro>"
27102 #: ../fuse/guestmount.pod:198
27104 "Add devices and mount everything read-only. Also disallow writes and make "
27105 "the disk appear read-only to FUSE."
27109 #: ../fuse/guestmount.pod:201
27111 "This is highly recommended if you are not going to edit the guest disk. If "
27112 "the guest is running and this option is I<not> supplied, then there is a "
27113 "strong risk of disk corruption in the guest. We try to prevent this from "
27114 "happening, but it is not always possible."
27118 #: ../fuse/guestmount.pod:206
27119 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
27123 #: ../fuse/guestmount.pod:210
27124 msgid "Enable SELinux support for the guest."
27128 #: ../fuse/guestmount.pod:212
27129 msgid "B<-v> | B<--verbose>"
27133 #: ../fuse/guestmount.pod:214
27134 msgid "Enable verbose messages from underlying libguestfs."
27138 #: ../fuse/guestmount.pod:216
27139 msgid "B<-V> | B<--version>"
27143 #: ../fuse/guestmount.pod:218
27144 msgid "Display the program version and exit."
27148 #: ../fuse/guestmount.pod:220
27149 msgid "B<-w> | B<--rw>"
27153 #: ../fuse/guestmount.pod:222
27155 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
27156 "FOR READ AND WRITE>."
27160 #: ../fuse/guestmount.pod:225
27161 msgid "B<-x> | B<--trace>"
27165 #: ../fuse/guestmount.pod:227
27166 msgid "Trace libguestfs calls and entry into each FUSE function."
27170 #: ../fuse/guestmount.pod:229
27171 msgid "This also stops the daemon from forking into the background."
27175 #: ../fuse/guestmount.pod:235
27177 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
27178 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
27179 "L<http://fuse.sf.net/>."
27183 #: ../tools/virt-edit.pl:34
27184 msgid "virt-edit - Edit a file in a virtual machine"
27188 #: ../tools/virt-edit.pl:38
27191 " virt-edit [--options] domname file\n"
27196 #: ../tools/virt-edit.pl:40
27199 " virt-edit [--options] disk.img [disk.img ...] file\n"
27204 #: ../tools/virt-edit.pl:42
27207 " virt-edit [domname|disk.img] file -e 'expr'\n"
27212 #: ../tools/virt-edit.pl:46
27214 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
27215 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
27216 "doing this, but doesn't catch all cases."
27220 #: ../tools/virt-edit.pl:52
27222 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
27223 "the named virtual machine (or disk image)."
27227 #: ../tools/virt-edit.pl:55
27229 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
27230 "you should look at the L<guestfish(1)> tool."
27234 #: ../tools/virt-edit.pl:60
27235 msgid "Edit the named files interactively:"
27239 #: ../tools/virt-edit.pl:62
27242 " virt-edit mydomain /boot/grub/grub.conf\n"
27247 #: ../tools/virt-edit.pl:64
27250 " virt-edit mydomain /etc/passwd\n"
27255 #: ../tools/virt-edit.pl:66
27257 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
27258 "below). To change the init default level to 5:"
27262 #: ../tools/virt-edit.pl:70
27265 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
27270 #: ../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
27271 msgid "Display brief help."
27275 #: ../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
27276 msgid "Display version number and exit."
27280 #: ../tools/virt-edit.pl:96
27281 msgid "B<--backup extension> | B<-b extension>"
27285 #: ../tools/virt-edit.pl:98
27287 "Create a backup of the original file I<in the guest disk image>. The backup "
27288 "has the original filename with C<extension> added."
27292 #: ../tools/virt-edit.pl:101
27294 "Usually the first character of C<extension> would be a dot C<.> so you would "
27299 #: ../tools/virt-edit.pl:104
27302 " virt-edit -b .orig [etc]\n"
27307 #: ../tools/virt-edit.pl:106
27308 msgid "By default, no backup file is made."
27312 #: ../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
27313 msgid "B<--connect URI> | B<-c URI>"
27317 #: ../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
27319 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
27320 "to the default libvirt hypervisor."
27324 #: ../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
27326 "If you specify guest block devices directly, then libvirt is not used at "
27331 #: ../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
27332 msgid "B<--format> raw"
27336 #: ../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
27338 "Specify the format of disk images given on the command line. If this is "
27339 "omitted then the format is autodetected from the content of the disk image."
27343 #: ../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
27345 "If disk images are requested from libvirt, then this program asks libvirt "
27346 "for this information. In this case, the value of the format parameter is "
27351 #: ../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
27353 "If working with untrusted raw-format guest disk images, you should ensure "
27354 "the format is always specified."
27358 #: ../tools/virt-edit.pl:141
27359 msgid "B<--expr EXPR> | B<-e EXPR>"
27363 #: ../tools/virt-edit.pl:143
27365 "Instead of launching the external editor, non-interactively apply the Perl "
27366 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
27371 #: ../tools/virt-edit.pl:147
27373 "Be careful to properly quote the expression to prevent it from being altered "
27378 #: ../tools/virt-edit.pl:268
27379 msgid "NON-INTERACTIVE EDITING"
27383 #: ../tools/virt-edit.pl:270
27385 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
27386 "administrator can interactively edit the file."
27390 #: ../tools/virt-edit.pl:273
27392 "There are two ways also to use C<virt-edit> from scripts in order to make "
27393 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
27394 "like this, it's less error-prone to write scripts directly using the "
27395 "libguestfs API and Augeas for configuration file editing.)"
27399 #: ../tools/virt-edit.pl:279
27401 "The first method is to temporarily set C<$EDITOR> to any script or program "
27402 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
27403 "update C<tmpfile> in place however it likes."
27407 #: ../tools/virt-edit.pl:283
27409 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
27410 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
27411 "instances of C<foo> with C<bar> in a file:"
27415 #: ../tools/virt-edit.pl:287
27418 " virt-edit domname filename -e 's/foo/bar/'\n"
27423 #: ../tools/virt-edit.pl:289
27425 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
27426 "For example to delete root's password you could do:"
27430 #: ../tools/virt-edit.pl:292
27433 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
27438 #: ../tools/virt-edit.pl:294
27440 "What really happens is that the snippet is evaluated as a Perl expression "
27441 "for each line of the file. The line, including the final C<\\n>, is passed "
27442 "in C<$_> and the expression should update C<$_> or leave it unchanged."
27446 #: ../tools/virt-edit.pl:299
27448 "To delete a line, set C<$_> to the empty string. For example, to delete the "
27449 "C<apache> user account from the password file you can do:"
27453 #: ../tools/virt-edit.pl:302
27456 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
27461 #: ../tools/virt-edit.pl:304
27463 "To insert a line, prepend or append it to C<$_>. However appending lines to "
27464 "the end of the file is rather difficult this way since there is no concept "
27465 "of \"last line of the file\" - your expression just doesn't get called "
27466 "again. You might want to use the first method (setting C<$EDITOR>) if you "
27471 #: ../tools/virt-edit.pl:310
27473 "The variable C<$lineno> contains the current line number. As is "
27474 "traditional, the first line in the file is number C<1>."
27478 #: ../tools/virt-edit.pl:313
27480 "The return value from the expression is ignored, but the expression may call "
27481 "C<die> in order to abort the whole program, leaving the original file "
27486 #: ../tools/virt-edit.pl:317
27488 "Remember when matching the end of a line that C<$_> may contain the final "
27489 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
27490 "newline then neither of these. Thus to match or substitute some text at the "
27491 "end of a line, use this regular expression:"
27495 #: ../tools/virt-edit.pl:322
27498 " /some text(\\r?\\n)?$/\n"
27503 #: ../tools/virt-edit.pl:324
27505 "Alternately, use the perl C<chomp> function, being careful not to chomp "
27506 "C<$_> itself (since that would remove all newlines from the file):"
27510 #: ../tools/virt-edit.pl:328
27513 " my $m = $_; chomp $m; $m =~ /some text$/\n"
27518 #: ../tools/virt-edit.pl:334
27523 #: ../tools/virt-edit.pl:336
27525 "If set, this string is used as the editor. It may contain arguments, "
27526 "eg. C<\"emacs -nw\">"
27530 #: ../tools/virt-edit.pl:339
27531 msgid "If not set, C<vi> is used."
27535 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559 ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
27536 msgid "SHELL QUOTING"
27540 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567 ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:252
27542 "Libvirt guest names can contain arbitrary characters, some of which have "
27543 "meaning to the shell such as C<#> and space. You may need to quote or "
27544 "escape these characters on the command line. See the shell manual page "
27545 "L<sh(1)> for details."
27549 #: ../tools/virt-edit.pl:352
27551 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
27552 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27553 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
27557 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:598 ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:269
27562 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:600 ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:271
27563 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
27567 #: ../tools/virt-edit.pl:370 ../tools/virt-list-partitions.pl:275
27568 msgid "Copyright (C) 2009-2010 Red Hat Inc."
27572 #: ../tools/virt-win-reg.pl:37
27574 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
27579 #: ../tools/virt-win-reg.pl:41
27582 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
27587 #: ../tools/virt-win-reg.pl:43
27590 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
27595 #: ../tools/virt-win-reg.pl:45
27598 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
27603 #: ../tools/virt-win-reg.pl:47
27606 " virt-win-reg --merge domname [input.reg ...]\n"
27611 #: ../tools/virt-win-reg.pl:49
27614 " virt-win-reg [--options] disk.img ... # instead of domname\n"
27619 #: ../tools/virt-win-reg.pl:53
27621 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
27622 "virtual machines. If you do this, you I<will> get irreversible disk "
27623 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
27624 "but doesn't catch all cases."
27628 #: ../tools/virt-win-reg.pl:58
27630 "Modifying the Windows Registry is an inherently risky operation. The format "
27631 "is deliberately obscure and undocumented, and Registry changes can leave the "
27632 "system unbootable. Therefore when using the C<--merge> option, make sure "
27633 "you have a reliable backup first."
27637 #: ../tools/virt-win-reg.pl:65
27639 "This program can export and merge Windows Registry entries from a Windows "
27644 #: ../tools/virt-win-reg.pl:68
27646 "The first parameter is the libvirt guest name or the raw disk image of a "
27651 #: ../tools/virt-win-reg.pl:71
27653 "If C<--merge> is I<not> specified, then the chosen registry key is "
27654 "displayed/exported (recursively). For example:"
27658 #: ../tools/virt-win-reg.pl:74
27661 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
27666 #: ../tools/virt-win-reg.pl:76
27667 msgid "You can also display single values from within registry keys, for example:"
27671 #: ../tools/virt-win-reg.pl:79
27674 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
27675 " $ virt-win-reg Windows7 $cvkey ProductName\n"
27676 " Windows 7 Enterprise\n"
27681 #: ../tools/virt-win-reg.pl:83
27683 "With C<--merge>, you can merge a textual regedit file into the Windows "
27688 #: ../tools/virt-win-reg.pl:86
27691 " $ virt-win-reg --merge Windows7 changes.reg\n"
27696 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
27701 #: ../tools/virt-win-reg.pl:90
27703 "This program is only meant for simple access to the registry. If you want "
27704 "to do complicated things with the registry, we suggest you download the "
27705 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27706 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27707 "L<hivexregedit(1)>."
27711 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
27716 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
27717 msgid "Enable debugging messages."
27721 #: ../tools/virt-win-reg.pl:157
27726 #: ../tools/virt-win-reg.pl:159
27728 "In merge mode, this merges a textual regedit file into the Windows Registry "
27729 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27730 "displays or exports Registry entries instead."
27734 #: ../tools/virt-win-reg.pl:163
27736 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27737 "result in disk corruption. However exporting (without this flag) is always "
27742 #: ../tools/virt-win-reg.pl:171
27743 msgid "B<--encoding> UTF-16LE|ASCII"
27747 #: ../tools/virt-win-reg.pl:173
27749 "When merging (only), you may need to specify the encoding for strings to be "
27750 "used in the hive file. This is explained in detail in "
27751 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
27755 #: ../tools/virt-win-reg.pl:177
27757 "The default is to use UTF-16LE, which should work with recent versions of "
27762 #: ../tools/virt-win-reg.pl:402
27763 msgid "SUPPORTED SYSTEMS"
27767 #: ../tools/virt-win-reg.pl:404
27769 "The program currently supports Windows NT-derived guests starting with "
27770 "Windows XP through to at least Windows 7."
27774 #: ../tools/virt-win-reg.pl:407
27776 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
27777 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
27778 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
27782 #: ../tools/virt-win-reg.pl:411
27784 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
27789 #: ../tools/virt-win-reg.pl:414
27791 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
27796 #: ../tools/virt-win-reg.pl:417
27801 #: ../tools/virt-win-reg.pl:419
27803 "C<virt-win-reg> expects that regedit files have already been reencoded in "
27804 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
27805 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
27806 "with Windows-style line endings, you may need to reencode the whole file "
27807 "before or after processing."
27811 #: ../tools/virt-win-reg.pl:425
27813 "To reencode a file from Windows format to Linux (before processing it with "
27814 "the C<--merge> option), you would do something like this:"
27818 #: ../tools/virt-win-reg.pl:428
27821 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
27826 #: ../tools/virt-win-reg.pl:430
27828 "To go in the opposite direction, after exporting and before sending the file "
27829 "to a Windows user, do something like this:"
27833 #: ../tools/virt-win-reg.pl:433
27836 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
27841 #: ../tools/virt-win-reg.pl:435
27842 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
27846 #: ../tools/virt-win-reg.pl:437
27848 "If you are unsure about the current encoding, use the L<file(1)> command. "
27849 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
27850 "Windows-style (CRLF) line endings, like this:"
27854 #: ../tools/virt-win-reg.pl:441
27857 " $ file software.reg\n"
27858 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
27859 " with CRLF line terminators\n"
27864 #: ../tools/virt-win-reg.pl:445
27865 msgid "This file would need conversion before you could C<--merge> it."
27869 #: ../tools/virt-win-reg.pl:447
27870 msgid "CurrentControlSet etc."
27874 #: ../tools/virt-win-reg.pl:449
27876 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
27877 "Registry at the level of the hive file, and therefore you cannot modify "
27882 #: ../tools/virt-win-reg.pl:453
27884 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
27885 "circumstances it might refer to another control set. The way to find out is "
27886 "to look at the C<HKLM\\SYSTEM\\Select> key:"
27890 #: ../tools/virt-win-reg.pl:457
27893 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
27894 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
27895 " \"Current\"=dword:00000001\n"
27896 " \"Default\"=dword:00000001\n"
27897 " \"Failed\"=dword:00000000\n"
27898 " \"LastKnownGood\"=dword:00000002\n"
27903 #: ../tools/virt-win-reg.pl:464
27904 msgid "\"Current\" is the one which Windows will choose when it boots."
27908 #: ../tools/virt-win-reg.pl:466
27909 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
27913 #: ../tools/virt-win-reg.pl:469
27914 msgid "WINDOWS TIPS"
27918 #: ../tools/virt-win-reg.pl:471
27920 "Note that some of these tips modify the guest disk image. The guest I<must> "
27921 "be shut off, else you will get disk corruption."
27925 #: ../tools/virt-win-reg.pl:474
27926 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
27930 #: ../tools/virt-win-reg.pl:476
27932 "Prepare a DOS batch script, VBScript or executable. Upload this using "
27933 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
27934 "is uploaded into C<C:\\>:"
27938 #: ../tools/virt-win-reg.pl:480
27941 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
27946 #: ../tools/virt-win-reg.pl:482
27947 msgid "Prepare a regedit file containing the registry change:"
27951 #: ../tools/virt-win-reg.pl:484
27954 " cat > test.reg <<'EOF'\n"
27955 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
27956 " \"Test\"=\"c:\\\\test.bat\"\n"
27962 #: ../tools/virt-win-reg.pl:489
27964 "In this example we use the key C<RunOnce> which means that the script will "
27965 "run precisely once when the first user logs in. If you want it to run every "
27966 "time a user logs in, replace C<RunOnce> with C<Run>."
27970 #: ../tools/virt-win-reg.pl:493
27971 msgid "Now update the registry:"
27975 #: ../tools/virt-win-reg.pl:495
27978 " virt-win-reg --merge WindowsGuest test.reg\n"
27983 #: ../tools/virt-win-reg.pl:497
27984 msgid "INSTALLING A SERVICE"
27988 #: ../tools/virt-win-reg.pl:499
27990 "This section assumes you are familiar with Windows services, and you either "
27991 "have a program which handles the Windows Service Control Protocol directly "
27992 "or you want to run any program using a service wrapper like SrvAny or the "
27997 #: ../tools/virt-win-reg.pl:504
27999 "First upload the program and optionally the service wrapper. In this case "
28000 "the test program is called C<test.exe> and we are using the RHSrvAny "
28005 #: ../tools/virt-win-reg.pl:508
28008 " guestfish -i -d WindowsGuest <<EOF\n"
28009 " upload rhsrvany.exe /rhsrvany.exe\n"
28010 " upload test.exe /test.exe\n"
28016 #: ../tools/virt-win-reg.pl:513
28018 "Prepare a regedit file containing the registry changes. In this example, "
28019 "the first registry change is needed for the service itself or the service "
28020 "wrapper (if used). The second registry change is only needed because I am "
28021 "using the RHSrvAny service wrapper."
28025 #: ../tools/virt-win-reg.pl:518
28028 " cat > service.reg <<'EOF'\n"
28029 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
28030 " \"Type\"=dword:00000010\n"
28031 " \"Start\"=dword:00000002\n"
28032 " \"ErrorControl\"=dword:00000001\n"
28033 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
28034 " \"DisplayName\"=\"RHSrvAny\"\n"
28035 " \"ObjectName\"=\"NetworkService\"\n"
28040 #: ../tools/virt-win-reg.pl:527
28043 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
28044 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
28045 " \"PWD\"=\"c:\\\\Temp\"\n"
28051 #: ../tools/virt-win-reg.pl:538
28053 "For use of C<ControlSet001> see the section above in this manual page. You "
28054 "may need to adjust this according to the control set that is in use by the "
28059 #: ../tools/virt-win-reg.pl:544
28061 "C<\"ObjectName\"> controls the privileges that the service will have. An "
28062 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
28063 "privileged account."
28067 #: ../tools/virt-win-reg.pl:550
28069 "For the meaning of the magic numbers, see this Microsoft KB article: "
28070 "L<http://support.microsoft.com/kb/103000>."
28074 #: ../tools/virt-win-reg.pl:555
28075 msgid "Update the registry:"
28079 #: ../tools/virt-win-reg.pl:557
28082 " virt-win-reg --merge WindowsGuest service.reg\n"
28087 #: ../tools/virt-win-reg.pl:561
28089 "Be careful when passing parameters containing C<\\> (backslash) in the "
28090 "shell. Usually you will have to use 'single quotes' or double backslashes "
28091 "(but not both) to protect them from the shell."
28095 #: ../tools/virt-win-reg.pl:565
28096 msgid "Paths and value names are case-insensitive."
28100 #: ../tools/virt-win-reg.pl:574
28102 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
28103 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
28104 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
28105 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28109 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:550
28111 "When reporting bugs, please enable debugging and capture the I<complete> "
28116 #: ../tools/virt-win-reg.pl:592
28119 " export LIBGUESTFS_DEBUG=1\n"
28120 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
28125 #: ../tools/virt-win-reg.pl:595
28127 "Attach /tmp/virt-win-reg.log to a new bug report at "
28128 "L<https://bugzilla.redhat.com/>"
28132 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:565
28133 msgid "Copyright (C) 2010 Red Hat Inc."
28137 #: ../tools/virt-resize.pl:42
28138 msgid "virt-resize - Resize a virtual machine disk"
28142 #: ../tools/virt-resize.pl:46
28145 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
28146 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
28147 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
28152 #: ../tools/virt-resize.pl:52
28154 "Virt-resize is a tool which can resize a virtual machine disk, making it "
28155 "larger or smaller overall, and resizing or deleting any partitions contained "
28160 #: ../tools/virt-resize.pl:56
28162 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
28163 "not> be used on live virtual machines - for consistent results, shut the "
28164 "virtual machine down before resizing it."
28168 #: ../tools/virt-resize.pl:60
28170 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
28171 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
28175 #: ../tools/virt-resize.pl:66
28177 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
28178 "fill the extra 5GB of space."
28182 #: ../tools/virt-resize.pl:69
28185 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
28186 " virt-filesystems --long -h --all -a olddisk\n"
28187 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
28188 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
28193 #: ../tools/virt-resize.pl:74
28195 "As above, but make the /boot partition 200MB bigger, while giving the "
28196 "remaining space to /dev/sda2:"
28200 #: ../tools/virt-resize.pl:77
28203 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
28208 #: ../tools/virt-resize.pl:79
28209 msgid "As above, but the output format will be uncompressed qcow2:"
28213 #: ../tools/virt-resize.pl:81
28216 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
28217 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
28222 #: ../tools/virt-resize.pl:84
28223 msgid "DETAILED USAGE"
28227 #: ../tools/virt-resize.pl:86
28228 msgid "EXPANDING A VIRTUAL MACHINE DISK"
28232 #: ../tools/virt-resize.pl:90
28233 msgid "1. Shut down the virtual machine"
28237 #: ../tools/virt-resize.pl:92
28238 msgid "2. Locate input disk image"
28242 #: ../tools/virt-resize.pl:94
28244 "Locate the input disk image (ie. the file or device on the host containing "
28245 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
28246 "dumpxml> like this to find the disk image name:"
28250 #: ../tools/virt-resize.pl:98
28253 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
28254 " Found 1 nodes:\n"
28256 " <source dev=\"/dev/vg/lv_guest\" />\n"
28261 #: ../tools/virt-resize.pl:103
28262 msgid "3. Look at current sizing"
28266 #: ../tools/virt-resize.pl:105
28267 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
28271 #: ../tools/virt-resize.pl:108
28274 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
28275 " Name Type Size Parent\n"
28276 " /dev/sda1 partition 101M /dev/sda\n"
28277 " /dev/sda2 partition 7.9G /dev/sda\n"
28278 " /dev/sda device 8.0G -\n"
28283 #: ../tools/virt-resize.pl:114
28285 "(This example is a virtual machine with an 8 GB disk which we would like to "
28286 "expand up to 10 GB)."
28290 #: ../tools/virt-resize.pl:117
28291 msgid "4. Create output disk"
28295 #: ../tools/virt-resize.pl:119
28297 "Virt-resize cannot do in-place disk modifications. You have to have space "
28298 "to store the resized output disk."
28302 #: ../tools/virt-resize.pl:122
28303 msgid "To store the resized disk image in a file, create a file of a suitable size:"
28307 #: ../tools/virt-resize.pl:125
28310 " # rm -f outdisk\n"
28311 " # truncate -s 10G outdisk\n"
28316 #: ../tools/virt-resize.pl:128
28317 msgid "Or use L<lvcreate(1)> to create a logical volume:"
28321 #: ../tools/virt-resize.pl:130
28324 " # lvcreate -L 10G -n lv_name vg_name\n"
28329 #: ../tools/virt-resize.pl:132
28330 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
28334 #: ../tools/virt-resize.pl:134
28337 " # virsh pool-list\n"
28338 " # virsh vol-create-as poolname newvol 10G\n"
28343 #: ../tools/virt-resize.pl:137
28348 #: ../tools/virt-resize.pl:139
28350 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
28351 "file) and the output disk. The output disk is the one created in the "
28356 #: ../tools/virt-resize.pl:143
28359 " # virt-resize indisk outdisk\n"
28364 #: ../tools/virt-resize.pl:145
28366 "This command just copies disk image C<indisk> to disk image C<outdisk> "
28367 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
28368 "larger, then an extra, empty partition is created at the end of the disk "
28369 "covering the extra space. If C<outdisk> is smaller, then it will give an "
28374 #: ../tools/virt-resize.pl:151
28376 "More realistically you'd want to expand existing partitions in the disk "
28377 "image by passing extra options (for the full list see the L</OPTIONS> "
28382 #: ../tools/virt-resize.pl:155
28384 "L</--expand> is the most useful option. It expands the named partition "
28385 "within the disk to fill any extra space:"
28389 #: ../tools/virt-resize.pl:158
28392 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
28397 #: ../tools/virt-resize.pl:160
28399 "(In this case, an extra partition is I<not> created at the end of the disk, "
28400 "because there will be no unused space)."
28404 #: ../tools/virt-resize.pl:163
28406 "L</--resize> is the other commonly used option. The following would "
28407 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
28408 "rest of the available space:"
28412 #: ../tools/virt-resize.pl:167
28415 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
28416 " indisk outdisk\n"
28421 #: ../tools/virt-resize.pl:170
28423 "If the expanded partition in the image contains a filesystem or LVM PV, then "
28424 "if virt-resize knows how, it will resize the contents, the equivalent of "
28425 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
28426 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
28427 "filesystems, so you would have to online resize them after booting the "
28432 #: ../tools/virt-resize.pl:177
28433 msgid "Other options are covered below."
28437 #: ../tools/virt-resize.pl:179
28442 #: ../tools/virt-resize.pl:181
28443 msgid "Thoroughly test the new disk image I<before> discarding the old one."
28447 #: ../tools/virt-resize.pl:183
28448 msgid "If you are using libvirt, edit the XML to point at the new disk:"
28452 #: ../tools/virt-resize.pl:185
28455 " # virsh edit guestname\n"
28460 #: ../tools/virt-resize.pl:187
28462 "Change E<lt>source ...E<gt>, see "
28463 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
28467 #: ../tools/virt-resize.pl:190
28468 msgid "Then start up the domain with the new, resized disk:"
28472 #: ../tools/virt-resize.pl:192
28475 " # virsh start guestname\n"
28480 #: ../tools/virt-resize.pl:194
28482 "and check that it still works. See also the L</NOTES> section below for "
28483 "additional information."
28487 #: ../tools/virt-resize.pl:197
28488 msgid "7. Resize LVs etc inside the guest"
28492 #: ../tools/virt-resize.pl:199
28493 msgid "(This can also be done offline using L<guestfish(1)>)"
28497 #: ../tools/virt-resize.pl:201
28499 "Once the guest has booted you should see the new space available, at least "
28500 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
28501 "may need to resize LVs inside PVs, and also resize filesystem types that "
28502 "virt-resize does not know how to expand."
28506 #: ../tools/virt-resize.pl:208
28507 msgid "SHRINKING A VIRTUAL MACHINE DISK"
28511 #: ../tools/virt-resize.pl:210
28513 "Shrinking is somewhat more complex than expanding, and only an overview is "
28518 #: ../tools/virt-resize.pl:213
28520 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
28521 "filesystems). The user has to shrink content before passing the disk image "
28522 "to virt-resize, and virt-resize will check that the content has been shrunk "
28527 #: ../tools/virt-resize.pl:218
28528 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28532 #: ../tools/virt-resize.pl:220
28534 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28535 "steps 3 and 4 above to allocate a new disk image."
28539 #: ../tools/virt-resize.pl:223
28540 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28544 #: ../tools/virt-resize.pl:226
28545 msgid "IGNORING OR DELETING PARTITIONS"
28549 #: ../tools/virt-resize.pl:228
28551 "virt-resize also gives a convenient way to ignore or delete partitions when "
28552 "copying from the input disk to the output disk. Ignoring a partition speeds "
28553 "up the copy where you don't care about the existing contents of a "
28554 "partition. Deleting a partition removes it completely, but note that it "
28555 "also renumbers any partitions after the one which is deleted, which can "
28556 "leave some guests unbootable."
28560 #: ../tools/virt-resize.pl:235
28561 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28565 #: ../tools/virt-resize.pl:237
28567 "If the input disk is in qcow2 format, then you may prefer that the output is "
28568 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28569 "the fly. The output format is simply determined by the format of the empty "
28570 "output container that you provide. Thus to create qcow2 output, use:"
28574 #: ../tools/virt-resize.pl:243
28577 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28582 #: ../tools/virt-resize.pl:245
28583 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28587 #: ../tools/virt-resize.pl:247
28588 msgid "Similarly, to get non-sparse raw output use:"
28592 #: ../tools/virt-resize.pl:249
28595 " fallocate -l size outdisk\n"
28600 #: ../tools/virt-resize.pl:251
28602 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
28603 "if=/dev/zero of=outdisk bs=1M count=..>)"
28607 #: ../tools/virt-resize.pl:264
28608 msgid "Display help."
28612 #: ../tools/virt-resize.pl:278
28613 msgid "B<--resize part=size>"
28617 #: ../tools/virt-resize.pl:280
28619 "Resize the named partition (expanding or shrinking it) so that it has the "
28624 #: ../tools/virt-resize.pl:283
28626 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28627 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28628 "Exabytes; or as a percentage of the current size; or as a relative number or "
28629 "percentage. For example:"
28633 #: ../tools/virt-resize.pl:288
28636 " --resize /dev/sda2=10G\n"
28641 #: ../tools/virt-resize.pl:290
28644 " --resize /dev/sda4=90%\n"
28649 #: ../tools/virt-resize.pl:292
28652 " --resize /dev/sda2=+1G\n"
28657 #: ../tools/virt-resize.pl:294
28660 " --resize /dev/sda2=-200M\n"
28665 #: ../tools/virt-resize.pl:296
28668 " --resize /dev/sda1=+128K\n"
28673 #: ../tools/virt-resize.pl:298
28676 " --resize /dev/sda1=+10%\n"
28681 #: ../tools/virt-resize.pl:300
28684 " --resize /dev/sda1=-10%\n"
28689 #: ../tools/virt-resize.pl:302
28691 "You can increase the size of any partition. Virt-resize will expand the "
28692 "direct content of the partition if it knows how (see C<--expand> below)."
28696 #: ../tools/virt-resize.pl:306
28698 "You can only I<decrease> the size of partitions that contain filesystems or "
28699 "PVs which have already been shrunk. Virt-resize will check this has been "
28700 "done before proceeding, or else will print an error (see also "
28701 "C<--resize-force>)."
28705 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
28706 msgid "You can give this option multiple times."
28710 #: ../tools/virt-resize.pl:317
28711 msgid "B<--resize-force part=size>"
28715 #: ../tools/virt-resize.pl:319
28717 "This is the same as C<--resize> except that it will let you decrease the "
28718 "size of any partition. Generally this means you will lose any data which "
28719 "was at the end of the partition you shrink, but you may not care about that "
28720 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28721 "as a swap partition)."
28725 #: ../tools/virt-resize.pl:325
28726 msgid "See also the C<--ignore> option."
28730 #: ../tools/virt-resize.pl:331
28731 msgid "B<--expand part>"
28735 #: ../tools/virt-resize.pl:333
28737 "Expand the named partition so it uses up all extra space (space left over "
28738 "after any other resize changes that you request have been done)."
28742 #: ../tools/virt-resize.pl:336
28744 "If virt-resize knows how, it will expand the direct content of the "
28745 "partition. For example, if the partition is an LVM PV, it will expand the "
28746 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28747 "content it doesn't know about alone."
28751 #: ../tools/virt-resize.pl:341
28752 msgid "Currently virt-resize can resize:"
28756 #: ../tools/virt-resize.pl:347
28758 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28763 #: ../tools/virt-resize.pl:352
28765 "NTFS filesystems contained directly in a partition, if libguestfs was "
28766 "compiled with support for NTFS."
28770 #: ../tools/virt-resize.pl:355
28772 "The filesystem must have been shut down consistently last time it was used. "
28773 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
28774 "consistency check, so at the first boot after resizing Windows will check "
28779 #: ../tools/virt-resize.pl:362
28781 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
28782 "inside the PV, but see the C<--LV-expand> option. The user could also "
28783 "resize LVs as desired after boot."
28787 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
28788 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
28792 #: ../tools/virt-resize.pl:374
28793 msgid "B<--shrink part>"
28797 #: ../tools/virt-resize.pl:376
28799 "Shrink the named partition until the overall disk image fits in the "
28800 "destination. The named partition B<must> contain a filesystem or PV which "
28801 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
28802 "online tools). Virt-resize will check this and give an error if it has not "
28807 #: ../tools/virt-resize.pl:382
28809 "The amount by which the overall disk must be shrunk (after carrying out all "
28810 "other operations requested by the user) is called the \"deficit\". For "
28811 "example, a straight copy (assume no other operations) from a 5GB disk image "
28812 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
28813 "would give an error unless the user specified a partition to shrink and that "
28814 "partition had more than a gigabyte of free space."
28818 #: ../tools/virt-resize.pl:396
28819 msgid "B<--ignore part>"
28823 #: ../tools/virt-resize.pl:398
28825 "Ignore the named partition. Effectively this means the partition is "
28826 "allocated on the destination disk, but the content is not copied across from "
28827 "the source disk. The content of the partition will be blank (all zero "
28832 #: ../tools/virt-resize.pl:409
28833 msgid "B<--delete part>"
28837 #: ../tools/virt-resize.pl:411
28839 "Delete the named partition. It would be more accurate to describe this as "
28840 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
28841 "the original disk image is left intact."
28845 #: ../tools/virt-resize.pl:415
28847 "Note that when you delete a partition, then anything contained in the "
28848 "partition is also deleted. Furthermore, this causes any partitions that "
28849 "come after to be I<renumbered>, which can easily make your guest unbootable."
28853 #: ../tools/virt-resize.pl:426
28854 msgid "B<--LV-expand logvol>"
28858 #: ../tools/virt-resize.pl:428
28860 "This takes the logical volume and, as a final step, expands it to fill all "
28861 "the space available in its volume group. A typical usage, assuming a Linux "
28862 "guest with a single PV C</dev/sda2> and a root device called "
28863 "C</dev/vg_guest/lv_root> would be:"
28867 #: ../tools/virt-resize.pl:433
28870 " virt-resize indisk outdisk \\\n"
28871 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
28876 #: ../tools/virt-resize.pl:436
28878 "This would first expand the partition (and PV), and then expand the root "
28879 "device to fill the extra space in the PV."
28883 #: ../tools/virt-resize.pl:439
28885 "The contents of the LV are also resized if virt-resize knows how to do "
28886 "that. You can stop virt-resize from trying to expand the content by using "
28887 "the option C<--no-expand-content>."
28891 #: ../tools/virt-resize.pl:443
28892 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
28896 #: ../tools/virt-resize.pl:446
28898 "You can give this option multiple times, I<but> it doesn't make sense to do "
28899 "this unless the logical volumes you specify are all in different volume "
28904 #: ../tools/virt-resize.pl:454
28905 msgid "B<--no-copy-boot-loader>"
28909 #: ../tools/virt-resize.pl:456
28911 "By default, virt-resize copies over some sectors at the start of the disk "
28912 "(up to the beginning of the first partition). Commonly these sectors "
28913 "contain the Master Boot Record (MBR) and the boot loader, and are required "
28914 "in order for the guest to boot correctly."
28918 #: ../tools/virt-resize.pl:461
28920 "If you specify this flag, then this initial copy is not done. You may need "
28921 "to reinstall the boot loader in this case."
28925 #: ../tools/virt-resize.pl:469
28926 msgid "B<--no-extra-partition>"
28930 #: ../tools/virt-resize.pl:471
28932 "By default, virt-resize creates an extra partition if there is any extra, "
28933 "unused space after all resizing has happened. Use this option to prevent "
28934 "the extra partition from being created. If you do this then the extra space "
28935 "will be inaccessible until you run fdisk, parted, or some other partitioning "
28936 "tool in the guest."
28940 #: ../tools/virt-resize.pl:477
28942 "Note that if the surplus space is smaller than 10 MB, no extra partition "
28947 #: ../tools/virt-resize.pl:484
28948 msgid "B<--no-expand-content>"
28952 #: ../tools/virt-resize.pl:486
28954 "By default, virt-resize will try to expand the direct contents of "
28955 "partitions, if it knows how (see C<--expand> option above)."
28959 #: ../tools/virt-resize.pl:489
28961 "If you give the C<--no-expand-content> option then virt-resize will not "
28966 #: ../tools/virt-resize.pl:496
28967 msgid "B<-d> | B<--debug>"
28971 #: ../tools/virt-resize.pl:504
28972 msgid "B<-n> | B<--dryrun>"
28976 #: ../tools/virt-resize.pl:506
28977 msgid "Print a summary of what would be done, but don't do anything."
28981 #: ../tools/virt-resize.pl:512
28982 msgid "B<-q> | B<--quiet>"
28986 #: ../tools/virt-resize.pl:514
28987 msgid "Don't print the summary."
28991 #: ../tools/virt-resize.pl:522
28993 "Specify the format of the input disk image. If this flag is not given then "
28994 "it is auto-detected from the image itself."
28998 #: ../tools/virt-resize.pl:528
29000 "Note that this option I<does not> affect the output format. See L</QCOW2 "
29001 "AND NON-SPARSE RAW FORMATS>."
29005 #: ../tools/virt-resize.pl:535
29006 msgid "B<--output-format> raw"
29010 #: ../tools/virt-resize.pl:537
29012 "Specify the format of the output disk image. If this flag is not given then "
29013 "it is auto-detected from the image itself."
29017 #: ../tools/virt-resize.pl:543
29019 "Note that you still need to create the output disk with the right format. "
29020 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
29024 #: ../tools/virt-resize.pl:1419
29029 #: ../tools/virt-resize.pl:1421
29030 msgid "\"Partition 1 does not end on cylinder boundary.\""
29034 #: ../tools/virt-resize.pl:1423
29036 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
29037 "means the partitions will not be aligned to the ancient CHS geometry. "
29038 "However CHS geometry is meaningless for disks manufactured since the early "
29039 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
29040 "cylinders is not required by any modern operating system."
29044 #: ../tools/virt-resize.pl:1430
29045 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
29049 #: ../tools/virt-resize.pl:1432
29051 "In Windows Vista and later versions, Microsoft switched to using a separate "
29052 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
29053 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
29054 "the boot partition. Doing so seems to break the guest completely. However "
29055 "expanding the second partition (ie. C: drive) should work."
29059 #: ../tools/virt-resize.pl:1439
29061 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
29062 "NTFS partitions have been expanded. This is just a safety check and (unless "
29063 "it find errors) is nothing to worry about."
29067 #: ../tools/virt-resize.pl:1443
29068 msgid "GUEST BOOT STUCK AT \"GRUB\""
29072 #: ../tools/virt-resize.pl:1445
29074 "If a Linux guest does not boot after resizing, and the boot is stuck after "
29075 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
29076 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
29077 "although we think is to do with partition alignment."
29081 #: ../tools/virt-resize.pl:1450
29084 " guestfish -i -a newdisk\n"
29085 " ><fs> cat /boot/grub/device.map\n"
29086 " # check the contents of this file are sensible or\n"
29087 " # edit the file if necessary\n"
29088 " ><fs> grub-install / /dev/vda\n"
29094 #: ../tools/virt-resize.pl:1457
29096 "For more flexible guest reconfiguration, including if you need to specify "
29097 "other parameters to grub-install, use L<virt-rescue(1)>."
29101 #: ../tools/virt-resize.pl:1460
29102 msgid "ALTERNATIVE TOOLS"
29106 #: ../tools/virt-resize.pl:1462
29108 "There are several proprietary tools for resizing partitions. We won't "
29109 "mention any here."
29113 #: ../tools/virt-resize.pl:1465
29115 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
29116 "operations on disk images. They can resize and move partitions, but I don't "
29117 "think they can do anything with the contents, and they certainly don't "
29122 #: ../tools/virt-resize.pl:1470
29124 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
29125 "but at a much lower level. You will probably end up hand-calculating sector "
29126 "offsets, which is something that virt-resize was designed to avoid. If you "
29127 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
29132 #: ../tools/virt-resize.pl:1485
29134 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
29135 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
29136 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
29137 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
29138 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29142 #: ../tools/virt-list-filesystems.pl:32
29143 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29147 #: ../tools/virt-list-filesystems.pl:36
29150 " virt-list-filesystems [--options] domname\n"
29155 #: ../tools/virt-list-filesystems.pl:38
29158 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29163 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29165 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29170 #: ../tools/virt-list-filesystems.pl:45
29172 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29173 "are contained in a virtual machine or disk image."
29177 #: ../tools/virt-list-filesystems.pl:49
29179 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29180 "functionality. For more complex cases you should look at the "
29181 "L<guestfish(1)> tool."
29185 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29186 msgid "B<-l> | B<--long>"
29190 #: ../tools/virt-list-filesystems.pl:108
29192 "With this option, C<virt-list-filesystems> displays the type of each "
29193 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29197 #: ../tools/virt-list-filesystems.pl:115
29198 msgid "B<-a> | B<--all>"
29202 #: ../tools/virt-list-filesystems.pl:117
29204 "Normally we only show mountable filesystems. If this option is given then "
29205 "swap devices are shown too."
29209 #: ../tools/virt-list-filesystems.pl:191
29211 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29212 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29213 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29217 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29218 msgid "Copyright (C) 2009 Red Hat Inc."
29222 #: ../tools/virt-tar.pl:33
29223 msgid "virt-tar - Extract or upload files to a virtual machine"
29227 #: ../tools/virt-tar.pl:37
29230 " virt-tar [--options] -x domname directory tarball\n"
29235 #: ../tools/virt-tar.pl:39
29238 " virt-tar [--options] -u domname tarball directory\n"
29243 #: ../tools/virt-tar.pl:41
29246 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29251 #: ../tools/virt-tar.pl:43
29254 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29259 #: ../tools/virt-tar.pl:47
29261 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29262 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29266 #: ../tools/virt-tar.pl:52
29267 msgid "Download C</home> from the VM into a local tarball:"
29271 #: ../tools/virt-tar.pl:54
29274 " virt-tar -x domname /home home.tar\n"
29279 #: ../tools/virt-tar.pl:56
29282 " virt-tar -zx domname /home home.tar.gz\n"
29287 #: ../tools/virt-tar.pl:58
29288 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29292 #: ../tools/virt-tar.pl:60
29295 " virt-tar -u domname uploadstuff.tar /tmp\n"
29300 #: ../tools/virt-tar.pl:62
29303 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29308 #: ../tools/virt-tar.pl:66
29310 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
29311 "virtual machines. If you do this, you risk disk corruption in the VM. "
29312 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29316 #: ../tools/virt-tar.pl:71
29318 "You can use C<-x> (extract) on live virtual machines, but you might get "
29319 "inconsistent results or errors if there is filesystem activity inside the "
29320 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29321 "work, but the only way to guarantee consistent results is if the virtual "
29322 "machine is shut down."
29326 #: ../tools/virt-tar.pl:79
29328 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29329 "parts of a guest filesystem. There are many possibilities: making backups, "
29330 "uploading data files, snooping on guest activity, fixing or customizing "
29335 #: ../tools/virt-tar.pl:84
29337 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29338 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29339 "should look at the L<guestfish(1)> tool."
29343 #: ../tools/virt-tar.pl:88
29345 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
29346 "its contents (recursively) from the virtual machine into a local tarball. "
29347 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
29348 "virtual machine. You cannot use these two options together."
29352 #: ../tools/virt-tar.pl:94
29354 "In addition, you may need to use the C<-z> (gZip) option to enable "
29355 "compression. When uploading, you have to specify C<-z> if the upload file "
29356 "is compressed because virt-tar won't detect this on its own."
29360 #: ../tools/virt-tar.pl:98
29362 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29363 "example it cannot do PKZip files or bzip2 compression. If you want that "
29364 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29365 "the L<libguestfs(3)> API)."
29369 #: ../tools/virt-tar.pl:156
29370 msgid "B<-x> | B<--extract> | B<--download>"
29374 #: ../tools/virt-tar.pl:158
29375 msgid "B<-u> | B<--upload>"
29379 #: ../tools/virt-tar.pl:160
29381 "Use C<-x> to extract (download) a directory from a virtual machine to a "
29386 #: ../tools/virt-tar.pl:163
29388 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
29389 "Please read the L</WARNING> section above before using this option."
29393 #: ../tools/virt-tar.pl:167
29394 msgid "You must specify exactly one of these options."
29398 #: ../tools/virt-tar.pl:173
29399 msgid "B<-z> | B<--gzip>"
29403 #: ../tools/virt-tar.pl:175
29404 msgid "Specify that the input or output tarball is gzip-compressed."
29408 #: ../tools/virt-tar.pl:288
29410 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29411 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29412 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29413 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29417 #: ../tools/virt-make-fs.pl:37
29418 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29422 #: ../tools/virt-make-fs.pl:41
29425 " virt-make-fs [--options] input.tar output.img\n"
29430 #: ../tools/virt-make-fs.pl:43
29433 " virt-make-fs [--options] input.tar.gz output.img\n"
29438 #: ../tools/virt-make-fs.pl:45
29441 " virt-make-fs [--options] directory output.img\n"
29446 #: ../tools/virt-make-fs.pl:49
29448 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29449 "archive or some files in a directory. It is similar to tools like "
29450 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29451 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29452 "useful if you want to attach these filesystems to existing virtual machines "
29453 "(eg. to import large amounts of read-only data to a VM)."
29457 #: ../tools/virt-make-fs.pl:57
29458 msgid "Basic usage is:"
29462 #: ../tools/virt-make-fs.pl:59
29465 " virt-make-fs input output\n"
29470 #: ../tools/virt-make-fs.pl:61
29472 "where C<input> is either a directory containing files that you want to add, "
29473 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29474 "C<output> is a disk image. The input type is detected automatically. The "
29475 "output disk image defaults to a raw ext2 image unless you specify extra "
29476 "flags (see L</OPTIONS> below)."
29480 #: ../tools/virt-make-fs.pl:67
29481 msgid "EXTRA SPACE"
29485 #: ../tools/virt-make-fs.pl:69
29487 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29488 "the files that it contains, but might have extra space. Depending on how "
29489 "you are going to use the output, you might think this extra space is wasted "
29490 "and want to minimize it, or you might want to leave space so that more files "
29491 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29492 "but you can use the C<--size> flag to leave space in the filesystem if you "
29497 #: ../tools/virt-make-fs.pl:77
29499 "An alternative way to leave extra space but not make the output image any "
29500 "bigger is to use an alternative disk image format (instead of the default "
29501 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29502 "image format (check your hypervisor supports this before using it). This "
29503 "allows you to choose a large C<--size> but the extra space won't actually be "
29504 "allocated in the image until you try to store something in it."
29508 #: ../tools/virt-make-fs.pl:85
29510 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29511 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29512 "to build another image from scratch."
29516 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29521 #: ../tools/virt-make-fs.pl:91
29524 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29529 #: ../tools/virt-make-fs.pl:93
29530 msgid "FILESYSTEM TYPE"
29534 #: ../tools/virt-make-fs.pl:95
29536 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29537 "libguestfs supports can be used (but I<not> read-only formats like "
29538 "ISO9660). Here are some of the more common choices:"
29542 #: ../tools/virt-make-fs.pl:101
29547 #: ../tools/virt-make-fs.pl:103
29549 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29550 "you are not going to use the filesystem in a way that requires the journal, "
29551 "then this is just wasted overhead."
29555 #: ../tools/virt-make-fs.pl:107
29556 msgid "I<ntfs> or I<vfat>"
29560 #: ../tools/virt-make-fs.pl:109
29561 msgid "Useful if exporting data to a Windows guest."
29565 #: ../tools/virt-make-fs.pl:111
29567 "I<Note for vfat>: The tar archive or local directory must only contain files "
29568 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29569 "program running within libguestfs is unable to change the ownership of "
29570 "non-root files, since vfat itself does not support this."
29574 #: ../tools/virt-make-fs.pl:116
29579 #: ../tools/virt-make-fs.pl:118
29581 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29582 "total filesystem size."
29586 #: ../tools/virt-make-fs.pl:125
29589 " virt-make-fs --type=minix input minixfs.img\n"
29594 #: ../tools/virt-make-fs.pl:127
29595 msgid "TO PARTITION OR NOT TO PARTITION"
29599 #: ../tools/virt-make-fs.pl:129
29600 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29604 #: ../tools/virt-make-fs.pl:131
29606 "Adding a partition can make the disk image more compatible with certain "
29607 "virtualized operating systems which don't expect to see a filesystem "
29608 "directly located on a block device (Linux doesn't care and will happily "
29609 "handle both types)."
29613 #: ../tools/virt-make-fs.pl:136
29615 "On the other hand, if you have a partition table then the output image is no "
29616 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29617 "directly on a partitioned disk image. (However libguestfs tools such as "
29618 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29622 #: ../tools/virt-make-fs.pl:144
29623 msgid "Add an MBR partition:"
29627 #: ../tools/virt-make-fs.pl:146
29630 " virt-make-fs --partition -- input disk.img\n"
29635 #: ../tools/virt-make-fs.pl:148
29637 "If the output disk image could be terabyte-sized or larger, it's better to "
29638 "use an EFI/GPT-compatible partition table:"
29642 #: ../tools/virt-make-fs.pl:151
29645 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29650 #: ../tools/virt-make-fs.pl:179
29651 msgid "Enable debugging information."
29655 #: ../tools/virt-make-fs.pl:185
29656 msgid "B<--size=E<lt>NE<gt>>"
29660 #: ../tools/virt-make-fs.pl:187
29661 msgid "B<--size=+E<lt>NE<gt>>"
29665 #: ../tools/virt-make-fs.pl:189
29666 msgid "B<-s E<lt>NE<gt>>"
29670 #: ../tools/virt-make-fs.pl:191
29671 msgid "B<-s +E<lt>NE<gt>>"
29675 #: ../tools/virt-make-fs.pl:193
29676 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29680 #: ../tools/virt-make-fs.pl:196
29682 "If this option is I<not> given, then the output image will be just large "
29683 "enough to contain all the files, with not much wasted space."
29687 #: ../tools/virt-make-fs.pl:199
29689 "To choose a fixed size output disk, specify an absolute number followed by "
29690 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29691 "Petabytes or Exabytes. This must be large enough to contain all the input "
29692 "files, else you will get an error."
29696 #: ../tools/virt-make-fs.pl:204
29698 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29699 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29700 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29701 "the input files, and (approximately) an extra 200 MB free space."
29705 #: ../tools/virt-make-fs.pl:210
29707 "Note that virt-make-fs estimates free space, and therefore will not produce "
29708 "filesystems containing precisely the free space requested. (It is much more "
29709 "expensive and time-consuming to produce a filesystem which has precisely the "
29710 "desired free space)."
29714 #: ../tools/virt-make-fs.pl:219
29715 msgid "B<--format=E<lt>fmtE<gt>>"
29719 #: ../tools/virt-make-fs.pl:221
29720 msgid "B<-F E<lt>fmtE<gt>>"
29724 #: ../tools/virt-make-fs.pl:223
29725 msgid "Choose the output disk image format."
29729 #: ../tools/virt-make-fs.pl:225
29730 msgid "The default is C<raw> (raw disk image)."
29734 #: ../tools/virt-make-fs.pl:227
29736 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29737 "that would really make sense here is C<qcow2>."
29741 #: ../tools/virt-make-fs.pl:234
29742 msgid "B<--type=E<lt>fsE<gt>>"
29746 #: ../tools/virt-make-fs.pl:236
29747 msgid "B<-t E<lt>fsE<gt>>"
29751 #: ../tools/virt-make-fs.pl:238
29752 msgid "Choose the output filesystem type."
29756 #: ../tools/virt-make-fs.pl:240
29757 msgid "The default is C<ext2>."
29761 #: ../tools/virt-make-fs.pl:242
29762 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29766 #: ../tools/virt-make-fs.pl:249
29767 msgid "B<--partition>"
29771 #: ../tools/virt-make-fs.pl:251
29772 msgid "B<--partition=E<lt>parttypeE<gt>>"
29776 #: ../tools/virt-make-fs.pl:253
29778 "If specified, this flag adds an MBR partition table to the output disk "
29783 #: ../tools/virt-make-fs.pl:256
29785 "You can change the partition table type, eg. C<--partition=gpt> for large "
29790 #: ../tools/virt-make-fs.pl:259
29792 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29793 "might consider the next parameter to be the partition type. For example:"
29797 #: ../tools/virt-make-fs.pl:263
29800 " virt-make-fs --partition input.tar ...\n"
29805 #: ../tools/virt-make-fs.pl:265
29807 "would cause virt-make-fs to think you wanted to use a partition type of "
29808 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29809 "dash) between options and the input file argument:"
29813 #: ../tools/virt-make-fs.pl:269
29816 " virt-make-fs --partition -- input.tar ...\n"
29821 #: ../tools/virt-make-fs.pl:536
29823 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
29824 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29825 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29829 #: ../tools/virt-make-fs.pl:553
29832 " export LIBGUESTFS_DEBUG=1\n"
29833 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29838 #: ../tools/virt-make-fs.pl:556
29840 "Attach /tmp/virt-make-fs.log to a new bug report at "
29841 "L<https://bugzilla.redhat.com/>"
29845 #: ../tools/virt-list-partitions.pl:32
29846 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29850 #: ../tools/virt-list-partitions.pl:36
29853 " virt-list-partitions [--options] domname\n"
29858 #: ../tools/virt-list-partitions.pl:38
29861 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29866 #: ../tools/virt-list-partitions.pl:45
29868 "C<virt-list-partitions> is a command line tool to list the partitions that "
29869 "are contained in a virtual machine or disk image. It is mainly useful as a "
29870 "first step to using L<virt-resize(1)>."
29874 #: ../tools/virt-list-partitions.pl:50
29876 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29877 "functionality. For more complex cases you should look at the "
29878 "L<guestfish(1)> tool."
29882 #: ../tools/virt-list-partitions.pl:107
29883 msgid "B<-h> | B<--human-readable>"
29887 #: ../tools/virt-list-partitions.pl:109
29888 msgid "Show sizes in human-readable form (eg. \"1G\")."
29892 #: ../tools/virt-list-partitions.pl:117
29894 "With this option, C<virt-list-partitions> displays the type and size of each "
29895 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29899 #: ../tools/virt-list-partitions.pl:124
29900 msgid "B<-t> | B<--total>"
29904 #: ../tools/virt-list-partitions.pl:126
29905 msgid "Display the total size of each block device (as a separate row or rows)."
29909 #: ../tools/virt-list-partitions.pl:259
29911 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29912 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29913 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."