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.8.11\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-08-07 23:12+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-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:72 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
73 #: ../src/guestfs.pod:25
75 "Libguestfs is a library for accessing and modifying guest disk images. "
76 "Amongst the things this is good for: making batch configuration changes to "
77 "guests, getting disk used/free statistics (see also: virt-df), migrating "
78 "between virtualization systems (see also: virt-p2v), performing partial "
79 "backups, performing partial guest clones, cloning guests and changing "
80 "registry/UUID/hostname info, and much else besides."
84 #: ../src/guestfs.pod:33
86 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
87 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
88 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
93 #: ../src/guestfs.pod:38
95 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
96 "what filesystem is in each LV, etc.). It can also run commands in the "
97 "context of the guest. Also you can access filesystems over FUSE."
101 #: ../src/guestfs.pod:43
103 "Libguestfs is a library that can be linked with C and C++ management "
104 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
105 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
110 #: ../src/guestfs.pod:48
112 "You don't need to be root to use libguestfs, although obviously you do need "
113 "enough permissions to access the disk images."
117 #: ../src/guestfs.pod:51
119 "Libguestfs is a large API because it can do many things. For a gentle "
120 "introduction, please read the L</API OVERVIEW> section next."
124 #: ../src/guestfs.pod:54
126 "There are also some example programs in the L<guestfs-examples(3)> manual "
131 #: ../src/guestfs.pod:57
136 #: ../src/guestfs.pod:59
138 "This section provides a gentler overview of the libguestfs API. We also try "
139 "to group API calls together, where that may not be obvious from reading "
140 "about the individual calls in the main section of this manual."
144 #: ../src/guestfs.pod:64
149 #: ../src/guestfs.pod:66
151 "Before you can use libguestfs calls, you have to create a handle. Then you "
152 "must add at least one disk image to the handle, followed by launching the "
153 "handle, then performing whatever operations you want, and finally closing "
154 "the handle. By convention we use the single letter C<g> for the name of the "
155 "handle variable, although of course you can use any name you want."
159 #: ../src/guestfs.pod:73
160 msgid "The general structure of all libguestfs-using programs looks like this:"
164 #: ../src/guestfs.pod:76
167 " guestfs_h *g = guestfs_create ();\n"
172 #: ../src/guestfs.pod:78
175 " /* Call guestfs_add_drive additional times if there are\n"
176 " * multiple disk images.\n"
178 " guestfs_add_drive (g, \"guest.img\");\n"
183 #: ../src/guestfs.pod:83
186 " /* Most manipulation calls won't work until you've launched\n"
187 " * the handle 'g'. You have to do this _after_ adding drives\n"
188 " * and _before_ other commands.\n"
190 " guestfs_launch (g);\n"
195 #: ../src/guestfs.pod:89
198 " /* Now you can examine what partitions, LVs etc are available.\n"
200 " char **partitions = guestfs_list_partitions (g);\n"
201 " char **logvols = guestfs_lvs (g);\n"
206 #: ../src/guestfs.pod:94
209 " /* To access a filesystem in the image, you must mount it.\n"
211 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
216 #: ../src/guestfs.pod:98
219 " /* Now you can perform filesystem actions on the guest\n"
222 " guestfs_touch (g, \"/hello\");\n"
227 #: ../src/guestfs.pod:103
230 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
231 " * it is done automatically when you close the handle. See\n"
232 " * discussion of autosync in this page.\n"
234 " guestfs_sync (g);\n"
239 #: ../src/guestfs.pod:109
242 " /* Close the handle 'g'. */\n"
243 " guestfs_close (g);\n"
248 #: ../src/guestfs.pod:112
250 "The code above doesn't include any error checking. In real code you should "
251 "check return values carefully for errors. In general all functions that "
252 "return integers return C<-1> on error, and all functions that return "
253 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
254 "how to handle errors, and consult the documentation for each function call "
255 "below to see precisely how they return error indications. See "
256 "L<guestfs-examples(3)> for fully worked examples."
260 #: ../src/guestfs.pod:121
265 #: ../src/guestfs.pod:123
267 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
268 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
269 "actual block device, or simply an empty file of zeroes that you have created "
270 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
275 #: ../src/guestfs.pod:129
277 "The call you should use in modern code for adding drives is "
278 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
279 "specifying that the format is raw, do:"
283 #: ../src/guestfs.pod:133
286 " guestfs_add_drive_opts (g, filename,\n"
287 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
293 #: ../src/guestfs.pod:137
294 msgid "You can add a disk read-only using:"
298 #: ../src/guestfs.pod:139
301 " guestfs_add_drive_opts (g, filename,\n"
302 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
303 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
309 #: ../src/guestfs.pod:144
311 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
312 "libguestfs won't modify the file."
316 #: ../src/guestfs.pod:147
318 "Be extremely cautious if the disk image is in use, eg. if it is being used "
319 "by a virtual machine. Adding it read-write will almost certainly cause disk "
320 "corruption, but adding it read-only is safe."
324 #: ../src/guestfs.pod:151
326 "You must add at least one disk image, and you may add multiple disk images. "
327 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
328 "first one you added), C</dev/sdb> (for the second one you added), etc."
332 #: ../src/guestfs.pod:156
334 "Once L</guestfs_launch> has been called you cannot add any more images. You "
335 "can call L</guestfs_list_devices> to get a list of the device names, in the "
336 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
340 #: ../src/guestfs.pod:161
345 #: ../src/guestfs.pod:163
347 "Before you can read or write files, create directories and so on in a disk "
348 "image that contains filesystems, you have to mount those filesystems using "
349 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
350 "a disk image contains (for example) one partition with a filesystem on that "
351 "partition, then you can mount it directly:"
355 #: ../src/guestfs.pod:170
358 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
363 #: ../src/guestfs.pod:172
365 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
366 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
367 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
368 "that these are libguestfs virtual devices, and are nothing to do with host "
373 #: ../src/guestfs.pod:178
375 "If you are given a disk image and you don't know what it contains then you "
376 "have to find out. Libguestfs can do that too: use "
377 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
378 "and LVs, and either try mounting each to see what is mountable, or else "
379 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
380 "filesystems, use L</guestfs_list_filesystems>."
384 #: ../src/guestfs.pod:186
386 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
387 "L</INSPECTION> below). But you might find it easier to look at higher level "
388 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
392 #: ../src/guestfs.pod:191
394 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
395 "several other variations of the C<guestfs_mount_*> call."
399 #: ../src/guestfs.pod:194
400 msgid "FILESYSTEM ACCESS AND MODIFICATION"
404 #: ../src/guestfs.pod:196
406 "The majority of the libguestfs API consists of fairly low-level calls for "
407 "accessing and modifying the files, directories, symlinks etc on mounted "
408 "filesystems. There are over a hundred such calls which you can find listed "
409 "in detail below in this man page, and we don't even pretend to cover them "
410 "all in this overview."
414 #: ../src/guestfs.pod:202
416 "Specify filenames as full paths, starting with C<\"/\"> and including the "
421 #: ../src/guestfs.pod:205
423 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
424 "the file called C<\"etc/passwd\"> then you could do:"
428 #: ../src/guestfs.pod:208
431 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
436 #: ../src/guestfs.pod:210
438 "This would return C<data> as a newly allocated buffer containing the full "
439 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
440 "or C<NULL> if there was an error."
444 #: ../src/guestfs.pod:214
446 "As another example, to create a top-level directory on that filesystem "
447 "called C<\"var\"> you would do:"
451 #: ../src/guestfs.pod:217
454 " guestfs_mkdir (g, \"/var\");\n"
459 #: ../src/guestfs.pod:219
460 msgid "To create a symlink you could do:"
464 #: ../src/guestfs.pod:221
467 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
468 " \"/etc/rc3.d/S30portmap\");\n"
473 #: ../src/guestfs.pod:224
475 "Libguestfs will reject attempts to use relative paths and there is no "
476 "concept of a current working directory."
480 #: ../src/guestfs.pod:227
482 "Libguestfs can return errors in many situations: for example if the "
483 "filesystem isn't writable, or if a file or directory that you requested "
484 "doesn't exist. If you are using the C API (documented here) you have to "
485 "check for those error conditions after each call. (Other language bindings "
486 "turn these errors into exceptions)."
490 #: ../src/guestfs.pod:233
492 "File writes are affected by the per-handle umask, set by calling "
493 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
497 #: ../src/guestfs.pod:236
502 #: ../src/guestfs.pod:238
504 "Libguestfs contains API calls to read, create and modify partition tables on "
509 #: ../src/guestfs.pod:241
511 "In the common case where you want to create a single partition covering the "
512 "whole disk, you should use the L</guestfs_part_disk> call:"
516 #: ../src/guestfs.pod:245
519 " const char *parttype = \"mbr\";\n"
520 " if (disk_is_larger_than_2TB)\n"
521 " parttype = \"gpt\";\n"
522 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
527 #: ../src/guestfs.pod:250
529 "Obviously this effectively wipes anything that was on that disk image "
534 #: ../src/guestfs.pod:253
539 #: ../src/guestfs.pod:255
541 "Libguestfs provides access to a large part of the LVM2 API, such as "
542 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
543 "unless you familiarize yourself with the concepts of physical volumes, "
544 "volume groups and logical volumes."
548 #: ../src/guestfs.pod:260
550 "This author strongly recommends reading the LVM HOWTO, online at "
551 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
555 #: ../src/guestfs.pod:263
560 #: ../src/guestfs.pod:265
562 "Use L</guestfs_cat> to download small, text only files. This call is "
563 "limited to files which are less than 2 MB and which cannot contain any ASCII "
564 "NUL (C<\\0>) characters. However the API is very simple to use."
568 #: ../src/guestfs.pod:269
570 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
571 "bit data, since it returns a (pointer, size) pair. However it is still "
572 "limited to \"small\" files, less than 2 MB."
576 #: ../src/guestfs.pod:273
578 "L</guestfs_download> can be used to download any file, with no limits on "
579 "content or size (even files larger than 4 GB)."
583 #: ../src/guestfs.pod:276
584 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
588 #: ../src/guestfs.pod:279
593 #: ../src/guestfs.pod:281
595 "It's often the case that you want to write a file or files to the disk "
600 #: ../src/guestfs.pod:284
602 "To write a small file with fixed content, use L</guestfs_write>. To create "
603 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
604 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
605 "variety of other functions for creating test files, for example "
606 "L</guestfs_fill> and L</guestfs_fill_pattern>."
610 #: ../src/guestfs.pod:290
612 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
613 "file content or size (even files larger than 4 GB)."
617 #: ../src/guestfs.pod:293
618 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
622 #: ../src/guestfs.pod:295
624 "However the fastest way to upload I<large numbers of arbitrary files> is to "
625 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
626 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
627 "the drive in a predictable way (eg. adding it last after all other drives) "
628 "then you can get the device name from L</guestfs_list_devices> and mount it "
629 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
630 "sometimes non-portable between kernel versions, and they don't support "
631 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
632 "using a label or UUID, use an ISO image instead."
636 #: ../src/guestfs.pod:306
641 #: ../src/guestfs.pod:308
643 "There are various different commands for copying between files and devices "
644 "and in and out of the guest filesystem. These are summarised in the table "
649 #: ../src/guestfs.pod:314
650 msgid "B<file> to B<file>"
654 #: ../src/guestfs.pod:316
656 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
657 "directories recursively."
661 #: ../src/guestfs.pod:319
662 msgid "B<file or device> to B<file or device>"
666 #: ../src/guestfs.pod:321
668 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
669 "devices in the guest."
673 #: ../src/guestfs.pod:324
674 msgid "Example: duplicate the contents of an LV:"
678 #: ../src/guestfs.pod:326
681 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
686 #: ../src/guestfs.pod:328
688 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
689 "(C</dev/VG/Original>). To copy less than the whole source device, use "
690 "L</guestfs_copy_size>."
694 #: ../src/guestfs.pod:332
695 msgid "B<file on the host> to B<file or device>"
699 #: ../src/guestfs.pod:334
700 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
704 #: ../src/guestfs.pod:336
705 msgid "B<file or device> to B<file on the host>"
709 #: ../src/guestfs.pod:338
710 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
714 #: ../src/guestfs.pod:342
715 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
719 #: ../src/guestfs.pod:344
721 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
722 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
723 "appears you can only upload and download to files. However many Un*x-like "
724 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
725 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
726 "stderr, and arbitrary file descriptor N."
730 #: ../src/guestfs.pod:352
731 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
735 #: ../src/guestfs.pod:355
738 " guestfs_download (g, filename, \"/dev/stdout\");\n"
743 #: ../src/guestfs.pod:357
744 msgid "and you can write tar output to a pipe C<fd> by doing:"
748 #: ../src/guestfs.pod:359
752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
753 " guestfs_tar_out (g, \"/\", devfd);\n"
758 #: ../src/guestfs.pod:363
759 msgid "LISTING FILES"
763 #: ../src/guestfs.pod:365
765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
766 "L<guestfish(1)>-equivalent command C<ll>)."
770 #: ../src/guestfs.pod:368
772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
773 "programs, as a flat list of strings."
777 #: ../src/guestfs.pod:371
779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
780 "directory, plus additional information about each one. It is more "
781 "equivalent to using the L<readdir(3)> call on a local filesystem."
785 #: ../src/guestfs.pod:375
787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
792 #: ../src/guestfs.pod:378
793 msgid "RUNNING COMMANDS"
797 #: ../src/guestfs.pod:380
799 "Although libguestfs is primarily an API for manipulating files inside guest "
800 "images, we also provide some limited facilities for running commands inside "
805 #: ../src/guestfs.pod:384
806 msgid "There are many limitations to this:"
810 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1011 ../src/guestfs.pod:1015 ../src/guestfs.pod:1019 ../src/guestfs.pod:1024 ../src/guestfs.pod:1032 ../src/guestfs.pod:1051 ../src/guestfs.pod:1059 ../src/guestfs.pod:1081 ../src/guestfs.pod:1085 ../src/guestfs.pod:1089 ../src/guestfs.pod:1093 ../src/guestfs.pod:1097 ../src/guestfs.pod:1101 ../src/guestfs.pod:1583 ../src/guestfs.pod:1588 ../src/guestfs.pod:1592 ../src/guestfs.pod:1702 ../src/guestfs.pod:1707 ../src/guestfs.pod:1711 ../src/guestfs.pod:2064 ../src/guestfs.pod:2070 ../src/guestfs.pod:2075 ../src/guestfs.pod:2081 ../src/guestfs.pod:2540 ../src/guestfs.pod:2544 ../src/guestfs.pod:2548 ../src/guestfs.pod:2552 ../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:1584 ../src/guestfs-actions.pod:1588 ../src/guestfs-actions.pod:1592 ../src/guestfs-actions.pod:1596 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608 ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1622 ../src/guestfs-actions.pod:1626 ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1768 ../src/guestfs-actions.pod:1772 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:1847 ../src/guestfs-actions.pod:1852 ../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:1062 ../fish/guestfish-actions.pod:1066 ../fish/guestfish-actions.pod:1070 ../fish/guestfish-actions.pod:1074 ../fish/guestfish-actions.pod:1082 ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1090 ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1104 ../fish/guestfish-actions.pod:1108 ../fish/guestfish-actions.pod:1198 ../fish/guestfish-actions.pod:1202 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1254 ../fish/guestfish-actions.pod:1258 ../fish/guestfish-actions.pod:1263 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1204 ../src/guestfs.pod:1335 ../src/guestfs.pod:2109
941 #: ../src/guestfs.pod:471
942 msgid "Before launching, do:"
946 #: ../src/guestfs.pod:473
949 " guestfs_set_selinux (g, 1);\n"
954 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1208 ../src/guestfs.pod:1339 ../src/guestfs.pod:2134
959 #: ../src/guestfs.pod:477
961 "After mounting the guest's filesystem(s), load the policy. This is best "
962 "done by running the L<load_policy(8)> command in the guest itself:"
966 #: ../src/guestfs.pod:481
969 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
974 #: ../src/guestfs.pod:483
976 "(Older versions of C<load_policy> require you to specify the name of the "
981 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1345
986 #: ../src/guestfs.pod:488
988 "Optionally, set the security context for the API. The correct security "
989 "context to use can only be known by inspecting the guest. As an example:"
993 #: ../src/guestfs.pod:492
996 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1001 #: ../src/guestfs.pod:496
1002 msgid "This will work for running commands and editing existing files."
1006 #: ../src/guestfs.pod:498
1008 "When new files are created, you may need to label them explicitly, for "
1009 "example by running the external command C<restorecon pathname>."
1013 #: ../src/guestfs.pod:502
1018 #: ../src/guestfs.pod:504
1020 "Certain calls are affected by the current file mode creation mask (the "
1021 "\"umask\"). In particular ones which create files or directories, such as "
1022 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1023 "either the default mode that the file is created with or modifies the mode "
1028 #: ../src/guestfs.pod:510
1030 "The default umask is C<022>, so files are created with modes such as C<0644> "
1031 "and directories with C<0755>."
1035 #: ../src/guestfs.pod:513
1037 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1038 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
1039 "L</guestfs_chmod> after creating each file or directory."
1043 #: ../src/guestfs.pod:517
1044 msgid "For more information about umask, see L<umask(2)>."
1048 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:720
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems. (These APIs used to be in a separate Perl-only "
1112 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1113 "frequently used part of this library has been rewritten in C and moved into "
1118 #: ../src/guestfs.pod:558
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:561
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:570
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:576
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:583
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:587
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:590
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:594
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:598
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:602
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:611
1213 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1217 #: ../src/guestfs.pod:613
1219 "Libguestfs can mount NTFS partitions. It does this using the "
1220 "L<http://www.ntfs-3g.org/> driver."
1224 #: ../src/guestfs.pod:616
1225 msgid "DRIVE LETTERS AND PATHS"
1229 #: ../src/guestfs.pod:618
1231 "DOS and Windows still use drive letters, and the filesystems are always "
1232 "treated as case insensitive by Windows itself, and therefore you might find "
1233 "a Windows configuration file referring to a path like "
1234 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1235 "that directory might be referred to as C</WINDOWS/System32>."
1239 #: ../src/guestfs.pod:624
1241 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1242 "libguestfs to read the appropriate Windows Registry and configuration files, "
1243 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1244 "L<virt-inspector(1)>)."
1248 #: ../src/guestfs.pod:629
1250 "Replacing backslash characters with forward slash characters is also outside "
1251 "the scope of libguestfs, but something that you can easily do."
1255 #: ../src/guestfs.pod:632
1257 "Where we can help is in resolving the case insensitivity of paths. For "
1258 "this, call L</guestfs_case_sensitive_path>."
1262 #: ../src/guestfs.pod:635
1263 msgid "ACCESSING THE WINDOWS REGISTRY"
1267 #: ../src/guestfs.pod:637
1269 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1270 "files, through the library C<hivex> which is part of the libguestfs project "
1271 "although ships as a separate tarball. You have to locate and download the "
1272 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1273 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1274 "L<virt-win-reg(1)> for more help on this issue."
1278 #: ../src/guestfs.pod:645
1279 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1283 #: ../src/guestfs.pod:647
1285 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1286 "provide something which looks like a Linux symlink. The way it tries to do "
1287 "the rewriting is described here:"
1291 #: ../src/guestfs.pod:651
1292 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1296 #: ../src/guestfs.pod:653
1298 "The essential problem is that ntfs-3g simply does not have enough "
1299 "information to do a correct job. NTFS links can contain drive letters and "
1300 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1301 "It is almost certainly the case that libguestfs callers should ignore what "
1302 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1306 #: ../src/guestfs.pod:660
1308 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1309 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1310 "attribute, and read the raw reparse data from that (you can find the format "
1311 "documented in various places around the web)."
1315 #: ../src/guestfs.pod:665
1316 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1320 #: ../src/guestfs.pod:667
1322 "There are other useful extended attributes that can be read from ntfs-3g "
1323 "filesystems (using L</guestfs_getxattr>). See:"
1327 #: ../src/guestfs.pod:670
1328 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1332 #: ../src/guestfs.pod:672
1333 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1337 #: ../src/guestfs.pod:674
1339 "Although we don't want to discourage you from using the C API, we will "
1340 "mention here that the same API is also available in other languages."
1344 #: ../src/guestfs.pod:677
1346 "The API is broadly identical in all supported languages. This means that "
1347 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1348 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1349 "OCaml. In other words, a straightforward, predictable isomorphism between "
1354 #: ../src/guestfs.pod:683
1356 "Error messages are automatically transformed into exceptions if the language "
1361 #: ../src/guestfs.pod:686
1363 "We don't try to \"object orientify\" parts of the API in OO languages, "
1364 "although contributors are welcome to write higher level APIs above what we "
1365 "provide in their favourite languages if they wish."
1369 #: ../src/guestfs.pod:692
1374 #: ../src/guestfs.pod:694
1376 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1377 "identical to the C API. C++ classes and exceptions are not used."
1381 #: ../src/guestfs.pod:698
1386 #: ../src/guestfs.pod:700
1388 "The C# bindings are highly experimental. Please read the warnings at the "
1389 "top of C<csharp/Libguestfs.cs>."
1393 #: ../src/guestfs.pod:703
1398 #: ../src/guestfs.pod:705
1400 "This is the only language binding that is working but incomplete. Only "
1401 "calls which return simple integers have been bound in Haskell, and we are "
1402 "looking for help to complete this binding."
1406 #: ../src/guestfs.pod:709
1411 #: ../src/guestfs.pod:711
1413 "Full documentation is contained in the Javadoc which is distributed with "
1418 #: ../src/guestfs.pod:714
1423 #: ../src/guestfs.pod:716
1424 msgid "See L<guestfs-ocaml(3)>."
1428 #: ../src/guestfs.pod:718
1433 #: ../src/guestfs.pod:720
1434 msgid "See L<Sys::Guestfs(3)>."
1438 #: ../src/guestfs.pod:722
1443 #: ../src/guestfs.pod:724
1445 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1446 "the php-libguestfs package for your distribution."
1450 #: ../src/guestfs.pod:727
1451 msgid "The PHP binding only works correctly on 64 bit machines."
1455 #: ../src/guestfs.pod:729
1460 #: ../src/guestfs.pod:731
1461 msgid "See L<guestfs-python(3)>."
1465 #: ../src/guestfs.pod:733
1470 #: ../src/guestfs.pod:735
1471 msgid "See L<guestfs-ruby(3)>."
1475 #: ../src/guestfs.pod:737
1476 msgid "B<shell scripts>"
1480 #: ../src/guestfs.pod:739
1481 msgid "See L<guestfish(1)>."
1485 #: ../src/guestfs.pod:743
1486 msgid "LIBGUESTFS GOTCHAS"
1490 #: ../src/guestfs.pod:745
1492 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1493 "system [...] that works in the way it is documented but is counterintuitive "
1494 "and almost invites mistakes.\""
1498 #: ../src/guestfs.pod:749
1500 "Since we developed libguestfs and the associated tools, there are several "
1501 "things we would have designed differently, but are now stuck with for "
1502 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1503 "release, you can expect these to change. Beware of them."
1507 #: ../src/guestfs.pod:757
1508 msgid "Autosync / forgetting to sync."
1512 #: ../src/guestfs.pod:759
1514 "When modifying a filesystem from C or another language, you B<must> unmount "
1515 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1516 "libguestfs handle. You can also call:"
1520 #: ../src/guestfs.pod:763
1523 " guestfs_set_autosync (g, 1);\n"
1528 #: ../src/guestfs.pod:765
1530 "to have the unmount/sync done automatically for you when the handle 'g' is "
1531 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1536 #: ../src/guestfs.pod:769
1538 "If you forget to do this, then it is entirely possible that your changes "
1539 "won't be written out, or will be partially written, or (very rarely) that "
1540 "you'll get disk corruption."
1544 #: ../src/guestfs.pod:773
1546 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1547 "guestfish scripts that forget to sync will work just fine, which can make "
1548 "this very puzzling if you are trying to debug a problem."
1552 #: ../src/guestfs.pod:777
1554 "Update: Autosync is enabled by default for all API users starting from "
1555 "libguestfs 1.5.24."
1559 #: ../src/guestfs.pod:780
1560 msgid "Mount option C<-o sync> should not be the default."
1564 #: ../src/guestfs.pod:782
1566 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1567 "However C<-o sync> does not add any reliability benefit, but does have a "
1568 "very large performance impact."
1572 #: ../src/guestfs.pod:786
1574 "The work around is to use L</guestfs_mount_options> and set the mount "
1575 "options that you actually want to use."
1579 #: ../src/guestfs.pod:789
1580 msgid "Read-only should be the default."
1584 #: ../src/guestfs.pod:791
1586 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1587 "specify I<--rw> if you want to make changes to the image."
1591 #: ../src/guestfs.pod:794
1592 msgid "This would reduce the potential to corrupt live VM images."
1596 #: ../src/guestfs.pod:796
1598 "Note that many filesystems change the disk when you just mount and unmount, "
1599 "even if you didn't perform any writes. You need to use "
1600 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1604 #: ../src/guestfs.pod:800
1605 msgid "guestfish command line is hard to use."
1609 #: ../src/guestfs.pod:802
1611 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1612 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1613 "exist, so it fails. In earlier versions of guestfish the error message was "
1614 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1615 "we should have used C<guestfish -c command> to run commands."
1619 #: ../src/guestfs.pod:809
1620 msgid "guestfish megabyte modifiers don't work right on all commands"
1624 #: ../src/guestfs.pod:811
1626 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1627 "other modifiers). What guestfish actually does is to multiply the number "
1628 "part by the modifier part and pass the result to the C API. However this "
1629 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1630 "expecting some other unit (eg. megabytes)."
1634 #: ../src/guestfs.pod:818
1635 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1639 #: ../src/guestfs.pod:820
1642 " lvcreate LV VG 100M\n"
1647 #: ../src/guestfs.pod:822
1649 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1650 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1651 "megabytes * megabytes) logical volume. The error message you get from this "
1652 "is also a little obscure."
1656 #: ../src/guestfs.pod:827
1658 "This could be fixed in the generator by specially marking parameters and "
1659 "return values which take bytes or other units."
1663 #: ../src/guestfs.pod:830
1664 msgid "Ambiguity between devices and paths"
1668 #: ../src/guestfs.pod:832
1670 "There is a subtle ambiguity in the API between a device name "
1671 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1672 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1676 #: ../src/guestfs.pod:837
1678 "In the current API we usually resolve this ambiguity by having two separate "
1679 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1680 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1681 "detecting if the path supplied begins with C</dev/>."
1685 #: ../src/guestfs.pod:843
1687 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1688 "make paths/devices into structured names. One way to do this would be to "
1689 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1690 "aspect of grub. Another way would be to use a structured type, equivalent "
1691 "to this OCaml type:"
1695 #: ../src/guestfs.pod:849
1698 " type path = Path of string | Device of int | Partition of int * int\n"
1703 #: ../src/guestfs.pod:851
1704 msgid "which would allow you to pass arguments like:"
1708 #: ../src/guestfs.pod:853
1711 " Path \"/foo/bar\"\n"
1712 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1713 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1714 " Path \"/dev/sdb2\" (* not a device *)\n"
1719 #: ../src/guestfs.pod:858
1721 "As you can see there are still problems to resolve even with this "
1722 "representation. Also consider how it might work in guestfish."
1726 #: ../src/guestfs.pod:863
1727 msgid "PROTOCOL LIMITS"
1731 #: ../src/guestfs.pod:865
1733 "Internally libguestfs uses a message-based protocol to pass API calls and "
1734 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1735 "plenty more detail about this). The maximum message size used by the "
1736 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1737 "aware of this limit. The API calls which may be affected are individually "
1738 "documented, with a link back to this section of the documentation."
1742 #: ../src/guestfs.pod:873
1744 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1745 "a simple string. Because this string is at some point internally encoded as "
1746 "a message, the maximum size that it can return is slightly under 4 MB. If "
1747 "the requested file is larger than this then you will get an error."
1751 #: ../src/guestfs.pod:879
1753 "In order to transfer large files into and out of the guest filesystem, you "
1754 "need to use particular calls that support this. The sections L</UPLOADING> "
1755 "and L</DOWNLOADING> document how to do this."
1759 #: ../src/guestfs.pod:883
1761 "You might also consider mounting the disk image using our FUSE filesystem "
1762 "support (L<guestmount(1)>)."
1766 #: ../src/guestfs.pod:886
1767 msgid "KEYS AND PASSPHRASES"
1771 #: ../src/guestfs.pod:888
1773 "Certain libguestfs calls take a parameter that contains sensitive key "
1774 "material, passed in as a C string."
1778 #: ../src/guestfs.pod:891
1780 "In the future we would hope to change the libguestfs implementation so that "
1781 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1782 "swap. However this is I<not> done at the moment, because of the complexity "
1783 "of such an implementation."
1787 #: ../src/guestfs.pod:896
1789 "Therefore you should be aware that any key parameter you pass to libguestfs "
1790 "might end up being written out to the swap partition. If this is a concern, "
1791 "scrub the swap partition or don't use libguestfs on encrypted devices."
1795 #: ../src/guestfs.pod:901
1796 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1800 #: ../src/guestfs.pod:903
1802 "All high-level libguestfs actions are synchronous. If you want to use "
1803 "libguestfs asynchronously then you must create a thread."
1807 #: ../src/guestfs.pod:906
1809 "Only use the handle from a single thread. Either use the handle exclusively "
1810 "from one thread, or provide your own mutex so that two threads cannot issue "
1811 "calls on the same handle at the same time."
1815 #: ../src/guestfs.pod:910
1817 "See the graphical program guestfs-browser for one possible architecture for "
1818 "multithreaded programs using libvirt and libguestfs."
1822 #: ../src/guestfs.pod:913
1827 #: ../src/guestfs.pod:915
1829 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1834 #: ../src/guestfs.pod:918
1836 "By default it looks for these in the directory C<$libdir/guestfs> "
1837 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1841 #: ../src/guestfs.pod:921
1843 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1844 "to change the directories that libguestfs will search in. The value is a "
1845 "colon-separated list of paths. The current directory is I<not> searched "
1846 "unless the path contains an empty element or C<.>. For example "
1847 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1848 "then C</usr/lib/guestfs>."
1852 #: ../src/guestfs.pod:928
1853 msgid "QEMU WRAPPERS"
1857 #: ../src/guestfs.pod:930
1859 "If you want to compile your own qemu, run qemu from a non-standard location, "
1860 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1865 #: ../src/guestfs.pod:934
1867 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1868 "last command in the shell script (so that qemu replaces the shell and "
1869 "becomes the direct child of the libguestfs-using program). If you don't do "
1870 "this, then the qemu process won't be cleaned up correctly."
1874 #: ../src/guestfs.pod:939
1876 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1881 #: ../src/guestfs.pod:942
1885 " qemudir=/home/rjones/d/qemu\n"
1886 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1892 #: ../src/guestfs.pod:946
1894 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1895 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1900 #: ../src/guestfs.pod:950
1903 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1908 #: ../src/guestfs.pod:952
1910 "Note that libguestfs also calls qemu with the -help and -version options in "
1911 "order to determine features."
1915 #: ../src/guestfs.pod:955
1916 msgid "ABI GUARANTEE"
1920 #: ../src/guestfs.pod:957
1922 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1923 "actions as outlined in this section. Although we will deprecate some "
1924 "actions, for example if they get replaced by newer calls, we will keep the "
1925 "old actions forever. This allows you the developer to program in confidence "
1926 "against the libguestfs API."
1930 #: ../src/guestfs.pod:963
1931 msgid "BLOCK DEVICE NAMING"
1935 #: ../src/guestfs.pod:965
1937 "In the kernel there is now quite a profusion of schemata for naming block "
1938 "devices (in this context, by I<block device> I mean a physical or virtual "
1939 "hard drive). The original Linux IDE driver used names starting with "
1940 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1941 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1942 "replacement for the old IDE driver (particularly for SATA devices) those "
1943 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1944 "machines with paravirtualized drivers. This has created several different "
1945 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1950 #: ../src/guestfs.pod:977
1952 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1953 "Linux kernel to access block devices. We can run a variety of appliances "
1954 "based on a variety of Linux kernels."
1958 #: ../src/guestfs.pod:981
1960 "This causes a problem for libguestfs because many API calls use device or "
1961 "partition names. Working scripts and the recipe (example) scripts that we "
1962 "make available over the internet could fail if the naming scheme changes."
1966 #: ../src/guestfs.pod:986
1968 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1969 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1970 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1971 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1975 #: ../src/guestfs.pod:992
1977 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1978 "L</guestfs_list_partitions> and similar calls return the true names of the "
1979 "devices and partitions as known to the appliance."
1983 #: ../src/guestfs.pod:997
1984 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1988 #: ../src/guestfs.pod:999
1990 "Usually this translation is transparent. However in some (very rare) cases "
1991 "you may need to know the exact algorithm. Such cases include where you use "
1992 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
1993 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
1998 #: ../src/guestfs.pod:1005
2000 "The algorithm is applied only to I<parameters> which are known to be either "
2001 "device or partition names. Return values from functions such as "
2002 "L</guestfs_list_devices> are never changed."
2006 #: ../src/guestfs.pod:1013
2007 msgid "Is the string a parameter which is a device or partition name?"
2011 #: ../src/guestfs.pod:1017
2012 msgid "Does the string begin with C</dev/sd>?"
2016 #: ../src/guestfs.pod:1021
2018 "Does the named device exist? If so, we use that device. However if I<not> "
2019 "then we continue with this algorithm."
2023 #: ../src/guestfs.pod:1026
2024 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2028 #: ../src/guestfs.pod:1028
2029 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2033 #: ../src/guestfs.pod:1030
2034 msgid "If that named device exists, use it. If not, continue."
2038 #: ../src/guestfs.pod:1034
2039 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2043 #: ../src/guestfs.pod:1036
2044 msgid "If that named device exists, use it. If not, return an error."
2048 #: ../src/guestfs.pod:1040
2049 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2053 #: ../src/guestfs.pod:1042
2055 "Although the standard naming scheme and automatic translation is useful for "
2056 "simple programs and guestfish scripts, for larger programs it is best not to "
2057 "rely on this mechanism."
2061 #: ../src/guestfs.pod:1046
2063 "Where possible for maximum future portability programs using libguestfs "
2064 "should use these future-proof techniques:"
2068 #: ../src/guestfs.pod:1053
2070 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2071 "device names, and then use those names directly."
2075 #: ../src/guestfs.pod:1056
2076 msgid "Since those device names exist by definition, they will never be translated."
2080 #: ../src/guestfs.pod:1061
2082 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2083 "filesystem labels."
2087 #: ../src/guestfs.pod:1066
2092 #: ../src/guestfs.pod:1068
2094 "This section discusses security implications of using libguestfs, "
2095 "particularly with untrusted or malicious guests or disk images."
2099 #: ../src/guestfs.pod:1071
2100 msgid "GENERAL SECURITY CONSIDERATIONS"
2104 #: ../src/guestfs.pod:1073
2106 "Be careful with any files or data that you download from a guest (by "
2107 "\"download\" we mean not just the L</guestfs_download> command but any "
2108 "command that reads files, filenames, directories or anything else from a "
2109 "disk image). An attacker could manipulate the data to fool your program "
2110 "into doing the wrong thing. Consider cases such as:"
2114 #: ../src/guestfs.pod:1083
2115 msgid "the data (file etc) not being present"
2119 #: ../src/guestfs.pod:1087
2120 msgid "being present but empty"
2124 #: ../src/guestfs.pod:1091
2125 msgid "being much larger than normal"
2129 #: ../src/guestfs.pod:1095
2130 msgid "containing arbitrary 8 bit data"
2134 #: ../src/guestfs.pod:1099
2135 msgid "being in an unexpected character encoding"
2139 #: ../src/guestfs.pod:1103
2140 msgid "containing homoglyphs."
2144 #: ../src/guestfs.pod:1107
2145 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2149 #: ../src/guestfs.pod:1109
2151 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2152 "(VFS) module can sometimes be escalated into exploits by deliberately "
2153 "creating a malicious, malformed filesystem. These exploits are very severe "
2154 "for two reasons. Firstly there are very many filesystem drivers in the "
2155 "kernel, and many of them are infrequently used and not much developer "
2156 "attention has been paid to the code. Linux userspace helps potential "
2157 "crackers by detecting the filesystem type and automatically choosing the "
2158 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2159 "the administrator. Secondly, a kernel-level exploit is like a local root "
2160 "exploit (worse in some ways), giving immediate and total access to the "
2161 "system right down to the hardware level."
2165 #: ../src/guestfs.pod:1122
2167 "That explains why you should never mount a filesystem from an untrusted "
2168 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2169 "inside a qemu virtual machine, usually running as a non-root user. The "
2170 "attacker would need to write a filesystem which first exploited the kernel, "
2171 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2172 "the libguestfs protocol, and finally to be as serious as the host kernel "
2173 "exploit it would need to escalate its privileges to root. This multi-step "
2174 "escalation, performed by a static piece of data, is thought to be extremely "
2175 "hard to do, although we never say 'never' about security issues."
2179 #: ../src/guestfs.pod:1133
2181 "In any case callers can reduce the attack surface by forcing the filesystem "
2182 "type when mounting (use L</guestfs_mount_vfs>)."
2186 #: ../src/guestfs.pod:1136
2187 msgid "PROTOCOL SECURITY"
2191 #: ../src/guestfs.pod:1138
2193 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2194 "defined upper message size. However a program that uses libguestfs must "
2195 "also take care - for example you can write a program that downloads a binary "
2196 "from a disk image and executes it locally, and no amount of protocol "
2197 "security will save you from the consequences."
2201 #: ../src/guestfs.pod:1144
2202 msgid "INSPECTION SECURITY"
2206 #: ../src/guestfs.pod:1146
2208 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2209 "directly from the guest, and these could contain any 8 bit data. Callers "
2210 "should be careful to escape these before printing them to a structured file "
2211 "(for example, use HTML escaping if creating a web page)."
2215 #: ../src/guestfs.pod:1152
2217 "Guest configuration may be altered in unusual ways by the administrator of "
2218 "the virtual machine, and may not reflect reality (particularly for untrusted "
2219 "or actively malicious guests). For example we parse the hostname from "
2220 "configuration files like C</etc/sysconfig/network> that we find in the "
2221 "guest, but the guest administrator can easily manipulate these files to "
2222 "provide the wrong hostname."
2226 #: ../src/guestfs.pod:1160
2228 "The inspection API parses guest configuration using two external libraries: "
2229 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2230 "designed to be robust in the face of malicious data, although denial of "
2231 "service attacks are still possible, for example with oversized configuration "
2236 #: ../src/guestfs.pod:1166
2237 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2241 #: ../src/guestfs.pod:1168
2243 "Be very cautious about running commands from the guest. By running a "
2244 "command in the guest, you are giving CPU time to a binary that you do not "
2245 "control, under the same user account as the library, albeit wrapped in qemu "
2246 "virtualization. More information and alternatives can be found in the "
2247 "section L</RUNNING COMMANDS>."
2251 #: ../src/guestfs.pod:1174
2252 msgid "CVE-2010-3851"
2256 #: ../src/guestfs.pod:1176
2257 msgid "https://bugzilla.redhat.com/642934"
2261 #: ../src/guestfs.pod:1178
2263 "This security bug concerns the automatic disk format detection that qemu "
2264 "does on disk images."
2268 #: ../src/guestfs.pod:1181
2270 "A raw disk image is just the raw bytes, there is no header. Other disk "
2271 "images like qcow2 contain a special header. Qemu deals with this by looking "
2272 "for one of the known headers, and if none is found then assuming the disk "
2273 "image must be raw."
2277 #: ../src/guestfs.pod:1186
2279 "This allows a guest which has been given a raw disk image to write some "
2280 "other header. At next boot (or when the disk image is accessed by "
2281 "libguestfs) qemu would do autodetection and think the disk image format was, "
2282 "say, qcow2 based on the header written by the guest."
2286 #: ../src/guestfs.pod:1191
2288 "This in itself would not be a problem, but qcow2 offers many features, one "
2289 "of which is to allow a disk image to refer to another image (called the "
2290 "\"backing disk\"). It does this by placing the path to the backing disk "
2291 "into the qcow2 header. This path is not validated and could point to any "
2292 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2293 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2294 "control of the attacker."
2298 #: ../src/guestfs.pod:1199
2299 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2303 #: ../src/guestfs.pod:1206
2304 msgid "You have enabled the network or have opened the disk in write mode."
2308 #: ../src/guestfs.pod:1210
2310 "You are also running untrusted code from the guest (see L</RUNNING "
2315 #: ../src/guestfs.pod:1215
2317 "The way to avoid this is to specify the expected disk format when adding "
2318 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2319 "should always do this if the disk is raw format, and it's a good idea for "
2324 #: ../src/guestfs.pod:1220
2326 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2327 "format is fetched from libvirt and passed through."
2331 #: ../src/guestfs.pod:1223
2333 "For libguestfs tools, use the I<--format> command line parameter as "
2338 #: ../src/guestfs.pod:1226
2339 msgid "CONNECTION MANAGEMENT"
2343 #: ../src/guestfs.pod:1228
2348 #: ../src/guestfs.pod:1230
2350 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2351 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2352 "handle and release all resources used."
2356 #: ../src/guestfs.pod:1234
2358 "For information on using multiple handles and threads, see the section "
2359 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2363 #: ../src/guestfs.pod:1237
2364 msgid "guestfs_create"
2368 #: ../src/guestfs.pod:1239
2371 " guestfs_h *guestfs_create (void);\n"
2376 #: ../src/guestfs.pod:1241
2377 msgid "Create a connection handle."
2381 #: ../src/guestfs.pod:1243
2383 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2384 "on the handle at least once."
2388 #: ../src/guestfs.pod:1246
2390 "This function returns a non-NULL pointer to a handle on success or NULL on "
2395 #: ../src/guestfs.pod:1249
2396 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2400 #: ../src/guestfs.pod:1251
2402 "You may also want to configure error handling for the handle. See L</ERROR "
2403 "HANDLING> section below."
2407 #: ../src/guestfs.pod:1254
2408 msgid "guestfs_close"
2412 #: ../src/guestfs.pod:1256
2415 " void guestfs_close (guestfs_h *g);\n"
2420 #: ../src/guestfs.pod:1258
2421 msgid "This closes the connection handle and frees up all resources used."
2425 #: ../src/guestfs.pod:1260
2426 msgid "ERROR HANDLING"
2430 #: ../src/guestfs.pod:1262
2432 "API functions can return errors. For example, almost all functions that "
2433 "return C<int> will return C<-1> to indicate an error."
2437 #: ../src/guestfs.pod:1265
2439 "Additional information is available for errors: an error message string and "
2440 "optionally an error number (errno) if the thing that failed was a system "
2445 #: ../src/guestfs.pod:1269
2447 "You can get at the additional information about the last error on the handle "
2448 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2449 "up an error handler with L</guestfs_set_error_handler>."
2453 #: ../src/guestfs.pod:1274
2455 "When the handle is created, a default error handler is installed which "
2456 "prints the error message string to C<stderr>. For small short-running "
2457 "command line programs it is sufficient to do:"
2461 #: ../src/guestfs.pod:1278
2464 " if (guestfs_launch (g) == -1)\n"
2465 " exit (EXIT_FAILURE);\n"
2470 #: ../src/guestfs.pod:1281
2472 "since the default error handler will ensure that an error message has been "
2473 "printed to C<stderr> before the program exits."
2477 #: ../src/guestfs.pod:1284
2479 "For other programs the caller will almost certainly want to install an "
2480 "alternate error handler or do error handling in-line like this:"
2484 #: ../src/guestfs.pod:1287
2487 " g = guestfs_create ();\n"
2492 #: ../src/guestfs.pod:1289
2495 " /* This disables the default behaviour of printing errors\n"
2497 " guestfs_set_error_handler (g, NULL, NULL);\n"
2502 #: ../src/guestfs.pod:1293
2505 " if (guestfs_launch (g) == -1) {\n"
2506 " /* Examine the error message and print it etc. */\n"
2507 " char *msg = guestfs_last_error (g);\n"
2508 " int errnum = guestfs_last_errno (g);\n"
2509 " fprintf (stderr, \"%s\\n\", msg);\n"
2516 #: ../src/guestfs.pod:1301
2518 "Out of memory errors are handled differently. The default action is to call "
2519 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2520 "L</guestfs_set_out_of_memory_handler>."
2524 #: ../src/guestfs.pod:1305
2526 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2527 "because there is no handle if this happens there is no way to get additional "
2528 "error information. However L</guestfs_create> is supposed to be a "
2529 "lightweight operation which can only fail because of insufficient memory (it "
2530 "returns NULL in this case)."
2534 #: ../src/guestfs.pod:1311
2535 msgid "guestfs_last_error"
2539 #: ../src/guestfs.pod:1313
2542 " const char *guestfs_last_error (guestfs_h *g);\n"
2547 #: ../src/guestfs.pod:1315
2549 "This returns the last error message that happened on C<g>. If there has not "
2550 "been an error since the handle was created, then this returns C<NULL>."
2554 #: ../src/guestfs.pod:1319
2556 "The lifetime of the returned string is until the next error occurs, or "
2557 "L</guestfs_close> is called."
2561 #: ../src/guestfs.pod:1322
2562 msgid "guestfs_last_errno"
2566 #: ../src/guestfs.pod:1324
2569 " int guestfs_last_errno (guestfs_h *g);\n"
2574 #: ../src/guestfs.pod:1326
2575 msgid "This returns the last error number (errno) that happened on C<g>."
2579 #: ../src/guestfs.pod:1328
2580 msgid "If successful, an errno integer not equal to zero is returned."
2584 #: ../src/guestfs.pod:1330
2585 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2589 #: ../src/guestfs.pod:1337
2590 msgid "There has not been any error on the handle."
2594 #: ../src/guestfs.pod:1341
2596 "There has been an error but the errno was meaningless. This corresponds to "
2597 "the case where the error did not come from a failed system call, but for "
2598 "some other reason."
2602 #: ../src/guestfs.pod:1347
2604 "There was an error from a failed system call, but for some reason the errno "
2605 "was not captured and returned. This usually indicates a bug in libguestfs."
2609 #: ../src/guestfs.pod:1353
2611 "Libguestfs tries to convert the errno from inside the applicance into a "
2612 "corresponding errno for the caller (not entirely trivial: the appliance "
2613 "might be running a completely different operating system from the library "
2614 "and error numbers are not standardized across Un*xen). If this could not be "
2615 "done, then the error is translated to C<EINVAL>. In practice this should "
2616 "only happen in very rare circumstances."
2620 #: ../src/guestfs.pod:1361
2621 msgid "guestfs_set_error_handler"
2625 #: ../src/guestfs.pod:1363
2628 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2630 " const char *msg);\n"
2631 " void guestfs_set_error_handler (guestfs_h *g,\n"
2632 " guestfs_error_handler_cb cb,\n"
2638 #: ../src/guestfs.pod:1370
2640 "The callback C<cb> will be called if there is an error. The parameters "
2641 "passed to the callback are an opaque data pointer and the error message "
2646 #: ../src/guestfs.pod:1374
2648 "C<errno> is not passed to the callback. To get that the callback must call "
2649 "L</guestfs_last_errno>."
2653 #: ../src/guestfs.pod:1377
2655 "Note that the message string C<msg> is freed as soon as the callback "
2656 "function returns, so if you want to stash it somewhere you must make your "
2661 #: ../src/guestfs.pod:1381
2662 msgid "The default handler prints messages on C<stderr>."
2666 #: ../src/guestfs.pod:1383
2667 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2671 #: ../src/guestfs.pod:1385
2672 msgid "guestfs_get_error_handler"
2676 #: ../src/guestfs.pod:1387
2679 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2680 " void **opaque_rtn);\n"
2685 #: ../src/guestfs.pod:1390
2686 msgid "Returns the current error handler callback."
2690 #: ../src/guestfs.pod:1392
2691 msgid "guestfs_set_out_of_memory_handler"
2695 #: ../src/guestfs.pod:1394
2698 " typedef void (*guestfs_abort_cb) (void);\n"
2699 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2700 " guestfs_abort_cb);\n"
2705 #: ../src/guestfs.pod:1398
2707 "The callback C<cb> will be called if there is an out of memory situation. "
2708 "I<Note this callback must not return>."
2712 #: ../src/guestfs.pod:1401
2713 msgid "The default is to call L<abort(3)>."
2717 #: ../src/guestfs.pod:1403
2718 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2722 #: ../src/guestfs.pod:1406
2723 msgid "guestfs_get_out_of_memory_handler"
2727 #: ../src/guestfs.pod:1408
2730 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2735 #: ../src/guestfs.pod:1410
2736 msgid "This returns the current out of memory handler."
2740 #: ../src/guestfs.pod:1412
2745 #: ../src/guestfs.pod:1414 ../fish/guestfish.pod:958
2750 #: ../src/guestfs.pod:1416
2755 #: ../src/guestfs.pod:1418
2760 #: ../src/guestfs.pod:1420
2761 msgid "AVAILABILITY"
2765 #: ../src/guestfs.pod:1422
2766 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2770 #: ../src/guestfs.pod:1424
2772 "Using L</guestfs_available> you can test availability of the following "
2773 "groups of functions. This test queries the appliance to see if the "
2774 "appliance you are currently using supports the functionality."
2778 #: ../src/guestfs.pod:1429
2779 msgid "@AVAILABILITY@"
2783 #: ../src/guestfs.pod:1431
2784 msgid "GUESTFISH supported COMMAND"
2788 #: ../src/guestfs.pod:1433
2790 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2791 "prints out the available groups and whether they are supported by this build "
2792 "of libguestfs. Note however that you have to do C<run> first."
2796 #: ../src/guestfs.pod:1438
2797 msgid "SINGLE CALLS AT COMPILE TIME"
2801 #: ../src/guestfs.pod:1440
2803 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2804 "function, such as:"
2808 #: ../src/guestfs.pod:1443
2811 " #define LIBGUESTFS_HAVE_DD 1\n"
2816 #: ../src/guestfs.pod:1445
2817 msgid "if L</guestfs_dd> is available."
2821 #: ../src/guestfs.pod:1447
2823 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2824 "function is available at compile time, we recommended using build tools such "
2825 "as autoconf or cmake. For example in autotools you could use:"
2829 #: ../src/guestfs.pod:1452
2832 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2833 " AC_CHECK_FUNCS([guestfs_dd])\n"
2838 #: ../src/guestfs.pod:1455
2840 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2845 #: ../src/guestfs.pod:1458
2846 msgid "SINGLE CALLS AT RUN TIME"
2850 #: ../src/guestfs.pod:1460
2852 "Testing at compile time doesn't guarantee that a function really exists in "
2853 "the library. The reason is that you might be dynamically linked against a "
2854 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2855 "This situation unfortunately results in a segmentation fault, which is a "
2856 "shortcoming of the C dynamic linking system itself."
2860 #: ../src/guestfs.pod:1467
2862 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2863 "in this example program (note that you still need the compile time check as "
2868 #: ../src/guestfs.pod:1471
2871 " #include <stdio.h>\n"
2872 " #include <stdlib.h>\n"
2873 " #include <unistd.h>\n"
2874 " #include <dlfcn.h>\n"
2875 " #include <guestfs.h>\n"
2880 #: ../src/guestfs.pod:1477
2885 " #ifdef LIBGUESTFS_HAVE_DD\n"
2887 " int has_function;\n"
2892 #: ../src/guestfs.pod:1483
2895 " /* Test if the function guestfs_dd is really available. */\n"
2896 " dl = dlopen (NULL, RTLD_LAZY);\n"
2898 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2899 " exit (EXIT_FAILURE);\n"
2901 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2907 #: ../src/guestfs.pod:1492
2910 " if (!has_function)\n"
2911 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2913 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2914 " /* Now it's safe to call\n"
2915 " guestfs_dd (g, \"foo\", \"bar\");\n"
2919 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2926 #: ../src/guestfs.pod:1505
2928 "You may think the above is an awful lot of hassle, and it is. There are "
2929 "other ways outside of the C linking system to ensure that this kind of "
2930 "incompatibility never arises, such as using package versioning:"
2934 #: ../src/guestfs.pod:1510
2937 " Requires: libguestfs >= 1.0.80\n"
2942 #: ../src/guestfs.pod:1512
2943 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2947 #: ../src/guestfs.pod:1514
2949 "A recent feature of the API is the introduction of calls which take optional "
2950 "arguments. In C these are declared 3 ways. The main way is as a call which "
2951 "takes variable arguments (ie. C<...>), as in this example:"
2955 #: ../src/guestfs.pod:1519
2958 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2963 #: ../src/guestfs.pod:1521
2965 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2966 "call with no optional arguments specified:"
2970 #: ../src/guestfs.pod:1524
2973 " guestfs_add_drive_opts (g, filename, -1);\n"
2978 #: ../src/guestfs.pod:1526
2979 msgid "With a single optional argument:"
2983 #: ../src/guestfs.pod:1528
2986 " guestfs_add_drive_opts (g, filename,\n"
2987 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2993 #: ../src/guestfs.pod:1532
2998 #: ../src/guestfs.pod:1534
3001 " guestfs_add_drive_opts (g, filename,\n"
3002 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3003 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3009 #: ../src/guestfs.pod:1539
3011 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3016 #: ../src/guestfs.pod:1542
3017 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3021 #: ../src/guestfs.pod:1544
3023 "The second variant has the same name with the suffix C<_va>, which works the "
3024 "same way but takes a C<va_list>. See the C manual for details. For the "
3025 "example function, this is declared:"
3029 #: ../src/guestfs.pod:1548
3032 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3038 #: ../src/guestfs.pod:1551
3039 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3043 #: ../src/guestfs.pod:1553
3045 "The third variant is useful where you need to construct these calls. You "
3046 "pass in a structure where you fill in the optional fields. The structure "
3047 "has a bitmask as the first element which you must set to indicate which "
3048 "fields you have filled in. For our example function the structure and call "
3053 #: ../src/guestfs.pod:1559
3056 " struct guestfs_add_drive_opts_argv {\n"
3057 " uint64_t bitmask;\n"
3059 " const char *format;\n"
3062 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3063 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3068 #: ../src/guestfs.pod:1568
3069 msgid "You could call it like this:"
3073 #: ../src/guestfs.pod:1570
3076 " struct guestfs_add_drive_opts_argv optargs = {\n"
3077 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3078 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3080 " .format = \"qcow2\"\n"
3086 #: ../src/guestfs.pod:1577
3089 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3094 #: ../src/guestfs.pod:1579 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1250 ../tools/virt-win-reg.pl:532
3099 #: ../src/guestfs.pod:1585
3100 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3104 #: ../src/guestfs.pod:1590
3105 msgid "You do not need to fill in all fields of the structure."
3109 #: ../src/guestfs.pod:1594
3111 "There must be a one-to-one correspondence between fields of the structure "
3112 "that are filled in, and bits set in the bitmask."
3116 #: ../src/guestfs.pod:1599
3117 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3121 #: ../src/guestfs.pod:1601
3123 "In other languages, optional arguments are expressed in the way that is "
3124 "natural for that language. We refer you to the language-specific "
3125 "documentation for more details on that."
3129 #: ../src/guestfs.pod:1605
3130 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3134 #: ../src/guestfs.pod:1607
3135 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3139 #: ../src/guestfs.pod:1609
3141 "The child process generates events in some situations. Current events "
3142 "include: receiving a log message, the child process exits."
3146 #: ../src/guestfs.pod:1612
3148 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3153 #: ../src/guestfs.pod:1615
3155 "Only I<one callback of each type> can be registered for each handle. "
3156 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3157 "that type. Cancel all callbacks of this type by calling this function with "
3158 "C<cb> set to C<NULL>."
3162 #: ../src/guestfs.pod:1620
3163 msgid "guestfs_set_log_message_callback"
3167 #: ../src/guestfs.pod:1622
3170 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3171 " char *buf, int len);\n"
3172 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3173 " guestfs_log_message_cb cb,\n"
3179 #: ../src/guestfs.pod:1628
3181 "The callback function C<cb> will be called whenever qemu or the guest writes "
3182 "anything to the console."
3186 #: ../src/guestfs.pod:1631
3187 msgid "Use this function to capture kernel messages and similar."
3191 #: ../src/guestfs.pod:1633
3193 "Normally there is no log message handler, and log messages are just "
3198 #: ../src/guestfs.pod:1636
3199 msgid "guestfs_set_subprocess_quit_callback"
3203 #: ../src/guestfs.pod:1638
3206 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3207 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3208 " guestfs_subprocess_quit_cb cb,\n"
3214 #: ../src/guestfs.pod:1643
3216 "The callback function C<cb> will be called when the child process quits, "
3217 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3218 "corresponds to a transition from any state to the CONFIG state)."
3222 #: ../src/guestfs.pod:1648
3223 msgid "guestfs_set_launch_done_callback"
3227 #: ../src/guestfs.pod:1650
3230 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3231 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3232 " guestfs_launch_done_cb cb,\n"
3238 #: ../src/guestfs.pod:1655
3240 "The callback function C<cb> will be called when the child process becomes "
3241 "ready first time after it has been launched. (This corresponds to a "
3242 "transition from LAUNCHING to the READY state)."
3246 #: ../src/guestfs.pod:1659
3247 msgid "guestfs_set_close_callback"
3251 #: ../src/guestfs.pod:1661
3254 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3255 " void guestfs_set_close_callback (guestfs_h *g,\n"
3256 " guestfs_close_cb cb,\n"
3262 #: ../src/guestfs.pod:1666
3264 "The callback function C<cb> will be called while the handle is being closed "
3265 "(synchronously from L</guestfs_close>)."
3269 #: ../src/guestfs.pod:1669
3271 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3272 "handles that are open when the program exits. This means that this callback "
3273 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3274 "problems in higher-level languages (eg. if your HLL interpreter has already "
3275 "been cleaned up by the time this is called, and if your callback then jumps "
3276 "into some HLL function)."
3280 #: ../src/guestfs.pod:1677
3281 msgid "guestfs_set_progress_callback"
3285 #: ../src/guestfs.pod:1679
3288 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3289 " int proc_nr, int serial,\n"
3290 " uint64_t position, uint64_t total);\n"
3291 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3292 " guestfs_progress_cb cb,\n"
3298 #: ../src/guestfs.pod:1686
3300 "Some long-running operations can generate progress messages. If this "
3301 "callback is registered, then it will be called each time a progress message "
3302 "is generated (usually two seconds after the operation started, and three "
3303 "times per second thereafter until it completes, although the frequency may "
3304 "change in future versions)."
3308 #: ../src/guestfs.pod:1692
3310 "The callback receives two numbers: C<position> and C<total>. The units of "
3311 "C<total> are not defined, although for some operations C<total> may relate "
3312 "in some way to the amount of data to be transferred (eg. in bytes or "
3313 "megabytes), and C<position> may be the portion which has been transferred."
3317 #: ../src/guestfs.pod:1698
3318 msgid "The only defined and stable parts of the API are:"
3322 #: ../src/guestfs.pod:1704
3324 "The callback can display to the user some type of progress bar or indicator "
3325 "which shows the ratio of C<position>:C<total>."
3329 #: ../src/guestfs.pod:1709
3330 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3334 #: ../src/guestfs.pod:1713
3336 "If any progress notification is sent during a call, then a final progress "
3337 "notification is always sent when C<position> = C<total> (I<unless> the call "
3338 "fails with an error)."
3342 #: ../src/guestfs.pod:1717
3344 "This is to simplify caller code, so callers can easily set the progress "
3345 "indicator to \"100%\" at the end of the operation, without requiring special "
3346 "code to detect this case."
3350 #: ../src/guestfs.pod:1723
3352 "The callback also receives the procedure number and serial number of the "
3353 "call. These are only useful for debugging protocol issues, and the callback "
3354 "can normally ignore them. The callback may want to print these numbers in "
3355 "error messages or debugging messages."
3359 #: ../src/guestfs.pod:1728
3360 msgid "PRIVATE DATA AREA"
3364 #: ../src/guestfs.pod:1730
3366 "You can attach named pieces of private data to the libguestfs handle, and "
3367 "fetch them by name for the lifetime of the handle. This is called the "
3368 "private data area and is only available from the C API."
3372 #: ../src/guestfs.pod:1734
3373 msgid "To attach a named piece of data, use the following call:"
3377 #: ../src/guestfs.pod:1736
3380 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3385 #: ../src/guestfs.pod:1738
3387 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3388 "pointer (which can be C<NULL>). Any previous item with the same name is "
3393 #: ../src/guestfs.pod:1742
3395 "You can use any C<key> you want, but names beginning with an underscore "
3396 "character are reserved for internal libguestfs purposes (for implementing "
3397 "language bindings). It is recommended to prefix the name with some unique "
3398 "string to avoid collisions with other users."
3402 #: ../src/guestfs.pod:1747
3403 msgid "To retrieve the pointer, use:"
3407 #: ../src/guestfs.pod:1749
3410 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3415 #: ../src/guestfs.pod:1751
3417 "This function returns C<NULL> if either no data is found associated with "
3418 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3423 #: ../src/guestfs.pod:1755
3425 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3426 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3427 "all. In particular, libguestfs does I<not> try to free the data when the "
3428 "handle is closed. If the data must be freed, then the caller must either "
3429 "free it before calling L</guestfs_close> or must set up a close callback to "
3430 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3431 "can be registered for a handle)."
3435 #: ../src/guestfs.pod:1763
3437 "The private data area is implemented using a hash table, and should be "
3438 "reasonably efficient for moderate numbers of keys."
3442 #: ../src/guestfs.pod:1766 ../src/guestfs.pod:1771
3447 #: ../src/guestfs.pod:1768
3449 "<!-- old anchor for the next section --> <a "
3450 "name=\"state_machine_and_low_level_event_api\"/>"
3454 #: ../src/guestfs.pod:1773
3455 msgid "ARCHITECTURE"
3459 #: ../src/guestfs.pod:1775
3461 "Internally, libguestfs is implemented by running an appliance (a special "
3462 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3463 "process of the main program."
3467 #: ../src/guestfs.pod:1779
3470 " ___________________\n"
3472 " | main program |\n"
3474 " | | child process / appliance\n"
3475 " | | __________________________\n"
3477 " +-------------------+ RPC | +-----------------+ |\n"
3478 " | libguestfs <--------------------> guestfsd | |\n"
3479 " | | | +-----------------+ |\n"
3480 " \\___________________/ | | Linux kernel | |\n"
3481 " | +--^--------------+ |\n"
3482 " \\_________|________________/\n"
3488 " \\______________/\n"
3493 #: ../src/guestfs.pod:1799
3495 "The library, linked to the main program, creates the child process and hence "
3496 "the appliance in the L</guestfs_launch> function."
3500 #: ../src/guestfs.pod:1802
3502 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3503 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3504 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3505 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3506 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3507 "attached to the qemu process which translates device access by the "
3508 "appliance's Linux kernel into accesses to the image."
3512 #: ../src/guestfs.pod:1811
3514 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3515 "Although the disk image you are attached to might also be used by some "
3516 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3517 "care if both libguestfs's qemu process and your virtual machine are trying "
3518 "to update the disk image at the same time, since these usually results in "
3519 "massive disk corruption)."
3523 #: ../src/guestfs.pod:1818
3524 msgid "STATE MACHINE"
3528 #: ../src/guestfs.pod:1820
3529 msgid "libguestfs uses a state machine to model the child process:"
3533 #: ../src/guestfs.pod:1822
3545 " / | \\ \\ guestfs_launch\n"
3546 " / | _\\__V______\n"
3548 " / | | LAUNCHING |\n"
3549 " / | \\___________/\n"
3551 " / | guestfs_launch\n"
3553 " ______ / __|____V\n"
3554 " / \\ ------> / \\\n"
3555 " | BUSY | | READY |\n"
3556 " \\______/ <------ \\________/\n"
3561 #: ../src/guestfs.pod:1844
3563 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3564 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3565 "(3) alternating between READY and BUSY as commands are issued to, and "
3566 "carried out by, the child process."
3570 #: ../src/guestfs.pod:1849
3572 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3573 "asynchronously at any time (eg. due to some internal error), and that causes "
3574 "the state to transition back to CONFIG."
3578 #: ../src/guestfs.pod:1853
3580 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3581 "issued when in the CONFIG state."
3585 #: ../src/guestfs.pod:1856
3587 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3588 "L</guestfs_launch> blocks until the child process is READY to accept "
3589 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3590 "moves the state from CONFIG to LAUNCHING while it is running."
3594 #: ../src/guestfs.pod:1862
3596 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3597 "state. These API calls block waiting for the command to be carried out "
3598 "(ie. the state to transition to BUSY and then back to READY). There are no "
3599 "non-blocking versions, and no way to issue more than one command per handle "
3604 #: ../src/guestfs.pod:1868
3606 "Finally, the child process sends asynchronous messages back to the main "
3607 "program, such as kernel log messages. You can register a callback to "
3608 "receive these messages."
3612 #: ../src/guestfs.pod:1872
3617 #: ../src/guestfs.pod:1874
3618 msgid "COMMUNICATION PROTOCOL"
3622 #: ../src/guestfs.pod:1876
3624 "Don't rely on using this protocol directly. This section documents how it "
3625 "currently works, but it may change at any time."
3629 #: ../src/guestfs.pod:1879
3631 "The protocol used to talk between the library and the daemon running inside "
3632 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3633 "1014, RFC 1832, RFC 4506)."
3637 #: ../src/guestfs.pod:1883
3639 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3640 "this file is automatically generated)."
3644 #: ../src/guestfs.pod:1886
3646 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3647 "and C<FileOut> parameters, which are handled with very simple request/reply "
3648 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3649 "parameters, which use the same request and reply messages, but they may also "
3650 "be followed by files sent using a chunked encoding."
3654 #: ../src/guestfs.pod:1893
3655 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3659 #: ../src/guestfs.pod:1895
3660 msgid "For ordinary functions, the request message is:"
3664 #: ../src/guestfs.pod:1897
3667 " total length (header + arguments,\n"
3668 " but not including the length word itself)\n"
3669 " struct guestfs_message_header (encoded as XDR)\n"
3670 " struct guestfs_<foo>_args (encoded as XDR)\n"
3675 #: ../src/guestfs.pod:1902
3677 "The total length field allows the daemon to allocate a fixed size buffer "
3678 "into which it slurps the rest of the message. As a result, the total length "
3679 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3680 "effective size of any request is limited to somewhere under this size."
3684 #: ../src/guestfs.pod:1908
3686 "Note also that many functions don't take any arguments, in which case the "
3687 "C<guestfs_I<foo>_args> is completely omitted."
3691 #: ../src/guestfs.pod:1911
3693 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3694 "receiver knows what type of args structure to expect, or none at all."
3698 #: ../src/guestfs.pod:1915
3700 "For functions that take optional arguments, the optional arguments are "
3701 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3702 "arguments. A bitmask in the header indicates which optional arguments are "
3703 "meaningful. The bitmask is also checked to see if it contains bits set "
3704 "which the daemon does not know about (eg. if more optional arguments were "
3705 "added in a later version of the library), and this causes the call to be "
3710 #: ../src/guestfs.pod:1923
3711 msgid "The reply message for ordinary functions is:"
3715 #: ../src/guestfs.pod:1925
3718 " total length (header + ret,\n"
3719 " but not including the length word itself)\n"
3720 " struct guestfs_message_header (encoded as XDR)\n"
3721 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3726 #: ../src/guestfs.pod:1930
3728 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3729 "functions that return no formal return values."
3733 #: ../src/guestfs.pod:1933
3734 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3738 #: ../src/guestfs.pod:1936
3740 "In the case of an error, a flag is set in the header, and the reply message "
3741 "is slightly changed:"
3745 #: ../src/guestfs.pod:1939
3748 " total length (header + error,\n"
3749 " but not including the length word itself)\n"
3750 " struct guestfs_message_header (encoded as XDR)\n"
3751 " struct guestfs_message_error (encoded as XDR)\n"
3756 #: ../src/guestfs.pod:1944
3758 "The C<guestfs_message_error> structure contains the error message as a "
3763 #: ../src/guestfs.pod:1947
3764 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3768 #: ../src/guestfs.pod:1949
3770 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3771 "The normal request message is sent (see above). However this is followed by "
3772 "a sequence of file chunks."
3776 #: ../src/guestfs.pod:1953
3779 " total length (header + arguments,\n"
3780 " but not including the length word itself,\n"
3781 " and not including the chunks)\n"
3782 " struct guestfs_message_header (encoded as XDR)\n"
3783 " struct guestfs_<foo>_args (encoded as XDR)\n"
3784 " sequence of chunks for FileIn param #0\n"
3785 " sequence of chunks for FileIn param #1 etc.\n"
3790 #: ../src/guestfs.pod:1961
3791 msgid "The \"sequence of chunks\" is:"
3795 #: ../src/guestfs.pod:1963
3798 " length of chunk (not including length word itself)\n"
3799 " struct guestfs_chunk (encoded as XDR)\n"
3800 " length of chunk\n"
3801 " struct guestfs_chunk (encoded as XDR)\n"
3803 " length of chunk\n"
3804 " struct guestfs_chunk (with data.data_len == 0)\n"
3809 #: ../src/guestfs.pod:1971
3811 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3812 "is set in the final chunk to indicate either successful completion or early "
3817 #: ../src/guestfs.pod:1975
3819 "At time of writing there are no functions that have more than one FileIn "
3820 "parameter. However this is (theoretically) supported, by sending the "
3821 "sequence of chunks for each FileIn parameter one after another (from left to "
3826 #: ../src/guestfs.pod:1980
3828 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3829 "transfer. The library does this by sending a chunk with a special flag set "
3830 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3831 "RPC, does I<not> send any reply, and goes back to reading the next request."
3835 #: ../src/guestfs.pod:1986
3837 "The daemon may also cancel. It does this by writing a special word "
3838 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3839 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3840 "cancel chunk). The special word is chosen so that even if cancellation "
3841 "happens right at the end of the transfer (after the library has finished "
3842 "writing and has started listening for the reply), the \"spurious\" cancel "
3843 "flag will not be confused with the reply message."
3847 #: ../src/guestfs.pod:1995
3849 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3850 "limit), and also files where the size is not known in advance (eg. from "
3851 "pipes or sockets). However the chunks are rather small "
3852 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3853 "to keep much in memory."
3857 #: ../src/guestfs.pod:2001
3858 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3862 #: ../src/guestfs.pod:2003
3864 "The protocol for FileOut parameters is exactly the same as for FileIn "
3865 "parameters, but with the roles of daemon and library reversed."
3869 #: ../src/guestfs.pod:2006
3872 " total length (header + ret,\n"
3873 " but not including the length word itself,\n"
3874 " and not including the chunks)\n"
3875 " struct guestfs_message_header (encoded as XDR)\n"
3876 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3877 " sequence of chunks for FileOut param #0\n"
3878 " sequence of chunks for FileOut param #1 etc.\n"
3883 #: ../src/guestfs.pod:2014
3884 msgid "INITIAL MESSAGE"
3888 #: ../src/guestfs.pod:2016
3890 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3891 "which indicates that the guest and daemon is alive. This is what "
3892 "L</guestfs_launch> waits for."
3896 #: ../src/guestfs.pod:2020
3897 msgid "PROGRESS NOTIFICATION MESSAGES"
3901 #: ../src/guestfs.pod:2022
3903 "The daemon may send progress notification messages at any time. These are "
3904 "distinguished by the normal length word being replaced by "
3905 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3909 #: ../src/guestfs.pod:2026
3911 "The library turns them into progress callbacks (see "
3912 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3913 "discards them if not."
3917 #: ../src/guestfs.pod:2030
3919 "The daemon self-limits the frequency of progress messages it sends (see "
3920 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3925 #: ../src/guestfs.pod:2034
3926 msgid "LIBGUESTFS VERSION NUMBERS"
3930 #: ../src/guestfs.pod:2036
3932 "Since April 2010, libguestfs has started to make separate development and "
3933 "stable releases, along with corresponding branches in our git repository. "
3934 "These separate releases can be identified by version number:"
3938 #: ../src/guestfs.pod:2041
3941 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3942 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3948 " | `-------- sub-version\n"
3950 " `------ always '1' because we don't change the ABI\n"
3955 #: ../src/guestfs.pod:2052
3956 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3960 #: ../src/guestfs.pod:2054
3962 "As time passes we cherry pick fixes from the development branch and backport "
3963 "those into the stable branch, the effect being that the stable branch should "
3964 "get more stable and less buggy over time. So the stable releases are ideal "
3965 "for people who don't need new features but would just like the software to "
3970 #: ../src/guestfs.pod:2060
3971 msgid "Our criteria for backporting changes are:"
3975 #: ../src/guestfs.pod:2066
3977 "Documentation changes which don't affect any code are backported unless the "
3978 "documentation refers to a future feature which is not in stable."
3982 #: ../src/guestfs.pod:2072
3984 "Bug fixes which are not controversial, fix obvious problems, and have been "
3985 "well tested are backported."
3989 #: ../src/guestfs.pod:2077
3991 "Simple rearrangements of code which shouldn't affect how it works get "
3992 "backported. This is so that the code in the two branches doesn't get too "
3993 "far out of step, allowing us to backport future fixes more easily."
3997 #: ../src/guestfs.pod:2083
3999 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4000 "exceptional case: the new feature is required in order to implement an "
4001 "important bug fix."
4005 #: ../src/guestfs.pod:2089
4007 "A new stable branch starts when we think the new features in development are "
4008 "substantial and compelling enough over the current stable branch to warrant "
4009 "it. When that happens we create new stable and development versions 1.N.0 "
4010 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4011 "stable at this point, but by backporting fixes from development, that branch "
4012 "will stabilize over time."
4016 #: ../src/guestfs.pod:2097
4017 msgid "EXTENDING LIBGUESTFS"
4021 #: ../src/guestfs.pod:2099
4022 msgid "ADDING A NEW API ACTION"
4026 #: ../src/guestfs.pod:2101
4028 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4029 "documentation) are generated, and this makes it easy to extend the "
4034 #: ../src/guestfs.pod:2105
4035 msgid "To add a new API action there are two changes:"
4039 #: ../src/guestfs.pod:2111
4041 "You need to add a description of the call (name, parameters, return type, "
4042 "tests, documentation) to C<generator/generator_actions.ml>."
4046 #: ../src/guestfs.pod:2114
4048 "There are two sorts of API action, depending on whether the call goes "
4049 "through to the daemon in the appliance, or is serviced entirely by the "
4050 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4051 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4052 "an example of the latter, since a trace flag is maintained in the handle and "
4053 "all tracing is done on the library side."
4057 #: ../src/guestfs.pod:2122
4059 "Most new actions are of the first type, and get added to the "
4060 "C<daemon_functions> list. Each function has a unique procedure number used "
4061 "in the RPC protocol which is assigned to that action when we publish "
4062 "libguestfs and cannot be reused. Take the latest procedure number and "
4067 #: ../src/guestfs.pod:2128
4069 "For library-only actions of the second type, add to the "
4070 "C<non_daemon_functions> list. Since these functions are serviced by the "
4071 "library and do not travel over the RPC mechanism to the daemon, these "
4072 "functions do not need a procedure number, and so the procedure number is set "
4077 #: ../src/guestfs.pod:2136
4078 msgid "Implement the action (in C):"
4082 #: ../src/guestfs.pod:2138
4084 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4085 "C<daemon/> directory."
4089 #: ../src/guestfs.pod:2141
4091 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4092 "(note: double underscore) in the C<src/> directory."
4096 #: ../src/guestfs.pod:2144
4097 msgid "In either case, use another function as an example of what to do."
4101 #: ../src/guestfs.pod:2148
4102 msgid "After making these changes, use C<make> to compile."
4106 #: ../src/guestfs.pod:2150
4108 "Note that you don't need to implement the RPC, language bindings, manual "
4109 "pages or anything else. It's all automatically generated from the OCaml "
4114 #: ../src/guestfs.pod:2154
4115 msgid "ADDING TESTS FOR AN API ACTION"
4119 #: ../src/guestfs.pod:2156
4121 "You can supply zero or as many tests as you want per API call. The tests "
4122 "can either be added as part of the API description "
4123 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4124 "drop a script into C<regressions/>. Note that adding a script to "
4125 "C<regressions/> is slower, so if possible use the first method."
4129 #: ../src/guestfs.pod:2162
4131 "The following describes the test environment used when you add an API test "
4132 "in C<generator_actions.ml>."
4136 #: ../src/guestfs.pod:2165
4137 msgid "The test environment has 4 block devices:"
4141 #: ../src/guestfs.pod:2169
4142 msgid "C</dev/sda> 500MB"
4146 #: ../src/guestfs.pod:2171
4147 msgid "General block device for testing."
4151 #: ../src/guestfs.pod:2173
4152 msgid "C</dev/sdb> 50MB"
4156 #: ../src/guestfs.pod:2175
4158 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4163 #: ../src/guestfs.pod:2178
4164 msgid "C</dev/sdc> 10MB"
4168 #: ../src/guestfs.pod:2180
4169 msgid "Used in a few tests where two block devices are needed."
4173 #: ../src/guestfs.pod:2182
4178 #: ../src/guestfs.pod:2184
4179 msgid "ISO with fixed content (see C<images/test.iso>)."
4183 #: ../src/guestfs.pod:2188
4185 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4186 "appliance and block devices are reused between tests. So don't try testing "
4187 "L</guestfs_kill_subprocess> :-x"
4191 #: ../src/guestfs.pod:2192
4193 "Each test starts with an initial scenario, selected using one of the "
4194 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4195 "initialize the disks mentioned above in a particular way as documented in "
4196 "C<generator_types.ml>. You should not assume anything about the previous "
4197 "contents of other disks that are not initialized."
4201 #: ../src/guestfs.pod:2198
4203 "You can add a prerequisite clause to any individual test. This is a "
4204 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4205 "if testing a command which might not work on all variations of libguestfs "
4206 "builds. A test that has prerequisite of C<Always> means to run "
4211 #: ../src/guestfs.pod:2204
4213 "In addition, packagers can skip individual tests by setting environment "
4214 "variables before running C<make check>."
4218 #: ../src/guestfs.pod:2207
4221 " SKIP_TEST_<CMD>_<NUM>=1\n"
4226 #: ../src/guestfs.pod:2209
4227 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4231 #: ../src/guestfs.pod:2211
4236 #: ../src/guestfs.pod:2213
4239 " SKIP_TEST_<CMD>=1\n"
4244 #: ../src/guestfs.pod:2215
4245 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4249 #: ../src/guestfs.pod:2217
4250 msgid "Packagers can run only certain tests by setting for example:"
4254 #: ../src/guestfs.pod:2219
4257 " TEST_ONLY=\"vfs_type zerofree\"\n"
4262 #: ../src/guestfs.pod:2221
4264 "See C<capitests/tests.c> for more details of how these environment variables "
4269 #: ../src/guestfs.pod:2224
4270 msgid "DEBUGGING NEW API ACTIONS"
4274 #: ../src/guestfs.pod:2226
4275 msgid "Test new actions work before submitting them."
4279 #: ../src/guestfs.pod:2228
4280 msgid "You can use guestfish to try out new commands."
4284 #: ../src/guestfs.pod:2230
4286 "Debugging the daemon is a problem because it runs inside a minimal "
4287 "environment. However you can fprintf messages in the daemon to stderr, and "
4288 "they will show up if you use C<guestfish -v>."
4292 #: ../src/guestfs.pod:2234
4293 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4297 #: ../src/guestfs.pod:2236
4299 "Our C source code generally adheres to some basic code-formatting "
4300 "conventions. The existing code base is not totally consistent on this "
4301 "front, but we do prefer that contributed code be formatted similarly. In "
4302 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4303 "indentation level, and other than that, follow the K&R style."
4307 #: ../src/guestfs.pod:2242
4309 "If you use Emacs, add the following to one of one of your start-up files "
4310 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4314 #: ../src/guestfs.pod:2245
4317 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4318 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4319 " (add-hook 'find-file-hook\n"
4320 " '(lambda () (if (and buffer-file-name\n"
4321 " (string-match \"/libguestfs\\\\>\"\n"
4322 " (buffer-file-name))\n"
4323 " (not (string-equal mode-name \"Change Log\"))\n"
4324 " (not (string-equal mode-name \"Makefile\")))\n"
4325 " (setq indent-tabs-mode nil))))\n"
4330 #: ../src/guestfs.pod:2255
4333 " ;;; When editing C sources in libguestfs, use this style.\n"
4334 " (defun libguestfs-c-mode ()\n"
4335 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4337 " (c-set-style \"K&R\")\n"
4338 " (setq c-indent-level 2)\n"
4339 " (setq c-basic-offset 2))\n"
4340 " (add-hook 'c-mode-hook\n"
4341 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4342 " (buffer-file-name))\n"
4343 " (libguestfs-c-mode))))\n"
4348 #: ../src/guestfs.pod:2267
4349 msgid "Enable warnings when compiling (and fix any problems this finds):"
4353 #: ../src/guestfs.pod:2270
4356 " ./configure --enable-gcc-warnings\n"
4361 #: ../src/guestfs.pod:2272
4362 msgid "Useful targets are:"
4366 #: ../src/guestfs.pod:2274
4369 " make syntax-check # checks the syntax of the C code\n"
4370 " make check # runs the test suite\n"
4375 #: ../src/guestfs.pod:2277
4376 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4380 #: ../src/guestfs.pod:2279
4382 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4383 "which are used to do shell quoting."
4387 #: ../src/guestfs.pod:2284
4392 #: ../src/guestfs.pod:2286
4394 "Simple shell quoted string. Any spaces or other shell characters are "
4399 #: ../src/guestfs.pod:2289
4404 #: ../src/guestfs.pod:2291
4406 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4411 #: ../src/guestfs.pod:2296 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4412 msgid "For example:"
4416 #: ../src/guestfs.pod:2298
4419 " asprintf (&cmd, \"cat %R\", path);\n"
4424 #: ../src/guestfs.pod:2300
4425 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4429 #: ../src/guestfs.pod:2302
4431 "I<Note:> Do I<not> use these when you are passing parameters to the "
4432 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4433 "because they are not passed via the shell (instead, straight to exec). You "
4434 "probably want to use the C<sysroot_path()> function however."
4438 #: ../src/guestfs.pod:2308
4439 msgid "SUBMITTING YOUR NEW API ACTIONS"
4443 #: ../src/guestfs.pod:2310
4445 "Submit patches to the mailing list: "
4446 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
4447 "L<rjones@redhat.com>."
4451 #: ../src/guestfs.pod:2314
4452 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
4456 #: ../src/guestfs.pod:2316
4457 msgid "We support i18n (gettext anyhow) in the library."
4461 #: ../src/guestfs.pod:2318
4463 "However many messages come from the daemon, and we don't translate those at "
4464 "the moment. One reason is that the appliance generally has all locale files "
4465 "removed from it, because they take up a lot of space. So we'd have to readd "
4466 "some of those, as well as copying our PO files into the appliance."
4470 #: ../src/guestfs.pod:2324
4472 "Debugging messages are never translated, since they are intended for the "
4477 #: ../src/guestfs.pod:2327
4478 msgid "SOURCE CODE SUBDIRECTORIES"
4482 #: ../src/guestfs.pod:2331
4483 msgid "C<appliance>"
4487 #: ../src/guestfs.pod:2333
4488 msgid "The libguestfs appliance, build scripts and so on."
4492 #: ../src/guestfs.pod:2335
4493 msgid "C<capitests>"
4497 #: ../src/guestfs.pod:2337
4498 msgid "Automated tests of the C API."
4502 #: ../src/guestfs.pod:2339
4507 #: ../src/guestfs.pod:2341
4509 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
4514 #: ../src/guestfs.pod:2344
4519 #: ../src/guestfs.pod:2346
4521 "Safety and liveness tests of components that libguestfs depends upon (not of "
4522 "libguestfs itself). Mainly this is for qemu and the kernel."
4526 #: ../src/guestfs.pod:2349
4531 #: ../src/guestfs.pod:2351
4532 msgid "Outside contributions, experimental parts."
4536 #: ../src/guestfs.pod:2353
4541 #: ../src/guestfs.pod:2355
4543 "The daemon that runs inside the libguestfs appliance and carries out "
4548 #: ../src/guestfs.pod:2358
4553 #: ../src/guestfs.pod:2360
4554 msgid "L<virt-df(1)> command and documentation."
4558 #: ../src/guestfs.pod:2362
4563 #: ../src/guestfs.pod:2364
4564 msgid "C API example code."
4568 #: ../src/guestfs.pod:2366
4573 #: ../src/guestfs.pod:2368
4574 msgid "L<guestfish(1)>, the command-line shell."
4578 #: ../src/guestfs.pod:2370
4583 #: ../src/guestfs.pod:2372
4584 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
4588 #: ../src/guestfs.pod:2374
4589 msgid "C<generator>"
4593 #: ../src/guestfs.pod:2376
4595 "The crucially important generator, used to automatically generate large "
4596 "amounts of boilerplate C code for things like RPC and bindings."
4600 #: ../src/guestfs.pod:2379
4605 #: ../src/guestfs.pod:2381
4606 msgid "Files used by the test suite."
4610 #: ../src/guestfs.pod:2383
4611 msgid "Some \"phony\" guest images which we test against."
4615 #: ../src/guestfs.pod:2385
4616 msgid "C<inspector>"
4620 #: ../src/guestfs.pod:2387
4621 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
4625 #: ../src/guestfs.pod:2389
4630 #: ../src/guestfs.pod:2391
4631 msgid "M4 macros used by autoconf."
4635 #: ../src/guestfs.pod:2393
4640 #: ../src/guestfs.pod:2395
4641 msgid "Translations of simple gettext strings."
4645 #: ../src/guestfs.pod:2397
4650 #: ../src/guestfs.pod:2399
4652 "The build infrastructure and PO files for translations of manpages and POD "
4653 "files. Eventually this will be combined with the C<po> directory, but that "
4654 "is rather complicated."
4658 #: ../src/guestfs.pod:2403
4659 msgid "C<regressions>"
4663 #: ../src/guestfs.pod:2405
4664 msgid "Regression tests."
4668 #: ../src/guestfs.pod:2407
4673 #: ../src/guestfs.pod:2409
4674 msgid "L<virt-rescue(1)> command and documentation."
4678 #: ../src/guestfs.pod:2411
4683 #: ../src/guestfs.pod:2413
4684 msgid "Source code to the C library."
4688 #: ../src/guestfs.pod:2415
4693 #: ../src/guestfs.pod:2417
4694 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
4698 #: ../src/guestfs.pod:2419
4699 msgid "C<test-tool>"
4703 #: ../src/guestfs.pod:2421
4705 "Test tool for end users to test if their qemu/kernel combination will work "
4710 #: ../src/guestfs.pod:2424
4715 #: ../src/guestfs.pod:2426
4720 #: ../src/guestfs.pod:2428
4725 #: ../src/guestfs.pod:2430
4730 #: ../src/guestfs.pod:2432
4735 #: ../src/guestfs.pod:2434
4740 #: ../src/guestfs.pod:2436
4745 #: ../src/guestfs.pod:2438
4750 #: ../src/guestfs.pod:2440
4751 msgid "Language bindings."
4755 #: ../src/guestfs.pod:2444 ../fish/guestfish.pod:965 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:375
4756 msgid "ENVIRONMENT VARIABLES"
4760 #: ../src/guestfs.pod:2448 ../fish/guestfish.pod:991
4761 msgid "LIBGUESTFS_APPEND"
4765 #: ../src/guestfs.pod:2450 ../fish/guestfish.pod:993
4766 msgid "Pass additional options to the guest kernel."
4770 #: ../src/guestfs.pod:2452 ../fish/guestfish.pod:995
4771 msgid "LIBGUESTFS_DEBUG"
4775 #: ../src/guestfs.pod:2454
4777 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
4778 "effect as calling C<guestfs_set_verbose (g, 1)>."
4782 #: ../src/guestfs.pod:2457 ../fish/guestfish.pod:1000
4783 msgid "LIBGUESTFS_MEMSIZE"
4787 #: ../src/guestfs.pod:2459 ../fish/guestfish.pod:1002
4788 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
4792 #: ../src/guestfs.pod:2462 ../fish/guestfish.pod:1005
4795 " LIBGUESTFS_MEMSIZE=700\n"
4800 #: ../src/guestfs.pod:2464 ../fish/guestfish.pod:1007
4801 msgid "LIBGUESTFS_PATH"
4805 #: ../src/guestfs.pod:2466
4807 "Set the path that libguestfs uses to search for a supermin appliance. See "
4808 "the discussion of paths in section L</PATH> above."
4812 #: ../src/guestfs.pod:2469 ../fish/guestfish.pod:1012
4813 msgid "LIBGUESTFS_QEMU"
4817 #: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1014
4819 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4820 "which was found at compile time by the configure script is used."
4824 #: ../src/guestfs.pod:2475
4825 msgid "See also L</QEMU WRAPPERS> above."
4829 #: ../src/guestfs.pod:2477 ../fish/guestfish.pod:1018
4830 msgid "LIBGUESTFS_TRACE"
4834 #: ../src/guestfs.pod:2479
4836 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4837 "effect as calling C<guestfs_set_trace (g, 1)>."
4841 #: ../src/guestfs.pod:2482 ../fish/guestfish.pod:1027
4846 #: ../src/guestfs.pod:2484 ../fish/guestfish.pod:1029
4847 msgid "Location of temporary directory, defaults to C</tmp>."
4851 #: ../src/guestfs.pod:2486 ../fish/guestfish.pod:1031
4853 "If libguestfs was compiled to use the supermin appliance then the real "
4854 "appliance is cached in this directory, shared between all handles belonging "
4855 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4856 "use in case C</tmp> is not large enough."
4860 #: ../src/guestfs.pod:2494 ../fish/guestfish.pod:1089 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:395 ../tools/virt-win-reg.pl:572 ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
4865 #: ../src/guestfs.pod:2496
4867 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4868 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4869 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
4870 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4871 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4872 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4873 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4877 #: ../src/guestfs.pod:2519
4879 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4880 "L<lvm(8)>, L<disktype(1)>."
4884 #: ../src/guestfs.pod:2526 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
4889 #: ../src/guestfs.pod:2528
4890 msgid "To get a list of bugs against libguestfs use this link:"
4894 #: ../src/guestfs.pod:2530
4895 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4899 #: ../src/guestfs.pod:2532
4900 msgid "To report a new bug against libguestfs use this link:"
4904 #: ../src/guestfs.pod:2534
4905 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4909 #: ../src/guestfs.pod:2536
4910 msgid "When reporting a bug, please check:"
4914 #: ../src/guestfs.pod:2542
4915 msgid "That the bug hasn't been reported already."
4919 #: ../src/guestfs.pod:2546
4920 msgid "That you are testing a recent version."
4924 #: ../src/guestfs.pod:2550
4925 msgid "Describe the bug accurately, and give a way to reproduce it."
4929 #: ../src/guestfs.pod:2554
4931 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4936 #: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1108 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4941 #: ../src/guestfs.pod:2561 ../fish/guestfish.pod:1110 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4942 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4946 #: ../src/guestfs.pod:2563 ../fish/guestfish.pod:1112 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:411 ../tools/virt-win-reg.pl:602 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
4951 #: ../src/guestfs.pod:2565 ../fish/guestfish.pod:1114 ../fuse/guestmount.pod:250
4952 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4956 #: ../src/guestfs.pod:2568
4958 "This library is free software; you can redistribute it and/or modify it "
4959 "under the terms of the GNU Lesser General Public License as published by the "
4960 "Free Software Foundation; either version 2 of the License, or (at your "
4961 "option) any later version."
4965 #: ../src/guestfs.pod:2573
4967 "This library is distributed in the hope that it will be useful, but WITHOUT "
4968 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4969 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4974 #: ../src/guestfs.pod:2578
4976 "You should have received a copy of the GNU Lesser General Public License "
4977 "along with this library; if not, write to the Free Software Foundation, "
4978 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4982 #: ../src/guestfs-actions.pod:1
4983 msgid "guestfs_add_cdrom"
4987 #: ../src/guestfs-actions.pod:3
4991 " guestfs_add_cdrom (guestfs_h *g,\n"
4992 " const char *filename);\n"
4997 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4998 msgid "This function adds a virtual CD-ROM disk image to the guest."
5002 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5003 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5007 #: ../src/guestfs-actions.pod:17
5009 "This call checks for the existence of C<filename>. This stops you from "
5010 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5011 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5016 #: ../src/guestfs-actions.pod:24
5018 "If you just want to add an ISO file (often you use this as an efficient way "
5019 "to transfer large files into the guest), then you should probably use "
5020 "C<guestfs_add_drive_ro> instead."
5024 #: ../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:1679 ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2384 ../src/guestfs-actions.pod:2445 ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:3223 ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3413 ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3469 ../src/guestfs-actions.pod:3505 ../src/guestfs-actions.pod:3577 ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3637 ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3692 ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3730 ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3777 ../src/guestfs-actions.pod:3813 ../src/guestfs-actions.pod:3829 ../src/guestfs-actions.pod:3842 ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3874 ../src/guestfs-actions.pod:3967 ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4069 ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4117 ../src/guestfs-actions.pod:4131 ../src/guestfs-actions.pod:4148 ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4229 ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4333 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4371 ../src/guestfs-actions.pod:4383 ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4428 ../src/guestfs-actions.pod:4443 ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4513 ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4593 ../src/guestfs-actions.pod:4639 ../src/guestfs-actions.pod:4653 ../src/guestfs-actions.pod:4681 ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:4716 ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4929 ../src/guestfs-actions.pod:4947 ../src/guestfs-actions.pod:4979 ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5075 ../src/guestfs-actions.pod:5089 ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5411 ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5437 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5479 ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5519 ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5556 ../src/guestfs-actions.pod:5579 ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:5656 ../src/guestfs-actions.pod:5673 ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:5725 ../src/guestfs-actions.pod:5744 ../src/guestfs-actions.pod:5768 ../src/guestfs-actions.pod:5783 ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5817 ../src/guestfs-actions.pod:5854 ../src/guestfs-actions.pod:5877 ../src/guestfs-actions.pod:5903 ../src/guestfs-actions.pod:6011 ../src/guestfs-actions.pod:6132 ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6170 ../src/guestfs-actions.pod:6192 ../src/guestfs-actions.pod:6205 ../src/guestfs-actions.pod:6218 ../src/guestfs-actions.pod:6231 ../src/guestfs-actions.pod:6246 ../src/guestfs-actions.pod:6305 ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6338 ../src/guestfs-actions.pod:6354 ../src/guestfs-actions.pod:6371 ../src/guestfs-actions.pod:6384 ../src/guestfs-actions.pod:6404 ../src/guestfs-actions.pod:6440 ../src/guestfs-actions.pod:6454 ../src/guestfs-actions.pod:6495 ../src/guestfs-actions.pod:6508 ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6560 ../src/guestfs-actions.pod:6596 ../src/guestfs-actions.pod:6715 ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:6802 ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6893 ../src/guestfs-actions.pod:6947 ../src/guestfs-actions.pod:6973 ../src/guestfs-actions.pod:7039 ../src/guestfs-actions.pod:7058 ../src/guestfs-actions.pod:7087
5025 msgid "This function returns 0 on success or -1 on error."
5029 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261
5031 "This function is deprecated. In new code, use the "
5032 "L</guestfs_add_drive_opts> call instead."
5036 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1918 ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:4188 ../src/guestfs-actions.pod:6981 ../src/guestfs-actions.pod:7150 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168 ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1303 ../fish/guestfish-actions.pod:1317 ../fish/guestfish-actions.pod:2817 ../fish/guestfish-actions.pod:4630 ../fish/guestfish-actions.pod:4727
5038 "Deprecated functions will not be removed from the API, but the fact that "
5039 "they are deprecated indicates that there are problems with correct use of "
5044 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2091 ../src/guestfs-actions.pod:3225 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:4480 ../src/guestfs-actions.pod:5558 ../src/guestfs-actions.pod:5675 ../src/guestfs-actions.pod:5785 ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6373 ../src/guestfs-actions.pod:6895
5045 msgid "(Added in 0.3)"
5049 #: ../src/guestfs-actions.pod:41
5050 msgid "guestfs_add_domain"
5054 #: ../src/guestfs-actions.pod:43
5058 " guestfs_add_domain (guestfs_h *g,\n"
5059 " const char *dom,\n"
5065 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137 ../src/guestfs-actions.pod:4202
5067 "You may supply a list of optional arguments to this call. Use zero or more "
5068 "of the following pairs of parameters, and terminate the list with C<-1> on "
5069 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5073 #: ../src/guestfs-actions.pod:53
5076 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5077 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5078 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5083 #: ../src/guestfs-actions.pod:57
5085 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5086 "It works by connecting to libvirt, requesting the domain and domain XML from "
5087 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5092 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5094 "The number of disks added is returned. This operation is atomic: if an "
5095 "error is returned, then no disks are added."
5099 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5101 "This function does some minimal checks to make sure the libvirt domain is "
5102 "not running (unless C<readonly> is true). In a future version we will try "
5103 "to acquire the libvirt lock on each disk."
5107 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5109 "Disks must be accessible locally. This often means that adding disks from a "
5110 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5111 "unless those disks are accessible via the same device path locally too."
5115 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5117 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5118 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5119 "default libvirt URI (or one set through an environment variable, see the "
5120 "libvirt documentation for full details)."
5124 #: ../src/guestfs-actions.pod:80
5126 "The other optional parameters are passed directly through to "
5127 "C<guestfs_add_drive_opts>."
5131 #: ../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:1658 ../src/guestfs-actions.pod:1861 ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2371 ../src/guestfs-actions.pod:2659 ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:4616 ../src/guestfs-actions.pod:4753 ../src/guestfs-actions.pod:5159 ../src/guestfs-actions.pod:5185 ../src/guestfs-actions.pod:6481 ../src/guestfs-actions.pod:6906 ../src/guestfs-actions.pod:6919 ../src/guestfs-actions.pod:6932
5132 msgid "On error this function returns -1."
5136 #: ../src/guestfs-actions.pod:85
5137 msgid "(Added in 1.7.4)"
5141 #: ../src/guestfs-actions.pod:87
5142 msgid "guestfs_add_domain_va"
5146 #: ../src/guestfs-actions.pod:89
5150 " guestfs_add_domain_va (guestfs_h *g,\n"
5151 " const char *dom,\n"
5157 #: ../src/guestfs-actions.pod:94
5158 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5162 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:4243 ../src/guestfs-actions.pod:4255
5163 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5167 #: ../src/guestfs-actions.pod:98
5168 msgid "guestfs_add_domain_argv"
5172 #: ../src/guestfs-actions.pod:100
5176 " guestfs_add_domain_argv (guestfs_h *g,\n"
5177 " const char *dom,\n"
5178 " const struct guestfs_add_domain_argv *optargs);\n"
5183 #: ../src/guestfs-actions.pod:105
5184 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5188 #: ../src/guestfs-actions.pod:109
5189 msgid "guestfs_add_drive"
5193 #: ../src/guestfs-actions.pod:111
5197 " guestfs_add_drive (guestfs_h *g,\n"
5198 " const char *filename);\n"
5203 #: ../src/guestfs-actions.pod:115
5205 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5206 "optional parameters, so the disk is added writable, with the format being "
5207 "detected automatically."
5211 #: ../src/guestfs-actions.pod:119
5213 "Automatic detection of the format opens you up to a potential security hole "
5214 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5215 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5216 "you should think about replacing calls to this function with calls to "
5217 "C<guestfs_add_drive_opts>, and specifying the format."
5221 #: ../src/guestfs-actions.pod:130
5222 msgid "guestfs_add_drive_opts"
5226 #: ../src/guestfs-actions.pod:132
5230 " guestfs_add_drive_opts (guestfs_h *g,\n"
5231 " const char *filename,\n"
5237 #: ../src/guestfs-actions.pod:142
5240 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5241 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5242 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5247 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
5249 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5250 "The first time you call this function, the disk appears as C</dev/sda>, the "
5251 "second time as C</dev/sdb>, and so on."
5255 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
5257 "You don't necessarily need to be root when using libguestfs. However you "
5258 "obviously do need sufficient permissions to access the filename for whatever "
5259 "operations you want to perform (ie. read access if you just want to read the "
5260 "image or write access if you want to modify the image)."
5264 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
5265 msgid "This call checks that C<filename> exists."
5269 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2828
5270 msgid "The optional arguments are:"
5274 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
5279 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
5281 "If true then the image is treated as read-only. Writes are still allowed, "
5282 "but they are stored in a temporary snapshot overlay which is discarded at "
5283 "the end. The disk that you add is not modified."
5287 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
5292 #: ../src/guestfs-actions.pod:171
5294 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5295 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5296 "Possible formats include C<raw> and C<qcow2>."
5300 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
5302 "Automatic detection of the format opens you up to a potential security hole "
5303 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5304 "RHBZ#642934. Specifying the format closes this security hole."
5308 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
5313 #: ../src/guestfs-actions.pod:182
5315 "This rarely-used option lets you emulate the behaviour of the deprecated "
5316 "C<guestfs_add_drive_with_if> call (q.v.)"
5320 #: ../src/guestfs-actions.pod:189
5321 msgid "(Added in 1.5.23)"
5325 #: ../src/guestfs-actions.pod:191
5326 msgid "guestfs_add_drive_opts_va"
5330 #: ../src/guestfs-actions.pod:193
5334 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5335 " const char *filename,\n"
5341 #: ../src/guestfs-actions.pod:198
5342 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5346 #: ../src/guestfs-actions.pod:202
5347 msgid "guestfs_add_drive_opts_argv"
5351 #: ../src/guestfs-actions.pod:204
5355 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5356 " const char *filename,\n"
5357 " const struct guestfs_add_drive_opts_argv "
5363 #: ../src/guestfs-actions.pod:209
5364 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5368 #: ../src/guestfs-actions.pod:213
5369 msgid "guestfs_add_drive_ro"
5373 #: ../src/guestfs-actions.pod:215
5377 " guestfs_add_drive_ro (guestfs_h *g,\n"
5378 " const char *filename);\n"
5383 #: ../src/guestfs-actions.pod:219
5385 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5386 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5387 "disk is added read-only, with the format being detected automatically."
5391 #: ../src/guestfs-actions.pod:226
5392 msgid "(Added in 1.0.38)"
5396 #: ../src/guestfs-actions.pod:228
5397 msgid "guestfs_add_drive_ro_with_if"
5401 #: ../src/guestfs-actions.pod:230
5405 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
5406 " const char *filename,\n"
5407 " const char *iface);\n"
5412 #: ../src/guestfs-actions.pod:235
5414 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
5415 "QEMU interface emulation to use at run time."
5419 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2330
5420 msgid "(Added in 1.0.84)"
5424 #: ../src/guestfs-actions.pod:249
5425 msgid "guestfs_add_drive_with_if"
5429 #: ../src/guestfs-actions.pod:251
5433 " guestfs_add_drive_with_if (guestfs_h *g,\n"
5434 " const char *filename,\n"
5435 " const char *iface);\n"
5440 #: ../src/guestfs-actions.pod:256
5442 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
5443 "QEMU interface emulation to use at run time."
5447 #: ../src/guestfs-actions.pod:270
5448 msgid "guestfs_aug_clear"
5452 #: ../src/guestfs-actions.pod:272
5456 " guestfs_aug_clear (guestfs_h *g,\n"
5457 " const char *augpath);\n"
5462 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
5464 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5465 "L<augtool(1)> C<clear> command."
5469 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2080
5470 msgid "(Added in 1.3.4)"
5474 #: ../src/guestfs-actions.pod:283
5475 msgid "guestfs_aug_close"
5479 #: ../src/guestfs-actions.pod:285
5483 " guestfs_aug_close (guestfs_h *g);\n"
5488 #: ../src/guestfs-actions.pod:288
5490 "Close the current Augeas handle and free up any resources used by it. After "
5491 "calling this, you have to call C<guestfs_aug_init> again before you can use "
5492 "any other Augeas functions."
5496 #: ../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:5236
5497 msgid "(Added in 0.7)"
5501 #: ../src/guestfs-actions.pod:297
5502 msgid "guestfs_aug_defnode"
5506 #: ../src/guestfs-actions.pod:299
5509 " struct guestfs_int_bool *\n"
5510 " guestfs_aug_defnode (guestfs_h *g,\n"
5511 " const char *name,\n"
5512 " const char *expr,\n"
5513 " const char *val);\n"
5518 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
5519 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5523 #: ../src/guestfs-actions.pod:308
5525 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5526 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
5527 "containing that single node."
5531 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
5533 "On success this returns a pair containing the number of nodes in the "
5534 "nodeset, and a boolean flag if a node was created."
5538 #: ../src/guestfs-actions.pod:316
5540 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
5541 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
5545 #: ../src/guestfs-actions.pod:322
5546 msgid "guestfs_aug_defvar"
5550 #: ../src/guestfs-actions.pod:324
5554 " guestfs_aug_defvar (guestfs_h *g,\n"
5555 " const char *name,\n"
5556 " const char *expr);\n"
5561 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
5563 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5564 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5568 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
5570 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5571 "evaluates to something which is not a nodeset."
5575 #: ../src/guestfs-actions.pod:340
5576 msgid "guestfs_aug_get"
5580 #: ../src/guestfs-actions.pod:342
5584 " guestfs_aug_get (guestfs_h *g,\n"
5585 " const char *augpath);\n"
5590 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
5592 "Look up the value associated with C<path>. If C<path> matches exactly one "
5593 "node, the C<value> is returned."
5597 #: ../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:1529 ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:1912 ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:2295 ../src/guestfs-actions.pod:2502 ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2631 ../src/guestfs-actions.pod:2745 ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:2800 ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:3399 ../src/guestfs-actions.pod:3749 ../src/guestfs-actions.pod:3919 ../src/guestfs-actions.pod:4029 ../src/guestfs-actions.pod:4771 ../src/guestfs-actions.pod:4964 ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5361 ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:5940 ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:5981 ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6692 ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:7144
5599 "This function returns a string, or NULL on error. I<The caller must free "
5600 "the returned string after use>."
5604 #: ../src/guestfs-actions.pod:354
5605 msgid "guestfs_aug_init"
5609 #: ../src/guestfs-actions.pod:356
5613 " guestfs_aug_init (guestfs_h *g,\n"
5614 " const char *root,\n"
5620 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
5622 "Create a new Augeas handle for editing configuration files. If there was "
5623 "any previous Augeas handle associated with this guestfs session, then it is "
5628 #: ../src/guestfs-actions.pod:365
5629 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5633 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
5634 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5638 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
5640 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5641 "logical I<or> of the following integers:"
5645 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
5646 msgid "C<AUG_SAVE_BACKUP> = 1"
5650 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
5651 msgid "Keep the original file with a C<.augsave> extension."
5655 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
5656 msgid "C<AUG_SAVE_NEWFILE> = 2"
5660 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
5662 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5663 "original. Overrides C<AUG_SAVE_BACKUP>."
5667 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
5668 msgid "C<AUG_TYPE_CHECK> = 4"
5672 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
5673 msgid "Typecheck lenses (can be expensive)."
5677 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
5678 msgid "C<AUG_NO_STDINC> = 8"
5682 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
5683 msgid "Do not use standard load path for modules."
5687 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
5688 msgid "C<AUG_SAVE_NOOP> = 16"
5692 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
5693 msgid "Make save a no-op, just record what would have been changed."
5697 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
5698 msgid "C<AUG_NO_LOAD> = 32"
5702 #: ../src/guestfs-actions.pod:400
5703 msgid "Do not load the tree in C<guestfs_aug_init>."
5707 #: ../src/guestfs-actions.pod:404
5708 msgid "To close the handle, you can call C<guestfs_aug_close>."
5712 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:270
5713 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5717 #: ../src/guestfs-actions.pod:412
5718 msgid "guestfs_aug_insert"
5722 #: ../src/guestfs-actions.pod:414
5726 " guestfs_aug_insert (guestfs_h *g,\n"
5727 " const char *augpath,\n"
5728 " const char *label,\n"
5734 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:276
5736 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5737 "or after C<path> (depending on the boolean flag C<before>)."
5741 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:280
5743 "C<path> must match exactly one existing node in the tree, and C<label> must "
5744 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5748 #: ../src/guestfs-actions.pod:432
5749 msgid "guestfs_aug_load"
5753 #: ../src/guestfs-actions.pod:434
5757 " guestfs_aug_load (guestfs_h *g);\n"
5762 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:288
5763 msgid "Load files into the tree."
5767 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
5768 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5772 #: ../src/guestfs-actions.pod:446
5773 msgid "guestfs_aug_ls"
5777 #: ../src/guestfs-actions.pod:448
5781 " guestfs_aug_ls (guestfs_h *g,\n"
5782 " const char *augpath);\n"
5787 #: ../src/guestfs-actions.pod:452
5789 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5790 "sorting the resulting nodes into alphabetical order."
5794 #: ../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:1743 ../src/guestfs-actions.pod:2175 ../src/guestfs-actions.pod:2191 ../src/guestfs-actions.pod:2210 ../src/guestfs-actions.pod:2253 ../src/guestfs-actions.pod:2277 ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2819 ../src/guestfs-actions.pod:3034 ../src/guestfs-actions.pod:3319 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:4577 ../src/guestfs-actions.pod:5106 ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5997 ../src/guestfs-actions.pod:6058 ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6259 ../src/guestfs-actions.pod:6283 ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6785 ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7016 ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7120 ../src/guestfs-actions.pod:7166 ../src/guestfs-actions.pod:7185
5796 "This function returns a NULL-terminated array of strings (like "
5797 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
5798 "strings and the array after use>."
5802 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3143 ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:4002 ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:5047 ../src/guestfs-actions.pod:5425 ../src/guestfs-actions.pod:5439 ../src/guestfs-actions.pod:5451 ../src/guestfs-actions.pod:5859 ../src/guestfs-actions.pod:6497 ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:6749 ../src/guestfs-actions.pod:6985
5803 msgid "(Added in 0.8)"
5807 #: ../src/guestfs-actions.pod:461
5808 msgid "guestfs_aug_match"
5812 #: ../src/guestfs-actions.pod:463
5816 " guestfs_aug_match (guestfs_h *g,\n"
5817 " const char *augpath);\n"
5822 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:304
5824 "Returns a list of paths which match the path expression C<path>. The "
5825 "returned paths are sufficiently qualified so that they match exactly one "
5826 "node in the current tree."
5830 #: ../src/guestfs-actions.pod:477
5831 msgid "guestfs_aug_mv"
5835 #: ../src/guestfs-actions.pod:479
5839 " guestfs_aug_mv (guestfs_h *g,\n"
5840 " const char *src,\n"
5841 " const char *dest);\n"
5846 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:312
5848 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5849 "C<dest> is overwritten if it exists."
5853 #: ../src/guestfs-actions.pod:491
5854 msgid "guestfs_aug_rm"
5858 #: ../src/guestfs-actions.pod:493
5862 " guestfs_aug_rm (guestfs_h *g,\n"
5863 " const char *augpath);\n"
5868 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:319
5869 msgid "Remove C<path> and all of its children."
5873 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5874 msgid "On success this returns the number of entries which were removed."
5878 #: ../src/guestfs-actions.pod:505
5879 msgid "guestfs_aug_save"
5883 #: ../src/guestfs-actions.pod:507
5887 " guestfs_aug_save (guestfs_h *g);\n"
5892 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:327
5893 msgid "This writes all pending changes to disk."
5897 #: ../src/guestfs-actions.pod:512
5899 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5904 #: ../src/guestfs-actions.pod:519
5905 msgid "guestfs_aug_set"
5909 #: ../src/guestfs-actions.pod:521
5913 " guestfs_aug_set (guestfs_h *g,\n"
5914 " const char *augpath,\n"
5915 " const char *val);\n"
5920 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:336
5921 msgid "Set the value associated with C<path> to C<val>."
5925 #: ../src/guestfs-actions.pod:528
5927 "In the Augeas API, it is possible to clear a node by setting the value to "
5928 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5929 "this call. Instead you must use the C<guestfs_aug_clear> call."
5933 #: ../src/guestfs-actions.pod:537
5934 msgid "guestfs_available"
5938 #: ../src/guestfs-actions.pod:539
5942 " guestfs_available (guestfs_h *g,\n"
5943 " char *const *groups);\n"
5948 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:347
5950 "This command is used to check the availability of some groups of "
5951 "functionality in the appliance, which not all builds of the libguestfs "
5952 "appliance will be able to provide."
5956 #: ../src/guestfs-actions.pod:547
5958 "The libguestfs groups, and the functions that those groups correspond to, "
5959 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5960 "runtime by calling C<guestfs_available_all_groups>."
5964 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:356
5966 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5967 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5968 "and Augeas (configuration file editing) functions."
5972 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
5973 msgid "The command returns no error if I<all> requested groups are available."
5977 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
5979 "It fails with an error if one or more of the requested groups is unavailable "
5984 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
5986 "If an unknown group name is included in the list of groups then an error is "
5991 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:369
5996 #: ../src/guestfs-actions.pod:571
5997 msgid "You must call C<guestfs_launch> before calling this function."
6001 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:377
6003 "The reason is because we don't know what groups are supported by the "
6004 "appliance/daemon until it is running and can be queried."
6008 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:383
6010 "If a group of functions is available, this does not necessarily mean that "
6011 "they will work. You still have to check for errors when calling individual "
6012 "API functions even if they are available."
6016 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:390
6018 "It is usually the job of distro packagers to build complete functionality "
6019 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6020 "with all requirements satisfied, will support everything."
6024 #: ../src/guestfs-actions.pod:593
6026 "This call was added in version C<1.0.80>. In previous versions of "
6027 "libguestfs all you could do would be to speculatively execute a command to "
6028 "find out if the daemon implemented it. See also C<guestfs_version>."
6032 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
6033 msgid "(Added in 1.0.80)"
6037 #: ../src/guestfs-actions.pod:604
6038 msgid "guestfs_available_all_groups"
6042 #: ../src/guestfs-actions.pod:606
6046 " guestfs_available_all_groups (guestfs_h *g);\n"
6051 #: ../src/guestfs-actions.pod:609
6053 "This command returns a list of all optional groups that this daemon knows "
6054 "about. Note this returns both supported and unsupported groups. To find "
6055 "out which ones the daemon can actually support you have to call "
6056 "C<guestfs_available> on each member of the returned list."
6060 #: ../src/guestfs-actions.pod:615
6061 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6065 #: ../src/guestfs-actions.pod:621
6066 msgid "(Added in 1.3.15)"
6070 #: ../src/guestfs-actions.pod:623
6071 msgid "guestfs_base64_in"
6075 #: ../src/guestfs-actions.pod:625
6079 " guestfs_base64_in (guestfs_h *g,\n"
6080 " const char *base64file,\n"
6081 " const char *filename);\n"
6086 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:420
6087 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6091 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
6092 msgid "(Added in 1.3.5)"
6096 #: ../src/guestfs-actions.pod:637
6097 msgid "guestfs_base64_out"
6101 #: ../src/guestfs-actions.pod:639
6105 " guestfs_base64_out (guestfs_h *g,\n"
6106 " const char *filename,\n"
6107 " const char *base64file);\n"
6112 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:429
6114 "This command downloads the contents of C<filename>, writing it out to local "
6115 "file C<base64file> encoded as base64."
6119 #: ../src/guestfs-actions.pod:651
6120 msgid "guestfs_blockdev_flushbufs"
6124 #: ../src/guestfs-actions.pod:653
6128 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6129 " const char *device);\n"
6134 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:438
6135 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6139 #: ../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
6140 msgid "This uses the L<blockdev(8)> command."
6144 #: ../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
6145 msgid "(Added in 0.9.3)"
6149 #: ../src/guestfs-actions.pod:666
6150 msgid "guestfs_blockdev_getbsz"
6154 #: ../src/guestfs-actions.pod:668
6158 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6159 " const char *device);\n"
6164 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:447
6165 msgid "This returns the block size of a device."
6169 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:512
6171 "(Note this is different from both I<size in blocks> and I<filesystem block "
6176 #: ../src/guestfs-actions.pod:683
6177 msgid "guestfs_blockdev_getro"
6181 #: ../src/guestfs-actions.pod:685
6185 " guestfs_blockdev_getro (guestfs_h *g,\n"
6186 " const char *device);\n"
6191 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:458
6193 "Returns a boolean indicating if the block device is read-only (true if "
6194 "read-only, false if not)."
6198 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1888 ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:2026 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3065 ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3125 ../src/guestfs-actions.pod:3141 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3168 ../src/guestfs-actions.pod:3182 ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3212 ../src/guestfs-actions.pod:4735
6199 msgid "This function returns a C truth value on success or -1 on error."
6203 #: ../src/guestfs-actions.pod:698
6204 msgid "guestfs_blockdev_getsize64"
6208 #: ../src/guestfs-actions.pod:700
6212 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6213 " const char *device);\n"
6218 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:467
6219 msgid "This returns the size of the device in bytes."
6223 #: ../src/guestfs-actions.pod:706
6224 msgid "See also C<guestfs_blockdev_getsz>."
6228 #: ../src/guestfs-actions.pod:714
6229 msgid "guestfs_blockdev_getss"
6233 #: ../src/guestfs-actions.pod:716
6237 " guestfs_blockdev_getss (guestfs_h *g,\n"
6238 " const char *device);\n"
6243 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:477
6245 "This returns the size of sectors on a block device. Usually 512, but can be "
6246 "larger for modern devices."
6250 #: ../src/guestfs-actions.pod:723
6252 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6257 #: ../src/guestfs-actions.pod:732
6258 msgid "guestfs_blockdev_getsz"
6262 #: ../src/guestfs-actions.pod:734
6266 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6267 " const char *device);\n"
6272 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:489
6274 "This returns the size of the device in units of 512-byte sectors (even if "
6275 "the sectorsize isn't 512 bytes ... weird)."
6279 #: ../src/guestfs-actions.pod:741
6281 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6282 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6286 #: ../src/guestfs-actions.pod:751
6287 msgid "guestfs_blockdev_rereadpt"
6291 #: ../src/guestfs-actions.pod:753
6295 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6296 " const char *device);\n"
6301 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:502
6302 msgid "Reread the partition table on C<device>."
6306 #: ../src/guestfs-actions.pod:765
6307 msgid "guestfs_blockdev_setbsz"
6311 #: ../src/guestfs-actions.pod:767
6315 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6316 " const char *device,\n"
6317 " int blocksize);\n"
6322 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:510
6323 msgid "This sets the block size of a device."
6327 #: ../src/guestfs-actions.pod:783
6328 msgid "guestfs_blockdev_setro"
6332 #: ../src/guestfs-actions.pod:785
6336 " guestfs_blockdev_setro (guestfs_h *g,\n"
6337 " const char *device);\n"
6342 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:521
6343 msgid "Sets the block device named C<device> to read-only."
6347 #: ../src/guestfs-actions.pod:797
6348 msgid "guestfs_blockdev_setrw"
6352 #: ../src/guestfs-actions.pod:799
6356 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6357 " const char *device);\n"
6362 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:529
6363 msgid "Sets the block device named C<device> to read-write."
6367 #: ../src/guestfs-actions.pod:811
6368 msgid "guestfs_case_sensitive_path"
6372 #: ../src/guestfs-actions.pod:813
6376 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6377 " const char *path);\n"
6382 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:537
6384 "This can be used to resolve case insensitive paths on a filesystem which is "
6385 "case sensitive. The use case is to resolve paths which you have read from "
6386 "Windows configuration files or the Windows Registry, to the true path."
6390 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
6392 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6393 "(and probably others), which is that although the underlying filesystem is "
6394 "case-insensitive, the driver exports the filesystem to Linux as "
6399 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
6401 "One consequence of this is that special directories such as C<c:\\windows> "
6402 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6403 "precise details of how they were created. In Windows itself this would not "
6408 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:553
6410 "Bug or feature? You decide: "
6411 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6415 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:556
6417 "This function resolves the true case of each element in the path and returns "
6418 "the case-sensitive path."
6422 #: ../src/guestfs-actions.pod:839
6424 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
6425 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6426 "how the directories were originally created under Windows)."
6430 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:564
6431 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6435 #: ../src/guestfs-actions.pod:847
6436 msgid "See also C<guestfs_realpath>."
6440 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6677
6441 msgid "(Added in 1.0.75)"
6445 #: ../src/guestfs-actions.pod:854
6450 #: ../src/guestfs-actions.pod:856
6454 " guestfs_cat (guestfs_h *g,\n"
6455 " const char *path);\n"
6460 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5222 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:3474
6461 msgid "Return the contents of the file named C<path>."
6465 #: ../src/guestfs-actions.pod:862
6467 "Note that this function cannot correctly handle binary files (specifically, "
6468 "files containing C<\\0> character which is treated as end of string). For "
6469 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
6470 "functions which have a more complex interface."
6474 #: ../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:1747 ../src/guestfs-actions.pod:2195 ../src/guestfs-actions.pod:2214 ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2281 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:5004 ../src/guestfs-actions.pod:5030 ../src/guestfs-actions.pod:5161 ../src/guestfs-actions.pod:5187 ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:6062 ../src/guestfs-actions.pod:6117 ../src/guestfs-actions.pod:6263 ../src/guestfs-actions.pod:6287 ../src/guestfs-actions.pod:6949 ../src/guestfs-actions.pod:6975 ../src/guestfs-actions.pod:7001 ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7105 ../src/guestfs-actions.pod:7124 ../src/guestfs-actions.pod:7170 ../src/guestfs-actions.pod:7189 ../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:1182 ../fish/guestfish-actions.pod:1477 ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1530 ../fish/guestfish-actions.pod:1540 ../fish/guestfish-actions.pod:1559 ../fish/guestfish-actions.pod:3344 ../fish/guestfish-actions.pod:3359 ../fish/guestfish-actions.pod:3435 ../fish/guestfish-actions.pod:3452 ../fish/guestfish-actions.pod:3467 ../fish/guestfish-actions.pod:4050 ../fish/guestfish-actions.pod:4096 ../fish/guestfish-actions.pod:4181 ../fish/guestfish-actions.pod:4196 ../fish/guestfish-actions.pod:4606 ../fish/guestfish-actions.pod:4624 ../fish/guestfish-actions.pod:4641 ../fish/guestfish-actions.pod:4651 ../fish/guestfish-actions.pod:4699 ../fish/guestfish-actions.pod:4709 ../fish/guestfish-actions.pod:4738 ../fish/guestfish-actions.pod:4748
6476 "Because of the message protocol, there is a transfer limit of somewhere "
6477 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6481 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3323 ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3909 ../src/guestfs-actions.pod:5110 ../src/guestfs-actions.pod:5124 ../src/guestfs-actions.pod:6836 ../src/guestfs-actions.pod:6850
6482 msgid "(Added in 0.4)"
6486 #: ../src/guestfs-actions.pod:875
6487 msgid "guestfs_checksum"
6491 #: ../src/guestfs-actions.pod:877
6495 " guestfs_checksum (guestfs_h *g,\n"
6496 " const char *csumtype,\n"
6497 " const char *path);\n"
6502 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:587
6503 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6507 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:590
6509 "The type of checksum to compute is given by the C<csumtype> parameter which "
6510 "must have one of the following values:"
6514 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
6519 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
6521 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6526 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
6531 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
6532 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6536 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
6541 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
6542 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6546 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
6551 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
6552 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6556 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
6561 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
6562 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6566 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
6571 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
6572 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6576 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
6581 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
6582 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6586 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:626
6587 msgid "The checksum is returned as a printable string."
6591 #: ../src/guestfs-actions.pod:923
6592 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6596 #: ../src/guestfs-actions.pod:925
6597 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6601 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3096 ../src/guestfs-actions.pod:3157 ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:6533
6602 msgid "(Added in 1.0.2)"
6606 #: ../src/guestfs-actions.pod:932
6607 msgid "guestfs_checksum_device"
6611 #: ../src/guestfs-actions.pod:934
6615 " guestfs_checksum_device (guestfs_h *g,\n"
6616 " const char *csumtype,\n"
6617 " const char *device);\n"
6622 #: ../src/guestfs-actions.pod:939
6624 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6625 "device named C<device>. For the types of checksums supported see the "
6626 "C<guestfs_checksum> command."
6630 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4641 ../src/guestfs-actions.pod:4700 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6862
6631 msgid "(Added in 1.3.2)"
6635 #: ../src/guestfs-actions.pod:948
6636 msgid "guestfs_checksums_out"
6640 #: ../src/guestfs-actions.pod:950
6644 " guestfs_checksums_out (guestfs_h *g,\n"
6645 " const char *csumtype,\n"
6646 " const char *directory,\n"
6647 " const char *sumsfile);\n"
6652 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:644
6654 "This command computes the checksums of all regular files in C<directory> and "
6655 "then emits a list of those checksums to the local output file C<sumsfile>."
6659 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:648
6661 "This can be used for verifying the integrity of a virtual machine. However "
6662 "to be properly secure you should pay attention to the output of the checksum "
6663 "command (it uses the ones from GNU coreutils). In particular when the "
6664 "filename is not printable, coreutils uses a special backslash syntax. For "
6665 "more information, see the GNU coreutils info file."
6669 #: ../src/guestfs-actions.pod:970
6670 msgid "(Added in 1.3.7)"
6674 #: ../src/guestfs-actions.pod:972
6675 msgid "guestfs_chmod"
6679 #: ../src/guestfs-actions.pod:974
6683 " guestfs_chmod (guestfs_h *g,\n"
6685 " const char *path);\n"
6690 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:662
6692 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6697 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:665
6699 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6700 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6705 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4146 ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4369 ../fish/guestfish-actions.pod:669 ../fish/guestfish-actions.pod:2792 ../fish/guestfish-actions.pod:2910 ../fish/guestfish-actions.pod:2920 ../fish/guestfish-actions.pod:2930
6706 msgid "The mode actually set is affected by the umask."
6710 #: ../src/guestfs-actions.pod:992
6711 msgid "guestfs_chown"
6715 #: ../src/guestfs-actions.pod:994
6719 " guestfs_chown (guestfs_h *g,\n"
6722 " const char *path);\n"
6727 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:675
6728 msgid "Change the file owner to C<owner> and group to C<group>."
6732 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:677 ../fish/guestfish-actions.pod:2250
6734 "Only numeric uid and gid are supported. If you want to use names, you will "
6735 "need to locate and parse the password file yourself (Augeas support makes "
6736 "this relatively easy)."
6740 #: ../src/guestfs-actions.pod:1010
6741 msgid "guestfs_command"
6745 #: ../src/guestfs-actions.pod:1012
6749 " guestfs_command (guestfs_h *g,\n"
6750 " char *const *arguments);\n"
6755 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:685
6757 "This call runs a command from the guest filesystem. The filesystem must be "
6758 "mounted, and must contain a compatible operating system (ie. something "
6759 "Linux, with the same or compatible processor architecture)."
6763 #: ../src/guestfs-actions.pod:1021
6765 "The single parameter is an argv-style list of arguments. The first element "
6766 "is the name of the program to run. Subsequent elements are parameters. The "
6767 "list must be non-empty (ie. must contain a program name). Note that the "
6768 "command runs directly, and is I<not> invoked via the shell (see "
6773 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:697
6774 msgid "The return value is anything printed to I<stdout> by the command."
6778 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:700
6780 "If the command returns a non-zero exit status, then this function returns an "
6781 "error message. The error message string is the content of I<stderr> from "
6786 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:704
6788 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6789 "C</bin>. If you require a program from another location, you should provide "
6790 "the full path in the first parameter."
6794 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
6796 "Shared libraries and data files required by the program must be available on "
6797 "filesystems which are mounted in the correct places. It is the caller's "
6798 "responsibility to ensure all filesystems that are needed are mounted at the "
6803 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072 ../src/guestfs-actions.pod:1532
6804 msgid "(Added in 0.9.1)"
6808 #: ../src/guestfs-actions.pod:1054
6809 msgid "guestfs_command_lines"
6813 #: ../src/guestfs-actions.pod:1056
6817 " guestfs_command_lines (guestfs_h *g,\n"
6818 " char *const *arguments);\n"
6823 #: ../src/guestfs-actions.pod:1060
6825 "This is the same as C<guestfs_command>, but splits the result into a list of "
6830 #: ../src/guestfs-actions.pod:1063
6831 msgid "See also: C<guestfs_sh_lines>"
6835 #: ../src/guestfs-actions.pod:1074
6836 msgid "guestfs_config"
6840 #: ../src/guestfs-actions.pod:1076
6844 " guestfs_config (guestfs_h *g,\n"
6845 " const char *qemuparam,\n"
6846 " const char *qemuvalue);\n"
6851 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:734
6853 "This can be used to add arbitrary qemu command line parameters of the form "
6854 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6855 "setting some parameters which would interfere with parameters that we use."
6859 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
6860 msgid "The first character of C<param> string must be a C<-> (dash)."
6864 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
6865 msgid "C<value> can be NULL."
6869 #: ../src/guestfs-actions.pod:1094
6870 msgid "guestfs_copy_size"
6874 #: ../src/guestfs-actions.pod:1096
6878 " guestfs_copy_size (guestfs_h *g,\n"
6879 " const char *src,\n"
6880 " const char *dest,\n"
6886 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:747
6888 "This command copies exactly C<size> bytes from one source device or file "
6889 "C<src> to another destination device or file C<dest>."
6893 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:750
6895 "Note this will fail if the source is too short or if the destination is not "
6900 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1681 ../src/guestfs-actions.pod:1703 ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6562 ../src/guestfs-actions.pod:7041 ../src/guestfs-actions.pod:7060
6902 "This long-running command can generate progress notification messages so "
6903 "that the caller can display a progress bar or indicator. To receive these "
6904 "messages, the caller must register a progress callback. See "
6905 "L<guestfs(3)/guestfs_set_progress_callback>."
6909 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:5137 ../src/guestfs-actions.pod:6769 ../src/guestfs-actions.pod:6789 ../src/guestfs-actions.pod:6875
6910 msgid "(Added in 1.0.87)"
6914 #: ../src/guestfs-actions.pod:1117
6919 #: ../src/guestfs-actions.pod:1119
6923 " guestfs_cp (guestfs_h *g,\n"
6924 " const char *src,\n"
6925 " const char *dest);\n"
6930 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:757
6932 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6933 "destination filename or destination directory."
6937 #: ../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:4595 ../src/guestfs-actions.pod:4981
6938 msgid "(Added in 1.0.18)"
6942 #: ../src/guestfs-actions.pod:1131
6943 msgid "guestfs_cp_a"
6947 #: ../src/guestfs-actions.pod:1133
6951 " guestfs_cp_a (guestfs_h *g,\n"
6952 " const char *src,\n"
6953 " const char *dest);\n"
6958 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:764
6960 "This copies a file or directory from C<src> to C<dest> recursively using the "
6965 #: ../src/guestfs-actions.pod:1145
6970 #: ../src/guestfs-actions.pod:1147
6974 " guestfs_dd (guestfs_h *g,\n"
6975 " const char *src,\n"
6976 " const char *dest);\n"
6981 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
6983 "This command copies from one source device or file C<src> to another "
6984 "destination device or file C<dest>. Normally you would use this to copy to "
6985 "or from a device or partition, for example to duplicate a filesystem."
6989 #: ../src/guestfs-actions.pod:1157
6991 "If the destination is a device, it must be as large or larger than the "
6992 "source file or device, otherwise the copy will fail. This command cannot do "
6993 "partial copies (see C<guestfs_copy_size>)."
6997 #: ../src/guestfs-actions.pod:1165
7002 #: ../src/guestfs-actions.pod:1167
7006 " guestfs_df (guestfs_h *g);\n"
7011 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:784
7012 msgid "This command runs the C<df> command to report disk space used."
7016 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
7018 "This command is mostly useful for interactive sessions. It is I<not> "
7019 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7024 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2260 ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2352 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4495 ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6290 ../src/guestfs-actions.pod:6908 ../src/guestfs-actions.pod:6921 ../src/guestfs-actions.pod:6934
7025 msgid "(Added in 1.0.54)"
7029 #: ../src/guestfs-actions.pod:1181
7030 msgid "guestfs_df_h"
7034 #: ../src/guestfs-actions.pod:1183
7038 " guestfs_df_h (guestfs_h *g);\n"
7043 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:794
7045 "This command runs the C<df -h> command to report disk space used in "
7046 "human-readable format."
7050 #: ../src/guestfs-actions.pod:1198
7051 msgid "guestfs_dmesg"
7055 #: ../src/guestfs-actions.pod:1200
7059 " guestfs_dmesg (guestfs_h *g);\n"
7064 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:805
7066 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7067 "This is sometimes useful for extended debugging of problems."
7071 #: ../src/guestfs-actions.pod:1207
7073 "Another way to get the same information is to enable verbose messages with "
7074 "C<guestfs_set_verbose> or by setting the environment variable "
7075 "C<LIBGUESTFS_DEBUG=1> before running the program."
7079 #: ../src/guestfs-actions.pod:1217
7080 msgid "guestfs_download"
7084 #: ../src/guestfs-actions.pod:1219
7088 " guestfs_download (guestfs_h *g,\n"
7089 " const char *remotefilename,\n"
7090 " const char *filename);\n"
7095 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249 ../fish/guestfish-actions.pod:818 ../fish/guestfish-actions.pod:831
7097 "Download file C<remotefilename> and save it as C<filename> on the local "
7102 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6522 ../fish/guestfish-actions.pod:821 ../fish/guestfish-actions.pod:4354
7103 msgid "C<filename> can also be a named pipe."
7107 #: ../src/guestfs-actions.pod:1229
7108 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7112 #: ../src/guestfs-actions.pod:1240
7113 msgid "guestfs_download_offset"
7117 #: ../src/guestfs-actions.pod:1242
7121 " guestfs_download_offset (guestfs_h *g,\n"
7122 " const char *remotefilename,\n"
7123 " const char *filename,\n"
7124 " int64_t offset,\n"
7130 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:834
7132 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7133 "region must be within the file or device)."
7137 #: ../src/guestfs-actions.pod:1255
7139 "Note that there is no limit on the amount of data that can be downloaded "
7140 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7141 "full amount unless an error occurs."
7145 #: ../src/guestfs-actions.pod:1260
7146 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7150 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6567
7151 msgid "(Added in 1.5.17)"
7155 #: ../src/guestfs-actions.pod:1271
7156 msgid "guestfs_drop_caches"
7160 #: ../src/guestfs-actions.pod:1273
7164 " guestfs_drop_caches (guestfs_h *g,\n"
7165 " int whattodrop);\n"
7170 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:850
7172 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7173 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7174 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7178 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
7179 msgid "Setting C<whattodrop> to 3 should drop everything."
7183 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
7185 "This automatically calls L<sync(2)> before the operation, so that the "
7186 "maximum guest memory is freed."
7190 #: ../src/guestfs-actions.pod:1291
7195 #: ../src/guestfs-actions.pod:1293
7199 " guestfs_du (guestfs_h *g,\n"
7200 " const char *path);\n"
7205 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:864
7207 "This command runs the C<du -s> command to estimate file space usage for "
7212 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:867
7214 "C<path> can be a file or a directory. If C<path> is a directory then the "
7215 "estimate includes the contents of the directory and all subdirectories "
7220 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:871
7221 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7225 #: ../src/guestfs-actions.pod:1311
7226 msgid "guestfs_e2fsck_f"
7230 #: ../src/guestfs-actions.pod:1313
7234 " guestfs_e2fsck_f (guestfs_h *g,\n"
7235 " const char *device);\n"
7240 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:878
7242 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7243 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7248 #: ../src/guestfs-actions.pod:1321
7250 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7251 "Normally you should use C<guestfs_fsck>."
7255 #: ../src/guestfs-actions.pod:1326
7256 msgid "(Added in 1.0.29)"
7260 #: ../src/guestfs-actions.pod:1328
7261 msgid "guestfs_echo_daemon"
7265 #: ../src/guestfs-actions.pod:1330
7269 " guestfs_echo_daemon (guestfs_h *g,\n"
7270 " char *const *words);\n"
7275 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:889
7277 "This command concatenates the list of C<words> passed with single spaces "
7278 "between them and returns the resulting string."
7282 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:892
7283 msgid "You can use this command to test the connection through to the daemon."
7287 #: ../src/guestfs-actions.pod:1339
7288 msgid "See also C<guestfs_ping_daemon>."
7292 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:5770
7293 msgid "(Added in 1.0.69)"
7297 #: ../src/guestfs-actions.pod:1346
7298 msgid "guestfs_egrep"
7302 #: ../src/guestfs-actions.pod:1348
7306 " guestfs_egrep (guestfs_h *g,\n"
7307 " const char *regex,\n"
7308 " const char *path);\n"
7313 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:900
7314 msgid "This calls the external C<egrep> program and returns the matching lines."
7318 #: ../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:2198 ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2373 ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2469 ../src/guestfs-actions.pod:2482 ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3442 ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:5315 ../src/guestfs-actions.pod:5364 ../src/guestfs-actions.pod:6134 ../src/guestfs-actions.pod:6146 ../src/guestfs-actions.pod:6159 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6194 ../src/guestfs-actions.pod:6207 ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:7004 ../src/guestfs-actions.pod:7023 ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7127 ../src/guestfs-actions.pod:7173 ../src/guestfs-actions.pod:7192
7319 msgid "(Added in 1.0.66)"
7323 #: ../src/guestfs-actions.pod:1365
7324 msgid "guestfs_egrepi"
7328 #: ../src/guestfs-actions.pod:1367
7332 " guestfs_egrepi (guestfs_h *g,\n"
7333 " const char *regex,\n"
7334 " const char *path);\n"
7339 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:910
7340 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7344 #: ../src/guestfs-actions.pod:1384
7345 msgid "guestfs_equal"
7349 #: ../src/guestfs-actions.pod:1386
7353 " guestfs_equal (guestfs_h *g,\n"
7354 " const char *file1,\n"
7355 " const char *file2);\n"
7360 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:920
7362 "This compares the two files C<file1> and C<file2> and returns true if their "
7363 "content is exactly equal, or false otherwise."
7367 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:923
7368 msgid "The external L<cmp(1)> program is used for the comparison."
7372 #: ../src/guestfs-actions.pod:1400
7373 msgid "guestfs_exists"
7377 #: ../src/guestfs-actions.pod:1402
7381 " guestfs_exists (guestfs_h *g,\n"
7382 " const char *path);\n"
7387 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:929
7389 "This returns C<true> if and only if there is a file, directory (or anything) "
7390 "with the given C<path> name."
7394 #: ../src/guestfs-actions.pod:1409
7395 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7399 #: ../src/guestfs-actions.pod:1415
7400 msgid "guestfs_fallocate"
7404 #: ../src/guestfs-actions.pod:1417
7408 " guestfs_fallocate (guestfs_h *g,\n"
7409 " const char *path,\n"
7415 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:957
7417 "This command preallocates a file (containing zero bytes) named C<path> of "
7418 "size C<len> bytes. If the file exists already, it is overwritten."
7422 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:942
7424 "Do not confuse this with the guestfish-specific C<alloc> command which "
7425 "allocates a file in the host and attaches it as a device."
7429 #: ../src/guestfs-actions.pod:1432
7431 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
7436 #: ../src/guestfs-actions.pod:1441
7437 msgid "guestfs_fallocate64"
7441 #: ../src/guestfs-actions.pod:1443
7445 " guestfs_fallocate64 (guestfs_h *g,\n"
7446 " const char *path,\n"
7452 #: ../src/guestfs-actions.pod:1452
7454 "Note that this call allocates disk blocks for the file. To create a sparse "
7455 "file use C<guestfs_truncate_size> instead."
7459 #: ../src/guestfs-actions.pod:1455
7461 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
7462 "oversight it only allowed 30 bit lengths to be specified, effectively "
7463 "limiting the maximum size of files created through that call to 1GB."
7467 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:969
7469 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7470 "commands which create a file in the host and attach it as a device."
7474 #: ../src/guestfs-actions.pod:1466
7475 msgid "(Added in 1.3.17)"
7479 #: ../src/guestfs-actions.pod:1468
7480 msgid "guestfs_fgrep"
7484 #: ../src/guestfs-actions.pod:1470
7488 " guestfs_fgrep (guestfs_h *g,\n"
7489 " const char *pattern,\n"
7490 " const char *path);\n"
7495 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:977
7496 msgid "This calls the external C<fgrep> program and returns the matching lines."
7500 #: ../src/guestfs-actions.pod:1487
7501 msgid "guestfs_fgrepi"
7505 #: ../src/guestfs-actions.pod:1489
7509 " guestfs_fgrepi (guestfs_h *g,\n"
7510 " const char *pattern,\n"
7511 " const char *path);\n"
7516 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:987
7517 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7521 #: ../src/guestfs-actions.pod:1506
7522 msgid "guestfs_file"
7526 #: ../src/guestfs-actions.pod:1508
7530 " guestfs_file (guestfs_h *g,\n"
7531 " const char *path);\n"
7536 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:997
7538 "This call uses the standard L<file(1)> command to determine the type or "
7539 "contents of the file."
7543 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1000
7545 "This call will also transparently look inside various types of compressed "
7550 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1003
7552 "The exact command which runs is C<file -zb path>. Note in particular that "
7553 "the filename is not prepended to the output (the C<-b> option)."
7557 #: ../src/guestfs-actions.pod:1522 ../fish/guestfish-actions.pod:1007
7559 "The output depends on the output of the underlying L<file(1)> command and it "
7560 "can change in future in ways beyond our control. In other words, the output "
7561 "is not guaranteed by the ABI."
7565 #: ../src/guestfs-actions.pod:1526
7567 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
7568 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
7572 #: ../src/guestfs-actions.pod:1534
7573 msgid "guestfs_file_architecture"
7577 #: ../src/guestfs-actions.pod:1536
7581 " guestfs_file_architecture (guestfs_h *g,\n"
7582 " const char *filename);\n"
7587 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1018
7589 "This detects the architecture of the binary C<filename>, and returns it if "
7594 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1021
7595 msgid "Currently defined architectures are:"
7599 #: ../src/guestfs-actions.pod:1547 ../fish/guestfish-actions.pod:1025
7604 #: ../src/guestfs-actions.pod:1549 ../fish/guestfish-actions.pod:1027
7606 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7607 "irrespective of the precise processor requirements of the binary."
7611 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7616 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
7617 msgid "64 bit x86-64."
7621 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1034
7626 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1036
7627 msgid "32 bit SPARC."
7631 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1038
7636 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1040
7637 msgid "64 bit SPARC V9 and above."
7641 #: ../src/guestfs-actions.pod:1564 ../fish/guestfish-actions.pod:1042
7646 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1044
7647 msgid "Intel Itanium."
7651 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1046
7656 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1048
7657 msgid "32 bit Power PC."
7661 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1050
7666 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1052
7667 msgid "64 bit Power PC."
7671 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1056
7672 msgid "Libguestfs may return other architecture strings in future."
7676 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1058
7677 msgid "The function works on at least the following types of files:"
7681 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1064
7682 msgid "many types of Un*x and Linux binary"
7686 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1068
7687 msgid "many types of Un*x and Linux shared library"
7691 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1072
7692 msgid "Windows Win32 and Win64 binaries"
7696 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1076
7697 msgid "Windows Win32 and Win64 DLLs"
7701 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1078
7702 msgid "Win32 binaries and DLLs return C<i386>."
7706 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1080
7707 msgid "Win64 binaries and DLLs return C<x86_64>."
7711 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1084
7712 msgid "Linux kernel modules"
7716 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1088
7717 msgid "Linux new-style initrd images"
7721 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1092
7722 msgid "some non-x86 Linux vmlinuz kernels"
7726 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1096
7727 msgid "What it can't do currently:"
7731 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1102
7732 msgid "static libraries (libfoo.a)"
7736 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1106
7737 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7741 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1110
7742 msgid "x86 Linux vmlinuz kernels"
7746 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1112
7748 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7749 "compressed code, and are horribly hard to unpack. If you want to find the "
7750 "architecture of a kernel, use the architecture of the associated initrd or "
7751 "kernel module(s) instead."
7755 #: ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2612 ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:3038 ../src/guestfs-actions.pod:3170
7756 msgid "(Added in 1.5.3)"
7760 #: ../src/guestfs-actions.pod:1646
7761 msgid "guestfs_filesize"
7765 #: ../src/guestfs-actions.pod:1648
7769 " guestfs_filesize (guestfs_h *g,\n"
7770 " const char *file);\n"
7775 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1123
7776 msgid "This command returns the size of C<file> in bytes."
7780 #: ../src/guestfs-actions.pod:1654
7782 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7783 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7784 "devices, use C<guestfs_blockdev_getsize64>."
7788 #: ../src/guestfs-actions.pod:1660
7789 msgid "(Added in 1.0.82)"
7793 #: ../src/guestfs-actions.pod:1662
7794 msgid "guestfs_fill"
7798 #: ../src/guestfs-actions.pod:1664
7802 " guestfs_fill (guestfs_h *g,\n"
7805 " const char *path);\n"
7810 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1133
7812 "This command creates a new file called C<path>. The initial content of the "
7813 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7818 #: ../src/guestfs-actions.pod:1674
7820 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7821 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7822 "bytes use C<guestfs_fill_pattern>."
7826 #: ../src/guestfs-actions.pod:1686
7827 msgid "(Added in 1.0.79)"
7831 #: ../src/guestfs-actions.pod:1688
7832 msgid "guestfs_fill_pattern"
7836 #: ../src/guestfs-actions.pod:1690
7840 " guestfs_fill_pattern (guestfs_h *g,\n"
7841 " const char *pattern,\n"
7843 " const char *path);\n"
7848 #: ../src/guestfs-actions.pod:1696
7850 "This function is like C<guestfs_fill> except that it creates a new file of "
7851 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7852 "pattern is truncated if necessary to ensure the length of the file is "
7853 "exactly C<len> bytes."
7857 #: ../src/guestfs-actions.pod:1708
7858 msgid "(Added in 1.3.12)"
7862 #: ../src/guestfs-actions.pod:1710
7863 msgid "guestfs_find"
7867 #: ../src/guestfs-actions.pod:1712
7871 " guestfs_find (guestfs_h *g,\n"
7872 " const char *directory);\n"
7877 #: ../src/guestfs-actions.pod:1716 ../fish/guestfish-actions.pod:1155
7879 "This command lists out all files and directories, recursively, starting at "
7880 "C<directory>. It is essentially equivalent to running the shell command "
7881 "C<find directory -print> but some post-processing happens on the output, "
7886 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
7888 "This returns a list of strings I<without any prefix>. Thus if the directory "
7893 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1163
7903 #: ../src/guestfs-actions.pod:1728
7904 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7908 #: ../src/guestfs-actions.pod:1731 ../fish/guestfish-actions.pod:1170
7919 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
7920 msgid "If C<directory> is not a directory, then this command returns an error."
7924 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1178
7925 msgid "The returned list is sorted."
7929 #: ../src/guestfs-actions.pod:1741
7930 msgid "See also C<guestfs_find0>."
7934 #: ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:3859 ../src/guestfs-actions.pod:5399
7935 msgid "(Added in 1.0.27)"
7939 #: ../src/guestfs-actions.pod:1752
7940 msgid "guestfs_find0"
7944 #: ../src/guestfs-actions.pod:1754
7948 " guestfs_find0 (guestfs_h *g,\n"
7949 " const char *directory,\n"
7950 " const char *files);\n"
7955 #: ../src/guestfs-actions.pod:1759 ../fish/guestfish-actions.pod:1189
7957 "This command lists out all files and directories, recursively, starting at "
7958 "C<directory>, placing the resulting list in the external file called "
7963 #: ../src/guestfs-actions.pod:1763
7965 "This command works the same way as C<guestfs_find> with the following "
7970 #: ../src/guestfs-actions.pod:1770 ../fish/guestfish-actions.pod:1200
7971 msgid "The resulting list is written to an external file."
7975 #: ../src/guestfs-actions.pod:1774 ../fish/guestfish-actions.pod:1204
7977 "Items (filenames) in the result are separated by C<\\0> characters. See "
7978 "L<find(1)> option I<-print0>."
7982 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
7983 msgid "This command is not limited in the number of names that it can return."
7987 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
7988 msgid "The result list is not sorted."
7992 #: ../src/guestfs-actions.pod:1790
7993 msgid "(Added in 1.0.74)"
7997 #: ../src/guestfs-actions.pod:1792
7998 msgid "guestfs_findfs_label"
8002 #: ../src/guestfs-actions.pod:1794
8006 " guestfs_findfs_label (guestfs_h *g,\n"
8007 " const char *label);\n"
8012 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1224
8014 "This command searches the filesystems and returns the one which has the "
8015 "given label. An error is returned if no such filesystem can be found."
8019 #: ../src/guestfs-actions.pod:1802
8020 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8024 #: ../src/guestfs-actions.pod:1809
8025 msgid "guestfs_findfs_uuid"
8029 #: ../src/guestfs-actions.pod:1811
8033 " guestfs_findfs_uuid (guestfs_h *g,\n"
8034 " const char *uuid);\n"
8039 #: ../src/guestfs-actions.pod:1815 ../fish/guestfish-actions.pod:1234
8041 "This command searches the filesystems and returns the one which has the "
8042 "given UUID. An error is returned if no such filesystem can be found."
8046 #: ../src/guestfs-actions.pod:1819
8047 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8051 #: ../src/guestfs-actions.pod:1826
8052 msgid "guestfs_fsck"
8056 #: ../src/guestfs-actions.pod:1828
8060 " guestfs_fsck (guestfs_h *g,\n"
8061 " const char *fstype,\n"
8062 " const char *device);\n"
8067 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1244
8069 "This runs the filesystem checker (fsck) on C<device> which should have "
8070 "filesystem type C<fstype>."
8074 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1247
8076 "The returned integer is the status. See L<fsck(8)> for the list of status "
8077 "codes from C<fsck>."
8081 #: ../src/guestfs-actions.pod:1845 ../fish/guestfish-actions.pod:1256
8082 msgid "Multiple status codes can be summed together."
8086 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1260
8088 "A non-zero return code can mean \"success\", for example if errors have been "
8089 "corrected on the filesystem."
8093 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
8094 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8098 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
8099 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8103 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:7046
8104 msgid "(Added in 1.0.16)"
8108 #: ../src/guestfs-actions.pod:1865
8109 msgid "guestfs_get_append"
8113 #: ../src/guestfs-actions.pod:1867
8117 " guestfs_get_append (guestfs_h *g);\n"
8122 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1276
8124 "Return the additional kernel options which are added to the guest kernel "
8129 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1279
8130 msgid "If C<NULL> then no options are added."
8134 #: ../src/guestfs-actions.pod:1875
8136 "This function returns a string which may be NULL. There is no way to return "
8137 "an error from this function. The string is owned by the guest handle and "
8138 "must I<not> be freed."
8142 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:5077 ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5927 ../src/guestfs-actions.pod:5943 ../src/guestfs-actions.pod:5960 ../src/guestfs-actions.pod:6717 ../src/guestfs-actions.pod:6735 ../src/guestfs-actions.pod:7089
8143 msgid "(Added in 1.0.26)"
8147 #: ../src/guestfs-actions.pod:1881
8148 msgid "guestfs_get_autosync"
8152 #: ../src/guestfs-actions.pod:1883
8156 " guestfs_get_autosync (guestfs_h *g);\n"
8161 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1285
8162 msgid "Get the autosync flag."
8166 #: ../src/guestfs-actions.pod:1892
8167 msgid "guestfs_get_direct"
8171 #: ../src/guestfs-actions.pod:1894
8175 " guestfs_get_direct (guestfs_h *g);\n"
8180 #: ../src/guestfs-actions.pod:1897 ../fish/guestfish-actions.pod:1291
8181 msgid "Return the direct appliance mode flag."
8185 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:5581
8186 msgid "(Added in 1.0.72)"
8190 #: ../src/guestfs-actions.pod:1903
8191 msgid "guestfs_get_e2label"
8195 #: ../src/guestfs-actions.pod:1905
8199 " guestfs_get_e2label (guestfs_h *g,\n"
8200 " const char *device);\n"
8205 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1297
8206 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8210 #: ../src/guestfs-actions.pod:1915
8212 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
8217 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:1943 ../src/guestfs-actions.pod:5599 ../src/guestfs-actions.pod:5618
8218 msgid "(Added in 1.0.15)"
8222 #: ../src/guestfs-actions.pod:1924
8223 msgid "guestfs_get_e2uuid"
8227 #: ../src/guestfs-actions.pod:1926
8231 " guestfs_get_e2uuid (guestfs_h *g,\n"
8232 " const char *device);\n"
8237 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1311
8238 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8242 #: ../src/guestfs-actions.pod:1936
8244 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
8249 #: ../src/guestfs-actions.pod:1945
8250 msgid "guestfs_get_memsize"
8254 #: ../src/guestfs-actions.pod:1947
8258 " guestfs_get_memsize (guestfs_h *g);\n"
8263 #: ../src/guestfs-actions.pod:1950 ../fish/guestfish-actions.pod:1325
8264 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8268 #: ../src/guestfs-actions.pod:1953
8270 "If C<guestfs_set_memsize> was not called on this handle, and if "
8271 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8272 "value for memsize."
8276 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:5634 ../src/guestfs-actions.pod:5741 ../fish/guestfish-actions.pod:1332 ../fish/guestfish-actions.pod:1383 ../fish/guestfish-actions.pod:3761 ../fish/guestfish-actions.pod:3848
8277 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8281 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:4335 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4373 ../src/guestfs-actions.pod:4385 ../src/guestfs-actions.pod:4402 ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5639 ../src/guestfs-actions.pod:5882 ../src/guestfs-actions.pod:6483
8282 msgid "(Added in 1.0.55)"
8286 #: ../src/guestfs-actions.pod:1964
8287 msgid "guestfs_get_network"
8291 #: ../src/guestfs-actions.pod:1966
8295 " guestfs_get_network (guestfs_h *g);\n"
8300 #: ../src/guestfs-actions.pod:1969 ../fish/guestfish-actions.pod:1339
8301 msgid "This returns the enable network flag."
8305 #: ../src/guestfs-actions.pod:1973 ../src/guestfs-actions.pod:5658
8306 msgid "(Added in 1.5.4)"
8310 #: ../src/guestfs-actions.pod:1975
8311 msgid "guestfs_get_path"
8315 #: ../src/guestfs-actions.pod:1977
8319 " guestfs_get_path (guestfs_h *g);\n"
8324 #: ../src/guestfs-actions.pod:1980 ../fish/guestfish-actions.pod:1345
8325 msgid "Return the current search path."
8329 #: ../src/guestfs-actions.pod:1982 ../fish/guestfish-actions.pod:1347
8331 "This is always non-NULL. If it wasn't set already, then this will return "
8336 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:2014
8338 "This function returns a string, or NULL on error. The string is owned by "
8339 "the guest handle and must I<not> be freed."
8343 #: ../src/guestfs-actions.pod:1990
8344 msgid "guestfs_get_pid"
8348 #: ../src/guestfs-actions.pod:1992
8352 " guestfs_get_pid (guestfs_h *g);\n"
8357 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1356
8359 "Return the process ID of the qemu subprocess. If there is no qemu "
8360 "subprocess, then this will return an error."
8364 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1359
8365 msgid "This is an internal call used for debugging and testing."
8369 #: ../src/guestfs-actions.pod:2002
8370 msgid "(Added in 1.0.56)"
8374 #: ../src/guestfs-actions.pod:2004
8375 msgid "guestfs_get_qemu"
8379 #: ../src/guestfs-actions.pod:2006
8383 " guestfs_get_qemu (guestfs_h *g);\n"
8388 #: ../src/guestfs-actions.pod:2009 ../fish/guestfish-actions.pod:1365
8389 msgid "Return the current qemu binary."
8393 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1367
8395 "This is always non-NULL. If it wasn't set already, then this will return "
8396 "the default qemu binary name."
8400 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:5703
8401 msgid "(Added in 1.0.6)"
8405 #: ../src/guestfs-actions.pod:2019
8406 msgid "guestfs_get_recovery_proc"
8410 #: ../src/guestfs-actions.pod:2021
8414 " guestfs_get_recovery_proc (guestfs_h *g);\n"
8419 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1374
8420 msgid "Return the recovery process enabled flag."
8424 #: ../src/guestfs-actions.pod:2028 ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:3989 ../src/guestfs-actions.pod:5007 ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5727 ../src/guestfs-actions.pod:6386 ../src/guestfs-actions.pod:6406 ../src/guestfs-actions.pod:6598
8425 msgid "(Added in 1.0.77)"
8429 #: ../src/guestfs-actions.pod:2030
8430 msgid "guestfs_get_selinux"
8434 #: ../src/guestfs-actions.pod:2032
8438 " guestfs_get_selinux (guestfs_h *g);\n"
8443 #: ../src/guestfs-actions.pod:2035
8445 "This returns the current setting of the selinux flag which is passed to the "
8446 "appliance at boot time. See C<guestfs_set_selinux>."
8450 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:5746 ../src/guestfs-actions.pod:5800
8451 msgid "(Added in 1.0.67)"
8455 #: ../src/guestfs-actions.pod:2045
8456 msgid "guestfs_get_state"
8460 #: ../src/guestfs-actions.pod:2047
8464 " guestfs_get_state (guestfs_h *g);\n"
8469 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
8471 "This returns the current state as an opaque integer. This is only useful "
8472 "for printing debug and internal error messages."
8476 #: ../src/guestfs-actions.pod:2053 ../src/guestfs-actions.pod:3063 ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3153 ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:1393 ../fish/guestfish-actions.pod:2132 ../fish/guestfish-actions.pod:2150 ../fish/guestfish-actions.pod:2188 ../fish/guestfish-actions.pod:2204
8477 msgid "For more information on states, see L<guestfs(3)>."
8481 #: ../src/guestfs-actions.pod:2059
8482 msgid "guestfs_get_trace"
8486 #: ../src/guestfs-actions.pod:2061
8490 " guestfs_get_trace (guestfs_h *g);\n"
8495 #: ../src/guestfs-actions.pod:2064 ../fish/guestfish-actions.pod:1399
8496 msgid "Return the command trace flag."
8500 #: ../src/guestfs-actions.pod:2070
8501 msgid "guestfs_get_umask"
8505 #: ../src/guestfs-actions.pod:2072
8509 " guestfs_get_umask (guestfs_h *g);\n"
8514 #: ../src/guestfs-actions.pod:2075
8516 "Return the current umask. By default the umask is C<022> unless it has been "
8517 "set by calling C<guestfs_umask>."
8521 #: ../src/guestfs-actions.pod:2082
8522 msgid "guestfs_get_verbose"
8526 #: ../src/guestfs-actions.pod:2084
8530 " guestfs_get_verbose (guestfs_h *g);\n"
8535 #: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1412
8536 msgid "This returns the verbose messages flag."
8540 #: ../src/guestfs-actions.pod:2093
8541 msgid "guestfs_getcon"
8545 #: ../src/guestfs-actions.pod:2095
8549 " guestfs_getcon (guestfs_h *g);\n"
8554 #: ../src/guestfs-actions.pod:2098 ../fish/guestfish-actions.pod:1418
8555 msgid "This gets the SELinux security context of the daemon."
8559 #: ../src/guestfs-actions.pod:2100
8560 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8564 #: ../src/guestfs-actions.pod:2108
8565 msgid "guestfs_getxattr"
8569 #: ../src/guestfs-actions.pod:2110
8573 " guestfs_getxattr (guestfs_h *g,\n"
8574 " const char *path,\n"
8575 " const char *name,\n"
8576 " size_t *size_r);\n"
8581 #: ../src/guestfs-actions.pod:2116
8583 "Get a single extended attribute from file C<path> named C<name>. This call "
8584 "follows symlinks. If you want to lookup an extended attribute for the "
8585 "symlink itself, use C<guestfs_lgetxattr>."
8589 #: ../src/guestfs-actions.pod:2120 ../src/guestfs-actions.pod:3274
8591 "Normally it is better to get all extended attributes from a file in one go "
8592 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
8593 "implementations are buggy and do not provide a way to list out attributes. "
8594 "For these filesystems (notably ntfs-3g) you have to know the names of the "
8595 "extended attributes you want in advance and call this function."
8599 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3281 ../fish/guestfish-actions.pod:1438 ../fish/guestfish-actions.pod:2269
8601 "Extended attribute values are blobs of binary data. If there is no extended "
8602 "attribute named C<name>, this returns an error."
8606 #: ../src/guestfs-actions.pod:2130
8607 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
8611 #: ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:3286 ../src/guestfs-actions.pod:5000 ../src/guestfs-actions.pod:5026 ../src/guestfs-actions.pod:5207
8613 "This function returns a buffer, or NULL on error. The size of the returned "
8614 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8619 #: ../src/guestfs-actions.pod:2136 ../src/guestfs-actions.pod:3290
8620 msgid "(Added in 1.7.24)"
8624 #: ../src/guestfs-actions.pod:2138
8625 msgid "guestfs_getxattrs"
8629 #: ../src/guestfs-actions.pod:2140
8632 " struct guestfs_xattr_list *\n"
8633 " guestfs_getxattrs (guestfs_h *g,\n"
8634 " const char *path);\n"
8639 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1447
8640 msgid "This call lists the extended attributes of the file or directory C<path>."
8644 #: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1450
8646 "At the system call level, this is a combination of the L<listxattr(2)> and "
8647 "L<getxattr(2)> calls."
8651 #: ../src/guestfs-actions.pod:2150
8652 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8656 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3302 ../src/guestfs-actions.pod:3953
8658 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8659 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8663 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3507 ../src/guestfs-actions.pod:5380 ../src/guestfs-actions.pod:5819 ../src/guestfs-actions.pod:7154
8664 msgid "(Added in 1.0.59)"
8668 #: ../src/guestfs-actions.pod:2158
8669 msgid "guestfs_glob_expand"
8673 #: ../src/guestfs-actions.pod:2160
8677 " guestfs_glob_expand (guestfs_h *g,\n"
8678 " const char *pattern);\n"
8683 #: ../src/guestfs-actions.pod:2164 ../fish/guestfish-actions.pod:1459
8685 "This command searches for all the pathnames matching C<pattern> according to "
8686 "the wildcard expansion rules used by the shell."
8690 #: ../src/guestfs-actions.pod:2168 ../fish/guestfish-actions.pod:1463
8691 msgid "If no paths match, then this returns an empty list (note: not an error)."
8695 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1466
8697 "It is just a wrapper around the C L<glob(3)> function with flags "
8698 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8702 #: ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:6001
8703 msgid "(Added in 1.0.50)"
8707 #: ../src/guestfs-actions.pod:2181
8708 msgid "guestfs_grep"
8712 #: ../src/guestfs-actions.pod:2183
8716 " guestfs_grep (guestfs_h *g,\n"
8717 " const char *regex,\n"
8718 " const char *path);\n"
8723 #: ../src/guestfs-actions.pod:2188 ../fish/guestfish-actions.pod:1474
8724 msgid "This calls the external C<grep> program and returns the matching lines."
8728 #: ../src/guestfs-actions.pod:2200
8729 msgid "guestfs_grepi"
8733 #: ../src/guestfs-actions.pod:2202
8737 " guestfs_grepi (guestfs_h *g,\n"
8738 " const char *regex,\n"
8739 " const char *path);\n"
8744 #: ../src/guestfs-actions.pod:2207 ../fish/guestfish-actions.pod:1484
8745 msgid "This calls the external C<grep -i> program and returns the matching lines."
8749 #: ../src/guestfs-actions.pod:2219
8750 msgid "guestfs_grub_install"
8754 #: ../src/guestfs-actions.pod:2221
8758 " guestfs_grub_install (guestfs_h *g,\n"
8759 " const char *root,\n"
8760 " const char *device);\n"
8765 #: ../src/guestfs-actions.pod:2226 ../fish/guestfish-actions.pod:1494
8767 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8768 "the root directory being C<root>."
8772 #: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1497
8774 "Note: If grub-install reports the error \"No suitable drive was found in the "
8775 "generated device map.\" it may be that you need to create a "
8776 "C</boot/grub/device.map> file first that contains the mapping between grub "
8777 "device names and Linux device names. It is usually sufficient to create a "
8782 #: ../src/guestfs-actions.pod:2236 ../fish/guestfish-actions.pod:1504
8790 #: ../src/guestfs-actions.pod:2238 ../fish/guestfish-actions.pod:1506
8791 msgid "replacing C</dev/vda> with the name of the installation device."
8795 #: ../src/guestfs-actions.pod:2242
8796 msgid "(Added in 1.0.17)"
8800 #: ../src/guestfs-actions.pod:2244
8801 msgid "guestfs_head"
8805 #: ../src/guestfs-actions.pod:2246
8809 " guestfs_head (guestfs_h *g,\n"
8810 " const char *path);\n"
8815 #: ../src/guestfs-actions.pod:2250 ../fish/guestfish-actions.pod:1512
8817 "This command returns up to the first 10 lines of a file as a list of "
8822 #: ../src/guestfs-actions.pod:2262
8823 msgid "guestfs_head_n"
8827 #: ../src/guestfs-actions.pod:2264
8831 " guestfs_head_n (guestfs_h *g,\n"
8833 " const char *path);\n"
8838 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1522
8840 "If the parameter C<nrlines> is a positive number, this returns the first "
8841 "C<nrlines> lines of the file C<path>."
8845 #: ../src/guestfs-actions.pod:2272 ../fish/guestfish-actions.pod:1525
8847 "If the parameter C<nrlines> is a negative number, this returns lines from "
8848 "the file C<path>, excluding the last C<nrlines> lines."
8852 #: ../src/guestfs-actions.pod:2275 ../src/guestfs-actions.pod:6281 ../fish/guestfish-actions.pod:1528 ../fish/guestfish-actions.pod:4194
8853 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8857 #: ../src/guestfs-actions.pod:2286
8858 msgid "guestfs_hexdump"
8862 #: ../src/guestfs-actions.pod:2288
8866 " guestfs_hexdump (guestfs_h *g,\n"
8867 " const char *path);\n"
8872 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1537
8874 "This runs C<hexdump -C> on the given C<path>. The result is the "
8875 "human-readable, canonical hex dump of the file."
8879 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6065 ../src/guestfs-actions.pod:6120
8880 msgid "(Added in 1.0.22)"
8884 #: ../src/guestfs-actions.pod:2303
8885 msgid "guestfs_initrd_cat"
8889 #: ../src/guestfs-actions.pod:2305
8893 " guestfs_initrd_cat (guestfs_h *g,\n"
8894 " const char *initrdpath,\n"
8895 " const char *filename,\n"
8896 " size_t *size_r);\n"
8901 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1547
8903 "This command unpacks the file C<filename> from the initrd file called "
8904 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8909 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1551
8911 "For example, in guestfish you could use the following command to examine the "
8912 "boot script (usually called C</init>) contained in a Linux initrd or "
8917 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1555
8920 " initrd-cat /boot/initrd-<version>.img init\n"
8925 #: ../src/guestfs-actions.pod:2321
8926 msgid "See also C<guestfs_initrd_list>."
8930 #: ../src/guestfs-actions.pod:2332
8931 msgid "guestfs_initrd_list"
8935 #: ../src/guestfs-actions.pod:2334
8939 " guestfs_initrd_list (guestfs_h *g,\n"
8940 " const char *path);\n"
8945 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1566
8946 msgid "This command lists out files contained in an initrd."
8950 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1568
8952 "The files are listed without any initial C</> character. The files are "
8953 "listed in the order they appear (not necessarily alphabetical). Directory "
8954 "names are listed as separate items."
8958 #: ../src/guestfs-actions.pod:2344 ../fish/guestfish-actions.pod:1572
8960 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8961 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8966 #: ../src/guestfs-actions.pod:2354
8967 msgid "guestfs_inotify_add_watch"
8971 #: ../src/guestfs-actions.pod:2356
8975 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8976 " const char *path,\n"
8982 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1580
8983 msgid "Watch C<path> for the events listed in C<mask>."
8987 #: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1582
8989 "Note that if C<path> is a directory then events within that directory are "
8990 "watched, but this does I<not> happen recursively (in subdirectories)."
8994 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1586
8996 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8997 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9001 #: ../src/guestfs-actions.pod:2375
9002 msgid "guestfs_inotify_close"
9006 #: ../src/guestfs-actions.pod:2377
9010 " guestfs_inotify_close (guestfs_h *g);\n"
9015 #: ../src/guestfs-actions.pod:2380 ../fish/guestfish-actions.pod:1594
9017 "This closes the inotify handle which was previously opened by inotify_init. "
9018 "It removes all watches, throws away any pending events, and deallocates all "
9023 #: ../src/guestfs-actions.pod:2388
9024 msgid "guestfs_inotify_files"
9028 #: ../src/guestfs-actions.pod:2390
9032 " guestfs_inotify_files (guestfs_h *g);\n"
9037 #: ../src/guestfs-actions.pod:2393
9039 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9040 "returns a list of pathnames of objects that were touched. The returned "
9041 "pathnames are sorted and deduplicated."
9045 #: ../src/guestfs-actions.pod:2403
9046 msgid "guestfs_inotify_init"
9050 #: ../src/guestfs-actions.pod:2405
9054 " guestfs_inotify_init (guestfs_h *g,\n"
9055 " int maxevents);\n"
9060 #: ../src/guestfs-actions.pod:2409 ../fish/guestfish-actions.pod:1610
9062 "This command creates a new inotify handle. The inotify subsystem can be "
9063 "used to notify events which happen to objects in the guest filesystem."
9067 #: ../src/guestfs-actions.pod:2413
9069 "C<maxevents> is the maximum number of events which will be queued up between "
9070 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9071 "passed as C<0>, then the kernel (or previously set) default is used. For "
9072 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9073 "throws away events, but records the fact that it threw them away by setting "
9074 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9075 "C<guestfs_inotify_read>)."
9079 #: ../src/guestfs-actions.pod:2423
9081 "Before any events are generated, you have to add some watches to the "
9082 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9083 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9087 #: ../src/guestfs-actions.pod:2429
9089 "Queued up events should be read periodically by calling "
9090 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9091 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9092 "often enough then you risk the internal queue overflowing."
9096 #: ../src/guestfs-actions.pod:2436
9098 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9099 "This also removes any watches automatically."
9103 #: ../src/guestfs-actions.pod:2440 ../fish/guestfish-actions.pod:1641
9105 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9106 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9107 "that there is one global inotify handle per libguestfs instance."
9111 #: ../src/guestfs-actions.pod:2449
9112 msgid "guestfs_inotify_read"
9116 #: ../src/guestfs-actions.pod:2451
9119 " struct guestfs_inotify_event_list *\n"
9120 " guestfs_inotify_read (guestfs_h *g);\n"
9125 #: ../src/guestfs-actions.pod:2454 ../fish/guestfish-actions.pod:1650
9127 "Return the complete queue of events that have happened since the previous "
9132 #: ../src/guestfs-actions.pod:2457 ../fish/guestfish-actions.pod:1653
9133 msgid "If no events have happened, this returns an empty list."
9137 #: ../src/guestfs-actions.pod:2459 ../fish/guestfish-actions.pod:1655
9139 "I<Note>: In order to make sure that all events have been read, you must call "
9140 "this function repeatedly until it returns an empty list. The reason is that "
9141 "the call will read events up to the maximum appliance-to-host message size "
9142 "and leave remaining events in the queue."
9146 #: ../src/guestfs-actions.pod:2465
9148 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9149 "there was an error. I<The caller must call "
9150 "C<guestfs_free_inotify_event_list> after use>."
9154 #: ../src/guestfs-actions.pod:2471
9155 msgid "guestfs_inotify_rm_watch"
9159 #: ../src/guestfs-actions.pod:2473
9163 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9169 #: ../src/guestfs-actions.pod:2477
9171 "Remove a previously defined inotify watch. See "
9172 "C<guestfs_inotify_add_watch>."
9176 #: ../src/guestfs-actions.pod:2484
9177 msgid "guestfs_inspect_get_arch"
9181 #: ../src/guestfs-actions.pod:2486
9185 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9186 " const char *root);\n"
9191 #: ../src/guestfs-actions.pod:2490 ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:2594 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2642 ../src/guestfs-actions.pod:2669 ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:2787 ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2896
9193 "This function should only be called with a root device string as returned by "
9194 "C<guestfs_inspect_os>."
9198 #: ../src/guestfs-actions.pod:2493
9200 "This returns the architecture of the inspected operating system. The "
9201 "possible return values are listed under C<guestfs_file_architecture>."
9205 #: ../src/guestfs-actions.pod:2497 ../fish/guestfish-actions.pod:1679
9207 "If the architecture could not be determined, then the string C<unknown> is "
9212 #: ../src/guestfs-actions.pod:2500 ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2657 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2883 ../src/guestfs-actions.pod:2989 ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:1682 ../fish/guestfish-actions.pod:1756 ../fish/guestfish-actions.pod:1789 ../fish/guestfish-actions.pod:1810 ../fish/guestfish-actions.pod:1874 ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1928 ../fish/guestfish-actions.pod:1963 ../fish/guestfish-actions.pod:1979 ../fish/guestfish-actions.pod:2078 ../fish/guestfish-actions.pod:2112
9213 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9217 #: ../src/guestfs-actions.pod:2507
9218 msgid "guestfs_inspect_get_distro"
9222 #: ../src/guestfs-actions.pod:2509
9226 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9227 " const char *root);\n"
9232 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1691
9233 msgid "This returns the distro (distribution) of the inspected operating system."
9237 #: ../src/guestfs-actions.pod:2519 ../fish/guestfish-actions.pod:1694
9238 msgid "Currently defined distros are:"
9242 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1698
9243 msgid "\"archlinux\""
9247 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1700
9252 #: ../src/guestfs-actions.pod:2527 ../fish/guestfish-actions.pod:1702
9257 #: ../src/guestfs-actions.pod:2529 ../fish/guestfish-actions.pod:1704
9262 #: ../src/guestfs-actions.pod:2531 ../fish/guestfish-actions.pod:1706
9267 #: ../src/guestfs-actions.pod:2533 ../fish/guestfish-actions.pod:1708
9272 #: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1710
9277 #: ../src/guestfs-actions.pod:2537 ../fish/guestfish-actions.pod:1712
9282 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1714
9283 msgid "\"linuxmint\""
9287 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:1716
9292 #: ../src/guestfs-actions.pod:2543 ../fish/guestfish-actions.pod:1718
9293 msgid "\"mandriva\""
9297 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1720
9302 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1722
9307 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1724
9312 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1726
9317 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1728
9322 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1730
9323 msgid "\"redhat-based\""
9327 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1732
9328 msgid "Some Red Hat-derived distro."
9332 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1734
9337 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1736
9338 msgid "Red Hat Enterprise Linux and some derivatives."
9342 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1738
9347 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1740
9352 #: ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2851 ../fish/guestfish-actions.pod:1742 ../fish/guestfish-actions.pod:1954
9357 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1744
9358 msgid "The distro could not be determined."
9362 #: ../src/guestfs-actions.pod:2571 ../src/guestfs-actions.pod:2843 ../fish/guestfish-actions.pod:1746 ../fish/guestfish-actions.pod:1946
9367 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1748
9369 "Windows does not have distributions. This string is returned if the OS type "
9374 #: ../src/guestfs-actions.pod:2578 ../src/guestfs-actions.pod:2857 ../fish/guestfish-actions.pod:1753 ../fish/guestfish-actions.pod:1960
9376 "Future versions of libguestfs may return other strings here. The caller "
9377 "should be prepared to handle any string."
9381 #: ../src/guestfs-actions.pod:2588
9382 msgid "guestfs_inspect_get_filesystems"
9386 #: ../src/guestfs-actions.pod:2590
9390 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9391 " const char *root);\n"
9396 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1765
9398 "This returns a list of all the filesystems that we think are associated with "
9399 "this operating system. This includes the root filesystem, other ordinary "
9400 "filesystems, and non-mounted devices like swap partitions."
9404 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1770
9406 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9407 "to be shared between operating systems."
9411 #: ../src/guestfs-actions.pod:2605
9413 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9414 "C<guestfs_inspect_get_mountpoints>."
9418 #: ../src/guestfs-actions.pod:2614
9419 msgid "guestfs_inspect_get_hostname"
9423 #: ../src/guestfs-actions.pod:2616
9427 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
9428 " const char *root);\n"
9433 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1783
9435 "This function returns the hostname of the operating system as found by "
9436 "inspection of the guest's configuration files."
9440 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1786
9442 "If the hostname could not be determined, then the string C<unknown> is "
9447 #: ../src/guestfs-actions.pod:2634
9448 msgid "(Added in 1.7.9)"
9452 #: ../src/guestfs-actions.pod:2636
9453 msgid "guestfs_inspect_get_major_version"
9457 #: ../src/guestfs-actions.pod:2638
9461 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
9462 " const char *root);\n"
9467 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1798
9468 msgid "This returns the major version number of the inspected operating system."
9472 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1801
9474 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9475 "popular public names used by the operating system. Notably the operating "
9476 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9477 "1). You can find out the real versions corresponding to releases of Windows "
9478 "by consulting Wikipedia or MSDN."
9482 #: ../src/guestfs-actions.pod:2655 ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1822
9483 msgid "If the version could not be determined, then C<0> is returned."
9487 #: ../src/guestfs-actions.pod:2663
9488 msgid "guestfs_inspect_get_minor_version"
9492 #: ../src/guestfs-actions.pod:2665
9496 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9497 " const char *root);\n"
9502 #: ../src/guestfs-actions.pod:2672 ../fish/guestfish-actions.pod:1819
9503 msgid "This returns the minor version number of the inspected operating system."
9507 #: ../src/guestfs-actions.pod:2677
9509 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9510 "C<guestfs_inspect_get_major_version>."
9514 #: ../src/guestfs-actions.pod:2684
9515 msgid "guestfs_inspect_get_mountpoints"
9519 #: ../src/guestfs-actions.pod:2686
9523 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9524 " const char *root);\n"
9529 #: ../src/guestfs-actions.pod:2693 ../fish/guestfish-actions.pod:1834
9531 "This returns a hash of where we think the filesystems associated with this "
9532 "operating system should be mounted. Callers should note that this is at "
9533 "best an educated guess made by reading configuration files such as "
9534 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
9535 "are non-existent or not mountable and callers should be prepared to handle "
9536 "or ignore failures if they try to mount them."
9540 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1843
9542 "Each element in the returned hashtable has a key which is the path of the "
9543 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9544 "mounted there (eg. C</dev/sda1>)."
9548 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
9549 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9553 #: ../src/guestfs-actions.pod:2710
9555 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9556 "C<guestfs_inspect_get_filesystems>."
9560 #: ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:3359 ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:6422
9562 "This function returns a NULL-terminated array of strings, or NULL if there "
9563 "was an error. The array of strings will always have length C<2n+1>, where "
9564 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9565 "caller must free the strings and the array after use>."
9569 #: ../src/guestfs-actions.pod:2721
9570 msgid "guestfs_inspect_get_package_format"
9574 #: ../src/guestfs-actions.pod:2723
9578 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9579 " const char *root);\n"
9584 #: ../src/guestfs-actions.pod:2730
9586 "This function and C<guestfs_inspect_get_package_management> return the "
9587 "package format and package management tool used by the inspected operating "
9588 "system. For example for Fedora these functions would return C<rpm> (package "
9589 "format) and C<yum> (package management)."
9593 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1867
9595 "This returns the string C<unknown> if we could not determine the package "
9596 "format I<or> if the operating system does not have a real packaging system "
9601 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:1871
9603 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9604 "Future versions of libguestfs may return other strings."
9608 #: ../src/guestfs-actions.pod:2748 ../src/guestfs-actions.pod:2779
9609 msgid "(Added in 1.7.5)"
9613 #: ../src/guestfs-actions.pod:2750
9614 msgid "guestfs_inspect_get_package_management"
9618 #: ../src/guestfs-actions.pod:2752
9622 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9623 " const char *root);\n"
9628 #: ../src/guestfs-actions.pod:2759
9630 "C<guestfs_inspect_get_package_format> and this function return the package "
9631 "format and package management tool used by the inspected operating system. "
9632 "For example for Fedora these functions would return C<rpm> (package format) "
9633 "and C<yum> (package management)."
9637 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1889
9639 "This returns the string C<unknown> if we could not determine the package "
9640 "management tool I<or> if the operating system does not have a real packaging "
9641 "system (eg. Windows)."
9645 #: ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1893
9647 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9648 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9649 "libguestfs may return other strings."
9653 #: ../src/guestfs-actions.pod:2781
9654 msgid "guestfs_inspect_get_product_name"
9658 #: ../src/guestfs-actions.pod:2783
9662 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9663 " const char *root);\n"
9668 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1907
9670 "This returns the product name of the inspected operating system. The "
9671 "product name is generally some freeform string which can be displayed to the "
9672 "user, but should not be parsed by programs."
9676 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1912
9678 "If the product name could not be determined, then the string C<unknown> is "
9683 #: ../src/guestfs-actions.pod:2805
9684 msgid "guestfs_inspect_get_roots"
9688 #: ../src/guestfs-actions.pod:2807
9692 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9697 #: ../src/guestfs-actions.pod:2810
9699 "This function is a convenient way to get the list of root devices, as "
9700 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9701 "the whole inspection process."
9705 #: ../src/guestfs-actions.pod:2814
9707 "This returns an empty list if either no root devices were found or the "
9708 "caller has not called C<guestfs_inspect_os>."
9712 #: ../src/guestfs-actions.pod:2823
9713 msgid "(Added in 1.7.3)"
9717 #: ../src/guestfs-actions.pod:2825
9718 msgid "guestfs_inspect_get_type"
9722 #: ../src/guestfs-actions.pod:2827
9726 " guestfs_inspect_get_type (guestfs_h *g,\n"
9727 " const char *root);\n"
9732 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1937
9734 "This returns the type of the inspected operating system. Currently defined "
9739 #: ../src/guestfs-actions.pod:2839 ../fish/guestfish-actions.pod:1942
9744 #: ../src/guestfs-actions.pod:2841 ../fish/guestfish-actions.pod:1944
9745 msgid "Any Linux-based operating system."
9749 #: ../src/guestfs-actions.pod:2845 ../fish/guestfish-actions.pod:1948
9750 msgid "Any Microsoft Windows operating system."
9754 #: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:1950
9759 #: ../src/guestfs-actions.pod:2849 ../fish/guestfish-actions.pod:1952
9764 #: ../src/guestfs-actions.pod:2853 ../fish/guestfish-actions.pod:1956
9765 msgid "The operating system type could not be determined."
9769 #: ../src/guestfs-actions.pod:2867
9770 msgid "guestfs_inspect_get_windows_systemroot"
9774 #: ../src/guestfs-actions.pod:2869
9778 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9779 " const char *root);\n"
9784 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1972
9786 "This returns the Windows systemroot of the inspected guest. The systemroot "
9787 "is a directory path such as C</WINDOWS>."
9791 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1975
9793 "This call assumes that the guest is Windows and that the systemroot could be "
9794 "determined by inspection. If this is not the case then an error is "
9799 #: ../src/guestfs-actions.pod:2888
9800 msgid "(Added in 1.5.25)"
9804 #: ../src/guestfs-actions.pod:2890
9805 msgid "guestfs_inspect_list_applications"
9809 #: ../src/guestfs-actions.pod:2892
9812 " struct guestfs_application_list *\n"
9813 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9814 " const char *root);\n"
9819 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1988
9820 msgid "Return the list of applications installed in the operating system."
9824 #: ../src/guestfs-actions.pod:2901
9826 "I<Note:> This call works differently from other parts of the inspection "
9827 "API. You have to call C<guestfs_inspect_os>, then "
9828 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9829 "this. Listing applications is a significantly more difficult operation "
9830 "which requires access to the full filesystem. Also note that unlike the "
9831 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9832 "the libguestfs handle, this call actually reads parts of the mounted "
9833 "filesystems during the call."
9837 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:2000
9839 "This returns an empty list if the inspection code was not able to determine "
9840 "the list of applications."
9844 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2003
9845 msgid "The application structure contains the following fields:"
9849 #: ../src/guestfs-actions.pod:2918 ../fish/guestfish-actions.pod:2007
9854 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2009
9856 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9857 "guests, this is the package name."
9861 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2012
9862 msgid "C<app_display_name>"
9866 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2014
9868 "The display name of the application, sometimes localized to the install "
9869 "language of the guest operating system."
9873 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2017
9875 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9876 "to display something can use C<app_name> instead."
9880 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2020
9881 msgid "C<app_epoch>"
9885 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2022
9887 "For package managers which use epochs, this contains the epoch of the "
9888 "package (an integer). If unavailable, this is returned as C<0>."
9892 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2025
9893 msgid "C<app_version>"
9897 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2027
9899 "The version string of the application or package. If unavailable this is "
9900 "returned as an empty string C<\"\">."
9904 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
9905 msgid "C<app_release>"
9909 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2032
9911 "The release string of the application or package, for package managers that "
9912 "use this. If unavailable this is returned as an empty string C<\"\">."
9916 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2036
9917 msgid "C<app_install_path>"
9921 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2038
9923 "The installation path of the application (on operating systems such as "
9924 "Windows which use installation paths). This path is in the format used by "
9925 "the guest operating system, it is not a libguestfs path."
9929 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2043
9930 msgid "If unavailable this is returned as an empty string C<\"\">."
9934 #: ../src/guestfs-actions.pod:2956 ../fish/guestfish-actions.pod:2045
9935 msgid "C<app_trans_path>"
9939 #: ../src/guestfs-actions.pod:2958 ../fish/guestfish-actions.pod:2047
9941 "The install path translated into a libguestfs path. If unavailable this is "
9942 "returned as an empty string C<\"\">."
9946 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2050
9947 msgid "C<app_publisher>"
9951 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2052
9953 "The name of the publisher of the application, for package managers that use "
9954 "this. If unavailable this is returned as an empty string C<\"\">."
9958 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2056
9963 #: ../src/guestfs-actions.pod:2969 ../fish/guestfish-actions.pod:2058
9965 "The URL (eg. upstream URL) of the application. If unavailable this is "
9966 "returned as an empty string C<\"\">."
9970 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2061
9971 msgid "C<app_source_package>"
9975 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2063
9977 "For packaging systems which support this, the name of the source package. "
9978 "If unavailable this is returned as an empty string C<\"\">."
9982 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2066
9983 msgid "C<app_summary>"
9987 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2068
9989 "A short (usually one line) description of the application or package. If "
9990 "unavailable this is returned as an empty string C<\"\">."
9994 #: ../src/guestfs-actions.pod:2982 ../fish/guestfish-actions.pod:2071
9995 msgid "C<app_description>"
9999 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2073
10001 "A longer description of the application or package. If unavailable this is "
10002 "returned as an empty string C<\"\">."
10006 #: ../src/guestfs-actions.pod:2991
10008 "This function returns a C<struct guestfs_application_list *>, or NULL if "
10009 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10014 #: ../src/guestfs-actions.pod:2995
10015 msgid "(Added in 1.7.8)"
10019 #: ../src/guestfs-actions.pod:2997
10020 msgid "guestfs_inspect_os"
10024 #: ../src/guestfs-actions.pod:2999
10028 " guestfs_inspect_os (guestfs_h *g);\n"
10033 #: ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:2084
10035 "This function uses other libguestfs functions and certain heuristics to "
10036 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10037 "for operating systems."
10041 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2088
10042 msgid "The list returned is empty if no operating systems were found."
10046 #: ../src/guestfs-actions.pod:3008 ../fish/guestfish-actions.pod:2090
10048 "If one operating system was found, then this returns a list with a single "
10049 "element, which is the name of the root filesystem of this operating system. "
10050 "It is also possible for this function to return a list containing more than "
10051 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10052 "element being the root filesystem of one of the operating systems."
10056 #: ../src/guestfs-actions.pod:3015
10058 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10059 "functions in order to query further information about each operating system, "
10060 "such as the name and version."
10064 #: ../src/guestfs-actions.pod:3020
10066 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10067 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10068 "the contents. This should be called with no disks currently mounted. The "
10069 "function may also use Augeas, so any existing Augeas handle will be closed."
10073 #: ../src/guestfs-actions.pod:3026 ../fish/guestfish-actions.pod:2108
10075 "This function cannot decrypt encrypted disks. The caller must do that first "
10076 "(supplying the necessary keys) if the disk is encrypted."
10080 #: ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3317 ../src/guestfs-actions.pod:3379
10081 msgid "See also C<guestfs_list_filesystems>."
10085 #: ../src/guestfs-actions.pod:3040
10086 msgid "guestfs_is_blockdev"
10090 #: ../src/guestfs-actions.pod:3042
10094 " guestfs_is_blockdev (guestfs_h *g,\n"
10095 " const char *path);\n"
10100 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2120
10102 "This returns C<true> if and only if there is a block device with the given "
10107 #: ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3108 ../src/guestfs-actions.pod:3123 ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3195 ../src/guestfs-actions.pod:3210
10108 msgid "See also C<guestfs_stat>."
10112 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3199 ../src/guestfs-actions.pod:3214
10113 msgid "(Added in 1.5.10)"
10117 #: ../src/guestfs-actions.pod:3055
10118 msgid "guestfs_is_busy"
10122 #: ../src/guestfs-actions.pod:3057
10126 " guestfs_is_busy (guestfs_h *g);\n"
10131 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2129
10133 "This returns true iff this handle is busy processing a command (in the "
10138 #: ../src/guestfs-actions.pod:3069
10139 msgid "guestfs_is_chardev"
10143 #: ../src/guestfs-actions.pod:3071
10147 " guestfs_is_chardev (guestfs_h *g,\n"
10148 " const char *path);\n"
10153 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2138
10155 "This returns C<true> if and only if there is a character device with the "
10156 "given C<path> name."
10160 #: ../src/guestfs-actions.pod:3084
10161 msgid "guestfs_is_config"
10165 #: ../src/guestfs-actions.pod:3086
10169 " guestfs_is_config (guestfs_h *g);\n"
10174 #: ../src/guestfs-actions.pod:3089 ../fish/guestfish-actions.pod:2147
10176 "This returns true iff this handle is being configured (in the C<CONFIG> "
10181 #: ../src/guestfs-actions.pod:3098
10182 msgid "guestfs_is_dir"
10186 #: ../src/guestfs-actions.pod:3100
10190 " guestfs_is_dir (guestfs_h *g,\n"
10191 " const char *path);\n"
10196 #: ../src/guestfs-actions.pod:3104 ../fish/guestfish-actions.pod:2156
10198 "This returns C<true> if and only if there is a directory with the given "
10199 "C<path> name. Note that it returns false for other objects like files."
10203 #: ../src/guestfs-actions.pod:3114
10204 msgid "guestfs_is_fifo"
10208 #: ../src/guestfs-actions.pod:3116
10212 " guestfs_is_fifo (guestfs_h *g,\n"
10213 " const char *path);\n"
10218 #: ../src/guestfs-actions.pod:3120 ../fish/guestfish-actions.pod:2166
10220 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10221 "given C<path> name."
10225 #: ../src/guestfs-actions.pod:3129
10226 msgid "guestfs_is_file"
10230 #: ../src/guestfs-actions.pod:3131
10234 " guestfs_is_file (guestfs_h *g,\n"
10235 " const char *path);\n"
10240 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2175
10242 "This returns C<true> if and only if there is a regular file with the given "
10243 "C<path> name. Note that it returns false for other objects like "
10248 #: ../src/guestfs-actions.pod:3145
10249 msgid "guestfs_is_launching"
10253 #: ../src/guestfs-actions.pod:3147
10257 " guestfs_is_launching (guestfs_h *g);\n"
10262 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2185
10264 "This returns true iff this handle is launching the subprocess (in the "
10265 "C<LAUNCHING> state)."
10269 #: ../src/guestfs-actions.pod:3159
10270 msgid "guestfs_is_lv"
10274 #: ../src/guestfs-actions.pod:3161
10278 " guestfs_is_lv (guestfs_h *g,\n"
10279 " const char *device);\n"
10284 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2194
10286 "This command tests whether C<device> is a logical volume, and returns true "
10287 "iff this is the case."
10291 #: ../src/guestfs-actions.pod:3172
10292 msgid "guestfs_is_ready"
10296 #: ../src/guestfs-actions.pod:3174
10300 " guestfs_is_ready (guestfs_h *g);\n"
10305 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2201
10307 "This returns true iff this handle is ready to accept commands (in the "
10312 #: ../src/guestfs-actions.pod:3186
10313 msgid "guestfs_is_socket"
10317 #: ../src/guestfs-actions.pod:3188
10321 " guestfs_is_socket (guestfs_h *g,\n"
10322 " const char *path);\n"
10327 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2210
10329 "This returns C<true> if and only if there is a Unix domain socket with the "
10330 "given C<path> name."
10334 #: ../src/guestfs-actions.pod:3201
10335 msgid "guestfs_is_symlink"
10339 #: ../src/guestfs-actions.pod:3203
10343 " guestfs_is_symlink (guestfs_h *g,\n"
10344 " const char *path);\n"
10349 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2219
10351 "This returns C<true> if and only if there is a symbolic link with the given "
10356 #: ../src/guestfs-actions.pod:3216
10357 msgid "guestfs_kill_subprocess"
10361 #: ../src/guestfs-actions.pod:3218
10365 " guestfs_kill_subprocess (guestfs_h *g);\n"
10370 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2228
10371 msgid "This kills the qemu subprocess. You should never need to call this."
10375 #: ../src/guestfs-actions.pod:3227
10376 msgid "guestfs_launch"
10380 #: ../src/guestfs-actions.pod:3229
10384 " guestfs_launch (guestfs_h *g);\n"
10389 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2236
10391 "Internally libguestfs is implemented by running a virtual machine using "
10396 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2239
10398 "You should call this after configuring the handle (eg. adding drives) but "
10399 "before performing any actions."
10403 #: ../src/guestfs-actions.pod:3242
10404 msgid "guestfs_lchown"
10408 #: ../src/guestfs-actions.pod:3244
10412 " guestfs_lchown (guestfs_h *g,\n"
10415 " const char *path);\n"
10420 #: ../src/guestfs-actions.pod:3250
10422 "Change the file owner to C<owner> and group to C<group>. This is like "
10423 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
10424 "changed, not the target."
10428 #: ../src/guestfs-actions.pod:3262
10429 msgid "guestfs_lgetxattr"
10433 #: ../src/guestfs-actions.pod:3264
10437 " guestfs_lgetxattr (guestfs_h *g,\n"
10438 " const char *path,\n"
10439 " const char *name,\n"
10440 " size_t *size_r);\n"
10445 #: ../src/guestfs-actions.pod:3270 ../fish/guestfish-actions.pod:2258
10447 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10448 "is a symlink, then this call returns an extended attribute from the symlink."
10452 #: ../src/guestfs-actions.pod:3284
10453 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
10457 #: ../src/guestfs-actions.pod:3292
10458 msgid "guestfs_lgetxattrs"
10462 #: ../src/guestfs-actions.pod:3294
10465 " struct guestfs_xattr_list *\n"
10466 " guestfs_lgetxattrs (guestfs_h *g,\n"
10467 " const char *path);\n"
10472 #: ../src/guestfs-actions.pod:3298
10474 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
10475 "then it returns the extended attributes of the link itself."
10479 #: ../src/guestfs-actions.pod:3308
10480 msgid "guestfs_list_devices"
10484 #: ../src/guestfs-actions.pod:3310
10488 " guestfs_list_devices (guestfs_h *g);\n"
10493 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2286
10494 msgid "List all the block devices."
10498 #: ../src/guestfs-actions.pod:3315 ../fish/guestfish-actions.pod:2288
10499 msgid "The full block device names are returned, eg. C</dev/sda>."
10503 #: ../src/guestfs-actions.pod:3325
10504 msgid "guestfs_list_filesystems"
10508 #: ../src/guestfs-actions.pod:3327
10512 " guestfs_list_filesystems (guestfs_h *g);\n"
10517 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2296
10519 "This inspection command looks for filesystems on partitions, block devices "
10520 "and logical volumes, returning a list of devices containing filesystems and "
10525 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2300
10527 "The return value is a hash, where the keys are the devices containing "
10528 "filesystems, and the values are the filesystem types. For example:"
10532 #: ../src/guestfs-actions.pod:3338 ../fish/guestfish-actions.pod:2304
10535 " \"/dev/sda1\" => \"ntfs\"\n"
10536 " \"/dev/sda2\" => \"ext2\"\n"
10537 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10538 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10543 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2309
10545 "The value can have the special value \"unknown\", meaning the content of the "
10546 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10550 #: ../src/guestfs-actions.pod:3347
10552 "This command runs other libguestfs commands, which might include "
10553 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10554 "soon after launch and only when nothing is mounted."
10558 #: ../src/guestfs-actions.pod:3351
10560 "Not all of the filesystems returned will be mountable. In particular, swap "
10561 "partitions are returned in the list. Also this command does not check that "
10562 "each filesystem found is valid and mountable, and some filesystems might be "
10563 "mountable but require special options. Filesystems may not all belong to a "
10564 "single logical operating system (use C<guestfs_inspect_os> to look for "
10569 #: ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:4967
10570 msgid "(Added in 1.5.15)"
10574 #: ../src/guestfs-actions.pod:3367
10575 msgid "guestfs_list_partitions"
10579 #: ../src/guestfs-actions.pod:3369
10583 " guestfs_list_partitions (guestfs_h *g);\n"
10588 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2329
10589 msgid "List all the partitions detected on all block devices."
10593 #: ../src/guestfs-actions.pod:3374 ../fish/guestfish-actions.pod:2331
10594 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10598 #: ../src/guestfs-actions.pod:3376
10600 "This does not return logical volumes. For that you will need to call "
10605 #: ../src/guestfs-actions.pod:3387
10610 #: ../src/guestfs-actions.pod:3389
10614 " guestfs_ll (guestfs_h *g,\n"
10615 " const char *directory);\n"
10620 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2342
10622 "List the files in C<directory> (relative to the root directory, there is no "
10623 "cwd) in the format of 'ls -la'."
10627 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2345
10629 "This command is mostly useful for interactive sessions. It is I<not> "
10630 "intended that you try to parse the output string."
10634 #: ../src/guestfs-actions.pod:3404
10639 #: ../src/guestfs-actions.pod:3406
10643 " guestfs_ln (guestfs_h *g,\n"
10644 " const char *target,\n"
10645 " const char *linkname);\n"
10650 #: ../src/guestfs-actions.pod:3411 ../fish/guestfish-actions.pod:2352
10651 msgid "This command creates a hard link using the C<ln> command."
10655 #: ../src/guestfs-actions.pod:3417
10656 msgid "guestfs_ln_f"
10660 #: ../src/guestfs-actions.pod:3419
10664 " guestfs_ln_f (guestfs_h *g,\n"
10665 " const char *target,\n"
10666 " const char *linkname);\n"
10671 #: ../src/guestfs-actions.pod:3424 ../fish/guestfish-actions.pod:2358
10673 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10674 "option removes the link (C<linkname>) if it exists already."
10678 #: ../src/guestfs-actions.pod:3431
10679 msgid "guestfs_ln_s"
10683 #: ../src/guestfs-actions.pod:3433
10687 " guestfs_ln_s (guestfs_h *g,\n"
10688 " const char *target,\n"
10689 " const char *linkname);\n"
10694 #: ../src/guestfs-actions.pod:3438 ../fish/guestfish-actions.pod:2365
10695 msgid "This command creates a symbolic link using the C<ln -s> command."
10699 #: ../src/guestfs-actions.pod:3444
10700 msgid "guestfs_ln_sf"
10704 #: ../src/guestfs-actions.pod:3446
10708 " guestfs_ln_sf (guestfs_h *g,\n"
10709 " const char *target,\n"
10710 " const char *linkname);\n"
10715 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2371
10717 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10718 "option removes the link (C<linkname>) if it exists already."
10722 #: ../src/guestfs-actions.pod:3458
10723 msgid "guestfs_lremovexattr"
10727 #: ../src/guestfs-actions.pod:3460
10731 " guestfs_lremovexattr (guestfs_h *g,\n"
10732 " const char *xattr,\n"
10733 " const char *path);\n"
10738 #: ../src/guestfs-actions.pod:3465
10740 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10741 "link, then it removes an extended attribute of the link itself."
10745 #: ../src/guestfs-actions.pod:3473
10750 #: ../src/guestfs-actions.pod:3475
10754 " guestfs_ls (guestfs_h *g,\n"
10755 " const char *directory);\n"
10760 #: ../src/guestfs-actions.pod:3479 ../fish/guestfish-actions.pod:2386
10762 "List the files in C<directory> (relative to the root directory, there is no "
10763 "cwd). The '.' and '..' entries are not returned, but hidden files are "
10768 #: ../src/guestfs-actions.pod:3483
10770 "This command is mostly useful for interactive sessions. Programs should "
10771 "probably use C<guestfs_readdir> instead."
10775 #: ../src/guestfs-actions.pod:3492
10776 msgid "guestfs_lsetxattr"
10780 #: ../src/guestfs-actions.pod:3494
10784 " guestfs_lsetxattr (guestfs_h *g,\n"
10785 " const char *xattr,\n"
10786 " const char *val,\n"
10788 " const char *path);\n"
10793 #: ../src/guestfs-actions.pod:3501
10795 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10796 "then it sets an extended attribute of the link itself."
10800 #: ../src/guestfs-actions.pod:3509
10801 msgid "guestfs_lstat"
10805 #: ../src/guestfs-actions.pod:3511
10808 " struct guestfs_stat *\n"
10809 " guestfs_lstat (guestfs_h *g,\n"
10810 " const char *path);\n"
10815 #: ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:2405 ../fish/guestfish-actions.pod:4029
10816 msgid "Returns file information for the given C<path>."
10820 #: ../src/guestfs-actions.pod:3517
10822 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10823 "link, then the link is stat-ed, not the file it refers to."
10827 #: ../src/guestfs-actions.pod:3521 ../fish/guestfish-actions.pod:2411
10828 msgid "This is the same as the C<lstat(2)> system call."
10832 #: ../src/guestfs-actions.pod:3523 ../src/guestfs-actions.pod:6025
10834 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10835 "error. I<The caller must call C<guestfs_free_stat> after use>."
10839 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:6029 ../src/guestfs-actions.pod:6047 ../src/guestfs-actions.pod:6428
10840 msgid "(Added in 0.9.2)"
10844 #: ../src/guestfs-actions.pod:3529
10845 msgid "guestfs_lstatlist"
10849 #: ../src/guestfs-actions.pod:3531
10852 " struct guestfs_stat_list *\n"
10853 " guestfs_lstatlist (guestfs_h *g,\n"
10854 " const char *path,\n"
10855 " char *const *names);\n"
10860 #: ../src/guestfs-actions.pod:3536
10862 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10863 "files, where all files are in the directory C<path>. C<names> is the list "
10864 "of files from this directory."
10868 #: ../src/guestfs-actions.pod:3540 ../fish/guestfish-actions.pod:2421
10870 "On return you get a list of stat structs, with a one-to-one correspondence "
10871 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10872 "then the C<ino> field of that structure is set to C<-1>."
10876 #: ../src/guestfs-actions.pod:3545
10878 "This call is intended for programs that want to efficiently list a directory "
10879 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10880 "for a similarly efficient call for getting extended attributes. Very long "
10881 "directory listings might cause the protocol message size to be exceeded, "
10882 "causing this call to fail. The caller must split up such requests into "
10883 "smaller groups of names."
10887 #: ../src/guestfs-actions.pod:3553
10889 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10890 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10894 #: ../src/guestfs-actions.pod:3559
10895 msgid "guestfs_luks_add_key"
10899 #: ../src/guestfs-actions.pod:3561
10903 " guestfs_luks_add_key (guestfs_h *g,\n"
10904 " const char *device,\n"
10905 " const char *key,\n"
10906 " const char *newkey,\n"
10912 #: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2438
10914 "This command adds a new key on LUKS device C<device>. C<key> is any "
10915 "existing key, and is used to access the device. C<newkey> is the new key to "
10916 "add. C<keyslot> is the key slot that will be replaced."
10920 #: ../src/guestfs-actions.pod:3573
10922 "Note that if C<keyslot> already contains a key, then this command will "
10923 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10927 #: ../src/guestfs-actions.pod:3579 ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3713
10929 "This function takes a key or passphrase parameter which could contain "
10930 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10935 #: ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3666
10936 msgid "(Added in 1.5.2)"
10940 #: ../src/guestfs-actions.pod:3585
10941 msgid "guestfs_luks_close"
10945 #: ../src/guestfs-actions.pod:3587
10949 " guestfs_luks_close (guestfs_h *g,\n"
10950 " const char *device);\n"
10955 #: ../src/guestfs-actions.pod:3591
10957 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10958 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10959 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10960 "underlying block device."
10964 #: ../src/guestfs-actions.pod:3599 ../src/guestfs-actions.pod:3698 ../src/guestfs-actions.pod:3717 ../src/guestfs-actions.pod:3767 ../src/guestfs-actions.pod:3815
10965 msgid "(Added in 1.5.1)"
10969 #: ../src/guestfs-actions.pod:3601
10970 msgid "guestfs_luks_format"
10974 #: ../src/guestfs-actions.pod:3603
10978 " guestfs_luks_format (guestfs_h *g,\n"
10979 " const char *device,\n"
10980 " const char *key,\n"
10986 #: ../src/guestfs-actions.pod:3609 ../fish/guestfish-actions.pod:2464
10988 "This command erases existing data on C<device> and formats the device as a "
10989 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10990 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10994 #: ../src/guestfs-actions.pod:3616 ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5856 ../src/guestfs-actions.pod:5879 ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:7065 ../fish/guestfish-actions.pod:2472 ../fish/guestfish-actions.pod:2485 ../fish/guestfish-actions.pod:2569 ../fish/guestfish-actions.pod:3141 ../fish/guestfish-actions.pod:3648 ../fish/guestfish-actions.pod:3928 ../fish/guestfish-actions.pod:3944 ../fish/guestfish-actions.pod:3959 ../fish/guestfish-actions.pod:4674
10996 "B<This command is dangerous. Without careful use you can easily destroy all "
11001 #: ../src/guestfs-actions.pod:3625
11002 msgid "guestfs_luks_format_cipher"
11006 #: ../src/guestfs-actions.pod:3627
11010 " guestfs_luks_format_cipher (guestfs_h *g,\n"
11011 " const char *device,\n"
11012 " const char *key,\n"
11014 " const char *cipher);\n"
11019 #: ../src/guestfs-actions.pod:3634
11021 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11022 "set the C<cipher> used."
11026 #: ../src/guestfs-actions.pod:3648
11027 msgid "guestfs_luks_kill_slot"
11031 #: ../src/guestfs-actions.pod:3650
11035 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11036 " const char *device,\n"
11037 " const char *key,\n"
11043 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2492
11045 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11046 "device C<device>. C<key> must be one of the I<other> keys."
11050 #: ../src/guestfs-actions.pod:3668
11051 msgid "guestfs_luks_open"
11055 #: ../src/guestfs-actions.pod:3670
11059 " guestfs_luks_open (guestfs_h *g,\n"
11060 " const char *device,\n"
11061 " const char *key,\n"
11062 " const char *mapname);\n"
11067 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2503
11069 "This command opens a block device which has been encrypted according to the "
11070 "Linux Unified Key Setup (LUKS) standard."
11074 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2506
11075 msgid "C<device> is the encrypted block device or partition."
11079 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2508
11081 "The caller must supply one of the keys associated with the LUKS block "
11082 "device, in the C<key> parameter."
11086 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2511
11088 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11089 "writes to this block device are decrypted from and encrypted to the "
11090 "underlying C<device> respectively."
11094 #: ../src/guestfs-actions.pod:3688
11096 "If this block device contains LVM volume groups, then calling "
11097 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11102 #: ../src/guestfs-actions.pod:3700
11103 msgid "guestfs_luks_open_ro"
11107 #: ../src/guestfs-actions.pod:3702
11111 " guestfs_luks_open_ro (guestfs_h *g,\n"
11112 " const char *device,\n"
11113 " const char *key,\n"
11114 " const char *mapname);\n"
11119 #: ../src/guestfs-actions.pod:3708
11121 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11126 #: ../src/guestfs-actions.pod:3719
11127 msgid "guestfs_lvcreate"
11131 #: ../src/guestfs-actions.pod:3721
11135 " guestfs_lvcreate (guestfs_h *g,\n"
11136 " const char *logvol,\n"
11137 " const char *volgroup,\n"
11143 #: ../src/guestfs-actions.pod:3727 ../fish/guestfish-actions.pod:2536
11145 "This creates an LVM logical volume called C<logvol> on the volume group "
11146 "C<volgroup>, with C<size> megabytes."
11150 #: ../src/guestfs-actions.pod:3734
11151 msgid "guestfs_lvm_canonical_lv_name"
11155 #: ../src/guestfs-actions.pod:3736
11159 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11160 " const char *lvname);\n"
11165 #: ../src/guestfs-actions.pod:3740 ../fish/guestfish-actions.pod:2543
11167 "This converts alternative naming schemes for LVs that you might find to the "
11168 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11173 #: ../src/guestfs-actions.pod:3744 ../fish/guestfish-actions.pod:2547
11175 "This command returns an error if the C<lvname> parameter does not refer to a "
11180 #: ../src/guestfs-actions.pod:3747
11181 msgid "See also C<guestfs_is_lv>."
11185 #: ../src/guestfs-actions.pod:3752
11186 msgid "(Added in 1.5.24)"
11190 #: ../src/guestfs-actions.pod:3754
11191 msgid "guestfs_lvm_clear_filter"
11195 #: ../src/guestfs-actions.pod:3756
11199 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11204 #: ../src/guestfs-actions.pod:3759
11206 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11207 "see every block device."
11211 #: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:3804 ../fish/guestfish-actions.pod:2559 ../fish/guestfish-actions.pod:2590
11212 msgid "This command also clears the LVM cache and performs a volume group scan."
11216 #: ../src/guestfs-actions.pod:3769
11217 msgid "guestfs_lvm_remove_all"
11221 #: ../src/guestfs-actions.pod:3771
11225 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11230 #: ../src/guestfs-actions.pod:3774 ../fish/guestfish-actions.pod:2566
11232 "This command removes all LVM logical volumes, volume groups and physical "
11237 #: ../src/guestfs-actions.pod:3784
11238 msgid "guestfs_lvm_set_filter"
11242 #: ../src/guestfs-actions.pod:3786
11246 " guestfs_lvm_set_filter (guestfs_h *g,\n"
11247 " char *const *devices);\n"
11252 #: ../src/guestfs-actions.pod:3790 ../fish/guestfish-actions.pod:2576
11254 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11255 "block devices in the list C<devices>, and will ignore all other attached "
11260 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2580
11262 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11263 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11264 "there are two types of duplication possible: either cloned PVs/VGs which "
11265 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11266 "same name. In normal operation you cannot create this situation, but you "
11267 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11268 "inside the LVM metadata."
11272 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2593
11273 msgid "You can filter whole block devices or individual partitions."
11277 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2595
11279 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11280 "filesystem), even if you are not filtering out that VG."
11284 #: ../src/guestfs-actions.pod:3817
11285 msgid "guestfs_lvremove"
11289 #: ../src/guestfs-actions.pod:3819
11293 " guestfs_lvremove (guestfs_h *g,\n"
11294 " const char *device);\n"
11299 #: ../src/guestfs-actions.pod:3823 ../fish/guestfish-actions.pod:2603
11301 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11302 "LV, such as C</dev/VG/LV>."
11306 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2606
11308 "You can also remove all LVs in a volume group by specifying the VG name, "
11313 #: ../src/guestfs-actions.pod:3831 ../src/guestfs-actions.pod:5064 ../src/guestfs-actions.pod:6804
11314 msgid "(Added in 1.0.13)"
11318 #: ../src/guestfs-actions.pod:3833
11319 msgid "guestfs_lvrename"
11323 #: ../src/guestfs-actions.pod:3835
11327 " guestfs_lvrename (guestfs_h *g,\n"
11328 " const char *logvol,\n"
11329 " const char *newlogvol);\n"
11334 #: ../src/guestfs-actions.pod:3840 ../fish/guestfish-actions.pod:2613
11335 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11339 #: ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:6817
11340 msgid "(Added in 1.0.83)"
11344 #: ../src/guestfs-actions.pod:3846
11345 msgid "guestfs_lvresize"
11349 #: ../src/guestfs-actions.pod:3848
11353 " guestfs_lvresize (guestfs_h *g,\n"
11354 " const char *device,\n"
11360 #: ../src/guestfs-actions.pod:3853 ../fish/guestfish-actions.pod:2619
11362 "This resizes (expands or shrinks) an existing LVM logical volume to "
11363 "C<mbytes>. When reducing, data in the reduced part is lost."
11367 #: ../src/guestfs-actions.pod:3861
11368 msgid "guestfs_lvresize_free"
11372 #: ../src/guestfs-actions.pod:3863
11376 " guestfs_lvresize_free (guestfs_h *g,\n"
11377 " const char *lv,\n"
11383 #: ../src/guestfs-actions.pod:3868 ../fish/guestfish-actions.pod:2627
11385 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11386 "remaining free space in the volume group. Commonly you would call this with "
11387 "pc = 100 which expands the logical volume as much as possible, using all "
11388 "remaining free space in the volume group."
11392 #: ../src/guestfs-actions.pod:3876
11393 msgid "(Added in 1.3.3)"
11397 #: ../src/guestfs-actions.pod:3878
11398 msgid "guestfs_lvs"
11402 #: ../src/guestfs-actions.pod:3880
11406 " guestfs_lvs (guestfs_h *g);\n"
11411 #: ../src/guestfs-actions.pod:3883 ../fish/guestfish-actions.pod:2637
11413 "List all the logical volumes detected. This is the equivalent of the "
11414 "L<lvs(8)> command."
11418 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2640
11420 "This returns a list of the logical volume device names "
11421 "(eg. C</dev/VolGroup00/LogVol00>)."
11425 #: ../src/guestfs-actions.pod:3889
11426 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
11430 #: ../src/guestfs-actions.pod:3897
11431 msgid "guestfs_lvs_full"
11435 #: ../src/guestfs-actions.pod:3899
11438 " struct guestfs_lvm_lv_list *\n"
11439 " guestfs_lvs_full (guestfs_h *g);\n"
11444 #: ../src/guestfs-actions.pod:3902 ../fish/guestfish-actions.pod:2649
11446 "List all the logical volumes detected. This is the equivalent of the "
11447 "L<lvs(8)> command. The \"full\" version includes all fields."
11451 #: ../src/guestfs-actions.pod:3905
11453 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
11454 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
11459 #: ../src/guestfs-actions.pod:3911
11460 msgid "guestfs_lvuuid"
11464 #: ../src/guestfs-actions.pod:3913
11468 " guestfs_lvuuid (guestfs_h *g,\n"
11469 " const char *device);\n"
11474 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2656
11475 msgid "This command returns the UUID of the LVM LV C<device>."
11479 #: ../src/guestfs-actions.pod:3924
11480 msgid "guestfs_lxattrlist"
11484 #: ../src/guestfs-actions.pod:3926
11487 " struct guestfs_xattr_list *\n"
11488 " guestfs_lxattrlist (guestfs_h *g,\n"
11489 " const char *path,\n"
11490 " char *const *names);\n"
11495 #: ../src/guestfs-actions.pod:3931 ../fish/guestfish-actions.pod:2662
11497 "This call allows you to get the extended attributes of multiple files, where "
11498 "all files are in the directory C<path>. C<names> is the list of files from "
11503 #: ../src/guestfs-actions.pod:3935 ../fish/guestfish-actions.pod:2666
11505 "On return you get a flat list of xattr structs which must be interpreted "
11506 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11507 "C<attrval> in this struct is zero-length to indicate there was an error "
11508 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11509 "number (the number of following attributes for this file, which could be "
11510 "C<\"0\">). Then after the first xattr struct are the zero or more "
11511 "attributes for the first named file. This repeats for the second and "
11512 "subsequent files."
11516 #: ../src/guestfs-actions.pod:3945
11518 "This call is intended for programs that want to efficiently list a directory "
11519 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11520 "a similarly efficient call for getting standard stats. Very long directory "
11521 "listings might cause the protocol message size to be exceeded, causing this "
11522 "call to fail. The caller must split up such requests into smaller groups of "
11527 #: ../src/guestfs-actions.pod:3959
11528 msgid "guestfs_mkdir"
11532 #: ../src/guestfs-actions.pod:3961
11536 " guestfs_mkdir (guestfs_h *g,\n"
11537 " const char *path);\n"
11542 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2688
11543 msgid "Create a directory named C<path>."
11547 #: ../src/guestfs-actions.pod:3971
11548 msgid "guestfs_mkdir_mode"
11552 #: ../src/guestfs-actions.pod:3973
11556 " guestfs_mkdir_mode (guestfs_h *g,\n"
11557 " const char *path,\n"
11563 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2694
11565 "This command creates a directory, setting the initial permissions of the "
11566 "directory to C<mode>."
11570 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2697
11572 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11573 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11578 #: ../src/guestfs-actions.pod:3985
11579 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11583 #: ../src/guestfs-actions.pod:3991
11584 msgid "guestfs_mkdir_p"
11588 #: ../src/guestfs-actions.pod:3993
11592 " guestfs_mkdir_p (guestfs_h *g,\n"
11593 " const char *path);\n"
11598 #: ../src/guestfs-actions.pod:3997 ../fish/guestfish-actions.pod:2707
11600 "Create a directory named C<path>, creating any parent directories as "
11601 "necessary. This is like the C<mkdir -p> shell command."
11605 #: ../src/guestfs-actions.pod:4004
11606 msgid "guestfs_mkdtemp"
11610 #: ../src/guestfs-actions.pod:4006
11614 " guestfs_mkdtemp (guestfs_h *g,\n"
11615 " const char *template);\n"
11620 #: ../src/guestfs-actions.pod:4010 ../fish/guestfish-actions.pod:2714
11622 "This command creates a temporary directory. The C<template> parameter "
11623 "should be a full pathname for the temporary directory name with the final "
11624 "six characters being \"XXXXXX\"."
11628 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2719
11630 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11631 "being suitable for Windows filesystems."
11635 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2722
11636 msgid "The name of the temporary directory that was created is returned."
11640 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2725
11641 msgid "The temporary directory is created with mode 0700 and is owned by root."
11645 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2728
11647 "The caller is responsible for deleting the temporary directory and its "
11648 "contents after use."
11652 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2731
11653 msgid "See also: L<mkdtemp(3)>"
11657 #: ../src/guestfs-actions.pod:4034
11658 msgid "guestfs_mke2fs_J"
11662 #: ../src/guestfs-actions.pod:4036
11666 " guestfs_mke2fs_J (guestfs_h *g,\n"
11667 " const char *fstype,\n"
11668 " int blocksize,\n"
11669 " const char *device,\n"
11670 " const char *journal);\n"
11675 #: ../src/guestfs-actions.pod:4043 ../fish/guestfish-actions.pod:2737
11677 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11678 "C<journal>. It is equivalent to the command:"
11682 #: ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2741
11685 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11690 #: ../src/guestfs-actions.pod:4049
11691 msgid "See also C<guestfs_mke2journal>."
11695 #: ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4071 ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:4119 ../src/guestfs-actions.pod:4133 ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4445
11696 msgid "(Added in 1.0.68)"
11700 #: ../src/guestfs-actions.pod:4055
11701 msgid "guestfs_mke2fs_JL"
11705 #: ../src/guestfs-actions.pod:4057
11709 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11710 " const char *fstype,\n"
11711 " int blocksize,\n"
11712 " const char *device,\n"
11713 " const char *label);\n"
11718 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2749
11720 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11721 "the journal labeled C<label>."
11725 #: ../src/guestfs-actions.pod:4067
11726 msgid "See also C<guestfs_mke2journal_L>."
11730 #: ../src/guestfs-actions.pod:4073
11731 msgid "guestfs_mke2fs_JU"
11735 #: ../src/guestfs-actions.pod:4075
11739 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11740 " const char *fstype,\n"
11741 " int blocksize,\n"
11742 " const char *device,\n"
11743 " const char *uuid);\n"
11748 #: ../src/guestfs-actions.pod:4082 ../fish/guestfish-actions.pod:2758
11750 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11751 "the journal with UUID C<uuid>."
11755 #: ../src/guestfs-actions.pod:4085
11756 msgid "See also C<guestfs_mke2journal_U>."
11760 #: ../src/guestfs-actions.pod:4091
11761 msgid "guestfs_mke2journal"
11765 #: ../src/guestfs-actions.pod:4093
11769 " guestfs_mke2journal (guestfs_h *g,\n"
11770 " int blocksize,\n"
11771 " const char *device);\n"
11776 #: ../src/guestfs-actions.pod:4098 ../fish/guestfish-actions.pod:2767
11778 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11783 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2770
11786 " mke2fs -O journal_dev -b blocksize device\n"
11791 #: ../src/guestfs-actions.pod:4107
11792 msgid "guestfs_mke2journal_L"
11796 #: ../src/guestfs-actions.pod:4109
11800 " guestfs_mke2journal_L (guestfs_h *g,\n"
11801 " int blocksize,\n"
11802 " const char *label,\n"
11803 " const char *device);\n"
11808 #: ../src/guestfs-actions.pod:4115 ../fish/guestfish-actions.pod:2776
11809 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11813 #: ../src/guestfs-actions.pod:4121
11814 msgid "guestfs_mke2journal_U"
11818 #: ../src/guestfs-actions.pod:4123
11822 " guestfs_mke2journal_U (guestfs_h *g,\n"
11823 " int blocksize,\n"
11824 " const char *uuid,\n"
11825 " const char *device);\n"
11830 #: ../src/guestfs-actions.pod:4129 ../fish/guestfish-actions.pod:2782
11831 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11835 #: ../src/guestfs-actions.pod:4135
11836 msgid "guestfs_mkfifo"
11840 #: ../src/guestfs-actions.pod:4137
11844 " guestfs_mkfifo (guestfs_h *g,\n"
11846 " const char *path);\n"
11851 #: ../src/guestfs-actions.pod:4142
11853 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11854 "is just a convenient wrapper around C<guestfs_mknod>."
11858 #: ../src/guestfs-actions.pod:4152
11859 msgid "guestfs_mkfs"
11863 #: ../src/guestfs-actions.pod:4154
11867 " guestfs_mkfs (guestfs_h *g,\n"
11868 " const char *fstype,\n"
11869 " const char *device);\n"
11874 #: ../src/guestfs-actions.pod:4159 ../fish/guestfish-actions.pod:2798
11876 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11877 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11881 #: ../src/guestfs-actions.pod:4167
11882 msgid "guestfs_mkfs_b"
11886 #: ../src/guestfs-actions.pod:4169
11890 " guestfs_mkfs_b (guestfs_h *g,\n"
11891 " const char *fstype,\n"
11892 " int blocksize,\n"
11893 " const char *device);\n"
11898 #: ../src/guestfs-actions.pod:4175
11900 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11901 "block size of the resulting filesystem. Supported block sizes depend on the "
11902 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11906 #: ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4222 ../fish/guestfish-actions.pod:2811 ../fish/guestfish-actions.pod:2838
11908 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11913 #: ../src/guestfs-actions.pod:4185
11915 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
11920 #: ../src/guestfs-actions.pod:4194
11921 msgid "guestfs_mkfs_opts"
11925 #: ../src/guestfs-actions.pod:4196
11929 " guestfs_mkfs_opts (guestfs_h *g,\n"
11930 " const char *fstype,\n"
11931 " const char *device,\n"
11937 #: ../src/guestfs-actions.pod:4207
11940 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
11945 #: ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:2825
11947 "This function creates a filesystem on C<device>. The filesystem type is "
11948 "C<fstype>, for example C<ext3>."
11952 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2832
11953 msgid "C<blocksize>"
11957 #: ../src/guestfs-actions.pod:4218 ../fish/guestfish-actions.pod:2834
11959 "The filesystem block size. Supported block sizes depend on the filesystem "
11960 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11965 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2841
11966 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
11970 #: ../src/guestfs-actions.pod:4231
11971 msgid "(Added in 1.7.19)"
11975 #: ../src/guestfs-actions.pod:4233
11976 msgid "guestfs_mkfs_opts_va"
11980 #: ../src/guestfs-actions.pod:4235
11984 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
11985 " const char *fstype,\n"
11986 " const char *device,\n"
11987 " va_list args);\n"
11992 #: ../src/guestfs-actions.pod:4241
11993 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
11997 #: ../src/guestfs-actions.pod:4245
11998 msgid "guestfs_mkfs_opts_argv"
12002 #: ../src/guestfs-actions.pod:4247
12006 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
12007 " const char *fstype,\n"
12008 " const char *device,\n"
12009 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12014 #: ../src/guestfs-actions.pod:4253
12015 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12019 #: ../src/guestfs-actions.pod:4257
12020 msgid "guestfs_mkmountpoint"
12024 #: ../src/guestfs-actions.pod:4259
12028 " guestfs_mkmountpoint (guestfs_h *g,\n"
12029 " const char *exemptpath);\n"
12034 #: ../src/guestfs-actions.pod:4263
12036 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12037 "that can be used to create extra mountpoints before mounting the first "
12042 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2855
12044 "These calls are I<only> necessary in some very limited circumstances, mainly "
12045 "the case where you want to mount a mix of unrelated and/or read-only "
12046 "filesystems together."
12050 #: ../src/guestfs-actions.pod:4271 ../fish/guestfish-actions.pod:2859
12052 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12053 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12054 "inside that. You can unpack this as follows in guestfish:"
12058 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2864
12061 " add-ro Fedora-11-i686-Live.iso\n"
12063 " mkmountpoint /cd\n"
12064 " mkmountpoint /sqsh\n"
12065 " mkmountpoint /ext3fs\n"
12066 " mount /dev/sda /cd\n"
12067 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12068 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12073 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2873
12074 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12078 #: ../src/guestfs-actions.pod:4287
12080 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12081 "may get unexpected errors if you try to mix these calls. It is safest to "
12082 "manually unmount filesystems and remove mountpoints after use."
12086 #: ../src/guestfs-actions.pod:4291
12088 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12089 "first, so for this to work for manual mountpoints, you must ensure that the "
12090 "innermost mountpoints have the longest pathnames, as in the example code "
12095 #: ../src/guestfs-actions.pod:4296 ../fish/guestfish-actions.pod:2884
12096 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12100 #: ../src/guestfs-actions.pod:4298
12102 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12103 "means that C<guestfs_umount_all> is called when the handle is closed which "
12104 "can also trigger these issues."
12108 #: ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:4563 ../src/guestfs-actions.pod:5465
12109 msgid "(Added in 1.0.62)"
12113 #: ../src/guestfs-actions.pod:4306
12114 msgid "guestfs_mknod"
12118 #: ../src/guestfs-actions.pod:4308
12122 " guestfs_mknod (guestfs_h *g,\n"
12126 " const char *path);\n"
12131 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2894
12133 "This call creates block or character special devices, or named pipes "
12138 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:2897
12140 "The C<mode> parameter should be the mode, using the standard constants. "
12141 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12142 "used when creating block and character special devices."
12146 #: ../src/guestfs-actions.pod:4323
12148 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12149 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12150 "regular file). These constants are available in the standard Linux header "
12151 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12152 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12153 "the appropriate constant for you."
12157 #: ../src/guestfs-actions.pod:4337
12158 msgid "guestfs_mknod_b"
12162 #: ../src/guestfs-actions.pod:4339
12166 " guestfs_mknod_b (guestfs_h *g,\n"
12170 " const char *path);\n"
12175 #: ../src/guestfs-actions.pod:4346
12177 "This call creates a block device node called C<path> with mode C<mode> and "
12178 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12179 "wrapper around C<guestfs_mknod>."
12183 #: ../src/guestfs-actions.pod:4356
12184 msgid "guestfs_mknod_c"
12188 #: ../src/guestfs-actions.pod:4358
12192 " guestfs_mknod_c (guestfs_h *g,\n"
12196 " const char *path);\n"
12201 #: ../src/guestfs-actions.pod:4365
12203 "This call creates a char device node called C<path> with mode C<mode> and "
12204 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12205 "wrapper around C<guestfs_mknod>."
12209 #: ../src/guestfs-actions.pod:4375
12210 msgid "guestfs_mkswap"
12214 #: ../src/guestfs-actions.pod:4377
12218 " guestfs_mkswap (guestfs_h *g,\n"
12219 " const char *device);\n"
12224 #: ../src/guestfs-actions.pod:4381 ../fish/guestfish-actions.pod:2936
12225 msgid "Create a swap partition on C<device>."
12229 #: ../src/guestfs-actions.pod:4387
12230 msgid "guestfs_mkswap_L"
12234 #: ../src/guestfs-actions.pod:4389
12238 " guestfs_mkswap_L (guestfs_h *g,\n"
12239 " const char *label,\n"
12240 " const char *device);\n"
12245 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2942
12246 msgid "Create a swap partition on C<device> with label C<label>."
12250 #: ../src/guestfs-actions.pod:4396 ../fish/guestfish-actions.pod:2944
12252 "Note that you cannot attach a swap label to a block device "
12253 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12254 "the kernel or swap tools."
12258 #: ../src/guestfs-actions.pod:4404
12259 msgid "guestfs_mkswap_U"
12263 #: ../src/guestfs-actions.pod:4406
12267 " guestfs_mkswap_U (guestfs_h *g,\n"
12268 " const char *uuid,\n"
12269 " const char *device);\n"
12274 #: ../src/guestfs-actions.pod:4411 ../fish/guestfish-actions.pod:2952
12275 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12279 #: ../src/guestfs-actions.pod:4417
12280 msgid "guestfs_mkswap_file"
12284 #: ../src/guestfs-actions.pod:4419
12288 " guestfs_mkswap_file (guestfs_h *g,\n"
12289 " const char *path);\n"
12294 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:2958
12295 msgid "Create a swap file."
12299 #: ../src/guestfs-actions.pod:4425
12301 "This command just writes a swap file signature to an existing file. To "
12302 "create the file itself, use something like C<guestfs_fallocate>."
12306 #: ../src/guestfs-actions.pod:4432
12307 msgid "guestfs_modprobe"
12311 #: ../src/guestfs-actions.pod:4434
12315 " guestfs_modprobe (guestfs_h *g,\n"
12316 " const char *modulename);\n"
12321 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2967
12322 msgid "This loads a kernel module in the appliance."
12326 #: ../src/guestfs-actions.pod:4440 ../fish/guestfish-actions.pod:2969
12328 "The kernel module must have been whitelisted when libguestfs was built (see "
12329 "C<appliance/kmod.whitelist.in> in the source)."
12333 #: ../src/guestfs-actions.pod:4447
12334 msgid "guestfs_mount"
12338 #: ../src/guestfs-actions.pod:4449
12342 " guestfs_mount (guestfs_h *g,\n"
12343 " const char *device,\n"
12344 " const char *mountpoint);\n"
12349 #: ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:2976
12351 "Mount a guest disk at a position in the filesystem. Block devices are named "
12352 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12353 "those block devices contain partitions, they will have the usual names "
12354 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12358 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:2982
12360 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12361 "mounted on C</> before others can be mounted. Other filesystems can only be "
12362 "mounted on directories which already exist."
12366 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2987
12368 "The mounted filesystem is writable, if we have sufficient permissions on the "
12369 "underlying device."
12373 #: ../src/guestfs-actions.pod:4468
12375 "B<Important note:> When you use this call, the filesystem options C<sync> "
12376 "and C<noatime> are set implicitly. This was originally done because we "
12377 "thought it would improve reliability, but it turns out that I<-o sync> has a "
12378 "very large negative performance impact and negligible effect on "
12379 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
12380 "in any code that needs performance, and instead use C<guestfs_mount_options> "
12381 "(use an empty string for the first parameter if you don't want any options)."
12385 #: ../src/guestfs-actions.pod:4482
12386 msgid "guestfs_mount_loop"
12390 #: ../src/guestfs-actions.pod:4484
12394 " guestfs_mount_loop (guestfs_h *g,\n"
12395 " const char *file,\n"
12396 " const char *mountpoint);\n"
12401 #: ../src/guestfs-actions.pod:4489 ../fish/guestfish-actions.pod:3004
12403 "This command lets you mount C<file> (a filesystem image in a file) on a "
12404 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12409 #: ../src/guestfs-actions.pod:4497
12410 msgid "guestfs_mount_options"
12414 #: ../src/guestfs-actions.pod:4499
12418 " guestfs_mount_options (guestfs_h *g,\n"
12419 " const char *options,\n"
12420 " const char *device,\n"
12421 " const char *mountpoint);\n"
12426 #: ../src/guestfs-actions.pod:4505
12428 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12429 "the mount options as for the L<mount(8)> I<-o> flag."
12433 #: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:3016
12435 "If the C<options> parameter is an empty string, then no options are passed "
12436 "(all options default to whatever the filesystem uses)."
12440 #: ../src/guestfs-actions.pod:4515 ../src/guestfs-actions.pod:4529 ../src/guestfs-actions.pod:4546
12441 msgid "(Added in 1.0.10)"
12445 #: ../src/guestfs-actions.pod:4517
12446 msgid "guestfs_mount_ro"
12450 #: ../src/guestfs-actions.pod:4519
12454 " guestfs_mount_ro (guestfs_h *g,\n"
12455 " const char *device,\n"
12456 " const char *mountpoint);\n"
12461 #: ../src/guestfs-actions.pod:4524
12463 "This is the same as the C<guestfs_mount> command, but it mounts the "
12464 "filesystem with the read-only (I<-o ro>) flag."
12468 #: ../src/guestfs-actions.pod:4531
12469 msgid "guestfs_mount_vfs"
12473 #: ../src/guestfs-actions.pod:4533
12477 " guestfs_mount_vfs (guestfs_h *g,\n"
12478 " const char *options,\n"
12479 " const char *vfstype,\n"
12480 " const char *device,\n"
12481 " const char *mountpoint);\n"
12486 #: ../src/guestfs-actions.pod:4540
12488 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12489 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
12494 #: ../src/guestfs-actions.pod:4548
12495 msgid "guestfs_mountpoints"
12499 #: ../src/guestfs-actions.pod:4550
12503 " guestfs_mountpoints (guestfs_h *g);\n"
12508 #: ../src/guestfs-actions.pod:4553
12510 "This call is similar to C<guestfs_mounts>. That call returns a list of "
12511 "devices. This one returns a hash table (map) of device name to directory "
12512 "where the device is mounted."
12516 #: ../src/guestfs-actions.pod:4565
12517 msgid "guestfs_mounts"
12521 #: ../src/guestfs-actions.pod:4567
12525 " guestfs_mounts (guestfs_h *g);\n"
12530 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3047
12532 "This returns the list of currently mounted filesystems. It returns the list "
12533 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12537 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3050
12538 msgid "Some internal mounts are not shown."
12542 #: ../src/guestfs-actions.pod:4575
12543 msgid "See also: C<guestfs_mountpoints>"
12547 #: ../src/guestfs-actions.pod:4583
12552 #: ../src/guestfs-actions.pod:4585
12556 " guestfs_mv (guestfs_h *g,\n"
12557 " const char *src,\n"
12558 " const char *dest);\n"
12563 #: ../src/guestfs-actions.pod:4590 ../fish/guestfish-actions.pod:3058
12565 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12566 "destination filename or destination directory."
12570 #: ../src/guestfs-actions.pod:4597
12571 msgid "guestfs_ntfs_3g_probe"
12575 #: ../src/guestfs-actions.pod:4599
12579 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12581 " const char *device);\n"
12586 #: ../src/guestfs-actions.pod:4604 ../fish/guestfish-actions.pod:3065
12588 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12589 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12590 "read-write, and some cannot be mounted at all)."
12594 #: ../src/guestfs-actions.pod:4608 ../fish/guestfish-actions.pod:3069
12596 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12597 "can be mounted read-write. Set it to false if you want to test if the "
12598 "volume can be mounted read-only."
12602 #: ../src/guestfs-actions.pod:4612 ../fish/guestfish-actions.pod:3073
12604 "The return value is an integer which C<0> if the operation would succeed, or "
12605 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12609 #: ../src/guestfs-actions.pod:4618
12610 msgid "(Added in 1.0.43)"
12614 #: ../src/guestfs-actions.pod:4620
12615 msgid "guestfs_ntfsresize"
12619 #: ../src/guestfs-actions.pod:4622
12623 " guestfs_ntfsresize (guestfs_h *g,\n"
12624 " const char *device);\n"
12629 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3081
12631 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12632 "size of the underlying device."
12636 #: ../src/guestfs-actions.pod:4629 ../fish/guestfish-actions.pod:3084
12638 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
12639 "consistency check (for safety). You have to boot into Windows to perform "
12640 "this check and clear this condition. Furthermore, ntfsresize refuses to "
12641 "resize filesystems which have been marked in this way. So in effect it is "
12642 "not possible to call ntfsresize multiple times on a single filesystem "
12643 "without booting into Windows between each resize."
12647 #: ../src/guestfs-actions.pod:4637 ../fish/guestfish-actions.pod:3092
12648 msgid "See also L<ntfsresize(8)>."
12652 #: ../src/guestfs-actions.pod:4643
12653 msgid "guestfs_ntfsresize_size"
12657 #: ../src/guestfs-actions.pod:4645
12661 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12662 " const char *device,\n"
12663 " int64_t size);\n"
12668 #: ../src/guestfs-actions.pod:4650
12670 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12671 "to specify the new size (in bytes) explicitly."
12675 #: ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:5091 ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5413 ../src/guestfs-actions.pod:6952
12676 msgid "(Added in 1.3.14)"
12680 #: ../src/guestfs-actions.pod:4657
12681 msgid "guestfs_part_add"
12685 #: ../src/guestfs-actions.pod:4659
12689 " guestfs_part_add (guestfs_h *g,\n"
12690 " const char *device,\n"
12691 " const char *prlogex,\n"
12692 " int64_t startsect,\n"
12693 " int64_t endsect);\n"
12698 #: ../src/guestfs-actions.pod:4666
12700 "This command adds a partition to C<device>. If there is no partition table "
12701 "on the device, call C<guestfs_part_init> first."
12705 #: ../src/guestfs-actions.pod:4669 ../fish/guestfish-actions.pod:3108
12707 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12708 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12709 "C<logical>) and C<e> (or C<extended>) partition types."
12713 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3113
12715 "C<startsect> and C<endsect> are the start and end of the partition in "
12716 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12717 "from the end of the disk (C<-1> is the last sector)."
12721 #: ../src/guestfs-actions.pod:4678
12723 "Creating a partition which covers the whole disk is not so easy. Use "
12724 "C<guestfs_part_disk> to do that."
12728 #: ../src/guestfs-actions.pod:4683 ../src/guestfs-actions.pod:4721 ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4852 ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4909 ../src/guestfs-actions.pod:4949
12729 msgid "(Added in 1.0.78)"
12733 #: ../src/guestfs-actions.pod:4685
12734 msgid "guestfs_part_del"
12738 #: ../src/guestfs-actions.pod:4687
12742 " guestfs_part_del (guestfs_h *g,\n"
12743 " const char *device,\n"
12749 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3124
12750 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12754 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3126
12756 "Note that in the case of MBR partitioning, deleting an extended partition "
12757 "also deletes any logical partitions it contains."
12761 #: ../src/guestfs-actions.pod:4702
12762 msgid "guestfs_part_disk"
12766 #: ../src/guestfs-actions.pod:4704
12770 " guestfs_part_disk (guestfs_h *g,\n"
12771 " const char *device,\n"
12772 " const char *parttype);\n"
12777 #: ../src/guestfs-actions.pod:4709
12779 "This command is simply a combination of C<guestfs_part_init> followed by "
12780 "C<guestfs_part_add> to create a single primary partition covering the whole "
12785 #: ../src/guestfs-actions.pod:4713
12787 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12788 "possible values are described in C<guestfs_part_init>."
12792 #: ../src/guestfs-actions.pod:4723
12793 msgid "guestfs_part_get_bootable"
12797 #: ../src/guestfs-actions.pod:4725
12801 " guestfs_part_get_bootable (guestfs_h *g,\n"
12802 " const char *device,\n"
12808 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3148
12810 "This command returns true if the partition C<partnum> on C<device> has the "
12811 "bootable flag set."
12815 #: ../src/guestfs-actions.pod:4733
12816 msgid "See also C<guestfs_part_set_bootable>."
12820 #: ../src/guestfs-actions.pod:4739
12821 msgid "guestfs_part_get_mbr_id"
12825 #: ../src/guestfs-actions.pod:4741
12829 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12830 " const char *device,\n"
12836 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3157
12838 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12839 "partition C<partnum>."
12843 #: ../src/guestfs-actions.pod:4749 ../src/guestfs-actions.pod:4925
12845 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12846 "undefined results for other partition table types (see "
12847 "C<guestfs_part_get_parttype>)."
12851 #: ../src/guestfs-actions.pod:4757
12852 msgid "guestfs_part_get_parttype"
12856 #: ../src/guestfs-actions.pod:4759
12860 " guestfs_part_get_parttype (guestfs_h *g,\n"
12861 " const char *device);\n"
12866 #: ../src/guestfs-actions.pod:4763 ../fish/guestfish-actions.pod:3168
12868 "This command examines the partition table on C<device> and returns the "
12869 "partition table type (format) being used."
12873 #: ../src/guestfs-actions.pod:4766
12875 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12876 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12877 "possible, although unusual. See C<guestfs_part_init> for a full list."
12881 #: ../src/guestfs-actions.pod:4776
12882 msgid "guestfs_part_init"
12886 #: ../src/guestfs-actions.pod:4778
12890 " guestfs_part_init (guestfs_h *g,\n"
12891 " const char *device,\n"
12892 " const char *parttype);\n"
12897 #: ../src/guestfs-actions.pod:4783 ../fish/guestfish-actions.pod:3180
12899 "This creates an empty partition table on C<device> of one of the partition "
12900 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12901 "(for large disks)."
12905 #: ../src/guestfs-actions.pod:4787
12907 "Initially there are no partitions. Following this, you should call "
12908 "C<guestfs_part_add> for each partition required."
12912 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3187
12913 msgid "Possible values for C<parttype> are:"
12917 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3191
12918 msgid "B<efi> | B<gpt>"
12922 #: ../src/guestfs-actions.pod:4796 ../fish/guestfish-actions.pod:3193
12923 msgid "Intel EFI / GPT partition table."
12927 #: ../src/guestfs-actions.pod:4798 ../fish/guestfish-actions.pod:3195
12929 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12930 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12931 "the C<mbr> format."
12935 #: ../src/guestfs-actions.pod:4802 ../fish/guestfish-actions.pod:3199
12936 msgid "B<mbr> | B<msdos>"
12940 #: ../src/guestfs-actions.pod:4804 ../fish/guestfish-actions.pod:3201
12942 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12943 "Windows. This partition type will B<only> work for device sizes up to 2 "
12944 "TB. For large disks we recommend using C<gpt>."
12948 #: ../src/guestfs-actions.pod:4811 ../fish/guestfish-actions.pod:3208
12949 msgid "Other partition table types that may work but are not supported include:"
12953 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3213
12958 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3215
12959 msgid "AIX disk labels."
12963 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:3217
12964 msgid "B<amiga> | B<rdb>"
12968 #: ../src/guestfs-actions.pod:4822 ../fish/guestfish-actions.pod:3219
12969 msgid "Amiga \"Rigid Disk Block\" format."
12973 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3221
12978 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3223
12979 msgid "BSD disk labels."
12983 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3225
12988 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3227
12989 msgid "DASD, used on IBM mainframes."
12993 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3229
12998 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3231
12999 msgid "MIPS/SGI volumes."
13003 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3233
13008 #: ../src/guestfs-actions.pod:4838 ../fish/guestfish-actions.pod:3235
13009 msgid "Old Mac partition format. Modern Macs use C<gpt>."
13013 #: ../src/guestfs-actions.pod:4840 ../fish/guestfish-actions.pod:3237
13018 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3239
13019 msgid "NEC PC-98 format, common in Japan apparently."
13023 #: ../src/guestfs-actions.pod:4844 ../fish/guestfish-actions.pod:3241
13028 #: ../src/guestfs-actions.pod:4846 ../fish/guestfish-actions.pod:3243
13029 msgid "Sun disk labels."
13033 #: ../src/guestfs-actions.pod:4854
13034 msgid "guestfs_part_list"
13038 #: ../src/guestfs-actions.pod:4856
13041 " struct guestfs_partition_list *\n"
13042 " guestfs_part_list (guestfs_h *g,\n"
13043 " const char *device);\n"
13048 #: ../src/guestfs-actions.pod:4860 ../fish/guestfish-actions.pod:3251
13050 "This command parses the partition table on C<device> and returns the list of "
13051 "partitions found."
13055 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3254
13056 msgid "The fields in the returned structure are:"
13060 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3258
13061 msgid "B<part_num>"
13065 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3260
13066 msgid "Partition number, counting from 1."
13070 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3262
13071 msgid "B<part_start>"
13075 #: ../src/guestfs-actions.pod:4873
13077 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13078 "the device's sector size, see C<guestfs_blockdev_getss>."
13082 #: ../src/guestfs-actions.pod:4876 ../fish/guestfish-actions.pod:3267
13083 msgid "B<part_end>"
13087 #: ../src/guestfs-actions.pod:4878 ../fish/guestfish-actions.pod:3269
13088 msgid "End of the partition in bytes."
13092 #: ../src/guestfs-actions.pod:4880 ../fish/guestfish-actions.pod:3271
13093 msgid "B<part_size>"
13097 #: ../src/guestfs-actions.pod:4882 ../fish/guestfish-actions.pod:3273
13098 msgid "Size of the partition in bytes."
13102 #: ../src/guestfs-actions.pod:4886
13104 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13105 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13110 #: ../src/guestfs-actions.pod:4892
13111 msgid "guestfs_part_set_bootable"
13115 #: ../src/guestfs-actions.pod:4894
13119 " guestfs_part_set_bootable (guestfs_h *g,\n"
13120 " const char *device,\n"
13122 " int bootable);\n"
13127 #: ../src/guestfs-actions.pod:4900 ../fish/guestfish-actions.pod:3281
13129 "This sets the bootable flag on partition numbered C<partnum> on device "
13130 "C<device>. Note that partitions are numbered from 1."
13134 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3284
13136 "The bootable flag is used by some operating systems (notably Windows) to "
13137 "determine which partition to boot from. It is by no means universally "
13142 #: ../src/guestfs-actions.pod:4911
13143 msgid "guestfs_part_set_mbr_id"
13147 #: ../src/guestfs-actions.pod:4913
13151 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13152 " const char *device,\n"
13159 #: ../src/guestfs-actions.pod:4919 ../fish/guestfish-actions.pod:3292
13161 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13162 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13163 "documentation are in fact hexadecimal numbers, but usually documented "
13164 "without any leading \"0x\" which might be confusing."
13168 #: ../src/guestfs-actions.pod:4933
13169 msgid "guestfs_part_set_name"
13173 #: ../src/guestfs-actions.pod:4935
13177 " guestfs_part_set_name (guestfs_h *g,\n"
13178 " const char *device,\n"
13180 " const char *name);\n"
13185 #: ../src/guestfs-actions.pod:4941 ../fish/guestfish-actions.pod:3306
13187 "This sets the partition name on partition numbered C<partnum> on device "
13188 "C<device>. Note that partitions are numbered from 1."
13192 #: ../src/guestfs-actions.pod:4944 ../fish/guestfish-actions.pod:3309
13194 "The partition name can only be set on certain types of partition table. "
13195 "This works on C<gpt> but not on C<mbr> partitions."
13199 #: ../src/guestfs-actions.pod:4951
13200 msgid "guestfs_part_to_dev"
13204 #: ../src/guestfs-actions.pod:4953
13208 " guestfs_part_to_dev (guestfs_h *g,\n"
13209 " const char *partition);\n"
13214 #: ../src/guestfs-actions.pod:4957 ../fish/guestfish-actions.pod:3316
13216 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13217 "partition number, returning the device name (eg. \"/dev/sdb\")."
13221 #: ../src/guestfs-actions.pod:4961
13223 "The named partition must exist, for example as a string returned from "
13224 "C<guestfs_list_partitions>."
13228 #: ../src/guestfs-actions.pod:4969
13229 msgid "guestfs_ping_daemon"
13233 #: ../src/guestfs-actions.pod:4971
13237 " guestfs_ping_daemon (guestfs_h *g);\n"
13242 #: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3327
13244 "This is a test probe into the guestfs daemon running inside the qemu "
13245 "subprocess. Calling this function checks that the daemon responds to the "
13246 "ping message, without affecting the daemon or attached block device(s) in "
13251 #: ../src/guestfs-actions.pod:4983
13252 msgid "guestfs_pread"
13256 #: ../src/guestfs-actions.pod:4985
13260 " guestfs_pread (guestfs_h *g,\n"
13261 " const char *path,\n"
13263 " int64_t offset,\n"
13264 " size_t *size_r);\n"
13269 #: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3336
13271 "This command lets you read part of a file. It reads C<count> bytes of the "
13272 "file, starting at C<offset>, from file C<path>."
13276 #: ../src/guestfs-actions.pod:4995 ../src/guestfs-actions.pod:5021 ../fish/guestfish-actions.pod:3339 ../fish/guestfish-actions.pod:3354
13278 "This may read fewer bytes than requested. For further details see the "
13279 "L<pread(2)> system call."
13283 #: ../src/guestfs-actions.pod:4998
13284 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
13288 #: ../src/guestfs-actions.pod:5009
13289 msgid "guestfs_pread_device"
13293 #: ../src/guestfs-actions.pod:5011
13297 " guestfs_pread_device (guestfs_h *g,\n"
13298 " const char *device,\n"
13300 " int64_t offset,\n"
13301 " size_t *size_r);\n"
13306 #: ../src/guestfs-actions.pod:5018 ../fish/guestfish-actions.pod:3351
13308 "This command lets you read part of a file. It reads C<count> bytes of "
13309 "C<device>, starting at C<offset>."
13313 #: ../src/guestfs-actions.pod:5024
13314 msgid "See also C<guestfs_pread>."
13318 #: ../src/guestfs-actions.pod:5033
13319 msgid "(Added in 1.5.21)"
13323 #: ../src/guestfs-actions.pod:5035
13324 msgid "guestfs_pvcreate"
13328 #: ../src/guestfs-actions.pod:5037
13332 " guestfs_pvcreate (guestfs_h *g,\n"
13333 " const char *device);\n"
13338 #: ../src/guestfs-actions.pod:5041 ../fish/guestfish-actions.pod:3366
13340 "This creates an LVM physical volume on the named C<device>, where C<device> "
13341 "should usually be a partition name such as C</dev/sda1>."
13345 #: ../src/guestfs-actions.pod:5049
13346 msgid "guestfs_pvremove"
13350 #: ../src/guestfs-actions.pod:5051
13354 " guestfs_pvremove (guestfs_h *g,\n"
13355 " const char *device);\n"
13360 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3374
13362 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13367 #: ../src/guestfs-actions.pod:5058 ../fish/guestfish-actions.pod:3377
13369 "The implementation uses the C<pvremove> command which refuses to wipe "
13370 "physical volumes that contain any volume groups, so you have to remove those "
13375 #: ../src/guestfs-actions.pod:5066
13376 msgid "guestfs_pvresize"
13380 #: ../src/guestfs-actions.pod:5068
13384 " guestfs_pvresize (guestfs_h *g,\n"
13385 " const char *device);\n"
13390 #: ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:3385
13392 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13393 "the new size of the underlying device."
13397 #: ../src/guestfs-actions.pod:5079
13398 msgid "guestfs_pvresize_size"
13402 #: ../src/guestfs-actions.pod:5081
13406 " guestfs_pvresize_size (guestfs_h *g,\n"
13407 " const char *device,\n"
13408 " int64_t size);\n"
13413 #: ../src/guestfs-actions.pod:5086
13415 "This command is the same as C<guestfs_pvresize> except that it allows you to "
13416 "specify the new size (in bytes) explicitly."
13420 #: ../src/guestfs-actions.pod:5093
13421 msgid "guestfs_pvs"
13425 #: ../src/guestfs-actions.pod:5095
13429 " guestfs_pvs (guestfs_h *g);\n"
13434 #: ../src/guestfs-actions.pod:5098 ../fish/guestfish-actions.pod:3399
13436 "List all the physical volumes detected. This is the equivalent of the "
13437 "L<pvs(8)> command."
13441 #: ../src/guestfs-actions.pod:5101 ../fish/guestfish-actions.pod:3402
13443 "This returns a list of just the device names that contain PVs "
13444 "(eg. C</dev/sda2>)."
13448 #: ../src/guestfs-actions.pod:5104
13449 msgid "See also C<guestfs_pvs_full>."
13453 #: ../src/guestfs-actions.pod:5112
13454 msgid "guestfs_pvs_full"
13458 #: ../src/guestfs-actions.pod:5114
13461 " struct guestfs_lvm_pv_list *\n"
13462 " guestfs_pvs_full (guestfs_h *g);\n"
13467 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3411
13469 "List all the physical volumes detected. This is the equivalent of the "
13470 "L<pvs(8)> command. The \"full\" version includes all fields."
13474 #: ../src/guestfs-actions.pod:5120
13476 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
13477 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
13482 #: ../src/guestfs-actions.pod:5126
13483 msgid "guestfs_pvuuid"
13487 #: ../src/guestfs-actions.pod:5128
13491 " guestfs_pvuuid (guestfs_h *g,\n"
13492 " const char *device);\n"
13497 #: ../src/guestfs-actions.pod:5132 ../fish/guestfish-actions.pod:3418
13498 msgid "This command returns the UUID of the LVM PV C<device>."
13502 #: ../src/guestfs-actions.pod:5139
13503 msgid "guestfs_pwrite"
13507 #: ../src/guestfs-actions.pod:5141
13511 " guestfs_pwrite (guestfs_h *g,\n"
13512 " const char *path,\n"
13513 " const char *content,\n"
13514 " size_t content_size,\n"
13515 " int64_t offset);\n"
13520 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3424
13522 "This command writes to part of a file. It writes the data buffer C<content> "
13523 "to the file C<path> starting at offset C<offset>."
13527 #: ../src/guestfs-actions.pod:5151 ../fish/guestfish-actions.pod:3427
13529 "This command implements the L<pwrite(2)> system call, and like that system "
13530 "call it may not write the full data requested. The return value is the "
13531 "number of bytes that were actually written to the file. This could even be "
13532 "0, although short writes are unlikely for regular files in ordinary "
13537 #: ../src/guestfs-actions.pod:5157
13538 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
13542 #: ../src/guestfs-actions.pod:5166
13543 msgid "guestfs_pwrite_device"
13547 #: ../src/guestfs-actions.pod:5168
13551 " guestfs_pwrite_device (guestfs_h *g,\n"
13552 " const char *device,\n"
13553 " const char *content,\n"
13554 " size_t content_size,\n"
13555 " int64_t offset);\n"
13560 #: ../src/guestfs-actions.pod:5175 ../fish/guestfish-actions.pod:3442
13562 "This command writes to part of a device. It writes the data buffer "
13563 "C<content> to C<device> starting at offset C<offset>."
13567 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3445
13569 "This command implements the L<pwrite(2)> system call, and like that system "
13570 "call it may not write the full data requested (although short writes to disk "
13571 "devices and partitions are probably impossible with standard Linux kernels)."
13575 #: ../src/guestfs-actions.pod:5183
13576 msgid "See also C<guestfs_pwrite>."
13580 #: ../src/guestfs-actions.pod:5190
13581 msgid "(Added in 1.5.20)"
13585 #: ../src/guestfs-actions.pod:5192
13586 msgid "guestfs_read_file"
13590 #: ../src/guestfs-actions.pod:5194
13594 " guestfs_read_file (guestfs_h *g,\n"
13595 " const char *path,\n"
13596 " size_t *size_r);\n"
13601 #: ../src/guestfs-actions.pod:5199 ../fish/guestfish-actions.pod:3459
13602 msgid "This calls returns the contents of the file C<path> as a buffer."
13606 #: ../src/guestfs-actions.pod:5202
13608 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13609 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13610 "function is limited in the total size of file that can be handled."
13614 #: ../src/guestfs-actions.pod:5214
13615 msgid "(Added in 1.0.63)"
13619 #: ../src/guestfs-actions.pod:5216
13620 msgid "guestfs_read_lines"
13624 #: ../src/guestfs-actions.pod:5218
13628 " guestfs_read_lines (guestfs_h *g,\n"
13629 " const char *path);\n"
13634 #: ../src/guestfs-actions.pod:5224 ../fish/guestfish-actions.pod:3476
13636 "The file contents are returned as a list of lines. Trailing C<LF> and "
13637 "C<CRLF> character sequences are I<not> returned."
13641 #: ../src/guestfs-actions.pod:5227
13643 "Note that this function cannot correctly handle binary files (specifically, "
13644 "files containing C<\\0> character which is treated as end of line). For "
13645 "those you need to use the C<guestfs_read_file> function which has a more "
13646 "complex interface."
13650 #: ../src/guestfs-actions.pod:5238
13651 msgid "guestfs_readdir"
13655 #: ../src/guestfs-actions.pod:5240
13658 " struct guestfs_dirent_list *\n"
13659 " guestfs_readdir (guestfs_h *g,\n"
13660 " const char *dir);\n"
13665 #: ../src/guestfs-actions.pod:5244 ../fish/guestfish-actions.pod:3488
13666 msgid "This returns the list of directory entries in directory C<dir>."
13670 #: ../src/guestfs-actions.pod:5246 ../fish/guestfish-actions.pod:3490
13672 "All entries in the directory are returned, including C<.> and C<..>. The "
13673 "entries are I<not> sorted, but returned in the same order as the underlying "
13678 #: ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3494
13680 "Also this call returns basic file type information about each file. The "
13681 "C<ftyp> field will contain one of the following characters:"
13685 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3499
13690 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3501
13691 msgid "Block special"
13695 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3503
13700 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3505
13701 msgid "Char special"
13705 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3507
13710 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3509
13715 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3511
13720 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:3513
13721 msgid "FIFO (named pipe)"
13725 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3515
13730 #: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:3517
13731 msgid "Symbolic link"
13735 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3519
13740 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3521
13741 msgid "Regular file"
13745 #: ../src/guestfs-actions.pod:5279 ../fish/guestfish-actions.pod:3523
13750 #: ../src/guestfs-actions.pod:5281 ../fish/guestfish-actions.pod:3525
13755 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3527
13760 #: ../src/guestfs-actions.pod:5285 ../fish/guestfish-actions.pod:3529
13761 msgid "Unknown file type"
13765 #: ../src/guestfs-actions.pod:5287 ../fish/guestfish-actions.pod:3531
13770 #: ../src/guestfs-actions.pod:5289 ../fish/guestfish-actions.pod:3533
13771 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13775 #: ../src/guestfs-actions.pod:5294
13777 "This function is primarily intended for use by programs. To get a simple "
13778 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13779 "consumption, use C<guestfs_ll>."
13783 #: ../src/guestfs-actions.pod:5298
13785 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13786 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
13791 #: ../src/guestfs-actions.pod:5304
13792 msgid "guestfs_readlink"
13796 #: ../src/guestfs-actions.pod:5306
13800 " guestfs_readlink (guestfs_h *g,\n"
13801 " const char *path);\n"
13806 #: ../src/guestfs-actions.pod:5310 ../fish/guestfish-actions.pod:3546
13807 msgid "This command reads the target of a symbolic link."
13811 #: ../src/guestfs-actions.pod:5317
13812 msgid "guestfs_readlinklist"
13816 #: ../src/guestfs-actions.pod:5319
13820 " guestfs_readlinklist (guestfs_h *g,\n"
13821 " const char *path,\n"
13822 " char *const *names);\n"
13827 #: ../src/guestfs-actions.pod:5324 ../fish/guestfish-actions.pod:3552
13829 "This call allows you to do a C<readlink> operation on multiple files, where "
13830 "all files are in the directory C<path>. C<names> is the list of files from "
13835 #: ../src/guestfs-actions.pod:5328 ../fish/guestfish-actions.pod:3556
13837 "On return you get a list of strings, with a one-to-one correspondence to the "
13838 "C<names> list. Each string is the value of the symbolic link."
13842 #: ../src/guestfs-actions.pod:5332 ../fish/guestfish-actions.pod:3560
13844 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13845 "result string is the empty string C<\"\">. However the whole operation is "
13846 "completed even if there were C<readlink(2)> errors, and so you can call this "
13847 "function with names where you don't know if they are symbolic links already "
13848 "(albeit slightly less efficient)."
13852 #: ../src/guestfs-actions.pod:5339 ../fish/guestfish-actions.pod:3567
13854 "This call is intended for programs that want to efficiently list a directory "
13855 "contents without making many round-trips. Very long directory listings "
13856 "might cause the protocol message size to be exceeded, causing this call to "
13857 "fail. The caller must split up such requests into smaller groups of names."
13861 #: ../src/guestfs-actions.pod:5352
13862 msgid "guestfs_realpath"
13866 #: ../src/guestfs-actions.pod:5354
13870 " guestfs_realpath (guestfs_h *g,\n"
13871 " const char *path);\n"
13876 #: ../src/guestfs-actions.pod:5358 ../fish/guestfish-actions.pod:3578
13878 "Return the canonicalized absolute pathname of C<path>. The returned path "
13879 "has no C<.>, C<..> or symbolic link path elements."
13883 #: ../src/guestfs-actions.pod:5366
13884 msgid "guestfs_removexattr"
13888 #: ../src/guestfs-actions.pod:5368
13892 " guestfs_removexattr (guestfs_h *g,\n"
13893 " const char *xattr,\n"
13894 " const char *path);\n"
13899 #: ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:3585
13900 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
13904 #: ../src/guestfs-actions.pod:5376
13905 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13909 #: ../src/guestfs-actions.pod:5382
13910 msgid "guestfs_resize2fs"
13914 #: ../src/guestfs-actions.pod:5384
13918 " guestfs_resize2fs (guestfs_h *g,\n"
13919 " const char *device);\n"
13924 #: ../src/guestfs-actions.pod:5388 ../fish/guestfish-actions.pod:3594
13926 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13927 "underlying device."
13931 #: ../src/guestfs-actions.pod:5391
13933 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13934 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13935 "sometimes gives an error about this and sometimes not. In any case, it is "
13936 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13940 #: ../src/guestfs-actions.pod:5401
13941 msgid "guestfs_resize2fs_size"
13945 #: ../src/guestfs-actions.pod:5403
13949 " guestfs_resize2fs_size (guestfs_h *g,\n"
13950 " const char *device,\n"
13951 " int64_t size);\n"
13956 #: ../src/guestfs-actions.pod:5408
13958 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13959 "to specify the new size (in bytes) explicitly."
13963 #: ../src/guestfs-actions.pod:5415
13968 #: ../src/guestfs-actions.pod:5417
13972 " guestfs_rm (guestfs_h *g,\n"
13973 " const char *path);\n"
13978 #: ../src/guestfs-actions.pod:5421 ../fish/guestfish-actions.pod:3614
13979 msgid "Remove the single file C<path>."
13983 #: ../src/guestfs-actions.pod:5427
13984 msgid "guestfs_rm_rf"
13988 #: ../src/guestfs-actions.pod:5429
13992 " guestfs_rm_rf (guestfs_h *g,\n"
13993 " const char *path);\n"
13998 #: ../src/guestfs-actions.pod:5433 ../fish/guestfish-actions.pod:3620
14000 "Remove the file or directory C<path>, recursively removing the contents if "
14001 "its a directory. This is like the C<rm -rf> shell command."
14005 #: ../src/guestfs-actions.pod:5441
14006 msgid "guestfs_rmdir"
14010 #: ../src/guestfs-actions.pod:5443
14014 " guestfs_rmdir (guestfs_h *g,\n"
14015 " const char *path);\n"
14020 #: ../src/guestfs-actions.pod:5447 ../fish/guestfish-actions.pod:3628
14021 msgid "Remove the single directory C<path>."
14025 #: ../src/guestfs-actions.pod:5453
14026 msgid "guestfs_rmmountpoint"
14030 #: ../src/guestfs-actions.pod:5455
14034 " guestfs_rmmountpoint (guestfs_h *g,\n"
14035 " const char *exemptpath);\n"
14040 #: ../src/guestfs-actions.pod:5459
14042 "This calls removes a mountpoint that was previously created with "
14043 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14047 #: ../src/guestfs-actions.pod:5467
14048 msgid "guestfs_scrub_device"
14052 #: ../src/guestfs-actions.pod:5469
14056 " guestfs_scrub_device (guestfs_h *g,\n"
14057 " const char *device);\n"
14062 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3642
14064 "This command writes patterns over C<device> to make data retrieval more "
14069 #: ../src/guestfs-actions.pod:5476 ../src/guestfs-actions.pod:5497 ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3645 ../fish/guestfish-actions.pod:3660 ../fish/guestfish-actions.pod:3673
14071 "It is an interface to the L<scrub(1)> program. See that manual page for "
14076 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5502 ../src/guestfs-actions.pod:5521
14077 msgid "(Added in 1.0.52)"
14081 #: ../src/guestfs-actions.pod:5486
14082 msgid "guestfs_scrub_file"
14086 #: ../src/guestfs-actions.pod:5488
14090 " guestfs_scrub_file (guestfs_h *g,\n"
14091 " const char *file);\n"
14096 #: ../src/guestfs-actions.pod:5492 ../fish/guestfish-actions.pod:3655
14098 "This command writes patterns over a file to make data retrieval more "
14103 #: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3658
14104 msgid "The file is I<removed> after scrubbing."
14108 #: ../src/guestfs-actions.pod:5504
14109 msgid "guestfs_scrub_freespace"
14113 #: ../src/guestfs-actions.pod:5506
14117 " guestfs_scrub_freespace (guestfs_h *g,\n"
14118 " const char *dir);\n"
14123 #: ../src/guestfs-actions.pod:5510
14125 "This command creates the directory C<dir> and then fills it with files until "
14126 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14127 "and deletes them. The intention is to scrub any free space on the partition "
14128 "containing C<dir>."
14132 #: ../src/guestfs-actions.pod:5523
14133 msgid "guestfs_set_append"
14137 #: ../src/guestfs-actions.pod:5525
14141 " guestfs_set_append (guestfs_h *g,\n"
14142 " const char *append);\n"
14147 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3682
14149 "This function is used to add additional options to the guest kernel command "
14154 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3685
14156 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14157 "environment variable."
14161 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3688
14163 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14164 "(libguestfs always adds a few of its own)."
14168 #: ../src/guestfs-actions.pod:5542
14169 msgid "guestfs_set_autosync"
14173 #: ../src/guestfs-actions.pod:5544
14177 " guestfs_set_autosync (guestfs_h *g,\n"
14178 " int autosync);\n"
14183 #: ../src/guestfs-actions.pod:5548
14185 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14186 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
14187 "the handle is closed (also if the program exits without closing handles)."
14191 #: ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:3702
14193 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14194 "disabled by default)."
14198 #: ../src/guestfs-actions.pod:5560
14199 msgid "guestfs_set_direct"
14203 #: ../src/guestfs-actions.pod:5562
14207 " guestfs_set_direct (guestfs_h *g,\n"
14213 #: ../src/guestfs-actions.pod:5566 ../fish/guestfish-actions.pod:3711
14215 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14216 "passed directly through to the appliance once it is launched."
14220 #: ../src/guestfs-actions.pod:5570
14222 "One consequence of this is that log messages aren't caught by the library "
14223 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
14228 #: ../src/guestfs-actions.pod:5574 ../fish/guestfish-actions.pod:3719
14229 msgid "You probably don't want to use this unless you know what you are doing."
14233 #: ../src/guestfs-actions.pod:5577 ../fish/guestfish-actions.pod:3722
14234 msgid "The default is disabled."
14238 #: ../src/guestfs-actions.pod:5583
14239 msgid "guestfs_set_e2label"
14243 #: ../src/guestfs-actions.pod:5585
14247 " guestfs_set_e2label (guestfs_h *g,\n"
14248 " const char *device,\n"
14249 " const char *label);\n"
14254 #: ../src/guestfs-actions.pod:5590 ../fish/guestfish-actions.pod:3728
14256 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14257 "C<label>. Filesystem labels are limited to 16 characters."
14261 #: ../src/guestfs-actions.pod:5594
14263 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
14264 "the existing label on a filesystem."
14268 #: ../src/guestfs-actions.pod:5601
14269 msgid "guestfs_set_e2uuid"
14273 #: ../src/guestfs-actions.pod:5603
14277 " guestfs_set_e2uuid (guestfs_h *g,\n"
14278 " const char *device,\n"
14279 " const char *uuid);\n"
14284 #: ../src/guestfs-actions.pod:5608 ../fish/guestfish-actions.pod:3739
14286 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14287 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14288 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14292 #: ../src/guestfs-actions.pod:5613
14294 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
14295 "the existing UUID of a filesystem."
14299 #: ../src/guestfs-actions.pod:5620
14300 msgid "guestfs_set_memsize"
14304 #: ../src/guestfs-actions.pod:5622
14308 " guestfs_set_memsize (guestfs_h *g,\n"
14314 #: ../src/guestfs-actions.pod:5626
14316 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14317 "This only has any effect if called before C<guestfs_launch>."
14321 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3757
14323 "You can also change this by setting the environment variable "
14324 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14328 #: ../src/guestfs-actions.pod:5641
14329 msgid "guestfs_set_network"
14333 #: ../src/guestfs-actions.pod:5643
14337 " guestfs_set_network (guestfs_h *g,\n"
14343 #: ../src/guestfs-actions.pod:5647 ../fish/guestfish-actions.pod:3770
14345 "If C<network> is true, then the network is enabled in the libguestfs "
14346 "appliance. The default is false."
14350 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3773
14352 "This affects whether commands are able to access the network (see "
14353 "L<guestfs(3)/RUNNING COMMANDS>)."
14357 #: ../src/guestfs-actions.pod:5653
14359 "You must call this before calling C<guestfs_launch>, otherwise it has no "
14364 #: ../src/guestfs-actions.pod:5660
14365 msgid "guestfs_set_path"
14369 #: ../src/guestfs-actions.pod:5662
14373 " guestfs_set_path (guestfs_h *g,\n"
14374 " const char *searchpath);\n"
14379 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3785
14380 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14384 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3787
14386 "The default is C<$libdir/guestfs> unless overridden by setting "
14387 "C<LIBGUESTFS_PATH> environment variable."
14391 #: ../src/guestfs-actions.pod:5671 ../fish/guestfish-actions.pod:3790
14392 msgid "Setting C<path> to C<NULL> restores the default path."
14396 #: ../src/guestfs-actions.pod:5677
14397 msgid "guestfs_set_qemu"
14401 #: ../src/guestfs-actions.pod:5679
14405 " guestfs_set_qemu (guestfs_h *g,\n"
14406 " const char *qemu);\n"
14411 #: ../src/guestfs-actions.pod:5683 ../fish/guestfish-actions.pod:3798
14412 msgid "Set the qemu binary that we will use."
14416 #: ../src/guestfs-actions.pod:5685 ../fish/guestfish-actions.pod:3800
14417 msgid "The default is chosen when the library was compiled by the configure script."
14421 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3803
14423 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14428 #: ../src/guestfs-actions.pod:5691 ../fish/guestfish-actions.pod:3806
14429 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14433 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3808
14435 "Note that you should call this function as early as possible after creating "
14436 "the handle. This is because some pre-launch operations depend on testing "
14437 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14438 "don't retest features, and so you might see inconsistent results. Using the "
14439 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14440 "the qemu binary at the same time as the handle is created."
14444 #: ../src/guestfs-actions.pod:5705
14445 msgid "guestfs_set_recovery_proc"
14449 #: ../src/guestfs-actions.pod:5707
14453 " guestfs_set_recovery_proc (guestfs_h *g,\n"
14454 " int recoveryproc);\n"
14459 #: ../src/guestfs-actions.pod:5711
14461 "If this is called with the parameter C<false> then C<guestfs_launch> does "
14462 "not create a recovery process. The purpose of the recovery process is to "
14463 "stop runaway qemu processes in the case where the main program aborts "
14468 #: ../src/guestfs-actions.pod:5716
14470 "This only has any effect if called before C<guestfs_launch>, and the default "
14475 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:3830
14477 "About the only time when you would want to disable this is if the main "
14478 "process will fork itself into the background (\"daemonize\" itself). In "
14479 "this case the recovery process thinks that the main program has disappeared "
14480 "and so kills qemu, which is not very helpful."
14484 #: ../src/guestfs-actions.pod:5729
14485 msgid "guestfs_set_selinux"
14489 #: ../src/guestfs-actions.pod:5731
14493 " guestfs_set_selinux (guestfs_h *g,\n"
14499 #: ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:3842
14501 "This sets the selinux flag that is passed to the appliance at boot time. "
14502 "The default is C<selinux=0> (disabled)."
14506 #: ../src/guestfs-actions.pod:5738 ../fish/guestfish-actions.pod:3845
14508 "Note that if SELinux is enabled, it is always in Permissive mode "
14509 "(C<enforcing=0>)."
14513 #: ../src/guestfs-actions.pod:5748
14514 msgid "guestfs_set_trace"
14518 #: ../src/guestfs-actions.pod:5750
14522 " guestfs_set_trace (guestfs_h *g,\n"
14528 #: ../src/guestfs-actions.pod:5754 ../fish/guestfish-actions.pod:3857
14530 "If the command trace flag is set to 1, then commands are printed on stderr "
14531 "before they are executed in a format which is very similar to the one used "
14532 "by guestfish. In other words, you can run a program with this enabled, and "
14533 "you will get out a script which you can feed to guestfish to perform the "
14534 "same set of actions."
14538 #: ../src/guestfs-actions.pod:5761 ../fish/guestfish-actions.pod:3864
14540 "If you want to trace C API calls into libguestfs (and other libraries) then "
14541 "possibly a better way is to use the external ltrace(1) command."
14545 #: ../src/guestfs-actions.pod:5765 ../fish/guestfish-actions.pod:3868
14547 "Command traces are disabled unless the environment variable "
14548 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14552 #: ../src/guestfs-actions.pod:5772
14553 msgid "guestfs_set_verbose"
14557 #: ../src/guestfs-actions.pod:5774
14561 " guestfs_set_verbose (guestfs_h *g,\n"
14567 #: ../src/guestfs-actions.pod:5778 ../fish/guestfish-actions.pod:3877
14568 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
14572 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3879
14574 "Verbose messages are disabled unless the environment variable "
14575 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14579 #: ../src/guestfs-actions.pod:5787
14580 msgid "guestfs_setcon"
14584 #: ../src/guestfs-actions.pod:5789
14588 " guestfs_setcon (guestfs_h *g,\n"
14589 " const char *context);\n"
14594 #: ../src/guestfs-actions.pod:5793 ../fish/guestfish-actions.pod:3886
14596 "This sets the SELinux security context of the daemon to the string "
14601 #: ../src/guestfs-actions.pod:5796 ../fish/guestfish-actions.pod:3889
14602 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14606 #: ../src/guestfs-actions.pod:5802
14607 msgid "guestfs_setxattr"
14611 #: ../src/guestfs-actions.pod:5804
14615 " guestfs_setxattr (guestfs_h *g,\n"
14616 " const char *xattr,\n"
14617 " const char *val,\n"
14619 " const char *path);\n"
14624 #: ../src/guestfs-actions.pod:5811 ../fish/guestfish-actions.pod:3895
14626 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14627 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14631 #: ../src/guestfs-actions.pod:5815
14632 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14636 #: ../src/guestfs-actions.pod:5821
14637 msgid "guestfs_sfdisk"
14641 #: ../src/guestfs-actions.pod:5823
14645 " guestfs_sfdisk (guestfs_h *g,\n"
14646 " const char *device,\n"
14650 " char *const *lines);\n"
14655 #: ../src/guestfs-actions.pod:5831 ../fish/guestfish-actions.pod:3905
14657 "This is a direct interface to the L<sfdisk(8)> program for creating "
14658 "partitions on block devices."
14662 #: ../src/guestfs-actions.pod:5834 ../fish/guestfish-actions.pod:3908
14663 msgid "C<device> should be a block device, for example C</dev/sda>."
14667 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3910
14669 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14670 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14671 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14672 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14673 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14674 "the kernel) cannot work out the right geometry and you will need to tell it."
14678 #: ../src/guestfs-actions.pod:5844 ../fish/guestfish-actions.pod:3918
14680 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14681 "refer to the L<sfdisk(8)> manpage."
14685 #: ../src/guestfs-actions.pod:5847 ../fish/guestfish-actions.pod:3921
14687 "To create a single partition occupying the whole disk, you would pass "
14688 "C<lines> as a single element list, when the single element being the string "
14693 #: ../src/guestfs-actions.pod:5851
14694 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14698 #: ../src/guestfs-actions.pod:5861
14699 msgid "guestfs_sfdiskM"
14703 #: ../src/guestfs-actions.pod:5863
14707 " guestfs_sfdiskM (guestfs_h *g,\n"
14708 " const char *device,\n"
14709 " char *const *lines);\n"
14714 #: ../src/guestfs-actions.pod:5868
14716 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14717 "partition sizes are specified in megabytes only (rounded to the nearest "
14718 "cylinder) and you don't need to specify the cyls, heads and sectors "
14719 "parameters which were rarely if ever used anyway."
14723 #: ../src/guestfs-actions.pod:5874
14725 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14726 "C<guestfs_part_disk>"
14730 #: ../src/guestfs-actions.pod:5884
14731 msgid "guestfs_sfdisk_N"
14735 #: ../src/guestfs-actions.pod:5886
14739 " guestfs_sfdisk_N (guestfs_h *g,\n"
14740 " const char *device,\n"
14745 " const char *line);\n"
14750 #: ../src/guestfs-actions.pod:5895 ../fish/guestfish-actions.pod:3951
14752 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14753 "(note: C<n> counts from 1)."
14757 #: ../src/guestfs-actions.pod:5898
14759 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14760 "for the cyls/heads/sectors parameters."
14764 #: ../src/guestfs-actions.pod:5901
14765 msgid "See also: C<guestfs_part_add>"
14769 #: ../src/guestfs-actions.pod:5910
14770 msgid "guestfs_sfdisk_disk_geometry"
14774 #: ../src/guestfs-actions.pod:5912
14778 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14779 " const char *device);\n"
14784 #: ../src/guestfs-actions.pod:5916
14786 "This displays the disk geometry of C<device> read from the partition table. "
14787 "Especially in the case where the underlying block device has been resized, "
14788 "this can be different from the kernel's idea of the geometry (see "
14789 "C<guestfs_sfdisk_kernel_geometry>)."
14793 #: ../src/guestfs-actions.pod:5921 ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3971 ../fish/guestfish-actions.pod:3980
14794 msgid "The result is in human-readable format, and not designed to be parsed."
14798 #: ../src/guestfs-actions.pod:5929
14799 msgid "guestfs_sfdisk_kernel_geometry"
14803 #: ../src/guestfs-actions.pod:5931
14807 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14808 " const char *device);\n"
14813 #: ../src/guestfs-actions.pod:5935 ../fish/guestfish-actions.pod:3978
14814 msgid "This displays the kernel's idea of the geometry of C<device>."
14818 #: ../src/guestfs-actions.pod:5945
14819 msgid "guestfs_sfdisk_l"
14823 #: ../src/guestfs-actions.pod:5947
14827 " guestfs_sfdisk_l (guestfs_h *g,\n"
14828 " const char *device);\n"
14833 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:3987
14835 "This displays the partition table on C<device>, in the human-readable output "
14836 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14840 #: ../src/guestfs-actions.pod:5955
14841 msgid "See also: C<guestfs_part_list>"
14845 #: ../src/guestfs-actions.pod:5962
14850 #: ../src/guestfs-actions.pod:5964
14854 " guestfs_sh (guestfs_h *g,\n"
14855 " const char *command);\n"
14860 #: ../src/guestfs-actions.pod:5968 ../fish/guestfish-actions.pod:3997
14862 "This call runs a command from the guest filesystem via the guest's "
14867 #: ../src/guestfs-actions.pod:5971
14868 msgid "This is like C<guestfs_command>, but passes the command to:"
14872 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4002
14875 " /bin/sh -c \"command\"\n"
14880 #: ../src/guestfs-actions.pod:5975 ../fish/guestfish-actions.pod:4004
14882 "Depending on the guest's shell, this usually results in wildcards being "
14883 "expanded, shell expressions being interpolated and so on."
14887 #: ../src/guestfs-actions.pod:5979
14888 msgid "All the provisos about C<guestfs_command> apply to this call."
14892 #: ../src/guestfs-actions.pod:5986
14893 msgid "guestfs_sh_lines"
14897 #: ../src/guestfs-actions.pod:5988
14901 " guestfs_sh_lines (guestfs_h *g,\n"
14902 " const char *command);\n"
14907 #: ../src/guestfs-actions.pod:5992
14909 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14914 #: ../src/guestfs-actions.pod:5995
14915 msgid "See also: C<guestfs_command_lines>"
14919 #: ../src/guestfs-actions.pod:6003
14920 msgid "guestfs_sleep"
14924 #: ../src/guestfs-actions.pod:6005
14928 " guestfs_sleep (guestfs_h *g,\n"
14934 #: ../src/guestfs-actions.pod:6009 ../fish/guestfish-actions.pod:4023
14935 msgid "Sleep for C<secs> seconds."
14939 #: ../src/guestfs-actions.pod:6013
14940 msgid "(Added in 1.0.41)"
14944 #: ../src/guestfs-actions.pod:6015 ../src/guestfs-structs.pod:109
14945 msgid "guestfs_stat"
14949 #: ../src/guestfs-actions.pod:6017
14952 " struct guestfs_stat *\n"
14953 " guestfs_stat (guestfs_h *g,\n"
14954 " const char *path);\n"
14959 #: ../src/guestfs-actions.pod:6023 ../fish/guestfish-actions.pod:4031
14960 msgid "This is the same as the C<stat(2)> system call."
14964 #: ../src/guestfs-actions.pod:6031 ../src/guestfs-structs.pod:135
14965 msgid "guestfs_statvfs"
14969 #: ../src/guestfs-actions.pod:6033
14972 " struct guestfs_statvfs *\n"
14973 " guestfs_statvfs (guestfs_h *g,\n"
14974 " const char *path);\n"
14979 #: ../src/guestfs-actions.pod:6037 ../fish/guestfish-actions.pod:4037
14981 "Returns file system statistics for any mounted file system. C<path> should "
14982 "be a file or directory in the mounted file system (typically it is the mount "
14983 "point itself, but it doesn't need to be)."
14987 #: ../src/guestfs-actions.pod:6041 ../fish/guestfish-actions.pod:4041
14988 msgid "This is the same as the C<statvfs(2)> system call."
14992 #: ../src/guestfs-actions.pod:6043
14994 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14995 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14999 #: ../src/guestfs-actions.pod:6049
15000 msgid "guestfs_strings"
15004 #: ../src/guestfs-actions.pod:6051
15008 " guestfs_strings (guestfs_h *g,\n"
15009 " const char *path);\n"
15014 #: ../src/guestfs-actions.pod:6055 ../fish/guestfish-actions.pod:4047
15016 "This runs the L<strings(1)> command on a file and returns the list of "
15017 "printable strings found."
15021 #: ../src/guestfs-actions.pod:6067
15022 msgid "guestfs_strings_e"
15026 #: ../src/guestfs-actions.pod:6069
15030 " guestfs_strings_e (guestfs_h *g,\n"
15031 " const char *encoding,\n"
15032 " const char *path);\n"
15037 #: ../src/guestfs-actions.pod:6074
15039 "This is like the C<guestfs_strings> command, but allows you to specify the "
15040 "encoding of strings that are looked for in the source file C<path>."
15044 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4061
15045 msgid "Allowed encodings are:"
15049 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4065
15054 #: ../src/guestfs-actions.pod:6084
15056 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15057 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15061 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4070
15066 #: ../src/guestfs-actions.pod:6089 ../fish/guestfish-actions.pod:4072
15067 msgid "Single 8-bit-byte characters."
15071 #: ../src/guestfs-actions.pod:6091 ../fish/guestfish-actions.pod:4074
15076 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4076
15077 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15081 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4079
15082 msgid "l (lower case letter L)"
15086 #: ../src/guestfs-actions.pod:6098 ../fish/guestfish-actions.pod:4081
15088 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15089 "examining binaries in Windows guests."
15093 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4084
15098 #: ../src/guestfs-actions.pod:6103 ../fish/guestfish-actions.pod:4086
15099 msgid "32-bit big endian such as UCS-4BE."
15103 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4088
15108 #: ../src/guestfs-actions.pod:6107 ../fish/guestfish-actions.pod:4090
15109 msgid "32-bit little endian such as UCS-4LE."
15113 #: ../src/guestfs-actions.pod:6111 ../fish/guestfish-actions.pod:4094
15114 msgid "The returned strings are transcoded to UTF-8."
15118 #: ../src/guestfs-actions.pod:6122
15119 msgid "guestfs_swapoff_device"
15123 #: ../src/guestfs-actions.pod:6124
15127 " guestfs_swapoff_device (guestfs_h *g,\n"
15128 " const char *device);\n"
15133 #: ../src/guestfs-actions.pod:6128
15135 "This command disables the libguestfs appliance swap device or partition "
15136 "named C<device>. See C<guestfs_swapon_device>."
15140 #: ../src/guestfs-actions.pod:6136
15141 msgid "guestfs_swapoff_file"
15145 #: ../src/guestfs-actions.pod:6138
15149 " guestfs_swapoff_file (guestfs_h *g,\n"
15150 " const char *file);\n"
15155 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4111
15156 msgid "This command disables the libguestfs appliance swap on file."
15160 #: ../src/guestfs-actions.pod:6148
15161 msgid "guestfs_swapoff_label"
15165 #: ../src/guestfs-actions.pod:6150
15169 " guestfs_swapoff_label (guestfs_h *g,\n"
15170 " const char *label);\n"
15175 #: ../src/guestfs-actions.pod:6154 ../fish/guestfish-actions.pod:4117
15177 "This command disables the libguestfs appliance swap on labeled swap "
15182 #: ../src/guestfs-actions.pod:6161
15183 msgid "guestfs_swapoff_uuid"
15187 #: ../src/guestfs-actions.pod:6163
15191 " guestfs_swapoff_uuid (guestfs_h *g,\n"
15192 " const char *uuid);\n"
15197 #: ../src/guestfs-actions.pod:6167 ../fish/guestfish-actions.pod:4124
15199 "This command disables the libguestfs appliance swap partition with the given "
15204 #: ../src/guestfs-actions.pod:6174
15205 msgid "guestfs_swapon_device"
15209 #: ../src/guestfs-actions.pod:6176
15213 " guestfs_swapon_device (guestfs_h *g,\n"
15214 " const char *device);\n"
15219 #: ../src/guestfs-actions.pod:6180
15221 "This command enables the libguestfs appliance to use the swap device or "
15222 "partition named C<device>. The increased memory is made available for all "
15223 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
15227 #: ../src/guestfs-actions.pod:6185 ../fish/guestfish-actions.pod:4136
15229 "Note that you should not swap to existing guest swap partitions unless you "
15230 "know what you are doing. They may contain hibernation information, or other "
15231 "information that the guest doesn't want you to trash. You also risk leaking "
15232 "information about the host to the guest this way. Instead, attach a new "
15233 "host device to the guest and swap on that."
15237 #: ../src/guestfs-actions.pod:6196
15238 msgid "guestfs_swapon_file"
15242 #: ../src/guestfs-actions.pod:6198
15246 " guestfs_swapon_file (guestfs_h *g,\n"
15247 " const char *file);\n"
15252 #: ../src/guestfs-actions.pod:6202
15254 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
15259 #: ../src/guestfs-actions.pod:6209
15260 msgid "guestfs_swapon_label"
15264 #: ../src/guestfs-actions.pod:6211
15268 " guestfs_swapon_label (guestfs_h *g,\n"
15269 " const char *label);\n"
15274 #: ../src/guestfs-actions.pod:6215
15276 "This command enables swap to a labeled swap partition. See "
15277 "C<guestfs_swapon_device> for other notes."
15281 #: ../src/guestfs-actions.pod:6222
15282 msgid "guestfs_swapon_uuid"
15286 #: ../src/guestfs-actions.pod:6224
15290 " guestfs_swapon_uuid (guestfs_h *g,\n"
15291 " const char *uuid);\n"
15296 #: ../src/guestfs-actions.pod:6228
15298 "This command enables swap to a swap partition with the given UUID. See "
15299 "C<guestfs_swapon_device> for other notes."
15303 #: ../src/guestfs-actions.pod:6235
15304 msgid "guestfs_sync"
15308 #: ../src/guestfs-actions.pod:6237
15312 " guestfs_sync (guestfs_h *g);\n"
15317 #: ../src/guestfs-actions.pod:6240 ../fish/guestfish-actions.pod:4168
15319 "This syncs the disk, so that any writes are flushed through to the "
15320 "underlying disk image."
15324 #: ../src/guestfs-actions.pod:6243 ../fish/guestfish-actions.pod:4171
15326 "You should always call this if you have modified a disk image, before "
15327 "closing the handle."
15331 #: ../src/guestfs-actions.pod:6250
15332 msgid "guestfs_tail"
15336 #: ../src/guestfs-actions.pod:6252
15340 " guestfs_tail (guestfs_h *g,\n"
15341 " const char *path);\n"
15346 #: ../src/guestfs-actions.pod:6256 ../fish/guestfish-actions.pod:4178
15347 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15351 #: ../src/guestfs-actions.pod:6268
15352 msgid "guestfs_tail_n"
15356 #: ../src/guestfs-actions.pod:6270
15360 " guestfs_tail_n (guestfs_h *g,\n"
15362 " const char *path);\n"
15367 #: ../src/guestfs-actions.pod:6275 ../fish/guestfish-actions.pod:4188
15369 "If the parameter C<nrlines> is a positive number, this returns the last "
15370 "C<nrlines> lines of the file C<path>."
15374 #: ../src/guestfs-actions.pod:6278 ../fish/guestfish-actions.pod:4191
15376 "If the parameter C<nrlines> is a negative number, this returns lines from "
15377 "the file C<path>, starting with the C<-nrlines>th line."
15381 #: ../src/guestfs-actions.pod:6292
15382 msgid "guestfs_tar_in"
15386 #: ../src/guestfs-actions.pod:6294
15390 " guestfs_tar_in (guestfs_h *g,\n"
15391 " const char *tarfile,\n"
15392 " const char *directory);\n"
15397 #: ../src/guestfs-actions.pod:6299 ../fish/guestfish-actions.pod:4203
15399 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15400 "tar file) into C<directory>."
15404 #: ../src/guestfs-actions.pod:6302
15405 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
15409 #: ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6324 ../src/guestfs-actions.pod:6340 ../src/guestfs-actions.pod:6356
15410 msgid "(Added in 1.0.3)"
15414 #: ../src/guestfs-actions.pod:6309
15415 msgid "guestfs_tar_out"
15419 #: ../src/guestfs-actions.pod:6311
15423 " guestfs_tar_out (guestfs_h *g,\n"
15424 " const char *directory,\n"
15425 " const char *tarfile);\n"
15430 #: ../src/guestfs-actions.pod:6316 ../fish/guestfish-actions.pod:4215
15432 "This command packs the contents of C<directory> and downloads it to local "
15437 #: ../src/guestfs-actions.pod:6319
15439 "To download a compressed tarball, use C<guestfs_tgz_out> or "
15440 "C<guestfs_txz_out>."
15444 #: ../src/guestfs-actions.pod:6326
15445 msgid "guestfs_tgz_in"
15449 #: ../src/guestfs-actions.pod:6328
15453 " guestfs_tgz_in (guestfs_h *g,\n"
15454 " const char *tarball,\n"
15455 " const char *directory);\n"
15460 #: ../src/guestfs-actions.pod:6333 ../fish/guestfish-actions.pod:4227
15462 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15463 "tar file) into C<directory>."
15467 #: ../src/guestfs-actions.pod:6336
15468 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
15472 #: ../src/guestfs-actions.pod:6342
15473 msgid "guestfs_tgz_out"
15477 #: ../src/guestfs-actions.pod:6344
15481 " guestfs_tgz_out (guestfs_h *g,\n"
15482 " const char *directory,\n"
15483 " const char *tarball);\n"
15488 #: ../src/guestfs-actions.pod:6349 ../fish/guestfish-actions.pod:4238
15490 "This command packs the contents of C<directory> and downloads it to local "
15495 #: ../src/guestfs-actions.pod:6352
15496 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
15500 #: ../src/guestfs-actions.pod:6358
15501 msgid "guestfs_touch"
15505 #: ../src/guestfs-actions.pod:6360
15509 " guestfs_touch (guestfs_h *g,\n"
15510 " const char *path);\n"
15515 #: ../src/guestfs-actions.pod:6364 ../fish/guestfish-actions.pod:4249
15517 "Touch acts like the L<touch(1)> command. It can be used to update the "
15518 "timestamps on a file, or, if the file does not exist, to create a new "
15519 "zero-length file."
15523 #: ../src/guestfs-actions.pod:6368 ../fish/guestfish-actions.pod:4253
15525 "This command only works on regular files, and will fail on other file types "
15526 "such as directories, symbolic links, block special etc."
15530 #: ../src/guestfs-actions.pod:6375
15531 msgid "guestfs_truncate"
15535 #: ../src/guestfs-actions.pod:6377
15539 " guestfs_truncate (guestfs_h *g,\n"
15540 " const char *path);\n"
15545 #: ../src/guestfs-actions.pod:6381 ../fish/guestfish-actions.pod:4260
15547 "This command truncates C<path> to a zero-length file. The file must exist "
15552 #: ../src/guestfs-actions.pod:6388
15553 msgid "guestfs_truncate_size"
15557 #: ../src/guestfs-actions.pod:6390
15561 " guestfs_truncate_size (guestfs_h *g,\n"
15562 " const char *path,\n"
15563 " int64_t size);\n"
15568 #: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4267
15570 "This command truncates C<path> to size C<size> bytes. The file must exist "
15575 #: ../src/guestfs-actions.pod:6398
15577 "If the current file size is less than C<size> then the file is extended to "
15578 "the required size with zero bytes. This creates a sparse file (ie. disk "
15579 "blocks are not allocated for the file until you write to it). To create a "
15580 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15584 #: ../src/guestfs-actions.pod:6408
15585 msgid "guestfs_tune2fs_l"
15589 #: ../src/guestfs-actions.pod:6410
15593 " guestfs_tune2fs_l (guestfs_h *g,\n"
15594 " const char *device);\n"
15599 #: ../src/guestfs-actions.pod:6414 ../fish/guestfish-actions.pod:4280
15601 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15606 #: ../src/guestfs-actions.pod:6417 ../fish/guestfish-actions.pod:4283
15608 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15609 "for more details. The list of fields returned isn't clearly defined, and "
15610 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15611 "and the filesystem itself."
15615 #: ../src/guestfs-actions.pod:6430
15616 msgid "guestfs_txz_in"
15620 #: ../src/guestfs-actions.pod:6432
15624 " guestfs_txz_in (guestfs_h *g,\n"
15625 " const char *tarball,\n"
15626 " const char *directory);\n"
15631 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4292
15633 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15634 "tar file) into C<directory>."
15638 #: ../src/guestfs-actions.pod:6444
15639 msgid "guestfs_txz_out"
15643 #: ../src/guestfs-actions.pod:6446
15647 " guestfs_txz_out (guestfs_h *g,\n"
15648 " const char *directory,\n"
15649 " const char *tarball);\n"
15654 #: ../src/guestfs-actions.pod:6451 ../fish/guestfish-actions.pod:4301
15656 "This command packs the contents of C<directory> and downloads it to local "
15657 "file C<tarball> (as an xz compressed tar archive)."
15661 #: ../src/guestfs-actions.pod:6458
15662 msgid "guestfs_umask"
15666 #: ../src/guestfs-actions.pod:6460
15670 " guestfs_umask (guestfs_h *g,\n"
15676 #: ../src/guestfs-actions.pod:6464 ../fish/guestfish-actions.pod:4310
15678 "This function sets the mask used for creating new files and device nodes to "
15683 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4313
15685 "Typical umask values would be C<022> which creates new files with "
15686 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15687 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15691 #: ../src/guestfs-actions.pod:6472 ../fish/guestfish-actions.pod:4318
15693 "The default umask is C<022>. This is important because it means that "
15694 "directories and device nodes will be created with C<0644> or C<0755> mode "
15695 "even if you specify C<0777>."
15699 #: ../src/guestfs-actions.pod:6476
15701 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15702 "C<guestfs_mkdir>."
15706 #: ../src/guestfs-actions.pod:6479 ../fish/guestfish-actions.pod:4325
15707 msgid "This call returns the previous umask."
15711 #: ../src/guestfs-actions.pod:6485
15712 msgid "guestfs_umount"
15716 #: ../src/guestfs-actions.pod:6487
15720 " guestfs_umount (guestfs_h *g,\n"
15721 " const char *pathordevice);\n"
15726 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4333
15728 "This unmounts the given filesystem. The filesystem may be specified either "
15729 "by its mountpoint (path) or the device which contains the filesystem."
15733 #: ../src/guestfs-actions.pod:6499
15734 msgid "guestfs_umount_all"
15738 #: ../src/guestfs-actions.pod:6501
15742 " guestfs_umount_all (guestfs_h *g);\n"
15747 #: ../src/guestfs-actions.pod:6504 ../fish/guestfish-actions.pod:4343
15748 msgid "This unmounts all mounted filesystems."
15752 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4345
15753 msgid "Some internal mounts are not unmounted by this call."
15757 #: ../src/guestfs-actions.pod:6512
15758 msgid "guestfs_upload"
15762 #: ../src/guestfs-actions.pod:6514
15766 " guestfs_upload (guestfs_h *g,\n"
15767 " const char *filename,\n"
15768 " const char *remotefilename);\n"
15773 #: ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6543 ../fish/guestfish-actions.pod:4351 ../fish/guestfish-actions.pod:4364
15774 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15778 #: ../src/guestfs-actions.pod:6524
15779 msgid "See also C<guestfs_download>."
15783 #: ../src/guestfs-actions.pod:6535
15784 msgid "guestfs_upload_offset"
15788 #: ../src/guestfs-actions.pod:6537
15792 " guestfs_upload_offset (guestfs_h *g,\n"
15793 " const char *filename,\n"
15794 " const char *remotefilename,\n"
15795 " int64_t offset);\n"
15800 #: ../src/guestfs-actions.pod:6546 ../fish/guestfish-actions.pod:4367
15802 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15803 "The intention is to overwrite parts of existing files or devices, although "
15804 "if a non-existant file is specified then it is created with a \"hole\" "
15805 "before C<offset>. The size of the data written is implicit in the size of "
15806 "the source C<filename>."
15810 #: ../src/guestfs-actions.pod:6553
15812 "Note that there is no limit on the amount of data that can be uploaded with "
15813 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15814 "full amount unless an error occurs."
15818 #: ../src/guestfs-actions.pod:6558
15819 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15823 #: ../src/guestfs-actions.pod:6569
15824 msgid "guestfs_utimens"
15828 #: ../src/guestfs-actions.pod:6571
15832 " guestfs_utimens (guestfs_h *g,\n"
15833 " const char *path,\n"
15834 " int64_t atsecs,\n"
15835 " int64_t atnsecs,\n"
15836 " int64_t mtsecs,\n"
15837 " int64_t mtnsecs);\n"
15842 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4387
15843 msgid "This command sets the timestamps of a file with nanosecond precision."
15847 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4390
15849 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15854 #: ../src/guestfs-actions.pod:6585 ../fish/guestfish-actions.pod:4393
15856 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15857 "nanoseconds from the epoch."
15861 #: ../src/guestfs-actions.pod:6588 ../fish/guestfish-actions.pod:4396
15863 "If the C<*nsecs> field contains the special value C<-1> then the "
15864 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15865 "ignored in this case)."
15869 #: ../src/guestfs-actions.pod:6592 ../fish/guestfish-actions.pod:4400
15871 "If the C<*nsecs> field contains the special value C<-2> then the "
15872 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15877 #: ../src/guestfs-actions.pod:6600 ../src/guestfs-structs.pod:175
15878 msgid "guestfs_version"
15882 #: ../src/guestfs-actions.pod:6602
15885 " struct guestfs_version *\n"
15886 " guestfs_version (guestfs_h *g);\n"
15891 #: ../src/guestfs-actions.pod:6605 ../fish/guestfish-actions.pod:4408
15892 msgid "Return the libguestfs version number that the program is linked against."
15896 #: ../src/guestfs-actions.pod:6608 ../fish/guestfish-actions.pod:4411
15898 "Note that because of dynamic linking this is not necessarily the version of "
15899 "libguestfs that you compiled against. You can compile the program, and then "
15900 "at runtime dynamically link against a completely different C<libguestfs.so> "
15905 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
15907 "This call was added in version C<1.0.58>. In previous versions of "
15908 "libguestfs there was no way to get the version number. From C code you can "
15909 "use dynamic linker functions to find out if this symbol exists (if it "
15910 "doesn't, then it's an earlier version)."
15914 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4422
15916 "The call returns a structure with four elements. The first three (C<major>, "
15917 "C<minor> and C<release>) are numbers and correspond to the usual version "
15918 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15919 "but may be used for distro-specific information."
15923 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4428
15924 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
15928 #: ../src/guestfs-actions.pod:6628 ../fish/guestfish-actions.pod:4431
15929 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15933 #: ../src/guestfs-actions.pod:6630
15935 "I<Note:> Don't use this call to test for availability of features. In "
15936 "enterprise distributions we backport features from later versions into "
15937 "earlier versions, making this an unreliable way to test for features. Use "
15938 "C<guestfs_available> instead."
15942 #: ../src/guestfs-actions.pod:6636
15944 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15945 "error. I<The caller must call C<guestfs_free_version> after use>."
15949 #: ../src/guestfs-actions.pod:6640
15950 msgid "(Added in 1.0.58)"
15954 #: ../src/guestfs-actions.pod:6642
15955 msgid "guestfs_vfs_label"
15959 #: ../src/guestfs-actions.pod:6644
15963 " guestfs_vfs_label (guestfs_h *g,\n"
15964 " const char *device);\n"
15969 #: ../src/guestfs-actions.pod:6648 ../fish/guestfish-actions.pod:4443
15970 msgid "This returns the filesystem label of the filesystem on C<device>."
15974 #: ../src/guestfs-actions.pod:6651 ../fish/guestfish-actions.pod:4446
15975 msgid "If the filesystem is unlabeled, this returns the empty string."
15979 #: ../src/guestfs-actions.pod:6653
15980 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15984 #: ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6695
15985 msgid "(Added in 1.3.18)"
15989 #: ../src/guestfs-actions.pod:6660
15990 msgid "guestfs_vfs_type"
15994 #: ../src/guestfs-actions.pod:6662
15998 " guestfs_vfs_type (guestfs_h *g,\n"
15999 " const char *device);\n"
16004 #: ../src/guestfs-actions.pod:6666 ../fish/guestfish-actions.pod:4454
16006 "This command gets the filesystem type corresponding to the filesystem on "
16011 #: ../src/guestfs-actions.pod:6669 ../fish/guestfish-actions.pod:4457
16013 "For most filesystems, the result is the name of the Linux VFS module which "
16014 "would be used to mount this filesystem if you mounted it without specifying "
16015 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
16019 #: ../src/guestfs-actions.pod:6679
16020 msgid "guestfs_vfs_uuid"
16024 #: ../src/guestfs-actions.pod:6681
16028 " guestfs_vfs_uuid (guestfs_h *g,\n"
16029 " const char *device);\n"
16034 #: ../src/guestfs-actions.pod:6685 ../fish/guestfish-actions.pod:4466
16035 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16039 #: ../src/guestfs-actions.pod:6688 ../fish/guestfish-actions.pod:4469
16040 msgid "If the filesystem does not have a UUID, this returns the empty string."
16044 #: ../src/guestfs-actions.pod:6690
16045 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16049 #: ../src/guestfs-actions.pod:6697
16050 msgid "guestfs_vg_activate"
16054 #: ../src/guestfs-actions.pod:6699
16058 " guestfs_vg_activate (guestfs_h *g,\n"
16060 " char *const *volgroups);\n"
16065 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4477
16067 "This command activates or (if C<activate> is false) deactivates all logical "
16068 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16069 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16070 "deactivated, then those devices disappear."
16074 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4483
16075 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16079 #: ../src/guestfs-actions.pod:6712 ../fish/guestfish-actions.pod:4485
16081 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16082 "activated or deactivated."
16086 #: ../src/guestfs-actions.pod:6719
16087 msgid "guestfs_vg_activate_all"
16091 #: ../src/guestfs-actions.pod:6721
16095 " guestfs_vg_activate_all (guestfs_h *g,\n"
16096 " int activate);\n"
16101 #: ../src/guestfs-actions.pod:6725 ../fish/guestfish-actions.pod:4492
16103 "This command activates or (if C<activate> is false) deactivates all logical "
16104 "volumes in all volume groups. If activated, then they are made known to the "
16105 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16106 "those devices disappear."
16110 #: ../src/guestfs-actions.pod:6731 ../fish/guestfish-actions.pod:4498
16111 msgid "This command is the same as running C<vgchange -a y|n>"
16115 #: ../src/guestfs-actions.pod:6737
16116 msgid "guestfs_vgcreate"
16120 #: ../src/guestfs-actions.pod:6739
16124 " guestfs_vgcreate (guestfs_h *g,\n"
16125 " const char *volgroup,\n"
16126 " char *const *physvols);\n"
16131 #: ../src/guestfs-actions.pod:6744 ../fish/guestfish-actions.pod:4504
16133 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16134 "of physical volumes C<physvols>."
16138 #: ../src/guestfs-actions.pod:6751
16139 msgid "guestfs_vglvuuids"
16143 #: ../src/guestfs-actions.pod:6753
16147 " guestfs_vglvuuids (guestfs_h *g,\n"
16148 " const char *vgname);\n"
16153 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4511
16155 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16156 "volumes created in this volume group."
16160 #: ../src/guestfs-actions.pod:6760
16162 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
16163 "associate logical volumes and volume groups."
16167 #: ../src/guestfs-actions.pod:6763
16168 msgid "See also C<guestfs_vgpvuuids>."
16172 #: ../src/guestfs-actions.pod:6771
16173 msgid "guestfs_vgpvuuids"
16177 #: ../src/guestfs-actions.pod:6773
16181 " guestfs_vgpvuuids (guestfs_h *g,\n"
16182 " const char *vgname);\n"
16187 #: ../src/guestfs-actions.pod:6777 ../fish/guestfish-actions.pod:4523
16189 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16190 "volumes that this volume group resides on."
16194 #: ../src/guestfs-actions.pod:6780
16196 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
16197 "associate physical volumes and volume groups."
16201 #: ../src/guestfs-actions.pod:6783
16202 msgid "See also C<guestfs_vglvuuids>."
16206 #: ../src/guestfs-actions.pod:6791
16207 msgid "guestfs_vgremove"
16211 #: ../src/guestfs-actions.pod:6793
16215 " guestfs_vgremove (guestfs_h *g,\n"
16216 " const char *vgname);\n"
16221 #: ../src/guestfs-actions.pod:6797 ../fish/guestfish-actions.pod:4535
16222 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16226 #: ../src/guestfs-actions.pod:6799 ../fish/guestfish-actions.pod:4537
16227 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16231 #: ../src/guestfs-actions.pod:6806
16232 msgid "guestfs_vgrename"
16236 #: ../src/guestfs-actions.pod:6808
16240 " guestfs_vgrename (guestfs_h *g,\n"
16241 " const char *volgroup,\n"
16242 " const char *newvolgroup);\n"
16247 #: ../src/guestfs-actions.pod:6813 ../fish/guestfish-actions.pod:4544
16248 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16252 #: ../src/guestfs-actions.pod:6819
16253 msgid "guestfs_vgs"
16257 #: ../src/guestfs-actions.pod:6821
16261 " guestfs_vgs (guestfs_h *g);\n"
16266 #: ../src/guestfs-actions.pod:6824 ../fish/guestfish-actions.pod:4550
16268 "List all the volumes groups detected. This is the equivalent of the "
16269 "L<vgs(8)> command."
16273 #: ../src/guestfs-actions.pod:6827 ../fish/guestfish-actions.pod:4553
16275 "This returns a list of just the volume group names that were detected "
16276 "(eg. C<VolGroup00>)."
16280 #: ../src/guestfs-actions.pod:6830
16281 msgid "See also C<guestfs_vgs_full>."
16285 #: ../src/guestfs-actions.pod:6838
16286 msgid "guestfs_vgs_full"
16290 #: ../src/guestfs-actions.pod:6840
16293 " struct guestfs_lvm_vg_list *\n"
16294 " guestfs_vgs_full (guestfs_h *g);\n"
16299 #: ../src/guestfs-actions.pod:6843 ../fish/guestfish-actions.pod:4562
16301 "List all the volumes groups detected. This is the equivalent of the "
16302 "L<vgs(8)> command. The \"full\" version includes all fields."
16306 #: ../src/guestfs-actions.pod:6846
16308 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
16309 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
16314 #: ../src/guestfs-actions.pod:6852
16315 msgid "guestfs_vgscan"
16319 #: ../src/guestfs-actions.pod:6854
16323 " guestfs_vgscan (guestfs_h *g);\n"
16328 #: ../src/guestfs-actions.pod:6857 ../fish/guestfish-actions.pod:4569
16330 "This rescans all block devices and rebuilds the list of LVM physical "
16331 "volumes, volume groups and logical volumes."
16335 #: ../src/guestfs-actions.pod:6864
16336 msgid "guestfs_vguuid"
16340 #: ../src/guestfs-actions.pod:6866
16344 " guestfs_vguuid (guestfs_h *g,\n"
16345 " const char *vgname);\n"
16350 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4576
16351 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16355 #: ../src/guestfs-actions.pod:6877
16356 msgid "guestfs_wait_ready"
16360 #: ../src/guestfs-actions.pod:6879
16364 " guestfs_wait_ready (guestfs_h *g);\n"
16369 #: ../src/guestfs-actions.pod:6882
16370 msgid "This function is a no op."
16374 #: ../src/guestfs-actions.pod:6884
16376 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
16377 "calling C<guestfs_launch> to wait for the launch to complete. However this "
16378 "is no longer necessary because C<guestfs_launch> now does the waiting."
16382 #: ../src/guestfs-actions.pod:6889
16384 "If you see any calls to this function in code then you can just remove them, "
16385 "unless you want to retain compatibility with older versions of the API."
16389 #: ../src/guestfs-actions.pod:6897
16390 msgid "guestfs_wc_c"
16394 #: ../src/guestfs-actions.pod:6899
16398 " guestfs_wc_c (guestfs_h *g,\n"
16399 " const char *path);\n"
16404 #: ../src/guestfs-actions.pod:6903 ../fish/guestfish-actions.pod:4582
16406 "This command counts the characters in a file, using the C<wc -c> external "
16411 #: ../src/guestfs-actions.pod:6910
16412 msgid "guestfs_wc_l"
16416 #: ../src/guestfs-actions.pod:6912
16420 " guestfs_wc_l (guestfs_h *g,\n"
16421 " const char *path);\n"
16426 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4589
16428 "This command counts the lines in a file, using the C<wc -l> external "
16433 #: ../src/guestfs-actions.pod:6923
16434 msgid "guestfs_wc_w"
16438 #: ../src/guestfs-actions.pod:6925
16442 " guestfs_wc_w (guestfs_h *g,\n"
16443 " const char *path);\n"
16448 #: ../src/guestfs-actions.pod:6929 ../fish/guestfish-actions.pod:4596
16450 "This command counts the words in a file, using the C<wc -w> external "
16455 #: ../src/guestfs-actions.pod:6936
16456 msgid "guestfs_write"
16460 #: ../src/guestfs-actions.pod:6938
16464 " guestfs_write (guestfs_h *g,\n"
16465 " const char *path,\n"
16466 " const char *content,\n"
16467 " size_t content_size);\n"
16472 #: ../src/guestfs-actions.pod:6944 ../fish/guestfish-actions.pod:4603
16474 "This call creates a file called C<path>. The content of the file is the "
16475 "string C<content> (which can contain any 8 bit data)."
16479 #: ../src/guestfs-actions.pod:6954
16480 msgid "guestfs_write_file"
16484 #: ../src/guestfs-actions.pod:6956
16488 " guestfs_write_file (guestfs_h *g,\n"
16489 " const char *path,\n"
16490 " const char *content,\n"
16496 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4613
16498 "This call creates a file called C<path>. The contents of the file is the "
16499 "string C<content> (which can contain any 8 bit data), with length C<size>."
16503 #: ../src/guestfs-actions.pod:6966 ../fish/guestfish-actions.pod:4617
16505 "As a special case, if C<size> is C<0> then the length is calculated using "
16506 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16510 #: ../src/guestfs-actions.pod:6970 ../fish/guestfish-actions.pod:4621
16512 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16513 "I<not> work, even if the length is specified."
16517 #: ../src/guestfs-actions.pod:6978
16519 "This function is deprecated. In new code, use the L</guestfs_write> call "
16524 #: ../src/guestfs-actions.pod:6987
16525 msgid "guestfs_zegrep"
16529 #: ../src/guestfs-actions.pod:6989
16533 " guestfs_zegrep (guestfs_h *g,\n"
16534 " const char *regex,\n"
16535 " const char *path);\n"
16540 #: ../src/guestfs-actions.pod:6994 ../fish/guestfish-actions.pod:4638
16541 msgid "This calls the external C<zegrep> program and returns the matching lines."
16545 #: ../src/guestfs-actions.pod:7006
16546 msgid "guestfs_zegrepi"
16550 #: ../src/guestfs-actions.pod:7008
16554 " guestfs_zegrepi (guestfs_h *g,\n"
16555 " const char *regex,\n"
16556 " const char *path);\n"
16561 #: ../src/guestfs-actions.pod:7013 ../fish/guestfish-actions.pod:4648
16562 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16566 #: ../src/guestfs-actions.pod:7025
16567 msgid "guestfs_zero"
16571 #: ../src/guestfs-actions.pod:7027
16575 " guestfs_zero (guestfs_h *g,\n"
16576 " const char *device);\n"
16581 #: ../src/guestfs-actions.pod:7031 ../fish/guestfish-actions.pod:4658
16582 msgid "This command writes zeroes over the first few blocks of C<device>."
16586 #: ../src/guestfs-actions.pod:7033 ../fish/guestfish-actions.pod:4660
16588 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16589 "securely wipe the device). It should be sufficient to remove any partition "
16590 "tables, filesystem superblocks and so on."
16594 #: ../src/guestfs-actions.pod:7037
16595 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16599 #: ../src/guestfs-actions.pod:7048
16600 msgid "guestfs_zero_device"
16604 #: ../src/guestfs-actions.pod:7050
16608 " guestfs_zero_device (guestfs_h *g,\n"
16609 " const char *device);\n"
16614 #: ../src/guestfs-actions.pod:7054
16616 "This command writes zeroes over the entire C<device>. Compare with "
16617 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16621 #: ../src/guestfs-actions.pod:7068
16622 msgid "(Added in 1.3.1)"
16626 #: ../src/guestfs-actions.pod:7070
16627 msgid "guestfs_zerofree"
16631 #: ../src/guestfs-actions.pod:7072
16635 " guestfs_zerofree (guestfs_h *g,\n"
16636 " const char *device);\n"
16641 #: ../src/guestfs-actions.pod:7076 ../fish/guestfish-actions.pod:4681
16643 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16644 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16645 "possible to compress the filesystem more effectively."
16649 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4686
16650 msgid "You should B<not> run this program if the filesystem is mounted."
16654 #: ../src/guestfs-actions.pod:7084 ../fish/guestfish-actions.pod:4689
16656 "It is possible that using this program can damage the filesystem or data on "
16661 #: ../src/guestfs-actions.pod:7091
16662 msgid "guestfs_zfgrep"
16666 #: ../src/guestfs-actions.pod:7093
16670 " guestfs_zfgrep (guestfs_h *g,\n"
16671 " const char *pattern,\n"
16672 " const char *path);\n"
16677 #: ../src/guestfs-actions.pod:7098 ../fish/guestfish-actions.pod:4696
16678 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16682 #: ../src/guestfs-actions.pod:7110
16683 msgid "guestfs_zfgrepi"
16687 #: ../src/guestfs-actions.pod:7112
16691 " guestfs_zfgrepi (guestfs_h *g,\n"
16692 " const char *pattern,\n"
16693 " const char *path);\n"
16698 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4706
16699 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16703 #: ../src/guestfs-actions.pod:7129
16704 msgid "guestfs_zfile"
16708 #: ../src/guestfs-actions.pod:7131
16712 " guestfs_zfile (guestfs_h *g,\n"
16713 " const char *meth,\n"
16714 " const char *path);\n"
16719 #: ../src/guestfs-actions.pod:7136 ../fish/guestfish-actions.pod:4716
16720 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16724 #: ../src/guestfs-actions.pod:7139 ../fish/guestfish-actions.pod:4719
16725 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16729 #: ../src/guestfs-actions.pod:7141
16731 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16736 #: ../src/guestfs-actions.pod:7147
16738 "This function is deprecated. In new code, use the L</guestfs_file> call "
16743 #: ../src/guestfs-actions.pod:7156
16744 msgid "guestfs_zgrep"
16748 #: ../src/guestfs-actions.pod:7158
16752 " guestfs_zgrep (guestfs_h *g,\n"
16753 " const char *regex,\n"
16754 " const char *path);\n"
16759 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4735
16760 msgid "This calls the external C<zgrep> program and returns the matching lines."
16764 #: ../src/guestfs-actions.pod:7175
16765 msgid "guestfs_zgrepi"
16769 #: ../src/guestfs-actions.pod:7177
16773 " guestfs_zgrepi (guestfs_h *g,\n"
16774 " const char *regex,\n"
16775 " const char *path);\n"
16780 #: ../src/guestfs-actions.pod:7182 ../fish/guestfish-actions.pod:4745
16781 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16785 #: ../src/guestfs-availability.pod:3
16790 #: ../src/guestfs-availability.pod:5
16792 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
16793 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
16794 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
16795 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
16796 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
16800 #: ../src/guestfs-availability.pod:21
16805 #: ../src/guestfs-availability.pod:23
16807 "The following functions: L</guestfs_inotify_add_watch> "
16808 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
16809 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16813 #: ../src/guestfs-availability.pod:31
16814 msgid "B<linuxfsuuid>"
16818 #: ../src/guestfs-availability.pod:33
16820 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
16821 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16825 #: ../src/guestfs-availability.pod:40
16826 msgid "B<linuxmodules>"
16830 #: ../src/guestfs-availability.pod:42
16831 msgid "The following functions: L</guestfs_modprobe>"
16835 #: ../src/guestfs-availability.pod:45
16836 msgid "B<linuxxattrs>"
16840 #: ../src/guestfs-availability.pod:47
16842 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
16843 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
16844 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
16845 "L</guestfs_setxattr>"
16849 #: ../src/guestfs-availability.pod:58
16854 #: ../src/guestfs-availability.pod:60
16856 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
16857 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
16858 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16862 #: ../src/guestfs-availability.pod:69
16867 #: ../src/guestfs-availability.pod:71
16869 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
16870 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
16871 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
16872 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
16873 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
16874 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
16875 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
16876 "L</guestfs_vgs_full>"
16880 #: ../src/guestfs-availability.pod:94
16885 #: ../src/guestfs-availability.pod:96
16887 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
16888 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
16892 #: ../src/guestfs-availability.pod:102
16897 #: ../src/guestfs-availability.pod:104
16898 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16902 #: ../src/guestfs-availability.pod:107
16903 msgid "B<ntfsprogs>"
16907 #: ../src/guestfs-availability.pod:109
16908 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16912 #: ../src/guestfs-availability.pod:113
16913 msgid "B<realpath>"
16917 #: ../src/guestfs-availability.pod:115
16918 msgid "The following functions: L</guestfs_realpath>"
16922 #: ../src/guestfs-availability.pod:118
16927 #: ../src/guestfs-availability.pod:120
16929 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
16930 "L</guestfs_scrub_freespace>"
16934 #: ../src/guestfs-availability.pod:125
16939 #: ../src/guestfs-availability.pod:127
16940 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16944 #: ../src/guestfs-availability.pod:131
16949 #: ../src/guestfs-availability.pod:133
16950 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16954 #: ../src/guestfs-availability.pod:137
16955 msgid "B<zerofree>"
16959 #: ../src/guestfs-availability.pod:139
16960 msgid "The following functions: L</guestfs_zerofree>"
16964 #: ../src/guestfs-structs.pod:1
16965 msgid "guestfs_int_bool"
16969 #: ../src/guestfs-structs.pod:3
16972 " struct guestfs_int_bool {\n"
16980 #: ../src/guestfs-structs.pod:8
16983 " struct guestfs_int_bool_list {\n"
16984 " uint32_t len; /* Number of elements in list. */\n"
16985 " struct guestfs_int_bool *val; /* Elements. */\n"
16991 #: ../src/guestfs-structs.pod:13
16994 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16995 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
17000 #: ../src/guestfs-structs.pod:16
17001 msgid "guestfs_lvm_pv"
17005 #: ../src/guestfs-structs.pod:18
17008 " struct guestfs_lvm_pv {\n"
17009 " char *pv_name;\n"
17010 " /* The next field is NOT nul-terminated, be careful when printing it: "
17012 " char pv_uuid[32];\n"
17014 " uint64_t pv_size;\n"
17015 " uint64_t dev_size;\n"
17016 " uint64_t pv_free;\n"
17017 " uint64_t pv_used;\n"
17018 " char *pv_attr;\n"
17019 " int64_t pv_pe_count;\n"
17020 " int64_t pv_pe_alloc_count;\n"
17021 " char *pv_tags;\n"
17022 " uint64_t pe_start;\n"
17023 " int64_t pv_mda_count;\n"
17024 " uint64_t pv_mda_free;\n"
17030 #: ../src/guestfs-structs.pod:36
17033 " struct guestfs_lvm_pv_list {\n"
17034 " uint32_t len; /* Number of elements in list. */\n"
17035 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17041 #: ../src/guestfs-structs.pod:41
17044 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17045 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17050 #: ../src/guestfs-structs.pod:44
17051 msgid "guestfs_lvm_vg"
17055 #: ../src/guestfs-structs.pod:46
17058 " struct guestfs_lvm_vg {\n"
17059 " char *vg_name;\n"
17060 " /* The next field is NOT nul-terminated, be careful when printing it: "
17062 " char vg_uuid[32];\n"
17064 " char *vg_attr;\n"
17065 " uint64_t vg_size;\n"
17066 " uint64_t vg_free;\n"
17067 " char *vg_sysid;\n"
17068 " uint64_t vg_extent_size;\n"
17069 " int64_t vg_extent_count;\n"
17070 " int64_t vg_free_count;\n"
17071 " int64_t max_lv;\n"
17072 " int64_t max_pv;\n"
17073 " int64_t pv_count;\n"
17074 " int64_t lv_count;\n"
17075 " int64_t snap_count;\n"
17076 " int64_t vg_seqno;\n"
17077 " char *vg_tags;\n"
17078 " int64_t vg_mda_count;\n"
17079 " uint64_t vg_mda_free;\n"
17085 #: ../src/guestfs-structs.pod:69
17088 " struct guestfs_lvm_vg_list {\n"
17089 " uint32_t len; /* Number of elements in list. */\n"
17090 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17096 #: ../src/guestfs-structs.pod:74
17099 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17100 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17105 #: ../src/guestfs-structs.pod:77
17106 msgid "guestfs_lvm_lv"
17110 #: ../src/guestfs-structs.pod:79
17113 " struct guestfs_lvm_lv {\n"
17114 " char *lv_name;\n"
17115 " /* The next field is NOT nul-terminated, be careful when printing it: "
17117 " char lv_uuid[32];\n"
17118 " char *lv_attr;\n"
17119 " int64_t lv_major;\n"
17120 " int64_t lv_minor;\n"
17121 " int64_t lv_kernel_major;\n"
17122 " int64_t lv_kernel_minor;\n"
17123 " uint64_t lv_size;\n"
17124 " int64_t seg_count;\n"
17126 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17127 " float snap_percent;\n"
17128 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17129 " float copy_percent;\n"
17130 " char *move_pv;\n"
17131 " char *lv_tags;\n"
17132 " char *mirror_log;\n"
17133 " char *modules;\n"
17139 #: ../src/guestfs-structs.pod:101
17142 " struct guestfs_lvm_lv_list {\n"
17143 " uint32_t len; /* Number of elements in list. */\n"
17144 " struct guestfs_lvm_lv *val; /* Elements. */\n"
17150 #: ../src/guestfs-structs.pod:106
17153 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
17154 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
17159 #: ../src/guestfs-structs.pod:111
17162 " struct guestfs_stat {\n"
17166 " int64_t nlink;\n"
17171 " int64_t blksize;\n"
17172 " int64_t blocks;\n"
17173 " int64_t atime;\n"
17174 " int64_t mtime;\n"
17175 " int64_t ctime;\n"
17181 #: ../src/guestfs-structs.pod:127
17184 " struct guestfs_stat_list {\n"
17185 " uint32_t len; /* Number of elements in list. */\n"
17186 " struct guestfs_stat *val; /* Elements. */\n"
17192 #: ../src/guestfs-structs.pod:132
17195 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
17196 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
17201 #: ../src/guestfs-structs.pod:137
17204 " struct guestfs_statvfs {\n"
17205 " int64_t bsize;\n"
17206 " int64_t frsize;\n"
17207 " int64_t blocks;\n"
17208 " int64_t bfree;\n"
17209 " int64_t bavail;\n"
17210 " int64_t files;\n"
17211 " int64_t ffree;\n"
17212 " int64_t favail;\n"
17215 " int64_t namemax;\n"
17221 #: ../src/guestfs-structs.pod:151
17224 " struct guestfs_statvfs_list {\n"
17225 " uint32_t len; /* Number of elements in list. */\n"
17226 " struct guestfs_statvfs *val; /* Elements. */\n"
17232 #: ../src/guestfs-structs.pod:156
17235 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
17236 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
17241 #: ../src/guestfs-structs.pod:159
17242 msgid "guestfs_dirent"
17246 #: ../src/guestfs-structs.pod:161
17249 " struct guestfs_dirent {\n"
17258 #: ../src/guestfs-structs.pod:167
17261 " struct guestfs_dirent_list {\n"
17262 " uint32_t len; /* Number of elements in list. */\n"
17263 " struct guestfs_dirent *val; /* Elements. */\n"
17269 #: ../src/guestfs-structs.pod:172
17272 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
17273 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
17278 #: ../src/guestfs-structs.pod:177
17281 " struct guestfs_version {\n"
17282 " int64_t major;\n"
17283 " int64_t minor;\n"
17284 " int64_t release;\n"
17291 #: ../src/guestfs-structs.pod:184
17294 " struct guestfs_version_list {\n"
17295 " uint32_t len; /* Number of elements in list. */\n"
17296 " struct guestfs_version *val; /* Elements. */\n"
17302 #: ../src/guestfs-structs.pod:189
17305 " void guestfs_free_version (struct guestfs_free_version *);\n"
17306 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
17311 #: ../src/guestfs-structs.pod:192
17312 msgid "guestfs_xattr"
17316 #: ../src/guestfs-structs.pod:194
17319 " struct guestfs_xattr {\n"
17320 " char *attrname;\n"
17321 " /* The next two fields describe a byte array. */\n"
17322 " uint32_t attrval_len;\n"
17323 " char *attrval;\n"
17329 #: ../src/guestfs-structs.pod:201
17332 " struct guestfs_xattr_list {\n"
17333 " uint32_t len; /* Number of elements in list. */\n"
17334 " struct guestfs_xattr *val; /* Elements. */\n"
17340 #: ../src/guestfs-structs.pod:206
17343 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
17344 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
17349 #: ../src/guestfs-structs.pod:209
17350 msgid "guestfs_inotify_event"
17354 #: ../src/guestfs-structs.pod:211
17357 " struct guestfs_inotify_event {\n"
17358 " int64_t in_wd;\n"
17359 " uint32_t in_mask;\n"
17360 " uint32_t in_cookie;\n"
17361 " char *in_name;\n"
17367 #: ../src/guestfs-structs.pod:218
17370 " struct guestfs_inotify_event_list {\n"
17371 " uint32_t len; /* Number of elements in list. */\n"
17372 " struct guestfs_inotify_event *val; /* Elements. */\n"
17378 #: ../src/guestfs-structs.pod:223
17381 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
17382 " void guestfs_free_inotify_event_list (struct "
17383 "guestfs_free_inotify_event_list *);\n"
17388 #: ../src/guestfs-structs.pod:226
17389 msgid "guestfs_partition"
17393 #: ../src/guestfs-structs.pod:228
17396 " struct guestfs_partition {\n"
17397 " int32_t part_num;\n"
17398 " uint64_t part_start;\n"
17399 " uint64_t part_end;\n"
17400 " uint64_t part_size;\n"
17406 #: ../src/guestfs-structs.pod:235
17409 " struct guestfs_partition_list {\n"
17410 " uint32_t len; /* Number of elements in list. */\n"
17411 " struct guestfs_partition *val; /* Elements. */\n"
17417 #: ../src/guestfs-structs.pod:240
17420 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
17421 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
17426 #: ../src/guestfs-structs.pod:243
17427 msgid "guestfs_application"
17431 #: ../src/guestfs-structs.pod:245
17434 " struct guestfs_application {\n"
17435 " char *app_name;\n"
17436 " char *app_display_name;\n"
17437 " int32_t app_epoch;\n"
17438 " char *app_version;\n"
17439 " char *app_release;\n"
17440 " char *app_install_path;\n"
17441 " char *app_trans_path;\n"
17442 " char *app_publisher;\n"
17443 " char *app_url;\n"
17444 " char *app_source_package;\n"
17445 " char *app_summary;\n"
17446 " char *app_description;\n"
17452 #: ../src/guestfs-structs.pod:260
17455 " struct guestfs_application_list {\n"
17456 " uint32_t len; /* Number of elements in list. */\n"
17457 " struct guestfs_application *val; /* Elements. */\n"
17463 #: ../src/guestfs-structs.pod:265
17466 " void guestfs_free_application (struct guestfs_free_application *);\n"
17467 " void guestfs_free_application_list (struct guestfs_free_application_list "
17473 #: ../fish/guestfish.pod:5
17474 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17478 #: ../fish/guestfish.pod:9
17481 " guestfish [--options] [commands]\n"
17486 #: ../fish/guestfish.pod:11
17494 #: ../fish/guestfish.pod:13
17497 " guestfish [--ro|--rw] -a disk.img\n"
17502 #: ../fish/guestfish.pod:15
17505 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17510 #: ../fish/guestfish.pod:17
17513 " guestfish -d libvirt-domain\n"
17518 #: ../fish/guestfish.pod:19
17521 " guestfish [--ro|--rw] -a disk.img -i\n"
17526 #: ../fish/guestfish.pod:21
17529 " guestfish -d libvirt-domain -i\n"
17534 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
17539 #: ../fish/guestfish.pod:25
17541 "Using guestfish in read/write mode on live virtual machines can be "
17542 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17543 "option to use guestfish safely if the disk image or virtual machine might be "
17548 #: ../fish/guestfish.pod:32
17550 "Guestfish is a shell and command-line tool for examining and modifying "
17551 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17552 "functionality of the guestfs API, see L<guestfs(3)>."
17556 #: ../fish/guestfish.pod:36
17558 "Guestfish gives you structured access to the libguestfs API, from shell "
17559 "scripts or the command line or interactively. If you want to rescue a "
17560 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17565 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:897 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
17570 #: ../fish/guestfish.pod:43
17571 msgid "As an interactive shell"
17575 #: ../fish/guestfish.pod:45
17583 #: ../fish/guestfish.pod:47
17586 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17587 " editing virtual machine filesystems.\n"
17592 #: ../fish/guestfish.pod:50
17595 " Type: 'help' for a list of commands\n"
17596 " 'man' to read the manual\n"
17597 " 'quit' to quit the shell\n"
17602 #: ../fish/guestfish.pod:54
17605 " ><fs> add-ro disk.img\n"
17607 " ><fs> list-filesystems\n"
17608 " /dev/sda1: ext4\n"
17609 " /dev/vg_guest/lv_root: ext4\n"
17610 " /dev/vg_guest/lv_swap: swap\n"
17611 " ><fs> mount /dev/vg_guest/lv_root /\n"
17612 " ><fs> cat /etc/fstab\n"
17614 " # Created by anaconda\n"
17621 #: ../fish/guestfish.pod:67
17622 msgid "From shell scripts"
17626 #: ../fish/guestfish.pod:69
17627 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17631 #: ../fish/guestfish.pod:71
17634 " guestfish <<_EOF_\n"
17637 " mount /dev/vg_guest/lv_root /\n"
17638 " write /etc/motd \"Welcome, new users\"\n"
17644 #: ../fish/guestfish.pod:78
17645 msgid "List the LVM logical volumes in a disk image:"
17649 #: ../fish/guestfish.pod:80
17652 " guestfish -a disk.img --ro <<_EOF_\n"
17660 #: ../fish/guestfish.pod:85
17661 msgid "List all the filesystems in a disk image:"
17665 #: ../fish/guestfish.pod:87
17668 " guestfish -a disk.img --ro <<_EOF_\n"
17670 " list-filesystems\n"
17676 #: ../fish/guestfish.pod:92
17677 msgid "On one command line"
17681 #: ../fish/guestfish.pod:94
17682 msgid "Update C</etc/resolv.conf> in a guest:"
17686 #: ../fish/guestfish.pod:96
17690 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17691 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17696 #: ../fish/guestfish.pod:100
17697 msgid "Edit C</boot/grub/grub.conf> interactively:"
17701 #: ../fish/guestfish.pod:102
17704 " guestfish --rw --add disk.img \\\n"
17705 " --mount /dev/vg_guest/lv_root \\\n"
17706 " --mount /dev/sda1:/boot \\\n"
17707 " edit /boot/grub/grub.conf\n"
17712 #: ../fish/guestfish.pod:107
17713 msgid "Mount disks automatically"
17717 #: ../fish/guestfish.pod:109
17719 "Use the I<-i> option to automatically mount the disks from a virtual "
17724 #: ../fish/guestfish.pod:112
17727 " guestfish --ro -a disk.img -i cat /etc/group\n"
17732 #: ../fish/guestfish.pod:114
17735 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17740 #: ../fish/guestfish.pod:116
17741 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17745 #: ../fish/guestfish.pod:118
17748 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17753 #: ../fish/guestfish.pod:120
17754 msgid "As a script interpreter"
17758 #: ../fish/guestfish.pod:122
17759 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17763 #: ../fish/guestfish.pod:124
17766 " #!/usr/bin/guestfish -f\n"
17767 " sparse test1.img 100M\n"
17769 " part-disk /dev/sda mbr\n"
17770 " mkfs ext2 /dev/sda1\n"
17775 #: ../fish/guestfish.pod:130
17776 msgid "Start with a prepared disk"
17780 #: ../fish/guestfish.pod:132
17782 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17783 "single ext2-formatted partition:"
17787 #: ../fish/guestfish.pod:135
17790 " guestfish -N fs\n"
17795 #: ../fish/guestfish.pod:137
17796 msgid "To list what is available do:"
17800 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:888
17803 " guestfish -N help | less\n"
17808 #: ../fish/guestfish.pod:141
17809 msgid "Remote control"
17813 #: ../fish/guestfish.pod:143
17816 " eval \"`guestfish --listen`\"\n"
17817 " guestfish --remote add-ro disk.img\n"
17818 " guestfish --remote run\n"
17819 " guestfish --remote lvs\n"
17824 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:77 ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
17829 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:85 ../tools/virt-win-reg.pl:104 ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
17834 #: ../fish/guestfish.pod:154
17835 msgid "Displays general help on options."
17839 #: ../fish/guestfish.pod:156
17844 #: ../fish/guestfish.pod:158
17845 msgid "B<--cmd-help>"
17849 #: ../fish/guestfish.pod:160
17850 msgid "Lists all available guestfish commands."
17854 #: ../fish/guestfish.pod:162
17859 #: ../fish/guestfish.pod:164
17860 msgid "B<--cmd-help cmd>"
17864 #: ../fish/guestfish.pod:166
17865 msgid "Displays detailed help on a single command C<cmd>."
17869 #: ../fish/guestfish.pod:168
17870 msgid "B<-a image>"
17874 #: ../fish/guestfish.pod:170
17875 msgid "B<--add image>"
17879 #: ../fish/guestfish.pod:172
17880 msgid "Add a block device or virtual machine image to the shell."
17884 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
17886 "The format of the disk image is auto-detected. To override this and force a "
17887 "particular format use the I<--format=..> option."
17891 #: ../fish/guestfish.pod:177
17893 "Using this flag is mostly equivalent to using the C<add> command, with "
17894 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17895 "the I<--format=...> flag was given."
17899 #: ../fish/guestfish.pod:181
17904 #: ../fish/guestfish.pod:183
17905 msgid "B<--connect URI>"
17909 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
17911 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17912 "URI to use. The default is to use the default libvirt connection."
17916 #: ../fish/guestfish.pod:189
17921 #: ../fish/guestfish.pod:191
17923 "If using the I<--listen> option and a csh-like shell, use this option. See "
17924 "section L</REMOTE CONTROL AND CSH> below."
17928 #: ../fish/guestfish.pod:194
17929 msgid "B<-d libvirt-domain>"
17933 #: ../fish/guestfish.pod:196
17934 msgid "B<--domain libvirt-domain>"
17938 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
17940 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17941 "used, then any libvirt domain can be used. However in write mode, only "
17942 "libvirt domains which are shut down can be named here."
17946 #: ../fish/guestfish.pod:202
17948 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17949 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17950 "if the I<--format:...> flag was given."
17954 #: ../fish/guestfish.pod:206
17959 #: ../fish/guestfish.pod:208
17960 msgid "B<--no-dest-paths>"
17964 #: ../fish/guestfish.pod:210
17966 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17967 "to hit the tab key to complete paths on the guest filesystem, but this "
17968 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17969 "allow this feature to be disabled."
17973 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
17974 msgid "B<--echo-keys>"
17978 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
17980 "When prompting for keys and passphrases, guestfish normally turns echoing "
17981 "off so you cannot see what you are typing. If you are not worried about "
17982 "Tempest attacks and there is no one else in the room you can specify this "
17983 "flag to see what you are typing."
17987 #: ../fish/guestfish.pod:222
17992 #: ../fish/guestfish.pod:224
17993 msgid "B<--file file>"
17997 #: ../fish/guestfish.pod:226
17998 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
18002 #: ../fish/guestfish.pod:229
18005 " #!/usr/bin/guestfish -f\n"
18010 #: ../fish/guestfish.pod:231
18011 msgid "B<--format=raw|qcow2|..>"
18015 #: ../fish/guestfish.pod:233
18016 msgid "B<--format>"
18020 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
18022 "The default for the I<-a> option is to auto-detect the format of the disk "
18023 "image. Using this forces the disk format for I<-a> options which follow on "
18024 "the command line. Using I<--format> with no argument switches back to "
18025 "auto-detection for subsequent I<-a> options."
18029 #: ../fish/guestfish.pod:242
18032 " guestfish --format=raw -a disk.img\n"
18037 #: ../fish/guestfish.pod:244
18038 msgid "forces raw format (no auto-detection) for C<disk.img>."
18042 #: ../fish/guestfish.pod:246
18045 " guestfish --format=raw -a disk.img --format -a another.img\n"
18050 #: ../fish/guestfish.pod:248
18052 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18053 "auto-detection for C<another.img>."
18057 #: ../fish/guestfish.pod:251
18059 "If you have untrusted raw-format guest disk images, you should use this "
18060 "option to specify the disk format. This avoids a possible security problem "
18061 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18065 #: ../fish/guestfish.pod:256
18070 #: ../fish/guestfish.pod:258
18071 msgid "B<--inspector>"
18075 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18077 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18078 "system and mount filesystems as they would be mounted on the real virtual "
18083 #: ../fish/guestfish.pod:264
18084 msgid "Typical usage is either:"
18088 #: ../fish/guestfish.pod:266
18091 " guestfish -d myguest -i\n"
18096 #: ../fish/guestfish.pod:268
18097 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18101 #: ../fish/guestfish.pod:270
18104 " guestfish --ro -d myguest -i\n"
18109 #: ../fish/guestfish.pod:272
18110 msgid "(for active domains, readonly), or specify the block device directly:"
18114 #: ../fish/guestfish.pod:274
18117 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18122 #: ../fish/guestfish.pod:276
18124 "Note that the command line syntax changed slightly over older versions of "
18125 "guestfish. You can still use the old syntax:"
18129 #: ../fish/guestfish.pod:279
18132 " guestfish [--ro] -i disk.img\n"
18137 #: ../fish/guestfish.pod:281
18140 " guestfish [--ro] -i libvirt-domain\n"
18145 #: ../fish/guestfish.pod:283
18147 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
18148 "then using other commands to mount the filesystems that were found."
18152 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
18153 msgid "B<--keys-from-stdin>"
18157 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
18159 "Read key or passphrase parameters from stdin. The default is to try to read "
18160 "passphrases from the user by opening C</dev/tty>."
18164 #: ../fish/guestfish.pod:292
18165 msgid "B<--listen>"
18169 #: ../fish/guestfish.pod:294
18171 "Fork into the background and listen for remote commands. See section "
18172 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18176 #: ../fish/guestfish.pod:297
18177 msgid "B<-m dev[:mountpoint]>"
18181 #: ../fish/guestfish.pod:299
18182 msgid "B<--mount dev[:mountpoint]>"
18186 #: ../fish/guestfish.pod:301
18187 msgid "Mount the named partition or logical volume on the given mountpoint."
18191 #: ../fish/guestfish.pod:303
18192 msgid "If the mountpoint is omitted, it defaults to C</>."
18196 #: ../fish/guestfish.pod:305
18197 msgid "You have to mount something on C</> before most commands will work."
18201 #: ../fish/guestfish.pod:307
18203 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18208 #: ../fish/guestfish.pod:310
18210 "If you don't know what filesystems a disk image contains, you can either run "
18211 "guestfish without this option, then list the partitions, filesystems and LVs "
18212 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18213 "commands), or you can use the L<virt-filesystems(1)> program."
18217 #: ../fish/guestfish.pod:316
18219 "Using this flag is mostly equivalent to using the C<mount-options> command "
18220 "or the C<mount-ro> command if the I<--ro> flag was given."
18224 #: ../fish/guestfish.pod:319
18229 #: ../fish/guestfish.pod:321
18230 msgid "B<--no-sync>"
18234 #: ../fish/guestfish.pod:323
18236 "Disable autosync. This is enabled by default. See the discussion of "
18237 "autosync in the L<guestfs(3)> manpage."
18241 #: ../fish/guestfish.pod:326
18246 #: ../fish/guestfish.pod:328
18247 msgid "B<--new type>"
18251 #: ../fish/guestfish.pod:330
18256 #: ../fish/guestfish.pod:332
18258 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18259 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18260 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18265 #: ../fish/guestfish.pod:337
18266 msgid "B<--progress-bars>"
18270 #: ../fish/guestfish.pod:339
18271 msgid "Enable progress bars, even when guestfish is used non-interactively."
18275 #: ../fish/guestfish.pod:341
18277 "Progress bars are enabled by default when guestfish is used as an "
18278 "interactive shell."
18282 #: ../fish/guestfish.pod:344
18283 msgid "B<--no-progress-bars>"
18287 #: ../fish/guestfish.pod:346
18288 msgid "Disable progress bars."
18292 #: ../fish/guestfish.pod:348
18293 msgid "B<--remote[=pid]>"
18297 #: ../fish/guestfish.pod:350
18299 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18300 "CONTROL GUESTFISH OVER A SOCKET> below."
18304 #: ../fish/guestfish.pod:353
18309 #: ../fish/guestfish.pod:355
18314 #: ../fish/guestfish.pod:357
18316 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18317 "mounts are done read-only."
18321 #: ../fish/guestfish.pod:360
18323 "The option must always be used if the disk image or virtual machine might be "
18324 "running, and is generally recommended in cases where you don't need write "
18325 "access to the disk."
18329 #: ../fish/guestfish.pod:364
18331 "Note that prepared disk images created with I<-N> are not affected by this "
18332 "option. Also commands like C<add> are not affected - you have to specify "
18333 "the C<readonly:true> option explicitly if you need it."
18337 #: ../fish/guestfish.pod:368
18338 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18342 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
18343 msgid "B<--selinux>"
18347 #: ../fish/guestfish.pod:372
18348 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18352 #: ../fish/guestfish.pod:374
18357 #: ../fish/guestfish.pod:376
18358 msgid "B<--verbose>"
18362 #: ../fish/guestfish.pod:378
18364 "Enable very verbose messages. This is particularly useful if you find a "
18369 #: ../fish/guestfish.pod:381
18374 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:93 ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
18375 msgid "B<--version>"
18379 #: ../fish/guestfish.pod:385
18380 msgid "Display the guestfish / libguestfs version number and exit."
18384 #: ../fish/guestfish.pod:387
18389 #: ../fish/guestfish.pod:389
18394 #: ../fish/guestfish.pod:391
18396 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
18401 #: ../fish/guestfish.pod:394
18406 #: ../fish/guestfish.pod:396
18407 msgid "Echo each command before executing it."
18411 #: ../fish/guestfish.pod:400
18412 msgid "COMMANDS ON COMMAND LINE"
18416 #: ../fish/guestfish.pod:402
18417 msgid "Any additional (non-option) arguments are treated as commands to execute."
18421 #: ../fish/guestfish.pod:405
18423 "Commands to execute should be separated by a colon (C<:>), where the colon "
18424 "is a separate parameter. Thus:"
18428 #: ../fish/guestfish.pod:408
18431 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18436 #: ../fish/guestfish.pod:410
18438 "If there are no additional arguments, then we enter a shell, either an "
18439 "interactive shell with a prompt (if the input is a terminal) or a "
18440 "non-interactive shell."
18444 #: ../fish/guestfish.pod:414
18446 "In either command line mode or non-interactive shell, the first command that "
18447 "gives an error causes the whole shell to exit. In interactive mode (with a "
18448 "prompt) if a command fails, you can continue to enter commands."
18452 #: ../fish/guestfish.pod:419
18453 msgid "USING launch (OR run)"
18457 #: ../fish/guestfish.pod:421
18459 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18460 "then launch it, then mount any disks you need, and finally issue "
18461 "actions/commands. So the general order of the day is:"
18465 #: ../fish/guestfish.pod:429
18466 msgid "add or -a/--add"
18470 #: ../fish/guestfish.pod:433
18471 msgid "launch (aka run)"
18475 #: ../fish/guestfish.pod:437
18476 msgid "mount or -m/--mount"
18480 #: ../fish/guestfish.pod:441
18481 msgid "any other commands"
18485 #: ../fish/guestfish.pod:445
18487 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18488 "guest before mounting or performing any other commands."
18492 #: ../fish/guestfish.pod:448
18494 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18495 "I<--new> options were given then C<run> is done automatically, simply "
18496 "because guestfish can't perform the action you asked for without doing this."
18500 #: ../fish/guestfish.pod:453
18501 msgid "OPENING DISKS FOR READ AND WRITE"
18505 #: ../fish/guestfish.pod:455
18507 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
18508 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
18509 "open disk images read-only or for writing."
18513 #: ../fish/guestfish.pod:459
18515 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
18516 "disk images supplied on the command line for write. To open a disk image "
18517 "read-only you have to do I<-a image --ro>."
18521 #: ../fish/guestfish.pod:463
18523 "This matters: If you accidentally open a live VM disk image writable then "
18524 "you will cause irreversible disk corruption."
18528 #: ../fish/guestfish.pod:466
18530 "By libguestfs 1.10 we intend to change the default the other way. Disk "
18531 "images will be opened read-only. You will have to either specify "
18532 "I<guestfish --rw> or change a configuration file in order to get write "
18533 "access for disk images specified by those other command line options."
18537 #: ../fish/guestfish.pod:471
18539 "This version of guestfish has a I<--rw> option which does nothing (it is "
18540 "already the default). However it is highly recommended that you use this "
18541 "option to indicate that guestfish needs write access, and to prepare your "
18542 "scripts for the day when this option will be required for write access."
18546 #: ../fish/guestfish.pod:477
18548 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18549 "other libguestfs program apart from guestfish and guestmount."
18553 #: ../fish/guestfish.pod:480
18558 #: ../fish/guestfish.pod:482
18560 "You can quote ordinary parameters using either single or double quotes. For "
18565 #: ../fish/guestfish.pod:485
18568 " add \"file with a space.img\"\n"
18573 #: ../fish/guestfish.pod:487
18576 " rm '/file name'\n"
18581 #: ../fish/guestfish.pod:489
18589 #: ../fish/guestfish.pod:491
18591 "A few commands require a list of strings to be passed. For these, use a "
18592 "whitespace-separated list, enclosed in quotes. Strings containing "
18593 "whitespace to be passed through must be enclosed in single quotes. A "
18594 "literal single quote must be escaped with a backslash."
18598 #: ../fish/guestfish.pod:496
18601 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18602 " command \"/bin/echo 'foo bar'\"\n"
18603 " command \"/bin/echo \\'foo\\'\"\n"
18608 #: ../fish/guestfish.pod:500
18609 msgid "OPTIONAL ARGUMENTS"
18613 #: ../fish/guestfish.pod:502
18615 "Some commands take optional arguments. These arguments appear in this "
18616 "documentation as C<[argname:..]>. You can use them as in these examples:"
18620 #: ../fish/guestfish.pod:506
18623 " add-drive-opts filename\n"
18628 #: ../fish/guestfish.pod:508
18631 " add-drive-opts filename readonly:true\n"
18636 #: ../fish/guestfish.pod:510
18639 " add-drive-opts filename format:qcow2 readonly:false\n"
18644 #: ../fish/guestfish.pod:512
18646 "Each optional argument can appear at most once. All optional arguments must "
18647 "appear after the required ones."
18651 #: ../fish/guestfish.pod:515
18656 #: ../fish/guestfish.pod:517
18657 msgid "This section applies to all commands which can take integers as parameters."
18661 #: ../fish/guestfish.pod:520
18662 msgid "SIZE SUFFIX"
18666 #: ../fish/guestfish.pod:522
18668 "When the command takes a parameter measured in bytes, you can use one of the "
18669 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18673 #: ../fish/guestfish.pod:528
18674 msgid "B<k> or B<K> or B<KiB>"
18678 #: ../fish/guestfish.pod:530
18679 msgid "The size in kilobytes (multiplied by 1024)."
18683 #: ../fish/guestfish.pod:532
18688 #: ../fish/guestfish.pod:534
18689 msgid "The size in SI 1000 byte units."
18693 #: ../fish/guestfish.pod:536
18694 msgid "B<M> or B<MiB>"
18698 #: ../fish/guestfish.pod:538
18699 msgid "The size in megabytes (multiplied by 1048576)."
18703 #: ../fish/guestfish.pod:540
18708 #: ../fish/guestfish.pod:542
18709 msgid "The size in SI 1000000 byte units."
18713 #: ../fish/guestfish.pod:544
18714 msgid "B<G> or B<GiB>"
18718 #: ../fish/guestfish.pod:546
18719 msgid "The size in gigabytes (multiplied by 2**30)."
18723 #: ../fish/guestfish.pod:548
18728 #: ../fish/guestfish.pod:550
18729 msgid "The size in SI 10**9 byte units."
18733 #: ../fish/guestfish.pod:552
18734 msgid "B<T> or B<TiB>"
18738 #: ../fish/guestfish.pod:554
18739 msgid "The size in terabytes (multiplied by 2**40)."
18743 #: ../fish/guestfish.pod:556
18748 #: ../fish/guestfish.pod:558
18749 msgid "The size in SI 10**12 byte units."
18753 #: ../fish/guestfish.pod:560
18754 msgid "B<P> or B<PiB>"
18758 #: ../fish/guestfish.pod:562
18759 msgid "The size in petabytes (multiplied by 2**50)."
18763 #: ../fish/guestfish.pod:564
18768 #: ../fish/guestfish.pod:566
18769 msgid "The size in SI 10**15 byte units."
18773 #: ../fish/guestfish.pod:568
18774 msgid "B<E> or B<EiB>"
18778 #: ../fish/guestfish.pod:570
18779 msgid "The size in exabytes (multiplied by 2**60)."
18783 #: ../fish/guestfish.pod:572
18788 #: ../fish/guestfish.pod:574
18789 msgid "The size in SI 10**18 byte units."
18793 #: ../fish/guestfish.pod:576
18794 msgid "B<Z> or B<ZiB>"
18798 #: ../fish/guestfish.pod:578
18799 msgid "The size in zettabytes (multiplied by 2**70)."
18803 #: ../fish/guestfish.pod:580
18808 #: ../fish/guestfish.pod:582
18809 msgid "The size in SI 10**21 byte units."
18813 #: ../fish/guestfish.pod:584
18814 msgid "B<Y> or B<YiB>"
18818 #: ../fish/guestfish.pod:586
18819 msgid "The size in yottabytes (multiplied by 2**80)."
18823 #: ../fish/guestfish.pod:588
18828 #: ../fish/guestfish.pod:590
18829 msgid "The size in SI 10**24 byte units."
18833 #: ../fish/guestfish.pod:596
18836 " truncate-size /file 1G\n"
18841 #: ../fish/guestfish.pod:598
18842 msgid "would truncate the file to 1 gigabyte."
18846 #: ../fish/guestfish.pod:600
18848 "Be careful because a few commands take sizes in kilobytes or megabytes "
18849 "(eg. the parameter to L</memsize> is specified in megabytes already). "
18850 "Adding a suffix will probably not do what you expect."
18854 #: ../fish/guestfish.pod:604
18855 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18859 #: ../fish/guestfish.pod:606
18861 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18862 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18866 #: ../fish/guestfish.pod:609
18869 " 1234 decimal number 1234\n"
18870 " 02322 octal number, equivalent to decimal 1234\n"
18871 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18876 #: ../fish/guestfish.pod:613
18878 "When using the C<chmod> command, you almost always want to specify an octal "
18879 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18880 "L<chmod(1)> program):"
18884 #: ../fish/guestfish.pod:617
18887 " chmod 0777 /public # OK\n"
18888 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18893 #: ../fish/guestfish.pod:620
18895 "Commands that return numbers usually print them in decimal, but some "
18896 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18897 "octal, preceeded by C<0>)."
18901 #: ../fish/guestfish.pod:624
18902 msgid "WILDCARDS AND GLOBBING"
18906 #: ../fish/guestfish.pod:626
18908 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18909 "(globbing) by default. So for example the following will not do what you "
18914 #: ../fish/guestfish.pod:630
18922 #: ../fish/guestfish.pod:632
18924 "Assuming you don't have a directory called literally C</home/*> then the "
18925 "above command will return an error."
18929 #: ../fish/guestfish.pod:635
18930 msgid "To perform wildcard expansion, use the C<glob> command."
18934 #: ../fish/guestfish.pod:637
18937 " glob rm-rf /home/*\n"
18942 #: ../fish/guestfish.pod:639
18944 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18945 "many times), equivalent to:"
18949 #: ../fish/guestfish.pod:642
18952 " rm-rf /home/jim\n"
18953 " rm-rf /home/joe\n"
18954 " rm-rf /home/mary\n"
18959 #: ../fish/guestfish.pod:646
18960 msgid "C<glob> only works on simple guest paths and not on device names."
18964 #: ../fish/guestfish.pod:648
18966 "If you have several parameters, each containing a wildcard, then glob will "
18967 "perform a Cartesian product."
18971 #: ../fish/guestfish.pod:651
18976 #: ../fish/guestfish.pod:653
18978 "Any line which starts with a I<#> character is treated as a comment and "
18979 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18980 "a command. For example:"
18984 #: ../fish/guestfish.pod:657
18987 " # this is a comment\n"
18988 " # this is a comment\n"
18989 " foo # NOT a comment\n"
18994 #: ../fish/guestfish.pod:661
18995 msgid "Blank lines are also ignored."
18999 #: ../fish/guestfish.pod:663
19000 msgid "RUNNING COMMANDS LOCALLY"
19004 #: ../fish/guestfish.pod:665
19006 "Any line which starts with a I<!> character is treated as a command sent to "
19007 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
19011 #: ../fish/guestfish.pod:669
19015 " tgz-out /remote local/remote-data.tar.gz\n"
19020 #: ../fish/guestfish.pod:672
19022 "will create a directory C<local> on the host, and then export the contents "
19023 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
19024 "(See C<tgz-out>)."
19028 #: ../fish/guestfish.pod:676
19030 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
19031 "effect, due to the way that subprocesses work in Unix."
19035 #: ../fish/guestfish.pod:679
19040 #: ../fish/guestfish.pod:681
19042 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19043 "command (a guestfish command) to the second command (any host command). For "
19048 #: ../fish/guestfish.pod:685
19051 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19056 #: ../fish/guestfish.pod:687
19058 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19059 "program). The above command would list all accounts in the guest filesystem "
19060 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19064 #: ../fish/guestfish.pod:692
19067 " hexdump /bin/ls | head\n"
19068 " list-devices | tail -1\n"
19069 " tgz-out / - | tar ztf -\n"
19074 #: ../fish/guestfish.pod:696
19076 "The space before the pipe symbol is required, any space after the pipe "
19077 "symbol is optional. Everything after the pipe symbol is just passed "
19078 "straight to the host shell, so it can contain redirections, globs and "
19079 "anything else that makes sense on the host side."
19083 #: ../fish/guestfish.pod:701
19085 "To use a literal argument which begins with a pipe symbol, you have to quote "
19090 #: ../fish/guestfish.pod:704
19098 #: ../fish/guestfish.pod:706
19099 msgid "HOME DIRECTORIES"
19103 #: ../fish/guestfish.pod:708
19105 "If a parameter starts with the character C<~> then the tilde may be expanded "
19106 "as a home directory path (either C<~> for the current user's home directory, "
19107 "or C<~user> for another user)."
19111 #: ../fish/guestfish.pod:712
19113 "Note that home directory expansion happens for users known I<on the host>, "
19114 "not in the guest filesystem."
19118 #: ../fish/guestfish.pod:715
19120 "To use a literal argument which begins with a tilde, you have to quote it, "
19125 #: ../fish/guestfish.pod:718
19133 #: ../fish/guestfish.pod:722
19135 "Libguestfs has some support for Linux guests encrypted according to the "
19136 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19137 "disk encryption systems used by modern Linux guests. Currently only "
19138 "LVM-on-LUKS is supported."
19142 #: ../fish/guestfish.pod:727
19143 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19147 #: ../fish/guestfish.pod:729
19150 " ><fs> vfs-type /dev/sda2\n"
19156 #: ../fish/guestfish.pod:732
19158 "Then open those devices using L</luks-open>. This creates a device-mapper "
19159 "device called C</dev/mapper/luksdev>."
19163 #: ../fish/guestfish.pod:735
19166 " ><fs> luks-open /dev/sda2 luksdev\n"
19167 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19172 #: ../fish/guestfish.pod:738
19174 "Finally you have to tell LVM to scan for volume groups on the newly created "
19179 #: ../fish/guestfish.pod:741
19183 " vg-activate-all true\n"
19188 #: ../fish/guestfish.pod:744
19189 msgid "The logical volume(s) can now be mounted in the usual way."
19193 #: ../fish/guestfish.pod:746
19195 "Before closing a LUKS device you must unmount any logical volumes on it and "
19196 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19197 "one. Then you can close the mapper device:"
19201 #: ../fish/guestfish.pod:750
19204 " vg-activate false /dev/VG\n"
19205 " luks-close /dev/mapper/luksdev\n"
19210 #: ../fish/guestfish.pod:753
19211 msgid "WINDOWS PATHS"
19215 #: ../fish/guestfish.pod:755
19217 "If a path is prefixed with C<win:> then you can use Windows-style paths "
19218 "(with some limitations). The following commands are equivalent:"
19222 #: ../fish/guestfish.pod:758
19225 " file /WINDOWS/system32/config/system.LOG\n"
19230 #: ../fish/guestfish.pod:760
19233 " file win:/windows/system32/config/system.log\n"
19238 #: ../fish/guestfish.pod:762
19241 " file win:\\windows\\system32\\config\\system.log\n"
19246 #: ../fish/guestfish.pod:764
19249 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
19254 #: ../fish/guestfish.pod:766
19256 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
19257 "handles case insensitivity like Windows would. This only works in argument "
19258 "positions that expect a path."
19262 #: ../fish/guestfish.pod:770
19263 msgid "UPLOADING AND DOWNLOADING FILES"
19267 #: ../fish/guestfish.pod:772
19269 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19270 "others which upload from or download to a local file, you can use the "
19271 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19275 #: ../fish/guestfish.pod:776
19283 #: ../fish/guestfish.pod:778
19284 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19288 #: ../fish/guestfish.pod:781
19291 " tar-out /etc - | tar tf -\n"
19296 #: ../fish/guestfish.pod:783
19298 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19299 "command (see L</PIPES>)."
19303 #: ../fish/guestfish.pod:786
19305 "When using C<-> to read from stdin, the input is read up to the end of "
19306 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19307 "some arbitrary end marker:"
19311 #: ../fish/guestfish.pod:790
19314 " upload -<<END /foo\n"
19323 #: ../fish/guestfish.pod:796
19325 "Any string of characters can be used instead of C<END>. The end marker must "
19326 "appear on a line of its own, without any preceeding or following characters "
19327 "(not even spaces)."
19331 #: ../fish/guestfish.pod:800
19333 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19334 "upload local files (so-called \"FileIn\" parameters in the generator)."
19338 #: ../fish/guestfish.pod:803
19339 msgid "EXIT ON ERROR BEHAVIOUR"
19343 #: ../fish/guestfish.pod:805
19345 "By default, guestfish will ignore any errors when in interactive mode "
19346 "(ie. taking commands from a human over a tty), and will exit on the first "
19347 "error in non-interactive mode (scripts, commands given on the command line)."
19351 #: ../fish/guestfish.pod:810
19353 "If you prefix a command with a I<-> character, then that command will not "
19354 "cause guestfish to exit, even if that (one) command returns an error."
19358 #: ../fish/guestfish.pod:814
19359 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19363 #: ../fish/guestfish.pod:816
19365 "Guestfish can be remote-controlled over a socket. This is useful "
19366 "particularly in shell scripts where you want to make several different "
19367 "changes to a filesystem, but you don't want the overhead of starting up a "
19368 "guestfish process each time."
19372 #: ../fish/guestfish.pod:821
19373 msgid "Start a guestfish server process using:"
19377 #: ../fish/guestfish.pod:823
19380 " eval \"`guestfish --listen`\"\n"
19385 #: ../fish/guestfish.pod:825
19386 msgid "and then send it commands by doing:"
19390 #: ../fish/guestfish.pod:827
19393 " guestfish --remote cmd [...]\n"
19398 #: ../fish/guestfish.pod:829
19399 msgid "To cause the server to exit, send it the exit command:"
19403 #: ../fish/guestfish.pod:831
19406 " guestfish --remote exit\n"
19411 #: ../fish/guestfish.pod:833
19413 "Note that the server will normally exit if there is an error in a command. "
19414 "You can change this in the usual way. See section L</EXIT ON ERROR "
19419 #: ../fish/guestfish.pod:837
19420 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19424 #: ../fish/guestfish.pod:839
19426 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19427 "is how the I<--remote> option knows where to send the commands. You can "
19428 "have several guestfish listener processes running using:"
19432 #: ../fish/guestfish.pod:843
19435 " eval \"`guestfish --listen`\"\n"
19436 " pid1=$GUESTFISH_PID\n"
19437 " eval \"`guestfish --listen`\"\n"
19438 " pid2=$GUESTFISH_PID\n"
19440 " guestfish --remote=$pid1 cmd\n"
19441 " guestfish --remote=$pid2 cmd\n"
19446 #: ../fish/guestfish.pod:851
19447 msgid "REMOTE CONTROL AND CSH"
19451 #: ../fish/guestfish.pod:853
19453 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19458 #: ../fish/guestfish.pod:856
19461 " eval \"`guestfish --listen --csh`\"\n"
19466 #: ../fish/guestfish.pod:858
19467 msgid "REMOTE CONTROL DETAILS"
19471 #: ../fish/guestfish.pod:860
19473 "Remote control happens over a Unix domain socket called "
19474 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19475 "of the process, and C<$PID> is the process ID of the server."
19479 #: ../fish/guestfish.pod:864
19480 msgid "Guestfish client and server versions must match exactly."
19484 #: ../fish/guestfish.pod:866
19485 msgid "PREPARED DISK IMAGES"
19489 #: ../fish/guestfish.pod:868
19491 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19492 "preformatted disk images that guestfish can make for you to save typing. "
19493 "This is particularly useful for testing purposes. This option is used "
19494 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19495 "can be mixed with I<-a>)."
19499 #: ../fish/guestfish.pod:874
19501 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19502 "the second and so on. Existing files in the current directory are "
19507 #: ../fish/guestfish.pod:878
19509 "The type briefly describes how the disk should be sized, partitioned, how "
19510 "filesystem(s) should be created, and how content should be added. "
19511 "Optionally the type can be followed by extra parameters, separated by C<:> "
19512 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19513 "sparsely-allocated disk, containing a single partition, with the partition "
19514 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19515 "on a 1GB disk instead."
19519 #: ../fish/guestfish.pod:886
19520 msgid "To list the available types and any extra parameters they take, run:"
19524 #: ../fish/guestfish.pod:890
19526 "Note that the prepared filesystem is not mounted. You would usually have to "
19527 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19531 #: ../fish/guestfish.pod:894
19533 "If any I<-N> or I<--new> options are given, the guest is automatically "
19538 #: ../fish/guestfish.pod:899
19539 msgid "Create a 100MB disk with an ext4-formatted partition:"
19543 #: ../fish/guestfish.pod:901
19546 " guestfish -N fs:ext4\n"
19551 #: ../fish/guestfish.pod:903
19552 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19556 #: ../fish/guestfish.pod:905
19559 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19564 #: ../fish/guestfish.pod:907
19565 msgid "Create a blank 200MB disk:"
19569 #: ../fish/guestfish.pod:909
19572 " guestfish -N disk:200M\n"
19577 #: ../fish/guestfish.pod:911
19578 msgid "PROGRESS BARS"
19582 #: ../fish/guestfish.pod:913
19584 "Some (not all) long-running commands send progress notification messages as "
19585 "they are running. Guestfish turns these messages into progress bars."
19589 #: ../fish/guestfish.pod:917
19591 "When a command that supports progress bars takes longer than two seconds to "
19592 "run, and if progress bars are enabled, then you will see one appearing below "
19597 #: ../fish/guestfish.pod:921
19600 " ><fs> copy-size /large-file /another-file 2048M\n"
19601 " / 10% [#####-----------------------------------------] 00:30\n"
19606 #: ../fish/guestfish.pod:924
19608 "The spinner on the left hand side moves round once for every progress "
19609 "notification received from the backend. This is a (reasonably) golden "
19610 "assurance that the command is \"doing something\" even if the progress bar "
19611 "is not moving, because the command is able to send the progress "
19612 "notifications. When the bar reaches 100% and the command finishes, the "
19613 "spinner disappears."
19617 #: ../fish/guestfish.pod:931
19619 "Progress bars are enabled by default when guestfish is used interactively. "
19620 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19621 "and you can disable them completely using I<--no-progress-bars>."
19625 #: ../fish/guestfish.pod:936
19626 msgid "GUESTFISH COMMANDS"
19630 #: ../fish/guestfish.pod:938
19632 "The commands in this section are guestfish convenience commands, in other "
19633 "words, they are not part of the L<guestfs(3)> API."
19637 #: ../fish/guestfish.pod:941
19642 #: ../fish/guestfish.pod:943
19651 #: ../fish/guestfish.pod:946
19652 msgid "Without any parameter, this provides general help."
19656 #: ../fish/guestfish.pod:948
19657 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19661 #: ../fish/guestfish.pod:950
19662 msgid "quit | exit"
19666 #: ../fish/guestfish.pod:952
19667 msgid "This exits guestfish. You can also use C<^D> key."
19671 #: ../fish/guestfish.pod:954
19672 msgid "@FISH_COMMANDS@"
19676 #: ../fish/guestfish.pod:956
19681 #: ../fish/guestfish.pod:960 ../test-tool/libguestfs-test-tool.pod:83
19686 #: ../fish/guestfish.pod:962
19688 "guestfish returns 0 if the commands completed without error, or 1 if there "
19693 #: ../fish/guestfish.pod:969
19698 #: ../fish/guestfish.pod:971
19700 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19705 #: ../fish/guestfish.pod:974
19706 msgid "GUESTFISH_PID"
19710 #: ../fish/guestfish.pod:976
19712 "Used with the I<--remote> option to specify the remote guestfish process to "
19713 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19717 #: ../fish/guestfish.pod:980
19722 #: ../fish/guestfish.pod:982
19724 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19725 "not specified, the external L<hexedit(1)> program is used."
19729 #: ../fish/guestfish.pod:986
19734 #: ../fish/guestfish.pod:988
19736 "If compiled with GNU readline support, various files in the home directory "
19737 "can be used. See L</FILES>."
19741 #: ../fish/guestfish.pod:997
19743 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19744 "effect as using the B<-v> option."
19748 #: ../fish/guestfish.pod:1009
19750 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19751 "the discussion of paths in L<guestfs(3)>."
19755 #: ../fish/guestfish.pod:1020
19756 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19760 #: ../fish/guestfish.pod:1022
19765 #: ../fish/guestfish.pod:1024
19767 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19772 #: ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:88
19777 #: ../fish/guestfish.pod:1043
19778 msgid "$HOME/.guestfish"
19782 #: ../fish/guestfish.pod:1045
19784 "If compiled with GNU readline support, then the command history is saved in "
19789 #: ../fish/guestfish.pod:1048
19790 msgid "$HOME/.inputrc"
19794 #: ../fish/guestfish.pod:1050
19795 msgid "/etc/inputrc"
19799 #: ../fish/guestfish.pod:1052
19801 "If compiled with GNU readline support, then these files can be used to "
19802 "configure readline. For further information, please see "
19803 "L<readline(3)/INITIALIZATION FILE>."
19807 #: ../fish/guestfish.pod:1056
19808 msgid "To write rules which only apply to guestfish, use:"
19812 #: ../fish/guestfish.pod:1058
19822 #: ../fish/guestfish.pod:1062
19824 "Variables that you can set in inputrc that change the behaviour of guestfish "
19825 "in useful ways include:"
19829 #: ../fish/guestfish.pod:1067
19830 msgid "completion-ignore-case (default: on)"
19834 #: ../fish/guestfish.pod:1069
19836 "By default, guestfish will ignore case when tab-completing paths on the "
19841 #: ../fish/guestfish.pod:1072
19844 " set completion-ignore-case off\n"
19849 #: ../fish/guestfish.pod:1074
19850 msgid "to make guestfish case sensitive."
19854 #: ../fish/guestfish.pod:1078
19859 #: ../fish/guestfish.pod:1080
19860 msgid "test2.img (etc)"
19864 #: ../fish/guestfish.pod:1082
19866 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19867 "will be created in the file C<test1.img> in the current directory. The "
19868 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19869 "the same name will be overwritten."
19873 #: ../fish/guestfish.pod:1091
19875 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19876 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
19877 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
19878 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
19879 "L<virt-win-reg(1)>, L<hexedit(1)>."
19883 #: ../fish/guestfish.pod:1117 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:415 ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
19885 "This program is free software; you can redistribute it and/or modify it "
19886 "under the terms of the GNU General Public License as published by the Free "
19887 "Software Foundation; either version 2 of the License, or (at your option) "
19888 "any later version."
19892 #: ../fish/guestfish.pod:1122 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:420 ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1517 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
19894 "This program is distributed in the hope that it will be useful, but WITHOUT "
19895 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19896 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19901 #: ../fish/guestfish.pod:1127 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:425 ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1522 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
19903 "You should have received a copy of the GNU General Public License along with "
19904 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19905 "Ave, Cambridge, MA 02139, USA."
19909 #: ../fish/guestfish-actions.pod:1
19914 #: ../fish/guestfish-actions.pod:3
19917 " add-cdrom filename\n"
19922 #: ../fish/guestfish-actions.pod:15
19924 "This call checks for the existence of C<filename>. This stops you from "
19925 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19926 "and C<http:> URLs. To specify those, use the general L</config> call "
19931 #: ../fish/guestfish-actions.pod:22
19933 "If you just want to add an ISO file (often you use this as an efficient way "
19934 "to transfer large files into the guest), then you should probably use "
19935 "L</add-drive-ro> instead."
19939 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
19941 "This function is deprecated. In new code, use the L</add_drive_opts> call "
19946 #: ../fish/guestfish-actions.pod:35
19951 #: ../fish/guestfish-actions.pod:37
19956 #: ../fish/guestfish-actions.pod:39
19959 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19964 #: ../fish/guestfish-actions.pod:41
19966 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19967 "It works by connecting to libvirt, requesting the domain and domain XML from "
19968 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19972 #: ../fish/guestfish-actions.pod:64
19974 "The other optional parameters are passed directly through to "
19975 "L</add-drive-opts>."
19979 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131 ../fish/guestfish-actions.pod:2845
19981 "This command has one or more optional arguments. See L</OPTIONAL "
19986 #: ../fish/guestfish-actions.pod:69
19991 #: ../fish/guestfish-actions.pod:71
19994 " add-drive filename\n"
19999 #: ../fish/guestfish-actions.pod:73
20001 "This function is the equivalent of calling L</add-drive-opts> with no "
20002 "optional parameters, so the disk is added writable, with the format being "
20003 "detected automatically."
20007 #: ../fish/guestfish-actions.pod:77
20009 "Automatic detection of the format opens you up to a potential security hole "
20010 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
20011 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
20012 "you should think about replacing calls to this function with calls to "
20013 "L</add-drive-opts>, and specifying the format."
20017 #: ../fish/guestfish-actions.pod:84
20018 msgid "add-drive-opts"
20022 #: ../fish/guestfish-actions.pod:86
20027 #: ../fish/guestfish-actions.pod:88
20030 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
20035 #: ../fish/guestfish-actions.pod:115
20037 "This forces the image format. If you omit this (or use L</add-drive> or "
20038 "L</add-drive-ro>) then the format is automatically detected. Possible "
20039 "formats include C<raw> and C<qcow2>."
20043 #: ../fish/guestfish-actions.pod:126
20045 "This rarely-used option lets you emulate the behaviour of the deprecated "
20046 "L</add-drive-with-if> call (q.v.)"
20050 #: ../fish/guestfish-actions.pod:133
20051 msgid "add-drive-ro"
20055 #: ../fish/guestfish-actions.pod:135
20060 #: ../fish/guestfish-actions.pod:137
20063 " add-drive-ro filename\n"
20068 #: ../fish/guestfish-actions.pod:139
20070 "This function is the equivalent of calling L</add-drive-opts> with the "
20071 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20072 "is added read-only, with the format being detected automatically."
20076 #: ../fish/guestfish-actions.pod:144
20077 msgid "add-drive-ro-with-if"
20081 #: ../fish/guestfish-actions.pod:146
20084 " add-drive-ro-with-if filename iface\n"
20089 #: ../fish/guestfish-actions.pod:148
20091 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
20092 "interface emulation to use at run time."
20096 #: ../fish/guestfish-actions.pod:158
20097 msgid "add-drive-with-if"
20101 #: ../fish/guestfish-actions.pod:160
20104 " add-drive-with-if filename iface\n"
20109 #: ../fish/guestfish-actions.pod:162
20111 "This is the same as L</add-drive> but it allows you to specify the QEMU "
20112 "interface emulation to use at run time."
20116 #: ../fish/guestfish-actions.pod:172
20121 #: ../fish/guestfish-actions.pod:174
20124 " aug-clear augpath\n"
20129 #: ../fish/guestfish-actions.pod:179
20134 #: ../fish/guestfish-actions.pod:181
20142 #: ../fish/guestfish-actions.pod:183
20144 "Close the current Augeas handle and free up any resources used by it. After "
20145 "calling this, you have to call L</aug-init> again before you can use any "
20146 "other Augeas functions."
20150 #: ../fish/guestfish-actions.pod:188
20151 msgid "aug-defnode"
20155 #: ../fish/guestfish-actions.pod:190
20158 " aug-defnode name expr val\n"
20163 #: ../fish/guestfish-actions.pod:195
20165 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
20166 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
20167 "containing that single node."
20171 #: ../fish/guestfish-actions.pod:203
20176 #: ../fish/guestfish-actions.pod:205
20179 " aug-defvar name expr\n"
20184 #: ../fish/guestfish-actions.pod:214
20189 #: ../fish/guestfish-actions.pod:216
20192 " aug-get augpath\n"
20197 #: ../fish/guestfish-actions.pod:221
20202 #: ../fish/guestfish-actions.pod:223
20205 " aug-init root flags\n"
20210 #: ../fish/guestfish-actions.pod:229
20211 msgid "You must call this before using any other L</aug-*> commands."
20215 #: ../fish/guestfish-actions.pod:264
20216 msgid "Do not load the tree in L</aug-init>."
20220 #: ../fish/guestfish-actions.pod:268
20221 msgid "To close the handle, you can call L</aug-close>."
20225 #: ../fish/guestfish-actions.pod:272
20230 #: ../fish/guestfish-actions.pod:274
20233 " aug-insert augpath label true|false\n"
20238 #: ../fish/guestfish-actions.pod:284
20243 #: ../fish/guestfish-actions.pod:286
20251 #: ../fish/guestfish-actions.pod:293
20256 #: ../fish/guestfish-actions.pod:295
20259 " aug-ls augpath\n"
20264 #: ../fish/guestfish-actions.pod:297
20266 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
20267 "resulting nodes into alphabetical order."
20271 #: ../fish/guestfish-actions.pod:300
20276 #: ../fish/guestfish-actions.pod:302
20279 " aug-match augpath\n"
20284 #: ../fish/guestfish-actions.pod:308
20289 #: ../fish/guestfish-actions.pod:310
20292 " aug-mv src dest\n"
20297 #: ../fish/guestfish-actions.pod:315
20302 #: ../fish/guestfish-actions.pod:317
20305 " aug-rm augpath\n"
20310 #: ../fish/guestfish-actions.pod:323
20315 #: ../fish/guestfish-actions.pod:325
20323 #: ../fish/guestfish-actions.pod:329
20325 "The flags which were passed to L</aug-init> affect exactly how files are "
20330 #: ../fish/guestfish-actions.pod:332
20335 #: ../fish/guestfish-actions.pod:334
20338 " aug-set augpath val\n"
20343 #: ../fish/guestfish-actions.pod:338
20345 "In the Augeas API, it is possible to clear a node by setting the value to "
20346 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
20347 "this call. Instead you must use the L</aug-clear> call."
20351 #: ../fish/guestfish-actions.pod:343
20356 #: ../fish/guestfish-actions.pod:345
20359 " available 'groups ...'\n"
20364 #: ../fish/guestfish-actions.pod:351
20366 "The libguestfs groups, and the functions that those groups correspond to, "
20367 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
20368 "runtime by calling L</available-all-groups>."
20372 #: ../fish/guestfish-actions.pod:375
20373 msgid "You must call L</launch> before calling this function."
20377 #: ../fish/guestfish-actions.pod:397
20379 "This call was added in version C<1.0.80>. In previous versions of "
20380 "libguestfs all you could do would be to speculatively execute a command to "
20381 "find out if the daemon implemented it. See also L</version>."
20385 #: ../fish/guestfish-actions.pod:404
20386 msgid "available-all-groups"
20390 #: ../fish/guestfish-actions.pod:406
20393 " available-all-groups\n"
20398 #: ../fish/guestfish-actions.pod:408
20400 "This command returns a list of all optional groups that this daemon knows "
20401 "about. Note this returns both supported and unsupported groups. To find "
20402 "out which ones the daemon can actually support you have to call "
20403 "L</available> on each member of the returned list."
20407 #: ../fish/guestfish-actions.pod:414
20408 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
20412 #: ../fish/guestfish-actions.pod:416
20417 #: ../fish/guestfish-actions.pod:418
20420 " base64-in (base64file|-) filename\n"
20425 #: ../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:1218 ../fish/guestfish-actions.pod:4209 ../fish/guestfish-actions.pod:4221 ../fish/guestfish-actions.pod:4232 ../fish/guestfish-actions.pod:4243 ../fish/guestfish-actions.pod:4295 ../fish/guestfish-actions.pod:4304 ../fish/guestfish-actions.pod:4358 ../fish/guestfish-actions.pod:4381
20426 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
20430 #: ../fish/guestfish-actions.pod:425
20435 #: ../fish/guestfish-actions.pod:427
20438 " base64-out filename (base64file|-)\n"
20443 #: ../fish/guestfish-actions.pod:434
20444 msgid "blockdev-flushbufs"
20448 #: ../fish/guestfish-actions.pod:436
20451 " blockdev-flushbufs device\n"
20456 #: ../fish/guestfish-actions.pod:443
20457 msgid "blockdev-getbsz"
20461 #: ../fish/guestfish-actions.pod:445
20464 " blockdev-getbsz device\n"
20469 #: ../fish/guestfish-actions.pod:454
20470 msgid "blockdev-getro"
20474 #: ../fish/guestfish-actions.pod:456
20477 " blockdev-getro device\n"
20482 #: ../fish/guestfish-actions.pod:463
20483 msgid "blockdev-getsize64"
20487 #: ../fish/guestfish-actions.pod:465
20490 " blockdev-getsize64 device\n"
20495 #: ../fish/guestfish-actions.pod:469
20496 msgid "See also L</blockdev-getsz>."
20500 #: ../fish/guestfish-actions.pod:473
20501 msgid "blockdev-getss"
20505 #: ../fish/guestfish-actions.pod:475
20508 " blockdev-getss device\n"
20513 #: ../fish/guestfish-actions.pod:480
20514 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
20518 #: ../fish/guestfish-actions.pod:485
20519 msgid "blockdev-getsz"
20523 #: ../fish/guestfish-actions.pod:487
20526 " blockdev-getsz device\n"
20531 #: ../fish/guestfish-actions.pod:492
20533 "See also L</blockdev-getss> for the real sector size of the device, and "
20534 "L</blockdev-getsize64> for the more useful I<size in bytes>."
20538 #: ../fish/guestfish-actions.pod:498
20539 msgid "blockdev-rereadpt"
20543 #: ../fish/guestfish-actions.pod:500
20546 " blockdev-rereadpt device\n"
20551 #: ../fish/guestfish-actions.pod:506
20552 msgid "blockdev-setbsz"
20556 #: ../fish/guestfish-actions.pod:508
20559 " blockdev-setbsz device blocksize\n"
20564 #: ../fish/guestfish-actions.pod:517
20565 msgid "blockdev-setro"
20569 #: ../fish/guestfish-actions.pod:519
20572 " blockdev-setro device\n"
20577 #: ../fish/guestfish-actions.pod:525
20578 msgid "blockdev-setrw"
20582 #: ../fish/guestfish-actions.pod:527
20585 " blockdev-setrw device\n"
20590 #: ../fish/guestfish-actions.pod:533
20591 msgid "case-sensitive-path"
20595 #: ../fish/guestfish-actions.pod:535
20598 " case-sensitive-path path\n"
20603 #: ../fish/guestfish-actions.pod:559
20605 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
20606 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
20607 "how the directories were originally created under Windows)."
20611 #: ../fish/guestfish-actions.pod:567
20612 msgid "See also L</realpath>."
20616 #: ../fish/guestfish-actions.pod:569
20621 #: ../fish/guestfish-actions.pod:571
20629 #: ../fish/guestfish-actions.pod:575
20631 "Note that this function cannot correctly handle binary files (specifically, "
20632 "files containing C<\\0> character which is treated as end of string). For "
20633 "those you need to use the L</read-file> or L</download> functions which have "
20634 "a more complex interface."
20638 #: ../fish/guestfish-actions.pod:583
20643 #: ../fish/guestfish-actions.pod:585
20646 " checksum csumtype path\n"
20651 #: ../fish/guestfish-actions.pod:628
20652 msgid "To get the checksum for a device, use L</checksum-device>."
20656 #: ../fish/guestfish-actions.pod:630
20657 msgid "To get the checksums for many files, use L</checksums-out>."
20661 #: ../fish/guestfish-actions.pod:632
20662 msgid "checksum-device"
20666 #: ../fish/guestfish-actions.pod:634
20669 " checksum-device csumtype device\n"
20674 #: ../fish/guestfish-actions.pod:636
20676 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20677 "device named C<device>. For the types of checksums supported see the "
20678 "L</checksum> command."
20682 #: ../fish/guestfish-actions.pod:640
20683 msgid "checksums-out"
20687 #: ../fish/guestfish-actions.pod:642
20690 " checksums-out csumtype directory (sumsfile|-)\n"
20695 #: ../fish/guestfish-actions.pod:658
20700 #: ../fish/guestfish-actions.pod:660
20703 " chmod mode path\n"
20708 #: ../fish/guestfish-actions.pod:671
20713 #: ../fish/guestfish-actions.pod:673
20716 " chown owner group path\n"
20721 #: ../fish/guestfish-actions.pod:681
20726 #: ../fish/guestfish-actions.pod:683
20729 " command 'arguments ...'\n"
20734 #: ../fish/guestfish-actions.pod:690
20736 "The single parameter is an argv-style list of arguments. The first element "
20737 "is the name of the program to run. Subsequent elements are parameters. The "
20738 "list must be non-empty (ie. must contain a program name). Note that the "
20739 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20743 #: ../fish/guestfish-actions.pod:718
20744 msgid "command-lines"
20748 #: ../fish/guestfish-actions.pod:720
20751 " command-lines 'arguments ...'\n"
20756 #: ../fish/guestfish-actions.pod:722
20757 msgid "This is the same as L</command>, but splits the result into a list of lines."
20761 #: ../fish/guestfish-actions.pod:725
20762 msgid "See also: L</sh-lines>"
20766 #: ../fish/guestfish-actions.pod:730
20771 #: ../fish/guestfish-actions.pod:732
20774 " config qemuparam qemuvalue\n"
20779 #: ../fish/guestfish-actions.pod:743
20784 #: ../fish/guestfish-actions.pod:745
20787 " copy-size src dest size\n"
20792 #: ../fish/guestfish-actions.pod:753
20797 #: ../fish/guestfish-actions.pod:755
20805 #: ../fish/guestfish-actions.pod:760
20810 #: ../fish/guestfish-actions.pod:762
20818 #: ../fish/guestfish-actions.pod:767
20823 #: ../fish/guestfish-actions.pod:769
20831 #: ../fish/guestfish-actions.pod:776
20833 "If the destination is a device, it must be as large or larger than the "
20834 "source file or device, otherwise the copy will fail. This command cannot do "
20835 "partial copies (see L</copy-size>)."
20839 #: ../fish/guestfish-actions.pod:780
20844 #: ../fish/guestfish-actions.pod:782
20852 #: ../fish/guestfish-actions.pod:786 ../fish/guestfish-actions.pod:797
20854 "This command is mostly useful for interactive sessions. It is I<not> "
20855 "intended that you try to parse the output string. Use L</statvfs> from "
20860 #: ../fish/guestfish-actions.pod:790
20865 #: ../fish/guestfish-actions.pod:792
20873 #: ../fish/guestfish-actions.pod:801
20878 #: ../fish/guestfish-actions.pod:803
20886 #: ../fish/guestfish-actions.pod:809
20888 "Another way to get the same information is to enable verbose messages with "
20889 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20890 "before running the program."
20894 #: ../fish/guestfish-actions.pod:814
20899 #: ../fish/guestfish-actions.pod:816
20902 " download remotefilename (filename|-)\n"
20907 #: ../fish/guestfish-actions.pod:823
20908 msgid "See also L</upload>, L</cat>."
20912 #: ../fish/guestfish-actions.pod:827
20913 msgid "download-offset"
20917 #: ../fish/guestfish-actions.pod:829
20920 " download-offset remotefilename (filename|-) offset size\n"
20925 #: ../fish/guestfish-actions.pod:837
20927 "Note that there is no limit on the amount of data that can be downloaded "
20928 "with this call, unlike with L</pread>, and this call always reads the full "
20929 "amount unless an error occurs."
20933 #: ../fish/guestfish-actions.pod:842
20934 msgid "See also L</download>, L</pread>."
20938 #: ../fish/guestfish-actions.pod:846
20939 msgid "drop-caches"
20943 #: ../fish/guestfish-actions.pod:848
20946 " drop-caches whattodrop\n"
20951 #: ../fish/guestfish-actions.pod:860
20956 #: ../fish/guestfish-actions.pod:862
20964 #: ../fish/guestfish-actions.pod:874
20969 #: ../fish/guestfish-actions.pod:876
20972 " e2fsck-f device\n"
20977 #: ../fish/guestfish-actions.pod:882
20979 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20980 "should use L</fsck>."
20984 #: ../fish/guestfish-actions.pod:885
20985 msgid "echo-daemon"
20989 #: ../fish/guestfish-actions.pod:887
20992 " echo-daemon 'words ...'\n"
20997 #: ../fish/guestfish-actions.pod:894
20998 msgid "See also L</ping-daemon>."
21002 #: ../fish/guestfish-actions.pod:896
21007 #: ../fish/guestfish-actions.pod:898
21010 " egrep regex path\n"
21015 #: ../fish/guestfish-actions.pod:906
21020 #: ../fish/guestfish-actions.pod:908
21023 " egrepi regex path\n"
21028 #: ../fish/guestfish-actions.pod:916
21033 #: ../fish/guestfish-actions.pod:918
21036 " equal file1 file2\n"
21041 #: ../fish/guestfish-actions.pod:925
21046 #: ../fish/guestfish-actions.pod:927
21054 #: ../fish/guestfish-actions.pod:932
21055 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21059 #: ../fish/guestfish-actions.pod:934
21064 #: ../fish/guestfish-actions.pod:936
21067 " fallocate path len\n"
21072 #: ../fish/guestfish-actions.pod:946
21074 "This function is deprecated. In new code, use the L</fallocate64> call "
21079 #: ../fish/guestfish-actions.pod:953
21080 msgid "fallocate64"
21084 #: ../fish/guestfish-actions.pod:955
21087 " fallocate64 path len\n"
21092 #: ../fish/guestfish-actions.pod:961
21094 "Note that this call allocates disk blocks for the file. To create a sparse "
21095 "file use L</truncate-size> instead."
21099 #: ../fish/guestfish-actions.pod:964
21101 "The deprecated call L</fallocate> does the same, but owing to an oversight "
21102 "it only allowed 30 bit lengths to be specified, effectively limiting the "
21103 "maximum size of files created through that call to 1GB."
21107 #: ../fish/guestfish-actions.pod:973
21112 #: ../fish/guestfish-actions.pod:975
21115 " fgrep pattern path\n"
21120 #: ../fish/guestfish-actions.pod:983
21125 #: ../fish/guestfish-actions.pod:985
21128 " fgrepi pattern path\n"
21133 #: ../fish/guestfish-actions.pod:993
21138 #: ../fish/guestfish-actions.pod:995
21146 #: ../fish/guestfish-actions.pod:1011
21148 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
21153 #: ../fish/guestfish-actions.pod:1014
21154 msgid "file-architecture"
21158 #: ../fish/guestfish-actions.pod:1016
21161 " file-architecture filename\n"
21166 #: ../fish/guestfish-actions.pod:1119
21171 #: ../fish/guestfish-actions.pod:1121
21179 #: ../fish/guestfish-actions.pod:1125
21181 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
21182 "L</is-file> etc. To get the size of block devices, use "
21183 "L</blockdev-getsize64>."
21187 #: ../fish/guestfish-actions.pod:1129
21192 #: ../fish/guestfish-actions.pod:1131
21195 " fill c len path\n"
21200 #: ../fish/guestfish-actions.pod:1137
21202 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
21203 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
21204 "L</fill-pattern>."
21208 #: ../fish/guestfish-actions.pod:1142
21209 msgid "fill-pattern"
21213 #: ../fish/guestfish-actions.pod:1144
21216 " fill-pattern pattern len path\n"
21221 #: ../fish/guestfish-actions.pod:1146
21223 "This function is like L</fill> except that it creates a new file of length "
21224 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
21225 "is truncated if necessary to ensure the length of the file is exactly C<len> "
21230 #: ../fish/guestfish-actions.pod:1151
21235 #: ../fish/guestfish-actions.pod:1153
21238 " find directory\n"
21243 #: ../fish/guestfish-actions.pod:1167
21244 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
21248 #: ../fish/guestfish-actions.pod:1180
21249 msgid "See also L</find0>."
21253 #: ../fish/guestfish-actions.pod:1185
21258 #: ../fish/guestfish-actions.pod:1187
21261 " find0 directory (files|-)\n"
21266 #: ../fish/guestfish-actions.pod:1193
21267 msgid "This command works the same way as L</find> with the following exceptions:"
21271 #: ../fish/guestfish-actions.pod:1220
21272 msgid "findfs-label"
21276 #: ../fish/guestfish-actions.pod:1222
21279 " findfs-label label\n"
21284 #: ../fish/guestfish-actions.pod:1228
21285 msgid "To find the label of a filesystem, use L</vfs-label>."
21289 #: ../fish/guestfish-actions.pod:1230
21290 msgid "findfs-uuid"
21294 #: ../fish/guestfish-actions.pod:1232
21297 " findfs-uuid uuid\n"
21302 #: ../fish/guestfish-actions.pod:1238
21303 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
21307 #: ../fish/guestfish-actions.pod:1240
21312 #: ../fish/guestfish-actions.pod:1242
21315 " fsck fstype device\n"
21320 #: ../fish/guestfish-actions.pod:1272
21325 #: ../fish/guestfish-actions.pod:1274
21333 #: ../fish/guestfish-actions.pod:1281
21334 msgid "get-autosync"
21338 #: ../fish/guestfish-actions.pod:1283
21346 #: ../fish/guestfish-actions.pod:1287
21351 #: ../fish/guestfish-actions.pod:1289
21359 #: ../fish/guestfish-actions.pod:1293
21360 msgid "get-e2label"
21364 #: ../fish/guestfish-actions.pod:1295
21367 " get-e2label device\n"
21372 #: ../fish/guestfish-actions.pod:1300
21374 "This function is deprecated. In new code, use the L</vfs_label> call "
21379 #: ../fish/guestfish-actions.pod:1307
21384 #: ../fish/guestfish-actions.pod:1309
21387 " get-e2uuid device\n"
21392 #: ../fish/guestfish-actions.pod:1314
21394 "This function is deprecated. In new code, use the L</vfs_uuid> call "
21399 #: ../fish/guestfish-actions.pod:1321
21400 msgid "get-memsize"
21404 #: ../fish/guestfish-actions.pod:1323
21412 #: ../fish/guestfish-actions.pod:1328
21414 "If L</set-memsize> was not called on this handle, and if "
21415 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
21416 "value for memsize."
21420 #: ../fish/guestfish-actions.pod:1335
21421 msgid "get-network"
21425 #: ../fish/guestfish-actions.pod:1337
21433 #: ../fish/guestfish-actions.pod:1341
21438 #: ../fish/guestfish-actions.pod:1343
21446 #: ../fish/guestfish-actions.pod:1350
21451 #: ../fish/guestfish-actions.pod:1352
21456 #: ../fish/guestfish-actions.pod:1354
21464 #: ../fish/guestfish-actions.pod:1361
21469 #: ../fish/guestfish-actions.pod:1363
21477 #: ../fish/guestfish-actions.pod:1370
21478 msgid "get-recovery-proc"
21482 #: ../fish/guestfish-actions.pod:1372
21485 " get-recovery-proc\n"
21490 #: ../fish/guestfish-actions.pod:1376
21491 msgid "get-selinux"
21495 #: ../fish/guestfish-actions.pod:1378
21503 #: ../fish/guestfish-actions.pod:1380
21505 "This returns the current setting of the selinux flag which is passed to the "
21506 "appliance at boot time. See L</set-selinux>."
21510 #: ../fish/guestfish-actions.pod:1386
21515 #: ../fish/guestfish-actions.pod:1388
21523 #: ../fish/guestfish-actions.pod:1395
21528 #: ../fish/guestfish-actions.pod:1397
21536 #: ../fish/guestfish-actions.pod:1401
21541 #: ../fish/guestfish-actions.pod:1403
21549 #: ../fish/guestfish-actions.pod:1405
21551 "Return the current umask. By default the umask is C<022> unless it has been "
21552 "set by calling L</umask>."
21556 #: ../fish/guestfish-actions.pod:1408
21557 msgid "get-verbose"
21561 #: ../fish/guestfish-actions.pod:1410
21569 #: ../fish/guestfish-actions.pod:1414
21574 #: ../fish/guestfish-actions.pod:1416
21582 #: ../fish/guestfish-actions.pod:1420
21583 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
21587 #: ../fish/guestfish-actions.pod:1423
21592 #: ../fish/guestfish-actions.pod:1425
21595 " getxattr path name\n"
21600 #: ../fish/guestfish-actions.pod:1427
21602 "Get a single extended attribute from file C<path> named C<name>. This call "
21603 "follows symlinks. If you want to lookup an extended attribute for the "
21604 "symlink itself, use L</lgetxattr>."
21608 #: ../fish/guestfish-actions.pod:1431 ../fish/guestfish-actions.pod:2262
21610 "Normally it is better to get all extended attributes from a file in one go "
21611 "by calling L</getxattrs>. However some Linux filesystem implementations are "
21612 "buggy and do not provide a way to list out attributes. For these "
21613 "filesystems (notably ntfs-3g) you have to know the names of the extended "
21614 "attributes you want in advance and call this function."
21618 #: ../fish/guestfish-actions.pod:1441
21619 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
21623 #: ../fish/guestfish-actions.pod:1443
21628 #: ../fish/guestfish-actions.pod:1445
21631 " getxattrs path\n"
21636 #: ../fish/guestfish-actions.pod:1453
21637 msgid "See also: L</lgetxattrs>, L<attr(5)>."
21641 #: ../fish/guestfish-actions.pod:1455
21642 msgid "glob-expand"
21646 #: ../fish/guestfish-actions.pod:1457
21649 " glob-expand pattern\n"
21654 #: ../fish/guestfish-actions.pod:1470
21659 #: ../fish/guestfish-actions.pod:1472
21662 " grep regex path\n"
21667 #: ../fish/guestfish-actions.pod:1480
21672 #: ../fish/guestfish-actions.pod:1482
21675 " grepi regex path\n"
21680 #: ../fish/guestfish-actions.pod:1490
21681 msgid "grub-install"
21685 #: ../fish/guestfish-actions.pod:1492
21688 " grub-install root device\n"
21693 #: ../fish/guestfish-actions.pod:1508
21698 #: ../fish/guestfish-actions.pod:1510
21706 #: ../fish/guestfish-actions.pod:1518
21711 #: ../fish/guestfish-actions.pod:1520
21714 " head-n nrlines path\n"
21719 #: ../fish/guestfish-actions.pod:1533
21724 #: ../fish/guestfish-actions.pod:1535
21732 #: ../fish/guestfish-actions.pod:1543
21737 #: ../fish/guestfish-actions.pod:1545
21740 " initrd-cat initrdpath filename\n"
21745 #: ../fish/guestfish-actions.pod:1557
21746 msgid "See also L</initrd-list>."
21750 #: ../fish/guestfish-actions.pod:1562
21751 msgid "initrd-list"
21755 #: ../fish/guestfish-actions.pod:1564
21758 " initrd-list path\n"
21763 #: ../fish/guestfish-actions.pod:1576
21764 msgid "inotify-add-watch"
21768 #: ../fish/guestfish-actions.pod:1578
21771 " inotify-add-watch path mask\n"
21776 #: ../fish/guestfish-actions.pod:1590
21777 msgid "inotify-close"
21781 #: ../fish/guestfish-actions.pod:1592
21789 #: ../fish/guestfish-actions.pod:1598
21790 msgid "inotify-files"
21794 #: ../fish/guestfish-actions.pod:1600
21802 #: ../fish/guestfish-actions.pod:1602
21804 "This function is a helpful wrapper around L</inotify-read> which just "
21805 "returns a list of pathnames of objects that were touched. The returned "
21806 "pathnames are sorted and deduplicated."
21810 #: ../fish/guestfish-actions.pod:1606
21811 msgid "inotify-init"
21815 #: ../fish/guestfish-actions.pod:1608
21818 " inotify-init maxevents\n"
21823 #: ../fish/guestfish-actions.pod:1614
21825 "C<maxevents> is the maximum number of events which will be queued up between "
21826 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21827 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21828 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21829 "but records the fact that it threw them away by setting a flag "
21830 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21834 #: ../fish/guestfish-actions.pod:1624
21836 "Before any events are generated, you have to add some watches to the "
21837 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21838 "L</inotify-watch-all>."
21842 #: ../fish/guestfish-actions.pod:1630
21844 "Queued up events should be read periodically by calling L</inotify-read> (or "
21845 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21846 "If you don't read the events out often enough then you risk the internal "
21847 "queue overflowing."
21851 #: ../fish/guestfish-actions.pod:1637
21853 "The handle should be closed after use by calling L</inotify-close>. This "
21854 "also removes any watches automatically."
21858 #: ../fish/guestfish-actions.pod:1646
21859 msgid "inotify-read"
21863 #: ../fish/guestfish-actions.pod:1648
21871 #: ../fish/guestfish-actions.pod:1661
21872 msgid "inotify-rm-watch"
21876 #: ../fish/guestfish-actions.pod:1663
21879 " inotify-rm-watch wd\n"
21884 #: ../fish/guestfish-actions.pod:1665
21885 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21889 #: ../fish/guestfish-actions.pod:1668
21890 msgid "inspect-get-arch"
21894 #: ../fish/guestfish-actions.pod:1670
21897 " inspect-get-arch root\n"
21902 #: ../fish/guestfish-actions.pod:1672 ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1762 ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1831 ../fish/guestfish-actions.pod:1858 ../fish/guestfish-actions.pod:1880 ../fish/guestfish-actions.pod:1904 ../fish/guestfish-actions.pod:1934 ../fish/guestfish-actions.pod:1969 ../fish/guestfish-actions.pod:1985
21904 "This function should only be called with a root device string as returned by "
21909 #: ../fish/guestfish-actions.pod:1675
21911 "This returns the architecture of the inspected operating system. The "
21912 "possible return values are listed under L</file-architecture>."
21916 #: ../fish/guestfish-actions.pod:1684
21917 msgid "inspect-get-distro"
21921 #: ../fish/guestfish-actions.pod:1686
21924 " inspect-get-distro root\n"
21929 #: ../fish/guestfish-actions.pod:1758
21930 msgid "inspect-get-filesystems"
21934 #: ../fish/guestfish-actions.pod:1760
21937 " inspect-get-filesystems root\n"
21942 #: ../fish/guestfish-actions.pod:1773
21944 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21945 "L</inspect-get-mountpoints>."
21949 #: ../fish/guestfish-actions.pod:1776
21950 msgid "inspect-get-hostname"
21954 #: ../fish/guestfish-actions.pod:1778
21957 " inspect-get-hostname root\n"
21962 #: ../fish/guestfish-actions.pod:1791
21963 msgid "inspect-get-major-version"
21967 #: ../fish/guestfish-actions.pod:1793
21970 " inspect-get-major-version root\n"
21975 #: ../fish/guestfish-actions.pod:1812
21976 msgid "inspect-get-minor-version"
21980 #: ../fish/guestfish-actions.pod:1814
21983 " inspect-get-minor-version root\n"
21988 #: ../fish/guestfish-actions.pod:1824
21990 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21991 "L</inspect-get-major-version>."
21995 #: ../fish/guestfish-actions.pod:1827
21996 msgid "inspect-get-mountpoints"
22000 #: ../fish/guestfish-actions.pod:1829
22003 " inspect-get-mountpoints root\n"
22008 #: ../fish/guestfish-actions.pod:1851
22010 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22011 "L</inspect-get-filesystems>."
22015 #: ../fish/guestfish-actions.pod:1854
22016 msgid "inspect-get-package-format"
22020 #: ../fish/guestfish-actions.pod:1856
22023 " inspect-get-package-format root\n"
22028 #: ../fish/guestfish-actions.pod:1861
22030 "This function and L</inspect-get-package-management> return the package "
22031 "format and package management tool used by the inspected operating system. "
22032 "For example for Fedora these functions would return C<rpm> (package format) "
22033 "and C<yum> (package management)."
22037 #: ../fish/guestfish-actions.pod:1876
22038 msgid "inspect-get-package-management"
22042 #: ../fish/guestfish-actions.pod:1878
22045 " inspect-get-package-management root\n"
22050 #: ../fish/guestfish-actions.pod:1883
22052 "L</inspect-get-package-format> and this function return the package format "
22053 "and package management tool used by the inspected operating system. For "
22054 "example for Fedora these functions would return C<rpm> (package format) and "
22055 "C<yum> (package management)."
22059 #: ../fish/guestfish-actions.pod:1900
22060 msgid "inspect-get-product-name"
22064 #: ../fish/guestfish-actions.pod:1902
22067 " inspect-get-product-name root\n"
22072 #: ../fish/guestfish-actions.pod:1917
22073 msgid "inspect-get-roots"
22077 #: ../fish/guestfish-actions.pod:1919
22080 " inspect-get-roots\n"
22085 #: ../fish/guestfish-actions.pod:1921
22087 "This function is a convenient way to get the list of root devices, as "
22088 "returned from a previous call to L</inspect-os>, but without redoing the "
22089 "whole inspection process."
22093 #: ../fish/guestfish-actions.pod:1925
22095 "This returns an empty list if either no root devices were found or the "
22096 "caller has not called L</inspect-os>."
22100 #: ../fish/guestfish-actions.pod:1930
22101 msgid "inspect-get-type"
22105 #: ../fish/guestfish-actions.pod:1932
22108 " inspect-get-type root\n"
22113 #: ../fish/guestfish-actions.pod:1965
22114 msgid "inspect-get-windows-systemroot"
22118 #: ../fish/guestfish-actions.pod:1967
22121 " inspect-get-windows-systemroot root\n"
22126 #: ../fish/guestfish-actions.pod:1981
22127 msgid "inspect-list-applications"
22131 #: ../fish/guestfish-actions.pod:1983
22134 " inspect-list-applications root\n"
22139 #: ../fish/guestfish-actions.pod:1990
22141 "I<Note:> This call works differently from other parts of the inspection "
22142 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
22143 "then mount up the disks, before calling this. Listing applications is a "
22144 "significantly more difficult operation which requires access to the full "
22145 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
22146 "are just returning data cached in the libguestfs handle, this call actually "
22147 "reads parts of the mounted filesystems during the call."
22151 #: ../fish/guestfish-actions.pod:2080
22156 #: ../fish/guestfish-actions.pod:2082
22164 #: ../fish/guestfish-actions.pod:2097
22166 "You can pass the root string(s) returned to other L</inspect-get-*> "
22167 "functions in order to query further information about each operating system, "
22168 "such as the name and version."
22172 #: ../fish/guestfish-actions.pod:2102
22174 "This function uses other libguestfs features such as L</mount-ro> and "
22175 "L</umount-all> in order to mount and unmount filesystems and look at the "
22176 "contents. This should be called with no disks currently mounted. The "
22177 "function may also use Augeas, so any existing Augeas handle will be closed."
22181 #: ../fish/guestfish-actions.pod:2114 ../fish/guestfish-actions.pod:2290 ../fish/guestfish-actions.pod:2336
22182 msgid "See also L</list-filesystems>."
22186 #: ../fish/guestfish-actions.pod:2116
22187 msgid "is-blockdev"
22191 #: ../fish/guestfish-actions.pod:2118
22194 " is-blockdev path\n"
22199 #: ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2179 ../fish/guestfish-actions.pod:2213 ../fish/guestfish-actions.pod:2222
22200 msgid "See also L</stat>."
22204 #: ../fish/guestfish-actions.pod:2125
22209 #: ../fish/guestfish-actions.pod:2127
22217 #: ../fish/guestfish-actions.pod:2134
22222 #: ../fish/guestfish-actions.pod:2136
22225 " is-chardev path\n"
22230 #: ../fish/guestfish-actions.pod:2143
22235 #: ../fish/guestfish-actions.pod:2145
22243 #: ../fish/guestfish-actions.pod:2152
22248 #: ../fish/guestfish-actions.pod:2154
22256 #: ../fish/guestfish-actions.pod:2162
22261 #: ../fish/guestfish-actions.pod:2164
22269 #: ../fish/guestfish-actions.pod:2171
22274 #: ../fish/guestfish-actions.pod:2173
22282 #: ../fish/guestfish-actions.pod:2181
22283 msgid "is-launching"
22287 #: ../fish/guestfish-actions.pod:2183
22295 #: ../fish/guestfish-actions.pod:2190
22300 #: ../fish/guestfish-actions.pod:2192
22308 #: ../fish/guestfish-actions.pod:2197
22313 #: ../fish/guestfish-actions.pod:2199
22321 #: ../fish/guestfish-actions.pod:2206
22326 #: ../fish/guestfish-actions.pod:2208
22329 " is-socket path\n"
22334 #: ../fish/guestfish-actions.pod:2215
22339 #: ../fish/guestfish-actions.pod:2217
22342 " is-symlink path\n"
22347 #: ../fish/guestfish-actions.pod:2224
22348 msgid "kill-subprocess"
22352 #: ../fish/guestfish-actions.pod:2226
22355 " kill-subprocess\n"
22360 #: ../fish/guestfish-actions.pod:2230
22365 #: ../fish/guestfish-actions.pod:2232
22370 #: ../fish/guestfish-actions.pod:2234
22378 #: ../fish/guestfish-actions.pod:2242
22383 #: ../fish/guestfish-actions.pod:2244
22386 " lchown owner group path\n"
22391 #: ../fish/guestfish-actions.pod:2246
22393 "Change the file owner to C<owner> and group to C<group>. This is like "
22394 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
22399 #: ../fish/guestfish-actions.pod:2254
22404 #: ../fish/guestfish-actions.pod:2256
22407 " lgetxattr path name\n"
22412 #: ../fish/guestfish-actions.pod:2272
22413 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
22417 #: ../fish/guestfish-actions.pod:2274
22422 #: ../fish/guestfish-actions.pod:2276
22425 " lgetxattrs path\n"
22430 #: ../fish/guestfish-actions.pod:2278
22432 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
22433 "it returns the extended attributes of the link itself."
22437 #: ../fish/guestfish-actions.pod:2282
22438 msgid "list-devices"
22442 #: ../fish/guestfish-actions.pod:2284
22450 #: ../fish/guestfish-actions.pod:2292
22451 msgid "list-filesystems"
22455 #: ../fish/guestfish-actions.pod:2294
22458 " list-filesystems\n"
22463 #: ../fish/guestfish-actions.pod:2313
22465 "This command runs other libguestfs commands, which might include L</mount> "
22466 "and L</umount>, and therefore you should use this soon after launch and only "
22467 "when nothing is mounted."
22471 #: ../fish/guestfish-actions.pod:2317
22473 "Not all of the filesystems returned will be mountable. In particular, swap "
22474 "partitions are returned in the list. Also this command does not check that "
22475 "each filesystem found is valid and mountable, and some filesystems might be "
22476 "mountable but require special options. Filesystems may not all belong to a "
22477 "single logical operating system (use L</inspect-os> to look for OSes)."
22481 #: ../fish/guestfish-actions.pod:2325
22482 msgid "list-partitions"
22486 #: ../fish/guestfish-actions.pod:2327
22489 " list-partitions\n"
22494 #: ../fish/guestfish-actions.pod:2333
22496 "This does not return logical volumes. For that you will need to call "
22501 #: ../fish/guestfish-actions.pod:2338
22506 #: ../fish/guestfish-actions.pod:2340
22514 #: ../fish/guestfish-actions.pod:2348
22519 #: ../fish/guestfish-actions.pod:2350
22522 " ln target linkname\n"
22527 #: ../fish/guestfish-actions.pod:2354
22532 #: ../fish/guestfish-actions.pod:2356
22535 " ln-f target linkname\n"
22540 #: ../fish/guestfish-actions.pod:2361
22545 #: ../fish/guestfish-actions.pod:2363
22548 " ln-s target linkname\n"
22553 #: ../fish/guestfish-actions.pod:2367
22558 #: ../fish/guestfish-actions.pod:2369
22561 " ln-sf target linkname\n"
22566 #: ../fish/guestfish-actions.pod:2374
22567 msgid "lremovexattr"
22571 #: ../fish/guestfish-actions.pod:2376
22574 " lremovexattr xattr path\n"
22579 #: ../fish/guestfish-actions.pod:2378
22581 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
22582 "it removes an extended attribute of the link itself."
22586 #: ../fish/guestfish-actions.pod:2382
22591 #: ../fish/guestfish-actions.pod:2384
22599 #: ../fish/guestfish-actions.pod:2390
22601 "This command is mostly useful for interactive sessions. Programs should "
22602 "probably use L</readdir> instead."
22606 #: ../fish/guestfish-actions.pod:2393
22611 #: ../fish/guestfish-actions.pod:2395
22614 " lsetxattr xattr val vallen path\n"
22619 #: ../fish/guestfish-actions.pod:2397
22621 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
22622 "sets an extended attribute of the link itself."
22626 #: ../fish/guestfish-actions.pod:2401
22631 #: ../fish/guestfish-actions.pod:2403
22639 #: ../fish/guestfish-actions.pod:2407
22641 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
22642 "the link is stat-ed, not the file it refers to."
22646 #: ../fish/guestfish-actions.pod:2413
22651 #: ../fish/guestfish-actions.pod:2415
22654 " lstatlist path 'names ...'\n"
22659 #: ../fish/guestfish-actions.pod:2417
22661 "This call allows you to perform the L</lstat> operation on multiple files, "
22662 "where all files are in the directory C<path>. C<names> is the list of files "
22663 "from this directory."
22667 #: ../fish/guestfish-actions.pod:2426
22669 "This call is intended for programs that want to efficiently list a directory "
22670 "contents without making many round-trips. See also L</lxattrlist> for a "
22671 "similarly efficient call for getting extended attributes. Very long "
22672 "directory listings might cause the protocol message size to be exceeded, "
22673 "causing this call to fail. The caller must split up such requests into "
22674 "smaller groups of names."
22678 #: ../fish/guestfish-actions.pod:2434
22679 msgid "luks-add-key"
22683 #: ../fish/guestfish-actions.pod:2436
22686 " luks-add-key device keyslot\n"
22691 #: ../fish/guestfish-actions.pod:2443
22693 "Note that if C<keyslot> already contains a key, then this command will "
22694 "fail. You have to use L</luks-kill-slot> first to remove that key."
22698 #: ../fish/guestfish-actions.pod:2447 ../fish/guestfish-actions.pod:2469 ../fish/guestfish-actions.pod:2482 ../fish/guestfish-actions.pod:2496 ../fish/guestfish-actions.pod:2519 ../fish/guestfish-actions.pod:2529
22700 "This command has one or more key or passphrase parameters. Guestfish will "
22701 "prompt for these separately."
22705 #: ../fish/guestfish-actions.pod:2450
22710 #: ../fish/guestfish-actions.pod:2452
22713 " luks-close device\n"
22718 #: ../fish/guestfish-actions.pod:2454
22720 "This closes a LUKS device that was created earlier by L</luks-open> or "
22721 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
22722 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
22723 "underlying block device."
22727 #: ../fish/guestfish-actions.pod:2460
22728 msgid "luks-format"
22732 #: ../fish/guestfish-actions.pod:2462
22735 " luks-format device keyslot\n"
22740 #: ../fish/guestfish-actions.pod:2475
22741 msgid "luks-format-cipher"
22745 #: ../fish/guestfish-actions.pod:2477
22748 " luks-format-cipher device keyslot cipher\n"
22753 #: ../fish/guestfish-actions.pod:2479
22755 "This command is the same as L</luks-format> but it also allows you to set "
22756 "the C<cipher> used."
22760 #: ../fish/guestfish-actions.pod:2488
22761 msgid "luks-kill-slot"
22765 #: ../fish/guestfish-actions.pod:2490
22768 " luks-kill-slot device keyslot\n"
22773 #: ../fish/guestfish-actions.pod:2499
22778 #: ../fish/guestfish-actions.pod:2501
22781 " luks-open device mapname\n"
22786 #: ../fish/guestfish-actions.pod:2515
22788 "If this block device contains LVM volume groups, then calling L</vgscan> "
22789 "followed by L</vg-activate-all> will make them visible."
22793 #: ../fish/guestfish-actions.pod:2522
22794 msgid "luks-open-ro"
22798 #: ../fish/guestfish-actions.pod:2524
22801 " luks-open-ro device mapname\n"
22806 #: ../fish/guestfish-actions.pod:2526
22808 "This is the same as L</luks-open> except that a read-only mapping is "
22813 #: ../fish/guestfish-actions.pod:2532
22818 #: ../fish/guestfish-actions.pod:2534
22821 " lvcreate logvol volgroup mbytes\n"
22826 #: ../fish/guestfish-actions.pod:2539
22827 msgid "lvm-canonical-lv-name"
22831 #: ../fish/guestfish-actions.pod:2541
22834 " lvm-canonical-lv-name lvname\n"
22839 #: ../fish/guestfish-actions.pod:2550
22840 msgid "See also L</is-lv>."
22844 #: ../fish/guestfish-actions.pod:2552
22845 msgid "lvm-clear-filter"
22849 #: ../fish/guestfish-actions.pod:2554
22852 " lvm-clear-filter\n"
22857 #: ../fish/guestfish-actions.pod:2556
22859 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22864 #: ../fish/guestfish-actions.pod:2562
22865 msgid "lvm-remove-all"
22869 #: ../fish/guestfish-actions.pod:2564
22872 " lvm-remove-all\n"
22877 #: ../fish/guestfish-actions.pod:2572
22878 msgid "lvm-set-filter"
22882 #: ../fish/guestfish-actions.pod:2574
22885 " lvm-set-filter 'devices ...'\n"
22890 #: ../fish/guestfish-actions.pod:2599
22895 #: ../fish/guestfish-actions.pod:2601
22898 " lvremove device\n"
22903 #: ../fish/guestfish-actions.pod:2609
22908 #: ../fish/guestfish-actions.pod:2611
22911 " lvrename logvol newlogvol\n"
22916 #: ../fish/guestfish-actions.pod:2615
22921 #: ../fish/guestfish-actions.pod:2617
22924 " lvresize device mbytes\n"
22929 #: ../fish/guestfish-actions.pod:2623
22930 msgid "lvresize-free"
22934 #: ../fish/guestfish-actions.pod:2625
22937 " lvresize-free lv percent\n"
22942 #: ../fish/guestfish-actions.pod:2633
22947 #: ../fish/guestfish-actions.pod:2635
22955 #: ../fish/guestfish-actions.pod:2643
22956 msgid "See also L</lvs-full>, L</list-filesystems>."
22960 #: ../fish/guestfish-actions.pod:2645
22965 #: ../fish/guestfish-actions.pod:2647
22973 #: ../fish/guestfish-actions.pod:2652
22978 #: ../fish/guestfish-actions.pod:2654
22986 #: ../fish/guestfish-actions.pod:2658
22991 #: ../fish/guestfish-actions.pod:2660
22994 " lxattrlist path 'names ...'\n"
22999 #: ../fish/guestfish-actions.pod:2676
23001 "This call is intended for programs that want to efficiently list a directory "
23002 "contents without making many round-trips. See also L</lstatlist> for a "
23003 "similarly efficient call for getting standard stats. Very long directory "
23004 "listings might cause the protocol message size to be exceeded, causing this "
23005 "call to fail. The caller must split up such requests into smaller groups of "
23010 #: ../fish/guestfish-actions.pod:2684
23015 #: ../fish/guestfish-actions.pod:2686
23023 #: ../fish/guestfish-actions.pod:2690
23028 #: ../fish/guestfish-actions.pod:2692
23031 " mkdir-mode path mode\n"
23036 #: ../fish/guestfish-actions.pod:2701
23037 msgid "See also L</mkdir>, L</umask>"
23041 #: ../fish/guestfish-actions.pod:2703
23046 #: ../fish/guestfish-actions.pod:2705
23054 #: ../fish/guestfish-actions.pod:2710
23059 #: ../fish/guestfish-actions.pod:2712
23062 " mkdtemp template\n"
23067 #: ../fish/guestfish-actions.pod:2733
23072 #: ../fish/guestfish-actions.pod:2735
23075 " mke2fs-J fstype blocksize device journal\n"
23080 #: ../fish/guestfish-actions.pod:2743
23081 msgid "See also L</mke2journal>."
23085 #: ../fish/guestfish-actions.pod:2745
23090 #: ../fish/guestfish-actions.pod:2747
23093 " mke2fs-JL fstype blocksize device label\n"
23098 #: ../fish/guestfish-actions.pod:2752
23099 msgid "See also L</mke2journal-L>."
23103 #: ../fish/guestfish-actions.pod:2754
23108 #: ../fish/guestfish-actions.pod:2756
23111 " mke2fs-JU fstype blocksize device uuid\n"
23116 #: ../fish/guestfish-actions.pod:2761
23117 msgid "See also L</mke2journal-U>."
23121 #: ../fish/guestfish-actions.pod:2763
23122 msgid "mke2journal"
23126 #: ../fish/guestfish-actions.pod:2765
23129 " mke2journal blocksize device\n"
23134 #: ../fish/guestfish-actions.pod:2772
23135 msgid "mke2journal-L"
23139 #: ../fish/guestfish-actions.pod:2774
23142 " mke2journal-L blocksize label device\n"
23147 #: ../fish/guestfish-actions.pod:2778
23148 msgid "mke2journal-U"
23152 #: ../fish/guestfish-actions.pod:2780
23155 " mke2journal-U blocksize uuid device\n"
23160 #: ../fish/guestfish-actions.pod:2784
23165 #: ../fish/guestfish-actions.pod:2786
23168 " mkfifo mode path\n"
23173 #: ../fish/guestfish-actions.pod:2788
23175 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
23176 "is just a convenient wrapper around L</mknod>."
23180 #: ../fish/guestfish-actions.pod:2794
23185 #: ../fish/guestfish-actions.pod:2796
23188 " mkfs fstype device\n"
23193 #: ../fish/guestfish-actions.pod:2802
23198 #: ../fish/guestfish-actions.pod:2804
23201 " mkfs-b fstype blocksize device\n"
23206 #: ../fish/guestfish-actions.pod:2806
23208 "This call is similar to L</mkfs>, but it allows you to control the block "
23209 "size of the resulting filesystem. Supported block sizes depend on the "
23210 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
23214 #: ../fish/guestfish-actions.pod:2814
23216 "This function is deprecated. In new code, use the L</mkfs_opts> call "
23221 #: ../fish/guestfish-actions.pod:2821
23226 #: ../fish/guestfish-actions.pod:2823
23229 " mkfs-opts fstype device [blocksize:..]\n"
23234 #: ../fish/guestfish-actions.pod:2847
23235 msgid "mkmountpoint"
23239 #: ../fish/guestfish-actions.pod:2849
23242 " mkmountpoint exemptpath\n"
23247 #: ../fish/guestfish-actions.pod:2851
23249 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
23250 "to create extra mountpoints before mounting the first filesystem."
23254 #: ../fish/guestfish-actions.pod:2875
23256 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
23257 "unexpected errors if you try to mix these calls. It is safest to manually "
23258 "unmount filesystems and remove mountpoints after use."
23262 #: ../fish/guestfish-actions.pod:2879
23264 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
23265 "for this to work for manual mountpoints, you must ensure that the innermost "
23266 "mountpoints have the longest pathnames, as in the example code above."
23270 #: ../fish/guestfish-actions.pod:2886
23272 "Autosync [see L</set-autosync>, this is set by default on handles] means "
23273 "that L</umount-all> is called when the handle is closed which can also "
23274 "trigger these issues."
23278 #: ../fish/guestfish-actions.pod:2890
23283 #: ../fish/guestfish-actions.pod:2892
23286 " mknod mode devmajor devminor path\n"
23291 #: ../fish/guestfish-actions.pod:2902
23293 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
23294 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
23295 "regular file). These constants are available in the standard Linux header "
23296 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
23297 "wrappers around this command which bitwise OR in the appropriate constant "
23302 #: ../fish/guestfish-actions.pod:2912
23307 #: ../fish/guestfish-actions.pod:2914
23310 " mknod-b mode devmajor devminor path\n"
23315 #: ../fish/guestfish-actions.pod:2916
23317 "This call creates a block device node called C<path> with mode C<mode> and "
23318 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23319 "wrapper around L</mknod>."
23323 #: ../fish/guestfish-actions.pod:2922
23328 #: ../fish/guestfish-actions.pod:2924
23331 " mknod-c mode devmajor devminor path\n"
23336 #: ../fish/guestfish-actions.pod:2926
23338 "This call creates a char device node called C<path> with mode C<mode> and "
23339 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23340 "wrapper around L</mknod>."
23344 #: ../fish/guestfish-actions.pod:2932
23349 #: ../fish/guestfish-actions.pod:2934
23357 #: ../fish/guestfish-actions.pod:2938
23362 #: ../fish/guestfish-actions.pod:2940
23365 " mkswap-L label device\n"
23370 #: ../fish/guestfish-actions.pod:2948
23375 #: ../fish/guestfish-actions.pod:2950
23378 " mkswap-U uuid device\n"
23383 #: ../fish/guestfish-actions.pod:2954
23384 msgid "mkswap-file"
23388 #: ../fish/guestfish-actions.pod:2956
23391 " mkswap-file path\n"
23396 #: ../fish/guestfish-actions.pod:2960
23398 "This command just writes a swap file signature to an existing file. To "
23399 "create the file itself, use something like L</fallocate>."
23403 #: ../fish/guestfish-actions.pod:2963
23408 #: ../fish/guestfish-actions.pod:2965
23411 " modprobe modulename\n"
23416 #: ../fish/guestfish-actions.pod:2972
23421 #: ../fish/guestfish-actions.pod:2974
23424 " mount device mountpoint\n"
23429 #: ../fish/guestfish-actions.pod:2990
23431 "B<Important note:> When you use this call, the filesystem options C<sync> "
23432 "and C<noatime> are set implicitly. This was originally done because we "
23433 "thought it would improve reliability, but it turns out that I<-o sync> has a "
23434 "very large negative performance impact and negligible effect on "
23435 "reliability. Therefore we recommend that you avoid using L</mount> in any "
23436 "code that needs performance, and instead use L</mount-options> (use an empty "
23437 "string for the first parameter if you don't want any options)."
23441 #: ../fish/guestfish-actions.pod:3000
23446 #: ../fish/guestfish-actions.pod:3002
23449 " mount-loop file mountpoint\n"
23454 #: ../fish/guestfish-actions.pod:3008
23455 msgid "mount-options"
23459 #: ../fish/guestfish-actions.pod:3010
23462 " mount-options options device mountpoint\n"
23467 #: ../fish/guestfish-actions.pod:3012
23469 "This is the same as the L</mount> command, but it allows you to set the "
23470 "mount options as for the L<mount(8)> I<-o> flag."
23474 #: ../fish/guestfish-actions.pod:3020
23479 #: ../fish/guestfish-actions.pod:3022
23482 " mount-ro device mountpoint\n"
23487 #: ../fish/guestfish-actions.pod:3024
23489 "This is the same as the L</mount> command, but it mounts the filesystem with "
23490 "the read-only (I<-o ro>) flag."
23494 #: ../fish/guestfish-actions.pod:3027
23499 #: ../fish/guestfish-actions.pod:3029
23502 " mount-vfs options vfstype device mountpoint\n"
23507 #: ../fish/guestfish-actions.pod:3031
23509 "This is the same as the L</mount> command, but it allows you to set both the "
23510 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
23514 #: ../fish/guestfish-actions.pod:3035
23515 msgid "mountpoints"
23519 #: ../fish/guestfish-actions.pod:3037
23527 #: ../fish/guestfish-actions.pod:3039
23529 "This call is similar to L</mounts>. That call returns a list of devices. "
23530 "This one returns a hash table (map) of device name to directory where the "
23531 "device is mounted."
23535 #: ../fish/guestfish-actions.pod:3043
23540 #: ../fish/guestfish-actions.pod:3045
23548 #: ../fish/guestfish-actions.pod:3052
23549 msgid "See also: L</mountpoints>"
23553 #: ../fish/guestfish-actions.pod:3054
23558 #: ../fish/guestfish-actions.pod:3056
23566 #: ../fish/guestfish-actions.pod:3061
23567 msgid "ntfs-3g-probe"
23571 #: ../fish/guestfish-actions.pod:3063
23574 " ntfs-3g-probe true|false device\n"
23579 #: ../fish/guestfish-actions.pod:3077
23584 #: ../fish/guestfish-actions.pod:3079
23587 " ntfsresize device\n"
23592 #: ../fish/guestfish-actions.pod:3094
23593 msgid "ntfsresize-size"
23597 #: ../fish/guestfish-actions.pod:3096
23600 " ntfsresize-size device size\n"
23605 #: ../fish/guestfish-actions.pod:3098
23607 "This command is the same as L</ntfsresize> except that it allows you to "
23608 "specify the new size (in bytes) explicitly."
23612 #: ../fish/guestfish-actions.pod:3101
23617 #: ../fish/guestfish-actions.pod:3103
23620 " part-add device prlogex startsect endsect\n"
23625 #: ../fish/guestfish-actions.pod:3105
23627 "This command adds a partition to C<device>. If there is no partition table "
23628 "on the device, call L</part-init> first."
23632 #: ../fish/guestfish-actions.pod:3117
23634 "Creating a partition which covers the whole disk is not so easy. Use "
23635 "L</part-disk> to do that."
23639 #: ../fish/guestfish-actions.pod:3120
23644 #: ../fish/guestfish-actions.pod:3122
23647 " part-del device partnum\n"
23652 #: ../fish/guestfish-actions.pod:3130
23657 #: ../fish/guestfish-actions.pod:3132
23660 " part-disk device parttype\n"
23665 #: ../fish/guestfish-actions.pod:3134
23667 "This command is simply a combination of L</part-init> followed by "
23668 "L</part-add> to create a single primary partition covering the whole disk."
23672 #: ../fish/guestfish-actions.pod:3138
23674 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
23675 "possible values are described in L</part-init>."
23679 #: ../fish/guestfish-actions.pod:3144
23680 msgid "part-get-bootable"
23684 #: ../fish/guestfish-actions.pod:3146
23687 " part-get-bootable device partnum\n"
23692 #: ../fish/guestfish-actions.pod:3151
23693 msgid "See also L</part-set-bootable>."
23697 #: ../fish/guestfish-actions.pod:3153
23698 msgid "part-get-mbr-id"
23702 #: ../fish/guestfish-actions.pod:3155
23705 " part-get-mbr-id device partnum\n"
23710 #: ../fish/guestfish-actions.pod:3160 ../fish/guestfish-actions.pod:3298
23712 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
23713 "undefined results for other partition table types (see "
23714 "L</part-get-parttype>)."
23718 #: ../fish/guestfish-actions.pod:3164
23719 msgid "part-get-parttype"
23723 #: ../fish/guestfish-actions.pod:3166
23726 " part-get-parttype device\n"
23731 #: ../fish/guestfish-actions.pod:3171
23733 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
23734 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
23735 "possible, although unusual. See L</part-init> for a full list."
23739 #: ../fish/guestfish-actions.pod:3176
23744 #: ../fish/guestfish-actions.pod:3178
23747 " part-init device parttype\n"
23752 #: ../fish/guestfish-actions.pod:3184
23754 "Initially there are no partitions. Following this, you should call "
23755 "L</part-add> for each partition required."
23759 #: ../fish/guestfish-actions.pod:3247
23764 #: ../fish/guestfish-actions.pod:3249
23767 " part-list device\n"
23772 #: ../fish/guestfish-actions.pod:3264
23774 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23775 "the device's sector size, see L</blockdev-getss>."
23779 #: ../fish/guestfish-actions.pod:3277
23780 msgid "part-set-bootable"
23784 #: ../fish/guestfish-actions.pod:3279
23787 " part-set-bootable device partnum true|false\n"
23792 #: ../fish/guestfish-actions.pod:3288
23793 msgid "part-set-mbr-id"
23797 #: ../fish/guestfish-actions.pod:3290
23800 " part-set-mbr-id device partnum idbyte\n"
23805 #: ../fish/guestfish-actions.pod:3302
23806 msgid "part-set-name"
23810 #: ../fish/guestfish-actions.pod:3304
23813 " part-set-name device partnum name\n"
23818 #: ../fish/guestfish-actions.pod:3312
23819 msgid "part-to-dev"
23823 #: ../fish/guestfish-actions.pod:3314
23826 " part-to-dev partition\n"
23831 #: ../fish/guestfish-actions.pod:3320
23833 "The named partition must exist, for example as a string returned from "
23834 "L</list-partitions>."
23838 #: ../fish/guestfish-actions.pod:3323
23839 msgid "ping-daemon"
23843 #: ../fish/guestfish-actions.pod:3325
23851 #: ../fish/guestfish-actions.pod:3332
23856 #: ../fish/guestfish-actions.pod:3334
23859 " pread path count offset\n"
23864 #: ../fish/guestfish-actions.pod:3342
23865 msgid "See also L</pwrite>, L</pread-device>."
23869 #: ../fish/guestfish-actions.pod:3347
23870 msgid "pread-device"
23874 #: ../fish/guestfish-actions.pod:3349
23877 " pread-device device count offset\n"
23882 #: ../fish/guestfish-actions.pod:3357
23883 msgid "See also L</pread>."
23887 #: ../fish/guestfish-actions.pod:3362
23892 #: ../fish/guestfish-actions.pod:3364
23895 " pvcreate device\n"
23900 #: ../fish/guestfish-actions.pod:3370
23905 #: ../fish/guestfish-actions.pod:3372
23908 " pvremove device\n"
23913 #: ../fish/guestfish-actions.pod:3381
23918 #: ../fish/guestfish-actions.pod:3383
23921 " pvresize device\n"
23926 #: ../fish/guestfish-actions.pod:3388
23927 msgid "pvresize-size"
23931 #: ../fish/guestfish-actions.pod:3390
23934 " pvresize-size device size\n"
23939 #: ../fish/guestfish-actions.pod:3392
23941 "This command is the same as L</pvresize> except that it allows you to "
23942 "specify the new size (in bytes) explicitly."
23946 #: ../fish/guestfish-actions.pod:3395
23951 #: ../fish/guestfish-actions.pod:3397
23959 #: ../fish/guestfish-actions.pod:3405
23960 msgid "See also L</pvs-full>."
23964 #: ../fish/guestfish-actions.pod:3407
23969 #: ../fish/guestfish-actions.pod:3409
23977 #: ../fish/guestfish-actions.pod:3414
23982 #: ../fish/guestfish-actions.pod:3416
23990 #: ../fish/guestfish-actions.pod:3420
23995 #: ../fish/guestfish-actions.pod:3422
23998 " pwrite path content offset\n"
24003 #: ../fish/guestfish-actions.pod:3433
24004 msgid "See also L</pread>, L</pwrite-device>."
24008 #: ../fish/guestfish-actions.pod:3438
24009 msgid "pwrite-device"
24013 #: ../fish/guestfish-actions.pod:3440
24016 " pwrite-device device content offset\n"
24021 #: ../fish/guestfish-actions.pod:3450
24022 msgid "See also L</pwrite>."
24026 #: ../fish/guestfish-actions.pod:3455
24031 #: ../fish/guestfish-actions.pod:3457
24034 " read-file path\n"
24039 #: ../fish/guestfish-actions.pod:3462
24041 "Unlike L</cat>, this function can correctly handle files that contain "
24042 "embedded ASCII NUL characters. However unlike L</download>, this function "
24043 "is limited in the total size of file that can be handled."
24047 #: ../fish/guestfish-actions.pod:3470
24052 #: ../fish/guestfish-actions.pod:3472
24055 " read-lines path\n"
24060 #: ../fish/guestfish-actions.pod:3479
24062 "Note that this function cannot correctly handle binary files (specifically, "
24063 "files containing C<\\0> character which is treated as end of line). For "
24064 "those you need to use the L</read-file> function which has a more complex "
24069 #: ../fish/guestfish-actions.pod:3484
24074 #: ../fish/guestfish-actions.pod:3486
24082 #: ../fish/guestfish-actions.pod:3538
24084 "This function is primarily intended for use by programs. To get a simple "
24085 "list of names, use L</ls>. To get a printable directory for human "
24086 "consumption, use L</ll>."
24090 #: ../fish/guestfish-actions.pod:3542
24095 #: ../fish/guestfish-actions.pod:3544
24103 #: ../fish/guestfish-actions.pod:3548
24104 msgid "readlinklist"
24108 #: ../fish/guestfish-actions.pod:3550
24111 " readlinklist path 'names ...'\n"
24116 #: ../fish/guestfish-actions.pod:3574
24121 #: ../fish/guestfish-actions.pod:3576
24129 #: ../fish/guestfish-actions.pod:3581
24130 msgid "removexattr"
24134 #: ../fish/guestfish-actions.pod:3583
24137 " removexattr xattr path\n"
24142 #: ../fish/guestfish-actions.pod:3588
24143 msgid "See also: L</lremovexattr>, L<attr(5)>."
24147 #: ../fish/guestfish-actions.pod:3590
24152 #: ../fish/guestfish-actions.pod:3592
24155 " resize2fs device\n"
24160 #: ../fish/guestfish-actions.pod:3597
24162 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
24163 "before calling this command. For unknown reasons C<resize2fs> sometimes "
24164 "gives an error about this and sometimes not. In any case, it is always safe "
24165 "to call L</e2fsck-f> before calling this function."
24169 #: ../fish/guestfish-actions.pod:3603
24170 msgid "resize2fs-size"
24174 #: ../fish/guestfish-actions.pod:3605
24177 " resize2fs-size device size\n"
24182 #: ../fish/guestfish-actions.pod:3607
24184 "This command is the same as L</resize2fs> except that it allows you to "
24185 "specify the new size (in bytes) explicitly."
24189 #: ../fish/guestfish-actions.pod:3610
24194 #: ../fish/guestfish-actions.pod:3612
24202 #: ../fish/guestfish-actions.pod:3616
24207 #: ../fish/guestfish-actions.pod:3618
24215 #: ../fish/guestfish-actions.pod:3624
24220 #: ../fish/guestfish-actions.pod:3626
24228 #: ../fish/guestfish-actions.pod:3630
24229 msgid "rmmountpoint"
24233 #: ../fish/guestfish-actions.pod:3632
24236 " rmmountpoint exemptpath\n"
24241 #: ../fish/guestfish-actions.pod:3634
24243 "This calls removes a mountpoint that was previously created with "
24244 "L</mkmountpoint>. See L</mkmountpoint> for full details."
24248 #: ../fish/guestfish-actions.pod:3638
24249 msgid "scrub-device"
24253 #: ../fish/guestfish-actions.pod:3640
24256 " scrub-device device\n"
24261 #: ../fish/guestfish-actions.pod:3651
24266 #: ../fish/guestfish-actions.pod:3653
24269 " scrub-file file\n"
24274 #: ../fish/guestfish-actions.pod:3663
24275 msgid "scrub-freespace"
24279 #: ../fish/guestfish-actions.pod:3665
24282 " scrub-freespace dir\n"
24287 #: ../fish/guestfish-actions.pod:3667
24289 "This command creates the directory C<dir> and then fills it with files until "
24290 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
24291 "deletes them. The intention is to scrub any free space on the partition "
24292 "containing C<dir>."
24296 #: ../fish/guestfish-actions.pod:3676
24301 #: ../fish/guestfish-actions.pod:3678
24306 #: ../fish/guestfish-actions.pod:3680
24309 " set-append append\n"
24314 #: ../fish/guestfish-actions.pod:3691
24315 msgid "set-autosync"
24319 #: ../fish/guestfish-actions.pod:3693
24324 #: ../fish/guestfish-actions.pod:3695
24327 " set-autosync true|false\n"
24332 #: ../fish/guestfish-actions.pod:3697
24334 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
24335 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
24336 "closed (also if the program exits without closing handles)."
24340 #: ../fish/guestfish-actions.pod:3705
24345 #: ../fish/guestfish-actions.pod:3707
24350 #: ../fish/guestfish-actions.pod:3709
24353 " set-direct true|false\n"
24358 #: ../fish/guestfish-actions.pod:3715
24360 "One consequence of this is that log messages aren't caught by the library "
24361 "and handled by L</set-log-message-callback>, but go straight to stdout."
24365 #: ../fish/guestfish-actions.pod:3724
24366 msgid "set-e2label"
24370 #: ../fish/guestfish-actions.pod:3726
24373 " set-e2label device label\n"
24378 #: ../fish/guestfish-actions.pod:3732
24380 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
24381 "label on a filesystem."
24385 #: ../fish/guestfish-actions.pod:3735
24390 #: ../fish/guestfish-actions.pod:3737
24393 " set-e2uuid device uuid\n"
24398 #: ../fish/guestfish-actions.pod:3744
24400 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
24401 "UUID of a filesystem."
24405 #: ../fish/guestfish-actions.pod:3747
24406 msgid "set-memsize"
24410 #: ../fish/guestfish-actions.pod:3749
24415 #: ../fish/guestfish-actions.pod:3751
24418 " set-memsize memsize\n"
24423 #: ../fish/guestfish-actions.pod:3753
24425 "This sets the memory size in megabytes allocated to the qemu subprocess. "
24426 "This only has any effect if called before L</launch>."
24430 #: ../fish/guestfish-actions.pod:3764
24431 msgid "set-network"
24435 #: ../fish/guestfish-actions.pod:3766
24440 #: ../fish/guestfish-actions.pod:3768
24443 " set-network true|false\n"
24448 #: ../fish/guestfish-actions.pod:3776
24449 msgid "You must call this before calling L</launch>, otherwise it has no effect."
24453 #: ../fish/guestfish-actions.pod:3779
24458 #: ../fish/guestfish-actions.pod:3781
24463 #: ../fish/guestfish-actions.pod:3783
24466 " set-path searchpath\n"
24471 #: ../fish/guestfish-actions.pod:3792
24476 #: ../fish/guestfish-actions.pod:3794
24481 #: ../fish/guestfish-actions.pod:3796
24489 #: ../fish/guestfish-actions.pod:3816
24490 msgid "set-recovery-proc"
24494 #: ../fish/guestfish-actions.pod:3818
24495 msgid "recovery-proc"
24499 #: ../fish/guestfish-actions.pod:3820
24502 " set-recovery-proc true|false\n"
24507 #: ../fish/guestfish-actions.pod:3822
24509 "If this is called with the parameter C<false> then L</launch> does not "
24510 "create a recovery process. The purpose of the recovery process is to stop "
24511 "runaway qemu processes in the case where the main program aborts abruptly."
24515 #: ../fish/guestfish-actions.pod:3827
24517 "This only has any effect if called before L</launch>, and the default is "
24522 #: ../fish/guestfish-actions.pod:3836
24523 msgid "set-selinux"
24527 #: ../fish/guestfish-actions.pod:3838
24532 #: ../fish/guestfish-actions.pod:3840
24535 " set-selinux true|false\n"
24540 #: ../fish/guestfish-actions.pod:3851
24545 #: ../fish/guestfish-actions.pod:3853
24550 #: ../fish/guestfish-actions.pod:3855
24553 " set-trace true|false\n"
24558 #: ../fish/guestfish-actions.pod:3871
24559 msgid "set-verbose"
24563 #: ../fish/guestfish-actions.pod:3873
24568 #: ../fish/guestfish-actions.pod:3875
24571 " set-verbose true|false\n"
24576 #: ../fish/guestfish-actions.pod:3882
24581 #: ../fish/guestfish-actions.pod:3884
24584 " setcon context\n"
24589 #: ../fish/guestfish-actions.pod:3891
24594 #: ../fish/guestfish-actions.pod:3893
24597 " setxattr xattr val vallen path\n"
24602 #: ../fish/guestfish-actions.pod:3899
24603 msgid "See also: L</lsetxattr>, L<attr(5)>."
24607 #: ../fish/guestfish-actions.pod:3901
24612 #: ../fish/guestfish-actions.pod:3903
24615 " sfdisk device cyls heads sectors 'lines ...'\n"
24620 #: ../fish/guestfish-actions.pod:3925
24621 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
24625 #: ../fish/guestfish-actions.pod:3931
24630 #: ../fish/guestfish-actions.pod:3933
24633 " sfdiskM device 'lines ...'\n"
24638 #: ../fish/guestfish-actions.pod:3935
24640 "This is a simplified interface to the L</sfdisk> command, where partition "
24641 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
24642 "you don't need to specify the cyls, heads and sectors parameters which were "
24643 "rarely if ever used anyway."
24647 #: ../fish/guestfish-actions.pod:3941
24648 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
24652 #: ../fish/guestfish-actions.pod:3947
24657 #: ../fish/guestfish-actions.pod:3949
24660 " sfdisk-N device partnum cyls heads sectors line\n"
24665 #: ../fish/guestfish-actions.pod:3954
24667 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
24668 "cyls/heads/sectors parameters."
24672 #: ../fish/guestfish-actions.pod:3957
24673 msgid "See also: L</part-add>"
24677 #: ../fish/guestfish-actions.pod:3962
24678 msgid "sfdisk-disk-geometry"
24682 #: ../fish/guestfish-actions.pod:3964
24685 " sfdisk-disk-geometry device\n"
24690 #: ../fish/guestfish-actions.pod:3966
24692 "This displays the disk geometry of C<device> read from the partition table. "
24693 "Especially in the case where the underlying block device has been resized, "
24694 "this can be different from the kernel's idea of the geometry (see "
24695 "L</sfdisk-kernel-geometry>)."
24699 #: ../fish/guestfish-actions.pod:3974
24700 msgid "sfdisk-kernel-geometry"
24704 #: ../fish/guestfish-actions.pod:3976
24707 " sfdisk-kernel-geometry device\n"
24712 #: ../fish/guestfish-actions.pod:3983
24717 #: ../fish/guestfish-actions.pod:3985
24720 " sfdisk-l device\n"
24725 #: ../fish/guestfish-actions.pod:3991
24726 msgid "See also: L</part-list>"
24730 #: ../fish/guestfish-actions.pod:3993
24735 #: ../fish/guestfish-actions.pod:3995
24743 #: ../fish/guestfish-actions.pod:4000
24744 msgid "This is like L</command>, but passes the command to:"
24748 #: ../fish/guestfish-actions.pod:4008
24749 msgid "All the provisos about L</command> apply to this call."
24753 #: ../fish/guestfish-actions.pod:4010
24758 #: ../fish/guestfish-actions.pod:4012
24761 " sh-lines command\n"
24766 #: ../fish/guestfish-actions.pod:4014
24767 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24771 #: ../fish/guestfish-actions.pod:4017
24772 msgid "See also: L</command-lines>"
24776 #: ../fish/guestfish-actions.pod:4019
24781 #: ../fish/guestfish-actions.pod:4021
24789 #: ../fish/guestfish-actions.pod:4025
24794 #: ../fish/guestfish-actions.pod:4027
24802 #: ../fish/guestfish-actions.pod:4033
24807 #: ../fish/guestfish-actions.pod:4035
24815 #: ../fish/guestfish-actions.pod:4043
24820 #: ../fish/guestfish-actions.pod:4045
24828 #: ../fish/guestfish-actions.pod:4053
24833 #: ../fish/guestfish-actions.pod:4055
24836 " strings-e encoding path\n"
24841 #: ../fish/guestfish-actions.pod:4057
24843 "This is like the L</strings> command, but allows you to specify the encoding "
24844 "of strings that are looked for in the source file C<path>."
24848 #: ../fish/guestfish-actions.pod:4067
24850 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24851 "ISO-8859-X (this is what L</strings> uses)."
24855 #: ../fish/guestfish-actions.pod:4099
24856 msgid "swapoff-device"
24860 #: ../fish/guestfish-actions.pod:4101
24863 " swapoff-device device\n"
24868 #: ../fish/guestfish-actions.pod:4103
24870 "This command disables the libguestfs appliance swap device or partition "
24871 "named C<device>. See L</swapon-device>."
24875 #: ../fish/guestfish-actions.pod:4107
24876 msgid "swapoff-file"
24880 #: ../fish/guestfish-actions.pod:4109
24883 " swapoff-file file\n"
24888 #: ../fish/guestfish-actions.pod:4113
24889 msgid "swapoff-label"
24893 #: ../fish/guestfish-actions.pod:4115
24896 " swapoff-label label\n"
24901 #: ../fish/guestfish-actions.pod:4120
24902 msgid "swapoff-uuid"
24906 #: ../fish/guestfish-actions.pod:4122
24909 " swapoff-uuid uuid\n"
24914 #: ../fish/guestfish-actions.pod:4127
24915 msgid "swapon-device"
24919 #: ../fish/guestfish-actions.pod:4129
24922 " swapon-device device\n"
24927 #: ../fish/guestfish-actions.pod:4131
24929 "This command enables the libguestfs appliance to use the swap device or "
24930 "partition named C<device>. The increased memory is made available for all "
24931 "commands, for example those run using L</command> or L</sh>."
24935 #: ../fish/guestfish-actions.pod:4143
24936 msgid "swapon-file"
24940 #: ../fish/guestfish-actions.pod:4145
24943 " swapon-file file\n"
24948 #: ../fish/guestfish-actions.pod:4147
24949 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
24953 #: ../fish/guestfish-actions.pod:4150
24954 msgid "swapon-label"
24958 #: ../fish/guestfish-actions.pod:4152
24961 " swapon-label label\n"
24966 #: ../fish/guestfish-actions.pod:4154
24968 "This command enables swap to a labeled swap partition. See "
24969 "L</swapon-device> for other notes."
24973 #: ../fish/guestfish-actions.pod:4157
24974 msgid "swapon-uuid"
24978 #: ../fish/guestfish-actions.pod:4159
24981 " swapon-uuid uuid\n"
24986 #: ../fish/guestfish-actions.pod:4161
24988 "This command enables swap to a swap partition with the given UUID. See "
24989 "L</swapon-device> for other notes."
24993 #: ../fish/guestfish-actions.pod:4164
24998 #: ../fish/guestfish-actions.pod:4166
25006 #: ../fish/guestfish-actions.pod:4174
25011 #: ../fish/guestfish-actions.pod:4176
25019 #: ../fish/guestfish-actions.pod:4184
25024 #: ../fish/guestfish-actions.pod:4186
25027 " tail-n nrlines path\n"
25032 #: ../fish/guestfish-actions.pod:4199
25037 #: ../fish/guestfish-actions.pod:4201
25040 " tar-in (tarfile|-) directory\n"
25045 #: ../fish/guestfish-actions.pod:4206
25046 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
25050 #: ../fish/guestfish-actions.pod:4211
25055 #: ../fish/guestfish-actions.pod:4213
25058 " tar-out directory (tarfile|-)\n"
25063 #: ../fish/guestfish-actions.pod:4218
25064 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
25068 #: ../fish/guestfish-actions.pod:4223
25073 #: ../fish/guestfish-actions.pod:4225
25076 " tgz-in (tarball|-) directory\n"
25081 #: ../fish/guestfish-actions.pod:4230
25082 msgid "To upload an uncompressed tarball, use L</tar-in>."
25086 #: ../fish/guestfish-actions.pod:4234
25091 #: ../fish/guestfish-actions.pod:4236
25094 " tgz-out directory (tarball|-)\n"
25099 #: ../fish/guestfish-actions.pod:4241
25100 msgid "To download an uncompressed tarball, use L</tar-out>."
25104 #: ../fish/guestfish-actions.pod:4245
25109 #: ../fish/guestfish-actions.pod:4247
25117 #: ../fish/guestfish-actions.pod:4256
25122 #: ../fish/guestfish-actions.pod:4258
25130 #: ../fish/guestfish-actions.pod:4263
25131 msgid "truncate-size"
25135 #: ../fish/guestfish-actions.pod:4265
25138 " truncate-size path size\n"
25143 #: ../fish/guestfish-actions.pod:4270
25145 "If the current file size is less than C<size> then the file is extended to "
25146 "the required size with zero bytes. This creates a sparse file (ie. disk "
25147 "blocks are not allocated for the file until you write to it). To create a "
25148 "non-sparse file of zeroes, use L</fallocate64> instead."
25152 #: ../fish/guestfish-actions.pod:4276
25157 #: ../fish/guestfish-actions.pod:4278
25160 " tune2fs-l device\n"
25165 #: ../fish/guestfish-actions.pod:4288
25170 #: ../fish/guestfish-actions.pod:4290
25173 " txz-in (tarball|-) directory\n"
25178 #: ../fish/guestfish-actions.pod:4297
25183 #: ../fish/guestfish-actions.pod:4299
25186 " txz-out directory (tarball|-)\n"
25191 #: ../fish/guestfish-actions.pod:4306
25196 #: ../fish/guestfish-actions.pod:4308
25204 #: ../fish/guestfish-actions.pod:4322
25205 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
25209 #: ../fish/guestfish-actions.pod:4327
25214 #: ../fish/guestfish-actions.pod:4329
25219 #: ../fish/guestfish-actions.pod:4331
25222 " umount pathordevice\n"
25227 #: ../fish/guestfish-actions.pod:4337
25232 #: ../fish/guestfish-actions.pod:4339
25233 msgid "unmount-all"
25237 #: ../fish/guestfish-actions.pod:4341
25245 #: ../fish/guestfish-actions.pod:4347
25250 #: ../fish/guestfish-actions.pod:4349
25253 " upload (filename|-) remotefilename\n"
25258 #: ../fish/guestfish-actions.pod:4356
25259 msgid "See also L</download>."
25263 #: ../fish/guestfish-actions.pod:4360
25264 msgid "upload-offset"
25268 #: ../fish/guestfish-actions.pod:4362
25271 " upload-offset (filename|-) remotefilename offset\n"
25276 #: ../fish/guestfish-actions.pod:4374
25278 "Note that there is no limit on the amount of data that can be uploaded with "
25279 "this call, unlike with L</pwrite>, and this call always writes the full "
25280 "amount unless an error occurs."
25284 #: ../fish/guestfish-actions.pod:4379
25285 msgid "See also L</upload>, L</pwrite>."
25289 #: ../fish/guestfish-actions.pod:4383
25294 #: ../fish/guestfish-actions.pod:4385
25297 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
25302 #: ../fish/guestfish-actions.pod:4404
25307 #: ../fish/guestfish-actions.pod:4406
25315 #: ../fish/guestfish-actions.pod:4433
25317 "I<Note:> Don't use this call to test for availability of features. In "
25318 "enterprise distributions we backport features from later versions into "
25319 "earlier versions, making this an unreliable way to test for features. Use "
25320 "L</available> instead."
25324 #: ../fish/guestfish-actions.pod:4439
25329 #: ../fish/guestfish-actions.pod:4441
25332 " vfs-label device\n"
25337 #: ../fish/guestfish-actions.pod:4448
25338 msgid "To find a filesystem from the label, use L</findfs-label>."
25342 #: ../fish/guestfish-actions.pod:4450
25347 #: ../fish/guestfish-actions.pod:4452
25350 " vfs-type device\n"
25355 #: ../fish/guestfish-actions.pod:4462
25360 #: ../fish/guestfish-actions.pod:4464
25363 " vfs-uuid device\n"
25368 #: ../fish/guestfish-actions.pod:4471
25369 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
25373 #: ../fish/guestfish-actions.pod:4473
25374 msgid "vg-activate"
25378 #: ../fish/guestfish-actions.pod:4475
25381 " vg-activate true|false 'volgroups ...'\n"
25386 #: ../fish/guestfish-actions.pod:4488
25387 msgid "vg-activate-all"
25391 #: ../fish/guestfish-actions.pod:4490
25394 " vg-activate-all true|false\n"
25399 #: ../fish/guestfish-actions.pod:4500
25404 #: ../fish/guestfish-actions.pod:4502
25407 " vgcreate volgroup 'physvols ...'\n"
25412 #: ../fish/guestfish-actions.pod:4507
25417 #: ../fish/guestfish-actions.pod:4509
25420 " vglvuuids vgname\n"
25425 #: ../fish/guestfish-actions.pod:4514
25427 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
25428 "logical volumes and volume groups."
25432 #: ../fish/guestfish-actions.pod:4517
25433 msgid "See also L</vgpvuuids>."
25437 #: ../fish/guestfish-actions.pod:4519
25442 #: ../fish/guestfish-actions.pod:4521
25445 " vgpvuuids vgname\n"
25450 #: ../fish/guestfish-actions.pod:4526
25452 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
25453 "physical volumes and volume groups."
25457 #: ../fish/guestfish-actions.pod:4529
25458 msgid "See also L</vglvuuids>."
25462 #: ../fish/guestfish-actions.pod:4531
25467 #: ../fish/guestfish-actions.pod:4533
25470 " vgremove vgname\n"
25475 #: ../fish/guestfish-actions.pod:4540
25480 #: ../fish/guestfish-actions.pod:4542
25483 " vgrename volgroup newvolgroup\n"
25488 #: ../fish/guestfish-actions.pod:4546
25493 #: ../fish/guestfish-actions.pod:4548
25501 #: ../fish/guestfish-actions.pod:4556
25502 msgid "See also L</vgs-full>."
25506 #: ../fish/guestfish-actions.pod:4558
25511 #: ../fish/guestfish-actions.pod:4560
25519 #: ../fish/guestfish-actions.pod:4565
25524 #: ../fish/guestfish-actions.pod:4567
25532 #: ../fish/guestfish-actions.pod:4572
25537 #: ../fish/guestfish-actions.pod:4574
25545 #: ../fish/guestfish-actions.pod:4578
25550 #: ../fish/guestfish-actions.pod:4580
25558 #: ../fish/guestfish-actions.pod:4585
25563 #: ../fish/guestfish-actions.pod:4587
25571 #: ../fish/guestfish-actions.pod:4592
25576 #: ../fish/guestfish-actions.pod:4594
25584 #: ../fish/guestfish-actions.pod:4599
25589 #: ../fish/guestfish-actions.pod:4601
25592 " write path content\n"
25597 #: ../fish/guestfish-actions.pod:4609
25602 #: ../fish/guestfish-actions.pod:4611
25605 " write-file path content size\n"
25610 #: ../fish/guestfish-actions.pod:4627
25611 msgid "This function is deprecated. In new code, use the L</write> call instead."
25615 #: ../fish/guestfish-actions.pod:4634
25620 #: ../fish/guestfish-actions.pod:4636
25623 " zegrep regex path\n"
25628 #: ../fish/guestfish-actions.pod:4644
25633 #: ../fish/guestfish-actions.pod:4646
25636 " zegrepi regex path\n"
25641 #: ../fish/guestfish-actions.pod:4654
25646 #: ../fish/guestfish-actions.pod:4656
25654 #: ../fish/guestfish-actions.pod:4664
25655 msgid "See also: L</zero-device>, L</scrub-device>."
25659 #: ../fish/guestfish-actions.pod:4666
25660 msgid "zero-device"
25664 #: ../fish/guestfish-actions.pod:4668
25667 " zero-device device\n"
25672 #: ../fish/guestfish-actions.pod:4670
25674 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
25675 "which just zeroes the first few blocks of a device."
25679 #: ../fish/guestfish-actions.pod:4677
25684 #: ../fish/guestfish-actions.pod:4679
25687 " zerofree device\n"
25692 #: ../fish/guestfish-actions.pod:4692
25697 #: ../fish/guestfish-actions.pod:4694
25700 " zfgrep pattern path\n"
25705 #: ../fish/guestfish-actions.pod:4702
25710 #: ../fish/guestfish-actions.pod:4704
25713 " zfgrepi pattern path\n"
25718 #: ../fish/guestfish-actions.pod:4712
25723 #: ../fish/guestfish-actions.pod:4714
25726 " zfile meth path\n"
25731 #: ../fish/guestfish-actions.pod:4721
25732 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
25736 #: ../fish/guestfish-actions.pod:4724
25737 msgid "This function is deprecated. In new code, use the L</file> call instead."
25741 #: ../fish/guestfish-actions.pod:4731
25746 #: ../fish/guestfish-actions.pod:4733
25749 " zgrep regex path\n"
25754 #: ../fish/guestfish-actions.pod:4741
25759 #: ../fish/guestfish-actions.pod:4743
25762 " zgrepi regex path\n"
25767 #: ../fish/guestfish-commands.pod:1
25772 #: ../fish/guestfish-commands.pod:3
25777 #: ../fish/guestfish-commands.pod:5
25780 " alloc filename size\n"
25785 #: ../fish/guestfish-commands.pod:7
25787 "This creates an empty (zeroed) file of the given size, and then adds so it "
25788 "can be further examined."
25792 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25793 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25797 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25798 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25802 #: ../fish/guestfish-commands.pod:14
25804 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25805 "image, see L</PREPARED DISK IMAGES>."
25809 #: ../fish/guestfish-commands.pod:17
25814 #: ../fish/guestfish-commands.pod:19
25817 " copy-in local [local ...] /remotedir\n"
25822 #: ../fish/guestfish-commands.pod:21
25824 "C<copy-in> copies local files or directories recursively into the disk "
25825 "image, placing them in the directory called C</remotedir> (which must "
25826 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25827 "other commands as necessary."
25831 #: ../fish/guestfish-commands.pod:26
25833 "Multiple local files and directories can be specified, but the last "
25834 "parameter must always be a remote directory. Wildcards cannot be used."
25838 #: ../fish/guestfish-commands.pod:30
25843 #: ../fish/guestfish-commands.pod:32
25846 " copy-out remote [remote ...] localdir\n"
25851 #: ../fish/guestfish-commands.pod:34
25853 "C<copy-out> copies remote files or directories recursively out of the disk "
25854 "image, placing them on the host disk in a local directory called C<localdir> "
25855 "(which must exist). This guestfish meta-command turns into a sequence of "
25856 "L</download>, L</tar-out> and other commands as necessary."
25860 #: ../fish/guestfish-commands.pod:40
25862 "Multiple remote files and directories can be specified, but the last "
25863 "parameter must always be a local directory. To download to the current "
25864 "directory, use C<.> as in:"
25868 #: ../fish/guestfish-commands.pod:44
25871 " copy-out /home .\n"
25876 #: ../fish/guestfish-commands.pod:46
25878 "Wildcards cannot be used in the ordinary command, but you can use them with "
25879 "the help of L</glob> like this:"
25883 #: ../fish/guestfish-commands.pod:49
25886 " glob copy-out /home/* .\n"
25891 #: ../fish/guestfish-commands.pod:51
25896 #: ../fish/guestfish-commands.pod:53
25899 " echo [params ...]\n"
25904 #: ../fish/guestfish-commands.pod:55
25905 msgid "This echos the parameters to the terminal."
25909 #: ../fish/guestfish-commands.pod:57
25914 #: ../fish/guestfish-commands.pod:59
25919 #: ../fish/guestfish-commands.pod:61
25924 #: ../fish/guestfish-commands.pod:63
25932 #: ../fish/guestfish-commands.pod:65
25934 "This is used to edit a file. It downloads the file, edits it locally using "
25935 "your editor, then uploads the result."
25939 #: ../fish/guestfish-commands.pod:68
25941 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25942 "or C<emacs> you will get those corresponding editors."
25946 #: ../fish/guestfish-commands.pod:72
25951 #: ../fish/guestfish-commands.pod:74
25954 " glob command args...\n"
25959 #: ../fish/guestfish-commands.pod:76
25961 "Expand wildcards in any paths in the args list, and run C<command> "
25962 "repeatedly on each matching path."
25966 #: ../fish/guestfish-commands.pod:79
25967 msgid "See L</WILDCARDS AND GLOBBING>."
25971 #: ../fish/guestfish-commands.pod:81
25976 #: ../fish/guestfish-commands.pod:83
25979 " hexedit <filename|device>\n"
25980 " hexedit <filename|device> <max>\n"
25981 " hexedit <filename|device> <start> <max>\n"
25986 #: ../fish/guestfish-commands.pod:87
25988 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25993 #: ../fish/guestfish-commands.pod:90
25995 "This command works by downloading potentially the whole file or device, "
25996 "editing it locally, then uploading it. If the file or device is large, you "
25997 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25998 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25999 "usual modifiers allowed such as C<1M> (1 megabyte)."
26003 #: ../fish/guestfish-commands.pod:97
26004 msgid "For example to edit the first few sectors of a disk you might do:"
26008 #: ../fish/guestfish-commands.pod:100
26011 " hexedit /dev/sda 1M\n"
26016 #: ../fish/guestfish-commands.pod:102
26018 "which would allow you to edit anywhere within the first megabyte of the "
26023 #: ../fish/guestfish-commands.pod:105
26024 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
26028 #: ../fish/guestfish-commands.pod:107
26031 " hexedit /dev/sda1 0x400 0x400\n"
26036 #: ../fish/guestfish-commands.pod:109
26037 msgid "(assuming the superblock is in the standard location)."
26041 #: ../fish/guestfish-commands.pod:111
26043 "This command requires the external L<hexedit(1)> program. You can specify "
26044 "another program to use by setting the C<HEXEDITOR> environment variable."
26048 #: ../fish/guestfish-commands.pod:115
26049 msgid "See also L</hexdump>."
26053 #: ../fish/guestfish-commands.pod:117
26058 #: ../fish/guestfish-commands.pod:119
26066 #: ../fish/guestfish-commands.pod:121
26067 msgid "Change the local directory, ie. the current directory of guestfish itself."
26071 #: ../fish/guestfish-commands.pod:124
26072 msgid "Note that C<!cd> won't do what you might expect."
26076 #: ../fish/guestfish-commands.pod:126
26081 #: ../fish/guestfish-commands.pod:128
26086 #: ../fish/guestfish-commands.pod:130
26094 #: ../fish/guestfish-commands.pod:132
26095 msgid "Opens the manual page for guestfish."
26099 #: ../fish/guestfish-commands.pod:134
26104 #: ../fish/guestfish-commands.pod:136
26109 #: ../fish/guestfish-commands.pod:138
26117 #: ../fish/guestfish-commands.pod:140
26125 #: ../fish/guestfish-commands.pod:142
26126 msgid "This is used to view a file."
26130 #: ../fish/guestfish-commands.pod:144
26132 "The default viewer is C<$PAGER>. However if you use the alternate command "
26133 "C<less> you will get the C<less> command specifically."
26137 #: ../fish/guestfish-commands.pod:147
26142 #: ../fish/guestfish-commands.pod:149
26150 #: ../fish/guestfish-commands.pod:151
26152 "Close and reopen the libguestfs handle. It is not necessary to use this "
26153 "normally, because the handle is closed properly when guestfish exits. "
26154 "However this is occasionally useful for testing."
26158 #: ../fish/guestfish-commands.pod:155
26163 #: ../fish/guestfish-commands.pod:157
26166 " sparse filename size\n"
26171 #: ../fish/guestfish-commands.pod:159
26173 "This creates an empty sparse file of the given size, and then adds so it can "
26174 "be further examined."
26178 #: ../fish/guestfish-commands.pod:162
26180 "In all respects it works the same as the L</alloc> command, except that the "
26181 "image file is allocated sparsely, which means that disk blocks are not "
26182 "assigned to the file until they are needed. Sparse disk files only use "
26183 "space when written to, but they are slower and there is a danger you could "
26184 "run out of real disk space during a write operation."
26188 #: ../fish/guestfish-commands.pod:172
26193 #: ../fish/guestfish-commands.pod:174
26201 #: ../fish/guestfish-commands.pod:176
26203 "This command returns a list of the optional groups known to the daemon, and "
26204 "indicates which ones are supported by this build of the libguestfs "
26209 #: ../fish/guestfish-commands.pod:180
26210 msgid "See also L<guestfs(3)/AVAILABILITY>."
26214 #: ../fish/guestfish-commands.pod:182
26219 #: ../fish/guestfish-commands.pod:184
26222 " time command args...\n"
26227 #: ../fish/guestfish-commands.pod:186
26229 "Run the command as usual, but print the elapsed time afterwards. This can "
26230 "be useful for benchmarking operations."
26234 #: ../test-tool/libguestfs-test-tool.pod:5
26235 msgid "libguestfs-test-tool - End user tests for libguestfs"
26239 #: ../test-tool/libguestfs-test-tool.pod:9
26242 " libguestfs-test-tool [--options]\n"
26247 #: ../test-tool/libguestfs-test-tool.pod:13
26249 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
26250 "and developers, to allow them to check basic libguestfs functionality is "
26251 "working. This is needed because libguestfs occasionally breaks for reasons "
26252 "beyond our control: usually because of changes in the underlying qemu or "
26253 "kernel packages, or the host environment."
26257 #: ../test-tool/libguestfs-test-tool.pod:20
26258 msgid "If you suspect a problem in libguestfs, then just run:"
26262 #: ../test-tool/libguestfs-test-tool.pod:22
26265 " libguestfs-test-tool\n"
26270 #: ../test-tool/libguestfs-test-tool.pod:24
26271 msgid "It will print lots of diagnostic messages."
26275 #: ../test-tool/libguestfs-test-tool.pod:26
26276 msgid "If it runs to completion successfully, you will see this near the end:"
26280 #: ../test-tool/libguestfs-test-tool.pod:28
26283 " ===== TEST FINISHED OK =====\n"
26288 #: ../test-tool/libguestfs-test-tool.pod:30
26289 msgid "and the test tool will exit with code 0."
26293 #: ../test-tool/libguestfs-test-tool.pod:32
26295 "If it fails (and/or exits with non-zero error code), please paste the "
26296 "B<complete, unedited> output of the test tool into a bug report. More "
26297 "information about reporting bugs can be found on the "
26298 "L<http://libguestfs.org/> website."
26302 #: ../test-tool/libguestfs-test-tool.pod:41
26307 #: ../test-tool/libguestfs-test-tool.pod:43
26308 msgid "Display short usage information and exit."
26312 #: ../test-tool/libguestfs-test-tool.pod:45
26313 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
26317 #: ../test-tool/libguestfs-test-tool.pod:47
26319 "Pass an alternate name for the helper program. libguestfs-test-tool will "
26320 "normally look in the C<$libexec> directory that was configured when the tool "
26325 #: ../test-tool/libguestfs-test-tool.pod:51
26326 msgid "I<--qemu qemu_binary>"
26330 #: ../test-tool/libguestfs-test-tool.pod:53
26332 "If you have downloaded another qemu binary, point this option at the full "
26333 "path of the binary to try it."
26337 #: ../test-tool/libguestfs-test-tool.pod:56
26338 msgid "I<--qemudir qemu_source_dir>"
26342 #: ../test-tool/libguestfs-test-tool.pod:58
26344 "If you have compiled qemu from source, point this option at the source "
26345 "directory to try it."
26349 #: ../test-tool/libguestfs-test-tool.pod:61
26350 msgid "I<--timeout N>"
26354 #: ../test-tool/libguestfs-test-tool.pod:63
26356 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
26357 "does not usually need to be adjusted unless your machine is very slow."
26361 #: ../test-tool/libguestfs-test-tool.pod:69
26362 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
26366 #: ../test-tool/libguestfs-test-tool.pod:71
26368 "If you have compiled another version of qemu from source and would like to "
26369 "try that, then you can use the I<--qemudir> option to point to the qemu "
26370 "source directory."
26374 #: ../test-tool/libguestfs-test-tool.pod:75
26376 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
26377 "option to point to the binary."
26381 #: ../test-tool/libguestfs-test-tool.pod:78
26383 "When using an alternate qemu with libguestfs, usually you would need to "
26384 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
26385 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
26386 "when you use either of the I<--qemudir> or I<--qemu> options."
26390 #: ../test-tool/libguestfs-test-tool.pod:85
26392 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
26393 "I<1> if there was an error."
26397 #: ../test-tool/libguestfs-test-tool.pod:92
26398 msgid "/usr/libexec/libguestfs-test-tool-helper"
26402 #: ../test-tool/libguestfs-test-tool.pod:94
26404 "This helper program is run inside the appliance and provides additional "
26409 #: ../test-tool/libguestfs-test-tool.pod:97
26410 msgid "/usr/bin/mkisofs"
26414 #: ../test-tool/libguestfs-test-tool.pod:99
26416 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
26417 "which is used as part of the tests."
26421 #: ../test-tool/libguestfs-test-tool.pod:106
26423 "For the full list of environment variables which may affect libguestfs, "
26424 "please see the L<guestfs(3)> manual page."
26428 #: ../test-tool/libguestfs-test-tool.pod:111
26429 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
26433 #: ../test-tool/libguestfs-test-tool.pod:121
26434 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
26438 #: ../fuse/guestmount.pod:5
26439 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
26443 #: ../fuse/guestmount.pod:9
26446 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
26451 #: ../fuse/guestmount.pod:11
26454 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
26459 #: ../fuse/guestmount.pod:13
26462 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
26467 #: ../fuse/guestmount.pod:17
26469 "You must I<not> use C<guestmount> in read-write mode on live virtual "
26470 "machines. If you do this, you risk disk corruption in the VM."
26474 #: ../fuse/guestmount.pod:22
26476 "The guestmount program can be used to mount virtual machine filesystems and "
26477 "other disk images on the host. It uses libguestfs for access to the guest "
26478 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
26479 "a mountable device."
26483 #: ../fuse/guestmount.pod:27
26485 "Along with other options, you have to give at least one device (I<-a> "
26486 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
26487 "option) or use the I<-i> inspection option. How this works is better "
26488 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
26493 #: ../fuse/guestmount.pod:33
26495 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
26496 "by you, and the filesystem will not be visible to any other users unless you "
26497 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
26498 "the filesystem, use the C<fusermount -u> command."
26502 #: ../fuse/guestmount.pod:41
26504 "For a typical Windows guest which has its main filesystem on the first "
26509 #: ../fuse/guestmount.pod:44
26512 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
26517 #: ../fuse/guestmount.pod:46
26519 "For a typical Linux guest which has a /boot filesystem on the first "
26520 "partition, and the root filesystem on a logical volume:"
26524 #: ../fuse/guestmount.pod:49
26527 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
26532 #: ../fuse/guestmount.pod:51
26533 msgid "To get libguestfs to detect guest mountpoints for you:"
26537 #: ../fuse/guestmount.pod:53
26540 " guestmount -a guest.img -i --ro /mnt\n"
26545 #: ../fuse/guestmount.pod:55
26546 msgid "For a libvirt guest called \"Guest\" you could do:"
26550 #: ../fuse/guestmount.pod:57
26553 " guestmount -d Guest -i --ro /mnt\n"
26558 #: ../fuse/guestmount.pod:59
26560 "If you don't know what filesystems are contained in a guest or disk image, "
26561 "use L<virt-filesystems(1)> first:"
26565 #: ../fuse/guestmount.pod:62
26568 " virt-filesystems MyGuest\n"
26573 #: ../fuse/guestmount.pod:64
26575 "If you want to trace the libguestfs calls but without excessive debugging "
26576 "information, we recommend:"
26580 #: ../fuse/guestmount.pod:67
26583 " guestmount [...] --trace /mnt\n"
26588 #: ../fuse/guestmount.pod:69
26589 msgid "If you want to debug the program, we recommend:"
26593 #: ../fuse/guestmount.pod:71
26596 " guestmount [...] --trace --verbose /mnt\n"
26601 #: ../fuse/guestmount.pod:77
26602 msgid "B<-a image> | B<--add image>"
26606 #: ../fuse/guestmount.pod:79
26607 msgid "Add a block device or virtual machine image."
26611 #: ../fuse/guestmount.pod:84
26612 msgid "B<-c URI> | B<--connect URI>"
26616 #: ../fuse/guestmount.pod:90
26617 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
26621 #: ../fuse/guestmount.pod:96
26622 msgid "B<--dir-cache-timeout N>"
26626 #: ../fuse/guestmount.pod:98
26628 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
26629 "seconds. The readdir cache [actually, there are several semi-independent "
26630 "caches] is populated after a readdir(2) call with the stat and extended "
26631 "attributes of the files in the directory, in anticipation that they will be "
26632 "requested soon after."
26636 #: ../fuse/guestmount.pod:104
26638 "There is also a different attribute cache implemented by FUSE (see the FUSE "
26639 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
26640 "requests, only cache existing ones."
26644 #: ../fuse/guestmount.pod:115
26645 msgid "B<--format=raw|qcow2|..> | B<--format>"
26649 #: ../fuse/guestmount.pod:122
26651 "If you have untrusted raw-format guest disk images, you should use this "
26652 "option to specify the disk format. This avoids a possible security problem "
26653 "with malicious guests (CVE-2010-3851). See also "
26654 "L<guestfs(3)/guestfs_add_drive_opts>."
26658 #: ../fuse/guestmount.pod:127
26659 msgid "B<--fuse-help>"
26663 #: ../fuse/guestmount.pod:129
26664 msgid "Display help on special FUSE options (see I<-o> below)."
26668 #: ../fuse/guestmount.pod:133
26669 msgid "Display brief help and exit."
26673 #: ../fuse/guestmount.pod:135
26674 msgid "B<-i> | B<--inspector>"
26678 #: ../fuse/guestmount.pod:146
26679 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
26683 #: ../fuse/guestmount.pod:148
26685 "Mount the named partition or logical volume on the given mountpoint B<in the "
26686 "guest> (this has nothing to do with mountpoints in the host)."
26690 #: ../fuse/guestmount.pod:151
26692 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
26693 "something on C</>."
26697 #: ../fuse/guestmount.pod:154
26698 msgid "B<-n> | B<--no-sync>"
26702 #: ../fuse/guestmount.pod:156
26704 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
26705 "unmounted. If you specify this option, then we don't attempt to sync the "
26706 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
26710 #: ../fuse/guestmount.pod:161
26711 msgid "B<-o option> | B<--option option>"
26715 #: ../fuse/guestmount.pod:163
26716 msgid "Pass extra options to FUSE."
26720 #: ../fuse/guestmount.pod:165
26722 "To get a list of all the extra options supported by FUSE, use the command "
26723 "below. Note that only the FUSE I<-o> options can be passed, and only some "
26724 "of them are a good idea."
26728 #: ../fuse/guestmount.pod:169
26731 " guestmount --fuse-help\n"
26736 #: ../fuse/guestmount.pod:171
26737 msgid "Some potentially useful FUSE options:"
26741 #: ../fuse/guestmount.pod:175
26742 msgid "B<-o allow_other>"
26746 #: ../fuse/guestmount.pod:177
26747 msgid "Allow other users to see the filesystem."
26751 #: ../fuse/guestmount.pod:179
26752 msgid "B<-o attr_timeout=N>"
26756 #: ../fuse/guestmount.pod:181
26757 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
26761 #: ../fuse/guestmount.pod:183
26762 msgid "B<-o kernel_cache>"
26766 #: ../fuse/guestmount.pod:185
26768 "Allow the kernel to cache files (reduces the number of reads that have to go "
26769 "through the L<guestfs(3)> API). This is generally a good idea if you can "
26770 "afford the extra memory usage."
26774 #: ../fuse/guestmount.pod:189
26775 msgid "B<-o uid=N> B<-o gid=N>"
26779 #: ../fuse/guestmount.pod:191
26781 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
26782 "the chosen values."
26786 #: ../fuse/guestmount.pod:196
26787 msgid "B<-r> | B<--ro>"
26791 #: ../fuse/guestmount.pod:198
26793 "Add devices and mount everything read-only. Also disallow writes and make "
26794 "the disk appear read-only to FUSE."
26798 #: ../fuse/guestmount.pod:201
26800 "This is highly recommended if you are not going to edit the guest disk. If "
26801 "the guest is running and this option is I<not> supplied, then there is a "
26802 "strong risk of disk corruption in the guest. We try to prevent this from "
26803 "happening, but it is not always possible."
26807 #: ../fuse/guestmount.pod:206
26808 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26812 #: ../fuse/guestmount.pod:210
26813 msgid "Enable SELinux support for the guest."
26817 #: ../fuse/guestmount.pod:212
26818 msgid "B<-v> | B<--verbose>"
26822 #: ../fuse/guestmount.pod:214
26823 msgid "Enable verbose messages from underlying libguestfs."
26827 #: ../fuse/guestmount.pod:216
26828 msgid "B<-V> | B<--version>"
26832 #: ../fuse/guestmount.pod:218
26833 msgid "Display the program version and exit."
26837 #: ../fuse/guestmount.pod:220
26838 msgid "B<-w> | B<--rw>"
26842 #: ../fuse/guestmount.pod:222
26844 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26845 "FOR READ AND WRITE>."
26849 #: ../fuse/guestmount.pod:225
26850 msgid "B<-x> | B<--trace>"
26854 #: ../fuse/guestmount.pod:227
26855 msgid "Trace libguestfs calls and entry into each FUSE function."
26859 #: ../fuse/guestmount.pod:229
26860 msgid "This also stops the daemon from forking into the background."
26864 #: ../fuse/guestmount.pod:235
26866 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26867 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
26868 "L<http://fuse.sf.net/>."
26872 #: ../tools/virt-edit.pl:34
26873 msgid "virt-edit - Edit a file in a virtual machine"
26877 #: ../tools/virt-edit.pl:38
26880 " virt-edit [--options] domname file\n"
26885 #: ../tools/virt-edit.pl:40
26888 " virt-edit [--options] disk.img [disk.img ...] file\n"
26893 #: ../tools/virt-edit.pl:42
26896 " virt-edit [domname|disk.img] file -e 'expr'\n"
26901 #: ../tools/virt-edit.pl:46
26903 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26904 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26905 "doing this, but doesn't catch all cases."
26909 #: ../tools/virt-edit.pl:52
26911 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26912 "the named virtual machine (or disk image)."
26916 #: ../tools/virt-edit.pl:55
26917 msgid "If you want to just view a file, use L<virt-cat(1)>."
26921 #: ../tools/virt-edit.pl:57
26923 "For more complex cases you should look at the L<guestfish(1)> tool (see "
26924 "L</USING GUESTFISH> below)."
26928 #: ../tools/virt-edit.pl:60
26930 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
26931 "files. L<guestfish(1)> can do that and much more."
26935 #: ../tools/virt-edit.pl:65
26936 msgid "Edit the named files interactively:"
26940 #: ../tools/virt-edit.pl:67
26943 " virt-edit mydomain /boot/grub/grub.conf\n"
26948 #: ../tools/virt-edit.pl:69
26951 " virt-edit mydomain /etc/passwd\n"
26956 #: ../tools/virt-edit.pl:71
26958 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26959 "below). To change the init default level to 5:"
26963 #: ../tools/virt-edit.pl:75
26966 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26971 #: ../tools/virt-edit.pl:87 ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
26972 msgid "Display brief help."
26976 #: ../tools/virt-edit.pl:95 ../tools/virt-win-reg.pl:114 ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
26977 msgid "Display version number and exit."
26981 #: ../tools/virt-edit.pl:101
26982 msgid "B<--backup extension> | B<-b extension>"
26986 #: ../tools/virt-edit.pl:103
26988 "Create a backup of the original file I<in the guest disk image>. The backup "
26989 "has the original filename with C<extension> added."
26993 #: ../tools/virt-edit.pl:106
26995 "Usually the first character of C<extension> would be a dot C<.> so you would "
27000 #: ../tools/virt-edit.pl:109
27003 " virt-edit -b .orig [etc]\n"
27008 #: ../tools/virt-edit.pl:111
27009 msgid "By default, no backup file is made."
27013 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122 ../tools/virt-list-partitions.pl:78
27014 msgid "B<--connect URI> | B<-c URI>"
27018 #: ../tools/virt-edit.pl:119 ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124 ../tools/virt-list-partitions.pl:80
27020 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
27021 "to the default libvirt hypervisor."
27025 #: ../tools/virt-edit.pl:122 ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:83
27027 "If you specify guest block devices directly, then libvirt is not used at "
27032 #: ../tools/virt-edit.pl:129 ../tools/virt-win-reg.pl:140 ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
27033 msgid "B<--format> raw"
27037 #: ../tools/virt-edit.pl:131 ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136 ../tools/virt-list-partitions.pl:92
27039 "Specify the format of disk images given on the command line. If this is "
27040 "omitted then the format is autodetected from the content of the disk image."
27044 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140 ../tools/virt-list-partitions.pl:96
27046 "If disk images are requested from libvirt, then this program asks libvirt "
27047 "for this information. In this case, the value of the format parameter is "
27052 #: ../tools/virt-edit.pl:139 ../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:144 ../tools/virt-list-partitions.pl:100
27054 "If working with untrusted raw-format guest disk images, you should ensure "
27055 "the format is always specified."
27059 #: ../tools/virt-edit.pl:146
27060 msgid "B<--expr EXPR> | B<-e EXPR>"
27064 #: ../tools/virt-edit.pl:148
27066 "Instead of launching the external editor, non-interactively apply the Perl "
27067 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
27072 #: ../tools/virt-edit.pl:152
27074 "Be careful to properly quote the expression to prevent it from being altered "
27079 #: ../tools/virt-edit.pl:272
27080 msgid "NON-INTERACTIVE EDITING"
27084 #: ../tools/virt-edit.pl:274
27086 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
27087 "administrator can interactively edit the file."
27091 #: ../tools/virt-edit.pl:277
27093 "There are two ways also to use C<virt-edit> from scripts in order to make "
27094 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
27095 "like this, it's less error-prone to write scripts directly using the "
27096 "libguestfs API and Augeas for configuration file editing.)"
27100 #: ../tools/virt-edit.pl:283
27102 "The first method is to temporarily set C<$EDITOR> to any script or program "
27103 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
27104 "update C<tmpfile> in place however it likes."
27108 #: ../tools/virt-edit.pl:287
27110 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
27111 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
27112 "instances of C<foo> with C<bar> in a file:"
27116 #: ../tools/virt-edit.pl:291
27119 " virt-edit domname filename -e 's/foo/bar/'\n"
27124 #: ../tools/virt-edit.pl:293
27126 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
27127 "For example to delete root's password you could do:"
27131 #: ../tools/virt-edit.pl:296
27134 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
27139 #: ../tools/virt-edit.pl:298
27141 "What really happens is that the snippet is evaluated as a Perl expression "
27142 "for each line of the file. The line, including the final C<\\n>, is passed "
27143 "in C<$_> and the expression should update C<$_> or leave it unchanged."
27147 #: ../tools/virt-edit.pl:303
27149 "To delete a line, set C<$_> to the empty string. For example, to delete the "
27150 "C<apache> user account from the password file you can do:"
27154 #: ../tools/virt-edit.pl:306
27157 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
27162 #: ../tools/virt-edit.pl:308
27164 "To insert a line, prepend or append it to C<$_>. However appending lines to "
27165 "the end of the file is rather difficult this way since there is no concept "
27166 "of \"last line of the file\" - your expression just doesn't get called "
27167 "again. You might want to use the first method (setting C<$EDITOR>) if you "
27172 #: ../tools/virt-edit.pl:314
27174 "The variable C<$lineno> contains the current line number. As is "
27175 "traditional, the first line in the file is number C<1>."
27179 #: ../tools/virt-edit.pl:317
27181 "The return value from the expression is ignored, but the expression may call "
27182 "C<die> in order to abort the whole program, leaving the original file "
27187 #: ../tools/virt-edit.pl:321
27189 "Remember when matching the end of a line that C<$_> may contain the final "
27190 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
27191 "newline then neither of these. Thus to match or substitute some text at the "
27192 "end of a line, use this regular expression:"
27196 #: ../tools/virt-edit.pl:326
27199 " /some text(\\r?\\n)?$/\n"
27204 #: ../tools/virt-edit.pl:328
27206 "Alternately, use the perl C<chomp> function, being careful not to chomp "
27207 "C<$_> itself (since that would remove all newlines from the file):"
27211 #: ../tools/virt-edit.pl:332
27214 " my $m = $_; chomp $m; $m =~ /some text$/\n"
27219 #: ../tools/virt-edit.pl:334
27220 msgid "USING GUESTFISH"
27224 #: ../tools/virt-edit.pl:336
27226 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
27227 "C<virt-edit> doesn't work."
27231 #: ../tools/virt-edit.pl:339
27232 msgid "Using C<virt-edit> is approximately equivalent to doing:"
27236 #: ../tools/virt-edit.pl:341
27239 " guestfish --rw -i -d domname edit /file\n"
27244 #: ../tools/virt-edit.pl:343
27246 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
27247 "path to the file."
27251 #: ../tools/virt-edit.pl:346
27253 "The command above uses libguestfs's guest inspection feature and so does not "
27254 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
27255 "disk images that don't contain guests. To edit a file on a disk image "
27260 #: ../tools/virt-edit.pl:351
27263 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
27268 #: ../tools/virt-edit.pl:353
27270 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
27271 "the disk image to edit, and C</file> is the full path to the file."
27275 #: ../tools/virt-edit.pl:357
27277 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
27278 "C<write> or C<upload> instead:"
27282 #: ../tools/virt-edit.pl:360
27285 " guestfish --rw -i -d domname touch /newfile\n"
27290 #: ../tools/virt-edit.pl:362
27293 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
27298 #: ../tools/virt-edit.pl:364
27301 " guestfish --rw -i -d domname upload localfile /newfile\n"
27306 #: ../tools/virt-edit.pl:366
27307 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
27311 #: ../tools/virt-edit.pl:369
27314 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
27319 #: ../tools/virt-edit.pl:379
27324 #: ../tools/virt-edit.pl:381
27326 "If set, this string is used as the editor. It may contain arguments, "
27327 "eg. C<\"emacs -nw\">"
27331 #: ../tools/virt-edit.pl:384
27332 msgid "If not set, C<vi> is used."
27336 #: ../tools/virt-edit.pl:388 ../tools/virt-win-reg.pl:559 ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274 ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
27337 msgid "SHELL QUOTING"
27341 #: ../tools/virt-edit.pl:390 ../tools/virt-win-reg.pl:567 ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
27343 "Libvirt guest names can contain arbitrary characters, some of which have "
27344 "meaning to the shell such as C<#> and space. You may need to quote or "
27345 "escape these characters on the command line. See the shell manual page "
27346 "L<sh(1)> for details."
27350 #: ../tools/virt-edit.pl:397
27352 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27353 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
27354 "L<perl(1)>, L<perlre(1)>."
27358 #: ../tools/virt-edit.pl:407 ../tools/virt-win-reg.pl:598 ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
27363 #: ../tools/virt-edit.pl:409 ../tools/virt-win-reg.pl:600 ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
27364 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
27368 #: ../tools/virt-edit.pl:413
27369 msgid "Copyright (C) 2009-2011 Red Hat Inc."
27373 #: ../tools/virt-win-reg.pl:37
27375 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
27380 #: ../tools/virt-win-reg.pl:41
27383 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
27388 #: ../tools/virt-win-reg.pl:43
27391 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
27396 #: ../tools/virt-win-reg.pl:45
27399 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
27404 #: ../tools/virt-win-reg.pl:47
27407 " virt-win-reg --merge domname [input.reg ...]\n"
27412 #: ../tools/virt-win-reg.pl:49
27415 " virt-win-reg [--options] disk.img ... # instead of domname\n"
27420 #: ../tools/virt-win-reg.pl:53
27422 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
27423 "virtual machines. If you do this, you I<will> get irreversible disk "
27424 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
27425 "but doesn't catch all cases."
27429 #: ../tools/virt-win-reg.pl:58
27431 "Modifying the Windows Registry is an inherently risky operation. The format "
27432 "is deliberately obscure and undocumented, and Registry changes can leave the "
27433 "system unbootable. Therefore when using the C<--merge> option, make sure "
27434 "you have a reliable backup first."
27438 #: ../tools/virt-win-reg.pl:65
27440 "This program can export and merge Windows Registry entries from a Windows "
27445 #: ../tools/virt-win-reg.pl:68
27447 "The first parameter is the libvirt guest name or the raw disk image of a "
27452 #: ../tools/virt-win-reg.pl:71
27454 "If C<--merge> is I<not> specified, then the chosen registry key is "
27455 "displayed/exported (recursively). For example:"
27459 #: ../tools/virt-win-reg.pl:74
27462 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
27467 #: ../tools/virt-win-reg.pl:76
27468 msgid "You can also display single values from within registry keys, for example:"
27472 #: ../tools/virt-win-reg.pl:79
27475 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
27476 " $ virt-win-reg Windows7 $cvkey ProductName\n"
27477 " Windows 7 Enterprise\n"
27482 #: ../tools/virt-win-reg.pl:83
27484 "With C<--merge>, you can merge a textual regedit file into the Windows "
27489 #: ../tools/virt-win-reg.pl:86
27492 " $ virt-win-reg --merge Windows7 changes.reg\n"
27497 #: ../tools/virt-win-reg.pl:88
27502 #: ../tools/virt-win-reg.pl:90
27504 "This program is only meant for simple access to the registry. If you want "
27505 "to do complicated things with the registry, we suggest you download the "
27506 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27507 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27508 "L<hivexregedit(1)>."
27512 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
27517 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
27518 msgid "Enable debugging messages."
27522 #: ../tools/virt-win-reg.pl:157
27527 #: ../tools/virt-win-reg.pl:159
27529 "In merge mode, this merges a textual regedit file into the Windows Registry "
27530 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27531 "displays or exports Registry entries instead."
27535 #: ../tools/virt-win-reg.pl:163
27537 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27538 "result in disk corruption. However exporting (without this flag) is always "
27543 #: ../tools/virt-win-reg.pl:171
27544 msgid "B<--encoding> UTF-16LE|ASCII"
27548 #: ../tools/virt-win-reg.pl:173
27550 "When merging (only), you may need to specify the encoding for strings to be "
27551 "used in the hive file. This is explained in detail in "
27552 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
27556 #: ../tools/virt-win-reg.pl:177
27558 "The default is to use UTF-16LE, which should work with recent versions of "
27563 #: ../tools/virt-win-reg.pl:402
27564 msgid "SUPPORTED SYSTEMS"
27568 #: ../tools/virt-win-reg.pl:404
27570 "The program currently supports Windows NT-derived guests starting with "
27571 "Windows XP through to at least Windows 7."
27575 #: ../tools/virt-win-reg.pl:407
27577 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
27578 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
27579 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
27583 #: ../tools/virt-win-reg.pl:411
27585 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
27590 #: ../tools/virt-win-reg.pl:414
27592 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
27597 #: ../tools/virt-win-reg.pl:417
27602 #: ../tools/virt-win-reg.pl:419
27604 "C<virt-win-reg> expects that regedit files have already been reencoded in "
27605 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
27606 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
27607 "with Windows-style line endings, you may need to reencode the whole file "
27608 "before or after processing."
27612 #: ../tools/virt-win-reg.pl:425
27614 "To reencode a file from Windows format to Linux (before processing it with "
27615 "the C<--merge> option), you would do something like this:"
27619 #: ../tools/virt-win-reg.pl:428
27622 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
27627 #: ../tools/virt-win-reg.pl:430
27629 "To go in the opposite direction, after exporting and before sending the file "
27630 "to a Windows user, do something like this:"
27634 #: ../tools/virt-win-reg.pl:433
27637 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
27642 #: ../tools/virt-win-reg.pl:435
27643 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
27647 #: ../tools/virt-win-reg.pl:437
27649 "If you are unsure about the current encoding, use the L<file(1)> command. "
27650 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
27651 "Windows-style (CRLF) line endings, like this:"
27655 #: ../tools/virt-win-reg.pl:441
27658 " $ file software.reg\n"
27659 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
27660 " with CRLF line terminators\n"
27665 #: ../tools/virt-win-reg.pl:445
27666 msgid "This file would need conversion before you could C<--merge> it."
27670 #: ../tools/virt-win-reg.pl:447
27671 msgid "CurrentControlSet etc."
27675 #: ../tools/virt-win-reg.pl:449
27677 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
27678 "Registry at the level of the hive file, and therefore you cannot modify "
27683 #: ../tools/virt-win-reg.pl:453
27685 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
27686 "circumstances it might refer to another control set. The way to find out is "
27687 "to look at the C<HKLM\\SYSTEM\\Select> key:"
27691 #: ../tools/virt-win-reg.pl:457
27694 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
27695 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
27696 " \"Current\"=dword:00000001\n"
27697 " \"Default\"=dword:00000001\n"
27698 " \"Failed\"=dword:00000000\n"
27699 " \"LastKnownGood\"=dword:00000002\n"
27704 #: ../tools/virt-win-reg.pl:464
27705 msgid "\"Current\" is the one which Windows will choose when it boots."
27709 #: ../tools/virt-win-reg.pl:466
27710 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
27714 #: ../tools/virt-win-reg.pl:469
27715 msgid "WINDOWS TIPS"
27719 #: ../tools/virt-win-reg.pl:471
27721 "Note that some of these tips modify the guest disk image. The guest I<must> "
27722 "be shut off, else you will get disk corruption."
27726 #: ../tools/virt-win-reg.pl:474
27727 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
27731 #: ../tools/virt-win-reg.pl:476
27733 "Prepare a DOS batch script, VBScript or executable. Upload this using "
27734 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
27735 "is uploaded into C<C:\\>:"
27739 #: ../tools/virt-win-reg.pl:480
27742 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
27747 #: ../tools/virt-win-reg.pl:482
27748 msgid "Prepare a regedit file containing the registry change:"
27752 #: ../tools/virt-win-reg.pl:484
27755 " cat > test.reg <<'EOF'\n"
27756 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
27757 " \"Test\"=\"c:\\\\test.bat\"\n"
27763 #: ../tools/virt-win-reg.pl:489
27765 "In this example we use the key C<RunOnce> which means that the script will "
27766 "run precisely once when the first user logs in. If you want it to run every "
27767 "time a user logs in, replace C<RunOnce> with C<Run>."
27771 #: ../tools/virt-win-reg.pl:493
27772 msgid "Now update the registry:"
27776 #: ../tools/virt-win-reg.pl:495
27779 " virt-win-reg --merge WindowsGuest test.reg\n"
27784 #: ../tools/virt-win-reg.pl:497
27785 msgid "INSTALLING A SERVICE"
27789 #: ../tools/virt-win-reg.pl:499
27791 "This section assumes you are familiar with Windows services, and you either "
27792 "have a program which handles the Windows Service Control Protocol directly "
27793 "or you want to run any program using a service wrapper like SrvAny or the "
27798 #: ../tools/virt-win-reg.pl:504
27800 "First upload the program and optionally the service wrapper. In this case "
27801 "the test program is called C<test.exe> and we are using the RHSrvAny "
27806 #: ../tools/virt-win-reg.pl:508
27809 " guestfish -i -d WindowsGuest <<EOF\n"
27810 " upload rhsrvany.exe /rhsrvany.exe\n"
27811 " upload test.exe /test.exe\n"
27817 #: ../tools/virt-win-reg.pl:513
27819 "Prepare a regedit file containing the registry changes. In this example, "
27820 "the first registry change is needed for the service itself or the service "
27821 "wrapper (if used). The second registry change is only needed because I am "
27822 "using the RHSrvAny service wrapper."
27826 #: ../tools/virt-win-reg.pl:518
27829 " cat > service.reg <<'EOF'\n"
27830 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
27831 " \"Type\"=dword:00000010\n"
27832 " \"Start\"=dword:00000002\n"
27833 " \"ErrorControl\"=dword:00000001\n"
27834 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
27835 " \"DisplayName\"=\"RHSrvAny\"\n"
27836 " \"ObjectName\"=\"NetworkService\"\n"
27841 #: ../tools/virt-win-reg.pl:527
27844 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
27845 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
27846 " \"PWD\"=\"c:\\\\Temp\"\n"
27852 #: ../tools/virt-win-reg.pl:538
27854 "For use of C<ControlSet001> see the section above in this manual page. You "
27855 "may need to adjust this according to the control set that is in use by the "
27860 #: ../tools/virt-win-reg.pl:544
27862 "C<\"ObjectName\"> controls the privileges that the service will have. An "
27863 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
27864 "privileged account."
27868 #: ../tools/virt-win-reg.pl:550
27870 "For the meaning of the magic numbers, see this Microsoft KB article: "
27871 "L<http://support.microsoft.com/kb/103000>."
27875 #: ../tools/virt-win-reg.pl:555
27876 msgid "Update the registry:"
27880 #: ../tools/virt-win-reg.pl:557
27883 " virt-win-reg --merge WindowsGuest service.reg\n"
27888 #: ../tools/virt-win-reg.pl:561
27890 "Be careful when passing parameters containing C<\\> (backslash) in the "
27891 "shell. Usually you will have to use 'single quotes' or double backslashes "
27892 "(but not both) to protect them from the shell."
27896 #: ../tools/virt-win-reg.pl:565
27897 msgid "Paths and value names are case-insensitive."
27901 #: ../tools/virt-win-reg.pl:574
27903 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
27904 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27905 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
27906 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27910 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
27912 "When reporting bugs, please enable debugging and capture the I<complete> "
27917 #: ../tools/virt-win-reg.pl:592
27920 " export LIBGUESTFS_DEBUG=1\n"
27921 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
27926 #: ../tools/virt-win-reg.pl:595
27928 "Attach /tmp/virt-win-reg.log to a new bug report at "
27929 "L<https://bugzilla.redhat.com/>"
27933 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:570
27934 msgid "Copyright (C) 2010 Red Hat Inc."
27938 #: ../tools/virt-resize.pl:42
27939 msgid "virt-resize - Resize a virtual machine disk"
27943 #: ../tools/virt-resize.pl:46
27946 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27947 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27948 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27953 #: ../tools/virt-resize.pl:52
27955 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27956 "larger or smaller overall, and resizing or deleting any partitions contained "
27961 #: ../tools/virt-resize.pl:56
27963 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27964 "not> be used on live virtual machines - for consistent results, shut the "
27965 "virtual machine down before resizing it."
27969 #: ../tools/virt-resize.pl:60
27971 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
27972 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
27976 #: ../tools/virt-resize.pl:66
27978 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27979 "fill the extra 5GB of space."
27983 #: ../tools/virt-resize.pl:69
27986 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27987 " virt-filesystems --long -h --all -a olddisk\n"
27988 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27989 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27994 #: ../tools/virt-resize.pl:74
27996 "As above, but make the /boot partition 200MB bigger, while giving the "
27997 "remaining space to /dev/sda2:"
28001 #: ../tools/virt-resize.pl:77
28004 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
28009 #: ../tools/virt-resize.pl:79
28010 msgid "As above, but the output format will be uncompressed qcow2:"
28014 #: ../tools/virt-resize.pl:81
28017 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
28018 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
28023 #: ../tools/virt-resize.pl:84
28024 msgid "DETAILED USAGE"
28028 #: ../tools/virt-resize.pl:86
28029 msgid "EXPANDING A VIRTUAL MACHINE DISK"
28033 #: ../tools/virt-resize.pl:90
28034 msgid "1. Shut down the virtual machine"
28038 #: ../tools/virt-resize.pl:92
28039 msgid "2. Locate input disk image"
28043 #: ../tools/virt-resize.pl:94
28045 "Locate the input disk image (ie. the file or device on the host containing "
28046 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
28047 "dumpxml> like this to find the disk image name:"
28051 #: ../tools/virt-resize.pl:98
28054 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
28055 " Found 1 nodes:\n"
28057 " <source dev=\"/dev/vg/lv_guest\" />\n"
28062 #: ../tools/virt-resize.pl:103
28063 msgid "3. Look at current sizing"
28067 #: ../tools/virt-resize.pl:105
28068 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
28072 #: ../tools/virt-resize.pl:108
28075 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
28076 " Name Type Size Parent\n"
28077 " /dev/sda1 partition 101M /dev/sda\n"
28078 " /dev/sda2 partition 7.9G /dev/sda\n"
28079 " /dev/sda device 8.0G -\n"
28084 #: ../tools/virt-resize.pl:114
28086 "(This example is a virtual machine with an 8 GB disk which we would like to "
28087 "expand up to 10 GB)."
28091 #: ../tools/virt-resize.pl:117
28092 msgid "4. Create output disk"
28096 #: ../tools/virt-resize.pl:119
28098 "Virt-resize cannot do in-place disk modifications. You have to have space "
28099 "to store the resized output disk."
28103 #: ../tools/virt-resize.pl:122
28104 msgid "To store the resized disk image in a file, create a file of a suitable size:"
28108 #: ../tools/virt-resize.pl:125
28111 " # rm -f outdisk\n"
28112 " # truncate -s 10G outdisk\n"
28117 #: ../tools/virt-resize.pl:128
28118 msgid "Or use L<lvcreate(1)> to create a logical volume:"
28122 #: ../tools/virt-resize.pl:130
28125 " # lvcreate -L 10G -n lv_name vg_name\n"
28130 #: ../tools/virt-resize.pl:132
28131 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
28135 #: ../tools/virt-resize.pl:134
28138 " # virsh pool-list\n"
28139 " # virsh vol-create-as poolname newvol 10G\n"
28144 #: ../tools/virt-resize.pl:137
28149 #: ../tools/virt-resize.pl:139
28151 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
28152 "file) and the output disk. The output disk is the one created in the "
28157 #: ../tools/virt-resize.pl:143
28160 " # virt-resize indisk outdisk\n"
28165 #: ../tools/virt-resize.pl:145
28167 "This command just copies disk image C<indisk> to disk image C<outdisk> "
28168 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
28169 "larger, then an extra, empty partition is created at the end of the disk "
28170 "covering the extra space. If C<outdisk> is smaller, then it will give an "
28175 #: ../tools/virt-resize.pl:151
28177 "More realistically you'd want to expand existing partitions in the disk "
28178 "image by passing extra options (for the full list see the L</OPTIONS> "
28183 #: ../tools/virt-resize.pl:155
28185 "L</--expand> is the most useful option. It expands the named partition "
28186 "within the disk to fill any extra space:"
28190 #: ../tools/virt-resize.pl:158
28193 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
28198 #: ../tools/virt-resize.pl:160
28200 "(In this case, an extra partition is I<not> created at the end of the disk, "
28201 "because there will be no unused space)."
28205 #: ../tools/virt-resize.pl:163
28207 "L</--resize> is the other commonly used option. The following would "
28208 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
28209 "rest of the available space:"
28213 #: ../tools/virt-resize.pl:167
28216 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
28217 " indisk outdisk\n"
28222 #: ../tools/virt-resize.pl:170
28224 "If the expanded partition in the image contains a filesystem or LVM PV, then "
28225 "if virt-resize knows how, it will resize the contents, the equivalent of "
28226 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
28227 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
28228 "filesystems, so you would have to online resize them after booting the "
28233 #: ../tools/virt-resize.pl:177
28234 msgid "Other options are covered below."
28238 #: ../tools/virt-resize.pl:179
28243 #: ../tools/virt-resize.pl:181
28244 msgid "Thoroughly test the new disk image I<before> discarding the old one."
28248 #: ../tools/virt-resize.pl:183
28249 msgid "If you are using libvirt, edit the XML to point at the new disk:"
28253 #: ../tools/virt-resize.pl:185
28256 " # virsh edit guestname\n"
28261 #: ../tools/virt-resize.pl:187
28263 "Change E<lt>source ...E<gt>, see "
28264 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
28268 #: ../tools/virt-resize.pl:190
28269 msgid "Then start up the domain with the new, resized disk:"
28273 #: ../tools/virt-resize.pl:192
28276 " # virsh start guestname\n"
28281 #: ../tools/virt-resize.pl:194
28283 "and check that it still works. See also the L</NOTES> section below for "
28284 "additional information."
28288 #: ../tools/virt-resize.pl:197
28289 msgid "7. Resize LVs etc inside the guest"
28293 #: ../tools/virt-resize.pl:199
28294 msgid "(This can also be done offline using L<guestfish(1)>)"
28298 #: ../tools/virt-resize.pl:201
28300 "Once the guest has booted you should see the new space available, at least "
28301 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
28302 "may need to resize LVs inside PVs, and also resize filesystem types that "
28303 "virt-resize does not know how to expand."
28307 #: ../tools/virt-resize.pl:208
28308 msgid "SHRINKING A VIRTUAL MACHINE DISK"
28312 #: ../tools/virt-resize.pl:210
28314 "Shrinking is somewhat more complex than expanding, and only an overview is "
28319 #: ../tools/virt-resize.pl:213
28321 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
28322 "filesystems). The user has to shrink content before passing the disk image "
28323 "to virt-resize, and virt-resize will check that the content has been shrunk "
28328 #: ../tools/virt-resize.pl:218
28329 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28333 #: ../tools/virt-resize.pl:220
28335 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28336 "steps 3 and 4 above to allocate a new disk image."
28340 #: ../tools/virt-resize.pl:223
28341 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28345 #: ../tools/virt-resize.pl:226
28346 msgid "IGNORING OR DELETING PARTITIONS"
28350 #: ../tools/virt-resize.pl:228
28352 "virt-resize also gives a convenient way to ignore or delete partitions when "
28353 "copying from the input disk to the output disk. Ignoring a partition speeds "
28354 "up the copy where you don't care about the existing contents of a "
28355 "partition. Deleting a partition removes it completely, but note that it "
28356 "also renumbers any partitions after the one which is deleted, which can "
28357 "leave some guests unbootable."
28361 #: ../tools/virt-resize.pl:235
28362 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28366 #: ../tools/virt-resize.pl:237
28368 "If the input disk is in qcow2 format, then you may prefer that the output is "
28369 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28370 "the fly. The output format is simply determined by the format of the empty "
28371 "output container that you provide. Thus to create qcow2 output, use:"
28375 #: ../tools/virt-resize.pl:243
28378 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28383 #: ../tools/virt-resize.pl:245
28384 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28388 #: ../tools/virt-resize.pl:247
28389 msgid "Similarly, to get non-sparse raw output use:"
28393 #: ../tools/virt-resize.pl:249
28396 " fallocate -l size outdisk\n"
28401 #: ../tools/virt-resize.pl:251
28403 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
28404 "if=/dev/zero of=outdisk bs=1M count=..>)"
28408 #: ../tools/virt-resize.pl:264
28409 msgid "Display help."
28413 #: ../tools/virt-resize.pl:278
28414 msgid "B<--resize part=size>"
28418 #: ../tools/virt-resize.pl:280
28420 "Resize the named partition (expanding or shrinking it) so that it has the "
28425 #: ../tools/virt-resize.pl:283
28427 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28428 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28429 "Exabytes; or as a percentage of the current size; or as a relative number or "
28430 "percentage. For example:"
28434 #: ../tools/virt-resize.pl:288
28437 " --resize /dev/sda2=10G\n"
28442 #: ../tools/virt-resize.pl:290
28445 " --resize /dev/sda4=90%\n"
28450 #: ../tools/virt-resize.pl:292
28453 " --resize /dev/sda2=+1G\n"
28458 #: ../tools/virt-resize.pl:294
28461 " --resize /dev/sda2=-200M\n"
28466 #: ../tools/virt-resize.pl:296
28469 " --resize /dev/sda1=+128K\n"
28474 #: ../tools/virt-resize.pl:298
28477 " --resize /dev/sda1=+10%\n"
28482 #: ../tools/virt-resize.pl:300
28485 " --resize /dev/sda1=-10%\n"
28490 #: ../tools/virt-resize.pl:302
28492 "You can increase the size of any partition. Virt-resize will expand the "
28493 "direct content of the partition if it knows how (see C<--expand> below)."
28497 #: ../tools/virt-resize.pl:306
28499 "You can only I<decrease> the size of partitions that contain filesystems or "
28500 "PVs which have already been shrunk. Virt-resize will check this has been "
28501 "done before proceeding, or else will print an error (see also "
28502 "C<--resize-force>)."
28506 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
28507 msgid "You can give this option multiple times."
28511 #: ../tools/virt-resize.pl:317
28512 msgid "B<--resize-force part=size>"
28516 #: ../tools/virt-resize.pl:319
28518 "This is the same as C<--resize> except that it will let you decrease the "
28519 "size of any partition. Generally this means you will lose any data which "
28520 "was at the end of the partition you shrink, but you may not care about that "
28521 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28522 "as a swap partition)."
28526 #: ../tools/virt-resize.pl:325
28527 msgid "See also the C<--ignore> option."
28531 #: ../tools/virt-resize.pl:331
28532 msgid "B<--expand part>"
28536 #: ../tools/virt-resize.pl:333
28538 "Expand the named partition so it uses up all extra space (space left over "
28539 "after any other resize changes that you request have been done)."
28543 #: ../tools/virt-resize.pl:336
28545 "If virt-resize knows how, it will expand the direct content of the "
28546 "partition. For example, if the partition is an LVM PV, it will expand the "
28547 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28548 "content it doesn't know about alone."
28552 #: ../tools/virt-resize.pl:341
28553 msgid "Currently virt-resize can resize:"
28557 #: ../tools/virt-resize.pl:347
28559 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28564 #: ../tools/virt-resize.pl:352
28566 "NTFS filesystems contained directly in a partition, if libguestfs was "
28567 "compiled with support for NTFS."
28571 #: ../tools/virt-resize.pl:355
28573 "The filesystem must have been shut down consistently last time it was used. "
28574 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
28575 "consistency check, so at the first boot after resizing Windows will check "
28580 #: ../tools/virt-resize.pl:362
28582 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
28583 "inside the PV, but see the C<--LV-expand> option. The user could also "
28584 "resize LVs as desired after boot."
28588 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
28589 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
28593 #: ../tools/virt-resize.pl:374
28594 msgid "B<--shrink part>"
28598 #: ../tools/virt-resize.pl:376
28600 "Shrink the named partition until the overall disk image fits in the "
28601 "destination. The named partition B<must> contain a filesystem or PV which "
28602 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
28603 "online tools). Virt-resize will check this and give an error if it has not "
28608 #: ../tools/virt-resize.pl:382
28610 "The amount by which the overall disk must be shrunk (after carrying out all "
28611 "other operations requested by the user) is called the \"deficit\". For "
28612 "example, a straight copy (assume no other operations) from a 5GB disk image "
28613 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
28614 "would give an error unless the user specified a partition to shrink and that "
28615 "partition had more than a gigabyte of free space."
28619 #: ../tools/virt-resize.pl:396
28620 msgid "B<--ignore part>"
28624 #: ../tools/virt-resize.pl:398
28626 "Ignore the named partition. Effectively this means the partition is "
28627 "allocated on the destination disk, but the content is not copied across from "
28628 "the source disk. The content of the partition will be blank (all zero "
28633 #: ../tools/virt-resize.pl:409
28634 msgid "B<--delete part>"
28638 #: ../tools/virt-resize.pl:411
28640 "Delete the named partition. It would be more accurate to describe this as "
28641 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
28642 "the original disk image is left intact."
28646 #: ../tools/virt-resize.pl:415
28648 "Note that when you delete a partition, then anything contained in the "
28649 "partition is also deleted. Furthermore, this causes any partitions that "
28650 "come after to be I<renumbered>, which can easily make your guest unbootable."
28654 #: ../tools/virt-resize.pl:426
28655 msgid "B<--LV-expand logvol>"
28659 #: ../tools/virt-resize.pl:428
28661 "This takes the logical volume and, as a final step, expands it to fill all "
28662 "the space available in its volume group. A typical usage, assuming a Linux "
28663 "guest with a single PV C</dev/sda2> and a root device called "
28664 "C</dev/vg_guest/lv_root> would be:"
28668 #: ../tools/virt-resize.pl:433
28671 " virt-resize indisk outdisk \\\n"
28672 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
28677 #: ../tools/virt-resize.pl:436
28679 "This would first expand the partition (and PV), and then expand the root "
28680 "device to fill the extra space in the PV."
28684 #: ../tools/virt-resize.pl:439
28686 "The contents of the LV are also resized if virt-resize knows how to do "
28687 "that. You can stop virt-resize from trying to expand the content by using "
28688 "the option C<--no-expand-content>."
28692 #: ../tools/virt-resize.pl:443
28693 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
28697 #: ../tools/virt-resize.pl:446
28699 "You can give this option multiple times, I<but> it doesn't make sense to do "
28700 "this unless the logical volumes you specify are all in different volume "
28705 #: ../tools/virt-resize.pl:454
28706 msgid "B<--no-copy-boot-loader>"
28710 #: ../tools/virt-resize.pl:456
28712 "By default, virt-resize copies over some sectors at the start of the disk "
28713 "(up to the beginning of the first partition). Commonly these sectors "
28714 "contain the Master Boot Record (MBR) and the boot loader, and are required "
28715 "in order for the guest to boot correctly."
28719 #: ../tools/virt-resize.pl:461
28721 "If you specify this flag, then this initial copy is not done. You may need "
28722 "to reinstall the boot loader in this case."
28726 #: ../tools/virt-resize.pl:469
28727 msgid "B<--no-extra-partition>"
28731 #: ../tools/virt-resize.pl:471
28733 "By default, virt-resize creates an extra partition if there is any extra, "
28734 "unused space after all resizing has happened. Use this option to prevent "
28735 "the extra partition from being created. If you do this then the extra space "
28736 "will be inaccessible until you run fdisk, parted, or some other partitioning "
28737 "tool in the guest."
28741 #: ../tools/virt-resize.pl:477
28743 "Note that if the surplus space is smaller than 10 MB, no extra partition "
28748 #: ../tools/virt-resize.pl:484
28749 msgid "B<--no-expand-content>"
28753 #: ../tools/virt-resize.pl:486
28755 "By default, virt-resize will try to expand the direct contents of "
28756 "partitions, if it knows how (see C<--expand> option above)."
28760 #: ../tools/virt-resize.pl:489
28762 "If you give the C<--no-expand-content> option then virt-resize will not "
28767 #: ../tools/virt-resize.pl:496
28768 msgid "B<-d> | B<--debug>"
28772 #: ../tools/virt-resize.pl:504
28773 msgid "B<-n> | B<--dryrun>"
28777 #: ../tools/virt-resize.pl:506
28778 msgid "Print a summary of what would be done, but don't do anything."
28782 #: ../tools/virt-resize.pl:512
28783 msgid "B<-q> | B<--quiet>"
28787 #: ../tools/virt-resize.pl:514
28788 msgid "Don't print the summary."
28792 #: ../tools/virt-resize.pl:522
28794 "Specify the format of the input disk image. If this flag is not given then "
28795 "it is auto-detected from the image itself."
28799 #: ../tools/virt-resize.pl:528
28801 "Note that this option I<does not> affect the output format. See L</QCOW2 "
28802 "AND NON-SPARSE RAW FORMATS>."
28806 #: ../tools/virt-resize.pl:535
28807 msgid "B<--output-format> raw"
28811 #: ../tools/virt-resize.pl:537
28813 "Specify the format of the output disk image. If this flag is not given then "
28814 "it is auto-detected from the image itself."
28818 #: ../tools/virt-resize.pl:543
28820 "Note that you still need to create the output disk with the right format. "
28821 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28825 #: ../tools/virt-resize.pl:1419
28830 #: ../tools/virt-resize.pl:1421
28831 msgid "\"Partition 1 does not end on cylinder boundary.\""
28835 #: ../tools/virt-resize.pl:1423
28837 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28838 "means the partitions will not be aligned to the ancient CHS geometry. "
28839 "However CHS geometry is meaningless for disks manufactured since the early "
28840 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28841 "cylinders is not required by any modern operating system."
28845 #: ../tools/virt-resize.pl:1430
28846 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28850 #: ../tools/virt-resize.pl:1432
28852 "In Windows Vista and later versions, Microsoft switched to using a separate "
28853 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28854 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28855 "the boot partition. Doing so seems to break the guest completely. However "
28856 "expanding the second partition (ie. C: drive) should work."
28860 #: ../tools/virt-resize.pl:1439
28862 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28863 "NTFS partitions have been expanded. This is just a safety check and (unless "
28864 "it find errors) is nothing to worry about."
28868 #: ../tools/virt-resize.pl:1443
28869 msgid "GUEST BOOT STUCK AT \"GRUB\""
28873 #: ../tools/virt-resize.pl:1445
28875 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28876 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28877 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28878 "although we think is to do with partition alignment."
28882 #: ../tools/virt-resize.pl:1450
28885 " guestfish -i -a newdisk\n"
28886 " ><fs> cat /boot/grub/device.map\n"
28887 " # check the contents of this file are sensible or\n"
28888 " # edit the file if necessary\n"
28889 " ><fs> grub-install / /dev/vda\n"
28895 #: ../tools/virt-resize.pl:1457
28897 "For more flexible guest reconfiguration, including if you need to specify "
28898 "other parameters to grub-install, use L<virt-rescue(1)>."
28902 #: ../tools/virt-resize.pl:1460
28903 msgid "ALTERNATIVE TOOLS"
28907 #: ../tools/virt-resize.pl:1462
28909 "There are several proprietary tools for resizing partitions. We won't "
28910 "mention any here."
28914 #: ../tools/virt-resize.pl:1465
28916 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28917 "operations on disk images. They can resize and move partitions, but I don't "
28918 "think they can do anything with the contents, and they certainly don't "
28923 #: ../tools/virt-resize.pl:1470
28925 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28926 "but at a much lower level. You will probably end up hand-calculating sector "
28927 "offsets, which is something that virt-resize was designed to avoid. If you "
28928 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
28933 #: ../tools/virt-resize.pl:1485
28935 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
28936 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
28937 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
28938 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
28939 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28943 #: ../tools/virt-list-filesystems.pl:32
28944 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28948 #: ../tools/virt-list-filesystems.pl:36
28951 " virt-list-filesystems [--options] domname\n"
28956 #: ../tools/virt-list-filesystems.pl:38
28959 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28964 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
28966 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
28971 #: ../tools/virt-list-filesystems.pl:45
28973 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28974 "are contained in a virtual machine or disk image."
28978 #: ../tools/virt-list-filesystems.pl:49
28980 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28981 "functionality. For more complex cases you should look at the "
28982 "L<guestfish(1)> tool."
28986 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
28987 msgid "B<-l> | B<--long>"
28991 #: ../tools/virt-list-filesystems.pl:108
28993 "With this option, C<virt-list-filesystems> displays the type of each "
28994 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28998 #: ../tools/virt-list-filesystems.pl:115
28999 msgid "B<-a> | B<--all>"
29003 #: ../tools/virt-list-filesystems.pl:117
29005 "Normally we only show mountable filesystems. If this option is given then "
29006 "swap devices are shown too."
29010 #: ../tools/virt-list-filesystems.pl:191
29012 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29013 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29014 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29018 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
29019 msgid "Copyright (C) 2009 Red Hat Inc."
29023 #: ../tools/virt-tar.pl:33
29024 msgid "virt-tar - Extract or upload files to a virtual machine"
29028 #: ../tools/virt-tar.pl:37
29031 " virt-tar [--options] -x domname directory tarball\n"
29036 #: ../tools/virt-tar.pl:39
29039 " virt-tar [--options] -u domname tarball directory\n"
29044 #: ../tools/virt-tar.pl:41
29047 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29052 #: ../tools/virt-tar.pl:43
29055 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29060 #: ../tools/virt-tar.pl:47
29061 msgid "Download C</home> from the VM into a local tarball:"
29065 #: ../tools/virt-tar.pl:49
29068 " virt-tar -x domname /home home.tar\n"
29073 #: ../tools/virt-tar.pl:51
29076 " virt-tar -zx domname /home home.tar.gz\n"
29081 #: ../tools/virt-tar.pl:53
29082 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29086 #: ../tools/virt-tar.pl:55
29089 " virt-tar -u domname uploadstuff.tar /tmp\n"
29094 #: ../tools/virt-tar.pl:57
29097 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29102 #: ../tools/virt-tar.pl:61
29104 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
29105 "virtual machines. If you do this, you risk disk corruption in the VM. "
29106 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29110 #: ../tools/virt-tar.pl:66
29112 "You can use C<-x> (extract) on live virtual machines, but you might get "
29113 "inconsistent results or errors if there is filesystem activity inside the "
29114 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29115 "work, but the only way to guarantee consistent results is if the virtual "
29116 "machine is shut down."
29120 #: ../tools/virt-tar.pl:74
29122 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29123 "parts of a guest filesystem. There are many possibilities: making backups, "
29124 "uploading data files, snooping on guest activity, fixing or customizing "
29129 #: ../tools/virt-tar.pl:79
29131 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29132 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29133 "should look at the L<guestfish(1)> tool."
29137 #: ../tools/virt-tar.pl:83
29139 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
29140 "its contents (recursively) from the virtual machine into a local tarball. "
29141 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
29142 "virtual machine. You cannot use these two options together."
29146 #: ../tools/virt-tar.pl:89
29148 "In addition, you may need to use the C<-z> (gZip) option to enable "
29149 "compression. When uploading, you have to specify C<-z> if the upload file "
29150 "is compressed because virt-tar won't detect this on its own."
29154 #: ../tools/virt-tar.pl:93
29156 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29157 "example it cannot do PKZip files or bzip2 compression. If you want that "
29158 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29159 "the L<libguestfs(3)> API)."
29163 #: ../tools/virt-tar.pl:151
29164 msgid "B<-x> | B<--extract> | B<--download>"
29168 #: ../tools/virt-tar.pl:153
29169 msgid "B<-u> | B<--upload>"
29173 #: ../tools/virt-tar.pl:155
29175 "Use C<-x> to extract (download) a directory from a virtual machine to a "
29180 #: ../tools/virt-tar.pl:158
29182 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
29183 "Please read the L</WARNING> section above before using this option."
29187 #: ../tools/virt-tar.pl:162
29188 msgid "You must specify exactly one of these options."
29192 #: ../tools/virt-tar.pl:168
29193 msgid "B<-z> | B<--gzip>"
29197 #: ../tools/virt-tar.pl:170
29198 msgid "Specify that the input or output tarball is gzip-compressed."
29202 #: ../tools/virt-tar.pl:283
29204 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29205 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29206 "L<http://libguestfs.org/>."
29210 #: ../tools/virt-make-fs.pl:37
29211 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29215 #: ../tools/virt-make-fs.pl:41
29218 " virt-make-fs [--options] input.tar output.img\n"
29223 #: ../tools/virt-make-fs.pl:43
29226 " virt-make-fs [--options] input.tar.gz output.img\n"
29231 #: ../tools/virt-make-fs.pl:45
29234 " virt-make-fs [--options] directory output.img\n"
29239 #: ../tools/virt-make-fs.pl:49
29241 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29242 "archive or some files in a directory. It is similar to tools like "
29243 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29244 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29245 "useful if you want to attach these filesystems to existing virtual machines "
29246 "(eg. to import large amounts of read-only data to a VM)."
29250 #: ../tools/virt-make-fs.pl:57
29251 msgid "Basic usage is:"
29255 #: ../tools/virt-make-fs.pl:59
29258 " virt-make-fs input output\n"
29263 #: ../tools/virt-make-fs.pl:61
29265 "where C<input> is either a directory containing files that you want to add, "
29266 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29267 "C<output> is a disk image. The input type is detected automatically. The "
29268 "output disk image defaults to a raw ext2 image unless you specify extra "
29269 "flags (see L</OPTIONS> below)."
29273 #: ../tools/virt-make-fs.pl:67
29274 msgid "EXTRA SPACE"
29278 #: ../tools/virt-make-fs.pl:69
29280 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29281 "the files that it contains, but might have extra space. Depending on how "
29282 "you are going to use the output, you might think this extra space is wasted "
29283 "and want to minimize it, or you might want to leave space so that more files "
29284 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29285 "but you can use the C<--size> flag to leave space in the filesystem if you "
29290 #: ../tools/virt-make-fs.pl:77
29292 "An alternative way to leave extra space but not make the output image any "
29293 "bigger is to use an alternative disk image format (instead of the default "
29294 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29295 "image format (check your hypervisor supports this before using it). This "
29296 "allows you to choose a large C<--size> but the extra space won't actually be "
29297 "allocated in the image until you try to store something in it."
29301 #: ../tools/virt-make-fs.pl:85
29303 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29304 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29305 "to build another image from scratch."
29309 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29314 #: ../tools/virt-make-fs.pl:91
29317 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29322 #: ../tools/virt-make-fs.pl:93
29323 msgid "FILESYSTEM TYPE"
29327 #: ../tools/virt-make-fs.pl:95
29329 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29330 "libguestfs supports can be used (but I<not> read-only formats like "
29331 "ISO9660). Here are some of the more common choices:"
29335 #: ../tools/virt-make-fs.pl:101
29340 #: ../tools/virt-make-fs.pl:103
29342 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29343 "you are not going to use the filesystem in a way that requires the journal, "
29344 "then this is just wasted overhead."
29348 #: ../tools/virt-make-fs.pl:107
29349 msgid "I<ntfs> or I<vfat>"
29353 #: ../tools/virt-make-fs.pl:109
29354 msgid "Useful if exporting data to a Windows guest."
29358 #: ../tools/virt-make-fs.pl:111
29360 "I<Note for vfat>: The tar archive or local directory must only contain files "
29361 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29362 "program running within libguestfs is unable to change the ownership of "
29363 "non-root files, since vfat itself does not support this."
29367 #: ../tools/virt-make-fs.pl:116
29372 #: ../tools/virt-make-fs.pl:118
29374 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29375 "total filesystem size."
29379 #: ../tools/virt-make-fs.pl:125
29382 " virt-make-fs --type=minix input minixfs.img\n"
29387 #: ../tools/virt-make-fs.pl:127
29388 msgid "TO PARTITION OR NOT TO PARTITION"
29392 #: ../tools/virt-make-fs.pl:129
29393 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29397 #: ../tools/virt-make-fs.pl:131
29399 "Adding a partition can make the disk image more compatible with certain "
29400 "virtualized operating systems which don't expect to see a filesystem "
29401 "directly located on a block device (Linux doesn't care and will happily "
29402 "handle both types)."
29406 #: ../tools/virt-make-fs.pl:136
29408 "On the other hand, if you have a partition table then the output image is no "
29409 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29410 "directly on a partitioned disk image. (However libguestfs tools such as "
29411 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29415 #: ../tools/virt-make-fs.pl:144
29416 msgid "Add an MBR partition:"
29420 #: ../tools/virt-make-fs.pl:146
29423 " virt-make-fs --partition -- input disk.img\n"
29428 #: ../tools/virt-make-fs.pl:148
29430 "If the output disk image could be terabyte-sized or larger, it's better to "
29431 "use an EFI/GPT-compatible partition table:"
29435 #: ../tools/virt-make-fs.pl:151
29438 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29443 #: ../tools/virt-make-fs.pl:179
29444 msgid "Enable debugging information."
29448 #: ../tools/virt-make-fs.pl:185
29449 msgid "B<--size=E<lt>NE<gt>>"
29453 #: ../tools/virt-make-fs.pl:187
29454 msgid "B<--size=+E<lt>NE<gt>>"
29458 #: ../tools/virt-make-fs.pl:189
29459 msgid "B<-s E<lt>NE<gt>>"
29463 #: ../tools/virt-make-fs.pl:191
29464 msgid "B<-s +E<lt>NE<gt>>"
29468 #: ../tools/virt-make-fs.pl:193
29469 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29473 #: ../tools/virt-make-fs.pl:196
29475 "If this option is I<not> given, then the output image will be just large "
29476 "enough to contain all the files, with not much wasted space."
29480 #: ../tools/virt-make-fs.pl:199
29482 "To choose a fixed size output disk, specify an absolute number followed by "
29483 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29484 "Petabytes or Exabytes. This must be large enough to contain all the input "
29485 "files, else you will get an error."
29489 #: ../tools/virt-make-fs.pl:204
29491 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29492 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29493 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29494 "the input files, and (approximately) an extra 200 MB free space."
29498 #: ../tools/virt-make-fs.pl:210
29500 "Note that virt-make-fs estimates free space, and therefore will not produce "
29501 "filesystems containing precisely the free space requested. (It is much more "
29502 "expensive and time-consuming to produce a filesystem which has precisely the "
29503 "desired free space)."
29507 #: ../tools/virt-make-fs.pl:219
29508 msgid "B<--format=E<lt>fmtE<gt>>"
29512 #: ../tools/virt-make-fs.pl:221
29513 msgid "B<-F E<lt>fmtE<gt>>"
29517 #: ../tools/virt-make-fs.pl:223
29518 msgid "Choose the output disk image format."
29522 #: ../tools/virt-make-fs.pl:225
29523 msgid "The default is C<raw> (raw disk image)."
29527 #: ../tools/virt-make-fs.pl:227
29529 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29530 "that would really make sense here is C<qcow2>."
29534 #: ../tools/virt-make-fs.pl:234
29535 msgid "B<--type=E<lt>fsE<gt>>"
29539 #: ../tools/virt-make-fs.pl:236
29540 msgid "B<-t E<lt>fsE<gt>>"
29544 #: ../tools/virt-make-fs.pl:238
29545 msgid "Choose the output filesystem type."
29549 #: ../tools/virt-make-fs.pl:240
29550 msgid "The default is C<ext2>."
29554 #: ../tools/virt-make-fs.pl:242
29555 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29559 #: ../tools/virt-make-fs.pl:249
29560 msgid "B<--partition>"
29564 #: ../tools/virt-make-fs.pl:251
29565 msgid "B<--partition=E<lt>parttypeE<gt>>"
29569 #: ../tools/virt-make-fs.pl:253
29571 "If specified, this flag adds an MBR partition table to the output disk "
29576 #: ../tools/virt-make-fs.pl:256
29578 "You can change the partition table type, eg. C<--partition=gpt> for large "
29583 #: ../tools/virt-make-fs.pl:259
29585 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29586 "might consider the next parameter to be the partition type. For example:"
29590 #: ../tools/virt-make-fs.pl:263
29593 " virt-make-fs --partition input.tar ...\n"
29598 #: ../tools/virt-make-fs.pl:265
29600 "would cause virt-make-fs to think you wanted to use a partition type of "
29601 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29602 "dash) between options and the input file argument:"
29606 #: ../tools/virt-make-fs.pl:269
29609 " virt-make-fs --partition -- input.tar ...\n"
29614 #: ../tools/virt-make-fs.pl:541
29616 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
29617 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29618 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29622 #: ../tools/virt-make-fs.pl:558
29625 " export LIBGUESTFS_DEBUG=1\n"
29626 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29631 #: ../tools/virt-make-fs.pl:561
29633 "Attach /tmp/virt-make-fs.log to a new bug report at "
29634 "L<https://bugzilla.redhat.com/>"
29638 #: ../tools/virt-list-partitions.pl:32
29639 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29643 #: ../tools/virt-list-partitions.pl:36
29646 " virt-list-partitions [--options] domname\n"
29651 #: ../tools/virt-list-partitions.pl:38
29654 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29659 #: ../tools/virt-list-partitions.pl:45
29661 "C<virt-list-partitions> is a command line tool to list the partitions that "
29662 "are contained in a virtual machine or disk image. It is mainly useful as a "
29663 "first step to using L<virt-resize(1)>."
29667 #: ../tools/virt-list-partitions.pl:50
29669 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29670 "functionality. For more complex cases you should look at the "
29671 "L<guestfish(1)> tool."
29675 #: ../tools/virt-list-partitions.pl:107
29676 msgid "B<-h> | B<--human-readable>"
29680 #: ../tools/virt-list-partitions.pl:109
29681 msgid "Show sizes in human-readable form (eg. \"1G\")."
29685 #: ../tools/virt-list-partitions.pl:117
29687 "With this option, C<virt-list-partitions> displays the type and size of each "
29688 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29692 #: ../tools/virt-list-partitions.pl:124
29693 msgid "B<-t> | B<--total>"
29697 #: ../tools/virt-list-partitions.pl:126
29698 msgid "Display the total size of each block device (as a separate row or rows)."
29702 #: ../tools/virt-list-partitions.pl:259
29704 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29705 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29706 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29710 #: ../tools/virt-list-partitions.pl:275
29711 msgid "Copyright (C) 2009-2010 Red Hat Inc."