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.7\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-05-18 12:05+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:2535 ../src/guestfs.pod:2539 ../src/guestfs.pod:2543 ../src/guestfs.pod:2547 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373 ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073 ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257 ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1204 ../src/guestfs.pod:1335 ../src/guestfs.pod: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 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2700 " guestfs_abort_cb);\n"
2705 #: ../src/guestfs.pod:1398
2707 "The callback C<cb> will be called if there is an out of memory situation. "
2708 "I<Note this callback must not return>."
2712 #: ../src/guestfs.pod:1401
2713 msgid "The default is to call L<abort(3)>."
2717 #: ../src/guestfs.pod:1403
2718 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2722 #: ../src/guestfs.pod:1406
2723 msgid "guestfs_get_out_of_memory_handler"
2727 #: ../src/guestfs.pod:1408
2730 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2735 #: ../src/guestfs.pod:1410
2736 msgid "This returns the current out of memory handler."
2740 #: ../src/guestfs.pod:1412
2745 #: ../src/guestfs.pod:1414 ../fish/guestfish.pod:958
2750 #: ../src/guestfs.pod:1416
2755 #: ../src/guestfs.pod:1418
2760 #: ../src/guestfs.pod:1420
2761 msgid "AVAILABILITY"
2765 #: ../src/guestfs.pod:1422
2766 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2770 #: ../src/guestfs.pod:1424
2772 "Using L</guestfs_available> you can test availability of the following "
2773 "groups of functions. This test queries the appliance to see if the "
2774 "appliance you are currently using supports the functionality."
2778 #: ../src/guestfs.pod:1429
2779 msgid "@AVAILABILITY@"
2783 #: ../src/guestfs.pod:1431
2784 msgid "GUESTFISH supported COMMAND"
2788 #: ../src/guestfs.pod:1433
2790 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2791 "prints out the available groups and whether they are supported by this build "
2792 "of libguestfs. Note however that you have to do C<run> first."
2796 #: ../src/guestfs.pod:1438
2797 msgid "SINGLE CALLS AT COMPILE TIME"
2801 #: ../src/guestfs.pod:1440
2803 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2804 "function, such as:"
2808 #: ../src/guestfs.pod:1443
2811 " #define LIBGUESTFS_HAVE_DD 1\n"
2816 #: ../src/guestfs.pod:1445
2817 msgid "if L</guestfs_dd> is available."
2821 #: ../src/guestfs.pod:1447
2823 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2824 "function is available at compile time, we recommended using build tools such "
2825 "as autoconf or cmake. For example in autotools you could use:"
2829 #: ../src/guestfs.pod:1452
2832 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2833 " AC_CHECK_FUNCS([guestfs_dd])\n"
2838 #: ../src/guestfs.pod:1455
2840 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2845 #: ../src/guestfs.pod:1458
2846 msgid "SINGLE CALLS AT RUN TIME"
2850 #: ../src/guestfs.pod:1460
2852 "Testing at compile time doesn't guarantee that a function really exists in "
2853 "the library. The reason is that you might be dynamically linked against a "
2854 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2855 "This situation unfortunately results in a segmentation fault, which is a "
2856 "shortcoming of the C dynamic linking system itself."
2860 #: ../src/guestfs.pod:1467
2862 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2863 "in this example program (note that you still need the compile time check as "
2868 #: ../src/guestfs.pod:1471
2871 " #include <stdio.h>\n"
2872 " #include <stdlib.h>\n"
2873 " #include <unistd.h>\n"
2874 " #include <dlfcn.h>\n"
2875 " #include <guestfs.h>\n"
2880 #: ../src/guestfs.pod:1477
2885 " #ifdef LIBGUESTFS_HAVE_DD\n"
2887 " int has_function;\n"
2892 #: ../src/guestfs.pod:1483
2895 " /* Test if the function guestfs_dd is really available. */\n"
2896 " dl = dlopen (NULL, RTLD_LAZY);\n"
2898 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2899 " exit (EXIT_FAILURE);\n"
2901 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2907 #: ../src/guestfs.pod:1492
2910 " if (!has_function)\n"
2911 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2913 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2914 " /* Now it's safe to call\n"
2915 " guestfs_dd (g, \"foo\", \"bar\");\n"
2919 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2926 #: ../src/guestfs.pod:1505
2928 "You may think the above is an awful lot of hassle, and it is. There are "
2929 "other ways outside of the C linking system to ensure that this kind of "
2930 "incompatibility never arises, such as using package versioning:"
2934 #: ../src/guestfs.pod:1510
2937 " Requires: libguestfs >= 1.0.80\n"
2942 #: ../src/guestfs.pod:1512
2943 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2947 #: ../src/guestfs.pod:1514
2949 "A recent feature of the API is the introduction of calls which take optional "
2950 "arguments. In C these are declared 3 ways. The main way is as a call which "
2951 "takes variable arguments (ie. C<...>), as in this example:"
2955 #: ../src/guestfs.pod:1519
2958 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2963 #: ../src/guestfs.pod:1521
2965 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2966 "call with no optional arguments specified:"
2970 #: ../src/guestfs.pod:1524
2973 " guestfs_add_drive_opts (g, filename, -1);\n"
2978 #: ../src/guestfs.pod:1526
2979 msgid "With a single optional argument:"
2983 #: ../src/guestfs.pod:1528
2986 " guestfs_add_drive_opts (g, filename,\n"
2987 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2993 #: ../src/guestfs.pod:1532
2998 #: ../src/guestfs.pod:1534
3001 " guestfs_add_drive_opts (g, filename,\n"
3002 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3003 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3009 #: ../src/guestfs.pod:1539
3011 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3016 #: ../src/guestfs.pod:1542
3017 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3021 #: ../src/guestfs.pod:1544
3023 "The second variant has the same name with the suffix C<_va>, which works the "
3024 "same way but takes a C<va_list>. See the C manual for details. For the "
3025 "example function, this is declared:"
3029 #: ../src/guestfs.pod:1548
3032 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3038 #: ../src/guestfs.pod:1551
3039 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3043 #: ../src/guestfs.pod:1553
3045 "The third variant is useful where you need to construct these calls. You "
3046 "pass in a structure where you fill in the optional fields. The structure "
3047 "has a bitmask as the first element which you must set to indicate which "
3048 "fields you have filled in. For our example function the structure and call "
3053 #: ../src/guestfs.pod:1559
3056 " struct guestfs_add_drive_opts_argv {\n"
3057 " uint64_t bitmask;\n"
3059 " const char *format;\n"
3062 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3063 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3068 #: ../src/guestfs.pod:1568
3069 msgid "You could call it like this:"
3073 #: ../src/guestfs.pod:1570
3076 " struct guestfs_add_drive_opts_argv optargs = {\n"
3077 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3078 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3080 " .format = \"qcow2\"\n"
3086 #: ../src/guestfs.pod:1577
3089 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3094 #: ../src/guestfs.pod:1579 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1253 ../tools/virt-win-reg.pl:532
3099 #: ../src/guestfs.pod:1585
3100 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3104 #: ../src/guestfs.pod:1590
3105 msgid "You do not need to fill in all fields of the structure."
3109 #: ../src/guestfs.pod:1594
3111 "There must be a one-to-one correspondence between fields of the structure "
3112 "that are filled in, and bits set in the bitmask."
3116 #: ../src/guestfs.pod:1599
3117 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3121 #: ../src/guestfs.pod:1601
3123 "In other languages, optional arguments are expressed in the way that is "
3124 "natural for that language. We refer you to the language-specific "
3125 "documentation for more details on that."
3129 #: ../src/guestfs.pod:1605
3130 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3134 #: ../src/guestfs.pod:1607
3135 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3139 #: ../src/guestfs.pod:1609
3141 "The child process generates events in some situations. Current events "
3142 "include: receiving a log message, the child process exits."
3146 #: ../src/guestfs.pod:1612
3148 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3153 #: ../src/guestfs.pod:1615
3155 "Only I<one callback of each type> can be registered for each handle. "
3156 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3157 "that type. Cancel all callbacks of this type by calling this function with "
3158 "C<cb> set to C<NULL>."
3162 #: ../src/guestfs.pod:1620
3163 msgid "guestfs_set_log_message_callback"
3167 #: ../src/guestfs.pod:1622
3170 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3171 " char *buf, int len);\n"
3172 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3173 " guestfs_log_message_cb cb,\n"
3179 #: ../src/guestfs.pod:1628
3181 "The callback function C<cb> will be called whenever qemu or the guest writes "
3182 "anything to the console."
3186 #: ../src/guestfs.pod:1631
3187 msgid "Use this function to capture kernel messages and similar."
3191 #: ../src/guestfs.pod:1633
3193 "Normally there is no log message handler, and log messages are just "
3198 #: ../src/guestfs.pod:1636
3199 msgid "guestfs_set_subprocess_quit_callback"
3203 #: ../src/guestfs.pod:1638
3206 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3207 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3208 " guestfs_subprocess_quit_cb cb,\n"
3214 #: ../src/guestfs.pod:1643
3216 "The callback function C<cb> will be called when the child process quits, "
3217 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3218 "corresponds to a transition from any state to the CONFIG state)."
3222 #: ../src/guestfs.pod:1648
3223 msgid "guestfs_set_launch_done_callback"
3227 #: ../src/guestfs.pod:1650
3230 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3231 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3232 " guestfs_launch_done_cb cb,\n"
3238 #: ../src/guestfs.pod:1655
3240 "The callback function C<cb> will be called when the child process becomes "
3241 "ready first time after it has been launched. (This corresponds to a "
3242 "transition from LAUNCHING to the READY state)."
3246 #: ../src/guestfs.pod:1659
3247 msgid "guestfs_set_close_callback"
3251 #: ../src/guestfs.pod:1661
3254 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3255 " void guestfs_set_close_callback (guestfs_h *g,\n"
3256 " guestfs_close_cb cb,\n"
3262 #: ../src/guestfs.pod:1666
3264 "The callback function C<cb> will be called while the handle is being closed "
3265 "(synchronously from L</guestfs_close>)."
3269 #: ../src/guestfs.pod:1669
3271 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3272 "handles that are open when the program exits. This means that this callback "
3273 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3274 "problems in higher-level languages (eg. if your HLL interpreter has already "
3275 "been cleaned up by the time this is called, and if your callback then jumps "
3276 "into some HLL function)."
3280 #: ../src/guestfs.pod:1677
3281 msgid "guestfs_set_progress_callback"
3285 #: ../src/guestfs.pod:1679
3288 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3289 " int proc_nr, int serial,\n"
3290 " uint64_t position, uint64_t total);\n"
3291 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3292 " guestfs_progress_cb cb,\n"
3298 #: ../src/guestfs.pod:1686
3300 "Some long-running operations can generate progress messages. If this "
3301 "callback is registered, then it will be called each time a progress message "
3302 "is generated (usually two seconds after the operation started, and three "
3303 "times per second thereafter until it completes, although the frequency may "
3304 "change in future versions)."
3308 #: ../src/guestfs.pod:1692
3310 "The callback receives two numbers: C<position> and C<total>. The units of "
3311 "C<total> are not defined, although for some operations C<total> may relate "
3312 "in some way to the amount of data to be transferred (eg. in bytes or "
3313 "megabytes), and C<position> may be the portion which has been transferred."
3317 #: ../src/guestfs.pod:1698
3318 msgid "The only defined and stable parts of the API are:"
3322 #: ../src/guestfs.pod:1704
3324 "The callback can display to the user some type of progress bar or indicator "
3325 "which shows the ratio of C<position>:C<total>."
3329 #: ../src/guestfs.pod:1709
3330 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3334 #: ../src/guestfs.pod:1713
3336 "If any progress notification is sent during a call, then a final progress "
3337 "notification is always sent when C<position> = C<total> (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
4520 msgid "Outside contributions, experimental parts."
4524 #: ../src/guestfs.pod:2348
4529 #: ../src/guestfs.pod:2350
4531 "The daemon that runs inside the libguestfs appliance and carries out "
4536 #: ../src/guestfs.pod:2353
4541 #: ../src/guestfs.pod:2355
4542 msgid "L<virt-df(1)> command and documentation."
4546 #: ../src/guestfs.pod:2357
4551 #: ../src/guestfs.pod:2359
4552 msgid "C API example code."
4556 #: ../src/guestfs.pod:2361
4561 #: ../src/guestfs.pod:2363
4562 msgid "L<guestfish(1)>, the command-line shell."
4566 #: ../src/guestfs.pod:2365
4571 #: ../src/guestfs.pod:2367
4572 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
4576 #: ../src/guestfs.pod:2369
4577 msgid "C<generator>"
4581 #: ../src/guestfs.pod:2371
4583 "The crucially important generator, used to automatically generate large "
4584 "amounts of boilerplate C code for things like RPC and bindings."
4588 #: ../src/guestfs.pod:2374
4593 #: ../src/guestfs.pod:2376
4594 msgid "Files used by the test suite."
4598 #: ../src/guestfs.pod:2378
4599 msgid "Some \"phony\" guest images which we test against."
4603 #: ../src/guestfs.pod:2380
4604 msgid "C<inspector>"
4608 #: ../src/guestfs.pod:2382
4609 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
4613 #: ../src/guestfs.pod:2384
4618 #: ../src/guestfs.pod:2386
4619 msgid "M4 macros used by autoconf."
4623 #: ../src/guestfs.pod:2388
4628 #: ../src/guestfs.pod:2390
4629 msgid "Translations of simple gettext strings."
4633 #: ../src/guestfs.pod:2392
4638 #: ../src/guestfs.pod:2394
4640 "The build infrastructure and PO files for translations of manpages and POD "
4641 "files. Eventually this will be combined with the C<po> directory, but that "
4642 "is rather complicated."
4646 #: ../src/guestfs.pod:2398
4647 msgid "C<regressions>"
4651 #: ../src/guestfs.pod:2400
4652 msgid "Regression tests."
4656 #: ../src/guestfs.pod:2402
4661 #: ../src/guestfs.pod:2404
4662 msgid "L<virt-rescue(1)> command and documentation."
4666 #: ../src/guestfs.pod:2406
4671 #: ../src/guestfs.pod:2408
4672 msgid "Source code to the C library."
4676 #: ../src/guestfs.pod:2410
4681 #: ../src/guestfs.pod:2412
4682 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
4686 #: ../src/guestfs.pod:2414
4687 msgid "C<test-tool>"
4691 #: ../src/guestfs.pod:2416
4693 "Test tool for end users to test if their qemu/kernel combination will work "
4698 #: ../src/guestfs.pod:2419
4703 #: ../src/guestfs.pod:2421
4708 #: ../src/guestfs.pod:2423
4713 #: ../src/guestfs.pod:2425
4718 #: ../src/guestfs.pod:2427
4723 #: ../src/guestfs.pod:2429
4728 #: ../src/guestfs.pod:2431
4733 #: ../src/guestfs.pod:2433
4738 #: ../src/guestfs.pod:2435
4739 msgid "Language bindings."
4743 #: ../src/guestfs.pod:2439 ../fish/guestfish.pod:965 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:375
4744 msgid "ENVIRONMENT VARIABLES"
4748 #: ../src/guestfs.pod:2443 ../fish/guestfish.pod:991
4749 msgid "LIBGUESTFS_APPEND"
4753 #: ../src/guestfs.pod:2445 ../fish/guestfish.pod:993
4754 msgid "Pass additional options to the guest kernel."
4758 #: ../src/guestfs.pod:2447 ../fish/guestfish.pod:995
4759 msgid "LIBGUESTFS_DEBUG"
4763 #: ../src/guestfs.pod:2449
4765 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
4766 "effect as calling C<guestfs_set_verbose (g, 1)>."
4770 #: ../src/guestfs.pod:2452 ../fish/guestfish.pod:1000
4771 msgid "LIBGUESTFS_MEMSIZE"
4775 #: ../src/guestfs.pod:2454 ../fish/guestfish.pod:1002
4776 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
4780 #: ../src/guestfs.pod:2457 ../fish/guestfish.pod:1005
4783 " LIBGUESTFS_MEMSIZE=700\n"
4788 #: ../src/guestfs.pod:2459 ../fish/guestfish.pod:1007
4789 msgid "LIBGUESTFS_PATH"
4793 #: ../src/guestfs.pod:2461
4795 "Set the path that libguestfs uses to search for a supermin appliance. See "
4796 "the discussion of paths in section L</PATH> above."
4800 #: ../src/guestfs.pod:2464 ../fish/guestfish.pod:1012
4801 msgid "LIBGUESTFS_QEMU"
4805 #: ../src/guestfs.pod:2466 ../fish/guestfish.pod:1014
4807 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4808 "which was found at compile time by the configure script is used."
4812 #: ../src/guestfs.pod:2470
4813 msgid "See also L</QEMU WRAPPERS> above."
4817 #: ../src/guestfs.pod:2472 ../fish/guestfish.pod:1018
4818 msgid "LIBGUESTFS_TRACE"
4822 #: ../src/guestfs.pod:2474
4824 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4825 "effect as calling C<guestfs_set_trace (g, 1)>."
4829 #: ../src/guestfs.pod:2477 ../fish/guestfish.pod:1027
4834 #: ../src/guestfs.pod:2479 ../fish/guestfish.pod:1029
4835 msgid "Location of temporary directory, defaults to C</tmp>."
4839 #: ../src/guestfs.pod:2481 ../fish/guestfish.pod:1031
4841 "If libguestfs was compiled to use the supermin appliance then the real "
4842 "appliance is cached in this directory, shared between all handles belonging "
4843 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4844 "use in case C</tmp> is not large enough."
4848 #: ../src/guestfs.pod:2489 ../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
4853 #: ../src/guestfs.pod:2491
4855 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4856 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4857 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
4858 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4859 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4860 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4861 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4865 #: ../src/guestfs.pod:2514
4867 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4868 "L<lvm(8)>, L<disktype(1)>."
4872 #: ../src/guestfs.pod:2521 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
4877 #: ../src/guestfs.pod:2523
4878 msgid "To get a list of bugs against libguestfs use this link:"
4882 #: ../src/guestfs.pod:2525
4883 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4887 #: ../src/guestfs.pod:2527
4888 msgid "To report a new bug against libguestfs use this link:"
4892 #: ../src/guestfs.pod:2529
4893 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4897 #: ../src/guestfs.pod:2531
4898 msgid "When reporting a bug, please check:"
4902 #: ../src/guestfs.pod:2537
4903 msgid "That the bug hasn't been reported already."
4907 #: ../src/guestfs.pod:2541
4908 msgid "That you are testing a recent version."
4912 #: ../src/guestfs.pod:2545
4913 msgid "Describe the bug accurately, and give a way to reproduce it."
4917 #: ../src/guestfs.pod:2549
4919 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4924 #: ../src/guestfs.pod:2554 ../fish/guestfish.pod:1108 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4929 #: ../src/guestfs.pod:2556 ../fish/guestfish.pod:1110 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4930 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4934 #: ../src/guestfs.pod:2558 ../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
4939 #: ../src/guestfs.pod:2560 ../fish/guestfish.pod:1114 ../fuse/guestmount.pod:250
4940 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4944 #: ../src/guestfs.pod:2563
4946 "This library is free software; you can redistribute it and/or modify it "
4947 "under the terms of the GNU Lesser General Public License as published by the "
4948 "Free Software Foundation; either version 2 of the License, or (at your "
4949 "option) any later version."
4953 #: ../src/guestfs.pod:2568
4955 "This library is distributed in the hope that it will be useful, but WITHOUT "
4956 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4957 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4962 #: ../src/guestfs.pod:2573
4964 "You should have received a copy of the GNU Lesser General Public License "
4965 "along with this library; if not, write to the Free Software Foundation, "
4966 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4970 #: ../src/guestfs-actions.pod:1
4971 msgid "guestfs_add_cdrom"
4975 #: ../src/guestfs-actions.pod:3
4979 " guestfs_add_cdrom (guestfs_h *g,\n"
4980 " const char *filename);\n"
4985 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4986 msgid "This function adds a virtual CD-ROM disk image to the guest."
4990 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4991 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4995 #: ../src/guestfs-actions.pod:17
4997 "This call checks for the existence of C<filename>. This stops you from "
4998 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4999 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5004 #: ../src/guestfs-actions.pod:24
5006 "If you just want to add an ISO file (often you use this as an efficient way "
5007 "to transfer large files into the guest), then you should probably use "
5008 "C<guestfs_add_drive_ro> instead."
5012 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262 ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448 ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3226 ../src/guestfs-actions.pod:3241 ../src/guestfs-actions.pod:3261 ../src/guestfs-actions.pod:3416 ../src/guestfs-actions.pod:3430 ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3457 ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:3617 ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:3695 ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3733 ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:3780 ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3860 ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:3990 ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:4120 ../src/guestfs-actions.pod:4134 ../src/guestfs-actions.pod:4151 ../src/guestfs-actions.pod:4166 ../src/guestfs-actions.pod:4186 ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4305 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:4446 ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4516 ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4547 ../src/guestfs-actions.pod:4596 ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4675 ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4710 ../src/guestfs-actions.pod:4844 ../src/guestfs-actions.pod:4901 ../src/guestfs-actions.pod:4923 ../src/guestfs-actions.pod:4941 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:5039 ../src/guestfs-actions.pod:5056 ../src/guestfs-actions.pod:5069 ../src/guestfs-actions.pod:5083 ../src/guestfs-actions.pod:5372 ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5417 ../src/guestfs-actions.pod:5431 ../src/guestfs-actions.pod:5443 ../src/guestfs-actions.pod:5457 ../src/guestfs-actions.pod:5473 ../src/guestfs-actions.pod:5494 ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5532 ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5573 ../src/guestfs-actions.pod:5591 ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5631 ../src/guestfs-actions.pod:5650 ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5695 ../src/guestfs-actions.pod:5719 ../src/guestfs-actions.pod:5738 ../src/guestfs-actions.pod:5762 ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5792 ../src/guestfs-actions.pod:5811 ../src/guestfs-actions.pod:5848 ../src/guestfs-actions.pod:5871 ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6005 ../src/guestfs-actions.pod:6126 ../src/guestfs-actions.pod:6138 ../src/guestfs-actions.pod:6151 ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6186 ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6240 ../src/guestfs-actions.pod:6299 ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6348 ../src/guestfs-actions.pod:6365 ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6398 ../src/guestfs-actions.pod:6434 ../src/guestfs-actions.pod:6448 ../src/guestfs-actions.pod:6489 ../src/guestfs-actions.pod:6502 ../src/guestfs-actions.pod:6520 ../src/guestfs-actions.pod:6554 ../src/guestfs-actions.pod:6590 ../src/guestfs-actions.pod:6709 ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6809 ../src/guestfs-actions.pod:6854 ../src/guestfs-actions.pod:6887 ../src/guestfs-actions.pod:6941 ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:7033 ../src/guestfs-actions.pod:7052 ../src/guestfs-actions.pod:7081
5013 msgid "This function returns 0 on success or -1 on error."
5017 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
5019 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5024 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942 ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:6975 ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168 ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1306 ../fish/guestfish-actions.pod:1320 ../fish/guestfish-actions.pod:2820 ../fish/guestfish-actions.pod:4624 ../fish/guestfish-actions.pod:4721
5026 "Deprecated functions will not be removed from the API, but the fact that "
5027 "they are deprecated indicates that there are problems with correct use of "
5032 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3228 ../src/guestfs-actions.pod:3243 ../src/guestfs-actions.pod:4483 ../src/guestfs-actions.pod:5552 ../src/guestfs-actions.pod:5669 ../src/guestfs-actions.pod:5779 ../src/guestfs-actions.pod:6242 ../src/guestfs-actions.pod:6367 ../src/guestfs-actions.pod:6889
5033 msgid "(Added in 0.3)"
5037 #: ../src/guestfs-actions.pod:41
5038 msgid "guestfs_add_domain"
5042 #: ../src/guestfs-actions.pod:43
5046 " guestfs_add_domain (guestfs_h *g,\n"
5047 " const char *dom,\n"
5053 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137 ../src/guestfs-actions.pod:4205
5055 "You may supply a list of optional arguments to this call. Use zero or more "
5056 "of the following pairs of parameters, and terminate the list with C<-1> on "
5057 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5061 #: ../src/guestfs-actions.pod:53
5064 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5065 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5066 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5071 #: ../src/guestfs-actions.pod:57
5073 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5074 "It works by connecting to libvirt, requesting the domain and domain XML from "
5075 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5080 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5082 "The number of disks added is returned. This operation is atomic: if an "
5083 "error is returned, then no disks are added."
5087 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5089 "This function does some minimal checks to make sure the libvirt domain is "
5090 "not running (unless C<readonly> is true). In a future version we will try "
5091 "to acquire the libvirt lock on each disk."
5095 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5097 "Disks must be accessible locally. This often means that adding disks from a "
5098 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5099 "unless those disks are accessible via the same device path locally too."
5103 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5105 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5106 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5107 "default libvirt URI (or one set through an environment variable, see the "
5108 "libvirt documentation for full details)."
5112 #: ../src/guestfs-actions.pod:80
5114 "The other optional parameters are passed directly through to "
5115 "C<guestfs_add_drive_opts>."
5119 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003 ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2662 ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:4619 ../src/guestfs-actions.pod:4747 ../src/guestfs-actions.pod:5153 ../src/guestfs-actions.pod:5179 ../src/guestfs-actions.pod:6475 ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6913 ../src/guestfs-actions.pod:6926
5120 msgid "On error this function returns -1."
5124 #: ../src/guestfs-actions.pod:85
5125 msgid "(Added in 1.7.4)"
5129 #: ../src/guestfs-actions.pod:87
5130 msgid "guestfs_add_domain_va"
5134 #: ../src/guestfs-actions.pod:89
5138 " guestfs_add_domain_va (guestfs_h *g,\n"
5139 " const char *dom,\n"
5145 #: ../src/guestfs-actions.pod:94
5146 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5150 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:4246 ../src/guestfs-actions.pod:4258
5151 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5155 #: ../src/guestfs-actions.pod:98
5156 msgid "guestfs_add_domain_argv"
5160 #: ../src/guestfs-actions.pod:100
5164 " guestfs_add_domain_argv (guestfs_h *g,\n"
5165 " const char *dom,\n"
5166 " const struct guestfs_add_domain_argv *optargs);\n"
5171 #: ../src/guestfs-actions.pod:105
5172 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5176 #: ../src/guestfs-actions.pod:109
5177 msgid "guestfs_add_drive"
5181 #: ../src/guestfs-actions.pod:111
5185 " guestfs_add_drive (guestfs_h *g,\n"
5186 " const char *filename);\n"
5191 #: ../src/guestfs-actions.pod:115
5193 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5194 "optional parameters, so the disk is added writable, with the format being "
5195 "detected automatically."
5199 #: ../src/guestfs-actions.pod:119
5201 "Automatic detection of the format opens you up to a potential security hole "
5202 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5203 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5204 "you should think about replacing calls to this function with calls to "
5205 "C<guestfs_add_drive_opts>, and specifying the format."
5209 #: ../src/guestfs-actions.pod:130
5210 msgid "guestfs_add_drive_opts"
5214 #: ../src/guestfs-actions.pod:132
5218 " guestfs_add_drive_opts (guestfs_h *g,\n"
5219 " const char *filename,\n"
5225 #: ../src/guestfs-actions.pod:142
5228 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5229 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5230 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5235 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
5237 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5238 "The first time you call this function, the disk appears as C</dev/sda>, the "
5239 "second time as C</dev/sdb>, and so on."
5243 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
5245 "You don't necessarily need to be root when using libguestfs. However you "
5246 "obviously do need sufficient permissions to access the filename for whatever "
5247 "operations you want to perform (ie. read access if you just want to read the "
5248 "image or write access if you want to modify the image)."
5252 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
5253 msgid "This call checks that C<filename> exists."
5257 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4215 ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2831
5258 msgid "The optional arguments are:"
5262 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
5267 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
5269 "If true then the image is treated as read-only. Writes are still allowed, "
5270 "but they are stored in a temporary snapshot overlay which is discarded at "
5271 "the end. The disk that you add is not modified."
5275 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
5280 #: ../src/guestfs-actions.pod:171
5282 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5283 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5284 "Possible formats include C<raw> and C<qcow2>."
5288 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
5290 "Automatic detection of the format opens you up to a potential security hole "
5291 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5292 "RHBZ#642934. Specifying the format closes this security hole."
5296 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
5301 #: ../src/guestfs-actions.pod:182
5303 "This rarely-used option lets you emulate the behaviour of the deprecated "
5304 "C<guestfs_add_drive_with_if> call (q.v.)"
5308 #: ../src/guestfs-actions.pod:189
5309 msgid "(Added in 1.5.23)"
5313 #: ../src/guestfs-actions.pod:191
5314 msgid "guestfs_add_drive_opts_va"
5318 #: ../src/guestfs-actions.pod:193
5322 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5323 " const char *filename,\n"
5329 #: ../src/guestfs-actions.pod:198
5330 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5334 #: ../src/guestfs-actions.pod:202
5335 msgid "guestfs_add_drive_opts_argv"
5339 #: ../src/guestfs-actions.pod:204
5343 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5344 " const char *filename,\n"
5345 " const struct guestfs_add_drive_opts_argv "
5351 #: ../src/guestfs-actions.pod:209
5352 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5356 #: ../src/guestfs-actions.pod:213
5357 msgid "guestfs_add_drive_ro"
5361 #: ../src/guestfs-actions.pod:215
5365 " guestfs_add_drive_ro (guestfs_h *g,\n"
5366 " const char *filename);\n"
5371 #: ../src/guestfs-actions.pod:219
5373 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5374 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5375 "disk is added read-only, with the format being detected automatically."
5379 #: ../src/guestfs-actions.pod:226
5380 msgid "(Added in 1.0.38)"
5384 #: ../src/guestfs-actions.pod:228
5385 msgid "guestfs_add_drive_ro_with_if"
5389 #: ../src/guestfs-actions.pod:230
5393 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
5394 " const char *filename,\n"
5395 " const char *iface);\n"
5400 #: ../src/guestfs-actions.pod:235
5402 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
5403 "QEMU interface emulation to use at run time."
5407 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2333
5408 msgid "(Added in 1.0.84)"
5412 #: ../src/guestfs-actions.pod:249
5413 msgid "guestfs_add_drive_with_if"
5417 #: ../src/guestfs-actions.pod:251
5421 " guestfs_add_drive_with_if (guestfs_h *g,\n"
5422 " const char *filename,\n"
5423 " const char *iface);\n"
5428 #: ../src/guestfs-actions.pod:256
5430 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
5431 "QEMU interface emulation to use at run time."
5435 #: ../src/guestfs-actions.pod:270
5436 msgid "guestfs_aug_clear"
5440 #: ../src/guestfs-actions.pod:272
5444 " guestfs_aug_clear (guestfs_h *g,\n"
5445 " const char *augpath);\n"
5450 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
5452 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5453 "L<augtool(1)> C<clear> command."
5457 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
5458 msgid "(Added in 1.3.4)"
5462 #: ../src/guestfs-actions.pod:283
5463 msgid "guestfs_aug_close"
5467 #: ../src/guestfs-actions.pod:285
5471 " guestfs_aug_close (guestfs_h *g);\n"
5476 #: ../src/guestfs-actions.pod:288
5478 "Close the current Augeas handle and free up any resources used by it. After "
5479 "calling this, you have to call C<guestfs_aug_init> again before you can use "
5480 "any other Augeas functions."
5484 #: ../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:5230
5485 msgid "(Added in 0.7)"
5489 #: ../src/guestfs-actions.pod:297
5490 msgid "guestfs_aug_defnode"
5494 #: ../src/guestfs-actions.pod:299
5497 " struct guestfs_int_bool *\n"
5498 " guestfs_aug_defnode (guestfs_h *g,\n"
5499 " const char *name,\n"
5500 " const char *expr,\n"
5501 " const char *val);\n"
5506 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
5507 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5511 #: ../src/guestfs-actions.pod:308
5513 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5514 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
5515 "containing that single node."
5519 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
5521 "On success this returns a pair containing the number of nodes in the "
5522 "nodeset, and a boolean flag if a node was created."
5526 #: ../src/guestfs-actions.pod:316
5528 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
5529 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
5533 #: ../src/guestfs-actions.pod:322
5534 msgid "guestfs_aug_defvar"
5538 #: ../src/guestfs-actions.pod:324
5542 " guestfs_aug_defvar (guestfs_h *g,\n"
5543 " const char *name,\n"
5544 " const char *expr);\n"
5549 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
5551 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5552 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5556 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
5558 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5559 "evaluates to something which is not a nodeset."
5563 #: ../src/guestfs-actions.pod:340
5564 msgid "guestfs_aug_get"
5568 #: ../src/guestfs-actions.pod:342
5572 " guestfs_aug_get (guestfs_h *g,\n"
5573 " const char *augpath);\n"
5578 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
5580 "Look up the value associated with C<path>. If C<path> matches exactly one "
5581 "node, the C<value> is returned."
5585 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341 ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2748 ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2888 ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4765 ../src/guestfs-actions.pod:4958 ../src/guestfs-actions.pod:5128 ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5934 ../src/guestfs-actions.pod:5951 ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6649 ../src/guestfs-actions.pod:6668 ../src/guestfs-actions.pod:6686 ../src/guestfs-actions.pod:6866 ../src/guestfs-actions.pod:7138
5587 "This function returns a string, or NULL on error. I<The caller must free "
5588 "the returned string after use>."
5592 #: ../src/guestfs-actions.pod:354
5593 msgid "guestfs_aug_init"
5597 #: ../src/guestfs-actions.pod:356
5601 " guestfs_aug_init (guestfs_h *g,\n"
5602 " const char *root,\n"
5608 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
5610 "Create a new Augeas handle for editing configuration files. If there was "
5611 "any previous Augeas handle associated with this guestfs session, then it is "
5616 #: ../src/guestfs-actions.pod:365
5617 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5621 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
5622 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5626 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
5628 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5629 "logical I<or> of the following integers:"
5633 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
5634 msgid "C<AUG_SAVE_BACKUP> = 1"
5638 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
5639 msgid "Keep the original file with a C<.augsave> extension."
5643 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
5644 msgid "C<AUG_SAVE_NEWFILE> = 2"
5648 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
5650 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5651 "original. Overrides C<AUG_SAVE_BACKUP>."
5655 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
5656 msgid "C<AUG_TYPE_CHECK> = 4"
5660 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
5661 msgid "Typecheck lenses (can be expensive)."
5665 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
5666 msgid "C<AUG_NO_STDINC> = 8"
5670 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
5671 msgid "Do not use standard load path for modules."
5675 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
5676 msgid "C<AUG_SAVE_NOOP> = 16"
5680 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
5681 msgid "Make save a no-op, just record what would have been changed."
5685 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
5686 msgid "C<AUG_NO_LOAD> = 32"
5690 #: ../src/guestfs-actions.pod:400
5691 msgid "Do not load the tree in C<guestfs_aug_init>."
5695 #: ../src/guestfs-actions.pod:404
5696 msgid "To close the handle, you can call C<guestfs_aug_close>."
5700 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:270
5701 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5705 #: ../src/guestfs-actions.pod:412
5706 msgid "guestfs_aug_insert"
5710 #: ../src/guestfs-actions.pod:414
5714 " guestfs_aug_insert (guestfs_h *g,\n"
5715 " const char *augpath,\n"
5716 " const char *label,\n"
5722 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:276
5724 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5725 "or after C<path> (depending on the boolean flag C<before>)."
5729 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:280
5731 "C<path> must match exactly one existing node in the tree, and C<label> must "
5732 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5736 #: ../src/guestfs-actions.pod:432
5737 msgid "guestfs_aug_load"
5741 #: ../src/guestfs-actions.pod:434
5745 " guestfs_aug_load (guestfs_h *g);\n"
5750 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:288
5751 msgid "Load files into the tree."
5755 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
5756 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5760 #: ../src/guestfs-actions.pod:446
5761 msgid "guestfs_aug_ls"
5765 #: ../src/guestfs-actions.pod:448
5769 " guestfs_aug_ls (guestfs_h *g,\n"
5770 " const char *augpath);\n"
5775 #: ../src/guestfs-actions.pod:452
5777 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5778 "sorting the resulting nodes into alphabetical order."
5782 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471 ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:2194 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2351 ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2822 ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3384 ../src/guestfs-actions.pod:3489 ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5340 ../src/guestfs-actions.pod:5991 ../src/guestfs-actions.pod:6052 ../src/guestfs-actions.pod:6107 ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:6277 ../src/guestfs-actions.pod:6759 ../src/guestfs-actions.pod:6779 ../src/guestfs-actions.pod:6826 ../src/guestfs-actions.pod:6991 ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7095 ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7160 ../src/guestfs-actions.pod:7179
5784 "This function returns a NULL-terminated array of strings (like "
5785 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
5786 "strings and the array after use>."
5790 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3735 ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:3972 ../src/guestfs-actions.pod:4005 ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5419 ../src/guestfs-actions.pod:5433 ../src/guestfs-actions.pod:5445 ../src/guestfs-actions.pod:5853 ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6504 ../src/guestfs-actions.pod:6743 ../src/guestfs-actions.pod:6979
5791 msgid "(Added in 0.8)"
5795 #: ../src/guestfs-actions.pod:461
5796 msgid "guestfs_aug_match"
5800 #: ../src/guestfs-actions.pod:463
5804 " guestfs_aug_match (guestfs_h *g,\n"
5805 " const char *augpath);\n"
5810 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:304
5812 "Returns a list of paths which match the path expression C<path>. The "
5813 "returned paths are sufficiently qualified so that they match exactly one "
5814 "node in the current tree."
5818 #: ../src/guestfs-actions.pod:477
5819 msgid "guestfs_aug_mv"
5823 #: ../src/guestfs-actions.pod:479
5827 " guestfs_aug_mv (guestfs_h *g,\n"
5828 " const char *src,\n"
5829 " const char *dest);\n"
5834 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:312
5836 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5837 "C<dest> is overwritten if it exists."
5841 #: ../src/guestfs-actions.pod:491
5842 msgid "guestfs_aug_rm"
5846 #: ../src/guestfs-actions.pod:493
5850 " guestfs_aug_rm (guestfs_h *g,\n"
5851 " const char *augpath);\n"
5856 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:319
5857 msgid "Remove C<path> and all of its children."
5861 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5862 msgid "On success this returns the number of entries which were removed."
5866 #: ../src/guestfs-actions.pod:505
5867 msgid "guestfs_aug_save"
5871 #: ../src/guestfs-actions.pod:507
5875 " guestfs_aug_save (guestfs_h *g);\n"
5880 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:327
5881 msgid "This writes all pending changes to disk."
5885 #: ../src/guestfs-actions.pod:512
5887 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5892 #: ../src/guestfs-actions.pod:519
5893 msgid "guestfs_aug_set"
5897 #: ../src/guestfs-actions.pod:521
5901 " guestfs_aug_set (guestfs_h *g,\n"
5902 " const char *augpath,\n"
5903 " const char *val);\n"
5908 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:336
5909 msgid "Set the value associated with C<path> to C<val>."
5913 #: ../src/guestfs-actions.pod:528
5915 "In the Augeas API, it is possible to clear a node by setting the value to "
5916 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5917 "this call. Instead you must use the C<guestfs_aug_clear> call."
5921 #: ../src/guestfs-actions.pod:537
5922 msgid "guestfs_available"
5926 #: ../src/guestfs-actions.pod:539
5930 " guestfs_available (guestfs_h *g,\n"
5931 " char *const *groups);\n"
5936 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:347
5938 "This command is used to check the availability of some groups of "
5939 "functionality in the appliance, which not all builds of the libguestfs "
5940 "appliance will be able to provide."
5944 #: ../src/guestfs-actions.pod:547
5946 "The libguestfs groups, and the functions that those groups correspond to, "
5947 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5948 "runtime by calling C<guestfs_available_all_groups>."
5952 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:356
5954 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5955 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5956 "and Augeas (configuration file editing) functions."
5960 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
5961 msgid "The command returns no error if I<all> requested groups are available."
5965 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
5967 "It fails with an error if one or more of the requested groups is unavailable "
5972 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
5974 "If an unknown group name is included in the list of groups then an error is "
5979 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:369
5984 #: ../src/guestfs-actions.pod:571
5985 msgid "You must call C<guestfs_launch> before calling this function."
5989 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:377
5991 "The reason is because we don't know what groups are supported by the "
5992 "appliance/daemon until it is running and can be queried."
5996 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:383
5998 "If a group of functions is available, this does not necessarily mean that "
5999 "they will work. You still have to check for errors when calling individual "
6000 "API functions even if they are available."
6004 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:390
6006 "It is usually the job of distro packagers to build complete functionality "
6007 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6008 "with all requirements satisfied, will support everything."
6012 #: ../src/guestfs-actions.pod:593
6014 "This call was added in version C<1.0.80>. In previous versions of "
6015 "libguestfs all you could do would be to speculatively execute a command to "
6016 "find out if the daemon implemented it. See also C<guestfs_version>."
6020 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
6021 msgid "(Added in 1.0.80)"
6025 #: ../src/guestfs-actions.pod:604
6026 msgid "guestfs_available_all_groups"
6030 #: ../src/guestfs-actions.pod:606
6034 " guestfs_available_all_groups (guestfs_h *g);\n"
6039 #: ../src/guestfs-actions.pod:609
6041 "This command returns a list of all optional groups that this daemon knows "
6042 "about. Note this returns both supported and unsupported groups. To find "
6043 "out which ones the daemon can actually support you have to call "
6044 "C<guestfs_available> on each member of the returned list."
6048 #: ../src/guestfs-actions.pod:615
6049 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6053 #: ../src/guestfs-actions.pod:621
6054 msgid "(Added in 1.3.15)"
6058 #: ../src/guestfs-actions.pod:623
6059 msgid "guestfs_base64_in"
6063 #: ../src/guestfs-actions.pod:625
6067 " guestfs_base64_in (guestfs_h *g,\n"
6068 " const char *base64file,\n"
6069 " const char *filename);\n"
6074 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:420
6075 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6079 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
6080 msgid "(Added in 1.3.5)"
6084 #: ../src/guestfs-actions.pod:637
6085 msgid "guestfs_base64_out"
6089 #: ../src/guestfs-actions.pod:639
6093 " guestfs_base64_out (guestfs_h *g,\n"
6094 " const char *filename,\n"
6095 " const char *base64file);\n"
6100 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:429
6102 "This command downloads the contents of C<filename>, writing it out to local "
6103 "file C<base64file> encoded as base64."
6107 #: ../src/guestfs-actions.pod:651
6108 msgid "guestfs_blockdev_flushbufs"
6112 #: ../src/guestfs-actions.pod:653
6116 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6117 " const char *device);\n"
6122 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:438
6123 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6127 #: ../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
6128 msgid "This uses the L<blockdev(8)> command."
6132 #: ../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
6133 msgid "(Added in 0.9.3)"
6137 #: ../src/guestfs-actions.pod:666
6138 msgid "guestfs_blockdev_getbsz"
6142 #: ../src/guestfs-actions.pod:668
6146 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6147 " const char *device);\n"
6152 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:447
6153 msgid "This returns the block size of a device."
6157 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:512
6159 "(Note this is different from both I<size in blocks> and I<filesystem block "
6164 #: ../src/guestfs-actions.pod:683
6165 msgid "guestfs_blockdev_getro"
6169 #: ../src/guestfs-actions.pod:685
6173 " guestfs_blockdev_getro (guestfs_h *g,\n"
6174 " const char *device);\n"
6179 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:458
6181 "Returns a boolean indicating if the block device is read-only (true if "
6182 "read-only, false if not)."
6186 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:3054 ../src/guestfs-actions.pod:3068 ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3158 ../src/guestfs-actions.pod:3171 ../src/guestfs-actions.pod:3185 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3215 ../src/guestfs-actions.pod:4729
6187 msgid "This function returns a C truth value on success or -1 on error."
6191 #: ../src/guestfs-actions.pod:698
6192 msgid "guestfs_blockdev_getsize64"
6196 #: ../src/guestfs-actions.pod:700
6200 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6201 " const char *device);\n"
6206 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:467
6207 msgid "This returns the size of the device in bytes."
6211 #: ../src/guestfs-actions.pod:706
6212 msgid "See also C<guestfs_blockdev_getsz>."
6216 #: ../src/guestfs-actions.pod:714
6217 msgid "guestfs_blockdev_getss"
6221 #: ../src/guestfs-actions.pod:716
6225 " guestfs_blockdev_getss (guestfs_h *g,\n"
6226 " const char *device);\n"
6231 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:477
6233 "This returns the size of sectors on a block device. Usually 512, but can be "
6234 "larger for modern devices."
6238 #: ../src/guestfs-actions.pod:723
6240 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6245 #: ../src/guestfs-actions.pod:732
6246 msgid "guestfs_blockdev_getsz"
6250 #: ../src/guestfs-actions.pod:734
6254 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6255 " const char *device);\n"
6260 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:489
6262 "This returns the size of the device in units of 512-byte sectors (even if "
6263 "the sectorsize isn't 512 bytes ... weird)."
6267 #: ../src/guestfs-actions.pod:741
6269 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6270 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6274 #: ../src/guestfs-actions.pod:751
6275 msgid "guestfs_blockdev_rereadpt"
6279 #: ../src/guestfs-actions.pod:753
6283 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6284 " const char *device);\n"
6289 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:502
6290 msgid "Reread the partition table on C<device>."
6294 #: ../src/guestfs-actions.pod:765
6295 msgid "guestfs_blockdev_setbsz"
6299 #: ../src/guestfs-actions.pod:767
6303 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6304 " const char *device,\n"
6305 " int blocksize);\n"
6310 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:510
6311 msgid "This sets the block size of a device."
6315 #: ../src/guestfs-actions.pod:783
6316 msgid "guestfs_blockdev_setro"
6320 #: ../src/guestfs-actions.pod:785
6324 " guestfs_blockdev_setro (guestfs_h *g,\n"
6325 " const char *device);\n"
6330 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:521
6331 msgid "Sets the block device named C<device> to read-only."
6335 #: ../src/guestfs-actions.pod:797
6336 msgid "guestfs_blockdev_setrw"
6340 #: ../src/guestfs-actions.pod:799
6344 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6345 " const char *device);\n"
6350 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:529
6351 msgid "Sets the block device named C<device> to read-write."
6355 #: ../src/guestfs-actions.pod:811
6356 msgid "guestfs_case_sensitive_path"
6360 #: ../src/guestfs-actions.pod:813
6364 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6365 " const char *path);\n"
6370 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:537
6372 "This can be used to resolve case insensitive paths on a filesystem which is "
6373 "case sensitive. The use case is to resolve paths which you have read from "
6374 "Windows configuration files or the Windows Registry, to the true path."
6378 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
6380 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6381 "(and probably others), which is that although the underlying filesystem is "
6382 "case-insensitive, the driver exports the filesystem to Linux as "
6387 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
6389 "One consequence of this is that special directories such as C<c:\\windows> "
6390 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6391 "precise details of how they were created. In Windows itself this would not "
6396 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:553
6398 "Bug or feature? You decide: "
6399 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6403 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:556
6405 "This function resolves the true case of each element in the path and returns "
6406 "the case-sensitive path."
6410 #: ../src/guestfs-actions.pod:839
6412 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
6413 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6414 "how the directories were originally created under Windows)."
6418 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:564
6419 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6423 #: ../src/guestfs-actions.pod:847
6424 msgid "See also C<guestfs_realpath>."
6428 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6671
6429 msgid "(Added in 1.0.75)"
6433 #: ../src/guestfs-actions.pod:854
6438 #: ../src/guestfs-actions.pod:856
6442 " guestfs_cat (guestfs_h *g,\n"
6443 " const char *path);\n"
6448 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5216 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:3468
6449 msgid "Return the contents of the file named C<path>."
6453 #: ../src/guestfs-actions.pod:862
6455 "Note that this function cannot correctly handle binary files (specifically, "
6456 "files containing C<\\0> character which is treated as end of string). For "
6457 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
6458 "functions which have a more complex interface."
6462 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2260 ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:4998 ../src/guestfs-actions.pod:5024 ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5181 ../src/guestfs-actions.pod:5205 ../src/guestfs-actions.pod:6056 ../src/guestfs-actions.pod:6111 ../src/guestfs-actions.pod:6257 ../src/guestfs-actions.pod:6281 ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6995 ../src/guestfs-actions.pod:7014 ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7118 ../src/guestfs-actions.pod:7164 ../src/guestfs-actions.pod:7183 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:715 ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:913 ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990 ../fish/guestfish-actions.pod:1185 ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:1490 ../fish/guestfish-actions.pod:1518 ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:1543 ../fish/guestfish-actions.pod:1562 ../fish/guestfish-actions.pod:3338 ../fish/guestfish-actions.pod:3353 ../fish/guestfish-actions.pod:3429 ../fish/guestfish-actions.pod:3446 ../fish/guestfish-actions.pod:3461 ../fish/guestfish-actions.pod:4044 ../fish/guestfish-actions.pod:4090 ../fish/guestfish-actions.pod:4175 ../fish/guestfish-actions.pod:4190 ../fish/guestfish-actions.pod:4600 ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4635 ../fish/guestfish-actions.pod:4645 ../fish/guestfish-actions.pod:4693 ../fish/guestfish-actions.pod:4703 ../fish/guestfish-actions.pod:4732 ../fish/guestfish-actions.pod:4742
6464 "Because of the message protocol, there is a transfer limit of somewhere "
6465 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6469 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3326 ../src/guestfs-actions.pod:3388 ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3912 ../src/guestfs-actions.pod:5104 ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:6830 ../src/guestfs-actions.pod:6844
6470 msgid "(Added in 0.4)"
6474 #: ../src/guestfs-actions.pod:875
6475 msgid "guestfs_checksum"
6479 #: ../src/guestfs-actions.pod:877
6483 " guestfs_checksum (guestfs_h *g,\n"
6484 " const char *csumtype,\n"
6485 " const char *path);\n"
6490 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:587
6491 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6495 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:590
6497 "The type of checksum to compute is given by the C<csumtype> parameter which "
6498 "must have one of the following values:"
6502 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
6507 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
6509 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6514 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
6519 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
6520 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6524 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
6529 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
6530 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6534 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
6539 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
6540 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6544 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
6549 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
6550 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6554 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
6559 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
6560 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6564 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
6569 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
6570 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6574 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:626
6575 msgid "The checksum is returned as a printable string."
6579 #: ../src/guestfs-actions.pod:923
6580 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6584 #: ../src/guestfs-actions.pod:925
6585 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6589 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3070 ../src/guestfs-actions.pod:3099 ../src/guestfs-actions.pod:3160 ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:6527
6590 msgid "(Added in 1.0.2)"
6594 #: ../src/guestfs-actions.pod:932
6595 msgid "guestfs_checksum_device"
6599 #: ../src/guestfs-actions.pod:934
6603 " guestfs_checksum_device (guestfs_h *g,\n"
6604 " const char *csumtype,\n"
6605 " const char *device);\n"
6610 #: ../src/guestfs-actions.pod:939
6612 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6613 "device named C<device>. For the types of checksums supported see the "
6614 "C<guestfs_checksum> command."
6618 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4635 ../src/guestfs-actions.pod:4694 ../src/guestfs-actions.pod:4731 ../src/guestfs-actions.pod:4749 ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6450 ../src/guestfs-actions.pod:6856
6619 msgid "(Added in 1.3.2)"
6623 #: ../src/guestfs-actions.pod:948
6624 msgid "guestfs_checksums_out"
6628 #: ../src/guestfs-actions.pod:950
6632 " guestfs_checksums_out (guestfs_h *g,\n"
6633 " const char *csumtype,\n"
6634 " const char *directory,\n"
6635 " const char *sumsfile);\n"
6640 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:644
6642 "This command computes the checksums of all regular files in C<directory> and "
6643 "then emits a list of those checksums to the local output file C<sumsfile>."
6647 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:648
6649 "This can be used for verifying the integrity of a virtual machine. However "
6650 "to be properly secure you should pay attention to the output of the checksum "
6651 "command (it uses the ones from GNU coreutils). In particular when the "
6652 "filename is not printable, coreutils uses a special backslash syntax. For "
6653 "more information, see the GNU coreutils info file."
6657 #: ../src/guestfs-actions.pod:970
6658 msgid "(Added in 1.3.7)"
6662 #: ../src/guestfs-actions.pod:972
6663 msgid "guestfs_chmod"
6667 #: ../src/guestfs-actions.pod:974
6671 " guestfs_chmod (guestfs_h *g,\n"
6673 " const char *path);\n"
6678 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:662
6680 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6685 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:665
6687 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6688 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6693 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4149 ../src/guestfs-actions.pod:4334 ../src/guestfs-actions.pod:4353 ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:669 ../fish/guestfish-actions.pod:2795 ../fish/guestfish-actions.pod:2913 ../fish/guestfish-actions.pod:2923 ../fish/guestfish-actions.pod:2933
6694 msgid "The mode actually set is affected by the umask."
6698 #: ../src/guestfs-actions.pod:992
6699 msgid "guestfs_chown"
6703 #: ../src/guestfs-actions.pod:994
6707 " guestfs_chown (guestfs_h *g,\n"
6710 " const char *path);\n"
6715 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:675
6716 msgid "Change the file owner to C<owner> and group to C<group>."
6720 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:677 ../fish/guestfish-actions.pod:2253
6722 "Only numeric uid and gid are supported. If you want to use names, you will "
6723 "need to locate and parse the password file yourself (Augeas support makes "
6724 "this relatively easy)."
6728 #: ../src/guestfs-actions.pod:1010
6729 msgid "guestfs_command"
6733 #: ../src/guestfs-actions.pod:1012
6737 " guestfs_command (guestfs_h *g,\n"
6738 " char *const *arguments);\n"
6743 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:685
6745 "This call runs a command from the guest filesystem. The filesystem must be "
6746 "mounted, and must contain a compatible operating system (ie. something "
6747 "Linux, with the same or compatible processor architecture)."
6751 #: ../src/guestfs-actions.pod:1021
6753 "The single parameter is an argv-style list of arguments. The first element "
6754 "is the name of the program to run. Subsequent elements are parameters. The "
6755 "list must be non-empty (ie. must contain a program name). Note that the "
6756 "command runs directly, and is I<not> invoked via the shell (see "
6761 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:697
6762 msgid "The return value is anything printed to I<stdout> by the command."
6766 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:700
6768 "If the command returns a non-zero exit status, then this function returns an "
6769 "error message. The error message string is the content of I<stderr> from "
6774 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:704
6776 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6777 "C</bin>. If you require a program from another location, you should provide "
6778 "the full path in the first parameter."
6782 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
6784 "Shared libraries and data files required by the program must be available on "
6785 "filesystems which are mounted in the correct places. It is the caller's "
6786 "responsibility to ensure all filesystems that are needed are mounted at the "
6791 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072 ../src/guestfs-actions.pod:1535
6792 msgid "(Added in 0.9.1)"
6796 #: ../src/guestfs-actions.pod:1054
6797 msgid "guestfs_command_lines"
6801 #: ../src/guestfs-actions.pod:1056
6805 " guestfs_command_lines (guestfs_h *g,\n"
6806 " char *const *arguments);\n"
6811 #: ../src/guestfs-actions.pod:1060
6813 "This is the same as C<guestfs_command>, but splits the result into a list of "
6818 #: ../src/guestfs-actions.pod:1063
6819 msgid "See also: C<guestfs_sh_lines>"
6823 #: ../src/guestfs-actions.pod:1074
6824 msgid "guestfs_config"
6828 #: ../src/guestfs-actions.pod:1076
6832 " guestfs_config (guestfs_h *g,\n"
6833 " const char *qemuparam,\n"
6834 " const char *qemuvalue);\n"
6839 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:734
6841 "This can be used to add arbitrary qemu command line parameters of the form "
6842 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6843 "setting some parameters which would interfere with parameters that we use."
6847 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
6848 msgid "The first character of C<param> string must be a C<-> (dash)."
6852 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
6853 msgid "C<value> can be NULL."
6857 #: ../src/guestfs-actions.pod:1094
6858 msgid "guestfs_copy_size"
6862 #: ../src/guestfs-actions.pod:1096
6866 " guestfs_copy_size (guestfs_h *g,\n"
6867 " const char *src,\n"
6868 " const char *dest,\n"
6874 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:747
6876 "This command copies exactly C<size> bytes from one source device or file "
6877 "C<src> to another destination device or file C<dest>."
6881 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:750
6883 "Note this will fail if the source is too short or if the destination is not "
6888 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6522 ../src/guestfs-actions.pod:6556 ../src/guestfs-actions.pod:7035 ../src/guestfs-actions.pod:7054
6890 "This long-running command can generate progress notification messages so "
6891 "that the caller can display a progress bar or indicator. To receive these "
6892 "messages, the caller must register a progress callback. See "
6893 "L<guestfs(3)/guestfs_set_progress_callback>."
6897 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:5131 ../src/guestfs-actions.pod:6763 ../src/guestfs-actions.pod:6783 ../src/guestfs-actions.pod:6869
6898 msgid "(Added in 1.0.87)"
6902 #: ../src/guestfs-actions.pod:1117
6907 #: ../src/guestfs-actions.pod:1119
6911 " guestfs_cp (guestfs_h *g,\n"
6912 " const char *src,\n"
6913 " const char *dest);\n"
6918 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:757
6920 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6921 "destination filename or destination directory."
6925 #: ../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:4598 ../src/guestfs-actions.pod:4975
6926 msgid "(Added in 1.0.18)"
6930 #: ../src/guestfs-actions.pod:1131
6931 msgid "guestfs_cp_a"
6935 #: ../src/guestfs-actions.pod:1133
6939 " guestfs_cp_a (guestfs_h *g,\n"
6940 " const char *src,\n"
6941 " const char *dest);\n"
6946 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:764
6948 "This copies a file or directory from C<src> to C<dest> recursively using the "
6953 #: ../src/guestfs-actions.pod:1145
6958 #: ../src/guestfs-actions.pod:1147
6962 " guestfs_dd (guestfs_h *g,\n"
6963 " const char *src,\n"
6964 " const char *dest);\n"
6969 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
6971 "This command copies from one source device or file C<src> to another "
6972 "destination device or file C<dest>. Normally you would use this to copy to "
6973 "or from a device or partition, for example to duplicate a filesystem."
6977 #: ../src/guestfs-actions.pod:1157
6979 "If the destination is a device, it must be as large or larger than the "
6980 "source file or device, otherwise the copy will fail. This command cannot do "
6981 "partial copies (see C<guestfs_copy_size>)."
6985 #: ../src/guestfs-actions.pod:1165
6990 #: ../src/guestfs-actions.pod:1167
6994 " guestfs_df (guestfs_h *g);\n"
6999 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:784
7000 msgid "This command runs the C<df> command to report disk space used."
7004 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
7006 "This command is mostly useful for interactive sessions. It is I<not> "
7007 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7012 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2263 ../src/guestfs-actions.pod:2287 ../src/guestfs-actions.pod:2355 ../src/guestfs-actions.pod:4035 ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:6260 ../src/guestfs-actions.pod:6284 ../src/guestfs-actions.pod:6902 ../src/guestfs-actions.pod:6915 ../src/guestfs-actions.pod:6928
7013 msgid "(Added in 1.0.54)"
7017 #: ../src/guestfs-actions.pod:1181
7018 msgid "guestfs_df_h"
7022 #: ../src/guestfs-actions.pod:1183
7026 " guestfs_df_h (guestfs_h *g);\n"
7031 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:794
7033 "This command runs the C<df -h> command to report disk space used in "
7034 "human-readable format."
7038 #: ../src/guestfs-actions.pod:1198
7039 msgid "guestfs_dmesg"
7043 #: ../src/guestfs-actions.pod:1200
7047 " guestfs_dmesg (guestfs_h *g);\n"
7052 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:805
7054 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7055 "This is sometimes useful for extended debugging of problems."
7059 #: ../src/guestfs-actions.pod:1207
7061 "Another way to get the same information is to enable verbose messages with "
7062 "C<guestfs_set_verbose> or by setting the environment variable "
7063 "C<LIBGUESTFS_DEBUG=1> before running the program."
7067 #: ../src/guestfs-actions.pod:1217
7068 msgid "guestfs_download"
7072 #: ../src/guestfs-actions.pod:1219
7076 " guestfs_download (guestfs_h *g,\n"
7077 " const char *remotefilename,\n"
7078 " const char *filename);\n"
7083 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249 ../fish/guestfish-actions.pod:818 ../fish/guestfish-actions.pod:831
7085 "Download file C<remotefilename> and save it as C<filename> on the local "
7090 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:821 ../fish/guestfish-actions.pod:4348
7091 msgid "C<filename> can also be a named pipe."
7095 #: ../src/guestfs-actions.pod:1229
7096 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7100 #: ../src/guestfs-actions.pod:1240
7101 msgid "guestfs_download_offset"
7105 #: ../src/guestfs-actions.pod:1242
7109 " guestfs_download_offset (guestfs_h *g,\n"
7110 " const char *remotefilename,\n"
7111 " const char *filename,\n"
7112 " int64_t offset,\n"
7118 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:834
7120 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7121 "region must be within the file or device)."
7125 #: ../src/guestfs-actions.pod:1255
7127 "Note that there is no limit on the amount of data that can be downloaded "
7128 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7129 "full amount unless an error occurs."
7133 #: ../src/guestfs-actions.pod:1260
7134 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7138 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6561
7139 msgid "(Added in 1.5.17)"
7143 #: ../src/guestfs-actions.pod:1271
7144 msgid "guestfs_drop_caches"
7148 #: ../src/guestfs-actions.pod:1273
7152 " guestfs_drop_caches (guestfs_h *g,\n"
7153 " int whattodrop);\n"
7158 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:850
7160 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7161 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7162 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7166 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
7167 msgid "Setting C<whattodrop> to 3 should drop everything."
7171 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
7173 "This automatically calls L<sync(2)> before the operation, so that the "
7174 "maximum guest memory is freed."
7178 #: ../src/guestfs-actions.pod:1291
7183 #: ../src/guestfs-actions.pod:1293
7187 " guestfs_du (guestfs_h *g,\n"
7188 " const char *path);\n"
7193 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:864
7195 "This command runs the C<du -s> command to estimate file space usage for "
7200 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:867
7202 "C<path> can be a file or a directory. If C<path> is a directory then the "
7203 "estimate includes the contents of the directory and all subdirectories "
7208 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:871
7209 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7213 #: ../src/guestfs-actions.pod:1311
7214 msgid "guestfs_e2fsck_f"
7218 #: ../src/guestfs-actions.pod:1313
7222 " guestfs_e2fsck_f (guestfs_h *g,\n"
7223 " const char *device);\n"
7228 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:878
7230 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7231 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7236 #: ../src/guestfs-actions.pod:1321
7238 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7239 "Normally you should use C<guestfs_fsck>."
7243 #: ../src/guestfs-actions.pod:1326
7244 msgid "(Added in 1.0.29)"
7248 #: ../src/guestfs-actions.pod:1328
7249 msgid "guestfs_echo_daemon"
7253 #: ../src/guestfs-actions.pod:1330
7257 " guestfs_echo_daemon (guestfs_h *g,\n"
7258 " char *const *words);\n"
7263 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:889
7265 "This command concatenates the list of C<words> passed with single spaces "
7266 "between them and returns the resulting string."
7270 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:892
7271 msgid "You can use this command to test the connection through to the daemon."
7275 #: ../src/guestfs-actions.pod:1339
7276 msgid "See also C<guestfs_ping_daemon>."
7280 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:5764
7281 msgid "(Added in 1.0.69)"
7285 #: ../src/guestfs-actions.pod:1346
7286 msgid "guestfs_egrep"
7290 #: ../src/guestfs-actions.pod:1348
7294 " guestfs_egrep (guestfs_h *g,\n"
7295 " const char *regex,\n"
7296 " const char *path);\n"
7301 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:900
7302 msgid "This calls the external C<egrep> program and returns the matching lines."
7306 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2201 ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:2404 ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:3459 ../src/guestfs-actions.pod:4433 ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6166 ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6201 ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6227 ../src/guestfs-actions.pod:6998 ../src/guestfs-actions.pod:7017 ../src/guestfs-actions.pod:7102 ../src/guestfs-actions.pod:7121 ../src/guestfs-actions.pod:7167 ../src/guestfs-actions.pod:7186
7307 msgid "(Added in 1.0.66)"
7311 #: ../src/guestfs-actions.pod:1365
7312 msgid "guestfs_egrepi"
7316 #: ../src/guestfs-actions.pod:1367
7320 " guestfs_egrepi (guestfs_h *g,\n"
7321 " const char *regex,\n"
7322 " const char *path);\n"
7327 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:910
7328 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7332 #: ../src/guestfs-actions.pod:1384
7333 msgid "guestfs_equal"
7337 #: ../src/guestfs-actions.pod:1386
7341 " guestfs_equal (guestfs_h *g,\n"
7342 " const char *file1,\n"
7343 " const char *file2);\n"
7348 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:920
7350 "This compares the two files C<file1> and C<file2> and returns true if their "
7351 "content is exactly equal, or false otherwise."
7355 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:923
7356 msgid "The external L<cmp(1)> program is used for the comparison."
7360 #: ../src/guestfs-actions.pod:1400
7361 msgid "guestfs_exists"
7365 #: ../src/guestfs-actions.pod:1402
7369 " guestfs_exists (guestfs_h *g,\n"
7370 " const char *path);\n"
7375 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:929
7377 "This returns C<true> if and only if there is a file, directory (or anything) "
7378 "with the given C<path> name."
7382 #: ../src/guestfs-actions.pod:1409
7383 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7387 #: ../src/guestfs-actions.pod:1415
7388 msgid "guestfs_fallocate"
7392 #: ../src/guestfs-actions.pod:1417
7396 " guestfs_fallocate (guestfs_h *g,\n"
7397 " const char *path,\n"
7403 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:957
7405 "This command preallocates a file (containing zero bytes) named C<path> of "
7406 "size C<len> bytes. If the file exists already, it is overwritten."
7410 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:942
7412 "Do not confuse this with the guestfish-specific C<alloc> command which "
7413 "allocates a file in the host and attaches it as a device."
7417 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:946
7419 "This function is deprecated. In new code, use the C<fallocate64> call "
7424 #: ../src/guestfs-actions.pod:1441
7425 msgid "guestfs_fallocate64"
7429 #: ../src/guestfs-actions.pod:1443
7433 " guestfs_fallocate64 (guestfs_h *g,\n"
7434 " const char *path,\n"
7440 #: ../src/guestfs-actions.pod:1452
7442 "Note that this call allocates disk blocks for the file. To create a sparse "
7443 "file use C<guestfs_truncate_size> instead."
7447 #: ../src/guestfs-actions.pod:1455
7449 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
7450 "oversight it only allowed 30 bit lengths to be specified, effectively "
7451 "limiting the maximum size of files created through that call to 1GB."
7455 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:969
7457 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7458 "commands which create a file in the host and attach it as a device."
7462 #: ../src/guestfs-actions.pod:1466
7463 msgid "(Added in 1.3.17)"
7467 #: ../src/guestfs-actions.pod:1468
7468 msgid "guestfs_fgrep"
7472 #: ../src/guestfs-actions.pod:1470
7476 " guestfs_fgrep (guestfs_h *g,\n"
7477 " const char *pattern,\n"
7478 " const char *path);\n"
7483 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:977
7484 msgid "This calls the external C<fgrep> program and returns the matching lines."
7488 #: ../src/guestfs-actions.pod:1487
7489 msgid "guestfs_fgrepi"
7493 #: ../src/guestfs-actions.pod:1489
7497 " guestfs_fgrepi (guestfs_h *g,\n"
7498 " const char *pattern,\n"
7499 " const char *path);\n"
7504 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:987
7505 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7509 #: ../src/guestfs-actions.pod:1506
7510 msgid "guestfs_file"
7514 #: ../src/guestfs-actions.pod:1508
7518 " guestfs_file (guestfs_h *g,\n"
7519 " const char *path);\n"
7524 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:997
7526 "This call uses the standard L<file(1)> command to determine the type or "
7527 "contents of the file."
7531 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1000
7533 "This call will also transparently look inside various types of compressed "
7538 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1003
7540 "The exact command which runs is C<file -zb path>. Note in particular that "
7541 "the filename is not prepended to the output (the C<-b> option)."
7545 #: ../src/guestfs-actions.pod:1522
7547 "This command can also be used on C</dev/> devices (and partitions, LV "
7548 "names). You can for example use this to determine if a device contains a "
7549 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7553 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1012
7555 "If the C<path> does not begin with C</dev/> then this command only works for "
7556 "the content of regular files. For other file types (directory, symbolic "
7557 "link etc) it will just return the string C<directory> etc."
7561 #: ../src/guestfs-actions.pod:1537
7562 msgid "guestfs_file_architecture"
7566 #: ../src/guestfs-actions.pod:1539
7570 " guestfs_file_architecture (guestfs_h *g,\n"
7571 " const char *filename);\n"
7576 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1021
7578 "This detects the architecture of the binary C<filename>, and returns it if "
7583 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
7584 msgid "Currently defined architectures are:"
7588 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1028
7593 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7595 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7596 "irrespective of the precise processor requirements of the binary."
7600 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1033
7605 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
7606 msgid "64 bit x86-64."
7610 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
7615 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
7616 msgid "32 bit SPARC."
7620 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
7625 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
7626 msgid "64 bit SPARC V9 and above."
7630 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
7635 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
7636 msgid "Intel Itanium."
7640 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
7645 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
7646 msgid "32 bit Power PC."
7650 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
7655 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
7656 msgid "64 bit Power PC."
7660 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1059
7661 msgid "Libguestfs may return other architecture strings in future."
7665 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
7666 msgid "The function works on at least the following types of files:"
7670 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1067
7671 msgid "many types of Un*x and Linux binary"
7675 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1071
7676 msgid "many types of Un*x and Linux shared library"
7680 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1075
7681 msgid "Windows Win32 and Win64 binaries"
7685 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1079
7686 msgid "Windows Win32 and Win64 DLLs"
7690 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
7691 msgid "Win32 binaries and DLLs return C<i386>."
7695 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
7696 msgid "Win64 binaries and DLLs return C<x86_64>."
7700 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1087
7701 msgid "Linux kernel modules"
7705 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1091
7706 msgid "Linux new-style initrd images"
7710 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1095
7711 msgid "some non-x86 Linux vmlinuz kernels"
7715 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1099
7716 msgid "What it can't do currently:"
7720 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1105
7721 msgid "static libraries (libfoo.a)"
7725 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1109
7726 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7730 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1113
7731 msgid "x86 Linux vmlinuz kernels"
7735 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
7737 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7738 "compressed code, and are horribly hard to unpack. If you want to find the "
7739 "architecture of a kernel, use the architecture of the associated initrd or "
7740 "kernel module(s) instead."
7744 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:2589 ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2806 ../src/guestfs-actions.pod:2868 ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3173
7745 msgid "(Added in 1.5.3)"
7749 #: ../src/guestfs-actions.pod:1649
7750 msgid "guestfs_filesize"
7754 #: ../src/guestfs-actions.pod:1651
7758 " guestfs_filesize (guestfs_h *g,\n"
7759 " const char *file);\n"
7764 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1126
7765 msgid "This command returns the size of C<file> in bytes."
7769 #: ../src/guestfs-actions.pod:1657
7771 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7772 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7773 "devices, use C<guestfs_blockdev_getsize64>."
7777 #: ../src/guestfs-actions.pod:1663
7778 msgid "(Added in 1.0.82)"
7782 #: ../src/guestfs-actions.pod:1665
7783 msgid "guestfs_fill"
7787 #: ../src/guestfs-actions.pod:1667
7791 " guestfs_fill (guestfs_h *g,\n"
7794 " const char *path);\n"
7799 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1136
7801 "This command creates a new file called C<path>. The initial content of the "
7802 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7807 #: ../src/guestfs-actions.pod:1677
7809 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7810 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7811 "bytes use C<guestfs_fill_pattern>."
7815 #: ../src/guestfs-actions.pod:1689
7816 msgid "(Added in 1.0.79)"
7820 #: ../src/guestfs-actions.pod:1691
7821 msgid "guestfs_fill_pattern"
7825 #: ../src/guestfs-actions.pod:1693
7829 " guestfs_fill_pattern (guestfs_h *g,\n"
7830 " const char *pattern,\n"
7832 " const char *path);\n"
7837 #: ../src/guestfs-actions.pod:1699
7839 "This function is like C<guestfs_fill> except that it creates a new file of "
7840 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7841 "pattern is truncated if necessary to ensure the length of the file is "
7842 "exactly C<len> bytes."
7846 #: ../src/guestfs-actions.pod:1711
7847 msgid "(Added in 1.3.12)"
7851 #: ../src/guestfs-actions.pod:1713
7852 msgid "guestfs_find"
7856 #: ../src/guestfs-actions.pod:1715
7860 " guestfs_find (guestfs_h *g,\n"
7861 " const char *directory);\n"
7866 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1158
7868 "This command lists out all files and directories, recursively, starting at "
7869 "C<directory>. It is essentially equivalent to running the shell command "
7870 "C<find directory -print> but some post-processing happens on the output, "
7875 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1163
7877 "This returns a list of strings I<without any prefix>. Thus if the directory "
7882 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1166
7892 #: ../src/guestfs-actions.pod:1731
7893 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7897 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1173
7908 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1178
7909 msgid "If C<directory> is not a directory, then this command returns an error."
7913 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1181
7914 msgid "The returned list is sorted."
7918 #: ../src/guestfs-actions.pod:1744
7919 msgid "See also C<guestfs_find0>."
7923 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:5393
7924 msgid "(Added in 1.0.27)"
7928 #: ../src/guestfs-actions.pod:1755
7929 msgid "guestfs_find0"
7933 #: ../src/guestfs-actions.pod:1757
7937 " guestfs_find0 (guestfs_h *g,\n"
7938 " const char *directory,\n"
7939 " const char *files);\n"
7944 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1192
7946 "This command lists out all files and directories, recursively, starting at "
7947 "C<directory>, placing the resulting list in the external file called "
7952 #: ../src/guestfs-actions.pod:1766
7954 "This command works the same way as C<guestfs_find> with the following "
7959 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1203
7960 msgid "The resulting list is written to an external file."
7964 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1207
7966 "Items (filenames) in the result are separated by C<\\0> characters. See "
7967 "L<find(1)> option I<-print0>."
7971 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1212
7972 msgid "This command is not limited in the number of names that it can return."
7976 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1217
7977 msgid "The result list is not sorted."
7981 #: ../src/guestfs-actions.pod:1793
7982 msgid "(Added in 1.0.74)"
7986 #: ../src/guestfs-actions.pod:1795
7987 msgid "guestfs_findfs_label"
7991 #: ../src/guestfs-actions.pod:1797
7995 " guestfs_findfs_label (guestfs_h *g,\n"
7996 " const char *label);\n"
8001 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1227
8003 "This command searches the filesystems and returns the one which has the "
8004 "given label. An error is returned if no such filesystem can be found."
8008 #: ../src/guestfs-actions.pod:1805
8009 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8013 #: ../src/guestfs-actions.pod:1812
8014 msgid "guestfs_findfs_uuid"
8018 #: ../src/guestfs-actions.pod:1814
8022 " guestfs_findfs_uuid (guestfs_h *g,\n"
8023 " const char *uuid);\n"
8028 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1237
8030 "This command searches the filesystems and returns the one which has the "
8031 "given UUID. An error is returned if no such filesystem can be found."
8035 #: ../src/guestfs-actions.pod:1822
8036 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8040 #: ../src/guestfs-actions.pod:1829
8041 msgid "guestfs_fsck"
8045 #: ../src/guestfs-actions.pod:1831
8049 " guestfs_fsck (guestfs_h *g,\n"
8050 " const char *fstype,\n"
8051 " const char *device);\n"
8056 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1247
8058 "This runs the filesystem checker (fsck) on C<device> which should have "
8059 "filesystem type C<fstype>."
8063 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1250
8065 "The returned integer is the status. See L<fsck(8)> for the list of status "
8066 "codes from C<fsck>."
8070 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1259
8071 msgid "Multiple status codes can be summed together."
8075 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1263
8077 "A non-zero return code can mean \"success\", for example if errors have been "
8078 "corrected on the filesystem."
8082 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1268
8083 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8087 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1273
8088 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8092 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:7040
8093 msgid "(Added in 1.0.16)"
8097 #: ../src/guestfs-actions.pod:1868
8098 msgid "guestfs_get_append"
8102 #: ../src/guestfs-actions.pod:1870
8106 " guestfs_get_append (guestfs_h *g);\n"
8111 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1279
8113 "Return the additional kernel options which are added to the guest kernel "
8118 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1282
8119 msgid "If C<NULL> then no options are added."
8123 #: ../src/guestfs-actions.pod:1878
8125 "This function returns a string which may be NULL. There is no way to return "
8126 "an error from this function. The string is owned by the guest handle and "
8127 "must I<not> be freed."
8131 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:5071 ../src/guestfs-actions.pod:5534 ../src/guestfs-actions.pod:5902 ../src/guestfs-actions.pod:5921 ../src/guestfs-actions.pod:5937 ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:6711 ../src/guestfs-actions.pod:6729 ../src/guestfs-actions.pod:7083
8132 msgid "(Added in 1.0.26)"
8136 #: ../src/guestfs-actions.pod:1884
8137 msgid "guestfs_get_autosync"
8141 #: ../src/guestfs-actions.pod:1886
8145 " guestfs_get_autosync (guestfs_h *g);\n"
8150 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
8151 msgid "Get the autosync flag."
8155 #: ../src/guestfs-actions.pod:1895
8156 msgid "guestfs_get_direct"
8160 #: ../src/guestfs-actions.pod:1897
8164 " guestfs_get_direct (guestfs_h *g);\n"
8169 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1294
8170 msgid "Return the direct appliance mode flag."
8174 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5575
8175 msgid "(Added in 1.0.72)"
8179 #: ../src/guestfs-actions.pod:1906
8180 msgid "guestfs_get_e2label"
8184 #: ../src/guestfs-actions.pod:1908
8188 " guestfs_get_e2label (guestfs_h *g,\n"
8189 " const char *device);\n"
8194 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1300
8195 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8199 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1303
8201 "This function is deprecated. In new code, use the C<vfs_label> call "
8206 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:5593 ../src/guestfs-actions.pod:5612
8207 msgid "(Added in 1.0.15)"
8211 #: ../src/guestfs-actions.pod:1927
8212 msgid "guestfs_get_e2uuid"
8216 #: ../src/guestfs-actions.pod:1929
8220 " guestfs_get_e2uuid (guestfs_h *g,\n"
8221 " const char *device);\n"
8226 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1314
8227 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8231 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1317
8232 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
8236 #: ../src/guestfs-actions.pod:1948
8237 msgid "guestfs_get_memsize"
8241 #: ../src/guestfs-actions.pod:1950
8245 " guestfs_get_memsize (guestfs_h *g);\n"
8250 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1328
8251 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8255 #: ../src/guestfs-actions.pod:1956
8257 "If C<guestfs_set_memsize> was not called on this handle, and if "
8258 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8259 "value for memsize."
8263 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:5628 ../src/guestfs-actions.pod:5735 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:1386 ../fish/guestfish-actions.pod:3755 ../fish/guestfish-actions.pod:3842
8264 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8268 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4153 ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4388 ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5876 ../src/guestfs-actions.pod:6477
8269 msgid "(Added in 1.0.55)"
8273 #: ../src/guestfs-actions.pod:1967
8274 msgid "guestfs_get_network"
8278 #: ../src/guestfs-actions.pod:1969
8282 " guestfs_get_network (guestfs_h *g);\n"
8287 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1342
8288 msgid "This returns the enable network flag."
8292 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5652
8293 msgid "(Added in 1.5.4)"
8297 #: ../src/guestfs-actions.pod:1978
8298 msgid "guestfs_get_path"
8302 #: ../src/guestfs-actions.pod:1980
8306 " guestfs_get_path (guestfs_h *g);\n"
8311 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1348
8312 msgid "Return the current search path."
8316 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
8318 "This is always non-NULL. If it wasn't set already, then this will return "
8323 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
8325 "This function returns a string, or NULL on error. The string is owned by "
8326 "the guest handle and must I<not> be freed."
8330 #: ../src/guestfs-actions.pod:1993
8331 msgid "guestfs_get_pid"
8335 #: ../src/guestfs-actions.pod:1995
8339 " guestfs_get_pid (guestfs_h *g);\n"
8344 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1359
8346 "Return the process ID of the qemu subprocess. If there is no qemu "
8347 "subprocess, then this will return an error."
8351 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1362
8352 msgid "This is an internal call used for debugging and testing."
8356 #: ../src/guestfs-actions.pod:2005
8357 msgid "(Added in 1.0.56)"
8361 #: ../src/guestfs-actions.pod:2007
8362 msgid "guestfs_get_qemu"
8366 #: ../src/guestfs-actions.pod:2009
8370 " guestfs_get_qemu (guestfs_h *g);\n"
8375 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1368
8376 msgid "Return the current qemu binary."
8380 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
8382 "This is always non-NULL. If it wasn't set already, then this will return "
8383 "the default qemu binary name."
8387 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5697
8388 msgid "(Added in 1.0.6)"
8392 #: ../src/guestfs-actions.pod:2022
8393 msgid "guestfs_get_recovery_proc"
8397 #: ../src/guestfs-actions.pod:2024
8401 " guestfs_get_recovery_proc (guestfs_h *g);\n"
8406 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
8407 msgid "Return the recovery process enabled flag."
8411 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3263 ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5344 ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:6380 ../src/guestfs-actions.pod:6400 ../src/guestfs-actions.pod:6592
8412 msgid "(Added in 1.0.77)"
8416 #: ../src/guestfs-actions.pod:2033
8417 msgid "guestfs_get_selinux"
8421 #: ../src/guestfs-actions.pod:2035
8425 " guestfs_get_selinux (guestfs_h *g);\n"
8430 #: ../src/guestfs-actions.pod:2038
8432 "This returns the current setting of the selinux flag which is passed to the "
8433 "appliance at boot time. See C<guestfs_set_selinux>."
8437 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109 ../src/guestfs-actions.pod:5740 ../src/guestfs-actions.pod:5794
8438 msgid "(Added in 1.0.67)"
8442 #: ../src/guestfs-actions.pod:2048
8443 msgid "guestfs_get_state"
8447 #: ../src/guestfs-actions.pod:2050
8451 " guestfs_get_state (guestfs_h *g);\n"
8456 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1393
8458 "This returns the current state as an opaque integer. This is only useful "
8459 "for printing debug and internal error messages."
8463 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3066 ../src/guestfs-actions.pod:3095 ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3183 ../fish/guestfish-actions.pod:1396 ../fish/guestfish-actions.pod:2135 ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2191 ../fish/guestfish-actions.pod:2207
8464 msgid "For more information on states, see L<guestfs(3)>."
8468 #: ../src/guestfs-actions.pod:2062
8469 msgid "guestfs_get_trace"
8473 #: ../src/guestfs-actions.pod:2064
8477 " guestfs_get_trace (guestfs_h *g);\n"
8482 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1402
8483 msgid "Return the command trace flag."
8487 #: ../src/guestfs-actions.pod:2073
8488 msgid "guestfs_get_umask"
8492 #: ../src/guestfs-actions.pod:2075
8496 " guestfs_get_umask (guestfs_h *g);\n"
8501 #: ../src/guestfs-actions.pod:2078
8503 "Return the current umask. By default the umask is C<022> unless it has been "
8504 "set by calling C<guestfs_umask>."
8508 #: ../src/guestfs-actions.pod:2085
8509 msgid "guestfs_get_verbose"
8513 #: ../src/guestfs-actions.pod:2087
8517 " guestfs_get_verbose (guestfs_h *g);\n"
8522 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
8523 msgid "This returns the verbose messages flag."
8527 #: ../src/guestfs-actions.pod:2096
8528 msgid "guestfs_getcon"
8532 #: ../src/guestfs-actions.pod:2098
8536 " guestfs_getcon (guestfs_h *g);\n"
8541 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1421
8542 msgid "This gets the SELinux security context of the daemon."
8546 #: ../src/guestfs-actions.pod:2103
8547 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8551 #: ../src/guestfs-actions.pod:2111
8552 msgid "guestfs_getxattr"
8556 #: ../src/guestfs-actions.pod:2113
8560 " guestfs_getxattr (guestfs_h *g,\n"
8561 " const char *path,\n"
8562 " const char *name,\n"
8563 " size_t *size_r);\n"
8568 #: ../src/guestfs-actions.pod:2119
8570 "Get a single extended attribute from file C<path> named C<name>. This call "
8571 "follows symlinks. If you want to lookup an extended attribute for the "
8572 "symlink itself, use C<guestfs_lgetxattr>."
8576 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:3277
8578 "Normally it is better to get all extended attributes from a file in one go "
8579 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
8580 "implementations are buggy and do not provide a way to list out attributes. "
8581 "For these filesystems (notably ntfs-3g) you have to know the names of the "
8582 "extended attributes you want in advance and call this function."
8586 #: ../src/guestfs-actions.pod:2130 ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:1441 ../fish/guestfish-actions.pod:2272
8588 "Extended attribute values are blobs of binary data. If there is no extended "
8589 "attribute named C<name>, this returns an error."
8593 #: ../src/guestfs-actions.pod:2133
8594 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
8598 #: ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5201
8600 "This function returns a buffer, or NULL on error. The size of the returned "
8601 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8606 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:3293
8607 msgid "(Added in 1.7.24)"
8611 #: ../src/guestfs-actions.pod:2141
8612 msgid "guestfs_getxattrs"
8616 #: ../src/guestfs-actions.pod:2143
8619 " struct guestfs_xattr_list *\n"
8620 " guestfs_getxattrs (guestfs_h *g,\n"
8621 " const char *path);\n"
8626 #: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1450
8627 msgid "This call lists the extended attributes of the file or directory C<path>."
8631 #: ../src/guestfs-actions.pod:2150 ../fish/guestfish-actions.pod:1453
8633 "At the system call level, this is a combination of the L<listxattr(2)> and "
8634 "L<getxattr(2)> calls."
8638 #: ../src/guestfs-actions.pod:2153
8639 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8643 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3305 ../src/guestfs-actions.pod:3956
8645 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8646 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8650 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3309 ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:5374 ../src/guestfs-actions.pod:5813 ../src/guestfs-actions.pod:7148
8651 msgid "(Added in 1.0.59)"
8655 #: ../src/guestfs-actions.pod:2161
8656 msgid "guestfs_glob_expand"
8660 #: ../src/guestfs-actions.pod:2163
8664 " guestfs_glob_expand (guestfs_h *g,\n"
8665 " const char *pattern);\n"
8670 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1462
8672 "This command searches for all the pathnames matching C<pattern> according to "
8673 "the wildcard expansion rules used by the shell."
8677 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1466
8678 msgid "If no paths match, then this returns an empty list (note: not an error)."
8682 #: ../src/guestfs-actions.pod:2174 ../fish/guestfish-actions.pod:1469
8684 "It is just a wrapper around the C L<glob(3)> function with flags "
8685 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8689 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:5978 ../src/guestfs-actions.pod:5995
8690 msgid "(Added in 1.0.50)"
8694 #: ../src/guestfs-actions.pod:2184
8695 msgid "guestfs_grep"
8699 #: ../src/guestfs-actions.pod:2186
8703 " guestfs_grep (guestfs_h *g,\n"
8704 " const char *regex,\n"
8705 " const char *path);\n"
8710 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1477
8711 msgid "This calls the external C<grep> program and returns the matching lines."
8715 #: ../src/guestfs-actions.pod:2203
8716 msgid "guestfs_grepi"
8720 #: ../src/guestfs-actions.pod:2205
8724 " guestfs_grepi (guestfs_h *g,\n"
8725 " const char *regex,\n"
8726 " const char *path);\n"
8731 #: ../src/guestfs-actions.pod:2210 ../fish/guestfish-actions.pod:1487
8732 msgid "This calls the external C<grep -i> program and returns the matching lines."
8736 #: ../src/guestfs-actions.pod:2222
8737 msgid "guestfs_grub_install"
8741 #: ../src/guestfs-actions.pod:2224
8745 " guestfs_grub_install (guestfs_h *g,\n"
8746 " const char *root,\n"
8747 " const char *device);\n"
8752 #: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1497
8754 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8755 "the root directory being C<root>."
8759 #: ../src/guestfs-actions.pod:2232 ../fish/guestfish-actions.pod:1500
8761 "Note: If grub-install reports the error \"No suitable drive was found in the "
8762 "generated device map.\" it may be that you need to create a "
8763 "C</boot/grub/device.map> file first that contains the mapping between grub "
8764 "device names and Linux device names. It is usually sufficient to create a "
8769 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1507
8777 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1509
8778 msgid "replacing C</dev/vda> with the name of the installation device."
8782 #: ../src/guestfs-actions.pod:2245
8783 msgid "(Added in 1.0.17)"
8787 #: ../src/guestfs-actions.pod:2247
8788 msgid "guestfs_head"
8792 #: ../src/guestfs-actions.pod:2249
8796 " guestfs_head (guestfs_h *g,\n"
8797 " const char *path);\n"
8802 #: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1515
8804 "This command returns up to the first 10 lines of a file as a list of "
8809 #: ../src/guestfs-actions.pod:2265
8810 msgid "guestfs_head_n"
8814 #: ../src/guestfs-actions.pod:2267
8818 " guestfs_head_n (guestfs_h *g,\n"
8820 " const char *path);\n"
8825 #: ../src/guestfs-actions.pod:2272 ../fish/guestfish-actions.pod:1525
8827 "If the parameter C<nrlines> is a positive number, this returns the first "
8828 "C<nrlines> lines of the file C<path>."
8832 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish-actions.pod:1528
8834 "If the parameter C<nrlines> is a negative number, this returns lines from "
8835 "the file C<path>, excluding the last C<nrlines> lines."
8839 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6275 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:4188
8840 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8844 #: ../src/guestfs-actions.pod:2289
8845 msgid "guestfs_hexdump"
8849 #: ../src/guestfs-actions.pod:2291
8853 " guestfs_hexdump (guestfs_h *g,\n"
8854 " const char *path);\n"
8859 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1540
8861 "This runs C<hexdump -C> on the given C<path>. The result is the "
8862 "human-readable, canonical hex dump of the file."
8866 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6114
8867 msgid "(Added in 1.0.22)"
8871 #: ../src/guestfs-actions.pod:2306
8872 msgid "guestfs_initrd_cat"
8876 #: ../src/guestfs-actions.pod:2308
8880 " guestfs_initrd_cat (guestfs_h *g,\n"
8881 " const char *initrdpath,\n"
8882 " const char *filename,\n"
8883 " size_t *size_r);\n"
8888 #: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1550
8890 "This command unpacks the file C<filename> from the initrd file called "
8891 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8896 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1554
8898 "For example, in guestfish you could use the following command to examine the "
8899 "boot script (usually called C</init>) contained in a Linux initrd or "
8904 #: ../src/guestfs-actions.pod:2322 ../fish/guestfish-actions.pod:1558
8907 " initrd-cat /boot/initrd-<version>.img init\n"
8912 #: ../src/guestfs-actions.pod:2324
8913 msgid "See also C<guestfs_initrd_list>."
8917 #: ../src/guestfs-actions.pod:2335
8918 msgid "guestfs_initrd_list"
8922 #: ../src/guestfs-actions.pod:2337
8926 " guestfs_initrd_list (guestfs_h *g,\n"
8927 " const char *path);\n"
8932 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1569
8933 msgid "This command lists out files contained in an initrd."
8937 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1571
8939 "The files are listed without any initial C</> character. The files are "
8940 "listed in the order they appear (not necessarily alphabetical). Directory "
8941 "names are listed as separate items."
8945 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1575
8947 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8948 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8953 #: ../src/guestfs-actions.pod:2357
8954 msgid "guestfs_inotify_add_watch"
8958 #: ../src/guestfs-actions.pod:2359
8962 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8963 " const char *path,\n"
8969 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1583
8970 msgid "Watch C<path> for the events listed in C<mask>."
8974 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1585
8976 "Note that if C<path> is a directory then events within that directory are "
8977 "watched, but this does I<not> happen recursively (in subdirectories)."
8981 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1589
8983 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8984 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8988 #: ../src/guestfs-actions.pod:2378
8989 msgid "guestfs_inotify_close"
8993 #: ../src/guestfs-actions.pod:2380
8997 " guestfs_inotify_close (guestfs_h *g);\n"
9002 #: ../src/guestfs-actions.pod:2383 ../fish/guestfish-actions.pod:1597
9004 "This closes the inotify handle which was previously opened by inotify_init. "
9005 "It removes all watches, throws away any pending events, and deallocates all "
9010 #: ../src/guestfs-actions.pod:2391
9011 msgid "guestfs_inotify_files"
9015 #: ../src/guestfs-actions.pod:2393
9019 " guestfs_inotify_files (guestfs_h *g);\n"
9024 #: ../src/guestfs-actions.pod:2396
9026 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9027 "returns a list of pathnames of objects that were touched. The returned "
9028 "pathnames are sorted and deduplicated."
9032 #: ../src/guestfs-actions.pod:2406
9033 msgid "guestfs_inotify_init"
9037 #: ../src/guestfs-actions.pod:2408
9041 " guestfs_inotify_init (guestfs_h *g,\n"
9042 " int maxevents);\n"
9047 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1613
9049 "This command creates a new inotify handle. The inotify subsystem can be "
9050 "used to notify events which happen to objects in the guest filesystem."
9054 #: ../src/guestfs-actions.pod:2416
9056 "C<maxevents> is the maximum number of events which will be queued up between "
9057 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9058 "passed as C<0>, then the kernel (or previously set) default is used. For "
9059 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9060 "throws away events, but records the fact that it threw them away by setting "
9061 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9062 "C<guestfs_inotify_read>)."
9066 #: ../src/guestfs-actions.pod:2426
9068 "Before any events are generated, you have to add some watches to the "
9069 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9070 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9074 #: ../src/guestfs-actions.pod:2432
9076 "Queued up events should be read periodically by calling "
9077 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9078 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9079 "often enough then you risk the internal queue overflowing."
9083 #: ../src/guestfs-actions.pod:2439
9085 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9086 "This also removes any watches automatically."
9090 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1644
9092 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9093 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9094 "that there is one global inotify handle per libguestfs instance."
9098 #: ../src/guestfs-actions.pod:2452
9099 msgid "guestfs_inotify_read"
9103 #: ../src/guestfs-actions.pod:2454
9106 " struct guestfs_inotify_event_list *\n"
9107 " guestfs_inotify_read (guestfs_h *g);\n"
9112 #: ../src/guestfs-actions.pod:2457 ../fish/guestfish-actions.pod:1653
9114 "Return the complete queue of events that have happened since the previous "
9119 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1656
9120 msgid "If no events have happened, this returns an empty list."
9124 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1658
9126 "I<Note>: In order to make sure that all events have been read, you must call "
9127 "this function repeatedly until it returns an empty list. The reason is that "
9128 "the call will read events up to the maximum appliance-to-host message size "
9129 "and leave remaining events in the queue."
9133 #: ../src/guestfs-actions.pod:2468
9135 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9136 "there was an error. I<The caller must call "
9137 "C<guestfs_free_inotify_event_list> after use>."
9141 #: ../src/guestfs-actions.pod:2474
9142 msgid "guestfs_inotify_rm_watch"
9146 #: ../src/guestfs-actions.pod:2476
9150 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9156 #: ../src/guestfs-actions.pod:2480
9158 "Remove a previously defined inotify watch. See "
9159 "C<guestfs_inotify_add_watch>."
9163 #: ../src/guestfs-actions.pod:2487
9164 msgid "guestfs_inspect_get_arch"
9168 #: ../src/guestfs-actions.pod:2489
9172 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9173 " const char *root);\n"
9178 #: ../src/guestfs-actions.pod:2493 ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2645 ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2759 ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2834 ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2899
9180 "This function should only be called with a root device string as returned by "
9181 "C<guestfs_inspect_os>."
9185 #: ../src/guestfs-actions.pod:2496
9187 "This returns the architecture of the inspected operating system. The "
9188 "possible return values are listed under C<guestfs_file_architecture>."
9192 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1682
9194 "If the architecture could not be determined, then the string C<unknown> is "
9199 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:2584 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2777 ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:2820 ../src/guestfs-actions.pod:2863 ../src/guestfs-actions.pod:2886 ../src/guestfs-actions.pod:2992 ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1792 ../fish/guestfish-actions.pod:1813 ../fish/guestfish-actions.pod:1877 ../fish/guestfish-actions.pod:1901 ../fish/guestfish-actions.pod:1918 ../fish/guestfish-actions.pod:1931 ../fish/guestfish-actions.pod:1966 ../fish/guestfish-actions.pod:1982 ../fish/guestfish-actions.pod:2081 ../fish/guestfish-actions.pod:2115
9200 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9204 #: ../src/guestfs-actions.pod:2510
9205 msgid "guestfs_inspect_get_distro"
9209 #: ../src/guestfs-actions.pod:2512
9213 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9214 " const char *root);\n"
9219 #: ../src/guestfs-actions.pod:2519 ../fish/guestfish-actions.pod:1694
9220 msgid "This returns the distro (distribution) of the inspected operating system."
9224 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1697
9225 msgid "Currently defined distros are:"
9229 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1701
9230 msgid "\"archlinux\""
9234 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1703
9239 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1705
9244 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1707
9249 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1709
9254 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1711
9259 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1713
9264 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1715
9269 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1717
9270 msgid "\"linuxmint\""
9274 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1719
9279 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1721
9280 msgid "\"mandriva\""
9284 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1723
9289 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1725
9294 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1727
9299 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1729
9304 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1731
9309 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1733
9310 msgid "\"redhat-based\""
9314 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1735
9315 msgid "Some Red Hat-derived distro."
9319 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1737
9324 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1739
9325 msgid "Red Hat Enterprise Linux and some derivatives."
9329 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1741
9334 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1743
9339 #: ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2854 ../fish/guestfish-actions.pod:1745 ../fish/guestfish-actions.pod:1957
9344 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1747
9345 msgid "The distro could not be determined."
9349 #: ../src/guestfs-actions.pod:2574 ../src/guestfs-actions.pod:2846 ../fish/guestfish-actions.pod:1749 ../fish/guestfish-actions.pod:1949
9354 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1751
9356 "Windows does not have distributions. This string is returned if the OS type "
9361 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1756 ../fish/guestfish-actions.pod:1963
9363 "Future versions of libguestfs may return other strings here. The caller "
9364 "should be prepared to handle any string."
9368 #: ../src/guestfs-actions.pod:2591
9369 msgid "guestfs_inspect_get_filesystems"
9373 #: ../src/guestfs-actions.pod:2593
9377 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9378 " const char *root);\n"
9383 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1768
9385 "This returns a list of all the filesystems that we think are associated with "
9386 "this operating system. This includes the root filesystem, other ordinary "
9387 "filesystems, and non-mounted devices like swap partitions."
9391 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1773
9393 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9394 "to be shared between operating systems."
9398 #: ../src/guestfs-actions.pod:2608
9400 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9401 "C<guestfs_inspect_get_mountpoints>."
9405 #: ../src/guestfs-actions.pod:2617
9406 msgid "guestfs_inspect_get_hostname"
9410 #: ../src/guestfs-actions.pod:2619
9414 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
9415 " const char *root);\n"
9420 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1786
9422 "This function returns the hostname of the operating system as found by "
9423 "inspection of the guest's configuration files."
9427 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1789
9429 "If the hostname could not be determined, then the string C<unknown> is "
9434 #: ../src/guestfs-actions.pod:2637
9435 msgid "(Added in 1.7.9)"
9439 #: ../src/guestfs-actions.pod:2639
9440 msgid "guestfs_inspect_get_major_version"
9444 #: ../src/guestfs-actions.pod:2641
9448 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
9449 " const char *root);\n"
9454 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1801
9455 msgid "This returns the major version number of the inspected operating system."
9459 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1804
9461 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9462 "popular public names used by the operating system. Notably the operating "
9463 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9464 "1). You can find out the real versions corresponding to releases of Windows "
9465 "by consulting Wikipedia or MSDN."
9469 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1825
9470 msgid "If the version could not be determined, then C<0> is returned."
9474 #: ../src/guestfs-actions.pod:2666
9475 msgid "guestfs_inspect_get_minor_version"
9479 #: ../src/guestfs-actions.pod:2668
9483 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9484 " const char *root);\n"
9489 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1822
9490 msgid "This returns the minor version number of the inspected operating system."
9494 #: ../src/guestfs-actions.pod:2680
9496 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9497 "C<guestfs_inspect_get_major_version>."
9501 #: ../src/guestfs-actions.pod:2687
9502 msgid "guestfs_inspect_get_mountpoints"
9506 #: ../src/guestfs-actions.pod:2689
9510 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9511 " const char *root);\n"
9516 #: ../src/guestfs-actions.pod:2696 ../fish/guestfish-actions.pod:1837
9518 "This returns a hash of where we think the filesystems associated with this "
9519 "operating system should be mounted. Callers should note that this is at "
9520 "best an educated guess made by reading configuration files such as "
9521 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
9522 "are non-existent or not mountable and callers should be prepared to handle "
9523 "or ignore failures if they try to mount them."
9527 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1846
9529 "Each element in the returned hashtable has a key which is the path of the "
9530 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9531 "mounted there (eg. C</dev/sda1>)."
9535 #: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1851
9536 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9540 #: ../src/guestfs-actions.pod:2713
9542 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9543 "C<guestfs_inspect_get_filesystems>."
9547 #: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:3362 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:6416
9549 "This function returns a NULL-terminated array of strings, or NULL if there "
9550 "was an error. The array of strings will always have length C<2n+1>, where "
9551 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9552 "caller must free the strings and the array after use>."
9556 #: ../src/guestfs-actions.pod:2724
9557 msgid "guestfs_inspect_get_package_format"
9561 #: ../src/guestfs-actions.pod:2726
9565 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9566 " const char *root);\n"
9571 #: ../src/guestfs-actions.pod:2733
9573 "This function and C<guestfs_inspect_get_package_management> return the "
9574 "package format and package management tool used by the inspected operating "
9575 "system. For example for Fedora these functions would return C<rpm> (package "
9576 "format) and C<yum> (package management)."
9580 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1870
9582 "This returns the string C<unknown> if we could not determine the package "
9583 "format I<or> if the operating system does not have a real packaging system "
9588 #: ../src/guestfs-actions.pod:2743 ../fish/guestfish-actions.pod:1874
9590 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9591 "Future versions of libguestfs may return other strings."
9595 #: ../src/guestfs-actions.pod:2751 ../src/guestfs-actions.pod:2782
9596 msgid "(Added in 1.7.5)"
9600 #: ../src/guestfs-actions.pod:2753
9601 msgid "guestfs_inspect_get_package_management"
9605 #: ../src/guestfs-actions.pod:2755
9609 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9610 " const char *root);\n"
9615 #: ../src/guestfs-actions.pod:2762
9617 "C<guestfs_inspect_get_package_format> and this function return the package "
9618 "format and package management tool used by the inspected operating system. "
9619 "For example for Fedora these functions would return C<rpm> (package format) "
9620 "and C<yum> (package management)."
9624 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1892
9626 "This returns the string C<unknown> if we could not determine the package "
9627 "management tool I<or> if the operating system does not have a real packaging "
9628 "system (eg. Windows)."
9632 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1896
9634 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9635 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9636 "libguestfs may return other strings."
9640 #: ../src/guestfs-actions.pod:2784
9641 msgid "guestfs_inspect_get_product_name"
9645 #: ../src/guestfs-actions.pod:2786
9649 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9650 " const char *root);\n"
9655 #: ../src/guestfs-actions.pod:2793 ../fish/guestfish-actions.pod:1910
9657 "This returns the product name of the inspected operating system. The "
9658 "product name is generally some freeform string which can be displayed to the "
9659 "user, but should not be parsed by programs."
9663 #: ../src/guestfs-actions.pod:2798 ../fish/guestfish-actions.pod:1915
9665 "If the product name could not be determined, then the string C<unknown> is "
9670 #: ../src/guestfs-actions.pod:2808
9671 msgid "guestfs_inspect_get_roots"
9675 #: ../src/guestfs-actions.pod:2810
9679 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9684 #: ../src/guestfs-actions.pod:2813
9686 "This function is a convenient way to get the list of root devices, as "
9687 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9688 "the whole inspection process."
9692 #: ../src/guestfs-actions.pod:2817
9694 "This returns an empty list if either no root devices were found or the "
9695 "caller has not called C<guestfs_inspect_os>."
9699 #: ../src/guestfs-actions.pod:2826
9700 msgid "(Added in 1.7.3)"
9704 #: ../src/guestfs-actions.pod:2828
9705 msgid "guestfs_inspect_get_type"
9709 #: ../src/guestfs-actions.pod:2830
9713 " guestfs_inspect_get_type (guestfs_h *g,\n"
9714 " const char *root);\n"
9719 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1940
9721 "This returns the type of the inspected operating system. Currently defined "
9726 #: ../src/guestfs-actions.pod:2842 ../fish/guestfish-actions.pod:1945
9731 #: ../src/guestfs-actions.pod:2844 ../fish/guestfish-actions.pod:1947
9732 msgid "Any Linux-based operating system."
9736 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1951
9737 msgid "Any Microsoft Windows operating system."
9741 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1953
9746 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1955
9751 #: ../src/guestfs-actions.pod:2856 ../fish/guestfish-actions.pod:1959
9752 msgid "The operating system type could not be determined."
9756 #: ../src/guestfs-actions.pod:2870
9757 msgid "guestfs_inspect_get_windows_systemroot"
9761 #: ../src/guestfs-actions.pod:2872
9765 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9766 " const char *root);\n"
9771 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1975
9773 "This returns the Windows systemroot of the inspected guest. The systemroot "
9774 "is a directory path such as C</WINDOWS>."
9778 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1978
9780 "This call assumes that the guest is Windows and that the systemroot could be "
9781 "determined by inspection. If this is not the case then an error is "
9786 #: ../src/guestfs-actions.pod:2891
9787 msgid "(Added in 1.5.25)"
9791 #: ../src/guestfs-actions.pod:2893
9792 msgid "guestfs_inspect_list_applications"
9796 #: ../src/guestfs-actions.pod:2895
9799 " struct guestfs_application_list *\n"
9800 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9801 " const char *root);\n"
9806 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:1991
9807 msgid "Return the list of applications installed in the operating system."
9811 #: ../src/guestfs-actions.pod:2904
9813 "I<Note:> This call works differently from other parts of the inspection "
9814 "API. You have to call C<guestfs_inspect_os>, then "
9815 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9816 "this. Listing applications is a significantly more difficult operation "
9817 "which requires access to the full filesystem. Also note that unlike the "
9818 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9819 "the libguestfs handle, this call actually reads parts of the mounted "
9820 "filesystems during the call."
9824 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2003
9826 "This returns an empty list if the inspection code was not able to determine "
9827 "the list of applications."
9831 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2006
9832 msgid "The application structure contains the following fields:"
9836 #: ../src/guestfs-actions.pod:2921 ../fish/guestfish-actions.pod:2010
9841 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2012
9843 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9844 "guests, this is the package name."
9848 #: ../src/guestfs-actions.pod:2926 ../fish/guestfish-actions.pod:2015
9849 msgid "C<app_display_name>"
9853 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2017
9855 "The display name of the application, sometimes localized to the install "
9856 "language of the guest operating system."
9860 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2020
9862 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9863 "to display something can use C<app_name> instead."
9867 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2023
9868 msgid "C<app_epoch>"
9872 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2025
9874 "For package managers which use epochs, this contains the epoch of the "
9875 "package (an integer). If unavailable, this is returned as C<0>."
9879 #: ../src/guestfs-actions.pod:2939 ../fish/guestfish-actions.pod:2028
9880 msgid "C<app_version>"
9884 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
9886 "The version string of the application or package. If unavailable this is "
9887 "returned as an empty string C<\"\">."
9891 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2033
9892 msgid "C<app_release>"
9896 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2035
9898 "The release string of the application or package, for package managers that "
9899 "use this. If unavailable this is returned as an empty string C<\"\">."
9903 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2039
9904 msgid "C<app_install_path>"
9908 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2041
9910 "The installation path of the application (on operating systems such as "
9911 "Windows which use installation paths). This path is in the format used by "
9912 "the guest operating system, it is not a libguestfs path."
9916 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2046
9917 msgid "If unavailable this is returned as an empty string C<\"\">."
9921 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2048
9922 msgid "C<app_trans_path>"
9926 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2050
9928 "The install path translated into a libguestfs path. If unavailable this is "
9929 "returned as an empty string C<\"\">."
9933 #: ../src/guestfs-actions.pod:2964 ../fish/guestfish-actions.pod:2053
9934 msgid "C<app_publisher>"
9938 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2055
9940 "The name of the publisher of the application, for package managers that use "
9941 "this. If unavailable this is returned as an empty string C<\"\">."
9945 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2059
9950 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2061
9952 "The URL (eg. upstream URL) of the application. If unavailable this is "
9953 "returned as an empty string C<\"\">."
9957 #: ../src/guestfs-actions.pod:2975 ../fish/guestfish-actions.pod:2064
9958 msgid "C<app_source_package>"
9962 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2066
9964 "For packaging systems which support this, the name of the source package. "
9965 "If unavailable this is returned as an empty string C<\"\">."
9969 #: ../src/guestfs-actions.pod:2980 ../fish/guestfish-actions.pod:2069
9970 msgid "C<app_summary>"
9974 #: ../src/guestfs-actions.pod:2982 ../fish/guestfish-actions.pod:2071
9976 "A short (usually one line) description of the application or package. If "
9977 "unavailable this is returned as an empty string C<\"\">."
9981 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2074
9982 msgid "C<app_description>"
9986 #: ../src/guestfs-actions.pod:2987 ../fish/guestfish-actions.pod:2076
9988 "A longer description of the application or package. If unavailable this is "
9989 "returned as an empty string C<\"\">."
9993 #: ../src/guestfs-actions.pod:2994
9995 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9996 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10001 #: ../src/guestfs-actions.pod:2998
10002 msgid "(Added in 1.7.8)"
10006 #: ../src/guestfs-actions.pod:3000
10007 msgid "guestfs_inspect_os"
10011 #: ../src/guestfs-actions.pod:3002
10015 " guestfs_inspect_os (guestfs_h *g);\n"
10020 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2087
10022 "This function uses other libguestfs functions and certain heuristics to "
10023 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10024 "for operating systems."
10028 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2091
10029 msgid "The list returned is empty if no operating systems were found."
10033 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2093
10035 "If one operating system was found, then this returns a list with a single "
10036 "element, which is the name of the root filesystem of this operating system. "
10037 "It is also possible for this function to return a list containing more than "
10038 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10039 "element being the root filesystem of one of the operating systems."
10043 #: ../src/guestfs-actions.pod:3018
10045 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10046 "functions in order to query further information about each operating system, "
10047 "such as the name and version."
10051 #: ../src/guestfs-actions.pod:3023
10053 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10054 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10055 "the contents. This should be called with no disks currently mounted. The "
10056 "function may also use Augeas, so any existing Augeas handle will be closed."
10060 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2111
10062 "This function cannot decrypt encrypted disks. The caller must do that first "
10063 "(supplying the necessary keys) if the disk is encrypted."
10067 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3382
10068 msgid "See also C<guestfs_list_filesystems>."
10072 #: ../src/guestfs-actions.pod:3043
10073 msgid "guestfs_is_blockdev"
10077 #: ../src/guestfs-actions.pod:3045
10081 " guestfs_is_blockdev (guestfs_h *g,\n"
10082 " const char *path);\n"
10087 #: ../src/guestfs-actions.pod:3049 ../fish/guestfish-actions.pod:2123
10089 "This returns C<true> if and only if there is a block device with the given "
10094 #: ../src/guestfs-actions.pod:3052 ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3126 ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3213
10095 msgid "See also C<guestfs_stat>."
10099 #: ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3202 ../src/guestfs-actions.pod:3217
10100 msgid "(Added in 1.5.10)"
10104 #: ../src/guestfs-actions.pod:3058
10105 msgid "guestfs_is_busy"
10109 #: ../src/guestfs-actions.pod:3060
10113 " guestfs_is_busy (guestfs_h *g);\n"
10118 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2132
10120 "This returns true iff this handle is busy processing a command (in the "
10125 #: ../src/guestfs-actions.pod:3072
10126 msgid "guestfs_is_chardev"
10130 #: ../src/guestfs-actions.pod:3074
10134 " guestfs_is_chardev (guestfs_h *g,\n"
10135 " const char *path);\n"
10140 #: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2141
10142 "This returns C<true> if and only if there is a character device with the "
10143 "given C<path> name."
10147 #: ../src/guestfs-actions.pod:3087
10148 msgid "guestfs_is_config"
10152 #: ../src/guestfs-actions.pod:3089
10156 " guestfs_is_config (guestfs_h *g);\n"
10161 #: ../src/guestfs-actions.pod:3092 ../fish/guestfish-actions.pod:2150
10163 "This returns true iff this handle is being configured (in the C<CONFIG> "
10168 #: ../src/guestfs-actions.pod:3101
10169 msgid "guestfs_is_dir"
10173 #: ../src/guestfs-actions.pod:3103
10177 " guestfs_is_dir (guestfs_h *g,\n"
10178 " const char *path);\n"
10183 #: ../src/guestfs-actions.pod:3107 ../fish/guestfish-actions.pod:2159
10185 "This returns C<true> if and only if there is a directory with the given "
10186 "C<path> name. Note that it returns false for other objects like files."
10190 #: ../src/guestfs-actions.pod:3117
10191 msgid "guestfs_is_fifo"
10195 #: ../src/guestfs-actions.pod:3119
10199 " guestfs_is_fifo (guestfs_h *g,\n"
10200 " const char *path);\n"
10205 #: ../src/guestfs-actions.pod:3123 ../fish/guestfish-actions.pod:2169
10207 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10208 "given C<path> name."
10212 #: ../src/guestfs-actions.pod:3132
10213 msgid "guestfs_is_file"
10217 #: ../src/guestfs-actions.pod:3134
10221 " guestfs_is_file (guestfs_h *g,\n"
10222 " const char *path);\n"
10227 #: ../src/guestfs-actions.pod:3138 ../fish/guestfish-actions.pod:2178
10229 "This returns C<true> if and only if there is a regular file with the given "
10230 "C<path> name. Note that it returns false for other objects like "
10235 #: ../src/guestfs-actions.pod:3148
10236 msgid "guestfs_is_launching"
10240 #: ../src/guestfs-actions.pod:3150
10244 " guestfs_is_launching (guestfs_h *g);\n"
10249 #: ../src/guestfs-actions.pod:3153 ../fish/guestfish-actions.pod:2188
10251 "This returns true iff this handle is launching the subprocess (in the "
10252 "C<LAUNCHING> state)."
10256 #: ../src/guestfs-actions.pod:3162
10257 msgid "guestfs_is_lv"
10261 #: ../src/guestfs-actions.pod:3164
10265 " guestfs_is_lv (guestfs_h *g,\n"
10266 " const char *device);\n"
10271 #: ../src/guestfs-actions.pod:3168 ../fish/guestfish-actions.pod:2197
10273 "This command tests whether C<device> is a logical volume, and returns true "
10274 "iff this is the case."
10278 #: ../src/guestfs-actions.pod:3175
10279 msgid "guestfs_is_ready"
10283 #: ../src/guestfs-actions.pod:3177
10287 " guestfs_is_ready (guestfs_h *g);\n"
10292 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2204
10294 "This returns true iff this handle is ready to accept commands (in the "
10299 #: ../src/guestfs-actions.pod:3189
10300 msgid "guestfs_is_socket"
10304 #: ../src/guestfs-actions.pod:3191
10308 " guestfs_is_socket (guestfs_h *g,\n"
10309 " const char *path);\n"
10314 #: ../src/guestfs-actions.pod:3195 ../fish/guestfish-actions.pod:2213
10316 "This returns C<true> if and only if there is a Unix domain socket with the "
10317 "given C<path> name."
10321 #: ../src/guestfs-actions.pod:3204
10322 msgid "guestfs_is_symlink"
10326 #: ../src/guestfs-actions.pod:3206
10330 " guestfs_is_symlink (guestfs_h *g,\n"
10331 " const char *path);\n"
10336 #: ../src/guestfs-actions.pod:3210 ../fish/guestfish-actions.pod:2222
10338 "This returns C<true> if and only if there is a symbolic link with the given "
10343 #: ../src/guestfs-actions.pod:3219
10344 msgid "guestfs_kill_subprocess"
10348 #: ../src/guestfs-actions.pod:3221
10352 " guestfs_kill_subprocess (guestfs_h *g);\n"
10357 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2231
10358 msgid "This kills the qemu subprocess. You should never need to call this."
10362 #: ../src/guestfs-actions.pod:3230
10363 msgid "guestfs_launch"
10367 #: ../src/guestfs-actions.pod:3232
10371 " guestfs_launch (guestfs_h *g);\n"
10376 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2239
10378 "Internally libguestfs is implemented by running a virtual machine using "
10383 #: ../src/guestfs-actions.pod:3238 ../fish/guestfish-actions.pod:2242
10385 "You should call this after configuring the handle (eg. adding drives) but "
10386 "before performing any actions."
10390 #: ../src/guestfs-actions.pod:3245
10391 msgid "guestfs_lchown"
10395 #: ../src/guestfs-actions.pod:3247
10399 " guestfs_lchown (guestfs_h *g,\n"
10402 " const char *path);\n"
10407 #: ../src/guestfs-actions.pod:3253
10409 "Change the file owner to C<owner> and group to C<group>. This is like "
10410 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
10411 "changed, not the target."
10415 #: ../src/guestfs-actions.pod:3265
10416 msgid "guestfs_lgetxattr"
10420 #: ../src/guestfs-actions.pod:3267
10424 " guestfs_lgetxattr (guestfs_h *g,\n"
10425 " const char *path,\n"
10426 " const char *name,\n"
10427 " size_t *size_r);\n"
10432 #: ../src/guestfs-actions.pod:3273 ../fish/guestfish-actions.pod:2261
10434 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10435 "is a symlink, then this call returns an extended attribute from the symlink."
10439 #: ../src/guestfs-actions.pod:3287
10440 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
10444 #: ../src/guestfs-actions.pod:3295
10445 msgid "guestfs_lgetxattrs"
10449 #: ../src/guestfs-actions.pod:3297
10452 " struct guestfs_xattr_list *\n"
10453 " guestfs_lgetxattrs (guestfs_h *g,\n"
10454 " const char *path);\n"
10459 #: ../src/guestfs-actions.pod:3301
10461 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
10462 "then it returns the extended attributes of the link itself."
10466 #: ../src/guestfs-actions.pod:3311
10467 msgid "guestfs_list_devices"
10471 #: ../src/guestfs-actions.pod:3313
10475 " guestfs_list_devices (guestfs_h *g);\n"
10480 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2289
10481 msgid "List all the block devices."
10485 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2291
10486 msgid "The full block device names are returned, eg. C</dev/sda>."
10490 #: ../src/guestfs-actions.pod:3328
10491 msgid "guestfs_list_filesystems"
10495 #: ../src/guestfs-actions.pod:3330
10499 " guestfs_list_filesystems (guestfs_h *g);\n"
10504 #: ../src/guestfs-actions.pod:3333 ../fish/guestfish-actions.pod:2299
10506 "This inspection command looks for filesystems on partitions, block devices "
10507 "and logical volumes, returning a list of devices containing filesystems and "
10512 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2303
10514 "The return value is a hash, where the keys are the devices containing "
10515 "filesystems, and the values are the filesystem types. For example:"
10519 #: ../src/guestfs-actions.pod:3341 ../fish/guestfish-actions.pod:2307
10522 " \"/dev/sda1\" => \"ntfs\"\n"
10523 " \"/dev/sda2\" => \"ext2\"\n"
10524 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10525 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10530 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2312
10532 "The value can have the special value \"unknown\", meaning the content of the "
10533 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10537 #: ../src/guestfs-actions.pod:3350
10539 "This command runs other libguestfs commands, which might include "
10540 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10541 "soon after launch and only when nothing is mounted."
10545 #: ../src/guestfs-actions.pod:3354
10547 "Not all of the filesystems returned will be mountable. In particular, swap "
10548 "partitions are returned in the list. Also this command does not check that "
10549 "each filesystem found is valid and mountable, and some filesystems might be "
10550 "mountable but require special options. Filesystems may not all belong to a "
10551 "single logical operating system (use C<guestfs_inspect_os> to look for "
10556 #: ../src/guestfs-actions.pod:3368 ../src/guestfs-actions.pod:4961
10557 msgid "(Added in 1.5.15)"
10561 #: ../src/guestfs-actions.pod:3370
10562 msgid "guestfs_list_partitions"
10566 #: ../src/guestfs-actions.pod:3372
10570 " guestfs_list_partitions (guestfs_h *g);\n"
10575 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2332
10576 msgid "List all the partitions detected on all block devices."
10580 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2334
10581 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10585 #: ../src/guestfs-actions.pod:3379
10587 "This does not return logical volumes. For that you will need to call "
10592 #: ../src/guestfs-actions.pod:3390
10597 #: ../src/guestfs-actions.pod:3392
10601 " guestfs_ll (guestfs_h *g,\n"
10602 " const char *directory);\n"
10607 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2345
10609 "List the files in C<directory> (relative to the root directory, there is no "
10610 "cwd) in the format of 'ls -la'."
10614 #: ../src/guestfs-actions.pod:3399 ../fish/guestfish-actions.pod:2348
10616 "This command is mostly useful for interactive sessions. It is I<not> "
10617 "intended that you try to parse the output string."
10621 #: ../src/guestfs-actions.pod:3407
10626 #: ../src/guestfs-actions.pod:3409
10630 " guestfs_ln (guestfs_h *g,\n"
10631 " const char *target,\n"
10632 " const char *linkname);\n"
10637 #: ../src/guestfs-actions.pod:3414 ../fish/guestfish-actions.pod:2355
10638 msgid "This command creates a hard link using the C<ln> command."
10642 #: ../src/guestfs-actions.pod:3420
10643 msgid "guestfs_ln_f"
10647 #: ../src/guestfs-actions.pod:3422
10651 " guestfs_ln_f (guestfs_h *g,\n"
10652 " const char *target,\n"
10653 " const char *linkname);\n"
10658 #: ../src/guestfs-actions.pod:3427 ../fish/guestfish-actions.pod:2361
10660 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10661 "option removes the link (C<linkname>) if it exists already."
10665 #: ../src/guestfs-actions.pod:3434
10666 msgid "guestfs_ln_s"
10670 #: ../src/guestfs-actions.pod:3436
10674 " guestfs_ln_s (guestfs_h *g,\n"
10675 " const char *target,\n"
10676 " const char *linkname);\n"
10681 #: ../src/guestfs-actions.pod:3441 ../fish/guestfish-actions.pod:2368
10682 msgid "This command creates a symbolic link using the C<ln -s> command."
10686 #: ../src/guestfs-actions.pod:3447
10687 msgid "guestfs_ln_sf"
10691 #: ../src/guestfs-actions.pod:3449
10695 " guestfs_ln_sf (guestfs_h *g,\n"
10696 " const char *target,\n"
10697 " const char *linkname);\n"
10702 #: ../src/guestfs-actions.pod:3454 ../fish/guestfish-actions.pod:2374
10704 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10705 "option removes the link (C<linkname>) if it exists already."
10709 #: ../src/guestfs-actions.pod:3461
10710 msgid "guestfs_lremovexattr"
10714 #: ../src/guestfs-actions.pod:3463
10718 " guestfs_lremovexattr (guestfs_h *g,\n"
10719 " const char *xattr,\n"
10720 " const char *path);\n"
10725 #: ../src/guestfs-actions.pod:3468
10727 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10728 "link, then it removes an extended attribute of the link itself."
10732 #: ../src/guestfs-actions.pod:3476
10737 #: ../src/guestfs-actions.pod:3478
10741 " guestfs_ls (guestfs_h *g,\n"
10742 " const char *directory);\n"
10747 #: ../src/guestfs-actions.pod:3482 ../fish/guestfish-actions.pod:2389
10749 "List the files in C<directory> (relative to the root directory, there is no "
10750 "cwd). The '.' and '..' entries are not returned, but hidden files are "
10755 #: ../src/guestfs-actions.pod:3486
10757 "This command is mostly useful for interactive sessions. Programs should "
10758 "probably use C<guestfs_readdir> instead."
10762 #: ../src/guestfs-actions.pod:3495
10763 msgid "guestfs_lsetxattr"
10767 #: ../src/guestfs-actions.pod:3497
10771 " guestfs_lsetxattr (guestfs_h *g,\n"
10772 " const char *xattr,\n"
10773 " const char *val,\n"
10775 " const char *path);\n"
10780 #: ../src/guestfs-actions.pod:3504
10782 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10783 "then it sets an extended attribute of the link itself."
10787 #: ../src/guestfs-actions.pod:3512
10788 msgid "guestfs_lstat"
10792 #: ../src/guestfs-actions.pod:3514
10795 " struct guestfs_stat *\n"
10796 " guestfs_lstat (guestfs_h *g,\n"
10797 " const char *path);\n"
10802 #: ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:6015 ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:4023
10803 msgid "Returns file information for the given C<path>."
10807 #: ../src/guestfs-actions.pod:3520
10809 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10810 "link, then the link is stat-ed, not the file it refers to."
10814 #: ../src/guestfs-actions.pod:3524 ../fish/guestfish-actions.pod:2414
10815 msgid "This is the same as the C<lstat(2)> system call."
10819 #: ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:6019
10821 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10822 "error. I<The caller must call C<guestfs_free_stat> after use>."
10826 #: ../src/guestfs-actions.pod:3530 ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6422
10827 msgid "(Added in 0.9.2)"
10831 #: ../src/guestfs-actions.pod:3532
10832 msgid "guestfs_lstatlist"
10836 #: ../src/guestfs-actions.pod:3534
10839 " struct guestfs_stat_list *\n"
10840 " guestfs_lstatlist (guestfs_h *g,\n"
10841 " const char *path,\n"
10842 " char *const *names);\n"
10847 #: ../src/guestfs-actions.pod:3539
10849 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10850 "files, where all files are in the directory C<path>. C<names> is the list "
10851 "of files from this directory."
10855 #: ../src/guestfs-actions.pod:3543 ../fish/guestfish-actions.pod:2424
10857 "On return you get a list of stat structs, with a one-to-one correspondence "
10858 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10859 "then the C<ino> field of that structure is set to C<-1>."
10863 #: ../src/guestfs-actions.pod:3548
10865 "This call is intended for programs that want to efficiently list a directory "
10866 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10867 "for a similarly efficient call for getting extended attributes. Very long "
10868 "directory listings might cause the protocol message size to be exceeded, "
10869 "causing this call to fail. The caller must split up such requests into "
10870 "smaller groups of names."
10874 #: ../src/guestfs-actions.pod:3556
10876 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10877 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10881 #: ../src/guestfs-actions.pod:3562
10882 msgid "guestfs_luks_add_key"
10886 #: ../src/guestfs-actions.pod:3564
10890 " guestfs_luks_add_key (guestfs_h *g,\n"
10891 " const char *device,\n"
10892 " const char *key,\n"
10893 " const char *newkey,\n"
10899 #: ../src/guestfs-actions.pod:3571 ../fish/guestfish-actions.pod:2441
10901 "This command adds a new key on LUKS device C<device>. C<key> is any "
10902 "existing key, and is used to access the device. C<newkey> is the new key to "
10903 "add. C<keyslot> is the key slot that will be replaced."
10907 #: ../src/guestfs-actions.pod:3576
10909 "Note that if C<keyslot> already contains a key, then this command will "
10910 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10914 #: ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3622 ../src/guestfs-actions.pod:3645 ../src/guestfs-actions.pod:3665 ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:3716
10916 "This function takes a key or passphrase parameter which could contain "
10917 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10922 #: ../src/guestfs-actions.pod:3586 ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3649 ../src/guestfs-actions.pod:3669
10923 msgid "(Added in 1.5.2)"
10927 #: ../src/guestfs-actions.pod:3588
10928 msgid "guestfs_luks_close"
10932 #: ../src/guestfs-actions.pod:3590
10936 " guestfs_luks_close (guestfs_h *g,\n"
10937 " const char *device);\n"
10942 #: ../src/guestfs-actions.pod:3594
10944 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10945 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10946 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10947 "underlying block device."
10951 #: ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:3701 ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:3818
10952 msgid "(Added in 1.5.1)"
10956 #: ../src/guestfs-actions.pod:3604
10957 msgid "guestfs_luks_format"
10961 #: ../src/guestfs-actions.pod:3606
10965 " guestfs_luks_format (guestfs_h *g,\n"
10966 " const char *device,\n"
10967 " const char *key,\n"
10973 #: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2467
10975 "This command erases existing data on C<device> and formats the device as a "
10976 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10977 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10981 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:4712 ../src/guestfs-actions.pod:5475 ../src/guestfs-actions.pod:5850 ../src/guestfs-actions.pod:5873 ../src/guestfs-actions.pod:5899 ../src/guestfs-actions.pod:7059 ../fish/guestfish-actions.pod:2475 ../fish/guestfish-actions.pod:2488 ../fish/guestfish-actions.pod:2572 ../fish/guestfish-actions.pod:3135 ../fish/guestfish-actions.pod:3642 ../fish/guestfish-actions.pod:3922 ../fish/guestfish-actions.pod:3938 ../fish/guestfish-actions.pod:3953 ../fish/guestfish-actions.pod:4668
10983 "B<This command is dangerous. Without careful use you can easily destroy all "
10988 #: ../src/guestfs-actions.pod:3628
10989 msgid "guestfs_luks_format_cipher"
10993 #: ../src/guestfs-actions.pod:3630
10997 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10998 " const char *device,\n"
10999 " const char *key,\n"
11001 " const char *cipher);\n"
11006 #: ../src/guestfs-actions.pod:3637
11008 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11009 "set the C<cipher> used."
11013 #: ../src/guestfs-actions.pod:3651
11014 msgid "guestfs_luks_kill_slot"
11018 #: ../src/guestfs-actions.pod:3653
11022 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11023 " const char *device,\n"
11024 " const char *key,\n"
11030 #: ../src/guestfs-actions.pod:3659 ../fish/guestfish-actions.pod:2495
11032 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11033 "device C<device>. C<key> must be one of the I<other> keys."
11037 #: ../src/guestfs-actions.pod:3671
11038 msgid "guestfs_luks_open"
11042 #: ../src/guestfs-actions.pod:3673
11046 " guestfs_luks_open (guestfs_h *g,\n"
11047 " const char *device,\n"
11048 " const char *key,\n"
11049 " const char *mapname);\n"
11054 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2506
11056 "This command opens a block device which has been encrypted according to the "
11057 "Linux Unified Key Setup (LUKS) standard."
11061 #: ../src/guestfs-actions.pod:3682 ../fish/guestfish-actions.pod:2509
11062 msgid "C<device> is the encrypted block device or partition."
11066 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2511
11068 "The caller must supply one of the keys associated with the LUKS block "
11069 "device, in the C<key> parameter."
11073 #: ../src/guestfs-actions.pod:3687 ../fish/guestfish-actions.pod:2514
11075 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11076 "writes to this block device are decrypted from and encrypted to the "
11077 "underlying C<device> respectively."
11081 #: ../src/guestfs-actions.pod:3691
11083 "If this block device contains LVM volume groups, then calling "
11084 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11089 #: ../src/guestfs-actions.pod:3703
11090 msgid "guestfs_luks_open_ro"
11094 #: ../src/guestfs-actions.pod:3705
11098 " guestfs_luks_open_ro (guestfs_h *g,\n"
11099 " const char *device,\n"
11100 " const char *key,\n"
11101 " const char *mapname);\n"
11106 #: ../src/guestfs-actions.pod:3711
11108 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11113 #: ../src/guestfs-actions.pod:3722
11114 msgid "guestfs_lvcreate"
11118 #: ../src/guestfs-actions.pod:3724
11122 " guestfs_lvcreate (guestfs_h *g,\n"
11123 " const char *logvol,\n"
11124 " const char *volgroup,\n"
11130 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2539
11132 "This creates an LVM logical volume called C<logvol> on the volume group "
11133 "C<volgroup>, with C<size> megabytes."
11137 #: ../src/guestfs-actions.pod:3737
11138 msgid "guestfs_lvm_canonical_lv_name"
11142 #: ../src/guestfs-actions.pod:3739
11146 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11147 " const char *lvname);\n"
11152 #: ../src/guestfs-actions.pod:3743 ../fish/guestfish-actions.pod:2546
11154 "This converts alternative naming schemes for LVs that you might find to the "
11155 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11160 #: ../src/guestfs-actions.pod:3747 ../fish/guestfish-actions.pod:2550
11162 "This command returns an error if the C<lvname> parameter does not refer to a "
11167 #: ../src/guestfs-actions.pod:3750
11168 msgid "See also C<guestfs_is_lv>."
11172 #: ../src/guestfs-actions.pod:3755
11173 msgid "(Added in 1.5.24)"
11177 #: ../src/guestfs-actions.pod:3757
11178 msgid "guestfs_lvm_clear_filter"
11182 #: ../src/guestfs-actions.pod:3759
11186 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11191 #: ../src/guestfs-actions.pod:3762
11193 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11194 "see every block device."
11198 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2562 ../fish/guestfish-actions.pod:2593
11199 msgid "This command also clears the LVM cache and performs a volume group scan."
11203 #: ../src/guestfs-actions.pod:3772
11204 msgid "guestfs_lvm_remove_all"
11208 #: ../src/guestfs-actions.pod:3774
11212 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11217 #: ../src/guestfs-actions.pod:3777 ../fish/guestfish-actions.pod:2569
11219 "This command removes all LVM logical volumes, volume groups and physical "
11224 #: ../src/guestfs-actions.pod:3787
11225 msgid "guestfs_lvm_set_filter"
11229 #: ../src/guestfs-actions.pod:3789
11233 " guestfs_lvm_set_filter (guestfs_h *g,\n"
11234 " char *const *devices);\n"
11239 #: ../src/guestfs-actions.pod:3793 ../fish/guestfish-actions.pod:2579
11241 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11242 "block devices in the list C<devices>, and will ignore all other attached "
11247 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2583
11249 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11250 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11251 "there are two types of duplication possible: either cloned PVs/VGs which "
11252 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11253 "same name. In normal operation you cannot create this situation, but you "
11254 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11255 "inside the LVM metadata."
11259 #: ../src/guestfs-actions.pod:3810 ../fish/guestfish-actions.pod:2596
11260 msgid "You can filter whole block devices or individual partitions."
11264 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
11266 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11267 "filesystem), even if you are not filtering out that VG."
11271 #: ../src/guestfs-actions.pod:3820
11272 msgid "guestfs_lvremove"
11276 #: ../src/guestfs-actions.pod:3822
11280 " guestfs_lvremove (guestfs_h *g,\n"
11281 " const char *device);\n"
11286 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2606
11288 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11289 "LV, such as C</dev/VG/LV>."
11293 #: ../src/guestfs-actions.pod:3829 ../fish/guestfish-actions.pod:2609
11295 "You can also remove all LVs in a volume group by specifying the VG name, "
11300 #: ../src/guestfs-actions.pod:3834 ../src/guestfs-actions.pod:5058 ../src/guestfs-actions.pod:6798
11301 msgid "(Added in 1.0.13)"
11305 #: ../src/guestfs-actions.pod:3836
11306 msgid "guestfs_lvrename"
11310 #: ../src/guestfs-actions.pod:3838
11314 " guestfs_lvrename (guestfs_h *g,\n"
11315 " const char *logvol,\n"
11316 " const char *newlogvol);\n"
11321 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2616
11322 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11326 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:6811
11327 msgid "(Added in 1.0.83)"
11331 #: ../src/guestfs-actions.pod:3849
11332 msgid "guestfs_lvresize"
11336 #: ../src/guestfs-actions.pod:3851
11340 " guestfs_lvresize (guestfs_h *g,\n"
11341 " const char *device,\n"
11347 #: ../src/guestfs-actions.pod:3856 ../fish/guestfish-actions.pod:2622
11349 "This resizes (expands or shrinks) an existing LVM logical volume to "
11350 "C<mbytes>. When reducing, data in the reduced part is lost."
11354 #: ../src/guestfs-actions.pod:3864
11355 msgid "guestfs_lvresize_free"
11359 #: ../src/guestfs-actions.pod:3866
11363 " guestfs_lvresize_free (guestfs_h *g,\n"
11364 " const char *lv,\n"
11370 #: ../src/guestfs-actions.pod:3871 ../fish/guestfish-actions.pod:2630
11372 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11373 "remaining free space in the volume group. Commonly you would call this with "
11374 "pc = 100 which expands the logical volume as much as possible, using all "
11375 "remaining free space in the volume group."
11379 #: ../src/guestfs-actions.pod:3879
11380 msgid "(Added in 1.3.3)"
11384 #: ../src/guestfs-actions.pod:3881
11385 msgid "guestfs_lvs"
11389 #: ../src/guestfs-actions.pod:3883
11393 " guestfs_lvs (guestfs_h *g);\n"
11398 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2640
11400 "List all the logical volumes detected. This is the equivalent of the "
11401 "L<lvs(8)> command."
11405 #: ../src/guestfs-actions.pod:3889 ../fish/guestfish-actions.pod:2643
11407 "This returns a list of the logical volume device names "
11408 "(eg. C</dev/VolGroup00/LogVol00>)."
11412 #: ../src/guestfs-actions.pod:3892
11413 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
11417 #: ../src/guestfs-actions.pod:3900
11418 msgid "guestfs_lvs_full"
11422 #: ../src/guestfs-actions.pod:3902
11425 " struct guestfs_lvm_lv_list *\n"
11426 " guestfs_lvs_full (guestfs_h *g);\n"
11431 #: ../src/guestfs-actions.pod:3905 ../fish/guestfish-actions.pod:2652
11433 "List all the logical volumes detected. This is the equivalent of the "
11434 "L<lvs(8)> command. The \"full\" version includes all fields."
11438 #: ../src/guestfs-actions.pod:3908
11440 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
11441 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
11446 #: ../src/guestfs-actions.pod:3914
11447 msgid "guestfs_lvuuid"
11451 #: ../src/guestfs-actions.pod:3916
11455 " guestfs_lvuuid (guestfs_h *g,\n"
11456 " const char *device);\n"
11461 #: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:2659
11462 msgid "This command returns the UUID of the LVM LV C<device>."
11466 #: ../src/guestfs-actions.pod:3927
11467 msgid "guestfs_lxattrlist"
11471 #: ../src/guestfs-actions.pod:3929
11474 " struct guestfs_xattr_list *\n"
11475 " guestfs_lxattrlist (guestfs_h *g,\n"
11476 " const char *path,\n"
11477 " char *const *names);\n"
11482 #: ../src/guestfs-actions.pod:3934 ../fish/guestfish-actions.pod:2665
11484 "This call allows you to get the extended attributes of multiple files, where "
11485 "all files are in the directory C<path>. C<names> is the list of files from "
11490 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2669
11492 "On return you get a flat list of xattr structs which must be interpreted "
11493 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11494 "C<attrval> in this struct is zero-length to indicate there was an error "
11495 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11496 "number (the number of following attributes for this file, which could be "
11497 "C<\"0\">). Then after the first xattr struct are the zero or more "
11498 "attributes for the first named file. This repeats for the second and "
11499 "subsequent files."
11503 #: ../src/guestfs-actions.pod:3948
11505 "This call is intended for programs that want to efficiently list a directory "
11506 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11507 "a similarly efficient call for getting standard stats. Very long directory "
11508 "listings might cause the protocol message size to be exceeded, causing this "
11509 "call to fail. The caller must split up such requests into smaller groups of "
11514 #: ../src/guestfs-actions.pod:3962
11515 msgid "guestfs_mkdir"
11519 #: ../src/guestfs-actions.pod:3964
11523 " guestfs_mkdir (guestfs_h *g,\n"
11524 " const char *path);\n"
11529 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2691
11530 msgid "Create a directory named C<path>."
11534 #: ../src/guestfs-actions.pod:3974
11535 msgid "guestfs_mkdir_mode"
11539 #: ../src/guestfs-actions.pod:3976
11543 " guestfs_mkdir_mode (guestfs_h *g,\n"
11544 " const char *path,\n"
11550 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2697
11552 "This command creates a directory, setting the initial permissions of the "
11553 "directory to C<mode>."
11557 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2700
11559 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11560 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11565 #: ../src/guestfs-actions.pod:3988
11566 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11570 #: ../src/guestfs-actions.pod:3994
11571 msgid "guestfs_mkdir_p"
11575 #: ../src/guestfs-actions.pod:3996
11579 " guestfs_mkdir_p (guestfs_h *g,\n"
11580 " const char *path);\n"
11585 #: ../src/guestfs-actions.pod:4000 ../fish/guestfish-actions.pod:2710
11587 "Create a directory named C<path>, creating any parent directories as "
11588 "necessary. This is like the C<mkdir -p> shell command."
11592 #: ../src/guestfs-actions.pod:4007
11593 msgid "guestfs_mkdtemp"
11597 #: ../src/guestfs-actions.pod:4009
11601 " guestfs_mkdtemp (guestfs_h *g,\n"
11602 " const char *template);\n"
11607 #: ../src/guestfs-actions.pod:4013 ../fish/guestfish-actions.pod:2717
11609 "This command creates a temporary directory. The C<template> parameter "
11610 "should be a full pathname for the temporary directory name with the final "
11611 "six characters being \"XXXXXX\"."
11615 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2722
11617 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11618 "being suitable for Windows filesystems."
11622 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2725
11623 msgid "The name of the temporary directory that was created is returned."
11627 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2728
11628 msgid "The temporary directory is created with mode 0700 and is owned by root."
11632 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2731
11634 "The caller is responsible for deleting the temporary directory and its "
11635 "contents after use."
11639 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2734
11640 msgid "See also: L<mkdtemp(3)>"
11644 #: ../src/guestfs-actions.pod:4037
11645 msgid "guestfs_mke2fs_J"
11649 #: ../src/guestfs-actions.pod:4039
11653 " guestfs_mke2fs_J (guestfs_h *g,\n"
11654 " const char *fstype,\n"
11655 " int blocksize,\n"
11656 " const char *device,\n"
11657 " const char *journal);\n"
11662 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2740
11664 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11665 "C<journal>. It is equivalent to the command:"
11669 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2744
11672 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11677 #: ../src/guestfs-actions.pod:4052
11678 msgid "See also C<guestfs_mke2journal>."
11682 #: ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:4108 ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4195 ../src/guestfs-actions.pod:4448
11683 msgid "(Added in 1.0.68)"
11687 #: ../src/guestfs-actions.pod:4058
11688 msgid "guestfs_mke2fs_JL"
11692 #: ../src/guestfs-actions.pod:4060
11696 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11697 " const char *fstype,\n"
11698 " int blocksize,\n"
11699 " const char *device,\n"
11700 " const char *label);\n"
11705 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2752
11707 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11708 "the journal labeled C<label>."
11712 #: ../src/guestfs-actions.pod:4070
11713 msgid "See also C<guestfs_mke2journal_L>."
11717 #: ../src/guestfs-actions.pod:4076
11718 msgid "guestfs_mke2fs_JU"
11722 #: ../src/guestfs-actions.pod:4078
11726 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11727 " const char *fstype,\n"
11728 " int blocksize,\n"
11729 " const char *device,\n"
11730 " const char *uuid);\n"
11735 #: ../src/guestfs-actions.pod:4085 ../fish/guestfish-actions.pod:2761
11737 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11738 "the journal with UUID C<uuid>."
11742 #: ../src/guestfs-actions.pod:4088
11743 msgid "See also C<guestfs_mke2journal_U>."
11747 #: ../src/guestfs-actions.pod:4094
11748 msgid "guestfs_mke2journal"
11752 #: ../src/guestfs-actions.pod:4096
11756 " guestfs_mke2journal (guestfs_h *g,\n"
11757 " int blocksize,\n"
11758 " const char *device);\n"
11763 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2770
11765 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11770 #: ../src/guestfs-actions.pod:4104 ../fish/guestfish-actions.pod:2773
11773 " mke2fs -O journal_dev -b blocksize device\n"
11778 #: ../src/guestfs-actions.pod:4110
11779 msgid "guestfs_mke2journal_L"
11783 #: ../src/guestfs-actions.pod:4112
11787 " guestfs_mke2journal_L (guestfs_h *g,\n"
11788 " int blocksize,\n"
11789 " const char *label,\n"
11790 " const char *device);\n"
11795 #: ../src/guestfs-actions.pod:4118 ../fish/guestfish-actions.pod:2779
11796 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11800 #: ../src/guestfs-actions.pod:4124
11801 msgid "guestfs_mke2journal_U"
11805 #: ../src/guestfs-actions.pod:4126
11809 " guestfs_mke2journal_U (guestfs_h *g,\n"
11810 " int blocksize,\n"
11811 " const char *uuid,\n"
11812 " const char *device);\n"
11817 #: ../src/guestfs-actions.pod:4132 ../fish/guestfish-actions.pod:2785
11818 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11822 #: ../src/guestfs-actions.pod:4138
11823 msgid "guestfs_mkfifo"
11827 #: ../src/guestfs-actions.pod:4140
11831 " guestfs_mkfifo (guestfs_h *g,\n"
11833 " const char *path);\n"
11838 #: ../src/guestfs-actions.pod:4145
11840 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11841 "is just a convenient wrapper around C<guestfs_mknod>."
11845 #: ../src/guestfs-actions.pod:4155
11846 msgid "guestfs_mkfs"
11850 #: ../src/guestfs-actions.pod:4157
11854 " guestfs_mkfs (guestfs_h *g,\n"
11855 " const char *fstype,\n"
11856 " const char *device);\n"
11861 #: ../src/guestfs-actions.pod:4162 ../fish/guestfish-actions.pod:2801
11863 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11864 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11868 #: ../src/guestfs-actions.pod:4170
11869 msgid "guestfs_mkfs_b"
11873 #: ../src/guestfs-actions.pod:4172
11877 " guestfs_mkfs_b (guestfs_h *g,\n"
11878 " const char *fstype,\n"
11879 " int blocksize,\n"
11880 " const char *device);\n"
11885 #: ../src/guestfs-actions.pod:4178
11887 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11888 "block size of the resulting filesystem. Supported block sizes depend on the "
11889 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11893 #: ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2814 ../fish/guestfish-actions.pod:2841
11895 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11900 #: ../src/guestfs-actions.pod:4188 ../fish/guestfish-actions.pod:2817
11902 "This function is deprecated. In new code, use the C<mkfs_opts> call "
11907 #: ../src/guestfs-actions.pod:4197
11908 msgid "guestfs_mkfs_opts"
11912 #: ../src/guestfs-actions.pod:4199
11916 " guestfs_mkfs_opts (guestfs_h *g,\n"
11917 " const char *fstype,\n"
11918 " const char *device,\n"
11924 #: ../src/guestfs-actions.pod:4210
11927 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
11932 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2828
11934 "This function creates a filesystem on C<device>. The filesystem type is "
11935 "C<fstype>, for example C<ext3>."
11939 #: ../src/guestfs-actions.pod:4219 ../fish/guestfish-actions.pod:2835
11940 msgid "C<blocksize>"
11944 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2837
11946 "The filesystem block size. Supported block sizes depend on the filesystem "
11947 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11952 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2844
11953 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
11957 #: ../src/guestfs-actions.pod:4234
11958 msgid "(Added in 1.7.19)"
11962 #: ../src/guestfs-actions.pod:4236
11963 msgid "guestfs_mkfs_opts_va"
11967 #: ../src/guestfs-actions.pod:4238
11971 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
11972 " const char *fstype,\n"
11973 " const char *device,\n"
11974 " va_list args);\n"
11979 #: ../src/guestfs-actions.pod:4244
11980 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
11984 #: ../src/guestfs-actions.pod:4248
11985 msgid "guestfs_mkfs_opts_argv"
11989 #: ../src/guestfs-actions.pod:4250
11993 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
11994 " const char *fstype,\n"
11995 " const char *device,\n"
11996 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12001 #: ../src/guestfs-actions.pod:4256
12002 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12006 #: ../src/guestfs-actions.pod:4260
12007 msgid "guestfs_mkmountpoint"
12011 #: ../src/guestfs-actions.pod:4262
12015 " guestfs_mkmountpoint (guestfs_h *g,\n"
12016 " const char *exemptpath);\n"
12021 #: ../src/guestfs-actions.pod:4266
12023 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12024 "that can be used to create extra mountpoints before mounting the first "
12029 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2858
12031 "These calls are I<only> necessary in some very limited circumstances, mainly "
12032 "the case where you want to mount a mix of unrelated and/or read-only "
12033 "filesystems together."
12037 #: ../src/guestfs-actions.pod:4274 ../fish/guestfish-actions.pod:2862
12039 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12040 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12041 "inside that. You can unpack this as follows in guestfish:"
12045 #: ../src/guestfs-actions.pod:4279 ../fish/guestfish-actions.pod:2867
12048 " add-ro Fedora-11-i686-Live.iso\n"
12050 " mkmountpoint /cd\n"
12051 " mkmountpoint /sqsh\n"
12052 " mkmountpoint /ext3fs\n"
12053 " mount /dev/sda /cd\n"
12054 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12055 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12060 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2876
12061 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12065 #: ../src/guestfs-actions.pod:4290
12067 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12068 "may get unexpected errors if you try to mix these calls. It is safest to "
12069 "manually unmount filesystems and remove mountpoints after use."
12073 #: ../src/guestfs-actions.pod:4294
12075 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12076 "first, so for this to work for manual mountpoints, you must ensure that the "
12077 "innermost mountpoints have the longest pathnames, as in the example code "
12082 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2887
12083 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12087 #: ../src/guestfs-actions.pod:4301
12089 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12090 "means that C<guestfs_umount_all> is called when the handle is closed which "
12091 "can also trigger these issues."
12095 #: ../src/guestfs-actions.pod:4307 ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:5459
12096 msgid "(Added in 1.0.62)"
12100 #: ../src/guestfs-actions.pod:4309
12101 msgid "guestfs_mknod"
12105 #: ../src/guestfs-actions.pod:4311
12109 " guestfs_mknod (guestfs_h *g,\n"
12113 " const char *path);\n"
12118 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:2897
12120 "This call creates block or character special devices, or named pipes "
12125 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2900
12127 "The C<mode> parameter should be the mode, using the standard constants. "
12128 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12129 "used when creating block and character special devices."
12133 #: ../src/guestfs-actions.pod:4326
12135 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12136 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12137 "regular file). These constants are available in the standard Linux header "
12138 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12139 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12140 "the appropriate constant for you."
12144 #: ../src/guestfs-actions.pod:4340
12145 msgid "guestfs_mknod_b"
12149 #: ../src/guestfs-actions.pod:4342
12153 " guestfs_mknod_b (guestfs_h *g,\n"
12157 " const char *path);\n"
12162 #: ../src/guestfs-actions.pod:4349
12164 "This call creates a block device node called C<path> with mode C<mode> and "
12165 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12166 "wrapper around C<guestfs_mknod>."
12170 #: ../src/guestfs-actions.pod:4359
12171 msgid "guestfs_mknod_c"
12175 #: ../src/guestfs-actions.pod:4361
12179 " guestfs_mknod_c (guestfs_h *g,\n"
12183 " const char *path);\n"
12188 #: ../src/guestfs-actions.pod:4368
12190 "This call creates a char device node called C<path> with mode C<mode> and "
12191 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12192 "wrapper around C<guestfs_mknod>."
12196 #: ../src/guestfs-actions.pod:4378
12197 msgid "guestfs_mkswap"
12201 #: ../src/guestfs-actions.pod:4380
12205 " guestfs_mkswap (guestfs_h *g,\n"
12206 " const char *device);\n"
12211 #: ../src/guestfs-actions.pod:4384 ../fish/guestfish-actions.pod:2939
12212 msgid "Create a swap partition on C<device>."
12216 #: ../src/guestfs-actions.pod:4390
12217 msgid "guestfs_mkswap_L"
12221 #: ../src/guestfs-actions.pod:4392
12225 " guestfs_mkswap_L (guestfs_h *g,\n"
12226 " const char *label,\n"
12227 " const char *device);\n"
12232 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2945
12233 msgid "Create a swap partition on C<device> with label C<label>."
12237 #: ../src/guestfs-actions.pod:4399 ../fish/guestfish-actions.pod:2947
12239 "Note that you cannot attach a swap label to a block device "
12240 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12241 "the kernel or swap tools."
12245 #: ../src/guestfs-actions.pod:4407
12246 msgid "guestfs_mkswap_U"
12250 #: ../src/guestfs-actions.pod:4409
12254 " guestfs_mkswap_U (guestfs_h *g,\n"
12255 " const char *uuid,\n"
12256 " const char *device);\n"
12261 #: ../src/guestfs-actions.pod:4414 ../fish/guestfish-actions.pod:2955
12262 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12266 #: ../src/guestfs-actions.pod:4420
12267 msgid "guestfs_mkswap_file"
12271 #: ../src/guestfs-actions.pod:4422
12275 " guestfs_mkswap_file (guestfs_h *g,\n"
12276 " const char *path);\n"
12281 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:2961
12282 msgid "Create a swap file."
12286 #: ../src/guestfs-actions.pod:4428
12288 "This command just writes a swap file signature to an existing file. To "
12289 "create the file itself, use something like C<guestfs_fallocate>."
12293 #: ../src/guestfs-actions.pod:4435
12294 msgid "guestfs_modprobe"
12298 #: ../src/guestfs-actions.pod:4437
12302 " guestfs_modprobe (guestfs_h *g,\n"
12303 " const char *modulename);\n"
12308 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:2970
12309 msgid "This loads a kernel module in the appliance."
12313 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:2972
12315 "The kernel module must have been whitelisted when libguestfs was built (see "
12316 "C<appliance/kmod.whitelist.in> in the source)."
12320 #: ../src/guestfs-actions.pod:4450
12321 msgid "guestfs_mount"
12325 #: ../src/guestfs-actions.pod:4452
12329 " guestfs_mount (guestfs_h *g,\n"
12330 " const char *device,\n"
12331 " const char *mountpoint);\n"
12336 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:2979
12338 "Mount a guest disk at a position in the filesystem. Block devices are named "
12339 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12340 "those block devices contain partitions, they will have the usual names "
12341 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12345 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2985
12347 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12348 "mounted on C</> before others can be mounted. Other filesystems can only be "
12349 "mounted on directories which already exist."
12353 #: ../src/guestfs-actions.pod:4468 ../fish/guestfish-actions.pod:2990
12355 "The mounted filesystem is writable, if we have sufficient permissions on the "
12356 "underlying device."
12360 #: ../src/guestfs-actions.pod:4471
12362 "B<Important note:> When you use this call, the filesystem options C<sync> "
12363 "and C<noatime> are set implicitly. This was originally done because we "
12364 "thought it would improve reliability, but it turns out that I<-o sync> has a "
12365 "very large negative performance impact and negligible effect on "
12366 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
12367 "in any code that needs performance, and instead use C<guestfs_mount_options> "
12368 "(use an empty string for the first parameter if you don't want any options)."
12372 #: ../src/guestfs-actions.pod:4485
12373 msgid "guestfs_mount_loop"
12377 #: ../src/guestfs-actions.pod:4487
12381 " guestfs_mount_loop (guestfs_h *g,\n"
12382 " const char *file,\n"
12383 " const char *mountpoint);\n"
12388 #: ../src/guestfs-actions.pod:4492 ../fish/guestfish-actions.pod:3007
12390 "This command lets you mount C<file> (a filesystem image in a file) on a "
12391 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12396 #: ../src/guestfs-actions.pod:4500
12397 msgid "guestfs_mount_options"
12401 #: ../src/guestfs-actions.pod:4502
12405 " guestfs_mount_options (guestfs_h *g,\n"
12406 " const char *options,\n"
12407 " const char *device,\n"
12408 " const char *mountpoint);\n"
12413 #: ../src/guestfs-actions.pod:4508
12415 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12416 "the mount options as for the L<mount(8)> I<-o> flag."
12420 #: ../src/guestfs-actions.pod:4512 ../fish/guestfish-actions.pod:3019
12422 "If the C<options> parameter is an empty string, then no options are passed "
12423 "(all options default to whatever the filesystem uses)."
12427 #: ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4532 ../src/guestfs-actions.pod:4549
12428 msgid "(Added in 1.0.10)"
12432 #: ../src/guestfs-actions.pod:4520
12433 msgid "guestfs_mount_ro"
12437 #: ../src/guestfs-actions.pod:4522
12441 " guestfs_mount_ro (guestfs_h *g,\n"
12442 " const char *device,\n"
12443 " const char *mountpoint);\n"
12448 #: ../src/guestfs-actions.pod:4527
12450 "This is the same as the C<guestfs_mount> command, but it mounts the "
12451 "filesystem with the read-only (I<-o ro>) flag."
12455 #: ../src/guestfs-actions.pod:4534
12456 msgid "guestfs_mount_vfs"
12460 #: ../src/guestfs-actions.pod:4536
12464 " guestfs_mount_vfs (guestfs_h *g,\n"
12465 " const char *options,\n"
12466 " const char *vfstype,\n"
12467 " const char *device,\n"
12468 " const char *mountpoint);\n"
12473 #: ../src/guestfs-actions.pod:4543
12475 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12476 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
12481 #: ../src/guestfs-actions.pod:4551
12482 msgid "guestfs_mountpoints"
12486 #: ../src/guestfs-actions.pod:4553
12490 " guestfs_mountpoints (guestfs_h *g);\n"
12495 #: ../src/guestfs-actions.pod:4556
12497 "This call is similar to C<guestfs_mounts>. That call returns a list of "
12498 "devices. This one returns a hash table (map) of device name to directory "
12499 "where the device is mounted."
12503 #: ../src/guestfs-actions.pod:4568
12504 msgid "guestfs_mounts"
12508 #: ../src/guestfs-actions.pod:4570
12512 " guestfs_mounts (guestfs_h *g);\n"
12517 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3050
12519 "This returns the list of currently mounted filesystems. It returns the list "
12520 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12524 #: ../src/guestfs-actions.pod:4576 ../fish/guestfish-actions.pod:3053
12525 msgid "Some internal mounts are not shown."
12529 #: ../src/guestfs-actions.pod:4578
12530 msgid "See also: C<guestfs_mountpoints>"
12534 #: ../src/guestfs-actions.pod:4586
12539 #: ../src/guestfs-actions.pod:4588
12543 " guestfs_mv (guestfs_h *g,\n"
12544 " const char *src,\n"
12545 " const char *dest);\n"
12550 #: ../src/guestfs-actions.pod:4593 ../fish/guestfish-actions.pod:3061
12552 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12553 "destination filename or destination directory."
12557 #: ../src/guestfs-actions.pod:4600
12558 msgid "guestfs_ntfs_3g_probe"
12562 #: ../src/guestfs-actions.pod:4602
12566 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12568 " const char *device);\n"
12573 #: ../src/guestfs-actions.pod:4607 ../fish/guestfish-actions.pod:3068
12575 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12576 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12577 "read-write, and some cannot be mounted at all)."
12581 #: ../src/guestfs-actions.pod:4611 ../fish/guestfish-actions.pod:3072
12583 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12584 "can be mounted read-write. Set it to false if you want to test if the "
12585 "volume can be mounted read-only."
12589 #: ../src/guestfs-actions.pod:4615 ../fish/guestfish-actions.pod:3076
12591 "The return value is an integer which C<0> if the operation would succeed, or "
12592 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12596 #: ../src/guestfs-actions.pod:4621
12597 msgid "(Added in 1.0.43)"
12601 #: ../src/guestfs-actions.pod:4623
12602 msgid "guestfs_ntfsresize"
12606 #: ../src/guestfs-actions.pod:4625
12610 " guestfs_ntfsresize (guestfs_h *g,\n"
12611 " const char *device);\n"
12616 #: ../src/guestfs-actions.pod:4629 ../fish/guestfish-actions.pod:3084
12618 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12619 "size of the underlying device. See also L<ntfsresize(8)>."
12623 #: ../src/guestfs-actions.pod:4637
12624 msgid "guestfs_ntfsresize_size"
12628 #: ../src/guestfs-actions.pod:4639
12632 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12633 " const char *device,\n"
12634 " int64_t size);\n"
12639 #: ../src/guestfs-actions.pod:4644
12641 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12642 "to specify the new size (in bytes) explicitly."
12646 #: ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:5085 ../src/guestfs-actions.pod:5158 ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:6946
12647 msgid "(Added in 1.3.14)"
12651 #: ../src/guestfs-actions.pod:4651
12652 msgid "guestfs_part_add"
12656 #: ../src/guestfs-actions.pod:4653
12660 " guestfs_part_add (guestfs_h *g,\n"
12661 " const char *device,\n"
12662 " const char *prlogex,\n"
12663 " int64_t startsect,\n"
12664 " int64_t endsect);\n"
12669 #: ../src/guestfs-actions.pod:4660
12671 "This command adds a partition to C<device>. If there is no partition table "
12672 "on the device, call C<guestfs_part_init> first."
12676 #: ../src/guestfs-actions.pod:4663 ../fish/guestfish-actions.pod:3102
12678 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12679 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12680 "C<logical>) and C<e> (or C<extended>) partition types."
12684 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3107
12686 "C<startsect> and C<endsect> are the start and end of the partition in "
12687 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12688 "from the end of the disk (C<-1> is the last sector)."
12692 #: ../src/guestfs-actions.pod:4672
12694 "Creating a partition which covers the whole disk is not so easy. Use "
12695 "C<guestfs_part_disk> to do that."
12699 #: ../src/guestfs-actions.pod:4677 ../src/guestfs-actions.pod:4715 ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4884 ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4943
12700 msgid "(Added in 1.0.78)"
12704 #: ../src/guestfs-actions.pod:4679
12705 msgid "guestfs_part_del"
12709 #: ../src/guestfs-actions.pod:4681
12713 " guestfs_part_del (guestfs_h *g,\n"
12714 " const char *device,\n"
12720 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3118
12721 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12725 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3120
12727 "Note that in the case of MBR partitioning, deleting an extended partition "
12728 "also deletes any logical partitions it contains."
12732 #: ../src/guestfs-actions.pod:4696
12733 msgid "guestfs_part_disk"
12737 #: ../src/guestfs-actions.pod:4698
12741 " guestfs_part_disk (guestfs_h *g,\n"
12742 " const char *device,\n"
12743 " const char *parttype);\n"
12748 #: ../src/guestfs-actions.pod:4703
12750 "This command is simply a combination of C<guestfs_part_init> followed by "
12751 "C<guestfs_part_add> to create a single primary partition covering the whole "
12756 #: ../src/guestfs-actions.pod:4707
12758 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12759 "possible values are described in C<guestfs_part_init>."
12763 #: ../src/guestfs-actions.pod:4717
12764 msgid "guestfs_part_get_bootable"
12768 #: ../src/guestfs-actions.pod:4719
12772 " guestfs_part_get_bootable (guestfs_h *g,\n"
12773 " const char *device,\n"
12779 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3142
12781 "This command returns true if the partition C<partnum> on C<device> has the "
12782 "bootable flag set."
12786 #: ../src/guestfs-actions.pod:4727
12787 msgid "See also C<guestfs_part_set_bootable>."
12791 #: ../src/guestfs-actions.pod:4733
12792 msgid "guestfs_part_get_mbr_id"
12796 #: ../src/guestfs-actions.pod:4735
12800 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12801 " const char *device,\n"
12807 #: ../src/guestfs-actions.pod:4740 ../fish/guestfish-actions.pod:3151
12809 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12810 "partition C<partnum>."
12814 #: ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:4919
12816 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12817 "undefined results for other partition table types (see "
12818 "C<guestfs_part_get_parttype>)."
12822 #: ../src/guestfs-actions.pod:4751
12823 msgid "guestfs_part_get_parttype"
12827 #: ../src/guestfs-actions.pod:4753
12831 " guestfs_part_get_parttype (guestfs_h *g,\n"
12832 " const char *device);\n"
12837 #: ../src/guestfs-actions.pod:4757 ../fish/guestfish-actions.pod:3162
12839 "This command examines the partition table on C<device> and returns the "
12840 "partition table type (format) being used."
12844 #: ../src/guestfs-actions.pod:4760
12846 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12847 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12848 "possible, although unusual. See C<guestfs_part_init> for a full list."
12852 #: ../src/guestfs-actions.pod:4770
12853 msgid "guestfs_part_init"
12857 #: ../src/guestfs-actions.pod:4772
12861 " guestfs_part_init (guestfs_h *g,\n"
12862 " const char *device,\n"
12863 " const char *parttype);\n"
12868 #: ../src/guestfs-actions.pod:4777 ../fish/guestfish-actions.pod:3174
12870 "This creates an empty partition table on C<device> of one of the partition "
12871 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12872 "(for large disks)."
12876 #: ../src/guestfs-actions.pod:4781
12878 "Initially there are no partitions. Following this, you should call "
12879 "C<guestfs_part_add> for each partition required."
12883 #: ../src/guestfs-actions.pod:4784 ../fish/guestfish-actions.pod:3181
12884 msgid "Possible values for C<parttype> are:"
12888 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3185
12889 msgid "B<efi> | B<gpt>"
12893 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3187
12894 msgid "Intel EFI / GPT partition table."
12898 #: ../src/guestfs-actions.pod:4792 ../fish/guestfish-actions.pod:3189
12900 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12901 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12902 "the C<mbr> format."
12906 #: ../src/guestfs-actions.pod:4796 ../fish/guestfish-actions.pod:3193
12907 msgid "B<mbr> | B<msdos>"
12911 #: ../src/guestfs-actions.pod:4798 ../fish/guestfish-actions.pod:3195
12913 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12914 "Windows. This partition type will B<only> work for device sizes up to 2 "
12915 "TB. For large disks we recommend using C<gpt>."
12919 #: ../src/guestfs-actions.pod:4805 ../fish/guestfish-actions.pod:3202
12920 msgid "Other partition table types that may work but are not supported include:"
12924 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3207
12929 #: ../src/guestfs-actions.pod:4812 ../fish/guestfish-actions.pod:3209
12930 msgid "AIX disk labels."
12934 #: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3211
12935 msgid "B<amiga> | B<rdb>"
12939 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3213
12940 msgid "Amiga \"Rigid Disk Block\" format."
12944 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3215
12949 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:3217
12950 msgid "BSD disk labels."
12954 #: ../src/guestfs-actions.pod:4822 ../fish/guestfish-actions.pod:3219
12959 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3221
12960 msgid "DASD, used on IBM mainframes."
12964 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3223
12969 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3225
12970 msgid "MIPS/SGI volumes."
12974 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3227
12979 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3229
12980 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12984 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3231
12989 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3233
12990 msgid "NEC PC-98 format, common in Japan apparently."
12994 #: ../src/guestfs-actions.pod:4838 ../fish/guestfish-actions.pod:3235
12999 #: ../src/guestfs-actions.pod:4840 ../fish/guestfish-actions.pod:3237
13000 msgid "Sun disk labels."
13004 #: ../src/guestfs-actions.pod:4848
13005 msgid "guestfs_part_list"
13009 #: ../src/guestfs-actions.pod:4850
13012 " struct guestfs_partition_list *\n"
13013 " guestfs_part_list (guestfs_h *g,\n"
13014 " const char *device);\n"
13019 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3245
13021 "This command parses the partition table on C<device> and returns the list of "
13022 "partitions found."
13026 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3248
13027 msgid "The fields in the returned structure are:"
13031 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3252
13032 msgid "B<part_num>"
13036 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3254
13037 msgid "Partition number, counting from 1."
13041 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3256
13042 msgid "B<part_start>"
13046 #: ../src/guestfs-actions.pod:4867
13048 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13049 "the device's sector size, see C<guestfs_blockdev_getss>."
13053 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3261
13054 msgid "B<part_end>"
13058 #: ../src/guestfs-actions.pod:4872 ../fish/guestfish-actions.pod:3263
13059 msgid "End of the partition in bytes."
13063 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3265
13064 msgid "B<part_size>"
13068 #: ../src/guestfs-actions.pod:4876 ../fish/guestfish-actions.pod:3267
13069 msgid "Size of the partition in bytes."
13073 #: ../src/guestfs-actions.pod:4880
13075 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13076 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13081 #: ../src/guestfs-actions.pod:4886
13082 msgid "guestfs_part_set_bootable"
13086 #: ../src/guestfs-actions.pod:4888
13090 " guestfs_part_set_bootable (guestfs_h *g,\n"
13091 " const char *device,\n"
13093 " int bootable);\n"
13098 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3275
13100 "This sets the bootable flag on partition numbered C<partnum> on device "
13101 "C<device>. Note that partitions are numbered from 1."
13105 #: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3278
13107 "The bootable flag is used by some operating systems (notably Windows) to "
13108 "determine which partition to boot from. It is by no means universally "
13113 #: ../src/guestfs-actions.pod:4905
13114 msgid "guestfs_part_set_mbr_id"
13118 #: ../src/guestfs-actions.pod:4907
13122 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13123 " const char *device,\n"
13130 #: ../src/guestfs-actions.pod:4913 ../fish/guestfish-actions.pod:3286
13132 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13133 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13134 "documentation are in fact hexadecimal numbers, but usually documented "
13135 "without any leading \"0x\" which might be confusing."
13139 #: ../src/guestfs-actions.pod:4927
13140 msgid "guestfs_part_set_name"
13144 #: ../src/guestfs-actions.pod:4929
13148 " guestfs_part_set_name (guestfs_h *g,\n"
13149 " const char *device,\n"
13151 " const char *name);\n"
13156 #: ../src/guestfs-actions.pod:4935 ../fish/guestfish-actions.pod:3300
13158 "This sets the partition name on partition numbered C<partnum> on device "
13159 "C<device>. Note that partitions are numbered from 1."
13163 #: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3303
13165 "The partition name can only be set on certain types of partition table. "
13166 "This works on C<gpt> but not on C<mbr> partitions."
13170 #: ../src/guestfs-actions.pod:4945
13171 msgid "guestfs_part_to_dev"
13175 #: ../src/guestfs-actions.pod:4947
13179 " guestfs_part_to_dev (guestfs_h *g,\n"
13180 " const char *partition);\n"
13185 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3310
13187 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13188 "partition number, returning the device name (eg. \"/dev/sdb\")."
13192 #: ../src/guestfs-actions.pod:4955
13194 "The named partition must exist, for example as a string returned from "
13195 "C<guestfs_list_partitions>."
13199 #: ../src/guestfs-actions.pod:4963
13200 msgid "guestfs_ping_daemon"
13204 #: ../src/guestfs-actions.pod:4965
13208 " guestfs_ping_daemon (guestfs_h *g);\n"
13213 #: ../src/guestfs-actions.pod:4968 ../fish/guestfish-actions.pod:3321
13215 "This is a test probe into the guestfs daemon running inside the qemu "
13216 "subprocess. Calling this function checks that the daemon responds to the "
13217 "ping message, without affecting the daemon or attached block device(s) in "
13222 #: ../src/guestfs-actions.pod:4977
13223 msgid "guestfs_pread"
13227 #: ../src/guestfs-actions.pod:4979
13231 " guestfs_pread (guestfs_h *g,\n"
13232 " const char *path,\n"
13234 " int64_t offset,\n"
13235 " size_t *size_r);\n"
13240 #: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3330
13242 "This command lets you read part of a file. It reads C<count> bytes of the "
13243 "file, starting at C<offset>, from file C<path>."
13247 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5015 ../fish/guestfish-actions.pod:3333 ../fish/guestfish-actions.pod:3348
13249 "This may read fewer bytes than requested. For further details see the "
13250 "L<pread(2)> system call."
13254 #: ../src/guestfs-actions.pod:4992
13255 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
13259 #: ../src/guestfs-actions.pod:5003
13260 msgid "guestfs_pread_device"
13264 #: ../src/guestfs-actions.pod:5005
13268 " guestfs_pread_device (guestfs_h *g,\n"
13269 " const char *device,\n"
13271 " int64_t offset,\n"
13272 " size_t *size_r);\n"
13277 #: ../src/guestfs-actions.pod:5012 ../fish/guestfish-actions.pod:3345
13279 "This command lets you read part of a file. It reads C<count> bytes of "
13280 "C<device>, starting at C<offset>."
13284 #: ../src/guestfs-actions.pod:5018
13285 msgid "See also C<guestfs_pread>."
13289 #: ../src/guestfs-actions.pod:5027
13290 msgid "(Added in 1.5.21)"
13294 #: ../src/guestfs-actions.pod:5029
13295 msgid "guestfs_pvcreate"
13299 #: ../src/guestfs-actions.pod:5031
13303 " guestfs_pvcreate (guestfs_h *g,\n"
13304 " const char *device);\n"
13309 #: ../src/guestfs-actions.pod:5035 ../fish/guestfish-actions.pod:3360
13311 "This creates an LVM physical volume on the named C<device>, where C<device> "
13312 "should usually be a partition name such as C</dev/sda1>."
13316 #: ../src/guestfs-actions.pod:5043
13317 msgid "guestfs_pvremove"
13321 #: ../src/guestfs-actions.pod:5045
13325 " guestfs_pvremove (guestfs_h *g,\n"
13326 " const char *device);\n"
13331 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3368
13333 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13338 #: ../src/guestfs-actions.pod:5052 ../fish/guestfish-actions.pod:3371
13340 "The implementation uses the C<pvremove> command which refuses to wipe "
13341 "physical volumes that contain any volume groups, so you have to remove those "
13346 #: ../src/guestfs-actions.pod:5060
13347 msgid "guestfs_pvresize"
13351 #: ../src/guestfs-actions.pod:5062
13355 " guestfs_pvresize (guestfs_h *g,\n"
13356 " const char *device);\n"
13361 #: ../src/guestfs-actions.pod:5066 ../fish/guestfish-actions.pod:3379
13363 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13364 "the new size of the underlying device."
13368 #: ../src/guestfs-actions.pod:5073
13369 msgid "guestfs_pvresize_size"
13373 #: ../src/guestfs-actions.pod:5075
13377 " guestfs_pvresize_size (guestfs_h *g,\n"
13378 " const char *device,\n"
13379 " int64_t size);\n"
13384 #: ../src/guestfs-actions.pod:5080
13386 "This command is the same as C<guestfs_pvresize> except that it allows you to "
13387 "specify the new size (in bytes) explicitly."
13391 #: ../src/guestfs-actions.pod:5087
13392 msgid "guestfs_pvs"
13396 #: ../src/guestfs-actions.pod:5089
13400 " guestfs_pvs (guestfs_h *g);\n"
13405 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3393
13407 "List all the physical volumes detected. This is the equivalent of the "
13408 "L<pvs(8)> command."
13412 #: ../src/guestfs-actions.pod:5095 ../fish/guestfish-actions.pod:3396
13414 "This returns a list of just the device names that contain PVs "
13415 "(eg. C</dev/sda2>)."
13419 #: ../src/guestfs-actions.pod:5098
13420 msgid "See also C<guestfs_pvs_full>."
13424 #: ../src/guestfs-actions.pod:5106
13425 msgid "guestfs_pvs_full"
13429 #: ../src/guestfs-actions.pod:5108
13432 " struct guestfs_lvm_pv_list *\n"
13433 " guestfs_pvs_full (guestfs_h *g);\n"
13438 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3405
13440 "List all the physical volumes detected. This is the equivalent of the "
13441 "L<pvs(8)> command. The \"full\" version includes all fields."
13445 #: ../src/guestfs-actions.pod:5114
13447 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
13448 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
13453 #: ../src/guestfs-actions.pod:5120
13454 msgid "guestfs_pvuuid"
13458 #: ../src/guestfs-actions.pod:5122
13462 " guestfs_pvuuid (guestfs_h *g,\n"
13463 " const char *device);\n"
13468 #: ../src/guestfs-actions.pod:5126 ../fish/guestfish-actions.pod:3412
13469 msgid "This command returns the UUID of the LVM PV C<device>."
13473 #: ../src/guestfs-actions.pod:5133
13474 msgid "guestfs_pwrite"
13478 #: ../src/guestfs-actions.pod:5135
13482 " guestfs_pwrite (guestfs_h *g,\n"
13483 " const char *path,\n"
13484 " const char *content,\n"
13485 " size_t content_size,\n"
13486 " int64_t offset);\n"
13491 #: ../src/guestfs-actions.pod:5142 ../fish/guestfish-actions.pod:3418
13493 "This command writes to part of a file. It writes the data buffer C<content> "
13494 "to the file C<path> starting at offset C<offset>."
13498 #: ../src/guestfs-actions.pod:5145 ../fish/guestfish-actions.pod:3421
13500 "This command implements the L<pwrite(2)> system call, and like that system "
13501 "call it may not write the full data requested. The return value is the "
13502 "number of bytes that were actually written to the file. This could even be "
13503 "0, although short writes are unlikely for regular files in ordinary "
13508 #: ../src/guestfs-actions.pod:5151
13509 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
13513 #: ../src/guestfs-actions.pod:5160
13514 msgid "guestfs_pwrite_device"
13518 #: ../src/guestfs-actions.pod:5162
13522 " guestfs_pwrite_device (guestfs_h *g,\n"
13523 " const char *device,\n"
13524 " const char *content,\n"
13525 " size_t content_size,\n"
13526 " int64_t offset);\n"
13531 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3436
13533 "This command writes to part of a device. It writes the data buffer "
13534 "C<content> to C<device> starting at offset C<offset>."
13538 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3439
13540 "This command implements the L<pwrite(2)> system call, and like that system "
13541 "call it may not write the full data requested (although short writes to disk "
13542 "devices and partitions are probably impossible with standard Linux kernels)."
13546 #: ../src/guestfs-actions.pod:5177
13547 msgid "See also C<guestfs_pwrite>."
13551 #: ../src/guestfs-actions.pod:5184
13552 msgid "(Added in 1.5.20)"
13556 #: ../src/guestfs-actions.pod:5186
13557 msgid "guestfs_read_file"
13561 #: ../src/guestfs-actions.pod:5188
13565 " guestfs_read_file (guestfs_h *g,\n"
13566 " const char *path,\n"
13567 " size_t *size_r);\n"
13572 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3453
13573 msgid "This calls returns the contents of the file C<path> as a buffer."
13577 #: ../src/guestfs-actions.pod:5196
13579 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13580 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13581 "function is limited in the total size of file that can be handled."
13585 #: ../src/guestfs-actions.pod:5208
13586 msgid "(Added in 1.0.63)"
13590 #: ../src/guestfs-actions.pod:5210
13591 msgid "guestfs_read_lines"
13595 #: ../src/guestfs-actions.pod:5212
13599 " guestfs_read_lines (guestfs_h *g,\n"
13600 " const char *path);\n"
13605 #: ../src/guestfs-actions.pod:5218 ../fish/guestfish-actions.pod:3470
13607 "The file contents are returned as a list of lines. Trailing C<LF> and "
13608 "C<CRLF> character sequences are I<not> returned."
13612 #: ../src/guestfs-actions.pod:5221
13614 "Note that this function cannot correctly handle binary files (specifically, "
13615 "files containing C<\\0> character which is treated as end of line). For "
13616 "those you need to use the C<guestfs_read_file> function which has a more "
13617 "complex interface."
13621 #: ../src/guestfs-actions.pod:5232
13622 msgid "guestfs_readdir"
13626 #: ../src/guestfs-actions.pod:5234
13629 " struct guestfs_dirent_list *\n"
13630 " guestfs_readdir (guestfs_h *g,\n"
13631 " const char *dir);\n"
13636 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3482
13637 msgid "This returns the list of directory entries in directory C<dir>."
13641 #: ../src/guestfs-actions.pod:5240 ../fish/guestfish-actions.pod:3484
13643 "All entries in the directory are returned, including C<.> and C<..>. The "
13644 "entries are I<not> sorted, but returned in the same order as the underlying "
13649 #: ../src/guestfs-actions.pod:5244 ../fish/guestfish-actions.pod:3488
13651 "Also this call returns basic file type information about each file. The "
13652 "C<ftyp> field will contain one of the following characters:"
13656 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3493
13661 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3495
13662 msgid "Block special"
13666 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:3497
13671 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3499
13672 msgid "Char special"
13676 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3501
13681 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3503
13686 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3505
13691 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3507
13692 msgid "FIFO (named pipe)"
13696 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3509
13701 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3511
13702 msgid "Symbolic link"
13706 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:3513
13711 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3515
13712 msgid "Regular file"
13716 #: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:3517
13721 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3519
13726 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3521
13731 #: ../src/guestfs-actions.pod:5279 ../fish/guestfish-actions.pod:3523
13732 msgid "Unknown file type"
13736 #: ../src/guestfs-actions.pod:5281 ../fish/guestfish-actions.pod:3525
13741 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3527
13742 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13746 #: ../src/guestfs-actions.pod:5288
13748 "This function is primarily intended for use by programs. To get a simple "
13749 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13750 "consumption, use C<guestfs_ll>."
13754 #: ../src/guestfs-actions.pod:5292
13756 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13757 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
13762 #: ../src/guestfs-actions.pod:5298
13763 msgid "guestfs_readlink"
13767 #: ../src/guestfs-actions.pod:5300
13771 " guestfs_readlink (guestfs_h *g,\n"
13772 " const char *path);\n"
13777 #: ../src/guestfs-actions.pod:5304 ../fish/guestfish-actions.pod:3540
13778 msgid "This command reads the target of a symbolic link."
13782 #: ../src/guestfs-actions.pod:5311
13783 msgid "guestfs_readlinklist"
13787 #: ../src/guestfs-actions.pod:5313
13791 " guestfs_readlinklist (guestfs_h *g,\n"
13792 " const char *path,\n"
13793 " char *const *names);\n"
13798 #: ../src/guestfs-actions.pod:5318 ../fish/guestfish-actions.pod:3546
13800 "This call allows you to do a C<readlink> operation on multiple files, where "
13801 "all files are in the directory C<path>. C<names> is the list of files from "
13806 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3550
13808 "On return you get a list of strings, with a one-to-one correspondence to the "
13809 "C<names> list. Each string is the value of the symbolic link."
13813 #: ../src/guestfs-actions.pod:5326 ../fish/guestfish-actions.pod:3554
13815 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13816 "result string is the empty string C<\"\">. However the whole operation is "
13817 "completed even if there were C<readlink(2)> errors, and so you can call this "
13818 "function with names where you don't know if they are symbolic links already "
13819 "(albeit slightly less efficient)."
13823 #: ../src/guestfs-actions.pod:5333 ../fish/guestfish-actions.pod:3561
13825 "This call is intended for programs that want to efficiently list a directory "
13826 "contents without making many round-trips. Very long directory listings "
13827 "might cause the protocol message size to be exceeded, causing this call to "
13828 "fail. The caller must split up such requests into smaller groups of names."
13832 #: ../src/guestfs-actions.pod:5346
13833 msgid "guestfs_realpath"
13837 #: ../src/guestfs-actions.pod:5348
13841 " guestfs_realpath (guestfs_h *g,\n"
13842 " const char *path);\n"
13847 #: ../src/guestfs-actions.pod:5352 ../fish/guestfish-actions.pod:3572
13849 "Return the canonicalized absolute pathname of C<path>. The returned path "
13850 "has no C<.>, C<..> or symbolic link path elements."
13854 #: ../src/guestfs-actions.pod:5360
13855 msgid "guestfs_removexattr"
13859 #: ../src/guestfs-actions.pod:5362
13863 " guestfs_removexattr (guestfs_h *g,\n"
13864 " const char *xattr,\n"
13865 " const char *path);\n"
13870 #: ../src/guestfs-actions.pod:5367 ../fish/guestfish-actions.pod:3579
13871 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
13875 #: ../src/guestfs-actions.pod:5370
13876 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13880 #: ../src/guestfs-actions.pod:5376
13881 msgid "guestfs_resize2fs"
13885 #: ../src/guestfs-actions.pod:5378
13889 " guestfs_resize2fs (guestfs_h *g,\n"
13890 " const char *device);\n"
13895 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3588
13897 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13898 "underlying device."
13902 #: ../src/guestfs-actions.pod:5385
13904 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13905 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13906 "sometimes gives an error about this and sometimes not. In any case, it is "
13907 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13911 #: ../src/guestfs-actions.pod:5395
13912 msgid "guestfs_resize2fs_size"
13916 #: ../src/guestfs-actions.pod:5397
13920 " guestfs_resize2fs_size (guestfs_h *g,\n"
13921 " const char *device,\n"
13922 " int64_t size);\n"
13927 #: ../src/guestfs-actions.pod:5402
13929 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13930 "to specify the new size (in bytes) explicitly."
13934 #: ../src/guestfs-actions.pod:5409
13939 #: ../src/guestfs-actions.pod:5411
13943 " guestfs_rm (guestfs_h *g,\n"
13944 " const char *path);\n"
13949 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3608
13950 msgid "Remove the single file C<path>."
13954 #: ../src/guestfs-actions.pod:5421
13955 msgid "guestfs_rm_rf"
13959 #: ../src/guestfs-actions.pod:5423
13963 " guestfs_rm_rf (guestfs_h *g,\n"
13964 " const char *path);\n"
13969 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3614
13971 "Remove the file or directory C<path>, recursively removing the contents if "
13972 "its a directory. This is like the C<rm -rf> shell command."
13976 #: ../src/guestfs-actions.pod:5435
13977 msgid "guestfs_rmdir"
13981 #: ../src/guestfs-actions.pod:5437
13985 " guestfs_rmdir (guestfs_h *g,\n"
13986 " const char *path);\n"
13991 #: ../src/guestfs-actions.pod:5441 ../fish/guestfish-actions.pod:3622
13992 msgid "Remove the single directory C<path>."
13996 #: ../src/guestfs-actions.pod:5447
13997 msgid "guestfs_rmmountpoint"
14001 #: ../src/guestfs-actions.pod:5449
14005 " guestfs_rmmountpoint (guestfs_h *g,\n"
14006 " const char *exemptpath);\n"
14011 #: ../src/guestfs-actions.pod:5453
14013 "This calls removes a mountpoint that was previously created with "
14014 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14018 #: ../src/guestfs-actions.pod:5461
14019 msgid "guestfs_scrub_device"
14023 #: ../src/guestfs-actions.pod:5463
14027 " guestfs_scrub_device (guestfs_h *g,\n"
14028 " const char *device);\n"
14033 #: ../src/guestfs-actions.pod:5467 ../fish/guestfish-actions.pod:3636
14035 "This command writes patterns over C<device> to make data retrieval more "
14040 #: ../src/guestfs-actions.pod:5470 ../src/guestfs-actions.pod:5491 ../src/guestfs-actions.pod:5510 ../fish/guestfish-actions.pod:3639 ../fish/guestfish-actions.pod:3654 ../fish/guestfish-actions.pod:3667
14042 "It is an interface to the L<scrub(1)> program. See that manual page for "
14047 #: ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5515
14048 msgid "(Added in 1.0.52)"
14052 #: ../src/guestfs-actions.pod:5480
14053 msgid "guestfs_scrub_file"
14057 #: ../src/guestfs-actions.pod:5482
14061 " guestfs_scrub_file (guestfs_h *g,\n"
14062 " const char *file);\n"
14067 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3649
14069 "This command writes patterns over a file to make data retrieval more "
14074 #: ../src/guestfs-actions.pod:5489 ../fish/guestfish-actions.pod:3652
14075 msgid "The file is I<removed> after scrubbing."
14079 #: ../src/guestfs-actions.pod:5498
14080 msgid "guestfs_scrub_freespace"
14084 #: ../src/guestfs-actions.pod:5500
14088 " guestfs_scrub_freespace (guestfs_h *g,\n"
14089 " const char *dir);\n"
14094 #: ../src/guestfs-actions.pod:5504
14096 "This command creates the directory C<dir> and then fills it with files until "
14097 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14098 "and deletes them. The intention is to scrub any free space on the partition "
14099 "containing C<dir>."
14103 #: ../src/guestfs-actions.pod:5517
14104 msgid "guestfs_set_append"
14108 #: ../src/guestfs-actions.pod:5519
14112 " guestfs_set_append (guestfs_h *g,\n"
14113 " const char *append);\n"
14118 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3676
14120 "This function is used to add additional options to the guest kernel command "
14125 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3679
14127 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14128 "environment variable."
14132 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3682
14134 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14135 "(libguestfs always adds a few of its own)."
14139 #: ../src/guestfs-actions.pod:5536
14140 msgid "guestfs_set_autosync"
14144 #: ../src/guestfs-actions.pod:5538
14148 " guestfs_set_autosync (guestfs_h *g,\n"
14149 " int autosync);\n"
14154 #: ../src/guestfs-actions.pod:5542
14156 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14157 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
14158 "the handle is closed (also if the program exits without closing handles)."
14162 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3696
14164 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14165 "disabled by default)."
14169 #: ../src/guestfs-actions.pod:5554
14170 msgid "guestfs_set_direct"
14174 #: ../src/guestfs-actions.pod:5556
14178 " guestfs_set_direct (guestfs_h *g,\n"
14184 #: ../src/guestfs-actions.pod:5560 ../fish/guestfish-actions.pod:3705
14186 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14187 "passed directly through to the appliance once it is launched."
14191 #: ../src/guestfs-actions.pod:5564
14193 "One consequence of this is that log messages aren't caught by the library "
14194 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
14199 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3713
14200 msgid "You probably don't want to use this unless you know what you are doing."
14204 #: ../src/guestfs-actions.pod:5571 ../fish/guestfish-actions.pod:3716
14205 msgid "The default is disabled."
14209 #: ../src/guestfs-actions.pod:5577
14210 msgid "guestfs_set_e2label"
14214 #: ../src/guestfs-actions.pod:5579
14218 " guestfs_set_e2label (guestfs_h *g,\n"
14219 " const char *device,\n"
14220 " const char *label);\n"
14225 #: ../src/guestfs-actions.pod:5584 ../fish/guestfish-actions.pod:3722
14227 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14228 "C<label>. Filesystem labels are limited to 16 characters."
14232 #: ../src/guestfs-actions.pod:5588
14234 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
14235 "the existing label on a filesystem."
14239 #: ../src/guestfs-actions.pod:5595
14240 msgid "guestfs_set_e2uuid"
14244 #: ../src/guestfs-actions.pod:5597
14248 " guestfs_set_e2uuid (guestfs_h *g,\n"
14249 " const char *device,\n"
14250 " const char *uuid);\n"
14255 #: ../src/guestfs-actions.pod:5602 ../fish/guestfish-actions.pod:3733
14257 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14258 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14259 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14263 #: ../src/guestfs-actions.pod:5607
14265 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
14266 "the existing UUID of a filesystem."
14270 #: ../src/guestfs-actions.pod:5614
14271 msgid "guestfs_set_memsize"
14275 #: ../src/guestfs-actions.pod:5616
14279 " guestfs_set_memsize (guestfs_h *g,\n"
14285 #: ../src/guestfs-actions.pod:5620
14287 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14288 "This only has any effect if called before C<guestfs_launch>."
14292 #: ../src/guestfs-actions.pod:5624 ../fish/guestfish-actions.pod:3751
14294 "You can also change this by setting the environment variable "
14295 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14299 #: ../src/guestfs-actions.pod:5635
14300 msgid "guestfs_set_network"
14304 #: ../src/guestfs-actions.pod:5637
14308 " guestfs_set_network (guestfs_h *g,\n"
14314 #: ../src/guestfs-actions.pod:5641 ../fish/guestfish-actions.pod:3764
14316 "If C<network> is true, then the network is enabled in the libguestfs "
14317 "appliance. The default is false."
14321 #: ../src/guestfs-actions.pod:5644 ../fish/guestfish-actions.pod:3767
14323 "This affects whether commands are able to access the network (see "
14324 "L<guestfs(3)/RUNNING COMMANDS>)."
14328 #: ../src/guestfs-actions.pod:5647
14330 "You must call this before calling C<guestfs_launch>, otherwise it has no "
14335 #: ../src/guestfs-actions.pod:5654
14336 msgid "guestfs_set_path"
14340 #: ../src/guestfs-actions.pod:5656
14344 " guestfs_set_path (guestfs_h *g,\n"
14345 " const char *searchpath);\n"
14350 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3779
14351 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14355 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3781
14357 "The default is C<$libdir/guestfs> unless overridden by setting "
14358 "C<LIBGUESTFS_PATH> environment variable."
14362 #: ../src/guestfs-actions.pod:5665 ../fish/guestfish-actions.pod:3784
14363 msgid "Setting C<path> to C<NULL> restores the default path."
14367 #: ../src/guestfs-actions.pod:5671
14368 msgid "guestfs_set_qemu"
14372 #: ../src/guestfs-actions.pod:5673
14376 " guestfs_set_qemu (guestfs_h *g,\n"
14377 " const char *qemu);\n"
14382 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:3792
14383 msgid "Set the qemu binary that we will use."
14387 #: ../src/guestfs-actions.pod:5679 ../fish/guestfish-actions.pod:3794
14388 msgid "The default is chosen when the library was compiled by the configure script."
14392 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3797
14394 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14399 #: ../src/guestfs-actions.pod:5685 ../fish/guestfish-actions.pod:3800
14400 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14404 #: ../src/guestfs-actions.pod:5687 ../fish/guestfish-actions.pod:3802
14406 "Note that you should call this function as early as possible after creating "
14407 "the handle. This is because some pre-launch operations depend on testing "
14408 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14409 "don't retest features, and so you might see inconsistent results. Using the "
14410 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14411 "the qemu binary at the same time as the handle is created."
14415 #: ../src/guestfs-actions.pod:5699
14416 msgid "guestfs_set_recovery_proc"
14420 #: ../src/guestfs-actions.pod:5701
14424 " guestfs_set_recovery_proc (guestfs_h *g,\n"
14425 " int recoveryproc);\n"
14430 #: ../src/guestfs-actions.pod:5705
14432 "If this is called with the parameter C<false> then C<guestfs_launch> does "
14433 "not create a recovery process. The purpose of the recovery process is to "
14434 "stop runaway qemu processes in the case where the main program aborts "
14439 #: ../src/guestfs-actions.pod:5710
14441 "This only has any effect if called before C<guestfs_launch>, and the default "
14446 #: ../src/guestfs-actions.pod:5713 ../fish/guestfish-actions.pod:3824
14448 "About the only time when you would want to disable this is if the main "
14449 "process will fork itself into the background (\"daemonize\" itself). In "
14450 "this case the recovery process thinks that the main program has disappeared "
14451 "and so kills qemu, which is not very helpful."
14455 #: ../src/guestfs-actions.pod:5723
14456 msgid "guestfs_set_selinux"
14460 #: ../src/guestfs-actions.pod:5725
14464 " guestfs_set_selinux (guestfs_h *g,\n"
14470 #: ../src/guestfs-actions.pod:5729 ../fish/guestfish-actions.pod:3836
14472 "This sets the selinux flag that is passed to the appliance at boot time. "
14473 "The default is C<selinux=0> (disabled)."
14477 #: ../src/guestfs-actions.pod:5732 ../fish/guestfish-actions.pod:3839
14479 "Note that if SELinux is enabled, it is always in Permissive mode "
14480 "(C<enforcing=0>)."
14484 #: ../src/guestfs-actions.pod:5742
14485 msgid "guestfs_set_trace"
14489 #: ../src/guestfs-actions.pod:5744
14493 " guestfs_set_trace (guestfs_h *g,\n"
14499 #: ../src/guestfs-actions.pod:5748 ../fish/guestfish-actions.pod:3851
14501 "If the command trace flag is set to 1, then commands are printed on stderr "
14502 "before they are executed in a format which is very similar to the one used "
14503 "by guestfish. In other words, you can run a program with this enabled, and "
14504 "you will get out a script which you can feed to guestfish to perform the "
14505 "same set of actions."
14509 #: ../src/guestfs-actions.pod:5755 ../fish/guestfish-actions.pod:3858
14511 "If you want to trace C API calls into libguestfs (and other libraries) then "
14512 "possibly a better way is to use the external ltrace(1) command."
14516 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3862
14518 "Command traces are disabled unless the environment variable "
14519 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14523 #: ../src/guestfs-actions.pod:5766
14524 msgid "guestfs_set_verbose"
14528 #: ../src/guestfs-actions.pod:5768
14532 " guestfs_set_verbose (guestfs_h *g,\n"
14538 #: ../src/guestfs-actions.pod:5772 ../fish/guestfish-actions.pod:3871
14539 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
14543 #: ../src/guestfs-actions.pod:5774 ../fish/guestfish-actions.pod:3873
14545 "Verbose messages are disabled unless the environment variable "
14546 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14550 #: ../src/guestfs-actions.pod:5781
14551 msgid "guestfs_setcon"
14555 #: ../src/guestfs-actions.pod:5783
14559 " guestfs_setcon (guestfs_h *g,\n"
14560 " const char *context);\n"
14565 #: ../src/guestfs-actions.pod:5787 ../fish/guestfish-actions.pod:3880
14567 "This sets the SELinux security context of the daemon to the string "
14572 #: ../src/guestfs-actions.pod:5790 ../fish/guestfish-actions.pod:3883
14573 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14577 #: ../src/guestfs-actions.pod:5796
14578 msgid "guestfs_setxattr"
14582 #: ../src/guestfs-actions.pod:5798
14586 " guestfs_setxattr (guestfs_h *g,\n"
14587 " const char *xattr,\n"
14588 " const char *val,\n"
14590 " const char *path);\n"
14595 #: ../src/guestfs-actions.pod:5805 ../fish/guestfish-actions.pod:3889
14597 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14598 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14602 #: ../src/guestfs-actions.pod:5809
14603 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14607 #: ../src/guestfs-actions.pod:5815
14608 msgid "guestfs_sfdisk"
14612 #: ../src/guestfs-actions.pod:5817
14616 " guestfs_sfdisk (guestfs_h *g,\n"
14617 " const char *device,\n"
14621 " char *const *lines);\n"
14626 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3899
14628 "This is a direct interface to the L<sfdisk(8)> program for creating "
14629 "partitions on block devices."
14633 #: ../src/guestfs-actions.pod:5828 ../fish/guestfish-actions.pod:3902
14634 msgid "C<device> should be a block device, for example C</dev/sda>."
14638 #: ../src/guestfs-actions.pod:5830 ../fish/guestfish-actions.pod:3904
14640 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14641 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14642 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14643 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14644 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14645 "the kernel) cannot work out the right geometry and you will need to tell it."
14649 #: ../src/guestfs-actions.pod:5838 ../fish/guestfish-actions.pod:3912
14651 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14652 "refer to the L<sfdisk(8)> manpage."
14656 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3915
14658 "To create a single partition occupying the whole disk, you would pass "
14659 "C<lines> as a single element list, when the single element being the string "
14664 #: ../src/guestfs-actions.pod:5845
14665 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14669 #: ../src/guestfs-actions.pod:5855
14670 msgid "guestfs_sfdiskM"
14674 #: ../src/guestfs-actions.pod:5857
14678 " guestfs_sfdiskM (guestfs_h *g,\n"
14679 " const char *device,\n"
14680 " char *const *lines);\n"
14685 #: ../src/guestfs-actions.pod:5862
14687 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14688 "partition sizes are specified in megabytes only (rounded to the nearest "
14689 "cylinder) and you don't need to specify the cyls, heads and sectors "
14690 "parameters which were rarely if ever used anyway."
14694 #: ../src/guestfs-actions.pod:5868
14696 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14697 "C<guestfs_part_disk>"
14701 #: ../src/guestfs-actions.pod:5878
14702 msgid "guestfs_sfdisk_N"
14706 #: ../src/guestfs-actions.pod:5880
14710 " guestfs_sfdisk_N (guestfs_h *g,\n"
14711 " const char *device,\n"
14716 " const char *line);\n"
14721 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3945
14723 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14724 "(note: C<n> counts from 1)."
14728 #: ../src/guestfs-actions.pod:5892
14730 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14731 "for the cyls/heads/sectors parameters."
14735 #: ../src/guestfs-actions.pod:5895
14736 msgid "See also: C<guestfs_part_add>"
14740 #: ../src/guestfs-actions.pod:5904
14741 msgid "guestfs_sfdisk_disk_geometry"
14745 #: ../src/guestfs-actions.pod:5906
14749 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14750 " const char *device);\n"
14755 #: ../src/guestfs-actions.pod:5910
14757 "This displays the disk geometry of C<device> read from the partition table. "
14758 "Especially in the case where the underlying block device has been resized, "
14759 "this can be different from the kernel's idea of the geometry (see "
14760 "C<guestfs_sfdisk_kernel_geometry>)."
14764 #: ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:5931 ../fish/guestfish-actions.pod:3965 ../fish/guestfish-actions.pod:3974
14765 msgid "The result is in human-readable format, and not designed to be parsed."
14769 #: ../src/guestfs-actions.pod:5923
14770 msgid "guestfs_sfdisk_kernel_geometry"
14774 #: ../src/guestfs-actions.pod:5925
14778 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14779 " const char *device);\n"
14784 #: ../src/guestfs-actions.pod:5929 ../fish/guestfish-actions.pod:3972
14785 msgid "This displays the kernel's idea of the geometry of C<device>."
14789 #: ../src/guestfs-actions.pod:5939
14790 msgid "guestfs_sfdisk_l"
14794 #: ../src/guestfs-actions.pod:5941
14798 " guestfs_sfdisk_l (guestfs_h *g,\n"
14799 " const char *device);\n"
14804 #: ../src/guestfs-actions.pod:5945 ../fish/guestfish-actions.pod:3981
14806 "This displays the partition table on C<device>, in the human-readable output "
14807 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14811 #: ../src/guestfs-actions.pod:5949
14812 msgid "See also: C<guestfs_part_list>"
14816 #: ../src/guestfs-actions.pod:5956
14821 #: ../src/guestfs-actions.pod:5958
14825 " guestfs_sh (guestfs_h *g,\n"
14826 " const char *command);\n"
14831 #: ../src/guestfs-actions.pod:5962 ../fish/guestfish-actions.pod:3991
14833 "This call runs a command from the guest filesystem via the guest's "
14838 #: ../src/guestfs-actions.pod:5965
14839 msgid "This is like C<guestfs_command>, but passes the command to:"
14843 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:3996
14846 " /bin/sh -c \"command\"\n"
14851 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:3998
14853 "Depending on the guest's shell, this usually results in wildcards being "
14854 "expanded, shell expressions being interpolated and so on."
14858 #: ../src/guestfs-actions.pod:5973
14859 msgid "All the provisos about C<guestfs_command> apply to this call."
14863 #: ../src/guestfs-actions.pod:5980
14864 msgid "guestfs_sh_lines"
14868 #: ../src/guestfs-actions.pod:5982
14872 " guestfs_sh_lines (guestfs_h *g,\n"
14873 " const char *command);\n"
14878 #: ../src/guestfs-actions.pod:5986
14880 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14885 #: ../src/guestfs-actions.pod:5989
14886 msgid "See also: C<guestfs_command_lines>"
14890 #: ../src/guestfs-actions.pod:5997
14891 msgid "guestfs_sleep"
14895 #: ../src/guestfs-actions.pod:5999
14899 " guestfs_sleep (guestfs_h *g,\n"
14905 #: ../src/guestfs-actions.pod:6003 ../fish/guestfish-actions.pod:4017
14906 msgid "Sleep for C<secs> seconds."
14910 #: ../src/guestfs-actions.pod:6007
14911 msgid "(Added in 1.0.41)"
14915 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-structs.pod:109
14916 msgid "guestfs_stat"
14920 #: ../src/guestfs-actions.pod:6011
14923 " struct guestfs_stat *\n"
14924 " guestfs_stat (guestfs_h *g,\n"
14925 " const char *path);\n"
14930 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4025
14931 msgid "This is the same as the C<stat(2)> system call."
14935 #: ../src/guestfs-actions.pod:6025 ../src/guestfs-structs.pod:135
14936 msgid "guestfs_statvfs"
14940 #: ../src/guestfs-actions.pod:6027
14943 " struct guestfs_statvfs *\n"
14944 " guestfs_statvfs (guestfs_h *g,\n"
14945 " const char *path);\n"
14950 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:4031
14952 "Returns file system statistics for any mounted file system. C<path> should "
14953 "be a file or directory in the mounted file system (typically it is the mount "
14954 "point itself, but it doesn't need to be)."
14958 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4035
14959 msgid "This is the same as the C<statvfs(2)> system call."
14963 #: ../src/guestfs-actions.pod:6037
14965 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14966 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14970 #: ../src/guestfs-actions.pod:6043
14971 msgid "guestfs_strings"
14975 #: ../src/guestfs-actions.pod:6045
14979 " guestfs_strings (guestfs_h *g,\n"
14980 " const char *path);\n"
14985 #: ../src/guestfs-actions.pod:6049 ../fish/guestfish-actions.pod:4041
14987 "This runs the L<strings(1)> command on a file and returns the list of "
14988 "printable strings found."
14992 #: ../src/guestfs-actions.pod:6061
14993 msgid "guestfs_strings_e"
14997 #: ../src/guestfs-actions.pod:6063
15001 " guestfs_strings_e (guestfs_h *g,\n"
15002 " const char *encoding,\n"
15003 " const char *path);\n"
15008 #: ../src/guestfs-actions.pod:6068
15010 "This is like the C<guestfs_strings> command, but allows you to specify the "
15011 "encoding of strings that are looked for in the source file C<path>."
15015 #: ../src/guestfs-actions.pod:6072 ../fish/guestfish-actions.pod:4055
15016 msgid "Allowed encodings are:"
15020 #: ../src/guestfs-actions.pod:6076 ../fish/guestfish-actions.pod:4059
15025 #: ../src/guestfs-actions.pod:6078
15027 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15028 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15032 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4064
15037 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4066
15038 msgid "Single 8-bit-byte characters."
15042 #: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4068
15047 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4070
15048 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15052 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4073
15053 msgid "l (lower case letter L)"
15057 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4075
15059 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15060 "examining binaries in Windows guests."
15064 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4078
15069 #: ../src/guestfs-actions.pod:6097 ../fish/guestfish-actions.pod:4080
15070 msgid "32-bit big endian such as UCS-4BE."
15074 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4082
15079 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4084
15080 msgid "32-bit little endian such as UCS-4LE."
15084 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4088
15085 msgid "The returned strings are transcoded to UTF-8."
15089 #: ../src/guestfs-actions.pod:6116
15090 msgid "guestfs_swapoff_device"
15094 #: ../src/guestfs-actions.pod:6118
15098 " guestfs_swapoff_device (guestfs_h *g,\n"
15099 " const char *device);\n"
15104 #: ../src/guestfs-actions.pod:6122
15106 "This command disables the libguestfs appliance swap device or partition "
15107 "named C<device>. See C<guestfs_swapon_device>."
15111 #: ../src/guestfs-actions.pod:6130
15112 msgid "guestfs_swapoff_file"
15116 #: ../src/guestfs-actions.pod:6132
15120 " guestfs_swapoff_file (guestfs_h *g,\n"
15121 " const char *file);\n"
15126 #: ../src/guestfs-actions.pod:6136 ../fish/guestfish-actions.pod:4105
15127 msgid "This command disables the libguestfs appliance swap on file."
15131 #: ../src/guestfs-actions.pod:6142
15132 msgid "guestfs_swapoff_label"
15136 #: ../src/guestfs-actions.pod:6144
15140 " guestfs_swapoff_label (guestfs_h *g,\n"
15141 " const char *label);\n"
15146 #: ../src/guestfs-actions.pod:6148 ../fish/guestfish-actions.pod:4111
15148 "This command disables the libguestfs appliance swap on labeled swap "
15153 #: ../src/guestfs-actions.pod:6155
15154 msgid "guestfs_swapoff_uuid"
15158 #: ../src/guestfs-actions.pod:6157
15162 " guestfs_swapoff_uuid (guestfs_h *g,\n"
15163 " const char *uuid);\n"
15168 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4118
15170 "This command disables the libguestfs appliance swap partition with the given "
15175 #: ../src/guestfs-actions.pod:6168
15176 msgid "guestfs_swapon_device"
15180 #: ../src/guestfs-actions.pod:6170
15184 " guestfs_swapon_device (guestfs_h *g,\n"
15185 " const char *device);\n"
15190 #: ../src/guestfs-actions.pod:6174
15192 "This command enables the libguestfs appliance to use the swap device or "
15193 "partition named C<device>. The increased memory is made available for all "
15194 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
15198 #: ../src/guestfs-actions.pod:6179 ../fish/guestfish-actions.pod:4130
15200 "Note that you should not swap to existing guest swap partitions unless you "
15201 "know what you are doing. They may contain hibernation information, or other "
15202 "information that the guest doesn't want you to trash. You also risk leaking "
15203 "information about the host to the guest this way. Instead, attach a new "
15204 "host device to the guest and swap on that."
15208 #: ../src/guestfs-actions.pod:6190
15209 msgid "guestfs_swapon_file"
15213 #: ../src/guestfs-actions.pod:6192
15217 " guestfs_swapon_file (guestfs_h *g,\n"
15218 " const char *file);\n"
15223 #: ../src/guestfs-actions.pod:6196
15225 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
15230 #: ../src/guestfs-actions.pod:6203
15231 msgid "guestfs_swapon_label"
15235 #: ../src/guestfs-actions.pod:6205
15239 " guestfs_swapon_label (guestfs_h *g,\n"
15240 " const char *label);\n"
15245 #: ../src/guestfs-actions.pod:6209
15247 "This command enables swap to a labeled swap partition. See "
15248 "C<guestfs_swapon_device> for other notes."
15252 #: ../src/guestfs-actions.pod:6216
15253 msgid "guestfs_swapon_uuid"
15257 #: ../src/guestfs-actions.pod:6218
15261 " guestfs_swapon_uuid (guestfs_h *g,\n"
15262 " const char *uuid);\n"
15267 #: ../src/guestfs-actions.pod:6222
15269 "This command enables swap to a swap partition with the given UUID. See "
15270 "C<guestfs_swapon_device> for other notes."
15274 #: ../src/guestfs-actions.pod:6229
15275 msgid "guestfs_sync"
15279 #: ../src/guestfs-actions.pod:6231
15283 " guestfs_sync (guestfs_h *g);\n"
15288 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4162
15290 "This syncs the disk, so that any writes are flushed through to the "
15291 "underlying disk image."
15295 #: ../src/guestfs-actions.pod:6237 ../fish/guestfish-actions.pod:4165
15297 "You should always call this if you have modified a disk image, before "
15298 "closing the handle."
15302 #: ../src/guestfs-actions.pod:6244
15303 msgid "guestfs_tail"
15307 #: ../src/guestfs-actions.pod:6246
15311 " guestfs_tail (guestfs_h *g,\n"
15312 " const char *path);\n"
15317 #: ../src/guestfs-actions.pod:6250 ../fish/guestfish-actions.pod:4172
15318 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15322 #: ../src/guestfs-actions.pod:6262
15323 msgid "guestfs_tail_n"
15327 #: ../src/guestfs-actions.pod:6264
15331 " guestfs_tail_n (guestfs_h *g,\n"
15333 " const char *path);\n"
15338 #: ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4182
15340 "If the parameter C<nrlines> is a positive number, this returns the last "
15341 "C<nrlines> lines of the file C<path>."
15345 #: ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:4185
15347 "If the parameter C<nrlines> is a negative number, this returns lines from "
15348 "the file C<path>, starting with the C<-nrlines>th line."
15352 #: ../src/guestfs-actions.pod:6286
15353 msgid "guestfs_tar_in"
15357 #: ../src/guestfs-actions.pod:6288
15361 " guestfs_tar_in (guestfs_h *g,\n"
15362 " const char *tarfile,\n"
15363 " const char *directory);\n"
15368 #: ../src/guestfs-actions.pod:6293 ../fish/guestfish-actions.pod:4197
15370 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15371 "tar file) into C<directory>."
15375 #: ../src/guestfs-actions.pod:6296
15376 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
15380 #: ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6318 ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6350
15381 msgid "(Added in 1.0.3)"
15385 #: ../src/guestfs-actions.pod:6303
15386 msgid "guestfs_tar_out"
15390 #: ../src/guestfs-actions.pod:6305
15394 " guestfs_tar_out (guestfs_h *g,\n"
15395 " const char *directory,\n"
15396 " const char *tarfile);\n"
15401 #: ../src/guestfs-actions.pod:6310 ../fish/guestfish-actions.pod:4209
15403 "This command packs the contents of C<directory> and downloads it to local "
15408 #: ../src/guestfs-actions.pod:6313
15410 "To download a compressed tarball, use C<guestfs_tgz_out> or "
15411 "C<guestfs_txz_out>."
15415 #: ../src/guestfs-actions.pod:6320
15416 msgid "guestfs_tgz_in"
15420 #: ../src/guestfs-actions.pod:6322
15424 " guestfs_tgz_in (guestfs_h *g,\n"
15425 " const char *tarball,\n"
15426 " const char *directory);\n"
15431 #: ../src/guestfs-actions.pod:6327 ../fish/guestfish-actions.pod:4221
15433 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15434 "tar file) into C<directory>."
15438 #: ../src/guestfs-actions.pod:6330
15439 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
15443 #: ../src/guestfs-actions.pod:6336
15444 msgid "guestfs_tgz_out"
15448 #: ../src/guestfs-actions.pod:6338
15452 " guestfs_tgz_out (guestfs_h *g,\n"
15453 " const char *directory,\n"
15454 " const char *tarball);\n"
15459 #: ../src/guestfs-actions.pod:6343 ../fish/guestfish-actions.pod:4232
15461 "This command packs the contents of C<directory> and downloads it to local "
15466 #: ../src/guestfs-actions.pod:6346
15467 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
15471 #: ../src/guestfs-actions.pod:6352
15472 msgid "guestfs_touch"
15476 #: ../src/guestfs-actions.pod:6354
15480 " guestfs_touch (guestfs_h *g,\n"
15481 " const char *path);\n"
15486 #: ../src/guestfs-actions.pod:6358 ../fish/guestfish-actions.pod:4243
15488 "Touch acts like the L<touch(1)> command. It can be used to update the "
15489 "timestamps on a file, or, if the file does not exist, to create a new "
15490 "zero-length file."
15494 #: ../src/guestfs-actions.pod:6362 ../fish/guestfish-actions.pod:4247
15496 "This command only works on regular files, and will fail on other file types "
15497 "such as directories, symbolic links, block special etc."
15501 #: ../src/guestfs-actions.pod:6369
15502 msgid "guestfs_truncate"
15506 #: ../src/guestfs-actions.pod:6371
15510 " guestfs_truncate (guestfs_h *g,\n"
15511 " const char *path);\n"
15516 #: ../src/guestfs-actions.pod:6375 ../fish/guestfish-actions.pod:4254
15518 "This command truncates C<path> to a zero-length file. The file must exist "
15523 #: ../src/guestfs-actions.pod:6382
15524 msgid "guestfs_truncate_size"
15528 #: ../src/guestfs-actions.pod:6384
15532 " guestfs_truncate_size (guestfs_h *g,\n"
15533 " const char *path,\n"
15534 " int64_t size);\n"
15539 #: ../src/guestfs-actions.pod:6389 ../fish/guestfish-actions.pod:4261
15541 "This command truncates C<path> to size C<size> bytes. The file must exist "
15546 #: ../src/guestfs-actions.pod:6392
15548 "If the current file size is less than C<size> then the file is extended to "
15549 "the required size with zero bytes. This creates a sparse file (ie. disk "
15550 "blocks are not allocated for the file until you write to it). To create a "
15551 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15555 #: ../src/guestfs-actions.pod:6402
15556 msgid "guestfs_tune2fs_l"
15560 #: ../src/guestfs-actions.pod:6404
15564 " guestfs_tune2fs_l (guestfs_h *g,\n"
15565 " const char *device);\n"
15570 #: ../src/guestfs-actions.pod:6408 ../fish/guestfish-actions.pod:4274
15572 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15577 #: ../src/guestfs-actions.pod:6411 ../fish/guestfish-actions.pod:4277
15579 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15580 "for more details. The list of fields returned isn't clearly defined, and "
15581 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15582 "and the filesystem itself."
15586 #: ../src/guestfs-actions.pod:6424
15587 msgid "guestfs_txz_in"
15591 #: ../src/guestfs-actions.pod:6426
15595 " guestfs_txz_in (guestfs_h *g,\n"
15596 " const char *tarball,\n"
15597 " const char *directory);\n"
15602 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4286
15604 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15605 "tar file) into C<directory>."
15609 #: ../src/guestfs-actions.pod:6438
15610 msgid "guestfs_txz_out"
15614 #: ../src/guestfs-actions.pod:6440
15618 " guestfs_txz_out (guestfs_h *g,\n"
15619 " const char *directory,\n"
15620 " const char *tarball);\n"
15625 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4295
15627 "This command packs the contents of C<directory> and downloads it to local "
15628 "file C<tarball> (as an xz compressed tar archive)."
15632 #: ../src/guestfs-actions.pod:6452
15633 msgid "guestfs_umask"
15637 #: ../src/guestfs-actions.pod:6454
15641 " guestfs_umask (guestfs_h *g,\n"
15647 #: ../src/guestfs-actions.pod:6458 ../fish/guestfish-actions.pod:4304
15649 "This function sets the mask used for creating new files and device nodes to "
15654 #: ../src/guestfs-actions.pod:6461 ../fish/guestfish-actions.pod:4307
15656 "Typical umask values would be C<022> which creates new files with "
15657 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15658 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15662 #: ../src/guestfs-actions.pod:6466 ../fish/guestfish-actions.pod:4312
15664 "The default umask is C<022>. This is important because it means that "
15665 "directories and device nodes will be created with C<0644> or C<0755> mode "
15666 "even if you specify C<0777>."
15670 #: ../src/guestfs-actions.pod:6470
15672 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15673 "C<guestfs_mkdir>."
15677 #: ../src/guestfs-actions.pod:6473 ../fish/guestfish-actions.pod:4319
15678 msgid "This call returns the previous umask."
15682 #: ../src/guestfs-actions.pod:6479
15683 msgid "guestfs_umount"
15687 #: ../src/guestfs-actions.pod:6481
15691 " guestfs_umount (guestfs_h *g,\n"
15692 " const char *pathordevice);\n"
15697 #: ../src/guestfs-actions.pod:6485 ../fish/guestfish-actions.pod:4327
15699 "This unmounts the given filesystem. The filesystem may be specified either "
15700 "by its mountpoint (path) or the device which contains the filesystem."
15704 #: ../src/guestfs-actions.pod:6493
15705 msgid "guestfs_umount_all"
15709 #: ../src/guestfs-actions.pod:6495
15713 " guestfs_umount_all (guestfs_h *g);\n"
15718 #: ../src/guestfs-actions.pod:6498 ../fish/guestfish-actions.pod:4337
15719 msgid "This unmounts all mounted filesystems."
15723 #: ../src/guestfs-actions.pod:6500 ../fish/guestfish-actions.pod:4339
15724 msgid "Some internal mounts are not unmounted by this call."
15728 #: ../src/guestfs-actions.pod:6506
15729 msgid "guestfs_upload"
15733 #: ../src/guestfs-actions.pod:6508
15737 " guestfs_upload (guestfs_h *g,\n"
15738 " const char *filename,\n"
15739 " const char *remotefilename);\n"
15744 #: ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6537 ../fish/guestfish-actions.pod:4345 ../fish/guestfish-actions.pod:4358
15745 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15749 #: ../src/guestfs-actions.pod:6518
15750 msgid "See also C<guestfs_download>."
15754 #: ../src/guestfs-actions.pod:6529
15755 msgid "guestfs_upload_offset"
15759 #: ../src/guestfs-actions.pod:6531
15763 " guestfs_upload_offset (guestfs_h *g,\n"
15764 " const char *filename,\n"
15765 " const char *remotefilename,\n"
15766 " int64_t offset);\n"
15771 #: ../src/guestfs-actions.pod:6540 ../fish/guestfish-actions.pod:4361
15773 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15774 "The intention is to overwrite parts of existing files or devices, although "
15775 "if a non-existant file is specified then it is created with a \"hole\" "
15776 "before C<offset>. The size of the data written is implicit in the size of "
15777 "the source C<filename>."
15781 #: ../src/guestfs-actions.pod:6547
15783 "Note that there is no limit on the amount of data that can be uploaded with "
15784 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15785 "full amount unless an error occurs."
15789 #: ../src/guestfs-actions.pod:6552
15790 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15794 #: ../src/guestfs-actions.pod:6563
15795 msgid "guestfs_utimens"
15799 #: ../src/guestfs-actions.pod:6565
15803 " guestfs_utimens (guestfs_h *g,\n"
15804 " const char *path,\n"
15805 " int64_t atsecs,\n"
15806 " int64_t atnsecs,\n"
15807 " int64_t mtsecs,\n"
15808 " int64_t mtnsecs);\n"
15813 #: ../src/guestfs-actions.pod:6573 ../fish/guestfish-actions.pod:4381
15814 msgid "This command sets the timestamps of a file with nanosecond precision."
15818 #: ../src/guestfs-actions.pod:6576 ../fish/guestfish-actions.pod:4384
15820 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15825 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4387
15827 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15828 "nanoseconds from the epoch."
15832 #: ../src/guestfs-actions.pod:6582 ../fish/guestfish-actions.pod:4390
15834 "If the C<*nsecs> field contains the special value C<-1> then the "
15835 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15836 "ignored in this case)."
15840 #: ../src/guestfs-actions.pod:6586 ../fish/guestfish-actions.pod:4394
15842 "If the C<*nsecs> field contains the special value C<-2> then the "
15843 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15848 #: ../src/guestfs-actions.pod:6594 ../src/guestfs-structs.pod:175
15849 msgid "guestfs_version"
15853 #: ../src/guestfs-actions.pod:6596
15856 " struct guestfs_version *\n"
15857 " guestfs_version (guestfs_h *g);\n"
15862 #: ../src/guestfs-actions.pod:6599 ../fish/guestfish-actions.pod:4402
15863 msgid "Return the libguestfs version number that the program is linked against."
15867 #: ../src/guestfs-actions.pod:6602 ../fish/guestfish-actions.pod:4405
15869 "Note that because of dynamic linking this is not necessarily the version of "
15870 "libguestfs that you compiled against. You can compile the program, and then "
15871 "at runtime dynamically link against a completely different C<libguestfs.so> "
15876 #: ../src/guestfs-actions.pod:6607 ../fish/guestfish-actions.pod:4410
15878 "This call was added in version C<1.0.58>. In previous versions of "
15879 "libguestfs there was no way to get the version number. From C code you can "
15880 "use dynamic linker functions to find out if this symbol exists (if it "
15881 "doesn't, then it's an earlier version)."
15885 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
15887 "The call returns a structure with four elements. The first three (C<major>, "
15888 "C<minor> and C<release>) are numbers and correspond to the usual version "
15889 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15890 "but may be used for distro-specific information."
15894 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4422
15895 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
15899 #: ../src/guestfs-actions.pod:6622 ../fish/guestfish-actions.pod:4425
15900 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15904 #: ../src/guestfs-actions.pod:6624
15906 "I<Note:> Don't use this call to test for availability of features. In "
15907 "enterprise distributions we backport features from later versions into "
15908 "earlier versions, making this an unreliable way to test for features. Use "
15909 "C<guestfs_available> instead."
15913 #: ../src/guestfs-actions.pod:6630
15915 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15916 "error. I<The caller must call C<guestfs_free_version> after use>."
15920 #: ../src/guestfs-actions.pod:6634
15921 msgid "(Added in 1.0.58)"
15925 #: ../src/guestfs-actions.pod:6636
15926 msgid "guestfs_vfs_label"
15930 #: ../src/guestfs-actions.pod:6638
15934 " guestfs_vfs_label (guestfs_h *g,\n"
15935 " const char *device);\n"
15940 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4437
15941 msgid "This returns the filesystem label of the filesystem on C<device>."
15945 #: ../src/guestfs-actions.pod:6645 ../fish/guestfish-actions.pod:4440
15946 msgid "If the filesystem is unlabeled, this returns the empty string."
15950 #: ../src/guestfs-actions.pod:6647
15951 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15955 #: ../src/guestfs-actions.pod:6652 ../src/guestfs-actions.pod:6689
15956 msgid "(Added in 1.3.18)"
15960 #: ../src/guestfs-actions.pod:6654
15961 msgid "guestfs_vfs_type"
15965 #: ../src/guestfs-actions.pod:6656
15969 " guestfs_vfs_type (guestfs_h *g,\n"
15970 " const char *device);\n"
15975 #: ../src/guestfs-actions.pod:6660 ../fish/guestfish-actions.pod:4448
15977 "This command gets the filesystem type corresponding to the filesystem on "
15982 #: ../src/guestfs-actions.pod:6663 ../fish/guestfish-actions.pod:4451
15984 "For most filesystems, the result is the name of the Linux VFS module which "
15985 "would be used to mount this filesystem if you mounted it without specifying "
15986 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15990 #: ../src/guestfs-actions.pod:6673
15991 msgid "guestfs_vfs_uuid"
15995 #: ../src/guestfs-actions.pod:6675
15999 " guestfs_vfs_uuid (guestfs_h *g,\n"
16000 " const char *device);\n"
16005 #: ../src/guestfs-actions.pod:6679 ../fish/guestfish-actions.pod:4460
16006 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16010 #: ../src/guestfs-actions.pod:6682 ../fish/guestfish-actions.pod:4463
16011 msgid "If the filesystem does not have a UUID, this returns the empty string."
16015 #: ../src/guestfs-actions.pod:6684
16016 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16020 #: ../src/guestfs-actions.pod:6691
16021 msgid "guestfs_vg_activate"
16025 #: ../src/guestfs-actions.pod:6693
16029 " guestfs_vg_activate (guestfs_h *g,\n"
16031 " char *const *volgroups);\n"
16036 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4471
16038 "This command activates or (if C<activate> is false) deactivates all logical "
16039 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16040 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16041 "deactivated, then those devices disappear."
16045 #: ../src/guestfs-actions.pod:6704 ../fish/guestfish-actions.pod:4477
16046 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16050 #: ../src/guestfs-actions.pod:6706 ../fish/guestfish-actions.pod:4479
16052 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16053 "activated or deactivated."
16057 #: ../src/guestfs-actions.pod:6713
16058 msgid "guestfs_vg_activate_all"
16062 #: ../src/guestfs-actions.pod:6715
16066 " guestfs_vg_activate_all (guestfs_h *g,\n"
16067 " int activate);\n"
16072 #: ../src/guestfs-actions.pod:6719 ../fish/guestfish-actions.pod:4486
16074 "This command activates or (if C<activate> is false) deactivates all logical "
16075 "volumes in all volume groups. If activated, then they are made known to the "
16076 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16077 "those devices disappear."
16081 #: ../src/guestfs-actions.pod:6725 ../fish/guestfish-actions.pod:4492
16082 msgid "This command is the same as running C<vgchange -a y|n>"
16086 #: ../src/guestfs-actions.pod:6731
16087 msgid "guestfs_vgcreate"
16091 #: ../src/guestfs-actions.pod:6733
16095 " guestfs_vgcreate (guestfs_h *g,\n"
16096 " const char *volgroup,\n"
16097 " char *const *physvols);\n"
16102 #: ../src/guestfs-actions.pod:6738 ../fish/guestfish-actions.pod:4498
16104 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16105 "of physical volumes C<physvols>."
16109 #: ../src/guestfs-actions.pod:6745
16110 msgid "guestfs_vglvuuids"
16114 #: ../src/guestfs-actions.pod:6747
16118 " guestfs_vglvuuids (guestfs_h *g,\n"
16119 " const char *vgname);\n"
16124 #: ../src/guestfs-actions.pod:6751 ../fish/guestfish-actions.pod:4505
16126 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16127 "volumes created in this volume group."
16131 #: ../src/guestfs-actions.pod:6754
16133 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
16134 "associate logical volumes and volume groups."
16138 #: ../src/guestfs-actions.pod:6757
16139 msgid "See also C<guestfs_vgpvuuids>."
16143 #: ../src/guestfs-actions.pod:6765
16144 msgid "guestfs_vgpvuuids"
16148 #: ../src/guestfs-actions.pod:6767
16152 " guestfs_vgpvuuids (guestfs_h *g,\n"
16153 " const char *vgname);\n"
16158 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4517
16160 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16161 "volumes that this volume group resides on."
16165 #: ../src/guestfs-actions.pod:6774
16167 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
16168 "associate physical volumes and volume groups."
16172 #: ../src/guestfs-actions.pod:6777
16173 msgid "See also C<guestfs_vglvuuids>."
16177 #: ../src/guestfs-actions.pod:6785
16178 msgid "guestfs_vgremove"
16182 #: ../src/guestfs-actions.pod:6787
16186 " guestfs_vgremove (guestfs_h *g,\n"
16187 " const char *vgname);\n"
16192 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4529
16193 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16197 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4531
16198 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16202 #: ../src/guestfs-actions.pod:6800
16203 msgid "guestfs_vgrename"
16207 #: ../src/guestfs-actions.pod:6802
16211 " guestfs_vgrename (guestfs_h *g,\n"
16212 " const char *volgroup,\n"
16213 " const char *newvolgroup);\n"
16218 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4538
16219 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16223 #: ../src/guestfs-actions.pod:6813
16224 msgid "guestfs_vgs"
16228 #: ../src/guestfs-actions.pod:6815
16232 " guestfs_vgs (guestfs_h *g);\n"
16237 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4544
16239 "List all the volumes groups detected. This is the equivalent of the "
16240 "L<vgs(8)> command."
16244 #: ../src/guestfs-actions.pod:6821 ../fish/guestfish-actions.pod:4547
16246 "This returns a list of just the volume group names that were detected "
16247 "(eg. C<VolGroup00>)."
16251 #: ../src/guestfs-actions.pod:6824
16252 msgid "See also C<guestfs_vgs_full>."
16256 #: ../src/guestfs-actions.pod:6832
16257 msgid "guestfs_vgs_full"
16261 #: ../src/guestfs-actions.pod:6834
16264 " struct guestfs_lvm_vg_list *\n"
16265 " guestfs_vgs_full (guestfs_h *g);\n"
16270 #: ../src/guestfs-actions.pod:6837 ../fish/guestfish-actions.pod:4556
16272 "List all the volumes groups detected. This is the equivalent of the "
16273 "L<vgs(8)> command. The \"full\" version includes all fields."
16277 #: ../src/guestfs-actions.pod:6840
16279 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
16280 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
16285 #: ../src/guestfs-actions.pod:6846
16286 msgid "guestfs_vgscan"
16290 #: ../src/guestfs-actions.pod:6848
16294 " guestfs_vgscan (guestfs_h *g);\n"
16299 #: ../src/guestfs-actions.pod:6851 ../fish/guestfish-actions.pod:4563
16301 "This rescans all block devices and rebuilds the list of LVM physical "
16302 "volumes, volume groups and logical volumes."
16306 #: ../src/guestfs-actions.pod:6858
16307 msgid "guestfs_vguuid"
16311 #: ../src/guestfs-actions.pod:6860
16315 " guestfs_vguuid (guestfs_h *g,\n"
16316 " const char *vgname);\n"
16321 #: ../src/guestfs-actions.pod:6864 ../fish/guestfish-actions.pod:4570
16322 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16326 #: ../src/guestfs-actions.pod:6871
16327 msgid "guestfs_wait_ready"
16331 #: ../src/guestfs-actions.pod:6873
16335 " guestfs_wait_ready (guestfs_h *g);\n"
16340 #: ../src/guestfs-actions.pod:6876
16341 msgid "This function is a no op."
16345 #: ../src/guestfs-actions.pod:6878
16347 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
16348 "calling C<guestfs_launch> to wait for the launch to complete. However this "
16349 "is no longer necessary because C<guestfs_launch> now does the waiting."
16353 #: ../src/guestfs-actions.pod:6883
16355 "If you see any calls to this function in code then you can just remove them, "
16356 "unless you want to retain compatibility with older versions of the API."
16360 #: ../src/guestfs-actions.pod:6891
16361 msgid "guestfs_wc_c"
16365 #: ../src/guestfs-actions.pod:6893
16369 " guestfs_wc_c (guestfs_h *g,\n"
16370 " const char *path);\n"
16375 #: ../src/guestfs-actions.pod:6897 ../fish/guestfish-actions.pod:4576
16377 "This command counts the characters in a file, using the C<wc -c> external "
16382 #: ../src/guestfs-actions.pod:6904
16383 msgid "guestfs_wc_l"
16387 #: ../src/guestfs-actions.pod:6906
16391 " guestfs_wc_l (guestfs_h *g,\n"
16392 " const char *path);\n"
16397 #: ../src/guestfs-actions.pod:6910 ../fish/guestfish-actions.pod:4583
16399 "This command counts the lines in a file, using the C<wc -l> external "
16404 #: ../src/guestfs-actions.pod:6917
16405 msgid "guestfs_wc_w"
16409 #: ../src/guestfs-actions.pod:6919
16413 " guestfs_wc_w (guestfs_h *g,\n"
16414 " const char *path);\n"
16419 #: ../src/guestfs-actions.pod:6923 ../fish/guestfish-actions.pod:4590
16421 "This command counts the words in a file, using the C<wc -w> external "
16426 #: ../src/guestfs-actions.pod:6930
16427 msgid "guestfs_write"
16431 #: ../src/guestfs-actions.pod:6932
16435 " guestfs_write (guestfs_h *g,\n"
16436 " const char *path,\n"
16437 " const char *content,\n"
16438 " size_t content_size);\n"
16443 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4597
16445 "This call creates a file called C<path>. The content of the file is the "
16446 "string C<content> (which can contain any 8 bit data)."
16450 #: ../src/guestfs-actions.pod:6948
16451 msgid "guestfs_write_file"
16455 #: ../src/guestfs-actions.pod:6950
16459 " guestfs_write_file (guestfs_h *g,\n"
16460 " const char *path,\n"
16461 " const char *content,\n"
16467 #: ../src/guestfs-actions.pod:6956 ../fish/guestfish-actions.pod:4607
16469 "This call creates a file called C<path>. The contents of the file is the "
16470 "string C<content> (which can contain any 8 bit data), with length C<size>."
16474 #: ../src/guestfs-actions.pod:6960 ../fish/guestfish-actions.pod:4611
16476 "As a special case, if C<size> is C<0> then the length is calculated using "
16477 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16481 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4615
16483 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16484 "I<not> work, even if the length is specified."
16488 #: ../src/guestfs-actions.pod:6972 ../fish/guestfish-actions.pod:4621
16489 msgid "This function is deprecated. In new code, use the C<write> call instead."
16493 #: ../src/guestfs-actions.pod:6981
16494 msgid "guestfs_zegrep"
16498 #: ../src/guestfs-actions.pod:6983
16502 " guestfs_zegrep (guestfs_h *g,\n"
16503 " const char *regex,\n"
16504 " const char *path);\n"
16509 #: ../src/guestfs-actions.pod:6988 ../fish/guestfish-actions.pod:4632
16510 msgid "This calls the external C<zegrep> program and returns the matching lines."
16514 #: ../src/guestfs-actions.pod:7000
16515 msgid "guestfs_zegrepi"
16519 #: ../src/guestfs-actions.pod:7002
16523 " guestfs_zegrepi (guestfs_h *g,\n"
16524 " const char *regex,\n"
16525 " const char *path);\n"
16530 #: ../src/guestfs-actions.pod:7007 ../fish/guestfish-actions.pod:4642
16531 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16535 #: ../src/guestfs-actions.pod:7019
16536 msgid "guestfs_zero"
16540 #: ../src/guestfs-actions.pod:7021
16544 " guestfs_zero (guestfs_h *g,\n"
16545 " const char *device);\n"
16550 #: ../src/guestfs-actions.pod:7025 ../fish/guestfish-actions.pod:4652
16551 msgid "This command writes zeroes over the first few blocks of C<device>."
16555 #: ../src/guestfs-actions.pod:7027 ../fish/guestfish-actions.pod:4654
16557 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16558 "securely wipe the device). It should be sufficient to remove any partition "
16559 "tables, filesystem superblocks and so on."
16563 #: ../src/guestfs-actions.pod:7031
16564 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16568 #: ../src/guestfs-actions.pod:7042
16569 msgid "guestfs_zero_device"
16573 #: ../src/guestfs-actions.pod:7044
16577 " guestfs_zero_device (guestfs_h *g,\n"
16578 " const char *device);\n"
16583 #: ../src/guestfs-actions.pod:7048
16585 "This command writes zeroes over the entire C<device>. Compare with "
16586 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16590 #: ../src/guestfs-actions.pod:7062
16591 msgid "(Added in 1.3.1)"
16595 #: ../src/guestfs-actions.pod:7064
16596 msgid "guestfs_zerofree"
16600 #: ../src/guestfs-actions.pod:7066
16604 " guestfs_zerofree (guestfs_h *g,\n"
16605 " const char *device);\n"
16610 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:4675
16612 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16613 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16614 "possible to compress the filesystem more effectively."
16618 #: ../src/guestfs-actions.pod:7075 ../fish/guestfish-actions.pod:4680
16619 msgid "You should B<not> run this program if the filesystem is mounted."
16623 #: ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:4683
16625 "It is possible that using this program can damage the filesystem or data on "
16630 #: ../src/guestfs-actions.pod:7085
16631 msgid "guestfs_zfgrep"
16635 #: ../src/guestfs-actions.pod:7087
16639 " guestfs_zfgrep (guestfs_h *g,\n"
16640 " const char *pattern,\n"
16641 " const char *path);\n"
16646 #: ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:4690
16647 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16651 #: ../src/guestfs-actions.pod:7104
16652 msgid "guestfs_zfgrepi"
16656 #: ../src/guestfs-actions.pod:7106
16660 " guestfs_zfgrepi (guestfs_h *g,\n"
16661 " const char *pattern,\n"
16662 " const char *path);\n"
16667 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4700
16668 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16672 #: ../src/guestfs-actions.pod:7123
16673 msgid "guestfs_zfile"
16677 #: ../src/guestfs-actions.pod:7125
16681 " guestfs_zfile (guestfs_h *g,\n"
16682 " const char *meth,\n"
16683 " const char *path);\n"
16688 #: ../src/guestfs-actions.pod:7130 ../fish/guestfish-actions.pod:4710
16689 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16693 #: ../src/guestfs-actions.pod:7133 ../fish/guestfish-actions.pod:4713
16694 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16698 #: ../src/guestfs-actions.pod:7135
16700 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16705 #: ../src/guestfs-actions.pod:7141 ../fish/guestfish-actions.pod:4718
16706 msgid "This function is deprecated. In new code, use the C<file> call instead."
16710 #: ../src/guestfs-actions.pod:7150
16711 msgid "guestfs_zgrep"
16715 #: ../src/guestfs-actions.pod:7152
16719 " guestfs_zgrep (guestfs_h *g,\n"
16720 " const char *regex,\n"
16721 " const char *path);\n"
16726 #: ../src/guestfs-actions.pod:7157 ../fish/guestfish-actions.pod:4729
16727 msgid "This calls the external C<zgrep> program and returns the matching lines."
16731 #: ../src/guestfs-actions.pod:7169
16732 msgid "guestfs_zgrepi"
16736 #: ../src/guestfs-actions.pod:7171
16740 " guestfs_zgrepi (guestfs_h *g,\n"
16741 " const char *regex,\n"
16742 " const char *path);\n"
16747 #: ../src/guestfs-actions.pod:7176 ../fish/guestfish-actions.pod:4739
16748 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16752 #: ../src/guestfs-availability.pod:3
16757 #: ../src/guestfs-availability.pod:5
16759 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
16760 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
16761 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
16762 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
16763 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
16767 #: ../src/guestfs-availability.pod:21
16772 #: ../src/guestfs-availability.pod:23
16774 "The following functions: L</guestfs_inotify_add_watch> "
16775 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
16776 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16780 #: ../src/guestfs-availability.pod:31
16781 msgid "B<linuxfsuuid>"
16785 #: ../src/guestfs-availability.pod:33
16787 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
16788 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16792 #: ../src/guestfs-availability.pod:40
16793 msgid "B<linuxmodules>"
16797 #: ../src/guestfs-availability.pod:42
16798 msgid "The following functions: L</guestfs_modprobe>"
16802 #: ../src/guestfs-availability.pod:45
16803 msgid "B<linuxxattrs>"
16807 #: ../src/guestfs-availability.pod:47
16809 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
16810 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
16811 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
16812 "L</guestfs_setxattr>"
16816 #: ../src/guestfs-availability.pod:58
16821 #: ../src/guestfs-availability.pod:60
16823 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
16824 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
16825 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16829 #: ../src/guestfs-availability.pod:69
16834 #: ../src/guestfs-availability.pod:71
16836 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
16837 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
16838 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
16839 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
16840 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
16841 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
16842 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
16843 "L</guestfs_vgs_full>"
16847 #: ../src/guestfs-availability.pod:94
16852 #: ../src/guestfs-availability.pod:96
16854 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
16855 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
16859 #: ../src/guestfs-availability.pod:102
16864 #: ../src/guestfs-availability.pod:104
16865 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16869 #: ../src/guestfs-availability.pod:107
16870 msgid "B<ntfsprogs>"
16874 #: ../src/guestfs-availability.pod:109
16875 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16879 #: ../src/guestfs-availability.pod:113
16880 msgid "B<realpath>"
16884 #: ../src/guestfs-availability.pod:115
16885 msgid "The following functions: L</guestfs_realpath>"
16889 #: ../src/guestfs-availability.pod:118
16894 #: ../src/guestfs-availability.pod:120
16896 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
16897 "L</guestfs_scrub_freespace>"
16901 #: ../src/guestfs-availability.pod:125
16906 #: ../src/guestfs-availability.pod:127
16907 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16911 #: ../src/guestfs-availability.pod:131
16916 #: ../src/guestfs-availability.pod:133
16917 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16921 #: ../src/guestfs-availability.pod:137
16922 msgid "B<zerofree>"
16926 #: ../src/guestfs-availability.pod:139
16927 msgid "The following functions: L</guestfs_zerofree>"
16931 #: ../src/guestfs-structs.pod:1
16932 msgid "guestfs_int_bool"
16936 #: ../src/guestfs-structs.pod:3
16939 " struct guestfs_int_bool {\n"
16947 #: ../src/guestfs-structs.pod:8
16950 " struct guestfs_int_bool_list {\n"
16951 " uint32_t len; /* Number of elements in list. */\n"
16952 " struct guestfs_int_bool *val; /* Elements. */\n"
16958 #: ../src/guestfs-structs.pod:13
16961 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16962 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16967 #: ../src/guestfs-structs.pod:16
16968 msgid "guestfs_lvm_pv"
16972 #: ../src/guestfs-structs.pod:18
16975 " struct guestfs_lvm_pv {\n"
16976 " char *pv_name;\n"
16977 " /* The next field is NOT nul-terminated, be careful when printing it: "
16979 " char pv_uuid[32];\n"
16981 " uint64_t pv_size;\n"
16982 " uint64_t dev_size;\n"
16983 " uint64_t pv_free;\n"
16984 " uint64_t pv_used;\n"
16985 " char *pv_attr;\n"
16986 " int64_t pv_pe_count;\n"
16987 " int64_t pv_pe_alloc_count;\n"
16988 " char *pv_tags;\n"
16989 " uint64_t pe_start;\n"
16990 " int64_t pv_mda_count;\n"
16991 " uint64_t pv_mda_free;\n"
16997 #: ../src/guestfs-structs.pod:36
17000 " struct guestfs_lvm_pv_list {\n"
17001 " uint32_t len; /* Number of elements in list. */\n"
17002 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17008 #: ../src/guestfs-structs.pod:41
17011 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17012 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17017 #: ../src/guestfs-structs.pod:44
17018 msgid "guestfs_lvm_vg"
17022 #: ../src/guestfs-structs.pod:46
17025 " struct guestfs_lvm_vg {\n"
17026 " char *vg_name;\n"
17027 " /* The next field is NOT nul-terminated, be careful when printing it: "
17029 " char vg_uuid[32];\n"
17031 " char *vg_attr;\n"
17032 " uint64_t vg_size;\n"
17033 " uint64_t vg_free;\n"
17034 " char *vg_sysid;\n"
17035 " uint64_t vg_extent_size;\n"
17036 " int64_t vg_extent_count;\n"
17037 " int64_t vg_free_count;\n"
17038 " int64_t max_lv;\n"
17039 " int64_t max_pv;\n"
17040 " int64_t pv_count;\n"
17041 " int64_t lv_count;\n"
17042 " int64_t snap_count;\n"
17043 " int64_t vg_seqno;\n"
17044 " char *vg_tags;\n"
17045 " int64_t vg_mda_count;\n"
17046 " uint64_t vg_mda_free;\n"
17052 #: ../src/guestfs-structs.pod:69
17055 " struct guestfs_lvm_vg_list {\n"
17056 " uint32_t len; /* Number of elements in list. */\n"
17057 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17063 #: ../src/guestfs-structs.pod:74
17066 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17067 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17072 #: ../src/guestfs-structs.pod:77
17073 msgid "guestfs_lvm_lv"
17077 #: ../src/guestfs-structs.pod:79
17080 " struct guestfs_lvm_lv {\n"
17081 " char *lv_name;\n"
17082 " /* The next field is NOT nul-terminated, be careful when printing it: "
17084 " char lv_uuid[32];\n"
17085 " char *lv_attr;\n"
17086 " int64_t lv_major;\n"
17087 " int64_t lv_minor;\n"
17088 " int64_t lv_kernel_major;\n"
17089 " int64_t lv_kernel_minor;\n"
17090 " uint64_t lv_size;\n"
17091 " int64_t seg_count;\n"
17093 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17094 " float snap_percent;\n"
17095 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17096 " float copy_percent;\n"
17097 " char *move_pv;\n"
17098 " char *lv_tags;\n"
17099 " char *mirror_log;\n"
17100 " char *modules;\n"
17106 #: ../src/guestfs-structs.pod:101
17109 " struct guestfs_lvm_lv_list {\n"
17110 " uint32_t len; /* Number of elements in list. */\n"
17111 " struct guestfs_lvm_lv *val; /* Elements. */\n"
17117 #: ../src/guestfs-structs.pod:106
17120 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
17121 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
17126 #: ../src/guestfs-structs.pod:111
17129 " struct guestfs_stat {\n"
17133 " int64_t nlink;\n"
17138 " int64_t blksize;\n"
17139 " int64_t blocks;\n"
17140 " int64_t atime;\n"
17141 " int64_t mtime;\n"
17142 " int64_t ctime;\n"
17148 #: ../src/guestfs-structs.pod:127
17151 " struct guestfs_stat_list {\n"
17152 " uint32_t len; /* Number of elements in list. */\n"
17153 " struct guestfs_stat *val; /* Elements. */\n"
17159 #: ../src/guestfs-structs.pod:132
17162 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
17163 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
17168 #: ../src/guestfs-structs.pod:137
17171 " struct guestfs_statvfs {\n"
17172 " int64_t bsize;\n"
17173 " int64_t frsize;\n"
17174 " int64_t blocks;\n"
17175 " int64_t bfree;\n"
17176 " int64_t bavail;\n"
17177 " int64_t files;\n"
17178 " int64_t ffree;\n"
17179 " int64_t favail;\n"
17182 " int64_t namemax;\n"
17188 #: ../src/guestfs-structs.pod:151
17191 " struct guestfs_statvfs_list {\n"
17192 " uint32_t len; /* Number of elements in list. */\n"
17193 " struct guestfs_statvfs *val; /* Elements. */\n"
17199 #: ../src/guestfs-structs.pod:156
17202 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
17203 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
17208 #: ../src/guestfs-structs.pod:159
17209 msgid "guestfs_dirent"
17213 #: ../src/guestfs-structs.pod:161
17216 " struct guestfs_dirent {\n"
17225 #: ../src/guestfs-structs.pod:167
17228 " struct guestfs_dirent_list {\n"
17229 " uint32_t len; /* Number of elements in list. */\n"
17230 " struct guestfs_dirent *val; /* Elements. */\n"
17236 #: ../src/guestfs-structs.pod:172
17239 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
17240 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
17245 #: ../src/guestfs-structs.pod:177
17248 " struct guestfs_version {\n"
17249 " int64_t major;\n"
17250 " int64_t minor;\n"
17251 " int64_t release;\n"
17258 #: ../src/guestfs-structs.pod:184
17261 " struct guestfs_version_list {\n"
17262 " uint32_t len; /* Number of elements in list. */\n"
17263 " struct guestfs_version *val; /* Elements. */\n"
17269 #: ../src/guestfs-structs.pod:189
17272 " void guestfs_free_version (struct guestfs_free_version *);\n"
17273 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
17278 #: ../src/guestfs-structs.pod:192
17279 msgid "guestfs_xattr"
17283 #: ../src/guestfs-structs.pod:194
17286 " struct guestfs_xattr {\n"
17287 " char *attrname;\n"
17288 " /* The next two fields describe a byte array. */\n"
17289 " uint32_t attrval_len;\n"
17290 " char *attrval;\n"
17296 #: ../src/guestfs-structs.pod:201
17299 " struct guestfs_xattr_list {\n"
17300 " uint32_t len; /* Number of elements in list. */\n"
17301 " struct guestfs_xattr *val; /* Elements. */\n"
17307 #: ../src/guestfs-structs.pod:206
17310 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
17311 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
17316 #: ../src/guestfs-structs.pod:209
17317 msgid "guestfs_inotify_event"
17321 #: ../src/guestfs-structs.pod:211
17324 " struct guestfs_inotify_event {\n"
17325 " int64_t in_wd;\n"
17326 " uint32_t in_mask;\n"
17327 " uint32_t in_cookie;\n"
17328 " char *in_name;\n"
17334 #: ../src/guestfs-structs.pod:218
17337 " struct guestfs_inotify_event_list {\n"
17338 " uint32_t len; /* Number of elements in list. */\n"
17339 " struct guestfs_inotify_event *val; /* Elements. */\n"
17345 #: ../src/guestfs-structs.pod:223
17348 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
17349 " void guestfs_free_inotify_event_list (struct "
17350 "guestfs_free_inotify_event_list *);\n"
17355 #: ../src/guestfs-structs.pod:226
17356 msgid "guestfs_partition"
17360 #: ../src/guestfs-structs.pod:228
17363 " struct guestfs_partition {\n"
17364 " int32_t part_num;\n"
17365 " uint64_t part_start;\n"
17366 " uint64_t part_end;\n"
17367 " uint64_t part_size;\n"
17373 #: ../src/guestfs-structs.pod:235
17376 " struct guestfs_partition_list {\n"
17377 " uint32_t len; /* Number of elements in list. */\n"
17378 " struct guestfs_partition *val; /* Elements. */\n"
17384 #: ../src/guestfs-structs.pod:240
17387 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
17388 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
17393 #: ../src/guestfs-structs.pod:243
17394 msgid "guestfs_application"
17398 #: ../src/guestfs-structs.pod:245
17401 " struct guestfs_application {\n"
17402 " char *app_name;\n"
17403 " char *app_display_name;\n"
17404 " int32_t app_epoch;\n"
17405 " char *app_version;\n"
17406 " char *app_release;\n"
17407 " char *app_install_path;\n"
17408 " char *app_trans_path;\n"
17409 " char *app_publisher;\n"
17410 " char *app_url;\n"
17411 " char *app_source_package;\n"
17412 " char *app_summary;\n"
17413 " char *app_description;\n"
17419 #: ../src/guestfs-structs.pod:260
17422 " struct guestfs_application_list {\n"
17423 " uint32_t len; /* Number of elements in list. */\n"
17424 " struct guestfs_application *val; /* Elements. */\n"
17430 #: ../src/guestfs-structs.pod:265
17433 " void guestfs_free_application (struct guestfs_free_application *);\n"
17434 " void guestfs_free_application_list (struct guestfs_free_application_list "
17440 #: ../fish/guestfish.pod:5
17441 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17445 #: ../fish/guestfish.pod:9
17448 " guestfish [--options] [commands]\n"
17453 #: ../fish/guestfish.pod:11
17461 #: ../fish/guestfish.pod:13
17464 " guestfish [--ro|--rw] -a disk.img\n"
17469 #: ../fish/guestfish.pod:15
17472 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17477 #: ../fish/guestfish.pod:17
17480 " guestfish -d libvirt-domain\n"
17485 #: ../fish/guestfish.pod:19
17488 " guestfish [--ro|--rw] -a disk.img -i\n"
17493 #: ../fish/guestfish.pod:21
17496 " guestfish -d libvirt-domain -i\n"
17501 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
17506 #: ../fish/guestfish.pod:25
17508 "Using guestfish in read/write mode on live virtual machines can be "
17509 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17510 "option to use guestfish safely if the disk image or virtual machine might be "
17515 #: ../fish/guestfish.pod:32
17517 "Guestfish is a shell and command-line tool for examining and modifying "
17518 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17519 "functionality of the guestfs API, see L<guestfs(3)>."
17523 #: ../fish/guestfish.pod:36
17525 "Guestfish gives you structured access to the libguestfs API, from shell "
17526 "scripts or the command line or interactively. If you want to rescue a "
17527 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17532 #: ../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
17537 #: ../fish/guestfish.pod:43
17538 msgid "As an interactive shell"
17542 #: ../fish/guestfish.pod:45
17550 #: ../fish/guestfish.pod:47
17553 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17554 " editing virtual machine filesystems.\n"
17559 #: ../fish/guestfish.pod:50
17562 " Type: 'help' for a list of commands\n"
17563 " 'man' to read the manual\n"
17564 " 'quit' to quit the shell\n"
17569 #: ../fish/guestfish.pod:54
17572 " ><fs> add-ro disk.img\n"
17574 " ><fs> list-filesystems\n"
17575 " /dev/sda1: ext4\n"
17576 " /dev/vg_guest/lv_root: ext4\n"
17577 " /dev/vg_guest/lv_swap: swap\n"
17578 " ><fs> mount /dev/vg_guest/lv_root /\n"
17579 " ><fs> cat /etc/fstab\n"
17581 " # Created by anaconda\n"
17588 #: ../fish/guestfish.pod:67
17589 msgid "From shell scripts"
17593 #: ../fish/guestfish.pod:69
17594 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17598 #: ../fish/guestfish.pod:71
17601 " guestfish <<_EOF_\n"
17604 " mount /dev/vg_guest/lv_root /\n"
17605 " write /etc/motd \"Welcome, new users\"\n"
17611 #: ../fish/guestfish.pod:78
17612 msgid "List the LVM logical volumes in a disk image:"
17616 #: ../fish/guestfish.pod:80
17619 " guestfish -a disk.img --ro <<_EOF_\n"
17627 #: ../fish/guestfish.pod:85
17628 msgid "List all the filesystems in a disk image:"
17632 #: ../fish/guestfish.pod:87
17635 " guestfish -a disk.img --ro <<_EOF_\n"
17637 " list-filesystems\n"
17643 #: ../fish/guestfish.pod:92
17644 msgid "On one command line"
17648 #: ../fish/guestfish.pod:94
17649 msgid "Update C</etc/resolv.conf> in a guest:"
17653 #: ../fish/guestfish.pod:96
17657 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17658 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17663 #: ../fish/guestfish.pod:100
17664 msgid "Edit C</boot/grub/grub.conf> interactively:"
17668 #: ../fish/guestfish.pod:102
17671 " guestfish --rw --add disk.img \\\n"
17672 " --mount /dev/vg_guest/lv_root \\\n"
17673 " --mount /dev/sda1:/boot \\\n"
17674 " edit /boot/grub/grub.conf\n"
17679 #: ../fish/guestfish.pod:107
17680 msgid "Mount disks automatically"
17684 #: ../fish/guestfish.pod:109
17686 "Use the I<-i> option to automatically mount the disks from a virtual "
17691 #: ../fish/guestfish.pod:112
17694 " guestfish --ro -a disk.img -i cat /etc/group\n"
17699 #: ../fish/guestfish.pod:114
17702 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17707 #: ../fish/guestfish.pod:116
17708 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17712 #: ../fish/guestfish.pod:118
17715 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17720 #: ../fish/guestfish.pod:120
17721 msgid "As a script interpreter"
17725 #: ../fish/guestfish.pod:122
17726 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17730 #: ../fish/guestfish.pod:124
17733 " #!/usr/bin/guestfish -f\n"
17734 " sparse test1.img 100M\n"
17736 " part-disk /dev/sda mbr\n"
17737 " mkfs ext2 /dev/sda1\n"
17742 #: ../fish/guestfish.pod:130
17743 msgid "Start with a prepared disk"
17747 #: ../fish/guestfish.pod:132
17749 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17750 "single ext2-formatted partition:"
17754 #: ../fish/guestfish.pod:135
17757 " guestfish -N fs\n"
17762 #: ../fish/guestfish.pod:137
17763 msgid "To list what is available do:"
17767 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:888
17770 " guestfish -N help | less\n"
17775 #: ../fish/guestfish.pod:141
17776 msgid "Remote control"
17780 #: ../fish/guestfish.pod:143
17783 " eval \"`guestfish --listen`\"\n"
17784 " guestfish --remote add-ro disk.img\n"
17785 " guestfish --remote run\n"
17786 " guestfish --remote lvs\n"
17791 #: ../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
17796 #: ../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
17801 #: ../fish/guestfish.pod:154
17802 msgid "Displays general help on options."
17806 #: ../fish/guestfish.pod:156
17811 #: ../fish/guestfish.pod:158
17812 msgid "B<--cmd-help>"
17816 #: ../fish/guestfish.pod:160
17817 msgid "Lists all available guestfish commands."
17821 #: ../fish/guestfish.pod:162
17826 #: ../fish/guestfish.pod:164
17827 msgid "B<--cmd-help cmd>"
17831 #: ../fish/guestfish.pod:166
17832 msgid "Displays detailed help on a single command C<cmd>."
17836 #: ../fish/guestfish.pod:168
17837 msgid "B<-a image>"
17841 #: ../fish/guestfish.pod:170
17842 msgid "B<--add image>"
17846 #: ../fish/guestfish.pod:172
17847 msgid "Add a block device or virtual machine image to the shell."
17851 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
17853 "The format of the disk image is auto-detected. To override this and force a "
17854 "particular format use the I<--format=..> option."
17858 #: ../fish/guestfish.pod:177
17860 "Using this flag is mostly equivalent to using the C<add> command, with "
17861 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17862 "the I<--format=...> flag was given."
17866 #: ../fish/guestfish.pod:181
17871 #: ../fish/guestfish.pod:183
17872 msgid "B<--connect URI>"
17876 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
17878 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17879 "URI to use. The default is to use the default libvirt connection."
17883 #: ../fish/guestfish.pod:189
17888 #: ../fish/guestfish.pod:191
17890 "If using the I<--listen> option and a csh-like shell, use this option. See "
17891 "section L</REMOTE CONTROL AND CSH> below."
17895 #: ../fish/guestfish.pod:194
17896 msgid "B<-d libvirt-domain>"
17900 #: ../fish/guestfish.pod:196
17901 msgid "B<--domain libvirt-domain>"
17905 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
17907 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17908 "used, then any libvirt domain can be used. However in write mode, only "
17909 "libvirt domains which are shut down can be named here."
17913 #: ../fish/guestfish.pod:202
17915 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17916 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17917 "if the I<--format:...> flag was given."
17921 #: ../fish/guestfish.pod:206
17926 #: ../fish/guestfish.pod:208
17927 msgid "B<--no-dest-paths>"
17931 #: ../fish/guestfish.pod:210
17933 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17934 "to hit the tab key to complete paths on the guest filesystem, but this "
17935 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17936 "allow this feature to be disabled."
17940 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
17941 msgid "B<--echo-keys>"
17945 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
17947 "When prompting for keys and passphrases, guestfish normally turns echoing "
17948 "off so you cannot see what you are typing. If you are not worried about "
17949 "Tempest attacks and there is no one else in the room you can specify this "
17950 "flag to see what you are typing."
17954 #: ../fish/guestfish.pod:222
17959 #: ../fish/guestfish.pod:224
17960 msgid "B<--file file>"
17964 #: ../fish/guestfish.pod:226
17965 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17969 #: ../fish/guestfish.pod:229
17972 " #!/usr/bin/guestfish -f\n"
17977 #: ../fish/guestfish.pod:231
17978 msgid "B<--format=raw|qcow2|..>"
17982 #: ../fish/guestfish.pod:233
17983 msgid "B<--format>"
17987 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
17989 "The default for the I<-a> option is to auto-detect the format of the disk "
17990 "image. Using this forces the disk format for I<-a> options which follow on "
17991 "the command line. Using I<--format> with no argument switches back to "
17992 "auto-detection for subsequent I<-a> options."
17996 #: ../fish/guestfish.pod:242
17999 " guestfish --format=raw -a disk.img\n"
18004 #: ../fish/guestfish.pod:244
18005 msgid "forces raw format (no auto-detection) for C<disk.img>."
18009 #: ../fish/guestfish.pod:246
18012 " guestfish --format=raw -a disk.img --format -a another.img\n"
18017 #: ../fish/guestfish.pod:248
18019 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18020 "auto-detection for C<another.img>."
18024 #: ../fish/guestfish.pod:251
18026 "If you have untrusted raw-format guest disk images, you should use this "
18027 "option to specify the disk format. This avoids a possible security problem "
18028 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18032 #: ../fish/guestfish.pod:256
18037 #: ../fish/guestfish.pod:258
18038 msgid "B<--inspector>"
18042 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18044 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18045 "system and mount filesystems as they would be mounted on the real virtual "
18050 #: ../fish/guestfish.pod:264
18051 msgid "Typical usage is either:"
18055 #: ../fish/guestfish.pod:266
18058 " guestfish -d myguest -i\n"
18063 #: ../fish/guestfish.pod:268
18064 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18068 #: ../fish/guestfish.pod:270
18071 " guestfish --ro -d myguest -i\n"
18076 #: ../fish/guestfish.pod:272
18077 msgid "(for active domains, readonly), or specify the block device directly:"
18081 #: ../fish/guestfish.pod:274
18084 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18089 #: ../fish/guestfish.pod:276
18091 "Note that the command line syntax changed slightly over older versions of "
18092 "guestfish. You can still use the old syntax:"
18096 #: ../fish/guestfish.pod:279
18099 " guestfish [--ro] -i disk.img\n"
18104 #: ../fish/guestfish.pod:281
18107 " guestfish [--ro] -i libvirt-domain\n"
18112 #: ../fish/guestfish.pod:283
18114 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
18115 "then using other commands to mount the filesystems that were found."
18119 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
18120 msgid "B<--keys-from-stdin>"
18124 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
18126 "Read key or passphrase parameters from stdin. The default is to try to read "
18127 "passphrases from the user by opening C</dev/tty>."
18131 #: ../fish/guestfish.pod:292
18132 msgid "B<--listen>"
18136 #: ../fish/guestfish.pod:294
18138 "Fork into the background and listen for remote commands. See section "
18139 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18143 #: ../fish/guestfish.pod:297
18144 msgid "B<-m dev[:mountpoint]>"
18148 #: ../fish/guestfish.pod:299
18149 msgid "B<--mount dev[:mountpoint]>"
18153 #: ../fish/guestfish.pod:301
18154 msgid "Mount the named partition or logical volume on the given mountpoint."
18158 #: ../fish/guestfish.pod:303
18159 msgid "If the mountpoint is omitted, it defaults to C</>."
18163 #: ../fish/guestfish.pod:305
18164 msgid "You have to mount something on C</> before most commands will work."
18168 #: ../fish/guestfish.pod:307
18170 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18175 #: ../fish/guestfish.pod:310
18177 "If you don't know what filesystems a disk image contains, you can either run "
18178 "guestfish without this option, then list the partitions, filesystems and LVs "
18179 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18180 "commands), or you can use the L<virt-filesystems(1)> program."
18184 #: ../fish/guestfish.pod:316
18186 "Using this flag is mostly equivalent to using the C<mount-options> command "
18187 "or the C<mount-ro> command if the I<--ro> flag was given."
18191 #: ../fish/guestfish.pod:319
18196 #: ../fish/guestfish.pod:321
18197 msgid "B<--no-sync>"
18201 #: ../fish/guestfish.pod:323
18203 "Disable autosync. This is enabled by default. See the discussion of "
18204 "autosync in the L<guestfs(3)> manpage."
18208 #: ../fish/guestfish.pod:326
18213 #: ../fish/guestfish.pod:328
18214 msgid "B<--new type>"
18218 #: ../fish/guestfish.pod:330
18223 #: ../fish/guestfish.pod:332
18225 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18226 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18227 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18232 #: ../fish/guestfish.pod:337
18233 msgid "B<--progress-bars>"
18237 #: ../fish/guestfish.pod:339
18238 msgid "Enable progress bars, even when guestfish is used non-interactively."
18242 #: ../fish/guestfish.pod:341
18244 "Progress bars are enabled by default when guestfish is used as an "
18245 "interactive shell."
18249 #: ../fish/guestfish.pod:344
18250 msgid "B<--no-progress-bars>"
18254 #: ../fish/guestfish.pod:346
18255 msgid "Disable progress bars."
18259 #: ../fish/guestfish.pod:348
18260 msgid "B<--remote[=pid]>"
18264 #: ../fish/guestfish.pod:350
18266 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18267 "CONTROL GUESTFISH OVER A SOCKET> below."
18271 #: ../fish/guestfish.pod:353
18276 #: ../fish/guestfish.pod:355
18281 #: ../fish/guestfish.pod:357
18283 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18284 "mounts are done read-only."
18288 #: ../fish/guestfish.pod:360
18290 "The option must always be used if the disk image or virtual machine might be "
18291 "running, and is generally recommended in cases where you don't need write "
18292 "access to the disk."
18296 #: ../fish/guestfish.pod:364
18298 "Note that prepared disk images created with I<-N> are not affected by this "
18299 "option. Also commands like C<add> are not affected - you have to specify "
18300 "the C<readonly:true> option explicitly if you need it."
18304 #: ../fish/guestfish.pod:368
18305 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18309 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
18310 msgid "B<--selinux>"
18314 #: ../fish/guestfish.pod:372
18315 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18319 #: ../fish/guestfish.pod:374
18324 #: ../fish/guestfish.pod:376
18325 msgid "B<--verbose>"
18329 #: ../fish/guestfish.pod:378
18331 "Enable very verbose messages. This is particularly useful if you find a "
18336 #: ../fish/guestfish.pod:381
18341 #: ../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
18342 msgid "B<--version>"
18346 #: ../fish/guestfish.pod:385
18347 msgid "Display the guestfish / libguestfs version number and exit."
18351 #: ../fish/guestfish.pod:387
18356 #: ../fish/guestfish.pod:389
18361 #: ../fish/guestfish.pod:391
18363 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
18368 #: ../fish/guestfish.pod:394
18373 #: ../fish/guestfish.pod:396
18374 msgid "Echo each command before executing it."
18378 #: ../fish/guestfish.pod:400
18379 msgid "COMMANDS ON COMMAND LINE"
18383 #: ../fish/guestfish.pod:402
18384 msgid "Any additional (non-option) arguments are treated as commands to execute."
18388 #: ../fish/guestfish.pod:405
18390 "Commands to execute should be separated by a colon (C<:>), where the colon "
18391 "is a separate parameter. Thus:"
18395 #: ../fish/guestfish.pod:408
18398 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18403 #: ../fish/guestfish.pod:410
18405 "If there are no additional arguments, then we enter a shell, either an "
18406 "interactive shell with a prompt (if the input is a terminal) or a "
18407 "non-interactive shell."
18411 #: ../fish/guestfish.pod:414
18413 "In either command line mode or non-interactive shell, the first command that "
18414 "gives an error causes the whole shell to exit. In interactive mode (with a "
18415 "prompt) if a command fails, you can continue to enter commands."
18419 #: ../fish/guestfish.pod:419
18420 msgid "USING launch (OR run)"
18424 #: ../fish/guestfish.pod:421
18426 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18427 "then launch it, then mount any disks you need, and finally issue "
18428 "actions/commands. So the general order of the day is:"
18432 #: ../fish/guestfish.pod:429
18433 msgid "add or -a/--add"
18437 #: ../fish/guestfish.pod:433
18438 msgid "launch (aka run)"
18442 #: ../fish/guestfish.pod:437
18443 msgid "mount or -m/--mount"
18447 #: ../fish/guestfish.pod:441
18448 msgid "any other commands"
18452 #: ../fish/guestfish.pod:445
18454 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18455 "guest before mounting or performing any other commands."
18459 #: ../fish/guestfish.pod:448
18461 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18462 "I<--new> options were given then C<run> is done automatically, simply "
18463 "because guestfish can't perform the action you asked for without doing this."
18467 #: ../fish/guestfish.pod:453
18468 msgid "OPENING DISKS FOR READ AND WRITE"
18472 #: ../fish/guestfish.pod:455
18474 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
18475 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
18476 "open disk images read-only or for writing."
18480 #: ../fish/guestfish.pod:459
18482 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
18483 "disk images supplied on the command line for write. To open a disk image "
18484 "read-only you have to do I<-a image --ro>."
18488 #: ../fish/guestfish.pod:463
18490 "This matters: If you accidentally open a live VM disk image writable then "
18491 "you will cause irreversible disk corruption."
18495 #: ../fish/guestfish.pod:466
18497 "By libguestfs 1.10 we intend to change the default the other way. Disk "
18498 "images will be opened read-only. You will have to either specify "
18499 "I<guestfish --rw> or change a configuration file in order to get write "
18500 "access for disk images specified by those other command line options."
18504 #: ../fish/guestfish.pod:471
18506 "This version of guestfish has a I<--rw> option which does nothing (it is "
18507 "already the default). However it is highly recommended that you use this "
18508 "option to indicate that guestfish needs write access, and to prepare your "
18509 "scripts for the day when this option will be required for write access."
18513 #: ../fish/guestfish.pod:477
18515 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18516 "other libguestfs program apart from guestfish and guestmount."
18520 #: ../fish/guestfish.pod:480
18525 #: ../fish/guestfish.pod:482
18527 "You can quote ordinary parameters using either single or double quotes. For "
18532 #: ../fish/guestfish.pod:485
18535 " add \"file with a space.img\"\n"
18540 #: ../fish/guestfish.pod:487
18543 " rm '/file name'\n"
18548 #: ../fish/guestfish.pod:489
18556 #: ../fish/guestfish.pod:491
18558 "A few commands require a list of strings to be passed. For these, use a "
18559 "whitespace-separated list, enclosed in quotes. Strings containing "
18560 "whitespace to be passed through must be enclosed in single quotes. A "
18561 "literal single quote must be escaped with a backslash."
18565 #: ../fish/guestfish.pod:496
18568 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18569 " command \"/bin/echo 'foo bar'\"\n"
18570 " command \"/bin/echo \\'foo\\'\"\n"
18575 #: ../fish/guestfish.pod:500
18576 msgid "OPTIONAL ARGUMENTS"
18580 #: ../fish/guestfish.pod:502
18582 "Some commands take optional arguments. These arguments appear in this "
18583 "documentation as C<[argname:..]>. You can use them as in these examples:"
18587 #: ../fish/guestfish.pod:506
18590 " add-drive-opts filename\n"
18595 #: ../fish/guestfish.pod:508
18598 " add-drive-opts filename readonly:true\n"
18603 #: ../fish/guestfish.pod:510
18606 " add-drive-opts filename format:qcow2 readonly:false\n"
18611 #: ../fish/guestfish.pod:512
18613 "Each optional argument can appear at most once. All optional arguments must "
18614 "appear after the required ones."
18618 #: ../fish/guestfish.pod:515
18623 #: ../fish/guestfish.pod:517
18624 msgid "This section applies to all commands which can take integers as parameters."
18628 #: ../fish/guestfish.pod:520
18629 msgid "SIZE SUFFIX"
18633 #: ../fish/guestfish.pod:522
18635 "When the command takes a parameter measured in bytes, you can use one of the "
18636 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18640 #: ../fish/guestfish.pod:528
18641 msgid "B<k> or B<K> or B<KiB>"
18645 #: ../fish/guestfish.pod:530
18646 msgid "The size in kilobytes (multiplied by 1024)."
18650 #: ../fish/guestfish.pod:532
18655 #: ../fish/guestfish.pod:534
18656 msgid "The size in SI 1000 byte units."
18660 #: ../fish/guestfish.pod:536
18661 msgid "B<M> or B<MiB>"
18665 #: ../fish/guestfish.pod:538
18666 msgid "The size in megabytes (multiplied by 1048576)."
18670 #: ../fish/guestfish.pod:540
18675 #: ../fish/guestfish.pod:542
18676 msgid "The size in SI 1000000 byte units."
18680 #: ../fish/guestfish.pod:544
18681 msgid "B<G> or B<GiB>"
18685 #: ../fish/guestfish.pod:546
18686 msgid "The size in gigabytes (multiplied by 2**30)."
18690 #: ../fish/guestfish.pod:548
18695 #: ../fish/guestfish.pod:550
18696 msgid "The size in SI 10**9 byte units."
18700 #: ../fish/guestfish.pod:552
18701 msgid "B<T> or B<TiB>"
18705 #: ../fish/guestfish.pod:554
18706 msgid "The size in terabytes (multiplied by 2**40)."
18710 #: ../fish/guestfish.pod:556
18715 #: ../fish/guestfish.pod:558
18716 msgid "The size in SI 10**12 byte units."
18720 #: ../fish/guestfish.pod:560
18721 msgid "B<P> or B<PiB>"
18725 #: ../fish/guestfish.pod:562
18726 msgid "The size in petabytes (multiplied by 2**50)."
18730 #: ../fish/guestfish.pod:564
18735 #: ../fish/guestfish.pod:566
18736 msgid "The size in SI 10**15 byte units."
18740 #: ../fish/guestfish.pod:568
18741 msgid "B<E> or B<EiB>"
18745 #: ../fish/guestfish.pod:570
18746 msgid "The size in exabytes (multiplied by 2**60)."
18750 #: ../fish/guestfish.pod:572
18755 #: ../fish/guestfish.pod:574
18756 msgid "The size in SI 10**18 byte units."
18760 #: ../fish/guestfish.pod:576
18761 msgid "B<Z> or B<ZiB>"
18765 #: ../fish/guestfish.pod:578
18766 msgid "The size in zettabytes (multiplied by 2**70)."
18770 #: ../fish/guestfish.pod:580
18775 #: ../fish/guestfish.pod:582
18776 msgid "The size in SI 10**21 byte units."
18780 #: ../fish/guestfish.pod:584
18781 msgid "B<Y> or B<YiB>"
18785 #: ../fish/guestfish.pod:586
18786 msgid "The size in yottabytes (multiplied by 2**80)."
18790 #: ../fish/guestfish.pod:588
18795 #: ../fish/guestfish.pod:590
18796 msgid "The size in SI 10**24 byte units."
18800 #: ../fish/guestfish.pod:596
18803 " truncate-size /file 1G\n"
18808 #: ../fish/guestfish.pod:598
18809 msgid "would truncate the file to 1 gigabyte."
18813 #: ../fish/guestfish.pod:600
18815 "Be careful because a few commands take sizes in kilobytes or megabytes "
18816 "(eg. the parameter to L</memsize> is specified in megabytes already). "
18817 "Adding a suffix will probably not do what you expect."
18821 #: ../fish/guestfish.pod:604
18822 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18826 #: ../fish/guestfish.pod:606
18828 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18829 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18833 #: ../fish/guestfish.pod:609
18836 " 1234 decimal number 1234\n"
18837 " 02322 octal number, equivalent to decimal 1234\n"
18838 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18843 #: ../fish/guestfish.pod:613
18845 "When using the C<chmod> command, you almost always want to specify an octal "
18846 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18847 "L<chmod(1)> program):"
18851 #: ../fish/guestfish.pod:617
18854 " chmod 0777 /public # OK\n"
18855 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18860 #: ../fish/guestfish.pod:620
18862 "Commands that return numbers usually print them in decimal, but some "
18863 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18864 "octal, preceeded by C<0>)."
18868 #: ../fish/guestfish.pod:624
18869 msgid "WILDCARDS AND GLOBBING"
18873 #: ../fish/guestfish.pod:626
18875 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18876 "(globbing) by default. So for example the following will not do what you "
18881 #: ../fish/guestfish.pod:630
18889 #: ../fish/guestfish.pod:632
18891 "Assuming you don't have a directory called literally C</home/*> then the "
18892 "above command will return an error."
18896 #: ../fish/guestfish.pod:635
18897 msgid "To perform wildcard expansion, use the C<glob> command."
18901 #: ../fish/guestfish.pod:637
18904 " glob rm-rf /home/*\n"
18909 #: ../fish/guestfish.pod:639
18911 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18912 "many times), equivalent to:"
18916 #: ../fish/guestfish.pod:642
18919 " rm-rf /home/jim\n"
18920 " rm-rf /home/joe\n"
18921 " rm-rf /home/mary\n"
18926 #: ../fish/guestfish.pod:646
18927 msgid "C<glob> only works on simple guest paths and not on device names."
18931 #: ../fish/guestfish.pod:648
18933 "If you have several parameters, each containing a wildcard, then glob will "
18934 "perform a Cartesian product."
18938 #: ../fish/guestfish.pod:651
18943 #: ../fish/guestfish.pod:653
18945 "Any line which starts with a I<#> character is treated as a comment and "
18946 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18947 "a command. For example:"
18951 #: ../fish/guestfish.pod:657
18954 " # this is a comment\n"
18955 " # this is a comment\n"
18956 " foo # NOT a comment\n"
18961 #: ../fish/guestfish.pod:661
18962 msgid "Blank lines are also ignored."
18966 #: ../fish/guestfish.pod:663
18967 msgid "RUNNING COMMANDS LOCALLY"
18971 #: ../fish/guestfish.pod:665
18973 "Any line which starts with a I<!> character is treated as a command sent to "
18974 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18978 #: ../fish/guestfish.pod:669
18982 " tgz-out /remote local/remote-data.tar.gz\n"
18987 #: ../fish/guestfish.pod:672
18989 "will create a directory C<local> on the host, and then export the contents "
18990 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18991 "(See C<tgz-out>)."
18995 #: ../fish/guestfish.pod:676
18997 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18998 "effect, due to the way that subprocesses work in Unix."
19002 #: ../fish/guestfish.pod:679
19007 #: ../fish/guestfish.pod:681
19009 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19010 "command (a guestfish command) to the second command (any host command). For "
19015 #: ../fish/guestfish.pod:685
19018 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19023 #: ../fish/guestfish.pod:687
19025 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19026 "program). The above command would list all accounts in the guest filesystem "
19027 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19031 #: ../fish/guestfish.pod:692
19034 " hexdump /bin/ls | head\n"
19035 " list-devices | tail -1\n"
19036 " tgz-out / - | tar ztf -\n"
19041 #: ../fish/guestfish.pod:696
19043 "The space before the pipe symbol is required, any space after the pipe "
19044 "symbol is optional. Everything after the pipe symbol is just passed "
19045 "straight to the host shell, so it can contain redirections, globs and "
19046 "anything else that makes sense on the host side."
19050 #: ../fish/guestfish.pod:701
19052 "To use a literal argument which begins with a pipe symbol, you have to quote "
19057 #: ../fish/guestfish.pod:704
19065 #: ../fish/guestfish.pod:706
19066 msgid "HOME DIRECTORIES"
19070 #: ../fish/guestfish.pod:708
19072 "If a parameter starts with the character C<~> then the tilde may be expanded "
19073 "as a home directory path (either C<~> for the current user's home directory, "
19074 "or C<~user> for another user)."
19078 #: ../fish/guestfish.pod:712
19080 "Note that home directory expansion happens for users known I<on the host>, "
19081 "not in the guest filesystem."
19085 #: ../fish/guestfish.pod:715
19087 "To use a literal argument which begins with a tilde, you have to quote it, "
19092 #: ../fish/guestfish.pod:718
19100 #: ../fish/guestfish.pod:722
19102 "Libguestfs has some support for Linux guests encrypted according to the "
19103 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19104 "disk encryption systems used by modern Linux guests. Currently only "
19105 "LVM-on-LUKS is supported."
19109 #: ../fish/guestfish.pod:727
19110 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19114 #: ../fish/guestfish.pod:729
19117 " ><fs> vfs-type /dev/sda2\n"
19123 #: ../fish/guestfish.pod:732
19125 "Then open those devices using L</luks-open>. This creates a device-mapper "
19126 "device called C</dev/mapper/luksdev>."
19130 #: ../fish/guestfish.pod:735
19133 " ><fs> luks-open /dev/sda2 luksdev\n"
19134 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19139 #: ../fish/guestfish.pod:738
19141 "Finally you have to tell LVM to scan for volume groups on the newly created "
19146 #: ../fish/guestfish.pod:741
19150 " vg-activate-all true\n"
19155 #: ../fish/guestfish.pod:744
19156 msgid "The logical volume(s) can now be mounted in the usual way."
19160 #: ../fish/guestfish.pod:746
19162 "Before closing a LUKS device you must unmount any logical volumes on it and "
19163 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19164 "one. Then you can close the mapper device:"
19168 #: ../fish/guestfish.pod:750
19171 " vg-activate false /dev/VG\n"
19172 " luks-close /dev/mapper/luksdev\n"
19177 #: ../fish/guestfish.pod:753
19178 msgid "WINDOWS PATHS"
19182 #: ../fish/guestfish.pod:755
19184 "If a path is prefixed with C<win:> then you can use Windows-style paths "
19185 "(with some limitations). The following commands are equivalent:"
19189 #: ../fish/guestfish.pod:758
19192 " file /WINDOWS/system32/config/system.LOG\n"
19197 #: ../fish/guestfish.pod:760
19200 " file win:/windows/system32/config/system.log\n"
19205 #: ../fish/guestfish.pod:762
19208 " file win:\\windows\\system32\\config\\system.log\n"
19213 #: ../fish/guestfish.pod:764
19216 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
19221 #: ../fish/guestfish.pod:766
19223 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
19224 "handles case insensitivity like Windows would. This only works in argument "
19225 "positions that expect a path."
19229 #: ../fish/guestfish.pod:770
19230 msgid "UPLOADING AND DOWNLOADING FILES"
19234 #: ../fish/guestfish.pod:772
19236 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19237 "others which upload from or download to a local file, you can use the "
19238 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19242 #: ../fish/guestfish.pod:776
19250 #: ../fish/guestfish.pod:778
19251 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19255 #: ../fish/guestfish.pod:781
19258 " tar-out /etc - | tar tf -\n"
19263 #: ../fish/guestfish.pod:783
19265 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19266 "command (see L</PIPES>)."
19270 #: ../fish/guestfish.pod:786
19272 "When using C<-> to read from stdin, the input is read up to the end of "
19273 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19274 "some arbitrary end marker:"
19278 #: ../fish/guestfish.pod:790
19281 " upload -<<END /foo\n"
19290 #: ../fish/guestfish.pod:796
19292 "Any string of characters can be used instead of C<END>. The end marker must "
19293 "appear on a line of its own, without any preceeding or following characters "
19294 "(not even spaces)."
19298 #: ../fish/guestfish.pod:800
19300 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19301 "upload local files (so-called \"FileIn\" parameters in the generator)."
19305 #: ../fish/guestfish.pod:803
19306 msgid "EXIT ON ERROR BEHAVIOUR"
19310 #: ../fish/guestfish.pod:805
19312 "By default, guestfish will ignore any errors when in interactive mode "
19313 "(ie. taking commands from a human over a tty), and will exit on the first "
19314 "error in non-interactive mode (scripts, commands given on the command line)."
19318 #: ../fish/guestfish.pod:810
19320 "If you prefix a command with a I<-> character, then that command will not "
19321 "cause guestfish to exit, even if that (one) command returns an error."
19325 #: ../fish/guestfish.pod:814
19326 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19330 #: ../fish/guestfish.pod:816
19332 "Guestfish can be remote-controlled over a socket. This is useful "
19333 "particularly in shell scripts where you want to make several different "
19334 "changes to a filesystem, but you don't want the overhead of starting up a "
19335 "guestfish process each time."
19339 #: ../fish/guestfish.pod:821
19340 msgid "Start a guestfish server process using:"
19344 #: ../fish/guestfish.pod:823
19347 " eval \"`guestfish --listen`\"\n"
19352 #: ../fish/guestfish.pod:825
19353 msgid "and then send it commands by doing:"
19357 #: ../fish/guestfish.pod:827
19360 " guestfish --remote cmd [...]\n"
19365 #: ../fish/guestfish.pod:829
19366 msgid "To cause the server to exit, send it the exit command:"
19370 #: ../fish/guestfish.pod:831
19373 " guestfish --remote exit\n"
19378 #: ../fish/guestfish.pod:833
19380 "Note that the server will normally exit if there is an error in a command. "
19381 "You can change this in the usual way. See section L</EXIT ON ERROR "
19386 #: ../fish/guestfish.pod:837
19387 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19391 #: ../fish/guestfish.pod:839
19393 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19394 "is how the I<--remote> option knows where to send the commands. You can "
19395 "have several guestfish listener processes running using:"
19399 #: ../fish/guestfish.pod:843
19402 " eval \"`guestfish --listen`\"\n"
19403 " pid1=$GUESTFISH_PID\n"
19404 " eval \"`guestfish --listen`\"\n"
19405 " pid2=$GUESTFISH_PID\n"
19407 " guestfish --remote=$pid1 cmd\n"
19408 " guestfish --remote=$pid2 cmd\n"
19413 #: ../fish/guestfish.pod:851
19414 msgid "REMOTE CONTROL AND CSH"
19418 #: ../fish/guestfish.pod:853
19420 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19425 #: ../fish/guestfish.pod:856
19428 " eval \"`guestfish --listen --csh`\"\n"
19433 #: ../fish/guestfish.pod:858
19434 msgid "REMOTE CONTROL DETAILS"
19438 #: ../fish/guestfish.pod:860
19440 "Remote control happens over a Unix domain socket called "
19441 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19442 "of the process, and C<$PID> is the process ID of the server."
19446 #: ../fish/guestfish.pod:864
19447 msgid "Guestfish client and server versions must match exactly."
19451 #: ../fish/guestfish.pod:866
19452 msgid "PREPARED DISK IMAGES"
19456 #: ../fish/guestfish.pod:868
19458 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19459 "preformatted disk images that guestfish can make for you to save typing. "
19460 "This is particularly useful for testing purposes. This option is used "
19461 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19462 "can be mixed with I<-a>)."
19466 #: ../fish/guestfish.pod:874
19468 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19469 "the second and so on. Existing files in the current directory are "
19474 #: ../fish/guestfish.pod:878
19476 "The type briefly describes how the disk should be sized, partitioned, how "
19477 "filesystem(s) should be created, and how content should be added. "
19478 "Optionally the type can be followed by extra parameters, separated by C<:> "
19479 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19480 "sparsely-allocated disk, containing a single partition, with the partition "
19481 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19482 "on a 1GB disk instead."
19486 #: ../fish/guestfish.pod:886
19487 msgid "To list the available types and any extra parameters they take, run:"
19491 #: ../fish/guestfish.pod:890
19493 "Note that the prepared filesystem is not mounted. You would usually have to "
19494 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19498 #: ../fish/guestfish.pod:894
19500 "If any I<-N> or I<--new> options are given, the guest is automatically "
19505 #: ../fish/guestfish.pod:899
19506 msgid "Create a 100MB disk with an ext4-formatted partition:"
19510 #: ../fish/guestfish.pod:901
19513 " guestfish -N fs:ext4\n"
19518 #: ../fish/guestfish.pod:903
19519 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19523 #: ../fish/guestfish.pod:905
19526 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19531 #: ../fish/guestfish.pod:907
19532 msgid "Create a blank 200MB disk:"
19536 #: ../fish/guestfish.pod:909
19539 " guestfish -N disk:200M\n"
19544 #: ../fish/guestfish.pod:911
19545 msgid "PROGRESS BARS"
19549 #: ../fish/guestfish.pod:913
19551 "Some (not all) long-running commands send progress notification messages as "
19552 "they are running. Guestfish turns these messages into progress bars."
19556 #: ../fish/guestfish.pod:917
19558 "When a command that supports progress bars takes longer than two seconds to "
19559 "run, and if progress bars are enabled, then you will see one appearing below "
19564 #: ../fish/guestfish.pod:921
19567 " ><fs> copy-size /large-file /another-file 2048M\n"
19568 " / 10% [#####-----------------------------------------] 00:30\n"
19573 #: ../fish/guestfish.pod:924
19575 "The spinner on the left hand side moves round once for every progress "
19576 "notification received from the backend. This is a (reasonably) golden "
19577 "assurance that the command is \"doing something\" even if the progress bar "
19578 "is not moving, because the command is able to send the progress "
19579 "notifications. When the bar reaches 100% and the command finishes, the "
19580 "spinner disappears."
19584 #: ../fish/guestfish.pod:931
19586 "Progress bars are enabled by default when guestfish is used interactively. "
19587 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19588 "and you can disable them completely using I<--no-progress-bars>."
19592 #: ../fish/guestfish.pod:936
19593 msgid "GUESTFISH COMMANDS"
19597 #: ../fish/guestfish.pod:938
19599 "The commands in this section are guestfish convenience commands, in other "
19600 "words, they are not part of the L<guestfs(3)> API."
19604 #: ../fish/guestfish.pod:941
19609 #: ../fish/guestfish.pod:943
19618 #: ../fish/guestfish.pod:946
19619 msgid "Without any parameter, this provides general help."
19623 #: ../fish/guestfish.pod:948
19624 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19628 #: ../fish/guestfish.pod:950
19629 msgid "quit | exit"
19633 #: ../fish/guestfish.pod:952
19634 msgid "This exits guestfish. You can also use C<^D> key."
19638 #: ../fish/guestfish.pod:954
19639 msgid "@FISH_COMMANDS@"
19643 #: ../fish/guestfish.pod:956
19648 #: ../fish/guestfish.pod:960 ../test-tool/libguestfs-test-tool.pod:83
19653 #: ../fish/guestfish.pod:962
19655 "guestfish returns 0 if the commands completed without error, or 1 if there "
19660 #: ../fish/guestfish.pod:969
19665 #: ../fish/guestfish.pod:971
19667 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19672 #: ../fish/guestfish.pod:974
19673 msgid "GUESTFISH_PID"
19677 #: ../fish/guestfish.pod:976
19679 "Used with the I<--remote> option to specify the remote guestfish process to "
19680 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19684 #: ../fish/guestfish.pod:980
19689 #: ../fish/guestfish.pod:982
19691 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19692 "not specified, the external L<hexedit(1)> program is used."
19696 #: ../fish/guestfish.pod:986
19701 #: ../fish/guestfish.pod:988
19703 "If compiled with GNU readline support, various files in the home directory "
19704 "can be used. See L</FILES>."
19708 #: ../fish/guestfish.pod:997
19710 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19711 "effect as using the B<-v> option."
19715 #: ../fish/guestfish.pod:1009
19717 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19718 "the discussion of paths in L<guestfs(3)>."
19722 #: ../fish/guestfish.pod:1020
19723 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19727 #: ../fish/guestfish.pod:1022
19732 #: ../fish/guestfish.pod:1024
19734 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19739 #: ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:88
19744 #: ../fish/guestfish.pod:1043
19745 msgid "$HOME/.guestfish"
19749 #: ../fish/guestfish.pod:1045
19751 "If compiled with GNU readline support, then the command history is saved in "
19756 #: ../fish/guestfish.pod:1048
19757 msgid "$HOME/.inputrc"
19761 #: ../fish/guestfish.pod:1050
19762 msgid "/etc/inputrc"
19766 #: ../fish/guestfish.pod:1052
19768 "If compiled with GNU readline support, then these files can be used to "
19769 "configure readline. For further information, please see "
19770 "L<readline(3)/INITIALIZATION FILE>."
19774 #: ../fish/guestfish.pod:1056
19775 msgid "To write rules which only apply to guestfish, use:"
19779 #: ../fish/guestfish.pod:1058
19789 #: ../fish/guestfish.pod:1062
19791 "Variables that you can set in inputrc that change the behaviour of guestfish "
19792 "in useful ways include:"
19796 #: ../fish/guestfish.pod:1067
19797 msgid "completion-ignore-case (default: on)"
19801 #: ../fish/guestfish.pod:1069
19803 "By default, guestfish will ignore case when tab-completing paths on the "
19808 #: ../fish/guestfish.pod:1072
19811 " set completion-ignore-case off\n"
19816 #: ../fish/guestfish.pod:1074
19817 msgid "to make guestfish case sensitive."
19821 #: ../fish/guestfish.pod:1078
19826 #: ../fish/guestfish.pod:1080
19827 msgid "test2.img (etc)"
19831 #: ../fish/guestfish.pod:1082
19833 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19834 "will be created in the file C<test1.img> in the current directory. The "
19835 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19836 "the same name will be overwritten."
19840 #: ../fish/guestfish.pod:1091
19842 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19843 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
19844 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
19845 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
19846 "L<virt-win-reg(1)>, L<hexedit(1)>."
19850 #: ../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
19852 "This program is free software; you can redistribute it and/or modify it "
19853 "under the terms of the GNU General Public License as published by the Free "
19854 "Software Foundation; either version 2 of the License, or (at your option) "
19855 "any later version."
19859 #: ../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
19861 "This program is distributed in the hope that it will be useful, but WITHOUT "
19862 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19863 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19868 #: ../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
19870 "You should have received a copy of the GNU General Public License along with "
19871 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19872 "Ave, Cambridge, MA 02139, USA."
19876 #: ../fish/guestfish-actions.pod:1
19881 #: ../fish/guestfish-actions.pod:3
19884 " add-cdrom filename\n"
19889 #: ../fish/guestfish-actions.pod:15
19891 "This call checks for the existence of C<filename>. This stops you from "
19892 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19893 "and C<http:> URLs. To specify those, use the general L</config> call "
19898 #: ../fish/guestfish-actions.pod:22
19900 "If you just want to add an ISO file (often you use this as an efficient way "
19901 "to transfer large files into the guest), then you should probably use "
19902 "L</add-drive-ro> instead."
19906 #: ../fish/guestfish-actions.pod:35
19911 #: ../fish/guestfish-actions.pod:37
19916 #: ../fish/guestfish-actions.pod:39
19919 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19924 #: ../fish/guestfish-actions.pod:41
19926 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19927 "It works by connecting to libvirt, requesting the domain and domain XML from "
19928 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19932 #: ../fish/guestfish-actions.pod:64
19934 "The other optional parameters are passed directly through to "
19935 "L</add-drive-opts>."
19939 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131 ../fish/guestfish-actions.pod:2848
19941 "This command has one or more optional arguments. See L</OPTIONAL "
19946 #: ../fish/guestfish-actions.pod:69
19951 #: ../fish/guestfish-actions.pod:71
19954 " add-drive filename\n"
19959 #: ../fish/guestfish-actions.pod:73
19961 "This function is the equivalent of calling L</add-drive-opts> with no "
19962 "optional parameters, so the disk is added writable, with the format being "
19963 "detected automatically."
19967 #: ../fish/guestfish-actions.pod:77
19969 "Automatic detection of the format opens you up to a potential security hole "
19970 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19971 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19972 "you should think about replacing calls to this function with calls to "
19973 "L</add-drive-opts>, and specifying the format."
19977 #: ../fish/guestfish-actions.pod:84
19978 msgid "add-drive-opts"
19982 #: ../fish/guestfish-actions.pod:86
19987 #: ../fish/guestfish-actions.pod:88
19990 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19995 #: ../fish/guestfish-actions.pod:115
19997 "This forces the image format. If you omit this (or use L</add-drive> or "
19998 "L</add-drive-ro>) then the format is automatically detected. Possible "
19999 "formats include C<raw> and C<qcow2>."
20003 #: ../fish/guestfish-actions.pod:126
20005 "This rarely-used option lets you emulate the behaviour of the deprecated "
20006 "L</add-drive-with-if> call (q.v.)"
20010 #: ../fish/guestfish-actions.pod:133
20011 msgid "add-drive-ro"
20015 #: ../fish/guestfish-actions.pod:135
20020 #: ../fish/guestfish-actions.pod:137
20023 " add-drive-ro filename\n"
20028 #: ../fish/guestfish-actions.pod:139
20030 "This function is the equivalent of calling L</add-drive-opts> with the "
20031 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20032 "is added read-only, with the format being detected automatically."
20036 #: ../fish/guestfish-actions.pod:144
20037 msgid "add-drive-ro-with-if"
20041 #: ../fish/guestfish-actions.pod:146
20044 " add-drive-ro-with-if filename iface\n"
20049 #: ../fish/guestfish-actions.pod:148
20051 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
20052 "interface emulation to use at run time."
20056 #: ../fish/guestfish-actions.pod:158
20057 msgid "add-drive-with-if"
20061 #: ../fish/guestfish-actions.pod:160
20064 " add-drive-with-if filename iface\n"
20069 #: ../fish/guestfish-actions.pod:162
20071 "This is the same as L</add-drive> but it allows you to specify the QEMU "
20072 "interface emulation to use at run time."
20076 #: ../fish/guestfish-actions.pod:172
20081 #: ../fish/guestfish-actions.pod:174
20084 " aug-clear augpath\n"
20089 #: ../fish/guestfish-actions.pod:179
20094 #: ../fish/guestfish-actions.pod:181
20102 #: ../fish/guestfish-actions.pod:183
20104 "Close the current Augeas handle and free up any resources used by it. After "
20105 "calling this, you have to call L</aug-init> again before you can use any "
20106 "other Augeas functions."
20110 #: ../fish/guestfish-actions.pod:188
20111 msgid "aug-defnode"
20115 #: ../fish/guestfish-actions.pod:190
20118 " aug-defnode name expr val\n"
20123 #: ../fish/guestfish-actions.pod:195
20125 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
20126 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
20127 "containing that single node."
20131 #: ../fish/guestfish-actions.pod:203
20136 #: ../fish/guestfish-actions.pod:205
20139 " aug-defvar name expr\n"
20144 #: ../fish/guestfish-actions.pod:214
20149 #: ../fish/guestfish-actions.pod:216
20152 " aug-get augpath\n"
20157 #: ../fish/guestfish-actions.pod:221
20162 #: ../fish/guestfish-actions.pod:223
20165 " aug-init root flags\n"
20170 #: ../fish/guestfish-actions.pod:229
20171 msgid "You must call this before using any other L</aug-*> commands."
20175 #: ../fish/guestfish-actions.pod:264
20176 msgid "Do not load the tree in L</aug-init>."
20180 #: ../fish/guestfish-actions.pod:268
20181 msgid "To close the handle, you can call L</aug-close>."
20185 #: ../fish/guestfish-actions.pod:272
20190 #: ../fish/guestfish-actions.pod:274
20193 " aug-insert augpath label true|false\n"
20198 #: ../fish/guestfish-actions.pod:284
20203 #: ../fish/guestfish-actions.pod:286
20211 #: ../fish/guestfish-actions.pod:293
20216 #: ../fish/guestfish-actions.pod:295
20219 " aug-ls augpath\n"
20224 #: ../fish/guestfish-actions.pod:297
20226 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
20227 "resulting nodes into alphabetical order."
20231 #: ../fish/guestfish-actions.pod:300
20236 #: ../fish/guestfish-actions.pod:302
20239 " aug-match augpath\n"
20244 #: ../fish/guestfish-actions.pod:308
20249 #: ../fish/guestfish-actions.pod:310
20252 " aug-mv src dest\n"
20257 #: ../fish/guestfish-actions.pod:315
20262 #: ../fish/guestfish-actions.pod:317
20265 " aug-rm augpath\n"
20270 #: ../fish/guestfish-actions.pod:323
20275 #: ../fish/guestfish-actions.pod:325
20283 #: ../fish/guestfish-actions.pod:329
20285 "The flags which were passed to L</aug-init> affect exactly how files are "
20290 #: ../fish/guestfish-actions.pod:332
20295 #: ../fish/guestfish-actions.pod:334
20298 " aug-set augpath val\n"
20303 #: ../fish/guestfish-actions.pod:338
20305 "In the Augeas API, it is possible to clear a node by setting the value to "
20306 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
20307 "this call. Instead you must use the L</aug-clear> call."
20311 #: ../fish/guestfish-actions.pod:343
20316 #: ../fish/guestfish-actions.pod:345
20319 " available 'groups ...'\n"
20324 #: ../fish/guestfish-actions.pod:351
20326 "The libguestfs groups, and the functions that those groups correspond to, "
20327 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
20328 "runtime by calling L</available-all-groups>."
20332 #: ../fish/guestfish-actions.pod:375
20333 msgid "You must call L</launch> before calling this function."
20337 #: ../fish/guestfish-actions.pod:397
20339 "This call was added in version C<1.0.80>. In previous versions of "
20340 "libguestfs all you could do would be to speculatively execute a command to "
20341 "find out if the daemon implemented it. See also L</version>."
20345 #: ../fish/guestfish-actions.pod:404
20346 msgid "available-all-groups"
20350 #: ../fish/guestfish-actions.pod:406
20353 " available-all-groups\n"
20358 #: ../fish/guestfish-actions.pod:408
20360 "This command returns a list of all optional groups that this daemon knows "
20361 "about. Note this returns both supported and unsupported groups. To find "
20362 "out which ones the daemon can actually support you have to call "
20363 "L</available> on each member of the returned list."
20367 #: ../fish/guestfish-actions.pod:414
20368 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
20372 #: ../fish/guestfish-actions.pod:416
20377 #: ../fish/guestfish-actions.pod:418
20380 " base64-in (base64file|-) filename\n"
20385 #: ../fish/guestfish-actions.pod:423 ../fish/guestfish-actions.pod:432 ../fish/guestfish-actions.pod:656 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:844 ../fish/guestfish-actions.pod:1221 ../fish/guestfish-actions.pod:4203 ../fish/guestfish-actions.pod:4215 ../fish/guestfish-actions.pod:4226 ../fish/guestfish-actions.pod:4237 ../fish/guestfish-actions.pod:4289 ../fish/guestfish-actions.pod:4298 ../fish/guestfish-actions.pod:4352 ../fish/guestfish-actions.pod:4375
20386 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
20390 #: ../fish/guestfish-actions.pod:425
20395 #: ../fish/guestfish-actions.pod:427
20398 " base64-out filename (base64file|-)\n"
20403 #: ../fish/guestfish-actions.pod:434
20404 msgid "blockdev-flushbufs"
20408 #: ../fish/guestfish-actions.pod:436
20411 " blockdev-flushbufs device\n"
20416 #: ../fish/guestfish-actions.pod:443
20417 msgid "blockdev-getbsz"
20421 #: ../fish/guestfish-actions.pod:445
20424 " blockdev-getbsz device\n"
20429 #: ../fish/guestfish-actions.pod:454
20430 msgid "blockdev-getro"
20434 #: ../fish/guestfish-actions.pod:456
20437 " blockdev-getro device\n"
20442 #: ../fish/guestfish-actions.pod:463
20443 msgid "blockdev-getsize64"
20447 #: ../fish/guestfish-actions.pod:465
20450 " blockdev-getsize64 device\n"
20455 #: ../fish/guestfish-actions.pod:469
20456 msgid "See also L</blockdev-getsz>."
20460 #: ../fish/guestfish-actions.pod:473
20461 msgid "blockdev-getss"
20465 #: ../fish/guestfish-actions.pod:475
20468 " blockdev-getss device\n"
20473 #: ../fish/guestfish-actions.pod:480
20474 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
20478 #: ../fish/guestfish-actions.pod:485
20479 msgid "blockdev-getsz"
20483 #: ../fish/guestfish-actions.pod:487
20486 " blockdev-getsz device\n"
20491 #: ../fish/guestfish-actions.pod:492
20493 "See also L</blockdev-getss> for the real sector size of the device, and "
20494 "L</blockdev-getsize64> for the more useful I<size in bytes>."
20498 #: ../fish/guestfish-actions.pod:498
20499 msgid "blockdev-rereadpt"
20503 #: ../fish/guestfish-actions.pod:500
20506 " blockdev-rereadpt device\n"
20511 #: ../fish/guestfish-actions.pod:506
20512 msgid "blockdev-setbsz"
20516 #: ../fish/guestfish-actions.pod:508
20519 " blockdev-setbsz device blocksize\n"
20524 #: ../fish/guestfish-actions.pod:517
20525 msgid "blockdev-setro"
20529 #: ../fish/guestfish-actions.pod:519
20532 " blockdev-setro device\n"
20537 #: ../fish/guestfish-actions.pod:525
20538 msgid "blockdev-setrw"
20542 #: ../fish/guestfish-actions.pod:527
20545 " blockdev-setrw device\n"
20550 #: ../fish/guestfish-actions.pod:533
20551 msgid "case-sensitive-path"
20555 #: ../fish/guestfish-actions.pod:535
20558 " case-sensitive-path path\n"
20563 #: ../fish/guestfish-actions.pod:559
20565 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
20566 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
20567 "how the directories were originally created under Windows)."
20571 #: ../fish/guestfish-actions.pod:567
20572 msgid "See also L</realpath>."
20576 #: ../fish/guestfish-actions.pod:569
20581 #: ../fish/guestfish-actions.pod:571
20589 #: ../fish/guestfish-actions.pod:575
20591 "Note that this function cannot correctly handle binary files (specifically, "
20592 "files containing C<\\0> character which is treated as end of string). For "
20593 "those you need to use the L</read-file> or L</download> functions which have "
20594 "a more complex interface."
20598 #: ../fish/guestfish-actions.pod:583
20603 #: ../fish/guestfish-actions.pod:585
20606 " checksum csumtype path\n"
20611 #: ../fish/guestfish-actions.pod:628
20612 msgid "To get the checksum for a device, use L</checksum-device>."
20616 #: ../fish/guestfish-actions.pod:630
20617 msgid "To get the checksums for many files, use L</checksums-out>."
20621 #: ../fish/guestfish-actions.pod:632
20622 msgid "checksum-device"
20626 #: ../fish/guestfish-actions.pod:634
20629 " checksum-device csumtype device\n"
20634 #: ../fish/guestfish-actions.pod:636
20636 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20637 "device named C<device>. For the types of checksums supported see the "
20638 "L</checksum> command."
20642 #: ../fish/guestfish-actions.pod:640
20643 msgid "checksums-out"
20647 #: ../fish/guestfish-actions.pod:642
20650 " checksums-out csumtype directory (sumsfile|-)\n"
20655 #: ../fish/guestfish-actions.pod:658
20660 #: ../fish/guestfish-actions.pod:660
20663 " chmod mode path\n"
20668 #: ../fish/guestfish-actions.pod:671
20673 #: ../fish/guestfish-actions.pod:673
20676 " chown owner group path\n"
20681 #: ../fish/guestfish-actions.pod:681
20686 #: ../fish/guestfish-actions.pod:683
20689 " command 'arguments ...'\n"
20694 #: ../fish/guestfish-actions.pod:690
20696 "The single parameter is an argv-style list of arguments. The first element "
20697 "is the name of the program to run. Subsequent elements are parameters. The "
20698 "list must be non-empty (ie. must contain a program name). Note that the "
20699 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20703 #: ../fish/guestfish-actions.pod:718
20704 msgid "command-lines"
20708 #: ../fish/guestfish-actions.pod:720
20711 " command-lines 'arguments ...'\n"
20716 #: ../fish/guestfish-actions.pod:722
20717 msgid "This is the same as L</command>, but splits the result into a list of lines."
20721 #: ../fish/guestfish-actions.pod:725
20722 msgid "See also: L</sh-lines>"
20726 #: ../fish/guestfish-actions.pod:730
20731 #: ../fish/guestfish-actions.pod:732
20734 " config qemuparam qemuvalue\n"
20739 #: ../fish/guestfish-actions.pod:743
20744 #: ../fish/guestfish-actions.pod:745
20747 " copy-size src dest size\n"
20752 #: ../fish/guestfish-actions.pod:753
20757 #: ../fish/guestfish-actions.pod:755
20765 #: ../fish/guestfish-actions.pod:760
20770 #: ../fish/guestfish-actions.pod:762
20778 #: ../fish/guestfish-actions.pod:767
20783 #: ../fish/guestfish-actions.pod:769
20791 #: ../fish/guestfish-actions.pod:776
20793 "If the destination is a device, it must be as large or larger than the "
20794 "source file or device, otherwise the copy will fail. This command cannot do "
20795 "partial copies (see L</copy-size>)."
20799 #: ../fish/guestfish-actions.pod:780
20804 #: ../fish/guestfish-actions.pod:782
20812 #: ../fish/guestfish-actions.pod:786 ../fish/guestfish-actions.pod:797
20814 "This command is mostly useful for interactive sessions. It is I<not> "
20815 "intended that you try to parse the output string. Use L</statvfs> from "
20820 #: ../fish/guestfish-actions.pod:790
20825 #: ../fish/guestfish-actions.pod:792
20833 #: ../fish/guestfish-actions.pod:801
20838 #: ../fish/guestfish-actions.pod:803
20846 #: ../fish/guestfish-actions.pod:809
20848 "Another way to get the same information is to enable verbose messages with "
20849 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20850 "before running the program."
20854 #: ../fish/guestfish-actions.pod:814
20859 #: ../fish/guestfish-actions.pod:816
20862 " download remotefilename (filename|-)\n"
20867 #: ../fish/guestfish-actions.pod:823
20868 msgid "See also L</upload>, L</cat>."
20872 #: ../fish/guestfish-actions.pod:827
20873 msgid "download-offset"
20877 #: ../fish/guestfish-actions.pod:829
20880 " download-offset remotefilename (filename|-) offset size\n"
20885 #: ../fish/guestfish-actions.pod:837
20887 "Note that there is no limit on the amount of data that can be downloaded "
20888 "with this call, unlike with L</pread>, and this call always reads the full "
20889 "amount unless an error occurs."
20893 #: ../fish/guestfish-actions.pod:842
20894 msgid "See also L</download>, L</pread>."
20898 #: ../fish/guestfish-actions.pod:846
20899 msgid "drop-caches"
20903 #: ../fish/guestfish-actions.pod:848
20906 " drop-caches whattodrop\n"
20911 #: ../fish/guestfish-actions.pod:860
20916 #: ../fish/guestfish-actions.pod:862
20924 #: ../fish/guestfish-actions.pod:874
20929 #: ../fish/guestfish-actions.pod:876
20932 " e2fsck-f device\n"
20937 #: ../fish/guestfish-actions.pod:882
20939 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20940 "should use L</fsck>."
20944 #: ../fish/guestfish-actions.pod:885
20945 msgid "echo-daemon"
20949 #: ../fish/guestfish-actions.pod:887
20952 " echo-daemon 'words ...'\n"
20957 #: ../fish/guestfish-actions.pod:894
20958 msgid "See also L</ping-daemon>."
20962 #: ../fish/guestfish-actions.pod:896
20967 #: ../fish/guestfish-actions.pod:898
20970 " egrep regex path\n"
20975 #: ../fish/guestfish-actions.pod:906
20980 #: ../fish/guestfish-actions.pod:908
20983 " egrepi regex path\n"
20988 #: ../fish/guestfish-actions.pod:916
20993 #: ../fish/guestfish-actions.pod:918
20996 " equal file1 file2\n"
21001 #: ../fish/guestfish-actions.pod:925
21006 #: ../fish/guestfish-actions.pod:927
21014 #: ../fish/guestfish-actions.pod:932
21015 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21019 #: ../fish/guestfish-actions.pod:934
21024 #: ../fish/guestfish-actions.pod:936
21027 " fallocate path len\n"
21032 #: ../fish/guestfish-actions.pod:953
21033 msgid "fallocate64"
21037 #: ../fish/guestfish-actions.pod:955
21040 " fallocate64 path len\n"
21045 #: ../fish/guestfish-actions.pod:961
21047 "Note that this call allocates disk blocks for the file. To create a sparse "
21048 "file use L</truncate-size> instead."
21052 #: ../fish/guestfish-actions.pod:964
21054 "The deprecated call L</fallocate> does the same, but owing to an oversight "
21055 "it only allowed 30 bit lengths to be specified, effectively limiting the "
21056 "maximum size of files created through that call to 1GB."
21060 #: ../fish/guestfish-actions.pod:973
21065 #: ../fish/guestfish-actions.pod:975
21068 " fgrep pattern path\n"
21073 #: ../fish/guestfish-actions.pod:983
21078 #: ../fish/guestfish-actions.pod:985
21081 " fgrepi pattern path\n"
21086 #: ../fish/guestfish-actions.pod:993
21091 #: ../fish/guestfish-actions.pod:995
21099 #: ../fish/guestfish-actions.pod:1007
21101 "This command can also be used on C</dev/> devices (and partitions, LV "
21102 "names). You can for example use this to determine if a device contains a "
21103 "filesystem, although it's usually better to use L</vfs-type>."
21107 #: ../fish/guestfish-actions.pod:1017
21108 msgid "file-architecture"
21112 #: ../fish/guestfish-actions.pod:1019
21115 " file-architecture filename\n"
21120 #: ../fish/guestfish-actions.pod:1122
21125 #: ../fish/guestfish-actions.pod:1124
21133 #: ../fish/guestfish-actions.pod:1128
21135 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
21136 "L</is-file> etc. To get the size of block devices, use "
21137 "L</blockdev-getsize64>."
21141 #: ../fish/guestfish-actions.pod:1132
21146 #: ../fish/guestfish-actions.pod:1134
21149 " fill c len path\n"
21154 #: ../fish/guestfish-actions.pod:1140
21156 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
21157 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
21158 "L</fill-pattern>."
21162 #: ../fish/guestfish-actions.pod:1145
21163 msgid "fill-pattern"
21167 #: ../fish/guestfish-actions.pod:1147
21170 " fill-pattern pattern len path\n"
21175 #: ../fish/guestfish-actions.pod:1149
21177 "This function is like L</fill> except that it creates a new file of length "
21178 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
21179 "is truncated if necessary to ensure the length of the file is exactly C<len> "
21184 #: ../fish/guestfish-actions.pod:1154
21189 #: ../fish/guestfish-actions.pod:1156
21192 " find directory\n"
21197 #: ../fish/guestfish-actions.pod:1170
21198 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
21202 #: ../fish/guestfish-actions.pod:1183
21203 msgid "See also L</find0>."
21207 #: ../fish/guestfish-actions.pod:1188
21212 #: ../fish/guestfish-actions.pod:1190
21215 " find0 directory (files|-)\n"
21220 #: ../fish/guestfish-actions.pod:1196
21221 msgid "This command works the same way as L</find> with the following exceptions:"
21225 #: ../fish/guestfish-actions.pod:1223
21226 msgid "findfs-label"
21230 #: ../fish/guestfish-actions.pod:1225
21233 " findfs-label label\n"
21238 #: ../fish/guestfish-actions.pod:1231
21239 msgid "To find the label of a filesystem, use L</vfs-label>."
21243 #: ../fish/guestfish-actions.pod:1233
21244 msgid "findfs-uuid"
21248 #: ../fish/guestfish-actions.pod:1235
21251 " findfs-uuid uuid\n"
21256 #: ../fish/guestfish-actions.pod:1241
21257 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
21261 #: ../fish/guestfish-actions.pod:1243
21266 #: ../fish/guestfish-actions.pod:1245
21269 " fsck fstype device\n"
21274 #: ../fish/guestfish-actions.pod:1275
21279 #: ../fish/guestfish-actions.pod:1277
21287 #: ../fish/guestfish-actions.pod:1284
21288 msgid "get-autosync"
21292 #: ../fish/guestfish-actions.pod:1286
21300 #: ../fish/guestfish-actions.pod:1290
21305 #: ../fish/guestfish-actions.pod:1292
21313 #: ../fish/guestfish-actions.pod:1296
21314 msgid "get-e2label"
21318 #: ../fish/guestfish-actions.pod:1298
21321 " get-e2label device\n"
21326 #: ../fish/guestfish-actions.pod:1310
21331 #: ../fish/guestfish-actions.pod:1312
21334 " get-e2uuid device\n"
21339 #: ../fish/guestfish-actions.pod:1324
21340 msgid "get-memsize"
21344 #: ../fish/guestfish-actions.pod:1326
21352 #: ../fish/guestfish-actions.pod:1331
21354 "If L</set-memsize> was not called on this handle, and if "
21355 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
21356 "value for memsize."
21360 #: ../fish/guestfish-actions.pod:1338
21361 msgid "get-network"
21365 #: ../fish/guestfish-actions.pod:1340
21373 #: ../fish/guestfish-actions.pod:1344
21378 #: ../fish/guestfish-actions.pod:1346
21386 #: ../fish/guestfish-actions.pod:1353
21391 #: ../fish/guestfish-actions.pod:1355
21396 #: ../fish/guestfish-actions.pod:1357
21404 #: ../fish/guestfish-actions.pod:1364
21409 #: ../fish/guestfish-actions.pod:1366
21417 #: ../fish/guestfish-actions.pod:1373
21418 msgid "get-recovery-proc"
21422 #: ../fish/guestfish-actions.pod:1375
21425 " get-recovery-proc\n"
21430 #: ../fish/guestfish-actions.pod:1379
21431 msgid "get-selinux"
21435 #: ../fish/guestfish-actions.pod:1381
21443 #: ../fish/guestfish-actions.pod:1383
21445 "This returns the current setting of the selinux flag which is passed to the "
21446 "appliance at boot time. See L</set-selinux>."
21450 #: ../fish/guestfish-actions.pod:1389
21455 #: ../fish/guestfish-actions.pod:1391
21463 #: ../fish/guestfish-actions.pod:1398
21468 #: ../fish/guestfish-actions.pod:1400
21476 #: ../fish/guestfish-actions.pod:1404
21481 #: ../fish/guestfish-actions.pod:1406
21489 #: ../fish/guestfish-actions.pod:1408
21491 "Return the current umask. By default the umask is C<022> unless it has been "
21492 "set by calling L</umask>."
21496 #: ../fish/guestfish-actions.pod:1411
21497 msgid "get-verbose"
21501 #: ../fish/guestfish-actions.pod:1413
21509 #: ../fish/guestfish-actions.pod:1417
21514 #: ../fish/guestfish-actions.pod:1419
21522 #: ../fish/guestfish-actions.pod:1423
21523 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
21527 #: ../fish/guestfish-actions.pod:1426
21532 #: ../fish/guestfish-actions.pod:1428
21535 " getxattr path name\n"
21540 #: ../fish/guestfish-actions.pod:1430
21542 "Get a single extended attribute from file C<path> named C<name>. This call "
21543 "follows symlinks. If you want to lookup an extended attribute for the "
21544 "symlink itself, use L</lgetxattr>."
21548 #: ../fish/guestfish-actions.pod:1434 ../fish/guestfish-actions.pod:2265
21550 "Normally it is better to get all extended attributes from a file in one go "
21551 "by calling L</getxattrs>. However some Linux filesystem implementations are "
21552 "buggy and do not provide a way to list out attributes. For these "
21553 "filesystems (notably ntfs-3g) you have to know the names of the extended "
21554 "attributes you want in advance and call this function."
21558 #: ../fish/guestfish-actions.pod:1444
21559 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
21563 #: ../fish/guestfish-actions.pod:1446
21568 #: ../fish/guestfish-actions.pod:1448
21571 " getxattrs path\n"
21576 #: ../fish/guestfish-actions.pod:1456
21577 msgid "See also: L</lgetxattrs>, L<attr(5)>."
21581 #: ../fish/guestfish-actions.pod:1458
21582 msgid "glob-expand"
21586 #: ../fish/guestfish-actions.pod:1460
21589 " glob-expand pattern\n"
21594 #: ../fish/guestfish-actions.pod:1473
21599 #: ../fish/guestfish-actions.pod:1475
21602 " grep regex path\n"
21607 #: ../fish/guestfish-actions.pod:1483
21612 #: ../fish/guestfish-actions.pod:1485
21615 " grepi regex path\n"
21620 #: ../fish/guestfish-actions.pod:1493
21621 msgid "grub-install"
21625 #: ../fish/guestfish-actions.pod:1495
21628 " grub-install root device\n"
21633 #: ../fish/guestfish-actions.pod:1511
21638 #: ../fish/guestfish-actions.pod:1513
21646 #: ../fish/guestfish-actions.pod:1521
21651 #: ../fish/guestfish-actions.pod:1523
21654 " head-n nrlines path\n"
21659 #: ../fish/guestfish-actions.pod:1536
21664 #: ../fish/guestfish-actions.pod:1538
21672 #: ../fish/guestfish-actions.pod:1546
21677 #: ../fish/guestfish-actions.pod:1548
21680 " initrd-cat initrdpath filename\n"
21685 #: ../fish/guestfish-actions.pod:1560
21686 msgid "See also L</initrd-list>."
21690 #: ../fish/guestfish-actions.pod:1565
21691 msgid "initrd-list"
21695 #: ../fish/guestfish-actions.pod:1567
21698 " initrd-list path\n"
21703 #: ../fish/guestfish-actions.pod:1579
21704 msgid "inotify-add-watch"
21708 #: ../fish/guestfish-actions.pod:1581
21711 " inotify-add-watch path mask\n"
21716 #: ../fish/guestfish-actions.pod:1593
21717 msgid "inotify-close"
21721 #: ../fish/guestfish-actions.pod:1595
21729 #: ../fish/guestfish-actions.pod:1601
21730 msgid "inotify-files"
21734 #: ../fish/guestfish-actions.pod:1603
21742 #: ../fish/guestfish-actions.pod:1605
21744 "This function is a helpful wrapper around L</inotify-read> which just "
21745 "returns a list of pathnames of objects that were touched. The returned "
21746 "pathnames are sorted and deduplicated."
21750 #: ../fish/guestfish-actions.pod:1609
21751 msgid "inotify-init"
21755 #: ../fish/guestfish-actions.pod:1611
21758 " inotify-init maxevents\n"
21763 #: ../fish/guestfish-actions.pod:1617
21765 "C<maxevents> is the maximum number of events which will be queued up between "
21766 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21767 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21768 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21769 "but records the fact that it threw them away by setting a flag "
21770 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21774 #: ../fish/guestfish-actions.pod:1627
21776 "Before any events are generated, you have to add some watches to the "
21777 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21778 "L</inotify-watch-all>."
21782 #: ../fish/guestfish-actions.pod:1633
21784 "Queued up events should be read periodically by calling L</inotify-read> (or "
21785 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21786 "If you don't read the events out often enough then you risk the internal "
21787 "queue overflowing."
21791 #: ../fish/guestfish-actions.pod:1640
21793 "The handle should be closed after use by calling L</inotify-close>. This "
21794 "also removes any watches automatically."
21798 #: ../fish/guestfish-actions.pod:1649
21799 msgid "inotify-read"
21803 #: ../fish/guestfish-actions.pod:1651
21811 #: ../fish/guestfish-actions.pod:1664
21812 msgid "inotify-rm-watch"
21816 #: ../fish/guestfish-actions.pod:1666
21819 " inotify-rm-watch wd\n"
21824 #: ../fish/guestfish-actions.pod:1668
21825 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21829 #: ../fish/guestfish-actions.pod:1671
21830 msgid "inspect-get-arch"
21834 #: ../fish/guestfish-actions.pod:1673
21837 " inspect-get-arch root\n"
21842 #: ../fish/guestfish-actions.pod:1675 ../fish/guestfish-actions.pod:1691 ../fish/guestfish-actions.pod:1765 ../fish/guestfish-actions.pod:1783 ../fish/guestfish-actions.pod:1798 ../fish/guestfish-actions.pod:1819 ../fish/guestfish-actions.pod:1834 ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1883 ../fish/guestfish-actions.pod:1907 ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:1972 ../fish/guestfish-actions.pod:1988
21844 "This function should only be called with a root device string as returned by "
21849 #: ../fish/guestfish-actions.pod:1678
21851 "This returns the architecture of the inspected operating system. The "
21852 "possible return values are listed under L</file-architecture>."
21856 #: ../fish/guestfish-actions.pod:1687
21857 msgid "inspect-get-distro"
21861 #: ../fish/guestfish-actions.pod:1689
21864 " inspect-get-distro root\n"
21869 #: ../fish/guestfish-actions.pod:1761
21870 msgid "inspect-get-filesystems"
21874 #: ../fish/guestfish-actions.pod:1763
21877 " inspect-get-filesystems root\n"
21882 #: ../fish/guestfish-actions.pod:1776
21884 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21885 "L</inspect-get-mountpoints>."
21889 #: ../fish/guestfish-actions.pod:1779
21890 msgid "inspect-get-hostname"
21894 #: ../fish/guestfish-actions.pod:1781
21897 " inspect-get-hostname root\n"
21902 #: ../fish/guestfish-actions.pod:1794
21903 msgid "inspect-get-major-version"
21907 #: ../fish/guestfish-actions.pod:1796
21910 " inspect-get-major-version root\n"
21915 #: ../fish/guestfish-actions.pod:1815
21916 msgid "inspect-get-minor-version"
21920 #: ../fish/guestfish-actions.pod:1817
21923 " inspect-get-minor-version root\n"
21928 #: ../fish/guestfish-actions.pod:1827
21930 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21931 "L</inspect-get-major-version>."
21935 #: ../fish/guestfish-actions.pod:1830
21936 msgid "inspect-get-mountpoints"
21940 #: ../fish/guestfish-actions.pod:1832
21943 " inspect-get-mountpoints root\n"
21948 #: ../fish/guestfish-actions.pod:1854
21950 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21951 "L</inspect-get-filesystems>."
21955 #: ../fish/guestfish-actions.pod:1857
21956 msgid "inspect-get-package-format"
21960 #: ../fish/guestfish-actions.pod:1859
21963 " inspect-get-package-format root\n"
21968 #: ../fish/guestfish-actions.pod:1864
21970 "This function and L</inspect-get-package-management> return the package "
21971 "format and package management tool used by the inspected operating system. "
21972 "For example for Fedora these functions would return C<rpm> (package format) "
21973 "and C<yum> (package management)."
21977 #: ../fish/guestfish-actions.pod:1879
21978 msgid "inspect-get-package-management"
21982 #: ../fish/guestfish-actions.pod:1881
21985 " inspect-get-package-management root\n"
21990 #: ../fish/guestfish-actions.pod:1886
21992 "L</inspect-get-package-format> and this function return the package format "
21993 "and package management tool used by the inspected operating system. For "
21994 "example for Fedora these functions would return C<rpm> (package format) and "
21995 "C<yum> (package management)."
21999 #: ../fish/guestfish-actions.pod:1903
22000 msgid "inspect-get-product-name"
22004 #: ../fish/guestfish-actions.pod:1905
22007 " inspect-get-product-name root\n"
22012 #: ../fish/guestfish-actions.pod:1920
22013 msgid "inspect-get-roots"
22017 #: ../fish/guestfish-actions.pod:1922
22020 " inspect-get-roots\n"
22025 #: ../fish/guestfish-actions.pod:1924
22027 "This function is a convenient way to get the list of root devices, as "
22028 "returned from a previous call to L</inspect-os>, but without redoing the "
22029 "whole inspection process."
22033 #: ../fish/guestfish-actions.pod:1928
22035 "This returns an empty list if either no root devices were found or the "
22036 "caller has not called L</inspect-os>."
22040 #: ../fish/guestfish-actions.pod:1933
22041 msgid "inspect-get-type"
22045 #: ../fish/guestfish-actions.pod:1935
22048 " inspect-get-type root\n"
22053 #: ../fish/guestfish-actions.pod:1968
22054 msgid "inspect-get-windows-systemroot"
22058 #: ../fish/guestfish-actions.pod:1970
22061 " inspect-get-windows-systemroot root\n"
22066 #: ../fish/guestfish-actions.pod:1984
22067 msgid "inspect-list-applications"
22071 #: ../fish/guestfish-actions.pod:1986
22074 " inspect-list-applications root\n"
22079 #: ../fish/guestfish-actions.pod:1993
22081 "I<Note:> This call works differently from other parts of the inspection "
22082 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
22083 "then mount up the disks, before calling this. Listing applications is a "
22084 "significantly more difficult operation which requires access to the full "
22085 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
22086 "are just returning data cached in the libguestfs handle, this call actually "
22087 "reads parts of the mounted filesystems during the call."
22091 #: ../fish/guestfish-actions.pod:2083
22096 #: ../fish/guestfish-actions.pod:2085
22104 #: ../fish/guestfish-actions.pod:2100
22106 "You can pass the root string(s) returned to other L</inspect-get-*> "
22107 "functions in order to query further information about each operating system, "
22108 "such as the name and version."
22112 #: ../fish/guestfish-actions.pod:2105
22114 "This function uses other libguestfs features such as L</mount-ro> and "
22115 "L</umount-all> in order to mount and unmount filesystems and look at the "
22116 "contents. This should be called with no disks currently mounted. The "
22117 "function may also use Augeas, so any existing Augeas handle will be closed."
22121 #: ../fish/guestfish-actions.pod:2117 ../fish/guestfish-actions.pod:2293 ../fish/guestfish-actions.pod:2339
22122 msgid "See also L</list-filesystems>."
22126 #: ../fish/guestfish-actions.pod:2119
22127 msgid "is-blockdev"
22131 #: ../fish/guestfish-actions.pod:2121
22134 " is-blockdev path\n"
22139 #: ../fish/guestfish-actions.pod:2126 ../fish/guestfish-actions.pod:2144 ../fish/guestfish-actions.pod:2163 ../fish/guestfish-actions.pod:2172 ../fish/guestfish-actions.pod:2182 ../fish/guestfish-actions.pod:2216 ../fish/guestfish-actions.pod:2225
22140 msgid "See also L</stat>."
22144 #: ../fish/guestfish-actions.pod:2128
22149 #: ../fish/guestfish-actions.pod:2130
22157 #: ../fish/guestfish-actions.pod:2137
22162 #: ../fish/guestfish-actions.pod:2139
22165 " is-chardev path\n"
22170 #: ../fish/guestfish-actions.pod:2146
22175 #: ../fish/guestfish-actions.pod:2148
22183 #: ../fish/guestfish-actions.pod:2155
22188 #: ../fish/guestfish-actions.pod:2157
22196 #: ../fish/guestfish-actions.pod:2165
22201 #: ../fish/guestfish-actions.pod:2167
22209 #: ../fish/guestfish-actions.pod:2174
22214 #: ../fish/guestfish-actions.pod:2176
22222 #: ../fish/guestfish-actions.pod:2184
22223 msgid "is-launching"
22227 #: ../fish/guestfish-actions.pod:2186
22235 #: ../fish/guestfish-actions.pod:2193
22240 #: ../fish/guestfish-actions.pod:2195
22248 #: ../fish/guestfish-actions.pod:2200
22253 #: ../fish/guestfish-actions.pod:2202
22261 #: ../fish/guestfish-actions.pod:2209
22266 #: ../fish/guestfish-actions.pod:2211
22269 " is-socket path\n"
22274 #: ../fish/guestfish-actions.pod:2218
22279 #: ../fish/guestfish-actions.pod:2220
22282 " is-symlink path\n"
22287 #: ../fish/guestfish-actions.pod:2227
22288 msgid "kill-subprocess"
22292 #: ../fish/guestfish-actions.pod:2229
22295 " kill-subprocess\n"
22300 #: ../fish/guestfish-actions.pod:2233
22305 #: ../fish/guestfish-actions.pod:2235
22310 #: ../fish/guestfish-actions.pod:2237
22318 #: ../fish/guestfish-actions.pod:2245
22323 #: ../fish/guestfish-actions.pod:2247
22326 " lchown owner group path\n"
22331 #: ../fish/guestfish-actions.pod:2249
22333 "Change the file owner to C<owner> and group to C<group>. This is like "
22334 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
22339 #: ../fish/guestfish-actions.pod:2257
22344 #: ../fish/guestfish-actions.pod:2259
22347 " lgetxattr path name\n"
22352 #: ../fish/guestfish-actions.pod:2275
22353 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
22357 #: ../fish/guestfish-actions.pod:2277
22362 #: ../fish/guestfish-actions.pod:2279
22365 " lgetxattrs path\n"
22370 #: ../fish/guestfish-actions.pod:2281
22372 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
22373 "it returns the extended attributes of the link itself."
22377 #: ../fish/guestfish-actions.pod:2285
22378 msgid "list-devices"
22382 #: ../fish/guestfish-actions.pod:2287
22390 #: ../fish/guestfish-actions.pod:2295
22391 msgid "list-filesystems"
22395 #: ../fish/guestfish-actions.pod:2297
22398 " list-filesystems\n"
22403 #: ../fish/guestfish-actions.pod:2316
22405 "This command runs other libguestfs commands, which might include L</mount> "
22406 "and L</umount>, and therefore you should use this soon after launch and only "
22407 "when nothing is mounted."
22411 #: ../fish/guestfish-actions.pod:2320
22413 "Not all of the filesystems returned will be mountable. In particular, swap "
22414 "partitions are returned in the list. Also this command does not check that "
22415 "each filesystem found is valid and mountable, and some filesystems might be "
22416 "mountable but require special options. Filesystems may not all belong to a "
22417 "single logical operating system (use L</inspect-os> to look for OSes)."
22421 #: ../fish/guestfish-actions.pod:2328
22422 msgid "list-partitions"
22426 #: ../fish/guestfish-actions.pod:2330
22429 " list-partitions\n"
22434 #: ../fish/guestfish-actions.pod:2336
22436 "This does not return logical volumes. For that you will need to call "
22441 #: ../fish/guestfish-actions.pod:2341
22446 #: ../fish/guestfish-actions.pod:2343
22454 #: ../fish/guestfish-actions.pod:2351
22459 #: ../fish/guestfish-actions.pod:2353
22462 " ln target linkname\n"
22467 #: ../fish/guestfish-actions.pod:2357
22472 #: ../fish/guestfish-actions.pod:2359
22475 " ln-f target linkname\n"
22480 #: ../fish/guestfish-actions.pod:2364
22485 #: ../fish/guestfish-actions.pod:2366
22488 " ln-s target linkname\n"
22493 #: ../fish/guestfish-actions.pod:2370
22498 #: ../fish/guestfish-actions.pod:2372
22501 " ln-sf target linkname\n"
22506 #: ../fish/guestfish-actions.pod:2377
22507 msgid "lremovexattr"
22511 #: ../fish/guestfish-actions.pod:2379
22514 " lremovexattr xattr path\n"
22519 #: ../fish/guestfish-actions.pod:2381
22521 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
22522 "it removes an extended attribute of the link itself."
22526 #: ../fish/guestfish-actions.pod:2385
22531 #: ../fish/guestfish-actions.pod:2387
22539 #: ../fish/guestfish-actions.pod:2393
22541 "This command is mostly useful for interactive sessions. Programs should "
22542 "probably use L</readdir> instead."
22546 #: ../fish/guestfish-actions.pod:2396
22551 #: ../fish/guestfish-actions.pod:2398
22554 " lsetxattr xattr val vallen path\n"
22559 #: ../fish/guestfish-actions.pod:2400
22561 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
22562 "sets an extended attribute of the link itself."
22566 #: ../fish/guestfish-actions.pod:2404
22571 #: ../fish/guestfish-actions.pod:2406
22579 #: ../fish/guestfish-actions.pod:2410
22581 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
22582 "the link is stat-ed, not the file it refers to."
22586 #: ../fish/guestfish-actions.pod:2416
22591 #: ../fish/guestfish-actions.pod:2418
22594 " lstatlist path 'names ...'\n"
22599 #: ../fish/guestfish-actions.pod:2420
22601 "This call allows you to perform the L</lstat> operation on multiple files, "
22602 "where all files are in the directory C<path>. C<names> is the list of files "
22603 "from this directory."
22607 #: ../fish/guestfish-actions.pod:2429
22609 "This call is intended for programs that want to efficiently list a directory "
22610 "contents without making many round-trips. See also L</lxattrlist> for a "
22611 "similarly efficient call for getting extended attributes. Very long "
22612 "directory listings might cause the protocol message size to be exceeded, "
22613 "causing this call to fail. The caller must split up such requests into "
22614 "smaller groups of names."
22618 #: ../fish/guestfish-actions.pod:2437
22619 msgid "luks-add-key"
22623 #: ../fish/guestfish-actions.pod:2439
22626 " luks-add-key device keyslot\n"
22631 #: ../fish/guestfish-actions.pod:2446
22633 "Note that if C<keyslot> already contains a key, then this command will "
22634 "fail. You have to use L</luks-kill-slot> first to remove that key."
22638 #: ../fish/guestfish-actions.pod:2450 ../fish/guestfish-actions.pod:2472 ../fish/guestfish-actions.pod:2485 ../fish/guestfish-actions.pod:2499 ../fish/guestfish-actions.pod:2522 ../fish/guestfish-actions.pod:2532
22640 "This command has one or more key or passphrase parameters. Guestfish will "
22641 "prompt for these separately."
22645 #: ../fish/guestfish-actions.pod:2453
22650 #: ../fish/guestfish-actions.pod:2455
22653 " luks-close device\n"
22658 #: ../fish/guestfish-actions.pod:2457
22660 "This closes a LUKS device that was created earlier by L</luks-open> or "
22661 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
22662 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
22663 "underlying block device."
22667 #: ../fish/guestfish-actions.pod:2463
22668 msgid "luks-format"
22672 #: ../fish/guestfish-actions.pod:2465
22675 " luks-format device keyslot\n"
22680 #: ../fish/guestfish-actions.pod:2478
22681 msgid "luks-format-cipher"
22685 #: ../fish/guestfish-actions.pod:2480
22688 " luks-format-cipher device keyslot cipher\n"
22693 #: ../fish/guestfish-actions.pod:2482
22695 "This command is the same as L</luks-format> but it also allows you to set "
22696 "the C<cipher> used."
22700 #: ../fish/guestfish-actions.pod:2491
22701 msgid "luks-kill-slot"
22705 #: ../fish/guestfish-actions.pod:2493
22708 " luks-kill-slot device keyslot\n"
22713 #: ../fish/guestfish-actions.pod:2502
22718 #: ../fish/guestfish-actions.pod:2504
22721 " luks-open device mapname\n"
22726 #: ../fish/guestfish-actions.pod:2518
22728 "If this block device contains LVM volume groups, then calling L</vgscan> "
22729 "followed by L</vg-activate-all> will make them visible."
22733 #: ../fish/guestfish-actions.pod:2525
22734 msgid "luks-open-ro"
22738 #: ../fish/guestfish-actions.pod:2527
22741 " luks-open-ro device mapname\n"
22746 #: ../fish/guestfish-actions.pod:2529
22748 "This is the same as L</luks-open> except that a read-only mapping is "
22753 #: ../fish/guestfish-actions.pod:2535
22758 #: ../fish/guestfish-actions.pod:2537
22761 " lvcreate logvol volgroup mbytes\n"
22766 #: ../fish/guestfish-actions.pod:2542
22767 msgid "lvm-canonical-lv-name"
22771 #: ../fish/guestfish-actions.pod:2544
22774 " lvm-canonical-lv-name lvname\n"
22779 #: ../fish/guestfish-actions.pod:2553
22780 msgid "See also L</is-lv>."
22784 #: ../fish/guestfish-actions.pod:2555
22785 msgid "lvm-clear-filter"
22789 #: ../fish/guestfish-actions.pod:2557
22792 " lvm-clear-filter\n"
22797 #: ../fish/guestfish-actions.pod:2559
22799 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22804 #: ../fish/guestfish-actions.pod:2565
22805 msgid "lvm-remove-all"
22809 #: ../fish/guestfish-actions.pod:2567
22812 " lvm-remove-all\n"
22817 #: ../fish/guestfish-actions.pod:2575
22818 msgid "lvm-set-filter"
22822 #: ../fish/guestfish-actions.pod:2577
22825 " lvm-set-filter 'devices ...'\n"
22830 #: ../fish/guestfish-actions.pod:2602
22835 #: ../fish/guestfish-actions.pod:2604
22838 " lvremove device\n"
22843 #: ../fish/guestfish-actions.pod:2612
22848 #: ../fish/guestfish-actions.pod:2614
22851 " lvrename logvol newlogvol\n"
22856 #: ../fish/guestfish-actions.pod:2618
22861 #: ../fish/guestfish-actions.pod:2620
22864 " lvresize device mbytes\n"
22869 #: ../fish/guestfish-actions.pod:2626
22870 msgid "lvresize-free"
22874 #: ../fish/guestfish-actions.pod:2628
22877 " lvresize-free lv percent\n"
22882 #: ../fish/guestfish-actions.pod:2636
22887 #: ../fish/guestfish-actions.pod:2638
22895 #: ../fish/guestfish-actions.pod:2646
22896 msgid "See also L</lvs-full>, L</list-filesystems>."
22900 #: ../fish/guestfish-actions.pod:2648
22905 #: ../fish/guestfish-actions.pod:2650
22913 #: ../fish/guestfish-actions.pod:2655
22918 #: ../fish/guestfish-actions.pod:2657
22926 #: ../fish/guestfish-actions.pod:2661
22931 #: ../fish/guestfish-actions.pod:2663
22934 " lxattrlist path 'names ...'\n"
22939 #: ../fish/guestfish-actions.pod:2679
22941 "This call is intended for programs that want to efficiently list a directory "
22942 "contents without making many round-trips. See also L</lstatlist> for a "
22943 "similarly efficient call for getting standard stats. Very long directory "
22944 "listings might cause the protocol message size to be exceeded, causing this "
22945 "call to fail. The caller must split up such requests into smaller groups of "
22950 #: ../fish/guestfish-actions.pod:2687
22955 #: ../fish/guestfish-actions.pod:2689
22963 #: ../fish/guestfish-actions.pod:2693
22968 #: ../fish/guestfish-actions.pod:2695
22971 " mkdir-mode path mode\n"
22976 #: ../fish/guestfish-actions.pod:2704
22977 msgid "See also L</mkdir>, L</umask>"
22981 #: ../fish/guestfish-actions.pod:2706
22986 #: ../fish/guestfish-actions.pod:2708
22994 #: ../fish/guestfish-actions.pod:2713
22999 #: ../fish/guestfish-actions.pod:2715
23002 " mkdtemp template\n"
23007 #: ../fish/guestfish-actions.pod:2736
23012 #: ../fish/guestfish-actions.pod:2738
23015 " mke2fs-J fstype blocksize device journal\n"
23020 #: ../fish/guestfish-actions.pod:2746
23021 msgid "See also L</mke2journal>."
23025 #: ../fish/guestfish-actions.pod:2748
23030 #: ../fish/guestfish-actions.pod:2750
23033 " mke2fs-JL fstype blocksize device label\n"
23038 #: ../fish/guestfish-actions.pod:2755
23039 msgid "See also L</mke2journal-L>."
23043 #: ../fish/guestfish-actions.pod:2757
23048 #: ../fish/guestfish-actions.pod:2759
23051 " mke2fs-JU fstype blocksize device uuid\n"
23056 #: ../fish/guestfish-actions.pod:2764
23057 msgid "See also L</mke2journal-U>."
23061 #: ../fish/guestfish-actions.pod:2766
23062 msgid "mke2journal"
23066 #: ../fish/guestfish-actions.pod:2768
23069 " mke2journal blocksize device\n"
23074 #: ../fish/guestfish-actions.pod:2775
23075 msgid "mke2journal-L"
23079 #: ../fish/guestfish-actions.pod:2777
23082 " mke2journal-L blocksize label device\n"
23087 #: ../fish/guestfish-actions.pod:2781
23088 msgid "mke2journal-U"
23092 #: ../fish/guestfish-actions.pod:2783
23095 " mke2journal-U blocksize uuid device\n"
23100 #: ../fish/guestfish-actions.pod:2787
23105 #: ../fish/guestfish-actions.pod:2789
23108 " mkfifo mode path\n"
23113 #: ../fish/guestfish-actions.pod:2791
23115 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
23116 "is just a convenient wrapper around L</mknod>."
23120 #: ../fish/guestfish-actions.pod:2797
23125 #: ../fish/guestfish-actions.pod:2799
23128 " mkfs fstype device\n"
23133 #: ../fish/guestfish-actions.pod:2805
23138 #: ../fish/guestfish-actions.pod:2807
23141 " mkfs-b fstype blocksize device\n"
23146 #: ../fish/guestfish-actions.pod:2809
23148 "This call is similar to L</mkfs>, but it allows you to control the block "
23149 "size of the resulting filesystem. Supported block sizes depend on the "
23150 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
23154 #: ../fish/guestfish-actions.pod:2824
23159 #: ../fish/guestfish-actions.pod:2826
23162 " mkfs-opts fstype device [blocksize:..]\n"
23167 #: ../fish/guestfish-actions.pod:2850
23168 msgid "mkmountpoint"
23172 #: ../fish/guestfish-actions.pod:2852
23175 " mkmountpoint exemptpath\n"
23180 #: ../fish/guestfish-actions.pod:2854
23182 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
23183 "to create extra mountpoints before mounting the first filesystem."
23187 #: ../fish/guestfish-actions.pod:2878
23189 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
23190 "unexpected errors if you try to mix these calls. It is safest to manually "
23191 "unmount filesystems and remove mountpoints after use."
23195 #: ../fish/guestfish-actions.pod:2882
23197 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
23198 "for this to work for manual mountpoints, you must ensure that the innermost "
23199 "mountpoints have the longest pathnames, as in the example code above."
23203 #: ../fish/guestfish-actions.pod:2889
23205 "Autosync [see L</set-autosync>, this is set by default on handles] means "
23206 "that L</umount-all> is called when the handle is closed which can also "
23207 "trigger these issues."
23211 #: ../fish/guestfish-actions.pod:2893
23216 #: ../fish/guestfish-actions.pod:2895
23219 " mknod mode devmajor devminor path\n"
23224 #: ../fish/guestfish-actions.pod:2905
23226 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
23227 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
23228 "regular file). These constants are available in the standard Linux header "
23229 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
23230 "wrappers around this command which bitwise OR in the appropriate constant "
23235 #: ../fish/guestfish-actions.pod:2915
23240 #: ../fish/guestfish-actions.pod:2917
23243 " mknod-b mode devmajor devminor path\n"
23248 #: ../fish/guestfish-actions.pod:2919
23250 "This call creates a block device node called C<path> with mode C<mode> and "
23251 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23252 "wrapper around L</mknod>."
23256 #: ../fish/guestfish-actions.pod:2925
23261 #: ../fish/guestfish-actions.pod:2927
23264 " mknod-c mode devmajor devminor path\n"
23269 #: ../fish/guestfish-actions.pod:2929
23271 "This call creates a char device node called C<path> with mode C<mode> and "
23272 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23273 "wrapper around L</mknod>."
23277 #: ../fish/guestfish-actions.pod:2935
23282 #: ../fish/guestfish-actions.pod:2937
23290 #: ../fish/guestfish-actions.pod:2941
23295 #: ../fish/guestfish-actions.pod:2943
23298 " mkswap-L label device\n"
23303 #: ../fish/guestfish-actions.pod:2951
23308 #: ../fish/guestfish-actions.pod:2953
23311 " mkswap-U uuid device\n"
23316 #: ../fish/guestfish-actions.pod:2957
23317 msgid "mkswap-file"
23321 #: ../fish/guestfish-actions.pod:2959
23324 " mkswap-file path\n"
23329 #: ../fish/guestfish-actions.pod:2963
23331 "This command just writes a swap file signature to an existing file. To "
23332 "create the file itself, use something like L</fallocate>."
23336 #: ../fish/guestfish-actions.pod:2966
23341 #: ../fish/guestfish-actions.pod:2968
23344 " modprobe modulename\n"
23349 #: ../fish/guestfish-actions.pod:2975
23354 #: ../fish/guestfish-actions.pod:2977
23357 " mount device mountpoint\n"
23362 #: ../fish/guestfish-actions.pod:2993
23364 "B<Important note:> When you use this call, the filesystem options C<sync> "
23365 "and C<noatime> are set implicitly. This was originally done because we "
23366 "thought it would improve reliability, but it turns out that I<-o sync> has a "
23367 "very large negative performance impact and negligible effect on "
23368 "reliability. Therefore we recommend that you avoid using L</mount> in any "
23369 "code that needs performance, and instead use L</mount-options> (use an empty "
23370 "string for the first parameter if you don't want any options)."
23374 #: ../fish/guestfish-actions.pod:3003
23379 #: ../fish/guestfish-actions.pod:3005
23382 " mount-loop file mountpoint\n"
23387 #: ../fish/guestfish-actions.pod:3011
23388 msgid "mount-options"
23392 #: ../fish/guestfish-actions.pod:3013
23395 " mount-options options device mountpoint\n"
23400 #: ../fish/guestfish-actions.pod:3015
23402 "This is the same as the L</mount> command, but it allows you to set the "
23403 "mount options as for the L<mount(8)> I<-o> flag."
23407 #: ../fish/guestfish-actions.pod:3023
23412 #: ../fish/guestfish-actions.pod:3025
23415 " mount-ro device mountpoint\n"
23420 #: ../fish/guestfish-actions.pod:3027
23422 "This is the same as the L</mount> command, but it mounts the filesystem with "
23423 "the read-only (I<-o ro>) flag."
23427 #: ../fish/guestfish-actions.pod:3030
23432 #: ../fish/guestfish-actions.pod:3032
23435 " mount-vfs options vfstype device mountpoint\n"
23440 #: ../fish/guestfish-actions.pod:3034
23442 "This is the same as the L</mount> command, but it allows you to set both the "
23443 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
23447 #: ../fish/guestfish-actions.pod:3038
23448 msgid "mountpoints"
23452 #: ../fish/guestfish-actions.pod:3040
23460 #: ../fish/guestfish-actions.pod:3042
23462 "This call is similar to L</mounts>. That call returns a list of devices. "
23463 "This one returns a hash table (map) of device name to directory where the "
23464 "device is mounted."
23468 #: ../fish/guestfish-actions.pod:3046
23473 #: ../fish/guestfish-actions.pod:3048
23481 #: ../fish/guestfish-actions.pod:3055
23482 msgid "See also: L</mountpoints>"
23486 #: ../fish/guestfish-actions.pod:3057
23491 #: ../fish/guestfish-actions.pod:3059
23499 #: ../fish/guestfish-actions.pod:3064
23500 msgid "ntfs-3g-probe"
23504 #: ../fish/guestfish-actions.pod:3066
23507 " ntfs-3g-probe true|false device\n"
23512 #: ../fish/guestfish-actions.pod:3080
23517 #: ../fish/guestfish-actions.pod:3082
23520 " ntfsresize device\n"
23525 #: ../fish/guestfish-actions.pod:3088
23526 msgid "ntfsresize-size"
23530 #: ../fish/guestfish-actions.pod:3090
23533 " ntfsresize-size device size\n"
23538 #: ../fish/guestfish-actions.pod:3092
23540 "This command is the same as L</ntfsresize> except that it allows you to "
23541 "specify the new size (in bytes) explicitly."
23545 #: ../fish/guestfish-actions.pod:3095
23550 #: ../fish/guestfish-actions.pod:3097
23553 " part-add device prlogex startsect endsect\n"
23558 #: ../fish/guestfish-actions.pod:3099
23560 "This command adds a partition to C<device>. If there is no partition table "
23561 "on the device, call L</part-init> first."
23565 #: ../fish/guestfish-actions.pod:3111
23567 "Creating a partition which covers the whole disk is not so easy. Use "
23568 "L</part-disk> to do that."
23572 #: ../fish/guestfish-actions.pod:3114
23577 #: ../fish/guestfish-actions.pod:3116
23580 " part-del device partnum\n"
23585 #: ../fish/guestfish-actions.pod:3124
23590 #: ../fish/guestfish-actions.pod:3126
23593 " part-disk device parttype\n"
23598 #: ../fish/guestfish-actions.pod:3128
23600 "This command is simply a combination of L</part-init> followed by "
23601 "L</part-add> to create a single primary partition covering the whole disk."
23605 #: ../fish/guestfish-actions.pod:3132
23607 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
23608 "possible values are described in L</part-init>."
23612 #: ../fish/guestfish-actions.pod:3138
23613 msgid "part-get-bootable"
23617 #: ../fish/guestfish-actions.pod:3140
23620 " part-get-bootable device partnum\n"
23625 #: ../fish/guestfish-actions.pod:3145
23626 msgid "See also L</part-set-bootable>."
23630 #: ../fish/guestfish-actions.pod:3147
23631 msgid "part-get-mbr-id"
23635 #: ../fish/guestfish-actions.pod:3149
23638 " part-get-mbr-id device partnum\n"
23643 #: ../fish/guestfish-actions.pod:3154 ../fish/guestfish-actions.pod:3292
23645 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
23646 "undefined results for other partition table types (see "
23647 "L</part-get-parttype>)."
23651 #: ../fish/guestfish-actions.pod:3158
23652 msgid "part-get-parttype"
23656 #: ../fish/guestfish-actions.pod:3160
23659 " part-get-parttype device\n"
23664 #: ../fish/guestfish-actions.pod:3165
23666 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
23667 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
23668 "possible, although unusual. See L</part-init> for a full list."
23672 #: ../fish/guestfish-actions.pod:3170
23677 #: ../fish/guestfish-actions.pod:3172
23680 " part-init device parttype\n"
23685 #: ../fish/guestfish-actions.pod:3178
23687 "Initially there are no partitions. Following this, you should call "
23688 "L</part-add> for each partition required."
23692 #: ../fish/guestfish-actions.pod:3241
23697 #: ../fish/guestfish-actions.pod:3243
23700 " part-list device\n"
23705 #: ../fish/guestfish-actions.pod:3258
23707 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23708 "the device's sector size, see L</blockdev-getss>."
23712 #: ../fish/guestfish-actions.pod:3271
23713 msgid "part-set-bootable"
23717 #: ../fish/guestfish-actions.pod:3273
23720 " part-set-bootable device partnum true|false\n"
23725 #: ../fish/guestfish-actions.pod:3282
23726 msgid "part-set-mbr-id"
23730 #: ../fish/guestfish-actions.pod:3284
23733 " part-set-mbr-id device partnum idbyte\n"
23738 #: ../fish/guestfish-actions.pod:3296
23739 msgid "part-set-name"
23743 #: ../fish/guestfish-actions.pod:3298
23746 " part-set-name device partnum name\n"
23751 #: ../fish/guestfish-actions.pod:3306
23752 msgid "part-to-dev"
23756 #: ../fish/guestfish-actions.pod:3308
23759 " part-to-dev partition\n"
23764 #: ../fish/guestfish-actions.pod:3314
23766 "The named partition must exist, for example as a string returned from "
23767 "L</list-partitions>."
23771 #: ../fish/guestfish-actions.pod:3317
23772 msgid "ping-daemon"
23776 #: ../fish/guestfish-actions.pod:3319
23784 #: ../fish/guestfish-actions.pod:3326
23789 #: ../fish/guestfish-actions.pod:3328
23792 " pread path count offset\n"
23797 #: ../fish/guestfish-actions.pod:3336
23798 msgid "See also L</pwrite>, L</pread-device>."
23802 #: ../fish/guestfish-actions.pod:3341
23803 msgid "pread-device"
23807 #: ../fish/guestfish-actions.pod:3343
23810 " pread-device device count offset\n"
23815 #: ../fish/guestfish-actions.pod:3351
23816 msgid "See also L</pread>."
23820 #: ../fish/guestfish-actions.pod:3356
23825 #: ../fish/guestfish-actions.pod:3358
23828 " pvcreate device\n"
23833 #: ../fish/guestfish-actions.pod:3364
23838 #: ../fish/guestfish-actions.pod:3366
23841 " pvremove device\n"
23846 #: ../fish/guestfish-actions.pod:3375
23851 #: ../fish/guestfish-actions.pod:3377
23854 " pvresize device\n"
23859 #: ../fish/guestfish-actions.pod:3382
23860 msgid "pvresize-size"
23864 #: ../fish/guestfish-actions.pod:3384
23867 " pvresize-size device size\n"
23872 #: ../fish/guestfish-actions.pod:3386
23874 "This command is the same as L</pvresize> except that it allows you to "
23875 "specify the new size (in bytes) explicitly."
23879 #: ../fish/guestfish-actions.pod:3389
23884 #: ../fish/guestfish-actions.pod:3391
23892 #: ../fish/guestfish-actions.pod:3399
23893 msgid "See also L</pvs-full>."
23897 #: ../fish/guestfish-actions.pod:3401
23902 #: ../fish/guestfish-actions.pod:3403
23910 #: ../fish/guestfish-actions.pod:3408
23915 #: ../fish/guestfish-actions.pod:3410
23923 #: ../fish/guestfish-actions.pod:3414
23928 #: ../fish/guestfish-actions.pod:3416
23931 " pwrite path content offset\n"
23936 #: ../fish/guestfish-actions.pod:3427
23937 msgid "See also L</pread>, L</pwrite-device>."
23941 #: ../fish/guestfish-actions.pod:3432
23942 msgid "pwrite-device"
23946 #: ../fish/guestfish-actions.pod:3434
23949 " pwrite-device device content offset\n"
23954 #: ../fish/guestfish-actions.pod:3444
23955 msgid "See also L</pwrite>."
23959 #: ../fish/guestfish-actions.pod:3449
23964 #: ../fish/guestfish-actions.pod:3451
23967 " read-file path\n"
23972 #: ../fish/guestfish-actions.pod:3456
23974 "Unlike L</cat>, this function can correctly handle files that contain "
23975 "embedded ASCII NUL characters. However unlike L</download>, this function "
23976 "is limited in the total size of file that can be handled."
23980 #: ../fish/guestfish-actions.pod:3464
23985 #: ../fish/guestfish-actions.pod:3466
23988 " read-lines path\n"
23993 #: ../fish/guestfish-actions.pod:3473
23995 "Note that this function cannot correctly handle binary files (specifically, "
23996 "files containing C<\\0> character which is treated as end of line). For "
23997 "those you need to use the L</read-file> function which has a more complex "
24002 #: ../fish/guestfish-actions.pod:3478
24007 #: ../fish/guestfish-actions.pod:3480
24015 #: ../fish/guestfish-actions.pod:3532
24017 "This function is primarily intended for use by programs. To get a simple "
24018 "list of names, use L</ls>. To get a printable directory for human "
24019 "consumption, use L</ll>."
24023 #: ../fish/guestfish-actions.pod:3536
24028 #: ../fish/guestfish-actions.pod:3538
24036 #: ../fish/guestfish-actions.pod:3542
24037 msgid "readlinklist"
24041 #: ../fish/guestfish-actions.pod:3544
24044 " readlinklist path 'names ...'\n"
24049 #: ../fish/guestfish-actions.pod:3568
24054 #: ../fish/guestfish-actions.pod:3570
24062 #: ../fish/guestfish-actions.pod:3575
24063 msgid "removexattr"
24067 #: ../fish/guestfish-actions.pod:3577
24070 " removexattr xattr path\n"
24075 #: ../fish/guestfish-actions.pod:3582
24076 msgid "See also: L</lremovexattr>, L<attr(5)>."
24080 #: ../fish/guestfish-actions.pod:3584
24085 #: ../fish/guestfish-actions.pod:3586
24088 " resize2fs device\n"
24093 #: ../fish/guestfish-actions.pod:3591
24095 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
24096 "before calling this command. For unknown reasons C<resize2fs> sometimes "
24097 "gives an error about this and sometimes not. In any case, it is always safe "
24098 "to call L</e2fsck-f> before calling this function."
24102 #: ../fish/guestfish-actions.pod:3597
24103 msgid "resize2fs-size"
24107 #: ../fish/guestfish-actions.pod:3599
24110 " resize2fs-size device size\n"
24115 #: ../fish/guestfish-actions.pod:3601
24117 "This command is the same as L</resize2fs> except that it allows you to "
24118 "specify the new size (in bytes) explicitly."
24122 #: ../fish/guestfish-actions.pod:3604
24127 #: ../fish/guestfish-actions.pod:3606
24135 #: ../fish/guestfish-actions.pod:3610
24140 #: ../fish/guestfish-actions.pod:3612
24148 #: ../fish/guestfish-actions.pod:3618
24153 #: ../fish/guestfish-actions.pod:3620
24161 #: ../fish/guestfish-actions.pod:3624
24162 msgid "rmmountpoint"
24166 #: ../fish/guestfish-actions.pod:3626
24169 " rmmountpoint exemptpath\n"
24174 #: ../fish/guestfish-actions.pod:3628
24176 "This calls removes a mountpoint that was previously created with "
24177 "L</mkmountpoint>. See L</mkmountpoint> for full details."
24181 #: ../fish/guestfish-actions.pod:3632
24182 msgid "scrub-device"
24186 #: ../fish/guestfish-actions.pod:3634
24189 " scrub-device device\n"
24194 #: ../fish/guestfish-actions.pod:3645
24199 #: ../fish/guestfish-actions.pod:3647
24202 " scrub-file file\n"
24207 #: ../fish/guestfish-actions.pod:3657
24208 msgid "scrub-freespace"
24212 #: ../fish/guestfish-actions.pod:3659
24215 " scrub-freespace dir\n"
24220 #: ../fish/guestfish-actions.pod:3661
24222 "This command creates the directory C<dir> and then fills it with files until "
24223 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
24224 "deletes them. The intention is to scrub any free space on the partition "
24225 "containing C<dir>."
24229 #: ../fish/guestfish-actions.pod:3670
24234 #: ../fish/guestfish-actions.pod:3672
24239 #: ../fish/guestfish-actions.pod:3674
24242 " set-append append\n"
24247 #: ../fish/guestfish-actions.pod:3685
24248 msgid "set-autosync"
24252 #: ../fish/guestfish-actions.pod:3687
24257 #: ../fish/guestfish-actions.pod:3689
24260 " set-autosync true|false\n"
24265 #: ../fish/guestfish-actions.pod:3691
24267 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
24268 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
24269 "closed (also if the program exits without closing handles)."
24273 #: ../fish/guestfish-actions.pod:3699
24278 #: ../fish/guestfish-actions.pod:3701
24283 #: ../fish/guestfish-actions.pod:3703
24286 " set-direct true|false\n"
24291 #: ../fish/guestfish-actions.pod:3709
24293 "One consequence of this is that log messages aren't caught by the library "
24294 "and handled by L</set-log-message-callback>, but go straight to stdout."
24298 #: ../fish/guestfish-actions.pod:3718
24299 msgid "set-e2label"
24303 #: ../fish/guestfish-actions.pod:3720
24306 " set-e2label device label\n"
24311 #: ../fish/guestfish-actions.pod:3726
24313 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
24314 "label on a filesystem."
24318 #: ../fish/guestfish-actions.pod:3729
24323 #: ../fish/guestfish-actions.pod:3731
24326 " set-e2uuid device uuid\n"
24331 #: ../fish/guestfish-actions.pod:3738
24333 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
24334 "UUID of a filesystem."
24338 #: ../fish/guestfish-actions.pod:3741
24339 msgid "set-memsize"
24343 #: ../fish/guestfish-actions.pod:3743
24348 #: ../fish/guestfish-actions.pod:3745
24351 " set-memsize memsize\n"
24356 #: ../fish/guestfish-actions.pod:3747
24358 "This sets the memory size in megabytes allocated to the qemu subprocess. "
24359 "This only has any effect if called before L</launch>."
24363 #: ../fish/guestfish-actions.pod:3758
24364 msgid "set-network"
24368 #: ../fish/guestfish-actions.pod:3760
24373 #: ../fish/guestfish-actions.pod:3762
24376 " set-network true|false\n"
24381 #: ../fish/guestfish-actions.pod:3770
24382 msgid "You must call this before calling L</launch>, otherwise it has no effect."
24386 #: ../fish/guestfish-actions.pod:3773
24391 #: ../fish/guestfish-actions.pod:3775
24396 #: ../fish/guestfish-actions.pod:3777
24399 " set-path searchpath\n"
24404 #: ../fish/guestfish-actions.pod:3786
24409 #: ../fish/guestfish-actions.pod:3788
24414 #: ../fish/guestfish-actions.pod:3790
24422 #: ../fish/guestfish-actions.pod:3810
24423 msgid "set-recovery-proc"
24427 #: ../fish/guestfish-actions.pod:3812
24428 msgid "recovery-proc"
24432 #: ../fish/guestfish-actions.pod:3814
24435 " set-recovery-proc true|false\n"
24440 #: ../fish/guestfish-actions.pod:3816
24442 "If this is called with the parameter C<false> then L</launch> does not "
24443 "create a recovery process. The purpose of the recovery process is to stop "
24444 "runaway qemu processes in the case where the main program aborts abruptly."
24448 #: ../fish/guestfish-actions.pod:3821
24450 "This only has any effect if called before L</launch>, and the default is "
24455 #: ../fish/guestfish-actions.pod:3830
24456 msgid "set-selinux"
24460 #: ../fish/guestfish-actions.pod:3832
24465 #: ../fish/guestfish-actions.pod:3834
24468 " set-selinux true|false\n"
24473 #: ../fish/guestfish-actions.pod:3845
24478 #: ../fish/guestfish-actions.pod:3847
24483 #: ../fish/guestfish-actions.pod:3849
24486 " set-trace true|false\n"
24491 #: ../fish/guestfish-actions.pod:3865
24492 msgid "set-verbose"
24496 #: ../fish/guestfish-actions.pod:3867
24501 #: ../fish/guestfish-actions.pod:3869
24504 " set-verbose true|false\n"
24509 #: ../fish/guestfish-actions.pod:3876
24514 #: ../fish/guestfish-actions.pod:3878
24517 " setcon context\n"
24522 #: ../fish/guestfish-actions.pod:3885
24527 #: ../fish/guestfish-actions.pod:3887
24530 " setxattr xattr val vallen path\n"
24535 #: ../fish/guestfish-actions.pod:3893
24536 msgid "See also: L</lsetxattr>, L<attr(5)>."
24540 #: ../fish/guestfish-actions.pod:3895
24545 #: ../fish/guestfish-actions.pod:3897
24548 " sfdisk device cyls heads sectors 'lines ...'\n"
24553 #: ../fish/guestfish-actions.pod:3919
24554 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
24558 #: ../fish/guestfish-actions.pod:3925
24563 #: ../fish/guestfish-actions.pod:3927
24566 " sfdiskM device 'lines ...'\n"
24571 #: ../fish/guestfish-actions.pod:3929
24573 "This is a simplified interface to the L</sfdisk> command, where partition "
24574 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
24575 "you don't need to specify the cyls, heads and sectors parameters which were "
24576 "rarely if ever used anyway."
24580 #: ../fish/guestfish-actions.pod:3935
24581 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
24585 #: ../fish/guestfish-actions.pod:3941
24590 #: ../fish/guestfish-actions.pod:3943
24593 " sfdisk-N device partnum cyls heads sectors line\n"
24598 #: ../fish/guestfish-actions.pod:3948
24600 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
24601 "cyls/heads/sectors parameters."
24605 #: ../fish/guestfish-actions.pod:3951
24606 msgid "See also: L</part-add>"
24610 #: ../fish/guestfish-actions.pod:3956
24611 msgid "sfdisk-disk-geometry"
24615 #: ../fish/guestfish-actions.pod:3958
24618 " sfdisk-disk-geometry device\n"
24623 #: ../fish/guestfish-actions.pod:3960
24625 "This displays the disk geometry of C<device> read from the partition table. "
24626 "Especially in the case where the underlying block device has been resized, "
24627 "this can be different from the kernel's idea of the geometry (see "
24628 "L</sfdisk-kernel-geometry>)."
24632 #: ../fish/guestfish-actions.pod:3968
24633 msgid "sfdisk-kernel-geometry"
24637 #: ../fish/guestfish-actions.pod:3970
24640 " sfdisk-kernel-geometry device\n"
24645 #: ../fish/guestfish-actions.pod:3977
24650 #: ../fish/guestfish-actions.pod:3979
24653 " sfdisk-l device\n"
24658 #: ../fish/guestfish-actions.pod:3985
24659 msgid "See also: L</part-list>"
24663 #: ../fish/guestfish-actions.pod:3987
24668 #: ../fish/guestfish-actions.pod:3989
24676 #: ../fish/guestfish-actions.pod:3994
24677 msgid "This is like L</command>, but passes the command to:"
24681 #: ../fish/guestfish-actions.pod:4002
24682 msgid "All the provisos about L</command> apply to this call."
24686 #: ../fish/guestfish-actions.pod:4004
24691 #: ../fish/guestfish-actions.pod:4006
24694 " sh-lines command\n"
24699 #: ../fish/guestfish-actions.pod:4008
24700 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24704 #: ../fish/guestfish-actions.pod:4011
24705 msgid "See also: L</command-lines>"
24709 #: ../fish/guestfish-actions.pod:4013
24714 #: ../fish/guestfish-actions.pod:4015
24722 #: ../fish/guestfish-actions.pod:4019
24727 #: ../fish/guestfish-actions.pod:4021
24735 #: ../fish/guestfish-actions.pod:4027
24740 #: ../fish/guestfish-actions.pod:4029
24748 #: ../fish/guestfish-actions.pod:4037
24753 #: ../fish/guestfish-actions.pod:4039
24761 #: ../fish/guestfish-actions.pod:4047
24766 #: ../fish/guestfish-actions.pod:4049
24769 " strings-e encoding path\n"
24774 #: ../fish/guestfish-actions.pod:4051
24776 "This is like the L</strings> command, but allows you to specify the encoding "
24777 "of strings that are looked for in the source file C<path>."
24781 #: ../fish/guestfish-actions.pod:4061
24783 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24784 "ISO-8859-X (this is what L</strings> uses)."
24788 #: ../fish/guestfish-actions.pod:4093
24789 msgid "swapoff-device"
24793 #: ../fish/guestfish-actions.pod:4095
24796 " swapoff-device device\n"
24801 #: ../fish/guestfish-actions.pod:4097
24803 "This command disables the libguestfs appliance swap device or partition "
24804 "named C<device>. See L</swapon-device>."
24808 #: ../fish/guestfish-actions.pod:4101
24809 msgid "swapoff-file"
24813 #: ../fish/guestfish-actions.pod:4103
24816 " swapoff-file file\n"
24821 #: ../fish/guestfish-actions.pod:4107
24822 msgid "swapoff-label"
24826 #: ../fish/guestfish-actions.pod:4109
24829 " swapoff-label label\n"
24834 #: ../fish/guestfish-actions.pod:4114
24835 msgid "swapoff-uuid"
24839 #: ../fish/guestfish-actions.pod:4116
24842 " swapoff-uuid uuid\n"
24847 #: ../fish/guestfish-actions.pod:4121
24848 msgid "swapon-device"
24852 #: ../fish/guestfish-actions.pod:4123
24855 " swapon-device device\n"
24860 #: ../fish/guestfish-actions.pod:4125
24862 "This command enables the libguestfs appliance to use the swap device or "
24863 "partition named C<device>. The increased memory is made available for all "
24864 "commands, for example those run using L</command> or L</sh>."
24868 #: ../fish/guestfish-actions.pod:4137
24869 msgid "swapon-file"
24873 #: ../fish/guestfish-actions.pod:4139
24876 " swapon-file file\n"
24881 #: ../fish/guestfish-actions.pod:4141
24882 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
24886 #: ../fish/guestfish-actions.pod:4144
24887 msgid "swapon-label"
24891 #: ../fish/guestfish-actions.pod:4146
24894 " swapon-label label\n"
24899 #: ../fish/guestfish-actions.pod:4148
24901 "This command enables swap to a labeled swap partition. See "
24902 "L</swapon-device> for other notes."
24906 #: ../fish/guestfish-actions.pod:4151
24907 msgid "swapon-uuid"
24911 #: ../fish/guestfish-actions.pod:4153
24914 " swapon-uuid uuid\n"
24919 #: ../fish/guestfish-actions.pod:4155
24921 "This command enables swap to a swap partition with the given UUID. See "
24922 "L</swapon-device> for other notes."
24926 #: ../fish/guestfish-actions.pod:4158
24931 #: ../fish/guestfish-actions.pod:4160
24939 #: ../fish/guestfish-actions.pod:4168
24944 #: ../fish/guestfish-actions.pod:4170
24952 #: ../fish/guestfish-actions.pod:4178
24957 #: ../fish/guestfish-actions.pod:4180
24960 " tail-n nrlines path\n"
24965 #: ../fish/guestfish-actions.pod:4193
24970 #: ../fish/guestfish-actions.pod:4195
24973 " tar-in (tarfile|-) directory\n"
24978 #: ../fish/guestfish-actions.pod:4200
24979 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24983 #: ../fish/guestfish-actions.pod:4205
24988 #: ../fish/guestfish-actions.pod:4207
24991 " tar-out directory (tarfile|-)\n"
24996 #: ../fish/guestfish-actions.pod:4212
24997 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
25001 #: ../fish/guestfish-actions.pod:4217
25006 #: ../fish/guestfish-actions.pod:4219
25009 " tgz-in (tarball|-) directory\n"
25014 #: ../fish/guestfish-actions.pod:4224
25015 msgid "To upload an uncompressed tarball, use L</tar-in>."
25019 #: ../fish/guestfish-actions.pod:4228
25024 #: ../fish/guestfish-actions.pod:4230
25027 " tgz-out directory (tarball|-)\n"
25032 #: ../fish/guestfish-actions.pod:4235
25033 msgid "To download an uncompressed tarball, use L</tar-out>."
25037 #: ../fish/guestfish-actions.pod:4239
25042 #: ../fish/guestfish-actions.pod:4241
25050 #: ../fish/guestfish-actions.pod:4250
25055 #: ../fish/guestfish-actions.pod:4252
25063 #: ../fish/guestfish-actions.pod:4257
25064 msgid "truncate-size"
25068 #: ../fish/guestfish-actions.pod:4259
25071 " truncate-size path size\n"
25076 #: ../fish/guestfish-actions.pod:4264
25078 "If the current file size is less than C<size> then the file is extended to "
25079 "the required size with zero bytes. This creates a sparse file (ie. disk "
25080 "blocks are not allocated for the file until you write to it). To create a "
25081 "non-sparse file of zeroes, use L</fallocate64> instead."
25085 #: ../fish/guestfish-actions.pod:4270
25090 #: ../fish/guestfish-actions.pod:4272
25093 " tune2fs-l device\n"
25098 #: ../fish/guestfish-actions.pod:4282
25103 #: ../fish/guestfish-actions.pod:4284
25106 " txz-in (tarball|-) directory\n"
25111 #: ../fish/guestfish-actions.pod:4291
25116 #: ../fish/guestfish-actions.pod:4293
25119 " txz-out directory (tarball|-)\n"
25124 #: ../fish/guestfish-actions.pod:4300
25129 #: ../fish/guestfish-actions.pod:4302
25137 #: ../fish/guestfish-actions.pod:4316
25138 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
25142 #: ../fish/guestfish-actions.pod:4321
25147 #: ../fish/guestfish-actions.pod:4323
25152 #: ../fish/guestfish-actions.pod:4325
25155 " umount pathordevice\n"
25160 #: ../fish/guestfish-actions.pod:4331
25165 #: ../fish/guestfish-actions.pod:4333
25166 msgid "unmount-all"
25170 #: ../fish/guestfish-actions.pod:4335
25178 #: ../fish/guestfish-actions.pod:4341
25183 #: ../fish/guestfish-actions.pod:4343
25186 " upload (filename|-) remotefilename\n"
25191 #: ../fish/guestfish-actions.pod:4350
25192 msgid "See also L</download>."
25196 #: ../fish/guestfish-actions.pod:4354
25197 msgid "upload-offset"
25201 #: ../fish/guestfish-actions.pod:4356
25204 " upload-offset (filename|-) remotefilename offset\n"
25209 #: ../fish/guestfish-actions.pod:4368
25211 "Note that there is no limit on the amount of data that can be uploaded with "
25212 "this call, unlike with L</pwrite>, and this call always writes the full "
25213 "amount unless an error occurs."
25217 #: ../fish/guestfish-actions.pod:4373
25218 msgid "See also L</upload>, L</pwrite>."
25222 #: ../fish/guestfish-actions.pod:4377
25227 #: ../fish/guestfish-actions.pod:4379
25230 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
25235 #: ../fish/guestfish-actions.pod:4398
25240 #: ../fish/guestfish-actions.pod:4400
25248 #: ../fish/guestfish-actions.pod:4427
25250 "I<Note:> Don't use this call to test for availability of features. In "
25251 "enterprise distributions we backport features from later versions into "
25252 "earlier versions, making this an unreliable way to test for features. Use "
25253 "L</available> instead."
25257 #: ../fish/guestfish-actions.pod:4433
25262 #: ../fish/guestfish-actions.pod:4435
25265 " vfs-label device\n"
25270 #: ../fish/guestfish-actions.pod:4442
25271 msgid "To find a filesystem from the label, use L</findfs-label>."
25275 #: ../fish/guestfish-actions.pod:4444
25280 #: ../fish/guestfish-actions.pod:4446
25283 " vfs-type device\n"
25288 #: ../fish/guestfish-actions.pod:4456
25293 #: ../fish/guestfish-actions.pod:4458
25296 " vfs-uuid device\n"
25301 #: ../fish/guestfish-actions.pod:4465
25302 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
25306 #: ../fish/guestfish-actions.pod:4467
25307 msgid "vg-activate"
25311 #: ../fish/guestfish-actions.pod:4469
25314 " vg-activate true|false 'volgroups ...'\n"
25319 #: ../fish/guestfish-actions.pod:4482
25320 msgid "vg-activate-all"
25324 #: ../fish/guestfish-actions.pod:4484
25327 " vg-activate-all true|false\n"
25332 #: ../fish/guestfish-actions.pod:4494
25337 #: ../fish/guestfish-actions.pod:4496
25340 " vgcreate volgroup 'physvols ...'\n"
25345 #: ../fish/guestfish-actions.pod:4501
25350 #: ../fish/guestfish-actions.pod:4503
25353 " vglvuuids vgname\n"
25358 #: ../fish/guestfish-actions.pod:4508
25360 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
25361 "logical volumes and volume groups."
25365 #: ../fish/guestfish-actions.pod:4511
25366 msgid "See also L</vgpvuuids>."
25370 #: ../fish/guestfish-actions.pod:4513
25375 #: ../fish/guestfish-actions.pod:4515
25378 " vgpvuuids vgname\n"
25383 #: ../fish/guestfish-actions.pod:4520
25385 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
25386 "physical volumes and volume groups."
25390 #: ../fish/guestfish-actions.pod:4523
25391 msgid "See also L</vglvuuids>."
25395 #: ../fish/guestfish-actions.pod:4525
25400 #: ../fish/guestfish-actions.pod:4527
25403 " vgremove vgname\n"
25408 #: ../fish/guestfish-actions.pod:4534
25413 #: ../fish/guestfish-actions.pod:4536
25416 " vgrename volgroup newvolgroup\n"
25421 #: ../fish/guestfish-actions.pod:4540
25426 #: ../fish/guestfish-actions.pod:4542
25434 #: ../fish/guestfish-actions.pod:4550
25435 msgid "See also L</vgs-full>."
25439 #: ../fish/guestfish-actions.pod:4552
25444 #: ../fish/guestfish-actions.pod:4554
25452 #: ../fish/guestfish-actions.pod:4559
25457 #: ../fish/guestfish-actions.pod:4561
25465 #: ../fish/guestfish-actions.pod:4566
25470 #: ../fish/guestfish-actions.pod:4568
25478 #: ../fish/guestfish-actions.pod:4572
25483 #: ../fish/guestfish-actions.pod:4574
25491 #: ../fish/guestfish-actions.pod:4579
25496 #: ../fish/guestfish-actions.pod:4581
25504 #: ../fish/guestfish-actions.pod:4586
25509 #: ../fish/guestfish-actions.pod:4588
25517 #: ../fish/guestfish-actions.pod:4593
25522 #: ../fish/guestfish-actions.pod:4595
25525 " write path content\n"
25530 #: ../fish/guestfish-actions.pod:4603
25535 #: ../fish/guestfish-actions.pod:4605
25538 " write-file path content size\n"
25543 #: ../fish/guestfish-actions.pod:4628
25548 #: ../fish/guestfish-actions.pod:4630
25551 " zegrep regex path\n"
25556 #: ../fish/guestfish-actions.pod:4638
25561 #: ../fish/guestfish-actions.pod:4640
25564 " zegrepi regex path\n"
25569 #: ../fish/guestfish-actions.pod:4648
25574 #: ../fish/guestfish-actions.pod:4650
25582 #: ../fish/guestfish-actions.pod:4658
25583 msgid "See also: L</zero-device>, L</scrub-device>."
25587 #: ../fish/guestfish-actions.pod:4660
25588 msgid "zero-device"
25592 #: ../fish/guestfish-actions.pod:4662
25595 " zero-device device\n"
25600 #: ../fish/guestfish-actions.pod:4664
25602 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
25603 "which just zeroes the first few blocks of a device."
25607 #: ../fish/guestfish-actions.pod:4671
25612 #: ../fish/guestfish-actions.pod:4673
25615 " zerofree device\n"
25620 #: ../fish/guestfish-actions.pod:4686
25625 #: ../fish/guestfish-actions.pod:4688
25628 " zfgrep pattern path\n"
25633 #: ../fish/guestfish-actions.pod:4696
25638 #: ../fish/guestfish-actions.pod:4698
25641 " zfgrepi pattern path\n"
25646 #: ../fish/guestfish-actions.pod:4706
25651 #: ../fish/guestfish-actions.pod:4708
25654 " zfile meth path\n"
25659 #: ../fish/guestfish-actions.pod:4715
25660 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
25664 #: ../fish/guestfish-actions.pod:4725
25669 #: ../fish/guestfish-actions.pod:4727
25672 " zgrep regex path\n"
25677 #: ../fish/guestfish-actions.pod:4735
25682 #: ../fish/guestfish-actions.pod:4737
25685 " zgrepi regex path\n"
25690 #: ../fish/guestfish-commands.pod:1
25695 #: ../fish/guestfish-commands.pod:3
25700 #: ../fish/guestfish-commands.pod:5
25703 " alloc filename size\n"
25708 #: ../fish/guestfish-commands.pod:7
25710 "This creates an empty (zeroed) file of the given size, and then adds so it "
25711 "can be further examined."
25715 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25716 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25720 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25721 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25725 #: ../fish/guestfish-commands.pod:14
25727 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25728 "image, see L</PREPARED DISK IMAGES>."
25732 #: ../fish/guestfish-commands.pod:17
25737 #: ../fish/guestfish-commands.pod:19
25740 " copy-in local [local ...] /remotedir\n"
25745 #: ../fish/guestfish-commands.pod:21
25747 "C<copy-in> copies local files or directories recursively into the disk "
25748 "image, placing them in the directory called C</remotedir> (which must "
25749 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25750 "other commands as necessary."
25754 #: ../fish/guestfish-commands.pod:26
25756 "Multiple local files and directories can be specified, but the last "
25757 "parameter must always be a remote directory. Wildcards cannot be used."
25761 #: ../fish/guestfish-commands.pod:30
25766 #: ../fish/guestfish-commands.pod:32
25769 " copy-out remote [remote ...] localdir\n"
25774 #: ../fish/guestfish-commands.pod:34
25776 "C<copy-out> copies remote files or directories recursively out of the disk "
25777 "image, placing them on the host disk in a local directory called C<localdir> "
25778 "(which must exist). This guestfish meta-command turns into a sequence of "
25779 "L</download>, L</tar-out> and other commands as necessary."
25783 #: ../fish/guestfish-commands.pod:40
25785 "Multiple remote files and directories can be specified, but the last "
25786 "parameter must always be a local directory. To download to the current "
25787 "directory, use C<.> as in:"
25791 #: ../fish/guestfish-commands.pod:44
25794 " copy-out /home .\n"
25799 #: ../fish/guestfish-commands.pod:46
25801 "Wildcards cannot be used in the ordinary command, but you can use them with "
25802 "the help of L</glob> like this:"
25806 #: ../fish/guestfish-commands.pod:49
25809 " glob copy-out /home/* .\n"
25814 #: ../fish/guestfish-commands.pod:51
25819 #: ../fish/guestfish-commands.pod:53
25822 " echo [params ...]\n"
25827 #: ../fish/guestfish-commands.pod:55
25828 msgid "This echos the parameters to the terminal."
25832 #: ../fish/guestfish-commands.pod:57
25837 #: ../fish/guestfish-commands.pod:59
25842 #: ../fish/guestfish-commands.pod:61
25847 #: ../fish/guestfish-commands.pod:63
25855 #: ../fish/guestfish-commands.pod:65
25857 "This is used to edit a file. It downloads the file, edits it locally using "
25858 "your editor, then uploads the result."
25862 #: ../fish/guestfish-commands.pod:68
25864 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25865 "or C<emacs> you will get those corresponding editors."
25869 #: ../fish/guestfish-commands.pod:72
25874 #: ../fish/guestfish-commands.pod:74
25877 " glob command args...\n"
25882 #: ../fish/guestfish-commands.pod:76
25884 "Expand wildcards in any paths in the args list, and run C<command> "
25885 "repeatedly on each matching path."
25889 #: ../fish/guestfish-commands.pod:79
25890 msgid "See L</WILDCARDS AND GLOBBING>."
25894 #: ../fish/guestfish-commands.pod:81
25899 #: ../fish/guestfish-commands.pod:83
25902 " hexedit <filename|device>\n"
25903 " hexedit <filename|device> <max>\n"
25904 " hexedit <filename|device> <start> <max>\n"
25909 #: ../fish/guestfish-commands.pod:87
25911 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25916 #: ../fish/guestfish-commands.pod:90
25918 "This command works by downloading potentially the whole file or device, "
25919 "editing it locally, then uploading it. If the file or device is large, you "
25920 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25921 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25922 "usual modifiers allowed such as C<1M> (1 megabyte)."
25926 #: ../fish/guestfish-commands.pod:97
25927 msgid "For example to edit the first few sectors of a disk you might do:"
25931 #: ../fish/guestfish-commands.pod:100
25934 " hexedit /dev/sda 1M\n"
25939 #: ../fish/guestfish-commands.pod:102
25941 "which would allow you to edit anywhere within the first megabyte of the "
25946 #: ../fish/guestfish-commands.pod:105
25947 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25951 #: ../fish/guestfish-commands.pod:107
25954 " hexedit /dev/sda1 0x400 0x400\n"
25959 #: ../fish/guestfish-commands.pod:109
25960 msgid "(assuming the superblock is in the standard location)."
25964 #: ../fish/guestfish-commands.pod:111
25966 "This command requires the external L<hexedit(1)> program. You can specify "
25967 "another program to use by setting the C<HEXEDITOR> environment variable."
25971 #: ../fish/guestfish-commands.pod:115
25972 msgid "See also L</hexdump>."
25976 #: ../fish/guestfish-commands.pod:117
25981 #: ../fish/guestfish-commands.pod:119
25989 #: ../fish/guestfish-commands.pod:121
25990 msgid "Change the local directory, ie. the current directory of guestfish itself."
25994 #: ../fish/guestfish-commands.pod:124
25995 msgid "Note that C<!cd> won't do what you might expect."
25999 #: ../fish/guestfish-commands.pod:126
26004 #: ../fish/guestfish-commands.pod:128
26009 #: ../fish/guestfish-commands.pod:130
26017 #: ../fish/guestfish-commands.pod:132
26018 msgid "Opens the manual page for guestfish."
26022 #: ../fish/guestfish-commands.pod:134
26027 #: ../fish/guestfish-commands.pod:136
26032 #: ../fish/guestfish-commands.pod:138
26040 #: ../fish/guestfish-commands.pod:140
26048 #: ../fish/guestfish-commands.pod:142
26049 msgid "This is used to view a file."
26053 #: ../fish/guestfish-commands.pod:144
26055 "The default viewer is C<$PAGER>. However if you use the alternate command "
26056 "C<less> you will get the C<less> command specifically."
26060 #: ../fish/guestfish-commands.pod:147
26065 #: ../fish/guestfish-commands.pod:149
26073 #: ../fish/guestfish-commands.pod:151
26075 "Close and reopen the libguestfs handle. It is not necessary to use this "
26076 "normally, because the handle is closed properly when guestfish exits. "
26077 "However this is occasionally useful for testing."
26081 #: ../fish/guestfish-commands.pod:155
26086 #: ../fish/guestfish-commands.pod:157
26089 " sparse filename size\n"
26094 #: ../fish/guestfish-commands.pod:159
26096 "This creates an empty sparse file of the given size, and then adds so it can "
26097 "be further examined."
26101 #: ../fish/guestfish-commands.pod:162
26103 "In all respects it works the same as the L</alloc> command, except that the "
26104 "image file is allocated sparsely, which means that disk blocks are not "
26105 "assigned to the file until they are needed. Sparse disk files only use "
26106 "space when written to, but they are slower and there is a danger you could "
26107 "run out of real disk space during a write operation."
26111 #: ../fish/guestfish-commands.pod:172
26116 #: ../fish/guestfish-commands.pod:174
26124 #: ../fish/guestfish-commands.pod:176
26126 "This command returns a list of the optional groups known to the daemon, and "
26127 "indicates which ones are supported by this build of the libguestfs "
26132 #: ../fish/guestfish-commands.pod:180
26133 msgid "See also L<guestfs(3)/AVAILABILITY>."
26137 #: ../fish/guestfish-commands.pod:182
26142 #: ../fish/guestfish-commands.pod:184
26145 " time command args...\n"
26150 #: ../fish/guestfish-commands.pod:186
26152 "Run the command as usual, but print the elapsed time afterwards. This can "
26153 "be useful for benchmarking operations."
26157 #: ../test-tool/libguestfs-test-tool.pod:5
26158 msgid "libguestfs-test-tool - End user tests for libguestfs"
26162 #: ../test-tool/libguestfs-test-tool.pod:9
26165 " libguestfs-test-tool [--options]\n"
26170 #: ../test-tool/libguestfs-test-tool.pod:13
26172 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
26173 "and developers, to allow them to check basic libguestfs functionality is "
26174 "working. This is needed because libguestfs occasionally breaks for reasons "
26175 "beyond our control: usually because of changes in the underlying qemu or "
26176 "kernel packages, or the host environment."
26180 #: ../test-tool/libguestfs-test-tool.pod:20
26181 msgid "If you suspect a problem in libguestfs, then just run:"
26185 #: ../test-tool/libguestfs-test-tool.pod:22
26188 " libguestfs-test-tool\n"
26193 #: ../test-tool/libguestfs-test-tool.pod:24
26194 msgid "It will print lots of diagnostic messages."
26198 #: ../test-tool/libguestfs-test-tool.pod:26
26199 msgid "If it runs to completion successfully, you will see this near the end:"
26203 #: ../test-tool/libguestfs-test-tool.pod:28
26206 " ===== TEST FINISHED OK =====\n"
26211 #: ../test-tool/libguestfs-test-tool.pod:30
26212 msgid "and the test tool will exit with code 0."
26216 #: ../test-tool/libguestfs-test-tool.pod:32
26218 "If it fails (and/or exits with non-zero error code), please paste the "
26219 "B<complete, unedited> output of the test tool into a bug report. More "
26220 "information about reporting bugs can be found on the "
26221 "L<http://libguestfs.org/> website."
26225 #: ../test-tool/libguestfs-test-tool.pod:41
26230 #: ../test-tool/libguestfs-test-tool.pod:43
26231 msgid "Display short usage information and exit."
26235 #: ../test-tool/libguestfs-test-tool.pod:45
26236 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
26240 #: ../test-tool/libguestfs-test-tool.pod:47
26242 "Pass an alternate name for the helper program. libguestfs-test-tool will "
26243 "normally look in the C<$libexec> directory that was configured when the tool "
26248 #: ../test-tool/libguestfs-test-tool.pod:51
26249 msgid "I<--qemu qemu_binary>"
26253 #: ../test-tool/libguestfs-test-tool.pod:53
26255 "If you have downloaded another qemu binary, point this option at the full "
26256 "path of the binary to try it."
26260 #: ../test-tool/libguestfs-test-tool.pod:56
26261 msgid "I<--qemudir qemu_source_dir>"
26265 #: ../test-tool/libguestfs-test-tool.pod:58
26267 "If you have compiled qemu from source, point this option at the source "
26268 "directory to try it."
26272 #: ../test-tool/libguestfs-test-tool.pod:61
26273 msgid "I<--timeout N>"
26277 #: ../test-tool/libguestfs-test-tool.pod:63
26279 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
26280 "does not usually need to be adjusted unless your machine is very slow."
26284 #: ../test-tool/libguestfs-test-tool.pod:69
26285 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
26289 #: ../test-tool/libguestfs-test-tool.pod:71
26291 "If you have compiled another version of qemu from source and would like to "
26292 "try that, then you can use the I<--qemudir> option to point to the qemu "
26293 "source directory."
26297 #: ../test-tool/libguestfs-test-tool.pod:75
26299 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
26300 "option to point to the binary."
26304 #: ../test-tool/libguestfs-test-tool.pod:78
26306 "When using an alternate qemu with libguestfs, usually you would need to "
26307 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
26308 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
26309 "when you use either of the I<--qemudir> or I<--qemu> options."
26313 #: ../test-tool/libguestfs-test-tool.pod:85
26315 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
26316 "I<1> if there was an error."
26320 #: ../test-tool/libguestfs-test-tool.pod:92
26321 msgid "/usr/libexec/libguestfs-test-tool-helper"
26325 #: ../test-tool/libguestfs-test-tool.pod:94
26327 "This helper program is run inside the appliance and provides additional "
26332 #: ../test-tool/libguestfs-test-tool.pod:97
26333 msgid "/usr/bin/mkisofs"
26337 #: ../test-tool/libguestfs-test-tool.pod:99
26339 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
26340 "which is used as part of the tests."
26344 #: ../test-tool/libguestfs-test-tool.pod:106
26346 "For the full list of environment variables which may affect libguestfs, "
26347 "please see the L<guestfs(3)> manual page."
26351 #: ../test-tool/libguestfs-test-tool.pod:111
26352 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
26356 #: ../test-tool/libguestfs-test-tool.pod:121
26357 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
26361 #: ../fuse/guestmount.pod:5
26362 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
26366 #: ../fuse/guestmount.pod:9
26369 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
26374 #: ../fuse/guestmount.pod:11
26377 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
26382 #: ../fuse/guestmount.pod:13
26385 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
26390 #: ../fuse/guestmount.pod:17
26392 "You must I<not> use C<guestmount> in read-write mode on live virtual "
26393 "machines. If you do this, you risk disk corruption in the VM."
26397 #: ../fuse/guestmount.pod:22
26399 "The guestmount program can be used to mount virtual machine filesystems and "
26400 "other disk images on the host. It uses libguestfs for access to the guest "
26401 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
26402 "a mountable device."
26406 #: ../fuse/guestmount.pod:27
26408 "Along with other options, you have to give at least one device (I<-a> "
26409 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
26410 "option) or use the I<-i> inspection option. How this works is better "
26411 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
26416 #: ../fuse/guestmount.pod:33
26418 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
26419 "by you, and the filesystem will not be visible to any other users unless you "
26420 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
26421 "the filesystem, use the C<fusermount -u> command."
26425 #: ../fuse/guestmount.pod:41
26427 "For a typical Windows guest which has its main filesystem on the first "
26432 #: ../fuse/guestmount.pod:44
26435 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
26440 #: ../fuse/guestmount.pod:46
26442 "For a typical Linux guest which has a /boot filesystem on the first "
26443 "partition, and the root filesystem on a logical volume:"
26447 #: ../fuse/guestmount.pod:49
26450 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
26455 #: ../fuse/guestmount.pod:51
26456 msgid "To get libguestfs to detect guest mountpoints for you:"
26460 #: ../fuse/guestmount.pod:53
26463 " guestmount -a guest.img -i --ro /mnt\n"
26468 #: ../fuse/guestmount.pod:55
26469 msgid "For a libvirt guest called \"Guest\" you could do:"
26473 #: ../fuse/guestmount.pod:57
26476 " guestmount -d Guest -i --ro /mnt\n"
26481 #: ../fuse/guestmount.pod:59
26483 "If you don't know what filesystems are contained in a guest or disk image, "
26484 "use L<virt-filesystems(1)> first:"
26488 #: ../fuse/guestmount.pod:62
26491 " virt-filesystems MyGuest\n"
26496 #: ../fuse/guestmount.pod:64
26498 "If you want to trace the libguestfs calls but without excessive debugging "
26499 "information, we recommend:"
26503 #: ../fuse/guestmount.pod:67
26506 " guestmount [...] --trace /mnt\n"
26511 #: ../fuse/guestmount.pod:69
26512 msgid "If you want to debug the program, we recommend:"
26516 #: ../fuse/guestmount.pod:71
26519 " guestmount [...] --trace --verbose /mnt\n"
26524 #: ../fuse/guestmount.pod:77
26525 msgid "B<-a image> | B<--add image>"
26529 #: ../fuse/guestmount.pod:79
26530 msgid "Add a block device or virtual machine image."
26534 #: ../fuse/guestmount.pod:84
26535 msgid "B<-c URI> | B<--connect URI>"
26539 #: ../fuse/guestmount.pod:90
26540 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
26544 #: ../fuse/guestmount.pod:96
26545 msgid "B<--dir-cache-timeout N>"
26549 #: ../fuse/guestmount.pod:98
26551 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
26552 "seconds. The readdir cache [actually, there are several semi-independent "
26553 "caches] is populated after a readdir(2) call with the stat and extended "
26554 "attributes of the files in the directory, in anticipation that they will be "
26555 "requested soon after."
26559 #: ../fuse/guestmount.pod:104
26561 "There is also a different attribute cache implemented by FUSE (see the FUSE "
26562 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
26563 "requests, only cache existing ones."
26567 #: ../fuse/guestmount.pod:115
26568 msgid "B<--format=raw|qcow2|..> | B<--format>"
26572 #: ../fuse/guestmount.pod:122
26574 "If you have untrusted raw-format guest disk images, you should use this "
26575 "option to specify the disk format. This avoids a possible security problem "
26576 "with malicious guests (CVE-2010-3851). See also "
26577 "L<guestfs(3)/guestfs_add_drive_opts>."
26581 #: ../fuse/guestmount.pod:127
26582 msgid "B<--fuse-help>"
26586 #: ../fuse/guestmount.pod:129
26587 msgid "Display help on special FUSE options (see I<-o> below)."
26591 #: ../fuse/guestmount.pod:133
26592 msgid "Display brief help and exit."
26596 #: ../fuse/guestmount.pod:135
26597 msgid "B<-i> | B<--inspector>"
26601 #: ../fuse/guestmount.pod:146
26602 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
26606 #: ../fuse/guestmount.pod:148
26608 "Mount the named partition or logical volume on the given mountpoint B<in the "
26609 "guest> (this has nothing to do with mountpoints in the host)."
26613 #: ../fuse/guestmount.pod:151
26615 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
26616 "something on C</>."
26620 #: ../fuse/guestmount.pod:154
26621 msgid "B<-n> | B<--no-sync>"
26625 #: ../fuse/guestmount.pod:156
26627 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
26628 "unmounted. If you specify this option, then we don't attempt to sync the "
26629 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
26633 #: ../fuse/guestmount.pod:161
26634 msgid "B<-o option> | B<--option option>"
26638 #: ../fuse/guestmount.pod:163
26639 msgid "Pass extra options to FUSE."
26643 #: ../fuse/guestmount.pod:165
26645 "To get a list of all the extra options supported by FUSE, use the command "
26646 "below. Note that only the FUSE I<-o> options can be passed, and only some "
26647 "of them are a good idea."
26651 #: ../fuse/guestmount.pod:169
26654 " guestmount --fuse-help\n"
26659 #: ../fuse/guestmount.pod:171
26660 msgid "Some potentially useful FUSE options:"
26664 #: ../fuse/guestmount.pod:175
26665 msgid "B<-o allow_other>"
26669 #: ../fuse/guestmount.pod:177
26670 msgid "Allow other users to see the filesystem."
26674 #: ../fuse/guestmount.pod:179
26675 msgid "B<-o attr_timeout=N>"
26679 #: ../fuse/guestmount.pod:181
26680 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
26684 #: ../fuse/guestmount.pod:183
26685 msgid "B<-o kernel_cache>"
26689 #: ../fuse/guestmount.pod:185
26691 "Allow the kernel to cache files (reduces the number of reads that have to go "
26692 "through the L<guestfs(3)> API). This is generally a good idea if you can "
26693 "afford the extra memory usage."
26697 #: ../fuse/guestmount.pod:189
26698 msgid "B<-o uid=N> B<-o gid=N>"
26702 #: ../fuse/guestmount.pod:191
26704 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
26705 "the chosen values."
26709 #: ../fuse/guestmount.pod:196
26710 msgid "B<-r> | B<--ro>"
26714 #: ../fuse/guestmount.pod:198
26716 "Add devices and mount everything read-only. Also disallow writes and make "
26717 "the disk appear read-only to FUSE."
26721 #: ../fuse/guestmount.pod:201
26723 "This is highly recommended if you are not going to edit the guest disk. If "
26724 "the guest is running and this option is I<not> supplied, then there is a "
26725 "strong risk of disk corruption in the guest. We try to prevent this from "
26726 "happening, but it is not always possible."
26730 #: ../fuse/guestmount.pod:206
26731 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26735 #: ../fuse/guestmount.pod:210
26736 msgid "Enable SELinux support for the guest."
26740 #: ../fuse/guestmount.pod:212
26741 msgid "B<-v> | B<--verbose>"
26745 #: ../fuse/guestmount.pod:214
26746 msgid "Enable verbose messages from underlying libguestfs."
26750 #: ../fuse/guestmount.pod:216
26751 msgid "B<-V> | B<--version>"
26755 #: ../fuse/guestmount.pod:218
26756 msgid "Display the program version and exit."
26760 #: ../fuse/guestmount.pod:220
26761 msgid "B<-w> | B<--rw>"
26765 #: ../fuse/guestmount.pod:222
26767 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26768 "FOR READ AND WRITE>."
26772 #: ../fuse/guestmount.pod:225
26773 msgid "B<-x> | B<--trace>"
26777 #: ../fuse/guestmount.pod:227
26778 msgid "Trace libguestfs calls and entry into each FUSE function."
26782 #: ../fuse/guestmount.pod:229
26783 msgid "This also stops the daemon from forking into the background."
26787 #: ../fuse/guestmount.pod:235
26789 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26790 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
26791 "L<http://fuse.sf.net/>."
26795 #: ../tools/virt-edit.pl:34
26796 msgid "virt-edit - Edit a file in a virtual machine"
26800 #: ../tools/virt-edit.pl:38
26803 " virt-edit [--options] domname file\n"
26808 #: ../tools/virt-edit.pl:40
26811 " virt-edit [--options] disk.img [disk.img ...] file\n"
26816 #: ../tools/virt-edit.pl:42
26819 " virt-edit [domname|disk.img] file -e 'expr'\n"
26824 #: ../tools/virt-edit.pl:46
26826 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26827 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26828 "doing this, but doesn't catch all cases."
26832 #: ../tools/virt-edit.pl:52
26834 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26835 "the named virtual machine (or disk image)."
26839 #: ../tools/virt-edit.pl:55
26840 msgid "If you want to just view a file, use L<virt-cat(1)>."
26844 #: ../tools/virt-edit.pl:57
26846 "For more complex cases you should look at the L<guestfish(1)> tool (see "
26847 "L</USING GUESTFISH> below)."
26851 #: ../tools/virt-edit.pl:60
26853 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
26854 "files. L<guestfish(1)> can do that and much more."
26858 #: ../tools/virt-edit.pl:65
26859 msgid "Edit the named files interactively:"
26863 #: ../tools/virt-edit.pl:67
26866 " virt-edit mydomain /boot/grub/grub.conf\n"
26871 #: ../tools/virt-edit.pl:69
26874 " virt-edit mydomain /etc/passwd\n"
26879 #: ../tools/virt-edit.pl:71
26881 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26882 "below). To change the init default level to 5:"
26886 #: ../tools/virt-edit.pl:75
26889 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26894 #: ../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
26895 msgid "Display brief help."
26899 #: ../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
26900 msgid "Display version number and exit."
26904 #: ../tools/virt-edit.pl:101
26905 msgid "B<--backup extension> | B<-b extension>"
26909 #: ../tools/virt-edit.pl:103
26911 "Create a backup of the original file I<in the guest disk image>. The backup "
26912 "has the original filename with C<extension> added."
26916 #: ../tools/virt-edit.pl:106
26918 "Usually the first character of C<extension> would be a dot C<.> so you would "
26923 #: ../tools/virt-edit.pl:109
26926 " virt-edit -b .orig [etc]\n"
26931 #: ../tools/virt-edit.pl:111
26932 msgid "By default, no backup file is made."
26936 #: ../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
26937 msgid "B<--connect URI> | B<-c URI>"
26941 #: ../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
26943 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26944 "to the default libvirt hypervisor."
26948 #: ../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
26950 "If you specify guest block devices directly, then libvirt is not used at "
26955 #: ../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
26956 msgid "B<--format> raw"
26960 #: ../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
26962 "Specify the format of disk images given on the command line. If this is "
26963 "omitted then the format is autodetected from the content of the disk image."
26967 #: ../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
26969 "If disk images are requested from libvirt, then this program asks libvirt "
26970 "for this information. In this case, the value of the format parameter is "
26975 #: ../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
26977 "If working with untrusted raw-format guest disk images, you should ensure "
26978 "the format is always specified."
26982 #: ../tools/virt-edit.pl:146
26983 msgid "B<--expr EXPR> | B<-e EXPR>"
26987 #: ../tools/virt-edit.pl:148
26989 "Instead of launching the external editor, non-interactively apply the Perl "
26990 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26995 #: ../tools/virt-edit.pl:152
26997 "Be careful to properly quote the expression to prevent it from being altered "
27002 #: ../tools/virt-edit.pl:272
27003 msgid "NON-INTERACTIVE EDITING"
27007 #: ../tools/virt-edit.pl:274
27009 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
27010 "administrator can interactively edit the file."
27014 #: ../tools/virt-edit.pl:277
27016 "There are two ways also to use C<virt-edit> from scripts in order to make "
27017 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
27018 "like this, it's less error-prone to write scripts directly using the "
27019 "libguestfs API and Augeas for configuration file editing.)"
27023 #: ../tools/virt-edit.pl:283
27025 "The first method is to temporarily set C<$EDITOR> to any script or program "
27026 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
27027 "update C<tmpfile> in place however it likes."
27031 #: ../tools/virt-edit.pl:287
27033 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
27034 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
27035 "instances of C<foo> with C<bar> in a file:"
27039 #: ../tools/virt-edit.pl:291
27042 " virt-edit domname filename -e 's/foo/bar/'\n"
27047 #: ../tools/virt-edit.pl:293
27049 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
27050 "For example to delete root's password you could do:"
27054 #: ../tools/virt-edit.pl:296
27057 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
27062 #: ../tools/virt-edit.pl:298
27064 "What really happens is that the snippet is evaluated as a Perl expression "
27065 "for each line of the file. The line, including the final C<\\n>, is passed "
27066 "in C<$_> and the expression should update C<$_> or leave it unchanged."
27070 #: ../tools/virt-edit.pl:303
27072 "To delete a line, set C<$_> to the empty string. For example, to delete the "
27073 "C<apache> user account from the password file you can do:"
27077 #: ../tools/virt-edit.pl:306
27080 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
27085 #: ../tools/virt-edit.pl:308
27087 "To insert a line, prepend or append it to C<$_>. However appending lines to "
27088 "the end of the file is rather difficult this way since there is no concept "
27089 "of \"last line of the file\" - your expression just doesn't get called "
27090 "again. You might want to use the first method (setting C<$EDITOR>) if you "
27095 #: ../tools/virt-edit.pl:314
27097 "The variable C<$lineno> contains the current line number. As is "
27098 "traditional, the first line in the file is number C<1>."
27102 #: ../tools/virt-edit.pl:317
27104 "The return value from the expression is ignored, but the expression may call "
27105 "C<die> in order to abort the whole program, leaving the original file "
27110 #: ../tools/virt-edit.pl:321
27112 "Remember when matching the end of a line that C<$_> may contain the final "
27113 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
27114 "newline then neither of these. Thus to match or substitute some text at the "
27115 "end of a line, use this regular expression:"
27119 #: ../tools/virt-edit.pl:326
27122 " /some text(\\r?\\n)?$/\n"
27127 #: ../tools/virt-edit.pl:328
27129 "Alternately, use the perl C<chomp> function, being careful not to chomp "
27130 "C<$_> itself (since that would remove all newlines from the file):"
27134 #: ../tools/virt-edit.pl:332
27137 " my $m = $_; chomp $m; $m =~ /some text$/\n"
27142 #: ../tools/virt-edit.pl:334
27143 msgid "USING GUESTFISH"
27147 #: ../tools/virt-edit.pl:336
27149 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
27150 "C<virt-edit> doesn't work."
27154 #: ../tools/virt-edit.pl:339
27155 msgid "Using C<virt-edit> is approximately equivalent to doing:"
27159 #: ../tools/virt-edit.pl:341
27162 " guestfish --rw -i -d domname edit /file\n"
27167 #: ../tools/virt-edit.pl:343
27169 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
27170 "path to the file."
27174 #: ../tools/virt-edit.pl:346
27176 "The command above uses libguestfs's guest inspection feature and so does not "
27177 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
27178 "disk images that don't contain guests. To edit a file on a disk image "
27183 #: ../tools/virt-edit.pl:351
27186 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
27191 #: ../tools/virt-edit.pl:353
27193 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
27194 "the disk image to edit, and C</file> is the full path to the file."
27198 #: ../tools/virt-edit.pl:357
27200 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
27201 "C<write> or C<upload> instead:"
27205 #: ../tools/virt-edit.pl:360
27208 " guestfish --rw -i -d domname touch /newfile\n"
27213 #: ../tools/virt-edit.pl:362
27216 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
27221 #: ../tools/virt-edit.pl:364
27224 " guestfish --rw -i -d domname upload localfile /newfile\n"
27229 #: ../tools/virt-edit.pl:366
27230 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
27234 #: ../tools/virt-edit.pl:369
27237 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
27242 #: ../tools/virt-edit.pl:379
27247 #: ../tools/virt-edit.pl:381
27249 "If set, this string is used as the editor. It may contain arguments, "
27250 "eg. C<\"emacs -nw\">"
27254 #: ../tools/virt-edit.pl:384
27255 msgid "If not set, C<vi> is used."
27259 #: ../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
27260 msgid "SHELL QUOTING"
27264 #: ../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
27266 "Libvirt guest names can contain arbitrary characters, some of which have "
27267 "meaning to the shell such as C<#> and space. You may need to quote or "
27268 "escape these characters on the command line. See the shell manual page "
27269 "L<sh(1)> for details."
27273 #: ../tools/virt-edit.pl:397
27275 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27276 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
27277 "L<perl(1)>, L<perlre(1)>."
27281 #: ../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
27286 #: ../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
27287 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
27291 #: ../tools/virt-edit.pl:413
27292 msgid "Copyright (C) 2009-2011 Red Hat Inc."
27296 #: ../tools/virt-win-reg.pl:37
27298 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
27303 #: ../tools/virt-win-reg.pl:41
27306 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
27311 #: ../tools/virt-win-reg.pl:43
27314 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
27319 #: ../tools/virt-win-reg.pl:45
27322 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
27327 #: ../tools/virt-win-reg.pl:47
27330 " virt-win-reg --merge domname [input.reg ...]\n"
27335 #: ../tools/virt-win-reg.pl:49
27338 " virt-win-reg [--options] disk.img ... # instead of domname\n"
27343 #: ../tools/virt-win-reg.pl:53
27345 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
27346 "virtual machines. If you do this, you I<will> get irreversible disk "
27347 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
27348 "but doesn't catch all cases."
27352 #: ../tools/virt-win-reg.pl:58
27354 "Modifying the Windows Registry is an inherently risky operation. The format "
27355 "is deliberately obscure and undocumented, and Registry changes can leave the "
27356 "system unbootable. Therefore when using the C<--merge> option, make sure "
27357 "you have a reliable backup first."
27361 #: ../tools/virt-win-reg.pl:65
27363 "This program can export and merge Windows Registry entries from a Windows "
27368 #: ../tools/virt-win-reg.pl:68
27370 "The first parameter is the libvirt guest name or the raw disk image of a "
27375 #: ../tools/virt-win-reg.pl:71
27377 "If C<--merge> is I<not> specified, then the chosen registry key is "
27378 "displayed/exported (recursively). For example:"
27382 #: ../tools/virt-win-reg.pl:74
27385 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
27390 #: ../tools/virt-win-reg.pl:76
27391 msgid "You can also display single values from within registry keys, for example:"
27395 #: ../tools/virt-win-reg.pl:79
27398 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
27399 " $ virt-win-reg Windows7 $cvkey ProductName\n"
27400 " Windows 7 Enterprise\n"
27405 #: ../tools/virt-win-reg.pl:83
27407 "With C<--merge>, you can merge a textual regedit file into the Windows "
27412 #: ../tools/virt-win-reg.pl:86
27415 " $ virt-win-reg --merge Windows7 changes.reg\n"
27420 #: ../tools/virt-win-reg.pl:88
27425 #: ../tools/virt-win-reg.pl:90
27427 "This program is only meant for simple access to the registry. If you want "
27428 "to do complicated things with the registry, we suggest you download the "
27429 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27430 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27431 "L<hivexregedit(1)>."
27435 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
27440 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
27441 msgid "Enable debugging messages."
27445 #: ../tools/virt-win-reg.pl:157
27450 #: ../tools/virt-win-reg.pl:159
27452 "In merge mode, this merges a textual regedit file into the Windows Registry "
27453 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27454 "displays or exports Registry entries instead."
27458 #: ../tools/virt-win-reg.pl:163
27460 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27461 "result in disk corruption. However exporting (without this flag) is always "
27466 #: ../tools/virt-win-reg.pl:171
27467 msgid "B<--encoding> UTF-16LE|ASCII"
27471 #: ../tools/virt-win-reg.pl:173
27473 "When merging (only), you may need to specify the encoding for strings to be "
27474 "used in the hive file. This is explained in detail in "
27475 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
27479 #: ../tools/virt-win-reg.pl:177
27481 "The default is to use UTF-16LE, which should work with recent versions of "
27486 #: ../tools/virt-win-reg.pl:402
27487 msgid "SUPPORTED SYSTEMS"
27491 #: ../tools/virt-win-reg.pl:404
27493 "The program currently supports Windows NT-derived guests starting with "
27494 "Windows XP through to at least Windows 7."
27498 #: ../tools/virt-win-reg.pl:407
27500 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
27501 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
27502 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
27506 #: ../tools/virt-win-reg.pl:411
27508 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
27513 #: ../tools/virt-win-reg.pl:414
27515 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
27520 #: ../tools/virt-win-reg.pl:417
27525 #: ../tools/virt-win-reg.pl:419
27527 "C<virt-win-reg> expects that regedit files have already been reencoded in "
27528 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
27529 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
27530 "with Windows-style line endings, you may need to reencode the whole file "
27531 "before or after processing."
27535 #: ../tools/virt-win-reg.pl:425
27537 "To reencode a file from Windows format to Linux (before processing it with "
27538 "the C<--merge> option), you would do something like this:"
27542 #: ../tools/virt-win-reg.pl:428
27545 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
27550 #: ../tools/virt-win-reg.pl:430
27552 "To go in the opposite direction, after exporting and before sending the file "
27553 "to a Windows user, do something like this:"
27557 #: ../tools/virt-win-reg.pl:433
27560 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
27565 #: ../tools/virt-win-reg.pl:435
27566 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
27570 #: ../tools/virt-win-reg.pl:437
27572 "If you are unsure about the current encoding, use the L<file(1)> command. "
27573 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
27574 "Windows-style (CRLF) line endings, like this:"
27578 #: ../tools/virt-win-reg.pl:441
27581 " $ file software.reg\n"
27582 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
27583 " with CRLF line terminators\n"
27588 #: ../tools/virt-win-reg.pl:445
27589 msgid "This file would need conversion before you could C<--merge> it."
27593 #: ../tools/virt-win-reg.pl:447
27594 msgid "CurrentControlSet etc."
27598 #: ../tools/virt-win-reg.pl:449
27600 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
27601 "Registry at the level of the hive file, and therefore you cannot modify "
27606 #: ../tools/virt-win-reg.pl:453
27608 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
27609 "circumstances it might refer to another control set. The way to find out is "
27610 "to look at the C<HKLM\\SYSTEM\\Select> key:"
27614 #: ../tools/virt-win-reg.pl:457
27617 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
27618 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
27619 " \"Current\"=dword:00000001\n"
27620 " \"Default\"=dword:00000001\n"
27621 " \"Failed\"=dword:00000000\n"
27622 " \"LastKnownGood\"=dword:00000002\n"
27627 #: ../tools/virt-win-reg.pl:464
27628 msgid "\"Current\" is the one which Windows will choose when it boots."
27632 #: ../tools/virt-win-reg.pl:466
27633 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
27637 #: ../tools/virt-win-reg.pl:469
27638 msgid "WINDOWS TIPS"
27642 #: ../tools/virt-win-reg.pl:471
27644 "Note that some of these tips modify the guest disk image. The guest I<must> "
27645 "be shut off, else you will get disk corruption."
27649 #: ../tools/virt-win-reg.pl:474
27650 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
27654 #: ../tools/virt-win-reg.pl:476
27656 "Prepare a DOS batch script, VBScript or executable. Upload this using "
27657 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
27658 "is uploaded into C<C:\\>:"
27662 #: ../tools/virt-win-reg.pl:480
27665 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
27670 #: ../tools/virt-win-reg.pl:482
27671 msgid "Prepare a regedit file containing the registry change:"
27675 #: ../tools/virt-win-reg.pl:484
27678 " cat > test.reg <<'EOF'\n"
27679 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
27680 " \"Test\"=\"c:\\\\test.bat\"\n"
27686 #: ../tools/virt-win-reg.pl:489
27688 "In this example we use the key C<RunOnce> which means that the script will "
27689 "run precisely once when the first user logs in. If you want it to run every "
27690 "time a user logs in, replace C<RunOnce> with C<Run>."
27694 #: ../tools/virt-win-reg.pl:493
27695 msgid "Now update the registry:"
27699 #: ../tools/virt-win-reg.pl:495
27702 " virt-win-reg --merge WindowsGuest test.reg\n"
27707 #: ../tools/virt-win-reg.pl:497
27708 msgid "INSTALLING A SERVICE"
27712 #: ../tools/virt-win-reg.pl:499
27714 "This section assumes you are familiar with Windows services, and you either "
27715 "have a program which handles the Windows Service Control Protocol directly "
27716 "or you want to run any program using a service wrapper like SrvAny or the "
27721 #: ../tools/virt-win-reg.pl:504
27723 "First upload the program and optionally the service wrapper. In this case "
27724 "the test program is called C<test.exe> and we are using the RHSrvAny "
27729 #: ../tools/virt-win-reg.pl:508
27732 " guestfish -i -d WindowsGuest <<EOF\n"
27733 " upload rhsrvany.exe /rhsrvany.exe\n"
27734 " upload test.exe /test.exe\n"
27740 #: ../tools/virt-win-reg.pl:513
27742 "Prepare a regedit file containing the registry changes. In this example, "
27743 "the first registry change is needed for the service itself or the service "
27744 "wrapper (if used). The second registry change is only needed because I am "
27745 "using the RHSrvAny service wrapper."
27749 #: ../tools/virt-win-reg.pl:518
27752 " cat > service.reg <<'EOF'\n"
27753 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
27754 " \"Type\"=dword:00000010\n"
27755 " \"Start\"=dword:00000002\n"
27756 " \"ErrorControl\"=dword:00000001\n"
27757 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
27758 " \"DisplayName\"=\"RHSrvAny\"\n"
27759 " \"ObjectName\"=\"NetworkService\"\n"
27764 #: ../tools/virt-win-reg.pl:527
27767 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
27768 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
27769 " \"PWD\"=\"c:\\\\Temp\"\n"
27775 #: ../tools/virt-win-reg.pl:538
27777 "For use of C<ControlSet001> see the section above in this manual page. You "
27778 "may need to adjust this according to the control set that is in use by the "
27783 #: ../tools/virt-win-reg.pl:544
27785 "C<\"ObjectName\"> controls the privileges that the service will have. An "
27786 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
27787 "privileged account."
27791 #: ../tools/virt-win-reg.pl:550
27793 "For the meaning of the magic numbers, see this Microsoft KB article: "
27794 "L<http://support.microsoft.com/kb/103000>."
27798 #: ../tools/virt-win-reg.pl:555
27799 msgid "Update the registry:"
27803 #: ../tools/virt-win-reg.pl:557
27806 " virt-win-reg --merge WindowsGuest service.reg\n"
27811 #: ../tools/virt-win-reg.pl:561
27813 "Be careful when passing parameters containing C<\\> (backslash) in the "
27814 "shell. Usually you will have to use 'single quotes' or double backslashes "
27815 "(but not both) to protect them from the shell."
27819 #: ../tools/virt-win-reg.pl:565
27820 msgid "Paths and value names are case-insensitive."
27824 #: ../tools/virt-win-reg.pl:574
27826 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
27827 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27828 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
27829 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27833 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
27835 "When reporting bugs, please enable debugging and capture the I<complete> "
27840 #: ../tools/virt-win-reg.pl:592
27843 " export LIBGUESTFS_DEBUG=1\n"
27844 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
27849 #: ../tools/virt-win-reg.pl:595
27851 "Attach /tmp/virt-win-reg.log to a new bug report at "
27852 "L<https://bugzilla.redhat.com/>"
27856 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:570
27857 msgid "Copyright (C) 2010 Red Hat Inc."
27861 #: ../tools/virt-resize.pl:42
27862 msgid "virt-resize - Resize a virtual machine disk"
27866 #: ../tools/virt-resize.pl:46
27869 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27870 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27871 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27876 #: ../tools/virt-resize.pl:52
27878 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27879 "larger or smaller overall, and resizing or deleting any partitions contained "
27884 #: ../tools/virt-resize.pl:56
27886 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27887 "not> be used on live virtual machines - for consistent results, shut the "
27888 "virtual machine down before resizing it."
27892 #: ../tools/virt-resize.pl:60
27894 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
27895 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
27899 #: ../tools/virt-resize.pl:66
27901 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27902 "fill the extra 5GB of space."
27906 #: ../tools/virt-resize.pl:69
27909 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27910 " virt-filesystems --long -h --all -a olddisk\n"
27911 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27912 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27917 #: ../tools/virt-resize.pl:74
27919 "As above, but make the /boot partition 200MB bigger, while giving the "
27920 "remaining space to /dev/sda2:"
27924 #: ../tools/virt-resize.pl:77
27927 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
27932 #: ../tools/virt-resize.pl:79
27933 msgid "As above, but the output format will be uncompressed qcow2:"
27937 #: ../tools/virt-resize.pl:81
27940 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
27941 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
27946 #: ../tools/virt-resize.pl:84
27947 msgid "DETAILED USAGE"
27951 #: ../tools/virt-resize.pl:86
27952 msgid "EXPANDING A VIRTUAL MACHINE DISK"
27956 #: ../tools/virt-resize.pl:90
27957 msgid "1. Shut down the virtual machine"
27961 #: ../tools/virt-resize.pl:92
27962 msgid "2. Locate input disk image"
27966 #: ../tools/virt-resize.pl:94
27968 "Locate the input disk image (ie. the file or device on the host containing "
27969 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27970 "dumpxml> like this to find the disk image name:"
27974 #: ../tools/virt-resize.pl:98
27977 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27978 " Found 1 nodes:\n"
27980 " <source dev=\"/dev/vg/lv_guest\" />\n"
27985 #: ../tools/virt-resize.pl:103
27986 msgid "3. Look at current sizing"
27990 #: ../tools/virt-resize.pl:105
27991 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
27995 #: ../tools/virt-resize.pl:108
27998 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
27999 " Name Type Size Parent\n"
28000 " /dev/sda1 partition 101M /dev/sda\n"
28001 " /dev/sda2 partition 7.9G /dev/sda\n"
28002 " /dev/sda device 8.0G -\n"
28007 #: ../tools/virt-resize.pl:114
28009 "(This example is a virtual machine with an 8 GB disk which we would like to "
28010 "expand up to 10 GB)."
28014 #: ../tools/virt-resize.pl:117
28015 msgid "4. Create output disk"
28019 #: ../tools/virt-resize.pl:119
28021 "Virt-resize cannot do in-place disk modifications. You have to have space "
28022 "to store the resized output disk."
28026 #: ../tools/virt-resize.pl:122
28027 msgid "To store the resized disk image in a file, create a file of a suitable size:"
28031 #: ../tools/virt-resize.pl:125
28034 " # rm -f outdisk\n"
28035 " # truncate -s 10G outdisk\n"
28040 #: ../tools/virt-resize.pl:128
28041 msgid "Or use L<lvcreate(1)> to create a logical volume:"
28045 #: ../tools/virt-resize.pl:130
28048 " # lvcreate -L 10G -n lv_name vg_name\n"
28053 #: ../tools/virt-resize.pl:132
28054 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
28058 #: ../tools/virt-resize.pl:134
28061 " # virsh pool-list\n"
28062 " # virsh vol-create-as poolname newvol 10G\n"
28067 #: ../tools/virt-resize.pl:137
28072 #: ../tools/virt-resize.pl:139
28074 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
28075 "file) and the output disk. The output disk is the one created in the "
28080 #: ../tools/virt-resize.pl:143
28083 " # virt-resize indisk outdisk\n"
28088 #: ../tools/virt-resize.pl:145
28090 "This command just copies disk image C<indisk> to disk image C<outdisk> "
28091 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
28092 "larger, then an extra, empty partition is created at the end of the disk "
28093 "covering the extra space. If C<outdisk> is smaller, then it will give an "
28098 #: ../tools/virt-resize.pl:151
28100 "More realistically you'd want to expand existing partitions in the disk "
28101 "image by passing extra options (for the full list see the L</OPTIONS> "
28106 #: ../tools/virt-resize.pl:155
28108 "L</--expand> is the most useful option. It expands the named partition "
28109 "within the disk to fill any extra space:"
28113 #: ../tools/virt-resize.pl:158
28116 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
28121 #: ../tools/virt-resize.pl:160
28123 "(In this case, an extra partition is I<not> created at the end of the disk, "
28124 "because there will be no unused space)."
28128 #: ../tools/virt-resize.pl:163
28130 "L</--resize> is the other commonly used option. The following would "
28131 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
28132 "rest of the available space:"
28136 #: ../tools/virt-resize.pl:167
28139 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
28140 " indisk outdisk\n"
28145 #: ../tools/virt-resize.pl:170
28147 "If the expanded partition in the image contains a filesystem or LVM PV, then "
28148 "if virt-resize knows how, it will resize the contents, the equivalent of "
28149 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
28150 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
28151 "filesystems, so you would have to online resize them after booting the "
28156 #: ../tools/virt-resize.pl:177
28157 msgid "Other options are covered below."
28161 #: ../tools/virt-resize.pl:179
28166 #: ../tools/virt-resize.pl:181
28167 msgid "Thoroughly test the new disk image I<before> discarding the old one."
28171 #: ../tools/virt-resize.pl:183
28172 msgid "If you are using libvirt, edit the XML to point at the new disk:"
28176 #: ../tools/virt-resize.pl:185
28179 " # virsh edit guestname\n"
28184 #: ../tools/virt-resize.pl:187
28186 "Change E<lt>source ...E<gt>, see "
28187 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
28191 #: ../tools/virt-resize.pl:190
28192 msgid "Then start up the domain with the new, resized disk:"
28196 #: ../tools/virt-resize.pl:192
28199 " # virsh start guestname\n"
28204 #: ../tools/virt-resize.pl:194
28206 "and check that it still works. See also the L</NOTES> section below for "
28207 "additional information."
28211 #: ../tools/virt-resize.pl:197
28212 msgid "7. Resize LVs etc inside the guest"
28216 #: ../tools/virt-resize.pl:199
28217 msgid "(This can also be done offline using L<guestfish(1)>)"
28221 #: ../tools/virt-resize.pl:201
28223 "Once the guest has booted you should see the new space available, at least "
28224 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
28225 "may need to resize LVs inside PVs, and also resize filesystem types that "
28226 "virt-resize does not know how to expand."
28230 #: ../tools/virt-resize.pl:208
28231 msgid "SHRINKING A VIRTUAL MACHINE DISK"
28235 #: ../tools/virt-resize.pl:210
28237 "Shrinking is somewhat more complex than expanding, and only an overview is "
28242 #: ../tools/virt-resize.pl:213
28244 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
28245 "filesystems). The user has to shrink content before passing the disk image "
28246 "to virt-resize, and virt-resize will check that the content has been shrunk "
28251 #: ../tools/virt-resize.pl:218
28252 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28256 #: ../tools/virt-resize.pl:220
28258 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28259 "steps 3 and 4 above to allocate a new disk image."
28263 #: ../tools/virt-resize.pl:223
28264 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28268 #: ../tools/virt-resize.pl:226
28269 msgid "IGNORING OR DELETING PARTITIONS"
28273 #: ../tools/virt-resize.pl:228
28275 "virt-resize also gives a convenient way to ignore or delete partitions when "
28276 "copying from the input disk to the output disk. Ignoring a partition speeds "
28277 "up the copy where you don't care about the existing contents of a "
28278 "partition. Deleting a partition removes it completely, but note that it "
28279 "also renumbers any partitions after the one which is deleted, which can "
28280 "leave some guests unbootable."
28284 #: ../tools/virt-resize.pl:235
28285 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28289 #: ../tools/virt-resize.pl:237
28291 "If the input disk is in qcow2 format, then you may prefer that the output is "
28292 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28293 "the fly. The output format is simply determined by the format of the empty "
28294 "output container that you provide. Thus to create qcow2 output, use:"
28298 #: ../tools/virt-resize.pl:243
28301 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28306 #: ../tools/virt-resize.pl:245
28307 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28311 #: ../tools/virt-resize.pl:247
28312 msgid "Similarly, to get non-sparse raw output use:"
28316 #: ../tools/virt-resize.pl:249
28319 " fallocate -l size outdisk\n"
28324 #: ../tools/virt-resize.pl:251
28326 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
28327 "if=/dev/zero of=outdisk bs=1M count=..>)"
28331 #: ../tools/virt-resize.pl:264
28332 msgid "Display help."
28336 #: ../tools/virt-resize.pl:278
28337 msgid "B<--resize part=size>"
28341 #: ../tools/virt-resize.pl:280
28343 "Resize the named partition (expanding or shrinking it) so that it has the "
28348 #: ../tools/virt-resize.pl:283
28350 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28351 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28352 "Exabytes; or as a percentage of the current size; or as a relative number or "
28353 "percentage. For example:"
28357 #: ../tools/virt-resize.pl:288
28360 " --resize /dev/sda2=10G\n"
28365 #: ../tools/virt-resize.pl:290
28368 " --resize /dev/sda4=90%\n"
28373 #: ../tools/virt-resize.pl:292
28376 " --resize /dev/sda2=+1G\n"
28381 #: ../tools/virt-resize.pl:294
28384 " --resize /dev/sda2=-200M\n"
28389 #: ../tools/virt-resize.pl:296
28392 " --resize /dev/sda1=+128K\n"
28397 #: ../tools/virt-resize.pl:298
28400 " --resize /dev/sda1=+10%\n"
28405 #: ../tools/virt-resize.pl:300
28408 " --resize /dev/sda1=-10%\n"
28413 #: ../tools/virt-resize.pl:302
28415 "You can increase the size of any partition. Virt-resize will expand the "
28416 "direct content of the partition if it knows how (see C<--expand> below)."
28420 #: ../tools/virt-resize.pl:306
28422 "You can only I<decrease> the size of partitions that contain filesystems or "
28423 "PVs which have already been shrunk. Virt-resize will check this has been "
28424 "done before proceeding, or else will print an error (see also "
28425 "C<--resize-force>)."
28429 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
28430 msgid "You can give this option multiple times."
28434 #: ../tools/virt-resize.pl:317
28435 msgid "B<--resize-force part=size>"
28439 #: ../tools/virt-resize.pl:319
28441 "This is the same as C<--resize> except that it will let you decrease the "
28442 "size of any partition. Generally this means you will lose any data which "
28443 "was at the end of the partition you shrink, but you may not care about that "
28444 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28445 "as a swap partition)."
28449 #: ../tools/virt-resize.pl:325
28450 msgid "See also the C<--ignore> option."
28454 #: ../tools/virt-resize.pl:331
28455 msgid "B<--expand part>"
28459 #: ../tools/virt-resize.pl:333
28461 "Expand the named partition so it uses up all extra space (space left over "
28462 "after any other resize changes that you request have been done)."
28466 #: ../tools/virt-resize.pl:336
28468 "If virt-resize knows how, it will expand the direct content of the "
28469 "partition. For example, if the partition is an LVM PV, it will expand the "
28470 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28471 "content it doesn't know about alone."
28475 #: ../tools/virt-resize.pl:341
28476 msgid "Currently virt-resize can resize:"
28480 #: ../tools/virt-resize.pl:347
28482 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28487 #: ../tools/virt-resize.pl:352
28489 "NTFS filesystems contained directly in a partition, if libguestfs was "
28490 "compiled with support for NTFS."
28494 #: ../tools/virt-resize.pl:355
28496 "The filesystem must have been shut down consistently last time it was used. "
28497 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
28498 "consistency check, so at the first boot after resizing Windows will check "
28503 #: ../tools/virt-resize.pl:362
28505 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
28506 "inside the PV, but see the C<--LV-expand> option. The user could also "
28507 "resize LVs as desired after boot."
28511 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
28512 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
28516 #: ../tools/virt-resize.pl:374
28517 msgid "B<--shrink part>"
28521 #: ../tools/virt-resize.pl:376
28523 "Shrink the named partition until the overall disk image fits in the "
28524 "destination. The named partition B<must> contain a filesystem or PV which "
28525 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
28526 "online tools). Virt-resize will check this and give an error if it has not "
28531 #: ../tools/virt-resize.pl:382
28533 "The amount by which the overall disk must be shrunk (after carrying out all "
28534 "other operations requested by the user) is called the \"deficit\". For "
28535 "example, a straight copy (assume no other operations) from a 5GB disk image "
28536 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
28537 "would give an error unless the user specified a partition to shrink and that "
28538 "partition had more than a gigabyte of free space."
28542 #: ../tools/virt-resize.pl:396
28543 msgid "B<--ignore part>"
28547 #: ../tools/virt-resize.pl:398
28549 "Ignore the named partition. Effectively this means the partition is "
28550 "allocated on the destination disk, but the content is not copied across from "
28551 "the source disk. The content of the partition will be blank (all zero "
28556 #: ../tools/virt-resize.pl:409
28557 msgid "B<--delete part>"
28561 #: ../tools/virt-resize.pl:411
28563 "Delete the named partition. It would be more accurate to describe this as "
28564 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
28565 "the original disk image is left intact."
28569 #: ../tools/virt-resize.pl:415
28571 "Note that when you delete a partition, then anything contained in the "
28572 "partition is also deleted. Furthermore, this causes any partitions that "
28573 "come after to be I<renumbered>, which can easily make your guest unbootable."
28577 #: ../tools/virt-resize.pl:426
28578 msgid "B<--LV-expand logvol>"
28582 #: ../tools/virt-resize.pl:428
28584 "This takes the logical volume and, as a final step, expands it to fill all "
28585 "the space available in its volume group. A typical usage, assuming a Linux "
28586 "guest with a single PV C</dev/sda2> and a root device called "
28587 "C</dev/vg_guest/lv_root> would be:"
28591 #: ../tools/virt-resize.pl:433
28594 " virt-resize indisk outdisk \\\n"
28595 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
28600 #: ../tools/virt-resize.pl:436
28602 "This would first expand the partition (and PV), and then expand the root "
28603 "device to fill the extra space in the PV."
28607 #: ../tools/virt-resize.pl:439
28609 "The contents of the LV are also resized if virt-resize knows how to do "
28610 "that. You can stop virt-resize from trying to expand the content by using "
28611 "the option C<--no-expand-content>."
28615 #: ../tools/virt-resize.pl:443
28616 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
28620 #: ../tools/virt-resize.pl:446
28622 "You can give this option multiple times, I<but> it doesn't make sense to do "
28623 "this unless the logical volumes you specify are all in different volume "
28628 #: ../tools/virt-resize.pl:454
28629 msgid "B<--no-copy-boot-loader>"
28633 #: ../tools/virt-resize.pl:456
28635 "By default, virt-resize copies over some sectors at the start of the disk "
28636 "(up to the beginning of the first partition). Commonly these sectors "
28637 "contain the Master Boot Record (MBR) and the boot loader, and are required "
28638 "in order for the guest to boot correctly."
28642 #: ../tools/virt-resize.pl:461
28644 "If you specify this flag, then this initial copy is not done. You may need "
28645 "to reinstall the boot loader in this case."
28649 #: ../tools/virt-resize.pl:469
28650 msgid "B<--no-extra-partition>"
28654 #: ../tools/virt-resize.pl:471
28656 "By default, virt-resize creates an extra partition if there is any extra, "
28657 "unused space after all resizing has happened. Use this option to prevent "
28658 "the extra partition from being created. If you do this then the extra space "
28659 "will be inaccessible until you run fdisk, parted, or some other partitioning "
28660 "tool in the guest."
28664 #: ../tools/virt-resize.pl:477
28666 "Note that if the surplus space is smaller than 10 MB, no extra partition "
28671 #: ../tools/virt-resize.pl:484
28672 msgid "B<--no-expand-content>"
28676 #: ../tools/virt-resize.pl:486
28678 "By default, virt-resize will try to expand the direct contents of "
28679 "partitions, if it knows how (see C<--expand> option above)."
28683 #: ../tools/virt-resize.pl:489
28685 "If you give the C<--no-expand-content> option then virt-resize will not "
28690 #: ../tools/virt-resize.pl:496
28691 msgid "B<-d> | B<--debug>"
28695 #: ../tools/virt-resize.pl:504
28696 msgid "B<-n> | B<--dryrun>"
28700 #: ../tools/virt-resize.pl:506
28701 msgid "Print a summary of what would be done, but don't do anything."
28705 #: ../tools/virt-resize.pl:512
28706 msgid "B<-q> | B<--quiet>"
28710 #: ../tools/virt-resize.pl:514
28711 msgid "Don't print the summary."
28715 #: ../tools/virt-resize.pl:522
28717 "Specify the format of the input disk image. If this flag is not given then "
28718 "it is auto-detected from the image itself."
28722 #: ../tools/virt-resize.pl:528
28724 "Note that this option I<does not> affect the output format. See L</QCOW2 "
28725 "AND NON-SPARSE RAW FORMATS>."
28729 #: ../tools/virt-resize.pl:535
28730 msgid "B<--output-format> raw"
28734 #: ../tools/virt-resize.pl:537
28736 "Specify the format of the output disk image. If this flag is not given then "
28737 "it is auto-detected from the image itself."
28741 #: ../tools/virt-resize.pl:543
28743 "Note that you still need to create the output disk with the right format. "
28744 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28748 #: ../tools/virt-resize.pl:1419
28753 #: ../tools/virt-resize.pl:1421
28754 msgid "\"Partition 1 does not end on cylinder boundary.\""
28758 #: ../tools/virt-resize.pl:1423
28760 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28761 "means the partitions will not be aligned to the ancient CHS geometry. "
28762 "However CHS geometry is meaningless for disks manufactured since the early "
28763 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28764 "cylinders is not required by any modern operating system."
28768 #: ../tools/virt-resize.pl:1430
28769 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28773 #: ../tools/virt-resize.pl:1432
28775 "In Windows Vista and later versions, Microsoft switched to using a separate "
28776 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28777 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28778 "the boot partition. Doing so seems to break the guest completely. However "
28779 "expanding the second partition (ie. C: drive) should work."
28783 #: ../tools/virt-resize.pl:1439
28785 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28786 "NTFS partitions have been expanded. This is just a safety check and (unless "
28787 "it find errors) is nothing to worry about."
28791 #: ../tools/virt-resize.pl:1443
28792 msgid "GUEST BOOT STUCK AT \"GRUB\""
28796 #: ../tools/virt-resize.pl:1445
28798 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28799 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28800 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28801 "although we think is to do with partition alignment."
28805 #: ../tools/virt-resize.pl:1450
28808 " guestfish -i -a newdisk\n"
28809 " ><fs> cat /boot/grub/device.map\n"
28810 " # check the contents of this file are sensible or\n"
28811 " # edit the file if necessary\n"
28812 " ><fs> grub-install / /dev/vda\n"
28818 #: ../tools/virt-resize.pl:1457
28820 "For more flexible guest reconfiguration, including if you need to specify "
28821 "other parameters to grub-install, use L<virt-rescue(1)>."
28825 #: ../tools/virt-resize.pl:1460
28826 msgid "ALTERNATIVE TOOLS"
28830 #: ../tools/virt-resize.pl:1462
28832 "There are several proprietary tools for resizing partitions. We won't "
28833 "mention any here."
28837 #: ../tools/virt-resize.pl:1465
28839 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28840 "operations on disk images. They can resize and move partitions, but I don't "
28841 "think they can do anything with the contents, and they certainly don't "
28846 #: ../tools/virt-resize.pl:1470
28848 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28849 "but at a much lower level. You will probably end up hand-calculating sector "
28850 "offsets, which is something that virt-resize was designed to avoid. If you "
28851 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
28856 #: ../tools/virt-resize.pl:1485
28858 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
28859 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
28860 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
28861 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
28862 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28866 #: ../tools/virt-list-filesystems.pl:32
28867 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28871 #: ../tools/virt-list-filesystems.pl:36
28874 " virt-list-filesystems [--options] domname\n"
28879 #: ../tools/virt-list-filesystems.pl:38
28882 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28887 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
28889 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
28894 #: ../tools/virt-list-filesystems.pl:45
28896 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28897 "are contained in a virtual machine or disk image."
28901 #: ../tools/virt-list-filesystems.pl:49
28903 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28904 "functionality. For more complex cases you should look at the "
28905 "L<guestfish(1)> tool."
28909 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
28910 msgid "B<-l> | B<--long>"
28914 #: ../tools/virt-list-filesystems.pl:108
28916 "With this option, C<virt-list-filesystems> displays the type of each "
28917 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28921 #: ../tools/virt-list-filesystems.pl:115
28922 msgid "B<-a> | B<--all>"
28926 #: ../tools/virt-list-filesystems.pl:117
28928 "Normally we only show mountable filesystems. If this option is given then "
28929 "swap devices are shown too."
28933 #: ../tools/virt-list-filesystems.pl:191
28935 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
28936 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
28937 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28941 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
28942 msgid "Copyright (C) 2009 Red Hat Inc."
28946 #: ../tools/virt-tar.pl:33
28947 msgid "virt-tar - Extract or upload files to a virtual machine"
28951 #: ../tools/virt-tar.pl:37
28954 " virt-tar [--options] -x domname directory tarball\n"
28959 #: ../tools/virt-tar.pl:39
28962 " virt-tar [--options] -u domname tarball directory\n"
28967 #: ../tools/virt-tar.pl:41
28970 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28975 #: ../tools/virt-tar.pl:43
28978 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28983 #: ../tools/virt-tar.pl:47
28984 msgid "Download C</home> from the VM into a local tarball:"
28988 #: ../tools/virt-tar.pl:49
28991 " virt-tar -x domname /home home.tar\n"
28996 #: ../tools/virt-tar.pl:51
28999 " virt-tar -zx domname /home home.tar.gz\n"
29004 #: ../tools/virt-tar.pl:53
29005 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29009 #: ../tools/virt-tar.pl:55
29012 " virt-tar -u domname uploadstuff.tar /tmp\n"
29017 #: ../tools/virt-tar.pl:57
29020 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29025 #: ../tools/virt-tar.pl:61
29027 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
29028 "virtual machines. If you do this, you risk disk corruption in the VM. "
29029 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29033 #: ../tools/virt-tar.pl:66
29035 "You can use C<-x> (extract) on live virtual machines, but you might get "
29036 "inconsistent results or errors if there is filesystem activity inside the "
29037 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29038 "work, but the only way to guarantee consistent results is if the virtual "
29039 "machine is shut down."
29043 #: ../tools/virt-tar.pl:74
29045 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29046 "parts of a guest filesystem. There are many possibilities: making backups, "
29047 "uploading data files, snooping on guest activity, fixing or customizing "
29052 #: ../tools/virt-tar.pl:79
29054 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29055 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29056 "should look at the L<guestfish(1)> tool."
29060 #: ../tools/virt-tar.pl:83
29062 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
29063 "its contents (recursively) from the virtual machine into a local tarball. "
29064 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
29065 "virtual machine. You cannot use these two options together."
29069 #: ../tools/virt-tar.pl:89
29071 "In addition, you may need to use the C<-z> (gZip) option to enable "
29072 "compression. When uploading, you have to specify C<-z> if the upload file "
29073 "is compressed because virt-tar won't detect this on its own."
29077 #: ../tools/virt-tar.pl:93
29079 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29080 "example it cannot do PKZip files or bzip2 compression. If you want that "
29081 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29082 "the L<libguestfs(3)> API)."
29086 #: ../tools/virt-tar.pl:151
29087 msgid "B<-x> | B<--extract> | B<--download>"
29091 #: ../tools/virt-tar.pl:153
29092 msgid "B<-u> | B<--upload>"
29096 #: ../tools/virt-tar.pl:155
29098 "Use C<-x> to extract (download) a directory from a virtual machine to a "
29103 #: ../tools/virt-tar.pl:158
29105 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
29106 "Please read the L</WARNING> section above before using this option."
29110 #: ../tools/virt-tar.pl:162
29111 msgid "You must specify exactly one of these options."
29115 #: ../tools/virt-tar.pl:168
29116 msgid "B<-z> | B<--gzip>"
29120 #: ../tools/virt-tar.pl:170
29121 msgid "Specify that the input or output tarball is gzip-compressed."
29125 #: ../tools/virt-tar.pl:283
29127 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29128 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29129 "L<http://libguestfs.org/>."
29133 #: ../tools/virt-make-fs.pl:37
29134 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29138 #: ../tools/virt-make-fs.pl:41
29141 " virt-make-fs [--options] input.tar output.img\n"
29146 #: ../tools/virt-make-fs.pl:43
29149 " virt-make-fs [--options] input.tar.gz output.img\n"
29154 #: ../tools/virt-make-fs.pl:45
29157 " virt-make-fs [--options] directory output.img\n"
29162 #: ../tools/virt-make-fs.pl:49
29164 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29165 "archive or some files in a directory. It is similar to tools like "
29166 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29167 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29168 "useful if you want to attach these filesystems to existing virtual machines "
29169 "(eg. to import large amounts of read-only data to a VM)."
29173 #: ../tools/virt-make-fs.pl:57
29174 msgid "Basic usage is:"
29178 #: ../tools/virt-make-fs.pl:59
29181 " virt-make-fs input output\n"
29186 #: ../tools/virt-make-fs.pl:61
29188 "where C<input> is either a directory containing files that you want to add, "
29189 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29190 "C<output> is a disk image. The input type is detected automatically. The "
29191 "output disk image defaults to a raw ext2 image unless you specify extra "
29192 "flags (see L</OPTIONS> below)."
29196 #: ../tools/virt-make-fs.pl:67
29197 msgid "EXTRA SPACE"
29201 #: ../tools/virt-make-fs.pl:69
29203 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29204 "the files that it contains, but might have extra space. Depending on how "
29205 "you are going to use the output, you might think this extra space is wasted "
29206 "and want to minimize it, or you might want to leave space so that more files "
29207 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29208 "but you can use the C<--size> flag to leave space in the filesystem if you "
29213 #: ../tools/virt-make-fs.pl:77
29215 "An alternative way to leave extra space but not make the output image any "
29216 "bigger is to use an alternative disk image format (instead of the default "
29217 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29218 "image format (check your hypervisor supports this before using it). This "
29219 "allows you to choose a large C<--size> but the extra space won't actually be "
29220 "allocated in the image until you try to store something in it."
29224 #: ../tools/virt-make-fs.pl:85
29226 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29227 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29228 "to build another image from scratch."
29232 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29237 #: ../tools/virt-make-fs.pl:91
29240 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29245 #: ../tools/virt-make-fs.pl:93
29246 msgid "FILESYSTEM TYPE"
29250 #: ../tools/virt-make-fs.pl:95
29252 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29253 "libguestfs supports can be used (but I<not> read-only formats like "
29254 "ISO9660). Here are some of the more common choices:"
29258 #: ../tools/virt-make-fs.pl:101
29263 #: ../tools/virt-make-fs.pl:103
29265 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29266 "you are not going to use the filesystem in a way that requires the journal, "
29267 "then this is just wasted overhead."
29271 #: ../tools/virt-make-fs.pl:107
29272 msgid "I<ntfs> or I<vfat>"
29276 #: ../tools/virt-make-fs.pl:109
29277 msgid "Useful if exporting data to a Windows guest."
29281 #: ../tools/virt-make-fs.pl:111
29283 "I<Note for vfat>: The tar archive or local directory must only contain files "
29284 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29285 "program running within libguestfs is unable to change the ownership of "
29286 "non-root files, since vfat itself does not support this."
29290 #: ../tools/virt-make-fs.pl:116
29295 #: ../tools/virt-make-fs.pl:118
29297 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29298 "total filesystem size."
29302 #: ../tools/virt-make-fs.pl:125
29305 " virt-make-fs --type=minix input minixfs.img\n"
29310 #: ../tools/virt-make-fs.pl:127
29311 msgid "TO PARTITION OR NOT TO PARTITION"
29315 #: ../tools/virt-make-fs.pl:129
29316 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29320 #: ../tools/virt-make-fs.pl:131
29322 "Adding a partition can make the disk image more compatible with certain "
29323 "virtualized operating systems which don't expect to see a filesystem "
29324 "directly located on a block device (Linux doesn't care and will happily "
29325 "handle both types)."
29329 #: ../tools/virt-make-fs.pl:136
29331 "On the other hand, if you have a partition table then the output image is no "
29332 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29333 "directly on a partitioned disk image. (However libguestfs tools such as "
29334 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29338 #: ../tools/virt-make-fs.pl:144
29339 msgid "Add an MBR partition:"
29343 #: ../tools/virt-make-fs.pl:146
29346 " virt-make-fs --partition -- input disk.img\n"
29351 #: ../tools/virt-make-fs.pl:148
29353 "If the output disk image could be terabyte-sized or larger, it's better to "
29354 "use an EFI/GPT-compatible partition table:"
29358 #: ../tools/virt-make-fs.pl:151
29361 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29366 #: ../tools/virt-make-fs.pl:179
29367 msgid "Enable debugging information."
29371 #: ../tools/virt-make-fs.pl:185
29372 msgid "B<--size=E<lt>NE<gt>>"
29376 #: ../tools/virt-make-fs.pl:187
29377 msgid "B<--size=+E<lt>NE<gt>>"
29381 #: ../tools/virt-make-fs.pl:189
29382 msgid "B<-s E<lt>NE<gt>>"
29386 #: ../tools/virt-make-fs.pl:191
29387 msgid "B<-s +E<lt>NE<gt>>"
29391 #: ../tools/virt-make-fs.pl:193
29392 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29396 #: ../tools/virt-make-fs.pl:196
29398 "If this option is I<not> given, then the output image will be just large "
29399 "enough to contain all the files, with not much wasted space."
29403 #: ../tools/virt-make-fs.pl:199
29405 "To choose a fixed size output disk, specify an absolute number followed by "
29406 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29407 "Petabytes or Exabytes. This must be large enough to contain all the input "
29408 "files, else you will get an error."
29412 #: ../tools/virt-make-fs.pl:204
29414 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29415 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29416 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29417 "the input files, and (approximately) an extra 200 MB free space."
29421 #: ../tools/virt-make-fs.pl:210
29423 "Note that virt-make-fs estimates free space, and therefore will not produce "
29424 "filesystems containing precisely the free space requested. (It is much more "
29425 "expensive and time-consuming to produce a filesystem which has precisely the "
29426 "desired free space)."
29430 #: ../tools/virt-make-fs.pl:219
29431 msgid "B<--format=E<lt>fmtE<gt>>"
29435 #: ../tools/virt-make-fs.pl:221
29436 msgid "B<-F E<lt>fmtE<gt>>"
29440 #: ../tools/virt-make-fs.pl:223
29441 msgid "Choose the output disk image format."
29445 #: ../tools/virt-make-fs.pl:225
29446 msgid "The default is C<raw> (raw disk image)."
29450 #: ../tools/virt-make-fs.pl:227
29452 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29453 "that would really make sense here is C<qcow2>."
29457 #: ../tools/virt-make-fs.pl:234
29458 msgid "B<--type=E<lt>fsE<gt>>"
29462 #: ../tools/virt-make-fs.pl:236
29463 msgid "B<-t E<lt>fsE<gt>>"
29467 #: ../tools/virt-make-fs.pl:238
29468 msgid "Choose the output filesystem type."
29472 #: ../tools/virt-make-fs.pl:240
29473 msgid "The default is C<ext2>."
29477 #: ../tools/virt-make-fs.pl:242
29478 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29482 #: ../tools/virt-make-fs.pl:249
29483 msgid "B<--partition>"
29487 #: ../tools/virt-make-fs.pl:251
29488 msgid "B<--partition=E<lt>parttypeE<gt>>"
29492 #: ../tools/virt-make-fs.pl:253
29494 "If specified, this flag adds an MBR partition table to the output disk "
29499 #: ../tools/virt-make-fs.pl:256
29501 "You can change the partition table type, eg. C<--partition=gpt> for large "
29506 #: ../tools/virt-make-fs.pl:259
29508 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29509 "might consider the next parameter to be the partition type. For example:"
29513 #: ../tools/virt-make-fs.pl:263
29516 " virt-make-fs --partition input.tar ...\n"
29521 #: ../tools/virt-make-fs.pl:265
29523 "would cause virt-make-fs to think you wanted to use a partition type of "
29524 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29525 "dash) between options and the input file argument:"
29529 #: ../tools/virt-make-fs.pl:269
29532 " virt-make-fs --partition -- input.tar ...\n"
29537 #: ../tools/virt-make-fs.pl:541
29539 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
29540 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29541 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29545 #: ../tools/virt-make-fs.pl:558
29548 " export LIBGUESTFS_DEBUG=1\n"
29549 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29554 #: ../tools/virt-make-fs.pl:561
29556 "Attach /tmp/virt-make-fs.log to a new bug report at "
29557 "L<https://bugzilla.redhat.com/>"
29561 #: ../tools/virt-list-partitions.pl:32
29562 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29566 #: ../tools/virt-list-partitions.pl:36
29569 " virt-list-partitions [--options] domname\n"
29574 #: ../tools/virt-list-partitions.pl:38
29577 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29582 #: ../tools/virt-list-partitions.pl:45
29584 "C<virt-list-partitions> is a command line tool to list the partitions that "
29585 "are contained in a virtual machine or disk image. It is mainly useful as a "
29586 "first step to using L<virt-resize(1)>."
29590 #: ../tools/virt-list-partitions.pl:50
29592 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29593 "functionality. For more complex cases you should look at the "
29594 "L<guestfish(1)> tool."
29598 #: ../tools/virt-list-partitions.pl:107
29599 msgid "B<-h> | B<--human-readable>"
29603 #: ../tools/virt-list-partitions.pl:109
29604 msgid "Show sizes in human-readable form (eg. \"1G\")."
29608 #: ../tools/virt-list-partitions.pl:117
29610 "With this option, C<virt-list-partitions> displays the type and size of each "
29611 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29615 #: ../tools/virt-list-partitions.pl:124
29616 msgid "B<-t> | B<--total>"
29620 #: ../tools/virt-list-partitions.pl:126
29621 msgid "Display the total size of each block device (as a separate row or rows)."
29625 #: ../tools/virt-list-partitions.pl:259
29627 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29628 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29629 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29633 #: ../tools/virt-list-partitions.pl:275
29634 msgid "Copyright (C) 2009-2010 Red Hat Inc."