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.8\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-06-13 14:36+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:1584 ../src/guestfs-actions.pod:1588 ../src/guestfs-actions.pod:1592 ../src/guestfs-actions.pod:1596 ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608 ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1622 ../src/guestfs-actions.pod:1626 ../src/guestfs-actions.pod:1630 ../src/guestfs-actions.pod:1768 ../src/guestfs-actions.pod:1772 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:1847 ../src/guestfs-actions.pod:1852 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:373 ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1062 ../fish/guestfish-actions.pod:1066 ../fish/guestfish-actions.pod:1070 ../fish/guestfish-actions.pod:1074 ../fish/guestfish-actions.pod:1082 ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1090 ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1104 ../fish/guestfish-actions.pod:1108 ../fish/guestfish-actions.pod:1198 ../fish/guestfish-actions.pod:1202 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1254 ../fish/guestfish-actions.pod:1258 ../fish/guestfish-actions.pod:1263 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1204 ../src/guestfs.pod:1335 ../src/guestfs.pod:2109
941 #: ../src/guestfs.pod:471
942 msgid "Before launching, do:"
946 #: ../src/guestfs.pod:473
949 " guestfs_set_selinux (g, 1);\n"
954 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1208 ../src/guestfs.pod:1339 ../src/guestfs.pod:2134
959 #: ../src/guestfs.pod:477
961 "After mounting the guest's filesystem(s), load the policy. This is best "
962 "done by running the L<load_policy(8)> command in the guest itself:"
966 #: ../src/guestfs.pod:481
969 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
974 #: ../src/guestfs.pod:483
976 "(Older versions of C<load_policy> require you to specify the name of the "
981 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1345
986 #: ../src/guestfs.pod:488
988 "Optionally, set the security context for the API. The correct security "
989 "context to use can only be known by inspecting the guest. As an example:"
993 #: ../src/guestfs.pod:492
996 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1001 #: ../src/guestfs.pod:496
1002 msgid "This will work for running commands and editing existing files."
1006 #: ../src/guestfs.pod:498
1008 "When new files are created, you may need to label them explicitly, for "
1009 "example by running the external command C<restorecon pathname>."
1013 #: ../src/guestfs.pod:502
1018 #: ../src/guestfs.pod:504
1020 "Certain calls are affected by the current file mode creation mask (the "
1021 "\"umask\"). In particular ones which create files or directories, such as "
1022 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1023 "either the default mode that the file is created with or modifies the mode "
1028 #: ../src/guestfs.pod:510
1030 "The default umask is C<022>, so files are created with modes such as C<0644> "
1031 "and directories with C<0755>."
1035 #: ../src/guestfs.pod:513
1037 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1038 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
1039 "L</guestfs_chmod> after creating each file or directory."
1043 #: ../src/guestfs.pod:517
1044 msgid "For more information about umask, see L<umask(2)>."
1048 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:720
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems. (These APIs used to be in a separate Perl-only "
1112 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1113 "frequently used part of this library has been rewritten in C and moved into "
1118 #: ../src/guestfs.pod:558
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:561
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:570
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:576
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:583
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:587
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:590
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:594
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:598
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:602
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:611
1213 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1217 #: ../src/guestfs.pod:613
1219 "Libguestfs can mount NTFS partitions. It does this using the "
1220 "L<http://www.ntfs-3g.org/> driver."
1224 #: ../src/guestfs.pod:616
1225 msgid "DRIVE LETTERS AND PATHS"
1229 #: ../src/guestfs.pod:618
1231 "DOS and Windows still use drive letters, and the filesystems are always "
1232 "treated as case insensitive by Windows itself, and therefore you might find "
1233 "a Windows configuration file referring to a path like "
1234 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1235 "that directory might be referred to as C</WINDOWS/System32>."
1239 #: ../src/guestfs.pod:624
1241 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1242 "libguestfs to read the appropriate Windows Registry and configuration files, "
1243 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1244 "L<virt-inspector(1)>)."
1248 #: ../src/guestfs.pod:629
1250 "Replacing backslash characters with forward slash characters is also outside "
1251 "the scope of libguestfs, but something that you can easily do."
1255 #: ../src/guestfs.pod:632
1257 "Where we can help is in resolving the case insensitivity of paths. For "
1258 "this, call L</guestfs_case_sensitive_path>."
1262 #: ../src/guestfs.pod:635
1263 msgid "ACCESSING THE WINDOWS REGISTRY"
1267 #: ../src/guestfs.pod:637
1269 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1270 "files, through the library C<hivex> which is part of the libguestfs project "
1271 "although ships as a separate tarball. You have to locate and download the "
1272 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1273 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1274 "L<virt-win-reg(1)> for more help on this issue."
1278 #: ../src/guestfs.pod:645
1279 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1283 #: ../src/guestfs.pod:647
1285 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1286 "provide something which looks like a Linux symlink. The way it tries to do "
1287 "the rewriting is described here:"
1291 #: ../src/guestfs.pod:651
1292 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1296 #: ../src/guestfs.pod:653
1298 "The essential problem is that ntfs-3g simply does not have enough "
1299 "information to do a correct job. NTFS links can contain drive letters and "
1300 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1301 "It is almost certainly the case that libguestfs callers should ignore what "
1302 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1306 #: ../src/guestfs.pod:660
1308 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1309 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1310 "attribute, and read the raw reparse data from that (you can find the format "
1311 "documented in various places around the web)."
1315 #: ../src/guestfs.pod:665
1316 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1320 #: ../src/guestfs.pod:667
1322 "There are other useful extended attributes that can be read from ntfs-3g "
1323 "filesystems (using L</guestfs_getxattr>). See:"
1327 #: ../src/guestfs.pod:670
1328 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1332 #: ../src/guestfs.pod:672
1333 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1337 #: ../src/guestfs.pod:674
1339 "Although we don't want to discourage you from using the C API, we will "
1340 "mention here that the same API is also available in other languages."
1344 #: ../src/guestfs.pod:677
1346 "The API is broadly identical in all supported languages. This means that "
1347 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1348 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1349 "OCaml. In other words, a straightforward, predictable isomorphism between "
1354 #: ../src/guestfs.pod:683
1356 "Error messages are automatically transformed into exceptions if the language "
1361 #: ../src/guestfs.pod:686
1363 "We don't try to \"object orientify\" parts of the API in OO languages, "
1364 "although contributors are welcome to write higher level APIs above what we "
1365 "provide in their favourite languages if they wish."
1369 #: ../src/guestfs.pod:692
1374 #: ../src/guestfs.pod:694
1376 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1377 "identical to the C API. C++ classes and exceptions are not used."
1381 #: ../src/guestfs.pod:698
1386 #: ../src/guestfs.pod:700
1388 "The C# bindings are highly experimental. Please read the warnings at the "
1389 "top of C<csharp/Libguestfs.cs>."
1393 #: ../src/guestfs.pod:703
1398 #: ../src/guestfs.pod:705
1400 "This is the only language binding that is working but incomplete. Only "
1401 "calls which return simple integers have been bound in Haskell, and we are "
1402 "looking for help to complete this binding."
1406 #: ../src/guestfs.pod:709
1411 #: ../src/guestfs.pod:711
1413 "Full documentation is contained in the Javadoc which is distributed with "
1418 #: ../src/guestfs.pod:714
1423 #: ../src/guestfs.pod:716
1424 msgid "See L<guestfs-ocaml(3)>."
1428 #: ../src/guestfs.pod:718
1433 #: ../src/guestfs.pod:720
1434 msgid "See L<Sys::Guestfs(3)>."
1438 #: ../src/guestfs.pod:722
1443 #: ../src/guestfs.pod:724
1445 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1446 "the php-libguestfs package for your distribution."
1450 #: ../src/guestfs.pod:727
1451 msgid "The PHP binding only works correctly on 64 bit machines."
1455 #: ../src/guestfs.pod:729
1460 #: ../src/guestfs.pod:731
1461 msgid "See L<guestfs-python(3)>."
1465 #: ../src/guestfs.pod:733
1470 #: ../src/guestfs.pod:735
1471 msgid "See L<guestfs-ruby(3)>."
1475 #: ../src/guestfs.pod:737
1476 msgid "B<shell scripts>"
1480 #: ../src/guestfs.pod:739
1481 msgid "See L<guestfish(1)>."
1485 #: ../src/guestfs.pod:743
1486 msgid "LIBGUESTFS GOTCHAS"
1490 #: ../src/guestfs.pod:745
1492 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1493 "system [...] that works in the way it is documented but is counterintuitive "
1494 "and almost invites mistakes.\""
1498 #: ../src/guestfs.pod:749
1500 "Since we developed libguestfs and the associated tools, there are several "
1501 "things we would have designed differently, but are now stuck with for "
1502 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1503 "release, you can expect these to change. Beware of them."
1507 #: ../src/guestfs.pod:757
1508 msgid "Autosync / forgetting to sync."
1512 #: ../src/guestfs.pod:759
1514 "When modifying a filesystem from C or another language, you B<must> unmount "
1515 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1516 "libguestfs handle. You can also call:"
1520 #: ../src/guestfs.pod:763
1523 " guestfs_set_autosync (g, 1);\n"
1528 #: ../src/guestfs.pod:765
1530 "to have the unmount/sync done automatically for you when the handle 'g' is "
1531 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1536 #: ../src/guestfs.pod:769
1538 "If you forget to do this, then it is entirely possible that your changes "
1539 "won't be written out, or will be partially written, or (very rarely) that "
1540 "you'll get disk corruption."
1544 #: ../src/guestfs.pod:773
1546 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1547 "guestfish scripts that forget to sync will work just fine, which can make "
1548 "this very puzzling if you are trying to debug a problem."
1552 #: ../src/guestfs.pod:777
1554 "Update: Autosync is enabled by default for all API users starting from "
1555 "libguestfs 1.5.24."
1559 #: ../src/guestfs.pod:780
1560 msgid "Mount option C<-o sync> should not be the default."
1564 #: ../src/guestfs.pod:782
1566 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1567 "However C<-o sync> does not add any reliability benefit, but does have a "
1568 "very large performance impact."
1572 #: ../src/guestfs.pod:786
1574 "The work around is to use L</guestfs_mount_options> and set the mount "
1575 "options that you actually want to use."
1579 #: ../src/guestfs.pod:789
1580 msgid "Read-only should be the default."
1584 #: ../src/guestfs.pod:791
1586 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1587 "specify I<--rw> if you want to make changes to the image."
1591 #: ../src/guestfs.pod:794
1592 msgid "This would reduce the potential to corrupt live VM images."
1596 #: ../src/guestfs.pod:796
1598 "Note that many filesystems change the disk when you just mount and unmount, "
1599 "even if you didn't perform any writes. You need to use "
1600 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1604 #: ../src/guestfs.pod:800
1605 msgid "guestfish command line is hard to use."
1609 #: ../src/guestfs.pod:802
1611 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1612 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1613 "exist, so it fails. In earlier versions of guestfish the error message was "
1614 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1615 "we should have used C<guestfish -c command> to run commands."
1619 #: ../src/guestfs.pod:809
1620 msgid "guestfish megabyte modifiers don't work right on all commands"
1624 #: ../src/guestfs.pod:811
1626 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1627 "other modifiers). What guestfish actually does is to multiply the number "
1628 "part by the modifier part and pass the result to the C API. However this "
1629 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1630 "expecting some other unit (eg. megabytes)."
1634 #: ../src/guestfs.pod:818
1635 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1639 #: ../src/guestfs.pod:820
1642 " lvcreate LV VG 100M\n"
1647 #: ../src/guestfs.pod:822
1649 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1650 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1651 "megabytes * megabytes) logical volume. The error message you get from this "
1652 "is also a little obscure."
1656 #: ../src/guestfs.pod:827
1658 "This could be fixed in the generator by specially marking parameters and "
1659 "return values which take bytes or other units."
1663 #: ../src/guestfs.pod:830
1664 msgid "Ambiguity between devices and paths"
1668 #: ../src/guestfs.pod:832
1670 "There is a subtle ambiguity in the API between a device name "
1671 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1672 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1676 #: ../src/guestfs.pod:837
1678 "In the current API we usually resolve this ambiguity by having two separate "
1679 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1680 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1681 "detecting if the path supplied begins with C</dev/>."
1685 #: ../src/guestfs.pod:843
1687 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1688 "make paths/devices into structured names. One way to do this would be to "
1689 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1690 "aspect of grub. Another way would be to use a structured type, equivalent "
1691 "to this OCaml type:"
1695 #: ../src/guestfs.pod:849
1698 " type path = Path of string | Device of int | Partition of int * int\n"
1703 #: ../src/guestfs.pod:851
1704 msgid "which would allow you to pass arguments like:"
1708 #: ../src/guestfs.pod:853
1711 " Path \"/foo/bar\"\n"
1712 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1713 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1714 " Path \"/dev/sdb2\" (* not a device *)\n"
1719 #: ../src/guestfs.pod:858
1721 "As you can see there are still problems to resolve even with this "
1722 "representation. Also consider how it might work in guestfish."
1726 #: ../src/guestfs.pod:863
1727 msgid "PROTOCOL LIMITS"
1731 #: ../src/guestfs.pod:865
1733 "Internally libguestfs uses a message-based protocol to pass API calls and "
1734 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1735 "plenty more detail about this). The maximum message size used by the "
1736 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1737 "aware of this limit. The API calls which may be affected are individually "
1738 "documented, with a link back to this section of the documentation."
1742 #: ../src/guestfs.pod:873
1744 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1745 "a simple string. Because this string is at some point internally encoded as "
1746 "a message, the maximum size that it can return is slightly under 4 MB. If "
1747 "the requested file is larger than this then you will get an error."
1751 #: ../src/guestfs.pod:879
1753 "In order to transfer large files into and out of the guest filesystem, you "
1754 "need to use particular calls that support this. The sections L</UPLOADING> "
1755 "and L</DOWNLOADING> document how to do this."
1759 #: ../src/guestfs.pod:883
1761 "You might also consider mounting the disk image using our FUSE filesystem "
1762 "support (L<guestmount(1)>)."
1766 #: ../src/guestfs.pod:886
1767 msgid "KEYS AND PASSPHRASES"
1771 #: ../src/guestfs.pod:888
1773 "Certain libguestfs calls take a parameter that contains sensitive key "
1774 "material, passed in as a C string."
1778 #: ../src/guestfs.pod:891
1780 "In the future we would hope to change the libguestfs implementation so that "
1781 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1782 "swap. However this is I<not> done at the moment, because of the complexity "
1783 "of such an implementation."
1787 #: ../src/guestfs.pod:896
1789 "Therefore you should be aware that any key parameter you pass to libguestfs "
1790 "might end up being written out to the swap partition. If this is a concern, "
1791 "scrub the swap partition or don't use libguestfs on encrypted devices."
1795 #: ../src/guestfs.pod:901
1796 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1800 #: ../src/guestfs.pod:903
1802 "All high-level libguestfs actions are synchronous. If you want to use "
1803 "libguestfs asynchronously then you must create a thread."
1807 #: ../src/guestfs.pod:906
1809 "Only use the handle from a single thread. Either use the handle exclusively "
1810 "from one thread, or provide your own mutex so that two threads cannot issue "
1811 "calls on the same handle at the same time."
1815 #: ../src/guestfs.pod:910
1817 "See the graphical program guestfs-browser for one possible architecture for "
1818 "multithreaded programs using libvirt and libguestfs."
1822 #: ../src/guestfs.pod:913
1827 #: ../src/guestfs.pod:915
1829 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1834 #: ../src/guestfs.pod:918
1836 "By default it looks for these in the directory C<$libdir/guestfs> "
1837 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1841 #: ../src/guestfs.pod:921
1843 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1844 "to change the directories that libguestfs will search in. The value is a "
1845 "colon-separated list of paths. The current directory is I<not> searched "
1846 "unless the path contains an empty element or C<.>. For example "
1847 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1848 "then C</usr/lib/guestfs>."
1852 #: ../src/guestfs.pod:928
1853 msgid "QEMU WRAPPERS"
1857 #: ../src/guestfs.pod:930
1859 "If you want to compile your own qemu, run qemu from a non-standard location, "
1860 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1865 #: ../src/guestfs.pod:934
1867 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1868 "last command in the shell script (so that qemu replaces the shell and "
1869 "becomes the direct child of the libguestfs-using program). If you don't do "
1870 "this, then the qemu process won't be cleaned up correctly."
1874 #: ../src/guestfs.pod:939
1876 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1881 #: ../src/guestfs.pod:942
1885 " qemudir=/home/rjones/d/qemu\n"
1886 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1892 #: ../src/guestfs.pod:946
1894 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1895 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1900 #: ../src/guestfs.pod:950
1903 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1908 #: ../src/guestfs.pod:952
1910 "Note that libguestfs also calls qemu with the -help and -version options in "
1911 "order to determine features."
1915 #: ../src/guestfs.pod:955
1916 msgid "ABI GUARANTEE"
1920 #: ../src/guestfs.pod:957
1922 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1923 "actions as outlined in this section. Although we will deprecate some "
1924 "actions, for example if they get replaced by newer calls, we will keep the "
1925 "old actions forever. This allows you the developer to program in confidence "
1926 "against the libguestfs API."
1930 #: ../src/guestfs.pod:963
1931 msgid "BLOCK DEVICE NAMING"
1935 #: ../src/guestfs.pod:965
1937 "In the kernel there is now quite a profusion of schemata for naming block "
1938 "devices (in this context, by I<block device> I mean a physical or virtual "
1939 "hard drive). The original Linux IDE driver used names starting with "
1940 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1941 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1942 "replacement for the old IDE driver (particularly for SATA devices) those "
1943 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1944 "machines with paravirtualized drivers. This has created several different "
1945 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1950 #: ../src/guestfs.pod:977
1952 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1953 "Linux kernel to access block devices. We can run a variety of appliances "
1954 "based on a variety of Linux kernels."
1958 #: ../src/guestfs.pod:981
1960 "This causes a problem for libguestfs because many API calls use device or "
1961 "partition names. Working scripts and the recipe (example) scripts that we "
1962 "make available over the internet could fail if the naming scheme changes."
1966 #: ../src/guestfs.pod:986
1968 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1969 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1970 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1971 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1975 #: ../src/guestfs.pod:992
1977 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1978 "L</guestfs_list_partitions> and similar calls return the true names of the "
1979 "devices and partitions as known to the appliance."
1983 #: ../src/guestfs.pod:997
1984 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1988 #: ../src/guestfs.pod:999
1990 "Usually this translation is transparent. However in some (very rare) cases "
1991 "you may need to know the exact algorithm. Such cases include where you use "
1992 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
1993 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
1998 #: ../src/guestfs.pod:1005
2000 "The algorithm is applied only to I<parameters> which are known to be either "
2001 "device or partition names. Return values from functions such as "
2002 "L</guestfs_list_devices> are never changed."
2006 #: ../src/guestfs.pod:1013
2007 msgid "Is the string a parameter which is a device or partition name?"
2011 #: ../src/guestfs.pod:1017
2012 msgid "Does the string begin with C</dev/sd>?"
2016 #: ../src/guestfs.pod:1021
2018 "Does the named device exist? If so, we use that device. However if I<not> "
2019 "then we continue with this algorithm."
2023 #: ../src/guestfs.pod:1026
2024 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2028 #: ../src/guestfs.pod:1028
2029 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2033 #: ../src/guestfs.pod:1030
2034 msgid "If that named device exists, use it. If not, continue."
2038 #: ../src/guestfs.pod:1034
2039 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2043 #: ../src/guestfs.pod:1036
2044 msgid "If that named device exists, use it. If not, return an error."
2048 #: ../src/guestfs.pod:1040
2049 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2053 #: ../src/guestfs.pod:1042
2055 "Although the standard naming scheme and automatic translation is useful for "
2056 "simple programs and guestfish scripts, for larger programs it is best not to "
2057 "rely on this mechanism."
2061 #: ../src/guestfs.pod:1046
2063 "Where possible for maximum future portability programs using libguestfs "
2064 "should use these future-proof techniques:"
2068 #: ../src/guestfs.pod:1053
2070 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2071 "device names, and then use those names directly."
2075 #: ../src/guestfs.pod:1056
2076 msgid "Since those device names exist by definition, they will never be translated."
2080 #: ../src/guestfs.pod:1061
2082 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2083 "filesystem labels."
2087 #: ../src/guestfs.pod:1066
2092 #: ../src/guestfs.pod:1068
2094 "This section discusses security implications of using libguestfs, "
2095 "particularly with untrusted or malicious guests or disk images."
2099 #: ../src/guestfs.pod:1071
2100 msgid "GENERAL SECURITY CONSIDERATIONS"
2104 #: ../src/guestfs.pod:1073
2106 "Be careful with any files or data that you download from a guest (by "
2107 "\"download\" we mean not just the L</guestfs_download> command but any "
2108 "command that reads files, filenames, directories or anything else from a "
2109 "disk image). An attacker could manipulate the data to fool your program "
2110 "into doing the wrong thing. Consider cases such as:"
2114 #: ../src/guestfs.pod:1083
2115 msgid "the data (file etc) not being present"
2119 #: ../src/guestfs.pod:1087
2120 msgid "being present but empty"
2124 #: ../src/guestfs.pod:1091
2125 msgid "being much larger than normal"
2129 #: ../src/guestfs.pod:1095
2130 msgid "containing arbitrary 8 bit data"
2134 #: ../src/guestfs.pod:1099
2135 msgid "being in an unexpected character encoding"
2139 #: ../src/guestfs.pod:1103
2140 msgid "containing homoglyphs."
2144 #: ../src/guestfs.pod:1107
2145 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2149 #: ../src/guestfs.pod:1109
2151 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2152 "(VFS) module can sometimes be escalated into exploits by deliberately "
2153 "creating a malicious, malformed filesystem. These exploits are very severe "
2154 "for two reasons. Firstly there are very many filesystem drivers in the "
2155 "kernel, and many of them are infrequently used and not much developer "
2156 "attention has been paid to the code. Linux userspace helps potential "
2157 "crackers by detecting the filesystem type and automatically choosing the "
2158 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2159 "the administrator. Secondly, a kernel-level exploit is like a local root "
2160 "exploit (worse in some ways), giving immediate and total access to the "
2161 "system right down to the hardware level."
2165 #: ../src/guestfs.pod:1122
2167 "That explains why you should never mount a filesystem from an untrusted "
2168 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2169 "inside a qemu virtual machine, usually running as a non-root user. The "
2170 "attacker would need to write a filesystem which first exploited the kernel, "
2171 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2172 "the libguestfs protocol, and finally to be as serious as the host kernel "
2173 "exploit it would need to escalate its privileges to root. This multi-step "
2174 "escalation, performed by a static piece of data, is thought to be extremely "
2175 "hard to do, although we never say 'never' about security issues."
2179 #: ../src/guestfs.pod:1133
2181 "In any case callers can reduce the attack surface by forcing the filesystem "
2182 "type when mounting (use L</guestfs_mount_vfs>)."
2186 #: ../src/guestfs.pod:1136
2187 msgid "PROTOCOL SECURITY"
2191 #: ../src/guestfs.pod:1138
2193 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2194 "defined upper message size. However a program that uses libguestfs must "
2195 "also take care - for example you can write a program that downloads a binary "
2196 "from a disk image and executes it locally, and no amount of protocol "
2197 "security will save you from the consequences."
2201 #: ../src/guestfs.pod:1144
2202 msgid "INSPECTION SECURITY"
2206 #: ../src/guestfs.pod:1146
2208 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2209 "directly from the guest, and these could contain any 8 bit data. Callers "
2210 "should be careful to escape these before printing them to a structured file "
2211 "(for example, use HTML escaping if creating a web page)."
2215 #: ../src/guestfs.pod:1152
2217 "Guest configuration may be altered in unusual ways by the administrator of "
2218 "the virtual machine, and may not reflect reality (particularly for untrusted "
2219 "or actively malicious guests). For example we parse the hostname from "
2220 "configuration files like C</etc/sysconfig/network> that we find in the "
2221 "guest, but the guest administrator can easily manipulate these files to "
2222 "provide the wrong hostname."
2226 #: ../src/guestfs.pod:1160
2228 "The inspection API parses guest configuration using two external libraries: "
2229 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2230 "designed to be robust in the face of malicious data, although denial of "
2231 "service attacks are still possible, for example with oversized configuration "
2236 #: ../src/guestfs.pod:1166
2237 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2241 #: ../src/guestfs.pod:1168
2243 "Be very cautious about running commands from the guest. By running a "
2244 "command in the guest, you are giving CPU time to a binary that you do not "
2245 "control, under the same user account as the library, albeit wrapped in qemu "
2246 "virtualization. More information and alternatives can be found in the "
2247 "section L</RUNNING COMMANDS>."
2251 #: ../src/guestfs.pod:1174
2252 msgid "CVE-2010-3851"
2256 #: ../src/guestfs.pod:1176
2257 msgid "https://bugzilla.redhat.com/642934"
2261 #: ../src/guestfs.pod:1178
2263 "This security bug concerns the automatic disk format detection that qemu "
2264 "does on disk images."
2268 #: ../src/guestfs.pod:1181
2270 "A raw disk image is just the raw bytes, there is no header. Other disk "
2271 "images like qcow2 contain a special header. Qemu deals with this by looking "
2272 "for one of the known headers, and if none is found then assuming the disk "
2273 "image must be raw."
2277 #: ../src/guestfs.pod:1186
2279 "This allows a guest which has been given a raw disk image to write some "
2280 "other header. At next boot (or when the disk image is accessed by "
2281 "libguestfs) qemu would do autodetection and think the disk image format was, "
2282 "say, qcow2 based on the header written by the guest."
2286 #: ../src/guestfs.pod:1191
2288 "This in itself would not be a problem, but qcow2 offers many features, one "
2289 "of which is to allow a disk image to refer to another image (called the "
2290 "\"backing disk\"). It does this by placing the path to the backing disk "
2291 "into the qcow2 header. This path is not validated and could point to any "
2292 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2293 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2294 "control of the attacker."
2298 #: ../src/guestfs.pod:1199
2299 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2303 #: ../src/guestfs.pod:1206
2304 msgid "You have enabled the network or have opened the disk in write mode."
2308 #: ../src/guestfs.pod:1210
2310 "You are also running untrusted code from the guest (see L</RUNNING "
2315 #: ../src/guestfs.pod:1215
2317 "The way to avoid this is to specify the expected disk format when adding "
2318 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2319 "should always do this if the disk is raw format, and it's a good idea for "
2324 #: ../src/guestfs.pod:1220
2326 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2327 "format is fetched from libvirt and passed through."
2331 #: ../src/guestfs.pod:1223
2333 "For libguestfs tools, use the I<--format> command line parameter as "
2338 #: ../src/guestfs.pod:1226
2339 msgid "CONNECTION MANAGEMENT"
2343 #: ../src/guestfs.pod:1228
2348 #: ../src/guestfs.pod:1230
2350 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2351 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2352 "handle and release all resources used."
2356 #: ../src/guestfs.pod:1234
2358 "For information on using multiple handles and threads, see the section "
2359 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2363 #: ../src/guestfs.pod:1237
2364 msgid "guestfs_create"
2368 #: ../src/guestfs.pod:1239
2371 " guestfs_h *guestfs_create (void);\n"
2376 #: ../src/guestfs.pod:1241
2377 msgid "Create a connection handle."
2381 #: ../src/guestfs.pod:1243
2383 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2384 "on the handle at least once."
2388 #: ../src/guestfs.pod:1246
2390 "This function returns a non-NULL pointer to a handle on success or NULL on "
2395 #: ../src/guestfs.pod:1249
2396 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2400 #: ../src/guestfs.pod:1251
2402 "You may also want to configure error handling for the handle. See L</ERROR "
2403 "HANDLING> section below."
2407 #: ../src/guestfs.pod:1254
2408 msgid "guestfs_close"
2412 #: ../src/guestfs.pod:1256
2415 " void guestfs_close (guestfs_h *g);\n"
2420 #: ../src/guestfs.pod:1258
2421 msgid "This closes the connection handle and frees up all resources used."
2425 #: ../src/guestfs.pod:1260
2426 msgid "ERROR HANDLING"
2430 #: ../src/guestfs.pod:1262
2432 "API functions can return errors. For example, almost all functions that "
2433 "return C<int> will return C<-1> to indicate an error."
2437 #: ../src/guestfs.pod:1265
2439 "Additional information is available for errors: an error message string and "
2440 "optionally an error number (errno) if the thing that failed was a system "
2445 #: ../src/guestfs.pod:1269
2447 "You can get at the additional information about the last error on the handle "
2448 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2449 "up an error handler with L</guestfs_set_error_handler>."
2453 #: ../src/guestfs.pod:1274
2455 "When the handle is created, a default error handler is installed which "
2456 "prints the error message string to C<stderr>. For small short-running "
2457 "command line programs it is sufficient to do:"
2461 #: ../src/guestfs.pod:1278
2464 " if (guestfs_launch (g) == -1)\n"
2465 " exit (EXIT_FAILURE);\n"
2470 #: ../src/guestfs.pod:1281
2472 "since the default error handler will ensure that an error message has been "
2473 "printed to C<stderr> before the program exits."
2477 #: ../src/guestfs.pod:1284
2479 "For other programs the caller will almost certainly want to install an "
2480 "alternate error handler or do error handling in-line like this:"
2484 #: ../src/guestfs.pod:1287
2487 " g = guestfs_create ();\n"
2492 #: ../src/guestfs.pod:1289
2495 " /* This disables the default behaviour of printing errors\n"
2497 " guestfs_set_error_handler (g, NULL, NULL);\n"
2502 #: ../src/guestfs.pod:1293
2505 " if (guestfs_launch (g) == -1) {\n"
2506 " /* Examine the error message and print it etc. */\n"
2507 " char *msg = guestfs_last_error (g);\n"
2508 " int errnum = guestfs_last_errno (g);\n"
2509 " fprintf (stderr, \"%s\\n\", msg);\n"
2516 #: ../src/guestfs.pod:1301
2518 "Out of memory errors are handled differently. The default action is to call "
2519 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2520 "L</guestfs_set_out_of_memory_handler>."
2524 #: ../src/guestfs.pod:1305
2526 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2527 "because there is no handle if this happens there is no way to get additional "
2528 "error information. However L</guestfs_create> is supposed to be a "
2529 "lightweight operation which can only fail because of insufficient memory (it "
2530 "returns NULL in this case)."
2534 #: ../src/guestfs.pod:1311
2535 msgid "guestfs_last_error"
2539 #: ../src/guestfs.pod:1313
2542 " const char *guestfs_last_error (guestfs_h *g);\n"
2547 #: ../src/guestfs.pod:1315
2549 "This returns the last error message that happened on C<g>. If there has not "
2550 "been an error since the handle was created, then this returns C<NULL>."
2554 #: ../src/guestfs.pod:1319
2556 "The lifetime of the returned string is until the next error occurs, or "
2557 "L</guestfs_close> is called."
2561 #: ../src/guestfs.pod:1322
2562 msgid "guestfs_last_errno"
2566 #: ../src/guestfs.pod:1324
2569 " int guestfs_last_errno (guestfs_h *g);\n"
2574 #: ../src/guestfs.pod:1326
2575 msgid "This returns the last error number (errno) that happened on C<g>."
2579 #: ../src/guestfs.pod:1328
2580 msgid "If successful, an errno integer not equal to zero is returned."
2584 #: ../src/guestfs.pod:1330
2585 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2589 #: ../src/guestfs.pod:1337
2590 msgid "There has not been any error on the handle."
2594 #: ../src/guestfs.pod:1341
2596 "There has been an error but the errno was meaningless. This corresponds to "
2597 "the case where the error did not come from a failed system call, but for "
2598 "some other reason."
2602 #: ../src/guestfs.pod:1347
2604 "There was an error from a failed system call, but for some reason the errno "
2605 "was not captured and returned. This usually indicates a bug in libguestfs."
2609 #: ../src/guestfs.pod:1353
2611 "Libguestfs tries to convert the errno from inside the applicance into a "
2612 "corresponding errno for the caller (not entirely trivial: the appliance "
2613 "might be running a completely different operating system from the library "
2614 "and error numbers are not standardized across Un*xen). If this could not be "
2615 "done, then the error is translated to C<EINVAL>. In practice this should "
2616 "only happen in very rare circumstances."
2620 #: ../src/guestfs.pod:1361
2621 msgid "guestfs_set_error_handler"
2625 #: ../src/guestfs.pod:1363
2628 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2630 " const char *msg);\n"
2631 " void guestfs_set_error_handler (guestfs_h *g,\n"
2632 " guestfs_error_handler_cb cb,\n"
2638 #: ../src/guestfs.pod:1370
2640 "The callback C<cb> will be called if there is an error. The parameters "
2641 "passed to the callback are an opaque data pointer and the error message "
2646 #: ../src/guestfs.pod:1374
2648 "C<errno> is not passed to the callback. To get that the callback must call "
2649 "L</guestfs_last_errno>."
2653 #: ../src/guestfs.pod:1377
2655 "Note that the message string C<msg> is freed as soon as the callback "
2656 "function returns, so if you want to stash it somewhere you must make your "
2661 #: ../src/guestfs.pod:1381
2662 msgid "The default handler prints messages on C<stderr>."
2666 #: ../src/guestfs.pod:1383
2667 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2671 #: ../src/guestfs.pod:1385
2672 msgid "guestfs_get_error_handler"
2676 #: ../src/guestfs.pod:1387
2679 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2680 " void **opaque_rtn);\n"
2685 #: ../src/guestfs.pod:1390
2686 msgid "Returns the current error handler callback."
2690 #: ../src/guestfs.pod:1392
2691 msgid "guestfs_set_out_of_memory_handler"
2695 #: ../src/guestfs.pod:1394
2698 " typedef void (*guestfs_abort_cb) (void);\n"
2699 " 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:1839 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1250 ../tools/virt-win-reg.pl:532
3099 #: ../src/guestfs.pod:1585
3100 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3104 #: ../src/guestfs.pod:1590
3105 msgid "You do not need to fill in all fields of the structure."
3109 #: ../src/guestfs.pod:1594
3111 "There must be a one-to-one correspondence between fields of the structure "
3112 "that are filled in, and bits set in the bitmask."
3116 #: ../src/guestfs.pod:1599
3117 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3121 #: ../src/guestfs.pod:1601
3123 "In other languages, optional arguments are expressed in the way that is "
3124 "natural for that language. We refer you to the language-specific "
3125 "documentation for more details on that."
3129 #: ../src/guestfs.pod:1605
3130 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3134 #: ../src/guestfs.pod:1607
3135 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3139 #: ../src/guestfs.pod:1609
3141 "The child process generates events in some situations. Current events "
3142 "include: receiving a log message, the child process exits."
3146 #: ../src/guestfs.pod:1612
3148 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3153 #: ../src/guestfs.pod:1615
3155 "Only I<one callback of each type> can be registered for each handle. "
3156 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3157 "that type. Cancel all callbacks of this type by calling this function with "
3158 "C<cb> set to C<NULL>."
3162 #: ../src/guestfs.pod:1620
3163 msgid "guestfs_set_log_message_callback"
3167 #: ../src/guestfs.pod:1622
3170 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3171 " char *buf, int len);\n"
3172 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3173 " guestfs_log_message_cb cb,\n"
3179 #: ../src/guestfs.pod:1628
3181 "The callback function C<cb> will be called whenever qemu or the guest writes "
3182 "anything to the console."
3186 #: ../src/guestfs.pod:1631
3187 msgid "Use this function to capture kernel messages and similar."
3191 #: ../src/guestfs.pod:1633
3193 "Normally there is no log message handler, and log messages are just "
3198 #: ../src/guestfs.pod:1636
3199 msgid "guestfs_set_subprocess_quit_callback"
3203 #: ../src/guestfs.pod:1638
3206 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3207 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3208 " guestfs_subprocess_quit_cb cb,\n"
3214 #: ../src/guestfs.pod:1643
3216 "The callback function C<cb> will be called when the child process quits, "
3217 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3218 "corresponds to a transition from any state to the CONFIG state)."
3222 #: ../src/guestfs.pod:1648
3223 msgid "guestfs_set_launch_done_callback"
3227 #: ../src/guestfs.pod:1650
3230 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3231 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3232 " guestfs_launch_done_cb cb,\n"
3238 #: ../src/guestfs.pod:1655
3240 "The callback function C<cb> will be called when the child process becomes "
3241 "ready first time after it has been launched. (This corresponds to a "
3242 "transition from LAUNCHING to the READY state)."
3246 #: ../src/guestfs.pod:1659
3247 msgid "guestfs_set_close_callback"
3251 #: ../src/guestfs.pod:1661
3254 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3255 " void guestfs_set_close_callback (guestfs_h *g,\n"
3256 " guestfs_close_cb cb,\n"
3262 #: ../src/guestfs.pod:1666
3264 "The callback function C<cb> will be called while the handle is being closed "
3265 "(synchronously from L</guestfs_close>)."
3269 #: ../src/guestfs.pod:1669
3271 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3272 "handles that are open when the program exits. This means that this callback "
3273 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3274 "problems in higher-level languages (eg. if your HLL interpreter has already "
3275 "been cleaned up by the time this is called, and if your callback then jumps "
3276 "into some HLL function)."
3280 #: ../src/guestfs.pod:1677
3281 msgid "guestfs_set_progress_callback"
3285 #: ../src/guestfs.pod:1679
3288 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3289 " int proc_nr, int serial,\n"
3290 " uint64_t position, uint64_t total);\n"
3291 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3292 " guestfs_progress_cb cb,\n"
3298 #: ../src/guestfs.pod:1686
3300 "Some long-running operations can generate progress messages. If this "
3301 "callback is registered, then it will be called each time a progress message "
3302 "is generated (usually two seconds after the operation started, and three "
3303 "times per second thereafter until it completes, although the frequency may "
3304 "change in future versions)."
3308 #: ../src/guestfs.pod:1692
3310 "The callback receives two numbers: C<position> and C<total>. The units of "
3311 "C<total> are not defined, although for some operations C<total> may relate "
3312 "in some way to the amount of data to be transferred (eg. in bytes or "
3313 "megabytes), and C<position> may be the portion which has been transferred."
3317 #: ../src/guestfs.pod:1698
3318 msgid "The only defined and stable parts of the API are:"
3322 #: ../src/guestfs.pod:1704
3324 "The callback can display to the user some type of progress bar or indicator "
3325 "which shows the ratio of C<position>:C<total>."
3329 #: ../src/guestfs.pod:1709
3330 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3334 #: ../src/guestfs.pod:1713
3336 "If any progress notification is sent during a call, then a final progress "
3337 "notification is always sent when C<position> = C<total> (I<unless> the call "
3338 "fails with an error)."
3342 #: ../src/guestfs.pod:1717
3344 "This is to simplify caller code, so callers can easily set the progress "
3345 "indicator to \"100%\" at the end of the operation, without requiring special "
3346 "code to detect this case."
3350 #: ../src/guestfs.pod:1723
3352 "The callback also receives the procedure number and serial number of the "
3353 "call. These are only useful for debugging protocol issues, and the callback "
3354 "can normally ignore them. The callback may want to print these numbers in "
3355 "error messages or debugging messages."
3359 #: ../src/guestfs.pod:1728
3360 msgid "PRIVATE DATA AREA"
3364 #: ../src/guestfs.pod:1730
3366 "You can attach named pieces of private data to the libguestfs handle, and "
3367 "fetch them by name for the lifetime of the handle. This is called the "
3368 "private data area and is only available from the C API."
3372 #: ../src/guestfs.pod:1734
3373 msgid "To attach a named piece of data, use the following call:"
3377 #: ../src/guestfs.pod:1736
3380 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3385 #: ../src/guestfs.pod:1738
3387 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3388 "pointer (which can be C<NULL>). Any previous item with the same name is "
3393 #: ../src/guestfs.pod:1742
3395 "You can use any C<key> you want, but names beginning with an underscore "
3396 "character are reserved for internal libguestfs purposes (for implementing "
3397 "language bindings). It is recommended to prefix the name with some unique "
3398 "string to avoid collisions with other users."
3402 #: ../src/guestfs.pod:1747
3403 msgid "To retrieve the pointer, use:"
3407 #: ../src/guestfs.pod:1749
3410 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3415 #: ../src/guestfs.pod:1751
3417 "This function returns C<NULL> if either no data is found associated with "
3418 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3423 #: ../src/guestfs.pod:1755
3425 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3426 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3427 "all. In particular, libguestfs does I<not> try to free the data when the "
3428 "handle is closed. If the data must be freed, then the caller must either "
3429 "free it before calling L</guestfs_close> or must set up a close callback to "
3430 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3431 "can be registered for a handle)."
3435 #: ../src/guestfs.pod:1763
3437 "The private data area is implemented using a hash table, and should be "
3438 "reasonably efficient for moderate numbers of keys."
3442 #: ../src/guestfs.pod:1766 ../src/guestfs.pod:1771
3447 #: ../src/guestfs.pod:1768
3449 "<!-- old anchor for the next section --> <a "
3450 "name=\"state_machine_and_low_level_event_api\"/>"
3454 #: ../src/guestfs.pod:1773
3455 msgid "ARCHITECTURE"
3459 #: ../src/guestfs.pod:1775
3461 "Internally, libguestfs is implemented by running an appliance (a special "
3462 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3463 "process of the main program."
3467 #: ../src/guestfs.pod:1779
3470 " ___________________\n"
3472 " | main program |\n"
3474 " | | child process / appliance\n"
3475 " | | __________________________\n"
3477 " +-------------------+ RPC | +-----------------+ |\n"
3478 " | libguestfs <--------------------> guestfsd | |\n"
3479 " | | | +-----------------+ |\n"
3480 " \\___________________/ | | Linux kernel | |\n"
3481 " | +--^--------------+ |\n"
3482 " \\_________|________________/\n"
3488 " \\______________/\n"
3493 #: ../src/guestfs.pod:1799
3495 "The library, linked to the main program, creates the child process and hence "
3496 "the appliance in the L</guestfs_launch> function."
3500 #: ../src/guestfs.pod:1802
3502 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3503 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3504 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3505 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3506 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3507 "attached to the qemu process which translates device access by the "
3508 "appliance's Linux kernel into accesses to the image."
3512 #: ../src/guestfs.pod:1811
3514 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3515 "Although the disk image you are attached to might also be used by some "
3516 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3517 "care if both libguestfs's qemu process and your virtual machine are trying "
3518 "to update the disk image at the same time, since these usually results in "
3519 "massive disk corruption)."
3523 #: ../src/guestfs.pod:1818
3524 msgid "STATE MACHINE"
3528 #: ../src/guestfs.pod:1820
3529 msgid "libguestfs uses a state machine to model the child process:"
3533 #: ../src/guestfs.pod:1822
3545 " / | \\ \\ guestfs_launch\n"
3546 " / | _\\__V______\n"
3548 " / | | LAUNCHING |\n"
3549 " / | \\___________/\n"
3551 " / | guestfs_launch\n"
3553 " ______ / __|____V\n"
3554 " / \\ ------> / \\\n"
3555 " | BUSY | | READY |\n"
3556 " \\______/ <------ \\________/\n"
3561 #: ../src/guestfs.pod:1844
3563 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3564 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3565 "(3) alternating between READY and BUSY as commands are issued to, and "
3566 "carried out by, the child process."
3570 #: ../src/guestfs.pod:1849
3572 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3573 "asynchronously at any time (eg. due to some internal error), and that causes "
3574 "the state to transition back to CONFIG."
3578 #: ../src/guestfs.pod:1853
3580 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3581 "issued when in the CONFIG state."
3585 #: ../src/guestfs.pod:1856
3587 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3588 "L</guestfs_launch> blocks until the child process is READY to accept "
3589 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3590 "moves the state from CONFIG to LAUNCHING while it is running."
3594 #: ../src/guestfs.pod:1862
3596 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3597 "state. These API calls block waiting for the command to be carried out "
3598 "(ie. the state to transition to BUSY and then back to READY). There are no "
3599 "non-blocking versions, and no way to issue more than one command per handle "
3604 #: ../src/guestfs.pod:1868
3606 "Finally, the child process sends asynchronous messages back to the main "
3607 "program, such as kernel log messages. You can register a callback to "
3608 "receive these messages."
3612 #: ../src/guestfs.pod:1872
3617 #: ../src/guestfs.pod:1874
3618 msgid "COMMUNICATION PROTOCOL"
3622 #: ../src/guestfs.pod:1876
3624 "Don't rely on using this protocol directly. This section documents how it "
3625 "currently works, but it may change at any time."
3629 #: ../src/guestfs.pod:1879
3631 "The protocol used to talk between the library and the daemon running inside "
3632 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3633 "1014, RFC 1832, RFC 4506)."
3637 #: ../src/guestfs.pod:1883
3639 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3640 "this file is automatically generated)."
3644 #: ../src/guestfs.pod:1886
3646 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3647 "and C<FileOut> parameters, which are handled with very simple request/reply "
3648 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3649 "parameters, which use the same request and reply messages, but they may also "
3650 "be followed by files sent using a chunked encoding."
3654 #: ../src/guestfs.pod:1893
3655 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3659 #: ../src/guestfs.pod:1895
3660 msgid "For ordinary functions, the request message is:"
3664 #: ../src/guestfs.pod:1897
3667 " total length (header + arguments,\n"
3668 " but not including the length word itself)\n"
3669 " struct guestfs_message_header (encoded as XDR)\n"
3670 " struct guestfs_<foo>_args (encoded as XDR)\n"
3675 #: ../src/guestfs.pod:1902
3677 "The total length field allows the daemon to allocate a fixed size buffer "
3678 "into which it slurps the rest of the message. As a result, the total length "
3679 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3680 "effective size of any request is limited to somewhere under this size."
3684 #: ../src/guestfs.pod:1908
3686 "Note also that many functions don't take any arguments, in which case the "
3687 "C<guestfs_I<foo>_args> is completely omitted."
3691 #: ../src/guestfs.pod:1911
3693 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3694 "receiver knows what type of args structure to expect, or none at all."
3698 #: ../src/guestfs.pod:1915
3700 "For functions that take optional arguments, the optional arguments are "
3701 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3702 "arguments. A bitmask in the header indicates which optional arguments are "
3703 "meaningful. The bitmask is also checked to see if it contains bits set "
3704 "which the daemon does not know about (eg. if more optional arguments were "
3705 "added in a later version of the library), and this causes the call to be "
3710 #: ../src/guestfs.pod:1923
3711 msgid "The reply message for ordinary functions is:"
3715 #: ../src/guestfs.pod:1925
3718 " total length (header + ret,\n"
3719 " but not including the length word itself)\n"
3720 " struct guestfs_message_header (encoded as XDR)\n"
3721 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3726 #: ../src/guestfs.pod:1930
3728 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3729 "functions that return no formal return values."
3733 #: ../src/guestfs.pod:1933
3734 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3738 #: ../src/guestfs.pod:1936
3740 "In the case of an error, a flag is set in the header, and the reply message "
3741 "is slightly changed:"
3745 #: ../src/guestfs.pod:1939
3748 " total length (header + error,\n"
3749 " but not including the length word itself)\n"
3750 " struct guestfs_message_header (encoded as XDR)\n"
3751 " struct guestfs_message_error (encoded as XDR)\n"
3756 #: ../src/guestfs.pod:1944
3758 "The C<guestfs_message_error> structure contains the error message as a "
3763 #: ../src/guestfs.pod:1947
3764 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3768 #: ../src/guestfs.pod:1949
3770 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3771 "The normal request message is sent (see above). However this is followed by "
3772 "a sequence of file chunks."
3776 #: ../src/guestfs.pod:1953
3779 " total length (header + arguments,\n"
3780 " but not including the length word itself,\n"
3781 " and not including the chunks)\n"
3782 " struct guestfs_message_header (encoded as XDR)\n"
3783 " struct guestfs_<foo>_args (encoded as XDR)\n"
3784 " sequence of chunks for FileIn param #0\n"
3785 " sequence of chunks for FileIn param #1 etc.\n"
3790 #: ../src/guestfs.pod:1961
3791 msgid "The \"sequence of chunks\" is:"
3795 #: ../src/guestfs.pod:1963
3798 " length of chunk (not including length word itself)\n"
3799 " struct guestfs_chunk (encoded as XDR)\n"
3800 " length of chunk\n"
3801 " struct guestfs_chunk (encoded as XDR)\n"
3803 " length of chunk\n"
3804 " struct guestfs_chunk (with data.data_len == 0)\n"
3809 #: ../src/guestfs.pod:1971
3811 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3812 "is set in the final chunk to indicate either successful completion or early "
3817 #: ../src/guestfs.pod:1975
3819 "At time of writing there are no functions that have more than one FileIn "
3820 "parameter. However this is (theoretically) supported, by sending the "
3821 "sequence of chunks for each FileIn parameter one after another (from left to "
3826 #: ../src/guestfs.pod:1980
3828 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3829 "transfer. The library does this by sending a chunk with a special flag set "
3830 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3831 "RPC, does I<not> send any reply, and goes back to reading the next request."
3835 #: ../src/guestfs.pod:1986
3837 "The daemon may also cancel. It does this by writing a special word "
3838 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3839 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3840 "cancel chunk). The special word is chosen so that even if cancellation "
3841 "happens right at the end of the transfer (after the library has finished "
3842 "writing and has started listening for the reply), the \"spurious\" cancel "
3843 "flag will not be confused with the reply message."
3847 #: ../src/guestfs.pod:1995
3849 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3850 "limit), and also files where the size is not known in advance (eg. from "
3851 "pipes or sockets). However the chunks are rather small "
3852 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3853 "to keep much in memory."
3857 #: ../src/guestfs.pod:2001
3858 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3862 #: ../src/guestfs.pod:2003
3864 "The protocol for FileOut parameters is exactly the same as for FileIn "
3865 "parameters, but with the roles of daemon and library reversed."
3869 #: ../src/guestfs.pod:2006
3872 " total length (header + ret,\n"
3873 " but not including the length word itself,\n"
3874 " and not including the chunks)\n"
3875 " struct guestfs_message_header (encoded as XDR)\n"
3876 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3877 " sequence of chunks for FileOut param #0\n"
3878 " sequence of chunks for FileOut param #1 etc.\n"
3883 #: ../src/guestfs.pod:2014
3884 msgid "INITIAL MESSAGE"
3888 #: ../src/guestfs.pod:2016
3890 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3891 "which indicates that the guest and daemon is alive. This is what "
3892 "L</guestfs_launch> waits for."
3896 #: ../src/guestfs.pod:2020
3897 msgid "PROGRESS NOTIFICATION MESSAGES"
3901 #: ../src/guestfs.pod:2022
3903 "The daemon may send progress notification messages at any time. These are "
3904 "distinguished by the normal length word being replaced by "
3905 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3909 #: ../src/guestfs.pod:2026
3911 "The library turns them into progress callbacks (see "
3912 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3913 "discards them if not."
3917 #: ../src/guestfs.pod:2030
3919 "The daemon self-limits the frequency of progress messages it sends (see "
3920 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3925 #: ../src/guestfs.pod:2034
3926 msgid "LIBGUESTFS VERSION NUMBERS"
3930 #: ../src/guestfs.pod:2036
3932 "Since April 2010, libguestfs has started to make separate development and "
3933 "stable releases, along with corresponding branches in our git repository. "
3934 "These separate releases can be identified by version number:"
3938 #: ../src/guestfs.pod:2041
3941 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3942 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3948 " | `-------- sub-version\n"
3950 " `------ always '1' because we don't change the ABI\n"
3955 #: ../src/guestfs.pod:2052
3956 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3960 #: ../src/guestfs.pod:2054
3962 "As time passes we cherry pick fixes from the development branch and backport "
3963 "those into the stable branch, the effect being that the stable branch should "
3964 "get more stable and less buggy over time. So the stable releases are ideal "
3965 "for people who don't need new features but would just like the software to "
3970 #: ../src/guestfs.pod:2060
3971 msgid "Our criteria for backporting changes are:"
3975 #: ../src/guestfs.pod:2066
3977 "Documentation changes which don't affect any code are backported unless the "
3978 "documentation refers to a future feature which is not in stable."
3982 #: ../src/guestfs.pod:2072
3984 "Bug fixes which are not controversial, fix obvious problems, and have been "
3985 "well tested are backported."
3989 #: ../src/guestfs.pod:2077
3991 "Simple rearrangements of code which shouldn't affect how it works get "
3992 "backported. This is so that the code in the two branches doesn't get too "
3993 "far out of step, allowing us to backport future fixes more easily."
3997 #: ../src/guestfs.pod:2083
3999 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4000 "exceptional case: the new feature is required in order to implement an "
4001 "important bug fix."
4005 #: ../src/guestfs.pod:2089
4007 "A new stable branch starts when we think the new features in development are "
4008 "substantial and compelling enough over the current stable branch to warrant "
4009 "it. When that happens we create new stable and development versions 1.N.0 "
4010 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4011 "stable at this point, but by backporting fixes from development, that branch "
4012 "will stabilize over time."
4016 #: ../src/guestfs.pod:2097
4017 msgid "EXTENDING LIBGUESTFS"
4021 #: ../src/guestfs.pod:2099
4022 msgid "ADDING A NEW API ACTION"
4026 #: ../src/guestfs.pod:2101
4028 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4029 "documentation) are generated, and this makes it easy to extend the "
4034 #: ../src/guestfs.pod:2105
4035 msgid "To add a new API action there are two changes:"
4039 #: ../src/guestfs.pod:2111
4041 "You need to add a description of the call (name, parameters, return type, "
4042 "tests, documentation) to C<generator/generator_actions.ml>."
4046 #: ../src/guestfs.pod:2114
4048 "There are two sorts of API action, depending on whether the call goes "
4049 "through to the daemon in the appliance, or is serviced entirely by the "
4050 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4051 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4052 "an example of the latter, since a trace flag is maintained in the handle and "
4053 "all tracing is done on the library side."
4057 #: ../src/guestfs.pod:2122
4059 "Most new actions are of the first type, and get added to the "
4060 "C<daemon_functions> list. Each function has a unique procedure number used "
4061 "in the RPC protocol which is assigned to that action when we publish "
4062 "libguestfs and cannot be reused. Take the latest procedure number and "
4067 #: ../src/guestfs.pod:2128
4069 "For library-only actions of the second type, add to the "
4070 "C<non_daemon_functions> list. Since these functions are serviced by the "
4071 "library and do not travel over the RPC mechanism to the daemon, these "
4072 "functions do not need a procedure number, and so the procedure number is set "
4077 #: ../src/guestfs.pod:2136
4078 msgid "Implement the action (in C):"
4082 #: ../src/guestfs.pod:2138
4084 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4085 "C<daemon/> directory."
4089 #: ../src/guestfs.pod:2141
4091 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4092 "(note: double underscore) in the C<src/> directory."
4096 #: ../src/guestfs.pod:2144
4097 msgid "In either case, use another function as an example of what to do."
4101 #: ../src/guestfs.pod:2148
4102 msgid "After making these changes, use C<make> to compile."
4106 #: ../src/guestfs.pod:2150
4108 "Note that you don't need to implement the RPC, language bindings, manual "
4109 "pages or anything else. It's all automatically generated from the OCaml "
4114 #: ../src/guestfs.pod:2154
4115 msgid "ADDING TESTS FOR AN API ACTION"
4119 #: ../src/guestfs.pod:2156
4121 "You can supply zero or as many tests as you want per API call. The tests "
4122 "can either be added as part of the API description "
4123 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4124 "drop a script into C<regressions/>. Note that adding a script to "
4125 "C<regressions/> is slower, so if possible use the first method."
4129 #: ../src/guestfs.pod:2162
4131 "The following describes the test environment used when you add an API test "
4132 "in C<generator_actions.ml>."
4136 #: ../src/guestfs.pod:2165
4137 msgid "The test environment has 4 block devices:"
4141 #: ../src/guestfs.pod:2169
4142 msgid "C</dev/sda> 500MB"
4146 #: ../src/guestfs.pod:2171
4147 msgid "General block device for testing."
4151 #: ../src/guestfs.pod:2173
4152 msgid "C</dev/sdb> 50MB"
4156 #: ../src/guestfs.pod:2175
4158 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4163 #: ../src/guestfs.pod:2178
4164 msgid "C</dev/sdc> 10MB"
4168 #: ../src/guestfs.pod:2180
4169 msgid "Used in a few tests where two block devices are needed."
4173 #: ../src/guestfs.pod:2182
4178 #: ../src/guestfs.pod:2184
4179 msgid "ISO with fixed content (see C<images/test.iso>)."
4183 #: ../src/guestfs.pod:2188
4185 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4186 "appliance and block devices are reused between tests. So don't try testing "
4187 "L</guestfs_kill_subprocess> :-x"
4191 #: ../src/guestfs.pod:2192
4193 "Each test starts with an initial scenario, selected using one of the "
4194 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4195 "initialize the disks mentioned above in a particular way as documented in "
4196 "C<generator_types.ml>. You should not assume anything about the previous "
4197 "contents of other disks that are not initialized."
4201 #: ../src/guestfs.pod:2198
4203 "You can add a prerequisite clause to any individual test. This is a "
4204 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4205 "if testing a command which might not work on all variations of libguestfs "
4206 "builds. A test that has prerequisite of C<Always> means to run "
4211 #: ../src/guestfs.pod:2204
4213 "In addition, packagers can skip individual tests by setting environment "
4214 "variables before running C<make check>."
4218 #: ../src/guestfs.pod:2207
4221 " SKIP_TEST_<CMD>_<NUM>=1\n"
4226 #: ../src/guestfs.pod:2209
4227 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4231 #: ../src/guestfs.pod:2211
4236 #: ../src/guestfs.pod:2213
4239 " SKIP_TEST_<CMD>=1\n"
4244 #: ../src/guestfs.pod:2215
4245 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4249 #: ../src/guestfs.pod:2217
4250 msgid "Packagers can run only certain tests by setting for example:"
4254 #: ../src/guestfs.pod:2219
4257 " TEST_ONLY=\"vfs_type zerofree\"\n"
4262 #: ../src/guestfs.pod:2221
4264 "See C<capitests/tests.c> for more details of how these environment variables "
4269 #: ../src/guestfs.pod:2224
4270 msgid "DEBUGGING NEW API ACTIONS"
4274 #: ../src/guestfs.pod:2226
4275 msgid "Test new actions work before submitting them."
4279 #: ../src/guestfs.pod:2228
4280 msgid "You can use guestfish to try out new commands."
4284 #: ../src/guestfs.pod:2230
4286 "Debugging the daemon is a problem because it runs inside a minimal "
4287 "environment. However you can fprintf messages in the daemon to stderr, and "
4288 "they will show up if you use C<guestfish -v>."
4292 #: ../src/guestfs.pod:2234
4293 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4297 #: ../src/guestfs.pod:2236
4299 "Our C source code generally adheres to some basic code-formatting "
4300 "conventions. The existing code base is not totally consistent on this "
4301 "front, but we do prefer that contributed code be formatted similarly. In "
4302 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4303 "indentation level, and other than that, follow the K&R style."
4307 #: ../src/guestfs.pod:2242
4309 "If you use Emacs, add the following to one of one of your start-up files "
4310 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4314 #: ../src/guestfs.pod:2245
4317 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4318 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4319 " (add-hook 'find-file-hook\n"
4320 " '(lambda () (if (and buffer-file-name\n"
4321 " (string-match \"/libguestfs\\\\>\"\n"
4322 " (buffer-file-name))\n"
4323 " (not (string-equal mode-name \"Change Log\"))\n"
4324 " (not (string-equal mode-name \"Makefile\")))\n"
4325 " (setq indent-tabs-mode nil))))\n"
4330 #: ../src/guestfs.pod:2255
4333 " ;;; When editing C sources in libguestfs, use this style.\n"
4334 " (defun libguestfs-c-mode ()\n"
4335 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4337 " (c-set-style \"K&R\")\n"
4338 " (setq c-indent-level 2)\n"
4339 " (setq c-basic-offset 2))\n"
4340 " (add-hook 'c-mode-hook\n"
4341 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4342 " (buffer-file-name))\n"
4343 " (libguestfs-c-mode))))\n"
4348 #: ../src/guestfs.pod:2267
4349 msgid "Enable warnings when compiling (and fix any problems this finds):"
4353 #: ../src/guestfs.pod:2270
4356 " ./configure --enable-gcc-warnings\n"
4361 #: ../src/guestfs.pod:2272
4362 msgid "Useful targets are:"
4366 #: ../src/guestfs.pod:2274
4369 " make syntax-check # checks the syntax of the C code\n"
4370 " make check # runs the test suite\n"
4375 #: ../src/guestfs.pod:2277
4376 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4380 #: ../src/guestfs.pod:2279
4382 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4383 "which are used to do shell quoting."
4387 #: ../src/guestfs.pod:2284
4392 #: ../src/guestfs.pod:2286
4394 "Simple shell quoted string. Any spaces or other shell characters are "
4399 #: ../src/guestfs.pod:2289
4404 #: ../src/guestfs.pod:2291
4406 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4411 #: ../src/guestfs.pod:2296 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4412 msgid "For example:"
4416 #: ../src/guestfs.pod:2298
4419 " asprintf (&cmd, \"cat %R\", path);\n"
4424 #: ../src/guestfs.pod:2300
4425 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4429 #: ../src/guestfs.pod:2302
4431 "I<Note:> Do I<not> use these when you are passing parameters to the "
4432 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4433 "because they are not passed via the shell (instead, straight to exec). You "
4434 "probably want to use the C<sysroot_path()> function however."
4438 #: ../src/guestfs.pod:2308
4439 msgid "SUBMITTING YOUR NEW API ACTIONS"
4443 #: ../src/guestfs.pod:2310
4445 "Submit patches to the mailing list: "
4446 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
4447 "L<rjones@redhat.com>."
4451 #: ../src/guestfs.pod:2314
4452 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
4456 #: ../src/guestfs.pod:2316
4457 msgid "We support i18n (gettext anyhow) in the library."
4461 #: ../src/guestfs.pod:2318
4463 "However many messages come from the daemon, and we don't translate those at "
4464 "the moment. One reason is that the appliance generally has all locale files "
4465 "removed from it, because they take up a lot of space. So we'd have to readd "
4466 "some of those, as well as copying our PO files into the appliance."
4470 #: ../src/guestfs.pod:2324
4472 "Debugging messages are never translated, since they are intended for the "
4477 #: ../src/guestfs.pod:2327
4478 msgid "SOURCE CODE SUBDIRECTORIES"
4482 #: ../src/guestfs.pod:2331
4483 msgid "C<appliance>"
4487 #: ../src/guestfs.pod:2333
4488 msgid "The libguestfs appliance, build scripts and so on."
4492 #: ../src/guestfs.pod:2335
4493 msgid "C<capitests>"
4497 #: ../src/guestfs.pod:2337
4498 msgid "Automated tests of the C API."
4502 #: ../src/guestfs.pod:2339
4507 #: ../src/guestfs.pod:2341
4509 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
4514 #: ../src/guestfs.pod:2344
4519 #: ../src/guestfs.pod:2346
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:1679 ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:2240 ../src/guestfs-actions.pod:2384 ../src/guestfs-actions.pod:2445 ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:3223 ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3413 ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3469 ../src/guestfs-actions.pod:3505 ../src/guestfs-actions.pod:3577 ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3637 ../src/guestfs-actions.pod:3660 ../src/guestfs-actions.pod:3692 ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3730 ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3777 ../src/guestfs-actions.pod:3813 ../src/guestfs-actions.pod:3829 ../src/guestfs-actions.pod:3842 ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3874 ../src/guestfs-actions.pod:3967 ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4069 ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4117 ../src/guestfs-actions.pod:4131 ../src/guestfs-actions.pod:4148 ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4229 ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4333 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4371 ../src/guestfs-actions.pod:4383 ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4413 ../src/guestfs-actions.pod:4428 ../src/guestfs-actions.pod:4443 ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4513 ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4593 ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4644 ../src/guestfs-actions.pod:4672 ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:4707 ../src/guestfs-actions.pod:4841 ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4920 ../src/guestfs-actions.pod:4938 ../src/guestfs-actions.pod:4970 ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5053 ../src/guestfs-actions.pod:5066 ../src/guestfs-actions.pod:5080 ../src/guestfs-actions.pod:5369 ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5414 ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5440 ../src/guestfs-actions.pod:5454 ../src/guestfs-actions.pod:5470 ../src/guestfs-actions.pod:5491 ../src/guestfs-actions.pod:5510 ../src/guestfs-actions.pod:5529 ../src/guestfs-actions.pod:5547 ../src/guestfs-actions.pod:5570 ../src/guestfs-actions.pod:5588 ../src/guestfs-actions.pod:5607 ../src/guestfs-actions.pod:5628 ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5735 ../src/guestfs-actions.pod:5759 ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5789 ../src/guestfs-actions.pod:5808 ../src/guestfs-actions.pod:5845 ../src/guestfs-actions.pod:5868 ../src/guestfs-actions.pod:5894 ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6123 ../src/guestfs-actions.pod:6135 ../src/guestfs-actions.pod:6148 ../src/guestfs-actions.pod:6161 ../src/guestfs-actions.pod:6183 ../src/guestfs-actions.pod:6196 ../src/guestfs-actions.pod:6209 ../src/guestfs-actions.pod:6222 ../src/guestfs-actions.pod:6237 ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6313 ../src/guestfs-actions.pod:6329 ../src/guestfs-actions.pod:6345 ../src/guestfs-actions.pod:6362 ../src/guestfs-actions.pod:6375 ../src/guestfs-actions.pod:6395 ../src/guestfs-actions.pod:6431 ../src/guestfs-actions.pod:6445 ../src/guestfs-actions.pod:6486 ../src/guestfs-actions.pod:6499 ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6551 ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6706 ../src/guestfs-actions.pod:6724 ../src/guestfs-actions.pod:6738 ../src/guestfs-actions.pod:6793 ../src/guestfs-actions.pod:6806 ../src/guestfs-actions.pod:6851 ../src/guestfs-actions.pod:6884 ../src/guestfs-actions.pod:6938 ../src/guestfs-actions.pod:6964 ../src/guestfs-actions.pod:7030 ../src/guestfs-actions.pod:7049 ../src/guestfs-actions.pod:7078
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:1918 ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:4188 ../src/guestfs-actions.pod:6972 ../src/guestfs-actions.pod:7141 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168 ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1303 ../fish/guestfish-actions.pod:1317 ../fish/guestfish-actions.pod:2817 ../fish/guestfish-actions.pod:4621 ../fish/guestfish-actions.pod:4718
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:1890 ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2091 ../src/guestfs-actions.pod:3225 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:4480 ../src/guestfs-actions.pod:5549 ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6364 ../src/guestfs-actions.pod:6886
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:4202
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:1658 ../src/guestfs-actions.pod:1861 ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2371 ../src/guestfs-actions.pod:2659 ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:4616 ../src/guestfs-actions.pod:4744 ../src/guestfs-actions.pod:5150 ../src/guestfs-actions.pod:5176 ../src/guestfs-actions.pod:6472 ../src/guestfs-actions.pod:6897 ../src/guestfs-actions.pod:6910 ../src/guestfs-actions.pod:6923
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:4243 ../src/guestfs-actions.pod:4255
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:4212 ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2828
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:2330
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:2080
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:5227
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:1529 ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:1912 ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:2295 ../src/guestfs-actions.pod:2502 ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2631 ../src/guestfs-actions.pod:2745 ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:2800 ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:3399 ../src/guestfs-actions.pod:3749 ../src/guestfs-actions.pod:3919 ../src/guestfs-actions.pod:4029 ../src/guestfs-actions.pod:4762 ../src/guestfs-actions.pod:4955 ../src/guestfs-actions.pod:5125 ../src/guestfs-actions.pod:5303 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:5931 ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:5972 ../src/guestfs-actions.pod:6646 ../src/guestfs-actions.pod:6665 ../src/guestfs-actions.pod:6683 ../src/guestfs-actions.pod:6863 ../src/guestfs-actions.pod:7135
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:1743 ../src/guestfs-actions.pod:2175 ../src/guestfs-actions.pod:2191 ../src/guestfs-actions.pod:2210 ../src/guestfs-actions.pod:2253 ../src/guestfs-actions.pod:2277 ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2819 ../src/guestfs-actions.pod:3034 ../src/guestfs-actions.pod:3319 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:4577 ../src/guestfs-actions.pod:5097 ../src/guestfs-actions.pod:5223 ../src/guestfs-actions.pod:5337 ../src/guestfs-actions.pod:5988 ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6104 ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6274 ../src/guestfs-actions.pod:6756 ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:6823 ../src/guestfs-actions.pod:6988 ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7092 ../src/guestfs-actions.pod:7111 ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7176
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:3112 ../src/guestfs-actions.pod:3143 ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:4002 ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:5038 ../src/guestfs-actions.pod:5416 ../src/guestfs-actions.pod:5430 ../src/guestfs-actions.pod:5442 ../src/guestfs-actions.pod:5850 ../src/guestfs-actions.pod:6488 ../src/guestfs-actions.pod:6501 ../src/guestfs-actions.pod:6740 ../src/guestfs-actions.pod:6976
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:1888 ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:2026 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3065 ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3125 ../src/guestfs-actions.pod:3141 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3168 ../src/guestfs-actions.pod:3182 ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3212 ../src/guestfs-actions.pod:4726
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:6668
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:5213 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:3465
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:1747 ../src/guestfs-actions.pod:2195 ../src/guestfs-actions.pod:2214 ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2281 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:4995 ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5178 ../src/guestfs-actions.pod:5202 ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6108 ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6278 ../src/guestfs-actions.pod:6940 ../src/guestfs-actions.pod:6966 ../src/guestfs-actions.pod:6992 ../src/guestfs-actions.pod:7011 ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7115 ../src/guestfs-actions.pod:7161 ../src/guestfs-actions.pod:7180 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:715 ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:913 ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990 ../fish/guestfish-actions.pod:1182 ../fish/guestfish-actions.pod:1477 ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1530 ../fish/guestfish-actions.pod:1540 ../fish/guestfish-actions.pod:1559 ../fish/guestfish-actions.pod:3335 ../fish/guestfish-actions.pod:3350 ../fish/guestfish-actions.pod:3426 ../fish/guestfish-actions.pod:3443 ../fish/guestfish-actions.pod:3458 ../fish/guestfish-actions.pod:4041 ../fish/guestfish-actions.pod:4087 ../fish/guestfish-actions.pod:4172 ../fish/guestfish-actions.pod:4187 ../fish/guestfish-actions.pod:4597 ../fish/guestfish-actions.pod:4615 ../fish/guestfish-actions.pod:4632 ../fish/guestfish-actions.pod:4642 ../fish/guestfish-actions.pod:4690 ../fish/guestfish-actions.pod:4700 ../fish/guestfish-actions.pod:4729 ../fish/guestfish-actions.pod:4739
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:3323 ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3909 ../src/guestfs-actions.pod:5101 ../src/guestfs-actions.pod:5115 ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6841
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:2057 ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3096 ../src/guestfs-actions.pod:3157 ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:6524
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:4632 ../src/guestfs-actions.pod:4691 ../src/guestfs-actions.pod:4728 ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:4922 ../src/guestfs-actions.pod:6433 ../src/guestfs-actions.pod:6447 ../src/guestfs-actions.pod:6853
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:4146 ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4369 ../fish/guestfish-actions.pod:669 ../fish/guestfish-actions.pod:2792 ../fish/guestfish-actions.pod:2910 ../fish/guestfish-actions.pod:2920 ../fish/guestfish-actions.pod:2930
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:3254 ../fish/guestfish-actions.pod:677 ../fish/guestfish-actions.pod:2250
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:1532
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:1681 ../src/guestfs-actions.pod:1703 ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6553 ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7051
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:3922 ../src/guestfs-actions.pod:5128 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6866
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:4595 ../src/guestfs-actions.pod:4972
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:2260 ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2352 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4495 ../src/guestfs-actions.pod:6257 ../src/guestfs-actions.pod:6281 ../src/guestfs-actions.pod:6899 ../src/guestfs-actions.pod:6912 ../src/guestfs-actions.pod:6925
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:6513 ../fish/guestfish-actions.pod:821 ../fish/guestfish-actions.pod:4345
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:6558
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:2068 ../src/guestfs-actions.pod:5761
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:2198 ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2373 ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2469 ../src/guestfs-actions.pod:2482 ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3442 ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:6125 ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6150 ../src/guestfs-actions.pod:6163 ../src/guestfs-actions.pod:6185 ../src/guestfs-actions.pod:6198 ../src/guestfs-actions.pod:6211 ../src/guestfs-actions.pod:6224 ../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
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 ../fish/guestfish-actions.pod:1007
7547 "The output depends on the output of the underlying L<file(1)> command and it "
7548 "can change in future in ways beyond our control. In other words, the output "
7549 "is not guaranteed by the ABI."
7553 #: ../src/guestfs-actions.pod:1526
7555 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
7556 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
7560 #: ../src/guestfs-actions.pod:1534
7561 msgid "guestfs_file_architecture"
7565 #: ../src/guestfs-actions.pod:1536
7569 " guestfs_file_architecture (guestfs_h *g,\n"
7570 " const char *filename);\n"
7575 #: ../src/guestfs-actions.pod:1540 ../fish/guestfish-actions.pod:1018
7577 "This detects the architecture of the binary C<filename>, and returns it if "
7582 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1021
7583 msgid "Currently defined architectures are:"
7587 #: ../src/guestfs-actions.pod:1547 ../fish/guestfish-actions.pod:1025
7592 #: ../src/guestfs-actions.pod:1549 ../fish/guestfish-actions.pod:1027
7594 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7595 "irrespective of the precise processor requirements of the binary."
7599 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7604 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
7605 msgid "64 bit x86-64."
7609 #: ../src/guestfs-actions.pod:1556 ../fish/guestfish-actions.pod:1034
7614 #: ../src/guestfs-actions.pod:1558 ../fish/guestfish-actions.pod:1036
7615 msgid "32 bit SPARC."
7619 #: ../src/guestfs-actions.pod:1560 ../fish/guestfish-actions.pod:1038
7624 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1040
7625 msgid "64 bit SPARC V9 and above."
7629 #: ../src/guestfs-actions.pod:1564 ../fish/guestfish-actions.pod:1042
7634 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1044
7635 msgid "Intel Itanium."
7639 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1046
7644 #: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1048
7645 msgid "32 bit Power PC."
7649 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1050
7654 #: ../src/guestfs-actions.pod:1574 ../fish/guestfish-actions.pod:1052
7655 msgid "64 bit Power PC."
7659 #: ../src/guestfs-actions.pod:1578 ../fish/guestfish-actions.pod:1056
7660 msgid "Libguestfs may return other architecture strings in future."
7664 #: ../src/guestfs-actions.pod:1580 ../fish/guestfish-actions.pod:1058
7665 msgid "The function works on at least the following types of files:"
7669 #: ../src/guestfs-actions.pod:1586 ../fish/guestfish-actions.pod:1064
7670 msgid "many types of Un*x and Linux binary"
7674 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1068
7675 msgid "many types of Un*x and Linux shared library"
7679 #: ../src/guestfs-actions.pod:1594 ../fish/guestfish-actions.pod:1072
7680 msgid "Windows Win32 and Win64 binaries"
7684 #: ../src/guestfs-actions.pod:1598 ../fish/guestfish-actions.pod:1076
7685 msgid "Windows Win32 and Win64 DLLs"
7689 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1078
7690 msgid "Win32 binaries and DLLs return C<i386>."
7694 #: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1080
7695 msgid "Win64 binaries and DLLs return C<x86_64>."
7699 #: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1084
7700 msgid "Linux kernel modules"
7704 #: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1088
7705 msgid "Linux new-style initrd images"
7709 #: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1092
7710 msgid "some non-x86 Linux vmlinuz kernels"
7714 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1096
7715 msgid "What it can't do currently:"
7719 #: ../src/guestfs-actions.pod:1624 ../fish/guestfish-actions.pod:1102
7720 msgid "static libraries (libfoo.a)"
7724 #: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1106
7725 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7729 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1110
7730 msgid "x86 Linux vmlinuz kernels"
7734 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1112
7736 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7737 "compressed code, and are horribly hard to unpack. If you want to find the "
7738 "architecture of a kernel, use the architecture of the associated initrd or "
7739 "kernel module(s) instead."
7743 #: ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2612 ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:3038 ../src/guestfs-actions.pod:3170
7744 msgid "(Added in 1.5.3)"
7748 #: ../src/guestfs-actions.pod:1646
7749 msgid "guestfs_filesize"
7753 #: ../src/guestfs-actions.pod:1648
7757 " guestfs_filesize (guestfs_h *g,\n"
7758 " const char *file);\n"
7763 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1123
7764 msgid "This command returns the size of C<file> in bytes."
7768 #: ../src/guestfs-actions.pod:1654
7770 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7771 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7772 "devices, use C<guestfs_blockdev_getsize64>."
7776 #: ../src/guestfs-actions.pod:1660
7777 msgid "(Added in 1.0.82)"
7781 #: ../src/guestfs-actions.pod:1662
7782 msgid "guestfs_fill"
7786 #: ../src/guestfs-actions.pod:1664
7790 " guestfs_fill (guestfs_h *g,\n"
7793 " const char *path);\n"
7798 #: ../src/guestfs-actions.pod:1670 ../fish/guestfish-actions.pod:1133
7800 "This command creates a new file called C<path>. The initial content of the "
7801 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7806 #: ../src/guestfs-actions.pod:1674
7808 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7809 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7810 "bytes use C<guestfs_fill_pattern>."
7814 #: ../src/guestfs-actions.pod:1686
7815 msgid "(Added in 1.0.79)"
7819 #: ../src/guestfs-actions.pod:1688
7820 msgid "guestfs_fill_pattern"
7824 #: ../src/guestfs-actions.pod:1690
7828 " guestfs_fill_pattern (guestfs_h *g,\n"
7829 " const char *pattern,\n"
7831 " const char *path);\n"
7836 #: ../src/guestfs-actions.pod:1696
7838 "This function is like C<guestfs_fill> except that it creates a new file of "
7839 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7840 "pattern is truncated if necessary to ensure the length of the file is "
7841 "exactly C<len> bytes."
7845 #: ../src/guestfs-actions.pod:1708
7846 msgid "(Added in 1.3.12)"
7850 #: ../src/guestfs-actions.pod:1710
7851 msgid "guestfs_find"
7855 #: ../src/guestfs-actions.pod:1712
7859 " guestfs_find (guestfs_h *g,\n"
7860 " const char *directory);\n"
7865 #: ../src/guestfs-actions.pod:1716 ../fish/guestfish-actions.pod:1155
7867 "This command lists out all files and directories, recursively, starting at "
7868 "C<directory>. It is essentially equivalent to running the shell command "
7869 "C<find directory -print> but some post-processing happens on the output, "
7874 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
7876 "This returns a list of strings I<without any prefix>. Thus if the directory "
7881 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1163
7891 #: ../src/guestfs-actions.pod:1728
7892 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7896 #: ../src/guestfs-actions.pod:1731 ../fish/guestfish-actions.pod:1170
7907 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
7908 msgid "If C<directory> is not a directory, then this command returns an error."
7912 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1178
7913 msgid "The returned list is sorted."
7917 #: ../src/guestfs-actions.pod:1741
7918 msgid "See also C<guestfs_find0>."
7922 #: ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:3859 ../src/guestfs-actions.pod:5390
7923 msgid "(Added in 1.0.27)"
7927 #: ../src/guestfs-actions.pod:1752
7928 msgid "guestfs_find0"
7932 #: ../src/guestfs-actions.pod:1754
7936 " guestfs_find0 (guestfs_h *g,\n"
7937 " const char *directory,\n"
7938 " const char *files);\n"
7943 #: ../src/guestfs-actions.pod:1759 ../fish/guestfish-actions.pod:1189
7945 "This command lists out all files and directories, recursively, starting at "
7946 "C<directory>, placing the resulting list in the external file called "
7951 #: ../src/guestfs-actions.pod:1763
7953 "This command works the same way as C<guestfs_find> with the following "
7958 #: ../src/guestfs-actions.pod:1770 ../fish/guestfish-actions.pod:1200
7959 msgid "The resulting list is written to an external file."
7963 #: ../src/guestfs-actions.pod:1774 ../fish/guestfish-actions.pod:1204
7965 "Items (filenames) in the result are separated by C<\\0> characters. See "
7966 "L<find(1)> option I<-print0>."
7970 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
7971 msgid "This command is not limited in the number of names that it can return."
7975 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
7976 msgid "The result list is not sorted."
7980 #: ../src/guestfs-actions.pod:1790
7981 msgid "(Added in 1.0.74)"
7985 #: ../src/guestfs-actions.pod:1792
7986 msgid "guestfs_findfs_label"
7990 #: ../src/guestfs-actions.pod:1794
7994 " guestfs_findfs_label (guestfs_h *g,\n"
7995 " const char *label);\n"
8000 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1224
8002 "This command searches the filesystems and returns the one which has the "
8003 "given label. An error is returned if no such filesystem can be found."
8007 #: ../src/guestfs-actions.pod:1802
8008 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8012 #: ../src/guestfs-actions.pod:1809
8013 msgid "guestfs_findfs_uuid"
8017 #: ../src/guestfs-actions.pod:1811
8021 " guestfs_findfs_uuid (guestfs_h *g,\n"
8022 " const char *uuid);\n"
8027 #: ../src/guestfs-actions.pod:1815 ../fish/guestfish-actions.pod:1234
8029 "This command searches the filesystems and returns the one which has the "
8030 "given UUID. An error is returned if no such filesystem can be found."
8034 #: ../src/guestfs-actions.pod:1819
8035 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8039 #: ../src/guestfs-actions.pod:1826
8040 msgid "guestfs_fsck"
8044 #: ../src/guestfs-actions.pod:1828
8048 " guestfs_fsck (guestfs_h *g,\n"
8049 " const char *fstype,\n"
8050 " const char *device);\n"
8055 #: ../src/guestfs-actions.pod:1833 ../fish/guestfish-actions.pod:1244
8057 "This runs the filesystem checker (fsck) on C<device> which should have "
8058 "filesystem type C<fstype>."
8062 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1247
8064 "The returned integer is the status. See L<fsck(8)> for the list of status "
8065 "codes from C<fsck>."
8069 #: ../src/guestfs-actions.pod:1845 ../fish/guestfish-actions.pod:1256
8070 msgid "Multiple status codes can be summed together."
8074 #: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1260
8076 "A non-zero return code can mean \"success\", for example if errors have been "
8077 "corrected on the filesystem."
8081 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
8082 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8086 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
8087 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8091 #: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:7037
8092 msgid "(Added in 1.0.16)"
8096 #: ../src/guestfs-actions.pod:1865
8097 msgid "guestfs_get_append"
8101 #: ../src/guestfs-actions.pod:1867
8105 " guestfs_get_append (guestfs_h *g);\n"
8110 #: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1276
8112 "Return the additional kernel options which are added to the guest kernel "
8117 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1279
8118 msgid "If C<NULL> then no options are added."
8122 #: ../src/guestfs-actions.pod:1875
8124 "This function returns a string which may be NULL. There is no way to return "
8125 "an error from this function. The string is owned by the guest handle and "
8126 "must I<not> be freed."
8130 #: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:5068 ../src/guestfs-actions.pod:5531 ../src/guestfs-actions.pod:5899 ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5934 ../src/guestfs-actions.pod:5951 ../src/guestfs-actions.pod:6708 ../src/guestfs-actions.pod:6726 ../src/guestfs-actions.pod:7080
8131 msgid "(Added in 1.0.26)"
8135 #: ../src/guestfs-actions.pod:1881
8136 msgid "guestfs_get_autosync"
8140 #: ../src/guestfs-actions.pod:1883
8144 " guestfs_get_autosync (guestfs_h *g);\n"
8149 #: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1285
8150 msgid "Get the autosync flag."
8154 #: ../src/guestfs-actions.pod:1892
8155 msgid "guestfs_get_direct"
8159 #: ../src/guestfs-actions.pod:1894
8163 " guestfs_get_direct (guestfs_h *g);\n"
8168 #: ../src/guestfs-actions.pod:1897 ../fish/guestfish-actions.pod:1291
8169 msgid "Return the direct appliance mode flag."
8173 #: ../src/guestfs-actions.pod:1901 ../src/guestfs-actions.pod:5572
8174 msgid "(Added in 1.0.72)"
8178 #: ../src/guestfs-actions.pod:1903
8179 msgid "guestfs_get_e2label"
8183 #: ../src/guestfs-actions.pod:1905
8187 " guestfs_get_e2label (guestfs_h *g,\n"
8188 " const char *device);\n"
8193 #: ../src/guestfs-actions.pod:1909 ../fish/guestfish-actions.pod:1297
8194 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8198 #: ../src/guestfs-actions.pod:1915 ../fish/guestfish-actions.pod:1300
8200 "This function is deprecated. In new code, use the C<vfs_label> call "
8205 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:1943 ../src/guestfs-actions.pod:5590 ../src/guestfs-actions.pod:5609
8206 msgid "(Added in 1.0.15)"
8210 #: ../src/guestfs-actions.pod:1924
8211 msgid "guestfs_get_e2uuid"
8215 #: ../src/guestfs-actions.pod:1926
8219 " guestfs_get_e2uuid (guestfs_h *g,\n"
8220 " const char *device);\n"
8225 #: ../src/guestfs-actions.pod:1930 ../fish/guestfish-actions.pod:1311
8226 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8230 #: ../src/guestfs-actions.pod:1936 ../fish/guestfish-actions.pod:1314
8231 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
8235 #: ../src/guestfs-actions.pod:1945
8236 msgid "guestfs_get_memsize"
8240 #: ../src/guestfs-actions.pod:1947
8244 " guestfs_get_memsize (guestfs_h *g);\n"
8249 #: ../src/guestfs-actions.pod:1950 ../fish/guestfish-actions.pod:1325
8250 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8254 #: ../src/guestfs-actions.pod:1953
8256 "If C<guestfs_set_memsize> was not called on this handle, and if "
8257 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8258 "value for memsize."
8262 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:5625 ../src/guestfs-actions.pod:5732 ../fish/guestfish-actions.pod:1332 ../fish/guestfish-actions.pod:1383 ../fish/guestfish-actions.pod:3752 ../fish/guestfish-actions.pod:3839
8263 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8267 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:4150 ../src/guestfs-actions.pod:4335 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4373 ../src/guestfs-actions.pod:4385 ../src/guestfs-actions.pod:4402 ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:5293 ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:5873 ../src/guestfs-actions.pod:6474
8268 msgid "(Added in 1.0.55)"
8272 #: ../src/guestfs-actions.pod:1964
8273 msgid "guestfs_get_network"
8277 #: ../src/guestfs-actions.pod:1966
8281 " guestfs_get_network (guestfs_h *g);\n"
8286 #: ../src/guestfs-actions.pod:1969 ../fish/guestfish-actions.pod:1339
8287 msgid "This returns the enable network flag."
8291 #: ../src/guestfs-actions.pod:1973 ../src/guestfs-actions.pod:5649
8292 msgid "(Added in 1.5.4)"
8296 #: ../src/guestfs-actions.pod:1975
8297 msgid "guestfs_get_path"
8301 #: ../src/guestfs-actions.pod:1977
8305 " guestfs_get_path (guestfs_h *g);\n"
8310 #: ../src/guestfs-actions.pod:1980 ../fish/guestfish-actions.pod:1345
8311 msgid "Return the current search path."
8315 #: ../src/guestfs-actions.pod:1982 ../fish/guestfish-actions.pod:1347
8317 "This is always non-NULL. If it wasn't set already, then this will return "
8322 #: ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:2014
8324 "This function returns a string, or NULL on error. The string is owned by "
8325 "the guest handle and must I<not> be freed."
8329 #: ../src/guestfs-actions.pod:1990
8330 msgid "guestfs_get_pid"
8334 #: ../src/guestfs-actions.pod:1992
8338 " guestfs_get_pid (guestfs_h *g);\n"
8343 #: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1356
8345 "Return the process ID of the qemu subprocess. If there is no qemu "
8346 "subprocess, then this will return an error."
8350 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1359
8351 msgid "This is an internal call used for debugging and testing."
8355 #: ../src/guestfs-actions.pod:2002
8356 msgid "(Added in 1.0.56)"
8360 #: ../src/guestfs-actions.pod:2004
8361 msgid "guestfs_get_qemu"
8365 #: ../src/guestfs-actions.pod:2006
8369 " guestfs_get_qemu (guestfs_h *g);\n"
8374 #: ../src/guestfs-actions.pod:2009 ../fish/guestfish-actions.pod:1365
8375 msgid "Return the current qemu binary."
8379 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1367
8381 "This is always non-NULL. If it wasn't set already, then this will return "
8382 "the default qemu binary name."
8386 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:5694
8387 msgid "(Added in 1.0.6)"
8391 #: ../src/guestfs-actions.pod:2019
8392 msgid "guestfs_get_recovery_proc"
8396 #: ../src/guestfs-actions.pod:2021
8400 " guestfs_get_recovery_proc (guestfs_h *g);\n"
8405 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1374
8406 msgid "Return the recovery process enabled flag."
8410 #: ../src/guestfs-actions.pod:2028 ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:3989 ../src/guestfs-actions.pod:4998 ../src/guestfs-actions.pod:5341 ../src/guestfs-actions.pod:5718 ../src/guestfs-actions.pod:6377 ../src/guestfs-actions.pod:6397 ../src/guestfs-actions.pod:6589
8411 msgid "(Added in 1.0.77)"
8415 #: ../src/guestfs-actions.pod:2030
8416 msgid "guestfs_get_selinux"
8420 #: ../src/guestfs-actions.pod:2032
8424 " guestfs_get_selinux (guestfs_h *g);\n"
8429 #: ../src/guestfs-actions.pod:2035
8431 "This returns the current setting of the selinux flag which is passed to the "
8432 "appliance at boot time. See C<guestfs_set_selinux>."
8436 #: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:5737 ../src/guestfs-actions.pod:5791
8437 msgid "(Added in 1.0.67)"
8441 #: ../src/guestfs-actions.pod:2045
8442 msgid "guestfs_get_state"
8446 #: ../src/guestfs-actions.pod:2047
8450 " guestfs_get_state (guestfs_h *g);\n"
8455 #: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390
8457 "This returns the current state as an opaque integer. This is only useful "
8458 "for printing debug and internal error messages."
8462 #: ../src/guestfs-actions.pod:2053 ../src/guestfs-actions.pod:3063 ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3153 ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:1393 ../fish/guestfish-actions.pod:2132 ../fish/guestfish-actions.pod:2150 ../fish/guestfish-actions.pod:2188 ../fish/guestfish-actions.pod:2204
8463 msgid "For more information on states, see L<guestfs(3)>."
8467 #: ../src/guestfs-actions.pod:2059
8468 msgid "guestfs_get_trace"
8472 #: ../src/guestfs-actions.pod:2061
8476 " guestfs_get_trace (guestfs_h *g);\n"
8481 #: ../src/guestfs-actions.pod:2064 ../fish/guestfish-actions.pod:1399
8482 msgid "Return the command trace flag."
8486 #: ../src/guestfs-actions.pod:2070
8487 msgid "guestfs_get_umask"
8491 #: ../src/guestfs-actions.pod:2072
8495 " guestfs_get_umask (guestfs_h *g);\n"
8500 #: ../src/guestfs-actions.pod:2075
8502 "Return the current umask. By default the umask is C<022> unless it has been "
8503 "set by calling C<guestfs_umask>."
8507 #: ../src/guestfs-actions.pod:2082
8508 msgid "guestfs_get_verbose"
8512 #: ../src/guestfs-actions.pod:2084
8516 " guestfs_get_verbose (guestfs_h *g);\n"
8521 #: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1412
8522 msgid "This returns the verbose messages flag."
8526 #: ../src/guestfs-actions.pod:2093
8527 msgid "guestfs_getcon"
8531 #: ../src/guestfs-actions.pod:2095
8535 " guestfs_getcon (guestfs_h *g);\n"
8540 #: ../src/guestfs-actions.pod:2098 ../fish/guestfish-actions.pod:1418
8541 msgid "This gets the SELinux security context of the daemon."
8545 #: ../src/guestfs-actions.pod:2100
8546 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8550 #: ../src/guestfs-actions.pod:2108
8551 msgid "guestfs_getxattr"
8555 #: ../src/guestfs-actions.pod:2110
8559 " guestfs_getxattr (guestfs_h *g,\n"
8560 " const char *path,\n"
8561 " const char *name,\n"
8562 " size_t *size_r);\n"
8567 #: ../src/guestfs-actions.pod:2116
8569 "Get a single extended attribute from file C<path> named C<name>. This call "
8570 "follows symlinks. If you want to lookup an extended attribute for the "
8571 "symlink itself, use C<guestfs_lgetxattr>."
8575 #: ../src/guestfs-actions.pod:2120 ../src/guestfs-actions.pod:3274
8577 "Normally it is better to get all extended attributes from a file in one go "
8578 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
8579 "implementations are buggy and do not provide a way to list out attributes. "
8580 "For these filesystems (notably ntfs-3g) you have to know the names of the "
8581 "extended attributes you want in advance and call this function."
8585 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3281 ../fish/guestfish-actions.pod:1438 ../fish/guestfish-actions.pod:2269
8587 "Extended attribute values are blobs of binary data. If there is no extended "
8588 "attribute named C<name>, this returns an error."
8592 #: ../src/guestfs-actions.pod:2130
8593 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
8597 #: ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:3286 ../src/guestfs-actions.pod:4991 ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5198
8599 "This function returns a buffer, or NULL on error. The size of the returned "
8600 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8605 #: ../src/guestfs-actions.pod:2136 ../src/guestfs-actions.pod:3290
8606 msgid "(Added in 1.7.24)"
8610 #: ../src/guestfs-actions.pod:2138
8611 msgid "guestfs_getxattrs"
8615 #: ../src/guestfs-actions.pod:2140
8618 " struct guestfs_xattr_list *\n"
8619 " guestfs_getxattrs (guestfs_h *g,\n"
8620 " const char *path);\n"
8625 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1447
8626 msgid "This call lists the extended attributes of the file or directory C<path>."
8630 #: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1450
8632 "At the system call level, this is a combination of the L<listxattr(2)> and "
8633 "L<getxattr(2)> calls."
8637 #: ../src/guestfs-actions.pod:2150
8638 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8642 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3302 ../src/guestfs-actions.pod:3953
8644 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8645 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8649 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:3471 ../src/guestfs-actions.pod:3507 ../src/guestfs-actions.pod:5371 ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:7145
8650 msgid "(Added in 1.0.59)"
8654 #: ../src/guestfs-actions.pod:2158
8655 msgid "guestfs_glob_expand"
8659 #: ../src/guestfs-actions.pod:2160
8663 " guestfs_glob_expand (guestfs_h *g,\n"
8664 " const char *pattern);\n"
8669 #: ../src/guestfs-actions.pod:2164 ../fish/guestfish-actions.pod:1459
8671 "This command searches for all the pathnames matching C<pattern> according to "
8672 "the wildcard expansion rules used by the shell."
8676 #: ../src/guestfs-actions.pod:2168 ../fish/guestfish-actions.pod:1463
8677 msgid "If no paths match, then this returns an empty list (note: not an error)."
8681 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1466
8683 "It is just a wrapper around the C L<glob(3)> function with flags "
8684 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8688 #: ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:5992
8689 msgid "(Added in 1.0.50)"
8693 #: ../src/guestfs-actions.pod:2181
8694 msgid "guestfs_grep"
8698 #: ../src/guestfs-actions.pod:2183
8702 " guestfs_grep (guestfs_h *g,\n"
8703 " const char *regex,\n"
8704 " const char *path);\n"
8709 #: ../src/guestfs-actions.pod:2188 ../fish/guestfish-actions.pod:1474
8710 msgid "This calls the external C<grep> program and returns the matching lines."
8714 #: ../src/guestfs-actions.pod:2200
8715 msgid "guestfs_grepi"
8719 #: ../src/guestfs-actions.pod:2202
8723 " guestfs_grepi (guestfs_h *g,\n"
8724 " const char *regex,\n"
8725 " const char *path);\n"
8730 #: ../src/guestfs-actions.pod:2207 ../fish/guestfish-actions.pod:1484
8731 msgid "This calls the external C<grep -i> program and returns the matching lines."
8735 #: ../src/guestfs-actions.pod:2219
8736 msgid "guestfs_grub_install"
8740 #: ../src/guestfs-actions.pod:2221
8744 " guestfs_grub_install (guestfs_h *g,\n"
8745 " const char *root,\n"
8746 " const char *device);\n"
8751 #: ../src/guestfs-actions.pod:2226 ../fish/guestfish-actions.pod:1494
8753 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8754 "the root directory being C<root>."
8758 #: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1497
8760 "Note: If grub-install reports the error \"No suitable drive was found in the "
8761 "generated device map.\" it may be that you need to create a "
8762 "C</boot/grub/device.map> file first that contains the mapping between grub "
8763 "device names and Linux device names. It is usually sufficient to create a "
8768 #: ../src/guestfs-actions.pod:2236 ../fish/guestfish-actions.pod:1504
8776 #: ../src/guestfs-actions.pod:2238 ../fish/guestfish-actions.pod:1506
8777 msgid "replacing C</dev/vda> with the name of the installation device."
8781 #: ../src/guestfs-actions.pod:2242
8782 msgid "(Added in 1.0.17)"
8786 #: ../src/guestfs-actions.pod:2244
8787 msgid "guestfs_head"
8791 #: ../src/guestfs-actions.pod:2246
8795 " guestfs_head (guestfs_h *g,\n"
8796 " const char *path);\n"
8801 #: ../src/guestfs-actions.pod:2250 ../fish/guestfish-actions.pod:1512
8803 "This command returns up to the first 10 lines of a file as a list of "
8808 #: ../src/guestfs-actions.pod:2262
8809 msgid "guestfs_head_n"
8813 #: ../src/guestfs-actions.pod:2264
8817 " guestfs_head_n (guestfs_h *g,\n"
8819 " const char *path);\n"
8824 #: ../src/guestfs-actions.pod:2269 ../fish/guestfish-actions.pod:1522
8826 "If the parameter C<nrlines> is a positive number, this returns the first "
8827 "C<nrlines> lines of the file C<path>."
8831 #: ../src/guestfs-actions.pod:2272 ../fish/guestfish-actions.pod:1525
8833 "If the parameter C<nrlines> is a negative number, this returns lines from "
8834 "the file C<path>, excluding the last C<nrlines> lines."
8838 #: ../src/guestfs-actions.pod:2275 ../src/guestfs-actions.pod:6272 ../fish/guestfish-actions.pod:1528 ../fish/guestfish-actions.pod:4185
8839 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8843 #: ../src/guestfs-actions.pod:2286
8844 msgid "guestfs_hexdump"
8848 #: ../src/guestfs-actions.pod:2288
8852 " guestfs_hexdump (guestfs_h *g,\n"
8853 " const char *path);\n"
8858 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1537
8860 "This runs C<hexdump -C> on the given C<path>. The result is the "
8861 "human-readable, canonical hex dump of the file."
8865 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6056 ../src/guestfs-actions.pod:6111
8866 msgid "(Added in 1.0.22)"
8870 #: ../src/guestfs-actions.pod:2303
8871 msgid "guestfs_initrd_cat"
8875 #: ../src/guestfs-actions.pod:2305
8879 " guestfs_initrd_cat (guestfs_h *g,\n"
8880 " const char *initrdpath,\n"
8881 " const char *filename,\n"
8882 " size_t *size_r);\n"
8887 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1547
8889 "This command unpacks the file C<filename> from the initrd file called "
8890 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8895 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1551
8897 "For example, in guestfish you could use the following command to examine the "
8898 "boot script (usually called C</init>) contained in a Linux initrd or "
8903 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1555
8906 " initrd-cat /boot/initrd-<version>.img init\n"
8911 #: ../src/guestfs-actions.pod:2321
8912 msgid "See also C<guestfs_initrd_list>."
8916 #: ../src/guestfs-actions.pod:2332
8917 msgid "guestfs_initrd_list"
8921 #: ../src/guestfs-actions.pod:2334
8925 " guestfs_initrd_list (guestfs_h *g,\n"
8926 " const char *path);\n"
8931 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1566
8932 msgid "This command lists out files contained in an initrd."
8936 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1568
8938 "The files are listed without any initial C</> character. The files are "
8939 "listed in the order they appear (not necessarily alphabetical). Directory "
8940 "names are listed as separate items."
8944 #: ../src/guestfs-actions.pod:2344 ../fish/guestfish-actions.pod:1572
8946 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8947 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8952 #: ../src/guestfs-actions.pod:2354
8953 msgid "guestfs_inotify_add_watch"
8957 #: ../src/guestfs-actions.pod:2356
8961 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8962 " const char *path,\n"
8968 #: ../src/guestfs-actions.pod:2361 ../fish/guestfish-actions.pod:1580
8969 msgid "Watch C<path> for the events listed in C<mask>."
8973 #: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1582
8975 "Note that if C<path> is a directory then events within that directory are "
8976 "watched, but this does I<not> happen recursively (in subdirectories)."
8980 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1586
8982 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8983 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8987 #: ../src/guestfs-actions.pod:2375
8988 msgid "guestfs_inotify_close"
8992 #: ../src/guestfs-actions.pod:2377
8996 " guestfs_inotify_close (guestfs_h *g);\n"
9001 #: ../src/guestfs-actions.pod:2380 ../fish/guestfish-actions.pod:1594
9003 "This closes the inotify handle which was previously opened by inotify_init. "
9004 "It removes all watches, throws away any pending events, and deallocates all "
9009 #: ../src/guestfs-actions.pod:2388
9010 msgid "guestfs_inotify_files"
9014 #: ../src/guestfs-actions.pod:2390
9018 " guestfs_inotify_files (guestfs_h *g);\n"
9023 #: ../src/guestfs-actions.pod:2393
9025 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9026 "returns a list of pathnames of objects that were touched. The returned "
9027 "pathnames are sorted and deduplicated."
9031 #: ../src/guestfs-actions.pod:2403
9032 msgid "guestfs_inotify_init"
9036 #: ../src/guestfs-actions.pod:2405
9040 " guestfs_inotify_init (guestfs_h *g,\n"
9041 " int maxevents);\n"
9046 #: ../src/guestfs-actions.pod:2409 ../fish/guestfish-actions.pod:1610
9048 "This command creates a new inotify handle. The inotify subsystem can be "
9049 "used to notify events which happen to objects in the guest filesystem."
9053 #: ../src/guestfs-actions.pod:2413
9055 "C<maxevents> is the maximum number of events which will be queued up between "
9056 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9057 "passed as C<0>, then the kernel (or previously set) default is used. For "
9058 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9059 "throws away events, but records the fact that it threw them away by setting "
9060 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9061 "C<guestfs_inotify_read>)."
9065 #: ../src/guestfs-actions.pod:2423
9067 "Before any events are generated, you have to add some watches to the "
9068 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9069 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9073 #: ../src/guestfs-actions.pod:2429
9075 "Queued up events should be read periodically by calling "
9076 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9077 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9078 "often enough then you risk the internal queue overflowing."
9082 #: ../src/guestfs-actions.pod:2436
9084 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9085 "This also removes any watches automatically."
9089 #: ../src/guestfs-actions.pod:2440 ../fish/guestfish-actions.pod:1641
9091 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9092 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9093 "that there is one global inotify handle per libguestfs instance."
9097 #: ../src/guestfs-actions.pod:2449
9098 msgid "guestfs_inotify_read"
9102 #: ../src/guestfs-actions.pod:2451
9105 " struct guestfs_inotify_event_list *\n"
9106 " guestfs_inotify_read (guestfs_h *g);\n"
9111 #: ../src/guestfs-actions.pod:2454 ../fish/guestfish-actions.pod:1650
9113 "Return the complete queue of events that have happened since the previous "
9118 #: ../src/guestfs-actions.pod:2457 ../fish/guestfish-actions.pod:1653
9119 msgid "If no events have happened, this returns an empty list."
9123 #: ../src/guestfs-actions.pod:2459 ../fish/guestfish-actions.pod:1655
9125 "I<Note>: In order to make sure that all events have been read, you must call "
9126 "this function repeatedly until it returns an empty list. The reason is that "
9127 "the call will read events up to the maximum appliance-to-host message size "
9128 "and leave remaining events in the queue."
9132 #: ../src/guestfs-actions.pod:2465
9134 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9135 "there was an error. I<The caller must call "
9136 "C<guestfs_free_inotify_event_list> after use>."
9140 #: ../src/guestfs-actions.pod:2471
9141 msgid "guestfs_inotify_rm_watch"
9145 #: ../src/guestfs-actions.pod:2473
9149 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9155 #: ../src/guestfs-actions.pod:2477
9157 "Remove a previously defined inotify watch. See "
9158 "C<guestfs_inotify_add_watch>."
9162 #: ../src/guestfs-actions.pod:2484
9163 msgid "guestfs_inspect_get_arch"
9167 #: ../src/guestfs-actions.pod:2486
9171 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9172 " const char *root);\n"
9177 #: ../src/guestfs-actions.pod:2490 ../src/guestfs-actions.pod:2513 ../src/guestfs-actions.pod:2594 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:2642 ../src/guestfs-actions.pod:2669 ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2756 ../src/guestfs-actions.pod:2787 ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2896
9179 "This function should only be called with a root device string as returned by "
9180 "C<guestfs_inspect_os>."
9184 #: ../src/guestfs-actions.pod:2493
9186 "This returns the architecture of the inspected operating system. The "
9187 "possible return values are listed under C<guestfs_file_architecture>."
9191 #: ../src/guestfs-actions.pod:2497 ../fish/guestfish-actions.pod:1679
9193 "If the architecture could not be determined, then the string C<unknown> is "
9198 #: ../src/guestfs-actions.pod:2500 ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2629 ../src/guestfs-actions.pod:2657 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:2817 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:2883 ../src/guestfs-actions.pod:2989 ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:1682 ../fish/guestfish-actions.pod:1756 ../fish/guestfish-actions.pod:1789 ../fish/guestfish-actions.pod:1810 ../fish/guestfish-actions.pod:1874 ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1928 ../fish/guestfish-actions.pod:1963 ../fish/guestfish-actions.pod:1979 ../fish/guestfish-actions.pod:2078 ../fish/guestfish-actions.pod:2112
9199 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9203 #: ../src/guestfs-actions.pod:2507
9204 msgid "guestfs_inspect_get_distro"
9208 #: ../src/guestfs-actions.pod:2509
9212 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9213 " const char *root);\n"
9218 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1691
9219 msgid "This returns the distro (distribution) of the inspected operating system."
9223 #: ../src/guestfs-actions.pod:2519 ../fish/guestfish-actions.pod:1694
9224 msgid "Currently defined distros are:"
9228 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1698
9229 msgid "\"archlinux\""
9233 #: ../src/guestfs-actions.pod:2525 ../fish/guestfish-actions.pod:1700
9238 #: ../src/guestfs-actions.pod:2527 ../fish/guestfish-actions.pod:1702
9243 #: ../src/guestfs-actions.pod:2529 ../fish/guestfish-actions.pod:1704
9248 #: ../src/guestfs-actions.pod:2531 ../fish/guestfish-actions.pod:1706
9253 #: ../src/guestfs-actions.pod:2533 ../fish/guestfish-actions.pod:1708
9258 #: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1710
9263 #: ../src/guestfs-actions.pod:2537 ../fish/guestfish-actions.pod:1712
9268 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1714
9269 msgid "\"linuxmint\""
9273 #: ../src/guestfs-actions.pod:2541 ../fish/guestfish-actions.pod:1716
9278 #: ../src/guestfs-actions.pod:2543 ../fish/guestfish-actions.pod:1718
9279 msgid "\"mandriva\""
9283 #: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1720
9288 #: ../src/guestfs-actions.pod:2547 ../fish/guestfish-actions.pod:1722
9293 #: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1724
9298 #: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1726
9303 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1728
9308 #: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1730
9309 msgid "\"redhat-based\""
9313 #: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1732
9314 msgid "Some Red Hat-derived distro."
9318 #: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1734
9323 #: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1736
9324 msgid "Red Hat Enterprise Linux and some derivatives."
9328 #: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1738
9333 #: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1740
9338 #: ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2851 ../fish/guestfish-actions.pod:1742 ../fish/guestfish-actions.pod:1954
9343 #: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1744
9344 msgid "The distro could not be determined."
9348 #: ../src/guestfs-actions.pod:2571 ../src/guestfs-actions.pod:2843 ../fish/guestfish-actions.pod:1746 ../fish/guestfish-actions.pod:1946
9353 #: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1748
9355 "Windows does not have distributions. This string is returned if the OS type "
9360 #: ../src/guestfs-actions.pod:2578 ../src/guestfs-actions.pod:2857 ../fish/guestfish-actions.pod:1753 ../fish/guestfish-actions.pod:1960
9362 "Future versions of libguestfs may return other strings here. The caller "
9363 "should be prepared to handle any string."
9367 #: ../src/guestfs-actions.pod:2588
9368 msgid "guestfs_inspect_get_filesystems"
9372 #: ../src/guestfs-actions.pod:2590
9376 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9377 " const char *root);\n"
9382 #: ../src/guestfs-actions.pod:2597 ../fish/guestfish-actions.pod:1765
9384 "This returns a list of all the filesystems that we think are associated with "
9385 "this operating system. This includes the root filesystem, other ordinary "
9386 "filesystems, and non-mounted devices like swap partitions."
9390 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1770
9392 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9393 "to be shared between operating systems."
9397 #: ../src/guestfs-actions.pod:2605
9399 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9400 "C<guestfs_inspect_get_mountpoints>."
9404 #: ../src/guestfs-actions.pod:2614
9405 msgid "guestfs_inspect_get_hostname"
9409 #: ../src/guestfs-actions.pod:2616
9413 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
9414 " const char *root);\n"
9419 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1783
9421 "This function returns the hostname of the operating system as found by "
9422 "inspection of the guest's configuration files."
9426 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1786
9428 "If the hostname could not be determined, then the string C<unknown> is "
9433 #: ../src/guestfs-actions.pod:2634
9434 msgid "(Added in 1.7.9)"
9438 #: ../src/guestfs-actions.pod:2636
9439 msgid "guestfs_inspect_get_major_version"
9443 #: ../src/guestfs-actions.pod:2638
9447 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
9448 " const char *root);\n"
9453 #: ../src/guestfs-actions.pod:2645 ../fish/guestfish-actions.pod:1798
9454 msgid "This returns the major version number of the inspected operating system."
9458 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1801
9460 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9461 "popular public names used by the operating system. Notably the operating "
9462 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9463 "1). You can find out the real versions corresponding to releases of Windows "
9464 "by consulting Wikipedia or MSDN."
9468 #: ../src/guestfs-actions.pod:2655 ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1822
9469 msgid "If the version could not be determined, then C<0> is returned."
9473 #: ../src/guestfs-actions.pod:2663
9474 msgid "guestfs_inspect_get_minor_version"
9478 #: ../src/guestfs-actions.pod:2665
9482 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9483 " const char *root);\n"
9488 #: ../src/guestfs-actions.pod:2672 ../fish/guestfish-actions.pod:1819
9489 msgid "This returns the minor version number of the inspected operating system."
9493 #: ../src/guestfs-actions.pod:2677
9495 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9496 "C<guestfs_inspect_get_major_version>."
9500 #: ../src/guestfs-actions.pod:2684
9501 msgid "guestfs_inspect_get_mountpoints"
9505 #: ../src/guestfs-actions.pod:2686
9509 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9510 " const char *root);\n"
9515 #: ../src/guestfs-actions.pod:2693 ../fish/guestfish-actions.pod:1834
9517 "This returns a hash of where we think the filesystems associated with this "
9518 "operating system should be mounted. Callers should note that this is at "
9519 "best an educated guess made by reading configuration files such as "
9520 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
9521 "are non-existent or not mountable and callers should be prepared to handle "
9522 "or ignore failures if they try to mount them."
9526 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1843
9528 "Each element in the returned hashtable has a key which is the path of the "
9529 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9530 "mounted there (eg. C</dev/sda1>)."
9534 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
9535 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9539 #: ../src/guestfs-actions.pod:2710
9541 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9542 "C<guestfs_inspect_get_filesystems>."
9546 #: ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:3359 ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:6413
9548 "This function returns a NULL-terminated array of strings, or NULL if there "
9549 "was an error. The array of strings will always have length C<2n+1>, where "
9550 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9551 "caller must free the strings and the array after use>."
9555 #: ../src/guestfs-actions.pod:2721
9556 msgid "guestfs_inspect_get_package_format"
9560 #: ../src/guestfs-actions.pod:2723
9564 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9565 " const char *root);\n"
9570 #: ../src/guestfs-actions.pod:2730
9572 "This function and C<guestfs_inspect_get_package_management> return the "
9573 "package format and package management tool used by the inspected operating "
9574 "system. For example for Fedora these functions would return C<rpm> (package "
9575 "format) and C<yum> (package management)."
9579 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1867
9581 "This returns the string C<unknown> if we could not determine the package "
9582 "format I<or> if the operating system does not have a real packaging system "
9587 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:1871
9589 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9590 "Future versions of libguestfs may return other strings."
9594 #: ../src/guestfs-actions.pod:2748 ../src/guestfs-actions.pod:2779
9595 msgid "(Added in 1.7.5)"
9599 #: ../src/guestfs-actions.pod:2750
9600 msgid "guestfs_inspect_get_package_management"
9604 #: ../src/guestfs-actions.pod:2752
9608 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9609 " const char *root);\n"
9614 #: ../src/guestfs-actions.pod:2759
9616 "C<guestfs_inspect_get_package_format> and this function return the package "
9617 "format and package management tool used by the inspected operating system. "
9618 "For example for Fedora these functions would return C<rpm> (package format) "
9619 "and C<yum> (package management)."
9623 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1889
9625 "This returns the string C<unknown> if we could not determine the package "
9626 "management tool I<or> if the operating system does not have a real packaging "
9627 "system (eg. Windows)."
9631 #: ../src/guestfs-actions.pod:2769 ../fish/guestfish-actions.pod:1893
9633 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9634 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9635 "libguestfs may return other strings."
9639 #: ../src/guestfs-actions.pod:2781
9640 msgid "guestfs_inspect_get_product_name"
9644 #: ../src/guestfs-actions.pod:2783
9648 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9649 " const char *root);\n"
9654 #: ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1907
9656 "This returns the product name of the inspected operating system. The "
9657 "product name is generally some freeform string which can be displayed to the "
9658 "user, but should not be parsed by programs."
9662 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1912
9664 "If the product name could not be determined, then the string C<unknown> is "
9669 #: ../src/guestfs-actions.pod:2805
9670 msgid "guestfs_inspect_get_roots"
9674 #: ../src/guestfs-actions.pod:2807
9678 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9683 #: ../src/guestfs-actions.pod:2810
9685 "This function is a convenient way to get the list of root devices, as "
9686 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9687 "the whole inspection process."
9691 #: ../src/guestfs-actions.pod:2814
9693 "This returns an empty list if either no root devices were found or the "
9694 "caller has not called C<guestfs_inspect_os>."
9698 #: ../src/guestfs-actions.pod:2823
9699 msgid "(Added in 1.7.3)"
9703 #: ../src/guestfs-actions.pod:2825
9704 msgid "guestfs_inspect_get_type"
9708 #: ../src/guestfs-actions.pod:2827
9712 " guestfs_inspect_get_type (guestfs_h *g,\n"
9713 " const char *root);\n"
9718 #: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1937
9720 "This returns the type of the inspected operating system. Currently defined "
9725 #: ../src/guestfs-actions.pod:2839 ../fish/guestfish-actions.pod:1942
9730 #: ../src/guestfs-actions.pod:2841 ../fish/guestfish-actions.pod:1944
9731 msgid "Any Linux-based operating system."
9735 #: ../src/guestfs-actions.pod:2845 ../fish/guestfish-actions.pod:1948
9736 msgid "Any Microsoft Windows operating system."
9740 #: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:1950
9745 #: ../src/guestfs-actions.pod:2849 ../fish/guestfish-actions.pod:1952
9750 #: ../src/guestfs-actions.pod:2853 ../fish/guestfish-actions.pod:1956
9751 msgid "The operating system type could not be determined."
9755 #: ../src/guestfs-actions.pod:2867
9756 msgid "guestfs_inspect_get_windows_systemroot"
9760 #: ../src/guestfs-actions.pod:2869
9764 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9765 " const char *root);\n"
9770 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1972
9772 "This returns the Windows systemroot of the inspected guest. The systemroot "
9773 "is a directory path such as C</WINDOWS>."
9777 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1975
9779 "This call assumes that the guest is Windows and that the systemroot could be "
9780 "determined by inspection. If this is not the case then an error is "
9785 #: ../src/guestfs-actions.pod:2888
9786 msgid "(Added in 1.5.25)"
9790 #: ../src/guestfs-actions.pod:2890
9791 msgid "guestfs_inspect_list_applications"
9795 #: ../src/guestfs-actions.pod:2892
9798 " struct guestfs_application_list *\n"
9799 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9800 " const char *root);\n"
9805 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1988
9806 msgid "Return the list of applications installed in the operating system."
9810 #: ../src/guestfs-actions.pod:2901
9812 "I<Note:> This call works differently from other parts of the inspection "
9813 "API. You have to call C<guestfs_inspect_os>, then "
9814 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9815 "this. Listing applications is a significantly more difficult operation "
9816 "which requires access to the full filesystem. Also note that unlike the "
9817 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9818 "the libguestfs handle, this call actually reads parts of the mounted "
9819 "filesystems during the call."
9823 #: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:2000
9825 "This returns an empty list if the inspection code was not able to determine "
9826 "the list of applications."
9830 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2003
9831 msgid "The application structure contains the following fields:"
9835 #: ../src/guestfs-actions.pod:2918 ../fish/guestfish-actions.pod:2007
9840 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2009
9842 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9843 "guests, this is the package name."
9847 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2012
9848 msgid "C<app_display_name>"
9852 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2014
9854 "The display name of the application, sometimes localized to the install "
9855 "language of the guest operating system."
9859 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2017
9861 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9862 "to display something can use C<app_name> instead."
9866 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:2020
9867 msgid "C<app_epoch>"
9871 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2022
9873 "For package managers which use epochs, this contains the epoch of the "
9874 "package (an integer). If unavailable, this is returned as C<0>."
9878 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2025
9879 msgid "C<app_version>"
9883 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2027
9885 "The version string of the application or package. If unavailable this is "
9886 "returned as an empty string C<\"\">."
9890 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
9891 msgid "C<app_release>"
9895 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2032
9897 "The release string of the application or package, for package managers that "
9898 "use this. If unavailable this is returned as an empty string C<\"\">."
9902 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2036
9903 msgid "C<app_install_path>"
9907 #: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2038
9909 "The installation path of the application (on operating systems such as "
9910 "Windows which use installation paths). This path is in the format used by "
9911 "the guest operating system, it is not a libguestfs path."
9915 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2043
9916 msgid "If unavailable this is returned as an empty string C<\"\">."
9920 #: ../src/guestfs-actions.pod:2956 ../fish/guestfish-actions.pod:2045
9921 msgid "C<app_trans_path>"
9925 #: ../src/guestfs-actions.pod:2958 ../fish/guestfish-actions.pod:2047
9927 "The install path translated into a libguestfs path. If unavailable this is "
9928 "returned as an empty string C<\"\">."
9932 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2050
9933 msgid "C<app_publisher>"
9937 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2052
9939 "The name of the publisher of the application, for package managers that use "
9940 "this. If unavailable this is returned as an empty string C<\"\">."
9944 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2056
9949 #: ../src/guestfs-actions.pod:2969 ../fish/guestfish-actions.pod:2058
9951 "The URL (eg. upstream URL) of the application. If unavailable this is "
9952 "returned as an empty string C<\"\">."
9956 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2061
9957 msgid "C<app_source_package>"
9961 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2063
9963 "For packaging systems which support this, the name of the source package. "
9964 "If unavailable this is returned as an empty string C<\"\">."
9968 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2066
9969 msgid "C<app_summary>"
9973 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2068
9975 "A short (usually one line) description of the application or package. If "
9976 "unavailable this is returned as an empty string C<\"\">."
9980 #: ../src/guestfs-actions.pod:2982 ../fish/guestfish-actions.pod:2071
9981 msgid "C<app_description>"
9985 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2073
9987 "A longer description of the application or package. If unavailable this is "
9988 "returned as an empty string C<\"\">."
9992 #: ../src/guestfs-actions.pod:2991
9994 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9995 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10000 #: ../src/guestfs-actions.pod:2995
10001 msgid "(Added in 1.7.8)"
10005 #: ../src/guestfs-actions.pod:2997
10006 msgid "guestfs_inspect_os"
10010 #: ../src/guestfs-actions.pod:2999
10014 " guestfs_inspect_os (guestfs_h *g);\n"
10019 #: ../src/guestfs-actions.pod:3002 ../fish/guestfish-actions.pod:2084
10021 "This function uses other libguestfs functions and certain heuristics to "
10022 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10023 "for operating systems."
10027 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2088
10028 msgid "The list returned is empty if no operating systems were found."
10032 #: ../src/guestfs-actions.pod:3008 ../fish/guestfish-actions.pod:2090
10034 "If one operating system was found, then this returns a list with a single "
10035 "element, which is the name of the root filesystem of this operating system. "
10036 "It is also possible for this function to return a list containing more than "
10037 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10038 "element being the root filesystem of one of the operating systems."
10042 #: ../src/guestfs-actions.pod:3015
10044 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10045 "functions in order to query further information about each operating system, "
10046 "such as the name and version."
10050 #: ../src/guestfs-actions.pod:3020
10052 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10053 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10054 "the contents. This should be called with no disks currently mounted. The "
10055 "function may also use Augeas, so any existing Augeas handle will be closed."
10059 #: ../src/guestfs-actions.pod:3026 ../fish/guestfish-actions.pod:2108
10061 "This function cannot decrypt encrypted disks. The caller must do that first "
10062 "(supplying the necessary keys) if the disk is encrypted."
10066 #: ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3317 ../src/guestfs-actions.pod:3379
10067 msgid "See also C<guestfs_list_filesystems>."
10071 #: ../src/guestfs-actions.pod:3040
10072 msgid "guestfs_is_blockdev"
10076 #: ../src/guestfs-actions.pod:3042
10080 " guestfs_is_blockdev (guestfs_h *g,\n"
10081 " const char *path);\n"
10086 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2120
10088 "This returns C<true> if and only if there is a block device with the given "
10093 #: ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3108 ../src/guestfs-actions.pod:3123 ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3195 ../src/guestfs-actions.pod:3210
10094 msgid "See also C<guestfs_stat>."
10098 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3199 ../src/guestfs-actions.pod:3214
10099 msgid "(Added in 1.5.10)"
10103 #: ../src/guestfs-actions.pod:3055
10104 msgid "guestfs_is_busy"
10108 #: ../src/guestfs-actions.pod:3057
10112 " guestfs_is_busy (guestfs_h *g);\n"
10117 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2129
10119 "This returns true iff this handle is busy processing a command (in the "
10124 #: ../src/guestfs-actions.pod:3069
10125 msgid "guestfs_is_chardev"
10129 #: ../src/guestfs-actions.pod:3071
10133 " guestfs_is_chardev (guestfs_h *g,\n"
10134 " const char *path);\n"
10139 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2138
10141 "This returns C<true> if and only if there is a character device with the "
10142 "given C<path> name."
10146 #: ../src/guestfs-actions.pod:3084
10147 msgid "guestfs_is_config"
10151 #: ../src/guestfs-actions.pod:3086
10155 " guestfs_is_config (guestfs_h *g);\n"
10160 #: ../src/guestfs-actions.pod:3089 ../fish/guestfish-actions.pod:2147
10162 "This returns true iff this handle is being configured (in the C<CONFIG> "
10167 #: ../src/guestfs-actions.pod:3098
10168 msgid "guestfs_is_dir"
10172 #: ../src/guestfs-actions.pod:3100
10176 " guestfs_is_dir (guestfs_h *g,\n"
10177 " const char *path);\n"
10182 #: ../src/guestfs-actions.pod:3104 ../fish/guestfish-actions.pod:2156
10184 "This returns C<true> if and only if there is a directory with the given "
10185 "C<path> name. Note that it returns false for other objects like files."
10189 #: ../src/guestfs-actions.pod:3114
10190 msgid "guestfs_is_fifo"
10194 #: ../src/guestfs-actions.pod:3116
10198 " guestfs_is_fifo (guestfs_h *g,\n"
10199 " const char *path);\n"
10204 #: ../src/guestfs-actions.pod:3120 ../fish/guestfish-actions.pod:2166
10206 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10207 "given C<path> name."
10211 #: ../src/guestfs-actions.pod:3129
10212 msgid "guestfs_is_file"
10216 #: ../src/guestfs-actions.pod:3131
10220 " guestfs_is_file (guestfs_h *g,\n"
10221 " const char *path);\n"
10226 #: ../src/guestfs-actions.pod:3135 ../fish/guestfish-actions.pod:2175
10228 "This returns C<true> if and only if there is a regular file with the given "
10229 "C<path> name. Note that it returns false for other objects like "
10234 #: ../src/guestfs-actions.pod:3145
10235 msgid "guestfs_is_launching"
10239 #: ../src/guestfs-actions.pod:3147
10243 " guestfs_is_launching (guestfs_h *g);\n"
10248 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2185
10250 "This returns true iff this handle is launching the subprocess (in the "
10251 "C<LAUNCHING> state)."
10255 #: ../src/guestfs-actions.pod:3159
10256 msgid "guestfs_is_lv"
10260 #: ../src/guestfs-actions.pod:3161
10264 " guestfs_is_lv (guestfs_h *g,\n"
10265 " const char *device);\n"
10270 #: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2194
10272 "This command tests whether C<device> is a logical volume, and returns true "
10273 "iff this is the case."
10277 #: ../src/guestfs-actions.pod:3172
10278 msgid "guestfs_is_ready"
10282 #: ../src/guestfs-actions.pod:3174
10286 " guestfs_is_ready (guestfs_h *g);\n"
10291 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2201
10293 "This returns true iff this handle is ready to accept commands (in the "
10298 #: ../src/guestfs-actions.pod:3186
10299 msgid "guestfs_is_socket"
10303 #: ../src/guestfs-actions.pod:3188
10307 " guestfs_is_socket (guestfs_h *g,\n"
10308 " const char *path);\n"
10313 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2210
10315 "This returns C<true> if and only if there is a Unix domain socket with the "
10316 "given C<path> name."
10320 #: ../src/guestfs-actions.pod:3201
10321 msgid "guestfs_is_symlink"
10325 #: ../src/guestfs-actions.pod:3203
10329 " guestfs_is_symlink (guestfs_h *g,\n"
10330 " const char *path);\n"
10335 #: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2219
10337 "This returns C<true> if and only if there is a symbolic link with the given "
10342 #: ../src/guestfs-actions.pod:3216
10343 msgid "guestfs_kill_subprocess"
10347 #: ../src/guestfs-actions.pod:3218
10351 " guestfs_kill_subprocess (guestfs_h *g);\n"
10356 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2228
10357 msgid "This kills the qemu subprocess. You should never need to call this."
10361 #: ../src/guestfs-actions.pod:3227
10362 msgid "guestfs_launch"
10366 #: ../src/guestfs-actions.pod:3229
10370 " guestfs_launch (guestfs_h *g);\n"
10375 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2236
10377 "Internally libguestfs is implemented by running a virtual machine using "
10382 #: ../src/guestfs-actions.pod:3235 ../fish/guestfish-actions.pod:2239
10384 "You should call this after configuring the handle (eg. adding drives) but "
10385 "before performing any actions."
10389 #: ../src/guestfs-actions.pod:3242
10390 msgid "guestfs_lchown"
10394 #: ../src/guestfs-actions.pod:3244
10398 " guestfs_lchown (guestfs_h *g,\n"
10401 " const char *path);\n"
10406 #: ../src/guestfs-actions.pod:3250
10408 "Change the file owner to C<owner> and group to C<group>. This is like "
10409 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
10410 "changed, not the target."
10414 #: ../src/guestfs-actions.pod:3262
10415 msgid "guestfs_lgetxattr"
10419 #: ../src/guestfs-actions.pod:3264
10423 " guestfs_lgetxattr (guestfs_h *g,\n"
10424 " const char *path,\n"
10425 " const char *name,\n"
10426 " size_t *size_r);\n"
10431 #: ../src/guestfs-actions.pod:3270 ../fish/guestfish-actions.pod:2258
10433 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10434 "is a symlink, then this call returns an extended attribute from the symlink."
10438 #: ../src/guestfs-actions.pod:3284
10439 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
10443 #: ../src/guestfs-actions.pod:3292
10444 msgid "guestfs_lgetxattrs"
10448 #: ../src/guestfs-actions.pod:3294
10451 " struct guestfs_xattr_list *\n"
10452 " guestfs_lgetxattrs (guestfs_h *g,\n"
10453 " const char *path);\n"
10458 #: ../src/guestfs-actions.pod:3298
10460 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
10461 "then it returns the extended attributes of the link itself."
10465 #: ../src/guestfs-actions.pod:3308
10466 msgid "guestfs_list_devices"
10470 #: ../src/guestfs-actions.pod:3310
10474 " guestfs_list_devices (guestfs_h *g);\n"
10479 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2286
10480 msgid "List all the block devices."
10484 #: ../src/guestfs-actions.pod:3315 ../fish/guestfish-actions.pod:2288
10485 msgid "The full block device names are returned, eg. C</dev/sda>."
10489 #: ../src/guestfs-actions.pod:3325
10490 msgid "guestfs_list_filesystems"
10494 #: ../src/guestfs-actions.pod:3327
10498 " guestfs_list_filesystems (guestfs_h *g);\n"
10503 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2296
10505 "This inspection command looks for filesystems on partitions, block devices "
10506 "and logical volumes, returning a list of devices containing filesystems and "
10511 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2300
10513 "The return value is a hash, where the keys are the devices containing "
10514 "filesystems, and the values are the filesystem types. For example:"
10518 #: ../src/guestfs-actions.pod:3338 ../fish/guestfish-actions.pod:2304
10521 " \"/dev/sda1\" => \"ntfs\"\n"
10522 " \"/dev/sda2\" => \"ext2\"\n"
10523 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10524 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10529 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2309
10531 "The value can have the special value \"unknown\", meaning the content of the "
10532 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10536 #: ../src/guestfs-actions.pod:3347
10538 "This command runs other libguestfs commands, which might include "
10539 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10540 "soon after launch and only when nothing is mounted."
10544 #: ../src/guestfs-actions.pod:3351
10546 "Not all of the filesystems returned will be mountable. In particular, swap "
10547 "partitions are returned in the list. Also this command does not check that "
10548 "each filesystem found is valid and mountable, and some filesystems might be "
10549 "mountable but require special options. Filesystems may not all belong to a "
10550 "single logical operating system (use C<guestfs_inspect_os> to look for "
10555 #: ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:4958
10556 msgid "(Added in 1.5.15)"
10560 #: ../src/guestfs-actions.pod:3367
10561 msgid "guestfs_list_partitions"
10565 #: ../src/guestfs-actions.pod:3369
10569 " guestfs_list_partitions (guestfs_h *g);\n"
10574 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2329
10575 msgid "List all the partitions detected on all block devices."
10579 #: ../src/guestfs-actions.pod:3374 ../fish/guestfish-actions.pod:2331
10580 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10584 #: ../src/guestfs-actions.pod:3376
10586 "This does not return logical volumes. For that you will need to call "
10591 #: ../src/guestfs-actions.pod:3387
10596 #: ../src/guestfs-actions.pod:3389
10600 " guestfs_ll (guestfs_h *g,\n"
10601 " const char *directory);\n"
10606 #: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2342
10608 "List the files in C<directory> (relative to the root directory, there is no "
10609 "cwd) in the format of 'ls -la'."
10613 #: ../src/guestfs-actions.pod:3396 ../fish/guestfish-actions.pod:2345
10615 "This command is mostly useful for interactive sessions. It is I<not> "
10616 "intended that you try to parse the output string."
10620 #: ../src/guestfs-actions.pod:3404
10625 #: ../src/guestfs-actions.pod:3406
10629 " guestfs_ln (guestfs_h *g,\n"
10630 " const char *target,\n"
10631 " const char *linkname);\n"
10636 #: ../src/guestfs-actions.pod:3411 ../fish/guestfish-actions.pod:2352
10637 msgid "This command creates a hard link using the C<ln> command."
10641 #: ../src/guestfs-actions.pod:3417
10642 msgid "guestfs_ln_f"
10646 #: ../src/guestfs-actions.pod:3419
10650 " guestfs_ln_f (guestfs_h *g,\n"
10651 " const char *target,\n"
10652 " const char *linkname);\n"
10657 #: ../src/guestfs-actions.pod:3424 ../fish/guestfish-actions.pod:2358
10659 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10660 "option removes the link (C<linkname>) if it exists already."
10664 #: ../src/guestfs-actions.pod:3431
10665 msgid "guestfs_ln_s"
10669 #: ../src/guestfs-actions.pod:3433
10673 " guestfs_ln_s (guestfs_h *g,\n"
10674 " const char *target,\n"
10675 " const char *linkname);\n"
10680 #: ../src/guestfs-actions.pod:3438 ../fish/guestfish-actions.pod:2365
10681 msgid "This command creates a symbolic link using the C<ln -s> command."
10685 #: ../src/guestfs-actions.pod:3444
10686 msgid "guestfs_ln_sf"
10690 #: ../src/guestfs-actions.pod:3446
10694 " guestfs_ln_sf (guestfs_h *g,\n"
10695 " const char *target,\n"
10696 " const char *linkname);\n"
10701 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2371
10703 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10704 "option removes the link (C<linkname>) if it exists already."
10708 #: ../src/guestfs-actions.pod:3458
10709 msgid "guestfs_lremovexattr"
10713 #: ../src/guestfs-actions.pod:3460
10717 " guestfs_lremovexattr (guestfs_h *g,\n"
10718 " const char *xattr,\n"
10719 " const char *path);\n"
10724 #: ../src/guestfs-actions.pod:3465
10726 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10727 "link, then it removes an extended attribute of the link itself."
10731 #: ../src/guestfs-actions.pod:3473
10736 #: ../src/guestfs-actions.pod:3475
10740 " guestfs_ls (guestfs_h *g,\n"
10741 " const char *directory);\n"
10746 #: ../src/guestfs-actions.pod:3479 ../fish/guestfish-actions.pod:2386
10748 "List the files in C<directory> (relative to the root directory, there is no "
10749 "cwd). The '.' and '..' entries are not returned, but hidden files are "
10754 #: ../src/guestfs-actions.pod:3483
10756 "This command is mostly useful for interactive sessions. Programs should "
10757 "probably use C<guestfs_readdir> instead."
10761 #: ../src/guestfs-actions.pod:3492
10762 msgid "guestfs_lsetxattr"
10766 #: ../src/guestfs-actions.pod:3494
10770 " guestfs_lsetxattr (guestfs_h *g,\n"
10771 " const char *xattr,\n"
10772 " const char *val,\n"
10774 " const char *path);\n"
10779 #: ../src/guestfs-actions.pod:3501
10781 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10782 "then it sets an extended attribute of the link itself."
10786 #: ../src/guestfs-actions.pod:3509
10787 msgid "guestfs_lstat"
10791 #: ../src/guestfs-actions.pod:3511
10794 " struct guestfs_stat *\n"
10795 " guestfs_lstat (guestfs_h *g,\n"
10796 " const char *path);\n"
10801 #: ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:6012 ../fish/guestfish-actions.pod:2405 ../fish/guestfish-actions.pod:4020
10802 msgid "Returns file information for the given C<path>."
10806 #: ../src/guestfs-actions.pod:3517
10808 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10809 "link, then the link is stat-ed, not the file it refers to."
10813 #: ../src/guestfs-actions.pod:3521 ../fish/guestfish-actions.pod:2411
10814 msgid "This is the same as the C<lstat(2)> system call."
10818 #: ../src/guestfs-actions.pod:3523 ../src/guestfs-actions.pod:6016
10820 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10821 "error. I<The caller must call C<guestfs_free_stat> after use>."
10825 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6038 ../src/guestfs-actions.pod:6419
10826 msgid "(Added in 0.9.2)"
10830 #: ../src/guestfs-actions.pod:3529
10831 msgid "guestfs_lstatlist"
10835 #: ../src/guestfs-actions.pod:3531
10838 " struct guestfs_stat_list *\n"
10839 " guestfs_lstatlist (guestfs_h *g,\n"
10840 " const char *path,\n"
10841 " char *const *names);\n"
10846 #: ../src/guestfs-actions.pod:3536
10848 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10849 "files, where all files are in the directory C<path>. C<names> is the list "
10850 "of files from this directory."
10854 #: ../src/guestfs-actions.pod:3540 ../fish/guestfish-actions.pod:2421
10856 "On return you get a list of stat structs, with a one-to-one correspondence "
10857 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10858 "then the C<ino> field of that structure is set to C<-1>."
10862 #: ../src/guestfs-actions.pod:3545
10864 "This call is intended for programs that want to efficiently list a directory "
10865 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10866 "for a similarly efficient call for getting extended attributes. Very long "
10867 "directory listings might cause the protocol message size to be exceeded, "
10868 "causing this call to fail. The caller must split up such requests into "
10869 "smaller groups of names."
10873 #: ../src/guestfs-actions.pod:3553
10875 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10876 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10880 #: ../src/guestfs-actions.pod:3559
10881 msgid "guestfs_luks_add_key"
10885 #: ../src/guestfs-actions.pod:3561
10889 " guestfs_luks_add_key (guestfs_h *g,\n"
10890 " const char *device,\n"
10891 " const char *key,\n"
10892 " const char *newkey,\n"
10898 #: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2438
10900 "This command adds a new key on LUKS device C<device>. C<key> is any "
10901 "existing key, and is used to access the device. C<newkey> is the new key to "
10902 "add. C<keyslot> is the key slot that will be replaced."
10906 #: ../src/guestfs-actions.pod:3573
10908 "Note that if C<keyslot> already contains a key, then this command will "
10909 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10913 #: ../src/guestfs-actions.pod:3579 ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3713
10915 "This function takes a key or passphrase parameter which could contain "
10916 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10921 #: ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3666
10922 msgid "(Added in 1.5.2)"
10926 #: ../src/guestfs-actions.pod:3585
10927 msgid "guestfs_luks_close"
10931 #: ../src/guestfs-actions.pod:3587
10935 " guestfs_luks_close (guestfs_h *g,\n"
10936 " const char *device);\n"
10941 #: ../src/guestfs-actions.pod:3591
10943 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10944 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10945 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10946 "underlying block device."
10950 #: ../src/guestfs-actions.pod:3599 ../src/guestfs-actions.pod:3698 ../src/guestfs-actions.pod:3717 ../src/guestfs-actions.pod:3767 ../src/guestfs-actions.pod:3815
10951 msgid "(Added in 1.5.1)"
10955 #: ../src/guestfs-actions.pod:3601
10956 msgid "guestfs_luks_format"
10960 #: ../src/guestfs-actions.pod:3603
10964 " guestfs_luks_format (guestfs_h *g,\n"
10965 " const char *device,\n"
10966 " const char *key,\n"
10972 #: ../src/guestfs-actions.pod:3609 ../fish/guestfish-actions.pod:2464
10974 "This command erases existing data on C<device> and formats the device as a "
10975 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10976 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10980 #: ../src/guestfs-actions.pod:3616 ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:4709 ../src/guestfs-actions.pod:5472 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5870 ../src/guestfs-actions.pod:5896 ../src/guestfs-actions.pod:7056 ../fish/guestfish-actions.pod:2472 ../fish/guestfish-actions.pod:2485 ../fish/guestfish-actions.pod:2569 ../fish/guestfish-actions.pod:3132 ../fish/guestfish-actions.pod:3639 ../fish/guestfish-actions.pod:3919 ../fish/guestfish-actions.pod:3935 ../fish/guestfish-actions.pod:3950 ../fish/guestfish-actions.pod:4665
10982 "B<This command is dangerous. Without careful use you can easily destroy all "
10987 #: ../src/guestfs-actions.pod:3625
10988 msgid "guestfs_luks_format_cipher"
10992 #: ../src/guestfs-actions.pod:3627
10996 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10997 " const char *device,\n"
10998 " const char *key,\n"
11000 " const char *cipher);\n"
11005 #: ../src/guestfs-actions.pod:3634
11007 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11008 "set the C<cipher> used."
11012 #: ../src/guestfs-actions.pod:3648
11013 msgid "guestfs_luks_kill_slot"
11017 #: ../src/guestfs-actions.pod:3650
11021 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11022 " const char *device,\n"
11023 " const char *key,\n"
11029 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2492
11031 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11032 "device C<device>. C<key> must be one of the I<other> keys."
11036 #: ../src/guestfs-actions.pod:3668
11037 msgid "guestfs_luks_open"
11041 #: ../src/guestfs-actions.pod:3670
11045 " guestfs_luks_open (guestfs_h *g,\n"
11046 " const char *device,\n"
11047 " const char *key,\n"
11048 " const char *mapname);\n"
11053 #: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2503
11055 "This command opens a block device which has been encrypted according to the "
11056 "Linux Unified Key Setup (LUKS) standard."
11060 #: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2506
11061 msgid "C<device> is the encrypted block device or partition."
11065 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2508
11067 "The caller must supply one of the keys associated with the LUKS block "
11068 "device, in the C<key> parameter."
11072 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2511
11074 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11075 "writes to this block device are decrypted from and encrypted to the "
11076 "underlying C<device> respectively."
11080 #: ../src/guestfs-actions.pod:3688
11082 "If this block device contains LVM volume groups, then calling "
11083 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11088 #: ../src/guestfs-actions.pod:3700
11089 msgid "guestfs_luks_open_ro"
11093 #: ../src/guestfs-actions.pod:3702
11097 " guestfs_luks_open_ro (guestfs_h *g,\n"
11098 " const char *device,\n"
11099 " const char *key,\n"
11100 " const char *mapname);\n"
11105 #: ../src/guestfs-actions.pod:3708
11107 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11112 #: ../src/guestfs-actions.pod:3719
11113 msgid "guestfs_lvcreate"
11117 #: ../src/guestfs-actions.pod:3721
11121 " guestfs_lvcreate (guestfs_h *g,\n"
11122 " const char *logvol,\n"
11123 " const char *volgroup,\n"
11129 #: ../src/guestfs-actions.pod:3727 ../fish/guestfish-actions.pod:2536
11131 "This creates an LVM logical volume called C<logvol> on the volume group "
11132 "C<volgroup>, with C<size> megabytes."
11136 #: ../src/guestfs-actions.pod:3734
11137 msgid "guestfs_lvm_canonical_lv_name"
11141 #: ../src/guestfs-actions.pod:3736
11145 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11146 " const char *lvname);\n"
11151 #: ../src/guestfs-actions.pod:3740 ../fish/guestfish-actions.pod:2543
11153 "This converts alternative naming schemes for LVs that you might find to the "
11154 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11159 #: ../src/guestfs-actions.pod:3744 ../fish/guestfish-actions.pod:2547
11161 "This command returns an error if the C<lvname> parameter does not refer to a "
11166 #: ../src/guestfs-actions.pod:3747
11167 msgid "See also C<guestfs_is_lv>."
11171 #: ../src/guestfs-actions.pod:3752
11172 msgid "(Added in 1.5.24)"
11176 #: ../src/guestfs-actions.pod:3754
11177 msgid "guestfs_lvm_clear_filter"
11181 #: ../src/guestfs-actions.pod:3756
11185 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11190 #: ../src/guestfs-actions.pod:3759
11192 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11193 "see every block device."
11197 #: ../src/guestfs-actions.pod:3762 ../src/guestfs-actions.pod:3804 ../fish/guestfish-actions.pod:2559 ../fish/guestfish-actions.pod:2590
11198 msgid "This command also clears the LVM cache and performs a volume group scan."
11202 #: ../src/guestfs-actions.pod:3769
11203 msgid "guestfs_lvm_remove_all"
11207 #: ../src/guestfs-actions.pod:3771
11211 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11216 #: ../src/guestfs-actions.pod:3774 ../fish/guestfish-actions.pod:2566
11218 "This command removes all LVM logical volumes, volume groups and physical "
11223 #: ../src/guestfs-actions.pod:3784
11224 msgid "guestfs_lvm_set_filter"
11228 #: ../src/guestfs-actions.pod:3786
11232 " guestfs_lvm_set_filter (guestfs_h *g,\n"
11233 " char *const *devices);\n"
11238 #: ../src/guestfs-actions.pod:3790 ../fish/guestfish-actions.pod:2576
11240 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11241 "block devices in the list C<devices>, and will ignore all other attached "
11246 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2580
11248 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11249 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11250 "there are two types of duplication possible: either cloned PVs/VGs which "
11251 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11252 "same name. In normal operation you cannot create this situation, but you "
11253 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11254 "inside the LVM metadata."
11258 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2593
11259 msgid "You can filter whole block devices or individual partitions."
11263 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2595
11265 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11266 "filesystem), even if you are not filtering out that VG."
11270 #: ../src/guestfs-actions.pod:3817
11271 msgid "guestfs_lvremove"
11275 #: ../src/guestfs-actions.pod:3819
11279 " guestfs_lvremove (guestfs_h *g,\n"
11280 " const char *device);\n"
11285 #: ../src/guestfs-actions.pod:3823 ../fish/guestfish-actions.pod:2603
11287 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11288 "LV, such as C</dev/VG/LV>."
11292 #: ../src/guestfs-actions.pod:3826 ../fish/guestfish-actions.pod:2606
11294 "You can also remove all LVs in a volume group by specifying the VG name, "
11299 #: ../src/guestfs-actions.pod:3831 ../src/guestfs-actions.pod:5055 ../src/guestfs-actions.pod:6795
11300 msgid "(Added in 1.0.13)"
11304 #: ../src/guestfs-actions.pod:3833
11305 msgid "guestfs_lvrename"
11309 #: ../src/guestfs-actions.pod:3835
11313 " guestfs_lvrename (guestfs_h *g,\n"
11314 " const char *logvol,\n"
11315 " const char *newlogvol);\n"
11320 #: ../src/guestfs-actions.pod:3840 ../fish/guestfish-actions.pod:2613
11321 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11325 #: ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:6808
11326 msgid "(Added in 1.0.83)"
11330 #: ../src/guestfs-actions.pod:3846
11331 msgid "guestfs_lvresize"
11335 #: ../src/guestfs-actions.pod:3848
11339 " guestfs_lvresize (guestfs_h *g,\n"
11340 " const char *device,\n"
11346 #: ../src/guestfs-actions.pod:3853 ../fish/guestfish-actions.pod:2619
11348 "This resizes (expands or shrinks) an existing LVM logical volume to "
11349 "C<mbytes>. When reducing, data in the reduced part is lost."
11353 #: ../src/guestfs-actions.pod:3861
11354 msgid "guestfs_lvresize_free"
11358 #: ../src/guestfs-actions.pod:3863
11362 " guestfs_lvresize_free (guestfs_h *g,\n"
11363 " const char *lv,\n"
11369 #: ../src/guestfs-actions.pod:3868 ../fish/guestfish-actions.pod:2627
11371 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11372 "remaining free space in the volume group. Commonly you would call this with "
11373 "pc = 100 which expands the logical volume as much as possible, using all "
11374 "remaining free space in the volume group."
11378 #: ../src/guestfs-actions.pod:3876
11379 msgid "(Added in 1.3.3)"
11383 #: ../src/guestfs-actions.pod:3878
11384 msgid "guestfs_lvs"
11388 #: ../src/guestfs-actions.pod:3880
11392 " guestfs_lvs (guestfs_h *g);\n"
11397 #: ../src/guestfs-actions.pod:3883 ../fish/guestfish-actions.pod:2637
11399 "List all the logical volumes detected. This is the equivalent of the "
11400 "L<lvs(8)> command."
11404 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2640
11406 "This returns a list of the logical volume device names "
11407 "(eg. C</dev/VolGroup00/LogVol00>)."
11411 #: ../src/guestfs-actions.pod:3889
11412 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
11416 #: ../src/guestfs-actions.pod:3897
11417 msgid "guestfs_lvs_full"
11421 #: ../src/guestfs-actions.pod:3899
11424 " struct guestfs_lvm_lv_list *\n"
11425 " guestfs_lvs_full (guestfs_h *g);\n"
11430 #: ../src/guestfs-actions.pod:3902 ../fish/guestfish-actions.pod:2649
11432 "List all the logical volumes detected. This is the equivalent of the "
11433 "L<lvs(8)> command. The \"full\" version includes all fields."
11437 #: ../src/guestfs-actions.pod:3905
11439 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
11440 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
11445 #: ../src/guestfs-actions.pod:3911
11446 msgid "guestfs_lvuuid"
11450 #: ../src/guestfs-actions.pod:3913
11454 " guestfs_lvuuid (guestfs_h *g,\n"
11455 " const char *device);\n"
11460 #: ../src/guestfs-actions.pod:3917 ../fish/guestfish-actions.pod:2656
11461 msgid "This command returns the UUID of the LVM LV C<device>."
11465 #: ../src/guestfs-actions.pod:3924
11466 msgid "guestfs_lxattrlist"
11470 #: ../src/guestfs-actions.pod:3926
11473 " struct guestfs_xattr_list *\n"
11474 " guestfs_lxattrlist (guestfs_h *g,\n"
11475 " const char *path,\n"
11476 " char *const *names);\n"
11481 #: ../src/guestfs-actions.pod:3931 ../fish/guestfish-actions.pod:2662
11483 "This call allows you to get the extended attributes of multiple files, where "
11484 "all files are in the directory C<path>. C<names> is the list of files from "
11489 #: ../src/guestfs-actions.pod:3935 ../fish/guestfish-actions.pod:2666
11491 "On return you get a flat list of xattr structs which must be interpreted "
11492 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11493 "C<attrval> in this struct is zero-length to indicate there was an error "
11494 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11495 "number (the number of following attributes for this file, which could be "
11496 "C<\"0\">). Then after the first xattr struct are the zero or more "
11497 "attributes for the first named file. This repeats for the second and "
11498 "subsequent files."
11502 #: ../src/guestfs-actions.pod:3945
11504 "This call is intended for programs that want to efficiently list a directory "
11505 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11506 "a similarly efficient call for getting standard stats. Very long directory "
11507 "listings might cause the protocol message size to be exceeded, causing this "
11508 "call to fail. The caller must split up such requests into smaller groups of "
11513 #: ../src/guestfs-actions.pod:3959
11514 msgid "guestfs_mkdir"
11518 #: ../src/guestfs-actions.pod:3961
11522 " guestfs_mkdir (guestfs_h *g,\n"
11523 " const char *path);\n"
11528 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2688
11529 msgid "Create a directory named C<path>."
11533 #: ../src/guestfs-actions.pod:3971
11534 msgid "guestfs_mkdir_mode"
11538 #: ../src/guestfs-actions.pod:3973
11542 " guestfs_mkdir_mode (guestfs_h *g,\n"
11543 " const char *path,\n"
11549 #: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:2694
11551 "This command creates a directory, setting the initial permissions of the "
11552 "directory to C<mode>."
11556 #: ../src/guestfs-actions.pod:3981 ../fish/guestfish-actions.pod:2697
11558 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11559 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11564 #: ../src/guestfs-actions.pod:3985
11565 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11569 #: ../src/guestfs-actions.pod:3991
11570 msgid "guestfs_mkdir_p"
11574 #: ../src/guestfs-actions.pod:3993
11578 " guestfs_mkdir_p (guestfs_h *g,\n"
11579 " const char *path);\n"
11584 #: ../src/guestfs-actions.pod:3997 ../fish/guestfish-actions.pod:2707
11586 "Create a directory named C<path>, creating any parent directories as "
11587 "necessary. This is like the C<mkdir -p> shell command."
11591 #: ../src/guestfs-actions.pod:4004
11592 msgid "guestfs_mkdtemp"
11596 #: ../src/guestfs-actions.pod:4006
11600 " guestfs_mkdtemp (guestfs_h *g,\n"
11601 " const char *template);\n"
11606 #: ../src/guestfs-actions.pod:4010 ../fish/guestfish-actions.pod:2714
11608 "This command creates a temporary directory. The C<template> parameter "
11609 "should be a full pathname for the temporary directory name with the final "
11610 "six characters being \"XXXXXX\"."
11614 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2719
11616 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11617 "being suitable for Windows filesystems."
11621 #: ../src/guestfs-actions.pod:4018 ../fish/guestfish-actions.pod:2722
11622 msgid "The name of the temporary directory that was created is returned."
11626 #: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:2725
11627 msgid "The temporary directory is created with mode 0700 and is owned by root."
11631 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2728
11633 "The caller is responsible for deleting the temporary directory and its "
11634 "contents after use."
11638 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2731
11639 msgid "See also: L<mkdtemp(3)>"
11643 #: ../src/guestfs-actions.pod:4034
11644 msgid "guestfs_mke2fs_J"
11648 #: ../src/guestfs-actions.pod:4036
11652 " guestfs_mke2fs_J (guestfs_h *g,\n"
11653 " const char *fstype,\n"
11654 " int blocksize,\n"
11655 " const char *device,\n"
11656 " const char *journal);\n"
11661 #: ../src/guestfs-actions.pod:4043 ../fish/guestfish-actions.pod:2737
11663 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11664 "C<journal>. It is equivalent to the command:"
11668 #: ../src/guestfs-actions.pod:4047 ../fish/guestfish-actions.pod:2741
11671 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11676 #: ../src/guestfs-actions.pod:4049
11677 msgid "See also C<guestfs_mke2journal>."
11681 #: ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4071 ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:4119 ../src/guestfs-actions.pod:4133 ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4445
11682 msgid "(Added in 1.0.68)"
11686 #: ../src/guestfs-actions.pod:4055
11687 msgid "guestfs_mke2fs_JL"
11691 #: ../src/guestfs-actions.pod:4057
11695 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11696 " const char *fstype,\n"
11697 " int blocksize,\n"
11698 " const char *device,\n"
11699 " const char *label);\n"
11704 #: ../src/guestfs-actions.pod:4064 ../fish/guestfish-actions.pod:2749
11706 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11707 "the journal labeled C<label>."
11711 #: ../src/guestfs-actions.pod:4067
11712 msgid "See also C<guestfs_mke2journal_L>."
11716 #: ../src/guestfs-actions.pod:4073
11717 msgid "guestfs_mke2fs_JU"
11721 #: ../src/guestfs-actions.pod:4075
11725 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11726 " const char *fstype,\n"
11727 " int blocksize,\n"
11728 " const char *device,\n"
11729 " const char *uuid);\n"
11734 #: ../src/guestfs-actions.pod:4082 ../fish/guestfish-actions.pod:2758
11736 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11737 "the journal with UUID C<uuid>."
11741 #: ../src/guestfs-actions.pod:4085
11742 msgid "See also C<guestfs_mke2journal_U>."
11746 #: ../src/guestfs-actions.pod:4091
11747 msgid "guestfs_mke2journal"
11751 #: ../src/guestfs-actions.pod:4093
11755 " guestfs_mke2journal (guestfs_h *g,\n"
11756 " int blocksize,\n"
11757 " const char *device);\n"
11762 #: ../src/guestfs-actions.pod:4098 ../fish/guestfish-actions.pod:2767
11764 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11769 #: ../src/guestfs-actions.pod:4101 ../fish/guestfish-actions.pod:2770
11772 " mke2fs -O journal_dev -b blocksize device\n"
11777 #: ../src/guestfs-actions.pod:4107
11778 msgid "guestfs_mke2journal_L"
11782 #: ../src/guestfs-actions.pod:4109
11786 " guestfs_mke2journal_L (guestfs_h *g,\n"
11787 " int blocksize,\n"
11788 " const char *label,\n"
11789 " const char *device);\n"
11794 #: ../src/guestfs-actions.pod:4115 ../fish/guestfish-actions.pod:2776
11795 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11799 #: ../src/guestfs-actions.pod:4121
11800 msgid "guestfs_mke2journal_U"
11804 #: ../src/guestfs-actions.pod:4123
11808 " guestfs_mke2journal_U (guestfs_h *g,\n"
11809 " int blocksize,\n"
11810 " const char *uuid,\n"
11811 " const char *device);\n"
11816 #: ../src/guestfs-actions.pod:4129 ../fish/guestfish-actions.pod:2782
11817 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11821 #: ../src/guestfs-actions.pod:4135
11822 msgid "guestfs_mkfifo"
11826 #: ../src/guestfs-actions.pod:4137
11830 " guestfs_mkfifo (guestfs_h *g,\n"
11832 " const char *path);\n"
11837 #: ../src/guestfs-actions.pod:4142
11839 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11840 "is just a convenient wrapper around C<guestfs_mknod>."
11844 #: ../src/guestfs-actions.pod:4152
11845 msgid "guestfs_mkfs"
11849 #: ../src/guestfs-actions.pod:4154
11853 " guestfs_mkfs (guestfs_h *g,\n"
11854 " const char *fstype,\n"
11855 " const char *device);\n"
11860 #: ../src/guestfs-actions.pod:4159 ../fish/guestfish-actions.pod:2798
11862 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11863 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11867 #: ../src/guestfs-actions.pod:4167
11868 msgid "guestfs_mkfs_b"
11872 #: ../src/guestfs-actions.pod:4169
11876 " guestfs_mkfs_b (guestfs_h *g,\n"
11877 " const char *fstype,\n"
11878 " int blocksize,\n"
11879 " const char *device);\n"
11884 #: ../src/guestfs-actions.pod:4175
11886 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11887 "block size of the resulting filesystem. Supported block sizes depend on the "
11888 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11892 #: ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4222 ../fish/guestfish-actions.pod:2811 ../fish/guestfish-actions.pod:2838
11894 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11899 #: ../src/guestfs-actions.pod:4185 ../fish/guestfish-actions.pod:2814
11901 "This function is deprecated. In new code, use the C<mkfs_opts> call "
11906 #: ../src/guestfs-actions.pod:4194
11907 msgid "guestfs_mkfs_opts"
11911 #: ../src/guestfs-actions.pod:4196
11915 " guestfs_mkfs_opts (guestfs_h *g,\n"
11916 " const char *fstype,\n"
11917 " const char *device,\n"
11923 #: ../src/guestfs-actions.pod:4207
11926 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
11931 #: ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:2825
11933 "This function creates a filesystem on C<device>. The filesystem type is "
11934 "C<fstype>, for example C<ext3>."
11938 #: ../src/guestfs-actions.pod:4216 ../fish/guestfish-actions.pod:2832
11939 msgid "C<blocksize>"
11943 #: ../src/guestfs-actions.pod:4218 ../fish/guestfish-actions.pod:2834
11945 "The filesystem block size. Supported block sizes depend on the filesystem "
11946 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11951 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2841
11952 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
11956 #: ../src/guestfs-actions.pod:4231
11957 msgid "(Added in 1.7.19)"
11961 #: ../src/guestfs-actions.pod:4233
11962 msgid "guestfs_mkfs_opts_va"
11966 #: ../src/guestfs-actions.pod:4235
11970 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
11971 " const char *fstype,\n"
11972 " const char *device,\n"
11973 " va_list args);\n"
11978 #: ../src/guestfs-actions.pod:4241
11979 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
11983 #: ../src/guestfs-actions.pod:4245
11984 msgid "guestfs_mkfs_opts_argv"
11988 #: ../src/guestfs-actions.pod:4247
11992 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
11993 " const char *fstype,\n"
11994 " const char *device,\n"
11995 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12000 #: ../src/guestfs-actions.pod:4253
12001 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12005 #: ../src/guestfs-actions.pod:4257
12006 msgid "guestfs_mkmountpoint"
12010 #: ../src/guestfs-actions.pod:4259
12014 " guestfs_mkmountpoint (guestfs_h *g,\n"
12015 " const char *exemptpath);\n"
12020 #: ../src/guestfs-actions.pod:4263
12022 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12023 "that can be used to create extra mountpoints before mounting the first "
12028 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2855
12030 "These calls are I<only> necessary in some very limited circumstances, mainly "
12031 "the case where you want to mount a mix of unrelated and/or read-only "
12032 "filesystems together."
12036 #: ../src/guestfs-actions.pod:4271 ../fish/guestfish-actions.pod:2859
12038 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12039 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12040 "inside that. You can unpack this as follows in guestfish:"
12044 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2864
12047 " add-ro Fedora-11-i686-Live.iso\n"
12049 " mkmountpoint /cd\n"
12050 " mkmountpoint /sqsh\n"
12051 " mkmountpoint /ext3fs\n"
12052 " mount /dev/sda /cd\n"
12053 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12054 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12059 #: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:2873
12060 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12064 #: ../src/guestfs-actions.pod:4287
12066 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12067 "may get unexpected errors if you try to mix these calls. It is safest to "
12068 "manually unmount filesystems and remove mountpoints after use."
12072 #: ../src/guestfs-actions.pod:4291
12074 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12075 "first, so for this to work for manual mountpoints, you must ensure that the "
12076 "innermost mountpoints have the longest pathnames, as in the example code "
12081 #: ../src/guestfs-actions.pod:4296 ../fish/guestfish-actions.pod:2884
12082 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12086 #: ../src/guestfs-actions.pod:4298
12088 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12089 "means that C<guestfs_umount_all> is called when the handle is closed which "
12090 "can also trigger these issues."
12094 #: ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:4563 ../src/guestfs-actions.pod:5456
12095 msgid "(Added in 1.0.62)"
12099 #: ../src/guestfs-actions.pod:4306
12100 msgid "guestfs_mknod"
12104 #: ../src/guestfs-actions.pod:4308
12108 " guestfs_mknod (guestfs_h *g,\n"
12112 " const char *path);\n"
12117 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2894
12119 "This call creates block or character special devices, or named pipes "
12124 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:2897
12126 "The C<mode> parameter should be the mode, using the standard constants. "
12127 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12128 "used when creating block and character special devices."
12132 #: ../src/guestfs-actions.pod:4323
12134 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12135 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12136 "regular file). These constants are available in the standard Linux header "
12137 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12138 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12139 "the appropriate constant for you."
12143 #: ../src/guestfs-actions.pod:4337
12144 msgid "guestfs_mknod_b"
12148 #: ../src/guestfs-actions.pod:4339
12152 " guestfs_mknod_b (guestfs_h *g,\n"
12156 " const char *path);\n"
12161 #: ../src/guestfs-actions.pod:4346
12163 "This call creates a block device node called C<path> with mode C<mode> and "
12164 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12165 "wrapper around C<guestfs_mknod>."
12169 #: ../src/guestfs-actions.pod:4356
12170 msgid "guestfs_mknod_c"
12174 #: ../src/guestfs-actions.pod:4358
12178 " guestfs_mknod_c (guestfs_h *g,\n"
12182 " const char *path);\n"
12187 #: ../src/guestfs-actions.pod:4365
12189 "This call creates a char device node called C<path> with mode C<mode> and "
12190 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12191 "wrapper around C<guestfs_mknod>."
12195 #: ../src/guestfs-actions.pod:4375
12196 msgid "guestfs_mkswap"
12200 #: ../src/guestfs-actions.pod:4377
12204 " guestfs_mkswap (guestfs_h *g,\n"
12205 " const char *device);\n"
12210 #: ../src/guestfs-actions.pod:4381 ../fish/guestfish-actions.pod:2936
12211 msgid "Create a swap partition on C<device>."
12215 #: ../src/guestfs-actions.pod:4387
12216 msgid "guestfs_mkswap_L"
12220 #: ../src/guestfs-actions.pod:4389
12224 " guestfs_mkswap_L (guestfs_h *g,\n"
12225 " const char *label,\n"
12226 " const char *device);\n"
12231 #: ../src/guestfs-actions.pod:4394 ../fish/guestfish-actions.pod:2942
12232 msgid "Create a swap partition on C<device> with label C<label>."
12236 #: ../src/guestfs-actions.pod:4396 ../fish/guestfish-actions.pod:2944
12238 "Note that you cannot attach a swap label to a block device "
12239 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12240 "the kernel or swap tools."
12244 #: ../src/guestfs-actions.pod:4404
12245 msgid "guestfs_mkswap_U"
12249 #: ../src/guestfs-actions.pod:4406
12253 " guestfs_mkswap_U (guestfs_h *g,\n"
12254 " const char *uuid,\n"
12255 " const char *device);\n"
12260 #: ../src/guestfs-actions.pod:4411 ../fish/guestfish-actions.pod:2952
12261 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12265 #: ../src/guestfs-actions.pod:4417
12266 msgid "guestfs_mkswap_file"
12270 #: ../src/guestfs-actions.pod:4419
12274 " guestfs_mkswap_file (guestfs_h *g,\n"
12275 " const char *path);\n"
12280 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:2958
12281 msgid "Create a swap file."
12285 #: ../src/guestfs-actions.pod:4425
12287 "This command just writes a swap file signature to an existing file. To "
12288 "create the file itself, use something like C<guestfs_fallocate>."
12292 #: ../src/guestfs-actions.pod:4432
12293 msgid "guestfs_modprobe"
12297 #: ../src/guestfs-actions.pod:4434
12301 " guestfs_modprobe (guestfs_h *g,\n"
12302 " const char *modulename);\n"
12307 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2967
12308 msgid "This loads a kernel module in the appliance."
12312 #: ../src/guestfs-actions.pod:4440 ../fish/guestfish-actions.pod:2969
12314 "The kernel module must have been whitelisted when libguestfs was built (see "
12315 "C<appliance/kmod.whitelist.in> in the source)."
12319 #: ../src/guestfs-actions.pod:4447
12320 msgid "guestfs_mount"
12324 #: ../src/guestfs-actions.pod:4449
12328 " guestfs_mount (guestfs_h *g,\n"
12329 " const char *device,\n"
12330 " const char *mountpoint);\n"
12335 #: ../src/guestfs-actions.pod:4454 ../fish/guestfish-actions.pod:2976
12337 "Mount a guest disk at a position in the filesystem. Block devices are named "
12338 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12339 "those block devices contain partitions, they will have the usual names "
12340 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12344 #: ../src/guestfs-actions.pod:4460 ../fish/guestfish-actions.pod:2982
12346 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12347 "mounted on C</> before others can be mounted. Other filesystems can only be "
12348 "mounted on directories which already exist."
12352 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2987
12354 "The mounted filesystem is writable, if we have sufficient permissions on the "
12355 "underlying device."
12359 #: ../src/guestfs-actions.pod:4468
12361 "B<Important note:> When you use this call, the filesystem options C<sync> "
12362 "and C<noatime> are set implicitly. This was originally done because we "
12363 "thought it would improve reliability, but it turns out that I<-o sync> has a "
12364 "very large negative performance impact and negligible effect on "
12365 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
12366 "in any code that needs performance, and instead use C<guestfs_mount_options> "
12367 "(use an empty string for the first parameter if you don't want any options)."
12371 #: ../src/guestfs-actions.pod:4482
12372 msgid "guestfs_mount_loop"
12376 #: ../src/guestfs-actions.pod:4484
12380 " guestfs_mount_loop (guestfs_h *g,\n"
12381 " const char *file,\n"
12382 " const char *mountpoint);\n"
12387 #: ../src/guestfs-actions.pod:4489 ../fish/guestfish-actions.pod:3004
12389 "This command lets you mount C<file> (a filesystem image in a file) on a "
12390 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12395 #: ../src/guestfs-actions.pod:4497
12396 msgid "guestfs_mount_options"
12400 #: ../src/guestfs-actions.pod:4499
12404 " guestfs_mount_options (guestfs_h *g,\n"
12405 " const char *options,\n"
12406 " const char *device,\n"
12407 " const char *mountpoint);\n"
12412 #: ../src/guestfs-actions.pod:4505
12414 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12415 "the mount options as for the L<mount(8)> I<-o> flag."
12419 #: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:3016
12421 "If the C<options> parameter is an empty string, then no options are passed "
12422 "(all options default to whatever the filesystem uses)."
12426 #: ../src/guestfs-actions.pod:4515 ../src/guestfs-actions.pod:4529 ../src/guestfs-actions.pod:4546
12427 msgid "(Added in 1.0.10)"
12431 #: ../src/guestfs-actions.pod:4517
12432 msgid "guestfs_mount_ro"
12436 #: ../src/guestfs-actions.pod:4519
12440 " guestfs_mount_ro (guestfs_h *g,\n"
12441 " const char *device,\n"
12442 " const char *mountpoint);\n"
12447 #: ../src/guestfs-actions.pod:4524
12449 "This is the same as the C<guestfs_mount> command, but it mounts the "
12450 "filesystem with the read-only (I<-o ro>) flag."
12454 #: ../src/guestfs-actions.pod:4531
12455 msgid "guestfs_mount_vfs"
12459 #: ../src/guestfs-actions.pod:4533
12463 " guestfs_mount_vfs (guestfs_h *g,\n"
12464 " const char *options,\n"
12465 " const char *vfstype,\n"
12466 " const char *device,\n"
12467 " const char *mountpoint);\n"
12472 #: ../src/guestfs-actions.pod:4540
12474 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12475 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
12480 #: ../src/guestfs-actions.pod:4548
12481 msgid "guestfs_mountpoints"
12485 #: ../src/guestfs-actions.pod:4550
12489 " guestfs_mountpoints (guestfs_h *g);\n"
12494 #: ../src/guestfs-actions.pod:4553
12496 "This call is similar to C<guestfs_mounts>. That call returns a list of "
12497 "devices. This one returns a hash table (map) of device name to directory "
12498 "where the device is mounted."
12502 #: ../src/guestfs-actions.pod:4565
12503 msgid "guestfs_mounts"
12507 #: ../src/guestfs-actions.pod:4567
12511 " guestfs_mounts (guestfs_h *g);\n"
12516 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3047
12518 "This returns the list of currently mounted filesystems. It returns the list "
12519 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12523 #: ../src/guestfs-actions.pod:4573 ../fish/guestfish-actions.pod:3050
12524 msgid "Some internal mounts are not shown."
12528 #: ../src/guestfs-actions.pod:4575
12529 msgid "See also: C<guestfs_mountpoints>"
12533 #: ../src/guestfs-actions.pod:4583
12538 #: ../src/guestfs-actions.pod:4585
12542 " guestfs_mv (guestfs_h *g,\n"
12543 " const char *src,\n"
12544 " const char *dest);\n"
12549 #: ../src/guestfs-actions.pod:4590 ../fish/guestfish-actions.pod:3058
12551 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12552 "destination filename or destination directory."
12556 #: ../src/guestfs-actions.pod:4597
12557 msgid "guestfs_ntfs_3g_probe"
12561 #: ../src/guestfs-actions.pod:4599
12565 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12567 " const char *device);\n"
12572 #: ../src/guestfs-actions.pod:4604 ../fish/guestfish-actions.pod:3065
12574 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12575 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12576 "read-write, and some cannot be mounted at all)."
12580 #: ../src/guestfs-actions.pod:4608 ../fish/guestfish-actions.pod:3069
12582 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12583 "can be mounted read-write. Set it to false if you want to test if the "
12584 "volume can be mounted read-only."
12588 #: ../src/guestfs-actions.pod:4612 ../fish/guestfish-actions.pod:3073
12590 "The return value is an integer which C<0> if the operation would succeed, or "
12591 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12595 #: ../src/guestfs-actions.pod:4618
12596 msgid "(Added in 1.0.43)"
12600 #: ../src/guestfs-actions.pod:4620
12601 msgid "guestfs_ntfsresize"
12605 #: ../src/guestfs-actions.pod:4622
12609 " guestfs_ntfsresize (guestfs_h *g,\n"
12610 " const char *device);\n"
12615 #: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3081
12617 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12618 "size of the underlying device. See also L<ntfsresize(8)>."
12622 #: ../src/guestfs-actions.pod:4634
12623 msgid "guestfs_ntfsresize_size"
12627 #: ../src/guestfs-actions.pod:4636
12631 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12632 " const char *device,\n"
12633 " int64_t size);\n"
12638 #: ../src/guestfs-actions.pod:4641
12640 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12641 "to specify the new size (in bytes) explicitly."
12645 #: ../src/guestfs-actions.pod:4646 ../src/guestfs-actions.pod:5082 ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5404 ../src/guestfs-actions.pod:6943
12646 msgid "(Added in 1.3.14)"
12650 #: ../src/guestfs-actions.pod:4648
12651 msgid "guestfs_part_add"
12655 #: ../src/guestfs-actions.pod:4650
12659 " guestfs_part_add (guestfs_h *g,\n"
12660 " const char *device,\n"
12661 " const char *prlogex,\n"
12662 " int64_t startsect,\n"
12663 " int64_t endsect);\n"
12668 #: ../src/guestfs-actions.pod:4657
12670 "This command adds a partition to C<device>. If there is no partition table "
12671 "on the device, call C<guestfs_part_init> first."
12675 #: ../src/guestfs-actions.pod:4660 ../fish/guestfish-actions.pod:3099
12677 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12678 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12679 "C<logical>) and C<e> (or C<extended>) partition types."
12683 #: ../src/guestfs-actions.pod:4665 ../fish/guestfish-actions.pod:3104
12685 "C<startsect> and C<endsect> are the start and end of the partition in "
12686 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12687 "from the end of the disk (C<-1> is the last sector)."
12691 #: ../src/guestfs-actions.pod:4669
12693 "Creating a partition which covers the whole disk is not so easy. Use "
12694 "C<guestfs_part_disk> to do that."
12698 #: ../src/guestfs-actions.pod:4674 ../src/guestfs-actions.pod:4712 ../src/guestfs-actions.pod:4765 ../src/guestfs-actions.pod:4843 ../src/guestfs-actions.pod:4881 ../src/guestfs-actions.pod:4900 ../src/guestfs-actions.pod:4940
12699 msgid "(Added in 1.0.78)"
12703 #: ../src/guestfs-actions.pod:4676
12704 msgid "guestfs_part_del"
12708 #: ../src/guestfs-actions.pod:4678
12712 " guestfs_part_del (guestfs_h *g,\n"
12713 " const char *device,\n"
12719 #: ../src/guestfs-actions.pod:4683 ../fish/guestfish-actions.pod:3115
12720 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12724 #: ../src/guestfs-actions.pod:4685 ../fish/guestfish-actions.pod:3117
12726 "Note that in the case of MBR partitioning, deleting an extended partition "
12727 "also deletes any logical partitions it contains."
12731 #: ../src/guestfs-actions.pod:4693
12732 msgid "guestfs_part_disk"
12736 #: ../src/guestfs-actions.pod:4695
12740 " guestfs_part_disk (guestfs_h *g,\n"
12741 " const char *device,\n"
12742 " const char *parttype);\n"
12747 #: ../src/guestfs-actions.pod:4700
12749 "This command is simply a combination of C<guestfs_part_init> followed by "
12750 "C<guestfs_part_add> to create a single primary partition covering the whole "
12755 #: ../src/guestfs-actions.pod:4704
12757 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12758 "possible values are described in C<guestfs_part_init>."
12762 #: ../src/guestfs-actions.pod:4714
12763 msgid "guestfs_part_get_bootable"
12767 #: ../src/guestfs-actions.pod:4716
12771 " guestfs_part_get_bootable (guestfs_h *g,\n"
12772 " const char *device,\n"
12778 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3139
12780 "This command returns true if the partition C<partnum> on C<device> has the "
12781 "bootable flag set."
12785 #: ../src/guestfs-actions.pod:4724
12786 msgid "See also C<guestfs_part_set_bootable>."
12790 #: ../src/guestfs-actions.pod:4730
12791 msgid "guestfs_part_get_mbr_id"
12795 #: ../src/guestfs-actions.pod:4732
12799 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12800 " const char *device,\n"
12806 #: ../src/guestfs-actions.pod:4737 ../fish/guestfish-actions.pod:3148
12808 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12809 "partition C<partnum>."
12813 #: ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4916
12815 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12816 "undefined results for other partition table types (see "
12817 "C<guestfs_part_get_parttype>)."
12821 #: ../src/guestfs-actions.pod:4748
12822 msgid "guestfs_part_get_parttype"
12826 #: ../src/guestfs-actions.pod:4750
12830 " guestfs_part_get_parttype (guestfs_h *g,\n"
12831 " const char *device);\n"
12836 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3159
12838 "This command examines the partition table on C<device> and returns the "
12839 "partition table type (format) being used."
12843 #: ../src/guestfs-actions.pod:4757
12845 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12846 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12847 "possible, although unusual. See C<guestfs_part_init> for a full list."
12851 #: ../src/guestfs-actions.pod:4767
12852 msgid "guestfs_part_init"
12856 #: ../src/guestfs-actions.pod:4769
12860 " guestfs_part_init (guestfs_h *g,\n"
12861 " const char *device,\n"
12862 " const char *parttype);\n"
12867 #: ../src/guestfs-actions.pod:4774 ../fish/guestfish-actions.pod:3171
12869 "This creates an empty partition table on C<device> of one of the partition "
12870 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12871 "(for large disks)."
12875 #: ../src/guestfs-actions.pod:4778
12877 "Initially there are no partitions. Following this, you should call "
12878 "C<guestfs_part_add> for each partition required."
12882 #: ../src/guestfs-actions.pod:4781 ../fish/guestfish-actions.pod:3178
12883 msgid "Possible values for C<parttype> are:"
12887 #: ../src/guestfs-actions.pod:4785 ../fish/guestfish-actions.pod:3182
12888 msgid "B<efi> | B<gpt>"
12892 #: ../src/guestfs-actions.pod:4787 ../fish/guestfish-actions.pod:3184
12893 msgid "Intel EFI / GPT partition table."
12897 #: ../src/guestfs-actions.pod:4789 ../fish/guestfish-actions.pod:3186
12899 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12900 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12901 "the C<mbr> format."
12905 #: ../src/guestfs-actions.pod:4793 ../fish/guestfish-actions.pod:3190
12906 msgid "B<mbr> | B<msdos>"
12910 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3192
12912 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12913 "Windows. This partition type will B<only> work for device sizes up to 2 "
12914 "TB. For large disks we recommend using C<gpt>."
12918 #: ../src/guestfs-actions.pod:4802 ../fish/guestfish-actions.pod:3199
12919 msgid "Other partition table types that may work but are not supported include:"
12923 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3204
12928 #: ../src/guestfs-actions.pod:4809 ../fish/guestfish-actions.pod:3206
12929 msgid "AIX disk labels."
12933 #: ../src/guestfs-actions.pod:4811 ../fish/guestfish-actions.pod:3208
12934 msgid "B<amiga> | B<rdb>"
12938 #: ../src/guestfs-actions.pod:4813 ../fish/guestfish-actions.pod:3210
12939 msgid "Amiga \"Rigid Disk Block\" format."
12943 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3212
12948 #: ../src/guestfs-actions.pod:4817 ../fish/guestfish-actions.pod:3214
12949 msgid "BSD disk labels."
12953 #: ../src/guestfs-actions.pod:4819 ../fish/guestfish-actions.pod:3216
12958 #: ../src/guestfs-actions.pod:4821 ../fish/guestfish-actions.pod:3218
12959 msgid "DASD, used on IBM mainframes."
12963 #: ../src/guestfs-actions.pod:4823 ../fish/guestfish-actions.pod:3220
12968 #: ../src/guestfs-actions.pod:4825 ../fish/guestfish-actions.pod:3222
12969 msgid "MIPS/SGI volumes."
12973 #: ../src/guestfs-actions.pod:4827 ../fish/guestfish-actions.pod:3224
12978 #: ../src/guestfs-actions.pod:4829 ../fish/guestfish-actions.pod:3226
12979 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12983 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:3228
12988 #: ../src/guestfs-actions.pod:4833 ../fish/guestfish-actions.pod:3230
12989 msgid "NEC PC-98 format, common in Japan apparently."
12993 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3232
12998 #: ../src/guestfs-actions.pod:4837 ../fish/guestfish-actions.pod:3234
12999 msgid "Sun disk labels."
13003 #: ../src/guestfs-actions.pod:4845
13004 msgid "guestfs_part_list"
13008 #: ../src/guestfs-actions.pod:4847
13011 " struct guestfs_partition_list *\n"
13012 " guestfs_part_list (guestfs_h *g,\n"
13013 " const char *device);\n"
13018 #: ../src/guestfs-actions.pod:4851 ../fish/guestfish-actions.pod:3242
13020 "This command parses the partition table on C<device> and returns the list of "
13021 "partitions found."
13025 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3245
13026 msgid "The fields in the returned structure are:"
13030 #: ../src/guestfs-actions.pod:4858 ../fish/guestfish-actions.pod:3249
13031 msgid "B<part_num>"
13035 #: ../src/guestfs-actions.pod:4860 ../fish/guestfish-actions.pod:3251
13036 msgid "Partition number, counting from 1."
13040 #: ../src/guestfs-actions.pod:4862 ../fish/guestfish-actions.pod:3253
13041 msgid "B<part_start>"
13045 #: ../src/guestfs-actions.pod:4864
13047 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13048 "the device's sector size, see C<guestfs_blockdev_getss>."
13052 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3258
13053 msgid "B<part_end>"
13057 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3260
13058 msgid "End of the partition in bytes."
13062 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3262
13063 msgid "B<part_size>"
13067 #: ../src/guestfs-actions.pod:4873 ../fish/guestfish-actions.pod:3264
13068 msgid "Size of the partition in bytes."
13072 #: ../src/guestfs-actions.pod:4877
13074 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13075 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13080 #: ../src/guestfs-actions.pod:4883
13081 msgid "guestfs_part_set_bootable"
13085 #: ../src/guestfs-actions.pod:4885
13089 " guestfs_part_set_bootable (guestfs_h *g,\n"
13090 " const char *device,\n"
13092 " int bootable);\n"
13097 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3272
13099 "This sets the bootable flag on partition numbered C<partnum> on device "
13100 "C<device>. Note that partitions are numbered from 1."
13104 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3275
13106 "The bootable flag is used by some operating systems (notably Windows) to "
13107 "determine which partition to boot from. It is by no means universally "
13112 #: ../src/guestfs-actions.pod:4902
13113 msgid "guestfs_part_set_mbr_id"
13117 #: ../src/guestfs-actions.pod:4904
13121 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13122 " const char *device,\n"
13129 #: ../src/guestfs-actions.pod:4910 ../fish/guestfish-actions.pod:3283
13131 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13132 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13133 "documentation are in fact hexadecimal numbers, but usually documented "
13134 "without any leading \"0x\" which might be confusing."
13138 #: ../src/guestfs-actions.pod:4924
13139 msgid "guestfs_part_set_name"
13143 #: ../src/guestfs-actions.pod:4926
13147 " guestfs_part_set_name (guestfs_h *g,\n"
13148 " const char *device,\n"
13150 " const char *name);\n"
13155 #: ../src/guestfs-actions.pod:4932 ../fish/guestfish-actions.pod:3297
13157 "This sets the partition name on partition numbered C<partnum> on device "
13158 "C<device>. Note that partitions are numbered from 1."
13162 #: ../src/guestfs-actions.pod:4935 ../fish/guestfish-actions.pod:3300
13164 "The partition name can only be set on certain types of partition table. "
13165 "This works on C<gpt> but not on C<mbr> partitions."
13169 #: ../src/guestfs-actions.pod:4942
13170 msgid "guestfs_part_to_dev"
13174 #: ../src/guestfs-actions.pod:4944
13178 " guestfs_part_to_dev (guestfs_h *g,\n"
13179 " const char *partition);\n"
13184 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3307
13186 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13187 "partition number, returning the device name (eg. \"/dev/sdb\")."
13191 #: ../src/guestfs-actions.pod:4952
13193 "The named partition must exist, for example as a string returned from "
13194 "C<guestfs_list_partitions>."
13198 #: ../src/guestfs-actions.pod:4960
13199 msgid "guestfs_ping_daemon"
13203 #: ../src/guestfs-actions.pod:4962
13207 " guestfs_ping_daemon (guestfs_h *g);\n"
13212 #: ../src/guestfs-actions.pod:4965 ../fish/guestfish-actions.pod:3318
13214 "This is a test probe into the guestfs daemon running inside the qemu "
13215 "subprocess. Calling this function checks that the daemon responds to the "
13216 "ping message, without affecting the daemon or attached block device(s) in "
13221 #: ../src/guestfs-actions.pod:4974
13222 msgid "guestfs_pread"
13226 #: ../src/guestfs-actions.pod:4976
13230 " guestfs_pread (guestfs_h *g,\n"
13231 " const char *path,\n"
13233 " int64_t offset,\n"
13234 " size_t *size_r);\n"
13239 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3327
13241 "This command lets you read part of a file. It reads C<count> bytes of the "
13242 "file, starting at C<offset>, from file C<path>."
13246 #: ../src/guestfs-actions.pod:4986 ../src/guestfs-actions.pod:5012 ../fish/guestfish-actions.pod:3330 ../fish/guestfish-actions.pod:3345
13248 "This may read fewer bytes than requested. For further details see the "
13249 "L<pread(2)> system call."
13253 #: ../src/guestfs-actions.pod:4989
13254 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
13258 #: ../src/guestfs-actions.pod:5000
13259 msgid "guestfs_pread_device"
13263 #: ../src/guestfs-actions.pod:5002
13267 " guestfs_pread_device (guestfs_h *g,\n"
13268 " const char *device,\n"
13270 " int64_t offset,\n"
13271 " size_t *size_r);\n"
13276 #: ../src/guestfs-actions.pod:5009 ../fish/guestfish-actions.pod:3342
13278 "This command lets you read part of a file. It reads C<count> bytes of "
13279 "C<device>, starting at C<offset>."
13283 #: ../src/guestfs-actions.pod:5015
13284 msgid "See also C<guestfs_pread>."
13288 #: ../src/guestfs-actions.pod:5024
13289 msgid "(Added in 1.5.21)"
13293 #: ../src/guestfs-actions.pod:5026
13294 msgid "guestfs_pvcreate"
13298 #: ../src/guestfs-actions.pod:5028
13302 " guestfs_pvcreate (guestfs_h *g,\n"
13303 " const char *device);\n"
13308 #: ../src/guestfs-actions.pod:5032 ../fish/guestfish-actions.pod:3357
13310 "This creates an LVM physical volume on the named C<device>, where C<device> "
13311 "should usually be a partition name such as C</dev/sda1>."
13315 #: ../src/guestfs-actions.pod:5040
13316 msgid "guestfs_pvremove"
13320 #: ../src/guestfs-actions.pod:5042
13324 " guestfs_pvremove (guestfs_h *g,\n"
13325 " const char *device);\n"
13330 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3365
13332 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13337 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3368
13339 "The implementation uses the C<pvremove> command which refuses to wipe "
13340 "physical volumes that contain any volume groups, so you have to remove those "
13345 #: ../src/guestfs-actions.pod:5057
13346 msgid "guestfs_pvresize"
13350 #: ../src/guestfs-actions.pod:5059
13354 " guestfs_pvresize (guestfs_h *g,\n"
13355 " const char *device);\n"
13360 #: ../src/guestfs-actions.pod:5063 ../fish/guestfish-actions.pod:3376
13362 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13363 "the new size of the underlying device."
13367 #: ../src/guestfs-actions.pod:5070
13368 msgid "guestfs_pvresize_size"
13372 #: ../src/guestfs-actions.pod:5072
13376 " guestfs_pvresize_size (guestfs_h *g,\n"
13377 " const char *device,\n"
13378 " int64_t size);\n"
13383 #: ../src/guestfs-actions.pod:5077
13385 "This command is the same as C<guestfs_pvresize> except that it allows you to "
13386 "specify the new size (in bytes) explicitly."
13390 #: ../src/guestfs-actions.pod:5084
13391 msgid "guestfs_pvs"
13395 #: ../src/guestfs-actions.pod:5086
13399 " guestfs_pvs (guestfs_h *g);\n"
13404 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3390
13406 "List all the physical volumes detected. This is the equivalent of the "
13407 "L<pvs(8)> command."
13411 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3393
13413 "This returns a list of just the device names that contain PVs "
13414 "(eg. C</dev/sda2>)."
13418 #: ../src/guestfs-actions.pod:5095
13419 msgid "See also C<guestfs_pvs_full>."
13423 #: ../src/guestfs-actions.pod:5103
13424 msgid "guestfs_pvs_full"
13428 #: ../src/guestfs-actions.pod:5105
13431 " struct guestfs_lvm_pv_list *\n"
13432 " guestfs_pvs_full (guestfs_h *g);\n"
13437 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3402
13439 "List all the physical volumes detected. This is the equivalent of the "
13440 "L<pvs(8)> command. The \"full\" version includes all fields."
13444 #: ../src/guestfs-actions.pod:5111
13446 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
13447 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
13452 #: ../src/guestfs-actions.pod:5117
13453 msgid "guestfs_pvuuid"
13457 #: ../src/guestfs-actions.pod:5119
13461 " guestfs_pvuuid (guestfs_h *g,\n"
13462 " const char *device);\n"
13467 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3409
13468 msgid "This command returns the UUID of the LVM PV C<device>."
13472 #: ../src/guestfs-actions.pod:5130
13473 msgid "guestfs_pwrite"
13477 #: ../src/guestfs-actions.pod:5132
13481 " guestfs_pwrite (guestfs_h *g,\n"
13482 " const char *path,\n"
13483 " const char *content,\n"
13484 " size_t content_size,\n"
13485 " int64_t offset);\n"
13490 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3415
13492 "This command writes to part of a file. It writes the data buffer C<content> "
13493 "to the file C<path> starting at offset C<offset>."
13497 #: ../src/guestfs-actions.pod:5142 ../fish/guestfish-actions.pod:3418
13499 "This command implements the L<pwrite(2)> system call, and like that system "
13500 "call it may not write the full data requested. The return value is the "
13501 "number of bytes that were actually written to the file. This could even be "
13502 "0, although short writes are unlikely for regular files in ordinary "
13507 #: ../src/guestfs-actions.pod:5148
13508 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
13512 #: ../src/guestfs-actions.pod:5157
13513 msgid "guestfs_pwrite_device"
13517 #: ../src/guestfs-actions.pod:5159
13521 " guestfs_pwrite_device (guestfs_h *g,\n"
13522 " const char *device,\n"
13523 " const char *content,\n"
13524 " size_t content_size,\n"
13525 " int64_t offset);\n"
13530 #: ../src/guestfs-actions.pod:5166 ../fish/guestfish-actions.pod:3433
13532 "This command writes to part of a device. It writes the data buffer "
13533 "C<content> to C<device> starting at offset C<offset>."
13537 #: ../src/guestfs-actions.pod:5169 ../fish/guestfish-actions.pod:3436
13539 "This command implements the L<pwrite(2)> system call, and like that system "
13540 "call it may not write the full data requested (although short writes to disk "
13541 "devices and partitions are probably impossible with standard Linux kernels)."
13545 #: ../src/guestfs-actions.pod:5174
13546 msgid "See also C<guestfs_pwrite>."
13550 #: ../src/guestfs-actions.pod:5181
13551 msgid "(Added in 1.5.20)"
13555 #: ../src/guestfs-actions.pod:5183
13556 msgid "guestfs_read_file"
13560 #: ../src/guestfs-actions.pod:5185
13564 " guestfs_read_file (guestfs_h *g,\n"
13565 " const char *path,\n"
13566 " size_t *size_r);\n"
13571 #: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:3450
13572 msgid "This calls returns the contents of the file C<path> as a buffer."
13576 #: ../src/guestfs-actions.pod:5193
13578 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13579 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13580 "function is limited in the total size of file that can be handled."
13584 #: ../src/guestfs-actions.pod:5205
13585 msgid "(Added in 1.0.63)"
13589 #: ../src/guestfs-actions.pod:5207
13590 msgid "guestfs_read_lines"
13594 #: ../src/guestfs-actions.pod:5209
13598 " guestfs_read_lines (guestfs_h *g,\n"
13599 " const char *path);\n"
13604 #: ../src/guestfs-actions.pod:5215 ../fish/guestfish-actions.pod:3467
13606 "The file contents are returned as a list of lines. Trailing C<LF> and "
13607 "C<CRLF> character sequences are I<not> returned."
13611 #: ../src/guestfs-actions.pod:5218
13613 "Note that this function cannot correctly handle binary files (specifically, "
13614 "files containing C<\\0> character which is treated as end of line). For "
13615 "those you need to use the C<guestfs_read_file> function which has a more "
13616 "complex interface."
13620 #: ../src/guestfs-actions.pod:5229
13621 msgid "guestfs_readdir"
13625 #: ../src/guestfs-actions.pod:5231
13628 " struct guestfs_dirent_list *\n"
13629 " guestfs_readdir (guestfs_h *g,\n"
13630 " const char *dir);\n"
13635 #: ../src/guestfs-actions.pod:5235 ../fish/guestfish-actions.pod:3479
13636 msgid "This returns the list of directory entries in directory C<dir>."
13640 #: ../src/guestfs-actions.pod:5237 ../fish/guestfish-actions.pod:3481
13642 "All entries in the directory are returned, including C<.> and C<..>. The "
13643 "entries are I<not> sorted, but returned in the same order as the underlying "
13648 #: ../src/guestfs-actions.pod:5241 ../fish/guestfish-actions.pod:3485
13650 "Also this call returns basic file type information about each file. The "
13651 "C<ftyp> field will contain one of the following characters:"
13655 #: ../src/guestfs-actions.pod:5246 ../fish/guestfish-actions.pod:3490
13660 #: ../src/guestfs-actions.pod:5248 ../fish/guestfish-actions.pod:3492
13661 msgid "Block special"
13665 #: ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3494
13670 #: ../src/guestfs-actions.pod:5252 ../fish/guestfish-actions.pod:3496
13671 msgid "Char special"
13675 #: ../src/guestfs-actions.pod:5254 ../fish/guestfish-actions.pod:3498
13680 #: ../src/guestfs-actions.pod:5256 ../fish/guestfish-actions.pod:3500
13685 #: ../src/guestfs-actions.pod:5258 ../fish/guestfish-actions.pod:3502
13690 #: ../src/guestfs-actions.pod:5260 ../fish/guestfish-actions.pod:3504
13691 msgid "FIFO (named pipe)"
13695 #: ../src/guestfs-actions.pod:5262 ../fish/guestfish-actions.pod:3506
13700 #: ../src/guestfs-actions.pod:5264 ../fish/guestfish-actions.pod:3508
13701 msgid "Symbolic link"
13705 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3510
13710 #: ../src/guestfs-actions.pod:5268 ../fish/guestfish-actions.pod:3512
13711 msgid "Regular file"
13715 #: ../src/guestfs-actions.pod:5270 ../fish/guestfish-actions.pod:3514
13720 #: ../src/guestfs-actions.pod:5272 ../fish/guestfish-actions.pod:3516
13725 #: ../src/guestfs-actions.pod:5274 ../fish/guestfish-actions.pod:3518
13730 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3520
13731 msgid "Unknown file type"
13735 #: ../src/guestfs-actions.pod:5278 ../fish/guestfish-actions.pod:3522
13740 #: ../src/guestfs-actions.pod:5280 ../fish/guestfish-actions.pod:3524
13741 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13745 #: ../src/guestfs-actions.pod:5285
13747 "This function is primarily intended for use by programs. To get a simple "
13748 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13749 "consumption, use C<guestfs_ll>."
13753 #: ../src/guestfs-actions.pod:5289
13755 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13756 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
13761 #: ../src/guestfs-actions.pod:5295
13762 msgid "guestfs_readlink"
13766 #: ../src/guestfs-actions.pod:5297
13770 " guestfs_readlink (guestfs_h *g,\n"
13771 " const char *path);\n"
13776 #: ../src/guestfs-actions.pod:5301 ../fish/guestfish-actions.pod:3537
13777 msgid "This command reads the target of a symbolic link."
13781 #: ../src/guestfs-actions.pod:5308
13782 msgid "guestfs_readlinklist"
13786 #: ../src/guestfs-actions.pod:5310
13790 " guestfs_readlinklist (guestfs_h *g,\n"
13791 " const char *path,\n"
13792 " char *const *names);\n"
13797 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3543
13799 "This call allows you to do a C<readlink> operation on multiple files, where "
13800 "all files are in the directory C<path>. C<names> is the list of files from "
13805 #: ../src/guestfs-actions.pod:5319 ../fish/guestfish-actions.pod:3547
13807 "On return you get a list of strings, with a one-to-one correspondence to the "
13808 "C<names> list. Each string is the value of the symbolic link."
13812 #: ../src/guestfs-actions.pod:5323 ../fish/guestfish-actions.pod:3551
13814 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13815 "result string is the empty string C<\"\">. However the whole operation is "
13816 "completed even if there were C<readlink(2)> errors, and so you can call this "
13817 "function with names where you don't know if they are symbolic links already "
13818 "(albeit slightly less efficient)."
13822 #: ../src/guestfs-actions.pod:5330 ../fish/guestfish-actions.pod:3558
13824 "This call is intended for programs that want to efficiently list a directory "
13825 "contents without making many round-trips. Very long directory listings "
13826 "might cause the protocol message size to be exceeded, causing this call to "
13827 "fail. The caller must split up such requests into smaller groups of names."
13831 #: ../src/guestfs-actions.pod:5343
13832 msgid "guestfs_realpath"
13836 #: ../src/guestfs-actions.pod:5345
13840 " guestfs_realpath (guestfs_h *g,\n"
13841 " const char *path);\n"
13846 #: ../src/guestfs-actions.pod:5349 ../fish/guestfish-actions.pod:3569
13848 "Return the canonicalized absolute pathname of C<path>. The returned path "
13849 "has no C<.>, C<..> or symbolic link path elements."
13853 #: ../src/guestfs-actions.pod:5357
13854 msgid "guestfs_removexattr"
13858 #: ../src/guestfs-actions.pod:5359
13862 " guestfs_removexattr (guestfs_h *g,\n"
13863 " const char *xattr,\n"
13864 " const char *path);\n"
13869 #: ../src/guestfs-actions.pod:5364 ../fish/guestfish-actions.pod:3576
13870 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
13874 #: ../src/guestfs-actions.pod:5367
13875 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13879 #: ../src/guestfs-actions.pod:5373
13880 msgid "guestfs_resize2fs"
13884 #: ../src/guestfs-actions.pod:5375
13888 " guestfs_resize2fs (guestfs_h *g,\n"
13889 " const char *device);\n"
13894 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3585
13896 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13897 "underlying device."
13901 #: ../src/guestfs-actions.pod:5382
13903 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13904 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13905 "sometimes gives an error about this and sometimes not. In any case, it is "
13906 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13910 #: ../src/guestfs-actions.pod:5392
13911 msgid "guestfs_resize2fs_size"
13915 #: ../src/guestfs-actions.pod:5394
13919 " guestfs_resize2fs_size (guestfs_h *g,\n"
13920 " const char *device,\n"
13921 " int64_t size);\n"
13926 #: ../src/guestfs-actions.pod:5399
13928 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13929 "to specify the new size (in bytes) explicitly."
13933 #: ../src/guestfs-actions.pod:5406
13938 #: ../src/guestfs-actions.pod:5408
13942 " guestfs_rm (guestfs_h *g,\n"
13943 " const char *path);\n"
13948 #: ../src/guestfs-actions.pod:5412 ../fish/guestfish-actions.pod:3605
13949 msgid "Remove the single file C<path>."
13953 #: ../src/guestfs-actions.pod:5418
13954 msgid "guestfs_rm_rf"
13958 #: ../src/guestfs-actions.pod:5420
13962 " guestfs_rm_rf (guestfs_h *g,\n"
13963 " const char *path);\n"
13968 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3611
13970 "Remove the file or directory C<path>, recursively removing the contents if "
13971 "its a directory. This is like the C<rm -rf> shell command."
13975 #: ../src/guestfs-actions.pod:5432
13976 msgid "guestfs_rmdir"
13980 #: ../src/guestfs-actions.pod:5434
13984 " guestfs_rmdir (guestfs_h *g,\n"
13985 " const char *path);\n"
13990 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3619
13991 msgid "Remove the single directory C<path>."
13995 #: ../src/guestfs-actions.pod:5444
13996 msgid "guestfs_rmmountpoint"
14000 #: ../src/guestfs-actions.pod:5446
14004 " guestfs_rmmountpoint (guestfs_h *g,\n"
14005 " const char *exemptpath);\n"
14010 #: ../src/guestfs-actions.pod:5450
14012 "This calls removes a mountpoint that was previously created with "
14013 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14017 #: ../src/guestfs-actions.pod:5458
14018 msgid "guestfs_scrub_device"
14022 #: ../src/guestfs-actions.pod:5460
14026 " guestfs_scrub_device (guestfs_h *g,\n"
14027 " const char *device);\n"
14032 #: ../src/guestfs-actions.pod:5464 ../fish/guestfish-actions.pod:3633
14034 "This command writes patterns over C<device> to make data retrieval more "
14039 #: ../src/guestfs-actions.pod:5467 ../src/guestfs-actions.pod:5488 ../src/guestfs-actions.pod:5507 ../fish/guestfish-actions.pod:3636 ../fish/guestfish-actions.pod:3651 ../fish/guestfish-actions.pod:3664
14041 "It is an interface to the L<scrub(1)> program. See that manual page for "
14046 #: ../src/guestfs-actions.pod:5475 ../src/guestfs-actions.pod:5493 ../src/guestfs-actions.pod:5512
14047 msgid "(Added in 1.0.52)"
14051 #: ../src/guestfs-actions.pod:5477
14052 msgid "guestfs_scrub_file"
14056 #: ../src/guestfs-actions.pod:5479
14060 " guestfs_scrub_file (guestfs_h *g,\n"
14061 " const char *file);\n"
14066 #: ../src/guestfs-actions.pod:5483 ../fish/guestfish-actions.pod:3646
14068 "This command writes patterns over a file to make data retrieval more "
14073 #: ../src/guestfs-actions.pod:5486 ../fish/guestfish-actions.pod:3649
14074 msgid "The file is I<removed> after scrubbing."
14078 #: ../src/guestfs-actions.pod:5495
14079 msgid "guestfs_scrub_freespace"
14083 #: ../src/guestfs-actions.pod:5497
14087 " guestfs_scrub_freespace (guestfs_h *g,\n"
14088 " const char *dir);\n"
14093 #: ../src/guestfs-actions.pod:5501
14095 "This command creates the directory C<dir> and then fills it with files until "
14096 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14097 "and deletes them. The intention is to scrub any free space on the partition "
14098 "containing C<dir>."
14102 #: ../src/guestfs-actions.pod:5514
14103 msgid "guestfs_set_append"
14107 #: ../src/guestfs-actions.pod:5516
14111 " guestfs_set_append (guestfs_h *g,\n"
14112 " const char *append);\n"
14117 #: ../src/guestfs-actions.pod:5520 ../fish/guestfish-actions.pod:3673
14119 "This function is used to add additional options to the guest kernel command "
14124 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3676
14126 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14127 "environment variable."
14131 #: ../src/guestfs-actions.pod:5526 ../fish/guestfish-actions.pod:3679
14133 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14134 "(libguestfs always adds a few of its own)."
14138 #: ../src/guestfs-actions.pod:5533
14139 msgid "guestfs_set_autosync"
14143 #: ../src/guestfs-actions.pod:5535
14147 " guestfs_set_autosync (guestfs_h *g,\n"
14148 " int autosync);\n"
14153 #: ../src/guestfs-actions.pod:5539
14155 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14156 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
14157 "the handle is closed (also if the program exits without closing handles)."
14161 #: ../src/guestfs-actions.pod:5544 ../fish/guestfish-actions.pod:3693
14163 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14164 "disabled by default)."
14168 #: ../src/guestfs-actions.pod:5551
14169 msgid "guestfs_set_direct"
14173 #: ../src/guestfs-actions.pod:5553
14177 " guestfs_set_direct (guestfs_h *g,\n"
14183 #: ../src/guestfs-actions.pod:5557 ../fish/guestfish-actions.pod:3702
14185 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14186 "passed directly through to the appliance once it is launched."
14190 #: ../src/guestfs-actions.pod:5561
14192 "One consequence of this is that log messages aren't caught by the library "
14193 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
14198 #: ../src/guestfs-actions.pod:5565 ../fish/guestfish-actions.pod:3710
14199 msgid "You probably don't want to use this unless you know what you are doing."
14203 #: ../src/guestfs-actions.pod:5568 ../fish/guestfish-actions.pod:3713
14204 msgid "The default is disabled."
14208 #: ../src/guestfs-actions.pod:5574
14209 msgid "guestfs_set_e2label"
14213 #: ../src/guestfs-actions.pod:5576
14217 " guestfs_set_e2label (guestfs_h *g,\n"
14218 " const char *device,\n"
14219 " const char *label);\n"
14224 #: ../src/guestfs-actions.pod:5581 ../fish/guestfish-actions.pod:3719
14226 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14227 "C<label>. Filesystem labels are limited to 16 characters."
14231 #: ../src/guestfs-actions.pod:5585
14233 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
14234 "the existing label on a filesystem."
14238 #: ../src/guestfs-actions.pod:5592
14239 msgid "guestfs_set_e2uuid"
14243 #: ../src/guestfs-actions.pod:5594
14247 " guestfs_set_e2uuid (guestfs_h *g,\n"
14248 " const char *device,\n"
14249 " const char *uuid);\n"
14254 #: ../src/guestfs-actions.pod:5599 ../fish/guestfish-actions.pod:3730
14256 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14257 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14258 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14262 #: ../src/guestfs-actions.pod:5604
14264 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
14265 "the existing UUID of a filesystem."
14269 #: ../src/guestfs-actions.pod:5611
14270 msgid "guestfs_set_memsize"
14274 #: ../src/guestfs-actions.pod:5613
14278 " guestfs_set_memsize (guestfs_h *g,\n"
14284 #: ../src/guestfs-actions.pod:5617
14286 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14287 "This only has any effect if called before C<guestfs_launch>."
14291 #: ../src/guestfs-actions.pod:5621 ../fish/guestfish-actions.pod:3748
14293 "You can also change this by setting the environment variable "
14294 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14298 #: ../src/guestfs-actions.pod:5632
14299 msgid "guestfs_set_network"
14303 #: ../src/guestfs-actions.pod:5634
14307 " guestfs_set_network (guestfs_h *g,\n"
14313 #: ../src/guestfs-actions.pod:5638 ../fish/guestfish-actions.pod:3761
14315 "If C<network> is true, then the network is enabled in the libguestfs "
14316 "appliance. The default is false."
14320 #: ../src/guestfs-actions.pod:5641 ../fish/guestfish-actions.pod:3764
14322 "This affects whether commands are able to access the network (see "
14323 "L<guestfs(3)/RUNNING COMMANDS>)."
14327 #: ../src/guestfs-actions.pod:5644
14329 "You must call this before calling C<guestfs_launch>, otherwise it has no "
14334 #: ../src/guestfs-actions.pod:5651
14335 msgid "guestfs_set_path"
14339 #: ../src/guestfs-actions.pod:5653
14343 " guestfs_set_path (guestfs_h *g,\n"
14344 " const char *searchpath);\n"
14349 #: ../src/guestfs-actions.pod:5657 ../fish/guestfish-actions.pod:3776
14350 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14354 #: ../src/guestfs-actions.pod:5659 ../fish/guestfish-actions.pod:3778
14356 "The default is C<$libdir/guestfs> unless overridden by setting "
14357 "C<LIBGUESTFS_PATH> environment variable."
14361 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3781
14362 msgid "Setting C<path> to C<NULL> restores the default path."
14366 #: ../src/guestfs-actions.pod:5668
14367 msgid "guestfs_set_qemu"
14371 #: ../src/guestfs-actions.pod:5670
14375 " guestfs_set_qemu (guestfs_h *g,\n"
14376 " const char *qemu);\n"
14381 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3789
14382 msgid "Set the qemu binary that we will use."
14386 #: ../src/guestfs-actions.pod:5676 ../fish/guestfish-actions.pod:3791
14387 msgid "The default is chosen when the library was compiled by the configure script."
14391 #: ../src/guestfs-actions.pod:5679 ../fish/guestfish-actions.pod:3794
14393 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14398 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3797
14399 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14403 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3799
14405 "Note that you should call this function as early as possible after creating "
14406 "the handle. This is because some pre-launch operations depend on testing "
14407 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14408 "don't retest features, and so you might see inconsistent results. Using the "
14409 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14410 "the qemu binary at the same time as the handle is created."
14414 #: ../src/guestfs-actions.pod:5696
14415 msgid "guestfs_set_recovery_proc"
14419 #: ../src/guestfs-actions.pod:5698
14423 " guestfs_set_recovery_proc (guestfs_h *g,\n"
14424 " int recoveryproc);\n"
14429 #: ../src/guestfs-actions.pod:5702
14431 "If this is called with the parameter C<false> then C<guestfs_launch> does "
14432 "not create a recovery process. The purpose of the recovery process is to "
14433 "stop runaway qemu processes in the case where the main program aborts "
14438 #: ../src/guestfs-actions.pod:5707
14440 "This only has any effect if called before C<guestfs_launch>, and the default "
14445 #: ../src/guestfs-actions.pod:5710 ../fish/guestfish-actions.pod:3821
14447 "About the only time when you would want to disable this is if the main "
14448 "process will fork itself into the background (\"daemonize\" itself). In "
14449 "this case the recovery process thinks that the main program has disappeared "
14450 "and so kills qemu, which is not very helpful."
14454 #: ../src/guestfs-actions.pod:5720
14455 msgid "guestfs_set_selinux"
14459 #: ../src/guestfs-actions.pod:5722
14463 " guestfs_set_selinux (guestfs_h *g,\n"
14469 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3833
14471 "This sets the selinux flag that is passed to the appliance at boot time. "
14472 "The default is C<selinux=0> (disabled)."
14476 #: ../src/guestfs-actions.pod:5729 ../fish/guestfish-actions.pod:3836
14478 "Note that if SELinux is enabled, it is always in Permissive mode "
14479 "(C<enforcing=0>)."
14483 #: ../src/guestfs-actions.pod:5739
14484 msgid "guestfs_set_trace"
14488 #: ../src/guestfs-actions.pod:5741
14492 " guestfs_set_trace (guestfs_h *g,\n"
14498 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3848
14500 "If the command trace flag is set to 1, then commands are printed on stderr "
14501 "before they are executed in a format which is very similar to the one used "
14502 "by guestfish. In other words, you can run a program with this enabled, and "
14503 "you will get out a script which you can feed to guestfish to perform the "
14504 "same set of actions."
14508 #: ../src/guestfs-actions.pod:5752 ../fish/guestfish-actions.pod:3855
14510 "If you want to trace C API calls into libguestfs (and other libraries) then "
14511 "possibly a better way is to use the external ltrace(1) command."
14515 #: ../src/guestfs-actions.pod:5756 ../fish/guestfish-actions.pod:3859
14517 "Command traces are disabled unless the environment variable "
14518 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14522 #: ../src/guestfs-actions.pod:5763
14523 msgid "guestfs_set_verbose"
14527 #: ../src/guestfs-actions.pod:5765
14531 " guestfs_set_verbose (guestfs_h *g,\n"
14537 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3868
14538 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
14542 #: ../src/guestfs-actions.pod:5771 ../fish/guestfish-actions.pod:3870
14544 "Verbose messages are disabled unless the environment variable "
14545 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14549 #: ../src/guestfs-actions.pod:5778
14550 msgid "guestfs_setcon"
14554 #: ../src/guestfs-actions.pod:5780
14558 " guestfs_setcon (guestfs_h *g,\n"
14559 " const char *context);\n"
14564 #: ../src/guestfs-actions.pod:5784 ../fish/guestfish-actions.pod:3877
14566 "This sets the SELinux security context of the daemon to the string "
14571 #: ../src/guestfs-actions.pod:5787 ../fish/guestfish-actions.pod:3880
14572 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14576 #: ../src/guestfs-actions.pod:5793
14577 msgid "guestfs_setxattr"
14581 #: ../src/guestfs-actions.pod:5795
14585 " guestfs_setxattr (guestfs_h *g,\n"
14586 " const char *xattr,\n"
14587 " const char *val,\n"
14589 " const char *path);\n"
14594 #: ../src/guestfs-actions.pod:5802 ../fish/guestfish-actions.pod:3886
14596 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14597 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14601 #: ../src/guestfs-actions.pod:5806
14602 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14606 #: ../src/guestfs-actions.pod:5812
14607 msgid "guestfs_sfdisk"
14611 #: ../src/guestfs-actions.pod:5814
14615 " guestfs_sfdisk (guestfs_h *g,\n"
14616 " const char *device,\n"
14620 " char *const *lines);\n"
14625 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3896
14627 "This is a direct interface to the L<sfdisk(8)> program for creating "
14628 "partitions on block devices."
14632 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3899
14633 msgid "C<device> should be a block device, for example C</dev/sda>."
14637 #: ../src/guestfs-actions.pod:5827 ../fish/guestfish-actions.pod:3901
14639 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14640 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14641 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14642 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14643 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14644 "the kernel) cannot work out the right geometry and you will need to tell it."
14648 #: ../src/guestfs-actions.pod:5835 ../fish/guestfish-actions.pod:3909
14650 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14651 "refer to the L<sfdisk(8)> manpage."
14655 #: ../src/guestfs-actions.pod:5838 ../fish/guestfish-actions.pod:3912
14657 "To create a single partition occupying the whole disk, you would pass "
14658 "C<lines> as a single element list, when the single element being the string "
14663 #: ../src/guestfs-actions.pod:5842
14664 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14668 #: ../src/guestfs-actions.pod:5852
14669 msgid "guestfs_sfdiskM"
14673 #: ../src/guestfs-actions.pod:5854
14677 " guestfs_sfdiskM (guestfs_h *g,\n"
14678 " const char *device,\n"
14679 " char *const *lines);\n"
14684 #: ../src/guestfs-actions.pod:5859
14686 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14687 "partition sizes are specified in megabytes only (rounded to the nearest "
14688 "cylinder) and you don't need to specify the cyls, heads and sectors "
14689 "parameters which were rarely if ever used anyway."
14693 #: ../src/guestfs-actions.pod:5865
14695 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14696 "C<guestfs_part_disk>"
14700 #: ../src/guestfs-actions.pod:5875
14701 msgid "guestfs_sfdisk_N"
14705 #: ../src/guestfs-actions.pod:5877
14709 " guestfs_sfdisk_N (guestfs_h *g,\n"
14710 " const char *device,\n"
14715 " const char *line);\n"
14720 #: ../src/guestfs-actions.pod:5886 ../fish/guestfish-actions.pod:3942
14722 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14723 "(note: C<n> counts from 1)."
14727 #: ../src/guestfs-actions.pod:5889
14729 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14730 "for the cyls/heads/sectors parameters."
14734 #: ../src/guestfs-actions.pod:5892
14735 msgid "See also: C<guestfs_part_add>"
14739 #: ../src/guestfs-actions.pod:5901
14740 msgid "guestfs_sfdisk_disk_geometry"
14744 #: ../src/guestfs-actions.pod:5903
14748 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14749 " const char *device);\n"
14754 #: ../src/guestfs-actions.pod:5907
14756 "This displays the disk geometry of C<device> read from the partition table. "
14757 "Especially in the case where the underlying block device has been resized, "
14758 "this can be different from the kernel's idea of the geometry (see "
14759 "C<guestfs_sfdisk_kernel_geometry>)."
14763 #: ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3962 ../fish/guestfish-actions.pod:3971
14764 msgid "The result is in human-readable format, and not designed to be parsed."
14768 #: ../src/guestfs-actions.pod:5920
14769 msgid "guestfs_sfdisk_kernel_geometry"
14773 #: ../src/guestfs-actions.pod:5922
14777 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14778 " const char *device);\n"
14783 #: ../src/guestfs-actions.pod:5926 ../fish/guestfish-actions.pod:3969
14784 msgid "This displays the kernel's idea of the geometry of C<device>."
14788 #: ../src/guestfs-actions.pod:5936
14789 msgid "guestfs_sfdisk_l"
14793 #: ../src/guestfs-actions.pod:5938
14797 " guestfs_sfdisk_l (guestfs_h *g,\n"
14798 " const char *device);\n"
14803 #: ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:3978
14805 "This displays the partition table on C<device>, in the human-readable output "
14806 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14810 #: ../src/guestfs-actions.pod:5946
14811 msgid "See also: C<guestfs_part_list>"
14815 #: ../src/guestfs-actions.pod:5953
14820 #: ../src/guestfs-actions.pod:5955
14824 " guestfs_sh (guestfs_h *g,\n"
14825 " const char *command);\n"
14830 #: ../src/guestfs-actions.pod:5959 ../fish/guestfish-actions.pod:3988
14832 "This call runs a command from the guest filesystem via the guest's "
14837 #: ../src/guestfs-actions.pod:5962
14838 msgid "This is like C<guestfs_command>, but passes the command to:"
14842 #: ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:3993
14845 " /bin/sh -c \"command\"\n"
14850 #: ../src/guestfs-actions.pod:5966 ../fish/guestfish-actions.pod:3995
14852 "Depending on the guest's shell, this usually results in wildcards being "
14853 "expanded, shell expressions being interpolated and so on."
14857 #: ../src/guestfs-actions.pod:5970
14858 msgid "All the provisos about C<guestfs_command> apply to this call."
14862 #: ../src/guestfs-actions.pod:5977
14863 msgid "guestfs_sh_lines"
14867 #: ../src/guestfs-actions.pod:5979
14871 " guestfs_sh_lines (guestfs_h *g,\n"
14872 " const char *command);\n"
14877 #: ../src/guestfs-actions.pod:5983
14879 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14884 #: ../src/guestfs-actions.pod:5986
14885 msgid "See also: C<guestfs_command_lines>"
14889 #: ../src/guestfs-actions.pod:5994
14890 msgid "guestfs_sleep"
14894 #: ../src/guestfs-actions.pod:5996
14898 " guestfs_sleep (guestfs_h *g,\n"
14904 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4014
14905 msgid "Sleep for C<secs> seconds."
14909 #: ../src/guestfs-actions.pod:6004
14910 msgid "(Added in 1.0.41)"
14914 #: ../src/guestfs-actions.pod:6006 ../src/guestfs-structs.pod:109
14915 msgid "guestfs_stat"
14919 #: ../src/guestfs-actions.pod:6008
14922 " struct guestfs_stat *\n"
14923 " guestfs_stat (guestfs_h *g,\n"
14924 " const char *path);\n"
14929 #: ../src/guestfs-actions.pod:6014 ../fish/guestfish-actions.pod:4022
14930 msgid "This is the same as the C<stat(2)> system call."
14934 #: ../src/guestfs-actions.pod:6022 ../src/guestfs-structs.pod:135
14935 msgid "guestfs_statvfs"
14939 #: ../src/guestfs-actions.pod:6024
14942 " struct guestfs_statvfs *\n"
14943 " guestfs_statvfs (guestfs_h *g,\n"
14944 " const char *path);\n"
14949 #: ../src/guestfs-actions.pod:6028 ../fish/guestfish-actions.pod:4028
14951 "Returns file system statistics for any mounted file system. C<path> should "
14952 "be a file or directory in the mounted file system (typically it is the mount "
14953 "point itself, but it doesn't need to be)."
14957 #: ../src/guestfs-actions.pod:6032 ../fish/guestfish-actions.pod:4032
14958 msgid "This is the same as the C<statvfs(2)> system call."
14962 #: ../src/guestfs-actions.pod:6034
14964 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14965 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14969 #: ../src/guestfs-actions.pod:6040
14970 msgid "guestfs_strings"
14974 #: ../src/guestfs-actions.pod:6042
14978 " guestfs_strings (guestfs_h *g,\n"
14979 " const char *path);\n"
14984 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4038
14986 "This runs the L<strings(1)> command on a file and returns the list of "
14987 "printable strings found."
14991 #: ../src/guestfs-actions.pod:6058
14992 msgid "guestfs_strings_e"
14996 #: ../src/guestfs-actions.pod:6060
15000 " guestfs_strings_e (guestfs_h *g,\n"
15001 " const char *encoding,\n"
15002 " const char *path);\n"
15007 #: ../src/guestfs-actions.pod:6065
15009 "This is like the C<guestfs_strings> command, but allows you to specify the "
15010 "encoding of strings that are looked for in the source file C<path>."
15014 #: ../src/guestfs-actions.pod:6069 ../fish/guestfish-actions.pod:4052
15015 msgid "Allowed encodings are:"
15019 #: ../src/guestfs-actions.pod:6073 ../fish/guestfish-actions.pod:4056
15024 #: ../src/guestfs-actions.pod:6075
15026 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15027 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15031 #: ../src/guestfs-actions.pod:6078 ../fish/guestfish-actions.pod:4061
15036 #: ../src/guestfs-actions.pod:6080 ../fish/guestfish-actions.pod:4063
15037 msgid "Single 8-bit-byte characters."
15041 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4065
15046 #: ../src/guestfs-actions.pod:6084 ../fish/guestfish-actions.pod:4067
15047 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15051 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4070
15052 msgid "l (lower case letter L)"
15056 #: ../src/guestfs-actions.pod:6089 ../fish/guestfish-actions.pod:4072
15058 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15059 "examining binaries in Windows guests."
15063 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4075
15068 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4077
15069 msgid "32-bit big endian such as UCS-4BE."
15073 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4079
15078 #: ../src/guestfs-actions.pod:6098 ../fish/guestfish-actions.pod:4081
15079 msgid "32-bit little endian such as UCS-4LE."
15083 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4085
15084 msgid "The returned strings are transcoded to UTF-8."
15088 #: ../src/guestfs-actions.pod:6113
15089 msgid "guestfs_swapoff_device"
15093 #: ../src/guestfs-actions.pod:6115
15097 " guestfs_swapoff_device (guestfs_h *g,\n"
15098 " const char *device);\n"
15103 #: ../src/guestfs-actions.pod:6119
15105 "This command disables the libguestfs appliance swap device or partition "
15106 "named C<device>. See C<guestfs_swapon_device>."
15110 #: ../src/guestfs-actions.pod:6127
15111 msgid "guestfs_swapoff_file"
15115 #: ../src/guestfs-actions.pod:6129
15119 " guestfs_swapoff_file (guestfs_h *g,\n"
15120 " const char *file);\n"
15125 #: ../src/guestfs-actions.pod:6133 ../fish/guestfish-actions.pod:4102
15126 msgid "This command disables the libguestfs appliance swap on file."
15130 #: ../src/guestfs-actions.pod:6139
15131 msgid "guestfs_swapoff_label"
15135 #: ../src/guestfs-actions.pod:6141
15139 " guestfs_swapoff_label (guestfs_h *g,\n"
15140 " const char *label);\n"
15145 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4108
15147 "This command disables the libguestfs appliance swap on labeled swap "
15152 #: ../src/guestfs-actions.pod:6152
15153 msgid "guestfs_swapoff_uuid"
15157 #: ../src/guestfs-actions.pod:6154
15161 " guestfs_swapoff_uuid (guestfs_h *g,\n"
15162 " const char *uuid);\n"
15167 #: ../src/guestfs-actions.pod:6158 ../fish/guestfish-actions.pod:4115
15169 "This command disables the libguestfs appliance swap partition with the given "
15174 #: ../src/guestfs-actions.pod:6165
15175 msgid "guestfs_swapon_device"
15179 #: ../src/guestfs-actions.pod:6167
15183 " guestfs_swapon_device (guestfs_h *g,\n"
15184 " const char *device);\n"
15189 #: ../src/guestfs-actions.pod:6171
15191 "This command enables the libguestfs appliance to use the swap device or "
15192 "partition named C<device>. The increased memory is made available for all "
15193 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
15197 #: ../src/guestfs-actions.pod:6176 ../fish/guestfish-actions.pod:4127
15199 "Note that you should not swap to existing guest swap partitions unless you "
15200 "know what you are doing. They may contain hibernation information, or other "
15201 "information that the guest doesn't want you to trash. You also risk leaking "
15202 "information about the host to the guest this way. Instead, attach a new "
15203 "host device to the guest and swap on that."
15207 #: ../src/guestfs-actions.pod:6187
15208 msgid "guestfs_swapon_file"
15212 #: ../src/guestfs-actions.pod:6189
15216 " guestfs_swapon_file (guestfs_h *g,\n"
15217 " const char *file);\n"
15222 #: ../src/guestfs-actions.pod:6193
15224 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
15229 #: ../src/guestfs-actions.pod:6200
15230 msgid "guestfs_swapon_label"
15234 #: ../src/guestfs-actions.pod:6202
15238 " guestfs_swapon_label (guestfs_h *g,\n"
15239 " const char *label);\n"
15244 #: ../src/guestfs-actions.pod:6206
15246 "This command enables swap to a labeled swap partition. See "
15247 "C<guestfs_swapon_device> for other notes."
15251 #: ../src/guestfs-actions.pod:6213
15252 msgid "guestfs_swapon_uuid"
15256 #: ../src/guestfs-actions.pod:6215
15260 " guestfs_swapon_uuid (guestfs_h *g,\n"
15261 " const char *uuid);\n"
15266 #: ../src/guestfs-actions.pod:6219
15268 "This command enables swap to a swap partition with the given UUID. See "
15269 "C<guestfs_swapon_device> for other notes."
15273 #: ../src/guestfs-actions.pod:6226
15274 msgid "guestfs_sync"
15278 #: ../src/guestfs-actions.pod:6228
15282 " guestfs_sync (guestfs_h *g);\n"
15287 #: ../src/guestfs-actions.pod:6231 ../fish/guestfish-actions.pod:4159
15289 "This syncs the disk, so that any writes are flushed through to the "
15290 "underlying disk image."
15294 #: ../src/guestfs-actions.pod:6234 ../fish/guestfish-actions.pod:4162
15296 "You should always call this if you have modified a disk image, before "
15297 "closing the handle."
15301 #: ../src/guestfs-actions.pod:6241
15302 msgid "guestfs_tail"
15306 #: ../src/guestfs-actions.pod:6243
15310 " guestfs_tail (guestfs_h *g,\n"
15311 " const char *path);\n"
15316 #: ../src/guestfs-actions.pod:6247 ../fish/guestfish-actions.pod:4169
15317 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15321 #: ../src/guestfs-actions.pod:6259
15322 msgid "guestfs_tail_n"
15326 #: ../src/guestfs-actions.pod:6261
15330 " guestfs_tail_n (guestfs_h *g,\n"
15332 " const char *path);\n"
15337 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4179
15339 "If the parameter C<nrlines> is a positive number, this returns the last "
15340 "C<nrlines> lines of the file C<path>."
15344 #: ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:4182
15346 "If the parameter C<nrlines> is a negative number, this returns lines from "
15347 "the file C<path>, starting with the C<-nrlines>th line."
15351 #: ../src/guestfs-actions.pod:6283
15352 msgid "guestfs_tar_in"
15356 #: ../src/guestfs-actions.pod:6285
15360 " guestfs_tar_in (guestfs_h *g,\n"
15361 " const char *tarfile,\n"
15362 " const char *directory);\n"
15367 #: ../src/guestfs-actions.pod:6290 ../fish/guestfish-actions.pod:4194
15369 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15370 "tar file) into C<directory>."
15374 #: ../src/guestfs-actions.pod:6293
15375 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
15379 #: ../src/guestfs-actions.pod:6298 ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6347
15380 msgid "(Added in 1.0.3)"
15384 #: ../src/guestfs-actions.pod:6300
15385 msgid "guestfs_tar_out"
15389 #: ../src/guestfs-actions.pod:6302
15393 " guestfs_tar_out (guestfs_h *g,\n"
15394 " const char *directory,\n"
15395 " const char *tarfile);\n"
15400 #: ../src/guestfs-actions.pod:6307 ../fish/guestfish-actions.pod:4206
15402 "This command packs the contents of C<directory> and downloads it to local "
15407 #: ../src/guestfs-actions.pod:6310
15409 "To download a compressed tarball, use C<guestfs_tgz_out> or "
15410 "C<guestfs_txz_out>."
15414 #: ../src/guestfs-actions.pod:6317
15415 msgid "guestfs_tgz_in"
15419 #: ../src/guestfs-actions.pod:6319
15423 " guestfs_tgz_in (guestfs_h *g,\n"
15424 " const char *tarball,\n"
15425 " const char *directory);\n"
15430 #: ../src/guestfs-actions.pod:6324 ../fish/guestfish-actions.pod:4218
15432 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15433 "tar file) into C<directory>."
15437 #: ../src/guestfs-actions.pod:6327
15438 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
15442 #: ../src/guestfs-actions.pod:6333
15443 msgid "guestfs_tgz_out"
15447 #: ../src/guestfs-actions.pod:6335
15451 " guestfs_tgz_out (guestfs_h *g,\n"
15452 " const char *directory,\n"
15453 " const char *tarball);\n"
15458 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4229
15460 "This command packs the contents of C<directory> and downloads it to local "
15465 #: ../src/guestfs-actions.pod:6343
15466 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
15470 #: ../src/guestfs-actions.pod:6349
15471 msgid "guestfs_touch"
15475 #: ../src/guestfs-actions.pod:6351
15479 " guestfs_touch (guestfs_h *g,\n"
15480 " const char *path);\n"
15485 #: ../src/guestfs-actions.pod:6355 ../fish/guestfish-actions.pod:4240
15487 "Touch acts like the L<touch(1)> command. It can be used to update the "
15488 "timestamps on a file, or, if the file does not exist, to create a new "
15489 "zero-length file."
15493 #: ../src/guestfs-actions.pod:6359 ../fish/guestfish-actions.pod:4244
15495 "This command only works on regular files, and will fail on other file types "
15496 "such as directories, symbolic links, block special etc."
15500 #: ../src/guestfs-actions.pod:6366
15501 msgid "guestfs_truncate"
15505 #: ../src/guestfs-actions.pod:6368
15509 " guestfs_truncate (guestfs_h *g,\n"
15510 " const char *path);\n"
15515 #: ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:4251
15517 "This command truncates C<path> to a zero-length file. The file must exist "
15522 #: ../src/guestfs-actions.pod:6379
15523 msgid "guestfs_truncate_size"
15527 #: ../src/guestfs-actions.pod:6381
15531 " guestfs_truncate_size (guestfs_h *g,\n"
15532 " const char *path,\n"
15533 " int64_t size);\n"
15538 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4258
15540 "This command truncates C<path> to size C<size> bytes. The file must exist "
15545 #: ../src/guestfs-actions.pod:6389
15547 "If the current file size is less than C<size> then the file is extended to "
15548 "the required size with zero bytes. This creates a sparse file (ie. disk "
15549 "blocks are not allocated for the file until you write to it). To create a "
15550 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15554 #: ../src/guestfs-actions.pod:6399
15555 msgid "guestfs_tune2fs_l"
15559 #: ../src/guestfs-actions.pod:6401
15563 " guestfs_tune2fs_l (guestfs_h *g,\n"
15564 " const char *device);\n"
15569 #: ../src/guestfs-actions.pod:6405 ../fish/guestfish-actions.pod:4271
15571 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15576 #: ../src/guestfs-actions.pod:6408 ../fish/guestfish-actions.pod:4274
15578 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15579 "for more details. The list of fields returned isn't clearly defined, and "
15580 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15581 "and the filesystem itself."
15585 #: ../src/guestfs-actions.pod:6421
15586 msgid "guestfs_txz_in"
15590 #: ../src/guestfs-actions.pod:6423
15594 " guestfs_txz_in (guestfs_h *g,\n"
15595 " const char *tarball,\n"
15596 " const char *directory);\n"
15601 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4283
15603 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15604 "tar file) into C<directory>."
15608 #: ../src/guestfs-actions.pod:6435
15609 msgid "guestfs_txz_out"
15613 #: ../src/guestfs-actions.pod:6437
15617 " guestfs_txz_out (guestfs_h *g,\n"
15618 " const char *directory,\n"
15619 " const char *tarball);\n"
15624 #: ../src/guestfs-actions.pod:6442 ../fish/guestfish-actions.pod:4292
15626 "This command packs the contents of C<directory> and downloads it to local "
15627 "file C<tarball> (as an xz compressed tar archive)."
15631 #: ../src/guestfs-actions.pod:6449
15632 msgid "guestfs_umask"
15636 #: ../src/guestfs-actions.pod:6451
15640 " guestfs_umask (guestfs_h *g,\n"
15646 #: ../src/guestfs-actions.pod:6455 ../fish/guestfish-actions.pod:4301
15648 "This function sets the mask used for creating new files and device nodes to "
15653 #: ../src/guestfs-actions.pod:6458 ../fish/guestfish-actions.pod:4304
15655 "Typical umask values would be C<022> which creates new files with "
15656 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15657 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15661 #: ../src/guestfs-actions.pod:6463 ../fish/guestfish-actions.pod:4309
15663 "The default umask is C<022>. This is important because it means that "
15664 "directories and device nodes will be created with C<0644> or C<0755> mode "
15665 "even if you specify C<0777>."
15669 #: ../src/guestfs-actions.pod:6467
15671 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15672 "C<guestfs_mkdir>."
15676 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4316
15677 msgid "This call returns the previous umask."
15681 #: ../src/guestfs-actions.pod:6476
15682 msgid "guestfs_umount"
15686 #: ../src/guestfs-actions.pod:6478
15690 " guestfs_umount (guestfs_h *g,\n"
15691 " const char *pathordevice);\n"
15696 #: ../src/guestfs-actions.pod:6482 ../fish/guestfish-actions.pod:4324
15698 "This unmounts the given filesystem. The filesystem may be specified either "
15699 "by its mountpoint (path) or the device which contains the filesystem."
15703 #: ../src/guestfs-actions.pod:6490
15704 msgid "guestfs_umount_all"
15708 #: ../src/guestfs-actions.pod:6492
15712 " guestfs_umount_all (guestfs_h *g);\n"
15717 #: ../src/guestfs-actions.pod:6495 ../fish/guestfish-actions.pod:4334
15718 msgid "This unmounts all mounted filesystems."
15722 #: ../src/guestfs-actions.pod:6497 ../fish/guestfish-actions.pod:4336
15723 msgid "Some internal mounts are not unmounted by this call."
15727 #: ../src/guestfs-actions.pod:6503
15728 msgid "guestfs_upload"
15732 #: ../src/guestfs-actions.pod:6505
15736 " guestfs_upload (guestfs_h *g,\n"
15737 " const char *filename,\n"
15738 " const char *remotefilename);\n"
15743 #: ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:6534 ../fish/guestfish-actions.pod:4342 ../fish/guestfish-actions.pod:4355
15744 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15748 #: ../src/guestfs-actions.pod:6515
15749 msgid "See also C<guestfs_download>."
15753 #: ../src/guestfs-actions.pod:6526
15754 msgid "guestfs_upload_offset"
15758 #: ../src/guestfs-actions.pod:6528
15762 " guestfs_upload_offset (guestfs_h *g,\n"
15763 " const char *filename,\n"
15764 " const char *remotefilename,\n"
15765 " int64_t offset);\n"
15770 #: ../src/guestfs-actions.pod:6537 ../fish/guestfish-actions.pod:4358
15772 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15773 "The intention is to overwrite parts of existing files or devices, although "
15774 "if a non-existant file is specified then it is created with a \"hole\" "
15775 "before C<offset>. The size of the data written is implicit in the size of "
15776 "the source C<filename>."
15780 #: ../src/guestfs-actions.pod:6544
15782 "Note that there is no limit on the amount of data that can be uploaded with "
15783 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15784 "full amount unless an error occurs."
15788 #: ../src/guestfs-actions.pod:6549
15789 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15793 #: ../src/guestfs-actions.pod:6560
15794 msgid "guestfs_utimens"
15798 #: ../src/guestfs-actions.pod:6562
15802 " guestfs_utimens (guestfs_h *g,\n"
15803 " const char *path,\n"
15804 " int64_t atsecs,\n"
15805 " int64_t atnsecs,\n"
15806 " int64_t mtsecs,\n"
15807 " int64_t mtnsecs);\n"
15812 #: ../src/guestfs-actions.pod:6570 ../fish/guestfish-actions.pod:4378
15813 msgid "This command sets the timestamps of a file with nanosecond precision."
15817 #: ../src/guestfs-actions.pod:6573 ../fish/guestfish-actions.pod:4381
15819 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15824 #: ../src/guestfs-actions.pod:6576 ../fish/guestfish-actions.pod:4384
15826 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15827 "nanoseconds from the epoch."
15831 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4387
15833 "If the C<*nsecs> field contains the special value C<-1> then the "
15834 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15835 "ignored in this case)."
15839 #: ../src/guestfs-actions.pod:6583 ../fish/guestfish-actions.pod:4391
15841 "If the C<*nsecs> field contains the special value C<-2> then the "
15842 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15847 #: ../src/guestfs-actions.pod:6591 ../src/guestfs-structs.pod:175
15848 msgid "guestfs_version"
15852 #: ../src/guestfs-actions.pod:6593
15855 " struct guestfs_version *\n"
15856 " guestfs_version (guestfs_h *g);\n"
15861 #: ../src/guestfs-actions.pod:6596 ../fish/guestfish-actions.pod:4399
15862 msgid "Return the libguestfs version number that the program is linked against."
15866 #: ../src/guestfs-actions.pod:6599 ../fish/guestfish-actions.pod:4402
15868 "Note that because of dynamic linking this is not necessarily the version of "
15869 "libguestfs that you compiled against. You can compile the program, and then "
15870 "at runtime dynamically link against a completely different C<libguestfs.so> "
15875 #: ../src/guestfs-actions.pod:6604 ../fish/guestfish-actions.pod:4407
15877 "This call was added in version C<1.0.58>. In previous versions of "
15878 "libguestfs there was no way to get the version number. From C code you can "
15879 "use dynamic linker functions to find out if this symbol exists (if it "
15880 "doesn't, then it's an earlier version)."
15884 #: ../src/guestfs-actions.pod:6610 ../fish/guestfish-actions.pod:4413
15886 "The call returns a structure with four elements. The first three (C<major>, "
15887 "C<minor> and C<release>) are numbers and correspond to the usual version "
15888 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15889 "but may be used for distro-specific information."
15893 #: ../src/guestfs-actions.pod:6616 ../fish/guestfish-actions.pod:4419
15894 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
15898 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4422
15899 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15903 #: ../src/guestfs-actions.pod:6621
15905 "I<Note:> Don't use this call to test for availability of features. In "
15906 "enterprise distributions we backport features from later versions into "
15907 "earlier versions, making this an unreliable way to test for features. Use "
15908 "C<guestfs_available> instead."
15912 #: ../src/guestfs-actions.pod:6627
15914 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15915 "error. I<The caller must call C<guestfs_free_version> after use>."
15919 #: ../src/guestfs-actions.pod:6631
15920 msgid "(Added in 1.0.58)"
15924 #: ../src/guestfs-actions.pod:6633
15925 msgid "guestfs_vfs_label"
15929 #: ../src/guestfs-actions.pod:6635
15933 " guestfs_vfs_label (guestfs_h *g,\n"
15934 " const char *device);\n"
15939 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4434
15940 msgid "This returns the filesystem label of the filesystem on C<device>."
15944 #: ../src/guestfs-actions.pod:6642 ../fish/guestfish-actions.pod:4437
15945 msgid "If the filesystem is unlabeled, this returns the empty string."
15949 #: ../src/guestfs-actions.pod:6644
15950 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15954 #: ../src/guestfs-actions.pod:6649 ../src/guestfs-actions.pod:6686
15955 msgid "(Added in 1.3.18)"
15959 #: ../src/guestfs-actions.pod:6651
15960 msgid "guestfs_vfs_type"
15964 #: ../src/guestfs-actions.pod:6653
15968 " guestfs_vfs_type (guestfs_h *g,\n"
15969 " const char *device);\n"
15974 #: ../src/guestfs-actions.pod:6657 ../fish/guestfish-actions.pod:4445
15976 "This command gets the filesystem type corresponding to the filesystem on "
15981 #: ../src/guestfs-actions.pod:6660 ../fish/guestfish-actions.pod:4448
15983 "For most filesystems, the result is the name of the Linux VFS module which "
15984 "would be used to mount this filesystem if you mounted it without specifying "
15985 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15989 #: ../src/guestfs-actions.pod:6670
15990 msgid "guestfs_vfs_uuid"
15994 #: ../src/guestfs-actions.pod:6672
15998 " guestfs_vfs_uuid (guestfs_h *g,\n"
15999 " const char *device);\n"
16004 #: ../src/guestfs-actions.pod:6676 ../fish/guestfish-actions.pod:4457
16005 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16009 #: ../src/guestfs-actions.pod:6679 ../fish/guestfish-actions.pod:4460
16010 msgid "If the filesystem does not have a UUID, this returns the empty string."
16014 #: ../src/guestfs-actions.pod:6681
16015 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16019 #: ../src/guestfs-actions.pod:6688
16020 msgid "guestfs_vg_activate"
16024 #: ../src/guestfs-actions.pod:6690
16028 " guestfs_vg_activate (guestfs_h *g,\n"
16030 " char *const *volgroups);\n"
16035 #: ../src/guestfs-actions.pod:6695 ../fish/guestfish-actions.pod:4468
16037 "This command activates or (if C<activate> is false) deactivates all logical "
16038 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16039 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16040 "deactivated, then those devices disappear."
16044 #: ../src/guestfs-actions.pod:6701 ../fish/guestfish-actions.pod:4474
16045 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16049 #: ../src/guestfs-actions.pod:6703 ../fish/guestfish-actions.pod:4476
16051 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16052 "activated or deactivated."
16056 #: ../src/guestfs-actions.pod:6710
16057 msgid "guestfs_vg_activate_all"
16061 #: ../src/guestfs-actions.pod:6712
16065 " guestfs_vg_activate_all (guestfs_h *g,\n"
16066 " int activate);\n"
16071 #: ../src/guestfs-actions.pod:6716 ../fish/guestfish-actions.pod:4483
16073 "This command activates or (if C<activate> is false) deactivates all logical "
16074 "volumes in all volume groups. If activated, then they are made known to the "
16075 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16076 "those devices disappear."
16080 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4489
16081 msgid "This command is the same as running C<vgchange -a y|n>"
16085 #: ../src/guestfs-actions.pod:6728
16086 msgid "guestfs_vgcreate"
16090 #: ../src/guestfs-actions.pod:6730
16094 " guestfs_vgcreate (guestfs_h *g,\n"
16095 " const char *volgroup,\n"
16096 " char *const *physvols);\n"
16101 #: ../src/guestfs-actions.pod:6735 ../fish/guestfish-actions.pod:4495
16103 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16104 "of physical volumes C<physvols>."
16108 #: ../src/guestfs-actions.pod:6742
16109 msgid "guestfs_vglvuuids"
16113 #: ../src/guestfs-actions.pod:6744
16117 " guestfs_vglvuuids (guestfs_h *g,\n"
16118 " const char *vgname);\n"
16123 #: ../src/guestfs-actions.pod:6748 ../fish/guestfish-actions.pod:4502
16125 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16126 "volumes created in this volume group."
16130 #: ../src/guestfs-actions.pod:6751
16132 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
16133 "associate logical volumes and volume groups."
16137 #: ../src/guestfs-actions.pod:6754
16138 msgid "See also C<guestfs_vgpvuuids>."
16142 #: ../src/guestfs-actions.pod:6762
16143 msgid "guestfs_vgpvuuids"
16147 #: ../src/guestfs-actions.pod:6764
16151 " guestfs_vgpvuuids (guestfs_h *g,\n"
16152 " const char *vgname);\n"
16157 #: ../src/guestfs-actions.pod:6768 ../fish/guestfish-actions.pod:4514
16159 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16160 "volumes that this volume group resides on."
16164 #: ../src/guestfs-actions.pod:6771
16166 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
16167 "associate physical volumes and volume groups."
16171 #: ../src/guestfs-actions.pod:6774
16172 msgid "See also C<guestfs_vglvuuids>."
16176 #: ../src/guestfs-actions.pod:6782
16177 msgid "guestfs_vgremove"
16181 #: ../src/guestfs-actions.pod:6784
16185 " guestfs_vgremove (guestfs_h *g,\n"
16186 " const char *vgname);\n"
16191 #: ../src/guestfs-actions.pod:6788 ../fish/guestfish-actions.pod:4526
16192 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16196 #: ../src/guestfs-actions.pod:6790 ../fish/guestfish-actions.pod:4528
16197 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16201 #: ../src/guestfs-actions.pod:6797
16202 msgid "guestfs_vgrename"
16206 #: ../src/guestfs-actions.pod:6799
16210 " guestfs_vgrename (guestfs_h *g,\n"
16211 " const char *volgroup,\n"
16212 " const char *newvolgroup);\n"
16217 #: ../src/guestfs-actions.pod:6804 ../fish/guestfish-actions.pod:4535
16218 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16222 #: ../src/guestfs-actions.pod:6810
16223 msgid "guestfs_vgs"
16227 #: ../src/guestfs-actions.pod:6812
16231 " guestfs_vgs (guestfs_h *g);\n"
16236 #: ../src/guestfs-actions.pod:6815 ../fish/guestfish-actions.pod:4541
16238 "List all the volumes groups detected. This is the equivalent of the "
16239 "L<vgs(8)> command."
16243 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4544
16245 "This returns a list of just the volume group names that were detected "
16246 "(eg. C<VolGroup00>)."
16250 #: ../src/guestfs-actions.pod:6821
16251 msgid "See also C<guestfs_vgs_full>."
16255 #: ../src/guestfs-actions.pod:6829
16256 msgid "guestfs_vgs_full"
16260 #: ../src/guestfs-actions.pod:6831
16263 " struct guestfs_lvm_vg_list *\n"
16264 " guestfs_vgs_full (guestfs_h *g);\n"
16269 #: ../src/guestfs-actions.pod:6834 ../fish/guestfish-actions.pod:4553
16271 "List all the volumes groups detected. This is the equivalent of the "
16272 "L<vgs(8)> command. The \"full\" version includes all fields."
16276 #: ../src/guestfs-actions.pod:6837
16278 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
16279 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
16284 #: ../src/guestfs-actions.pod:6843
16285 msgid "guestfs_vgscan"
16289 #: ../src/guestfs-actions.pod:6845
16293 " guestfs_vgscan (guestfs_h *g);\n"
16298 #: ../src/guestfs-actions.pod:6848 ../fish/guestfish-actions.pod:4560
16300 "This rescans all block devices and rebuilds the list of LVM physical "
16301 "volumes, volume groups and logical volumes."
16305 #: ../src/guestfs-actions.pod:6855
16306 msgid "guestfs_vguuid"
16310 #: ../src/guestfs-actions.pod:6857
16314 " guestfs_vguuid (guestfs_h *g,\n"
16315 " const char *vgname);\n"
16320 #: ../src/guestfs-actions.pod:6861 ../fish/guestfish-actions.pod:4567
16321 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16325 #: ../src/guestfs-actions.pod:6868
16326 msgid "guestfs_wait_ready"
16330 #: ../src/guestfs-actions.pod:6870
16334 " guestfs_wait_ready (guestfs_h *g);\n"
16339 #: ../src/guestfs-actions.pod:6873
16340 msgid "This function is a no op."
16344 #: ../src/guestfs-actions.pod:6875
16346 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
16347 "calling C<guestfs_launch> to wait for the launch to complete. However this "
16348 "is no longer necessary because C<guestfs_launch> now does the waiting."
16352 #: ../src/guestfs-actions.pod:6880
16354 "If you see any calls to this function in code then you can just remove them, "
16355 "unless you want to retain compatibility with older versions of the API."
16359 #: ../src/guestfs-actions.pod:6888
16360 msgid "guestfs_wc_c"
16364 #: ../src/guestfs-actions.pod:6890
16368 " guestfs_wc_c (guestfs_h *g,\n"
16369 " const char *path);\n"
16374 #: ../src/guestfs-actions.pod:6894 ../fish/guestfish-actions.pod:4573
16376 "This command counts the characters in a file, using the C<wc -c> external "
16381 #: ../src/guestfs-actions.pod:6901
16382 msgid "guestfs_wc_l"
16386 #: ../src/guestfs-actions.pod:6903
16390 " guestfs_wc_l (guestfs_h *g,\n"
16391 " const char *path);\n"
16396 #: ../src/guestfs-actions.pod:6907 ../fish/guestfish-actions.pod:4580
16398 "This command counts the lines in a file, using the C<wc -l> external "
16403 #: ../src/guestfs-actions.pod:6914
16404 msgid "guestfs_wc_w"
16408 #: ../src/guestfs-actions.pod:6916
16412 " guestfs_wc_w (guestfs_h *g,\n"
16413 " const char *path);\n"
16418 #: ../src/guestfs-actions.pod:6920 ../fish/guestfish-actions.pod:4587
16420 "This command counts the words in a file, using the C<wc -w> external "
16425 #: ../src/guestfs-actions.pod:6927
16426 msgid "guestfs_write"
16430 #: ../src/guestfs-actions.pod:6929
16434 " guestfs_write (guestfs_h *g,\n"
16435 " const char *path,\n"
16436 " const char *content,\n"
16437 " size_t content_size);\n"
16442 #: ../src/guestfs-actions.pod:6935 ../fish/guestfish-actions.pod:4594
16444 "This call creates a file called C<path>. The content of the file is the "
16445 "string C<content> (which can contain any 8 bit data)."
16449 #: ../src/guestfs-actions.pod:6945
16450 msgid "guestfs_write_file"
16454 #: ../src/guestfs-actions.pod:6947
16458 " guestfs_write_file (guestfs_h *g,\n"
16459 " const char *path,\n"
16460 " const char *content,\n"
16466 #: ../src/guestfs-actions.pod:6953 ../fish/guestfish-actions.pod:4604
16468 "This call creates a file called C<path>. The contents of the file is the "
16469 "string C<content> (which can contain any 8 bit data), with length C<size>."
16473 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4608
16475 "As a special case, if C<size> is C<0> then the length is calculated using "
16476 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16480 #: ../src/guestfs-actions.pod:6961 ../fish/guestfish-actions.pod:4612
16482 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16483 "I<not> work, even if the length is specified."
16487 #: ../src/guestfs-actions.pod:6969 ../fish/guestfish-actions.pod:4618
16488 msgid "This function is deprecated. In new code, use the C<write> call instead."
16492 #: ../src/guestfs-actions.pod:6978
16493 msgid "guestfs_zegrep"
16497 #: ../src/guestfs-actions.pod:6980
16501 " guestfs_zegrep (guestfs_h *g,\n"
16502 " const char *regex,\n"
16503 " const char *path);\n"
16508 #: ../src/guestfs-actions.pod:6985 ../fish/guestfish-actions.pod:4629
16509 msgid "This calls the external C<zegrep> program and returns the matching lines."
16513 #: ../src/guestfs-actions.pod:6997
16514 msgid "guestfs_zegrepi"
16518 #: ../src/guestfs-actions.pod:6999
16522 " guestfs_zegrepi (guestfs_h *g,\n"
16523 " const char *regex,\n"
16524 " const char *path);\n"
16529 #: ../src/guestfs-actions.pod:7004 ../fish/guestfish-actions.pod:4639
16530 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16534 #: ../src/guestfs-actions.pod:7016
16535 msgid "guestfs_zero"
16539 #: ../src/guestfs-actions.pod:7018
16543 " guestfs_zero (guestfs_h *g,\n"
16544 " const char *device);\n"
16549 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4649
16550 msgid "This command writes zeroes over the first few blocks of C<device>."
16554 #: ../src/guestfs-actions.pod:7024 ../fish/guestfish-actions.pod:4651
16556 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16557 "securely wipe the device). It should be sufficient to remove any partition "
16558 "tables, filesystem superblocks and so on."
16562 #: ../src/guestfs-actions.pod:7028
16563 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16567 #: ../src/guestfs-actions.pod:7039
16568 msgid "guestfs_zero_device"
16572 #: ../src/guestfs-actions.pod:7041
16576 " guestfs_zero_device (guestfs_h *g,\n"
16577 " const char *device);\n"
16582 #: ../src/guestfs-actions.pod:7045
16584 "This command writes zeroes over the entire C<device>. Compare with "
16585 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16589 #: ../src/guestfs-actions.pod:7059
16590 msgid "(Added in 1.3.1)"
16594 #: ../src/guestfs-actions.pod:7061
16595 msgid "guestfs_zerofree"
16599 #: ../src/guestfs-actions.pod:7063
16603 " guestfs_zerofree (guestfs_h *g,\n"
16604 " const char *device);\n"
16609 #: ../src/guestfs-actions.pod:7067 ../fish/guestfish-actions.pod:4672
16611 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16612 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16613 "possible to compress the filesystem more effectively."
16617 #: ../src/guestfs-actions.pod:7072 ../fish/guestfish-actions.pod:4677
16618 msgid "You should B<not> run this program if the filesystem is mounted."
16622 #: ../src/guestfs-actions.pod:7075 ../fish/guestfish-actions.pod:4680
16624 "It is possible that using this program can damage the filesystem or data on "
16629 #: ../src/guestfs-actions.pod:7082
16630 msgid "guestfs_zfgrep"
16634 #: ../src/guestfs-actions.pod:7084
16638 " guestfs_zfgrep (guestfs_h *g,\n"
16639 " const char *pattern,\n"
16640 " const char *path);\n"
16645 #: ../src/guestfs-actions.pod:7089 ../fish/guestfish-actions.pod:4687
16646 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16650 #: ../src/guestfs-actions.pod:7101
16651 msgid "guestfs_zfgrepi"
16655 #: ../src/guestfs-actions.pod:7103
16659 " guestfs_zfgrepi (guestfs_h *g,\n"
16660 " const char *pattern,\n"
16661 " const char *path);\n"
16666 #: ../src/guestfs-actions.pod:7108 ../fish/guestfish-actions.pod:4697
16667 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16671 #: ../src/guestfs-actions.pod:7120
16672 msgid "guestfs_zfile"
16676 #: ../src/guestfs-actions.pod:7122
16680 " guestfs_zfile (guestfs_h *g,\n"
16681 " const char *meth,\n"
16682 " const char *path);\n"
16687 #: ../src/guestfs-actions.pod:7127 ../fish/guestfish-actions.pod:4707
16688 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16692 #: ../src/guestfs-actions.pod:7130 ../fish/guestfish-actions.pod:4710
16693 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16697 #: ../src/guestfs-actions.pod:7132
16699 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16704 #: ../src/guestfs-actions.pod:7138 ../fish/guestfish-actions.pod:4715
16705 msgid "This function is deprecated. In new code, use the C<file> call instead."
16709 #: ../src/guestfs-actions.pod:7147
16710 msgid "guestfs_zgrep"
16714 #: ../src/guestfs-actions.pod:7149
16718 " guestfs_zgrep (guestfs_h *g,\n"
16719 " const char *regex,\n"
16720 " const char *path);\n"
16725 #: ../src/guestfs-actions.pod:7154 ../fish/guestfish-actions.pod:4726
16726 msgid "This calls the external C<zgrep> program and returns the matching lines."
16730 #: ../src/guestfs-actions.pod:7166
16731 msgid "guestfs_zgrepi"
16735 #: ../src/guestfs-actions.pod:7168
16739 " guestfs_zgrepi (guestfs_h *g,\n"
16740 " const char *regex,\n"
16741 " const char *path);\n"
16746 #: ../src/guestfs-actions.pod:7173 ../fish/guestfish-actions.pod:4736
16747 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16751 #: ../src/guestfs-availability.pod:3
16756 #: ../src/guestfs-availability.pod:5
16758 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
16759 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
16760 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
16761 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
16762 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
16766 #: ../src/guestfs-availability.pod:21
16771 #: ../src/guestfs-availability.pod:23
16773 "The following functions: L</guestfs_inotify_add_watch> "
16774 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
16775 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16779 #: ../src/guestfs-availability.pod:31
16780 msgid "B<linuxfsuuid>"
16784 #: ../src/guestfs-availability.pod:33
16786 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
16787 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16791 #: ../src/guestfs-availability.pod:40
16792 msgid "B<linuxmodules>"
16796 #: ../src/guestfs-availability.pod:42
16797 msgid "The following functions: L</guestfs_modprobe>"
16801 #: ../src/guestfs-availability.pod:45
16802 msgid "B<linuxxattrs>"
16806 #: ../src/guestfs-availability.pod:47
16808 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
16809 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
16810 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
16811 "L</guestfs_setxattr>"
16815 #: ../src/guestfs-availability.pod:58
16820 #: ../src/guestfs-availability.pod:60
16822 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
16823 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
16824 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16828 #: ../src/guestfs-availability.pod:69
16833 #: ../src/guestfs-availability.pod:71
16835 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
16836 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
16837 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
16838 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
16839 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
16840 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
16841 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
16842 "L</guestfs_vgs_full>"
16846 #: ../src/guestfs-availability.pod:94
16851 #: ../src/guestfs-availability.pod:96
16853 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
16854 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
16858 #: ../src/guestfs-availability.pod:102
16863 #: ../src/guestfs-availability.pod:104
16864 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16868 #: ../src/guestfs-availability.pod:107
16869 msgid "B<ntfsprogs>"
16873 #: ../src/guestfs-availability.pod:109
16874 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16878 #: ../src/guestfs-availability.pod:113
16879 msgid "B<realpath>"
16883 #: ../src/guestfs-availability.pod:115
16884 msgid "The following functions: L</guestfs_realpath>"
16888 #: ../src/guestfs-availability.pod:118
16893 #: ../src/guestfs-availability.pod:120
16895 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
16896 "L</guestfs_scrub_freespace>"
16900 #: ../src/guestfs-availability.pod:125
16905 #: ../src/guestfs-availability.pod:127
16906 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16910 #: ../src/guestfs-availability.pod:131
16915 #: ../src/guestfs-availability.pod:133
16916 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16920 #: ../src/guestfs-availability.pod:137
16921 msgid "B<zerofree>"
16925 #: ../src/guestfs-availability.pod:139
16926 msgid "The following functions: L</guestfs_zerofree>"
16930 #: ../src/guestfs-structs.pod:1
16931 msgid "guestfs_int_bool"
16935 #: ../src/guestfs-structs.pod:3
16938 " struct guestfs_int_bool {\n"
16946 #: ../src/guestfs-structs.pod:8
16949 " struct guestfs_int_bool_list {\n"
16950 " uint32_t len; /* Number of elements in list. */\n"
16951 " struct guestfs_int_bool *val; /* Elements. */\n"
16957 #: ../src/guestfs-structs.pod:13
16960 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16961 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16966 #: ../src/guestfs-structs.pod:16
16967 msgid "guestfs_lvm_pv"
16971 #: ../src/guestfs-structs.pod:18
16974 " struct guestfs_lvm_pv {\n"
16975 " char *pv_name;\n"
16976 " /* The next field is NOT nul-terminated, be careful when printing it: "
16978 " char pv_uuid[32];\n"
16980 " uint64_t pv_size;\n"
16981 " uint64_t dev_size;\n"
16982 " uint64_t pv_free;\n"
16983 " uint64_t pv_used;\n"
16984 " char *pv_attr;\n"
16985 " int64_t pv_pe_count;\n"
16986 " int64_t pv_pe_alloc_count;\n"
16987 " char *pv_tags;\n"
16988 " uint64_t pe_start;\n"
16989 " int64_t pv_mda_count;\n"
16990 " uint64_t pv_mda_free;\n"
16996 #: ../src/guestfs-structs.pod:36
16999 " struct guestfs_lvm_pv_list {\n"
17000 " uint32_t len; /* Number of elements in list. */\n"
17001 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17007 #: ../src/guestfs-structs.pod:41
17010 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17011 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17016 #: ../src/guestfs-structs.pod:44
17017 msgid "guestfs_lvm_vg"
17021 #: ../src/guestfs-structs.pod:46
17024 " struct guestfs_lvm_vg {\n"
17025 " char *vg_name;\n"
17026 " /* The next field is NOT nul-terminated, be careful when printing it: "
17028 " char vg_uuid[32];\n"
17030 " char *vg_attr;\n"
17031 " uint64_t vg_size;\n"
17032 " uint64_t vg_free;\n"
17033 " char *vg_sysid;\n"
17034 " uint64_t vg_extent_size;\n"
17035 " int64_t vg_extent_count;\n"
17036 " int64_t vg_free_count;\n"
17037 " int64_t max_lv;\n"
17038 " int64_t max_pv;\n"
17039 " int64_t pv_count;\n"
17040 " int64_t lv_count;\n"
17041 " int64_t snap_count;\n"
17042 " int64_t vg_seqno;\n"
17043 " char *vg_tags;\n"
17044 " int64_t vg_mda_count;\n"
17045 " uint64_t vg_mda_free;\n"
17051 #: ../src/guestfs-structs.pod:69
17054 " struct guestfs_lvm_vg_list {\n"
17055 " uint32_t len; /* Number of elements in list. */\n"
17056 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17062 #: ../src/guestfs-structs.pod:74
17065 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17066 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17071 #: ../src/guestfs-structs.pod:77
17072 msgid "guestfs_lvm_lv"
17076 #: ../src/guestfs-structs.pod:79
17079 " struct guestfs_lvm_lv {\n"
17080 " char *lv_name;\n"
17081 " /* The next field is NOT nul-terminated, be careful when printing it: "
17083 " char lv_uuid[32];\n"
17084 " char *lv_attr;\n"
17085 " int64_t lv_major;\n"
17086 " int64_t lv_minor;\n"
17087 " int64_t lv_kernel_major;\n"
17088 " int64_t lv_kernel_minor;\n"
17089 " uint64_t lv_size;\n"
17090 " int64_t seg_count;\n"
17092 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17093 " float snap_percent;\n"
17094 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17095 " float copy_percent;\n"
17096 " char *move_pv;\n"
17097 " char *lv_tags;\n"
17098 " char *mirror_log;\n"
17099 " char *modules;\n"
17105 #: ../src/guestfs-structs.pod:101
17108 " struct guestfs_lvm_lv_list {\n"
17109 " uint32_t len; /* Number of elements in list. */\n"
17110 " struct guestfs_lvm_lv *val; /* Elements. */\n"
17116 #: ../src/guestfs-structs.pod:106
17119 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
17120 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
17125 #: ../src/guestfs-structs.pod:111
17128 " struct guestfs_stat {\n"
17132 " int64_t nlink;\n"
17137 " int64_t blksize;\n"
17138 " int64_t blocks;\n"
17139 " int64_t atime;\n"
17140 " int64_t mtime;\n"
17141 " int64_t ctime;\n"
17147 #: ../src/guestfs-structs.pod:127
17150 " struct guestfs_stat_list {\n"
17151 " uint32_t len; /* Number of elements in list. */\n"
17152 " struct guestfs_stat *val; /* Elements. */\n"
17158 #: ../src/guestfs-structs.pod:132
17161 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
17162 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
17167 #: ../src/guestfs-structs.pod:137
17170 " struct guestfs_statvfs {\n"
17171 " int64_t bsize;\n"
17172 " int64_t frsize;\n"
17173 " int64_t blocks;\n"
17174 " int64_t bfree;\n"
17175 " int64_t bavail;\n"
17176 " int64_t files;\n"
17177 " int64_t ffree;\n"
17178 " int64_t favail;\n"
17181 " int64_t namemax;\n"
17187 #: ../src/guestfs-structs.pod:151
17190 " struct guestfs_statvfs_list {\n"
17191 " uint32_t len; /* Number of elements in list. */\n"
17192 " struct guestfs_statvfs *val; /* Elements. */\n"
17198 #: ../src/guestfs-structs.pod:156
17201 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
17202 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
17207 #: ../src/guestfs-structs.pod:159
17208 msgid "guestfs_dirent"
17212 #: ../src/guestfs-structs.pod:161
17215 " struct guestfs_dirent {\n"
17224 #: ../src/guestfs-structs.pod:167
17227 " struct guestfs_dirent_list {\n"
17228 " uint32_t len; /* Number of elements in list. */\n"
17229 " struct guestfs_dirent *val; /* Elements. */\n"
17235 #: ../src/guestfs-structs.pod:172
17238 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
17239 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
17244 #: ../src/guestfs-structs.pod:177
17247 " struct guestfs_version {\n"
17248 " int64_t major;\n"
17249 " int64_t minor;\n"
17250 " int64_t release;\n"
17257 #: ../src/guestfs-structs.pod:184
17260 " struct guestfs_version_list {\n"
17261 " uint32_t len; /* Number of elements in list. */\n"
17262 " struct guestfs_version *val; /* Elements. */\n"
17268 #: ../src/guestfs-structs.pod:189
17271 " void guestfs_free_version (struct guestfs_free_version *);\n"
17272 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
17277 #: ../src/guestfs-structs.pod:192
17278 msgid "guestfs_xattr"
17282 #: ../src/guestfs-structs.pod:194
17285 " struct guestfs_xattr {\n"
17286 " char *attrname;\n"
17287 " /* The next two fields describe a byte array. */\n"
17288 " uint32_t attrval_len;\n"
17289 " char *attrval;\n"
17295 #: ../src/guestfs-structs.pod:201
17298 " struct guestfs_xattr_list {\n"
17299 " uint32_t len; /* Number of elements in list. */\n"
17300 " struct guestfs_xattr *val; /* Elements. */\n"
17306 #: ../src/guestfs-structs.pod:206
17309 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
17310 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
17315 #: ../src/guestfs-structs.pod:209
17316 msgid "guestfs_inotify_event"
17320 #: ../src/guestfs-structs.pod:211
17323 " struct guestfs_inotify_event {\n"
17324 " int64_t in_wd;\n"
17325 " uint32_t in_mask;\n"
17326 " uint32_t in_cookie;\n"
17327 " char *in_name;\n"
17333 #: ../src/guestfs-structs.pod:218
17336 " struct guestfs_inotify_event_list {\n"
17337 " uint32_t len; /* Number of elements in list. */\n"
17338 " struct guestfs_inotify_event *val; /* Elements. */\n"
17344 #: ../src/guestfs-structs.pod:223
17347 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
17348 " void guestfs_free_inotify_event_list (struct "
17349 "guestfs_free_inotify_event_list *);\n"
17354 #: ../src/guestfs-structs.pod:226
17355 msgid "guestfs_partition"
17359 #: ../src/guestfs-structs.pod:228
17362 " struct guestfs_partition {\n"
17363 " int32_t part_num;\n"
17364 " uint64_t part_start;\n"
17365 " uint64_t part_end;\n"
17366 " uint64_t part_size;\n"
17372 #: ../src/guestfs-structs.pod:235
17375 " struct guestfs_partition_list {\n"
17376 " uint32_t len; /* Number of elements in list. */\n"
17377 " struct guestfs_partition *val; /* Elements. */\n"
17383 #: ../src/guestfs-structs.pod:240
17386 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
17387 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
17392 #: ../src/guestfs-structs.pod:243
17393 msgid "guestfs_application"
17397 #: ../src/guestfs-structs.pod:245
17400 " struct guestfs_application {\n"
17401 " char *app_name;\n"
17402 " char *app_display_name;\n"
17403 " int32_t app_epoch;\n"
17404 " char *app_version;\n"
17405 " char *app_release;\n"
17406 " char *app_install_path;\n"
17407 " char *app_trans_path;\n"
17408 " char *app_publisher;\n"
17409 " char *app_url;\n"
17410 " char *app_source_package;\n"
17411 " char *app_summary;\n"
17412 " char *app_description;\n"
17418 #: ../src/guestfs-structs.pod:260
17421 " struct guestfs_application_list {\n"
17422 " uint32_t len; /* Number of elements in list. */\n"
17423 " struct guestfs_application *val; /* Elements. */\n"
17429 #: ../src/guestfs-structs.pod:265
17432 " void guestfs_free_application (struct guestfs_free_application *);\n"
17433 " void guestfs_free_application_list (struct guestfs_free_application_list "
17439 #: ../fish/guestfish.pod:5
17440 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17444 #: ../fish/guestfish.pod:9
17447 " guestfish [--options] [commands]\n"
17452 #: ../fish/guestfish.pod:11
17460 #: ../fish/guestfish.pod:13
17463 " guestfish [--ro|--rw] -a disk.img\n"
17468 #: ../fish/guestfish.pod:15
17471 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17476 #: ../fish/guestfish.pod:17
17479 " guestfish -d libvirt-domain\n"
17484 #: ../fish/guestfish.pod:19
17487 " guestfish [--ro|--rw] -a disk.img -i\n"
17492 #: ../fish/guestfish.pod:21
17495 " guestfish -d libvirt-domain -i\n"
17500 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
17505 #: ../fish/guestfish.pod:25
17507 "Using guestfish in read/write mode on live virtual machines can be "
17508 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17509 "option to use guestfish safely if the disk image or virtual machine might be "
17514 #: ../fish/guestfish.pod:32
17516 "Guestfish is a shell and command-line tool for examining and modifying "
17517 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17518 "functionality of the guestfs API, see L<guestfs(3)>."
17522 #: ../fish/guestfish.pod:36
17524 "Guestfish gives you structured access to the libguestfs API, from shell "
17525 "scripts or the command line or interactively. If you want to rescue a "
17526 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17531 #: ../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
17536 #: ../fish/guestfish.pod:43
17537 msgid "As an interactive shell"
17541 #: ../fish/guestfish.pod:45
17549 #: ../fish/guestfish.pod:47
17552 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17553 " editing virtual machine filesystems.\n"
17558 #: ../fish/guestfish.pod:50
17561 " Type: 'help' for a list of commands\n"
17562 " 'man' to read the manual\n"
17563 " 'quit' to quit the shell\n"
17568 #: ../fish/guestfish.pod:54
17571 " ><fs> add-ro disk.img\n"
17573 " ><fs> list-filesystems\n"
17574 " /dev/sda1: ext4\n"
17575 " /dev/vg_guest/lv_root: ext4\n"
17576 " /dev/vg_guest/lv_swap: swap\n"
17577 " ><fs> mount /dev/vg_guest/lv_root /\n"
17578 " ><fs> cat /etc/fstab\n"
17580 " # Created by anaconda\n"
17587 #: ../fish/guestfish.pod:67
17588 msgid "From shell scripts"
17592 #: ../fish/guestfish.pod:69
17593 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17597 #: ../fish/guestfish.pod:71
17600 " guestfish <<_EOF_\n"
17603 " mount /dev/vg_guest/lv_root /\n"
17604 " write /etc/motd \"Welcome, new users\"\n"
17610 #: ../fish/guestfish.pod:78
17611 msgid "List the LVM logical volumes in a disk image:"
17615 #: ../fish/guestfish.pod:80
17618 " guestfish -a disk.img --ro <<_EOF_\n"
17626 #: ../fish/guestfish.pod:85
17627 msgid "List all the filesystems in a disk image:"
17631 #: ../fish/guestfish.pod:87
17634 " guestfish -a disk.img --ro <<_EOF_\n"
17636 " list-filesystems\n"
17642 #: ../fish/guestfish.pod:92
17643 msgid "On one command line"
17647 #: ../fish/guestfish.pod:94
17648 msgid "Update C</etc/resolv.conf> in a guest:"
17652 #: ../fish/guestfish.pod:96
17656 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17657 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17662 #: ../fish/guestfish.pod:100
17663 msgid "Edit C</boot/grub/grub.conf> interactively:"
17667 #: ../fish/guestfish.pod:102
17670 " guestfish --rw --add disk.img \\\n"
17671 " --mount /dev/vg_guest/lv_root \\\n"
17672 " --mount /dev/sda1:/boot \\\n"
17673 " edit /boot/grub/grub.conf\n"
17678 #: ../fish/guestfish.pod:107
17679 msgid "Mount disks automatically"
17683 #: ../fish/guestfish.pod:109
17685 "Use the I<-i> option to automatically mount the disks from a virtual "
17690 #: ../fish/guestfish.pod:112
17693 " guestfish --ro -a disk.img -i cat /etc/group\n"
17698 #: ../fish/guestfish.pod:114
17701 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17706 #: ../fish/guestfish.pod:116
17707 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17711 #: ../fish/guestfish.pod:118
17714 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17719 #: ../fish/guestfish.pod:120
17720 msgid "As a script interpreter"
17724 #: ../fish/guestfish.pod:122
17725 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17729 #: ../fish/guestfish.pod:124
17732 " #!/usr/bin/guestfish -f\n"
17733 " sparse test1.img 100M\n"
17735 " part-disk /dev/sda mbr\n"
17736 " mkfs ext2 /dev/sda1\n"
17741 #: ../fish/guestfish.pod:130
17742 msgid "Start with a prepared disk"
17746 #: ../fish/guestfish.pod:132
17748 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17749 "single ext2-formatted partition:"
17753 #: ../fish/guestfish.pod:135
17756 " guestfish -N fs\n"
17761 #: ../fish/guestfish.pod:137
17762 msgid "To list what is available do:"
17766 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:888
17769 " guestfish -N help | less\n"
17774 #: ../fish/guestfish.pod:141
17775 msgid "Remote control"
17779 #: ../fish/guestfish.pod:143
17782 " eval \"`guestfish --listen`\"\n"
17783 " guestfish --remote add-ro disk.img\n"
17784 " guestfish --remote run\n"
17785 " guestfish --remote lvs\n"
17790 #: ../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
17795 #: ../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
17800 #: ../fish/guestfish.pod:154
17801 msgid "Displays general help on options."
17805 #: ../fish/guestfish.pod:156
17810 #: ../fish/guestfish.pod:158
17811 msgid "B<--cmd-help>"
17815 #: ../fish/guestfish.pod:160
17816 msgid "Lists all available guestfish commands."
17820 #: ../fish/guestfish.pod:162
17825 #: ../fish/guestfish.pod:164
17826 msgid "B<--cmd-help cmd>"
17830 #: ../fish/guestfish.pod:166
17831 msgid "Displays detailed help on a single command C<cmd>."
17835 #: ../fish/guestfish.pod:168
17836 msgid "B<-a image>"
17840 #: ../fish/guestfish.pod:170
17841 msgid "B<--add image>"
17845 #: ../fish/guestfish.pod:172
17846 msgid "Add a block device or virtual machine image to the shell."
17850 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
17852 "The format of the disk image is auto-detected. To override this and force a "
17853 "particular format use the I<--format=..> option."
17857 #: ../fish/guestfish.pod:177
17859 "Using this flag is mostly equivalent to using the C<add> command, with "
17860 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17861 "the I<--format=...> flag was given."
17865 #: ../fish/guestfish.pod:181
17870 #: ../fish/guestfish.pod:183
17871 msgid "B<--connect URI>"
17875 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
17877 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17878 "URI to use. The default is to use the default libvirt connection."
17882 #: ../fish/guestfish.pod:189
17887 #: ../fish/guestfish.pod:191
17889 "If using the I<--listen> option and a csh-like shell, use this option. See "
17890 "section L</REMOTE CONTROL AND CSH> below."
17894 #: ../fish/guestfish.pod:194
17895 msgid "B<-d libvirt-domain>"
17899 #: ../fish/guestfish.pod:196
17900 msgid "B<--domain libvirt-domain>"
17904 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
17906 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17907 "used, then any libvirt domain can be used. However in write mode, only "
17908 "libvirt domains which are shut down can be named here."
17912 #: ../fish/guestfish.pod:202
17914 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17915 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17916 "if the I<--format:...> flag was given."
17920 #: ../fish/guestfish.pod:206
17925 #: ../fish/guestfish.pod:208
17926 msgid "B<--no-dest-paths>"
17930 #: ../fish/guestfish.pod:210
17932 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17933 "to hit the tab key to complete paths on the guest filesystem, but this "
17934 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17935 "allow this feature to be disabled."
17939 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
17940 msgid "B<--echo-keys>"
17944 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
17946 "When prompting for keys and passphrases, guestfish normally turns echoing "
17947 "off so you cannot see what you are typing. If you are not worried about "
17948 "Tempest attacks and there is no one else in the room you can specify this "
17949 "flag to see what you are typing."
17953 #: ../fish/guestfish.pod:222
17958 #: ../fish/guestfish.pod:224
17959 msgid "B<--file file>"
17963 #: ../fish/guestfish.pod:226
17964 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17968 #: ../fish/guestfish.pod:229
17971 " #!/usr/bin/guestfish -f\n"
17976 #: ../fish/guestfish.pod:231
17977 msgid "B<--format=raw|qcow2|..>"
17981 #: ../fish/guestfish.pod:233
17982 msgid "B<--format>"
17986 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
17988 "The default for the I<-a> option is to auto-detect the format of the disk "
17989 "image. Using this forces the disk format for I<-a> options which follow on "
17990 "the command line. Using I<--format> with no argument switches back to "
17991 "auto-detection for subsequent I<-a> options."
17995 #: ../fish/guestfish.pod:242
17998 " guestfish --format=raw -a disk.img\n"
18003 #: ../fish/guestfish.pod:244
18004 msgid "forces raw format (no auto-detection) for C<disk.img>."
18008 #: ../fish/guestfish.pod:246
18011 " guestfish --format=raw -a disk.img --format -a another.img\n"
18016 #: ../fish/guestfish.pod:248
18018 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18019 "auto-detection for C<another.img>."
18023 #: ../fish/guestfish.pod:251
18025 "If you have untrusted raw-format guest disk images, you should use this "
18026 "option to specify the disk format. This avoids a possible security problem "
18027 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18031 #: ../fish/guestfish.pod:256
18036 #: ../fish/guestfish.pod:258
18037 msgid "B<--inspector>"
18041 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18043 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18044 "system and mount filesystems as they would be mounted on the real virtual "
18049 #: ../fish/guestfish.pod:264
18050 msgid "Typical usage is either:"
18054 #: ../fish/guestfish.pod:266
18057 " guestfish -d myguest -i\n"
18062 #: ../fish/guestfish.pod:268
18063 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18067 #: ../fish/guestfish.pod:270
18070 " guestfish --ro -d myguest -i\n"
18075 #: ../fish/guestfish.pod:272
18076 msgid "(for active domains, readonly), or specify the block device directly:"
18080 #: ../fish/guestfish.pod:274
18083 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18088 #: ../fish/guestfish.pod:276
18090 "Note that the command line syntax changed slightly over older versions of "
18091 "guestfish. You can still use the old syntax:"
18095 #: ../fish/guestfish.pod:279
18098 " guestfish [--ro] -i disk.img\n"
18103 #: ../fish/guestfish.pod:281
18106 " guestfish [--ro] -i libvirt-domain\n"
18111 #: ../fish/guestfish.pod:283
18113 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
18114 "then using other commands to mount the filesystems that were found."
18118 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
18119 msgid "B<--keys-from-stdin>"
18123 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
18125 "Read key or passphrase parameters from stdin. The default is to try to read "
18126 "passphrases from the user by opening C</dev/tty>."
18130 #: ../fish/guestfish.pod:292
18131 msgid "B<--listen>"
18135 #: ../fish/guestfish.pod:294
18137 "Fork into the background and listen for remote commands. See section "
18138 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18142 #: ../fish/guestfish.pod:297
18143 msgid "B<-m dev[:mountpoint]>"
18147 #: ../fish/guestfish.pod:299
18148 msgid "B<--mount dev[:mountpoint]>"
18152 #: ../fish/guestfish.pod:301
18153 msgid "Mount the named partition or logical volume on the given mountpoint."
18157 #: ../fish/guestfish.pod:303
18158 msgid "If the mountpoint is omitted, it defaults to C</>."
18162 #: ../fish/guestfish.pod:305
18163 msgid "You have to mount something on C</> before most commands will work."
18167 #: ../fish/guestfish.pod:307
18169 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18174 #: ../fish/guestfish.pod:310
18176 "If you don't know what filesystems a disk image contains, you can either run "
18177 "guestfish without this option, then list the partitions, filesystems and LVs "
18178 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18179 "commands), or you can use the L<virt-filesystems(1)> program."
18183 #: ../fish/guestfish.pod:316
18185 "Using this flag is mostly equivalent to using the C<mount-options> command "
18186 "or the C<mount-ro> command if the I<--ro> flag was given."
18190 #: ../fish/guestfish.pod:319
18195 #: ../fish/guestfish.pod:321
18196 msgid "B<--no-sync>"
18200 #: ../fish/guestfish.pod:323
18202 "Disable autosync. This is enabled by default. See the discussion of "
18203 "autosync in the L<guestfs(3)> manpage."
18207 #: ../fish/guestfish.pod:326
18212 #: ../fish/guestfish.pod:328
18213 msgid "B<--new type>"
18217 #: ../fish/guestfish.pod:330
18222 #: ../fish/guestfish.pod:332
18224 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18225 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18226 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18231 #: ../fish/guestfish.pod:337
18232 msgid "B<--progress-bars>"
18236 #: ../fish/guestfish.pod:339
18237 msgid "Enable progress bars, even when guestfish is used non-interactively."
18241 #: ../fish/guestfish.pod:341
18243 "Progress bars are enabled by default when guestfish is used as an "
18244 "interactive shell."
18248 #: ../fish/guestfish.pod:344
18249 msgid "B<--no-progress-bars>"
18253 #: ../fish/guestfish.pod:346
18254 msgid "Disable progress bars."
18258 #: ../fish/guestfish.pod:348
18259 msgid "B<--remote[=pid]>"
18263 #: ../fish/guestfish.pod:350
18265 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18266 "CONTROL GUESTFISH OVER A SOCKET> below."
18270 #: ../fish/guestfish.pod:353
18275 #: ../fish/guestfish.pod:355
18280 #: ../fish/guestfish.pod:357
18282 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18283 "mounts are done read-only."
18287 #: ../fish/guestfish.pod:360
18289 "The option must always be used if the disk image or virtual machine might be "
18290 "running, and is generally recommended in cases where you don't need write "
18291 "access to the disk."
18295 #: ../fish/guestfish.pod:364
18297 "Note that prepared disk images created with I<-N> are not affected by this "
18298 "option. Also commands like C<add> are not affected - you have to specify "
18299 "the C<readonly:true> option explicitly if you need it."
18303 #: ../fish/guestfish.pod:368
18304 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18308 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
18309 msgid "B<--selinux>"
18313 #: ../fish/guestfish.pod:372
18314 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18318 #: ../fish/guestfish.pod:374
18323 #: ../fish/guestfish.pod:376
18324 msgid "B<--verbose>"
18328 #: ../fish/guestfish.pod:378
18330 "Enable very verbose messages. This is particularly useful if you find a "
18335 #: ../fish/guestfish.pod:381
18340 #: ../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
18341 msgid "B<--version>"
18345 #: ../fish/guestfish.pod:385
18346 msgid "Display the guestfish / libguestfs version number and exit."
18350 #: ../fish/guestfish.pod:387
18355 #: ../fish/guestfish.pod:389
18360 #: ../fish/guestfish.pod:391
18362 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
18367 #: ../fish/guestfish.pod:394
18372 #: ../fish/guestfish.pod:396
18373 msgid "Echo each command before executing it."
18377 #: ../fish/guestfish.pod:400
18378 msgid "COMMANDS ON COMMAND LINE"
18382 #: ../fish/guestfish.pod:402
18383 msgid "Any additional (non-option) arguments are treated as commands to execute."
18387 #: ../fish/guestfish.pod:405
18389 "Commands to execute should be separated by a colon (C<:>), where the colon "
18390 "is a separate parameter. Thus:"
18394 #: ../fish/guestfish.pod:408
18397 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18402 #: ../fish/guestfish.pod:410
18404 "If there are no additional arguments, then we enter a shell, either an "
18405 "interactive shell with a prompt (if the input is a terminal) or a "
18406 "non-interactive shell."
18410 #: ../fish/guestfish.pod:414
18412 "In either command line mode or non-interactive shell, the first command that "
18413 "gives an error causes the whole shell to exit. In interactive mode (with a "
18414 "prompt) if a command fails, you can continue to enter commands."
18418 #: ../fish/guestfish.pod:419
18419 msgid "USING launch (OR run)"
18423 #: ../fish/guestfish.pod:421
18425 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18426 "then launch it, then mount any disks you need, and finally issue "
18427 "actions/commands. So the general order of the day is:"
18431 #: ../fish/guestfish.pod:429
18432 msgid "add or -a/--add"
18436 #: ../fish/guestfish.pod:433
18437 msgid "launch (aka run)"
18441 #: ../fish/guestfish.pod:437
18442 msgid "mount or -m/--mount"
18446 #: ../fish/guestfish.pod:441
18447 msgid "any other commands"
18451 #: ../fish/guestfish.pod:445
18453 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18454 "guest before mounting or performing any other commands."
18458 #: ../fish/guestfish.pod:448
18460 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18461 "I<--new> options were given then C<run> is done automatically, simply "
18462 "because guestfish can't perform the action you asked for without doing this."
18466 #: ../fish/guestfish.pod:453
18467 msgid "OPENING DISKS FOR READ AND WRITE"
18471 #: ../fish/guestfish.pod:455
18473 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
18474 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
18475 "open disk images read-only or for writing."
18479 #: ../fish/guestfish.pod:459
18481 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
18482 "disk images supplied on the command line for write. To open a disk image "
18483 "read-only you have to do I<-a image --ro>."
18487 #: ../fish/guestfish.pod:463
18489 "This matters: If you accidentally open a live VM disk image writable then "
18490 "you will cause irreversible disk corruption."
18494 #: ../fish/guestfish.pod:466
18496 "By libguestfs 1.10 we intend to change the default the other way. Disk "
18497 "images will be opened read-only. You will have to either specify "
18498 "I<guestfish --rw> or change a configuration file in order to get write "
18499 "access for disk images specified by those other command line options."
18503 #: ../fish/guestfish.pod:471
18505 "This version of guestfish has a I<--rw> option which does nothing (it is "
18506 "already the default). However it is highly recommended that you use this "
18507 "option to indicate that guestfish needs write access, and to prepare your "
18508 "scripts for the day when this option will be required for write access."
18512 #: ../fish/guestfish.pod:477
18514 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18515 "other libguestfs program apart from guestfish and guestmount."
18519 #: ../fish/guestfish.pod:480
18524 #: ../fish/guestfish.pod:482
18526 "You can quote ordinary parameters using either single or double quotes. For "
18531 #: ../fish/guestfish.pod:485
18534 " add \"file with a space.img\"\n"
18539 #: ../fish/guestfish.pod:487
18542 " rm '/file name'\n"
18547 #: ../fish/guestfish.pod:489
18555 #: ../fish/guestfish.pod:491
18557 "A few commands require a list of strings to be passed. For these, use a "
18558 "whitespace-separated list, enclosed in quotes. Strings containing "
18559 "whitespace to be passed through must be enclosed in single quotes. A "
18560 "literal single quote must be escaped with a backslash."
18564 #: ../fish/guestfish.pod:496
18567 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18568 " command \"/bin/echo 'foo bar'\"\n"
18569 " command \"/bin/echo \\'foo\\'\"\n"
18574 #: ../fish/guestfish.pod:500
18575 msgid "OPTIONAL ARGUMENTS"
18579 #: ../fish/guestfish.pod:502
18581 "Some commands take optional arguments. These arguments appear in this "
18582 "documentation as C<[argname:..]>. You can use them as in these examples:"
18586 #: ../fish/guestfish.pod:506
18589 " add-drive-opts filename\n"
18594 #: ../fish/guestfish.pod:508
18597 " add-drive-opts filename readonly:true\n"
18602 #: ../fish/guestfish.pod:510
18605 " add-drive-opts filename format:qcow2 readonly:false\n"
18610 #: ../fish/guestfish.pod:512
18612 "Each optional argument can appear at most once. All optional arguments must "
18613 "appear after the required ones."
18617 #: ../fish/guestfish.pod:515
18622 #: ../fish/guestfish.pod:517
18623 msgid "This section applies to all commands which can take integers as parameters."
18627 #: ../fish/guestfish.pod:520
18628 msgid "SIZE SUFFIX"
18632 #: ../fish/guestfish.pod:522
18634 "When the command takes a parameter measured in bytes, you can use one of the "
18635 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18639 #: ../fish/guestfish.pod:528
18640 msgid "B<k> or B<K> or B<KiB>"
18644 #: ../fish/guestfish.pod:530
18645 msgid "The size in kilobytes (multiplied by 1024)."
18649 #: ../fish/guestfish.pod:532
18654 #: ../fish/guestfish.pod:534
18655 msgid "The size in SI 1000 byte units."
18659 #: ../fish/guestfish.pod:536
18660 msgid "B<M> or B<MiB>"
18664 #: ../fish/guestfish.pod:538
18665 msgid "The size in megabytes (multiplied by 1048576)."
18669 #: ../fish/guestfish.pod:540
18674 #: ../fish/guestfish.pod:542
18675 msgid "The size in SI 1000000 byte units."
18679 #: ../fish/guestfish.pod:544
18680 msgid "B<G> or B<GiB>"
18684 #: ../fish/guestfish.pod:546
18685 msgid "The size in gigabytes (multiplied by 2**30)."
18689 #: ../fish/guestfish.pod:548
18694 #: ../fish/guestfish.pod:550
18695 msgid "The size in SI 10**9 byte units."
18699 #: ../fish/guestfish.pod:552
18700 msgid "B<T> or B<TiB>"
18704 #: ../fish/guestfish.pod:554
18705 msgid "The size in terabytes (multiplied by 2**40)."
18709 #: ../fish/guestfish.pod:556
18714 #: ../fish/guestfish.pod:558
18715 msgid "The size in SI 10**12 byte units."
18719 #: ../fish/guestfish.pod:560
18720 msgid "B<P> or B<PiB>"
18724 #: ../fish/guestfish.pod:562
18725 msgid "The size in petabytes (multiplied by 2**50)."
18729 #: ../fish/guestfish.pod:564
18734 #: ../fish/guestfish.pod:566
18735 msgid "The size in SI 10**15 byte units."
18739 #: ../fish/guestfish.pod:568
18740 msgid "B<E> or B<EiB>"
18744 #: ../fish/guestfish.pod:570
18745 msgid "The size in exabytes (multiplied by 2**60)."
18749 #: ../fish/guestfish.pod:572
18754 #: ../fish/guestfish.pod:574
18755 msgid "The size in SI 10**18 byte units."
18759 #: ../fish/guestfish.pod:576
18760 msgid "B<Z> or B<ZiB>"
18764 #: ../fish/guestfish.pod:578
18765 msgid "The size in zettabytes (multiplied by 2**70)."
18769 #: ../fish/guestfish.pod:580
18774 #: ../fish/guestfish.pod:582
18775 msgid "The size in SI 10**21 byte units."
18779 #: ../fish/guestfish.pod:584
18780 msgid "B<Y> or B<YiB>"
18784 #: ../fish/guestfish.pod:586
18785 msgid "The size in yottabytes (multiplied by 2**80)."
18789 #: ../fish/guestfish.pod:588
18794 #: ../fish/guestfish.pod:590
18795 msgid "The size in SI 10**24 byte units."
18799 #: ../fish/guestfish.pod:596
18802 " truncate-size /file 1G\n"
18807 #: ../fish/guestfish.pod:598
18808 msgid "would truncate the file to 1 gigabyte."
18812 #: ../fish/guestfish.pod:600
18814 "Be careful because a few commands take sizes in kilobytes or megabytes "
18815 "(eg. the parameter to L</memsize> is specified in megabytes already). "
18816 "Adding a suffix will probably not do what you expect."
18820 #: ../fish/guestfish.pod:604
18821 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18825 #: ../fish/guestfish.pod:606
18827 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18828 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18832 #: ../fish/guestfish.pod:609
18835 " 1234 decimal number 1234\n"
18836 " 02322 octal number, equivalent to decimal 1234\n"
18837 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18842 #: ../fish/guestfish.pod:613
18844 "When using the C<chmod> command, you almost always want to specify an octal "
18845 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18846 "L<chmod(1)> program):"
18850 #: ../fish/guestfish.pod:617
18853 " chmod 0777 /public # OK\n"
18854 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18859 #: ../fish/guestfish.pod:620
18861 "Commands that return numbers usually print them in decimal, but some "
18862 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18863 "octal, preceeded by C<0>)."
18867 #: ../fish/guestfish.pod:624
18868 msgid "WILDCARDS AND GLOBBING"
18872 #: ../fish/guestfish.pod:626
18874 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18875 "(globbing) by default. So for example the following will not do what you "
18880 #: ../fish/guestfish.pod:630
18888 #: ../fish/guestfish.pod:632
18890 "Assuming you don't have a directory called literally C</home/*> then the "
18891 "above command will return an error."
18895 #: ../fish/guestfish.pod:635
18896 msgid "To perform wildcard expansion, use the C<glob> command."
18900 #: ../fish/guestfish.pod:637
18903 " glob rm-rf /home/*\n"
18908 #: ../fish/guestfish.pod:639
18910 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18911 "many times), equivalent to:"
18915 #: ../fish/guestfish.pod:642
18918 " rm-rf /home/jim\n"
18919 " rm-rf /home/joe\n"
18920 " rm-rf /home/mary\n"
18925 #: ../fish/guestfish.pod:646
18926 msgid "C<glob> only works on simple guest paths and not on device names."
18930 #: ../fish/guestfish.pod:648
18932 "If you have several parameters, each containing a wildcard, then glob will "
18933 "perform a Cartesian product."
18937 #: ../fish/guestfish.pod:651
18942 #: ../fish/guestfish.pod:653
18944 "Any line which starts with a I<#> character is treated as a comment and "
18945 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18946 "a command. For example:"
18950 #: ../fish/guestfish.pod:657
18953 " # this is a comment\n"
18954 " # this is a comment\n"
18955 " foo # NOT a comment\n"
18960 #: ../fish/guestfish.pod:661
18961 msgid "Blank lines are also ignored."
18965 #: ../fish/guestfish.pod:663
18966 msgid "RUNNING COMMANDS LOCALLY"
18970 #: ../fish/guestfish.pod:665
18972 "Any line which starts with a I<!> character is treated as a command sent to "
18973 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18977 #: ../fish/guestfish.pod:669
18981 " tgz-out /remote local/remote-data.tar.gz\n"
18986 #: ../fish/guestfish.pod:672
18988 "will create a directory C<local> on the host, and then export the contents "
18989 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18990 "(See C<tgz-out>)."
18994 #: ../fish/guestfish.pod:676
18996 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18997 "effect, due to the way that subprocesses work in Unix."
19001 #: ../fish/guestfish.pod:679
19006 #: ../fish/guestfish.pod:681
19008 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19009 "command (a guestfish command) to the second command (any host command). For "
19014 #: ../fish/guestfish.pod:685
19017 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19022 #: ../fish/guestfish.pod:687
19024 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19025 "program). The above command would list all accounts in the guest filesystem "
19026 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19030 #: ../fish/guestfish.pod:692
19033 " hexdump /bin/ls | head\n"
19034 " list-devices | tail -1\n"
19035 " tgz-out / - | tar ztf -\n"
19040 #: ../fish/guestfish.pod:696
19042 "The space before the pipe symbol is required, any space after the pipe "
19043 "symbol is optional. Everything after the pipe symbol is just passed "
19044 "straight to the host shell, so it can contain redirections, globs and "
19045 "anything else that makes sense on the host side."
19049 #: ../fish/guestfish.pod:701
19051 "To use a literal argument which begins with a pipe symbol, you have to quote "
19056 #: ../fish/guestfish.pod:704
19064 #: ../fish/guestfish.pod:706
19065 msgid "HOME DIRECTORIES"
19069 #: ../fish/guestfish.pod:708
19071 "If a parameter starts with the character C<~> then the tilde may be expanded "
19072 "as a home directory path (either C<~> for the current user's home directory, "
19073 "or C<~user> for another user)."
19077 #: ../fish/guestfish.pod:712
19079 "Note that home directory expansion happens for users known I<on the host>, "
19080 "not in the guest filesystem."
19084 #: ../fish/guestfish.pod:715
19086 "To use a literal argument which begins with a tilde, you have to quote it, "
19091 #: ../fish/guestfish.pod:718
19099 #: ../fish/guestfish.pod:722
19101 "Libguestfs has some support for Linux guests encrypted according to the "
19102 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19103 "disk encryption systems used by modern Linux guests. Currently only "
19104 "LVM-on-LUKS is supported."
19108 #: ../fish/guestfish.pod:727
19109 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19113 #: ../fish/guestfish.pod:729
19116 " ><fs> vfs-type /dev/sda2\n"
19122 #: ../fish/guestfish.pod:732
19124 "Then open those devices using L</luks-open>. This creates a device-mapper "
19125 "device called C</dev/mapper/luksdev>."
19129 #: ../fish/guestfish.pod:735
19132 " ><fs> luks-open /dev/sda2 luksdev\n"
19133 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19138 #: ../fish/guestfish.pod:738
19140 "Finally you have to tell LVM to scan for volume groups on the newly created "
19145 #: ../fish/guestfish.pod:741
19149 " vg-activate-all true\n"
19154 #: ../fish/guestfish.pod:744
19155 msgid "The logical volume(s) can now be mounted in the usual way."
19159 #: ../fish/guestfish.pod:746
19161 "Before closing a LUKS device you must unmount any logical volumes on it and "
19162 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19163 "one. Then you can close the mapper device:"
19167 #: ../fish/guestfish.pod:750
19170 " vg-activate false /dev/VG\n"
19171 " luks-close /dev/mapper/luksdev\n"
19176 #: ../fish/guestfish.pod:753
19177 msgid "WINDOWS PATHS"
19181 #: ../fish/guestfish.pod:755
19183 "If a path is prefixed with C<win:> then you can use Windows-style paths "
19184 "(with some limitations). The following commands are equivalent:"
19188 #: ../fish/guestfish.pod:758
19191 " file /WINDOWS/system32/config/system.LOG\n"
19196 #: ../fish/guestfish.pod:760
19199 " file win:/windows/system32/config/system.log\n"
19204 #: ../fish/guestfish.pod:762
19207 " file win:\\windows\\system32\\config\\system.log\n"
19212 #: ../fish/guestfish.pod:764
19215 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
19220 #: ../fish/guestfish.pod:766
19222 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
19223 "handles case insensitivity like Windows would. This only works in argument "
19224 "positions that expect a path."
19228 #: ../fish/guestfish.pod:770
19229 msgid "UPLOADING AND DOWNLOADING FILES"
19233 #: ../fish/guestfish.pod:772
19235 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19236 "others which upload from or download to a local file, you can use the "
19237 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19241 #: ../fish/guestfish.pod:776
19249 #: ../fish/guestfish.pod:778
19250 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19254 #: ../fish/guestfish.pod:781
19257 " tar-out /etc - | tar tf -\n"
19262 #: ../fish/guestfish.pod:783
19264 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19265 "command (see L</PIPES>)."
19269 #: ../fish/guestfish.pod:786
19271 "When using C<-> to read from stdin, the input is read up to the end of "
19272 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19273 "some arbitrary end marker:"
19277 #: ../fish/guestfish.pod:790
19280 " upload -<<END /foo\n"
19289 #: ../fish/guestfish.pod:796
19291 "Any string of characters can be used instead of C<END>. The end marker must "
19292 "appear on a line of its own, without any preceeding or following characters "
19293 "(not even spaces)."
19297 #: ../fish/guestfish.pod:800
19299 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19300 "upload local files (so-called \"FileIn\" parameters in the generator)."
19304 #: ../fish/guestfish.pod:803
19305 msgid "EXIT ON ERROR BEHAVIOUR"
19309 #: ../fish/guestfish.pod:805
19311 "By default, guestfish will ignore any errors when in interactive mode "
19312 "(ie. taking commands from a human over a tty), and will exit on the first "
19313 "error in non-interactive mode (scripts, commands given on the command line)."
19317 #: ../fish/guestfish.pod:810
19319 "If you prefix a command with a I<-> character, then that command will not "
19320 "cause guestfish to exit, even if that (one) command returns an error."
19324 #: ../fish/guestfish.pod:814
19325 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19329 #: ../fish/guestfish.pod:816
19331 "Guestfish can be remote-controlled over a socket. This is useful "
19332 "particularly in shell scripts where you want to make several different "
19333 "changes to a filesystem, but you don't want the overhead of starting up a "
19334 "guestfish process each time."
19338 #: ../fish/guestfish.pod:821
19339 msgid "Start a guestfish server process using:"
19343 #: ../fish/guestfish.pod:823
19346 " eval \"`guestfish --listen`\"\n"
19351 #: ../fish/guestfish.pod:825
19352 msgid "and then send it commands by doing:"
19356 #: ../fish/guestfish.pod:827
19359 " guestfish --remote cmd [...]\n"
19364 #: ../fish/guestfish.pod:829
19365 msgid "To cause the server to exit, send it the exit command:"
19369 #: ../fish/guestfish.pod:831
19372 " guestfish --remote exit\n"
19377 #: ../fish/guestfish.pod:833
19379 "Note that the server will normally exit if there is an error in a command. "
19380 "You can change this in the usual way. See section L</EXIT ON ERROR "
19385 #: ../fish/guestfish.pod:837
19386 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19390 #: ../fish/guestfish.pod:839
19392 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19393 "is how the I<--remote> option knows where to send the commands. You can "
19394 "have several guestfish listener processes running using:"
19398 #: ../fish/guestfish.pod:843
19401 " eval \"`guestfish --listen`\"\n"
19402 " pid1=$GUESTFISH_PID\n"
19403 " eval \"`guestfish --listen`\"\n"
19404 " pid2=$GUESTFISH_PID\n"
19406 " guestfish --remote=$pid1 cmd\n"
19407 " guestfish --remote=$pid2 cmd\n"
19412 #: ../fish/guestfish.pod:851
19413 msgid "REMOTE CONTROL AND CSH"
19417 #: ../fish/guestfish.pod:853
19419 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19424 #: ../fish/guestfish.pod:856
19427 " eval \"`guestfish --listen --csh`\"\n"
19432 #: ../fish/guestfish.pod:858
19433 msgid "REMOTE CONTROL DETAILS"
19437 #: ../fish/guestfish.pod:860
19439 "Remote control happens over a Unix domain socket called "
19440 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19441 "of the process, and C<$PID> is the process ID of the server."
19445 #: ../fish/guestfish.pod:864
19446 msgid "Guestfish client and server versions must match exactly."
19450 #: ../fish/guestfish.pod:866
19451 msgid "PREPARED DISK IMAGES"
19455 #: ../fish/guestfish.pod:868
19457 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19458 "preformatted disk images that guestfish can make for you to save typing. "
19459 "This is particularly useful for testing purposes. This option is used "
19460 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19461 "can be mixed with I<-a>)."
19465 #: ../fish/guestfish.pod:874
19467 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19468 "the second and so on. Existing files in the current directory are "
19473 #: ../fish/guestfish.pod:878
19475 "The type briefly describes how the disk should be sized, partitioned, how "
19476 "filesystem(s) should be created, and how content should be added. "
19477 "Optionally the type can be followed by extra parameters, separated by C<:> "
19478 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19479 "sparsely-allocated disk, containing a single partition, with the partition "
19480 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19481 "on a 1GB disk instead."
19485 #: ../fish/guestfish.pod:886
19486 msgid "To list the available types and any extra parameters they take, run:"
19490 #: ../fish/guestfish.pod:890
19492 "Note that the prepared filesystem is not mounted. You would usually have to "
19493 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19497 #: ../fish/guestfish.pod:894
19499 "If any I<-N> or I<--new> options are given, the guest is automatically "
19504 #: ../fish/guestfish.pod:899
19505 msgid "Create a 100MB disk with an ext4-formatted partition:"
19509 #: ../fish/guestfish.pod:901
19512 " guestfish -N fs:ext4\n"
19517 #: ../fish/guestfish.pod:903
19518 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19522 #: ../fish/guestfish.pod:905
19525 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19530 #: ../fish/guestfish.pod:907
19531 msgid "Create a blank 200MB disk:"
19535 #: ../fish/guestfish.pod:909
19538 " guestfish -N disk:200M\n"
19543 #: ../fish/guestfish.pod:911
19544 msgid "PROGRESS BARS"
19548 #: ../fish/guestfish.pod:913
19550 "Some (not all) long-running commands send progress notification messages as "
19551 "they are running. Guestfish turns these messages into progress bars."
19555 #: ../fish/guestfish.pod:917
19557 "When a command that supports progress bars takes longer than two seconds to "
19558 "run, and if progress bars are enabled, then you will see one appearing below "
19563 #: ../fish/guestfish.pod:921
19566 " ><fs> copy-size /large-file /another-file 2048M\n"
19567 " / 10% [#####-----------------------------------------] 00:30\n"
19572 #: ../fish/guestfish.pod:924
19574 "The spinner on the left hand side moves round once for every progress "
19575 "notification received from the backend. This is a (reasonably) golden "
19576 "assurance that the command is \"doing something\" even if the progress bar "
19577 "is not moving, because the command is able to send the progress "
19578 "notifications. When the bar reaches 100% and the command finishes, the "
19579 "spinner disappears."
19583 #: ../fish/guestfish.pod:931
19585 "Progress bars are enabled by default when guestfish is used interactively. "
19586 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19587 "and you can disable them completely using I<--no-progress-bars>."
19591 #: ../fish/guestfish.pod:936
19592 msgid "GUESTFISH COMMANDS"
19596 #: ../fish/guestfish.pod:938
19598 "The commands in this section are guestfish convenience commands, in other "
19599 "words, they are not part of the L<guestfs(3)> API."
19603 #: ../fish/guestfish.pod:941
19608 #: ../fish/guestfish.pod:943
19617 #: ../fish/guestfish.pod:946
19618 msgid "Without any parameter, this provides general help."
19622 #: ../fish/guestfish.pod:948
19623 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19627 #: ../fish/guestfish.pod:950
19628 msgid "quit | exit"
19632 #: ../fish/guestfish.pod:952
19633 msgid "This exits guestfish. You can also use C<^D> key."
19637 #: ../fish/guestfish.pod:954
19638 msgid "@FISH_COMMANDS@"
19642 #: ../fish/guestfish.pod:956
19647 #: ../fish/guestfish.pod:960 ../test-tool/libguestfs-test-tool.pod:83
19652 #: ../fish/guestfish.pod:962
19654 "guestfish returns 0 if the commands completed without error, or 1 if there "
19659 #: ../fish/guestfish.pod:969
19664 #: ../fish/guestfish.pod:971
19666 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19671 #: ../fish/guestfish.pod:974
19672 msgid "GUESTFISH_PID"
19676 #: ../fish/guestfish.pod:976
19678 "Used with the I<--remote> option to specify the remote guestfish process to "
19679 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19683 #: ../fish/guestfish.pod:980
19688 #: ../fish/guestfish.pod:982
19690 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19691 "not specified, the external L<hexedit(1)> program is used."
19695 #: ../fish/guestfish.pod:986
19700 #: ../fish/guestfish.pod:988
19702 "If compiled with GNU readline support, various files in the home directory "
19703 "can be used. See L</FILES>."
19707 #: ../fish/guestfish.pod:997
19709 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19710 "effect as using the B<-v> option."
19714 #: ../fish/guestfish.pod:1009
19716 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19717 "the discussion of paths in L<guestfs(3)>."
19721 #: ../fish/guestfish.pod:1020
19722 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19726 #: ../fish/guestfish.pod:1022
19731 #: ../fish/guestfish.pod:1024
19733 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19738 #: ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:88
19743 #: ../fish/guestfish.pod:1043
19744 msgid "$HOME/.guestfish"
19748 #: ../fish/guestfish.pod:1045
19750 "If compiled with GNU readline support, then the command history is saved in "
19755 #: ../fish/guestfish.pod:1048
19756 msgid "$HOME/.inputrc"
19760 #: ../fish/guestfish.pod:1050
19761 msgid "/etc/inputrc"
19765 #: ../fish/guestfish.pod:1052
19767 "If compiled with GNU readline support, then these files can be used to "
19768 "configure readline. For further information, please see "
19769 "L<readline(3)/INITIALIZATION FILE>."
19773 #: ../fish/guestfish.pod:1056
19774 msgid "To write rules which only apply to guestfish, use:"
19778 #: ../fish/guestfish.pod:1058
19788 #: ../fish/guestfish.pod:1062
19790 "Variables that you can set in inputrc that change the behaviour of guestfish "
19791 "in useful ways include:"
19795 #: ../fish/guestfish.pod:1067
19796 msgid "completion-ignore-case (default: on)"
19800 #: ../fish/guestfish.pod:1069
19802 "By default, guestfish will ignore case when tab-completing paths on the "
19807 #: ../fish/guestfish.pod:1072
19810 " set completion-ignore-case off\n"
19815 #: ../fish/guestfish.pod:1074
19816 msgid "to make guestfish case sensitive."
19820 #: ../fish/guestfish.pod:1078
19825 #: ../fish/guestfish.pod:1080
19826 msgid "test2.img (etc)"
19830 #: ../fish/guestfish.pod:1082
19832 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19833 "will be created in the file C<test1.img> in the current directory. The "
19834 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19835 "the same name will be overwritten."
19839 #: ../fish/guestfish.pod:1091
19841 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19842 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
19843 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
19844 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
19845 "L<virt-win-reg(1)>, L<hexedit(1)>."
19849 #: ../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
19851 "This program is free software; you can redistribute it and/or modify it "
19852 "under the terms of the GNU General Public License as published by the Free "
19853 "Software Foundation; either version 2 of the License, or (at your option) "
19854 "any later version."
19858 #: ../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
19860 "This program is distributed in the hope that it will be useful, but WITHOUT "
19861 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19862 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19867 #: ../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
19869 "You should have received a copy of the GNU General Public License along with "
19870 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19871 "Ave, Cambridge, MA 02139, USA."
19875 #: ../fish/guestfish-actions.pod:1
19880 #: ../fish/guestfish-actions.pod:3
19883 " add-cdrom filename\n"
19888 #: ../fish/guestfish-actions.pod:15
19890 "This call checks for the existence of C<filename>. This stops you from "
19891 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19892 "and C<http:> URLs. To specify those, use the general L</config> call "
19897 #: ../fish/guestfish-actions.pod:22
19899 "If you just want to add an ISO file (often you use this as an efficient way "
19900 "to transfer large files into the guest), then you should probably use "
19901 "L</add-drive-ro> instead."
19905 #: ../fish/guestfish-actions.pod:35
19910 #: ../fish/guestfish-actions.pod:37
19915 #: ../fish/guestfish-actions.pod:39
19918 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19923 #: ../fish/guestfish-actions.pod:41
19925 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19926 "It works by connecting to libvirt, requesting the domain and domain XML from "
19927 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19931 #: ../fish/guestfish-actions.pod:64
19933 "The other optional parameters are passed directly through to "
19934 "L</add-drive-opts>."
19938 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131 ../fish/guestfish-actions.pod:2845
19940 "This command has one or more optional arguments. See L</OPTIONAL "
19945 #: ../fish/guestfish-actions.pod:69
19950 #: ../fish/guestfish-actions.pod:71
19953 " add-drive filename\n"
19958 #: ../fish/guestfish-actions.pod:73
19960 "This function is the equivalent of calling L</add-drive-opts> with no "
19961 "optional parameters, so the disk is added writable, with the format being "
19962 "detected automatically."
19966 #: ../fish/guestfish-actions.pod:77
19968 "Automatic detection of the format opens you up to a potential security hole "
19969 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19970 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19971 "you should think about replacing calls to this function with calls to "
19972 "L</add-drive-opts>, and specifying the format."
19976 #: ../fish/guestfish-actions.pod:84
19977 msgid "add-drive-opts"
19981 #: ../fish/guestfish-actions.pod:86
19986 #: ../fish/guestfish-actions.pod:88
19989 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19994 #: ../fish/guestfish-actions.pod:115
19996 "This forces the image format. If you omit this (or use L</add-drive> or "
19997 "L</add-drive-ro>) then the format is automatically detected. Possible "
19998 "formats include C<raw> and C<qcow2>."
20002 #: ../fish/guestfish-actions.pod:126
20004 "This rarely-used option lets you emulate the behaviour of the deprecated "
20005 "L</add-drive-with-if> call (q.v.)"
20009 #: ../fish/guestfish-actions.pod:133
20010 msgid "add-drive-ro"
20014 #: ../fish/guestfish-actions.pod:135
20019 #: ../fish/guestfish-actions.pod:137
20022 " add-drive-ro filename\n"
20027 #: ../fish/guestfish-actions.pod:139
20029 "This function is the equivalent of calling L</add-drive-opts> with the "
20030 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20031 "is added read-only, with the format being detected automatically."
20035 #: ../fish/guestfish-actions.pod:144
20036 msgid "add-drive-ro-with-if"
20040 #: ../fish/guestfish-actions.pod:146
20043 " add-drive-ro-with-if filename iface\n"
20048 #: ../fish/guestfish-actions.pod:148
20050 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
20051 "interface emulation to use at run time."
20055 #: ../fish/guestfish-actions.pod:158
20056 msgid "add-drive-with-if"
20060 #: ../fish/guestfish-actions.pod:160
20063 " add-drive-with-if filename iface\n"
20068 #: ../fish/guestfish-actions.pod:162
20070 "This is the same as L</add-drive> but it allows you to specify the QEMU "
20071 "interface emulation to use at run time."
20075 #: ../fish/guestfish-actions.pod:172
20080 #: ../fish/guestfish-actions.pod:174
20083 " aug-clear augpath\n"
20088 #: ../fish/guestfish-actions.pod:179
20093 #: ../fish/guestfish-actions.pod:181
20101 #: ../fish/guestfish-actions.pod:183
20103 "Close the current Augeas handle and free up any resources used by it. After "
20104 "calling this, you have to call L</aug-init> again before you can use any "
20105 "other Augeas functions."
20109 #: ../fish/guestfish-actions.pod:188
20110 msgid "aug-defnode"
20114 #: ../fish/guestfish-actions.pod:190
20117 " aug-defnode name expr val\n"
20122 #: ../fish/guestfish-actions.pod:195
20124 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
20125 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
20126 "containing that single node."
20130 #: ../fish/guestfish-actions.pod:203
20135 #: ../fish/guestfish-actions.pod:205
20138 " aug-defvar name expr\n"
20143 #: ../fish/guestfish-actions.pod:214
20148 #: ../fish/guestfish-actions.pod:216
20151 " aug-get augpath\n"
20156 #: ../fish/guestfish-actions.pod:221
20161 #: ../fish/guestfish-actions.pod:223
20164 " aug-init root flags\n"
20169 #: ../fish/guestfish-actions.pod:229
20170 msgid "You must call this before using any other L</aug-*> commands."
20174 #: ../fish/guestfish-actions.pod:264
20175 msgid "Do not load the tree in L</aug-init>."
20179 #: ../fish/guestfish-actions.pod:268
20180 msgid "To close the handle, you can call L</aug-close>."
20184 #: ../fish/guestfish-actions.pod:272
20189 #: ../fish/guestfish-actions.pod:274
20192 " aug-insert augpath label true|false\n"
20197 #: ../fish/guestfish-actions.pod:284
20202 #: ../fish/guestfish-actions.pod:286
20210 #: ../fish/guestfish-actions.pod:293
20215 #: ../fish/guestfish-actions.pod:295
20218 " aug-ls augpath\n"
20223 #: ../fish/guestfish-actions.pod:297
20225 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
20226 "resulting nodes into alphabetical order."
20230 #: ../fish/guestfish-actions.pod:300
20235 #: ../fish/guestfish-actions.pod:302
20238 " aug-match augpath\n"
20243 #: ../fish/guestfish-actions.pod:308
20248 #: ../fish/guestfish-actions.pod:310
20251 " aug-mv src dest\n"
20256 #: ../fish/guestfish-actions.pod:315
20261 #: ../fish/guestfish-actions.pod:317
20264 " aug-rm augpath\n"
20269 #: ../fish/guestfish-actions.pod:323
20274 #: ../fish/guestfish-actions.pod:325
20282 #: ../fish/guestfish-actions.pod:329
20284 "The flags which were passed to L</aug-init> affect exactly how files are "
20289 #: ../fish/guestfish-actions.pod:332
20294 #: ../fish/guestfish-actions.pod:334
20297 " aug-set augpath val\n"
20302 #: ../fish/guestfish-actions.pod:338
20304 "In the Augeas API, it is possible to clear a node by setting the value to "
20305 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
20306 "this call. Instead you must use the L</aug-clear> call."
20310 #: ../fish/guestfish-actions.pod:343
20315 #: ../fish/guestfish-actions.pod:345
20318 " available 'groups ...'\n"
20323 #: ../fish/guestfish-actions.pod:351
20325 "The libguestfs groups, and the functions that those groups correspond to, "
20326 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
20327 "runtime by calling L</available-all-groups>."
20331 #: ../fish/guestfish-actions.pod:375
20332 msgid "You must call L</launch> before calling this function."
20336 #: ../fish/guestfish-actions.pod:397
20338 "This call was added in version C<1.0.80>. In previous versions of "
20339 "libguestfs all you could do would be to speculatively execute a command to "
20340 "find out if the daemon implemented it. See also L</version>."
20344 #: ../fish/guestfish-actions.pod:404
20345 msgid "available-all-groups"
20349 #: ../fish/guestfish-actions.pod:406
20352 " available-all-groups\n"
20357 #: ../fish/guestfish-actions.pod:408
20359 "This command returns a list of all optional groups that this daemon knows "
20360 "about. Note this returns both supported and unsupported groups. To find "
20361 "out which ones the daemon can actually support you have to call "
20362 "L</available> on each member of the returned list."
20366 #: ../fish/guestfish-actions.pod:414
20367 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
20371 #: ../fish/guestfish-actions.pod:416
20376 #: ../fish/guestfish-actions.pod:418
20379 " base64-in (base64file|-) filename\n"
20384 #: ../fish/guestfish-actions.pod:423 ../fish/guestfish-actions.pod:432 ../fish/guestfish-actions.pod:656 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:844 ../fish/guestfish-actions.pod:1218 ../fish/guestfish-actions.pod:4200 ../fish/guestfish-actions.pod:4212 ../fish/guestfish-actions.pod:4223 ../fish/guestfish-actions.pod:4234 ../fish/guestfish-actions.pod:4286 ../fish/guestfish-actions.pod:4295 ../fish/guestfish-actions.pod:4349 ../fish/guestfish-actions.pod:4372
20385 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
20389 #: ../fish/guestfish-actions.pod:425
20394 #: ../fish/guestfish-actions.pod:427
20397 " base64-out filename (base64file|-)\n"
20402 #: ../fish/guestfish-actions.pod:434
20403 msgid "blockdev-flushbufs"
20407 #: ../fish/guestfish-actions.pod:436
20410 " blockdev-flushbufs device\n"
20415 #: ../fish/guestfish-actions.pod:443
20416 msgid "blockdev-getbsz"
20420 #: ../fish/guestfish-actions.pod:445
20423 " blockdev-getbsz device\n"
20428 #: ../fish/guestfish-actions.pod:454
20429 msgid "blockdev-getro"
20433 #: ../fish/guestfish-actions.pod:456
20436 " blockdev-getro device\n"
20441 #: ../fish/guestfish-actions.pod:463
20442 msgid "blockdev-getsize64"
20446 #: ../fish/guestfish-actions.pod:465
20449 " blockdev-getsize64 device\n"
20454 #: ../fish/guestfish-actions.pod:469
20455 msgid "See also L</blockdev-getsz>."
20459 #: ../fish/guestfish-actions.pod:473
20460 msgid "blockdev-getss"
20464 #: ../fish/guestfish-actions.pod:475
20467 " blockdev-getss device\n"
20472 #: ../fish/guestfish-actions.pod:480
20473 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
20477 #: ../fish/guestfish-actions.pod:485
20478 msgid "blockdev-getsz"
20482 #: ../fish/guestfish-actions.pod:487
20485 " blockdev-getsz device\n"
20490 #: ../fish/guestfish-actions.pod:492
20492 "See also L</blockdev-getss> for the real sector size of the device, and "
20493 "L</blockdev-getsize64> for the more useful I<size in bytes>."
20497 #: ../fish/guestfish-actions.pod:498
20498 msgid "blockdev-rereadpt"
20502 #: ../fish/guestfish-actions.pod:500
20505 " blockdev-rereadpt device\n"
20510 #: ../fish/guestfish-actions.pod:506
20511 msgid "blockdev-setbsz"
20515 #: ../fish/guestfish-actions.pod:508
20518 " blockdev-setbsz device blocksize\n"
20523 #: ../fish/guestfish-actions.pod:517
20524 msgid "blockdev-setro"
20528 #: ../fish/guestfish-actions.pod:519
20531 " blockdev-setro device\n"
20536 #: ../fish/guestfish-actions.pod:525
20537 msgid "blockdev-setrw"
20541 #: ../fish/guestfish-actions.pod:527
20544 " blockdev-setrw device\n"
20549 #: ../fish/guestfish-actions.pod:533
20550 msgid "case-sensitive-path"
20554 #: ../fish/guestfish-actions.pod:535
20557 " case-sensitive-path path\n"
20562 #: ../fish/guestfish-actions.pod:559
20564 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
20565 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
20566 "how the directories were originally created under Windows)."
20570 #: ../fish/guestfish-actions.pod:567
20571 msgid "See also L</realpath>."
20575 #: ../fish/guestfish-actions.pod:569
20580 #: ../fish/guestfish-actions.pod:571
20588 #: ../fish/guestfish-actions.pod:575
20590 "Note that this function cannot correctly handle binary files (specifically, "
20591 "files containing C<\\0> character which is treated as end of string). For "
20592 "those you need to use the L</read-file> or L</download> functions which have "
20593 "a more complex interface."
20597 #: ../fish/guestfish-actions.pod:583
20602 #: ../fish/guestfish-actions.pod:585
20605 " checksum csumtype path\n"
20610 #: ../fish/guestfish-actions.pod:628
20611 msgid "To get the checksum for a device, use L</checksum-device>."
20615 #: ../fish/guestfish-actions.pod:630
20616 msgid "To get the checksums for many files, use L</checksums-out>."
20620 #: ../fish/guestfish-actions.pod:632
20621 msgid "checksum-device"
20625 #: ../fish/guestfish-actions.pod:634
20628 " checksum-device csumtype device\n"
20633 #: ../fish/guestfish-actions.pod:636
20635 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20636 "device named C<device>. For the types of checksums supported see the "
20637 "L</checksum> command."
20641 #: ../fish/guestfish-actions.pod:640
20642 msgid "checksums-out"
20646 #: ../fish/guestfish-actions.pod:642
20649 " checksums-out csumtype directory (sumsfile|-)\n"
20654 #: ../fish/guestfish-actions.pod:658
20659 #: ../fish/guestfish-actions.pod:660
20662 " chmod mode path\n"
20667 #: ../fish/guestfish-actions.pod:671
20672 #: ../fish/guestfish-actions.pod:673
20675 " chown owner group path\n"
20680 #: ../fish/guestfish-actions.pod:681
20685 #: ../fish/guestfish-actions.pod:683
20688 " command 'arguments ...'\n"
20693 #: ../fish/guestfish-actions.pod:690
20695 "The single parameter is an argv-style list of arguments. The first element "
20696 "is the name of the program to run. Subsequent elements are parameters. The "
20697 "list must be non-empty (ie. must contain a program name). Note that the "
20698 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20702 #: ../fish/guestfish-actions.pod:718
20703 msgid "command-lines"
20707 #: ../fish/guestfish-actions.pod:720
20710 " command-lines 'arguments ...'\n"
20715 #: ../fish/guestfish-actions.pod:722
20716 msgid "This is the same as L</command>, but splits the result into a list of lines."
20720 #: ../fish/guestfish-actions.pod:725
20721 msgid "See also: L</sh-lines>"
20725 #: ../fish/guestfish-actions.pod:730
20730 #: ../fish/guestfish-actions.pod:732
20733 " config qemuparam qemuvalue\n"
20738 #: ../fish/guestfish-actions.pod:743
20743 #: ../fish/guestfish-actions.pod:745
20746 " copy-size src dest size\n"
20751 #: ../fish/guestfish-actions.pod:753
20756 #: ../fish/guestfish-actions.pod:755
20764 #: ../fish/guestfish-actions.pod:760
20769 #: ../fish/guestfish-actions.pod:762
20777 #: ../fish/guestfish-actions.pod:767
20782 #: ../fish/guestfish-actions.pod:769
20790 #: ../fish/guestfish-actions.pod:776
20792 "If the destination is a device, it must be as large or larger than the "
20793 "source file or device, otherwise the copy will fail. This command cannot do "
20794 "partial copies (see L</copy-size>)."
20798 #: ../fish/guestfish-actions.pod:780
20803 #: ../fish/guestfish-actions.pod:782
20811 #: ../fish/guestfish-actions.pod:786 ../fish/guestfish-actions.pod:797
20813 "This command is mostly useful for interactive sessions. It is I<not> "
20814 "intended that you try to parse the output string. Use L</statvfs> from "
20819 #: ../fish/guestfish-actions.pod:790
20824 #: ../fish/guestfish-actions.pod:792
20832 #: ../fish/guestfish-actions.pod:801
20837 #: ../fish/guestfish-actions.pod:803
20845 #: ../fish/guestfish-actions.pod:809
20847 "Another way to get the same information is to enable verbose messages with "
20848 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20849 "before running the program."
20853 #: ../fish/guestfish-actions.pod:814
20858 #: ../fish/guestfish-actions.pod:816
20861 " download remotefilename (filename|-)\n"
20866 #: ../fish/guestfish-actions.pod:823
20867 msgid "See also L</upload>, L</cat>."
20871 #: ../fish/guestfish-actions.pod:827
20872 msgid "download-offset"
20876 #: ../fish/guestfish-actions.pod:829
20879 " download-offset remotefilename (filename|-) offset size\n"
20884 #: ../fish/guestfish-actions.pod:837
20886 "Note that there is no limit on the amount of data that can be downloaded "
20887 "with this call, unlike with L</pread>, and this call always reads the full "
20888 "amount unless an error occurs."
20892 #: ../fish/guestfish-actions.pod:842
20893 msgid "See also L</download>, L</pread>."
20897 #: ../fish/guestfish-actions.pod:846
20898 msgid "drop-caches"
20902 #: ../fish/guestfish-actions.pod:848
20905 " drop-caches whattodrop\n"
20910 #: ../fish/guestfish-actions.pod:860
20915 #: ../fish/guestfish-actions.pod:862
20923 #: ../fish/guestfish-actions.pod:874
20928 #: ../fish/guestfish-actions.pod:876
20931 " e2fsck-f device\n"
20936 #: ../fish/guestfish-actions.pod:882
20938 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20939 "should use L</fsck>."
20943 #: ../fish/guestfish-actions.pod:885
20944 msgid "echo-daemon"
20948 #: ../fish/guestfish-actions.pod:887
20951 " echo-daemon 'words ...'\n"
20956 #: ../fish/guestfish-actions.pod:894
20957 msgid "See also L</ping-daemon>."
20961 #: ../fish/guestfish-actions.pod:896
20966 #: ../fish/guestfish-actions.pod:898
20969 " egrep regex path\n"
20974 #: ../fish/guestfish-actions.pod:906
20979 #: ../fish/guestfish-actions.pod:908
20982 " egrepi regex path\n"
20987 #: ../fish/guestfish-actions.pod:916
20992 #: ../fish/guestfish-actions.pod:918
20995 " equal file1 file2\n"
21000 #: ../fish/guestfish-actions.pod:925
21005 #: ../fish/guestfish-actions.pod:927
21013 #: ../fish/guestfish-actions.pod:932
21014 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21018 #: ../fish/guestfish-actions.pod:934
21023 #: ../fish/guestfish-actions.pod:936
21026 " fallocate path len\n"
21031 #: ../fish/guestfish-actions.pod:953
21032 msgid "fallocate64"
21036 #: ../fish/guestfish-actions.pod:955
21039 " fallocate64 path len\n"
21044 #: ../fish/guestfish-actions.pod:961
21046 "Note that this call allocates disk blocks for the file. To create a sparse "
21047 "file use L</truncate-size> instead."
21051 #: ../fish/guestfish-actions.pod:964
21053 "The deprecated call L</fallocate> does the same, but owing to an oversight "
21054 "it only allowed 30 bit lengths to be specified, effectively limiting the "
21055 "maximum size of files created through that call to 1GB."
21059 #: ../fish/guestfish-actions.pod:973
21064 #: ../fish/guestfish-actions.pod:975
21067 " fgrep pattern path\n"
21072 #: ../fish/guestfish-actions.pod:983
21077 #: ../fish/guestfish-actions.pod:985
21080 " fgrepi pattern path\n"
21085 #: ../fish/guestfish-actions.pod:993
21090 #: ../fish/guestfish-actions.pod:995
21098 #: ../fish/guestfish-actions.pod:1011
21100 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
21105 #: ../fish/guestfish-actions.pod:1014
21106 msgid "file-architecture"
21110 #: ../fish/guestfish-actions.pod:1016
21113 " file-architecture filename\n"
21118 #: ../fish/guestfish-actions.pod:1119
21123 #: ../fish/guestfish-actions.pod:1121
21131 #: ../fish/guestfish-actions.pod:1125
21133 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
21134 "L</is-file> etc. To get the size of block devices, use "
21135 "L</blockdev-getsize64>."
21139 #: ../fish/guestfish-actions.pod:1129
21144 #: ../fish/guestfish-actions.pod:1131
21147 " fill c len path\n"
21152 #: ../fish/guestfish-actions.pod:1137
21154 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
21155 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
21156 "L</fill-pattern>."
21160 #: ../fish/guestfish-actions.pod:1142
21161 msgid "fill-pattern"
21165 #: ../fish/guestfish-actions.pod:1144
21168 " fill-pattern pattern len path\n"
21173 #: ../fish/guestfish-actions.pod:1146
21175 "This function is like L</fill> except that it creates a new file of length "
21176 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
21177 "is truncated if necessary to ensure the length of the file is exactly C<len> "
21182 #: ../fish/guestfish-actions.pod:1151
21187 #: ../fish/guestfish-actions.pod:1153
21190 " find directory\n"
21195 #: ../fish/guestfish-actions.pod:1167
21196 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
21200 #: ../fish/guestfish-actions.pod:1180
21201 msgid "See also L</find0>."
21205 #: ../fish/guestfish-actions.pod:1185
21210 #: ../fish/guestfish-actions.pod:1187
21213 " find0 directory (files|-)\n"
21218 #: ../fish/guestfish-actions.pod:1193
21219 msgid "This command works the same way as L</find> with the following exceptions:"
21223 #: ../fish/guestfish-actions.pod:1220
21224 msgid "findfs-label"
21228 #: ../fish/guestfish-actions.pod:1222
21231 " findfs-label label\n"
21236 #: ../fish/guestfish-actions.pod:1228
21237 msgid "To find the label of a filesystem, use L</vfs-label>."
21241 #: ../fish/guestfish-actions.pod:1230
21242 msgid "findfs-uuid"
21246 #: ../fish/guestfish-actions.pod:1232
21249 " findfs-uuid uuid\n"
21254 #: ../fish/guestfish-actions.pod:1238
21255 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
21259 #: ../fish/guestfish-actions.pod:1240
21264 #: ../fish/guestfish-actions.pod:1242
21267 " fsck fstype device\n"
21272 #: ../fish/guestfish-actions.pod:1272
21277 #: ../fish/guestfish-actions.pod:1274
21285 #: ../fish/guestfish-actions.pod:1281
21286 msgid "get-autosync"
21290 #: ../fish/guestfish-actions.pod:1283
21298 #: ../fish/guestfish-actions.pod:1287
21303 #: ../fish/guestfish-actions.pod:1289
21311 #: ../fish/guestfish-actions.pod:1293
21312 msgid "get-e2label"
21316 #: ../fish/guestfish-actions.pod:1295
21319 " get-e2label device\n"
21324 #: ../fish/guestfish-actions.pod:1307
21329 #: ../fish/guestfish-actions.pod:1309
21332 " get-e2uuid device\n"
21337 #: ../fish/guestfish-actions.pod:1321
21338 msgid "get-memsize"
21342 #: ../fish/guestfish-actions.pod:1323
21350 #: ../fish/guestfish-actions.pod:1328
21352 "If L</set-memsize> was not called on this handle, and if "
21353 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
21354 "value for memsize."
21358 #: ../fish/guestfish-actions.pod:1335
21359 msgid "get-network"
21363 #: ../fish/guestfish-actions.pod:1337
21371 #: ../fish/guestfish-actions.pod:1341
21376 #: ../fish/guestfish-actions.pod:1343
21384 #: ../fish/guestfish-actions.pod:1350
21389 #: ../fish/guestfish-actions.pod:1352
21394 #: ../fish/guestfish-actions.pod:1354
21402 #: ../fish/guestfish-actions.pod:1361
21407 #: ../fish/guestfish-actions.pod:1363
21415 #: ../fish/guestfish-actions.pod:1370
21416 msgid "get-recovery-proc"
21420 #: ../fish/guestfish-actions.pod:1372
21423 " get-recovery-proc\n"
21428 #: ../fish/guestfish-actions.pod:1376
21429 msgid "get-selinux"
21433 #: ../fish/guestfish-actions.pod:1378
21441 #: ../fish/guestfish-actions.pod:1380
21443 "This returns the current setting of the selinux flag which is passed to the "
21444 "appliance at boot time. See L</set-selinux>."
21448 #: ../fish/guestfish-actions.pod:1386
21453 #: ../fish/guestfish-actions.pod:1388
21461 #: ../fish/guestfish-actions.pod:1395
21466 #: ../fish/guestfish-actions.pod:1397
21474 #: ../fish/guestfish-actions.pod:1401
21479 #: ../fish/guestfish-actions.pod:1403
21487 #: ../fish/guestfish-actions.pod:1405
21489 "Return the current umask. By default the umask is C<022> unless it has been "
21490 "set by calling L</umask>."
21494 #: ../fish/guestfish-actions.pod:1408
21495 msgid "get-verbose"
21499 #: ../fish/guestfish-actions.pod:1410
21507 #: ../fish/guestfish-actions.pod:1414
21512 #: ../fish/guestfish-actions.pod:1416
21520 #: ../fish/guestfish-actions.pod:1420
21521 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
21525 #: ../fish/guestfish-actions.pod:1423
21530 #: ../fish/guestfish-actions.pod:1425
21533 " getxattr path name\n"
21538 #: ../fish/guestfish-actions.pod:1427
21540 "Get a single extended attribute from file C<path> named C<name>. This call "
21541 "follows symlinks. If you want to lookup an extended attribute for the "
21542 "symlink itself, use L</lgetxattr>."
21546 #: ../fish/guestfish-actions.pod:1431 ../fish/guestfish-actions.pod:2262
21548 "Normally it is better to get all extended attributes from a file in one go "
21549 "by calling L</getxattrs>. However some Linux filesystem implementations are "
21550 "buggy and do not provide a way to list out attributes. For these "
21551 "filesystems (notably ntfs-3g) you have to know the names of the extended "
21552 "attributes you want in advance and call this function."
21556 #: ../fish/guestfish-actions.pod:1441
21557 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
21561 #: ../fish/guestfish-actions.pod:1443
21566 #: ../fish/guestfish-actions.pod:1445
21569 " getxattrs path\n"
21574 #: ../fish/guestfish-actions.pod:1453
21575 msgid "See also: L</lgetxattrs>, L<attr(5)>."
21579 #: ../fish/guestfish-actions.pod:1455
21580 msgid "glob-expand"
21584 #: ../fish/guestfish-actions.pod:1457
21587 " glob-expand pattern\n"
21592 #: ../fish/guestfish-actions.pod:1470
21597 #: ../fish/guestfish-actions.pod:1472
21600 " grep regex path\n"
21605 #: ../fish/guestfish-actions.pod:1480
21610 #: ../fish/guestfish-actions.pod:1482
21613 " grepi regex path\n"
21618 #: ../fish/guestfish-actions.pod:1490
21619 msgid "grub-install"
21623 #: ../fish/guestfish-actions.pod:1492
21626 " grub-install root device\n"
21631 #: ../fish/guestfish-actions.pod:1508
21636 #: ../fish/guestfish-actions.pod:1510
21644 #: ../fish/guestfish-actions.pod:1518
21649 #: ../fish/guestfish-actions.pod:1520
21652 " head-n nrlines path\n"
21657 #: ../fish/guestfish-actions.pod:1533
21662 #: ../fish/guestfish-actions.pod:1535
21670 #: ../fish/guestfish-actions.pod:1543
21675 #: ../fish/guestfish-actions.pod:1545
21678 " initrd-cat initrdpath filename\n"
21683 #: ../fish/guestfish-actions.pod:1557
21684 msgid "See also L</initrd-list>."
21688 #: ../fish/guestfish-actions.pod:1562
21689 msgid "initrd-list"
21693 #: ../fish/guestfish-actions.pod:1564
21696 " initrd-list path\n"
21701 #: ../fish/guestfish-actions.pod:1576
21702 msgid "inotify-add-watch"
21706 #: ../fish/guestfish-actions.pod:1578
21709 " inotify-add-watch path mask\n"
21714 #: ../fish/guestfish-actions.pod:1590
21715 msgid "inotify-close"
21719 #: ../fish/guestfish-actions.pod:1592
21727 #: ../fish/guestfish-actions.pod:1598
21728 msgid "inotify-files"
21732 #: ../fish/guestfish-actions.pod:1600
21740 #: ../fish/guestfish-actions.pod:1602
21742 "This function is a helpful wrapper around L</inotify-read> which just "
21743 "returns a list of pathnames of objects that were touched. The returned "
21744 "pathnames are sorted and deduplicated."
21748 #: ../fish/guestfish-actions.pod:1606
21749 msgid "inotify-init"
21753 #: ../fish/guestfish-actions.pod:1608
21756 " inotify-init maxevents\n"
21761 #: ../fish/guestfish-actions.pod:1614
21763 "C<maxevents> is the maximum number of events which will be queued up between "
21764 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21765 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21766 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21767 "but records the fact that it threw them away by setting a flag "
21768 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21772 #: ../fish/guestfish-actions.pod:1624
21774 "Before any events are generated, you have to add some watches to the "
21775 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21776 "L</inotify-watch-all>."
21780 #: ../fish/guestfish-actions.pod:1630
21782 "Queued up events should be read periodically by calling L</inotify-read> (or "
21783 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21784 "If you don't read the events out often enough then you risk the internal "
21785 "queue overflowing."
21789 #: ../fish/guestfish-actions.pod:1637
21791 "The handle should be closed after use by calling L</inotify-close>. This "
21792 "also removes any watches automatically."
21796 #: ../fish/guestfish-actions.pod:1646
21797 msgid "inotify-read"
21801 #: ../fish/guestfish-actions.pod:1648
21809 #: ../fish/guestfish-actions.pod:1661
21810 msgid "inotify-rm-watch"
21814 #: ../fish/guestfish-actions.pod:1663
21817 " inotify-rm-watch wd\n"
21822 #: ../fish/guestfish-actions.pod:1665
21823 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21827 #: ../fish/guestfish-actions.pod:1668
21828 msgid "inspect-get-arch"
21832 #: ../fish/guestfish-actions.pod:1670
21835 " inspect-get-arch root\n"
21840 #: ../fish/guestfish-actions.pod:1672 ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1762 ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1831 ../fish/guestfish-actions.pod:1858 ../fish/guestfish-actions.pod:1880 ../fish/guestfish-actions.pod:1904 ../fish/guestfish-actions.pod:1934 ../fish/guestfish-actions.pod:1969 ../fish/guestfish-actions.pod:1985
21842 "This function should only be called with a root device string as returned by "
21847 #: ../fish/guestfish-actions.pod:1675
21849 "This returns the architecture of the inspected operating system. The "
21850 "possible return values are listed under L</file-architecture>."
21854 #: ../fish/guestfish-actions.pod:1684
21855 msgid "inspect-get-distro"
21859 #: ../fish/guestfish-actions.pod:1686
21862 " inspect-get-distro root\n"
21867 #: ../fish/guestfish-actions.pod:1758
21868 msgid "inspect-get-filesystems"
21872 #: ../fish/guestfish-actions.pod:1760
21875 " inspect-get-filesystems root\n"
21880 #: ../fish/guestfish-actions.pod:1773
21882 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21883 "L</inspect-get-mountpoints>."
21887 #: ../fish/guestfish-actions.pod:1776
21888 msgid "inspect-get-hostname"
21892 #: ../fish/guestfish-actions.pod:1778
21895 " inspect-get-hostname root\n"
21900 #: ../fish/guestfish-actions.pod:1791
21901 msgid "inspect-get-major-version"
21905 #: ../fish/guestfish-actions.pod:1793
21908 " inspect-get-major-version root\n"
21913 #: ../fish/guestfish-actions.pod:1812
21914 msgid "inspect-get-minor-version"
21918 #: ../fish/guestfish-actions.pod:1814
21921 " inspect-get-minor-version root\n"
21926 #: ../fish/guestfish-actions.pod:1824
21928 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21929 "L</inspect-get-major-version>."
21933 #: ../fish/guestfish-actions.pod:1827
21934 msgid "inspect-get-mountpoints"
21938 #: ../fish/guestfish-actions.pod:1829
21941 " inspect-get-mountpoints root\n"
21946 #: ../fish/guestfish-actions.pod:1851
21948 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21949 "L</inspect-get-filesystems>."
21953 #: ../fish/guestfish-actions.pod:1854
21954 msgid "inspect-get-package-format"
21958 #: ../fish/guestfish-actions.pod:1856
21961 " inspect-get-package-format root\n"
21966 #: ../fish/guestfish-actions.pod:1861
21968 "This function and L</inspect-get-package-management> return the package "
21969 "format and package management tool used by the inspected operating system. "
21970 "For example for Fedora these functions would return C<rpm> (package format) "
21971 "and C<yum> (package management)."
21975 #: ../fish/guestfish-actions.pod:1876
21976 msgid "inspect-get-package-management"
21980 #: ../fish/guestfish-actions.pod:1878
21983 " inspect-get-package-management root\n"
21988 #: ../fish/guestfish-actions.pod:1883
21990 "L</inspect-get-package-format> and this function return the package format "
21991 "and package management tool used by the inspected operating system. For "
21992 "example for Fedora these functions would return C<rpm> (package format) and "
21993 "C<yum> (package management)."
21997 #: ../fish/guestfish-actions.pod:1900
21998 msgid "inspect-get-product-name"
22002 #: ../fish/guestfish-actions.pod:1902
22005 " inspect-get-product-name root\n"
22010 #: ../fish/guestfish-actions.pod:1917
22011 msgid "inspect-get-roots"
22015 #: ../fish/guestfish-actions.pod:1919
22018 " inspect-get-roots\n"
22023 #: ../fish/guestfish-actions.pod:1921
22025 "This function is a convenient way to get the list of root devices, as "
22026 "returned from a previous call to L</inspect-os>, but without redoing the "
22027 "whole inspection process."
22031 #: ../fish/guestfish-actions.pod:1925
22033 "This returns an empty list if either no root devices were found or the "
22034 "caller has not called L</inspect-os>."
22038 #: ../fish/guestfish-actions.pod:1930
22039 msgid "inspect-get-type"
22043 #: ../fish/guestfish-actions.pod:1932
22046 " inspect-get-type root\n"
22051 #: ../fish/guestfish-actions.pod:1965
22052 msgid "inspect-get-windows-systemroot"
22056 #: ../fish/guestfish-actions.pod:1967
22059 " inspect-get-windows-systemroot root\n"
22064 #: ../fish/guestfish-actions.pod:1981
22065 msgid "inspect-list-applications"
22069 #: ../fish/guestfish-actions.pod:1983
22072 " inspect-list-applications root\n"
22077 #: ../fish/guestfish-actions.pod:1990
22079 "I<Note:> This call works differently from other parts of the inspection "
22080 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
22081 "then mount up the disks, before calling this. Listing applications is a "
22082 "significantly more difficult operation which requires access to the full "
22083 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
22084 "are just returning data cached in the libguestfs handle, this call actually "
22085 "reads parts of the mounted filesystems during the call."
22089 #: ../fish/guestfish-actions.pod:2080
22094 #: ../fish/guestfish-actions.pod:2082
22102 #: ../fish/guestfish-actions.pod:2097
22104 "You can pass the root string(s) returned to other L</inspect-get-*> "
22105 "functions in order to query further information about each operating system, "
22106 "such as the name and version."
22110 #: ../fish/guestfish-actions.pod:2102
22112 "This function uses other libguestfs features such as L</mount-ro> and "
22113 "L</umount-all> in order to mount and unmount filesystems and look at the "
22114 "contents. This should be called with no disks currently mounted. The "
22115 "function may also use Augeas, so any existing Augeas handle will be closed."
22119 #: ../fish/guestfish-actions.pod:2114 ../fish/guestfish-actions.pod:2290 ../fish/guestfish-actions.pod:2336
22120 msgid "See also L</list-filesystems>."
22124 #: ../fish/guestfish-actions.pod:2116
22125 msgid "is-blockdev"
22129 #: ../fish/guestfish-actions.pod:2118
22132 " is-blockdev path\n"
22137 #: ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2179 ../fish/guestfish-actions.pod:2213 ../fish/guestfish-actions.pod:2222
22138 msgid "See also L</stat>."
22142 #: ../fish/guestfish-actions.pod:2125
22147 #: ../fish/guestfish-actions.pod:2127
22155 #: ../fish/guestfish-actions.pod:2134
22160 #: ../fish/guestfish-actions.pod:2136
22163 " is-chardev path\n"
22168 #: ../fish/guestfish-actions.pod:2143
22173 #: ../fish/guestfish-actions.pod:2145
22181 #: ../fish/guestfish-actions.pod:2152
22186 #: ../fish/guestfish-actions.pod:2154
22194 #: ../fish/guestfish-actions.pod:2162
22199 #: ../fish/guestfish-actions.pod:2164
22207 #: ../fish/guestfish-actions.pod:2171
22212 #: ../fish/guestfish-actions.pod:2173
22220 #: ../fish/guestfish-actions.pod:2181
22221 msgid "is-launching"
22225 #: ../fish/guestfish-actions.pod:2183
22233 #: ../fish/guestfish-actions.pod:2190
22238 #: ../fish/guestfish-actions.pod:2192
22246 #: ../fish/guestfish-actions.pod:2197
22251 #: ../fish/guestfish-actions.pod:2199
22259 #: ../fish/guestfish-actions.pod:2206
22264 #: ../fish/guestfish-actions.pod:2208
22267 " is-socket path\n"
22272 #: ../fish/guestfish-actions.pod:2215
22277 #: ../fish/guestfish-actions.pod:2217
22280 " is-symlink path\n"
22285 #: ../fish/guestfish-actions.pod:2224
22286 msgid "kill-subprocess"
22290 #: ../fish/guestfish-actions.pod:2226
22293 " kill-subprocess\n"
22298 #: ../fish/guestfish-actions.pod:2230
22303 #: ../fish/guestfish-actions.pod:2232
22308 #: ../fish/guestfish-actions.pod:2234
22316 #: ../fish/guestfish-actions.pod:2242
22321 #: ../fish/guestfish-actions.pod:2244
22324 " lchown owner group path\n"
22329 #: ../fish/guestfish-actions.pod:2246
22331 "Change the file owner to C<owner> and group to C<group>. This is like "
22332 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
22337 #: ../fish/guestfish-actions.pod:2254
22342 #: ../fish/guestfish-actions.pod:2256
22345 " lgetxattr path name\n"
22350 #: ../fish/guestfish-actions.pod:2272
22351 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
22355 #: ../fish/guestfish-actions.pod:2274
22360 #: ../fish/guestfish-actions.pod:2276
22363 " lgetxattrs path\n"
22368 #: ../fish/guestfish-actions.pod:2278
22370 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
22371 "it returns the extended attributes of the link itself."
22375 #: ../fish/guestfish-actions.pod:2282
22376 msgid "list-devices"
22380 #: ../fish/guestfish-actions.pod:2284
22388 #: ../fish/guestfish-actions.pod:2292
22389 msgid "list-filesystems"
22393 #: ../fish/guestfish-actions.pod:2294
22396 " list-filesystems\n"
22401 #: ../fish/guestfish-actions.pod:2313
22403 "This command runs other libguestfs commands, which might include L</mount> "
22404 "and L</umount>, and therefore you should use this soon after launch and only "
22405 "when nothing is mounted."
22409 #: ../fish/guestfish-actions.pod:2317
22411 "Not all of the filesystems returned will be mountable. In particular, swap "
22412 "partitions are returned in the list. Also this command does not check that "
22413 "each filesystem found is valid and mountable, and some filesystems might be "
22414 "mountable but require special options. Filesystems may not all belong to a "
22415 "single logical operating system (use L</inspect-os> to look for OSes)."
22419 #: ../fish/guestfish-actions.pod:2325
22420 msgid "list-partitions"
22424 #: ../fish/guestfish-actions.pod:2327
22427 " list-partitions\n"
22432 #: ../fish/guestfish-actions.pod:2333
22434 "This does not return logical volumes. For that you will need to call "
22439 #: ../fish/guestfish-actions.pod:2338
22444 #: ../fish/guestfish-actions.pod:2340
22452 #: ../fish/guestfish-actions.pod:2348
22457 #: ../fish/guestfish-actions.pod:2350
22460 " ln target linkname\n"
22465 #: ../fish/guestfish-actions.pod:2354
22470 #: ../fish/guestfish-actions.pod:2356
22473 " ln-f target linkname\n"
22478 #: ../fish/guestfish-actions.pod:2361
22483 #: ../fish/guestfish-actions.pod:2363
22486 " ln-s target linkname\n"
22491 #: ../fish/guestfish-actions.pod:2367
22496 #: ../fish/guestfish-actions.pod:2369
22499 " ln-sf target linkname\n"
22504 #: ../fish/guestfish-actions.pod:2374
22505 msgid "lremovexattr"
22509 #: ../fish/guestfish-actions.pod:2376
22512 " lremovexattr xattr path\n"
22517 #: ../fish/guestfish-actions.pod:2378
22519 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
22520 "it removes an extended attribute of the link itself."
22524 #: ../fish/guestfish-actions.pod:2382
22529 #: ../fish/guestfish-actions.pod:2384
22537 #: ../fish/guestfish-actions.pod:2390
22539 "This command is mostly useful for interactive sessions. Programs should "
22540 "probably use L</readdir> instead."
22544 #: ../fish/guestfish-actions.pod:2393
22549 #: ../fish/guestfish-actions.pod:2395
22552 " lsetxattr xattr val vallen path\n"
22557 #: ../fish/guestfish-actions.pod:2397
22559 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
22560 "sets an extended attribute of the link itself."
22564 #: ../fish/guestfish-actions.pod:2401
22569 #: ../fish/guestfish-actions.pod:2403
22577 #: ../fish/guestfish-actions.pod:2407
22579 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
22580 "the link is stat-ed, not the file it refers to."
22584 #: ../fish/guestfish-actions.pod:2413
22589 #: ../fish/guestfish-actions.pod:2415
22592 " lstatlist path 'names ...'\n"
22597 #: ../fish/guestfish-actions.pod:2417
22599 "This call allows you to perform the L</lstat> operation on multiple files, "
22600 "where all files are in the directory C<path>. C<names> is the list of files "
22601 "from this directory."
22605 #: ../fish/guestfish-actions.pod:2426
22607 "This call is intended for programs that want to efficiently list a directory "
22608 "contents without making many round-trips. See also L</lxattrlist> for a "
22609 "similarly efficient call for getting extended attributes. Very long "
22610 "directory listings might cause the protocol message size to be exceeded, "
22611 "causing this call to fail. The caller must split up such requests into "
22612 "smaller groups of names."
22616 #: ../fish/guestfish-actions.pod:2434
22617 msgid "luks-add-key"
22621 #: ../fish/guestfish-actions.pod:2436
22624 " luks-add-key device keyslot\n"
22629 #: ../fish/guestfish-actions.pod:2443
22631 "Note that if C<keyslot> already contains a key, then this command will "
22632 "fail. You have to use L</luks-kill-slot> first to remove that key."
22636 #: ../fish/guestfish-actions.pod:2447 ../fish/guestfish-actions.pod:2469 ../fish/guestfish-actions.pod:2482 ../fish/guestfish-actions.pod:2496 ../fish/guestfish-actions.pod:2519 ../fish/guestfish-actions.pod:2529
22638 "This command has one or more key or passphrase parameters. Guestfish will "
22639 "prompt for these separately."
22643 #: ../fish/guestfish-actions.pod:2450
22648 #: ../fish/guestfish-actions.pod:2452
22651 " luks-close device\n"
22656 #: ../fish/guestfish-actions.pod:2454
22658 "This closes a LUKS device that was created earlier by L</luks-open> or "
22659 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
22660 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
22661 "underlying block device."
22665 #: ../fish/guestfish-actions.pod:2460
22666 msgid "luks-format"
22670 #: ../fish/guestfish-actions.pod:2462
22673 " luks-format device keyslot\n"
22678 #: ../fish/guestfish-actions.pod:2475
22679 msgid "luks-format-cipher"
22683 #: ../fish/guestfish-actions.pod:2477
22686 " luks-format-cipher device keyslot cipher\n"
22691 #: ../fish/guestfish-actions.pod:2479
22693 "This command is the same as L</luks-format> but it also allows you to set "
22694 "the C<cipher> used."
22698 #: ../fish/guestfish-actions.pod:2488
22699 msgid "luks-kill-slot"
22703 #: ../fish/guestfish-actions.pod:2490
22706 " luks-kill-slot device keyslot\n"
22711 #: ../fish/guestfish-actions.pod:2499
22716 #: ../fish/guestfish-actions.pod:2501
22719 " luks-open device mapname\n"
22724 #: ../fish/guestfish-actions.pod:2515
22726 "If this block device contains LVM volume groups, then calling L</vgscan> "
22727 "followed by L</vg-activate-all> will make them visible."
22731 #: ../fish/guestfish-actions.pod:2522
22732 msgid "luks-open-ro"
22736 #: ../fish/guestfish-actions.pod:2524
22739 " luks-open-ro device mapname\n"
22744 #: ../fish/guestfish-actions.pod:2526
22746 "This is the same as L</luks-open> except that a read-only mapping is "
22751 #: ../fish/guestfish-actions.pod:2532
22756 #: ../fish/guestfish-actions.pod:2534
22759 " lvcreate logvol volgroup mbytes\n"
22764 #: ../fish/guestfish-actions.pod:2539
22765 msgid "lvm-canonical-lv-name"
22769 #: ../fish/guestfish-actions.pod:2541
22772 " lvm-canonical-lv-name lvname\n"
22777 #: ../fish/guestfish-actions.pod:2550
22778 msgid "See also L</is-lv>."
22782 #: ../fish/guestfish-actions.pod:2552
22783 msgid "lvm-clear-filter"
22787 #: ../fish/guestfish-actions.pod:2554
22790 " lvm-clear-filter\n"
22795 #: ../fish/guestfish-actions.pod:2556
22797 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22802 #: ../fish/guestfish-actions.pod:2562
22803 msgid "lvm-remove-all"
22807 #: ../fish/guestfish-actions.pod:2564
22810 " lvm-remove-all\n"
22815 #: ../fish/guestfish-actions.pod:2572
22816 msgid "lvm-set-filter"
22820 #: ../fish/guestfish-actions.pod:2574
22823 " lvm-set-filter 'devices ...'\n"
22828 #: ../fish/guestfish-actions.pod:2599
22833 #: ../fish/guestfish-actions.pod:2601
22836 " lvremove device\n"
22841 #: ../fish/guestfish-actions.pod:2609
22846 #: ../fish/guestfish-actions.pod:2611
22849 " lvrename logvol newlogvol\n"
22854 #: ../fish/guestfish-actions.pod:2615
22859 #: ../fish/guestfish-actions.pod:2617
22862 " lvresize device mbytes\n"
22867 #: ../fish/guestfish-actions.pod:2623
22868 msgid "lvresize-free"
22872 #: ../fish/guestfish-actions.pod:2625
22875 " lvresize-free lv percent\n"
22880 #: ../fish/guestfish-actions.pod:2633
22885 #: ../fish/guestfish-actions.pod:2635
22893 #: ../fish/guestfish-actions.pod:2643
22894 msgid "See also L</lvs-full>, L</list-filesystems>."
22898 #: ../fish/guestfish-actions.pod:2645
22903 #: ../fish/guestfish-actions.pod:2647
22911 #: ../fish/guestfish-actions.pod:2652
22916 #: ../fish/guestfish-actions.pod:2654
22924 #: ../fish/guestfish-actions.pod:2658
22929 #: ../fish/guestfish-actions.pod:2660
22932 " lxattrlist path 'names ...'\n"
22937 #: ../fish/guestfish-actions.pod:2676
22939 "This call is intended for programs that want to efficiently list a directory "
22940 "contents without making many round-trips. See also L</lstatlist> for a "
22941 "similarly efficient call for getting standard stats. Very long directory "
22942 "listings might cause the protocol message size to be exceeded, causing this "
22943 "call to fail. The caller must split up such requests into smaller groups of "
22948 #: ../fish/guestfish-actions.pod:2684
22953 #: ../fish/guestfish-actions.pod:2686
22961 #: ../fish/guestfish-actions.pod:2690
22966 #: ../fish/guestfish-actions.pod:2692
22969 " mkdir-mode path mode\n"
22974 #: ../fish/guestfish-actions.pod:2701
22975 msgid "See also L</mkdir>, L</umask>"
22979 #: ../fish/guestfish-actions.pod:2703
22984 #: ../fish/guestfish-actions.pod:2705
22992 #: ../fish/guestfish-actions.pod:2710
22997 #: ../fish/guestfish-actions.pod:2712
23000 " mkdtemp template\n"
23005 #: ../fish/guestfish-actions.pod:2733
23010 #: ../fish/guestfish-actions.pod:2735
23013 " mke2fs-J fstype blocksize device journal\n"
23018 #: ../fish/guestfish-actions.pod:2743
23019 msgid "See also L</mke2journal>."
23023 #: ../fish/guestfish-actions.pod:2745
23028 #: ../fish/guestfish-actions.pod:2747
23031 " mke2fs-JL fstype blocksize device label\n"
23036 #: ../fish/guestfish-actions.pod:2752
23037 msgid "See also L</mke2journal-L>."
23041 #: ../fish/guestfish-actions.pod:2754
23046 #: ../fish/guestfish-actions.pod:2756
23049 " mke2fs-JU fstype blocksize device uuid\n"
23054 #: ../fish/guestfish-actions.pod:2761
23055 msgid "See also L</mke2journal-U>."
23059 #: ../fish/guestfish-actions.pod:2763
23060 msgid "mke2journal"
23064 #: ../fish/guestfish-actions.pod:2765
23067 " mke2journal blocksize device\n"
23072 #: ../fish/guestfish-actions.pod:2772
23073 msgid "mke2journal-L"
23077 #: ../fish/guestfish-actions.pod:2774
23080 " mke2journal-L blocksize label device\n"
23085 #: ../fish/guestfish-actions.pod:2778
23086 msgid "mke2journal-U"
23090 #: ../fish/guestfish-actions.pod:2780
23093 " mke2journal-U blocksize uuid device\n"
23098 #: ../fish/guestfish-actions.pod:2784
23103 #: ../fish/guestfish-actions.pod:2786
23106 " mkfifo mode path\n"
23111 #: ../fish/guestfish-actions.pod:2788
23113 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
23114 "is just a convenient wrapper around L</mknod>."
23118 #: ../fish/guestfish-actions.pod:2794
23123 #: ../fish/guestfish-actions.pod:2796
23126 " mkfs fstype device\n"
23131 #: ../fish/guestfish-actions.pod:2802
23136 #: ../fish/guestfish-actions.pod:2804
23139 " mkfs-b fstype blocksize device\n"
23144 #: ../fish/guestfish-actions.pod:2806
23146 "This call is similar to L</mkfs>, but it allows you to control the block "
23147 "size of the resulting filesystem. Supported block sizes depend on the "
23148 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
23152 #: ../fish/guestfish-actions.pod:2821
23157 #: ../fish/guestfish-actions.pod:2823
23160 " mkfs-opts fstype device [blocksize:..]\n"
23165 #: ../fish/guestfish-actions.pod:2847
23166 msgid "mkmountpoint"
23170 #: ../fish/guestfish-actions.pod:2849
23173 " mkmountpoint exemptpath\n"
23178 #: ../fish/guestfish-actions.pod:2851
23180 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
23181 "to create extra mountpoints before mounting the first filesystem."
23185 #: ../fish/guestfish-actions.pod:2875
23187 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
23188 "unexpected errors if you try to mix these calls. It is safest to manually "
23189 "unmount filesystems and remove mountpoints after use."
23193 #: ../fish/guestfish-actions.pod:2879
23195 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
23196 "for this to work for manual mountpoints, you must ensure that the innermost "
23197 "mountpoints have the longest pathnames, as in the example code above."
23201 #: ../fish/guestfish-actions.pod:2886
23203 "Autosync [see L</set-autosync>, this is set by default on handles] means "
23204 "that L</umount-all> is called when the handle is closed which can also "
23205 "trigger these issues."
23209 #: ../fish/guestfish-actions.pod:2890
23214 #: ../fish/guestfish-actions.pod:2892
23217 " mknod mode devmajor devminor path\n"
23222 #: ../fish/guestfish-actions.pod:2902
23224 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
23225 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
23226 "regular file). These constants are available in the standard Linux header "
23227 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
23228 "wrappers around this command which bitwise OR in the appropriate constant "
23233 #: ../fish/guestfish-actions.pod:2912
23238 #: ../fish/guestfish-actions.pod:2914
23241 " mknod-b mode devmajor devminor path\n"
23246 #: ../fish/guestfish-actions.pod:2916
23248 "This call creates a block device node called C<path> with mode C<mode> and "
23249 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23250 "wrapper around L</mknod>."
23254 #: ../fish/guestfish-actions.pod:2922
23259 #: ../fish/guestfish-actions.pod:2924
23262 " mknod-c mode devmajor devminor path\n"
23267 #: ../fish/guestfish-actions.pod:2926
23269 "This call creates a char device node called C<path> with mode C<mode> and "
23270 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23271 "wrapper around L</mknod>."
23275 #: ../fish/guestfish-actions.pod:2932
23280 #: ../fish/guestfish-actions.pod:2934
23288 #: ../fish/guestfish-actions.pod:2938
23293 #: ../fish/guestfish-actions.pod:2940
23296 " mkswap-L label device\n"
23301 #: ../fish/guestfish-actions.pod:2948
23306 #: ../fish/guestfish-actions.pod:2950
23309 " mkswap-U uuid device\n"
23314 #: ../fish/guestfish-actions.pod:2954
23315 msgid "mkswap-file"
23319 #: ../fish/guestfish-actions.pod:2956
23322 " mkswap-file path\n"
23327 #: ../fish/guestfish-actions.pod:2960
23329 "This command just writes a swap file signature to an existing file. To "
23330 "create the file itself, use something like L</fallocate>."
23334 #: ../fish/guestfish-actions.pod:2963
23339 #: ../fish/guestfish-actions.pod:2965
23342 " modprobe modulename\n"
23347 #: ../fish/guestfish-actions.pod:2972
23352 #: ../fish/guestfish-actions.pod:2974
23355 " mount device mountpoint\n"
23360 #: ../fish/guestfish-actions.pod:2990
23362 "B<Important note:> When you use this call, the filesystem options C<sync> "
23363 "and C<noatime> are set implicitly. This was originally done because we "
23364 "thought it would improve reliability, but it turns out that I<-o sync> has a "
23365 "very large negative performance impact and negligible effect on "
23366 "reliability. Therefore we recommend that you avoid using L</mount> in any "
23367 "code that needs performance, and instead use L</mount-options> (use an empty "
23368 "string for the first parameter if you don't want any options)."
23372 #: ../fish/guestfish-actions.pod:3000
23377 #: ../fish/guestfish-actions.pod:3002
23380 " mount-loop file mountpoint\n"
23385 #: ../fish/guestfish-actions.pod:3008
23386 msgid "mount-options"
23390 #: ../fish/guestfish-actions.pod:3010
23393 " mount-options options device mountpoint\n"
23398 #: ../fish/guestfish-actions.pod:3012
23400 "This is the same as the L</mount> command, but it allows you to set the "
23401 "mount options as for the L<mount(8)> I<-o> flag."
23405 #: ../fish/guestfish-actions.pod:3020
23410 #: ../fish/guestfish-actions.pod:3022
23413 " mount-ro device mountpoint\n"
23418 #: ../fish/guestfish-actions.pod:3024
23420 "This is the same as the L</mount> command, but it mounts the filesystem with "
23421 "the read-only (I<-o ro>) flag."
23425 #: ../fish/guestfish-actions.pod:3027
23430 #: ../fish/guestfish-actions.pod:3029
23433 " mount-vfs options vfstype device mountpoint\n"
23438 #: ../fish/guestfish-actions.pod:3031
23440 "This is the same as the L</mount> command, but it allows you to set both the "
23441 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
23445 #: ../fish/guestfish-actions.pod:3035
23446 msgid "mountpoints"
23450 #: ../fish/guestfish-actions.pod:3037
23458 #: ../fish/guestfish-actions.pod:3039
23460 "This call is similar to L</mounts>. That call returns a list of devices. "
23461 "This one returns a hash table (map) of device name to directory where the "
23462 "device is mounted."
23466 #: ../fish/guestfish-actions.pod:3043
23471 #: ../fish/guestfish-actions.pod:3045
23479 #: ../fish/guestfish-actions.pod:3052
23480 msgid "See also: L</mountpoints>"
23484 #: ../fish/guestfish-actions.pod:3054
23489 #: ../fish/guestfish-actions.pod:3056
23497 #: ../fish/guestfish-actions.pod:3061
23498 msgid "ntfs-3g-probe"
23502 #: ../fish/guestfish-actions.pod:3063
23505 " ntfs-3g-probe true|false device\n"
23510 #: ../fish/guestfish-actions.pod:3077
23515 #: ../fish/guestfish-actions.pod:3079
23518 " ntfsresize device\n"
23523 #: ../fish/guestfish-actions.pod:3085
23524 msgid "ntfsresize-size"
23528 #: ../fish/guestfish-actions.pod:3087
23531 " ntfsresize-size device size\n"
23536 #: ../fish/guestfish-actions.pod:3089
23538 "This command is the same as L</ntfsresize> except that it allows you to "
23539 "specify the new size (in bytes) explicitly."
23543 #: ../fish/guestfish-actions.pod:3092
23548 #: ../fish/guestfish-actions.pod:3094
23551 " part-add device prlogex startsect endsect\n"
23556 #: ../fish/guestfish-actions.pod:3096
23558 "This command adds a partition to C<device>. If there is no partition table "
23559 "on the device, call L</part-init> first."
23563 #: ../fish/guestfish-actions.pod:3108
23565 "Creating a partition which covers the whole disk is not so easy. Use "
23566 "L</part-disk> to do that."
23570 #: ../fish/guestfish-actions.pod:3111
23575 #: ../fish/guestfish-actions.pod:3113
23578 " part-del device partnum\n"
23583 #: ../fish/guestfish-actions.pod:3121
23588 #: ../fish/guestfish-actions.pod:3123
23591 " part-disk device parttype\n"
23596 #: ../fish/guestfish-actions.pod:3125
23598 "This command is simply a combination of L</part-init> followed by "
23599 "L</part-add> to create a single primary partition covering the whole disk."
23603 #: ../fish/guestfish-actions.pod:3129
23605 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
23606 "possible values are described in L</part-init>."
23610 #: ../fish/guestfish-actions.pod:3135
23611 msgid "part-get-bootable"
23615 #: ../fish/guestfish-actions.pod:3137
23618 " part-get-bootable device partnum\n"
23623 #: ../fish/guestfish-actions.pod:3142
23624 msgid "See also L</part-set-bootable>."
23628 #: ../fish/guestfish-actions.pod:3144
23629 msgid "part-get-mbr-id"
23633 #: ../fish/guestfish-actions.pod:3146
23636 " part-get-mbr-id device partnum\n"
23641 #: ../fish/guestfish-actions.pod:3151 ../fish/guestfish-actions.pod:3289
23643 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
23644 "undefined results for other partition table types (see "
23645 "L</part-get-parttype>)."
23649 #: ../fish/guestfish-actions.pod:3155
23650 msgid "part-get-parttype"
23654 #: ../fish/guestfish-actions.pod:3157
23657 " part-get-parttype device\n"
23662 #: ../fish/guestfish-actions.pod:3162
23664 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
23665 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
23666 "possible, although unusual. See L</part-init> for a full list."
23670 #: ../fish/guestfish-actions.pod:3167
23675 #: ../fish/guestfish-actions.pod:3169
23678 " part-init device parttype\n"
23683 #: ../fish/guestfish-actions.pod:3175
23685 "Initially there are no partitions. Following this, you should call "
23686 "L</part-add> for each partition required."
23690 #: ../fish/guestfish-actions.pod:3238
23695 #: ../fish/guestfish-actions.pod:3240
23698 " part-list device\n"
23703 #: ../fish/guestfish-actions.pod:3255
23705 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23706 "the device's sector size, see L</blockdev-getss>."
23710 #: ../fish/guestfish-actions.pod:3268
23711 msgid "part-set-bootable"
23715 #: ../fish/guestfish-actions.pod:3270
23718 " part-set-bootable device partnum true|false\n"
23723 #: ../fish/guestfish-actions.pod:3279
23724 msgid "part-set-mbr-id"
23728 #: ../fish/guestfish-actions.pod:3281
23731 " part-set-mbr-id device partnum idbyte\n"
23736 #: ../fish/guestfish-actions.pod:3293
23737 msgid "part-set-name"
23741 #: ../fish/guestfish-actions.pod:3295
23744 " part-set-name device partnum name\n"
23749 #: ../fish/guestfish-actions.pod:3303
23750 msgid "part-to-dev"
23754 #: ../fish/guestfish-actions.pod:3305
23757 " part-to-dev partition\n"
23762 #: ../fish/guestfish-actions.pod:3311
23764 "The named partition must exist, for example as a string returned from "
23765 "L</list-partitions>."
23769 #: ../fish/guestfish-actions.pod:3314
23770 msgid "ping-daemon"
23774 #: ../fish/guestfish-actions.pod:3316
23782 #: ../fish/guestfish-actions.pod:3323
23787 #: ../fish/guestfish-actions.pod:3325
23790 " pread path count offset\n"
23795 #: ../fish/guestfish-actions.pod:3333
23796 msgid "See also L</pwrite>, L</pread-device>."
23800 #: ../fish/guestfish-actions.pod:3338
23801 msgid "pread-device"
23805 #: ../fish/guestfish-actions.pod:3340
23808 " pread-device device count offset\n"
23813 #: ../fish/guestfish-actions.pod:3348
23814 msgid "See also L</pread>."
23818 #: ../fish/guestfish-actions.pod:3353
23823 #: ../fish/guestfish-actions.pod:3355
23826 " pvcreate device\n"
23831 #: ../fish/guestfish-actions.pod:3361
23836 #: ../fish/guestfish-actions.pod:3363
23839 " pvremove device\n"
23844 #: ../fish/guestfish-actions.pod:3372
23849 #: ../fish/guestfish-actions.pod:3374
23852 " pvresize device\n"
23857 #: ../fish/guestfish-actions.pod:3379
23858 msgid "pvresize-size"
23862 #: ../fish/guestfish-actions.pod:3381
23865 " pvresize-size device size\n"
23870 #: ../fish/guestfish-actions.pod:3383
23872 "This command is the same as L</pvresize> except that it allows you to "
23873 "specify the new size (in bytes) explicitly."
23877 #: ../fish/guestfish-actions.pod:3386
23882 #: ../fish/guestfish-actions.pod:3388
23890 #: ../fish/guestfish-actions.pod:3396
23891 msgid "See also L</pvs-full>."
23895 #: ../fish/guestfish-actions.pod:3398
23900 #: ../fish/guestfish-actions.pod:3400
23908 #: ../fish/guestfish-actions.pod:3405
23913 #: ../fish/guestfish-actions.pod:3407
23921 #: ../fish/guestfish-actions.pod:3411
23926 #: ../fish/guestfish-actions.pod:3413
23929 " pwrite path content offset\n"
23934 #: ../fish/guestfish-actions.pod:3424
23935 msgid "See also L</pread>, L</pwrite-device>."
23939 #: ../fish/guestfish-actions.pod:3429
23940 msgid "pwrite-device"
23944 #: ../fish/guestfish-actions.pod:3431
23947 " pwrite-device device content offset\n"
23952 #: ../fish/guestfish-actions.pod:3441
23953 msgid "See also L</pwrite>."
23957 #: ../fish/guestfish-actions.pod:3446
23962 #: ../fish/guestfish-actions.pod:3448
23965 " read-file path\n"
23970 #: ../fish/guestfish-actions.pod:3453
23972 "Unlike L</cat>, this function can correctly handle files that contain "
23973 "embedded ASCII NUL characters. However unlike L</download>, this function "
23974 "is limited in the total size of file that can be handled."
23978 #: ../fish/guestfish-actions.pod:3461
23983 #: ../fish/guestfish-actions.pod:3463
23986 " read-lines path\n"
23991 #: ../fish/guestfish-actions.pod:3470
23993 "Note that this function cannot correctly handle binary files (specifically, "
23994 "files containing C<\\0> character which is treated as end of line). For "
23995 "those you need to use the L</read-file> function which has a more complex "
24000 #: ../fish/guestfish-actions.pod:3475
24005 #: ../fish/guestfish-actions.pod:3477
24013 #: ../fish/guestfish-actions.pod:3529
24015 "This function is primarily intended for use by programs. To get a simple "
24016 "list of names, use L</ls>. To get a printable directory for human "
24017 "consumption, use L</ll>."
24021 #: ../fish/guestfish-actions.pod:3533
24026 #: ../fish/guestfish-actions.pod:3535
24034 #: ../fish/guestfish-actions.pod:3539
24035 msgid "readlinklist"
24039 #: ../fish/guestfish-actions.pod:3541
24042 " readlinklist path 'names ...'\n"
24047 #: ../fish/guestfish-actions.pod:3565
24052 #: ../fish/guestfish-actions.pod:3567
24060 #: ../fish/guestfish-actions.pod:3572
24061 msgid "removexattr"
24065 #: ../fish/guestfish-actions.pod:3574
24068 " removexattr xattr path\n"
24073 #: ../fish/guestfish-actions.pod:3579
24074 msgid "See also: L</lremovexattr>, L<attr(5)>."
24078 #: ../fish/guestfish-actions.pod:3581
24083 #: ../fish/guestfish-actions.pod:3583
24086 " resize2fs device\n"
24091 #: ../fish/guestfish-actions.pod:3588
24093 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
24094 "before calling this command. For unknown reasons C<resize2fs> sometimes "
24095 "gives an error about this and sometimes not. In any case, it is always safe "
24096 "to call L</e2fsck-f> before calling this function."
24100 #: ../fish/guestfish-actions.pod:3594
24101 msgid "resize2fs-size"
24105 #: ../fish/guestfish-actions.pod:3596
24108 " resize2fs-size device size\n"
24113 #: ../fish/guestfish-actions.pod:3598
24115 "This command is the same as L</resize2fs> except that it allows you to "
24116 "specify the new size (in bytes) explicitly."
24120 #: ../fish/guestfish-actions.pod:3601
24125 #: ../fish/guestfish-actions.pod:3603
24133 #: ../fish/guestfish-actions.pod:3607
24138 #: ../fish/guestfish-actions.pod:3609
24146 #: ../fish/guestfish-actions.pod:3615
24151 #: ../fish/guestfish-actions.pod:3617
24159 #: ../fish/guestfish-actions.pod:3621
24160 msgid "rmmountpoint"
24164 #: ../fish/guestfish-actions.pod:3623
24167 " rmmountpoint exemptpath\n"
24172 #: ../fish/guestfish-actions.pod:3625
24174 "This calls removes a mountpoint that was previously created with "
24175 "L</mkmountpoint>. See L</mkmountpoint> for full details."
24179 #: ../fish/guestfish-actions.pod:3629
24180 msgid "scrub-device"
24184 #: ../fish/guestfish-actions.pod:3631
24187 " scrub-device device\n"
24192 #: ../fish/guestfish-actions.pod:3642
24197 #: ../fish/guestfish-actions.pod:3644
24200 " scrub-file file\n"
24205 #: ../fish/guestfish-actions.pod:3654
24206 msgid "scrub-freespace"
24210 #: ../fish/guestfish-actions.pod:3656
24213 " scrub-freespace dir\n"
24218 #: ../fish/guestfish-actions.pod:3658
24220 "This command creates the directory C<dir> and then fills it with files until "
24221 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
24222 "deletes them. The intention is to scrub any free space on the partition "
24223 "containing C<dir>."
24227 #: ../fish/guestfish-actions.pod:3667
24232 #: ../fish/guestfish-actions.pod:3669
24237 #: ../fish/guestfish-actions.pod:3671
24240 " set-append append\n"
24245 #: ../fish/guestfish-actions.pod:3682
24246 msgid "set-autosync"
24250 #: ../fish/guestfish-actions.pod:3684
24255 #: ../fish/guestfish-actions.pod:3686
24258 " set-autosync true|false\n"
24263 #: ../fish/guestfish-actions.pod:3688
24265 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
24266 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
24267 "closed (also if the program exits without closing handles)."
24271 #: ../fish/guestfish-actions.pod:3696
24276 #: ../fish/guestfish-actions.pod:3698
24281 #: ../fish/guestfish-actions.pod:3700
24284 " set-direct true|false\n"
24289 #: ../fish/guestfish-actions.pod:3706
24291 "One consequence of this is that log messages aren't caught by the library "
24292 "and handled by L</set-log-message-callback>, but go straight to stdout."
24296 #: ../fish/guestfish-actions.pod:3715
24297 msgid "set-e2label"
24301 #: ../fish/guestfish-actions.pod:3717
24304 " set-e2label device label\n"
24309 #: ../fish/guestfish-actions.pod:3723
24311 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
24312 "label on a filesystem."
24316 #: ../fish/guestfish-actions.pod:3726
24321 #: ../fish/guestfish-actions.pod:3728
24324 " set-e2uuid device uuid\n"
24329 #: ../fish/guestfish-actions.pod:3735
24331 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
24332 "UUID of a filesystem."
24336 #: ../fish/guestfish-actions.pod:3738
24337 msgid "set-memsize"
24341 #: ../fish/guestfish-actions.pod:3740
24346 #: ../fish/guestfish-actions.pod:3742
24349 " set-memsize memsize\n"
24354 #: ../fish/guestfish-actions.pod:3744
24356 "This sets the memory size in megabytes allocated to the qemu subprocess. "
24357 "This only has any effect if called before L</launch>."
24361 #: ../fish/guestfish-actions.pod:3755
24362 msgid "set-network"
24366 #: ../fish/guestfish-actions.pod:3757
24371 #: ../fish/guestfish-actions.pod:3759
24374 " set-network true|false\n"
24379 #: ../fish/guestfish-actions.pod:3767
24380 msgid "You must call this before calling L</launch>, otherwise it has no effect."
24384 #: ../fish/guestfish-actions.pod:3770
24389 #: ../fish/guestfish-actions.pod:3772
24394 #: ../fish/guestfish-actions.pod:3774
24397 " set-path searchpath\n"
24402 #: ../fish/guestfish-actions.pod:3783
24407 #: ../fish/guestfish-actions.pod:3785
24412 #: ../fish/guestfish-actions.pod:3787
24420 #: ../fish/guestfish-actions.pod:3807
24421 msgid "set-recovery-proc"
24425 #: ../fish/guestfish-actions.pod:3809
24426 msgid "recovery-proc"
24430 #: ../fish/guestfish-actions.pod:3811
24433 " set-recovery-proc true|false\n"
24438 #: ../fish/guestfish-actions.pod:3813
24440 "If this is called with the parameter C<false> then L</launch> does not "
24441 "create a recovery process. The purpose of the recovery process is to stop "
24442 "runaway qemu processes in the case where the main program aborts abruptly."
24446 #: ../fish/guestfish-actions.pod:3818
24448 "This only has any effect if called before L</launch>, and the default is "
24453 #: ../fish/guestfish-actions.pod:3827
24454 msgid "set-selinux"
24458 #: ../fish/guestfish-actions.pod:3829
24463 #: ../fish/guestfish-actions.pod:3831
24466 " set-selinux true|false\n"
24471 #: ../fish/guestfish-actions.pod:3842
24476 #: ../fish/guestfish-actions.pod:3844
24481 #: ../fish/guestfish-actions.pod:3846
24484 " set-trace true|false\n"
24489 #: ../fish/guestfish-actions.pod:3862
24490 msgid "set-verbose"
24494 #: ../fish/guestfish-actions.pod:3864
24499 #: ../fish/guestfish-actions.pod:3866
24502 " set-verbose true|false\n"
24507 #: ../fish/guestfish-actions.pod:3873
24512 #: ../fish/guestfish-actions.pod:3875
24515 " setcon context\n"
24520 #: ../fish/guestfish-actions.pod:3882
24525 #: ../fish/guestfish-actions.pod:3884
24528 " setxattr xattr val vallen path\n"
24533 #: ../fish/guestfish-actions.pod:3890
24534 msgid "See also: L</lsetxattr>, L<attr(5)>."
24538 #: ../fish/guestfish-actions.pod:3892
24543 #: ../fish/guestfish-actions.pod:3894
24546 " sfdisk device cyls heads sectors 'lines ...'\n"
24551 #: ../fish/guestfish-actions.pod:3916
24552 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
24556 #: ../fish/guestfish-actions.pod:3922
24561 #: ../fish/guestfish-actions.pod:3924
24564 " sfdiskM device 'lines ...'\n"
24569 #: ../fish/guestfish-actions.pod:3926
24571 "This is a simplified interface to the L</sfdisk> command, where partition "
24572 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
24573 "you don't need to specify the cyls, heads and sectors parameters which were "
24574 "rarely if ever used anyway."
24578 #: ../fish/guestfish-actions.pod:3932
24579 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
24583 #: ../fish/guestfish-actions.pod:3938
24588 #: ../fish/guestfish-actions.pod:3940
24591 " sfdisk-N device partnum cyls heads sectors line\n"
24596 #: ../fish/guestfish-actions.pod:3945
24598 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
24599 "cyls/heads/sectors parameters."
24603 #: ../fish/guestfish-actions.pod:3948
24604 msgid "See also: L</part-add>"
24608 #: ../fish/guestfish-actions.pod:3953
24609 msgid "sfdisk-disk-geometry"
24613 #: ../fish/guestfish-actions.pod:3955
24616 " sfdisk-disk-geometry device\n"
24621 #: ../fish/guestfish-actions.pod:3957
24623 "This displays the disk geometry of C<device> read from the partition table. "
24624 "Especially in the case where the underlying block device has been resized, "
24625 "this can be different from the kernel's idea of the geometry (see "
24626 "L</sfdisk-kernel-geometry>)."
24630 #: ../fish/guestfish-actions.pod:3965
24631 msgid "sfdisk-kernel-geometry"
24635 #: ../fish/guestfish-actions.pod:3967
24638 " sfdisk-kernel-geometry device\n"
24643 #: ../fish/guestfish-actions.pod:3974
24648 #: ../fish/guestfish-actions.pod:3976
24651 " sfdisk-l device\n"
24656 #: ../fish/guestfish-actions.pod:3982
24657 msgid "See also: L</part-list>"
24661 #: ../fish/guestfish-actions.pod:3984
24666 #: ../fish/guestfish-actions.pod:3986
24674 #: ../fish/guestfish-actions.pod:3991
24675 msgid "This is like L</command>, but passes the command to:"
24679 #: ../fish/guestfish-actions.pod:3999
24680 msgid "All the provisos about L</command> apply to this call."
24684 #: ../fish/guestfish-actions.pod:4001
24689 #: ../fish/guestfish-actions.pod:4003
24692 " sh-lines command\n"
24697 #: ../fish/guestfish-actions.pod:4005
24698 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24702 #: ../fish/guestfish-actions.pod:4008
24703 msgid "See also: L</command-lines>"
24707 #: ../fish/guestfish-actions.pod:4010
24712 #: ../fish/guestfish-actions.pod:4012
24720 #: ../fish/guestfish-actions.pod:4016
24725 #: ../fish/guestfish-actions.pod:4018
24733 #: ../fish/guestfish-actions.pod:4024
24738 #: ../fish/guestfish-actions.pod:4026
24746 #: ../fish/guestfish-actions.pod:4034
24751 #: ../fish/guestfish-actions.pod:4036
24759 #: ../fish/guestfish-actions.pod:4044
24764 #: ../fish/guestfish-actions.pod:4046
24767 " strings-e encoding path\n"
24772 #: ../fish/guestfish-actions.pod:4048
24774 "This is like the L</strings> command, but allows you to specify the encoding "
24775 "of strings that are looked for in the source file C<path>."
24779 #: ../fish/guestfish-actions.pod:4058
24781 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24782 "ISO-8859-X (this is what L</strings> uses)."
24786 #: ../fish/guestfish-actions.pod:4090
24787 msgid "swapoff-device"
24791 #: ../fish/guestfish-actions.pod:4092
24794 " swapoff-device device\n"
24799 #: ../fish/guestfish-actions.pod:4094
24801 "This command disables the libguestfs appliance swap device or partition "
24802 "named C<device>. See L</swapon-device>."
24806 #: ../fish/guestfish-actions.pod:4098
24807 msgid "swapoff-file"
24811 #: ../fish/guestfish-actions.pod:4100
24814 " swapoff-file file\n"
24819 #: ../fish/guestfish-actions.pod:4104
24820 msgid "swapoff-label"
24824 #: ../fish/guestfish-actions.pod:4106
24827 " swapoff-label label\n"
24832 #: ../fish/guestfish-actions.pod:4111
24833 msgid "swapoff-uuid"
24837 #: ../fish/guestfish-actions.pod:4113
24840 " swapoff-uuid uuid\n"
24845 #: ../fish/guestfish-actions.pod:4118
24846 msgid "swapon-device"
24850 #: ../fish/guestfish-actions.pod:4120
24853 " swapon-device device\n"
24858 #: ../fish/guestfish-actions.pod:4122
24860 "This command enables the libguestfs appliance to use the swap device or "
24861 "partition named C<device>. The increased memory is made available for all "
24862 "commands, for example those run using L</command> or L</sh>."
24866 #: ../fish/guestfish-actions.pod:4134
24867 msgid "swapon-file"
24871 #: ../fish/guestfish-actions.pod:4136
24874 " swapon-file file\n"
24879 #: ../fish/guestfish-actions.pod:4138
24880 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
24884 #: ../fish/guestfish-actions.pod:4141
24885 msgid "swapon-label"
24889 #: ../fish/guestfish-actions.pod:4143
24892 " swapon-label label\n"
24897 #: ../fish/guestfish-actions.pod:4145
24899 "This command enables swap to a labeled swap partition. See "
24900 "L</swapon-device> for other notes."
24904 #: ../fish/guestfish-actions.pod:4148
24905 msgid "swapon-uuid"
24909 #: ../fish/guestfish-actions.pod:4150
24912 " swapon-uuid uuid\n"
24917 #: ../fish/guestfish-actions.pod:4152
24919 "This command enables swap to a swap partition with the given UUID. See "
24920 "L</swapon-device> for other notes."
24924 #: ../fish/guestfish-actions.pod:4155
24929 #: ../fish/guestfish-actions.pod:4157
24937 #: ../fish/guestfish-actions.pod:4165
24942 #: ../fish/guestfish-actions.pod:4167
24950 #: ../fish/guestfish-actions.pod:4175
24955 #: ../fish/guestfish-actions.pod:4177
24958 " tail-n nrlines path\n"
24963 #: ../fish/guestfish-actions.pod:4190
24968 #: ../fish/guestfish-actions.pod:4192
24971 " tar-in (tarfile|-) directory\n"
24976 #: ../fish/guestfish-actions.pod:4197
24977 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24981 #: ../fish/guestfish-actions.pod:4202
24986 #: ../fish/guestfish-actions.pod:4204
24989 " tar-out directory (tarfile|-)\n"
24994 #: ../fish/guestfish-actions.pod:4209
24995 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24999 #: ../fish/guestfish-actions.pod:4214
25004 #: ../fish/guestfish-actions.pod:4216
25007 " tgz-in (tarball|-) directory\n"
25012 #: ../fish/guestfish-actions.pod:4221
25013 msgid "To upload an uncompressed tarball, use L</tar-in>."
25017 #: ../fish/guestfish-actions.pod:4225
25022 #: ../fish/guestfish-actions.pod:4227
25025 " tgz-out directory (tarball|-)\n"
25030 #: ../fish/guestfish-actions.pod:4232
25031 msgid "To download an uncompressed tarball, use L</tar-out>."
25035 #: ../fish/guestfish-actions.pod:4236
25040 #: ../fish/guestfish-actions.pod:4238
25048 #: ../fish/guestfish-actions.pod:4247
25053 #: ../fish/guestfish-actions.pod:4249
25061 #: ../fish/guestfish-actions.pod:4254
25062 msgid "truncate-size"
25066 #: ../fish/guestfish-actions.pod:4256
25069 " truncate-size path size\n"
25074 #: ../fish/guestfish-actions.pod:4261
25076 "If the current file size is less than C<size> then the file is extended to "
25077 "the required size with zero bytes. This creates a sparse file (ie. disk "
25078 "blocks are not allocated for the file until you write to it). To create a "
25079 "non-sparse file of zeroes, use L</fallocate64> instead."
25083 #: ../fish/guestfish-actions.pod:4267
25088 #: ../fish/guestfish-actions.pod:4269
25091 " tune2fs-l device\n"
25096 #: ../fish/guestfish-actions.pod:4279
25101 #: ../fish/guestfish-actions.pod:4281
25104 " txz-in (tarball|-) directory\n"
25109 #: ../fish/guestfish-actions.pod:4288
25114 #: ../fish/guestfish-actions.pod:4290
25117 " txz-out directory (tarball|-)\n"
25122 #: ../fish/guestfish-actions.pod:4297
25127 #: ../fish/guestfish-actions.pod:4299
25135 #: ../fish/guestfish-actions.pod:4313
25136 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
25140 #: ../fish/guestfish-actions.pod:4318
25145 #: ../fish/guestfish-actions.pod:4320
25150 #: ../fish/guestfish-actions.pod:4322
25153 " umount pathordevice\n"
25158 #: ../fish/guestfish-actions.pod:4328
25163 #: ../fish/guestfish-actions.pod:4330
25164 msgid "unmount-all"
25168 #: ../fish/guestfish-actions.pod:4332
25176 #: ../fish/guestfish-actions.pod:4338
25181 #: ../fish/guestfish-actions.pod:4340
25184 " upload (filename|-) remotefilename\n"
25189 #: ../fish/guestfish-actions.pod:4347
25190 msgid "See also L</download>."
25194 #: ../fish/guestfish-actions.pod:4351
25195 msgid "upload-offset"
25199 #: ../fish/guestfish-actions.pod:4353
25202 " upload-offset (filename|-) remotefilename offset\n"
25207 #: ../fish/guestfish-actions.pod:4365
25209 "Note that there is no limit on the amount of data that can be uploaded with "
25210 "this call, unlike with L</pwrite>, and this call always writes the full "
25211 "amount unless an error occurs."
25215 #: ../fish/guestfish-actions.pod:4370
25216 msgid "See also L</upload>, L</pwrite>."
25220 #: ../fish/guestfish-actions.pod:4374
25225 #: ../fish/guestfish-actions.pod:4376
25228 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
25233 #: ../fish/guestfish-actions.pod:4395
25238 #: ../fish/guestfish-actions.pod:4397
25246 #: ../fish/guestfish-actions.pod:4424
25248 "I<Note:> Don't use this call to test for availability of features. In "
25249 "enterprise distributions we backport features from later versions into "
25250 "earlier versions, making this an unreliable way to test for features. Use "
25251 "L</available> instead."
25255 #: ../fish/guestfish-actions.pod:4430
25260 #: ../fish/guestfish-actions.pod:4432
25263 " vfs-label device\n"
25268 #: ../fish/guestfish-actions.pod:4439
25269 msgid "To find a filesystem from the label, use L</findfs-label>."
25273 #: ../fish/guestfish-actions.pod:4441
25278 #: ../fish/guestfish-actions.pod:4443
25281 " vfs-type device\n"
25286 #: ../fish/guestfish-actions.pod:4453
25291 #: ../fish/guestfish-actions.pod:4455
25294 " vfs-uuid device\n"
25299 #: ../fish/guestfish-actions.pod:4462
25300 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
25304 #: ../fish/guestfish-actions.pod:4464
25305 msgid "vg-activate"
25309 #: ../fish/guestfish-actions.pod:4466
25312 " vg-activate true|false 'volgroups ...'\n"
25317 #: ../fish/guestfish-actions.pod:4479
25318 msgid "vg-activate-all"
25322 #: ../fish/guestfish-actions.pod:4481
25325 " vg-activate-all true|false\n"
25330 #: ../fish/guestfish-actions.pod:4491
25335 #: ../fish/guestfish-actions.pod:4493
25338 " vgcreate volgroup 'physvols ...'\n"
25343 #: ../fish/guestfish-actions.pod:4498
25348 #: ../fish/guestfish-actions.pod:4500
25351 " vglvuuids vgname\n"
25356 #: ../fish/guestfish-actions.pod:4505
25358 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
25359 "logical volumes and volume groups."
25363 #: ../fish/guestfish-actions.pod:4508
25364 msgid "See also L</vgpvuuids>."
25368 #: ../fish/guestfish-actions.pod:4510
25373 #: ../fish/guestfish-actions.pod:4512
25376 " vgpvuuids vgname\n"
25381 #: ../fish/guestfish-actions.pod:4517
25383 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
25384 "physical volumes and volume groups."
25388 #: ../fish/guestfish-actions.pod:4520
25389 msgid "See also L</vglvuuids>."
25393 #: ../fish/guestfish-actions.pod:4522
25398 #: ../fish/guestfish-actions.pod:4524
25401 " vgremove vgname\n"
25406 #: ../fish/guestfish-actions.pod:4531
25411 #: ../fish/guestfish-actions.pod:4533
25414 " vgrename volgroup newvolgroup\n"
25419 #: ../fish/guestfish-actions.pod:4537
25424 #: ../fish/guestfish-actions.pod:4539
25432 #: ../fish/guestfish-actions.pod:4547
25433 msgid "See also L</vgs-full>."
25437 #: ../fish/guestfish-actions.pod:4549
25442 #: ../fish/guestfish-actions.pod:4551
25450 #: ../fish/guestfish-actions.pod:4556
25455 #: ../fish/guestfish-actions.pod:4558
25463 #: ../fish/guestfish-actions.pod:4563
25468 #: ../fish/guestfish-actions.pod:4565
25476 #: ../fish/guestfish-actions.pod:4569
25481 #: ../fish/guestfish-actions.pod:4571
25489 #: ../fish/guestfish-actions.pod:4576
25494 #: ../fish/guestfish-actions.pod:4578
25502 #: ../fish/guestfish-actions.pod:4583
25507 #: ../fish/guestfish-actions.pod:4585
25515 #: ../fish/guestfish-actions.pod:4590
25520 #: ../fish/guestfish-actions.pod:4592
25523 " write path content\n"
25528 #: ../fish/guestfish-actions.pod:4600
25533 #: ../fish/guestfish-actions.pod:4602
25536 " write-file path content size\n"
25541 #: ../fish/guestfish-actions.pod:4625
25546 #: ../fish/guestfish-actions.pod:4627
25549 " zegrep regex path\n"
25554 #: ../fish/guestfish-actions.pod:4635
25559 #: ../fish/guestfish-actions.pod:4637
25562 " zegrepi regex path\n"
25567 #: ../fish/guestfish-actions.pod:4645
25572 #: ../fish/guestfish-actions.pod:4647
25580 #: ../fish/guestfish-actions.pod:4655
25581 msgid "See also: L</zero-device>, L</scrub-device>."
25585 #: ../fish/guestfish-actions.pod:4657
25586 msgid "zero-device"
25590 #: ../fish/guestfish-actions.pod:4659
25593 " zero-device device\n"
25598 #: ../fish/guestfish-actions.pod:4661
25600 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
25601 "which just zeroes the first few blocks of a device."
25605 #: ../fish/guestfish-actions.pod:4668
25610 #: ../fish/guestfish-actions.pod:4670
25613 " zerofree device\n"
25618 #: ../fish/guestfish-actions.pod:4683
25623 #: ../fish/guestfish-actions.pod:4685
25626 " zfgrep pattern path\n"
25631 #: ../fish/guestfish-actions.pod:4693
25636 #: ../fish/guestfish-actions.pod:4695
25639 " zfgrepi pattern path\n"
25644 #: ../fish/guestfish-actions.pod:4703
25649 #: ../fish/guestfish-actions.pod:4705
25652 " zfile meth path\n"
25657 #: ../fish/guestfish-actions.pod:4712
25658 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
25662 #: ../fish/guestfish-actions.pod:4722
25667 #: ../fish/guestfish-actions.pod:4724
25670 " zgrep regex path\n"
25675 #: ../fish/guestfish-actions.pod:4732
25680 #: ../fish/guestfish-actions.pod:4734
25683 " zgrepi regex path\n"
25688 #: ../fish/guestfish-commands.pod:1
25693 #: ../fish/guestfish-commands.pod:3
25698 #: ../fish/guestfish-commands.pod:5
25701 " alloc filename size\n"
25706 #: ../fish/guestfish-commands.pod:7
25708 "This creates an empty (zeroed) file of the given size, and then adds so it "
25709 "can be further examined."
25713 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25714 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25718 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25719 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25723 #: ../fish/guestfish-commands.pod:14
25725 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25726 "image, see L</PREPARED DISK IMAGES>."
25730 #: ../fish/guestfish-commands.pod:17
25735 #: ../fish/guestfish-commands.pod:19
25738 " copy-in local [local ...] /remotedir\n"
25743 #: ../fish/guestfish-commands.pod:21
25745 "C<copy-in> copies local files or directories recursively into the disk "
25746 "image, placing them in the directory called C</remotedir> (which must "
25747 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25748 "other commands as necessary."
25752 #: ../fish/guestfish-commands.pod:26
25754 "Multiple local files and directories can be specified, but the last "
25755 "parameter must always be a remote directory. Wildcards cannot be used."
25759 #: ../fish/guestfish-commands.pod:30
25764 #: ../fish/guestfish-commands.pod:32
25767 " copy-out remote [remote ...] localdir\n"
25772 #: ../fish/guestfish-commands.pod:34
25774 "C<copy-out> copies remote files or directories recursively out of the disk "
25775 "image, placing them on the host disk in a local directory called C<localdir> "
25776 "(which must exist). This guestfish meta-command turns into a sequence of "
25777 "L</download>, L</tar-out> and other commands as necessary."
25781 #: ../fish/guestfish-commands.pod:40
25783 "Multiple remote files and directories can be specified, but the last "
25784 "parameter must always be a local directory. To download to the current "
25785 "directory, use C<.> as in:"
25789 #: ../fish/guestfish-commands.pod:44
25792 " copy-out /home .\n"
25797 #: ../fish/guestfish-commands.pod:46
25799 "Wildcards cannot be used in the ordinary command, but you can use them with "
25800 "the help of L</glob> like this:"
25804 #: ../fish/guestfish-commands.pod:49
25807 " glob copy-out /home/* .\n"
25812 #: ../fish/guestfish-commands.pod:51
25817 #: ../fish/guestfish-commands.pod:53
25820 " echo [params ...]\n"
25825 #: ../fish/guestfish-commands.pod:55
25826 msgid "This echos the parameters to the terminal."
25830 #: ../fish/guestfish-commands.pod:57
25835 #: ../fish/guestfish-commands.pod:59
25840 #: ../fish/guestfish-commands.pod:61
25845 #: ../fish/guestfish-commands.pod:63
25853 #: ../fish/guestfish-commands.pod:65
25855 "This is used to edit a file. It downloads the file, edits it locally using "
25856 "your editor, then uploads the result."
25860 #: ../fish/guestfish-commands.pod:68
25862 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25863 "or C<emacs> you will get those corresponding editors."
25867 #: ../fish/guestfish-commands.pod:72
25872 #: ../fish/guestfish-commands.pod:74
25875 " glob command args...\n"
25880 #: ../fish/guestfish-commands.pod:76
25882 "Expand wildcards in any paths in the args list, and run C<command> "
25883 "repeatedly on each matching path."
25887 #: ../fish/guestfish-commands.pod:79
25888 msgid "See L</WILDCARDS AND GLOBBING>."
25892 #: ../fish/guestfish-commands.pod:81
25897 #: ../fish/guestfish-commands.pod:83
25900 " hexedit <filename|device>\n"
25901 " hexedit <filename|device> <max>\n"
25902 " hexedit <filename|device> <start> <max>\n"
25907 #: ../fish/guestfish-commands.pod:87
25909 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25914 #: ../fish/guestfish-commands.pod:90
25916 "This command works by downloading potentially the whole file or device, "
25917 "editing it locally, then uploading it. If the file or device is large, you "
25918 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25919 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25920 "usual modifiers allowed such as C<1M> (1 megabyte)."
25924 #: ../fish/guestfish-commands.pod:97
25925 msgid "For example to edit the first few sectors of a disk you might do:"
25929 #: ../fish/guestfish-commands.pod:100
25932 " hexedit /dev/sda 1M\n"
25937 #: ../fish/guestfish-commands.pod:102
25939 "which would allow you to edit anywhere within the first megabyte of the "
25944 #: ../fish/guestfish-commands.pod:105
25945 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25949 #: ../fish/guestfish-commands.pod:107
25952 " hexedit /dev/sda1 0x400 0x400\n"
25957 #: ../fish/guestfish-commands.pod:109
25958 msgid "(assuming the superblock is in the standard location)."
25962 #: ../fish/guestfish-commands.pod:111
25964 "This command requires the external L<hexedit(1)> program. You can specify "
25965 "another program to use by setting the C<HEXEDITOR> environment variable."
25969 #: ../fish/guestfish-commands.pod:115
25970 msgid "See also L</hexdump>."
25974 #: ../fish/guestfish-commands.pod:117
25979 #: ../fish/guestfish-commands.pod:119
25987 #: ../fish/guestfish-commands.pod:121
25988 msgid "Change the local directory, ie. the current directory of guestfish itself."
25992 #: ../fish/guestfish-commands.pod:124
25993 msgid "Note that C<!cd> won't do what you might expect."
25997 #: ../fish/guestfish-commands.pod:126
26002 #: ../fish/guestfish-commands.pod:128
26007 #: ../fish/guestfish-commands.pod:130
26015 #: ../fish/guestfish-commands.pod:132
26016 msgid "Opens the manual page for guestfish."
26020 #: ../fish/guestfish-commands.pod:134
26025 #: ../fish/guestfish-commands.pod:136
26030 #: ../fish/guestfish-commands.pod:138
26038 #: ../fish/guestfish-commands.pod:140
26046 #: ../fish/guestfish-commands.pod:142
26047 msgid "This is used to view a file."
26051 #: ../fish/guestfish-commands.pod:144
26053 "The default viewer is C<$PAGER>. However if you use the alternate command "
26054 "C<less> you will get the C<less> command specifically."
26058 #: ../fish/guestfish-commands.pod:147
26063 #: ../fish/guestfish-commands.pod:149
26071 #: ../fish/guestfish-commands.pod:151
26073 "Close and reopen the libguestfs handle. It is not necessary to use this "
26074 "normally, because the handle is closed properly when guestfish exits. "
26075 "However this is occasionally useful for testing."
26079 #: ../fish/guestfish-commands.pod:155
26084 #: ../fish/guestfish-commands.pod:157
26087 " sparse filename size\n"
26092 #: ../fish/guestfish-commands.pod:159
26094 "This creates an empty sparse file of the given size, and then adds so it can "
26095 "be further examined."
26099 #: ../fish/guestfish-commands.pod:162
26101 "In all respects it works the same as the L</alloc> command, except that the "
26102 "image file is allocated sparsely, which means that disk blocks are not "
26103 "assigned to the file until they are needed. Sparse disk files only use "
26104 "space when written to, but they are slower and there is a danger you could "
26105 "run out of real disk space during a write operation."
26109 #: ../fish/guestfish-commands.pod:172
26114 #: ../fish/guestfish-commands.pod:174
26122 #: ../fish/guestfish-commands.pod:176
26124 "This command returns a list of the optional groups known to the daemon, and "
26125 "indicates which ones are supported by this build of the libguestfs "
26130 #: ../fish/guestfish-commands.pod:180
26131 msgid "See also L<guestfs(3)/AVAILABILITY>."
26135 #: ../fish/guestfish-commands.pod:182
26140 #: ../fish/guestfish-commands.pod:184
26143 " time command args...\n"
26148 #: ../fish/guestfish-commands.pod:186
26150 "Run the command as usual, but print the elapsed time afterwards. This can "
26151 "be useful for benchmarking operations."
26155 #: ../test-tool/libguestfs-test-tool.pod:5
26156 msgid "libguestfs-test-tool - End user tests for libguestfs"
26160 #: ../test-tool/libguestfs-test-tool.pod:9
26163 " libguestfs-test-tool [--options]\n"
26168 #: ../test-tool/libguestfs-test-tool.pod:13
26170 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
26171 "and developers, to allow them to check basic libguestfs functionality is "
26172 "working. This is needed because libguestfs occasionally breaks for reasons "
26173 "beyond our control: usually because of changes in the underlying qemu or "
26174 "kernel packages, or the host environment."
26178 #: ../test-tool/libguestfs-test-tool.pod:20
26179 msgid "If you suspect a problem in libguestfs, then just run:"
26183 #: ../test-tool/libguestfs-test-tool.pod:22
26186 " libguestfs-test-tool\n"
26191 #: ../test-tool/libguestfs-test-tool.pod:24
26192 msgid "It will print lots of diagnostic messages."
26196 #: ../test-tool/libguestfs-test-tool.pod:26
26197 msgid "If it runs to completion successfully, you will see this near the end:"
26201 #: ../test-tool/libguestfs-test-tool.pod:28
26204 " ===== TEST FINISHED OK =====\n"
26209 #: ../test-tool/libguestfs-test-tool.pod:30
26210 msgid "and the test tool will exit with code 0."
26214 #: ../test-tool/libguestfs-test-tool.pod:32
26216 "If it fails (and/or exits with non-zero error code), please paste the "
26217 "B<complete, unedited> output of the test tool into a bug report. More "
26218 "information about reporting bugs can be found on the "
26219 "L<http://libguestfs.org/> website."
26223 #: ../test-tool/libguestfs-test-tool.pod:41
26228 #: ../test-tool/libguestfs-test-tool.pod:43
26229 msgid "Display short usage information and exit."
26233 #: ../test-tool/libguestfs-test-tool.pod:45
26234 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
26238 #: ../test-tool/libguestfs-test-tool.pod:47
26240 "Pass an alternate name for the helper program. libguestfs-test-tool will "
26241 "normally look in the C<$libexec> directory that was configured when the tool "
26246 #: ../test-tool/libguestfs-test-tool.pod:51
26247 msgid "I<--qemu qemu_binary>"
26251 #: ../test-tool/libguestfs-test-tool.pod:53
26253 "If you have downloaded another qemu binary, point this option at the full "
26254 "path of the binary to try it."
26258 #: ../test-tool/libguestfs-test-tool.pod:56
26259 msgid "I<--qemudir qemu_source_dir>"
26263 #: ../test-tool/libguestfs-test-tool.pod:58
26265 "If you have compiled qemu from source, point this option at the source "
26266 "directory to try it."
26270 #: ../test-tool/libguestfs-test-tool.pod:61
26271 msgid "I<--timeout N>"
26275 #: ../test-tool/libguestfs-test-tool.pod:63
26277 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
26278 "does not usually need to be adjusted unless your machine is very slow."
26282 #: ../test-tool/libguestfs-test-tool.pod:69
26283 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
26287 #: ../test-tool/libguestfs-test-tool.pod:71
26289 "If you have compiled another version of qemu from source and would like to "
26290 "try that, then you can use the I<--qemudir> option to point to the qemu "
26291 "source directory."
26295 #: ../test-tool/libguestfs-test-tool.pod:75
26297 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
26298 "option to point to the binary."
26302 #: ../test-tool/libguestfs-test-tool.pod:78
26304 "When using an alternate qemu with libguestfs, usually you would need to "
26305 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
26306 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
26307 "when you use either of the I<--qemudir> or I<--qemu> options."
26311 #: ../test-tool/libguestfs-test-tool.pod:85
26313 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
26314 "I<1> if there was an error."
26318 #: ../test-tool/libguestfs-test-tool.pod:92
26319 msgid "/usr/libexec/libguestfs-test-tool-helper"
26323 #: ../test-tool/libguestfs-test-tool.pod:94
26325 "This helper program is run inside the appliance and provides additional "
26330 #: ../test-tool/libguestfs-test-tool.pod:97
26331 msgid "/usr/bin/mkisofs"
26335 #: ../test-tool/libguestfs-test-tool.pod:99
26337 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
26338 "which is used as part of the tests."
26342 #: ../test-tool/libguestfs-test-tool.pod:106
26344 "For the full list of environment variables which may affect libguestfs, "
26345 "please see the L<guestfs(3)> manual page."
26349 #: ../test-tool/libguestfs-test-tool.pod:111
26350 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
26354 #: ../test-tool/libguestfs-test-tool.pod:121
26355 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
26359 #: ../fuse/guestmount.pod:5
26360 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
26364 #: ../fuse/guestmount.pod:9
26367 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
26372 #: ../fuse/guestmount.pod:11
26375 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
26380 #: ../fuse/guestmount.pod:13
26383 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
26388 #: ../fuse/guestmount.pod:17
26390 "You must I<not> use C<guestmount> in read-write mode on live virtual "
26391 "machines. If you do this, you risk disk corruption in the VM."
26395 #: ../fuse/guestmount.pod:22
26397 "The guestmount program can be used to mount virtual machine filesystems and "
26398 "other disk images on the host. It uses libguestfs for access to the guest "
26399 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
26400 "a mountable device."
26404 #: ../fuse/guestmount.pod:27
26406 "Along with other options, you have to give at least one device (I<-a> "
26407 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
26408 "option) or use the I<-i> inspection option. How this works is better "
26409 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
26414 #: ../fuse/guestmount.pod:33
26416 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
26417 "by you, and the filesystem will not be visible to any other users unless you "
26418 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
26419 "the filesystem, use the C<fusermount -u> command."
26423 #: ../fuse/guestmount.pod:41
26425 "For a typical Windows guest which has its main filesystem on the first "
26430 #: ../fuse/guestmount.pod:44
26433 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
26438 #: ../fuse/guestmount.pod:46
26440 "For a typical Linux guest which has a /boot filesystem on the first "
26441 "partition, and the root filesystem on a logical volume:"
26445 #: ../fuse/guestmount.pod:49
26448 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
26453 #: ../fuse/guestmount.pod:51
26454 msgid "To get libguestfs to detect guest mountpoints for you:"
26458 #: ../fuse/guestmount.pod:53
26461 " guestmount -a guest.img -i --ro /mnt\n"
26466 #: ../fuse/guestmount.pod:55
26467 msgid "For a libvirt guest called \"Guest\" you could do:"
26471 #: ../fuse/guestmount.pod:57
26474 " guestmount -d Guest -i --ro /mnt\n"
26479 #: ../fuse/guestmount.pod:59
26481 "If you don't know what filesystems are contained in a guest or disk image, "
26482 "use L<virt-filesystems(1)> first:"
26486 #: ../fuse/guestmount.pod:62
26489 " virt-filesystems MyGuest\n"
26494 #: ../fuse/guestmount.pod:64
26496 "If you want to trace the libguestfs calls but without excessive debugging "
26497 "information, we recommend:"
26501 #: ../fuse/guestmount.pod:67
26504 " guestmount [...] --trace /mnt\n"
26509 #: ../fuse/guestmount.pod:69
26510 msgid "If you want to debug the program, we recommend:"
26514 #: ../fuse/guestmount.pod:71
26517 " guestmount [...] --trace --verbose /mnt\n"
26522 #: ../fuse/guestmount.pod:77
26523 msgid "B<-a image> | B<--add image>"
26527 #: ../fuse/guestmount.pod:79
26528 msgid "Add a block device or virtual machine image."
26532 #: ../fuse/guestmount.pod:84
26533 msgid "B<-c URI> | B<--connect URI>"
26537 #: ../fuse/guestmount.pod:90
26538 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
26542 #: ../fuse/guestmount.pod:96
26543 msgid "B<--dir-cache-timeout N>"
26547 #: ../fuse/guestmount.pod:98
26549 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
26550 "seconds. The readdir cache [actually, there are several semi-independent "
26551 "caches] is populated after a readdir(2) call with the stat and extended "
26552 "attributes of the files in the directory, in anticipation that they will be "
26553 "requested soon after."
26557 #: ../fuse/guestmount.pod:104
26559 "There is also a different attribute cache implemented by FUSE (see the FUSE "
26560 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
26561 "requests, only cache existing ones."
26565 #: ../fuse/guestmount.pod:115
26566 msgid "B<--format=raw|qcow2|..> | B<--format>"
26570 #: ../fuse/guestmount.pod:122
26572 "If you have untrusted raw-format guest disk images, you should use this "
26573 "option to specify the disk format. This avoids a possible security problem "
26574 "with malicious guests (CVE-2010-3851). See also "
26575 "L<guestfs(3)/guestfs_add_drive_opts>."
26579 #: ../fuse/guestmount.pod:127
26580 msgid "B<--fuse-help>"
26584 #: ../fuse/guestmount.pod:129
26585 msgid "Display help on special FUSE options (see I<-o> below)."
26589 #: ../fuse/guestmount.pod:133
26590 msgid "Display brief help and exit."
26594 #: ../fuse/guestmount.pod:135
26595 msgid "B<-i> | B<--inspector>"
26599 #: ../fuse/guestmount.pod:146
26600 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
26604 #: ../fuse/guestmount.pod:148
26606 "Mount the named partition or logical volume on the given mountpoint B<in the "
26607 "guest> (this has nothing to do with mountpoints in the host)."
26611 #: ../fuse/guestmount.pod:151
26613 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
26614 "something on C</>."
26618 #: ../fuse/guestmount.pod:154
26619 msgid "B<-n> | B<--no-sync>"
26623 #: ../fuse/guestmount.pod:156
26625 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
26626 "unmounted. If you specify this option, then we don't attempt to sync the "
26627 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
26631 #: ../fuse/guestmount.pod:161
26632 msgid "B<-o option> | B<--option option>"
26636 #: ../fuse/guestmount.pod:163
26637 msgid "Pass extra options to FUSE."
26641 #: ../fuse/guestmount.pod:165
26643 "To get a list of all the extra options supported by FUSE, use the command "
26644 "below. Note that only the FUSE I<-o> options can be passed, and only some "
26645 "of them are a good idea."
26649 #: ../fuse/guestmount.pod:169
26652 " guestmount --fuse-help\n"
26657 #: ../fuse/guestmount.pod:171
26658 msgid "Some potentially useful FUSE options:"
26662 #: ../fuse/guestmount.pod:175
26663 msgid "B<-o allow_other>"
26667 #: ../fuse/guestmount.pod:177
26668 msgid "Allow other users to see the filesystem."
26672 #: ../fuse/guestmount.pod:179
26673 msgid "B<-o attr_timeout=N>"
26677 #: ../fuse/guestmount.pod:181
26678 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
26682 #: ../fuse/guestmount.pod:183
26683 msgid "B<-o kernel_cache>"
26687 #: ../fuse/guestmount.pod:185
26689 "Allow the kernel to cache files (reduces the number of reads that have to go "
26690 "through the L<guestfs(3)> API). This is generally a good idea if you can "
26691 "afford the extra memory usage."
26695 #: ../fuse/guestmount.pod:189
26696 msgid "B<-o uid=N> B<-o gid=N>"
26700 #: ../fuse/guestmount.pod:191
26702 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
26703 "the chosen values."
26707 #: ../fuse/guestmount.pod:196
26708 msgid "B<-r> | B<--ro>"
26712 #: ../fuse/guestmount.pod:198
26714 "Add devices and mount everything read-only. Also disallow writes and make "
26715 "the disk appear read-only to FUSE."
26719 #: ../fuse/guestmount.pod:201
26721 "This is highly recommended if you are not going to edit the guest disk. If "
26722 "the guest is running and this option is I<not> supplied, then there is a "
26723 "strong risk of disk corruption in the guest. We try to prevent this from "
26724 "happening, but it is not always possible."
26728 #: ../fuse/guestmount.pod:206
26729 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26733 #: ../fuse/guestmount.pod:210
26734 msgid "Enable SELinux support for the guest."
26738 #: ../fuse/guestmount.pod:212
26739 msgid "B<-v> | B<--verbose>"
26743 #: ../fuse/guestmount.pod:214
26744 msgid "Enable verbose messages from underlying libguestfs."
26748 #: ../fuse/guestmount.pod:216
26749 msgid "B<-V> | B<--version>"
26753 #: ../fuse/guestmount.pod:218
26754 msgid "Display the program version and exit."
26758 #: ../fuse/guestmount.pod:220
26759 msgid "B<-w> | B<--rw>"
26763 #: ../fuse/guestmount.pod:222
26765 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26766 "FOR READ AND WRITE>."
26770 #: ../fuse/guestmount.pod:225
26771 msgid "B<-x> | B<--trace>"
26775 #: ../fuse/guestmount.pod:227
26776 msgid "Trace libguestfs calls and entry into each FUSE function."
26780 #: ../fuse/guestmount.pod:229
26781 msgid "This also stops the daemon from forking into the background."
26785 #: ../fuse/guestmount.pod:235
26787 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26788 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
26789 "L<http://fuse.sf.net/>."
26793 #: ../tools/virt-edit.pl:34
26794 msgid "virt-edit - Edit a file in a virtual machine"
26798 #: ../tools/virt-edit.pl:38
26801 " virt-edit [--options] domname file\n"
26806 #: ../tools/virt-edit.pl:40
26809 " virt-edit [--options] disk.img [disk.img ...] file\n"
26814 #: ../tools/virt-edit.pl:42
26817 " virt-edit [domname|disk.img] file -e 'expr'\n"
26822 #: ../tools/virt-edit.pl:46
26824 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26825 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26826 "doing this, but doesn't catch all cases."
26830 #: ../tools/virt-edit.pl:52
26832 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26833 "the named virtual machine (or disk image)."
26837 #: ../tools/virt-edit.pl:55
26838 msgid "If you want to just view a file, use L<virt-cat(1)>."
26842 #: ../tools/virt-edit.pl:57
26844 "For more complex cases you should look at the L<guestfish(1)> tool (see "
26845 "L</USING GUESTFISH> below)."
26849 #: ../tools/virt-edit.pl:60
26851 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
26852 "files. L<guestfish(1)> can do that and much more."
26856 #: ../tools/virt-edit.pl:65
26857 msgid "Edit the named files interactively:"
26861 #: ../tools/virt-edit.pl:67
26864 " virt-edit mydomain /boot/grub/grub.conf\n"
26869 #: ../tools/virt-edit.pl:69
26872 " virt-edit mydomain /etc/passwd\n"
26877 #: ../tools/virt-edit.pl:71
26879 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26880 "below). To change the init default level to 5:"
26884 #: ../tools/virt-edit.pl:75
26887 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26892 #: ../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
26893 msgid "Display brief help."
26897 #: ../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
26898 msgid "Display version number and exit."
26902 #: ../tools/virt-edit.pl:101
26903 msgid "B<--backup extension> | B<-b extension>"
26907 #: ../tools/virt-edit.pl:103
26909 "Create a backup of the original file I<in the guest disk image>. The backup "
26910 "has the original filename with C<extension> added."
26914 #: ../tools/virt-edit.pl:106
26916 "Usually the first character of C<extension> would be a dot C<.> so you would "
26921 #: ../tools/virt-edit.pl:109
26924 " virt-edit -b .orig [etc]\n"
26929 #: ../tools/virt-edit.pl:111
26930 msgid "By default, no backup file is made."
26934 #: ../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
26935 msgid "B<--connect URI> | B<-c URI>"
26939 #: ../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
26941 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26942 "to the default libvirt hypervisor."
26946 #: ../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
26948 "If you specify guest block devices directly, then libvirt is not used at "
26953 #: ../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
26954 msgid "B<--format> raw"
26958 #: ../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
26960 "Specify the format of disk images given on the command line. If this is "
26961 "omitted then the format is autodetected from the content of the disk image."
26965 #: ../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
26967 "If disk images are requested from libvirt, then this program asks libvirt "
26968 "for this information. In this case, the value of the format parameter is "
26973 #: ../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
26975 "If working with untrusted raw-format guest disk images, you should ensure "
26976 "the format is always specified."
26980 #: ../tools/virt-edit.pl:146
26981 msgid "B<--expr EXPR> | B<-e EXPR>"
26985 #: ../tools/virt-edit.pl:148
26987 "Instead of launching the external editor, non-interactively apply the Perl "
26988 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26993 #: ../tools/virt-edit.pl:152
26995 "Be careful to properly quote the expression to prevent it from being altered "
27000 #: ../tools/virt-edit.pl:272
27001 msgid "NON-INTERACTIVE EDITING"
27005 #: ../tools/virt-edit.pl:274
27007 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
27008 "administrator can interactively edit the file."
27012 #: ../tools/virt-edit.pl:277
27014 "There are two ways also to use C<virt-edit> from scripts in order to make "
27015 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
27016 "like this, it's less error-prone to write scripts directly using the "
27017 "libguestfs API and Augeas for configuration file editing.)"
27021 #: ../tools/virt-edit.pl:283
27023 "The first method is to temporarily set C<$EDITOR> to any script or program "
27024 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
27025 "update C<tmpfile> in place however it likes."
27029 #: ../tools/virt-edit.pl:287
27031 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
27032 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
27033 "instances of C<foo> with C<bar> in a file:"
27037 #: ../tools/virt-edit.pl:291
27040 " virt-edit domname filename -e 's/foo/bar/'\n"
27045 #: ../tools/virt-edit.pl:293
27047 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
27048 "For example to delete root's password you could do:"
27052 #: ../tools/virt-edit.pl:296
27055 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
27060 #: ../tools/virt-edit.pl:298
27062 "What really happens is that the snippet is evaluated as a Perl expression "
27063 "for each line of the file. The line, including the final C<\\n>, is passed "
27064 "in C<$_> and the expression should update C<$_> or leave it unchanged."
27068 #: ../tools/virt-edit.pl:303
27070 "To delete a line, set C<$_> to the empty string. For example, to delete the "
27071 "C<apache> user account from the password file you can do:"
27075 #: ../tools/virt-edit.pl:306
27078 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
27083 #: ../tools/virt-edit.pl:308
27085 "To insert a line, prepend or append it to C<$_>. However appending lines to "
27086 "the end of the file is rather difficult this way since there is no concept "
27087 "of \"last line of the file\" - your expression just doesn't get called "
27088 "again. You might want to use the first method (setting C<$EDITOR>) if you "
27093 #: ../tools/virt-edit.pl:314
27095 "The variable C<$lineno> contains the current line number. As is "
27096 "traditional, the first line in the file is number C<1>."
27100 #: ../tools/virt-edit.pl:317
27102 "The return value from the expression is ignored, but the expression may call "
27103 "C<die> in order to abort the whole program, leaving the original file "
27108 #: ../tools/virt-edit.pl:321
27110 "Remember when matching the end of a line that C<$_> may contain the final "
27111 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
27112 "newline then neither of these. Thus to match or substitute some text at the "
27113 "end of a line, use this regular expression:"
27117 #: ../tools/virt-edit.pl:326
27120 " /some text(\\r?\\n)?$/\n"
27125 #: ../tools/virt-edit.pl:328
27127 "Alternately, use the perl C<chomp> function, being careful not to chomp "
27128 "C<$_> itself (since that would remove all newlines from the file):"
27132 #: ../tools/virt-edit.pl:332
27135 " my $m = $_; chomp $m; $m =~ /some text$/\n"
27140 #: ../tools/virt-edit.pl:334
27141 msgid "USING GUESTFISH"
27145 #: ../tools/virt-edit.pl:336
27147 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
27148 "C<virt-edit> doesn't work."
27152 #: ../tools/virt-edit.pl:339
27153 msgid "Using C<virt-edit> is approximately equivalent to doing:"
27157 #: ../tools/virt-edit.pl:341
27160 " guestfish --rw -i -d domname edit /file\n"
27165 #: ../tools/virt-edit.pl:343
27167 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
27168 "path to the file."
27172 #: ../tools/virt-edit.pl:346
27174 "The command above uses libguestfs's guest inspection feature and so does not "
27175 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
27176 "disk images that don't contain guests. To edit a file on a disk image "
27181 #: ../tools/virt-edit.pl:351
27184 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
27189 #: ../tools/virt-edit.pl:353
27191 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
27192 "the disk image to edit, and C</file> is the full path to the file."
27196 #: ../tools/virt-edit.pl:357
27198 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
27199 "C<write> or C<upload> instead:"
27203 #: ../tools/virt-edit.pl:360
27206 " guestfish --rw -i -d domname touch /newfile\n"
27211 #: ../tools/virt-edit.pl:362
27214 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
27219 #: ../tools/virt-edit.pl:364
27222 " guestfish --rw -i -d domname upload localfile /newfile\n"
27227 #: ../tools/virt-edit.pl:366
27228 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
27232 #: ../tools/virt-edit.pl:369
27235 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
27240 #: ../tools/virt-edit.pl:379
27245 #: ../tools/virt-edit.pl:381
27247 "If set, this string is used as the editor. It may contain arguments, "
27248 "eg. C<\"emacs -nw\">"
27252 #: ../tools/virt-edit.pl:384
27253 msgid "If not set, C<vi> is used."
27257 #: ../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
27258 msgid "SHELL QUOTING"
27262 #: ../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
27264 "Libvirt guest names can contain arbitrary characters, some of which have "
27265 "meaning to the shell such as C<#> and space. You may need to quote or "
27266 "escape these characters on the command line. See the shell manual page "
27267 "L<sh(1)> for details."
27271 #: ../tools/virt-edit.pl:397
27273 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27274 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
27275 "L<perl(1)>, L<perlre(1)>."
27279 #: ../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
27284 #: ../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
27285 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
27289 #: ../tools/virt-edit.pl:413
27290 msgid "Copyright (C) 2009-2011 Red Hat Inc."
27294 #: ../tools/virt-win-reg.pl:37
27296 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
27301 #: ../tools/virt-win-reg.pl:41
27304 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
27309 #: ../tools/virt-win-reg.pl:43
27312 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
27317 #: ../tools/virt-win-reg.pl:45
27320 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
27325 #: ../tools/virt-win-reg.pl:47
27328 " virt-win-reg --merge domname [input.reg ...]\n"
27333 #: ../tools/virt-win-reg.pl:49
27336 " virt-win-reg [--options] disk.img ... # instead of domname\n"
27341 #: ../tools/virt-win-reg.pl:53
27343 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
27344 "virtual machines. If you do this, you I<will> get irreversible disk "
27345 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
27346 "but doesn't catch all cases."
27350 #: ../tools/virt-win-reg.pl:58
27352 "Modifying the Windows Registry is an inherently risky operation. The format "
27353 "is deliberately obscure and undocumented, and Registry changes can leave the "
27354 "system unbootable. Therefore when using the C<--merge> option, make sure "
27355 "you have a reliable backup first."
27359 #: ../tools/virt-win-reg.pl:65
27361 "This program can export and merge Windows Registry entries from a Windows "
27366 #: ../tools/virt-win-reg.pl:68
27368 "The first parameter is the libvirt guest name or the raw disk image of a "
27373 #: ../tools/virt-win-reg.pl:71
27375 "If C<--merge> is I<not> specified, then the chosen registry key is "
27376 "displayed/exported (recursively). For example:"
27380 #: ../tools/virt-win-reg.pl:74
27383 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
27388 #: ../tools/virt-win-reg.pl:76
27389 msgid "You can also display single values from within registry keys, for example:"
27393 #: ../tools/virt-win-reg.pl:79
27396 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
27397 " $ virt-win-reg Windows7 $cvkey ProductName\n"
27398 " Windows 7 Enterprise\n"
27403 #: ../tools/virt-win-reg.pl:83
27405 "With C<--merge>, you can merge a textual regedit file into the Windows "
27410 #: ../tools/virt-win-reg.pl:86
27413 " $ virt-win-reg --merge Windows7 changes.reg\n"
27418 #: ../tools/virt-win-reg.pl:88
27423 #: ../tools/virt-win-reg.pl:90
27425 "This program is only meant for simple access to the registry. If you want "
27426 "to do complicated things with the registry, we suggest you download the "
27427 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27428 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27429 "L<hivexregedit(1)>."
27433 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
27438 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
27439 msgid "Enable debugging messages."
27443 #: ../tools/virt-win-reg.pl:157
27448 #: ../tools/virt-win-reg.pl:159
27450 "In merge mode, this merges a textual regedit file into the Windows Registry "
27451 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27452 "displays or exports Registry entries instead."
27456 #: ../tools/virt-win-reg.pl:163
27458 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27459 "result in disk corruption. However exporting (without this flag) is always "
27464 #: ../tools/virt-win-reg.pl:171
27465 msgid "B<--encoding> UTF-16LE|ASCII"
27469 #: ../tools/virt-win-reg.pl:173
27471 "When merging (only), you may need to specify the encoding for strings to be "
27472 "used in the hive file. This is explained in detail in "
27473 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
27477 #: ../tools/virt-win-reg.pl:177
27479 "The default is to use UTF-16LE, which should work with recent versions of "
27484 #: ../tools/virt-win-reg.pl:402
27485 msgid "SUPPORTED SYSTEMS"
27489 #: ../tools/virt-win-reg.pl:404
27491 "The program currently supports Windows NT-derived guests starting with "
27492 "Windows XP through to at least Windows 7."
27496 #: ../tools/virt-win-reg.pl:407
27498 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
27499 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
27500 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
27504 #: ../tools/virt-win-reg.pl:411
27506 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
27511 #: ../tools/virt-win-reg.pl:414
27513 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
27518 #: ../tools/virt-win-reg.pl:417
27523 #: ../tools/virt-win-reg.pl:419
27525 "C<virt-win-reg> expects that regedit files have already been reencoded in "
27526 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
27527 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
27528 "with Windows-style line endings, you may need to reencode the whole file "
27529 "before or after processing."
27533 #: ../tools/virt-win-reg.pl:425
27535 "To reencode a file from Windows format to Linux (before processing it with "
27536 "the C<--merge> option), you would do something like this:"
27540 #: ../tools/virt-win-reg.pl:428
27543 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
27548 #: ../tools/virt-win-reg.pl:430
27550 "To go in the opposite direction, after exporting and before sending the file "
27551 "to a Windows user, do something like this:"
27555 #: ../tools/virt-win-reg.pl:433
27558 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
27563 #: ../tools/virt-win-reg.pl:435
27564 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
27568 #: ../tools/virt-win-reg.pl:437
27570 "If you are unsure about the current encoding, use the L<file(1)> command. "
27571 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
27572 "Windows-style (CRLF) line endings, like this:"
27576 #: ../tools/virt-win-reg.pl:441
27579 " $ file software.reg\n"
27580 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
27581 " with CRLF line terminators\n"
27586 #: ../tools/virt-win-reg.pl:445
27587 msgid "This file would need conversion before you could C<--merge> it."
27591 #: ../tools/virt-win-reg.pl:447
27592 msgid "CurrentControlSet etc."
27596 #: ../tools/virt-win-reg.pl:449
27598 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
27599 "Registry at the level of the hive file, and therefore you cannot modify "
27604 #: ../tools/virt-win-reg.pl:453
27606 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
27607 "circumstances it might refer to another control set. The way to find out is "
27608 "to look at the C<HKLM\\SYSTEM\\Select> key:"
27612 #: ../tools/virt-win-reg.pl:457
27615 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
27616 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
27617 " \"Current\"=dword:00000001\n"
27618 " \"Default\"=dword:00000001\n"
27619 " \"Failed\"=dword:00000000\n"
27620 " \"LastKnownGood\"=dword:00000002\n"
27625 #: ../tools/virt-win-reg.pl:464
27626 msgid "\"Current\" is the one which Windows will choose when it boots."
27630 #: ../tools/virt-win-reg.pl:466
27631 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
27635 #: ../tools/virt-win-reg.pl:469
27636 msgid "WINDOWS TIPS"
27640 #: ../tools/virt-win-reg.pl:471
27642 "Note that some of these tips modify the guest disk image. The guest I<must> "
27643 "be shut off, else you will get disk corruption."
27647 #: ../tools/virt-win-reg.pl:474
27648 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
27652 #: ../tools/virt-win-reg.pl:476
27654 "Prepare a DOS batch script, VBScript or executable. Upload this using "
27655 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
27656 "is uploaded into C<C:\\>:"
27660 #: ../tools/virt-win-reg.pl:480
27663 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
27668 #: ../tools/virt-win-reg.pl:482
27669 msgid "Prepare a regedit file containing the registry change:"
27673 #: ../tools/virt-win-reg.pl:484
27676 " cat > test.reg <<'EOF'\n"
27677 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
27678 " \"Test\"=\"c:\\\\test.bat\"\n"
27684 #: ../tools/virt-win-reg.pl:489
27686 "In this example we use the key C<RunOnce> which means that the script will "
27687 "run precisely once when the first user logs in. If you want it to run every "
27688 "time a user logs in, replace C<RunOnce> with C<Run>."
27692 #: ../tools/virt-win-reg.pl:493
27693 msgid "Now update the registry:"
27697 #: ../tools/virt-win-reg.pl:495
27700 " virt-win-reg --merge WindowsGuest test.reg\n"
27705 #: ../tools/virt-win-reg.pl:497
27706 msgid "INSTALLING A SERVICE"
27710 #: ../tools/virt-win-reg.pl:499
27712 "This section assumes you are familiar with Windows services, and you either "
27713 "have a program which handles the Windows Service Control Protocol directly "
27714 "or you want to run any program using a service wrapper like SrvAny or the "
27719 #: ../tools/virt-win-reg.pl:504
27721 "First upload the program and optionally the service wrapper. In this case "
27722 "the test program is called C<test.exe> and we are using the RHSrvAny "
27727 #: ../tools/virt-win-reg.pl:508
27730 " guestfish -i -d WindowsGuest <<EOF\n"
27731 " upload rhsrvany.exe /rhsrvany.exe\n"
27732 " upload test.exe /test.exe\n"
27738 #: ../tools/virt-win-reg.pl:513
27740 "Prepare a regedit file containing the registry changes. In this example, "
27741 "the first registry change is needed for the service itself or the service "
27742 "wrapper (if used). The second registry change is only needed because I am "
27743 "using the RHSrvAny service wrapper."
27747 #: ../tools/virt-win-reg.pl:518
27750 " cat > service.reg <<'EOF'\n"
27751 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
27752 " \"Type\"=dword:00000010\n"
27753 " \"Start\"=dword:00000002\n"
27754 " \"ErrorControl\"=dword:00000001\n"
27755 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
27756 " \"DisplayName\"=\"RHSrvAny\"\n"
27757 " \"ObjectName\"=\"NetworkService\"\n"
27762 #: ../tools/virt-win-reg.pl:527
27765 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
27766 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
27767 " \"PWD\"=\"c:\\\\Temp\"\n"
27773 #: ../tools/virt-win-reg.pl:538
27775 "For use of C<ControlSet001> see the section above in this manual page. You "
27776 "may need to adjust this according to the control set that is in use by the "
27781 #: ../tools/virt-win-reg.pl:544
27783 "C<\"ObjectName\"> controls the privileges that the service will have. An "
27784 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
27785 "privileged account."
27789 #: ../tools/virt-win-reg.pl:550
27791 "For the meaning of the magic numbers, see this Microsoft KB article: "
27792 "L<http://support.microsoft.com/kb/103000>."
27796 #: ../tools/virt-win-reg.pl:555
27797 msgid "Update the registry:"
27801 #: ../tools/virt-win-reg.pl:557
27804 " virt-win-reg --merge WindowsGuest service.reg\n"
27809 #: ../tools/virt-win-reg.pl:561
27811 "Be careful when passing parameters containing C<\\> (backslash) in the "
27812 "shell. Usually you will have to use 'single quotes' or double backslashes "
27813 "(but not both) to protect them from the shell."
27817 #: ../tools/virt-win-reg.pl:565
27818 msgid "Paths and value names are case-insensitive."
27822 #: ../tools/virt-win-reg.pl:574
27824 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
27825 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27826 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
27827 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27831 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
27833 "When reporting bugs, please enable debugging and capture the I<complete> "
27838 #: ../tools/virt-win-reg.pl:592
27841 " export LIBGUESTFS_DEBUG=1\n"
27842 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
27847 #: ../tools/virt-win-reg.pl:595
27849 "Attach /tmp/virt-win-reg.log to a new bug report at "
27850 "L<https://bugzilla.redhat.com/>"
27854 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:570
27855 msgid "Copyright (C) 2010 Red Hat Inc."
27859 #: ../tools/virt-resize.pl:42
27860 msgid "virt-resize - Resize a virtual machine disk"
27864 #: ../tools/virt-resize.pl:46
27867 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27868 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27869 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27874 #: ../tools/virt-resize.pl:52
27876 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27877 "larger or smaller overall, and resizing or deleting any partitions contained "
27882 #: ../tools/virt-resize.pl:56
27884 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27885 "not> be used on live virtual machines - for consistent results, shut the "
27886 "virtual machine down before resizing it."
27890 #: ../tools/virt-resize.pl:60
27892 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
27893 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
27897 #: ../tools/virt-resize.pl:66
27899 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27900 "fill the extra 5GB of space."
27904 #: ../tools/virt-resize.pl:69
27907 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27908 " virt-filesystems --long -h --all -a olddisk\n"
27909 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27910 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27915 #: ../tools/virt-resize.pl:74
27917 "As above, but make the /boot partition 200MB bigger, while giving the "
27918 "remaining space to /dev/sda2:"
27922 #: ../tools/virt-resize.pl:77
27925 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
27930 #: ../tools/virt-resize.pl:79
27931 msgid "As above, but the output format will be uncompressed qcow2:"
27935 #: ../tools/virt-resize.pl:81
27938 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
27939 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
27944 #: ../tools/virt-resize.pl:84
27945 msgid "DETAILED USAGE"
27949 #: ../tools/virt-resize.pl:86
27950 msgid "EXPANDING A VIRTUAL MACHINE DISK"
27954 #: ../tools/virt-resize.pl:90
27955 msgid "1. Shut down the virtual machine"
27959 #: ../tools/virt-resize.pl:92
27960 msgid "2. Locate input disk image"
27964 #: ../tools/virt-resize.pl:94
27966 "Locate the input disk image (ie. the file or device on the host containing "
27967 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27968 "dumpxml> like this to find the disk image name:"
27972 #: ../tools/virt-resize.pl:98
27975 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27976 " Found 1 nodes:\n"
27978 " <source dev=\"/dev/vg/lv_guest\" />\n"
27983 #: ../tools/virt-resize.pl:103
27984 msgid "3. Look at current sizing"
27988 #: ../tools/virt-resize.pl:105
27989 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
27993 #: ../tools/virt-resize.pl:108
27996 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
27997 " Name Type Size Parent\n"
27998 " /dev/sda1 partition 101M /dev/sda\n"
27999 " /dev/sda2 partition 7.9G /dev/sda\n"
28000 " /dev/sda device 8.0G -\n"
28005 #: ../tools/virt-resize.pl:114
28007 "(This example is a virtual machine with an 8 GB disk which we would like to "
28008 "expand up to 10 GB)."
28012 #: ../tools/virt-resize.pl:117
28013 msgid "4. Create output disk"
28017 #: ../tools/virt-resize.pl:119
28019 "Virt-resize cannot do in-place disk modifications. You have to have space "
28020 "to store the resized output disk."
28024 #: ../tools/virt-resize.pl:122
28025 msgid "To store the resized disk image in a file, create a file of a suitable size:"
28029 #: ../tools/virt-resize.pl:125
28032 " # rm -f outdisk\n"
28033 " # truncate -s 10G outdisk\n"
28038 #: ../tools/virt-resize.pl:128
28039 msgid "Or use L<lvcreate(1)> to create a logical volume:"
28043 #: ../tools/virt-resize.pl:130
28046 " # lvcreate -L 10G -n lv_name vg_name\n"
28051 #: ../tools/virt-resize.pl:132
28052 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
28056 #: ../tools/virt-resize.pl:134
28059 " # virsh pool-list\n"
28060 " # virsh vol-create-as poolname newvol 10G\n"
28065 #: ../tools/virt-resize.pl:137
28070 #: ../tools/virt-resize.pl:139
28072 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
28073 "file) and the output disk. The output disk is the one created in the "
28078 #: ../tools/virt-resize.pl:143
28081 " # virt-resize indisk outdisk\n"
28086 #: ../tools/virt-resize.pl:145
28088 "This command just copies disk image C<indisk> to disk image C<outdisk> "
28089 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
28090 "larger, then an extra, empty partition is created at the end of the disk "
28091 "covering the extra space. If C<outdisk> is smaller, then it will give an "
28096 #: ../tools/virt-resize.pl:151
28098 "More realistically you'd want to expand existing partitions in the disk "
28099 "image by passing extra options (for the full list see the L</OPTIONS> "
28104 #: ../tools/virt-resize.pl:155
28106 "L</--expand> is the most useful option. It expands the named partition "
28107 "within the disk to fill any extra space:"
28111 #: ../tools/virt-resize.pl:158
28114 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
28119 #: ../tools/virt-resize.pl:160
28121 "(In this case, an extra partition is I<not> created at the end of the disk, "
28122 "because there will be no unused space)."
28126 #: ../tools/virt-resize.pl:163
28128 "L</--resize> is the other commonly used option. The following would "
28129 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
28130 "rest of the available space:"
28134 #: ../tools/virt-resize.pl:167
28137 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
28138 " indisk outdisk\n"
28143 #: ../tools/virt-resize.pl:170
28145 "If the expanded partition in the image contains a filesystem or LVM PV, then "
28146 "if virt-resize knows how, it will resize the contents, the equivalent of "
28147 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
28148 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
28149 "filesystems, so you would have to online resize them after booting the "
28154 #: ../tools/virt-resize.pl:177
28155 msgid "Other options are covered below."
28159 #: ../tools/virt-resize.pl:179
28164 #: ../tools/virt-resize.pl:181
28165 msgid "Thoroughly test the new disk image I<before> discarding the old one."
28169 #: ../tools/virt-resize.pl:183
28170 msgid "If you are using libvirt, edit the XML to point at the new disk:"
28174 #: ../tools/virt-resize.pl:185
28177 " # virsh edit guestname\n"
28182 #: ../tools/virt-resize.pl:187
28184 "Change E<lt>source ...E<gt>, see "
28185 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
28189 #: ../tools/virt-resize.pl:190
28190 msgid "Then start up the domain with the new, resized disk:"
28194 #: ../tools/virt-resize.pl:192
28197 " # virsh start guestname\n"
28202 #: ../tools/virt-resize.pl:194
28204 "and check that it still works. See also the L</NOTES> section below for "
28205 "additional information."
28209 #: ../tools/virt-resize.pl:197
28210 msgid "7. Resize LVs etc inside the guest"
28214 #: ../tools/virt-resize.pl:199
28215 msgid "(This can also be done offline using L<guestfish(1)>)"
28219 #: ../tools/virt-resize.pl:201
28221 "Once the guest has booted you should see the new space available, at least "
28222 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
28223 "may need to resize LVs inside PVs, and also resize filesystem types that "
28224 "virt-resize does not know how to expand."
28228 #: ../tools/virt-resize.pl:208
28229 msgid "SHRINKING A VIRTUAL MACHINE DISK"
28233 #: ../tools/virt-resize.pl:210
28235 "Shrinking is somewhat more complex than expanding, and only an overview is "
28240 #: ../tools/virt-resize.pl:213
28242 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
28243 "filesystems). The user has to shrink content before passing the disk image "
28244 "to virt-resize, and virt-resize will check that the content has been shrunk "
28249 #: ../tools/virt-resize.pl:218
28250 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28254 #: ../tools/virt-resize.pl:220
28256 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28257 "steps 3 and 4 above to allocate a new disk image."
28261 #: ../tools/virt-resize.pl:223
28262 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28266 #: ../tools/virt-resize.pl:226
28267 msgid "IGNORING OR DELETING PARTITIONS"
28271 #: ../tools/virt-resize.pl:228
28273 "virt-resize also gives a convenient way to ignore or delete partitions when "
28274 "copying from the input disk to the output disk. Ignoring a partition speeds "
28275 "up the copy where you don't care about the existing contents of a "
28276 "partition. Deleting a partition removes it completely, but note that it "
28277 "also renumbers any partitions after the one which is deleted, which can "
28278 "leave some guests unbootable."
28282 #: ../tools/virt-resize.pl:235
28283 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28287 #: ../tools/virt-resize.pl:237
28289 "If the input disk is in qcow2 format, then you may prefer that the output is "
28290 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28291 "the fly. The output format is simply determined by the format of the empty "
28292 "output container that you provide. Thus to create qcow2 output, use:"
28296 #: ../tools/virt-resize.pl:243
28299 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28304 #: ../tools/virt-resize.pl:245
28305 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28309 #: ../tools/virt-resize.pl:247
28310 msgid "Similarly, to get non-sparse raw output use:"
28314 #: ../tools/virt-resize.pl:249
28317 " fallocate -l size outdisk\n"
28322 #: ../tools/virt-resize.pl:251
28324 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
28325 "if=/dev/zero of=outdisk bs=1M count=..>)"
28329 #: ../tools/virt-resize.pl:264
28330 msgid "Display help."
28334 #: ../tools/virt-resize.pl:278
28335 msgid "B<--resize part=size>"
28339 #: ../tools/virt-resize.pl:280
28341 "Resize the named partition (expanding or shrinking it) so that it has the "
28346 #: ../tools/virt-resize.pl:283
28348 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28349 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28350 "Exabytes; or as a percentage of the current size; or as a relative number or "
28351 "percentage. For example:"
28355 #: ../tools/virt-resize.pl:288
28358 " --resize /dev/sda2=10G\n"
28363 #: ../tools/virt-resize.pl:290
28366 " --resize /dev/sda4=90%\n"
28371 #: ../tools/virt-resize.pl:292
28374 " --resize /dev/sda2=+1G\n"
28379 #: ../tools/virt-resize.pl:294
28382 " --resize /dev/sda2=-200M\n"
28387 #: ../tools/virt-resize.pl:296
28390 " --resize /dev/sda1=+128K\n"
28395 #: ../tools/virt-resize.pl:298
28398 " --resize /dev/sda1=+10%\n"
28403 #: ../tools/virt-resize.pl:300
28406 " --resize /dev/sda1=-10%\n"
28411 #: ../tools/virt-resize.pl:302
28413 "You can increase the size of any partition. Virt-resize will expand the "
28414 "direct content of the partition if it knows how (see C<--expand> below)."
28418 #: ../tools/virt-resize.pl:306
28420 "You can only I<decrease> the size of partitions that contain filesystems or "
28421 "PVs which have already been shrunk. Virt-resize will check this has been "
28422 "done before proceeding, or else will print an error (see also "
28423 "C<--resize-force>)."
28427 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
28428 msgid "You can give this option multiple times."
28432 #: ../tools/virt-resize.pl:317
28433 msgid "B<--resize-force part=size>"
28437 #: ../tools/virt-resize.pl:319
28439 "This is the same as C<--resize> except that it will let you decrease the "
28440 "size of any partition. Generally this means you will lose any data which "
28441 "was at the end of the partition you shrink, but you may not care about that "
28442 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28443 "as a swap partition)."
28447 #: ../tools/virt-resize.pl:325
28448 msgid "See also the C<--ignore> option."
28452 #: ../tools/virt-resize.pl:331
28453 msgid "B<--expand part>"
28457 #: ../tools/virt-resize.pl:333
28459 "Expand the named partition so it uses up all extra space (space left over "
28460 "after any other resize changes that you request have been done)."
28464 #: ../tools/virt-resize.pl:336
28466 "If virt-resize knows how, it will expand the direct content of the "
28467 "partition. For example, if the partition is an LVM PV, it will expand the "
28468 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28469 "content it doesn't know about alone."
28473 #: ../tools/virt-resize.pl:341
28474 msgid "Currently virt-resize can resize:"
28478 #: ../tools/virt-resize.pl:347
28480 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28485 #: ../tools/virt-resize.pl:352
28487 "NTFS filesystems contained directly in a partition, if libguestfs was "
28488 "compiled with support for NTFS."
28492 #: ../tools/virt-resize.pl:355
28494 "The filesystem must have been shut down consistently last time it was used. "
28495 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
28496 "consistency check, so at the first boot after resizing Windows will check "
28501 #: ../tools/virt-resize.pl:362
28503 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
28504 "inside the PV, but see the C<--LV-expand> option. The user could also "
28505 "resize LVs as desired after boot."
28509 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
28510 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
28514 #: ../tools/virt-resize.pl:374
28515 msgid "B<--shrink part>"
28519 #: ../tools/virt-resize.pl:376
28521 "Shrink the named partition until the overall disk image fits in the "
28522 "destination. The named partition B<must> contain a filesystem or PV which "
28523 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
28524 "online tools). Virt-resize will check this and give an error if it has not "
28529 #: ../tools/virt-resize.pl:382
28531 "The amount by which the overall disk must be shrunk (after carrying out all "
28532 "other operations requested by the user) is called the \"deficit\". For "
28533 "example, a straight copy (assume no other operations) from a 5GB disk image "
28534 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
28535 "would give an error unless the user specified a partition to shrink and that "
28536 "partition had more than a gigabyte of free space."
28540 #: ../tools/virt-resize.pl:396
28541 msgid "B<--ignore part>"
28545 #: ../tools/virt-resize.pl:398
28547 "Ignore the named partition. Effectively this means the partition is "
28548 "allocated on the destination disk, but the content is not copied across from "
28549 "the source disk. The content of the partition will be blank (all zero "
28554 #: ../tools/virt-resize.pl:409
28555 msgid "B<--delete part>"
28559 #: ../tools/virt-resize.pl:411
28561 "Delete the named partition. It would be more accurate to describe this as "
28562 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
28563 "the original disk image is left intact."
28567 #: ../tools/virt-resize.pl:415
28569 "Note that when you delete a partition, then anything contained in the "
28570 "partition is also deleted. Furthermore, this causes any partitions that "
28571 "come after to be I<renumbered>, which can easily make your guest unbootable."
28575 #: ../tools/virt-resize.pl:426
28576 msgid "B<--LV-expand logvol>"
28580 #: ../tools/virt-resize.pl:428
28582 "This takes the logical volume and, as a final step, expands it to fill all "
28583 "the space available in its volume group. A typical usage, assuming a Linux "
28584 "guest with a single PV C</dev/sda2> and a root device called "
28585 "C</dev/vg_guest/lv_root> would be:"
28589 #: ../tools/virt-resize.pl:433
28592 " virt-resize indisk outdisk \\\n"
28593 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
28598 #: ../tools/virt-resize.pl:436
28600 "This would first expand the partition (and PV), and then expand the root "
28601 "device to fill the extra space in the PV."
28605 #: ../tools/virt-resize.pl:439
28607 "The contents of the LV are also resized if virt-resize knows how to do "
28608 "that. You can stop virt-resize from trying to expand the content by using "
28609 "the option C<--no-expand-content>."
28613 #: ../tools/virt-resize.pl:443
28614 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
28618 #: ../tools/virt-resize.pl:446
28620 "You can give this option multiple times, I<but> it doesn't make sense to do "
28621 "this unless the logical volumes you specify are all in different volume "
28626 #: ../tools/virt-resize.pl:454
28627 msgid "B<--no-copy-boot-loader>"
28631 #: ../tools/virt-resize.pl:456
28633 "By default, virt-resize copies over some sectors at the start of the disk "
28634 "(up to the beginning of the first partition). Commonly these sectors "
28635 "contain the Master Boot Record (MBR) and the boot loader, and are required "
28636 "in order for the guest to boot correctly."
28640 #: ../tools/virt-resize.pl:461
28642 "If you specify this flag, then this initial copy is not done. You may need "
28643 "to reinstall the boot loader in this case."
28647 #: ../tools/virt-resize.pl:469
28648 msgid "B<--no-extra-partition>"
28652 #: ../tools/virt-resize.pl:471
28654 "By default, virt-resize creates an extra partition if there is any extra, "
28655 "unused space after all resizing has happened. Use this option to prevent "
28656 "the extra partition from being created. If you do this then the extra space "
28657 "will be inaccessible until you run fdisk, parted, or some other partitioning "
28658 "tool in the guest."
28662 #: ../tools/virt-resize.pl:477
28664 "Note that if the surplus space is smaller than 10 MB, no extra partition "
28669 #: ../tools/virt-resize.pl:484
28670 msgid "B<--no-expand-content>"
28674 #: ../tools/virt-resize.pl:486
28676 "By default, virt-resize will try to expand the direct contents of "
28677 "partitions, if it knows how (see C<--expand> option above)."
28681 #: ../tools/virt-resize.pl:489
28683 "If you give the C<--no-expand-content> option then virt-resize will not "
28688 #: ../tools/virt-resize.pl:496
28689 msgid "B<-d> | B<--debug>"
28693 #: ../tools/virt-resize.pl:504
28694 msgid "B<-n> | B<--dryrun>"
28698 #: ../tools/virt-resize.pl:506
28699 msgid "Print a summary of what would be done, but don't do anything."
28703 #: ../tools/virt-resize.pl:512
28704 msgid "B<-q> | B<--quiet>"
28708 #: ../tools/virt-resize.pl:514
28709 msgid "Don't print the summary."
28713 #: ../tools/virt-resize.pl:522
28715 "Specify the format of the input disk image. If this flag is not given then "
28716 "it is auto-detected from the image itself."
28720 #: ../tools/virt-resize.pl:528
28722 "Note that this option I<does not> affect the output format. See L</QCOW2 "
28723 "AND NON-SPARSE RAW FORMATS>."
28727 #: ../tools/virt-resize.pl:535
28728 msgid "B<--output-format> raw"
28732 #: ../tools/virt-resize.pl:537
28734 "Specify the format of the output disk image. If this flag is not given then "
28735 "it is auto-detected from the image itself."
28739 #: ../tools/virt-resize.pl:543
28741 "Note that you still need to create the output disk with the right format. "
28742 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28746 #: ../tools/virt-resize.pl:1419
28751 #: ../tools/virt-resize.pl:1421
28752 msgid "\"Partition 1 does not end on cylinder boundary.\""
28756 #: ../tools/virt-resize.pl:1423
28758 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28759 "means the partitions will not be aligned to the ancient CHS geometry. "
28760 "However CHS geometry is meaningless for disks manufactured since the early "
28761 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28762 "cylinders is not required by any modern operating system."
28766 #: ../tools/virt-resize.pl:1430
28767 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28771 #: ../tools/virt-resize.pl:1432
28773 "In Windows Vista and later versions, Microsoft switched to using a separate "
28774 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28775 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28776 "the boot partition. Doing so seems to break the guest completely. However "
28777 "expanding the second partition (ie. C: drive) should work."
28781 #: ../tools/virt-resize.pl:1439
28783 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28784 "NTFS partitions have been expanded. This is just a safety check and (unless "
28785 "it find errors) is nothing to worry about."
28789 #: ../tools/virt-resize.pl:1443
28790 msgid "GUEST BOOT STUCK AT \"GRUB\""
28794 #: ../tools/virt-resize.pl:1445
28796 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28797 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28798 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28799 "although we think is to do with partition alignment."
28803 #: ../tools/virt-resize.pl:1450
28806 " guestfish -i -a newdisk\n"
28807 " ><fs> cat /boot/grub/device.map\n"
28808 " # check the contents of this file are sensible or\n"
28809 " # edit the file if necessary\n"
28810 " ><fs> grub-install / /dev/vda\n"
28816 #: ../tools/virt-resize.pl:1457
28818 "For more flexible guest reconfiguration, including if you need to specify "
28819 "other parameters to grub-install, use L<virt-rescue(1)>."
28823 #: ../tools/virt-resize.pl:1460
28824 msgid "ALTERNATIVE TOOLS"
28828 #: ../tools/virt-resize.pl:1462
28830 "There are several proprietary tools for resizing partitions. We won't "
28831 "mention any here."
28835 #: ../tools/virt-resize.pl:1465
28837 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28838 "operations on disk images. They can resize and move partitions, but I don't "
28839 "think they can do anything with the contents, and they certainly don't "
28844 #: ../tools/virt-resize.pl:1470
28846 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28847 "but at a much lower level. You will probably end up hand-calculating sector "
28848 "offsets, which is something that virt-resize was designed to avoid. If you "
28849 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
28854 #: ../tools/virt-resize.pl:1485
28856 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
28857 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
28858 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
28859 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
28860 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28864 #: ../tools/virt-list-filesystems.pl:32
28865 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28869 #: ../tools/virt-list-filesystems.pl:36
28872 " virt-list-filesystems [--options] domname\n"
28877 #: ../tools/virt-list-filesystems.pl:38
28880 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28885 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
28887 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
28892 #: ../tools/virt-list-filesystems.pl:45
28894 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28895 "are contained in a virtual machine or disk image."
28899 #: ../tools/virt-list-filesystems.pl:49
28901 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28902 "functionality. For more complex cases you should look at the "
28903 "L<guestfish(1)> tool."
28907 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
28908 msgid "B<-l> | B<--long>"
28912 #: ../tools/virt-list-filesystems.pl:108
28914 "With this option, C<virt-list-filesystems> displays the type of each "
28915 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28919 #: ../tools/virt-list-filesystems.pl:115
28920 msgid "B<-a> | B<--all>"
28924 #: ../tools/virt-list-filesystems.pl:117
28926 "Normally we only show mountable filesystems. If this option is given then "
28927 "swap devices are shown too."
28931 #: ../tools/virt-list-filesystems.pl:191
28933 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
28934 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
28935 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28939 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
28940 msgid "Copyright (C) 2009 Red Hat Inc."
28944 #: ../tools/virt-tar.pl:33
28945 msgid "virt-tar - Extract or upload files to a virtual machine"
28949 #: ../tools/virt-tar.pl:37
28952 " virt-tar [--options] -x domname directory tarball\n"
28957 #: ../tools/virt-tar.pl:39
28960 " virt-tar [--options] -u domname tarball directory\n"
28965 #: ../tools/virt-tar.pl:41
28968 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28973 #: ../tools/virt-tar.pl:43
28976 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28981 #: ../tools/virt-tar.pl:47
28982 msgid "Download C</home> from the VM into a local tarball:"
28986 #: ../tools/virt-tar.pl:49
28989 " virt-tar -x domname /home home.tar\n"
28994 #: ../tools/virt-tar.pl:51
28997 " virt-tar -zx domname /home home.tar.gz\n"
29002 #: ../tools/virt-tar.pl:53
29003 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29007 #: ../tools/virt-tar.pl:55
29010 " virt-tar -u domname uploadstuff.tar /tmp\n"
29015 #: ../tools/virt-tar.pl:57
29018 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29023 #: ../tools/virt-tar.pl:61
29025 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
29026 "virtual machines. If you do this, you risk disk corruption in the VM. "
29027 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29031 #: ../tools/virt-tar.pl:66
29033 "You can use C<-x> (extract) on live virtual machines, but you might get "
29034 "inconsistent results or errors if there is filesystem activity inside the "
29035 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29036 "work, but the only way to guarantee consistent results is if the virtual "
29037 "machine is shut down."
29041 #: ../tools/virt-tar.pl:74
29043 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29044 "parts of a guest filesystem. There are many possibilities: making backups, "
29045 "uploading data files, snooping on guest activity, fixing or customizing "
29050 #: ../tools/virt-tar.pl:79
29052 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29053 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29054 "should look at the L<guestfish(1)> tool."
29058 #: ../tools/virt-tar.pl:83
29060 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
29061 "its contents (recursively) from the virtual machine into a local tarball. "
29062 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
29063 "virtual machine. You cannot use these two options together."
29067 #: ../tools/virt-tar.pl:89
29069 "In addition, you may need to use the C<-z> (gZip) option to enable "
29070 "compression. When uploading, you have to specify C<-z> if the upload file "
29071 "is compressed because virt-tar won't detect this on its own."
29075 #: ../tools/virt-tar.pl:93
29077 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29078 "example it cannot do PKZip files or bzip2 compression. If you want that "
29079 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29080 "the L<libguestfs(3)> API)."
29084 #: ../tools/virt-tar.pl:151
29085 msgid "B<-x> | B<--extract> | B<--download>"
29089 #: ../tools/virt-tar.pl:153
29090 msgid "B<-u> | B<--upload>"
29094 #: ../tools/virt-tar.pl:155
29096 "Use C<-x> to extract (download) a directory from a virtual machine to a "
29101 #: ../tools/virt-tar.pl:158
29103 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
29104 "Please read the L</WARNING> section above before using this option."
29108 #: ../tools/virt-tar.pl:162
29109 msgid "You must specify exactly one of these options."
29113 #: ../tools/virt-tar.pl:168
29114 msgid "B<-z> | B<--gzip>"
29118 #: ../tools/virt-tar.pl:170
29119 msgid "Specify that the input or output tarball is gzip-compressed."
29123 #: ../tools/virt-tar.pl:283
29125 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29126 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29127 "L<http://libguestfs.org/>."
29131 #: ../tools/virt-make-fs.pl:37
29132 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29136 #: ../tools/virt-make-fs.pl:41
29139 " virt-make-fs [--options] input.tar output.img\n"
29144 #: ../tools/virt-make-fs.pl:43
29147 " virt-make-fs [--options] input.tar.gz output.img\n"
29152 #: ../tools/virt-make-fs.pl:45
29155 " virt-make-fs [--options] directory output.img\n"
29160 #: ../tools/virt-make-fs.pl:49
29162 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29163 "archive or some files in a directory. It is similar to tools like "
29164 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29165 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29166 "useful if you want to attach these filesystems to existing virtual machines "
29167 "(eg. to import large amounts of read-only data to a VM)."
29171 #: ../tools/virt-make-fs.pl:57
29172 msgid "Basic usage is:"
29176 #: ../tools/virt-make-fs.pl:59
29179 " virt-make-fs input output\n"
29184 #: ../tools/virt-make-fs.pl:61
29186 "where C<input> is either a directory containing files that you want to add, "
29187 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29188 "C<output> is a disk image. The input type is detected automatically. The "
29189 "output disk image defaults to a raw ext2 image unless you specify extra "
29190 "flags (see L</OPTIONS> below)."
29194 #: ../tools/virt-make-fs.pl:67
29195 msgid "EXTRA SPACE"
29199 #: ../tools/virt-make-fs.pl:69
29201 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29202 "the files that it contains, but might have extra space. Depending on how "
29203 "you are going to use the output, you might think this extra space is wasted "
29204 "and want to minimize it, or you might want to leave space so that more files "
29205 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29206 "but you can use the C<--size> flag to leave space in the filesystem if you "
29211 #: ../tools/virt-make-fs.pl:77
29213 "An alternative way to leave extra space but not make the output image any "
29214 "bigger is to use an alternative disk image format (instead of the default "
29215 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29216 "image format (check your hypervisor supports this before using it). This "
29217 "allows you to choose a large C<--size> but the extra space won't actually be "
29218 "allocated in the image until you try to store something in it."
29222 #: ../tools/virt-make-fs.pl:85
29224 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29225 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29226 "to build another image from scratch."
29230 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29235 #: ../tools/virt-make-fs.pl:91
29238 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29243 #: ../tools/virt-make-fs.pl:93
29244 msgid "FILESYSTEM TYPE"
29248 #: ../tools/virt-make-fs.pl:95
29250 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29251 "libguestfs supports can be used (but I<not> read-only formats like "
29252 "ISO9660). Here are some of the more common choices:"
29256 #: ../tools/virt-make-fs.pl:101
29261 #: ../tools/virt-make-fs.pl:103
29263 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29264 "you are not going to use the filesystem in a way that requires the journal, "
29265 "then this is just wasted overhead."
29269 #: ../tools/virt-make-fs.pl:107
29270 msgid "I<ntfs> or I<vfat>"
29274 #: ../tools/virt-make-fs.pl:109
29275 msgid "Useful if exporting data to a Windows guest."
29279 #: ../tools/virt-make-fs.pl:111
29281 "I<Note for vfat>: The tar archive or local directory must only contain files "
29282 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29283 "program running within libguestfs is unable to change the ownership of "
29284 "non-root files, since vfat itself does not support this."
29288 #: ../tools/virt-make-fs.pl:116
29293 #: ../tools/virt-make-fs.pl:118
29295 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29296 "total filesystem size."
29300 #: ../tools/virt-make-fs.pl:125
29303 " virt-make-fs --type=minix input minixfs.img\n"
29308 #: ../tools/virt-make-fs.pl:127
29309 msgid "TO PARTITION OR NOT TO PARTITION"
29313 #: ../tools/virt-make-fs.pl:129
29314 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29318 #: ../tools/virt-make-fs.pl:131
29320 "Adding a partition can make the disk image more compatible with certain "
29321 "virtualized operating systems which don't expect to see a filesystem "
29322 "directly located on a block device (Linux doesn't care and will happily "
29323 "handle both types)."
29327 #: ../tools/virt-make-fs.pl:136
29329 "On the other hand, if you have a partition table then the output image is no "
29330 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29331 "directly on a partitioned disk image. (However libguestfs tools such as "
29332 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29336 #: ../tools/virt-make-fs.pl:144
29337 msgid "Add an MBR partition:"
29341 #: ../tools/virt-make-fs.pl:146
29344 " virt-make-fs --partition -- input disk.img\n"
29349 #: ../tools/virt-make-fs.pl:148
29351 "If the output disk image could be terabyte-sized or larger, it's better to "
29352 "use an EFI/GPT-compatible partition table:"
29356 #: ../tools/virt-make-fs.pl:151
29359 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29364 #: ../tools/virt-make-fs.pl:179
29365 msgid "Enable debugging information."
29369 #: ../tools/virt-make-fs.pl:185
29370 msgid "B<--size=E<lt>NE<gt>>"
29374 #: ../tools/virt-make-fs.pl:187
29375 msgid "B<--size=+E<lt>NE<gt>>"
29379 #: ../tools/virt-make-fs.pl:189
29380 msgid "B<-s E<lt>NE<gt>>"
29384 #: ../tools/virt-make-fs.pl:191
29385 msgid "B<-s +E<lt>NE<gt>>"
29389 #: ../tools/virt-make-fs.pl:193
29390 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29394 #: ../tools/virt-make-fs.pl:196
29396 "If this option is I<not> given, then the output image will be just large "
29397 "enough to contain all the files, with not much wasted space."
29401 #: ../tools/virt-make-fs.pl:199
29403 "To choose a fixed size output disk, specify an absolute number followed by "
29404 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29405 "Petabytes or Exabytes. This must be large enough to contain all the input "
29406 "files, else you will get an error."
29410 #: ../tools/virt-make-fs.pl:204
29412 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29413 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29414 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29415 "the input files, and (approximately) an extra 200 MB free space."
29419 #: ../tools/virt-make-fs.pl:210
29421 "Note that virt-make-fs estimates free space, and therefore will not produce "
29422 "filesystems containing precisely the free space requested. (It is much more "
29423 "expensive and time-consuming to produce a filesystem which has precisely the "
29424 "desired free space)."
29428 #: ../tools/virt-make-fs.pl:219
29429 msgid "B<--format=E<lt>fmtE<gt>>"
29433 #: ../tools/virt-make-fs.pl:221
29434 msgid "B<-F E<lt>fmtE<gt>>"
29438 #: ../tools/virt-make-fs.pl:223
29439 msgid "Choose the output disk image format."
29443 #: ../tools/virt-make-fs.pl:225
29444 msgid "The default is C<raw> (raw disk image)."
29448 #: ../tools/virt-make-fs.pl:227
29450 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29451 "that would really make sense here is C<qcow2>."
29455 #: ../tools/virt-make-fs.pl:234
29456 msgid "B<--type=E<lt>fsE<gt>>"
29460 #: ../tools/virt-make-fs.pl:236
29461 msgid "B<-t E<lt>fsE<gt>>"
29465 #: ../tools/virt-make-fs.pl:238
29466 msgid "Choose the output filesystem type."
29470 #: ../tools/virt-make-fs.pl:240
29471 msgid "The default is C<ext2>."
29475 #: ../tools/virt-make-fs.pl:242
29476 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29480 #: ../tools/virt-make-fs.pl:249
29481 msgid "B<--partition>"
29485 #: ../tools/virt-make-fs.pl:251
29486 msgid "B<--partition=E<lt>parttypeE<gt>>"
29490 #: ../tools/virt-make-fs.pl:253
29492 "If specified, this flag adds an MBR partition table to the output disk "
29497 #: ../tools/virt-make-fs.pl:256
29499 "You can change the partition table type, eg. C<--partition=gpt> for large "
29504 #: ../tools/virt-make-fs.pl:259
29506 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29507 "might consider the next parameter to be the partition type. For example:"
29511 #: ../tools/virt-make-fs.pl:263
29514 " virt-make-fs --partition input.tar ...\n"
29519 #: ../tools/virt-make-fs.pl:265
29521 "would cause virt-make-fs to think you wanted to use a partition type of "
29522 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29523 "dash) between options and the input file argument:"
29527 #: ../tools/virt-make-fs.pl:269
29530 " virt-make-fs --partition -- input.tar ...\n"
29535 #: ../tools/virt-make-fs.pl:541
29537 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
29538 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29539 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29543 #: ../tools/virt-make-fs.pl:558
29546 " export LIBGUESTFS_DEBUG=1\n"
29547 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29552 #: ../tools/virt-make-fs.pl:561
29554 "Attach /tmp/virt-make-fs.log to a new bug report at "
29555 "L<https://bugzilla.redhat.com/>"
29559 #: ../tools/virt-list-partitions.pl:32
29560 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29564 #: ../tools/virt-list-partitions.pl:36
29567 " virt-list-partitions [--options] domname\n"
29572 #: ../tools/virt-list-partitions.pl:38
29575 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29580 #: ../tools/virt-list-partitions.pl:45
29582 "C<virt-list-partitions> is a command line tool to list the partitions that "
29583 "are contained in a virtual machine or disk image. It is mainly useful as a "
29584 "first step to using L<virt-resize(1)>."
29588 #: ../tools/virt-list-partitions.pl:50
29590 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29591 "functionality. For more complex cases you should look at the "
29592 "L<guestfish(1)> tool."
29596 #: ../tools/virt-list-partitions.pl:107
29597 msgid "B<-h> | B<--human-readable>"
29601 #: ../tools/virt-list-partitions.pl:109
29602 msgid "Show sizes in human-readable form (eg. \"1G\")."
29606 #: ../tools/virt-list-partitions.pl:117
29608 "With this option, C<virt-list-partitions> displays the type and size of each "
29609 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29613 #: ../tools/virt-list-partitions.pl:124
29614 msgid "B<-t> | B<--total>"
29618 #: ../tools/virt-list-partitions.pl:126
29619 msgid "Display the total size of each block device (as a separate row or rows)."
29623 #: ../tools/virt-list-partitions.pl:259
29625 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29626 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29627 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29631 #: ../tools/virt-list-partitions.pl:275
29632 msgid "Copyright (C) 2009-2010 Red Hat Inc."