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.13\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-09-16 16:37+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
26 #: ../src/guestfs.pod:5
27 msgid "guestfs - Library for accessing and modifying virtual machine images"
31 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
36 #: ../src/guestfs.pod:9
39 " #include <guestfs.h>\n"
44 #: ../src/guestfs.pod:11
47 " guestfs_h *g = guestfs_create ();\n"
48 " guestfs_add_drive (g, \"guest.img\");\n"
49 " guestfs_launch (g);\n"
50 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
51 " guestfs_touch (g, \"/hello\");\n"
52 " guestfs_umount (g, \"/\");\n"
53 " guestfs_close (g);\n"
58 #: ../src/guestfs.pod:19
61 " cc prog.c -o prog -lguestfs\n"
63 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
68 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
73 #: ../src/guestfs.pod:25
75 "Libguestfs is a library for accessing and modifying guest disk images. "
76 "Amongst the things this is good for: making batch configuration changes to "
77 "guests, getting disk used/free statistics (see also: virt-df), migrating "
78 "between virtualization systems (see also: virt-p2v), performing partial "
79 "backups, performing partial guest clones, cloning guests and changing "
80 "registry/UUID/hostname info, and much else besides."
84 #: ../src/guestfs.pod:33
86 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
87 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
88 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
93 #: ../src/guestfs.pod:38
95 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
96 "what filesystem is in each LV, etc.). It can also run commands in the "
97 "context of the guest. Also you can access filesystems over FUSE."
101 #: ../src/guestfs.pod:43
103 "Libguestfs is a library that can be linked with C and C++ management "
104 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
105 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
110 #: ../src/guestfs.pod:48
112 "You don't need to be root to use libguestfs, although obviously you do need "
113 "enough permissions to access the disk images."
117 #: ../src/guestfs.pod:51
119 "Libguestfs is a large API because it can do many things. For a gentle "
120 "introduction, please read the L</API OVERVIEW> section next."
124 #: ../src/guestfs.pod:54
126 "There are also some example programs in the L<guestfs-examples(3)> manual "
131 #: ../src/guestfs.pod:57
136 #: ../src/guestfs.pod:59
138 "This section provides a gentler overview of the libguestfs API. We also try "
139 "to group API calls together, where that may not be obvious from reading "
140 "about the individual calls in the main section of this manual."
144 #: ../src/guestfs.pod:64
149 #: ../src/guestfs.pod:66
151 "Before you can use libguestfs calls, you have to create a handle. Then you "
152 "must add at least one disk image to the handle, followed by launching the "
153 "handle, then performing whatever operations you want, and finally closing "
154 "the handle. By convention we use the single letter C<g> for the name of the "
155 "handle variable, although of course you can use any name you want."
159 #: ../src/guestfs.pod:73
160 msgid "The general structure of all libguestfs-using programs looks like this:"
164 #: ../src/guestfs.pod:76
167 " guestfs_h *g = guestfs_create ();\n"
172 #: ../src/guestfs.pod:78
175 " /* Call guestfs_add_drive additional times if there are\n"
176 " * multiple disk images.\n"
178 " guestfs_add_drive (g, \"guest.img\");\n"
183 #: ../src/guestfs.pod:83
186 " /* Most manipulation calls won't work until you've launched\n"
187 " * the handle 'g'. You have to do this _after_ adding drives\n"
188 " * and _before_ other commands.\n"
190 " guestfs_launch (g);\n"
195 #: ../src/guestfs.pod:89
198 " /* Now you can examine what partitions, LVs etc are available.\n"
200 " char **partitions = guestfs_list_partitions (g);\n"
201 " char **logvols = guestfs_lvs (g);\n"
206 #: ../src/guestfs.pod:94
209 " /* To access a filesystem in the image, you must mount it.\n"
211 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
216 #: ../src/guestfs.pod:98
219 " /* Now you can perform filesystem actions on the guest\n"
222 " guestfs_touch (g, \"/hello\");\n"
227 #: ../src/guestfs.pod:103
230 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
231 " * it is done automatically when you close the handle. See\n"
232 " * discussion of autosync in this page.\n"
234 " guestfs_sync (g);\n"
239 #: ../src/guestfs.pod:109
242 " /* Close the handle 'g'. */\n"
243 " guestfs_close (g);\n"
248 #: ../src/guestfs.pod:112
250 "The code above doesn't include any error checking. In real code you should "
251 "check return values carefully for errors. In general all functions that "
252 "return integers return C<-1> on error, and all functions that return "
253 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
254 "how to handle errors, and consult the documentation for each function call "
255 "below to see precisely how they return error indications. See "
256 "L<guestfs-examples(3)> for fully worked examples."
260 #: ../src/guestfs.pod:121
265 #: ../src/guestfs.pod:123
267 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
268 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
269 "actual block device, or simply an empty file of zeroes that you have created "
270 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
275 #: ../src/guestfs.pod:129
277 "The call you should use in modern code for adding drives is "
278 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
279 "specifying that the format is raw, do:"
283 #: ../src/guestfs.pod:133
286 " guestfs_add_drive_opts (g, filename,\n"
287 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
293 #: ../src/guestfs.pod:137
294 msgid "You can add a disk read-only using:"
298 #: ../src/guestfs.pod:139
301 " guestfs_add_drive_opts (g, filename,\n"
302 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
303 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
309 #: ../src/guestfs.pod:144
311 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
312 "libguestfs won't modify the file."
316 #: ../src/guestfs.pod:147
318 "Be extremely cautious if the disk image is in use, eg. if it is being used "
319 "by a virtual machine. Adding it read-write will almost certainly cause disk "
320 "corruption, but adding it read-only is safe."
324 #: ../src/guestfs.pod:151
326 "You must add at least one disk image, and you may add multiple disk images. "
327 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
328 "first one you added), C</dev/sdb> (for the second one you added), etc."
332 #: ../src/guestfs.pod:156
334 "Once L</guestfs_launch> has been called you cannot add any more images. You "
335 "can call L</guestfs_list_devices> to get a list of the device names, in the "
336 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
340 #: ../src/guestfs.pod:161
345 #: ../src/guestfs.pod:163
347 "Before you can read or write files, create directories and so on in a disk "
348 "image that contains filesystems, you have to mount those filesystems using "
349 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
350 "a disk image contains (for example) one partition with a filesystem on that "
351 "partition, then you can mount it directly:"
355 #: ../src/guestfs.pod:170
358 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
363 #: ../src/guestfs.pod:172
365 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
366 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
367 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
368 "that these are libguestfs virtual devices, and are nothing to do with host "
373 #: ../src/guestfs.pod:178
375 "If you are given a disk image and you don't know what it contains then you "
376 "have to find out. Libguestfs can do that too: use "
377 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
378 "and LVs, and either try mounting each to see what is mountable, or else "
379 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
380 "filesystems, use L</guestfs_list_filesystems>."
384 #: ../src/guestfs.pod:186
386 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
387 "L</INSPECTION> below). But you might find it easier to look at higher level "
388 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
392 #: ../src/guestfs.pod:191
394 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
395 "several other variations of the C<guestfs_mount_*> call."
399 #: ../src/guestfs.pod:194
400 msgid "FILESYSTEM ACCESS AND MODIFICATION"
404 #: ../src/guestfs.pod:196
406 "The majority of the libguestfs API consists of fairly low-level calls for "
407 "accessing and modifying the files, directories, symlinks etc on mounted "
408 "filesystems. There are over a hundred such calls which you can find listed "
409 "in detail below in this man page, and we don't even pretend to cover them "
410 "all in this overview."
414 #: ../src/guestfs.pod:202
416 "Specify filenames as full paths, starting with C<\"/\"> and including the "
421 #: ../src/guestfs.pod:205
423 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
424 "the file called C<\"etc/passwd\"> then you could do:"
428 #: ../src/guestfs.pod:208
431 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
436 #: ../src/guestfs.pod:210
438 "This would return C<data> as a newly allocated buffer containing the full "
439 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
440 "or C<NULL> if there was an error."
444 #: ../src/guestfs.pod:214
446 "As another example, to create a top-level directory on that filesystem "
447 "called C<\"var\"> you would do:"
451 #: ../src/guestfs.pod:217
454 " guestfs_mkdir (g, \"/var\");\n"
459 #: ../src/guestfs.pod:219
460 msgid "To create a symlink you could do:"
464 #: ../src/guestfs.pod:221
467 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
468 " \"/etc/rc3.d/S30portmap\");\n"
473 #: ../src/guestfs.pod:224
475 "Libguestfs will reject attempts to use relative paths and there is no "
476 "concept of a current working directory."
480 #: ../src/guestfs.pod:227
482 "Libguestfs can return errors in many situations: for example if the "
483 "filesystem isn't writable, or if a file or directory that you requested "
484 "doesn't exist. If you are using the C API (documented here) you have to "
485 "check for those error conditions after each call. (Other language bindings "
486 "turn these errors into exceptions)."
490 #: ../src/guestfs.pod:233
492 "File writes are affected by the per-handle umask, set by calling "
493 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
497 #: ../src/guestfs.pod:236
502 #: ../src/guestfs.pod:238
504 "Libguestfs contains API calls to read, create and modify partition tables on "
509 #: ../src/guestfs.pod:241
511 "In the common case where you want to create a single partition covering the "
512 "whole disk, you should use the L</guestfs_part_disk> call:"
516 #: ../src/guestfs.pod:245
519 " const char *parttype = \"mbr\";\n"
520 " if (disk_is_larger_than_2TB)\n"
521 " parttype = \"gpt\";\n"
522 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
527 #: ../src/guestfs.pod:250
529 "Obviously this effectively wipes anything that was on that disk image "
534 #: ../src/guestfs.pod:253
539 #: ../src/guestfs.pod:255
541 "Libguestfs provides access to a large part of the LVM2 API, such as "
542 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
543 "unless you familiarize yourself with the concepts of physical volumes, "
544 "volume groups and logical volumes."
548 #: ../src/guestfs.pod:260
550 "This author strongly recommends reading the LVM HOWTO, online at "
551 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
555 #: ../src/guestfs.pod:263
560 #: ../src/guestfs.pod:265
562 "Use L</guestfs_cat> to download small, text only files. This call is "
563 "limited to files which are less than 2 MB and which cannot contain any ASCII "
564 "NUL (C<\\0>) characters. However the API is very simple to use."
568 #: ../src/guestfs.pod:269
570 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
571 "bit data, since it returns a (pointer, size) pair. However it is still "
572 "limited to \"small\" files, less than 2 MB."
576 #: ../src/guestfs.pod:273
578 "L</guestfs_download> can be used to download any file, with no limits on "
579 "content or size (even files larger than 4 GB)."
583 #: ../src/guestfs.pod:276
584 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
588 #: ../src/guestfs.pod:279
593 #: ../src/guestfs.pod:281
595 "It's often the case that you want to write a file or files to the disk "
600 #: ../src/guestfs.pod:284
602 "To write a small file with fixed content, use L</guestfs_write>. To create "
603 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
604 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
605 "variety of other functions for creating test files, for example "
606 "L</guestfs_fill> and L</guestfs_fill_pattern>."
610 #: ../src/guestfs.pod:290
612 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
613 "file content or size (even files larger than 4 GB)."
617 #: ../src/guestfs.pod:293
618 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
622 #: ../src/guestfs.pod:295
624 "However the fastest way to upload I<large numbers of arbitrary files> is to "
625 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
626 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
627 "the drive in a predictable way (eg. adding it last after all other drives) "
628 "then you can get the device name from L</guestfs_list_devices> and mount it "
629 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
630 "sometimes non-portable between kernel versions, and they don't support "
631 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
632 "using a label or UUID, use an ISO image instead."
636 #: ../src/guestfs.pod:306
641 #: ../src/guestfs.pod:308
643 "There are various different commands for copying between files and devices "
644 "and in and out of the guest filesystem. These are summarised in the table "
649 #: ../src/guestfs.pod:314
650 msgid "B<file> to B<file>"
654 #: ../src/guestfs.pod:316
656 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
657 "directories recursively."
661 #: ../src/guestfs.pod:319
662 msgid "B<file or device> to B<file or device>"
666 #: ../src/guestfs.pod:321
668 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
669 "devices in the guest."
673 #: ../src/guestfs.pod:324
674 msgid "Example: duplicate the contents of an LV:"
678 #: ../src/guestfs.pod:326
681 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
686 #: ../src/guestfs.pod:328
688 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
689 "(C</dev/VG/Original>). To copy less than the whole source device, use "
690 "L</guestfs_copy_size>."
694 #: ../src/guestfs.pod:332
695 msgid "B<file on the host> to B<file or device>"
699 #: ../src/guestfs.pod:334
700 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
704 #: ../src/guestfs.pod:336
705 msgid "B<file or device> to B<file on the host>"
709 #: ../src/guestfs.pod:338
710 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
714 #: ../src/guestfs.pod:342
715 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
719 #: ../src/guestfs.pod:344
721 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
722 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
723 "appears you can only upload and download to files. However many Un*x-like "
724 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
725 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
726 "stderr, and arbitrary file descriptor N."
730 #: ../src/guestfs.pod:352
731 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
735 #: ../src/guestfs.pod:355
738 " guestfs_download (g, filename, \"/dev/stdout\");\n"
743 #: ../src/guestfs.pod:357
744 msgid "and you can write tar output to a pipe C<fd> by doing:"
748 #: ../src/guestfs.pod:359
752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
753 " guestfs_tar_out (g, \"/\", devfd);\n"
758 #: ../src/guestfs.pod:363
759 msgid "LISTING FILES"
763 #: ../src/guestfs.pod:365
765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
766 "L<guestfish(1)>-equivalent command C<ll>)."
770 #: ../src/guestfs.pod:368
772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
773 "programs, as a flat list of strings."
777 #: ../src/guestfs.pod:371
779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
780 "directory, plus additional information about each one. It is more "
781 "equivalent to using the L<readdir(3)> call on a local filesystem."
785 #: ../src/guestfs.pod:375
787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
792 #: ../src/guestfs.pod:378
793 msgid "RUNNING COMMANDS"
797 #: ../src/guestfs.pod:380
799 "Although libguestfs is primarily an API for manipulating files inside guest "
800 "images, we also provide some limited facilities for running commands inside "
805 #: ../src/guestfs.pod:384
806 msgid "There are many limitations to this:"
810 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1011 ../src/guestfs.pod:1015 ../src/guestfs.pod:1019 ../src/guestfs.pod:1024 ../src/guestfs.pod:1032 ../src/guestfs.pod:1051 ../src/guestfs.pod:1059 ../src/guestfs.pod:1081 ../src/guestfs.pod:1085 ../src/guestfs.pod:1089 ../src/guestfs.pod:1093 ../src/guestfs.pod:1097 ../src/guestfs.pod:1101 ../src/guestfs.pod:1583 ../src/guestfs.pod:1588 ../src/guestfs.pod:1592 ../src/guestfs.pod:1702 ../src/guestfs.pod:1707 ../src/guestfs.pod:1711 ../src/guestfs.pod:2064 ../src/guestfs.pod:2070 ../src/guestfs.pod:2075 ../src/guestfs.pod:2081 ../src/guestfs.pod:2540 ../src/guestfs.pod:2544 ../src/guestfs.pod:2548 ../src/guestfs.pod:2552 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:574 ../src/guestfs-actions.pod:582 ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 ../src/guestfs-actions.pod:1857 ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:2252 ../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:378 ../fish/guestfish-actions.pod:386 ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1506 ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:1520 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1204 ../src/guestfs.pod:1335 ../src/guestfs.pod:2109
941 #: ../src/guestfs.pod:471
942 msgid "Before launching, do:"
946 #: ../src/guestfs.pod:473
949 " guestfs_set_selinux (g, 1);\n"
954 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1208 ../src/guestfs.pod:1339 ../src/guestfs.pod:2134
959 #: ../src/guestfs.pod:477
961 "After mounting the guest's filesystem(s), load the policy. This is best "
962 "done by running the L<load_policy(8)> command in the guest itself:"
966 #: ../src/guestfs.pod:481
969 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
974 #: ../src/guestfs.pod:483
976 "(Older versions of C<load_policy> require you to specify the name of the "
981 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1345
986 #: ../src/guestfs.pod:488
988 "Optionally, set the security context for the API. The correct security "
989 "context to use can only be known by inspecting the guest. As an example:"
993 #: ../src/guestfs.pod:492
996 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1001 #: ../src/guestfs.pod:496
1002 msgid "This will work for running commands and editing existing files."
1006 #: ../src/guestfs.pod:498
1008 "When new files are created, you may need to label them explicitly, for "
1009 "example by running the external command C<restorecon pathname>."
1013 #: ../src/guestfs.pod:502
1018 #: ../src/guestfs.pod:504
1020 "Certain calls are affected by the current file mode creation mask (the "
1021 "\"umask\"). In particular ones which create files or directories, such as "
1022 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1023 "either the default mode that the file is created with or modifies the mode "
1028 #: ../src/guestfs.pod:510
1030 "The default umask is C<022>, so files are created with modes such as C<0644> "
1031 "and directories with C<0755>."
1035 #: ../src/guestfs.pod:513
1037 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1038 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
1039 "L</guestfs_chmod> after creating each file or directory."
1043 #: ../src/guestfs.pod:517
1044 msgid "For more information about umask, see L<umask(2)>."
1048 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:720
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems. (These APIs used to be in a separate Perl-only "
1112 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1113 "frequently used part of this library has been rewritten in C and moved into "
1118 #: ../src/guestfs.pod:558
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:561
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:570
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:576
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:583
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:587
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:590
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:594
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:598
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:602
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:611
1213 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1217 #: ../src/guestfs.pod:613
1219 "Libguestfs can mount NTFS partitions. It does this using the "
1220 "L<http://www.ntfs-3g.org/> driver."
1224 #: ../src/guestfs.pod:616
1225 msgid "DRIVE LETTERS AND PATHS"
1229 #: ../src/guestfs.pod:618
1231 "DOS and Windows still use drive letters, and the filesystems are always "
1232 "treated as case insensitive by Windows itself, and therefore you might find "
1233 "a Windows configuration file referring to a path like "
1234 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1235 "that directory might be referred to as C</WINDOWS/System32>."
1239 #: ../src/guestfs.pod:624
1241 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1242 "libguestfs to read the appropriate Windows Registry and configuration files, "
1243 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1244 "L<virt-inspector(1)>)."
1248 #: ../src/guestfs.pod:629
1250 "Replacing backslash characters with forward slash characters is also outside "
1251 "the scope of libguestfs, but something that you can easily do."
1255 #: ../src/guestfs.pod:632
1257 "Where we can help is in resolving the case insensitivity of paths. For "
1258 "this, call L</guestfs_case_sensitive_path>."
1262 #: ../src/guestfs.pod:635
1263 msgid "ACCESSING THE WINDOWS REGISTRY"
1267 #: ../src/guestfs.pod:637
1269 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1270 "files, through the library C<hivex> which is part of the libguestfs project "
1271 "although ships as a separate tarball. You have to locate and download the "
1272 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1273 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1274 "L<virt-win-reg(1)> for more help on this issue."
1278 #: ../src/guestfs.pod:645
1279 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1283 #: ../src/guestfs.pod:647
1285 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1286 "provide something which looks like a Linux symlink. The way it tries to do "
1287 "the rewriting is described here:"
1291 #: ../src/guestfs.pod:651
1292 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1296 #: ../src/guestfs.pod:653
1298 "The essential problem is that ntfs-3g simply does not have enough "
1299 "information to do a correct job. NTFS links can contain drive letters and "
1300 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1301 "It is almost certainly the case that libguestfs callers should ignore what "
1302 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1306 #: ../src/guestfs.pod:660
1308 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1309 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1310 "attribute, and read the raw reparse data from that (you can find the format "
1311 "documented in various places around the web)."
1315 #: ../src/guestfs.pod:665
1316 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1320 #: ../src/guestfs.pod:667
1322 "There are other useful extended attributes that can be read from ntfs-3g "
1323 "filesystems (using L</guestfs_getxattr>). See:"
1327 #: ../src/guestfs.pod:670
1328 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1332 #: ../src/guestfs.pod:672
1333 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1337 #: ../src/guestfs.pod:674
1339 "Although we don't want to discourage you from using the C API, we will "
1340 "mention here that the same API is also available in other languages."
1344 #: ../src/guestfs.pod:677
1346 "The API is broadly identical in all supported languages. This means that "
1347 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1348 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1349 "OCaml. In other words, a straightforward, predictable isomorphism between "
1354 #: ../src/guestfs.pod:683
1356 "Error messages are automatically transformed into exceptions if the language "
1361 #: ../src/guestfs.pod:686
1363 "We don't try to \"object orientify\" parts of the API in OO languages, "
1364 "although contributors are welcome to write higher level APIs above what we "
1365 "provide in their favourite languages if they wish."
1369 #: ../src/guestfs.pod:692
1374 #: ../src/guestfs.pod:694
1376 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1377 "identical to the C API. C++ classes and exceptions are not used."
1381 #: ../src/guestfs.pod:698
1386 #: ../src/guestfs.pod:700
1388 "The C# bindings are highly experimental. Please read the warnings at the "
1389 "top of C<csharp/Libguestfs.cs>."
1393 #: ../src/guestfs.pod:703
1398 #: ../src/guestfs.pod:705
1400 "This is the only language binding that is working but incomplete. Only "
1401 "calls which return simple integers have been bound in Haskell, and we are "
1402 "looking for help to complete this binding."
1406 #: ../src/guestfs.pod:709
1411 #: ../src/guestfs.pod:711
1413 "Full documentation is contained in the Javadoc which is distributed with "
1418 #: ../src/guestfs.pod:714
1423 #: ../src/guestfs.pod:716
1424 msgid "See L<guestfs-ocaml(3)>."
1428 #: ../src/guestfs.pod:718
1433 #: ../src/guestfs.pod:720
1434 msgid "See L<Sys::Guestfs(3)>."
1438 #: ../src/guestfs.pod:722
1443 #: ../src/guestfs.pod:724
1445 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1446 "the php-libguestfs package for your distribution."
1450 #: ../src/guestfs.pod:727
1451 msgid "The PHP binding only works correctly on 64 bit machines."
1455 #: ../src/guestfs.pod:729
1460 #: ../src/guestfs.pod:731
1461 msgid "See L<guestfs-python(3)>."
1465 #: ../src/guestfs.pod:733
1470 #: ../src/guestfs.pod:735
1471 msgid "See L<guestfs-ruby(3)>."
1475 #: ../src/guestfs.pod:737
1476 msgid "B<shell scripts>"
1480 #: ../src/guestfs.pod:739
1481 msgid "See L<guestfish(1)>."
1485 #: ../src/guestfs.pod:743
1486 msgid "LIBGUESTFS GOTCHAS"
1490 #: ../src/guestfs.pod:745
1492 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1493 "system [...] that works in the way it is documented but is counterintuitive "
1494 "and almost invites mistakes.\""
1498 #: ../src/guestfs.pod:749
1500 "Since we developed libguestfs and the associated tools, there are several "
1501 "things we would have designed differently, but are now stuck with for "
1502 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1503 "release, you can expect these to change. Beware of them."
1507 #: ../src/guestfs.pod:757
1508 msgid "Autosync / forgetting to sync."
1512 #: ../src/guestfs.pod:759
1514 "When modifying a filesystem from C or another language, you B<must> unmount "
1515 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1516 "libguestfs handle. You can also call:"
1520 #: ../src/guestfs.pod:763
1523 " guestfs_set_autosync (g, 1);\n"
1528 #: ../src/guestfs.pod:765
1530 "to have the unmount/sync done automatically for you when the handle 'g' is "
1531 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1536 #: ../src/guestfs.pod:769
1538 "If you forget to do this, then it is entirely possible that your changes "
1539 "won't be written out, or will be partially written, or (very rarely) that "
1540 "you'll get disk corruption."
1544 #: ../src/guestfs.pod:773
1546 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1547 "guestfish scripts that forget to sync will work just fine, which can make "
1548 "this very puzzling if you are trying to debug a problem."
1552 #: ../src/guestfs.pod:777
1554 "Update: Autosync is enabled by default for all API users starting from "
1555 "libguestfs 1.5.24."
1559 #: ../src/guestfs.pod:780
1560 msgid "Mount option C<-o sync> should not be the default."
1564 #: ../src/guestfs.pod:782
1566 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1567 "However C<-o sync> does not add any reliability benefit, but does have a "
1568 "very large performance impact."
1572 #: ../src/guestfs.pod:786
1574 "The work around is to use L</guestfs_mount_options> and set the mount "
1575 "options that you actually want to use."
1579 #: ../src/guestfs.pod:789
1580 msgid "Read-only should be the default."
1584 #: ../src/guestfs.pod:791
1586 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1587 "specify I<--rw> if you want to make changes to the image."
1591 #: ../src/guestfs.pod:794
1592 msgid "This would reduce the potential to corrupt live VM images."
1596 #: ../src/guestfs.pod:796
1598 "Note that many filesystems change the disk when you just mount and unmount, "
1599 "even if you didn't perform any writes. You need to use "
1600 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1604 #: ../src/guestfs.pod:800
1605 msgid "guestfish command line is hard to use."
1609 #: ../src/guestfs.pod:802
1611 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1612 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1613 "exist, so it fails. In earlier versions of guestfish the error message was "
1614 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1615 "we should have used C<guestfish -c command> to run commands."
1619 #: ../src/guestfs.pod:809
1620 msgid "guestfish megabyte modifiers don't work right on all commands"
1624 #: ../src/guestfs.pod:811
1626 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1627 "other modifiers). What guestfish actually does is to multiply the number "
1628 "part by the modifier part and pass the result to the C API. However this "
1629 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1630 "expecting some other unit (eg. megabytes)."
1634 #: ../src/guestfs.pod:818
1635 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1639 #: ../src/guestfs.pod:820
1642 " lvcreate LV VG 100M\n"
1647 #: ../src/guestfs.pod:822
1649 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1650 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1651 "megabytes * megabytes) logical volume. The error message you get from this "
1652 "is also a little obscure."
1656 #: ../src/guestfs.pod:827
1658 "This could be fixed in the generator by specially marking parameters and "
1659 "return values which take bytes or other units."
1663 #: ../src/guestfs.pod:830
1664 msgid "Ambiguity between devices and paths"
1668 #: ../src/guestfs.pod:832
1670 "There is a subtle ambiguity in the API between a device name "
1671 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1672 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1676 #: ../src/guestfs.pod:837
1678 "In the current API we usually resolve this ambiguity by having two separate "
1679 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1680 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1681 "detecting if the path supplied begins with C</dev/>."
1685 #: ../src/guestfs.pod:843
1687 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1688 "make paths/devices into structured names. One way to do this would be to "
1689 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1690 "aspect of grub. Another way would be to use a structured type, equivalent "
1691 "to this OCaml type:"
1695 #: ../src/guestfs.pod:849
1698 " type path = Path of string | Device of int | Partition of int * int\n"
1703 #: ../src/guestfs.pod:851
1704 msgid "which would allow you to pass arguments like:"
1708 #: ../src/guestfs.pod:853
1711 " Path \"/foo/bar\"\n"
1712 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1713 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1714 " Path \"/dev/sdb2\" (* not a device *)\n"
1719 #: ../src/guestfs.pod:858
1721 "As you can see there are still problems to resolve even with this "
1722 "representation. Also consider how it might work in guestfish."
1726 #: ../src/guestfs.pod:863
1727 msgid "PROTOCOL LIMITS"
1731 #: ../src/guestfs.pod:865
1733 "Internally libguestfs uses a message-based protocol to pass API calls and "
1734 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1735 "plenty more detail about this). The maximum message size used by the "
1736 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1737 "aware of this limit. The API calls which may be affected are individually "
1738 "documented, with a link back to this section of the documentation."
1742 #: ../src/guestfs.pod:873
1744 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1745 "a simple string. Because this string is at some point internally encoded as "
1746 "a message, the maximum size that it can return is slightly under 4 MB. If "
1747 "the requested file is larger than this then you will get an error."
1751 #: ../src/guestfs.pod:879
1753 "In order to transfer large files into and out of the guest filesystem, you "
1754 "need to use particular calls that support this. The sections L</UPLOADING> "
1755 "and L</DOWNLOADING> document how to do this."
1759 #: ../src/guestfs.pod:883
1761 "You might also consider mounting the disk image using our FUSE filesystem "
1762 "support (L<guestmount(1)>)."
1766 #: ../src/guestfs.pod:886
1767 msgid "KEYS AND PASSPHRASES"
1771 #: ../src/guestfs.pod:888
1773 "Certain libguestfs calls take a parameter that contains sensitive key "
1774 "material, passed in as a C string."
1778 #: ../src/guestfs.pod:891
1780 "In the future we would hope to change the libguestfs implementation so that "
1781 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1782 "swap. However this is I<not> done at the moment, because of the complexity "
1783 "of such an implementation."
1787 #: ../src/guestfs.pod:896
1789 "Therefore you should be aware that any key parameter you pass to libguestfs "
1790 "might end up being written out to the swap partition. If this is a concern, "
1791 "scrub the swap partition or don't use libguestfs on encrypted devices."
1795 #: ../src/guestfs.pod:901
1796 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1800 #: ../src/guestfs.pod:903
1802 "All high-level libguestfs actions are synchronous. If you want to use "
1803 "libguestfs asynchronously then you must create a thread."
1807 #: ../src/guestfs.pod:906
1809 "Only use the handle from a single thread. Either use the handle exclusively "
1810 "from one thread, or provide your own mutex so that two threads cannot issue "
1811 "calls on the same handle at the same time."
1815 #: ../src/guestfs.pod:910
1817 "See the graphical program guestfs-browser for one possible architecture for "
1818 "multithreaded programs using libvirt and libguestfs."
1822 #: ../src/guestfs.pod:913
1827 #: ../src/guestfs.pod:915
1829 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1834 #: ../src/guestfs.pod:918
1836 "By default it looks for these in the directory C<$libdir/guestfs> "
1837 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1841 #: ../src/guestfs.pod:921
1843 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1844 "to change the directories that libguestfs will search in. The value is a "
1845 "colon-separated list of paths. The current directory is I<not> searched "
1846 "unless the path contains an empty element or C<.>. For example "
1847 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1848 "then C</usr/lib/guestfs>."
1852 #: ../src/guestfs.pod:928
1853 msgid "QEMU WRAPPERS"
1857 #: ../src/guestfs.pod:930
1859 "If you want to compile your own qemu, run qemu from a non-standard location, "
1860 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1865 #: ../src/guestfs.pod:934
1867 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1868 "last command in the shell script (so that qemu replaces the shell and "
1869 "becomes the direct child of the libguestfs-using program). If you don't do "
1870 "this, then the qemu process won't be cleaned up correctly."
1874 #: ../src/guestfs.pod:939
1876 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1881 #: ../src/guestfs.pod:942
1885 " qemudir=/home/rjones/d/qemu\n"
1886 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1892 #: ../src/guestfs.pod:946
1894 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1895 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1900 #: ../src/guestfs.pod:950
1903 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1908 #: ../src/guestfs.pod:952
1910 "Note that libguestfs also calls qemu with the -help and -version options in "
1911 "order to determine features."
1915 #: ../src/guestfs.pod:955
1916 msgid "ABI GUARANTEE"
1920 #: ../src/guestfs.pod:957
1922 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1923 "actions as outlined in this section. Although we will deprecate some "
1924 "actions, for example if they get replaced by newer calls, we will keep the "
1925 "old actions forever. This allows you the developer to program in confidence "
1926 "against the libguestfs API."
1930 #: ../src/guestfs.pod:963
1931 msgid "BLOCK DEVICE NAMING"
1935 #: ../src/guestfs.pod:965
1937 "In the kernel there is now quite a profusion of schemata for naming block "
1938 "devices (in this context, by I<block device> I mean a physical or virtual "
1939 "hard drive). The original Linux IDE driver used names starting with "
1940 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1941 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1942 "replacement for the old IDE driver (particularly for SATA devices) those "
1943 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1944 "machines with paravirtualized drivers. This has created several different "
1945 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1950 #: ../src/guestfs.pod:977
1952 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1953 "Linux kernel to access block devices. We can run a variety of appliances "
1954 "based on a variety of Linux kernels."
1958 #: ../src/guestfs.pod:981
1960 "This causes a problem for libguestfs because many API calls use device or "
1961 "partition names. Working scripts and the recipe (example) scripts that we "
1962 "make available over the internet could fail if the naming scheme changes."
1966 #: ../src/guestfs.pod:986
1968 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1969 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1970 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1971 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1975 #: ../src/guestfs.pod:992
1977 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1978 "L</guestfs_list_partitions> and similar calls return the true names of the "
1979 "devices and partitions as known to the appliance."
1983 #: ../src/guestfs.pod:997
1984 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1988 #: ../src/guestfs.pod:999
1990 "Usually this translation is transparent. However in some (very rare) cases "
1991 "you may need to know the exact algorithm. Such cases include where you use "
1992 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
1993 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
1998 #: ../src/guestfs.pod:1005
2000 "The algorithm is applied only to I<parameters> which are known to be either "
2001 "device or partition names. Return values from functions such as "
2002 "L</guestfs_list_devices> are never changed."
2006 #: ../src/guestfs.pod:1013
2007 msgid "Is the string a parameter which is a device or partition name?"
2011 #: ../src/guestfs.pod:1017
2012 msgid "Does the string begin with C</dev/sd>?"
2016 #: ../src/guestfs.pod:1021
2018 "Does the named device exist? If so, we use that device. However if I<not> "
2019 "then we continue with this algorithm."
2023 #: ../src/guestfs.pod:1026
2024 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2028 #: ../src/guestfs.pod:1028
2029 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2033 #: ../src/guestfs.pod:1030
2034 msgid "If that named device exists, use it. If not, continue."
2038 #: ../src/guestfs.pod:1034
2039 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2043 #: ../src/guestfs.pod:1036
2044 msgid "If that named device exists, use it. If not, return an error."
2048 #: ../src/guestfs.pod:1040
2049 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2053 #: ../src/guestfs.pod:1042
2055 "Although the standard naming scheme and automatic translation is useful for "
2056 "simple programs and guestfish scripts, for larger programs it is best not to "
2057 "rely on this mechanism."
2061 #: ../src/guestfs.pod:1046
2063 "Where possible for maximum future portability programs using libguestfs "
2064 "should use these future-proof techniques:"
2068 #: ../src/guestfs.pod:1053
2070 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2071 "device names, and then use those names directly."
2075 #: ../src/guestfs.pod:1056
2076 msgid "Since those device names exist by definition, they will never be translated."
2080 #: ../src/guestfs.pod:1061
2082 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2083 "filesystem labels."
2087 #: ../src/guestfs.pod:1066
2092 #: ../src/guestfs.pod:1068
2094 "This section discusses security implications of using libguestfs, "
2095 "particularly with untrusted or malicious guests or disk images."
2099 #: ../src/guestfs.pod:1071
2100 msgid "GENERAL SECURITY CONSIDERATIONS"
2104 #: ../src/guestfs.pod:1073
2106 "Be careful with any files or data that you download from a guest (by "
2107 "\"download\" we mean not just the L</guestfs_download> command but any "
2108 "command that reads files, filenames, directories or anything else from a "
2109 "disk image). An attacker could manipulate the data to fool your program "
2110 "into doing the wrong thing. Consider cases such as:"
2114 #: ../src/guestfs.pod:1083
2115 msgid "the data (file etc) not being present"
2119 #: ../src/guestfs.pod:1087
2120 msgid "being present but empty"
2124 #: ../src/guestfs.pod:1091
2125 msgid "being much larger than normal"
2129 #: ../src/guestfs.pod:1095
2130 msgid "containing arbitrary 8 bit data"
2134 #: ../src/guestfs.pod:1099
2135 msgid "being in an unexpected character encoding"
2139 #: ../src/guestfs.pod:1103
2140 msgid "containing homoglyphs."
2144 #: ../src/guestfs.pod:1107
2145 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2149 #: ../src/guestfs.pod:1109
2151 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2152 "(VFS) module can sometimes be escalated into exploits by deliberately "
2153 "creating a malicious, malformed filesystem. These exploits are very severe "
2154 "for two reasons. Firstly there are very many filesystem drivers in the "
2155 "kernel, and many of them are infrequently used and not much developer "
2156 "attention has been paid to the code. Linux userspace helps potential "
2157 "crackers by detecting the filesystem type and automatically choosing the "
2158 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2159 "the administrator. Secondly, a kernel-level exploit is like a local root "
2160 "exploit (worse in some ways), giving immediate and total access to the "
2161 "system right down to the hardware level."
2165 #: ../src/guestfs.pod:1122
2167 "That explains why you should never mount a filesystem from an untrusted "
2168 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2169 "inside a qemu virtual machine, usually running as a non-root user. The "
2170 "attacker would need to write a filesystem which first exploited the kernel, "
2171 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2172 "the libguestfs protocol, and finally to be as serious as the host kernel "
2173 "exploit it would need to escalate its privileges to root. This multi-step "
2174 "escalation, performed by a static piece of data, is thought to be extremely "
2175 "hard to do, although we never say 'never' about security issues."
2179 #: ../src/guestfs.pod:1133
2181 "In any case callers can reduce the attack surface by forcing the filesystem "
2182 "type when mounting (use L</guestfs_mount_vfs>)."
2186 #: ../src/guestfs.pod:1136
2187 msgid "PROTOCOL SECURITY"
2191 #: ../src/guestfs.pod:1138
2193 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2194 "defined upper message size. However a program that uses libguestfs must "
2195 "also take care - for example you can write a program that downloads a binary "
2196 "from a disk image and executes it locally, and no amount of protocol "
2197 "security will save you from the consequences."
2201 #: ../src/guestfs.pod:1144
2202 msgid "INSPECTION SECURITY"
2206 #: ../src/guestfs.pod:1146
2208 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2209 "directly from the guest, and these could contain any 8 bit data. Callers "
2210 "should be careful to escape these before printing them to a structured file "
2211 "(for example, use HTML escaping if creating a web page)."
2215 #: ../src/guestfs.pod:1152
2217 "Guest configuration may be altered in unusual ways by the administrator of "
2218 "the virtual machine, and may not reflect reality (particularly for untrusted "
2219 "or actively malicious guests). For example we parse the hostname from "
2220 "configuration files like C</etc/sysconfig/network> that we find in the "
2221 "guest, but the guest administrator can easily manipulate these files to "
2222 "provide the wrong hostname."
2226 #: ../src/guestfs.pod:1160
2228 "The inspection API parses guest configuration using two external libraries: "
2229 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2230 "designed to be robust in the face of malicious data, although denial of "
2231 "service attacks are still possible, for example with oversized configuration "
2236 #: ../src/guestfs.pod:1166
2237 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2241 #: ../src/guestfs.pod:1168
2243 "Be very cautious about running commands from the guest. By running a "
2244 "command in the guest, you are giving CPU time to a binary that you do not "
2245 "control, under the same user account as the library, albeit wrapped in qemu "
2246 "virtualization. More information and alternatives can be found in the "
2247 "section L</RUNNING COMMANDS>."
2251 #: ../src/guestfs.pod:1174
2252 msgid "CVE-2010-3851"
2256 #: ../src/guestfs.pod:1176
2257 msgid "https://bugzilla.redhat.com/642934"
2261 #: ../src/guestfs.pod:1178
2263 "This security bug concerns the automatic disk format detection that qemu "
2264 "does on disk images."
2268 #: ../src/guestfs.pod:1181
2270 "A raw disk image is just the raw bytes, there is no header. Other disk "
2271 "images like qcow2 contain a special header. Qemu deals with this by looking "
2272 "for one of the known headers, and if none is found then assuming the disk "
2273 "image must be raw."
2277 #: ../src/guestfs.pod:1186
2279 "This allows a guest which has been given a raw disk image to write some "
2280 "other header. At next boot (or when the disk image is accessed by "
2281 "libguestfs) qemu would do autodetection and think the disk image format was, "
2282 "say, qcow2 based on the header written by the guest."
2286 #: ../src/guestfs.pod:1191
2288 "This in itself would not be a problem, but qcow2 offers many features, one "
2289 "of which is to allow a disk image to refer to another image (called the "
2290 "\"backing disk\"). It does this by placing the path to the backing disk "
2291 "into the qcow2 header. This path is not validated and could point to any "
2292 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2293 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2294 "control of the attacker."
2298 #: ../src/guestfs.pod:1199
2299 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2303 #: ../src/guestfs.pod:1206
2304 msgid "You have enabled the network or have opened the disk in write mode."
2308 #: ../src/guestfs.pod:1210
2310 "You are also running untrusted code from the guest (see L</RUNNING "
2315 #: ../src/guestfs.pod:1215
2317 "The way to avoid this is to specify the expected disk format when adding "
2318 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2319 "should always do this if the disk is raw format, and it's a good idea for "
2324 #: ../src/guestfs.pod:1220
2326 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2327 "format is fetched from libvirt and passed through."
2331 #: ../src/guestfs.pod:1223
2333 "For libguestfs tools, use the I<--format> command line parameter as "
2338 #: ../src/guestfs.pod:1226
2339 msgid "CONNECTION MANAGEMENT"
2343 #: ../src/guestfs.pod:1228
2348 #: ../src/guestfs.pod:1230
2350 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2351 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2352 "handle and release all resources used."
2356 #: ../src/guestfs.pod:1234
2358 "For information on using multiple handles and threads, see the section "
2359 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2363 #: ../src/guestfs.pod:1237
2364 msgid "guestfs_create"
2368 #: ../src/guestfs.pod:1239
2371 " guestfs_h *guestfs_create (void);\n"
2376 #: ../src/guestfs.pod:1241
2377 msgid "Create a connection handle."
2381 #: ../src/guestfs.pod:1243
2383 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2384 "on the handle at least once."
2388 #: ../src/guestfs.pod:1246
2390 "This function returns a non-NULL pointer to a handle on success or NULL on "
2395 #: ../src/guestfs.pod:1249
2396 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2400 #: ../src/guestfs.pod:1251
2402 "You may also want to configure error handling for the handle. See L</ERROR "
2403 "HANDLING> section below."
2407 #: ../src/guestfs.pod:1254
2408 msgid "guestfs_close"
2412 #: ../src/guestfs.pod:1256
2415 " void guestfs_close (guestfs_h *g);\n"
2420 #: ../src/guestfs.pod:1258
2421 msgid "This closes the connection handle and frees up all resources used."
2425 #: ../src/guestfs.pod:1260
2426 msgid "ERROR HANDLING"
2430 #: ../src/guestfs.pod:1262
2432 "API functions can return errors. For example, almost all functions that "
2433 "return C<int> will return C<-1> to indicate an error."
2437 #: ../src/guestfs.pod:1265
2439 "Additional information is available for errors: an error message string and "
2440 "optionally an error number (errno) if the thing that failed was a system "
2445 #: ../src/guestfs.pod:1269
2447 "You can get at the additional information about the last error on the handle "
2448 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2449 "up an error handler with L</guestfs_set_error_handler>."
2453 #: ../src/guestfs.pod:1274
2455 "When the handle is created, a default error handler is installed which "
2456 "prints the error message string to C<stderr>. For small short-running "
2457 "command line programs it is sufficient to do:"
2461 #: ../src/guestfs.pod:1278
2464 " if (guestfs_launch (g) == -1)\n"
2465 " exit (EXIT_FAILURE);\n"
2470 #: ../src/guestfs.pod:1281
2472 "since the default error handler will ensure that an error message has been "
2473 "printed to C<stderr> before the program exits."
2477 #: ../src/guestfs.pod:1284
2479 "For other programs the caller will almost certainly want to install an "
2480 "alternate error handler or do error handling in-line like this:"
2484 #: ../src/guestfs.pod:1287
2487 " g = guestfs_create ();\n"
2492 #: ../src/guestfs.pod:1289
2495 " /* This disables the default behaviour of printing errors\n"
2497 " guestfs_set_error_handler (g, NULL, NULL);\n"
2502 #: ../src/guestfs.pod:1293
2505 " if (guestfs_launch (g) == -1) {\n"
2506 " /* Examine the error message and print it etc. */\n"
2507 " char *msg = guestfs_last_error (g);\n"
2508 " int errnum = guestfs_last_errno (g);\n"
2509 " fprintf (stderr, \"%s\\n\", msg);\n"
2516 #: ../src/guestfs.pod:1301
2518 "Out of memory errors are handled differently. The default action is to call "
2519 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2520 "L</guestfs_set_out_of_memory_handler>."
2524 #: ../src/guestfs.pod:1305
2526 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2527 "because there is no handle if this happens there is no way to get additional "
2528 "error information. However L</guestfs_create> is supposed to be a "
2529 "lightweight operation which can only fail because of insufficient memory (it "
2530 "returns NULL in this case)."
2534 #: ../src/guestfs.pod:1311
2535 msgid "guestfs_last_error"
2539 #: ../src/guestfs.pod:1313
2542 " const char *guestfs_last_error (guestfs_h *g);\n"
2547 #: ../src/guestfs.pod:1315
2549 "This returns the last error message that happened on C<g>. If there has not "
2550 "been an error since the handle was created, then this returns C<NULL>."
2554 #: ../src/guestfs.pod:1319
2556 "The lifetime of the returned string is until the next error occurs, or "
2557 "L</guestfs_close> is called."
2561 #: ../src/guestfs.pod:1322
2562 msgid "guestfs_last_errno"
2566 #: ../src/guestfs.pod:1324
2569 " int guestfs_last_errno (guestfs_h *g);\n"
2574 #: ../src/guestfs.pod:1326
2575 msgid "This returns the last error number (errno) that happened on C<g>."
2579 #: ../src/guestfs.pod:1328
2580 msgid "If successful, an errno integer not equal to zero is returned."
2584 #: ../src/guestfs.pod:1330
2585 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2589 #: ../src/guestfs.pod:1337
2590 msgid "There has not been any error on the handle."
2594 #: ../src/guestfs.pod:1341
2596 "There has been an error but the errno was meaningless. This corresponds to "
2597 "the case where the error did not come from a failed system call, but for "
2598 "some other reason."
2602 #: ../src/guestfs.pod:1347
2604 "There was an error from a failed system call, but for some reason the errno "
2605 "was not captured and returned. This usually indicates a bug in libguestfs."
2609 #: ../src/guestfs.pod:1353
2611 "Libguestfs tries to convert the errno from inside the applicance into a "
2612 "corresponding errno for the caller (not entirely trivial: the appliance "
2613 "might be running a completely different operating system from the library "
2614 "and error numbers are not standardized across Un*xen). If this could not be "
2615 "done, then the error is translated to C<EINVAL>. In practice this should "
2616 "only happen in very rare circumstances."
2620 #: ../src/guestfs.pod:1361
2621 msgid "guestfs_set_error_handler"
2625 #: ../src/guestfs.pod:1363
2628 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2630 " const char *msg);\n"
2631 " void guestfs_set_error_handler (guestfs_h *g,\n"
2632 " guestfs_error_handler_cb cb,\n"
2638 #: ../src/guestfs.pod:1370
2640 "The callback C<cb> will be called if there is an error. The parameters "
2641 "passed to the callback are an opaque data pointer and the error message "
2646 #: ../src/guestfs.pod:1374
2648 "C<errno> is not passed to the callback. To get that the callback must call "
2649 "L</guestfs_last_errno>."
2653 #: ../src/guestfs.pod:1377
2655 "Note that the message string C<msg> is freed as soon as the callback "
2656 "function returns, so if you want to stash it somewhere you must make your "
2661 #: ../src/guestfs.pod:1381
2662 msgid "The default handler prints messages on C<stderr>."
2666 #: ../src/guestfs.pod:1383
2667 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2671 #: ../src/guestfs.pod:1385
2672 msgid "guestfs_get_error_handler"
2676 #: ../src/guestfs.pod:1387
2679 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2680 " void **opaque_rtn);\n"
2685 #: ../src/guestfs.pod:1390
2686 msgid "Returns the current error handler callback."
2690 #: ../src/guestfs.pod:1392
2691 msgid "guestfs_set_out_of_memory_handler"
2695 #: ../src/guestfs.pod:1394
2698 " typedef void (*guestfs_abort_cb) (void);\n"
2699 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2700 " guestfs_abort_cb);\n"
2705 #: ../src/guestfs.pod:1398
2707 "The callback C<cb> will be called if there is an out of memory situation. "
2708 "I<Note this callback must not return>."
2712 #: ../src/guestfs.pod:1401
2713 msgid "The default is to call L<abort(3)>."
2717 #: ../src/guestfs.pod:1403
2718 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2722 #: ../src/guestfs.pod:1406
2723 msgid "guestfs_get_out_of_memory_handler"
2727 #: ../src/guestfs.pod:1408
2730 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2735 #: ../src/guestfs.pod:1410
2736 msgid "This returns the current out of memory handler."
2740 #: ../src/guestfs.pod:1412
2745 #: ../src/guestfs.pod:1414 ../fish/guestfish.pod:969
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:1844 ../src/guestfs-actions.pod:2234 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255 ../fish/guestfish-actions.pod:1502 ../tools/virt-win-reg.pl:532
3099 #: ../src/guestfs.pod:1585
3100 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3104 #: ../src/guestfs.pod:1590
3105 msgid "You do not need to fill in all fields of the structure."
3109 #: ../src/guestfs.pod:1594
3111 "There must be a one-to-one correspondence between fields of the structure "
3112 "that are filled in, and bits set in the bitmask."
3116 #: ../src/guestfs.pod:1599
3117 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3121 #: ../src/guestfs.pod:1601
3123 "In other languages, optional arguments are expressed in the way that is "
3124 "natural for that language. We refer you to the language-specific "
3125 "documentation for more details on that."
3129 #: ../src/guestfs.pod:1605
3130 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3134 #: ../src/guestfs.pod:1607
3135 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3139 #: ../src/guestfs.pod:1609
3141 "The child process generates events in some situations. Current events "
3142 "include: receiving a log message, the child process exits."
3146 #: ../src/guestfs.pod:1612
3148 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3153 #: ../src/guestfs.pod:1615
3155 "Only I<one callback of each type> can be registered for each handle. "
3156 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3157 "that type. Cancel all callbacks of this type by calling this function with "
3158 "C<cb> set to C<NULL>."
3162 #: ../src/guestfs.pod:1620
3163 msgid "guestfs_set_log_message_callback"
3167 #: ../src/guestfs.pod:1622
3170 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3171 " char *buf, int len);\n"
3172 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3173 " guestfs_log_message_cb cb,\n"
3179 #: ../src/guestfs.pod:1628
3181 "The callback function C<cb> will be called whenever qemu or the guest writes "
3182 "anything to the console."
3186 #: ../src/guestfs.pod:1631
3187 msgid "Use this function to capture kernel messages and similar."
3191 #: ../src/guestfs.pod:1633
3193 "Normally there is no log message handler, and log messages are just "
3198 #: ../src/guestfs.pod:1636
3199 msgid "guestfs_set_subprocess_quit_callback"
3203 #: ../src/guestfs.pod:1638
3206 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3207 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3208 " guestfs_subprocess_quit_cb cb,\n"
3214 #: ../src/guestfs.pod:1643
3216 "The callback function C<cb> will be called when the child process quits, "
3217 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3218 "corresponds to a transition from any state to the CONFIG state)."
3222 #: ../src/guestfs.pod:1648
3223 msgid "guestfs_set_launch_done_callback"
3227 #: ../src/guestfs.pod:1650
3230 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3231 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3232 " guestfs_launch_done_cb cb,\n"
3238 #: ../src/guestfs.pod:1655
3240 "The callback function C<cb> will be called when the child process becomes "
3241 "ready first time after it has been launched. (This corresponds to a "
3242 "transition from LAUNCHING to the READY state)."
3246 #: ../src/guestfs.pod:1659
3247 msgid "guestfs_set_close_callback"
3251 #: ../src/guestfs.pod:1661
3254 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3255 " void guestfs_set_close_callback (guestfs_h *g,\n"
3256 " guestfs_close_cb cb,\n"
3262 #: ../src/guestfs.pod:1666
3264 "The callback function C<cb> will be called while the handle is being closed "
3265 "(synchronously from L</guestfs_close>)."
3269 #: ../src/guestfs.pod:1669
3271 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3272 "handles that are open when the program exits. This means that this callback "
3273 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3274 "problems in higher-level languages (eg. if your HLL interpreter has already "
3275 "been cleaned up by the time this is called, and if your callback then jumps "
3276 "into some HLL function)."
3280 #: ../src/guestfs.pod:1677
3281 msgid "guestfs_set_progress_callback"
3285 #: ../src/guestfs.pod:1679
3288 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3289 " int proc_nr, int serial,\n"
3290 " uint64_t position, uint64_t total);\n"
3291 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3292 " guestfs_progress_cb cb,\n"
3298 #: ../src/guestfs.pod:1686
3300 "Some long-running operations can generate progress messages. If this "
3301 "callback is registered, then it will be called each time a progress message "
3302 "is generated (usually two seconds after the operation started, and three "
3303 "times per second thereafter until it completes, although the frequency may "
3304 "change in future versions)."
3308 #: ../src/guestfs.pod:1692
3310 "The callback receives two numbers: C<position> and C<total>. The units of "
3311 "C<total> are not defined, although for some operations C<total> may relate "
3312 "in some way to the amount of data to be transferred (eg. in bytes or "
3313 "megabytes), and C<position> may be the portion which has been transferred."
3317 #: ../src/guestfs.pod:1698
3318 msgid "The only defined and stable parts of the API are:"
3322 #: ../src/guestfs.pod:1704
3324 "The callback can display to the user some type of progress bar or indicator "
3325 "which shows the ratio of C<position>:C<total>."
3329 #: ../src/guestfs.pod:1709
3330 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3334 #: ../src/guestfs.pod:1713
3336 "If any progress notification is sent during a call, then a final progress "
3337 "notification is always sent when C<position> = C<total> (I<unless> the call "
3338 "fails with an error)."
3342 #: ../src/guestfs.pod:1717
3344 "This is to simplify caller code, so callers can easily set the progress "
3345 "indicator to \"100%\" at the end of the operation, without requiring special "
3346 "code to detect this case."
3350 #: ../src/guestfs.pod:1723
3352 "The callback also receives the procedure number and serial number of the "
3353 "call. These are only useful for debugging protocol issues, and the callback "
3354 "can normally ignore them. The callback may want to print these numbers in "
3355 "error messages or debugging messages."
3359 #: ../src/guestfs.pod:1728
3360 msgid "PRIVATE DATA AREA"
3364 #: ../src/guestfs.pod:1730
3366 "You can attach named pieces of private data to the libguestfs handle, and "
3367 "fetch them by name for the lifetime of the handle. This is called the "
3368 "private data area and is only available from the C API."
3372 #: ../src/guestfs.pod:1734
3373 msgid "To attach a named piece of data, use the following call:"
3377 #: ../src/guestfs.pod:1736
3380 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3385 #: ../src/guestfs.pod:1738
3387 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3388 "pointer (which can be C<NULL>). Any previous item with the same name is "
3393 #: ../src/guestfs.pod:1742
3395 "You can use any C<key> you want, but names beginning with an underscore "
3396 "character are reserved for internal libguestfs purposes (for implementing "
3397 "language bindings). It is recommended to prefix the name with some unique "
3398 "string to avoid collisions with other users."
3402 #: ../src/guestfs.pod:1747
3403 msgid "To retrieve the pointer, use:"
3407 #: ../src/guestfs.pod:1749
3410 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3415 #: ../src/guestfs.pod:1751
3417 "This function returns C<NULL> if either no data is found associated with "
3418 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3423 #: ../src/guestfs.pod:1755
3425 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3426 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3427 "all. In particular, libguestfs does I<not> try to free the data when the "
3428 "handle is closed. If the data must be freed, then the caller must either "
3429 "free it before calling L</guestfs_close> or must set up a close callback to "
3430 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3431 "can be registered for a handle)."
3435 #: ../src/guestfs.pod:1763
3437 "The private data area is implemented using a hash table, and should be "
3438 "reasonably efficient for moderate numbers of keys."
3442 #: ../src/guestfs.pod:1766 ../src/guestfs.pod:1771
3447 #: ../src/guestfs.pod:1768
3449 "<!-- old anchor for the next section --> <a "
3450 "name=\"state_machine_and_low_level_event_api\"/>"
3454 #: ../src/guestfs.pod:1773
3455 msgid "ARCHITECTURE"
3459 #: ../src/guestfs.pod:1775
3461 "Internally, libguestfs is implemented by running an appliance (a special "
3462 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3463 "process of the main program."
3467 #: ../src/guestfs.pod:1779
3470 " ___________________\n"
3472 " | main program |\n"
3474 " | | child process / appliance\n"
3475 " | | __________________________\n"
3477 " +-------------------+ RPC | +-----------------+ |\n"
3478 " | libguestfs <--------------------> guestfsd | |\n"
3479 " | | | +-----------------+ |\n"
3480 " \\___________________/ | | Linux kernel | |\n"
3481 " | +--^--------------+ |\n"
3482 " \\_________|________________/\n"
3488 " \\______________/\n"
3493 #: ../src/guestfs.pod:1799
3495 "The library, linked to the main program, creates the child process and hence "
3496 "the appliance in the L</guestfs_launch> function."
3500 #: ../src/guestfs.pod:1802
3502 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3503 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3504 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3505 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3506 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3507 "attached to the qemu process which translates device access by the "
3508 "appliance's Linux kernel into accesses to the image."
3512 #: ../src/guestfs.pod:1811
3514 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3515 "Although the disk image you are attached to might also be used by some "
3516 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3517 "care if both libguestfs's qemu process and your virtual machine are trying "
3518 "to update the disk image at the same time, since these usually results in "
3519 "massive disk corruption)."
3523 #: ../src/guestfs.pod:1818
3524 msgid "STATE MACHINE"
3528 #: ../src/guestfs.pod:1820
3529 msgid "libguestfs uses a state machine to model the child process:"
3533 #: ../src/guestfs.pod:1822
3545 " / | \\ \\ guestfs_launch\n"
3546 " / | _\\__V______\n"
3548 " / | | LAUNCHING |\n"
3549 " / | \\___________/\n"
3551 " / | guestfs_launch\n"
3553 " ______ / __|____V\n"
3554 " / \\ ------> / \\\n"
3555 " | BUSY | | READY |\n"
3556 " \\______/ <------ \\________/\n"
3561 #: ../src/guestfs.pod:1844
3563 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3564 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3565 "(3) alternating between READY and BUSY as commands are issued to, and "
3566 "carried out by, the child process."
3570 #: ../src/guestfs.pod:1849
3572 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3573 "asynchronously at any time (eg. due to some internal error), and that causes "
3574 "the state to transition back to CONFIG."
3578 #: ../src/guestfs.pod:1853
3580 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3581 "issued when in the CONFIG state."
3585 #: ../src/guestfs.pod:1856
3587 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3588 "L</guestfs_launch> blocks until the child process is READY to accept "
3589 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3590 "moves the state from CONFIG to LAUNCHING while it is running."
3594 #: ../src/guestfs.pod:1862
3596 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3597 "state. These API calls block waiting for the command to be carried out "
3598 "(ie. the state to transition to BUSY and then back to READY). There are no "
3599 "non-blocking versions, and no way to issue more than one command per handle "
3604 #: ../src/guestfs.pod:1868
3606 "Finally, the child process sends asynchronous messages back to the main "
3607 "program, such as kernel log messages. You can register a callback to "
3608 "receive these messages."
3612 #: ../src/guestfs.pod:1872
3617 #: ../src/guestfs.pod:1874
3618 msgid "COMMUNICATION PROTOCOL"
3622 #: ../src/guestfs.pod:1876
3624 "Don't rely on using this protocol directly. This section documents how it "
3625 "currently works, but it may change at any time."
3629 #: ../src/guestfs.pod:1879
3631 "The protocol used to talk between the library and the daemon running inside "
3632 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3633 "1014, RFC 1832, RFC 4506)."
3637 #: ../src/guestfs.pod:1883
3639 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3640 "this file is automatically generated)."
3644 #: ../src/guestfs.pod:1886
3646 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3647 "and C<FileOut> parameters, which are handled with very simple request/reply "
3648 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3649 "parameters, which use the same request and reply messages, but they may also "
3650 "be followed by files sent using a chunked encoding."
3654 #: ../src/guestfs.pod:1893
3655 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3659 #: ../src/guestfs.pod:1895
3660 msgid "For ordinary functions, the request message is:"
3664 #: ../src/guestfs.pod:1897
3667 " total length (header + arguments,\n"
3668 " but not including the length word itself)\n"
3669 " struct guestfs_message_header (encoded as XDR)\n"
3670 " struct guestfs_<foo>_args (encoded as XDR)\n"
3675 #: ../src/guestfs.pod:1902
3677 "The total length field allows the daemon to allocate a fixed size buffer "
3678 "into which it slurps the rest of the message. As a result, the total length "
3679 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3680 "effective size of any request is limited to somewhere under this size."
3684 #: ../src/guestfs.pod:1908
3686 "Note also that many functions don't take any arguments, in which case the "
3687 "C<guestfs_I<foo>_args> is completely omitted."
3691 #: ../src/guestfs.pod:1911
3693 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3694 "receiver knows what type of args structure to expect, or none at all."
3698 #: ../src/guestfs.pod:1915
3700 "For functions that take optional arguments, the optional arguments are "
3701 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3702 "arguments. A bitmask in the header indicates which optional arguments are "
3703 "meaningful. The bitmask is also checked to see if it contains bits set "
3704 "which the daemon does not know about (eg. if more optional arguments were "
3705 "added in a later version of the library), and this causes the call to be "
3710 #: ../src/guestfs.pod:1923
3711 msgid "The reply message for ordinary functions is:"
3715 #: ../src/guestfs.pod:1925
3718 " total length (header + ret,\n"
3719 " but not including the length word itself)\n"
3720 " struct guestfs_message_header (encoded as XDR)\n"
3721 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3726 #: ../src/guestfs.pod:1930
3728 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3729 "functions that return no formal return values."
3733 #: ../src/guestfs.pod:1933
3734 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3738 #: ../src/guestfs.pod:1936
3740 "In the case of an error, a flag is set in the header, and the reply message "
3741 "is slightly changed:"
3745 #: ../src/guestfs.pod:1939
3748 " total length (header + error,\n"
3749 " but not including the length word itself)\n"
3750 " struct guestfs_message_header (encoded as XDR)\n"
3751 " struct guestfs_message_error (encoded as XDR)\n"
3756 #: ../src/guestfs.pod:1944
3758 "The C<guestfs_message_error> structure contains the error message as a "
3763 #: ../src/guestfs.pod:1947
3764 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3768 #: ../src/guestfs.pod:1949
3770 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3771 "The normal request message is sent (see above). However this is followed by "
3772 "a sequence of file chunks."
3776 #: ../src/guestfs.pod:1953
3779 " total length (header + arguments,\n"
3780 " but not including the length word itself,\n"
3781 " and not including the chunks)\n"
3782 " struct guestfs_message_header (encoded as XDR)\n"
3783 " struct guestfs_<foo>_args (encoded as XDR)\n"
3784 " sequence of chunks for FileIn param #0\n"
3785 " sequence of chunks for FileIn param #1 etc.\n"
3790 #: ../src/guestfs.pod:1961
3791 msgid "The \"sequence of chunks\" is:"
3795 #: ../src/guestfs.pod:1963
3798 " length of chunk (not including length word itself)\n"
3799 " struct guestfs_chunk (encoded as XDR)\n"
3800 " length of chunk\n"
3801 " struct guestfs_chunk (encoded as XDR)\n"
3803 " length of chunk\n"
3804 " struct guestfs_chunk (with data.data_len == 0)\n"
3809 #: ../src/guestfs.pod:1971
3811 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3812 "is set in the final chunk to indicate either successful completion or early "
3817 #: ../src/guestfs.pod:1975
3819 "At time of writing there are no functions that have more than one FileIn "
3820 "parameter. However this is (theoretically) supported, by sending the "
3821 "sequence of chunks for each FileIn parameter one after another (from left to "
3826 #: ../src/guestfs.pod:1980
3828 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3829 "transfer. The library does this by sending a chunk with a special flag set "
3830 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3831 "RPC, does I<not> send any reply, and goes back to reading the next request."
3835 #: ../src/guestfs.pod:1986
3837 "The daemon may also cancel. It does this by writing a special word "
3838 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3839 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3840 "cancel chunk). The special word is chosen so that even if cancellation "
3841 "happens right at the end of the transfer (after the library has finished "
3842 "writing and has started listening for the reply), the \"spurious\" cancel "
3843 "flag will not be confused with the reply message."
3847 #: ../src/guestfs.pod:1995
3849 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3850 "limit), and also files where the size is not known in advance (eg. from "
3851 "pipes or sockets). However the chunks are rather small "
3852 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3853 "to keep much in memory."
3857 #: ../src/guestfs.pod:2001
3858 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3862 #: ../src/guestfs.pod:2003
3864 "The protocol for FileOut parameters is exactly the same as for FileIn "
3865 "parameters, but with the roles of daemon and library reversed."
3869 #: ../src/guestfs.pod:2006
3872 " total length (header + ret,\n"
3873 " but not including the length word itself,\n"
3874 " and not including the chunks)\n"
3875 " struct guestfs_message_header (encoded as XDR)\n"
3876 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3877 " sequence of chunks for FileOut param #0\n"
3878 " sequence of chunks for FileOut param #1 etc.\n"
3883 #: ../src/guestfs.pod:2014
3884 msgid "INITIAL MESSAGE"
3888 #: ../src/guestfs.pod:2016
3890 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3891 "which indicates that the guest and daemon is alive. This is what "
3892 "L</guestfs_launch> waits for."
3896 #: ../src/guestfs.pod:2020
3897 msgid "PROGRESS NOTIFICATION MESSAGES"
3901 #: ../src/guestfs.pod:2022
3903 "The daemon may send progress notification messages at any time. These are "
3904 "distinguished by the normal length word being replaced by "
3905 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3909 #: ../src/guestfs.pod:2026
3911 "The library turns them into progress callbacks (see "
3912 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3913 "discards them if not."
3917 #: ../src/guestfs.pod:2030
3919 "The daemon self-limits the frequency of progress messages it sends (see "
3920 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3925 #: ../src/guestfs.pod:2034
3926 msgid "LIBGUESTFS VERSION NUMBERS"
3930 #: ../src/guestfs.pod:2036
3932 "Since April 2010, libguestfs has started to make separate development and "
3933 "stable releases, along with corresponding branches in our git repository. "
3934 "These separate releases can be identified by version number:"
3938 #: ../src/guestfs.pod:2041
3941 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3942 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3948 " | `-------- sub-version\n"
3950 " `------ always '1' because we don't change the ABI\n"
3955 #: ../src/guestfs.pod:2052
3956 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3960 #: ../src/guestfs.pod:2054
3962 "As time passes we cherry pick fixes from the development branch and backport "
3963 "those into the stable branch, the effect being that the stable branch should "
3964 "get more stable and less buggy over time. So the stable releases are ideal "
3965 "for people who don't need new features but would just like the software to "
3970 #: ../src/guestfs.pod:2060
3971 msgid "Our criteria for backporting changes are:"
3975 #: ../src/guestfs.pod:2066
3977 "Documentation changes which don't affect any code are backported unless the "
3978 "documentation refers to a future feature which is not in stable."
3982 #: ../src/guestfs.pod:2072
3984 "Bug fixes which are not controversial, fix obvious problems, and have been "
3985 "well tested are backported."
3989 #: ../src/guestfs.pod:2077
3991 "Simple rearrangements of code which shouldn't affect how it works get "
3992 "backported. This is so that the code in the two branches doesn't get too "
3993 "far out of step, allowing us to backport future fixes more easily."
3997 #: ../src/guestfs.pod:2083
3999 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4000 "exceptional case: the new feature is required in order to implement an "
4001 "important bug fix."
4005 #: ../src/guestfs.pod:2089
4007 "A new stable branch starts when we think the new features in development are "
4008 "substantial and compelling enough over the current stable branch to warrant "
4009 "it. When that happens we create new stable and development versions 1.N.0 "
4010 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4011 "stable at this point, but by backporting fixes from development, that branch "
4012 "will stabilize over time."
4016 #: ../src/guestfs.pod:2097
4017 msgid "EXTENDING LIBGUESTFS"
4021 #: ../src/guestfs.pod:2099
4022 msgid "ADDING A NEW API ACTION"
4026 #: ../src/guestfs.pod:2101
4028 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4029 "documentation) are generated, and this makes it easy to extend the "
4034 #: ../src/guestfs.pod:2105
4035 msgid "To add a new API action there are two changes:"
4039 #: ../src/guestfs.pod:2111
4041 "You need to add a description of the call (name, parameters, return type, "
4042 "tests, documentation) to C<generator/generator_actions.ml>."
4046 #: ../src/guestfs.pod:2114
4048 "There are two sorts of API action, depending on whether the call goes "
4049 "through to the daemon in the appliance, or is serviced entirely by the "
4050 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4051 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4052 "an example of the latter, since a trace flag is maintained in the handle and "
4053 "all tracing is done on the library side."
4057 #: ../src/guestfs.pod:2122
4059 "Most new actions are of the first type, and get added to the "
4060 "C<daemon_functions> list. Each function has a unique procedure number used "
4061 "in the RPC protocol which is assigned to that action when we publish "
4062 "libguestfs and cannot be reused. Take the latest procedure number and "
4067 #: ../src/guestfs.pod:2128
4069 "For library-only actions of the second type, add to the "
4070 "C<non_daemon_functions> list. Since these functions are serviced by the "
4071 "library and do not travel over the RPC mechanism to the daemon, these "
4072 "functions do not need a procedure number, and so the procedure number is set "
4077 #: ../src/guestfs.pod:2136
4078 msgid "Implement the action (in C):"
4082 #: ../src/guestfs.pod:2138
4084 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4085 "C<daemon/> directory."
4089 #: ../src/guestfs.pod:2141
4091 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4092 "(note: double underscore) in the C<src/> directory."
4096 #: ../src/guestfs.pod:2144
4097 msgid "In either case, use another function as an example of what to do."
4101 #: ../src/guestfs.pod:2148
4102 msgid "After making these changes, use C<make> to compile."
4106 #: ../src/guestfs.pod:2150
4108 "Note that you don't need to implement the RPC, language bindings, manual "
4109 "pages or anything else. It's all automatically generated from the OCaml "
4114 #: ../src/guestfs.pod:2154
4115 msgid "ADDING TESTS FOR AN API ACTION"
4119 #: ../src/guestfs.pod:2156
4121 "You can supply zero or as many tests as you want per API call. The tests "
4122 "can either be added as part of the API description "
4123 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4124 "drop a script into C<regressions/>. Note that adding a script to "
4125 "C<regressions/> is slower, so if possible use the first method."
4129 #: ../src/guestfs.pod:2162
4131 "The following describes the test environment used when you add an API test "
4132 "in C<generator_actions.ml>."
4136 #: ../src/guestfs.pod:2165
4137 msgid "The test environment has 4 block devices:"
4141 #: ../src/guestfs.pod:2169
4142 msgid "C</dev/sda> 500MB"
4146 #: ../src/guestfs.pod:2171
4147 msgid "General block device for testing."
4151 #: ../src/guestfs.pod:2173
4152 msgid "C</dev/sdb> 50MB"
4156 #: ../src/guestfs.pod:2175
4158 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4163 #: ../src/guestfs.pod:2178
4164 msgid "C</dev/sdc> 10MB"
4168 #: ../src/guestfs.pod:2180
4169 msgid "Used in a few tests where two block devices are needed."
4173 #: ../src/guestfs.pod:2182
4178 #: ../src/guestfs.pod:2184
4179 msgid "ISO with fixed content (see C<images/test.iso>)."
4183 #: ../src/guestfs.pod:2188
4185 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4186 "appliance and block devices are reused between tests. So don't try testing "
4187 "L</guestfs_kill_subprocess> :-x"
4191 #: ../src/guestfs.pod:2192
4193 "Each test starts with an initial scenario, selected using one of the "
4194 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4195 "initialize the disks mentioned above in a particular way as documented in "
4196 "C<generator_types.ml>. You should not assume anything about the previous "
4197 "contents of other disks that are not initialized."
4201 #: ../src/guestfs.pod:2198
4203 "You can add a prerequisite clause to any individual test. This is a "
4204 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4205 "if testing a command which might not work on all variations of libguestfs "
4206 "builds. A test that has prerequisite of C<Always> means to run "
4211 #: ../src/guestfs.pod:2204
4213 "In addition, packagers can skip individual tests by setting environment "
4214 "variables before running C<make check>."
4218 #: ../src/guestfs.pod:2207
4221 " SKIP_TEST_<CMD>_<NUM>=1\n"
4226 #: ../src/guestfs.pod:2209
4227 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4231 #: ../src/guestfs.pod:2211
4236 #: ../src/guestfs.pod:2213
4239 " SKIP_TEST_<CMD>=1\n"
4244 #: ../src/guestfs.pod:2215
4245 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4249 #: ../src/guestfs.pod:2217
4250 msgid "Packagers can run only certain tests by setting for example:"
4254 #: ../src/guestfs.pod:2219
4257 " TEST_ONLY=\"vfs_type zerofree\"\n"
4262 #: ../src/guestfs.pod:2221
4264 "See C<capitests/tests.c> for more details of how these environment variables "
4269 #: ../src/guestfs.pod:2224
4270 msgid "DEBUGGING NEW API ACTIONS"
4274 #: ../src/guestfs.pod:2226
4275 msgid "Test new actions work before submitting them."
4279 #: ../src/guestfs.pod:2228
4280 msgid "You can use guestfish to try out new commands."
4284 #: ../src/guestfs.pod:2230
4286 "Debugging the daemon is a problem because it runs inside a minimal "
4287 "environment. However you can fprintf messages in the daemon to stderr, and "
4288 "they will show up if you use C<guestfish -v>."
4292 #: ../src/guestfs.pod:2234
4293 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4297 #: ../src/guestfs.pod:2236
4299 "Our C source code generally adheres to some basic code-formatting "
4300 "conventions. The existing code base is not totally consistent on this "
4301 "front, but we do prefer that contributed code be formatted similarly. In "
4302 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4303 "indentation level, and other than that, follow the K&R style."
4307 #: ../src/guestfs.pod:2242
4309 "If you use Emacs, add the following to one of one of your start-up files "
4310 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4314 #: ../src/guestfs.pod:2245
4317 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4318 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4319 " (add-hook 'find-file-hook\n"
4320 " '(lambda () (if (and buffer-file-name\n"
4321 " (string-match \"/libguestfs\\\\>\"\n"
4322 " (buffer-file-name))\n"
4323 " (not (string-equal mode-name \"Change Log\"))\n"
4324 " (not (string-equal mode-name \"Makefile\")))\n"
4325 " (setq indent-tabs-mode nil))))\n"
4330 #: ../src/guestfs.pod:2255
4333 " ;;; When editing C sources in libguestfs, use this style.\n"
4334 " (defun libguestfs-c-mode ()\n"
4335 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4337 " (c-set-style \"K&R\")\n"
4338 " (setq c-indent-level 2)\n"
4339 " (setq c-basic-offset 2))\n"
4340 " (add-hook 'c-mode-hook\n"
4341 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4342 " (buffer-file-name))\n"
4343 " (libguestfs-c-mode))))\n"
4348 #: ../src/guestfs.pod:2267
4349 msgid "Enable warnings when compiling (and fix any problems this finds):"
4353 #: ../src/guestfs.pod:2270
4356 " ./configure --enable-gcc-warnings\n"
4361 #: ../src/guestfs.pod:2272
4362 msgid "Useful targets are:"
4366 #: ../src/guestfs.pod:2274
4369 " make syntax-check # checks the syntax of the C code\n"
4370 " make check # runs the test suite\n"
4375 #: ../src/guestfs.pod:2277
4376 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4380 #: ../src/guestfs.pod:2279
4382 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4383 "which are used to do shell quoting."
4387 #: ../src/guestfs.pod:2284
4392 #: ../src/guestfs.pod:2286
4394 "Simple shell quoted string. Any spaces or other shell characters are "
4399 #: ../src/guestfs.pod:2289
4404 #: ../src/guestfs.pod:2291
4406 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4411 #: ../src/guestfs.pod:2296 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4412 msgid "For example:"
4416 #: ../src/guestfs.pod:2298
4419 " asprintf (&cmd, \"cat %R\", path);\n"
4424 #: ../src/guestfs.pod:2300
4425 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4429 #: ../src/guestfs.pod:2302
4431 "I<Note:> Do I<not> use these when you are passing parameters to the "
4432 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4433 "because they are not passed via the shell (instead, straight to exec). You "
4434 "probably want to use the C<sysroot_path()> function however."
4438 #: ../src/guestfs.pod:2308
4439 msgid "SUBMITTING YOUR NEW API ACTIONS"
4443 #: ../src/guestfs.pod:2310
4445 "Submit patches to the mailing list: "
4446 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
4447 "L<rjones@redhat.com>."
4451 #: ../src/guestfs.pod:2314
4452 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
4456 #: ../src/guestfs.pod:2316
4457 msgid "We support i18n (gettext anyhow) in the library."
4461 #: ../src/guestfs.pod:2318
4463 "However many messages come from the daemon, and we don't translate those at "
4464 "the moment. One reason is that the appliance generally has all locale files "
4465 "removed from it, because they take up a lot of space. So we'd have to readd "
4466 "some of those, as well as copying our PO files into the appliance."
4470 #: ../src/guestfs.pod:2324
4472 "Debugging messages are never translated, since they are intended for the "
4477 #: ../src/guestfs.pod:2327
4478 msgid "SOURCE CODE SUBDIRECTORIES"
4482 #: ../src/guestfs.pod:2331
4483 msgid "C<appliance>"
4487 #: ../src/guestfs.pod:2333
4488 msgid "The libguestfs appliance, build scripts and so on."
4492 #: ../src/guestfs.pod:2335
4493 msgid "C<capitests>"
4497 #: ../src/guestfs.pod:2337
4498 msgid "Automated tests of the C API."
4502 #: ../src/guestfs.pod:2339
4507 #: ../src/guestfs.pod:2341
4509 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
4514 #: ../src/guestfs.pod:2344
4519 #: ../src/guestfs.pod:2346
4521 "Safety and liveness tests of components that libguestfs depends upon (not of "
4522 "libguestfs itself). Mainly this is for qemu and the kernel."
4526 #: ../src/guestfs.pod:2349
4531 #: ../src/guestfs.pod:2351
4532 msgid "Outside contributions, experimental parts."
4536 #: ../src/guestfs.pod:2353
4541 #: ../src/guestfs.pod:2355
4543 "The daemon that runs inside the libguestfs appliance and carries out "
4548 #: ../src/guestfs.pod:2358
4553 #: ../src/guestfs.pod:2360
4554 msgid "L<virt-df(1)> command and documentation."
4558 #: ../src/guestfs.pod:2362
4563 #: ../src/guestfs.pod:2364
4564 msgid "C API example code."
4568 #: ../src/guestfs.pod:2366
4573 #: ../src/guestfs.pod:2368
4574 msgid "L<guestfish(1)>, the command-line shell."
4578 #: ../src/guestfs.pod:2370
4583 #: ../src/guestfs.pod:2372
4584 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
4588 #: ../src/guestfs.pod:2374
4589 msgid "C<generator>"
4593 #: ../src/guestfs.pod:2376
4595 "The crucially important generator, used to automatically generate large "
4596 "amounts of boilerplate C code for things like RPC and bindings."
4600 #: ../src/guestfs.pod:2379
4605 #: ../src/guestfs.pod:2381
4606 msgid "Files used by the test suite."
4610 #: ../src/guestfs.pod:2383
4611 msgid "Some \"phony\" guest images which we test against."
4615 #: ../src/guestfs.pod:2385
4616 msgid "C<inspector>"
4620 #: ../src/guestfs.pod:2387
4621 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
4625 #: ../src/guestfs.pod:2389
4630 #: ../src/guestfs.pod:2391
4631 msgid "M4 macros used by autoconf."
4635 #: ../src/guestfs.pod:2393
4640 #: ../src/guestfs.pod:2395
4641 msgid "Translations of simple gettext strings."
4645 #: ../src/guestfs.pod:2397
4650 #: ../src/guestfs.pod:2399
4652 "The build infrastructure and PO files for translations of manpages and POD "
4653 "files. Eventually this will be combined with the C<po> directory, but that "
4654 "is rather complicated."
4658 #: ../src/guestfs.pod:2403
4659 msgid "C<regressions>"
4663 #: ../src/guestfs.pod:2405
4664 msgid "Regression tests."
4668 #: ../src/guestfs.pod:2407
4673 #: ../src/guestfs.pod:2409
4674 msgid "L<virt-rescue(1)> command and documentation."
4678 #: ../src/guestfs.pod:2411
4683 #: ../src/guestfs.pod:2413
4684 msgid "Source code to the C library."
4688 #: ../src/guestfs.pod:2415
4693 #: ../src/guestfs.pod:2417
4694 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
4698 #: ../src/guestfs.pod:2419
4699 msgid "C<test-tool>"
4703 #: ../src/guestfs.pod:2421
4705 "Test tool for end users to test if their qemu/kernel combination will work "
4710 #: ../src/guestfs.pod:2424
4715 #: ../src/guestfs.pod:2426
4720 #: ../src/guestfs.pod:2428
4725 #: ../src/guestfs.pod:2430
4730 #: ../src/guestfs.pod:2432
4735 #: ../src/guestfs.pod:2434
4740 #: ../src/guestfs.pod:2436
4745 #: ../src/guestfs.pod:2438
4750 #: ../src/guestfs.pod:2440
4751 msgid "Language bindings."
4755 #: ../src/guestfs.pod:2444 ../fish/guestfish.pod:976 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:375
4756 msgid "ENVIRONMENT VARIABLES"
4760 #: ../src/guestfs.pod:2448 ../fish/guestfish.pod:1002
4761 msgid "LIBGUESTFS_APPEND"
4765 #: ../src/guestfs.pod:2450 ../fish/guestfish.pod:1004
4766 msgid "Pass additional options to the guest kernel."
4770 #: ../src/guestfs.pod:2452 ../fish/guestfish.pod:1006
4771 msgid "LIBGUESTFS_DEBUG"
4775 #: ../src/guestfs.pod:2454
4777 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
4778 "effect as calling C<guestfs_set_verbose (g, 1)>."
4782 #: ../src/guestfs.pod:2457 ../fish/guestfish.pod:1011
4783 msgid "LIBGUESTFS_MEMSIZE"
4787 #: ../src/guestfs.pod:2459 ../fish/guestfish.pod:1013
4788 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
4792 #: ../src/guestfs.pod:2462 ../fish/guestfish.pod:1016
4795 " LIBGUESTFS_MEMSIZE=700\n"
4800 #: ../src/guestfs.pod:2464 ../fish/guestfish.pod:1018
4801 msgid "LIBGUESTFS_PATH"
4805 #: ../src/guestfs.pod:2466
4807 "Set the path that libguestfs uses to search for a supermin appliance. See "
4808 "the discussion of paths in section L</PATH> above."
4812 #: ../src/guestfs.pod:2469 ../fish/guestfish.pod:1023
4813 msgid "LIBGUESTFS_QEMU"
4817 #: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1025
4819 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4820 "which was found at compile time by the configure script is used."
4824 #: ../src/guestfs.pod:2475
4825 msgid "See also L</QEMU WRAPPERS> above."
4829 #: ../src/guestfs.pod:2477 ../fish/guestfish.pod:1029
4830 msgid "LIBGUESTFS_TRACE"
4834 #: ../src/guestfs.pod:2479
4836 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4837 "effect as calling C<guestfs_set_trace (g, 1)>."
4841 #: ../src/guestfs.pod:2482 ../fish/guestfish.pod:1038
4846 #: ../src/guestfs.pod:2484 ../fish/guestfish.pod:1040
4847 msgid "Location of temporary directory, defaults to C</tmp>."
4851 #: ../src/guestfs.pod:2486 ../fish/guestfish.pod:1042
4853 "If libguestfs was compiled to use the supermin appliance then the real "
4854 "appliance is cached in this directory, shared between all handles belonging "
4855 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4856 "use in case C</tmp> is not large enough."
4860 #: ../src/guestfs.pod:2494 ../fish/guestfish.pod:1100 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:395 ../tools/virt-win-reg.pl:572 ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
4865 #: ../src/guestfs.pod:2496
4867 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4868 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4869 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
4870 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4871 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4872 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4873 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4877 #: ../src/guestfs.pod:2519
4879 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4880 "L<lvm(8)>, L<disktype(1)>."
4884 #: ../src/guestfs.pod:2526 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
4889 #: ../src/guestfs.pod:2528
4890 msgid "To get a list of bugs against libguestfs use this link:"
4894 #: ../src/guestfs.pod:2530
4895 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4899 #: ../src/guestfs.pod:2532
4900 msgid "To report a new bug against libguestfs use this link:"
4904 #: ../src/guestfs.pod:2534
4905 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4909 #: ../src/guestfs.pod:2536
4910 msgid "When reporting a bug, please check:"
4914 #: ../src/guestfs.pod:2542
4915 msgid "That the bug hasn't been reported already."
4919 #: ../src/guestfs.pod:2546
4920 msgid "That you are testing a recent version."
4924 #: ../src/guestfs.pod:2550
4925 msgid "Describe the bug accurately, and give a way to reproduce it."
4929 #: ../src/guestfs.pod:2554
4931 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4936 #: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1119 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4941 #: ../src/guestfs.pod:2561 ../fish/guestfish.pod:1121 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4942 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4946 #: ../src/guestfs.pod:2563 ../fish/guestfish.pod:1123 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:411 ../tools/virt-win-reg.pl:602 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
4951 #: ../src/guestfs.pod:2565 ../fish/guestfish.pod:1125 ../fuse/guestmount.pod:250
4952 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4956 #: ../src/guestfs.pod:2568
4958 "This library is free software; you can redistribute it and/or modify it "
4959 "under the terms of the GNU Lesser General Public License as published by the "
4960 "Free Software Foundation; either version 2 of the License, or (at your "
4961 "option) any later version."
4965 #: ../src/guestfs.pod:2573
4967 "This library is distributed in the hope that it will be useful, but WITHOUT "
4968 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4969 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4974 #: ../src/guestfs.pod:2578
4976 "You should have received a copy of the GNU Lesser General Public License "
4977 "along with this library; if not, write to the Free Software Foundation, "
4978 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4982 #: ../src/guestfs-actions.pod:1
4983 msgid "guestfs_add_cdrom"
4987 #: ../src/guestfs-actions.pod:3
4991 " guestfs_add_cdrom (guestfs_h *g,\n"
4992 " const char *filename);\n"
4997 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4998 msgid "This function adds a virtual CD-ROM disk image to the guest."
5002 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5003 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5007 #: ../src/guestfs-actions.pod:17
5009 "This call checks for the existence of C<filename>. This stops you from "
5010 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5011 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5016 #: ../src/guestfs-actions.pod:24
5018 "If you just want to add an ISO file (often you use this as an efficient way "
5019 "to transfer large files into the guest), then you should probably use "
5020 "C<guestfs_add_drive_ro> instead."
5024 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:413 ../src/guestfs-actions.pod:433 ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:492 ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:538 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:638 ../src/guestfs-actions.pod:652 ../src/guestfs-actions.pod:667 ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:784 ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:812 ../src/guestfs-actions.pod:973 ../src/guestfs-actions.pod:993 ../src/guestfs-actions.pod:1011 ../src/guestfs-actions.pod:1095 ../src/guestfs-actions.pod:1113 ../src/guestfs-actions.pod:1132 ../src/guestfs-actions.pod:1146 ../src/guestfs-actions.pod:1166 ../src/guestfs-actions.pod:1236 ../src/guestfs-actions.pod:1267 ../src/guestfs-actions.pod:1292 ../src/guestfs-actions.pod:1329 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1469 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2267 ../src/guestfs-actions.pod:2411 ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2507 ../src/guestfs-actions.pod:3250 ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3496 ../src/guestfs-actions.pod:3532 ../src/guestfs-actions.pod:3604 ../src/guestfs-actions.pod:3624 ../src/guestfs-actions.pod:3641 ../src/guestfs-actions.pod:3664 ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:3719 ../src/guestfs-actions.pod:3738 ../src/guestfs-actions.pod:3757 ../src/guestfs-actions.pod:3792 ../src/guestfs-actions.pod:3804 ../src/guestfs-actions.pod:3840 ../src/guestfs-actions.pod:3856 ../src/guestfs-actions.pod:3869 ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:4027 ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:4096 ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4144 ../src/guestfs-actions.pod:4158 ../src/guestfs-actions.pod:4175 ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:4329 ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:4379 ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4410 ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4455 ../src/guestfs-actions.pod:4470 ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4540 ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:4571 ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4680 ../src/guestfs-actions.pod:4708 ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:4877 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:4974 ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5072 ../src/guestfs-actions.pod:5089 ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5116 ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5424 ../src/guestfs-actions.pod:5438 ../src/guestfs-actions.pod:5450 ../src/guestfs-actions.pod:5464 ../src/guestfs-actions.pod:5476 ../src/guestfs-actions.pod:5490 ../src/guestfs-actions.pod:5506 ../src/guestfs-actions.pod:5527 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5565 ../src/guestfs-actions.pod:5583 ../src/guestfs-actions.pod:5606 ../src/guestfs-actions.pod:5624 ../src/guestfs-actions.pod:5643 ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5683 ../src/guestfs-actions.pod:5700 ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5795 ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:5825 ../src/guestfs-actions.pod:5844 ../src/guestfs-actions.pod:5881 ../src/guestfs-actions.pod:5904 ../src/guestfs-actions.pod:5930 ../src/guestfs-actions.pod:6038 ../src/guestfs-actions.pod:6159 ../src/guestfs-actions.pod:6171 ../src/guestfs-actions.pod:6184 ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6219 ../src/guestfs-actions.pod:6232 ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6273 ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6349 ../src/guestfs-actions.pod:6365 ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6398 ../src/guestfs-actions.pod:6411 ../src/guestfs-actions.pod:6431 ../src/guestfs-actions.pod:6467 ../src/guestfs-actions.pod:6481 ../src/guestfs-actions.pod:6522 ../src/guestfs-actions.pod:6535 ../src/guestfs-actions.pod:6553 ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6623 ../src/guestfs-actions.pod:6742 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6887 ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:6974 ../src/guestfs-actions.pod:7000 ../src/guestfs-actions.pod:7066 ../src/guestfs-actions.pod:7085 ../src/guestfs-actions.pod:7114
5025 msgid "This function returns 0 on success or -1 on error."
5029 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261
5031 "This function is deprecated. In new code, use the "
5032 "L</guestfs_add_drive_opts> call instead."
5036 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7177 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168 ../fish/guestfish-actions.pod:954 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:2844 ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4754
5038 "Deprecated functions will not be removed from the API, but the fact that "
5039 "they are deprecated indicates that there are problems with correct use of "
5044 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1097 ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:3252 ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:4507 ../src/guestfs-actions.pod:5585 ../src/guestfs-actions.pod:5702 ../src/guestfs-actions.pod:5812 ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6400 ../src/guestfs-actions.pod:6922
5045 msgid "(Added in 0.3)"
5049 #: ../src/guestfs-actions.pod:41
5050 msgid "guestfs_add_domain"
5054 #: ../src/guestfs-actions.pod:43
5058 " guestfs_add_domain (guestfs_h *g,\n"
5059 " const char *dom,\n"
5065 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137 ../src/guestfs-actions.pod:4229
5067 "You may supply a list of optional arguments to this call. Use zero or more "
5068 "of the following pairs of parameters, and terminate the list with C<-1> on "
5069 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5073 #: ../src/guestfs-actions.pod:53
5076 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5077 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5078 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5083 #: ../src/guestfs-actions.pod:57
5085 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5086 "It works by connecting to libvirt, requesting the domain and domain XML from "
5087 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5092 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5094 "The number of disks added is returned. This operation is atomic: if an "
5095 "error is returned, then no disks are added."
5099 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5101 "This function does some minimal checks to make sure the libvirt domain is "
5102 "not running (unless C<readonly> is true). In a future version we will try "
5103 "to acquire the libvirt lock on each disk."
5107 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5109 "Disks must be accessible locally. This often means that adding disks from a "
5110 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5111 "unless those disks are accessible via the same device path locally too."
5115 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5117 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5118 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5119 "default libvirt URI (or one set through an environment variable, see the "
5120 "libvirt documentation for full details)."
5124 #: ../src/guestfs-actions.pod:80
5126 "The other optional parameters are passed directly through to "
5127 "C<guestfs_add_drive_opts>."
5131 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:506 ../src/guestfs-actions.pod:684 ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:733 ../src/guestfs-actions.pod:752 ../src/guestfs-actions.pod:1312 ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2398 ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2707 ../src/guestfs-actions.pod:4643 ../src/guestfs-actions.pod:4780 ../src/guestfs-actions.pod:5186 ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:6508 ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6946 ../src/guestfs-actions.pod:6959
5132 msgid "On error this function returns -1."
5136 #: ../src/guestfs-actions.pod:85
5137 msgid "(Added in 1.7.4)"
5141 #: ../src/guestfs-actions.pod:87
5142 msgid "guestfs_add_domain_va"
5146 #: ../src/guestfs-actions.pod:89
5150 " guestfs_add_domain_va (guestfs_h *g,\n"
5151 " const char *dom,\n"
5157 #: ../src/guestfs-actions.pod:94
5158 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5162 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4282
5163 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5167 #: ../src/guestfs-actions.pod:98
5168 msgid "guestfs_add_domain_argv"
5172 #: ../src/guestfs-actions.pod:100
5176 " guestfs_add_domain_argv (guestfs_h *g,\n"
5177 " const char *dom,\n"
5178 " const struct guestfs_add_domain_argv *optargs);\n"
5183 #: ../src/guestfs-actions.pod:105
5184 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5188 #: ../src/guestfs-actions.pod:109
5189 msgid "guestfs_add_drive"
5193 #: ../src/guestfs-actions.pod:111
5197 " guestfs_add_drive (guestfs_h *g,\n"
5198 " const char *filename);\n"
5203 #: ../src/guestfs-actions.pod:115
5205 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5206 "optional parameters, so the disk is added writable, with the format being "
5207 "detected automatically."
5211 #: ../src/guestfs-actions.pod:119
5213 "Automatic detection of the format opens you up to a potential security hole "
5214 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5215 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5216 "you should think about replacing calls to this function with calls to "
5217 "C<guestfs_add_drive_opts>, and specifying the format."
5221 #: ../src/guestfs-actions.pod:130
5222 msgid "guestfs_add_drive_opts"
5226 #: ../src/guestfs-actions.pod:132
5230 " guestfs_add_drive_opts (guestfs_h *g,\n"
5231 " const char *filename,\n"
5237 #: ../src/guestfs-actions.pod:142
5240 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5241 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5242 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5247 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
5249 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5250 "The first time you call this function, the disk appears as C</dev/sda>, the "
5251 "second time as C</dev/sdb>, and so on."
5255 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
5257 "You don't necessarily need to be root when using libguestfs. However you "
5258 "obviously do need sufficient permissions to access the filename for whatever "
5259 "operations you want to perform (ie. read access if you just want to read the "
5260 "image or write access if you want to modify the image)."
5264 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
5265 msgid "This call checks that C<filename> exists."
5269 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4239 ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2855
5270 msgid "The optional arguments are:"
5274 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
5279 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
5281 "If true then the image is treated as read-only. Writes are still allowed, "
5282 "but they are stored in a temporary snapshot overlay which is discarded at "
5283 "the end. The disk that you add is not modified."
5287 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
5292 #: ../src/guestfs-actions.pod:171
5294 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5295 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5296 "Possible formats include C<raw> and C<qcow2>."
5300 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
5302 "Automatic detection of the format opens you up to a potential security hole "
5303 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5304 "RHBZ#642934. Specifying the format closes this security hole."
5308 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
5313 #: ../src/guestfs-actions.pod:182
5315 "This rarely-used option lets you emulate the behaviour of the deprecated "
5316 "C<guestfs_add_drive_with_if> call (q.v.)"
5320 #: ../src/guestfs-actions.pod:189
5321 msgid "(Added in 1.5.23)"
5325 #: ../src/guestfs-actions.pod:191
5326 msgid "guestfs_add_drive_opts_va"
5330 #: ../src/guestfs-actions.pod:193
5334 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5335 " const char *filename,\n"
5341 #: ../src/guestfs-actions.pod:198
5342 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5346 #: ../src/guestfs-actions.pod:202
5347 msgid "guestfs_add_drive_opts_argv"
5351 #: ../src/guestfs-actions.pod:204
5355 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5356 " const char *filename,\n"
5357 " const struct guestfs_add_drive_opts_argv "
5363 #: ../src/guestfs-actions.pod:209
5364 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5368 #: ../src/guestfs-actions.pod:213
5369 msgid "guestfs_add_drive_ro"
5373 #: ../src/guestfs-actions.pod:215
5377 " guestfs_add_drive_ro (guestfs_h *g,\n"
5378 " const char *filename);\n"
5383 #: ../src/guestfs-actions.pod:219
5385 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5386 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5387 "disk is added read-only, with the format being detected automatically."
5391 #: ../src/guestfs-actions.pod:226
5392 msgid "(Added in 1.0.38)"
5396 #: ../src/guestfs-actions.pod:228
5397 msgid "guestfs_add_drive_ro_with_if"
5401 #: ../src/guestfs-actions.pod:230
5405 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
5406 " const char *filename,\n"
5407 " const char *iface);\n"
5412 #: ../src/guestfs-actions.pod:235
5414 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
5415 "QEMU interface emulation to use at run time."
5419 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2357
5420 msgid "(Added in 1.0.84)"
5424 #: ../src/guestfs-actions.pod:249
5425 msgid "guestfs_add_drive_with_if"
5429 #: ../src/guestfs-actions.pod:251
5433 " guestfs_add_drive_with_if (guestfs_h *g,\n"
5434 " const char *filename,\n"
5435 " const char *iface);\n"
5440 #: ../src/guestfs-actions.pod:256
5442 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
5443 "QEMU interface emulation to use at run time."
5447 #: ../src/guestfs-actions.pod:270
5448 msgid "guestfs_aug_clear"
5452 #: ../src/guestfs-actions.pod:272
5456 " guestfs_aug_clear (guestfs_h *g,\n"
5457 " const char *augpath);\n"
5462 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
5464 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5465 "L<augtool(1)> C<clear> command."
5469 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2085
5470 msgid "(Added in 1.3.4)"
5474 #: ../src/guestfs-actions.pod:283
5475 msgid "guestfs_aug_close"
5479 #: ../src/guestfs-actions.pod:285
5483 " guestfs_aug_close (guestfs_h *g);\n"
5488 #: ../src/guestfs-actions.pod:288
5490 "Close the current Augeas handle and free up any resources used by it. After "
5491 "calling this, you have to call C<guestfs_aug_init> again before you can use "
5492 "any other Augeas functions."
5496 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:415 ../src/guestfs-actions.pod:435 ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:480 ../src/guestfs-actions.pod:494 ../src/guestfs-actions.pod:508 ../src/guestfs-actions.pod:522 ../src/guestfs-actions.pod:540 ../src/guestfs-actions.pod:5263
5497 msgid "(Added in 0.7)"
5501 #: ../src/guestfs-actions.pod:297
5502 msgid "guestfs_aug_defnode"
5506 #: ../src/guestfs-actions.pod:299
5509 " struct guestfs_int_bool *\n"
5510 " guestfs_aug_defnode (guestfs_h *g,\n"
5511 " const char *name,\n"
5512 " const char *expr,\n"
5513 " const char *val);\n"
5518 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
5519 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5523 #: ../src/guestfs-actions.pod:308
5525 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5526 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
5527 "containing that single node."
5531 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
5533 "On success this returns a pair containing the number of nodes in the "
5534 "nodeset, and a boolean flag if a node was created."
5538 #: ../src/guestfs-actions.pod:316
5540 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
5541 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
5545 #: ../src/guestfs-actions.pod:322
5546 msgid "guestfs_aug_defvar"
5550 #: ../src/guestfs-actions.pod:324
5554 " guestfs_aug_defvar (guestfs_h *g,\n"
5555 " const char *name,\n"
5556 " const char *expr);\n"
5561 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
5563 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5564 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5568 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
5570 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5571 "evaluates to something which is not a nodeset."
5575 #: ../src/guestfs-actions.pod:340
5576 msgid "guestfs_aug_get"
5580 #: ../src/guestfs-actions.pod:342
5584 " guestfs_aug_get (guestfs_h *g,\n"
5585 " const char *augpath);\n"
5590 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
5592 "Look up the value associated with C<path>. If C<path> matches exactly one "
5593 "node, the C<value> is returned."
5597 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:872 ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1051 ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:1217 ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938 ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2322 ../src/guestfs-actions.pod:2529 ../src/guestfs-actions.pod:2610 ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2772 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2827 ../src/guestfs-actions.pod:2889 ../src/guestfs-actions.pod:2912 ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3776 ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4798 ../src/guestfs-actions.pod:4991 ../src/guestfs-actions.pod:5161 ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5951 ../src/guestfs-actions.pod:5967 ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:6008 ../src/guestfs-actions.pod:6682 ../src/guestfs-actions.pod:6701 ../src/guestfs-actions.pod:6719 ../src/guestfs-actions.pod:6899 ../src/guestfs-actions.pod:7171
5599 "This function returns a string, or NULL on error. I<The caller must free "
5600 "the returned string after use>."
5604 #: ../src/guestfs-actions.pod:354
5605 msgid "guestfs_aug_init"
5609 #: ../src/guestfs-actions.pod:356
5613 " guestfs_aug_init (guestfs_h *g,\n"
5614 " const char *root,\n"
5620 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
5622 "Create a new Augeas handle for editing configuration files. If there was "
5623 "any previous Augeas handle associated with this guestfs session, then it is "
5628 #: ../src/guestfs-actions.pod:365
5629 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5633 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
5634 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5638 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
5640 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5641 "logical I<or> of the following integers:"
5645 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
5646 msgid "C<AUG_SAVE_BACKUP> = 1"
5650 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
5651 msgid "Keep the original file with a C<.augsave> extension."
5655 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
5656 msgid "C<AUG_SAVE_NEWFILE> = 2"
5660 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
5662 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5663 "original. Overrides C<AUG_SAVE_BACKUP>."
5667 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
5668 msgid "C<AUG_TYPE_CHECK> = 4"
5672 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
5673 msgid "Typecheck lenses."
5677 #: ../src/guestfs-actions.pod:390
5679 "This option is only useful when debugging Augeas lenses. Use of this option "
5680 "may require additional memory for the libguestfs appliance. You may need to "
5681 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
5682 "C<guestfs_set_memsize>."
5686 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:259
5687 msgid "C<AUG_NO_STDINC> = 8"
5691 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:261
5692 msgid "Do not use standard load path for modules."
5696 #: ../src/guestfs-actions.pod:399 ../fish/guestfish-actions.pod:263
5697 msgid "C<AUG_SAVE_NOOP> = 16"
5701 #: ../src/guestfs-actions.pod:401 ../fish/guestfish-actions.pod:265
5702 msgid "Make save a no-op, just record what would have been changed."
5706 #: ../src/guestfs-actions.pod:403 ../fish/guestfish-actions.pod:267
5707 msgid "C<AUG_NO_LOAD> = 32"
5711 #: ../src/guestfs-actions.pod:405
5712 msgid "Do not load the tree in C<guestfs_aug_init>."
5716 #: ../src/guestfs-actions.pod:409
5717 msgid "To close the handle, you can call C<guestfs_aug_close>."
5721 #: ../src/guestfs-actions.pod:411 ../fish/guestfish-actions.pod:275
5722 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5726 #: ../src/guestfs-actions.pod:417
5727 msgid "guestfs_aug_insert"
5731 #: ../src/guestfs-actions.pod:419
5735 " guestfs_aug_insert (guestfs_h *g,\n"
5736 " const char *augpath,\n"
5737 " const char *label,\n"
5743 #: ../src/guestfs-actions.pod:425 ../fish/guestfish-actions.pod:281
5745 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5746 "or after C<path> (depending on the boolean flag C<before>)."
5750 #: ../src/guestfs-actions.pod:429 ../fish/guestfish-actions.pod:285
5752 "C<path> must match exactly one existing node in the tree, and C<label> must "
5753 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5757 #: ../src/guestfs-actions.pod:437
5758 msgid "guestfs_aug_load"
5762 #: ../src/guestfs-actions.pod:439
5766 " guestfs_aug_load (guestfs_h *g);\n"
5771 #: ../src/guestfs-actions.pod:442 ../fish/guestfish-actions.pod:293
5772 msgid "Load files into the tree."
5776 #: ../src/guestfs-actions.pod:444 ../fish/guestfish-actions.pod:295
5777 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5781 #: ../src/guestfs-actions.pod:451
5782 msgid "guestfs_aug_ls"
5786 #: ../src/guestfs-actions.pod:453
5790 " guestfs_aug_ls (guestfs_h *g,\n"
5791 " const char *augpath);\n"
5796 #: ../src/guestfs-actions.pod:457
5798 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5799 "sorting the resulting nodes into alphabetical order."
5803 #: ../src/guestfs-actions.pod:460 ../src/guestfs-actions.pod:476 ../src/guestfs-actions.pod:622 ../src/guestfs-actions.pod:1070 ../src/guestfs-actions.pod:1361 ../src/guestfs-actions.pod:1380 ../src/guestfs-actions.pod:1483 ../src/guestfs-actions.pod:1502 ../src/guestfs-actions.pod:1748 ../src/guestfs-actions.pod:2180 ../src/guestfs-actions.pod:2196 ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:2375 ../src/guestfs-actions.pod:2424 ../src/guestfs-actions.pod:2635 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:3061 ../src/guestfs-actions.pod:3346 ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:4604 ../src/guestfs-actions.pod:5133 ../src/guestfs-actions.pod:5259 ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:6024 ../src/guestfs-actions.pod:6085 ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6286 ../src/guestfs-actions.pod:6310 ../src/guestfs-actions.pod:6792 ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6859 ../src/guestfs-actions.pod:7024 ../src/guestfs-actions.pod:7043 ../src/guestfs-actions.pod:7128 ../src/guestfs-actions.pod:7147 ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7212
5805 "This function returns a NULL-terminated array of strings (like "
5806 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
5807 "strings and the array after use>."
5811 #: ../src/guestfs-actions.pod:464 ../src/guestfs-actions.pod:995 ../src/guestfs-actions.pod:1013 ../src/guestfs-actions.pod:1418 ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3170 ../src/guestfs-actions.pod:3759 ../src/guestfs-actions.pod:3809 ../src/guestfs-actions.pod:3996 ../src/guestfs-actions.pod:4029 ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4608 ../src/guestfs-actions.pod:5074 ../src/guestfs-actions.pod:5452 ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:5886 ../src/guestfs-actions.pod:6524 ../src/guestfs-actions.pod:6537 ../src/guestfs-actions.pod:6776 ../src/guestfs-actions.pod:7012
5812 msgid "(Added in 0.8)"
5816 #: ../src/guestfs-actions.pod:466
5817 msgid "guestfs_aug_match"
5821 #: ../src/guestfs-actions.pod:468
5825 " guestfs_aug_match (guestfs_h *g,\n"
5826 " const char *augpath);\n"
5831 #: ../src/guestfs-actions.pod:472 ../fish/guestfish-actions.pod:309
5833 "Returns a list of paths which match the path expression C<path>. The "
5834 "returned paths are sufficiently qualified so that they match exactly one "
5835 "node in the current tree."
5839 #: ../src/guestfs-actions.pod:482
5840 msgid "guestfs_aug_mv"
5844 #: ../src/guestfs-actions.pod:484
5848 " guestfs_aug_mv (guestfs_h *g,\n"
5849 " const char *src,\n"
5850 " const char *dest);\n"
5855 #: ../src/guestfs-actions.pod:489 ../fish/guestfish-actions.pod:317
5857 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5858 "C<dest> is overwritten if it exists."
5862 #: ../src/guestfs-actions.pod:496
5863 msgid "guestfs_aug_rm"
5867 #: ../src/guestfs-actions.pod:498
5871 " guestfs_aug_rm (guestfs_h *g,\n"
5872 " const char *augpath);\n"
5877 #: ../src/guestfs-actions.pod:502 ../fish/guestfish-actions.pod:324
5878 msgid "Remove C<path> and all of its children."
5882 #: ../src/guestfs-actions.pod:504 ../fish/guestfish-actions.pod:326
5883 msgid "On success this returns the number of entries which were removed."
5887 #: ../src/guestfs-actions.pod:510
5888 msgid "guestfs_aug_save"
5892 #: ../src/guestfs-actions.pod:512
5896 " guestfs_aug_save (guestfs_h *g);\n"
5901 #: ../src/guestfs-actions.pod:515 ../fish/guestfish-actions.pod:332
5902 msgid "This writes all pending changes to disk."
5906 #: ../src/guestfs-actions.pod:517
5908 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5913 #: ../src/guestfs-actions.pod:524
5914 msgid "guestfs_aug_set"
5918 #: ../src/guestfs-actions.pod:526
5922 " guestfs_aug_set (guestfs_h *g,\n"
5923 " const char *augpath,\n"
5924 " const char *val);\n"
5929 #: ../src/guestfs-actions.pod:531 ../fish/guestfish-actions.pod:341
5930 msgid "Set the value associated with C<path> to C<val>."
5934 #: ../src/guestfs-actions.pod:533
5936 "In the Augeas API, it is possible to clear a node by setting the value to "
5937 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5938 "this call. Instead you must use the C<guestfs_aug_clear> call."
5942 #: ../src/guestfs-actions.pod:542
5943 msgid "guestfs_available"
5947 #: ../src/guestfs-actions.pod:544
5951 " guestfs_available (guestfs_h *g,\n"
5952 " char *const *groups);\n"
5957 #: ../src/guestfs-actions.pod:548 ../fish/guestfish-actions.pod:352
5959 "This command is used to check the availability of some groups of "
5960 "functionality in the appliance, which not all builds of the libguestfs "
5961 "appliance will be able to provide."
5965 #: ../src/guestfs-actions.pod:552
5967 "The libguestfs groups, and the functions that those groups correspond to, "
5968 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5969 "runtime by calling C<guestfs_available_all_groups>."
5973 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
5975 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5976 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5977 "and Augeas (configuration file editing) functions."
5981 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
5982 msgid "The command returns no error if I<all> requested groups are available."
5986 #: ../src/guestfs-actions.pod:564 ../fish/guestfish-actions.pod:368
5988 "It fails with an error if one or more of the requested groups is unavailable "
5993 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:371
5995 "If an unknown group name is included in the list of groups then an error is "
6000 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:374
6005 #: ../src/guestfs-actions.pod:576
6006 msgid "You must call C<guestfs_launch> before calling this function."
6010 #: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:382
6012 "The reason is because we don't know what groups are supported by the "
6013 "appliance/daemon until it is running and can be queried."
6017 #: ../src/guestfs-actions.pod:584 ../fish/guestfish-actions.pod:388
6019 "If a group of functions is available, this does not necessarily mean that "
6020 "they will work. You still have to check for errors when calling individual "
6021 "API functions even if they are available."
6025 #: ../src/guestfs-actions.pod:591 ../fish/guestfish-actions.pod:395
6027 "It is usually the job of distro packagers to build complete functionality "
6028 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6029 "with all requirements satisfied, will support everything."
6033 #: ../src/guestfs-actions.pod:598
6035 "This call was added in version C<1.0.80>. In previous versions of "
6036 "libguestfs all you could do would be to speculatively execute a command to "
6037 "find out if the daemon implemented it. See also C<guestfs_version>."
6041 #: ../src/guestfs-actions.pod:607 ../src/guestfs-actions.pod:1168
6042 msgid "(Added in 1.0.80)"
6046 #: ../src/guestfs-actions.pod:609
6047 msgid "guestfs_available_all_groups"
6051 #: ../src/guestfs-actions.pod:611
6055 " guestfs_available_all_groups (guestfs_h *g);\n"
6060 #: ../src/guestfs-actions.pod:614
6062 "This command returns a list of all optional groups that this daemon knows "
6063 "about. Note this returns both supported and unsupported groups. To find "
6064 "out which ones the daemon can actually support you have to call "
6065 "C<guestfs_available> on each member of the returned list."
6069 #: ../src/guestfs-actions.pod:620
6070 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6074 #: ../src/guestfs-actions.pod:626
6075 msgid "(Added in 1.3.15)"
6079 #: ../src/guestfs-actions.pod:628
6080 msgid "guestfs_base64_in"
6084 #: ../src/guestfs-actions.pod:630
6088 " guestfs_base64_in (guestfs_h *g,\n"
6089 " const char *base64file,\n"
6090 " const char *filename);\n"
6095 #: ../src/guestfs-actions.pod:635 ../fish/guestfish-actions.pod:425
6096 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6100 #: ../src/guestfs-actions.pod:640 ../src/guestfs-actions.pod:654
6101 msgid "(Added in 1.3.5)"
6105 #: ../src/guestfs-actions.pod:642
6106 msgid "guestfs_base64_out"
6110 #: ../src/guestfs-actions.pod:644
6114 " guestfs_base64_out (guestfs_h *g,\n"
6115 " const char *filename,\n"
6116 " const char *base64file);\n"
6121 #: ../src/guestfs-actions.pod:649 ../fish/guestfish-actions.pod:434
6123 "This command downloads the contents of C<filename>, writing it out to local "
6124 "file C<base64file> encoded as base64."
6128 #: ../src/guestfs-actions.pod:656
6129 msgid "guestfs_blockdev_flushbufs"
6133 #: ../src/guestfs-actions.pod:658
6137 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6138 " const char *device);\n"
6143 #: ../src/guestfs-actions.pod:662 ../fish/guestfish-actions.pod:443
6144 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6148 #: ../src/guestfs-actions.pod:665 ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:697 ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:731 ../src/guestfs-actions.pod:750 ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:796 ../src/guestfs-actions.pod:810 ../fish/guestfish-actions.pod:446 ../fish/guestfish-actions.pod:457 ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:476 ../fish/guestfish-actions.pod:488 ../fish/guestfish-actions.pod:501 ../fish/guestfish-actions.pod:509 ../fish/guestfish-actions.pod:520 ../fish/guestfish-actions.pod:528 ../fish/guestfish-actions.pod:536
6149 msgid "This uses the L<blockdev(8)> command."
6153 #: ../src/guestfs-actions.pod:669 ../src/guestfs-actions.pod:686 ../src/guestfs-actions.pod:701 ../src/guestfs-actions.pod:717 ../src/guestfs-actions.pod:735 ../src/guestfs-actions.pod:754 ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:786 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:814
6154 msgid "(Added in 0.9.3)"
6158 #: ../src/guestfs-actions.pod:671
6159 msgid "guestfs_blockdev_getbsz"
6163 #: ../src/guestfs-actions.pod:673
6167 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6168 " const char *device);\n"
6173 #: ../src/guestfs-actions.pod:677 ../fish/guestfish-actions.pod:452
6174 msgid "This returns the block size of a device."
6178 #: ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:779 ../fish/guestfish-actions.pod:454 ../fish/guestfish-actions.pod:517
6180 "(Note this is different from both I<size in blocks> and I<filesystem block "
6185 #: ../src/guestfs-actions.pod:688
6186 msgid "guestfs_blockdev_getro"
6190 #: ../src/guestfs-actions.pod:690
6194 " guestfs_blockdev_getro (guestfs_h *g,\n"
6195 " const char *device);\n"
6200 #: ../src/guestfs-actions.pod:694 ../fish/guestfish-actions.pod:463
6202 "Returns a boolean indicating if the block device is read-only (true if "
6203 "read-only, false if not)."
6207 #: ../src/guestfs-actions.pod:699 ../src/guestfs-actions.pod:1401 ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3107 ../src/guestfs-actions.pod:3121 ../src/guestfs-actions.pod:3137 ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3168 ../src/guestfs-actions.pod:3182 ../src/guestfs-actions.pod:3195 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3239 ../src/guestfs-actions.pod:4762
6208 msgid "This function returns a C truth value on success or -1 on error."
6212 #: ../src/guestfs-actions.pod:703
6213 msgid "guestfs_blockdev_getsize64"
6217 #: ../src/guestfs-actions.pod:705
6221 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6222 " const char *device);\n"
6227 #: ../src/guestfs-actions.pod:709 ../fish/guestfish-actions.pod:472
6228 msgid "This returns the size of the device in bytes."
6232 #: ../src/guestfs-actions.pod:711
6233 msgid "See also C<guestfs_blockdev_getsz>."
6237 #: ../src/guestfs-actions.pod:719
6238 msgid "guestfs_blockdev_getss"
6242 #: ../src/guestfs-actions.pod:721
6246 " guestfs_blockdev_getss (guestfs_h *g,\n"
6247 " const char *device);\n"
6252 #: ../src/guestfs-actions.pod:725 ../fish/guestfish-actions.pod:482
6254 "This returns the size of sectors on a block device. Usually 512, but can be "
6255 "larger for modern devices."
6259 #: ../src/guestfs-actions.pod:728
6261 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6266 #: ../src/guestfs-actions.pod:737
6267 msgid "guestfs_blockdev_getsz"
6271 #: ../src/guestfs-actions.pod:739
6275 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6276 " const char *device);\n"
6281 #: ../src/guestfs-actions.pod:743 ../fish/guestfish-actions.pod:494
6283 "This returns the size of the device in units of 512-byte sectors (even if "
6284 "the sectorsize isn't 512 bytes ... weird)."
6288 #: ../src/guestfs-actions.pod:746
6290 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6291 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6295 #: ../src/guestfs-actions.pod:756
6296 msgid "guestfs_blockdev_rereadpt"
6300 #: ../src/guestfs-actions.pod:758
6304 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6305 " const char *device);\n"
6310 #: ../src/guestfs-actions.pod:762 ../fish/guestfish-actions.pod:507
6311 msgid "Reread the partition table on C<device>."
6315 #: ../src/guestfs-actions.pod:770
6316 msgid "guestfs_blockdev_setbsz"
6320 #: ../src/guestfs-actions.pod:772
6324 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6325 " const char *device,\n"
6326 " int blocksize);\n"
6331 #: ../src/guestfs-actions.pod:777 ../fish/guestfish-actions.pod:515
6332 msgid "This sets the block size of a device."
6336 #: ../src/guestfs-actions.pod:788
6337 msgid "guestfs_blockdev_setro"
6341 #: ../src/guestfs-actions.pod:790
6345 " guestfs_blockdev_setro (guestfs_h *g,\n"
6346 " const char *device);\n"
6351 #: ../src/guestfs-actions.pod:794 ../fish/guestfish-actions.pod:526
6352 msgid "Sets the block device named C<device> to read-only."
6356 #: ../src/guestfs-actions.pod:802
6357 msgid "guestfs_blockdev_setrw"
6361 #: ../src/guestfs-actions.pod:804
6365 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6366 " const char *device);\n"
6371 #: ../src/guestfs-actions.pod:808 ../fish/guestfish-actions.pod:534
6372 msgid "Sets the block device named C<device> to read-write."
6376 #: ../src/guestfs-actions.pod:816
6377 msgid "guestfs_case_sensitive_path"
6381 #: ../src/guestfs-actions.pod:818
6385 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6386 " const char *path);\n"
6391 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
6393 "This can be used to resolve case insensitive paths on a filesystem which is "
6394 "case sensitive. The use case is to resolve paths which you have read from "
6395 "Windows configuration files or the Windows Registry, to the true path."
6399 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
6401 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6402 "(and probably others), which is that although the underlying filesystem is "
6403 "case-insensitive, the driver exports the filesystem to Linux as "
6408 #: ../src/guestfs-actions.pod:832 ../fish/guestfish-actions.pod:552
6410 "One consequence of this is that special directories such as C<c:\\windows> "
6411 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6412 "precise details of how they were created. In Windows itself this would not "
6417 #: ../src/guestfs-actions.pod:838 ../fish/guestfish-actions.pod:558
6419 "Bug or feature? You decide: "
6420 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6424 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:561
6426 "This function resolves the true case of each element in the path and returns "
6427 "the case-sensitive path."
6431 #: ../src/guestfs-actions.pod:844
6433 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
6434 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6435 "how the directories were originally created under Windows)."
6439 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:569
6440 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6444 #: ../src/guestfs-actions.pod:852
6445 msgid "See also C<guestfs_realpath>."
6449 #: ../src/guestfs-actions.pod:857 ../src/guestfs-actions.pod:6704
6450 msgid "(Added in 1.0.75)"
6454 #: ../src/guestfs-actions.pod:859
6459 #: ../src/guestfs-actions.pod:861
6463 " guestfs_cat (guestfs_h *g,\n"
6464 " const char *path);\n"
6469 #: ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:578 ../fish/guestfish-actions.pod:3501
6470 msgid "Return the contents of the file named C<path>."
6474 #: ../src/guestfs-actions.pod:867
6476 "Note that this function cannot correctly handle binary files (specifically, "
6477 "files containing C<\\0> character which is treated as end of string). For "
6478 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
6479 "functions which have a more complex interface."
6483 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1384 ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1506 ../src/guestfs-actions.pod:1752 ../src/guestfs-actions.pod:2200 ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2308 ../src/guestfs-actions.pod:2325 ../src/guestfs-actions.pod:2354 ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5057 ../src/guestfs-actions.pod:5188 ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5238 ../src/guestfs-actions.pod:6089 ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6290 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6976 ../src/guestfs-actions.pod:7002 ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7047 ../src/guestfs-actions.pod:7132 ../src/guestfs-actions.pod:7151 ../src/guestfs-actions.pod:7197 ../src/guestfs-actions.pod:7216 ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:720 ../fish/guestfish-actions.pod:732 ../fish/guestfish-actions.pod:908 ../fish/guestfish-actions.pod:918 ../fish/guestfish-actions.pod:985 ../fish/guestfish-actions.pod:995 ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1482 ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:1542 ../fish/guestfish-actions.pod:1557 ../fish/guestfish-actions.pod:1567 ../fish/guestfish-actions.pod:1586 ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386 ../fish/guestfish-actions.pod:3462 ../fish/guestfish-actions.pod:3479 ../fish/guestfish-actions.pod:3494 ../fish/guestfish-actions.pod:4077 ../fish/guestfish-actions.pod:4123 ../fish/guestfish-actions.pod:4208 ../fish/guestfish-actions.pod:4223 ../fish/guestfish-actions.pod:4633 ../fish/guestfish-actions.pod:4651 ../fish/guestfish-actions.pod:4668 ../fish/guestfish-actions.pod:4678 ../fish/guestfish-actions.pod:4726 ../fish/guestfish-actions.pod:4736 ../fish/guestfish-actions.pod:4765 ../fish/guestfish-actions.pod:4775
6485 "Because of the message protocol, there is a transfer limit of somewhere "
6486 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6490 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3517 ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:3936 ../src/guestfs-actions.pod:5137 ../src/guestfs-actions.pod:5151 ../src/guestfs-actions.pod:6863 ../src/guestfs-actions.pod:6877
6491 msgid "(Added in 0.4)"
6495 #: ../src/guestfs-actions.pod:880
6496 msgid "guestfs_checksum"
6500 #: ../src/guestfs-actions.pod:882
6504 " guestfs_checksum (guestfs_h *g,\n"
6505 " const char *csumtype,\n"
6506 " const char *path);\n"
6511 #: ../src/guestfs-actions.pod:887 ../fish/guestfish-actions.pod:592
6512 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6516 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
6518 "The type of checksum to compute is given by the C<csumtype> parameter which "
6519 "must have one of the following values:"
6523 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
6528 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
6530 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6535 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:605
6540 #: ../src/guestfs-actions.pod:902 ../fish/guestfish-actions.pod:607
6541 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6545 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:609
6550 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:611
6551 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6555 #: ../src/guestfs-actions.pod:908 ../fish/guestfish-actions.pod:613
6560 #: ../src/guestfs-actions.pod:910 ../fish/guestfish-actions.pod:615
6561 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6565 #: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:617
6570 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:619
6571 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6575 #: ../src/guestfs-actions.pod:916 ../fish/guestfish-actions.pod:621
6580 #: ../src/guestfs-actions.pod:918 ../fish/guestfish-actions.pod:623
6581 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6585 #: ../src/guestfs-actions.pod:920 ../fish/guestfish-actions.pod:625
6590 #: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:627
6591 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6595 #: ../src/guestfs-actions.pod:926 ../fish/guestfish-actions.pod:631
6596 msgid "The checksum is returned as a printable string."
6600 #: ../src/guestfs-actions.pod:928
6601 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6605 #: ../src/guestfs-actions.pod:930
6606 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6610 #: ../src/guestfs-actions.pod:935 ../src/guestfs-actions.pod:1243 ../src/guestfs-actions.pod:2062 ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3123 ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:6560
6611 msgid "(Added in 1.0.2)"
6615 #: ../src/guestfs-actions.pod:937
6616 msgid "guestfs_checksum_device"
6620 #: ../src/guestfs-actions.pod:939
6624 " guestfs_checksum_device (guestfs_h *g,\n"
6625 " const char *csumtype,\n"
6626 " const char *device);\n"
6631 #: ../src/guestfs-actions.pod:944
6633 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6634 "device named C<device>. For the types of checksums supported see the "
6635 "C<guestfs_checksum> command."
6639 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:4727 ../src/guestfs-actions.pod:4764 ../src/guestfs-actions.pod:4782 ../src/guestfs-actions.pod:4958 ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:6483 ../src/guestfs-actions.pod:6889
6640 msgid "(Added in 1.3.2)"
6644 #: ../src/guestfs-actions.pod:953
6645 msgid "guestfs_checksums_out"
6649 #: ../src/guestfs-actions.pod:955
6653 " guestfs_checksums_out (guestfs_h *g,\n"
6654 " const char *csumtype,\n"
6655 " const char *directory,\n"
6656 " const char *sumsfile);\n"
6661 #: ../src/guestfs-actions.pod:961 ../fish/guestfish-actions.pod:649
6663 "This command computes the checksums of all regular files in C<directory> and "
6664 "then emits a list of those checksums to the local output file C<sumsfile>."
6668 #: ../src/guestfs-actions.pod:965 ../fish/guestfish-actions.pod:653
6670 "This can be used for verifying the integrity of a virtual machine. However "
6671 "to be properly secure you should pay attention to the output of the checksum "
6672 "command (it uses the ones from GNU coreutils). In particular when the "
6673 "filename is not printable, coreutils uses a special backslash syntax. For "
6674 "more information, see the GNU coreutils info file."
6678 #: ../src/guestfs-actions.pod:975
6679 msgid "(Added in 1.3.7)"
6683 #: ../src/guestfs-actions.pod:977
6684 msgid "guestfs_chmod"
6688 #: ../src/guestfs-actions.pod:979
6692 " guestfs_chmod (guestfs_h *g,\n"
6694 " const char *path);\n"
6699 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:667
6701 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6706 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:670
6708 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6709 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6714 #: ../src/guestfs-actions.pod:991 ../src/guestfs-actions.pod:4173 ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4377 ../src/guestfs-actions.pod:4396 ../fish/guestfish-actions.pod:674 ../fish/guestfish-actions.pod:2819 ../fish/guestfish-actions.pod:2937 ../fish/guestfish-actions.pod:2947 ../fish/guestfish-actions.pod:2957
6715 msgid "The mode actually set is affected by the umask."
6719 #: ../src/guestfs-actions.pod:997
6720 msgid "guestfs_chown"
6724 #: ../src/guestfs-actions.pod:999
6728 " guestfs_chown (guestfs_h *g,\n"
6731 " const char *path);\n"
6736 #: ../src/guestfs-actions.pod:1005 ../fish/guestfish-actions.pod:680
6737 msgid "Change the file owner to C<owner> and group to C<group>."
6741 #: ../src/guestfs-actions.pod:1007 ../src/guestfs-actions.pod:3281 ../fish/guestfish-actions.pod:682 ../fish/guestfish-actions.pod:2277
6743 "Only numeric uid and gid are supported. If you want to use names, you will "
6744 "need to locate and parse the password file yourself (Augeas support makes "
6745 "this relatively easy)."
6749 #: ../src/guestfs-actions.pod:1015
6750 msgid "guestfs_command"
6754 #: ../src/guestfs-actions.pod:1017
6758 " guestfs_command (guestfs_h *g,\n"
6759 " char *const *arguments);\n"
6764 #: ../src/guestfs-actions.pod:1021 ../fish/guestfish-actions.pod:690
6766 "This call runs a command from the guest filesystem. The filesystem must be "
6767 "mounted, and must contain a compatible operating system (ie. something "
6768 "Linux, with the same or compatible processor architecture)."
6772 #: ../src/guestfs-actions.pod:1026
6774 "The single parameter is an argv-style list of arguments. The first element "
6775 "is the name of the program to run. Subsequent elements are parameters. The "
6776 "list must be non-empty (ie. must contain a program name). Note that the "
6777 "command runs directly, and is I<not> invoked via the shell (see "
6782 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:702
6783 msgid "The return value is anything printed to I<stdout> by the command."
6787 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:705
6789 "If the command returns a non-zero exit status, then this function returns an "
6790 "error message. The error message string is the content of I<stderr> from "
6795 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
6797 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6798 "C</bin>. If you require a program from another location, you should provide "
6799 "the full path in the first parameter."
6803 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:714
6805 "Shared libraries and data files required by the program must be available on "
6806 "filesystems which are mounted in the correct places. It is the caller's "
6807 "responsibility to ensure all filesystems that are needed are mounted at the "
6812 #: ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1537
6813 msgid "(Added in 0.9.1)"
6817 #: ../src/guestfs-actions.pod:1059
6818 msgid "guestfs_command_lines"
6822 #: ../src/guestfs-actions.pod:1061
6826 " guestfs_command_lines (guestfs_h *g,\n"
6827 " char *const *arguments);\n"
6832 #: ../src/guestfs-actions.pod:1065
6834 "This is the same as C<guestfs_command>, but splits the result into a list of "
6839 #: ../src/guestfs-actions.pod:1068
6840 msgid "See also: C<guestfs_sh_lines>"
6844 #: ../src/guestfs-actions.pod:1079
6845 msgid "guestfs_config"
6849 #: ../src/guestfs-actions.pod:1081
6853 " guestfs_config (guestfs_h *g,\n"
6854 " const char *qemuparam,\n"
6855 " const char *qemuvalue);\n"
6860 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
6862 "This can be used to add arbitrary qemu command line parameters of the form "
6863 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6864 "setting some parameters which would interfere with parameters that we use."
6868 #: ../src/guestfs-actions.pod:1091 ../fish/guestfish-actions.pod:744
6869 msgid "The first character of C<param> string must be a C<-> (dash)."
6873 #: ../src/guestfs-actions.pod:1093 ../fish/guestfish-actions.pod:746
6874 msgid "C<value> can be NULL."
6878 #: ../src/guestfs-actions.pod:1099
6879 msgid "guestfs_copy_size"
6883 #: ../src/guestfs-actions.pod:1101
6887 " guestfs_copy_size (guestfs_h *g,\n"
6888 " const char *src,\n"
6889 " const char *dest,\n"
6895 #: ../src/guestfs-actions.pod:1107 ../fish/guestfish-actions.pod:752
6897 "This command copies exactly C<size> bytes from one source device or file "
6898 "C<src> to another destination device or file C<dest>."
6902 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:755
6904 "Note this will fail if the source is too short or if the destination is not "
6909 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6589 ../src/guestfs-actions.pod:7068 ../src/guestfs-actions.pod:7087
6911 "This long-running command can generate progress notification messages so "
6912 "that the caller can display a progress bar or indicator. To receive these "
6913 "messages, the caller must register a progress callback. See "
6914 "L<guestfs(3)/guestfs_set_progress_callback>."
6918 #: ../src/guestfs-actions.pod:1120 ../src/guestfs-actions.pod:3949 ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6816 ../src/guestfs-actions.pod:6902
6919 msgid "(Added in 1.0.87)"
6923 #: ../src/guestfs-actions.pod:1122
6928 #: ../src/guestfs-actions.pod:1124
6932 " guestfs_cp (guestfs_h *g,\n"
6933 " const char *src,\n"
6934 " const char *dest);\n"
6939 #: ../src/guestfs-actions.pod:1129 ../fish/guestfish-actions.pod:762
6941 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6942 "destination filename or destination directory."
6946 #: ../src/guestfs-actions.pod:1134 ../src/guestfs-actions.pod:1148 ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1294 ../src/guestfs-actions.pod:1403 ../src/guestfs-actions.pod:4622 ../src/guestfs-actions.pod:5008
6947 msgid "(Added in 1.0.18)"
6951 #: ../src/guestfs-actions.pod:1136
6952 msgid "guestfs_cp_a"
6956 #: ../src/guestfs-actions.pod:1138
6960 " guestfs_cp_a (guestfs_h *g,\n"
6961 " const char *src,\n"
6962 " const char *dest);\n"
6967 #: ../src/guestfs-actions.pod:1143 ../fish/guestfish-actions.pod:769
6969 "This copies a file or directory from C<src> to C<dest> recursively using the "
6974 #: ../src/guestfs-actions.pod:1150
6979 #: ../src/guestfs-actions.pod:1152
6983 " guestfs_dd (guestfs_h *g,\n"
6984 " const char *src,\n"
6985 " const char *dest);\n"
6990 #: ../src/guestfs-actions.pod:1157 ../fish/guestfish-actions.pod:776
6992 "This command copies from one source device or file C<src> to another "
6993 "destination device or file C<dest>. Normally you would use this to copy to "
6994 "or from a device or partition, for example to duplicate a filesystem."
6998 #: ../src/guestfs-actions.pod:1162
7000 "If the destination is a device, it must be as large or larger than the "
7001 "source file or device, otherwise the copy will fail. This command cannot do "
7002 "partial copies (see C<guestfs_copy_size>)."
7006 #: ../src/guestfs-actions.pod:1170
7011 #: ../src/guestfs-actions.pod:1172
7015 " guestfs_df (guestfs_h *g);\n"
7020 #: ../src/guestfs-actions.pod:1175 ../fish/guestfish-actions.pod:789
7021 msgid "This command runs the C<df> command to report disk space used."
7025 #: ../src/guestfs-actions.pod:1177 ../src/guestfs-actions.pod:1194
7027 "This command is mostly useful for interactive sessions. It is I<not> "
7028 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7033 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201 ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:2287 ../src/guestfs-actions.pod:2311 ../src/guestfs-actions.pod:2379 ../src/guestfs-actions.pod:4059 ../src/guestfs-actions.pod:4522 ../src/guestfs-actions.pod:6293 ../src/guestfs-actions.pod:6317 ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6961
7034 msgid "(Added in 1.0.54)"
7038 #: ../src/guestfs-actions.pod:1186
7039 msgid "guestfs_df_h"
7043 #: ../src/guestfs-actions.pod:1188
7047 " guestfs_df_h (guestfs_h *g);\n"
7052 #: ../src/guestfs-actions.pod:1191 ../fish/guestfish-actions.pod:799
7054 "This command runs the C<df -h> command to report disk space used in "
7055 "human-readable format."
7059 #: ../src/guestfs-actions.pod:1203
7060 msgid "guestfs_dmesg"
7064 #: ../src/guestfs-actions.pod:1205
7068 " guestfs_dmesg (guestfs_h *g);\n"
7073 #: ../src/guestfs-actions.pod:1208 ../fish/guestfish-actions.pod:810
7075 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7076 "This is sometimes useful for extended debugging of problems."
7080 #: ../src/guestfs-actions.pod:1212
7082 "Another way to get the same information is to enable verbose messages with "
7083 "C<guestfs_set_verbose> or by setting the environment variable "
7084 "C<LIBGUESTFS_DEBUG=1> before running the program."
7088 #: ../src/guestfs-actions.pod:1222
7089 msgid "guestfs_download"
7093 #: ../src/guestfs-actions.pod:1224
7097 " guestfs_download (guestfs_h *g,\n"
7098 " const char *remotefilename,\n"
7099 " const char *filename);\n"
7104 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1254 ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:836
7106 "Download file C<remotefilename> and save it as C<filename> on the local "
7111 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:826 ../fish/guestfish-actions.pod:4381
7112 msgid "C<filename> can also be a named pipe."
7116 #: ../src/guestfs-actions.pod:1234
7117 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7121 #: ../src/guestfs-actions.pod:1245
7122 msgid "guestfs_download_offset"
7126 #: ../src/guestfs-actions.pod:1247
7130 " guestfs_download_offset (guestfs_h *g,\n"
7131 " const char *remotefilename,\n"
7132 " const char *filename,\n"
7133 " int64_t offset,\n"
7139 #: ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:839
7141 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7142 "region must be within the file or device)."
7146 #: ../src/guestfs-actions.pod:1260
7148 "Note that there is no limit on the amount of data that can be downloaded "
7149 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7150 "full amount unless an error occurs."
7154 #: ../src/guestfs-actions.pod:1265
7155 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7159 #: ../src/guestfs-actions.pod:1274 ../src/guestfs-actions.pod:6594
7160 msgid "(Added in 1.5.17)"
7164 #: ../src/guestfs-actions.pod:1276
7165 msgid "guestfs_drop_caches"
7169 #: ../src/guestfs-actions.pod:1278
7173 " guestfs_drop_caches (guestfs_h *g,\n"
7174 " int whattodrop);\n"
7179 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
7181 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7182 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7183 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7187 #: ../src/guestfs-actions.pod:1287 ../fish/guestfish-actions.pod:860
7188 msgid "Setting C<whattodrop> to 3 should drop everything."
7192 #: ../src/guestfs-actions.pod:1289 ../fish/guestfish-actions.pod:862
7194 "This automatically calls L<sync(2)> before the operation, so that the "
7195 "maximum guest memory is freed."
7199 #: ../src/guestfs-actions.pod:1296
7204 #: ../src/guestfs-actions.pod:1298
7208 " guestfs_du (guestfs_h *g,\n"
7209 " const char *path);\n"
7214 #: ../src/guestfs-actions.pod:1302 ../fish/guestfish-actions.pod:869
7216 "This command runs the C<du -s> command to estimate file space usage for "
7221 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:872
7223 "C<path> can be a file or a directory. If C<path> is a directory then the "
7224 "estimate includes the contents of the directory and all subdirectories "
7229 #: ../src/guestfs-actions.pod:1309 ../fish/guestfish-actions.pod:876
7230 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7234 #: ../src/guestfs-actions.pod:1316
7235 msgid "guestfs_e2fsck_f"
7239 #: ../src/guestfs-actions.pod:1318
7243 " guestfs_e2fsck_f (guestfs_h *g,\n"
7244 " const char *device);\n"
7249 #: ../src/guestfs-actions.pod:1322 ../fish/guestfish-actions.pod:883
7251 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7252 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7257 #: ../src/guestfs-actions.pod:1326
7259 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7260 "Normally you should use C<guestfs_fsck>."
7264 #: ../src/guestfs-actions.pod:1331
7265 msgid "(Added in 1.0.29)"
7269 #: ../src/guestfs-actions.pod:1333
7270 msgid "guestfs_echo_daemon"
7274 #: ../src/guestfs-actions.pod:1335
7278 " guestfs_echo_daemon (guestfs_h *g,\n"
7279 " char *const *words);\n"
7284 #: ../src/guestfs-actions.pod:1339 ../fish/guestfish-actions.pod:894
7286 "This command concatenates the list of C<words> passed with single spaces "
7287 "between them and returns the resulting string."
7291 #: ../src/guestfs-actions.pod:1342 ../fish/guestfish-actions.pod:897
7292 msgid "You can use this command to test the connection through to the daemon."
7296 #: ../src/guestfs-actions.pod:1344
7297 msgid "See also C<guestfs_ping_daemon>."
7301 #: ../src/guestfs-actions.pod:1349 ../src/guestfs-actions.pod:2073 ../src/guestfs-actions.pod:5797
7302 msgid "(Added in 1.0.69)"
7306 #: ../src/guestfs-actions.pod:1351
7307 msgid "guestfs_egrep"
7311 #: ../src/guestfs-actions.pod:1353
7315 " guestfs_egrep (guestfs_h *g,\n"
7316 " const char *regex,\n"
7317 " const char *path);\n"
7322 #: ../src/guestfs-actions.pod:1358 ../fish/guestfish-actions.pod:905
7323 msgid "This calls the external C<egrep> program and returns the matching lines."
7327 #: ../src/guestfs-actions.pod:1368 ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:1444 ../src/guestfs-actions.pod:1490 ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:2203 ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:2413 ../src/guestfs-actions.pod:2428 ../src/guestfs-actions.pod:2474 ../src/guestfs-actions.pod:2496 ../src/guestfs-actions.pod:2509 ../src/guestfs-actions.pod:3442 ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3469 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:4457 ../src/guestfs-actions.pod:5342 ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:6161 ../src/guestfs-actions.pod:6173 ../src/guestfs-actions.pod:6186 ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6234 ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6260 ../src/guestfs-actions.pod:7031 ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7135 ../src/guestfs-actions.pod:7154 ../src/guestfs-actions.pod:7200 ../src/guestfs-actions.pod:7219
7328 msgid "(Added in 1.0.66)"
7332 #: ../src/guestfs-actions.pod:1370
7333 msgid "guestfs_egrepi"
7337 #: ../src/guestfs-actions.pod:1372
7341 " guestfs_egrepi (guestfs_h *g,\n"
7342 " const char *regex,\n"
7343 " const char *path);\n"
7348 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:915
7349 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7353 #: ../src/guestfs-actions.pod:1389
7354 msgid "guestfs_equal"
7358 #: ../src/guestfs-actions.pod:1391
7362 " guestfs_equal (guestfs_h *g,\n"
7363 " const char *file1,\n"
7364 " const char *file2);\n"
7369 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:925
7371 "This compares the two files C<file1> and C<file2> and returns true if their "
7372 "content is exactly equal, or false otherwise."
7376 #: ../src/guestfs-actions.pod:1399 ../fish/guestfish-actions.pod:928
7377 msgid "The external L<cmp(1)> program is used for the comparison."
7381 #: ../src/guestfs-actions.pod:1405
7382 msgid "guestfs_exists"
7386 #: ../src/guestfs-actions.pod:1407
7390 " guestfs_exists (guestfs_h *g,\n"
7391 " const char *path);\n"
7396 #: ../src/guestfs-actions.pod:1411 ../fish/guestfish-actions.pod:934
7398 "This returns C<true> if and only if there is a file, directory (or anything) "
7399 "with the given C<path> name."
7403 #: ../src/guestfs-actions.pod:1414
7404 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7408 #: ../src/guestfs-actions.pod:1420
7409 msgid "guestfs_fallocate"
7413 #: ../src/guestfs-actions.pod:1422
7417 " guestfs_fallocate (guestfs_h *g,\n"
7418 " const char *path,\n"
7424 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:1453 ../fish/guestfish-actions.pod:943 ../fish/guestfish-actions.pod:962
7426 "This command preallocates a file (containing zero bytes) named C<path> of "
7427 "size C<len> bytes. If the file exists already, it is overwritten."
7431 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:947
7433 "Do not confuse this with the guestfish-specific C<alloc> command which "
7434 "allocates a file in the host and attaches it as a device."
7438 #: ../src/guestfs-actions.pod:1437
7440 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
7445 #: ../src/guestfs-actions.pod:1446
7446 msgid "guestfs_fallocate64"
7450 #: ../src/guestfs-actions.pod:1448
7454 " guestfs_fallocate64 (guestfs_h *g,\n"
7455 " const char *path,\n"
7461 #: ../src/guestfs-actions.pod:1457
7463 "Note that this call allocates disk blocks for the file. To create a sparse "
7464 "file use C<guestfs_truncate_size> instead."
7468 #: ../src/guestfs-actions.pod:1460
7470 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
7471 "oversight it only allowed 30 bit lengths to be specified, effectively "
7472 "limiting the maximum size of files created through that call to 1GB."
7476 #: ../src/guestfs-actions.pod:1465 ../fish/guestfish-actions.pod:974
7478 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7479 "commands which create a file in the host and attach it as a device."
7483 #: ../src/guestfs-actions.pod:1471
7484 msgid "(Added in 1.3.17)"
7488 #: ../src/guestfs-actions.pod:1473
7489 msgid "guestfs_fgrep"
7493 #: ../src/guestfs-actions.pod:1475
7497 " guestfs_fgrep (guestfs_h *g,\n"
7498 " const char *pattern,\n"
7499 " const char *path);\n"
7504 #: ../src/guestfs-actions.pod:1480 ../fish/guestfish-actions.pod:982
7505 msgid "This calls the external C<fgrep> program and returns the matching lines."
7509 #: ../src/guestfs-actions.pod:1492
7510 msgid "guestfs_fgrepi"
7514 #: ../src/guestfs-actions.pod:1494
7518 " guestfs_fgrepi (guestfs_h *g,\n"
7519 " const char *pattern,\n"
7520 " const char *path);\n"
7525 #: ../src/guestfs-actions.pod:1499 ../fish/guestfish-actions.pod:992
7526 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7530 #: ../src/guestfs-actions.pod:1511
7531 msgid "guestfs_file"
7535 #: ../src/guestfs-actions.pod:1513
7539 " guestfs_file (guestfs_h *g,\n"
7540 " const char *path);\n"
7545 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1002
7547 "This call uses the standard L<file(1)> command to determine the type or "
7548 "contents of the file."
7552 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1005
7554 "This call will also transparently look inside various types of compressed "
7559 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1008
7561 "The exact command which runs is C<file -zb path>. Note in particular that "
7562 "the filename is not prepended to the output (the C<-b> option)."
7566 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1012
7568 "The output depends on the output of the underlying L<file(1)> command and it "
7569 "can change in future in ways beyond our control. In other words, the output "
7570 "is not guaranteed by the ABI."
7574 #: ../src/guestfs-actions.pod:1531
7576 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
7577 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
7581 #: ../src/guestfs-actions.pod:1539
7582 msgid "guestfs_file_architecture"
7586 #: ../src/guestfs-actions.pod:1541
7590 " guestfs_file_architecture (guestfs_h *g,\n"
7591 " const char *filename);\n"
7596 #: ../src/guestfs-actions.pod:1545 ../fish/guestfish-actions.pod:1023
7598 "This detects the architecture of the binary C<filename>, and returns it if "
7603 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1026
7604 msgid "Currently defined architectures are:"
7608 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7613 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
7615 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7616 "irrespective of the precise processor requirements of the binary."
7620 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
7625 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
7626 msgid "64 bit x86-64."
7630 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
7635 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
7636 msgid "32 bit SPARC."
7640 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
7645 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
7646 msgid "64 bit SPARC V9 and above."
7650 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
7655 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
7656 msgid "Intel Itanium."
7660 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
7665 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
7666 msgid "32 bit Power PC."
7670 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
7675 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1057
7676 msgid "64 bit Power PC."
7680 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
7681 msgid "Libguestfs may return other architecture strings in future."
7685 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1063
7686 msgid "The function works on at least the following types of files:"
7690 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1069
7691 msgid "many types of Un*x and Linux binary"
7695 #: ../src/guestfs-actions.pod:1595 ../fish/guestfish-actions.pod:1073
7696 msgid "many types of Un*x and Linux shared library"
7700 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1077
7701 msgid "Windows Win32 and Win64 binaries"
7705 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
7706 msgid "Windows Win32 and Win64 DLLs"
7710 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
7711 msgid "Win32 binaries and DLLs return C<i386>."
7715 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1085
7716 msgid "Win64 binaries and DLLs return C<x86_64>."
7720 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1089
7721 msgid "Linux kernel modules"
7725 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1093
7726 msgid "Linux new-style initrd images"
7730 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1097
7731 msgid "some non-x86 Linux vmlinuz kernels"
7735 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1101
7736 msgid "What it can't do currently:"
7740 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1107
7741 msgid "static libraries (libfoo.a)"
7745 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1111
7746 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7750 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
7751 msgid "x86 Linux vmlinuz kernels"
7755 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1117
7757 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7758 "compressed code, and are horribly hard to unpack. If you want to find the "
7759 "architecture of a kernel, use the architecture of the associated initrd or "
7760 "kernel module(s) instead."
7764 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1812 ../src/guestfs-actions.pod:1829 ../src/guestfs-actions.pod:2532 ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2639 ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:2709 ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2830 ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:3065 ../src/guestfs-actions.pod:3197
7765 msgid "(Added in 1.5.3)"
7769 #: ../src/guestfs-actions.pod:1651
7770 msgid "guestfs_filesize"
7774 #: ../src/guestfs-actions.pod:1653
7778 " guestfs_filesize (guestfs_h *g,\n"
7779 " const char *file);\n"
7784 #: ../src/guestfs-actions.pod:1657 ../fish/guestfish-actions.pod:1128
7785 msgid "This command returns the size of C<file> in bytes."
7789 #: ../src/guestfs-actions.pod:1659
7791 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7792 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7793 "devices, use C<guestfs_blockdev_getsize64>."
7797 #: ../src/guestfs-actions.pod:1665
7798 msgid "(Added in 1.0.82)"
7802 #: ../src/guestfs-actions.pod:1667
7803 msgid "guestfs_fill"
7807 #: ../src/guestfs-actions.pod:1669
7811 " guestfs_fill (guestfs_h *g,\n"
7814 " const char *path);\n"
7819 #: ../src/guestfs-actions.pod:1675 ../fish/guestfish-actions.pod:1138
7821 "This command creates a new file called C<path>. The initial content of the "
7822 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7827 #: ../src/guestfs-actions.pod:1679
7829 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7830 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7831 "bytes use C<guestfs_fill_pattern>."
7835 #: ../src/guestfs-actions.pod:1691
7836 msgid "(Added in 1.0.79)"
7840 #: ../src/guestfs-actions.pod:1693
7841 msgid "guestfs_fill_pattern"
7845 #: ../src/guestfs-actions.pod:1695
7849 " guestfs_fill_pattern (guestfs_h *g,\n"
7850 " const char *pattern,\n"
7852 " const char *path);\n"
7857 #: ../src/guestfs-actions.pod:1701
7859 "This function is like C<guestfs_fill> except that it creates a new file of "
7860 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7861 "pattern is truncated if necessary to ensure the length of the file is "
7862 "exactly C<len> bytes."
7866 #: ../src/guestfs-actions.pod:1713
7867 msgid "(Added in 1.3.12)"
7871 #: ../src/guestfs-actions.pod:1715
7872 msgid "guestfs_find"
7876 #: ../src/guestfs-actions.pod:1717
7880 " guestfs_find (guestfs_h *g,\n"
7881 " const char *directory);\n"
7886 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
7888 "This command lists out all files and directories, recursively, starting at "
7889 "C<directory>. It is essentially equivalent to running the shell command "
7890 "C<find directory -print> but some post-processing happens on the output, "
7895 #: ../src/guestfs-actions.pod:1726 ../fish/guestfish-actions.pod:1165
7897 "This returns a list of strings I<without any prefix>. Thus if the directory "
7902 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1168
7912 #: ../src/guestfs-actions.pod:1733
7913 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7917 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
7928 #: ../src/guestfs-actions.pod:1741 ../fish/guestfish-actions.pod:1180
7929 msgid "If C<directory> is not a directory, then this command returns an error."
7933 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1183
7934 msgid "The returned list is sorted."
7938 #: ../src/guestfs-actions.pod:1746
7939 msgid "See also C<guestfs_find0>."
7943 #: ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:3886 ../src/guestfs-actions.pod:5426
7944 msgid "(Added in 1.0.27)"
7948 #: ../src/guestfs-actions.pod:1757
7949 msgid "guestfs_find0"
7953 #: ../src/guestfs-actions.pod:1759
7957 " guestfs_find0 (guestfs_h *g,\n"
7958 " const char *directory,\n"
7959 " const char *files);\n"
7964 #: ../src/guestfs-actions.pod:1764 ../fish/guestfish-actions.pod:1194
7966 "This command lists out all files and directories, recursively, starting at "
7967 "C<directory>, placing the resulting list in the external file called "
7972 #: ../src/guestfs-actions.pod:1768
7974 "This command works the same way as C<guestfs_find> with the following "
7979 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1205
7980 msgid "The resulting list is written to an external file."
7984 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
7986 "Items (filenames) in the result are separated by C<\\0> characters. See "
7987 "L<find(1)> option I<-print0>."
7991 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
7992 msgid "This command is not limited in the number of names that it can return."
7996 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1219
7997 msgid "The result list is not sorted."
8001 #: ../src/guestfs-actions.pod:1795
8002 msgid "(Added in 1.0.74)"
8006 #: ../src/guestfs-actions.pod:1797
8007 msgid "guestfs_findfs_label"
8011 #: ../src/guestfs-actions.pod:1799
8015 " guestfs_findfs_label (guestfs_h *g,\n"
8016 " const char *label);\n"
8021 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1229
8023 "This command searches the filesystems and returns the one which has the "
8024 "given label. An error is returned if no such filesystem can be found."
8028 #: ../src/guestfs-actions.pod:1807
8029 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8033 #: ../src/guestfs-actions.pod:1814
8034 msgid "guestfs_findfs_uuid"
8038 #: ../src/guestfs-actions.pod:1816
8042 " guestfs_findfs_uuid (guestfs_h *g,\n"
8043 " const char *uuid);\n"
8048 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
8050 "This command searches the filesystems and returns the one which has the "
8051 "given UUID. An error is returned if no such filesystem can be found."
8055 #: ../src/guestfs-actions.pod:1824
8056 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8060 #: ../src/guestfs-actions.pod:1831
8061 msgid "guestfs_fsck"
8065 #: ../src/guestfs-actions.pod:1833
8069 " guestfs_fsck (guestfs_h *g,\n"
8070 " const char *fstype,\n"
8071 " const char *device);\n"
8076 #: ../src/guestfs-actions.pod:1838 ../fish/guestfish-actions.pod:1249
8078 "This runs the filesystem checker (fsck) on C<device> which should have "
8079 "filesystem type C<fstype>."
8083 #: ../src/guestfs-actions.pod:1841 ../fish/guestfish-actions.pod:1252
8085 "The returned integer is the status. See L<fsck(8)> for the list of status "
8086 "codes from C<fsck>."
8090 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1261
8091 msgid "Multiple status codes can be summed together."
8095 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
8097 "A non-zero return code can mean \"success\", for example if errors have been "
8098 "corrected on the filesystem."
8102 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
8103 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8107 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1275
8108 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8112 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:7073
8113 msgid "(Added in 1.0.16)"
8117 #: ../src/guestfs-actions.pod:1870
8118 msgid "guestfs_get_append"
8122 #: ../src/guestfs-actions.pod:1872
8126 " guestfs_get_append (guestfs_h *g);\n"
8131 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1281
8133 "Return the additional kernel options which are added to the guest kernel "
8138 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1284
8139 msgid "If C<NULL> then no options are added."
8143 #: ../src/guestfs-actions.pod:1880
8145 "This function returns a string which may be NULL. There is no way to return "
8146 "an error from this function. The string is owned by the guest handle and "
8147 "must I<not> be freed."
8151 #: ../src/guestfs-actions.pod:1884 ../src/guestfs-actions.pod:5104 ../src/guestfs-actions.pod:5567 ../src/guestfs-actions.pod:5935 ../src/guestfs-actions.pod:5954 ../src/guestfs-actions.pod:5970 ../src/guestfs-actions.pod:5987 ../src/guestfs-actions.pod:6744 ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:7116
8152 msgid "(Added in 1.0.26)"
8156 #: ../src/guestfs-actions.pod:1886
8157 msgid "guestfs_get_autosync"
8161 #: ../src/guestfs-actions.pod:1888
8165 " guestfs_get_autosync (guestfs_h *g);\n"
8170 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1290
8171 msgid "Get the autosync flag."
8175 #: ../src/guestfs-actions.pod:1897
8176 msgid "guestfs_get_direct"
8180 #: ../src/guestfs-actions.pod:1899
8184 " guestfs_get_direct (guestfs_h *g);\n"
8189 #: ../src/guestfs-actions.pod:1902 ../fish/guestfish-actions.pod:1296
8190 msgid "Return the direct appliance mode flag."
8194 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:5608
8195 msgid "(Added in 1.0.72)"
8199 #: ../src/guestfs-actions.pod:1908
8200 msgid "guestfs_get_e2label"
8204 #: ../src/guestfs-actions.pod:1910
8208 " guestfs_get_e2label (guestfs_h *g,\n"
8209 " const char *device);\n"
8214 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1302
8215 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8219 #: ../src/guestfs-actions.pod:1920
8221 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
8226 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:5626 ../src/guestfs-actions.pod:5645
8227 msgid "(Added in 1.0.15)"
8231 #: ../src/guestfs-actions.pod:1929
8232 msgid "guestfs_get_e2uuid"
8236 #: ../src/guestfs-actions.pod:1931
8240 " guestfs_get_e2uuid (guestfs_h *g,\n"
8241 " const char *device);\n"
8246 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1316
8247 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8251 #: ../src/guestfs-actions.pod:1941
8253 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
8258 #: ../src/guestfs-actions.pod:1950
8259 msgid "guestfs_get_memsize"
8263 #: ../src/guestfs-actions.pod:1952
8267 " guestfs_get_memsize (guestfs_h *g);\n"
8272 #: ../src/guestfs-actions.pod:1955 ../fish/guestfish-actions.pod:1330
8273 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8277 #: ../src/guestfs-actions.pod:1958
8279 "If C<guestfs_set_memsize> was not called on this handle, and if "
8280 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8281 "value for memsize."
8285 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5661 ../src/guestfs-actions.pod:5768 ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388 ../fish/guestfish-actions.pod:3788 ../fish/guestfish-actions.pod:3875
8286 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8290 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:4177 ../src/guestfs-actions.pod:4362 ../src/guestfs-actions.pod:4381 ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4442 ../src/guestfs-actions.pod:5329 ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:5909 ../src/guestfs-actions.pod:6510
8291 msgid "(Added in 1.0.55)"
8295 #: ../src/guestfs-actions.pod:1969
8296 msgid "guestfs_get_network"
8300 #: ../src/guestfs-actions.pod:1971
8304 " guestfs_get_network (guestfs_h *g);\n"
8309 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1344
8310 msgid "This returns the enable network flag."
8314 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:5685
8315 msgid "(Added in 1.5.4)"
8319 #: ../src/guestfs-actions.pod:1980
8320 msgid "guestfs_get_path"
8324 #: ../src/guestfs-actions.pod:1982
8328 " guestfs_get_path (guestfs_h *g);\n"
8333 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
8334 msgid "Return the current search path."
8338 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1352
8340 "This is always non-NULL. If it wasn't set already, then this will return "
8345 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:2019
8347 "This function returns a string, or NULL on error. The string is owned by "
8348 "the guest handle and must I<not> be freed."
8352 #: ../src/guestfs-actions.pod:1995
8353 msgid "guestfs_get_pid"
8357 #: ../src/guestfs-actions.pod:1997
8361 " guestfs_get_pid (guestfs_h *g);\n"
8366 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1361
8368 "Return the process ID of the qemu subprocess. If there is no qemu "
8369 "subprocess, then this will return an error."
8373 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1364
8374 msgid "This is an internal call used for debugging and testing."
8378 #: ../src/guestfs-actions.pod:2007
8379 msgid "(Added in 1.0.56)"
8383 #: ../src/guestfs-actions.pod:2009
8384 msgid "guestfs_get_qemu"
8388 #: ../src/guestfs-actions.pod:2011
8392 " guestfs_get_qemu (guestfs_h *g);\n"
8397 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
8398 msgid "Return the current qemu binary."
8402 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
8404 "This is always non-NULL. If it wasn't set already, then this will return "
8405 "the default qemu binary name."
8409 #: ../src/guestfs-actions.pod:2022 ../src/guestfs-actions.pod:5730
8410 msgid "(Added in 1.0.6)"
8414 #: ../src/guestfs-actions.pod:2024
8415 msgid "guestfs_get_recovery_proc"
8419 #: ../src/guestfs-actions.pod:2026
8423 " guestfs_get_recovery_proc (guestfs_h *g);\n"
8428 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1379
8429 msgid "Return the recovery process enabled flag."
8433 #: ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:3287 ../src/guestfs-actions.pod:3584 ../src/guestfs-actions.pod:3984 ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5377 ../src/guestfs-actions.pod:5754 ../src/guestfs-actions.pod:6413 ../src/guestfs-actions.pod:6433 ../src/guestfs-actions.pod:6625
8434 msgid "(Added in 1.0.77)"
8438 #: ../src/guestfs-actions.pod:2035
8439 msgid "guestfs_get_selinux"
8443 #: ../src/guestfs-actions.pod:2037
8447 " guestfs_get_selinux (guestfs_h *g);\n"
8452 #: ../src/guestfs-actions.pod:2040
8454 "This returns the current setting of the selinux flag which is passed to the "
8455 "appliance at boot time. See C<guestfs_set_selinux>."
8459 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2111 ../src/guestfs-actions.pod:5773 ../src/guestfs-actions.pod:5827
8460 msgid "(Added in 1.0.67)"
8464 #: ../src/guestfs-actions.pod:2050
8465 msgid "guestfs_get_state"
8469 #: ../src/guestfs-actions.pod:2052
8473 " guestfs_get_state (guestfs_h *g);\n"
8478 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1395
8480 "This returns the current state as an opaque integer. This is only useful "
8481 "for printing debug and internal error messages."
8485 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:3090 ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3180 ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:2159 ../fish/guestfish-actions.pod:2177 ../fish/guestfish-actions.pod:2215 ../fish/guestfish-actions.pod:2231
8486 msgid "For more information on states, see L<guestfs(3)>."
8490 #: ../src/guestfs-actions.pod:2064
8491 msgid "guestfs_get_trace"
8495 #: ../src/guestfs-actions.pod:2066
8499 " guestfs_get_trace (guestfs_h *g);\n"
8504 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1404
8505 msgid "Return the command trace flag."
8509 #: ../src/guestfs-actions.pod:2075
8510 msgid "guestfs_get_umask"
8514 #: ../src/guestfs-actions.pod:2077
8518 " guestfs_get_umask (guestfs_h *g);\n"
8523 #: ../src/guestfs-actions.pod:2080
8525 "Return the current umask. By default the umask is C<022> unless it has been "
8526 "set by calling C<guestfs_umask>."
8530 #: ../src/guestfs-actions.pod:2087
8531 msgid "guestfs_get_verbose"
8535 #: ../src/guestfs-actions.pod:2089
8539 " guestfs_get_verbose (guestfs_h *g);\n"
8544 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
8545 msgid "This returns the verbose messages flag."
8549 #: ../src/guestfs-actions.pod:2098
8550 msgid "guestfs_getcon"
8554 #: ../src/guestfs-actions.pod:2100
8558 " guestfs_getcon (guestfs_h *g);\n"
8563 #: ../src/guestfs-actions.pod:2103 ../fish/guestfish-actions.pod:1423
8564 msgid "This gets the SELinux security context of the daemon."
8568 #: ../src/guestfs-actions.pod:2105
8569 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8573 #: ../src/guestfs-actions.pod:2113
8574 msgid "guestfs_getxattr"
8578 #: ../src/guestfs-actions.pod:2115
8582 " guestfs_getxattr (guestfs_h *g,\n"
8583 " const char *path,\n"
8584 " const char *name,\n"
8585 " size_t *size_r);\n"
8590 #: ../src/guestfs-actions.pod:2121
8592 "Get a single extended attribute from file C<path> named C<name>. This call "
8593 "follows symlinks. If you want to lookup an extended attribute for the "
8594 "symlink itself, use C<guestfs_lgetxattr>."
8598 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3301
8600 "Normally it is better to get all extended attributes from a file in one go "
8601 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
8602 "implementations are buggy and do not provide a way to list out attributes. "
8603 "For these filesystems (notably ntfs-3g) you have to know the names of the "
8604 "extended attributes you want in advance and call this function."
8608 #: ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:3308 ../fish/guestfish-actions.pod:1443 ../fish/guestfish-actions.pod:2296
8610 "Extended attribute values are blobs of binary data. If there is no extended "
8611 "attribute named C<name>, this returns an error."
8615 #: ../src/guestfs-actions.pod:2135
8616 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
8620 #: ../src/guestfs-actions.pod:2137 ../src/guestfs-actions.pod:2350 ../src/guestfs-actions.pod:3313 ../src/guestfs-actions.pod:5027 ../src/guestfs-actions.pod:5053 ../src/guestfs-actions.pod:5234
8622 "This function returns a buffer, or NULL on error. The size of the returned "
8623 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8628 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3317
8629 msgid "(Added in 1.7.24)"
8633 #: ../src/guestfs-actions.pod:2143
8634 msgid "guestfs_getxattrs"
8638 #: ../src/guestfs-actions.pod:2145
8641 " struct guestfs_xattr_list *\n"
8642 " guestfs_getxattrs (guestfs_h *g,\n"
8643 " const char *path);\n"
8648 #: ../src/guestfs-actions.pod:2149 ../fish/guestfish-actions.pod:1452
8649 msgid "This call lists the extended attributes of the file or directory C<path>."
8653 #: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1455
8655 "At the system call level, this is a combination of the L<listxattr(2)> and "
8656 "L<getxattr(2)> calls."
8660 #: ../src/guestfs-actions.pod:2155
8661 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8665 #: ../src/guestfs-actions.pod:2157 ../src/guestfs-actions.pod:3329 ../src/guestfs-actions.pod:3980
8667 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8668 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8672 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:3333 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3534 ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:5846 ../src/guestfs-actions.pod:7181
8673 msgid "(Added in 1.0.59)"
8677 #: ../src/guestfs-actions.pod:2163
8678 msgid "guestfs_glob_expand"
8682 #: ../src/guestfs-actions.pod:2165
8686 " guestfs_glob_expand (guestfs_h *g,\n"
8687 " const char *pattern);\n"
8692 #: ../src/guestfs-actions.pod:2169 ../fish/guestfish-actions.pod:1464
8694 "This command searches for all the pathnames matching C<pattern> according to "
8695 "the wildcard expansion rules used by the shell."
8699 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1468
8700 msgid "If no paths match, then this returns an empty list (note: not an error)."
8704 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1471
8706 "It is just a wrapper around the C L<glob(3)> function with flags "
8707 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8711 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:6011 ../src/guestfs-actions.pod:6028
8712 msgid "(Added in 1.0.50)"
8716 #: ../src/guestfs-actions.pod:2186
8717 msgid "guestfs_grep"
8721 #: ../src/guestfs-actions.pod:2188
8725 " guestfs_grep (guestfs_h *g,\n"
8726 " const char *regex,\n"
8727 " const char *path);\n"
8732 #: ../src/guestfs-actions.pod:2193 ../fish/guestfish-actions.pod:1479
8733 msgid "This calls the external C<grep> program and returns the matching lines."
8737 #: ../src/guestfs-actions.pod:2205
8738 msgid "guestfs_grepi"
8742 #: ../src/guestfs-actions.pod:2207
8746 " guestfs_grepi (guestfs_h *g,\n"
8747 " const char *regex,\n"
8748 " const char *path);\n"
8753 #: ../src/guestfs-actions.pod:2212 ../fish/guestfish-actions.pod:1489
8754 msgid "This calls the external C<grep -i> program and returns the matching lines."
8758 #: ../src/guestfs-actions.pod:2224
8759 msgid "guestfs_grub_install"
8763 #: ../src/guestfs-actions.pod:2226
8767 " guestfs_grub_install (guestfs_h *g,\n"
8768 " const char *root,\n"
8769 " const char *device);\n"
8774 #: ../src/guestfs-actions.pod:2231 ../fish/guestfish-actions.pod:1499
8776 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
8777 "with the root directory being C<root>."
8781 #: ../src/guestfs-actions.pod:2240 ../fish/guestfish-actions.pod:1508
8783 "There is currently no way in the API to install grub2, which is used by most "
8784 "modern Linux guests. It is possible to run the grub2 command from the "
8785 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
8789 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1515
8791 "This uses C<grub-install> from the host. Unfortunately grub is not always "
8792 "compatible with itself, so this only works in rather narrow circumstances. "
8793 "Careful testing with each guest version is advisable."
8797 #: ../src/guestfs-actions.pod:2254 ../fish/guestfish-actions.pod:1522
8799 "If grub-install reports the error \"No suitable drive was found in the "
8800 "generated device map.\" it may be that you need to create a "
8801 "C</boot/grub/device.map> file first that contains the mapping between grub "
8802 "device names and Linux device names. It is usually sufficient to create a "
8807 #: ../src/guestfs-actions.pod:2261 ../fish/guestfish-actions.pod:1529
8815 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1531
8816 msgid "replacing C</dev/vda> with the name of the installation device."
8820 #: ../src/guestfs-actions.pod:2269
8821 msgid "(Added in 1.0.17)"
8825 #: ../src/guestfs-actions.pod:2271
8826 msgid "guestfs_head"
8830 #: ../src/guestfs-actions.pod:2273
8834 " guestfs_head (guestfs_h *g,\n"
8835 " const char *path);\n"
8840 #: ../src/guestfs-actions.pod:2277 ../fish/guestfish-actions.pod:1539
8842 "This command returns up to the first 10 lines of a file as a list of "
8847 #: ../src/guestfs-actions.pod:2289
8848 msgid "guestfs_head_n"
8852 #: ../src/guestfs-actions.pod:2291
8856 " guestfs_head_n (guestfs_h *g,\n"
8858 " const char *path);\n"
8863 #: ../src/guestfs-actions.pod:2296 ../fish/guestfish-actions.pod:1549
8865 "If the parameter C<nrlines> is a positive number, this returns the first "
8866 "C<nrlines> lines of the file C<path>."
8870 #: ../src/guestfs-actions.pod:2299 ../fish/guestfish-actions.pod:1552
8872 "If the parameter C<nrlines> is a negative number, this returns lines from "
8873 "the file C<path>, excluding the last C<nrlines> lines."
8877 #: ../src/guestfs-actions.pod:2302 ../src/guestfs-actions.pod:6308 ../fish/guestfish-actions.pod:1555 ../fish/guestfish-actions.pod:4221
8878 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8882 #: ../src/guestfs-actions.pod:2313
8883 msgid "guestfs_hexdump"
8887 #: ../src/guestfs-actions.pod:2315
8891 " guestfs_hexdump (guestfs_h *g,\n"
8892 " const char *path);\n"
8897 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1564
8899 "This runs C<hexdump -C> on the given C<path>. The result is the "
8900 "human-readable, canonical hex dump of the file."
8904 #: ../src/guestfs-actions.pod:2328 ../src/guestfs-actions.pod:6092 ../src/guestfs-actions.pod:6147
8905 msgid "(Added in 1.0.22)"
8909 #: ../src/guestfs-actions.pod:2330
8910 msgid "guestfs_initrd_cat"
8914 #: ../src/guestfs-actions.pod:2332
8918 " guestfs_initrd_cat (guestfs_h *g,\n"
8919 " const char *initrdpath,\n"
8920 " const char *filename,\n"
8921 " size_t *size_r);\n"
8926 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1574
8928 "This command unpacks the file C<filename> from the initrd file called "
8929 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8934 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1578
8936 "For example, in guestfish you could use the following command to examine the "
8937 "boot script (usually called C</init>) contained in a Linux initrd or "
8942 #: ../src/guestfs-actions.pod:2346 ../fish/guestfish-actions.pod:1582
8945 " initrd-cat /boot/initrd-<version>.img init\n"
8950 #: ../src/guestfs-actions.pod:2348
8951 msgid "See also C<guestfs_initrd_list>."
8955 #: ../src/guestfs-actions.pod:2359
8956 msgid "guestfs_initrd_list"
8960 #: ../src/guestfs-actions.pod:2361
8964 " guestfs_initrd_list (guestfs_h *g,\n"
8965 " const char *path);\n"
8970 #: ../src/guestfs-actions.pod:2365 ../fish/guestfish-actions.pod:1593
8971 msgid "This command lists out files contained in an initrd."
8975 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1595
8977 "The files are listed without any initial C</> character. The files are "
8978 "listed in the order they appear (not necessarily alphabetical). Directory "
8979 "names are listed as separate items."
8983 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1599
8985 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8986 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8991 #: ../src/guestfs-actions.pod:2381
8992 msgid "guestfs_inotify_add_watch"
8996 #: ../src/guestfs-actions.pod:2383
9000 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9001 " const char *path,\n"
9007 #: ../src/guestfs-actions.pod:2388 ../fish/guestfish-actions.pod:1607
9008 msgid "Watch C<path> for the events listed in C<mask>."
9012 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1609
9014 "Note that if C<path> is a directory then events within that directory are "
9015 "watched, but this does I<not> happen recursively (in subdirectories)."
9019 #: ../src/guestfs-actions.pod:2394 ../fish/guestfish-actions.pod:1613
9021 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9022 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9026 #: ../src/guestfs-actions.pod:2402
9027 msgid "guestfs_inotify_close"
9031 #: ../src/guestfs-actions.pod:2404
9035 " guestfs_inotify_close (guestfs_h *g);\n"
9040 #: ../src/guestfs-actions.pod:2407 ../fish/guestfish-actions.pod:1621
9042 "This closes the inotify handle which was previously opened by inotify_init. "
9043 "It removes all watches, throws away any pending events, and deallocates all "
9048 #: ../src/guestfs-actions.pod:2415
9049 msgid "guestfs_inotify_files"
9053 #: ../src/guestfs-actions.pod:2417
9057 " guestfs_inotify_files (guestfs_h *g);\n"
9062 #: ../src/guestfs-actions.pod:2420
9064 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9065 "returns a list of pathnames of objects that were touched. The returned "
9066 "pathnames are sorted and deduplicated."
9070 #: ../src/guestfs-actions.pod:2430
9071 msgid "guestfs_inotify_init"
9075 #: ../src/guestfs-actions.pod:2432
9079 " guestfs_inotify_init (guestfs_h *g,\n"
9080 " int maxevents);\n"
9085 #: ../src/guestfs-actions.pod:2436 ../fish/guestfish-actions.pod:1637
9087 "This command creates a new inotify handle. The inotify subsystem can be "
9088 "used to notify events which happen to objects in the guest filesystem."
9092 #: ../src/guestfs-actions.pod:2440
9094 "C<maxevents> is the maximum number of events which will be queued up between "
9095 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9096 "passed as C<0>, then the kernel (or previously set) default is used. For "
9097 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9098 "throws away events, but records the fact that it threw them away by setting "
9099 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9100 "C<guestfs_inotify_read>)."
9104 #: ../src/guestfs-actions.pod:2450
9106 "Before any events are generated, you have to add some watches to the "
9107 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9108 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9112 #: ../src/guestfs-actions.pod:2456
9114 "Queued up events should be read periodically by calling "
9115 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9116 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9117 "often enough then you risk the internal queue overflowing."
9121 #: ../src/guestfs-actions.pod:2463
9123 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9124 "This also removes any watches automatically."
9128 #: ../src/guestfs-actions.pod:2467 ../fish/guestfish-actions.pod:1668
9130 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9131 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9132 "that there is one global inotify handle per libguestfs instance."
9136 #: ../src/guestfs-actions.pod:2476
9137 msgid "guestfs_inotify_read"
9141 #: ../src/guestfs-actions.pod:2478
9144 " struct guestfs_inotify_event_list *\n"
9145 " guestfs_inotify_read (guestfs_h *g);\n"
9150 #: ../src/guestfs-actions.pod:2481 ../fish/guestfish-actions.pod:1677
9152 "Return the complete queue of events that have happened since the previous "
9157 #: ../src/guestfs-actions.pod:2484 ../fish/guestfish-actions.pod:1680
9158 msgid "If no events have happened, this returns an empty list."
9162 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1682
9164 "I<Note>: In order to make sure that all events have been read, you must call "
9165 "this function repeatedly until it returns an empty list. The reason is that "
9166 "the call will read events up to the maximum appliance-to-host message size "
9167 "and leave remaining events in the queue."
9171 #: ../src/guestfs-actions.pod:2492
9173 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9174 "there was an error. I<The caller must call "
9175 "C<guestfs_free_inotify_event_list> after use>."
9179 #: ../src/guestfs-actions.pod:2498
9180 msgid "guestfs_inotify_rm_watch"
9184 #: ../src/guestfs-actions.pod:2500
9188 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9194 #: ../src/guestfs-actions.pod:2504
9196 "Remove a previously defined inotify watch. See "
9197 "C<guestfs_inotify_add_watch>."
9201 #: ../src/guestfs-actions.pod:2511
9202 msgid "guestfs_inspect_get_arch"
9206 #: ../src/guestfs-actions.pod:2513
9210 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9211 " const char *root);\n"
9216 #: ../src/guestfs-actions.pod:2517 ../src/guestfs-actions.pod:2540 ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2647 ../src/guestfs-actions.pod:2669 ../src/guestfs-actions.pod:2696 ../src/guestfs-actions.pod:2717 ../src/guestfs-actions.pod:2754 ../src/guestfs-actions.pod:2783 ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:2858 ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2923
9218 "This function should only be called with a root device string as returned by "
9219 "C<guestfs_inspect_os>."
9223 #: ../src/guestfs-actions.pod:2520
9225 "This returns the architecture of the inspected operating system. The "
9226 "possible return values are listed under C<guestfs_file_architecture>."
9230 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1706
9232 "If the architecture could not be determined, then the string C<unknown> is "
9237 #: ../src/guestfs-actions.pod:2527 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:2825 ../src/guestfs-actions.pod:2844 ../src/guestfs-actions.pod:2887 ../src/guestfs-actions.pod:2910 ../src/guestfs-actions.pod:3016 ../src/guestfs-actions.pod:3057 ../fish/guestfish-actions.pod:1709 ../fish/guestfish-actions.pod:1783 ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1837 ../fish/guestfish-actions.pod:1901 ../fish/guestfish-actions.pod:1925 ../fish/guestfish-actions.pod:1942 ../fish/guestfish-actions.pod:1955 ../fish/guestfish-actions.pod:1990 ../fish/guestfish-actions.pod:2006 ../fish/guestfish-actions.pod:2105 ../fish/guestfish-actions.pod:2139
9238 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9242 #: ../src/guestfs-actions.pod:2534
9243 msgid "guestfs_inspect_get_distro"
9247 #: ../src/guestfs-actions.pod:2536
9251 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9252 " const char *root);\n"
9257 #: ../src/guestfs-actions.pod:2543 ../fish/guestfish-actions.pod:1718
9258 msgid "This returns the distro (distribution) of the inspected operating system."
9262 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1721
9263 msgid "Currently defined distros are:"
9267 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1725
9268 msgid "\"archlinux\""
9272 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1727
9277 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1729
9282 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1731
9287 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1733
9292 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1735
9297 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1737
9302 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1739
9307 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1741
9308 msgid "\"linuxmint\""
9312 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1743
9317 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1745
9318 msgid "\"mandriva\""
9322 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1747
9327 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1749
9332 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1751
9337 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1753
9342 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1755
9347 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1757
9348 msgid "\"redhat-based\""
9352 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1759
9353 msgid "Some Red Hat-derived distro."
9357 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1761
9362 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1763
9363 msgid "Red Hat Enterprise Linux and some derivatives."
9367 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1765
9372 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1767
9377 #: ../src/guestfs-actions.pod:2594 ../src/guestfs-actions.pod:2878 ../fish/guestfish-actions.pod:1769 ../fish/guestfish-actions.pod:1981
9382 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1771
9383 msgid "The distro could not be determined."
9387 #: ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:1773 ../fish/guestfish-actions.pod:1973
9392 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1775
9394 "Windows does not have distributions. This string is returned if the OS type "
9399 #: ../src/guestfs-actions.pod:2605 ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1987
9401 "Future versions of libguestfs may return other strings here. The caller "
9402 "should be prepared to handle any string."
9406 #: ../src/guestfs-actions.pod:2615
9407 msgid "guestfs_inspect_get_filesystems"
9411 #: ../src/guestfs-actions.pod:2617
9415 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9416 " const char *root);\n"
9421 #: ../src/guestfs-actions.pod:2624 ../fish/guestfish-actions.pod:1792
9423 "This returns a list of all the filesystems that we think are associated with "
9424 "this operating system. This includes the root filesystem, other ordinary "
9425 "filesystems, and non-mounted devices like swap partitions."
9429 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1797
9431 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9432 "to be shared between operating systems."
9436 #: ../src/guestfs-actions.pod:2632
9438 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9439 "C<guestfs_inspect_get_mountpoints>."
9443 #: ../src/guestfs-actions.pod:2641
9444 msgid "guestfs_inspect_get_hostname"
9448 #: ../src/guestfs-actions.pod:2643
9452 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
9453 " const char *root);\n"
9458 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1810
9460 "This function returns the hostname of the operating system as found by "
9461 "inspection of the guest's configuration files."
9465 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1813
9467 "If the hostname could not be determined, then the string C<unknown> is "
9472 #: ../src/guestfs-actions.pod:2661
9473 msgid "(Added in 1.7.9)"
9477 #: ../src/guestfs-actions.pod:2663
9478 msgid "guestfs_inspect_get_major_version"
9482 #: ../src/guestfs-actions.pod:2665
9486 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
9487 " const char *root);\n"
9492 #: ../src/guestfs-actions.pod:2672 ../fish/guestfish-actions.pod:1825
9493 msgid "This returns the major version number of the inspected operating system."
9497 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1828
9499 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9500 "popular public names used by the operating system. Notably the operating "
9501 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9502 "1). You can find out the real versions corresponding to releases of Windows "
9503 "by consulting Wikipedia or MSDN."
9507 #: ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1835 ../fish/guestfish-actions.pod:1849
9508 msgid "If the version could not be determined, then C<0> is returned."
9512 #: ../src/guestfs-actions.pod:2690
9513 msgid "guestfs_inspect_get_minor_version"
9517 #: ../src/guestfs-actions.pod:2692
9521 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9522 " const char *root);\n"
9527 #: ../src/guestfs-actions.pod:2699 ../fish/guestfish-actions.pod:1846
9528 msgid "This returns the minor version number of the inspected operating system."
9532 #: ../src/guestfs-actions.pod:2704
9534 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9535 "C<guestfs_inspect_get_major_version>."
9539 #: ../src/guestfs-actions.pod:2711
9540 msgid "guestfs_inspect_get_mountpoints"
9544 #: ../src/guestfs-actions.pod:2713
9548 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9549 " const char *root);\n"
9554 #: ../src/guestfs-actions.pod:2720 ../fish/guestfish-actions.pod:1861
9556 "This returns a hash of where we think the filesystems associated with this "
9557 "operating system should be mounted. Callers should note that this is at "
9558 "best an educated guess made by reading configuration files such as "
9559 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
9560 "are non-existent or not mountable and callers should be prepared to handle "
9561 "or ignore failures if they try to mount them."
9565 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1870
9567 "Each element in the returned hashtable has a key which is the path of the "
9568 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9569 "mounted there (eg. C</dev/sda1>)."
9573 #: ../src/guestfs-actions.pod:2734 ../fish/guestfish-actions.pod:1875
9574 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9578 #: ../src/guestfs-actions.pod:2737
9580 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9581 "C<guestfs_inspect_get_filesystems>."
9585 #: ../src/guestfs-actions.pod:2740 ../src/guestfs-actions.pod:3386 ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:6449
9587 "This function returns a NULL-terminated array of strings, or NULL if there "
9588 "was an error. The array of strings will always have length C<2n+1>, where "
9589 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9590 "caller must free the strings and the array after use>."
9594 #: ../src/guestfs-actions.pod:2748
9595 msgid "guestfs_inspect_get_package_format"
9599 #: ../src/guestfs-actions.pod:2750
9603 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9604 " const char *root);\n"
9609 #: ../src/guestfs-actions.pod:2757
9611 "This function and C<guestfs_inspect_get_package_management> return the "
9612 "package format and package management tool used by the inspected operating "
9613 "system. For example for Fedora these functions would return C<rpm> (package "
9614 "format) and C<yum> (package management)."
9618 #: ../src/guestfs-actions.pod:2763 ../fish/guestfish-actions.pod:1894
9620 "This returns the string C<unknown> if we could not determine the package "
9621 "format I<or> if the operating system does not have a real packaging system "
9626 #: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1898
9628 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9629 "Future versions of libguestfs may return other strings."
9633 #: ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2806
9634 msgid "(Added in 1.7.5)"
9638 #: ../src/guestfs-actions.pod:2777
9639 msgid "guestfs_inspect_get_package_management"
9643 #: ../src/guestfs-actions.pod:2779
9647 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9648 " const char *root);\n"
9653 #: ../src/guestfs-actions.pod:2786
9655 "C<guestfs_inspect_get_package_format> and this function return the package "
9656 "format and package management tool used by the inspected operating system. "
9657 "For example for Fedora these functions would return C<rpm> (package format) "
9658 "and C<yum> (package management)."
9662 #: ../src/guestfs-actions.pod:2792 ../fish/guestfish-actions.pod:1916
9664 "This returns the string C<unknown> if we could not determine the package "
9665 "management tool I<or> if the operating system does not have a real packaging "
9666 "system (eg. Windows)."
9670 #: ../src/guestfs-actions.pod:2796 ../fish/guestfish-actions.pod:1920
9672 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9673 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9674 "libguestfs may return other strings."
9678 #: ../src/guestfs-actions.pod:2808
9679 msgid "guestfs_inspect_get_product_name"
9683 #: ../src/guestfs-actions.pod:2810
9687 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9688 " const char *root);\n"
9693 #: ../src/guestfs-actions.pod:2817 ../fish/guestfish-actions.pod:1934
9695 "This returns the product name of the inspected operating system. The "
9696 "product name is generally some freeform string which can be displayed to the "
9697 "user, but should not be parsed by programs."
9701 #: ../src/guestfs-actions.pod:2822 ../fish/guestfish-actions.pod:1939
9703 "If the product name could not be determined, then the string C<unknown> is "
9708 #: ../src/guestfs-actions.pod:2832
9709 msgid "guestfs_inspect_get_roots"
9713 #: ../src/guestfs-actions.pod:2834
9717 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9722 #: ../src/guestfs-actions.pod:2837
9724 "This function is a convenient way to get the list of root devices, as "
9725 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9726 "the whole inspection process."
9730 #: ../src/guestfs-actions.pod:2841
9732 "This returns an empty list if either no root devices were found or the "
9733 "caller has not called C<guestfs_inspect_os>."
9737 #: ../src/guestfs-actions.pod:2850
9738 msgid "(Added in 1.7.3)"
9742 #: ../src/guestfs-actions.pod:2852
9743 msgid "guestfs_inspect_get_type"
9747 #: ../src/guestfs-actions.pod:2854
9751 " guestfs_inspect_get_type (guestfs_h *g,\n"
9752 " const char *root);\n"
9757 #: ../src/guestfs-actions.pod:2861 ../fish/guestfish-actions.pod:1964
9759 "This returns the type of the inspected operating system. Currently defined "
9764 #: ../src/guestfs-actions.pod:2866 ../fish/guestfish-actions.pod:1969
9769 #: ../src/guestfs-actions.pod:2868 ../fish/guestfish-actions.pod:1971
9770 msgid "Any Linux-based operating system."
9774 #: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:1975
9775 msgid "Any Microsoft Windows operating system."
9779 #: ../src/guestfs-actions.pod:2874 ../fish/guestfish-actions.pod:1977
9784 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1979
9789 #: ../src/guestfs-actions.pod:2880 ../fish/guestfish-actions.pod:1983
9790 msgid "The operating system type could not be determined."
9794 #: ../src/guestfs-actions.pod:2894
9795 msgid "guestfs_inspect_get_windows_systemroot"
9799 #: ../src/guestfs-actions.pod:2896
9803 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9804 " const char *root);\n"
9809 #: ../src/guestfs-actions.pod:2903 ../fish/guestfish-actions.pod:1999
9811 "This returns the Windows systemroot of the inspected guest. The systemroot "
9812 "is a directory path such as C</WINDOWS>."
9816 #: ../src/guestfs-actions.pod:2906 ../fish/guestfish-actions.pod:2002
9818 "This call assumes that the guest is Windows and that the systemroot could be "
9819 "determined by inspection. If this is not the case then an error is "
9824 #: ../src/guestfs-actions.pod:2915
9825 msgid "(Added in 1.5.25)"
9829 #: ../src/guestfs-actions.pod:2917
9830 msgid "guestfs_inspect_list_applications"
9834 #: ../src/guestfs-actions.pod:2919
9837 " struct guestfs_application_list *\n"
9838 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9839 " const char *root);\n"
9844 #: ../src/guestfs-actions.pod:2926 ../fish/guestfish-actions.pod:2015
9845 msgid "Return the list of applications installed in the operating system."
9849 #: ../src/guestfs-actions.pod:2928
9851 "I<Note:> This call works differently from other parts of the inspection "
9852 "API. You have to call C<guestfs_inspect_os>, then "
9853 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9854 "this. Listing applications is a significantly more difficult operation "
9855 "which requires access to the full filesystem. Also note that unlike the "
9856 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9857 "the libguestfs handle, this call actually reads parts of the mounted "
9858 "filesystems during the call."
9862 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2027
9864 "This returns an empty list if the inspection code was not able to determine "
9865 "the list of applications."
9869 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
9870 msgid "The application structure contains the following fields:"
9874 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2034
9879 #: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2036
9881 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9882 "guests, this is the package name."
9886 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2039
9887 msgid "C<app_display_name>"
9891 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2041
9893 "The display name of the application, sometimes localized to the install "
9894 "language of the guest operating system."
9898 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2044
9900 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9901 "to display something can use C<app_name> instead."
9905 #: ../src/guestfs-actions.pod:2958 ../fish/guestfish-actions.pod:2047
9906 msgid "C<app_epoch>"
9910 #: ../src/guestfs-actions.pod:2960 ../fish/guestfish-actions.pod:2049
9912 "For package managers which use epochs, this contains the epoch of the "
9913 "package (an integer). If unavailable, this is returned as C<0>."
9917 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2052
9918 msgid "C<app_version>"
9922 #: ../src/guestfs-actions.pod:2965 ../fish/guestfish-actions.pod:2054
9924 "The version string of the application or package. If unavailable this is "
9925 "returned as an empty string C<\"\">."
9929 #: ../src/guestfs-actions.pod:2968 ../fish/guestfish-actions.pod:2057
9930 msgid "C<app_release>"
9934 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2059
9936 "The release string of the application or package, for package managers that "
9937 "use this. If unavailable this is returned as an empty string C<\"\">."
9941 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2063
9942 msgid "C<app_install_path>"
9946 #: ../src/guestfs-actions.pod:2976 ../fish/guestfish-actions.pod:2065
9948 "The installation path of the application (on operating systems such as "
9949 "Windows which use installation paths). This path is in the format used by "
9950 "the guest operating system, it is not a libguestfs path."
9954 #: ../src/guestfs-actions.pod:2981 ../fish/guestfish-actions.pod:2070
9955 msgid "If unavailable this is returned as an empty string C<\"\">."
9959 #: ../src/guestfs-actions.pod:2983 ../fish/guestfish-actions.pod:2072
9960 msgid "C<app_trans_path>"
9964 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2074
9966 "The install path translated into a libguestfs path. If unavailable this is "
9967 "returned as an empty string C<\"\">."
9971 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2077
9972 msgid "C<app_publisher>"
9976 #: ../src/guestfs-actions.pod:2990 ../fish/guestfish-actions.pod:2079
9978 "The name of the publisher of the application, for package managers that use "
9979 "this. If unavailable this is returned as an empty string C<\"\">."
9983 #: ../src/guestfs-actions.pod:2994 ../fish/guestfish-actions.pod:2083
9988 #: ../src/guestfs-actions.pod:2996 ../fish/guestfish-actions.pod:2085
9990 "The URL (eg. upstream URL) of the application. If unavailable this is "
9991 "returned as an empty string C<\"\">."
9995 #: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2088
9996 msgid "C<app_source_package>"
10000 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2090
10002 "For packaging systems which support this, the name of the source package. "
10003 "If unavailable this is returned as an empty string C<\"\">."
10007 #: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2093
10008 msgid "C<app_summary>"
10012 #: ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:2095
10014 "A short (usually one line) description of the application or package. If "
10015 "unavailable this is returned as an empty string C<\"\">."
10019 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2098
10020 msgid "C<app_description>"
10024 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2100
10026 "A longer description of the application or package. If unavailable this is "
10027 "returned as an empty string C<\"\">."
10031 #: ../src/guestfs-actions.pod:3018
10033 "This function returns a C<struct guestfs_application_list *>, or NULL if "
10034 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10039 #: ../src/guestfs-actions.pod:3022
10040 msgid "(Added in 1.7.8)"
10044 #: ../src/guestfs-actions.pod:3024
10045 msgid "guestfs_inspect_os"
10049 #: ../src/guestfs-actions.pod:3026
10053 " guestfs_inspect_os (guestfs_h *g);\n"
10058 #: ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:2111
10060 "This function uses other libguestfs functions and certain heuristics to "
10061 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10062 "for operating systems."
10066 #: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2115
10067 msgid "The list returned is empty if no operating systems were found."
10071 #: ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:2117
10073 "If one operating system was found, then this returns a list with a single "
10074 "element, which is the name of the root filesystem of this operating system. "
10075 "It is also possible for this function to return a list containing more than "
10076 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10077 "element being the root filesystem of one of the operating systems."
10081 #: ../src/guestfs-actions.pod:3042
10083 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10084 "functions in order to query further information about each operating system, "
10085 "such as the name and version."
10089 #: ../src/guestfs-actions.pod:3047
10091 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10092 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10093 "the contents. This should be called with no disks currently mounted. The "
10094 "function may also use Augeas, so any existing Augeas handle will be closed."
10098 #: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2135
10100 "This function cannot decrypt encrypted disks. The caller must do that first "
10101 "(supplying the necessary keys) if the disk is encrypted."
10105 #: ../src/guestfs-actions.pod:3059 ../src/guestfs-actions.pod:3344 ../src/guestfs-actions.pod:3406
10106 msgid "See also C<guestfs_list_filesystems>."
10110 #: ../src/guestfs-actions.pod:3067
10111 msgid "guestfs_is_blockdev"
10115 #: ../src/guestfs-actions.pod:3069
10119 " guestfs_is_blockdev (guestfs_h *g,\n"
10120 " const char *path);\n"
10125 #: ../src/guestfs-actions.pod:3073 ../fish/guestfish-actions.pod:2147
10127 "This returns C<true> if and only if there is a block device with the given "
10132 #: ../src/guestfs-actions.pod:3076 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3135 ../src/guestfs-actions.pod:3150 ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3237
10133 msgid "See also C<guestfs_stat>."
10137 #: ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3226 ../src/guestfs-actions.pod:3241
10138 msgid "(Added in 1.5.10)"
10142 #: ../src/guestfs-actions.pod:3082
10143 msgid "guestfs_is_busy"
10147 #: ../src/guestfs-actions.pod:3084
10151 " guestfs_is_busy (guestfs_h *g);\n"
10156 #: ../src/guestfs-actions.pod:3087 ../fish/guestfish-actions.pod:2156
10158 "This returns true iff this handle is busy processing a command (in the "
10163 #: ../src/guestfs-actions.pod:3096
10164 msgid "guestfs_is_chardev"
10168 #: ../src/guestfs-actions.pod:3098
10172 " guestfs_is_chardev (guestfs_h *g,\n"
10173 " const char *path);\n"
10178 #: ../src/guestfs-actions.pod:3102 ../fish/guestfish-actions.pod:2165
10180 "This returns C<true> if and only if there is a character device with the "
10181 "given C<path> name."
10185 #: ../src/guestfs-actions.pod:3111
10186 msgid "guestfs_is_config"
10190 #: ../src/guestfs-actions.pod:3113
10194 " guestfs_is_config (guestfs_h *g);\n"
10199 #: ../src/guestfs-actions.pod:3116 ../fish/guestfish-actions.pod:2174
10201 "This returns true iff this handle is being configured (in the C<CONFIG> "
10206 #: ../src/guestfs-actions.pod:3125
10207 msgid "guestfs_is_dir"
10211 #: ../src/guestfs-actions.pod:3127
10215 " guestfs_is_dir (guestfs_h *g,\n"
10216 " const char *path);\n"
10221 #: ../src/guestfs-actions.pod:3131 ../fish/guestfish-actions.pod:2183
10223 "This returns C<true> if and only if there is a directory with the given "
10224 "C<path> name. Note that it returns false for other objects like files."
10228 #: ../src/guestfs-actions.pod:3141
10229 msgid "guestfs_is_fifo"
10233 #: ../src/guestfs-actions.pod:3143
10237 " guestfs_is_fifo (guestfs_h *g,\n"
10238 " const char *path);\n"
10243 #: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2193
10245 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10246 "given C<path> name."
10250 #: ../src/guestfs-actions.pod:3156
10251 msgid "guestfs_is_file"
10255 #: ../src/guestfs-actions.pod:3158
10259 " guestfs_is_file (guestfs_h *g,\n"
10260 " const char *path);\n"
10265 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:2202
10267 "This returns C<true> if and only if there is a regular file with the given "
10268 "C<path> name. Note that it returns false for other objects like "
10273 #: ../src/guestfs-actions.pod:3172
10274 msgid "guestfs_is_launching"
10278 #: ../src/guestfs-actions.pod:3174
10282 " guestfs_is_launching (guestfs_h *g);\n"
10287 #: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2212
10289 "This returns true iff this handle is launching the subprocess (in the "
10290 "C<LAUNCHING> state)."
10294 #: ../src/guestfs-actions.pod:3186
10295 msgid "guestfs_is_lv"
10299 #: ../src/guestfs-actions.pod:3188
10303 " guestfs_is_lv (guestfs_h *g,\n"
10304 " const char *device);\n"
10309 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2221
10311 "This command tests whether C<device> is a logical volume, and returns true "
10312 "iff this is the case."
10316 #: ../src/guestfs-actions.pod:3199
10317 msgid "guestfs_is_ready"
10321 #: ../src/guestfs-actions.pod:3201
10325 " guestfs_is_ready (guestfs_h *g);\n"
10330 #: ../src/guestfs-actions.pod:3204 ../fish/guestfish-actions.pod:2228
10332 "This returns true iff this handle is ready to accept commands (in the "
10337 #: ../src/guestfs-actions.pod:3213
10338 msgid "guestfs_is_socket"
10342 #: ../src/guestfs-actions.pod:3215
10346 " guestfs_is_socket (guestfs_h *g,\n"
10347 " const char *path);\n"
10352 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2237
10354 "This returns C<true> if and only if there is a Unix domain socket with the "
10355 "given C<path> name."
10359 #: ../src/guestfs-actions.pod:3228
10360 msgid "guestfs_is_symlink"
10364 #: ../src/guestfs-actions.pod:3230
10368 " guestfs_is_symlink (guestfs_h *g,\n"
10369 " const char *path);\n"
10374 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2246
10376 "This returns C<true> if and only if there is a symbolic link with the given "
10381 #: ../src/guestfs-actions.pod:3243
10382 msgid "guestfs_kill_subprocess"
10386 #: ../src/guestfs-actions.pod:3245
10390 " guestfs_kill_subprocess (guestfs_h *g);\n"
10395 #: ../src/guestfs-actions.pod:3248 ../fish/guestfish-actions.pod:2255
10396 msgid "This kills the qemu subprocess. You should never need to call this."
10400 #: ../src/guestfs-actions.pod:3254
10401 msgid "guestfs_launch"
10405 #: ../src/guestfs-actions.pod:3256
10409 " guestfs_launch (guestfs_h *g);\n"
10414 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2263
10416 "Internally libguestfs is implemented by running a virtual machine using "
10421 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2266
10423 "You should call this after configuring the handle (eg. adding drives) but "
10424 "before performing any actions."
10428 #: ../src/guestfs-actions.pod:3269
10429 msgid "guestfs_lchown"
10433 #: ../src/guestfs-actions.pod:3271
10437 " guestfs_lchown (guestfs_h *g,\n"
10440 " const char *path);\n"
10445 #: ../src/guestfs-actions.pod:3277
10447 "Change the file owner to C<owner> and group to C<group>. This is like "
10448 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
10449 "changed, not the target."
10453 #: ../src/guestfs-actions.pod:3289
10454 msgid "guestfs_lgetxattr"
10458 #: ../src/guestfs-actions.pod:3291
10462 " guestfs_lgetxattr (guestfs_h *g,\n"
10463 " const char *path,\n"
10464 " const char *name,\n"
10465 " size_t *size_r);\n"
10470 #: ../src/guestfs-actions.pod:3297 ../fish/guestfish-actions.pod:2285
10472 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10473 "is a symlink, then this call returns an extended attribute from the symlink."
10477 #: ../src/guestfs-actions.pod:3311
10478 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
10482 #: ../src/guestfs-actions.pod:3319
10483 msgid "guestfs_lgetxattrs"
10487 #: ../src/guestfs-actions.pod:3321
10490 " struct guestfs_xattr_list *\n"
10491 " guestfs_lgetxattrs (guestfs_h *g,\n"
10492 " const char *path);\n"
10497 #: ../src/guestfs-actions.pod:3325
10499 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
10500 "then it returns the extended attributes of the link itself."
10504 #: ../src/guestfs-actions.pod:3335
10505 msgid "guestfs_list_devices"
10509 #: ../src/guestfs-actions.pod:3337
10513 " guestfs_list_devices (guestfs_h *g);\n"
10518 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2313
10519 msgid "List all the block devices."
10523 #: ../src/guestfs-actions.pod:3342 ../fish/guestfish-actions.pod:2315
10524 msgid "The full block device names are returned, eg. C</dev/sda>."
10528 #: ../src/guestfs-actions.pod:3352
10529 msgid "guestfs_list_filesystems"
10533 #: ../src/guestfs-actions.pod:3354
10537 " guestfs_list_filesystems (guestfs_h *g);\n"
10542 #: ../src/guestfs-actions.pod:3357 ../fish/guestfish-actions.pod:2323
10544 "This inspection command looks for filesystems on partitions, block devices "
10545 "and logical volumes, returning a list of devices containing filesystems and "
10550 #: ../src/guestfs-actions.pod:3361 ../fish/guestfish-actions.pod:2327
10552 "The return value is a hash, where the keys are the devices containing "
10553 "filesystems, and the values are the filesystem types. For example:"
10557 #: ../src/guestfs-actions.pod:3365 ../fish/guestfish-actions.pod:2331
10560 " \"/dev/sda1\" => \"ntfs\"\n"
10561 " \"/dev/sda2\" => \"ext2\"\n"
10562 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10563 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10568 #: ../src/guestfs-actions.pod:3370 ../fish/guestfish-actions.pod:2336
10570 "The value can have the special value \"unknown\", meaning the content of the "
10571 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10575 #: ../src/guestfs-actions.pod:3374
10577 "This command runs other libguestfs commands, which might include "
10578 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10579 "soon after launch and only when nothing is mounted."
10583 #: ../src/guestfs-actions.pod:3378
10585 "Not all of the filesystems returned will be mountable. In particular, swap "
10586 "partitions are returned in the list. Also this command does not check that "
10587 "each filesystem found is valid and mountable, and some filesystems might be "
10588 "mountable but require special options. Filesystems may not all belong to a "
10589 "single logical operating system (use C<guestfs_inspect_os> to look for "
10594 #: ../src/guestfs-actions.pod:3392 ../src/guestfs-actions.pod:4994
10595 msgid "(Added in 1.5.15)"
10599 #: ../src/guestfs-actions.pod:3394
10600 msgid "guestfs_list_partitions"
10604 #: ../src/guestfs-actions.pod:3396
10608 " guestfs_list_partitions (guestfs_h *g);\n"
10613 #: ../src/guestfs-actions.pod:3399 ../fish/guestfish-actions.pod:2356
10614 msgid "List all the partitions detected on all block devices."
10618 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2358
10619 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10623 #: ../src/guestfs-actions.pod:3403
10625 "This does not return logical volumes. For that you will need to call "
10630 #: ../src/guestfs-actions.pod:3414
10635 #: ../src/guestfs-actions.pod:3416
10639 " guestfs_ll (guestfs_h *g,\n"
10640 " const char *directory);\n"
10645 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2369
10647 "List the files in C<directory> (relative to the root directory, there is no "
10648 "cwd) in the format of 'ls -la'."
10652 #: ../src/guestfs-actions.pod:3423 ../fish/guestfish-actions.pod:2372
10654 "This command is mostly useful for interactive sessions. It is I<not> "
10655 "intended that you try to parse the output string."
10659 #: ../src/guestfs-actions.pod:3431
10664 #: ../src/guestfs-actions.pod:3433
10668 " guestfs_ln (guestfs_h *g,\n"
10669 " const char *target,\n"
10670 " const char *linkname);\n"
10675 #: ../src/guestfs-actions.pod:3438 ../fish/guestfish-actions.pod:2379
10676 msgid "This command creates a hard link using the C<ln> command."
10680 #: ../src/guestfs-actions.pod:3444
10681 msgid "guestfs_ln_f"
10685 #: ../src/guestfs-actions.pod:3446
10689 " guestfs_ln_f (guestfs_h *g,\n"
10690 " const char *target,\n"
10691 " const char *linkname);\n"
10696 #: ../src/guestfs-actions.pod:3451 ../fish/guestfish-actions.pod:2385
10698 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10699 "option removes the link (C<linkname>) if it exists already."
10703 #: ../src/guestfs-actions.pod:3458
10704 msgid "guestfs_ln_s"
10708 #: ../src/guestfs-actions.pod:3460
10712 " guestfs_ln_s (guestfs_h *g,\n"
10713 " const char *target,\n"
10714 " const char *linkname);\n"
10719 #: ../src/guestfs-actions.pod:3465 ../fish/guestfish-actions.pod:2392
10720 msgid "This command creates a symbolic link using the C<ln -s> command."
10724 #: ../src/guestfs-actions.pod:3471
10725 msgid "guestfs_ln_sf"
10729 #: ../src/guestfs-actions.pod:3473
10733 " guestfs_ln_sf (guestfs_h *g,\n"
10734 " const char *target,\n"
10735 " const char *linkname);\n"
10740 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2398
10742 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10743 "option removes the link (C<linkname>) if it exists already."
10747 #: ../src/guestfs-actions.pod:3485
10748 msgid "guestfs_lremovexattr"
10752 #: ../src/guestfs-actions.pod:3487
10756 " guestfs_lremovexattr (guestfs_h *g,\n"
10757 " const char *xattr,\n"
10758 " const char *path);\n"
10763 #: ../src/guestfs-actions.pod:3492
10765 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10766 "link, then it removes an extended attribute of the link itself."
10770 #: ../src/guestfs-actions.pod:3500
10775 #: ../src/guestfs-actions.pod:3502
10779 " guestfs_ls (guestfs_h *g,\n"
10780 " const char *directory);\n"
10785 #: ../src/guestfs-actions.pod:3506 ../fish/guestfish-actions.pod:2413
10787 "List the files in C<directory> (relative to the root directory, there is no "
10788 "cwd). The '.' and '..' entries are not returned, but hidden files are "
10793 #: ../src/guestfs-actions.pod:3510
10795 "This command is mostly useful for interactive sessions. Programs should "
10796 "probably use C<guestfs_readdir> instead."
10800 #: ../src/guestfs-actions.pod:3519
10801 msgid "guestfs_lsetxattr"
10805 #: ../src/guestfs-actions.pod:3521
10809 " guestfs_lsetxattr (guestfs_h *g,\n"
10810 " const char *xattr,\n"
10811 " const char *val,\n"
10813 " const char *path);\n"
10818 #: ../src/guestfs-actions.pod:3528
10820 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10821 "then it sets an extended attribute of the link itself."
10825 #: ../src/guestfs-actions.pod:3536
10826 msgid "guestfs_lstat"
10830 #: ../src/guestfs-actions.pod:3538
10833 " struct guestfs_stat *\n"
10834 " guestfs_lstat (guestfs_h *g,\n"
10835 " const char *path);\n"
10840 #: ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:6048 ../fish/guestfish-actions.pod:2432 ../fish/guestfish-actions.pod:4056
10841 msgid "Returns file information for the given C<path>."
10845 #: ../src/guestfs-actions.pod:3544
10847 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10848 "link, then the link is stat-ed, not the file it refers to."
10852 #: ../src/guestfs-actions.pod:3548 ../fish/guestfish-actions.pod:2438
10853 msgid "This is the same as the C<lstat(2)> system call."
10857 #: ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:6052
10859 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10860 "error. I<The caller must call C<guestfs_free_stat> after use>."
10864 #: ../src/guestfs-actions.pod:3554 ../src/guestfs-actions.pod:6056 ../src/guestfs-actions.pod:6074 ../src/guestfs-actions.pod:6455
10865 msgid "(Added in 0.9.2)"
10869 #: ../src/guestfs-actions.pod:3556
10870 msgid "guestfs_lstatlist"
10874 #: ../src/guestfs-actions.pod:3558
10877 " struct guestfs_stat_list *\n"
10878 " guestfs_lstatlist (guestfs_h *g,\n"
10879 " const char *path,\n"
10880 " char *const *names);\n"
10885 #: ../src/guestfs-actions.pod:3563
10887 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10888 "files, where all files are in the directory C<path>. C<names> is the list "
10889 "of files from this directory."
10893 #: ../src/guestfs-actions.pod:3567 ../fish/guestfish-actions.pod:2448
10895 "On return you get a list of stat structs, with a one-to-one correspondence "
10896 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10897 "then the C<ino> field of that structure is set to C<-1>."
10901 #: ../src/guestfs-actions.pod:3572
10903 "This call is intended for programs that want to efficiently list a directory "
10904 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10905 "for a similarly efficient call for getting extended attributes. Very long "
10906 "directory listings might cause the protocol message size to be exceeded, "
10907 "causing this call to fail. The caller must split up such requests into "
10908 "smaller groups of names."
10912 #: ../src/guestfs-actions.pod:3580
10914 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10915 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10919 #: ../src/guestfs-actions.pod:3586
10920 msgid "guestfs_luks_add_key"
10924 #: ../src/guestfs-actions.pod:3588
10928 " guestfs_luks_add_key (guestfs_h *g,\n"
10929 " const char *device,\n"
10930 " const char *key,\n"
10931 " const char *newkey,\n"
10937 #: ../src/guestfs-actions.pod:3595 ../fish/guestfish-actions.pod:2465
10939 "This command adds a new key on LUKS device C<device>. C<key> is any "
10940 "existing key, and is used to access the device. C<newkey> is the new key to "
10941 "add. C<keyslot> is the key slot that will be replaced."
10945 #: ../src/guestfs-actions.pod:3600
10947 "Note that if C<keyslot> already contains a key, then this command will "
10948 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10952 #: ../src/guestfs-actions.pod:3606 ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3669 ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:3721 ../src/guestfs-actions.pod:3740
10954 "This function takes a key or passphrase parameter which could contain "
10955 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10960 #: ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3650 ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3693
10961 msgid "(Added in 1.5.2)"
10965 #: ../src/guestfs-actions.pod:3612
10966 msgid "guestfs_luks_close"
10970 #: ../src/guestfs-actions.pod:3614
10974 " guestfs_luks_close (guestfs_h *g,\n"
10975 " const char *device);\n"
10980 #: ../src/guestfs-actions.pod:3618
10982 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10983 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10984 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10985 "underlying block device."
10989 #: ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3725 ../src/guestfs-actions.pod:3744 ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:3842
10990 msgid "(Added in 1.5.1)"
10994 #: ../src/guestfs-actions.pod:3628
10995 msgid "guestfs_luks_format"
10999 #: ../src/guestfs-actions.pod:3630
11003 " guestfs_luks_format (guestfs_h *g,\n"
11004 " const char *device,\n"
11005 " const char *key,\n"
11011 #: ../src/guestfs-actions.pod:3636 ../fish/guestfish-actions.pod:2491
11013 "This command erases existing data on C<device> and formats the device as a "
11014 "LUKS encrypted device. C<key> is the initial key, which is added to key "
11015 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
11019 #: ../src/guestfs-actions.pod:3643 ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3806 ../src/guestfs-actions.pod:4745 ../src/guestfs-actions.pod:5508 ../src/guestfs-actions.pod:5883 ../src/guestfs-actions.pod:5906 ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:7092 ../fish/guestfish-actions.pod:2499 ../fish/guestfish-actions.pod:2512 ../fish/guestfish-actions.pod:2596 ../fish/guestfish-actions.pod:3168 ../fish/guestfish-actions.pod:3675 ../fish/guestfish-actions.pod:3955 ../fish/guestfish-actions.pod:3971 ../fish/guestfish-actions.pod:3986 ../fish/guestfish-actions.pod:4701
11021 "B<This command is dangerous. Without careful use you can easily destroy all "
11026 #: ../src/guestfs-actions.pod:3652
11027 msgid "guestfs_luks_format_cipher"
11031 #: ../src/guestfs-actions.pod:3654
11035 " guestfs_luks_format_cipher (guestfs_h *g,\n"
11036 " const char *device,\n"
11037 " const char *key,\n"
11039 " const char *cipher);\n"
11044 #: ../src/guestfs-actions.pod:3661
11046 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11047 "set the C<cipher> used."
11051 #: ../src/guestfs-actions.pod:3675
11052 msgid "guestfs_luks_kill_slot"
11056 #: ../src/guestfs-actions.pod:3677
11060 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11061 " const char *device,\n"
11062 " const char *key,\n"
11068 #: ../src/guestfs-actions.pod:3683 ../fish/guestfish-actions.pod:2519
11070 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11071 "device C<device>. C<key> must be one of the I<other> keys."
11075 #: ../src/guestfs-actions.pod:3695
11076 msgid "guestfs_luks_open"
11080 #: ../src/guestfs-actions.pod:3697
11084 " guestfs_luks_open (guestfs_h *g,\n"
11085 " const char *device,\n"
11086 " const char *key,\n"
11087 " const char *mapname);\n"
11092 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2530
11094 "This command opens a block device which has been encrypted according to the "
11095 "Linux Unified Key Setup (LUKS) standard."
11099 #: ../src/guestfs-actions.pod:3706 ../fish/guestfish-actions.pod:2533
11100 msgid "C<device> is the encrypted block device or partition."
11104 #: ../src/guestfs-actions.pod:3708 ../fish/guestfish-actions.pod:2535
11106 "The caller must supply one of the keys associated with the LUKS block "
11107 "device, in the C<key> parameter."
11111 #: ../src/guestfs-actions.pod:3711 ../fish/guestfish-actions.pod:2538
11113 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11114 "writes to this block device are decrypted from and encrypted to the "
11115 "underlying C<device> respectively."
11119 #: ../src/guestfs-actions.pod:3715
11121 "If this block device contains LVM volume groups, then calling "
11122 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11127 #: ../src/guestfs-actions.pod:3727
11128 msgid "guestfs_luks_open_ro"
11132 #: ../src/guestfs-actions.pod:3729
11136 " guestfs_luks_open_ro (guestfs_h *g,\n"
11137 " const char *device,\n"
11138 " const char *key,\n"
11139 " const char *mapname);\n"
11144 #: ../src/guestfs-actions.pod:3735
11146 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11151 #: ../src/guestfs-actions.pod:3746
11152 msgid "guestfs_lvcreate"
11156 #: ../src/guestfs-actions.pod:3748
11160 " guestfs_lvcreate (guestfs_h *g,\n"
11161 " const char *logvol,\n"
11162 " const char *volgroup,\n"
11168 #: ../src/guestfs-actions.pod:3754 ../fish/guestfish-actions.pod:2563
11170 "This creates an LVM logical volume called C<logvol> on the volume group "
11171 "C<volgroup>, with C<size> megabytes."
11175 #: ../src/guestfs-actions.pod:3761
11176 msgid "guestfs_lvm_canonical_lv_name"
11180 #: ../src/guestfs-actions.pod:3763
11184 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11185 " const char *lvname);\n"
11190 #: ../src/guestfs-actions.pod:3767 ../fish/guestfish-actions.pod:2570
11192 "This converts alternative naming schemes for LVs that you might find to the "
11193 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11198 #: ../src/guestfs-actions.pod:3771 ../fish/guestfish-actions.pod:2574
11200 "This command returns an error if the C<lvname> parameter does not refer to a "
11205 #: ../src/guestfs-actions.pod:3774
11206 msgid "See also C<guestfs_is_lv>."
11210 #: ../src/guestfs-actions.pod:3779
11211 msgid "(Added in 1.5.24)"
11215 #: ../src/guestfs-actions.pod:3781
11216 msgid "guestfs_lvm_clear_filter"
11220 #: ../src/guestfs-actions.pod:3783
11224 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11229 #: ../src/guestfs-actions.pod:3786
11231 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11232 "see every block device."
11236 #: ../src/guestfs-actions.pod:3789 ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2586 ../fish/guestfish-actions.pod:2617
11237 msgid "This command also clears the LVM cache and performs a volume group scan."
11241 #: ../src/guestfs-actions.pod:3796
11242 msgid "guestfs_lvm_remove_all"
11246 #: ../src/guestfs-actions.pod:3798
11250 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11255 #: ../src/guestfs-actions.pod:3801 ../fish/guestfish-actions.pod:2593
11257 "This command removes all LVM logical volumes, volume groups and physical "
11262 #: ../src/guestfs-actions.pod:3811
11263 msgid "guestfs_lvm_set_filter"
11267 #: ../src/guestfs-actions.pod:3813
11271 " guestfs_lvm_set_filter (guestfs_h *g,\n"
11272 " char *const *devices);\n"
11277 #: ../src/guestfs-actions.pod:3817 ../fish/guestfish-actions.pod:2603
11279 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11280 "block devices in the list C<devices>, and will ignore all other attached "
11285 #: ../src/guestfs-actions.pod:3821 ../fish/guestfish-actions.pod:2607
11287 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11288 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11289 "there are two types of duplication possible: either cloned PVs/VGs which "
11290 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11291 "same name. In normal operation you cannot create this situation, but you "
11292 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11293 "inside the LVM metadata."
11297 #: ../src/guestfs-actions.pod:3834 ../fish/guestfish-actions.pod:2620
11298 msgid "You can filter whole block devices or individual partitions."
11302 #: ../src/guestfs-actions.pod:3836 ../fish/guestfish-actions.pod:2622
11304 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11305 "filesystem), even if you are not filtering out that VG."
11309 #: ../src/guestfs-actions.pod:3844
11310 msgid "guestfs_lvremove"
11314 #: ../src/guestfs-actions.pod:3846
11318 " guestfs_lvremove (guestfs_h *g,\n"
11319 " const char *device);\n"
11324 #: ../src/guestfs-actions.pod:3850 ../fish/guestfish-actions.pod:2630
11326 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11327 "LV, such as C</dev/VG/LV>."
11331 #: ../src/guestfs-actions.pod:3853 ../fish/guestfish-actions.pod:2633
11333 "You can also remove all LVs in a volume group by specifying the VG name, "
11338 #: ../src/guestfs-actions.pod:3858 ../src/guestfs-actions.pod:5091 ../src/guestfs-actions.pod:6831
11339 msgid "(Added in 1.0.13)"
11343 #: ../src/guestfs-actions.pod:3860
11344 msgid "guestfs_lvrename"
11348 #: ../src/guestfs-actions.pod:3862
11352 " guestfs_lvrename (guestfs_h *g,\n"
11353 " const char *logvol,\n"
11354 " const char *newlogvol);\n"
11359 #: ../src/guestfs-actions.pod:3867 ../fish/guestfish-actions.pod:2640
11360 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11364 #: ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:6844
11365 msgid "(Added in 1.0.83)"
11369 #: ../src/guestfs-actions.pod:3873
11370 msgid "guestfs_lvresize"
11374 #: ../src/guestfs-actions.pod:3875
11378 " guestfs_lvresize (guestfs_h *g,\n"
11379 " const char *device,\n"
11385 #: ../src/guestfs-actions.pod:3880 ../fish/guestfish-actions.pod:2646
11387 "This resizes (expands or shrinks) an existing LVM logical volume to "
11388 "C<mbytes>. When reducing, data in the reduced part is lost."
11392 #: ../src/guestfs-actions.pod:3888
11393 msgid "guestfs_lvresize_free"
11397 #: ../src/guestfs-actions.pod:3890
11401 " guestfs_lvresize_free (guestfs_h *g,\n"
11402 " const char *lv,\n"
11408 #: ../src/guestfs-actions.pod:3895 ../fish/guestfish-actions.pod:2654
11410 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11411 "remaining free space in the volume group. Commonly you would call this with "
11412 "pc = 100 which expands the logical volume as much as possible, using all "
11413 "remaining free space in the volume group."
11417 #: ../src/guestfs-actions.pod:3903
11418 msgid "(Added in 1.3.3)"
11422 #: ../src/guestfs-actions.pod:3905
11423 msgid "guestfs_lvs"
11427 #: ../src/guestfs-actions.pod:3907
11431 " guestfs_lvs (guestfs_h *g);\n"
11436 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2664
11438 "List all the logical volumes detected. This is the equivalent of the "
11439 "L<lvs(8)> command."
11443 #: ../src/guestfs-actions.pod:3913 ../fish/guestfish-actions.pod:2667
11445 "This returns a list of the logical volume device names "
11446 "(eg. C</dev/VolGroup00/LogVol00>)."
11450 #: ../src/guestfs-actions.pod:3916
11451 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
11455 #: ../src/guestfs-actions.pod:3924
11456 msgid "guestfs_lvs_full"
11460 #: ../src/guestfs-actions.pod:3926
11463 " struct guestfs_lvm_lv_list *\n"
11464 " guestfs_lvs_full (guestfs_h *g);\n"
11469 #: ../src/guestfs-actions.pod:3929 ../fish/guestfish-actions.pod:2676
11471 "List all the logical volumes detected. This is the equivalent of the "
11472 "L<lvs(8)> command. The \"full\" version includes all fields."
11476 #: ../src/guestfs-actions.pod:3932
11478 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
11479 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
11484 #: ../src/guestfs-actions.pod:3938
11485 msgid "guestfs_lvuuid"
11489 #: ../src/guestfs-actions.pod:3940
11493 " guestfs_lvuuid (guestfs_h *g,\n"
11494 " const char *device);\n"
11499 #: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:2683
11500 msgid "This command returns the UUID of the LVM LV C<device>."
11504 #: ../src/guestfs-actions.pod:3951
11505 msgid "guestfs_lxattrlist"
11509 #: ../src/guestfs-actions.pod:3953
11512 " struct guestfs_xattr_list *\n"
11513 " guestfs_lxattrlist (guestfs_h *g,\n"
11514 " const char *path,\n"
11515 " char *const *names);\n"
11520 #: ../src/guestfs-actions.pod:3958 ../fish/guestfish-actions.pod:2689
11522 "This call allows you to get the extended attributes of multiple files, where "
11523 "all files are in the directory C<path>. C<names> is the list of files from "
11528 #: ../src/guestfs-actions.pod:3962 ../fish/guestfish-actions.pod:2693
11530 "On return you get a flat list of xattr structs which must be interpreted "
11531 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11532 "C<attrval> in this struct is zero-length to indicate there was an error "
11533 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11534 "number (the number of following attributes for this file, which could be "
11535 "C<\"0\">). Then after the first xattr struct are the zero or more "
11536 "attributes for the first named file. This repeats for the second and "
11537 "subsequent files."
11541 #: ../src/guestfs-actions.pod:3972
11543 "This call is intended for programs that want to efficiently list a directory "
11544 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11545 "a similarly efficient call for getting standard stats. Very long directory "
11546 "listings might cause the protocol message size to be exceeded, causing this "
11547 "call to fail. The caller must split up such requests into smaller groups of "
11552 #: ../src/guestfs-actions.pod:3986
11553 msgid "guestfs_mkdir"
11557 #: ../src/guestfs-actions.pod:3988
11561 " guestfs_mkdir (guestfs_h *g,\n"
11562 " const char *path);\n"
11567 #: ../src/guestfs-actions.pod:3992 ../fish/guestfish-actions.pod:2715
11568 msgid "Create a directory named C<path>."
11572 #: ../src/guestfs-actions.pod:3998
11573 msgid "guestfs_mkdir_mode"
11577 #: ../src/guestfs-actions.pod:4000
11581 " guestfs_mkdir_mode (guestfs_h *g,\n"
11582 " const char *path,\n"
11588 #: ../src/guestfs-actions.pod:4005 ../fish/guestfish-actions.pod:2721
11590 "This command creates a directory, setting the initial permissions of the "
11591 "directory to C<mode>."
11595 #: ../src/guestfs-actions.pod:4008 ../fish/guestfish-actions.pod:2724
11597 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11598 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11603 #: ../src/guestfs-actions.pod:4012
11604 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11608 #: ../src/guestfs-actions.pod:4018
11609 msgid "guestfs_mkdir_p"
11613 #: ../src/guestfs-actions.pod:4020
11617 " guestfs_mkdir_p (guestfs_h *g,\n"
11618 " const char *path);\n"
11623 #: ../src/guestfs-actions.pod:4024 ../fish/guestfish-actions.pod:2734
11625 "Create a directory named C<path>, creating any parent directories as "
11626 "necessary. This is like the C<mkdir -p> shell command."
11630 #: ../src/guestfs-actions.pod:4031
11631 msgid "guestfs_mkdtemp"
11635 #: ../src/guestfs-actions.pod:4033
11639 " guestfs_mkdtemp (guestfs_h *g,\n"
11640 " const char *template);\n"
11645 #: ../src/guestfs-actions.pod:4037 ../fish/guestfish-actions.pod:2741
11647 "This command creates a temporary directory. The C<template> parameter "
11648 "should be a full pathname for the temporary directory name with the final "
11649 "six characters being \"XXXXXX\"."
11653 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2746
11655 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11656 "being suitable for Windows filesystems."
11660 #: ../src/guestfs-actions.pod:4045 ../fish/guestfish-actions.pod:2749
11661 msgid "The name of the temporary directory that was created is returned."
11665 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2752
11666 msgid "The temporary directory is created with mode 0700 and is owned by root."
11670 #: ../src/guestfs-actions.pod:4051 ../fish/guestfish-actions.pod:2755
11672 "The caller is responsible for deleting the temporary directory and its "
11673 "contents after use."
11677 #: ../src/guestfs-actions.pod:4054 ../fish/guestfish-actions.pod:2758
11678 msgid "See also: L<mkdtemp(3)>"
11682 #: ../src/guestfs-actions.pod:4061
11683 msgid "guestfs_mke2fs_J"
11687 #: ../src/guestfs-actions.pod:4063
11691 " guestfs_mke2fs_J (guestfs_h *g,\n"
11692 " const char *fstype,\n"
11693 " int blocksize,\n"
11694 " const char *device,\n"
11695 " const char *journal);\n"
11700 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2764
11702 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11703 "C<journal>. It is equivalent to the command:"
11707 #: ../src/guestfs-actions.pod:4074 ../fish/guestfish-actions.pod:2768
11710 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11715 #: ../src/guestfs-actions.pod:4076
11716 msgid "See also C<guestfs_mke2journal>."
11720 #: ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4098 ../src/guestfs-actions.pod:4116 ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4146 ../src/guestfs-actions.pod:4160 ../src/guestfs-actions.pod:4219 ../src/guestfs-actions.pod:4472
11721 msgid "(Added in 1.0.68)"
11725 #: ../src/guestfs-actions.pod:4082
11726 msgid "guestfs_mke2fs_JL"
11730 #: ../src/guestfs-actions.pod:4084
11734 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11735 " const char *fstype,\n"
11736 " int blocksize,\n"
11737 " const char *device,\n"
11738 " const char *label);\n"
11743 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2776
11745 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11746 "the journal labeled C<label>."
11750 #: ../src/guestfs-actions.pod:4094
11751 msgid "See also C<guestfs_mke2journal_L>."
11755 #: ../src/guestfs-actions.pod:4100
11756 msgid "guestfs_mke2fs_JU"
11760 #: ../src/guestfs-actions.pod:4102
11764 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11765 " const char *fstype,\n"
11766 " int blocksize,\n"
11767 " const char *device,\n"
11768 " const char *uuid);\n"
11773 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2785
11775 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11776 "the journal with UUID C<uuid>."
11780 #: ../src/guestfs-actions.pod:4112
11781 msgid "See also C<guestfs_mke2journal_U>."
11785 #: ../src/guestfs-actions.pod:4118
11786 msgid "guestfs_mke2journal"
11790 #: ../src/guestfs-actions.pod:4120
11794 " guestfs_mke2journal (guestfs_h *g,\n"
11795 " int blocksize,\n"
11796 " const char *device);\n"
11801 #: ../src/guestfs-actions.pod:4125 ../fish/guestfish-actions.pod:2794
11803 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11808 #: ../src/guestfs-actions.pod:4128 ../fish/guestfish-actions.pod:2797
11811 " mke2fs -O journal_dev -b blocksize device\n"
11816 #: ../src/guestfs-actions.pod:4134
11817 msgid "guestfs_mke2journal_L"
11821 #: ../src/guestfs-actions.pod:4136
11825 " guestfs_mke2journal_L (guestfs_h *g,\n"
11826 " int blocksize,\n"
11827 " const char *label,\n"
11828 " const char *device);\n"
11833 #: ../src/guestfs-actions.pod:4142 ../fish/guestfish-actions.pod:2803
11834 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11838 #: ../src/guestfs-actions.pod:4148
11839 msgid "guestfs_mke2journal_U"
11843 #: ../src/guestfs-actions.pod:4150
11847 " guestfs_mke2journal_U (guestfs_h *g,\n"
11848 " int blocksize,\n"
11849 " const char *uuid,\n"
11850 " const char *device);\n"
11855 #: ../src/guestfs-actions.pod:4156 ../fish/guestfish-actions.pod:2809
11856 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11860 #: ../src/guestfs-actions.pod:4162
11861 msgid "guestfs_mkfifo"
11865 #: ../src/guestfs-actions.pod:4164
11869 " guestfs_mkfifo (guestfs_h *g,\n"
11871 " const char *path);\n"
11876 #: ../src/guestfs-actions.pod:4169
11878 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11879 "is just a convenient wrapper around C<guestfs_mknod>."
11883 #: ../src/guestfs-actions.pod:4179
11884 msgid "guestfs_mkfs"
11888 #: ../src/guestfs-actions.pod:4181
11892 " guestfs_mkfs (guestfs_h *g,\n"
11893 " const char *fstype,\n"
11894 " const char *device);\n"
11899 #: ../src/guestfs-actions.pod:4186 ../fish/guestfish-actions.pod:2825
11901 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11902 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11906 #: ../src/guestfs-actions.pod:4194
11907 msgid "guestfs_mkfs_b"
11911 #: ../src/guestfs-actions.pod:4196
11915 " guestfs_mkfs_b (guestfs_h *g,\n"
11916 " const char *fstype,\n"
11917 " int blocksize,\n"
11918 " const char *device);\n"
11923 #: ../src/guestfs-actions.pod:4202
11925 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11926 "block size of the resulting filesystem. Supported block sizes depend on the "
11927 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11931 #: ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4249 ../fish/guestfish-actions.pod:2838 ../fish/guestfish-actions.pod:2865
11933 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11938 #: ../src/guestfs-actions.pod:4212
11940 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
11945 #: ../src/guestfs-actions.pod:4221
11946 msgid "guestfs_mkfs_opts"
11950 #: ../src/guestfs-actions.pod:4223
11954 " guestfs_mkfs_opts (guestfs_h *g,\n"
11955 " const char *fstype,\n"
11956 " const char *device,\n"
11962 #: ../src/guestfs-actions.pod:4234
11965 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
11970 #: ../src/guestfs-actions.pod:4236 ../fish/guestfish-actions.pod:2852
11972 "This function creates a filesystem on C<device>. The filesystem type is "
11973 "C<fstype>, for example C<ext3>."
11977 #: ../src/guestfs-actions.pod:4243 ../fish/guestfish-actions.pod:2859
11978 msgid "C<blocksize>"
11982 #: ../src/guestfs-actions.pod:4245 ../fish/guestfish-actions.pod:2861
11984 "The filesystem block size. Supported block sizes depend on the filesystem "
11985 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11990 #: ../src/guestfs-actions.pod:4252 ../fish/guestfish-actions.pod:2868
11991 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
11995 #: ../src/guestfs-actions.pod:4258
11996 msgid "(Added in 1.7.19)"
12000 #: ../src/guestfs-actions.pod:4260
12001 msgid "guestfs_mkfs_opts_va"
12005 #: ../src/guestfs-actions.pod:4262
12009 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
12010 " const char *fstype,\n"
12011 " const char *device,\n"
12012 " va_list args);\n"
12017 #: ../src/guestfs-actions.pod:4268
12018 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
12022 #: ../src/guestfs-actions.pod:4272
12023 msgid "guestfs_mkfs_opts_argv"
12027 #: ../src/guestfs-actions.pod:4274
12031 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
12032 " const char *fstype,\n"
12033 " const char *device,\n"
12034 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12039 #: ../src/guestfs-actions.pod:4280
12040 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12044 #: ../src/guestfs-actions.pod:4284
12045 msgid "guestfs_mkmountpoint"
12049 #: ../src/guestfs-actions.pod:4286
12053 " guestfs_mkmountpoint (guestfs_h *g,\n"
12054 " const char *exemptpath);\n"
12059 #: ../src/guestfs-actions.pod:4290
12061 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12062 "that can be used to create extra mountpoints before mounting the first "
12067 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2882
12069 "These calls are I<only> necessary in some very limited circumstances, mainly "
12070 "the case where you want to mount a mix of unrelated and/or read-only "
12071 "filesystems together."
12075 #: ../src/guestfs-actions.pod:4298 ../fish/guestfish-actions.pod:2886
12077 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12078 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12079 "inside that. You can unpack this as follows in guestfish:"
12083 #: ../src/guestfs-actions.pod:4303 ../fish/guestfish-actions.pod:2891
12086 " add-ro Fedora-11-i686-Live.iso\n"
12088 " mkmountpoint /cd\n"
12089 " mkmountpoint /sqsh\n"
12090 " mkmountpoint /ext3fs\n"
12091 " mount /dev/sda /cd\n"
12092 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12093 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12098 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:2900
12099 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12103 #: ../src/guestfs-actions.pod:4314
12105 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12106 "may get unexpected errors if you try to mix these calls. It is safest to "
12107 "manually unmount filesystems and remove mountpoints after use."
12111 #: ../src/guestfs-actions.pod:4318
12113 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12114 "first, so for this to work for manual mountpoints, you must ensure that the "
12115 "innermost mountpoints have the longest pathnames, as in the example code "
12120 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2911
12121 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12125 #: ../src/guestfs-actions.pod:4325
12127 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12128 "means that C<guestfs_umount_all> is called when the handle is closed which "
12129 "can also trigger these issues."
12133 #: ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:5492
12134 msgid "(Added in 1.0.62)"
12138 #: ../src/guestfs-actions.pod:4333
12139 msgid "guestfs_mknod"
12143 #: ../src/guestfs-actions.pod:4335
12147 " guestfs_mknod (guestfs_h *g,\n"
12151 " const char *path);\n"
12156 #: ../src/guestfs-actions.pod:4342 ../fish/guestfish-actions.pod:2921
12158 "This call creates block or character special devices, or named pipes "
12163 #: ../src/guestfs-actions.pod:4345 ../fish/guestfish-actions.pod:2924
12165 "The C<mode> parameter should be the mode, using the standard constants. "
12166 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12167 "used when creating block and character special devices."
12171 #: ../src/guestfs-actions.pod:4350
12173 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12174 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12175 "regular file). These constants are available in the standard Linux header "
12176 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12177 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12178 "the appropriate constant for you."
12182 #: ../src/guestfs-actions.pod:4364
12183 msgid "guestfs_mknod_b"
12187 #: ../src/guestfs-actions.pod:4366
12191 " guestfs_mknod_b (guestfs_h *g,\n"
12195 " const char *path);\n"
12200 #: ../src/guestfs-actions.pod:4373
12202 "This call creates a block device node called C<path> with mode C<mode> and "
12203 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12204 "wrapper around C<guestfs_mknod>."
12208 #: ../src/guestfs-actions.pod:4383
12209 msgid "guestfs_mknod_c"
12213 #: ../src/guestfs-actions.pod:4385
12217 " guestfs_mknod_c (guestfs_h *g,\n"
12221 " const char *path);\n"
12226 #: ../src/guestfs-actions.pod:4392
12228 "This call creates a char device node called C<path> with mode C<mode> and "
12229 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12230 "wrapper around C<guestfs_mknod>."
12234 #: ../src/guestfs-actions.pod:4402
12235 msgid "guestfs_mkswap"
12239 #: ../src/guestfs-actions.pod:4404
12243 " guestfs_mkswap (guestfs_h *g,\n"
12244 " const char *device);\n"
12249 #: ../src/guestfs-actions.pod:4408 ../fish/guestfish-actions.pod:2963
12250 msgid "Create a swap partition on C<device>."
12254 #: ../src/guestfs-actions.pod:4414
12255 msgid "guestfs_mkswap_L"
12259 #: ../src/guestfs-actions.pod:4416
12263 " guestfs_mkswap_L (guestfs_h *g,\n"
12264 " const char *label,\n"
12265 " const char *device);\n"
12270 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:2969
12271 msgid "Create a swap partition on C<device> with label C<label>."
12275 #: ../src/guestfs-actions.pod:4423 ../fish/guestfish-actions.pod:2971
12277 "Note that you cannot attach a swap label to a block device "
12278 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12279 "the kernel or swap tools."
12283 #: ../src/guestfs-actions.pod:4431
12284 msgid "guestfs_mkswap_U"
12288 #: ../src/guestfs-actions.pod:4433
12292 " guestfs_mkswap_U (guestfs_h *g,\n"
12293 " const char *uuid,\n"
12294 " const char *device);\n"
12299 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2979
12300 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12304 #: ../src/guestfs-actions.pod:4444
12305 msgid "guestfs_mkswap_file"
12309 #: ../src/guestfs-actions.pod:4446
12313 " guestfs_mkswap_file (guestfs_h *g,\n"
12314 " const char *path);\n"
12319 #: ../src/guestfs-actions.pod:4450 ../fish/guestfish-actions.pod:2985
12320 msgid "Create a swap file."
12324 #: ../src/guestfs-actions.pod:4452
12326 "This command just writes a swap file signature to an existing file. To "
12327 "create the file itself, use something like C<guestfs_fallocate>."
12331 #: ../src/guestfs-actions.pod:4459
12332 msgid "guestfs_modprobe"
12336 #: ../src/guestfs-actions.pod:4461
12340 " guestfs_modprobe (guestfs_h *g,\n"
12341 " const char *modulename);\n"
12346 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2994
12347 msgid "This loads a kernel module in the appliance."
12351 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:2996
12353 "The kernel module must have been whitelisted when libguestfs was built (see "
12354 "C<appliance/kmod.whitelist.in> in the source)."
12358 #: ../src/guestfs-actions.pod:4474
12359 msgid "guestfs_mount"
12363 #: ../src/guestfs-actions.pod:4476
12367 " guestfs_mount (guestfs_h *g,\n"
12368 " const char *device,\n"
12369 " const char *mountpoint);\n"
12374 #: ../src/guestfs-actions.pod:4481 ../fish/guestfish-actions.pod:3003
12376 "Mount a guest disk at a position in the filesystem. Block devices are named "
12377 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12378 "those block devices contain partitions, they will have the usual names "
12379 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12383 #: ../src/guestfs-actions.pod:4487 ../fish/guestfish-actions.pod:3009
12385 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12386 "mounted on C</> before others can be mounted. Other filesystems can only be "
12387 "mounted on directories which already exist."
12391 #: ../src/guestfs-actions.pod:4492 ../fish/guestfish-actions.pod:3014
12393 "The mounted filesystem is writable, if we have sufficient permissions on the "
12394 "underlying device."
12398 #: ../src/guestfs-actions.pod:4495
12400 "B<Important note:> When you use this call, the filesystem options C<sync> "
12401 "and C<noatime> are set implicitly. This was originally done because we "
12402 "thought it would improve reliability, but it turns out that I<-o sync> has a "
12403 "very large negative performance impact and negligible effect on "
12404 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
12405 "in any code that needs performance, and instead use C<guestfs_mount_options> "
12406 "(use an empty string for the first parameter if you don't want any options)."
12410 #: ../src/guestfs-actions.pod:4509
12411 msgid "guestfs_mount_loop"
12415 #: ../src/guestfs-actions.pod:4511
12419 " guestfs_mount_loop (guestfs_h *g,\n"
12420 " const char *file,\n"
12421 " const char *mountpoint);\n"
12426 #: ../src/guestfs-actions.pod:4516 ../fish/guestfish-actions.pod:3031
12428 "This command lets you mount C<file> (a filesystem image in a file) on a "
12429 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12434 #: ../src/guestfs-actions.pod:4524
12435 msgid "guestfs_mount_options"
12439 #: ../src/guestfs-actions.pod:4526
12443 " guestfs_mount_options (guestfs_h *g,\n"
12444 " const char *options,\n"
12445 " const char *device,\n"
12446 " const char *mountpoint);\n"
12451 #: ../src/guestfs-actions.pod:4532
12453 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12454 "the mount options as for the L<mount(8)> I<-o> flag."
12458 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3043
12460 "If the C<options> parameter is an empty string, then no options are passed "
12461 "(all options default to whatever the filesystem uses)."
12465 #: ../src/guestfs-actions.pod:4542 ../src/guestfs-actions.pod:4556 ../src/guestfs-actions.pod:4573
12466 msgid "(Added in 1.0.10)"
12470 #: ../src/guestfs-actions.pod:4544
12471 msgid "guestfs_mount_ro"
12475 #: ../src/guestfs-actions.pod:4546
12479 " guestfs_mount_ro (guestfs_h *g,\n"
12480 " const char *device,\n"
12481 " const char *mountpoint);\n"
12486 #: ../src/guestfs-actions.pod:4551
12488 "This is the same as the C<guestfs_mount> command, but it mounts the "
12489 "filesystem with the read-only (I<-o ro>) flag."
12493 #: ../src/guestfs-actions.pod:4558
12494 msgid "guestfs_mount_vfs"
12498 #: ../src/guestfs-actions.pod:4560
12502 " guestfs_mount_vfs (guestfs_h *g,\n"
12503 " const char *options,\n"
12504 " const char *vfstype,\n"
12505 " const char *device,\n"
12506 " const char *mountpoint);\n"
12511 #: ../src/guestfs-actions.pod:4567
12513 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12514 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
12519 #: ../src/guestfs-actions.pod:4575
12520 msgid "guestfs_mountpoints"
12524 #: ../src/guestfs-actions.pod:4577
12528 " guestfs_mountpoints (guestfs_h *g);\n"
12533 #: ../src/guestfs-actions.pod:4580
12535 "This call is similar to C<guestfs_mounts>. That call returns a list of "
12536 "devices. This one returns a hash table (map) of device name to directory "
12537 "where the device is mounted."
12541 #: ../src/guestfs-actions.pod:4592
12542 msgid "guestfs_mounts"
12546 #: ../src/guestfs-actions.pod:4594
12550 " guestfs_mounts (guestfs_h *g);\n"
12555 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3074
12557 "This returns the list of currently mounted filesystems. It returns the list "
12558 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12562 #: ../src/guestfs-actions.pod:4600 ../fish/guestfish-actions.pod:3077
12563 msgid "Some internal mounts are not shown."
12567 #: ../src/guestfs-actions.pod:4602
12568 msgid "See also: C<guestfs_mountpoints>"
12572 #: ../src/guestfs-actions.pod:4610
12577 #: ../src/guestfs-actions.pod:4612
12581 " guestfs_mv (guestfs_h *g,\n"
12582 " const char *src,\n"
12583 " const char *dest);\n"
12588 #: ../src/guestfs-actions.pod:4617 ../fish/guestfish-actions.pod:3085
12590 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12591 "destination filename or destination directory."
12595 #: ../src/guestfs-actions.pod:4624
12596 msgid "guestfs_ntfs_3g_probe"
12600 #: ../src/guestfs-actions.pod:4626
12604 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12606 " const char *device);\n"
12611 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3092
12613 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12614 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12615 "read-write, and some cannot be mounted at all)."
12619 #: ../src/guestfs-actions.pod:4635 ../fish/guestfish-actions.pod:3096
12621 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12622 "can be mounted read-write. Set it to false if you want to test if the "
12623 "volume can be mounted read-only."
12627 #: ../src/guestfs-actions.pod:4639 ../fish/guestfish-actions.pod:3100
12629 "The return value is an integer which C<0> if the operation would succeed, or "
12630 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12634 #: ../src/guestfs-actions.pod:4645
12635 msgid "(Added in 1.0.43)"
12639 #: ../src/guestfs-actions.pod:4647
12640 msgid "guestfs_ntfsresize"
12644 #: ../src/guestfs-actions.pod:4649
12648 " guestfs_ntfsresize (guestfs_h *g,\n"
12649 " const char *device);\n"
12654 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3108
12656 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12657 "size of the underlying device."
12661 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3111
12663 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
12664 "consistency check (for safety). You have to boot into Windows to perform "
12665 "this check and clear this condition. Furthermore, ntfsresize refuses to "
12666 "resize filesystems which have been marked in this way. So in effect it is "
12667 "not possible to call ntfsresize multiple times on a single filesystem "
12668 "without booting into Windows between each resize."
12672 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3119
12673 msgid "See also L<ntfsresize(8)>."
12677 #: ../src/guestfs-actions.pod:4670
12678 msgid "guestfs_ntfsresize_size"
12682 #: ../src/guestfs-actions.pod:4672
12686 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12687 " const char *device,\n"
12688 " int64_t size);\n"
12693 #: ../src/guestfs-actions.pod:4677
12695 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12696 "to specify the new size (in bytes) explicitly."
12700 #: ../src/guestfs-actions.pod:4682 ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:5191 ../src/guestfs-actions.pod:5440 ../src/guestfs-actions.pod:6979
12701 msgid "(Added in 1.3.14)"
12705 #: ../src/guestfs-actions.pod:4684
12706 msgid "guestfs_part_add"
12710 #: ../src/guestfs-actions.pod:4686
12714 " guestfs_part_add (guestfs_h *g,\n"
12715 " const char *device,\n"
12716 " const char *prlogex,\n"
12717 " int64_t startsect,\n"
12718 " int64_t endsect);\n"
12723 #: ../src/guestfs-actions.pod:4693
12725 "This command adds a partition to C<device>. If there is no partition table "
12726 "on the device, call C<guestfs_part_init> first."
12730 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3135
12732 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12733 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12734 "C<logical>) and C<e> (or C<extended>) partition types."
12738 #: ../src/guestfs-actions.pod:4701 ../fish/guestfish-actions.pod:3140
12740 "C<startsect> and C<endsect> are the start and end of the partition in "
12741 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12742 "from the end of the disk (C<-1> is the last sector)."
12746 #: ../src/guestfs-actions.pod:4705
12748 "Creating a partition which covers the whole disk is not so easy. Use "
12749 "C<guestfs_part_disk> to do that."
12753 #: ../src/guestfs-actions.pod:4710 ../src/guestfs-actions.pod:4748 ../src/guestfs-actions.pod:4801 ../src/guestfs-actions.pod:4879 ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4936 ../src/guestfs-actions.pod:4976
12754 msgid "(Added in 1.0.78)"
12758 #: ../src/guestfs-actions.pod:4712
12759 msgid "guestfs_part_del"
12763 #: ../src/guestfs-actions.pod:4714
12767 " guestfs_part_del (guestfs_h *g,\n"
12768 " const char *device,\n"
12774 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3151
12775 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12779 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3153
12781 "Note that in the case of MBR partitioning, deleting an extended partition "
12782 "also deletes any logical partitions it contains."
12786 #: ../src/guestfs-actions.pod:4729
12787 msgid "guestfs_part_disk"
12791 #: ../src/guestfs-actions.pod:4731
12795 " guestfs_part_disk (guestfs_h *g,\n"
12796 " const char *device,\n"
12797 " const char *parttype);\n"
12802 #: ../src/guestfs-actions.pod:4736
12804 "This command is simply a combination of C<guestfs_part_init> followed by "
12805 "C<guestfs_part_add> to create a single primary partition covering the whole "
12810 #: ../src/guestfs-actions.pod:4740
12812 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12813 "possible values are described in C<guestfs_part_init>."
12817 #: ../src/guestfs-actions.pod:4750
12818 msgid "guestfs_part_get_bootable"
12822 #: ../src/guestfs-actions.pod:4752
12826 " guestfs_part_get_bootable (guestfs_h *g,\n"
12827 " const char *device,\n"
12833 #: ../src/guestfs-actions.pod:4757 ../fish/guestfish-actions.pod:3175
12835 "This command returns true if the partition C<partnum> on C<device> has the "
12836 "bootable flag set."
12840 #: ../src/guestfs-actions.pod:4760
12841 msgid "See also C<guestfs_part_set_bootable>."
12845 #: ../src/guestfs-actions.pod:4766
12846 msgid "guestfs_part_get_mbr_id"
12850 #: ../src/guestfs-actions.pod:4768
12854 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12855 " const char *device,\n"
12861 #: ../src/guestfs-actions.pod:4773 ../fish/guestfish-actions.pod:3184
12863 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12864 "partition C<partnum>."
12868 #: ../src/guestfs-actions.pod:4776 ../src/guestfs-actions.pod:4952
12870 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12871 "undefined results for other partition table types (see "
12872 "C<guestfs_part_get_parttype>)."
12876 #: ../src/guestfs-actions.pod:4784
12877 msgid "guestfs_part_get_parttype"
12881 #: ../src/guestfs-actions.pod:4786
12885 " guestfs_part_get_parttype (guestfs_h *g,\n"
12886 " const char *device);\n"
12891 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3195
12893 "This command examines the partition table on C<device> and returns the "
12894 "partition table type (format) being used."
12898 #: ../src/guestfs-actions.pod:4793
12900 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12901 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12902 "possible, although unusual. See C<guestfs_part_init> for a full list."
12906 #: ../src/guestfs-actions.pod:4803
12907 msgid "guestfs_part_init"
12911 #: ../src/guestfs-actions.pod:4805
12915 " guestfs_part_init (guestfs_h *g,\n"
12916 " const char *device,\n"
12917 " const char *parttype);\n"
12922 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3207
12924 "This creates an empty partition table on C<device> of one of the partition "
12925 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12926 "(for large disks)."
12930 #: ../src/guestfs-actions.pod:4814
12932 "Initially there are no partitions. Following this, you should call "
12933 "C<guestfs_part_add> for each partition required."
12937 #: ../src/guestfs-actions.pod:4817 ../fish/guestfish-actions.pod:3214
12938 msgid "Possible values for C<parttype> are:"
12942 #: ../src/guestfs-actions.pod:4821 ../fish/guestfish-actions.pod:3218
12943 msgid "B<efi> | B<gpt>"
12947 #: ../src/guestfs-actions.pod:4823 ../fish/guestfish-actions.pod:3220
12948 msgid "Intel EFI / GPT partition table."
12952 #: ../src/guestfs-actions.pod:4825 ../fish/guestfish-actions.pod:3222
12954 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12955 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12956 "the C<mbr> format."
12960 #: ../src/guestfs-actions.pod:4829 ../fish/guestfish-actions.pod:3226
12961 msgid "B<mbr> | B<msdos>"
12965 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:3228
12967 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12968 "Windows. This partition type will B<only> work for device sizes up to 2 "
12969 "TB. For large disks we recommend using C<gpt>."
12973 #: ../src/guestfs-actions.pod:4838 ../fish/guestfish-actions.pod:3235
12974 msgid "Other partition table types that may work but are not supported include:"
12978 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3240
12983 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3242
12984 msgid "AIX disk labels."
12988 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3244
12989 msgid "B<amiga> | B<rdb>"
12993 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3246
12994 msgid "Amiga \"Rigid Disk Block\" format."
12998 #: ../src/guestfs-actions.pod:4851 ../fish/guestfish-actions.pod:3248
13003 #: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3250
13004 msgid "BSD disk labels."
13008 #: ../src/guestfs-actions.pod:4855 ../fish/guestfish-actions.pod:3252
13013 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3254
13014 msgid "DASD, used on IBM mainframes."
13018 #: ../src/guestfs-actions.pod:4859 ../fish/guestfish-actions.pod:3256
13023 #: ../src/guestfs-actions.pod:4861 ../fish/guestfish-actions.pod:3258
13024 msgid "MIPS/SGI volumes."
13028 #: ../src/guestfs-actions.pod:4863 ../fish/guestfish-actions.pod:3260
13033 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3262
13034 msgid "Old Mac partition format. Modern Macs use C<gpt>."
13038 #: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3264
13043 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3266
13044 msgid "NEC PC-98 format, common in Japan apparently."
13048 #: ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3268
13053 #: ../src/guestfs-actions.pod:4873 ../fish/guestfish-actions.pod:3270
13054 msgid "Sun disk labels."
13058 #: ../src/guestfs-actions.pod:4881
13059 msgid "guestfs_part_list"
13063 #: ../src/guestfs-actions.pod:4883
13066 " struct guestfs_partition_list *\n"
13067 " guestfs_part_list (guestfs_h *g,\n"
13068 " const char *device);\n"
13073 #: ../src/guestfs-actions.pod:4887 ../fish/guestfish-actions.pod:3278
13075 "This command parses the partition table on C<device> and returns the list of "
13076 "partitions found."
13080 #: ../src/guestfs-actions.pod:4890 ../fish/guestfish-actions.pod:3281
13081 msgid "The fields in the returned structure are:"
13085 #: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3285
13086 msgid "B<part_num>"
13090 #: ../src/guestfs-actions.pod:4896 ../fish/guestfish-actions.pod:3287
13091 msgid "Partition number, counting from 1."
13095 #: ../src/guestfs-actions.pod:4898 ../fish/guestfish-actions.pod:3289
13096 msgid "B<part_start>"
13100 #: ../src/guestfs-actions.pod:4900
13102 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13103 "the device's sector size, see C<guestfs_blockdev_getss>."
13107 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3294
13108 msgid "B<part_end>"
13112 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3296
13113 msgid "End of the partition in bytes."
13117 #: ../src/guestfs-actions.pod:4907 ../fish/guestfish-actions.pod:3298
13118 msgid "B<part_size>"
13122 #: ../src/guestfs-actions.pod:4909 ../fish/guestfish-actions.pod:3300
13123 msgid "Size of the partition in bytes."
13127 #: ../src/guestfs-actions.pod:4913
13129 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13130 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13135 #: ../src/guestfs-actions.pod:4919
13136 msgid "guestfs_part_set_bootable"
13140 #: ../src/guestfs-actions.pod:4921
13144 " guestfs_part_set_bootable (guestfs_h *g,\n"
13145 " const char *device,\n"
13147 " int bootable);\n"
13152 #: ../src/guestfs-actions.pod:4927 ../fish/guestfish-actions.pod:3308
13154 "This sets the bootable flag on partition numbered C<partnum> on device "
13155 "C<device>. Note that partitions are numbered from 1."
13159 #: ../src/guestfs-actions.pod:4930 ../fish/guestfish-actions.pod:3311
13161 "The bootable flag is used by some operating systems (notably Windows) to "
13162 "determine which partition to boot from. It is by no means universally "
13167 #: ../src/guestfs-actions.pod:4938
13168 msgid "guestfs_part_set_mbr_id"
13172 #: ../src/guestfs-actions.pod:4940
13176 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13177 " const char *device,\n"
13184 #: ../src/guestfs-actions.pod:4946 ../fish/guestfish-actions.pod:3319
13186 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13187 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13188 "documentation are in fact hexadecimal numbers, but usually documented "
13189 "without any leading \"0x\" which might be confusing."
13193 #: ../src/guestfs-actions.pod:4960
13194 msgid "guestfs_part_set_name"
13198 #: ../src/guestfs-actions.pod:4962
13202 " guestfs_part_set_name (guestfs_h *g,\n"
13203 " const char *device,\n"
13205 " const char *name);\n"
13210 #: ../src/guestfs-actions.pod:4968 ../fish/guestfish-actions.pod:3333
13212 "This sets the partition name on partition numbered C<partnum> on device "
13213 "C<device>. Note that partitions are numbered from 1."
13217 #: ../src/guestfs-actions.pod:4971 ../fish/guestfish-actions.pod:3336
13219 "The partition name can only be set on certain types of partition table. "
13220 "This works on C<gpt> but not on C<mbr> partitions."
13224 #: ../src/guestfs-actions.pod:4978
13225 msgid "guestfs_part_to_dev"
13229 #: ../src/guestfs-actions.pod:4980
13233 " guestfs_part_to_dev (guestfs_h *g,\n"
13234 " const char *partition);\n"
13239 #: ../src/guestfs-actions.pod:4984 ../fish/guestfish-actions.pod:3343
13241 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13242 "partition number, returning the device name (eg. \"/dev/sdb\")."
13246 #: ../src/guestfs-actions.pod:4988
13248 "The named partition must exist, for example as a string returned from "
13249 "C<guestfs_list_partitions>."
13253 #: ../src/guestfs-actions.pod:4996
13254 msgid "guestfs_ping_daemon"
13258 #: ../src/guestfs-actions.pod:4998
13262 " guestfs_ping_daemon (guestfs_h *g);\n"
13267 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3354
13269 "This is a test probe into the guestfs daemon running inside the qemu "
13270 "subprocess. Calling this function checks that the daemon responds to the "
13271 "ping message, without affecting the daemon or attached block device(s) in "
13276 #: ../src/guestfs-actions.pod:5010
13277 msgid "guestfs_pread"
13281 #: ../src/guestfs-actions.pod:5012
13285 " guestfs_pread (guestfs_h *g,\n"
13286 " const char *path,\n"
13288 " int64_t offset,\n"
13289 " size_t *size_r);\n"
13294 #: ../src/guestfs-actions.pod:5019 ../fish/guestfish-actions.pod:3363
13296 "This command lets you read part of a file. It reads C<count> bytes of the "
13297 "file, starting at C<offset>, from file C<path>."
13301 #: ../src/guestfs-actions.pod:5022 ../src/guestfs-actions.pod:5048 ../fish/guestfish-actions.pod:3366 ../fish/guestfish-actions.pod:3381
13303 "This may read fewer bytes than requested. For further details see the "
13304 "L<pread(2)> system call."
13308 #: ../src/guestfs-actions.pod:5025
13309 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
13313 #: ../src/guestfs-actions.pod:5036
13314 msgid "guestfs_pread_device"
13318 #: ../src/guestfs-actions.pod:5038
13322 " guestfs_pread_device (guestfs_h *g,\n"
13323 " const char *device,\n"
13325 " int64_t offset,\n"
13326 " size_t *size_r);\n"
13331 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3378
13333 "This command lets you read part of a file. It reads C<count> bytes of "
13334 "C<device>, starting at C<offset>."
13338 #: ../src/guestfs-actions.pod:5051
13339 msgid "See also C<guestfs_pread>."
13343 #: ../src/guestfs-actions.pod:5060
13344 msgid "(Added in 1.5.21)"
13348 #: ../src/guestfs-actions.pod:5062
13349 msgid "guestfs_pvcreate"
13353 #: ../src/guestfs-actions.pod:5064
13357 " guestfs_pvcreate (guestfs_h *g,\n"
13358 " const char *device);\n"
13363 #: ../src/guestfs-actions.pod:5068 ../fish/guestfish-actions.pod:3393
13365 "This creates an LVM physical volume on the named C<device>, where C<device> "
13366 "should usually be a partition name such as C</dev/sda1>."
13370 #: ../src/guestfs-actions.pod:5076
13371 msgid "guestfs_pvremove"
13375 #: ../src/guestfs-actions.pod:5078
13379 " guestfs_pvremove (guestfs_h *g,\n"
13380 " const char *device);\n"
13385 #: ../src/guestfs-actions.pod:5082 ../fish/guestfish-actions.pod:3401
13387 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13392 #: ../src/guestfs-actions.pod:5085 ../fish/guestfish-actions.pod:3404
13394 "The implementation uses the C<pvremove> command which refuses to wipe "
13395 "physical volumes that contain any volume groups, so you have to remove those "
13400 #: ../src/guestfs-actions.pod:5093
13401 msgid "guestfs_pvresize"
13405 #: ../src/guestfs-actions.pod:5095
13409 " guestfs_pvresize (guestfs_h *g,\n"
13410 " const char *device);\n"
13415 #: ../src/guestfs-actions.pod:5099 ../fish/guestfish-actions.pod:3412
13417 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13418 "the new size of the underlying device."
13422 #: ../src/guestfs-actions.pod:5106
13423 msgid "guestfs_pvresize_size"
13427 #: ../src/guestfs-actions.pod:5108
13431 " guestfs_pvresize_size (guestfs_h *g,\n"
13432 " const char *device,\n"
13433 " int64_t size);\n"
13438 #: ../src/guestfs-actions.pod:5113
13440 "This command is the same as C<guestfs_pvresize> except that it allows you to "
13441 "specify the new size (in bytes) explicitly."
13445 #: ../src/guestfs-actions.pod:5120
13446 msgid "guestfs_pvs"
13450 #: ../src/guestfs-actions.pod:5122
13454 " guestfs_pvs (guestfs_h *g);\n"
13459 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3426
13461 "List all the physical volumes detected. This is the equivalent of the "
13462 "L<pvs(8)> command."
13466 #: ../src/guestfs-actions.pod:5128 ../fish/guestfish-actions.pod:3429
13468 "This returns a list of just the device names that contain PVs "
13469 "(eg. C</dev/sda2>)."
13473 #: ../src/guestfs-actions.pod:5131
13474 msgid "See also C<guestfs_pvs_full>."
13478 #: ../src/guestfs-actions.pod:5139
13479 msgid "guestfs_pvs_full"
13483 #: ../src/guestfs-actions.pod:5141
13486 " struct guestfs_lvm_pv_list *\n"
13487 " guestfs_pvs_full (guestfs_h *g);\n"
13492 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3438
13494 "List all the physical volumes detected. This is the equivalent of the "
13495 "L<pvs(8)> command. The \"full\" version includes all fields."
13499 #: ../src/guestfs-actions.pod:5147
13501 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
13502 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
13507 #: ../src/guestfs-actions.pod:5153
13508 msgid "guestfs_pvuuid"
13512 #: ../src/guestfs-actions.pod:5155
13516 " guestfs_pvuuid (guestfs_h *g,\n"
13517 " const char *device);\n"
13522 #: ../src/guestfs-actions.pod:5159 ../fish/guestfish-actions.pod:3445
13523 msgid "This command returns the UUID of the LVM PV C<device>."
13527 #: ../src/guestfs-actions.pod:5166
13528 msgid "guestfs_pwrite"
13532 #: ../src/guestfs-actions.pod:5168
13536 " guestfs_pwrite (guestfs_h *g,\n"
13537 " const char *path,\n"
13538 " const char *content,\n"
13539 " size_t content_size,\n"
13540 " int64_t offset);\n"
13545 #: ../src/guestfs-actions.pod:5175 ../fish/guestfish-actions.pod:3451
13547 "This command writes to part of a file. It writes the data buffer C<content> "
13548 "to the file C<path> starting at offset C<offset>."
13552 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3454
13554 "This command implements the L<pwrite(2)> system call, and like that system "
13555 "call it may not write the full data requested. The return value is the "
13556 "number of bytes that were actually written to the file. This could even be "
13557 "0, although short writes are unlikely for regular files in ordinary "
13562 #: ../src/guestfs-actions.pod:5184
13563 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
13567 #: ../src/guestfs-actions.pod:5193
13568 msgid "guestfs_pwrite_device"
13572 #: ../src/guestfs-actions.pod:5195
13576 " guestfs_pwrite_device (guestfs_h *g,\n"
13577 " const char *device,\n"
13578 " const char *content,\n"
13579 " size_t content_size,\n"
13580 " int64_t offset);\n"
13585 #: ../src/guestfs-actions.pod:5202 ../fish/guestfish-actions.pod:3469
13587 "This command writes to part of a device. It writes the data buffer "
13588 "C<content> to C<device> starting at offset C<offset>."
13592 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3472
13594 "This command implements the L<pwrite(2)> system call, and like that system "
13595 "call it may not write the full data requested (although short writes to disk "
13596 "devices and partitions are probably impossible with standard Linux kernels)."
13600 #: ../src/guestfs-actions.pod:5210
13601 msgid "See also C<guestfs_pwrite>."
13605 #: ../src/guestfs-actions.pod:5217
13606 msgid "(Added in 1.5.20)"
13610 #: ../src/guestfs-actions.pod:5219
13611 msgid "guestfs_read_file"
13615 #: ../src/guestfs-actions.pod:5221
13619 " guestfs_read_file (guestfs_h *g,\n"
13620 " const char *path,\n"
13621 " size_t *size_r);\n"
13626 #: ../src/guestfs-actions.pod:5226 ../fish/guestfish-actions.pod:3486
13627 msgid "This calls returns the contents of the file C<path> as a buffer."
13631 #: ../src/guestfs-actions.pod:5229
13633 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13634 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13635 "function is limited in the total size of file that can be handled."
13639 #: ../src/guestfs-actions.pod:5241
13640 msgid "(Added in 1.0.63)"
13644 #: ../src/guestfs-actions.pod:5243
13645 msgid "guestfs_read_lines"
13649 #: ../src/guestfs-actions.pod:5245
13653 " guestfs_read_lines (guestfs_h *g,\n"
13654 " const char *path);\n"
13659 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3503
13661 "The file contents are returned as a list of lines. Trailing C<LF> and "
13662 "C<CRLF> character sequences are I<not> returned."
13666 #: ../src/guestfs-actions.pod:5254
13668 "Note that this function cannot correctly handle binary files (specifically, "
13669 "files containing C<\\0> character which is treated as end of line). For "
13670 "those you need to use the C<guestfs_read_file> function which has a more "
13671 "complex interface."
13675 #: ../src/guestfs-actions.pod:5265
13676 msgid "guestfs_readdir"
13680 #: ../src/guestfs-actions.pod:5267
13683 " struct guestfs_dirent_list *\n"
13684 " guestfs_readdir (guestfs_h *g,\n"
13685 " const char *dir);\n"
13690 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3515
13691 msgid "This returns the list of directory entries in directory C<dir>."
13695 #: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:3517
13697 "All entries in the directory are returned, including C<.> and C<..>. The "
13698 "entries are I<not> sorted, but returned in the same order as the underlying "
13703 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3521
13705 "Also this call returns basic file type information about each file. The "
13706 "C<ftyp> field will contain one of the following characters:"
13710 #: ../src/guestfs-actions.pod:5282 ../fish/guestfish-actions.pod:3526
13715 #: ../src/guestfs-actions.pod:5284 ../fish/guestfish-actions.pod:3528
13716 msgid "Block special"
13720 #: ../src/guestfs-actions.pod:5286 ../fish/guestfish-actions.pod:3530
13725 #: ../src/guestfs-actions.pod:5288 ../fish/guestfish-actions.pod:3532
13726 msgid "Char special"
13730 #: ../src/guestfs-actions.pod:5290 ../fish/guestfish-actions.pod:3534
13735 #: ../src/guestfs-actions.pod:5292 ../fish/guestfish-actions.pod:3536
13740 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3538
13745 #: ../src/guestfs-actions.pod:5296 ../fish/guestfish-actions.pod:3540
13746 msgid "FIFO (named pipe)"
13750 #: ../src/guestfs-actions.pod:5298 ../fish/guestfish-actions.pod:3542
13755 #: ../src/guestfs-actions.pod:5300 ../fish/guestfish-actions.pod:3544
13756 msgid "Symbolic link"
13760 #: ../src/guestfs-actions.pod:5302 ../fish/guestfish-actions.pod:3546
13765 #: ../src/guestfs-actions.pod:5304 ../fish/guestfish-actions.pod:3548
13766 msgid "Regular file"
13770 #: ../src/guestfs-actions.pod:5306 ../fish/guestfish-actions.pod:3550
13775 #: ../src/guestfs-actions.pod:5308 ../fish/guestfish-actions.pod:3552
13780 #: ../src/guestfs-actions.pod:5310 ../fish/guestfish-actions.pod:3554
13785 #: ../src/guestfs-actions.pod:5312 ../fish/guestfish-actions.pod:3556
13786 msgid "Unknown file type"
13790 #: ../src/guestfs-actions.pod:5314 ../fish/guestfish-actions.pod:3558
13795 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3560
13796 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13800 #: ../src/guestfs-actions.pod:5321
13802 "This function is primarily intended for use by programs. To get a simple "
13803 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13804 "consumption, use C<guestfs_ll>."
13808 #: ../src/guestfs-actions.pod:5325
13810 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13811 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
13816 #: ../src/guestfs-actions.pod:5331
13817 msgid "guestfs_readlink"
13821 #: ../src/guestfs-actions.pod:5333
13825 " guestfs_readlink (guestfs_h *g,\n"
13826 " const char *path);\n"
13831 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3573
13832 msgid "This command reads the target of a symbolic link."
13836 #: ../src/guestfs-actions.pod:5344
13837 msgid "guestfs_readlinklist"
13841 #: ../src/guestfs-actions.pod:5346
13845 " guestfs_readlinklist (guestfs_h *g,\n"
13846 " const char *path,\n"
13847 " char *const *names);\n"
13852 #: ../src/guestfs-actions.pod:5351 ../fish/guestfish-actions.pod:3579
13854 "This call allows you to do a C<readlink> operation on multiple files, where "
13855 "all files are in the directory C<path>. C<names> is the list of files from "
13860 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3583
13862 "On return you get a list of strings, with a one-to-one correspondence to the "
13863 "C<names> list. Each string is the value of the symbolic link."
13867 #: ../src/guestfs-actions.pod:5359 ../fish/guestfish-actions.pod:3587
13869 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13870 "result string is the empty string C<\"\">. However the whole operation is "
13871 "completed even if there were C<readlink(2)> errors, and so you can call this "
13872 "function with names where you don't know if they are symbolic links already "
13873 "(albeit slightly less efficient)."
13877 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3594
13879 "This call is intended for programs that want to efficiently list a directory "
13880 "contents without making many round-trips. Very long directory listings "
13881 "might cause the protocol message size to be exceeded, causing this call to "
13882 "fail. The caller must split up such requests into smaller groups of names."
13886 #: ../src/guestfs-actions.pod:5379
13887 msgid "guestfs_realpath"
13891 #: ../src/guestfs-actions.pod:5381
13895 " guestfs_realpath (guestfs_h *g,\n"
13896 " const char *path);\n"
13901 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3605
13903 "Return the canonicalized absolute pathname of C<path>. The returned path "
13904 "has no C<.>, C<..> or symbolic link path elements."
13908 #: ../src/guestfs-actions.pod:5393
13909 msgid "guestfs_removexattr"
13913 #: ../src/guestfs-actions.pod:5395
13917 " guestfs_removexattr (guestfs_h *g,\n"
13918 " const char *xattr,\n"
13919 " const char *path);\n"
13924 #: ../src/guestfs-actions.pod:5400 ../fish/guestfish-actions.pod:3612
13925 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
13929 #: ../src/guestfs-actions.pod:5403
13930 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13934 #: ../src/guestfs-actions.pod:5409
13935 msgid "guestfs_resize2fs"
13939 #: ../src/guestfs-actions.pod:5411
13943 " guestfs_resize2fs (guestfs_h *g,\n"
13944 " const char *device);\n"
13949 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3621
13951 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13952 "underlying device."
13956 #: ../src/guestfs-actions.pod:5418
13958 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13959 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13960 "sometimes gives an error about this and sometimes not. In any case, it is "
13961 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13965 #: ../src/guestfs-actions.pod:5428
13966 msgid "guestfs_resize2fs_size"
13970 #: ../src/guestfs-actions.pod:5430
13974 " guestfs_resize2fs_size (guestfs_h *g,\n"
13975 " const char *device,\n"
13976 " int64_t size);\n"
13981 #: ../src/guestfs-actions.pod:5435
13983 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13984 "to specify the new size (in bytes) explicitly."
13988 #: ../src/guestfs-actions.pod:5442
13993 #: ../src/guestfs-actions.pod:5444
13997 " guestfs_rm (guestfs_h *g,\n"
13998 " const char *path);\n"
14003 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3641
14004 msgid "Remove the single file C<path>."
14008 #: ../src/guestfs-actions.pod:5454
14009 msgid "guestfs_rm_rf"
14013 #: ../src/guestfs-actions.pod:5456
14017 " guestfs_rm_rf (guestfs_h *g,\n"
14018 " const char *path);\n"
14023 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3647
14025 "Remove the file or directory C<path>, recursively removing the contents if "
14026 "its a directory. This is like the C<rm -rf> shell command."
14030 #: ../src/guestfs-actions.pod:5468
14031 msgid "guestfs_rmdir"
14035 #: ../src/guestfs-actions.pod:5470
14039 " guestfs_rmdir (guestfs_h *g,\n"
14040 " const char *path);\n"
14045 #: ../src/guestfs-actions.pod:5474 ../fish/guestfish-actions.pod:3655
14046 msgid "Remove the single directory C<path>."
14050 #: ../src/guestfs-actions.pod:5480
14051 msgid "guestfs_rmmountpoint"
14055 #: ../src/guestfs-actions.pod:5482
14059 " guestfs_rmmountpoint (guestfs_h *g,\n"
14060 " const char *exemptpath);\n"
14065 #: ../src/guestfs-actions.pod:5486
14067 "This calls removes a mountpoint that was previously created with "
14068 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14072 #: ../src/guestfs-actions.pod:5494
14073 msgid "guestfs_scrub_device"
14077 #: ../src/guestfs-actions.pod:5496
14081 " guestfs_scrub_device (guestfs_h *g,\n"
14082 " const char *device);\n"
14087 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3669
14089 "This command writes patterns over C<device> to make data retrieval more "
14094 #: ../src/guestfs-actions.pod:5503 ../src/guestfs-actions.pod:5524 ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3672 ../fish/guestfish-actions.pod:3687 ../fish/guestfish-actions.pod:3700
14096 "It is an interface to the L<scrub(1)> program. See that manual page for "
14101 #: ../src/guestfs-actions.pod:5511 ../src/guestfs-actions.pod:5529 ../src/guestfs-actions.pod:5548
14102 msgid "(Added in 1.0.52)"
14106 #: ../src/guestfs-actions.pod:5513
14107 msgid "guestfs_scrub_file"
14111 #: ../src/guestfs-actions.pod:5515
14115 " guestfs_scrub_file (guestfs_h *g,\n"
14116 " const char *file);\n"
14121 #: ../src/guestfs-actions.pod:5519 ../fish/guestfish-actions.pod:3682
14123 "This command writes patterns over a file to make data retrieval more "
14128 #: ../src/guestfs-actions.pod:5522 ../fish/guestfish-actions.pod:3685
14129 msgid "The file is I<removed> after scrubbing."
14133 #: ../src/guestfs-actions.pod:5531
14134 msgid "guestfs_scrub_freespace"
14138 #: ../src/guestfs-actions.pod:5533
14142 " guestfs_scrub_freespace (guestfs_h *g,\n"
14143 " const char *dir);\n"
14148 #: ../src/guestfs-actions.pod:5537
14150 "This command creates the directory C<dir> and then fills it with files until "
14151 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14152 "and deletes them. The intention is to scrub any free space on the partition "
14153 "containing C<dir>."
14157 #: ../src/guestfs-actions.pod:5550
14158 msgid "guestfs_set_append"
14162 #: ../src/guestfs-actions.pod:5552
14166 " guestfs_set_append (guestfs_h *g,\n"
14167 " const char *append);\n"
14172 #: ../src/guestfs-actions.pod:5556 ../fish/guestfish-actions.pod:3709
14174 "This function is used to add additional options to the guest kernel command "
14179 #: ../src/guestfs-actions.pod:5559 ../fish/guestfish-actions.pod:3712
14181 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14182 "environment variable."
14186 #: ../src/guestfs-actions.pod:5562 ../fish/guestfish-actions.pod:3715
14188 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14189 "(libguestfs always adds a few of its own)."
14193 #: ../src/guestfs-actions.pod:5569
14194 msgid "guestfs_set_autosync"
14198 #: ../src/guestfs-actions.pod:5571
14202 " guestfs_set_autosync (guestfs_h *g,\n"
14203 " int autosync);\n"
14208 #: ../src/guestfs-actions.pod:5575
14210 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14211 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
14212 "the handle is closed (also if the program exits without closing handles)."
14216 #: ../src/guestfs-actions.pod:5580 ../fish/guestfish-actions.pod:3729
14218 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14219 "disabled by default)."
14223 #: ../src/guestfs-actions.pod:5587
14224 msgid "guestfs_set_direct"
14228 #: ../src/guestfs-actions.pod:5589
14232 " guestfs_set_direct (guestfs_h *g,\n"
14238 #: ../src/guestfs-actions.pod:5593 ../fish/guestfish-actions.pod:3738
14240 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14241 "passed directly through to the appliance once it is launched."
14245 #: ../src/guestfs-actions.pod:5597
14247 "One consequence of this is that log messages aren't caught by the library "
14248 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
14253 #: ../src/guestfs-actions.pod:5601 ../fish/guestfish-actions.pod:3746
14254 msgid "You probably don't want to use this unless you know what you are doing."
14258 #: ../src/guestfs-actions.pod:5604 ../fish/guestfish-actions.pod:3749
14259 msgid "The default is disabled."
14263 #: ../src/guestfs-actions.pod:5610
14264 msgid "guestfs_set_e2label"
14268 #: ../src/guestfs-actions.pod:5612
14272 " guestfs_set_e2label (guestfs_h *g,\n"
14273 " const char *device,\n"
14274 " const char *label);\n"
14279 #: ../src/guestfs-actions.pod:5617 ../fish/guestfish-actions.pod:3755
14281 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14282 "C<label>. Filesystem labels are limited to 16 characters."
14286 #: ../src/guestfs-actions.pod:5621
14288 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
14289 "the existing label on a filesystem."
14293 #: ../src/guestfs-actions.pod:5628
14294 msgid "guestfs_set_e2uuid"
14298 #: ../src/guestfs-actions.pod:5630
14302 " guestfs_set_e2uuid (guestfs_h *g,\n"
14303 " const char *device,\n"
14304 " const char *uuid);\n"
14309 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3766
14311 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14312 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14313 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14317 #: ../src/guestfs-actions.pod:5640
14319 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
14320 "the existing UUID of a filesystem."
14324 #: ../src/guestfs-actions.pod:5647
14325 msgid "guestfs_set_memsize"
14329 #: ../src/guestfs-actions.pod:5649
14333 " guestfs_set_memsize (guestfs_h *g,\n"
14339 #: ../src/guestfs-actions.pod:5653
14341 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14342 "This only has any effect if called before C<guestfs_launch>."
14346 #: ../src/guestfs-actions.pod:5657 ../fish/guestfish-actions.pod:3784
14348 "You can also change this by setting the environment variable "
14349 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14353 #: ../src/guestfs-actions.pod:5668
14354 msgid "guestfs_set_network"
14358 #: ../src/guestfs-actions.pod:5670
14362 " guestfs_set_network (guestfs_h *g,\n"
14368 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3797
14370 "If C<network> is true, then the network is enabled in the libguestfs "
14371 "appliance. The default is false."
14375 #: ../src/guestfs-actions.pod:5677 ../fish/guestfish-actions.pod:3800
14377 "This affects whether commands are able to access the network (see "
14378 "L<guestfs(3)/RUNNING COMMANDS>)."
14382 #: ../src/guestfs-actions.pod:5680
14384 "You must call this before calling C<guestfs_launch>, otherwise it has no "
14389 #: ../src/guestfs-actions.pod:5687
14390 msgid "guestfs_set_path"
14394 #: ../src/guestfs-actions.pod:5689
14398 " guestfs_set_path (guestfs_h *g,\n"
14399 " const char *searchpath);\n"
14404 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3812
14405 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14409 #: ../src/guestfs-actions.pod:5695 ../fish/guestfish-actions.pod:3814
14411 "The default is C<$libdir/guestfs> unless overridden by setting "
14412 "C<LIBGUESTFS_PATH> environment variable."
14416 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3817
14417 msgid "Setting C<path> to C<NULL> restores the default path."
14421 #: ../src/guestfs-actions.pod:5704
14422 msgid "guestfs_set_qemu"
14426 #: ../src/guestfs-actions.pod:5706
14430 " guestfs_set_qemu (guestfs_h *g,\n"
14431 " const char *qemu);\n"
14436 #: ../src/guestfs-actions.pod:5710 ../fish/guestfish-actions.pod:3825
14437 msgid "Set the qemu binary that we will use."
14441 #: ../src/guestfs-actions.pod:5712 ../fish/guestfish-actions.pod:3827
14442 msgid "The default is chosen when the library was compiled by the configure script."
14446 #: ../src/guestfs-actions.pod:5715 ../fish/guestfish-actions.pod:3830
14448 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14453 #: ../src/guestfs-actions.pod:5718 ../fish/guestfish-actions.pod:3833
14454 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14458 #: ../src/guestfs-actions.pod:5720 ../fish/guestfish-actions.pod:3835
14460 "Note that you should call this function as early as possible after creating "
14461 "the handle. This is because some pre-launch operations depend on testing "
14462 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14463 "don't retest features, and so you might see inconsistent results. Using the "
14464 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14465 "the qemu binary at the same time as the handle is created."
14469 #: ../src/guestfs-actions.pod:5732
14470 msgid "guestfs_set_recovery_proc"
14474 #: ../src/guestfs-actions.pod:5734
14478 " guestfs_set_recovery_proc (guestfs_h *g,\n"
14479 " int recoveryproc);\n"
14484 #: ../src/guestfs-actions.pod:5738
14486 "If this is called with the parameter C<false> then C<guestfs_launch> does "
14487 "not create a recovery process. The purpose of the recovery process is to "
14488 "stop runaway qemu processes in the case where the main program aborts "
14493 #: ../src/guestfs-actions.pod:5743
14495 "This only has any effect if called before C<guestfs_launch>, and the default "
14500 #: ../src/guestfs-actions.pod:5746 ../fish/guestfish-actions.pod:3857
14502 "About the only time when you would want to disable this is if the main "
14503 "process will fork itself into the background (\"daemonize\" itself). In "
14504 "this case the recovery process thinks that the main program has disappeared "
14505 "and so kills qemu, which is not very helpful."
14509 #: ../src/guestfs-actions.pod:5756
14510 msgid "guestfs_set_selinux"
14514 #: ../src/guestfs-actions.pod:5758
14518 " guestfs_set_selinux (guestfs_h *g,\n"
14524 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3869
14526 "This sets the selinux flag that is passed to the appliance at boot time. "
14527 "The default is C<selinux=0> (disabled)."
14531 #: ../src/guestfs-actions.pod:5765 ../fish/guestfish-actions.pod:3872
14533 "Note that if SELinux is enabled, it is always in Permissive mode "
14534 "(C<enforcing=0>)."
14538 #: ../src/guestfs-actions.pod:5775
14539 msgid "guestfs_set_trace"
14543 #: ../src/guestfs-actions.pod:5777
14547 " guestfs_set_trace (guestfs_h *g,\n"
14553 #: ../src/guestfs-actions.pod:5781 ../fish/guestfish-actions.pod:3884
14555 "If the command trace flag is set to 1, then commands are printed on stderr "
14556 "before they are executed in a format which is very similar to the one used "
14557 "by guestfish. In other words, you can run a program with this enabled, and "
14558 "you will get out a script which you can feed to guestfish to perform the "
14559 "same set of actions."
14563 #: ../src/guestfs-actions.pod:5788 ../fish/guestfish-actions.pod:3891
14565 "If you want to trace C API calls into libguestfs (and other libraries) then "
14566 "possibly a better way is to use the external ltrace(1) command."
14570 #: ../src/guestfs-actions.pod:5792 ../fish/guestfish-actions.pod:3895
14572 "Command traces are disabled unless the environment variable "
14573 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14577 #: ../src/guestfs-actions.pod:5799
14578 msgid "guestfs_set_verbose"
14582 #: ../src/guestfs-actions.pod:5801
14586 " guestfs_set_verbose (guestfs_h *g,\n"
14592 #: ../src/guestfs-actions.pod:5805 ../fish/guestfish-actions.pod:3904
14593 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
14597 #: ../src/guestfs-actions.pod:5807 ../fish/guestfish-actions.pod:3906
14599 "Verbose messages are disabled unless the environment variable "
14600 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14604 #: ../src/guestfs-actions.pod:5814
14605 msgid "guestfs_setcon"
14609 #: ../src/guestfs-actions.pod:5816
14613 " guestfs_setcon (guestfs_h *g,\n"
14614 " const char *context);\n"
14619 #: ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:3913
14621 "This sets the SELinux security context of the daemon to the string "
14626 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3916
14627 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14631 #: ../src/guestfs-actions.pod:5829
14632 msgid "guestfs_setxattr"
14636 #: ../src/guestfs-actions.pod:5831
14640 " guestfs_setxattr (guestfs_h *g,\n"
14641 " const char *xattr,\n"
14642 " const char *val,\n"
14644 " const char *path);\n"
14649 #: ../src/guestfs-actions.pod:5838 ../fish/guestfish-actions.pod:3922
14651 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14652 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14656 #: ../src/guestfs-actions.pod:5842
14657 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14661 #: ../src/guestfs-actions.pod:5848
14662 msgid "guestfs_sfdisk"
14666 #: ../src/guestfs-actions.pod:5850
14670 " guestfs_sfdisk (guestfs_h *g,\n"
14671 " const char *device,\n"
14675 " char *const *lines);\n"
14680 #: ../src/guestfs-actions.pod:5858 ../fish/guestfish-actions.pod:3932
14682 "This is a direct interface to the L<sfdisk(8)> program for creating "
14683 "partitions on block devices."
14687 #: ../src/guestfs-actions.pod:5861 ../fish/guestfish-actions.pod:3935
14688 msgid "C<device> should be a block device, for example C</dev/sda>."
14692 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3937
14694 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14695 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14696 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14697 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14698 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14699 "the kernel) cannot work out the right geometry and you will need to tell it."
14703 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3945
14705 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14706 "refer to the L<sfdisk(8)> manpage."
14710 #: ../src/guestfs-actions.pod:5874 ../fish/guestfish-actions.pod:3948
14712 "To create a single partition occupying the whole disk, you would pass "
14713 "C<lines> as a single element list, when the single element being the string "
14718 #: ../src/guestfs-actions.pod:5878
14719 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14723 #: ../src/guestfs-actions.pod:5888
14724 msgid "guestfs_sfdiskM"
14728 #: ../src/guestfs-actions.pod:5890
14732 " guestfs_sfdiskM (guestfs_h *g,\n"
14733 " const char *device,\n"
14734 " char *const *lines);\n"
14739 #: ../src/guestfs-actions.pod:5895
14741 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14742 "partition sizes are specified in megabytes only (rounded to the nearest "
14743 "cylinder) and you don't need to specify the cyls, heads and sectors "
14744 "parameters which were rarely if ever used anyway."
14748 #: ../src/guestfs-actions.pod:5901
14750 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14751 "C<guestfs_part_disk>"
14755 #: ../src/guestfs-actions.pod:5911
14756 msgid "guestfs_sfdisk_N"
14760 #: ../src/guestfs-actions.pod:5913
14764 " guestfs_sfdisk_N (guestfs_h *g,\n"
14765 " const char *device,\n"
14770 " const char *line);\n"
14775 #: ../src/guestfs-actions.pod:5922 ../fish/guestfish-actions.pod:3978
14777 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14778 "(note: C<n> counts from 1)."
14782 #: ../src/guestfs-actions.pod:5925
14784 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14785 "for the cyls/heads/sectors parameters."
14789 #: ../src/guestfs-actions.pod:5928
14790 msgid "See also: C<guestfs_part_add>"
14794 #: ../src/guestfs-actions.pod:5937
14795 msgid "guestfs_sfdisk_disk_geometry"
14799 #: ../src/guestfs-actions.pod:5939
14803 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14804 " const char *device);\n"
14809 #: ../src/guestfs-actions.pod:5943
14811 "This displays the disk geometry of C<device> read from the partition table. "
14812 "Especially in the case where the underlying block device has been resized, "
14813 "this can be different from the kernel's idea of the geometry (see "
14814 "C<guestfs_sfdisk_kernel_geometry>)."
14818 #: ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:5964 ../fish/guestfish-actions.pod:3998 ../fish/guestfish-actions.pod:4007
14819 msgid "The result is in human-readable format, and not designed to be parsed."
14823 #: ../src/guestfs-actions.pod:5956
14824 msgid "guestfs_sfdisk_kernel_geometry"
14828 #: ../src/guestfs-actions.pod:5958
14832 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14833 " const char *device);\n"
14838 #: ../src/guestfs-actions.pod:5962 ../fish/guestfish-actions.pod:4005
14839 msgid "This displays the kernel's idea of the geometry of C<device>."
14843 #: ../src/guestfs-actions.pod:5972
14844 msgid "guestfs_sfdisk_l"
14848 #: ../src/guestfs-actions.pod:5974
14852 " guestfs_sfdisk_l (guestfs_h *g,\n"
14853 " const char *device);\n"
14858 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4014
14860 "This displays the partition table on C<device>, in the human-readable output "
14861 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14865 #: ../src/guestfs-actions.pod:5982
14866 msgid "See also: C<guestfs_part_list>"
14870 #: ../src/guestfs-actions.pod:5989
14875 #: ../src/guestfs-actions.pod:5991
14879 " guestfs_sh (guestfs_h *g,\n"
14880 " const char *command);\n"
14885 #: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:4024
14887 "This call runs a command from the guest filesystem via the guest's "
14892 #: ../src/guestfs-actions.pod:5998
14893 msgid "This is like C<guestfs_command>, but passes the command to:"
14897 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4029
14900 " /bin/sh -c \"command\"\n"
14905 #: ../src/guestfs-actions.pod:6002 ../fish/guestfish-actions.pod:4031
14907 "Depending on the guest's shell, this usually results in wildcards being "
14908 "expanded, shell expressions being interpolated and so on."
14912 #: ../src/guestfs-actions.pod:6006
14913 msgid "All the provisos about C<guestfs_command> apply to this call."
14917 #: ../src/guestfs-actions.pod:6013
14918 msgid "guestfs_sh_lines"
14922 #: ../src/guestfs-actions.pod:6015
14926 " guestfs_sh_lines (guestfs_h *g,\n"
14927 " const char *command);\n"
14932 #: ../src/guestfs-actions.pod:6019
14934 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14939 #: ../src/guestfs-actions.pod:6022
14940 msgid "See also: C<guestfs_command_lines>"
14944 #: ../src/guestfs-actions.pod:6030
14945 msgid "guestfs_sleep"
14949 #: ../src/guestfs-actions.pod:6032
14953 " guestfs_sleep (guestfs_h *g,\n"
14959 #: ../src/guestfs-actions.pod:6036 ../fish/guestfish-actions.pod:4050
14960 msgid "Sleep for C<secs> seconds."
14964 #: ../src/guestfs-actions.pod:6040
14965 msgid "(Added in 1.0.41)"
14969 #: ../src/guestfs-actions.pod:6042 ../src/guestfs-structs.pod:109
14970 msgid "guestfs_stat"
14974 #: ../src/guestfs-actions.pod:6044
14977 " struct guestfs_stat *\n"
14978 " guestfs_stat (guestfs_h *g,\n"
14979 " const char *path);\n"
14984 #: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4058
14985 msgid "This is the same as the C<stat(2)> system call."
14989 #: ../src/guestfs-actions.pod:6058 ../src/guestfs-structs.pod:135
14990 msgid "guestfs_statvfs"
14994 #: ../src/guestfs-actions.pod:6060
14997 " struct guestfs_statvfs *\n"
14998 " guestfs_statvfs (guestfs_h *g,\n"
14999 " const char *path);\n"
15004 #: ../src/guestfs-actions.pod:6064 ../fish/guestfish-actions.pod:4064
15006 "Returns file system statistics for any mounted file system. C<path> should "
15007 "be a file or directory in the mounted file system (typically it is the mount "
15008 "point itself, but it doesn't need to be)."
15012 #: ../src/guestfs-actions.pod:6068 ../fish/guestfish-actions.pod:4068
15013 msgid "This is the same as the C<statvfs(2)> system call."
15017 #: ../src/guestfs-actions.pod:6070
15019 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
15020 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
15024 #: ../src/guestfs-actions.pod:6076
15025 msgid "guestfs_strings"
15029 #: ../src/guestfs-actions.pod:6078
15033 " guestfs_strings (guestfs_h *g,\n"
15034 " const char *path);\n"
15039 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4074
15041 "This runs the L<strings(1)> command on a file and returns the list of "
15042 "printable strings found."
15046 #: ../src/guestfs-actions.pod:6094
15047 msgid "guestfs_strings_e"
15051 #: ../src/guestfs-actions.pod:6096
15055 " guestfs_strings_e (guestfs_h *g,\n"
15056 " const char *encoding,\n"
15057 " const char *path);\n"
15062 #: ../src/guestfs-actions.pod:6101
15064 "This is like the C<guestfs_strings> command, but allows you to specify the "
15065 "encoding of strings that are looked for in the source file C<path>."
15069 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4088
15070 msgid "Allowed encodings are:"
15074 #: ../src/guestfs-actions.pod:6109 ../fish/guestfish-actions.pod:4092
15079 #: ../src/guestfs-actions.pod:6111
15081 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15082 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15086 #: ../src/guestfs-actions.pod:6114 ../fish/guestfish-actions.pod:4097
15091 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4099
15092 msgid "Single 8-bit-byte characters."
15096 #: ../src/guestfs-actions.pod:6118 ../fish/guestfish-actions.pod:4101
15101 #: ../src/guestfs-actions.pod:6120 ../fish/guestfish-actions.pod:4103
15102 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15106 #: ../src/guestfs-actions.pod:6123 ../fish/guestfish-actions.pod:4106
15107 msgid "l (lower case letter L)"
15111 #: ../src/guestfs-actions.pod:6125 ../fish/guestfish-actions.pod:4108
15113 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15114 "examining binaries in Windows guests."
15118 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4111
15123 #: ../src/guestfs-actions.pod:6130 ../fish/guestfish-actions.pod:4113
15124 msgid "32-bit big endian such as UCS-4BE."
15128 #: ../src/guestfs-actions.pod:6132 ../fish/guestfish-actions.pod:4115
15133 #: ../src/guestfs-actions.pod:6134 ../fish/guestfish-actions.pod:4117
15134 msgid "32-bit little endian such as UCS-4LE."
15138 #: ../src/guestfs-actions.pod:6138 ../fish/guestfish-actions.pod:4121
15139 msgid "The returned strings are transcoded to UTF-8."
15143 #: ../src/guestfs-actions.pod:6149
15144 msgid "guestfs_swapoff_device"
15148 #: ../src/guestfs-actions.pod:6151
15152 " guestfs_swapoff_device (guestfs_h *g,\n"
15153 " const char *device);\n"
15158 #: ../src/guestfs-actions.pod:6155
15160 "This command disables the libguestfs appliance swap device or partition "
15161 "named C<device>. See C<guestfs_swapon_device>."
15165 #: ../src/guestfs-actions.pod:6163
15166 msgid "guestfs_swapoff_file"
15170 #: ../src/guestfs-actions.pod:6165
15174 " guestfs_swapoff_file (guestfs_h *g,\n"
15175 " const char *file);\n"
15180 #: ../src/guestfs-actions.pod:6169 ../fish/guestfish-actions.pod:4138
15181 msgid "This command disables the libguestfs appliance swap on file."
15185 #: ../src/guestfs-actions.pod:6175
15186 msgid "guestfs_swapoff_label"
15190 #: ../src/guestfs-actions.pod:6177
15194 " guestfs_swapoff_label (guestfs_h *g,\n"
15195 " const char *label);\n"
15200 #: ../src/guestfs-actions.pod:6181 ../fish/guestfish-actions.pod:4144
15202 "This command disables the libguestfs appliance swap on labeled swap "
15207 #: ../src/guestfs-actions.pod:6188
15208 msgid "guestfs_swapoff_uuid"
15212 #: ../src/guestfs-actions.pod:6190
15216 " guestfs_swapoff_uuid (guestfs_h *g,\n"
15217 " const char *uuid);\n"
15222 #: ../src/guestfs-actions.pod:6194 ../fish/guestfish-actions.pod:4151
15224 "This command disables the libguestfs appliance swap partition with the given "
15229 #: ../src/guestfs-actions.pod:6201
15230 msgid "guestfs_swapon_device"
15234 #: ../src/guestfs-actions.pod:6203
15238 " guestfs_swapon_device (guestfs_h *g,\n"
15239 " const char *device);\n"
15244 #: ../src/guestfs-actions.pod:6207
15246 "This command enables the libguestfs appliance to use the swap device or "
15247 "partition named C<device>. The increased memory is made available for all "
15248 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
15252 #: ../src/guestfs-actions.pod:6212 ../fish/guestfish-actions.pod:4163
15254 "Note that you should not swap to existing guest swap partitions unless you "
15255 "know what you are doing. They may contain hibernation information, or other "
15256 "information that the guest doesn't want you to trash. You also risk leaking "
15257 "information about the host to the guest this way. Instead, attach a new "
15258 "host device to the guest and swap on that."
15262 #: ../src/guestfs-actions.pod:6223
15263 msgid "guestfs_swapon_file"
15267 #: ../src/guestfs-actions.pod:6225
15271 " guestfs_swapon_file (guestfs_h *g,\n"
15272 " const char *file);\n"
15277 #: ../src/guestfs-actions.pod:6229
15279 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
15284 #: ../src/guestfs-actions.pod:6236
15285 msgid "guestfs_swapon_label"
15289 #: ../src/guestfs-actions.pod:6238
15293 " guestfs_swapon_label (guestfs_h *g,\n"
15294 " const char *label);\n"
15299 #: ../src/guestfs-actions.pod:6242
15301 "This command enables swap to a labeled swap partition. See "
15302 "C<guestfs_swapon_device> for other notes."
15306 #: ../src/guestfs-actions.pod:6249
15307 msgid "guestfs_swapon_uuid"
15311 #: ../src/guestfs-actions.pod:6251
15315 " guestfs_swapon_uuid (guestfs_h *g,\n"
15316 " const char *uuid);\n"
15321 #: ../src/guestfs-actions.pod:6255
15323 "This command enables swap to a swap partition with the given UUID. See "
15324 "C<guestfs_swapon_device> for other notes."
15328 #: ../src/guestfs-actions.pod:6262
15329 msgid "guestfs_sync"
15333 #: ../src/guestfs-actions.pod:6264
15337 " guestfs_sync (guestfs_h *g);\n"
15342 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4195
15344 "This syncs the disk, so that any writes are flushed through to the "
15345 "underlying disk image."
15349 #: ../src/guestfs-actions.pod:6270 ../fish/guestfish-actions.pod:4198
15351 "You should always call this if you have modified a disk image, before "
15352 "closing the handle."
15356 #: ../src/guestfs-actions.pod:6277
15357 msgid "guestfs_tail"
15361 #: ../src/guestfs-actions.pod:6279
15365 " guestfs_tail (guestfs_h *g,\n"
15366 " const char *path);\n"
15371 #: ../src/guestfs-actions.pod:6283 ../fish/guestfish-actions.pod:4205
15372 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15376 #: ../src/guestfs-actions.pod:6295
15377 msgid "guestfs_tail_n"
15381 #: ../src/guestfs-actions.pod:6297
15385 " guestfs_tail_n (guestfs_h *g,\n"
15387 " const char *path);\n"
15392 #: ../src/guestfs-actions.pod:6302 ../fish/guestfish-actions.pod:4215
15394 "If the parameter C<nrlines> is a positive number, this returns the last "
15395 "C<nrlines> lines of the file C<path>."
15399 #: ../src/guestfs-actions.pod:6305 ../fish/guestfish-actions.pod:4218
15401 "If the parameter C<nrlines> is a negative number, this returns lines from "
15402 "the file C<path>, starting with the C<-nrlines>th line."
15406 #: ../src/guestfs-actions.pod:6319
15407 msgid "guestfs_tar_in"
15411 #: ../src/guestfs-actions.pod:6321
15415 " guestfs_tar_in (guestfs_h *g,\n"
15416 " const char *tarfile,\n"
15417 " const char *directory);\n"
15422 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4230
15424 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15425 "tar file) into C<directory>."
15429 #: ../src/guestfs-actions.pod:6329
15430 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
15434 #: ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6367 ../src/guestfs-actions.pod:6383
15435 msgid "(Added in 1.0.3)"
15439 #: ../src/guestfs-actions.pod:6336
15440 msgid "guestfs_tar_out"
15444 #: ../src/guestfs-actions.pod:6338
15448 " guestfs_tar_out (guestfs_h *g,\n"
15449 " const char *directory,\n"
15450 " const char *tarfile);\n"
15455 #: ../src/guestfs-actions.pod:6343 ../fish/guestfish-actions.pod:4242
15457 "This command packs the contents of C<directory> and downloads it to local "
15462 #: ../src/guestfs-actions.pod:6346
15464 "To download a compressed tarball, use C<guestfs_tgz_out> or "
15465 "C<guestfs_txz_out>."
15469 #: ../src/guestfs-actions.pod:6353
15470 msgid "guestfs_tgz_in"
15474 #: ../src/guestfs-actions.pod:6355
15478 " guestfs_tgz_in (guestfs_h *g,\n"
15479 " const char *tarball,\n"
15480 " const char *directory);\n"
15485 #: ../src/guestfs-actions.pod:6360 ../fish/guestfish-actions.pod:4254
15487 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15488 "tar file) into C<directory>."
15492 #: ../src/guestfs-actions.pod:6363
15493 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
15497 #: ../src/guestfs-actions.pod:6369
15498 msgid "guestfs_tgz_out"
15502 #: ../src/guestfs-actions.pod:6371
15506 " guestfs_tgz_out (guestfs_h *g,\n"
15507 " const char *directory,\n"
15508 " const char *tarball);\n"
15513 #: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4265
15515 "This command packs the contents of C<directory> and downloads it to local "
15520 #: ../src/guestfs-actions.pod:6379
15521 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
15525 #: ../src/guestfs-actions.pod:6385
15526 msgid "guestfs_touch"
15530 #: ../src/guestfs-actions.pod:6387
15534 " guestfs_touch (guestfs_h *g,\n"
15535 " const char *path);\n"
15540 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4276
15542 "Touch acts like the L<touch(1)> command. It can be used to update the "
15543 "timestamps on a file, or, if the file does not exist, to create a new "
15544 "zero-length file."
15548 #: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4280
15550 "This command only works on regular files, and will fail on other file types "
15551 "such as directories, symbolic links, block special etc."
15555 #: ../src/guestfs-actions.pod:6402
15556 msgid "guestfs_truncate"
15560 #: ../src/guestfs-actions.pod:6404
15564 " guestfs_truncate (guestfs_h *g,\n"
15565 " const char *path);\n"
15570 #: ../src/guestfs-actions.pod:6408 ../fish/guestfish-actions.pod:4287
15572 "This command truncates C<path> to a zero-length file. The file must exist "
15577 #: ../src/guestfs-actions.pod:6415
15578 msgid "guestfs_truncate_size"
15582 #: ../src/guestfs-actions.pod:6417
15586 " guestfs_truncate_size (guestfs_h *g,\n"
15587 " const char *path,\n"
15588 " int64_t size);\n"
15593 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4294
15595 "This command truncates C<path> to size C<size> bytes. The file must exist "
15600 #: ../src/guestfs-actions.pod:6425
15602 "If the current file size is less than C<size> then the file is extended to "
15603 "the required size with zero bytes. This creates a sparse file (ie. disk "
15604 "blocks are not allocated for the file until you write to it). To create a "
15605 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15609 #: ../src/guestfs-actions.pod:6435
15610 msgid "guestfs_tune2fs_l"
15614 #: ../src/guestfs-actions.pod:6437
15618 " guestfs_tune2fs_l (guestfs_h *g,\n"
15619 " const char *device);\n"
15624 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4307
15626 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15631 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4310
15633 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15634 "for more details. The list of fields returned isn't clearly defined, and "
15635 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15636 "and the filesystem itself."
15640 #: ../src/guestfs-actions.pod:6457
15641 msgid "guestfs_txz_in"
15645 #: ../src/guestfs-actions.pod:6459
15649 " guestfs_txz_in (guestfs_h *g,\n"
15650 " const char *tarball,\n"
15651 " const char *directory);\n"
15656 #: ../src/guestfs-actions.pod:6464 ../fish/guestfish-actions.pod:4319
15658 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15659 "tar file) into C<directory>."
15663 #: ../src/guestfs-actions.pod:6471
15664 msgid "guestfs_txz_out"
15668 #: ../src/guestfs-actions.pod:6473
15672 " guestfs_txz_out (guestfs_h *g,\n"
15673 " const char *directory,\n"
15674 " const char *tarball);\n"
15679 #: ../src/guestfs-actions.pod:6478 ../fish/guestfish-actions.pod:4328
15681 "This command packs the contents of C<directory> and downloads it to local "
15682 "file C<tarball> (as an xz compressed tar archive)."
15686 #: ../src/guestfs-actions.pod:6485
15687 msgid "guestfs_umask"
15691 #: ../src/guestfs-actions.pod:6487
15695 " guestfs_umask (guestfs_h *g,\n"
15701 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4337
15703 "This function sets the mask used for creating new files and device nodes to "
15708 #: ../src/guestfs-actions.pod:6494 ../fish/guestfish-actions.pod:4340
15710 "Typical umask values would be C<022> which creates new files with "
15711 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15712 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15716 #: ../src/guestfs-actions.pod:6499 ../fish/guestfish-actions.pod:4345
15718 "The default umask is C<022>. This is important because it means that "
15719 "directories and device nodes will be created with C<0644> or C<0755> mode "
15720 "even if you specify C<0777>."
15724 #: ../src/guestfs-actions.pod:6503
15726 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15727 "C<guestfs_mkdir>."
15731 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4352
15732 msgid "This call returns the previous umask."
15736 #: ../src/guestfs-actions.pod:6512
15737 msgid "guestfs_umount"
15741 #: ../src/guestfs-actions.pod:6514
15745 " guestfs_umount (guestfs_h *g,\n"
15746 " const char *pathordevice);\n"
15751 #: ../src/guestfs-actions.pod:6518 ../fish/guestfish-actions.pod:4360
15753 "This unmounts the given filesystem. The filesystem may be specified either "
15754 "by its mountpoint (path) or the device which contains the filesystem."
15758 #: ../src/guestfs-actions.pod:6526
15759 msgid "guestfs_umount_all"
15763 #: ../src/guestfs-actions.pod:6528
15767 " guestfs_umount_all (guestfs_h *g);\n"
15772 #: ../src/guestfs-actions.pod:6531 ../fish/guestfish-actions.pod:4370
15773 msgid "This unmounts all mounted filesystems."
15777 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4372
15778 msgid "Some internal mounts are not unmounted by this call."
15782 #: ../src/guestfs-actions.pod:6539
15783 msgid "guestfs_upload"
15787 #: ../src/guestfs-actions.pod:6541
15791 " guestfs_upload (guestfs_h *g,\n"
15792 " const char *filename,\n"
15793 " const char *remotefilename);\n"
15798 #: ../src/guestfs-actions.pod:6546 ../src/guestfs-actions.pod:6570 ../fish/guestfish-actions.pod:4378 ../fish/guestfish-actions.pod:4391
15799 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15803 #: ../src/guestfs-actions.pod:6551
15804 msgid "See also C<guestfs_download>."
15808 #: ../src/guestfs-actions.pod:6562
15809 msgid "guestfs_upload_offset"
15813 #: ../src/guestfs-actions.pod:6564
15817 " guestfs_upload_offset (guestfs_h *g,\n"
15818 " const char *filename,\n"
15819 " const char *remotefilename,\n"
15820 " int64_t offset);\n"
15825 #: ../src/guestfs-actions.pod:6573 ../fish/guestfish-actions.pod:4394
15827 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15828 "The intention is to overwrite parts of existing files or devices, although "
15829 "if a non-existant file is specified then it is created with a \"hole\" "
15830 "before C<offset>. The size of the data written is implicit in the size of "
15831 "the source C<filename>."
15835 #: ../src/guestfs-actions.pod:6580
15837 "Note that there is no limit on the amount of data that can be uploaded with "
15838 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15839 "full amount unless an error occurs."
15843 #: ../src/guestfs-actions.pod:6585
15844 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15848 #: ../src/guestfs-actions.pod:6596
15849 msgid "guestfs_utimens"
15853 #: ../src/guestfs-actions.pod:6598
15857 " guestfs_utimens (guestfs_h *g,\n"
15858 " const char *path,\n"
15859 " int64_t atsecs,\n"
15860 " int64_t atnsecs,\n"
15861 " int64_t mtsecs,\n"
15862 " int64_t mtnsecs);\n"
15867 #: ../src/guestfs-actions.pod:6606 ../fish/guestfish-actions.pod:4414
15868 msgid "This command sets the timestamps of a file with nanosecond precision."
15872 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4417
15874 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15879 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4420
15881 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15882 "nanoseconds from the epoch."
15886 #: ../src/guestfs-actions.pod:6615 ../fish/guestfish-actions.pod:4423
15888 "If the C<*nsecs> field contains the special value C<-1> then the "
15889 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15890 "ignored in this case)."
15894 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4427
15896 "If the C<*nsecs> field contains the special value C<-2> then the "
15897 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15902 #: ../src/guestfs-actions.pod:6627 ../src/guestfs-structs.pod:175
15903 msgid "guestfs_version"
15907 #: ../src/guestfs-actions.pod:6629
15910 " struct guestfs_version *\n"
15911 " guestfs_version (guestfs_h *g);\n"
15916 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4435
15917 msgid "Return the libguestfs version number that the program is linked against."
15921 #: ../src/guestfs-actions.pod:6635 ../fish/guestfish-actions.pod:4438
15923 "Note that because of dynamic linking this is not necessarily the version of "
15924 "libguestfs that you compiled against. You can compile the program, and then "
15925 "at runtime dynamically link against a completely different C<libguestfs.so> "
15930 #: ../src/guestfs-actions.pod:6640 ../fish/guestfish-actions.pod:4443
15932 "This call was added in version C<1.0.58>. In previous versions of "
15933 "libguestfs there was no way to get the version number. From C code you can "
15934 "use dynamic linker functions to find out if this symbol exists (if it "
15935 "doesn't, then it's an earlier version)."
15939 #: ../src/guestfs-actions.pod:6646 ../fish/guestfish-actions.pod:4449
15941 "The call returns a structure with four elements. The first three (C<major>, "
15942 "C<minor> and C<release>) are numbers and correspond to the usual version "
15943 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15944 "but may be used for distro-specific information."
15948 #: ../src/guestfs-actions.pod:6652 ../fish/guestfish-actions.pod:4455
15949 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
15953 #: ../src/guestfs-actions.pod:6655 ../fish/guestfish-actions.pod:4458
15954 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15958 #: ../src/guestfs-actions.pod:6657
15960 "I<Note:> Don't use this call to test for availability of features. In "
15961 "enterprise distributions we backport features from later versions into "
15962 "earlier versions, making this an unreliable way to test for features. Use "
15963 "C<guestfs_available> instead."
15967 #: ../src/guestfs-actions.pod:6663
15969 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15970 "error. I<The caller must call C<guestfs_free_version> after use>."
15974 #: ../src/guestfs-actions.pod:6667
15975 msgid "(Added in 1.0.58)"
15979 #: ../src/guestfs-actions.pod:6669
15980 msgid "guestfs_vfs_label"
15984 #: ../src/guestfs-actions.pod:6671
15988 " guestfs_vfs_label (guestfs_h *g,\n"
15989 " const char *device);\n"
15994 #: ../src/guestfs-actions.pod:6675 ../fish/guestfish-actions.pod:4470
15995 msgid "This returns the filesystem label of the filesystem on C<device>."
15999 #: ../src/guestfs-actions.pod:6678 ../fish/guestfish-actions.pod:4473
16000 msgid "If the filesystem is unlabeled, this returns the empty string."
16004 #: ../src/guestfs-actions.pod:6680
16005 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
16009 #: ../src/guestfs-actions.pod:6685 ../src/guestfs-actions.pod:6722
16010 msgid "(Added in 1.3.18)"
16014 #: ../src/guestfs-actions.pod:6687
16015 msgid "guestfs_vfs_type"
16019 #: ../src/guestfs-actions.pod:6689
16023 " guestfs_vfs_type (guestfs_h *g,\n"
16024 " const char *device);\n"
16029 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:4481
16031 "This command gets the filesystem type corresponding to the filesystem on "
16036 #: ../src/guestfs-actions.pod:6696 ../fish/guestfish-actions.pod:4484
16038 "For most filesystems, the result is the name of the Linux VFS module which "
16039 "would be used to mount this filesystem if you mounted it without specifying "
16040 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
16044 #: ../src/guestfs-actions.pod:6706
16045 msgid "guestfs_vfs_uuid"
16049 #: ../src/guestfs-actions.pod:6708
16053 " guestfs_vfs_uuid (guestfs_h *g,\n"
16054 " const char *device);\n"
16059 #: ../src/guestfs-actions.pod:6712 ../fish/guestfish-actions.pod:4493
16060 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16064 #: ../src/guestfs-actions.pod:6715 ../fish/guestfish-actions.pod:4496
16065 msgid "If the filesystem does not have a UUID, this returns the empty string."
16069 #: ../src/guestfs-actions.pod:6717
16070 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16074 #: ../src/guestfs-actions.pod:6724
16075 msgid "guestfs_vg_activate"
16079 #: ../src/guestfs-actions.pod:6726
16083 " guestfs_vg_activate (guestfs_h *g,\n"
16085 " char *const *volgroups);\n"
16090 #: ../src/guestfs-actions.pod:6731 ../fish/guestfish-actions.pod:4504
16092 "This command activates or (if C<activate> is false) deactivates all logical "
16093 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16094 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16095 "deactivated, then those devices disappear."
16099 #: ../src/guestfs-actions.pod:6737 ../fish/guestfish-actions.pod:4510
16100 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16104 #: ../src/guestfs-actions.pod:6739 ../fish/guestfish-actions.pod:4512
16106 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16107 "activated or deactivated."
16111 #: ../src/guestfs-actions.pod:6746
16112 msgid "guestfs_vg_activate_all"
16116 #: ../src/guestfs-actions.pod:6748
16120 " guestfs_vg_activate_all (guestfs_h *g,\n"
16121 " int activate);\n"
16126 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4519
16128 "This command activates or (if C<activate> is false) deactivates all logical "
16129 "volumes in all volume groups. If activated, then they are made known to the "
16130 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16131 "those devices disappear."
16135 #: ../src/guestfs-actions.pod:6758 ../fish/guestfish-actions.pod:4525
16136 msgid "This command is the same as running C<vgchange -a y|n>"
16140 #: ../src/guestfs-actions.pod:6764
16141 msgid "guestfs_vgcreate"
16145 #: ../src/guestfs-actions.pod:6766
16149 " guestfs_vgcreate (guestfs_h *g,\n"
16150 " const char *volgroup,\n"
16151 " char *const *physvols);\n"
16156 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4531
16158 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16159 "of physical volumes C<physvols>."
16163 #: ../src/guestfs-actions.pod:6778
16164 msgid "guestfs_vglvuuids"
16168 #: ../src/guestfs-actions.pod:6780
16172 " guestfs_vglvuuids (guestfs_h *g,\n"
16173 " const char *vgname);\n"
16178 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4538
16180 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16181 "volumes created in this volume group."
16185 #: ../src/guestfs-actions.pod:6787
16187 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
16188 "associate logical volumes and volume groups."
16192 #: ../src/guestfs-actions.pod:6790
16193 msgid "See also C<guestfs_vgpvuuids>."
16197 #: ../src/guestfs-actions.pod:6798
16198 msgid "guestfs_vgpvuuids"
16202 #: ../src/guestfs-actions.pod:6800
16206 " guestfs_vgpvuuids (guestfs_h *g,\n"
16207 " const char *vgname);\n"
16212 #: ../src/guestfs-actions.pod:6804 ../fish/guestfish-actions.pod:4550
16214 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16215 "volumes that this volume group resides on."
16219 #: ../src/guestfs-actions.pod:6807
16221 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
16222 "associate physical volumes and volume groups."
16226 #: ../src/guestfs-actions.pod:6810
16227 msgid "See also C<guestfs_vglvuuids>."
16231 #: ../src/guestfs-actions.pod:6818
16232 msgid "guestfs_vgremove"
16236 #: ../src/guestfs-actions.pod:6820
16240 " guestfs_vgremove (guestfs_h *g,\n"
16241 " const char *vgname);\n"
16246 #: ../src/guestfs-actions.pod:6824 ../fish/guestfish-actions.pod:4562
16247 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16251 #: ../src/guestfs-actions.pod:6826 ../fish/guestfish-actions.pod:4564
16252 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16256 #: ../src/guestfs-actions.pod:6833
16257 msgid "guestfs_vgrename"
16261 #: ../src/guestfs-actions.pod:6835
16265 " guestfs_vgrename (guestfs_h *g,\n"
16266 " const char *volgroup,\n"
16267 " const char *newvolgroup);\n"
16272 #: ../src/guestfs-actions.pod:6840 ../fish/guestfish-actions.pod:4571
16273 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16277 #: ../src/guestfs-actions.pod:6846
16278 msgid "guestfs_vgs"
16282 #: ../src/guestfs-actions.pod:6848
16286 " guestfs_vgs (guestfs_h *g);\n"
16291 #: ../src/guestfs-actions.pod:6851 ../fish/guestfish-actions.pod:4577
16293 "List all the volumes groups detected. This is the equivalent of the "
16294 "L<vgs(8)> command."
16298 #: ../src/guestfs-actions.pod:6854 ../fish/guestfish-actions.pod:4580
16300 "This returns a list of just the volume group names that were detected "
16301 "(eg. C<VolGroup00>)."
16305 #: ../src/guestfs-actions.pod:6857
16306 msgid "See also C<guestfs_vgs_full>."
16310 #: ../src/guestfs-actions.pod:6865
16311 msgid "guestfs_vgs_full"
16315 #: ../src/guestfs-actions.pod:6867
16318 " struct guestfs_lvm_vg_list *\n"
16319 " guestfs_vgs_full (guestfs_h *g);\n"
16324 #: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4589
16326 "List all the volumes groups detected. This is the equivalent of the "
16327 "L<vgs(8)> command. The \"full\" version includes all fields."
16331 #: ../src/guestfs-actions.pod:6873
16333 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
16334 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
16339 #: ../src/guestfs-actions.pod:6879
16340 msgid "guestfs_vgscan"
16344 #: ../src/guestfs-actions.pod:6881
16348 " guestfs_vgscan (guestfs_h *g);\n"
16353 #: ../src/guestfs-actions.pod:6884 ../fish/guestfish-actions.pod:4596
16355 "This rescans all block devices and rebuilds the list of LVM physical "
16356 "volumes, volume groups and logical volumes."
16360 #: ../src/guestfs-actions.pod:6891
16361 msgid "guestfs_vguuid"
16365 #: ../src/guestfs-actions.pod:6893
16369 " guestfs_vguuid (guestfs_h *g,\n"
16370 " const char *vgname);\n"
16375 #: ../src/guestfs-actions.pod:6897 ../fish/guestfish-actions.pod:4603
16376 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16380 #: ../src/guestfs-actions.pod:6904
16381 msgid "guestfs_wait_ready"
16385 #: ../src/guestfs-actions.pod:6906
16389 " guestfs_wait_ready (guestfs_h *g);\n"
16394 #: ../src/guestfs-actions.pod:6909
16395 msgid "This function is a no op."
16399 #: ../src/guestfs-actions.pod:6911
16401 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
16402 "calling C<guestfs_launch> to wait for the launch to complete. However this "
16403 "is no longer necessary because C<guestfs_launch> now does the waiting."
16407 #: ../src/guestfs-actions.pod:6916
16409 "If you see any calls to this function in code then you can just remove them, "
16410 "unless you want to retain compatibility with older versions of the API."
16414 #: ../src/guestfs-actions.pod:6924
16415 msgid "guestfs_wc_c"
16419 #: ../src/guestfs-actions.pod:6926
16423 " guestfs_wc_c (guestfs_h *g,\n"
16424 " const char *path);\n"
16429 #: ../src/guestfs-actions.pod:6930 ../fish/guestfish-actions.pod:4609
16431 "This command counts the characters in a file, using the C<wc -c> external "
16436 #: ../src/guestfs-actions.pod:6937
16437 msgid "guestfs_wc_l"
16441 #: ../src/guestfs-actions.pod:6939
16445 " guestfs_wc_l (guestfs_h *g,\n"
16446 " const char *path);\n"
16451 #: ../src/guestfs-actions.pod:6943 ../fish/guestfish-actions.pod:4616
16453 "This command counts the lines in a file, using the C<wc -l> external "
16458 #: ../src/guestfs-actions.pod:6950
16459 msgid "guestfs_wc_w"
16463 #: ../src/guestfs-actions.pod:6952
16467 " guestfs_wc_w (guestfs_h *g,\n"
16468 " const char *path);\n"
16473 #: ../src/guestfs-actions.pod:6956 ../fish/guestfish-actions.pod:4623
16475 "This command counts the words in a file, using the C<wc -w> external "
16480 #: ../src/guestfs-actions.pod:6963
16481 msgid "guestfs_write"
16485 #: ../src/guestfs-actions.pod:6965
16489 " guestfs_write (guestfs_h *g,\n"
16490 " const char *path,\n"
16491 " const char *content,\n"
16492 " size_t content_size);\n"
16497 #: ../src/guestfs-actions.pod:6971 ../fish/guestfish-actions.pod:4630
16499 "This call creates a file called C<path>. The content of the file is the "
16500 "string C<content> (which can contain any 8 bit data)."
16504 #: ../src/guestfs-actions.pod:6981
16505 msgid "guestfs_write_file"
16509 #: ../src/guestfs-actions.pod:6983
16513 " guestfs_write_file (guestfs_h *g,\n"
16514 " const char *path,\n"
16515 " const char *content,\n"
16521 #: ../src/guestfs-actions.pod:6989 ../fish/guestfish-actions.pod:4640
16523 "This call creates a file called C<path>. The contents of the file is the "
16524 "string C<content> (which can contain any 8 bit data), with length C<size>."
16528 #: ../src/guestfs-actions.pod:6993 ../fish/guestfish-actions.pod:4644
16530 "As a special case, if C<size> is C<0> then the length is calculated using "
16531 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16535 #: ../src/guestfs-actions.pod:6997 ../fish/guestfish-actions.pod:4648
16537 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16538 "I<not> work, even if the length is specified."
16542 #: ../src/guestfs-actions.pod:7005
16544 "This function is deprecated. In new code, use the L</guestfs_write> call "
16549 #: ../src/guestfs-actions.pod:7014
16550 msgid "guestfs_zegrep"
16554 #: ../src/guestfs-actions.pod:7016
16558 " guestfs_zegrep (guestfs_h *g,\n"
16559 " const char *regex,\n"
16560 " const char *path);\n"
16565 #: ../src/guestfs-actions.pod:7021 ../fish/guestfish-actions.pod:4665
16566 msgid "This calls the external C<zegrep> program and returns the matching lines."
16570 #: ../src/guestfs-actions.pod:7033
16571 msgid "guestfs_zegrepi"
16575 #: ../src/guestfs-actions.pod:7035
16579 " guestfs_zegrepi (guestfs_h *g,\n"
16580 " const char *regex,\n"
16581 " const char *path);\n"
16586 #: ../src/guestfs-actions.pod:7040 ../fish/guestfish-actions.pod:4675
16587 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16591 #: ../src/guestfs-actions.pod:7052
16592 msgid "guestfs_zero"
16596 #: ../src/guestfs-actions.pod:7054
16600 " guestfs_zero (guestfs_h *g,\n"
16601 " const char *device);\n"
16606 #: ../src/guestfs-actions.pod:7058 ../fish/guestfish-actions.pod:4685
16607 msgid "This command writes zeroes over the first few blocks of C<device>."
16611 #: ../src/guestfs-actions.pod:7060 ../fish/guestfish-actions.pod:4687
16613 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16614 "securely wipe the device). It should be sufficient to remove any partition "
16615 "tables, filesystem superblocks and so on."
16619 #: ../src/guestfs-actions.pod:7064
16620 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16624 #: ../src/guestfs-actions.pod:7075
16625 msgid "guestfs_zero_device"
16629 #: ../src/guestfs-actions.pod:7077
16633 " guestfs_zero_device (guestfs_h *g,\n"
16634 " const char *device);\n"
16639 #: ../src/guestfs-actions.pod:7081
16641 "This command writes zeroes over the entire C<device>. Compare with "
16642 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16646 #: ../src/guestfs-actions.pod:7095
16647 msgid "(Added in 1.3.1)"
16651 #: ../src/guestfs-actions.pod:7097
16652 msgid "guestfs_zerofree"
16656 #: ../src/guestfs-actions.pod:7099
16660 " guestfs_zerofree (guestfs_h *g,\n"
16661 " const char *device);\n"
16666 #: ../src/guestfs-actions.pod:7103 ../fish/guestfish-actions.pod:4708
16668 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16669 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16670 "possible to compress the filesystem more effectively."
16674 #: ../src/guestfs-actions.pod:7108 ../fish/guestfish-actions.pod:4713
16675 msgid "You should B<not> run this program if the filesystem is mounted."
16679 #: ../src/guestfs-actions.pod:7111 ../fish/guestfish-actions.pod:4716
16681 "It is possible that using this program can damage the filesystem or data on "
16686 #: ../src/guestfs-actions.pod:7118
16687 msgid "guestfs_zfgrep"
16691 #: ../src/guestfs-actions.pod:7120
16695 " guestfs_zfgrep (guestfs_h *g,\n"
16696 " const char *pattern,\n"
16697 " const char *path);\n"
16702 #: ../src/guestfs-actions.pod:7125 ../fish/guestfish-actions.pod:4723
16703 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16707 #: ../src/guestfs-actions.pod:7137
16708 msgid "guestfs_zfgrepi"
16712 #: ../src/guestfs-actions.pod:7139
16716 " guestfs_zfgrepi (guestfs_h *g,\n"
16717 " const char *pattern,\n"
16718 " const char *path);\n"
16723 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:4733
16724 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16728 #: ../src/guestfs-actions.pod:7156
16729 msgid "guestfs_zfile"
16733 #: ../src/guestfs-actions.pod:7158
16737 " guestfs_zfile (guestfs_h *g,\n"
16738 " const char *meth,\n"
16739 " const char *path);\n"
16744 #: ../src/guestfs-actions.pod:7163 ../fish/guestfish-actions.pod:4743
16745 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16749 #: ../src/guestfs-actions.pod:7166 ../fish/guestfish-actions.pod:4746
16750 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16754 #: ../src/guestfs-actions.pod:7168
16756 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16761 #: ../src/guestfs-actions.pod:7174
16763 "This function is deprecated. In new code, use the L</guestfs_file> call "
16768 #: ../src/guestfs-actions.pod:7183
16769 msgid "guestfs_zgrep"
16773 #: ../src/guestfs-actions.pod:7185
16777 " guestfs_zgrep (guestfs_h *g,\n"
16778 " const char *regex,\n"
16779 " const char *path);\n"
16784 #: ../src/guestfs-actions.pod:7190 ../fish/guestfish-actions.pod:4762
16785 msgid "This calls the external C<zgrep> program and returns the matching lines."
16789 #: ../src/guestfs-actions.pod:7202
16790 msgid "guestfs_zgrepi"
16794 #: ../src/guestfs-actions.pod:7204
16798 " guestfs_zgrepi (guestfs_h *g,\n"
16799 " const char *regex,\n"
16800 " const char *path);\n"
16805 #: ../src/guestfs-actions.pod:7209 ../fish/guestfish-actions.pod:4772
16806 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16810 #: ../src/guestfs-availability.pod:3
16815 #: ../src/guestfs-availability.pod:5
16817 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
16818 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
16819 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
16820 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
16821 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
16825 #: ../src/guestfs-availability.pod:21
16830 #: ../src/guestfs-availability.pod:23
16831 msgid "The following functions: L</guestfs_grub_install>"
16835 #: ../src/guestfs-availability.pod:26
16840 #: ../src/guestfs-availability.pod:28
16842 "The following functions: L</guestfs_inotify_add_watch> "
16843 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
16844 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16848 #: ../src/guestfs-availability.pod:36
16849 msgid "B<linuxfsuuid>"
16853 #: ../src/guestfs-availability.pod:38
16855 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
16856 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16860 #: ../src/guestfs-availability.pod:45
16861 msgid "B<linuxmodules>"
16865 #: ../src/guestfs-availability.pod:47
16866 msgid "The following functions: L</guestfs_modprobe>"
16870 #: ../src/guestfs-availability.pod:50
16871 msgid "B<linuxxattrs>"
16875 #: ../src/guestfs-availability.pod:52
16877 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
16878 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
16879 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
16880 "L</guestfs_setxattr>"
16884 #: ../src/guestfs-availability.pod:63
16889 #: ../src/guestfs-availability.pod:65
16891 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
16892 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
16893 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16897 #: ../src/guestfs-availability.pod:74
16902 #: ../src/guestfs-availability.pod:76
16904 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
16905 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
16906 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
16907 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
16908 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
16909 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
16910 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
16911 "L</guestfs_vgs_full>"
16915 #: ../src/guestfs-availability.pod:99
16920 #: ../src/guestfs-availability.pod:101
16922 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
16923 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
16927 #: ../src/guestfs-availability.pod:107
16932 #: ../src/guestfs-availability.pod:109
16933 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16937 #: ../src/guestfs-availability.pod:112
16938 msgid "B<ntfsprogs>"
16942 #: ../src/guestfs-availability.pod:114
16943 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16947 #: ../src/guestfs-availability.pod:118
16948 msgid "B<realpath>"
16952 #: ../src/guestfs-availability.pod:120
16953 msgid "The following functions: L</guestfs_realpath>"
16957 #: ../src/guestfs-availability.pod:123
16962 #: ../src/guestfs-availability.pod:125
16964 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
16965 "L</guestfs_scrub_freespace>"
16969 #: ../src/guestfs-availability.pod:130
16974 #: ../src/guestfs-availability.pod:132
16975 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16979 #: ../src/guestfs-availability.pod:136
16984 #: ../src/guestfs-availability.pod:138
16985 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16989 #: ../src/guestfs-availability.pod:142
16990 msgid "B<zerofree>"
16994 #: ../src/guestfs-availability.pod:144
16995 msgid "The following functions: L</guestfs_zerofree>"
16999 #: ../src/guestfs-structs.pod:1
17000 msgid "guestfs_int_bool"
17004 #: ../src/guestfs-structs.pod:3
17007 " struct guestfs_int_bool {\n"
17015 #: ../src/guestfs-structs.pod:8
17018 " struct guestfs_int_bool_list {\n"
17019 " uint32_t len; /* Number of elements in list. */\n"
17020 " struct guestfs_int_bool *val; /* Elements. */\n"
17026 #: ../src/guestfs-structs.pod:13
17029 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
17030 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
17035 #: ../src/guestfs-structs.pod:16
17036 msgid "guestfs_lvm_pv"
17040 #: ../src/guestfs-structs.pod:18
17043 " struct guestfs_lvm_pv {\n"
17044 " char *pv_name;\n"
17045 " /* The next field is NOT nul-terminated, be careful when printing it: "
17047 " char pv_uuid[32];\n"
17049 " uint64_t pv_size;\n"
17050 " uint64_t dev_size;\n"
17051 " uint64_t pv_free;\n"
17052 " uint64_t pv_used;\n"
17053 " char *pv_attr;\n"
17054 " int64_t pv_pe_count;\n"
17055 " int64_t pv_pe_alloc_count;\n"
17056 " char *pv_tags;\n"
17057 " uint64_t pe_start;\n"
17058 " int64_t pv_mda_count;\n"
17059 " uint64_t pv_mda_free;\n"
17065 #: ../src/guestfs-structs.pod:36
17068 " struct guestfs_lvm_pv_list {\n"
17069 " uint32_t len; /* Number of elements in list. */\n"
17070 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17076 #: ../src/guestfs-structs.pod:41
17079 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17080 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17085 #: ../src/guestfs-structs.pod:44
17086 msgid "guestfs_lvm_vg"
17090 #: ../src/guestfs-structs.pod:46
17093 " struct guestfs_lvm_vg {\n"
17094 " char *vg_name;\n"
17095 " /* The next field is NOT nul-terminated, be careful when printing it: "
17097 " char vg_uuid[32];\n"
17099 " char *vg_attr;\n"
17100 " uint64_t vg_size;\n"
17101 " uint64_t vg_free;\n"
17102 " char *vg_sysid;\n"
17103 " uint64_t vg_extent_size;\n"
17104 " int64_t vg_extent_count;\n"
17105 " int64_t vg_free_count;\n"
17106 " int64_t max_lv;\n"
17107 " int64_t max_pv;\n"
17108 " int64_t pv_count;\n"
17109 " int64_t lv_count;\n"
17110 " int64_t snap_count;\n"
17111 " int64_t vg_seqno;\n"
17112 " char *vg_tags;\n"
17113 " int64_t vg_mda_count;\n"
17114 " uint64_t vg_mda_free;\n"
17120 #: ../src/guestfs-structs.pod:69
17123 " struct guestfs_lvm_vg_list {\n"
17124 " uint32_t len; /* Number of elements in list. */\n"
17125 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17131 #: ../src/guestfs-structs.pod:74
17134 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17135 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17140 #: ../src/guestfs-structs.pod:77
17141 msgid "guestfs_lvm_lv"
17145 #: ../src/guestfs-structs.pod:79
17148 " struct guestfs_lvm_lv {\n"
17149 " char *lv_name;\n"
17150 " /* The next field is NOT nul-terminated, be careful when printing it: "
17152 " char lv_uuid[32];\n"
17153 " char *lv_attr;\n"
17154 " int64_t lv_major;\n"
17155 " int64_t lv_minor;\n"
17156 " int64_t lv_kernel_major;\n"
17157 " int64_t lv_kernel_minor;\n"
17158 " uint64_t lv_size;\n"
17159 " int64_t seg_count;\n"
17161 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17162 " float snap_percent;\n"
17163 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17164 " float copy_percent;\n"
17165 " char *move_pv;\n"
17166 " char *lv_tags;\n"
17167 " char *mirror_log;\n"
17168 " char *modules;\n"
17174 #: ../src/guestfs-structs.pod:101
17177 " struct guestfs_lvm_lv_list {\n"
17178 " uint32_t len; /* Number of elements in list. */\n"
17179 " struct guestfs_lvm_lv *val; /* Elements. */\n"
17185 #: ../src/guestfs-structs.pod:106
17188 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
17189 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
17194 #: ../src/guestfs-structs.pod:111
17197 " struct guestfs_stat {\n"
17201 " int64_t nlink;\n"
17206 " int64_t blksize;\n"
17207 " int64_t blocks;\n"
17208 " int64_t atime;\n"
17209 " int64_t mtime;\n"
17210 " int64_t ctime;\n"
17216 #: ../src/guestfs-structs.pod:127
17219 " struct guestfs_stat_list {\n"
17220 " uint32_t len; /* Number of elements in list. */\n"
17221 " struct guestfs_stat *val; /* Elements. */\n"
17227 #: ../src/guestfs-structs.pod:132
17230 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
17231 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
17236 #: ../src/guestfs-structs.pod:137
17239 " struct guestfs_statvfs {\n"
17240 " int64_t bsize;\n"
17241 " int64_t frsize;\n"
17242 " int64_t blocks;\n"
17243 " int64_t bfree;\n"
17244 " int64_t bavail;\n"
17245 " int64_t files;\n"
17246 " int64_t ffree;\n"
17247 " int64_t favail;\n"
17250 " int64_t namemax;\n"
17256 #: ../src/guestfs-structs.pod:151
17259 " struct guestfs_statvfs_list {\n"
17260 " uint32_t len; /* Number of elements in list. */\n"
17261 " struct guestfs_statvfs *val; /* Elements. */\n"
17267 #: ../src/guestfs-structs.pod:156
17270 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
17271 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
17276 #: ../src/guestfs-structs.pod:159
17277 msgid "guestfs_dirent"
17281 #: ../src/guestfs-structs.pod:161
17284 " struct guestfs_dirent {\n"
17293 #: ../src/guestfs-structs.pod:167
17296 " struct guestfs_dirent_list {\n"
17297 " uint32_t len; /* Number of elements in list. */\n"
17298 " struct guestfs_dirent *val; /* Elements. */\n"
17304 #: ../src/guestfs-structs.pod:172
17307 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
17308 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
17313 #: ../src/guestfs-structs.pod:177
17316 " struct guestfs_version {\n"
17317 " int64_t major;\n"
17318 " int64_t minor;\n"
17319 " int64_t release;\n"
17326 #: ../src/guestfs-structs.pod:184
17329 " struct guestfs_version_list {\n"
17330 " uint32_t len; /* Number of elements in list. */\n"
17331 " struct guestfs_version *val; /* Elements. */\n"
17337 #: ../src/guestfs-structs.pod:189
17340 " void guestfs_free_version (struct guestfs_free_version *);\n"
17341 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
17346 #: ../src/guestfs-structs.pod:192
17347 msgid "guestfs_xattr"
17351 #: ../src/guestfs-structs.pod:194
17354 " struct guestfs_xattr {\n"
17355 " char *attrname;\n"
17356 " /* The next two fields describe a byte array. */\n"
17357 " uint32_t attrval_len;\n"
17358 " char *attrval;\n"
17364 #: ../src/guestfs-structs.pod:201
17367 " struct guestfs_xattr_list {\n"
17368 " uint32_t len; /* Number of elements in list. */\n"
17369 " struct guestfs_xattr *val; /* Elements. */\n"
17375 #: ../src/guestfs-structs.pod:206
17378 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
17379 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
17384 #: ../src/guestfs-structs.pod:209
17385 msgid "guestfs_inotify_event"
17389 #: ../src/guestfs-structs.pod:211
17392 " struct guestfs_inotify_event {\n"
17393 " int64_t in_wd;\n"
17394 " uint32_t in_mask;\n"
17395 " uint32_t in_cookie;\n"
17396 " char *in_name;\n"
17402 #: ../src/guestfs-structs.pod:218
17405 " struct guestfs_inotify_event_list {\n"
17406 " uint32_t len; /* Number of elements in list. */\n"
17407 " struct guestfs_inotify_event *val; /* Elements. */\n"
17413 #: ../src/guestfs-structs.pod:223
17416 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
17417 " void guestfs_free_inotify_event_list (struct "
17418 "guestfs_free_inotify_event_list *);\n"
17423 #: ../src/guestfs-structs.pod:226
17424 msgid "guestfs_partition"
17428 #: ../src/guestfs-structs.pod:228
17431 " struct guestfs_partition {\n"
17432 " int32_t part_num;\n"
17433 " uint64_t part_start;\n"
17434 " uint64_t part_end;\n"
17435 " uint64_t part_size;\n"
17441 #: ../src/guestfs-structs.pod:235
17444 " struct guestfs_partition_list {\n"
17445 " uint32_t len; /* Number of elements in list. */\n"
17446 " struct guestfs_partition *val; /* Elements. */\n"
17452 #: ../src/guestfs-structs.pod:240
17455 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
17456 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
17461 #: ../src/guestfs-structs.pod:243
17462 msgid "guestfs_application"
17466 #: ../src/guestfs-structs.pod:245
17469 " struct guestfs_application {\n"
17470 " char *app_name;\n"
17471 " char *app_display_name;\n"
17472 " int32_t app_epoch;\n"
17473 " char *app_version;\n"
17474 " char *app_release;\n"
17475 " char *app_install_path;\n"
17476 " char *app_trans_path;\n"
17477 " char *app_publisher;\n"
17478 " char *app_url;\n"
17479 " char *app_source_package;\n"
17480 " char *app_summary;\n"
17481 " char *app_description;\n"
17487 #: ../src/guestfs-structs.pod:260
17490 " struct guestfs_application_list {\n"
17491 " uint32_t len; /* Number of elements in list. */\n"
17492 " struct guestfs_application *val; /* Elements. */\n"
17498 #: ../src/guestfs-structs.pod:265
17501 " void guestfs_free_application (struct guestfs_free_application *);\n"
17502 " void guestfs_free_application_list (struct guestfs_free_application_list "
17508 #: ../fish/guestfish.pod:5
17509 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17513 #: ../fish/guestfish.pod:9
17516 " guestfish [--options] [commands]\n"
17521 #: ../fish/guestfish.pod:11
17529 #: ../fish/guestfish.pod:13
17532 " guestfish [--ro|--rw] -a disk.img\n"
17537 #: ../fish/guestfish.pod:15
17540 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17545 #: ../fish/guestfish.pod:17
17548 " guestfish -d libvirt-domain\n"
17553 #: ../fish/guestfish.pod:19
17556 " guestfish [--ro|--rw] -a disk.img -i\n"
17561 #: ../fish/guestfish.pod:21
17564 " guestfish -d libvirt-domain -i\n"
17569 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
17574 #: ../fish/guestfish.pod:25
17576 "Using guestfish in read/write mode on live virtual machines can be "
17577 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17578 "option to use guestfish safely if the disk image or virtual machine might be "
17583 #: ../fish/guestfish.pod:32
17585 "Guestfish is a shell and command-line tool for examining and modifying "
17586 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17587 "functionality of the guestfs API, see L<guestfs(3)>."
17591 #: ../fish/guestfish.pod:36
17593 "Guestfish gives you structured access to the libguestfs API, from shell "
17594 "scripts or the command line or interactively. If you want to rescue a "
17595 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17600 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:908 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
17605 #: ../fish/guestfish.pod:43
17606 msgid "As an interactive shell"
17610 #: ../fish/guestfish.pod:45
17618 #: ../fish/guestfish.pod:47
17621 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17622 " editing virtual machine filesystems.\n"
17627 #: ../fish/guestfish.pod:50
17630 " Type: 'help' for a list of commands\n"
17631 " 'man' to read the manual\n"
17632 " 'quit' to quit the shell\n"
17637 #: ../fish/guestfish.pod:54
17640 " ><fs> add-ro disk.img\n"
17642 " ><fs> list-filesystems\n"
17643 " /dev/sda1: ext4\n"
17644 " /dev/vg_guest/lv_root: ext4\n"
17645 " /dev/vg_guest/lv_swap: swap\n"
17646 " ><fs> mount /dev/vg_guest/lv_root /\n"
17647 " ><fs> cat /etc/fstab\n"
17649 " # Created by anaconda\n"
17656 #: ../fish/guestfish.pod:67
17657 msgid "From shell scripts"
17661 #: ../fish/guestfish.pod:69
17662 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17666 #: ../fish/guestfish.pod:71
17669 " guestfish <<_EOF_\n"
17672 " mount /dev/vg_guest/lv_root /\n"
17673 " write /etc/motd \"Welcome, new users\"\n"
17679 #: ../fish/guestfish.pod:78
17680 msgid "List the LVM logical volumes in a disk image:"
17684 #: ../fish/guestfish.pod:80
17687 " guestfish -a disk.img --ro <<_EOF_\n"
17695 #: ../fish/guestfish.pod:85
17696 msgid "List all the filesystems in a disk image:"
17700 #: ../fish/guestfish.pod:87
17703 " guestfish -a disk.img --ro <<_EOF_\n"
17705 " list-filesystems\n"
17711 #: ../fish/guestfish.pod:92
17712 msgid "On one command line"
17716 #: ../fish/guestfish.pod:94
17717 msgid "Update C</etc/resolv.conf> in a guest:"
17721 #: ../fish/guestfish.pod:96
17725 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17726 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17731 #: ../fish/guestfish.pod:100
17732 msgid "Edit C</boot/grub/grub.conf> interactively:"
17736 #: ../fish/guestfish.pod:102
17739 " guestfish --rw --add disk.img \\\n"
17740 " --mount /dev/vg_guest/lv_root \\\n"
17741 " --mount /dev/sda1:/boot \\\n"
17742 " edit /boot/grub/grub.conf\n"
17747 #: ../fish/guestfish.pod:107
17748 msgid "Mount disks automatically"
17752 #: ../fish/guestfish.pod:109
17754 "Use the I<-i> option to automatically mount the disks from a virtual "
17759 #: ../fish/guestfish.pod:112
17762 " guestfish --ro -a disk.img -i cat /etc/group\n"
17767 #: ../fish/guestfish.pod:114
17770 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17775 #: ../fish/guestfish.pod:116
17776 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17780 #: ../fish/guestfish.pod:118
17783 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17788 #: ../fish/guestfish.pod:120
17789 msgid "As a script interpreter"
17793 #: ../fish/guestfish.pod:122
17794 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17798 #: ../fish/guestfish.pod:124
17801 " #!/usr/bin/guestfish -f\n"
17802 " sparse test1.img 100M\n"
17804 " part-disk /dev/sda mbr\n"
17805 " mkfs ext2 /dev/sda1\n"
17810 #: ../fish/guestfish.pod:130
17811 msgid "Start with a prepared disk"
17815 #: ../fish/guestfish.pod:132
17817 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17818 "single ext2-formatted partition:"
17822 #: ../fish/guestfish.pod:135
17825 " guestfish -N fs\n"
17830 #: ../fish/guestfish.pod:137
17831 msgid "To list what is available do:"
17835 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:899
17838 " guestfish -N help | less\n"
17843 #: ../fish/guestfish.pod:141
17844 msgid "Remote control"
17848 #: ../fish/guestfish.pod:143
17851 " eval \"`guestfish --listen`\"\n"
17852 " guestfish --remote add-ro disk.img\n"
17853 " guestfish --remote run\n"
17854 " guestfish --remote lvs\n"
17859 #: ../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
17864 #: ../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
17869 #: ../fish/guestfish.pod:154
17870 msgid "Displays general help on options."
17874 #: ../fish/guestfish.pod:156
17879 #: ../fish/guestfish.pod:158
17880 msgid "B<--cmd-help>"
17884 #: ../fish/guestfish.pod:160
17885 msgid "Lists all available guestfish commands."
17889 #: ../fish/guestfish.pod:162
17894 #: ../fish/guestfish.pod:164
17895 msgid "B<--cmd-help cmd>"
17899 #: ../fish/guestfish.pod:166
17900 msgid "Displays detailed help on a single command C<cmd>."
17904 #: ../fish/guestfish.pod:168
17905 msgid "B<-a image>"
17909 #: ../fish/guestfish.pod:170
17910 msgid "B<--add image>"
17914 #: ../fish/guestfish.pod:172
17915 msgid "Add a block device or virtual machine image to the shell."
17919 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
17921 "The format of the disk image is auto-detected. To override this and force a "
17922 "particular format use the I<--format=..> option."
17926 #: ../fish/guestfish.pod:177
17928 "Using this flag is mostly equivalent to using the C<add> command, with "
17929 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17930 "the I<--format=...> flag was given."
17934 #: ../fish/guestfish.pod:181
17939 #: ../fish/guestfish.pod:183
17940 msgid "B<--connect URI>"
17944 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
17946 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17947 "URI to use. The default is to use the default libvirt connection."
17951 #: ../fish/guestfish.pod:189
17956 #: ../fish/guestfish.pod:191
17958 "If using the I<--listen> option and a csh-like shell, use this option. See "
17959 "section L</REMOTE CONTROL AND CSH> below."
17963 #: ../fish/guestfish.pod:194
17964 msgid "B<-d libvirt-domain>"
17968 #: ../fish/guestfish.pod:196
17969 msgid "B<--domain libvirt-domain>"
17973 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
17975 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17976 "used, then any libvirt domain can be used. However in write mode, only "
17977 "libvirt domains which are shut down can be named here."
17981 #: ../fish/guestfish.pod:202
17983 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17984 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17985 "if the I<--format:...> flag was given."
17989 #: ../fish/guestfish.pod:206
17994 #: ../fish/guestfish.pod:208
17995 msgid "B<--no-dest-paths>"
17999 #: ../fish/guestfish.pod:210
18001 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
18002 "to hit the tab key to complete paths on the guest filesystem, but this "
18003 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
18004 "allow this feature to be disabled."
18008 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
18009 msgid "B<--echo-keys>"
18013 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
18015 "When prompting for keys and passphrases, guestfish normally turns echoing "
18016 "off so you cannot see what you are typing. If you are not worried about "
18017 "Tempest attacks and there is no one else in the room you can specify this "
18018 "flag to see what you are typing."
18022 #: ../fish/guestfish.pod:222
18027 #: ../fish/guestfish.pod:224
18028 msgid "B<--file file>"
18032 #: ../fish/guestfish.pod:226
18033 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
18037 #: ../fish/guestfish.pod:229
18040 " #!/usr/bin/guestfish -f\n"
18045 #: ../fish/guestfish.pod:231
18046 msgid "B<--format=raw|qcow2|..>"
18050 #: ../fish/guestfish.pod:233
18051 msgid "B<--format>"
18055 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
18057 "The default for the I<-a> option is to auto-detect the format of the disk "
18058 "image. Using this forces the disk format for I<-a> options which follow on "
18059 "the command line. Using I<--format> with no argument switches back to "
18060 "auto-detection for subsequent I<-a> options."
18064 #: ../fish/guestfish.pod:242
18067 " guestfish --format=raw -a disk.img\n"
18072 #: ../fish/guestfish.pod:244
18073 msgid "forces raw format (no auto-detection) for C<disk.img>."
18077 #: ../fish/guestfish.pod:246
18080 " guestfish --format=raw -a disk.img --format -a another.img\n"
18085 #: ../fish/guestfish.pod:248
18087 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18088 "auto-detection for C<another.img>."
18092 #: ../fish/guestfish.pod:251
18094 "If you have untrusted raw-format guest disk images, you should use this "
18095 "option to specify the disk format. This avoids a possible security problem "
18096 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18100 #: ../fish/guestfish.pod:256
18105 #: ../fish/guestfish.pod:258
18106 msgid "B<--inspector>"
18110 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18112 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18113 "system and mount filesystems as they would be mounted on the real virtual "
18118 #: ../fish/guestfish.pod:264
18119 msgid "Typical usage is either:"
18123 #: ../fish/guestfish.pod:266
18126 " guestfish -d myguest -i\n"
18131 #: ../fish/guestfish.pod:268
18132 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18136 #: ../fish/guestfish.pod:270
18139 " guestfish --ro -d myguest -i\n"
18144 #: ../fish/guestfish.pod:272
18145 msgid "(for active domains, readonly), or specify the block device directly:"
18149 #: ../fish/guestfish.pod:274
18152 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18157 #: ../fish/guestfish.pod:276
18159 "Note that the command line syntax changed slightly over older versions of "
18160 "guestfish. You can still use the old syntax:"
18164 #: ../fish/guestfish.pod:279
18167 " guestfish [--ro] -i disk.img\n"
18172 #: ../fish/guestfish.pod:281
18175 " guestfish [--ro] -i libvirt-domain\n"
18180 #: ../fish/guestfish.pod:283
18182 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
18183 "then using other commands to mount the filesystems that were found."
18187 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
18188 msgid "B<--keys-from-stdin>"
18192 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
18194 "Read key or passphrase parameters from stdin. The default is to try to read "
18195 "passphrases from the user by opening C</dev/tty>."
18199 #: ../fish/guestfish.pod:292
18200 msgid "B<--listen>"
18204 #: ../fish/guestfish.pod:294
18206 "Fork into the background and listen for remote commands. See section "
18207 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18211 #: ../fish/guestfish.pod:297
18212 msgid "B<-m dev[:mountpoint]>"
18216 #: ../fish/guestfish.pod:299
18217 msgid "B<--mount dev[:mountpoint]>"
18221 #: ../fish/guestfish.pod:301
18222 msgid "Mount the named partition or logical volume on the given mountpoint."
18226 #: ../fish/guestfish.pod:303
18227 msgid "If the mountpoint is omitted, it defaults to C</>."
18231 #: ../fish/guestfish.pod:305
18232 msgid "You have to mount something on C</> before most commands will work."
18236 #: ../fish/guestfish.pod:307
18238 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18243 #: ../fish/guestfish.pod:310
18245 "If you don't know what filesystems a disk image contains, you can either run "
18246 "guestfish without this option, then list the partitions, filesystems and LVs "
18247 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18248 "commands), or you can use the L<virt-filesystems(1)> program."
18252 #: ../fish/guestfish.pod:316
18254 "Using this flag is mostly equivalent to using the C<mount-options> command "
18255 "or the C<mount-ro> command if the I<--ro> flag was given."
18259 #: ../fish/guestfish.pod:319
18264 #: ../fish/guestfish.pod:321
18265 msgid "B<--no-sync>"
18269 #: ../fish/guestfish.pod:323
18271 "Disable autosync. This is enabled by default. See the discussion of "
18272 "autosync in the L<guestfs(3)> manpage."
18276 #: ../fish/guestfish.pod:326
18281 #: ../fish/guestfish.pod:328
18282 msgid "B<--new type>"
18286 #: ../fish/guestfish.pod:330
18291 #: ../fish/guestfish.pod:332
18293 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18294 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18295 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18300 #: ../fish/guestfish.pod:337
18301 msgid "B<--progress-bars>"
18305 #: ../fish/guestfish.pod:339
18306 msgid "Enable progress bars, even when guestfish is used non-interactively."
18310 #: ../fish/guestfish.pod:341
18312 "Progress bars are enabled by default when guestfish is used as an "
18313 "interactive shell."
18317 #: ../fish/guestfish.pod:344
18318 msgid "B<--no-progress-bars>"
18322 #: ../fish/guestfish.pod:346
18323 msgid "Disable progress bars."
18327 #: ../fish/guestfish.pod:348
18328 msgid "B<--remote[=pid]>"
18332 #: ../fish/guestfish.pod:350
18334 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18335 "CONTROL GUESTFISH OVER A SOCKET> below."
18339 #: ../fish/guestfish.pod:353
18344 #: ../fish/guestfish.pod:355
18349 #: ../fish/guestfish.pod:357
18351 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18352 "mounts are done read-only."
18356 #: ../fish/guestfish.pod:360
18358 "The option must always be used if the disk image or virtual machine might be "
18359 "running, and is generally recommended in cases where you don't need write "
18360 "access to the disk."
18364 #: ../fish/guestfish.pod:364
18366 "Note that prepared disk images created with I<-N> are not affected by this "
18367 "option. Also commands like C<add> are not affected - you have to specify "
18368 "the C<readonly:true> option explicitly if you need it."
18372 #: ../fish/guestfish.pod:368
18373 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18377 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
18378 msgid "B<--selinux>"
18382 #: ../fish/guestfish.pod:372
18383 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18387 #: ../fish/guestfish.pod:374
18392 #: ../fish/guestfish.pod:376
18393 msgid "B<--verbose>"
18397 #: ../fish/guestfish.pod:378
18399 "Enable very verbose messages. This is particularly useful if you find a "
18404 #: ../fish/guestfish.pod:381
18409 #: ../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
18410 msgid "B<--version>"
18414 #: ../fish/guestfish.pod:385
18415 msgid "Display the guestfish / libguestfs version number and exit."
18419 #: ../fish/guestfish.pod:387
18424 #: ../fish/guestfish.pod:389
18429 #: ../fish/guestfish.pod:391
18431 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
18436 #: ../fish/guestfish.pod:394
18441 #: ../fish/guestfish.pod:396
18442 msgid "Echo each command before executing it."
18446 #: ../fish/guestfish.pod:400
18447 msgid "COMMANDS ON COMMAND LINE"
18451 #: ../fish/guestfish.pod:402
18452 msgid "Any additional (non-option) arguments are treated as commands to execute."
18456 #: ../fish/guestfish.pod:405
18458 "Commands to execute should be separated by a colon (C<:>), where the colon "
18459 "is a separate parameter. Thus:"
18463 #: ../fish/guestfish.pod:408
18466 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18471 #: ../fish/guestfish.pod:410
18473 "If there are no additional arguments, then we enter a shell, either an "
18474 "interactive shell with a prompt (if the input is a terminal) or a "
18475 "non-interactive shell."
18479 #: ../fish/guestfish.pod:414
18481 "In either command line mode or non-interactive shell, the first command that "
18482 "gives an error causes the whole shell to exit. In interactive mode (with a "
18483 "prompt) if a command fails, you can continue to enter commands."
18487 #: ../fish/guestfish.pod:419
18488 msgid "USING launch (OR run)"
18492 #: ../fish/guestfish.pod:421
18494 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18495 "then launch it, then mount any disks you need, and finally issue "
18496 "actions/commands. So the general order of the day is:"
18500 #: ../fish/guestfish.pod:429
18501 msgid "add or -a/--add"
18505 #: ../fish/guestfish.pod:433
18506 msgid "launch (aka run)"
18510 #: ../fish/guestfish.pod:437
18511 msgid "mount or -m/--mount"
18515 #: ../fish/guestfish.pod:441
18516 msgid "any other commands"
18520 #: ../fish/guestfish.pod:445
18522 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18523 "guest before mounting or performing any other commands."
18527 #: ../fish/guestfish.pod:448
18529 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18530 "I<--new> options were given then C<run> is done automatically, simply "
18531 "because guestfish can't perform the action you asked for without doing this."
18535 #: ../fish/guestfish.pod:453
18536 msgid "OPENING DISKS FOR READ AND WRITE"
18540 #: ../fish/guestfish.pod:455
18542 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
18543 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
18544 "open disk images read-only or for writing."
18548 #: ../fish/guestfish.pod:459
18550 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
18551 "disk images supplied on the command line for write. To open a disk image "
18552 "read-only you have to do I<-a image --ro>."
18556 #: ../fish/guestfish.pod:463
18558 "This matters: If you accidentally open a live VM disk image writable then "
18559 "you will cause irreversible disk corruption."
18563 #: ../fish/guestfish.pod:466
18565 "By libguestfs 1.10 we intend to change the default the other way. Disk "
18566 "images will be opened read-only. You will have to either specify "
18567 "I<guestfish --rw> or change a configuration file in order to get write "
18568 "access for disk images specified by those other command line options."
18572 #: ../fish/guestfish.pod:471
18574 "This version of guestfish has a I<--rw> option which does nothing (it is "
18575 "already the default). However it is highly recommended that you use this "
18576 "option to indicate that guestfish needs write access, and to prepare your "
18577 "scripts for the day when this option will be required for write access."
18581 #: ../fish/guestfish.pod:477
18583 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18584 "other libguestfs program apart from guestfish and guestmount."
18588 #: ../fish/guestfish.pod:480
18593 #: ../fish/guestfish.pod:482
18595 "You can quote ordinary parameters using either single or double quotes. For "
18600 #: ../fish/guestfish.pod:485
18603 " add \"file with a space.img\"\n"
18608 #: ../fish/guestfish.pod:487
18611 " rm '/file name'\n"
18616 #: ../fish/guestfish.pod:489
18624 #: ../fish/guestfish.pod:491
18626 "A few commands require a list of strings to be passed. For these, use a "
18627 "whitespace-separated list, enclosed in quotes. Strings containing "
18628 "whitespace to be passed through must be enclosed in single quotes. A "
18629 "literal single quote must be escaped with a backslash."
18633 #: ../fish/guestfish.pod:496
18636 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18637 " command \"/bin/echo 'foo bar'\"\n"
18638 " command \"/bin/echo \\'foo\\'\"\n"
18643 #: ../fish/guestfish.pod:500
18644 msgid "OPTIONAL ARGUMENTS"
18648 #: ../fish/guestfish.pod:502
18650 "Some commands take optional arguments. These arguments appear in this "
18651 "documentation as C<[argname:..]>. You can use them as in these examples:"
18655 #: ../fish/guestfish.pod:506
18658 " add-drive-opts filename\n"
18663 #: ../fish/guestfish.pod:508
18666 " add-drive-opts filename readonly:true\n"
18671 #: ../fish/guestfish.pod:510
18674 " add-drive-opts filename format:qcow2 readonly:false\n"
18679 #: ../fish/guestfish.pod:512
18681 "Each optional argument can appear at most once. All optional arguments must "
18682 "appear after the required ones."
18686 #: ../fish/guestfish.pod:515
18691 #: ../fish/guestfish.pod:517
18692 msgid "This section applies to all commands which can take integers as parameters."
18696 #: ../fish/guestfish.pod:520
18697 msgid "SIZE SUFFIX"
18701 #: ../fish/guestfish.pod:522
18703 "When the command takes a parameter measured in bytes, you can use one of the "
18704 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18708 #: ../fish/guestfish.pod:528
18709 msgid "B<k> or B<K> or B<KiB>"
18713 #: ../fish/guestfish.pod:530
18714 msgid "The size in kilobytes (multiplied by 1024)."
18718 #: ../fish/guestfish.pod:532
18723 #: ../fish/guestfish.pod:534
18724 msgid "The size in SI 1000 byte units."
18728 #: ../fish/guestfish.pod:536
18729 msgid "B<M> or B<MiB>"
18733 #: ../fish/guestfish.pod:538
18734 msgid "The size in megabytes (multiplied by 1048576)."
18738 #: ../fish/guestfish.pod:540
18743 #: ../fish/guestfish.pod:542
18744 msgid "The size in SI 1000000 byte units."
18748 #: ../fish/guestfish.pod:544
18749 msgid "B<G> or B<GiB>"
18753 #: ../fish/guestfish.pod:546
18754 msgid "The size in gigabytes (multiplied by 2**30)."
18758 #: ../fish/guestfish.pod:548
18763 #: ../fish/guestfish.pod:550
18764 msgid "The size in SI 10**9 byte units."
18768 #: ../fish/guestfish.pod:552
18769 msgid "B<T> or B<TiB>"
18773 #: ../fish/guestfish.pod:554
18774 msgid "The size in terabytes (multiplied by 2**40)."
18778 #: ../fish/guestfish.pod:556
18783 #: ../fish/guestfish.pod:558
18784 msgid "The size in SI 10**12 byte units."
18788 #: ../fish/guestfish.pod:560
18789 msgid "B<P> or B<PiB>"
18793 #: ../fish/guestfish.pod:562
18794 msgid "The size in petabytes (multiplied by 2**50)."
18798 #: ../fish/guestfish.pod:564
18803 #: ../fish/guestfish.pod:566
18804 msgid "The size in SI 10**15 byte units."
18808 #: ../fish/guestfish.pod:568
18809 msgid "B<E> or B<EiB>"
18813 #: ../fish/guestfish.pod:570
18814 msgid "The size in exabytes (multiplied by 2**60)."
18818 #: ../fish/guestfish.pod:572
18823 #: ../fish/guestfish.pod:574
18824 msgid "The size in SI 10**18 byte units."
18828 #: ../fish/guestfish.pod:576
18829 msgid "B<Z> or B<ZiB>"
18833 #: ../fish/guestfish.pod:578
18834 msgid "The size in zettabytes (multiplied by 2**70)."
18838 #: ../fish/guestfish.pod:580
18843 #: ../fish/guestfish.pod:582
18844 msgid "The size in SI 10**21 byte units."
18848 #: ../fish/guestfish.pod:584
18849 msgid "B<Y> or B<YiB>"
18853 #: ../fish/guestfish.pod:586
18854 msgid "The size in yottabytes (multiplied by 2**80)."
18858 #: ../fish/guestfish.pod:588
18863 #: ../fish/guestfish.pod:590
18864 msgid "The size in SI 10**24 byte units."
18868 #: ../fish/guestfish.pod:596
18871 " truncate-size /file 1G\n"
18876 #: ../fish/guestfish.pod:598
18877 msgid "would truncate the file to 1 gigabyte."
18881 #: ../fish/guestfish.pod:600
18883 "Be careful because a few commands take sizes in kilobytes or megabytes "
18884 "(eg. the parameter to L</memsize> is specified in megabytes already). "
18885 "Adding a suffix will probably not do what you expect."
18889 #: ../fish/guestfish.pod:604
18890 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18894 #: ../fish/guestfish.pod:606
18896 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18897 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18901 #: ../fish/guestfish.pod:609
18904 " 1234 decimal number 1234\n"
18905 " 02322 octal number, equivalent to decimal 1234\n"
18906 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18911 #: ../fish/guestfish.pod:613
18913 "When using the C<chmod> command, you almost always want to specify an octal "
18914 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18915 "L<chmod(1)> program):"
18919 #: ../fish/guestfish.pod:617
18922 " chmod 0777 /public # OK\n"
18923 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18928 #: ../fish/guestfish.pod:620
18930 "Commands that return numbers usually print them in decimal, but some "
18931 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18932 "octal, preceeded by C<0>)."
18936 #: ../fish/guestfish.pod:624
18937 msgid "WILDCARDS AND GLOBBING"
18941 #: ../fish/guestfish.pod:626
18943 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18944 "(globbing) by default. So for example the following will not do what you "
18949 #: ../fish/guestfish.pod:630
18957 #: ../fish/guestfish.pod:632
18959 "Assuming you don't have a directory called literally C</home/*> then the "
18960 "above command will return an error."
18964 #: ../fish/guestfish.pod:635
18965 msgid "To perform wildcard expansion, use the C<glob> command."
18969 #: ../fish/guestfish.pod:637
18972 " glob rm-rf /home/*\n"
18977 #: ../fish/guestfish.pod:639
18979 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18980 "many times), equivalent to:"
18984 #: ../fish/guestfish.pod:642
18987 " rm-rf /home/jim\n"
18988 " rm-rf /home/joe\n"
18989 " rm-rf /home/mary\n"
18994 #: ../fish/guestfish.pod:646
18995 msgid "C<glob> only works on simple guest paths and not on device names."
18999 #: ../fish/guestfish.pod:648
19001 "If you have several parameters, each containing a wildcard, then glob will "
19002 "perform a Cartesian product."
19006 #: ../fish/guestfish.pod:651
19011 #: ../fish/guestfish.pod:653
19013 "Any line which starts with a I<#> character is treated as a comment and "
19014 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
19015 "a command. For example:"
19019 #: ../fish/guestfish.pod:657
19022 " # this is a comment\n"
19023 " # this is a comment\n"
19024 " foo # NOT a comment\n"
19029 #: ../fish/guestfish.pod:661
19030 msgid "Blank lines are also ignored."
19034 #: ../fish/guestfish.pod:663
19035 msgid "RUNNING COMMANDS LOCALLY"
19039 #: ../fish/guestfish.pod:665
19041 "Any line which starts with a I<!> character is treated as a command sent to "
19042 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
19046 #: ../fish/guestfish.pod:669
19050 " tgz-out /remote local/remote-data.tar.gz\n"
19055 #: ../fish/guestfish.pod:672
19057 "will create a directory C<local> on the host, and then export the contents "
19058 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
19059 "(See C<tgz-out>)."
19063 #: ../fish/guestfish.pod:676
19065 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
19066 "effect, due to the way that subprocesses work in Unix."
19070 #: ../fish/guestfish.pod:679
19075 #: ../fish/guestfish.pod:681
19077 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19078 "command (a guestfish command) to the second command (any host command). For "
19083 #: ../fish/guestfish.pod:685
19086 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19091 #: ../fish/guestfish.pod:687
19093 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19094 "program). The above command would list all accounts in the guest filesystem "
19095 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19099 #: ../fish/guestfish.pod:692
19102 " hexdump /bin/ls | head\n"
19103 " list-devices | tail -1\n"
19104 " tgz-out / - | tar ztf -\n"
19109 #: ../fish/guestfish.pod:696
19111 "The space before the pipe symbol is required, any space after the pipe "
19112 "symbol is optional. Everything after the pipe symbol is just passed "
19113 "straight to the host shell, so it can contain redirections, globs and "
19114 "anything else that makes sense on the host side."
19118 #: ../fish/guestfish.pod:701
19120 "To use a literal argument which begins with a pipe symbol, you have to quote "
19125 #: ../fish/guestfish.pod:704
19133 #: ../fish/guestfish.pod:706
19134 msgid "HOME DIRECTORIES"
19138 #: ../fish/guestfish.pod:708
19140 "If a parameter starts with the character C<~> then the tilde may be expanded "
19141 "as a home directory path (either C<~> for the current user's home directory, "
19142 "or C<~user> for another user)."
19146 #: ../fish/guestfish.pod:712
19148 "Note that home directory expansion happens for users known I<on the host>, "
19149 "not in the guest filesystem."
19153 #: ../fish/guestfish.pod:715
19155 "To use a literal argument which begins with a tilde, you have to quote it, "
19160 #: ../fish/guestfish.pod:718
19168 #: ../fish/guestfish.pod:722
19170 "Libguestfs has some support for Linux guests encrypted according to the "
19171 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19172 "disk encryption systems used by modern Linux guests. Currently only "
19173 "LVM-on-LUKS is supported."
19177 #: ../fish/guestfish.pod:727
19178 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19182 #: ../fish/guestfish.pod:729
19185 " ><fs> vfs-type /dev/sda2\n"
19191 #: ../fish/guestfish.pod:732
19193 "Then open those devices using L</luks-open>. This creates a device-mapper "
19194 "device called C</dev/mapper/luksdev>."
19198 #: ../fish/guestfish.pod:735
19201 " ><fs> luks-open /dev/sda2 luksdev\n"
19202 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19207 #: ../fish/guestfish.pod:738
19209 "Finally you have to tell LVM to scan for volume groups on the newly created "
19214 #: ../fish/guestfish.pod:741
19218 " vg-activate-all true\n"
19223 #: ../fish/guestfish.pod:744
19224 msgid "The logical volume(s) can now be mounted in the usual way."
19228 #: ../fish/guestfish.pod:746
19230 "Before closing a LUKS device you must unmount any logical volumes on it and "
19231 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19232 "one. Then you can close the mapper device:"
19236 #: ../fish/guestfish.pod:750
19239 " vg-activate false /dev/VG\n"
19240 " luks-close /dev/mapper/luksdev\n"
19245 #: ../fish/guestfish.pod:753
19246 msgid "WINDOWS PATHS"
19250 #: ../fish/guestfish.pod:755
19252 "If a path is prefixed with C<win:> then you can use Windows-style paths "
19253 "(with some limitations). The following commands are equivalent:"
19257 #: ../fish/guestfish.pod:758
19260 " file /WINDOWS/system32/config/system.LOG\n"
19265 #: ../fish/guestfish.pod:760
19268 " file win:/windows/system32/config/system.log\n"
19273 #: ../fish/guestfish.pod:762
19276 " file win:\\windows\\system32\\config\\system.log\n"
19281 #: ../fish/guestfish.pod:764
19284 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
19289 #: ../fish/guestfish.pod:766
19291 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
19292 "handles case insensitivity like Windows would. This only works in argument "
19293 "positions that expect a path."
19297 #: ../fish/guestfish.pod:770
19298 msgid "UPLOADING AND DOWNLOADING FILES"
19302 #: ../fish/guestfish.pod:772
19304 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19305 "others which upload from or download to a local file, you can use the "
19306 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19310 #: ../fish/guestfish.pod:776
19318 #: ../fish/guestfish.pod:778
19319 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19323 #: ../fish/guestfish.pod:781
19326 " tar-out /etc - | tar tf -\n"
19331 #: ../fish/guestfish.pod:783
19333 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19334 "command (see L</PIPES>)."
19338 #: ../fish/guestfish.pod:786
19340 "When using C<-> to read from stdin, the input is read up to the end of "
19341 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19342 "some arbitrary end marker:"
19346 #: ../fish/guestfish.pod:790
19349 " upload -<<END /foo\n"
19358 #: ../fish/guestfish.pod:796
19360 "Any string of characters can be used instead of C<END>. The end marker must "
19361 "appear on a line of its own, without any preceeding or following characters "
19362 "(not even spaces)."
19366 #: ../fish/guestfish.pod:800
19368 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19369 "upload local files (so-called \"FileIn\" parameters in the generator)."
19373 #: ../fish/guestfish.pod:803
19374 msgid "EXIT ON ERROR BEHAVIOUR"
19378 #: ../fish/guestfish.pod:805
19380 "By default, guestfish will ignore any errors when in interactive mode "
19381 "(ie. taking commands from a human over a tty), and will exit on the first "
19382 "error in non-interactive mode (scripts, commands given on the command line)."
19386 #: ../fish/guestfish.pod:810
19388 "If you prefix a command with a I<-> character, then that command will not "
19389 "cause guestfish to exit, even if that (one) command returns an error."
19393 #: ../fish/guestfish.pod:814
19394 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19398 #: ../fish/guestfish.pod:816
19400 "Guestfish can be remote-controlled over a socket. This is useful "
19401 "particularly in shell scripts where you want to make several different "
19402 "changes to a filesystem, but you don't want the overhead of starting up a "
19403 "guestfish process each time."
19407 #: ../fish/guestfish.pod:821
19408 msgid "Start a guestfish server process using:"
19412 #: ../fish/guestfish.pod:823
19415 " eval \"`guestfish --listen`\"\n"
19420 #: ../fish/guestfish.pod:825
19421 msgid "and then send it commands by doing:"
19425 #: ../fish/guestfish.pod:827
19428 " guestfish --remote cmd [...]\n"
19433 #: ../fish/guestfish.pod:829
19434 msgid "To cause the server to exit, send it the exit command:"
19438 #: ../fish/guestfish.pod:831
19441 " guestfish --remote exit\n"
19446 #: ../fish/guestfish.pod:833
19448 "Note that the server will normally exit if there is an error in a command. "
19449 "You can change this in the usual way. See section L</EXIT ON ERROR "
19454 #: ../fish/guestfish.pod:837
19455 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19459 #: ../fish/guestfish.pod:839
19461 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19462 "is how the I<--remote> option knows where to send the commands. You can "
19463 "have several guestfish listener processes running using:"
19467 #: ../fish/guestfish.pod:843
19470 " eval \"`guestfish --listen`\"\n"
19471 " pid1=$GUESTFISH_PID\n"
19472 " eval \"`guestfish --listen`\"\n"
19473 " pid2=$GUESTFISH_PID\n"
19475 " guestfish --remote=$pid1 cmd\n"
19476 " guestfish --remote=$pid2 cmd\n"
19481 #: ../fish/guestfish.pod:851
19482 msgid "REMOTE CONTROL AND CSH"
19486 #: ../fish/guestfish.pod:853
19488 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19493 #: ../fish/guestfish.pod:856
19496 " eval \"`guestfish --listen --csh`\"\n"
19501 #: ../fish/guestfish.pod:858
19502 msgid "REMOTE CONTROL DETAILS"
19506 #: ../fish/guestfish.pod:860
19508 "Remote control happens over a Unix domain socket called "
19509 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19510 "of the process, and C<$PID> is the process ID of the server."
19514 #: ../fish/guestfish.pod:864
19515 msgid "Guestfish client and server versions must match exactly."
19519 #: ../fish/guestfish.pod:866
19520 msgid "REMOTE CONTROL RUN COMMAND HANGING"
19524 #: ../fish/guestfish.pod:868
19526 "Using the C<run> (or C<launch>) command remotely in a command substitution "
19527 "context hangs, ie. don't do (note the backquotes):"
19531 #: ../fish/guestfish.pod:871
19534 " a=`guestfish --remote run`\n"
19539 #: ../fish/guestfish.pod:873
19541 "Since the C<run> command produces no output on stdout, this is not useful "
19542 "anyway. For further information see "
19543 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
19547 #: ../fish/guestfish.pod:877
19548 msgid "PREPARED DISK IMAGES"
19552 #: ../fish/guestfish.pod:879
19554 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19555 "preformatted disk images that guestfish can make for you to save typing. "
19556 "This is particularly useful for testing purposes. This option is used "
19557 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19558 "can be mixed with I<-a>)."
19562 #: ../fish/guestfish.pod:885
19564 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19565 "the second and so on. Existing files in the current directory are "
19570 #: ../fish/guestfish.pod:889
19572 "The type briefly describes how the disk should be sized, partitioned, how "
19573 "filesystem(s) should be created, and how content should be added. "
19574 "Optionally the type can be followed by extra parameters, separated by C<:> "
19575 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19576 "sparsely-allocated disk, containing a single partition, with the partition "
19577 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19578 "on a 1GB disk instead."
19582 #: ../fish/guestfish.pod:897
19583 msgid "To list the available types and any extra parameters they take, run:"
19587 #: ../fish/guestfish.pod:901
19589 "Note that the prepared filesystem is not mounted. You would usually have to "
19590 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19594 #: ../fish/guestfish.pod:905
19596 "If any I<-N> or I<--new> options are given, the guest is automatically "
19601 #: ../fish/guestfish.pod:910
19602 msgid "Create a 100MB disk with an ext4-formatted partition:"
19606 #: ../fish/guestfish.pod:912
19609 " guestfish -N fs:ext4\n"
19614 #: ../fish/guestfish.pod:914
19615 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19619 #: ../fish/guestfish.pod:916
19622 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19627 #: ../fish/guestfish.pod:918
19628 msgid "Create a blank 200MB disk:"
19632 #: ../fish/guestfish.pod:920
19635 " guestfish -N disk:200M\n"
19640 #: ../fish/guestfish.pod:922
19641 msgid "PROGRESS BARS"
19645 #: ../fish/guestfish.pod:924
19647 "Some (not all) long-running commands send progress notification messages as "
19648 "they are running. Guestfish turns these messages into progress bars."
19652 #: ../fish/guestfish.pod:928
19654 "When a command that supports progress bars takes longer than two seconds to "
19655 "run, and if progress bars are enabled, then you will see one appearing below "
19660 #: ../fish/guestfish.pod:932
19663 " ><fs> copy-size /large-file /another-file 2048M\n"
19664 " / 10% [#####-----------------------------------------] 00:30\n"
19669 #: ../fish/guestfish.pod:935
19671 "The spinner on the left hand side moves round once for every progress "
19672 "notification received from the backend. This is a (reasonably) golden "
19673 "assurance that the command is \"doing something\" even if the progress bar "
19674 "is not moving, because the command is able to send the progress "
19675 "notifications. When the bar reaches 100% and the command finishes, the "
19676 "spinner disappears."
19680 #: ../fish/guestfish.pod:942
19682 "Progress bars are enabled by default when guestfish is used interactively. "
19683 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19684 "and you can disable them completely using I<--no-progress-bars>."
19688 #: ../fish/guestfish.pod:947
19689 msgid "GUESTFISH COMMANDS"
19693 #: ../fish/guestfish.pod:949
19695 "The commands in this section are guestfish convenience commands, in other "
19696 "words, they are not part of the L<guestfs(3)> API."
19700 #: ../fish/guestfish.pod:952
19705 #: ../fish/guestfish.pod:954
19714 #: ../fish/guestfish.pod:957
19715 msgid "Without any parameter, this provides general help."
19719 #: ../fish/guestfish.pod:959
19720 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19724 #: ../fish/guestfish.pod:961
19725 msgid "quit | exit"
19729 #: ../fish/guestfish.pod:963
19730 msgid "This exits guestfish. You can also use C<^D> key."
19734 #: ../fish/guestfish.pod:965
19735 msgid "@FISH_COMMANDS@"
19739 #: ../fish/guestfish.pod:967
19744 #: ../fish/guestfish.pod:971 ../test-tool/libguestfs-test-tool.pod:83
19749 #: ../fish/guestfish.pod:973
19751 "guestfish returns 0 if the commands completed without error, or 1 if there "
19756 #: ../fish/guestfish.pod:980
19761 #: ../fish/guestfish.pod:982
19763 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19768 #: ../fish/guestfish.pod:985
19769 msgid "GUESTFISH_PID"
19773 #: ../fish/guestfish.pod:987
19775 "Used with the I<--remote> option to specify the remote guestfish process to "
19776 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19780 #: ../fish/guestfish.pod:991
19785 #: ../fish/guestfish.pod:993
19787 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19788 "not specified, the external L<hexedit(1)> program is used."
19792 #: ../fish/guestfish.pod:997
19797 #: ../fish/guestfish.pod:999
19799 "If compiled with GNU readline support, various files in the home directory "
19800 "can be used. See L</FILES>."
19804 #: ../fish/guestfish.pod:1008
19806 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19807 "effect as using the B<-v> option."
19811 #: ../fish/guestfish.pod:1020
19813 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19814 "the discussion of paths in L<guestfs(3)>."
19818 #: ../fish/guestfish.pod:1031
19819 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19823 #: ../fish/guestfish.pod:1033
19828 #: ../fish/guestfish.pod:1035
19830 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19835 #: ../fish/guestfish.pod:1050 ../test-tool/libguestfs-test-tool.pod:88
19840 #: ../fish/guestfish.pod:1054
19841 msgid "$HOME/.guestfish"
19845 #: ../fish/guestfish.pod:1056
19847 "If compiled with GNU readline support, then the command history is saved in "
19852 #: ../fish/guestfish.pod:1059
19853 msgid "$HOME/.inputrc"
19857 #: ../fish/guestfish.pod:1061
19858 msgid "/etc/inputrc"
19862 #: ../fish/guestfish.pod:1063
19864 "If compiled with GNU readline support, then these files can be used to "
19865 "configure readline. For further information, please see "
19866 "L<readline(3)/INITIALIZATION FILE>."
19870 #: ../fish/guestfish.pod:1067
19871 msgid "To write rules which only apply to guestfish, use:"
19875 #: ../fish/guestfish.pod:1069
19885 #: ../fish/guestfish.pod:1073
19887 "Variables that you can set in inputrc that change the behaviour of guestfish "
19888 "in useful ways include:"
19892 #: ../fish/guestfish.pod:1078
19893 msgid "completion-ignore-case (default: on)"
19897 #: ../fish/guestfish.pod:1080
19899 "By default, guestfish will ignore case when tab-completing paths on the "
19904 #: ../fish/guestfish.pod:1083
19907 " set completion-ignore-case off\n"
19912 #: ../fish/guestfish.pod:1085
19913 msgid "to make guestfish case sensitive."
19917 #: ../fish/guestfish.pod:1089
19922 #: ../fish/guestfish.pod:1091
19923 msgid "test2.img (etc)"
19927 #: ../fish/guestfish.pod:1093
19929 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19930 "will be created in the file C<test1.img> in the current directory. The "
19931 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19932 "the same name will be overwritten."
19936 #: ../fish/guestfish.pod:1102
19938 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19939 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
19940 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
19941 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
19942 "L<virt-win-reg(1)>, L<hexedit(1)>."
19946 #: ../fish/guestfish.pod:1128 ../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
19948 "This program is free software; you can redistribute it and/or modify it "
19949 "under the terms of the GNU General Public License as published by the Free "
19950 "Software Foundation; either version 2 of the License, or (at your option) "
19951 "any later version."
19955 #: ../fish/guestfish.pod:1133 ../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
19957 "This program is distributed in the hope that it will be useful, but WITHOUT "
19958 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19959 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19964 #: ../fish/guestfish.pod:1138 ../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
19966 "You should have received a copy of the GNU General Public License along with "
19967 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19968 "Ave, Cambridge, MA 02139, USA."
19972 #: ../fish/guestfish-actions.pod:1
19977 #: ../fish/guestfish-actions.pod:3
19980 " add-cdrom filename\n"
19985 #: ../fish/guestfish-actions.pod:15
19987 "This call checks for the existence of C<filename>. This stops you from "
19988 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19989 "and C<http:> URLs. To specify those, use the general L</config> call "
19994 #: ../fish/guestfish-actions.pod:22
19996 "If you just want to add an ISO file (often you use this as an efficient way "
19997 "to transfer large files into the guest), then you should probably use "
19998 "L</add-drive-ro> instead."
20002 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
20004 "This function is deprecated. In new code, use the L</add_drive_opts> call "
20009 #: ../fish/guestfish-actions.pod:35
20014 #: ../fish/guestfish-actions.pod:37
20019 #: ../fish/guestfish-actions.pod:39
20022 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
20027 #: ../fish/guestfish-actions.pod:41
20029 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
20030 "It works by connecting to libvirt, requesting the domain and domain XML from "
20031 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
20035 #: ../fish/guestfish-actions.pod:64
20037 "The other optional parameters are passed directly through to "
20038 "L</add-drive-opts>."
20042 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131 ../fish/guestfish-actions.pod:2872
20044 "This command has one or more optional arguments. See L</OPTIONAL "
20049 #: ../fish/guestfish-actions.pod:69
20054 #: ../fish/guestfish-actions.pod:71
20057 " add-drive filename\n"
20062 #: ../fish/guestfish-actions.pod:73
20064 "This function is the equivalent of calling L</add-drive-opts> with no "
20065 "optional parameters, so the disk is added writable, with the format being "
20066 "detected automatically."
20070 #: ../fish/guestfish-actions.pod:77
20072 "Automatic detection of the format opens you up to a potential security hole "
20073 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
20074 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
20075 "you should think about replacing calls to this function with calls to "
20076 "L</add-drive-opts>, and specifying the format."
20080 #: ../fish/guestfish-actions.pod:84
20081 msgid "add-drive-opts"
20085 #: ../fish/guestfish-actions.pod:86
20090 #: ../fish/guestfish-actions.pod:88
20093 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
20098 #: ../fish/guestfish-actions.pod:115
20100 "This forces the image format. If you omit this (or use L</add-drive> or "
20101 "L</add-drive-ro>) then the format is automatically detected. Possible "
20102 "formats include C<raw> and C<qcow2>."
20106 #: ../fish/guestfish-actions.pod:126
20108 "This rarely-used option lets you emulate the behaviour of the deprecated "
20109 "L</add-drive-with-if> call (q.v.)"
20113 #: ../fish/guestfish-actions.pod:133
20114 msgid "add-drive-ro"
20118 #: ../fish/guestfish-actions.pod:135
20123 #: ../fish/guestfish-actions.pod:137
20126 " add-drive-ro filename\n"
20131 #: ../fish/guestfish-actions.pod:139
20133 "This function is the equivalent of calling L</add-drive-opts> with the "
20134 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20135 "is added read-only, with the format being detected automatically."
20139 #: ../fish/guestfish-actions.pod:144
20140 msgid "add-drive-ro-with-if"
20144 #: ../fish/guestfish-actions.pod:146
20147 " add-drive-ro-with-if filename iface\n"
20152 #: ../fish/guestfish-actions.pod:148
20154 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
20155 "interface emulation to use at run time."
20159 #: ../fish/guestfish-actions.pod:158
20160 msgid "add-drive-with-if"
20164 #: ../fish/guestfish-actions.pod:160
20167 " add-drive-with-if filename iface\n"
20172 #: ../fish/guestfish-actions.pod:162
20174 "This is the same as L</add-drive> but it allows you to specify the QEMU "
20175 "interface emulation to use at run time."
20179 #: ../fish/guestfish-actions.pod:172
20184 #: ../fish/guestfish-actions.pod:174
20187 " aug-clear augpath\n"
20192 #: ../fish/guestfish-actions.pod:179
20197 #: ../fish/guestfish-actions.pod:181
20205 #: ../fish/guestfish-actions.pod:183
20207 "Close the current Augeas handle and free up any resources used by it. After "
20208 "calling this, you have to call L</aug-init> again before you can use any "
20209 "other Augeas functions."
20213 #: ../fish/guestfish-actions.pod:188
20214 msgid "aug-defnode"
20218 #: ../fish/guestfish-actions.pod:190
20221 " aug-defnode name expr val\n"
20226 #: ../fish/guestfish-actions.pod:195
20228 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
20229 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
20230 "containing that single node."
20234 #: ../fish/guestfish-actions.pod:203
20239 #: ../fish/guestfish-actions.pod:205
20242 " aug-defvar name expr\n"
20247 #: ../fish/guestfish-actions.pod:214
20252 #: ../fish/guestfish-actions.pod:216
20255 " aug-get augpath\n"
20260 #: ../fish/guestfish-actions.pod:221
20265 #: ../fish/guestfish-actions.pod:223
20268 " aug-init root flags\n"
20273 #: ../fish/guestfish-actions.pod:229
20274 msgid "You must call this before using any other L</aug-*> commands."
20278 #: ../fish/guestfish-actions.pod:254
20280 "This option is only useful when debugging Augeas lenses. Use of this option "
20281 "may require additional memory for the libguestfs appliance. You may need to "
20282 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
20286 #: ../fish/guestfish-actions.pod:269
20287 msgid "Do not load the tree in L</aug-init>."
20291 #: ../fish/guestfish-actions.pod:273
20292 msgid "To close the handle, you can call L</aug-close>."
20296 #: ../fish/guestfish-actions.pod:277
20301 #: ../fish/guestfish-actions.pod:279
20304 " aug-insert augpath label true|false\n"
20309 #: ../fish/guestfish-actions.pod:289
20314 #: ../fish/guestfish-actions.pod:291
20322 #: ../fish/guestfish-actions.pod:298
20327 #: ../fish/guestfish-actions.pod:300
20330 " aug-ls augpath\n"
20335 #: ../fish/guestfish-actions.pod:302
20337 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
20338 "resulting nodes into alphabetical order."
20342 #: ../fish/guestfish-actions.pod:305
20347 #: ../fish/guestfish-actions.pod:307
20350 " aug-match augpath\n"
20355 #: ../fish/guestfish-actions.pod:313
20360 #: ../fish/guestfish-actions.pod:315
20363 " aug-mv src dest\n"
20368 #: ../fish/guestfish-actions.pod:320
20373 #: ../fish/guestfish-actions.pod:322
20376 " aug-rm augpath\n"
20381 #: ../fish/guestfish-actions.pod:328
20386 #: ../fish/guestfish-actions.pod:330
20394 #: ../fish/guestfish-actions.pod:334
20396 "The flags which were passed to L</aug-init> affect exactly how files are "
20401 #: ../fish/guestfish-actions.pod:337
20406 #: ../fish/guestfish-actions.pod:339
20409 " aug-set augpath val\n"
20414 #: ../fish/guestfish-actions.pod:343
20416 "In the Augeas API, it is possible to clear a node by setting the value to "
20417 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
20418 "this call. Instead you must use the L</aug-clear> call."
20422 #: ../fish/guestfish-actions.pod:348
20427 #: ../fish/guestfish-actions.pod:350
20430 " available 'groups ...'\n"
20435 #: ../fish/guestfish-actions.pod:356
20437 "The libguestfs groups, and the functions that those groups correspond to, "
20438 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
20439 "runtime by calling L</available-all-groups>."
20443 #: ../fish/guestfish-actions.pod:380
20444 msgid "You must call L</launch> before calling this function."
20448 #: ../fish/guestfish-actions.pod:402
20450 "This call was added in version C<1.0.80>. In previous versions of "
20451 "libguestfs all you could do would be to speculatively execute a command to "
20452 "find out if the daemon implemented it. See also L</version>."
20456 #: ../fish/guestfish-actions.pod:409
20457 msgid "available-all-groups"
20461 #: ../fish/guestfish-actions.pod:411
20464 " available-all-groups\n"
20469 #: ../fish/guestfish-actions.pod:413
20471 "This command returns a list of all optional groups that this daemon knows "
20472 "about. Note this returns both supported and unsupported groups. To find "
20473 "out which ones the daemon can actually support you have to call "
20474 "L</available> on each member of the returned list."
20478 #: ../fish/guestfish-actions.pod:419
20479 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
20483 #: ../fish/guestfish-actions.pod:421
20488 #: ../fish/guestfish-actions.pod:423
20491 " base64-in (base64file|-) filename\n"
20496 #: ../fish/guestfish-actions.pod:428 ../fish/guestfish-actions.pod:437 ../fish/guestfish-actions.pod:661 ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:849 ../fish/guestfish-actions.pod:1223 ../fish/guestfish-actions.pod:4236 ../fish/guestfish-actions.pod:4248 ../fish/guestfish-actions.pod:4259 ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4322 ../fish/guestfish-actions.pod:4331 ../fish/guestfish-actions.pod:4385 ../fish/guestfish-actions.pod:4408
20497 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
20501 #: ../fish/guestfish-actions.pod:430
20506 #: ../fish/guestfish-actions.pod:432
20509 " base64-out filename (base64file|-)\n"
20514 #: ../fish/guestfish-actions.pod:439
20515 msgid "blockdev-flushbufs"
20519 #: ../fish/guestfish-actions.pod:441
20522 " blockdev-flushbufs device\n"
20527 #: ../fish/guestfish-actions.pod:448
20528 msgid "blockdev-getbsz"
20532 #: ../fish/guestfish-actions.pod:450
20535 " blockdev-getbsz device\n"
20540 #: ../fish/guestfish-actions.pod:459
20541 msgid "blockdev-getro"
20545 #: ../fish/guestfish-actions.pod:461
20548 " blockdev-getro device\n"
20553 #: ../fish/guestfish-actions.pod:468
20554 msgid "blockdev-getsize64"
20558 #: ../fish/guestfish-actions.pod:470
20561 " blockdev-getsize64 device\n"
20566 #: ../fish/guestfish-actions.pod:474
20567 msgid "See also L</blockdev-getsz>."
20571 #: ../fish/guestfish-actions.pod:478
20572 msgid "blockdev-getss"
20576 #: ../fish/guestfish-actions.pod:480
20579 " blockdev-getss device\n"
20584 #: ../fish/guestfish-actions.pod:485
20585 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
20589 #: ../fish/guestfish-actions.pod:490
20590 msgid "blockdev-getsz"
20594 #: ../fish/guestfish-actions.pod:492
20597 " blockdev-getsz device\n"
20602 #: ../fish/guestfish-actions.pod:497
20604 "See also L</blockdev-getss> for the real sector size of the device, and "
20605 "L</blockdev-getsize64> for the more useful I<size in bytes>."
20609 #: ../fish/guestfish-actions.pod:503
20610 msgid "blockdev-rereadpt"
20614 #: ../fish/guestfish-actions.pod:505
20617 " blockdev-rereadpt device\n"
20622 #: ../fish/guestfish-actions.pod:511
20623 msgid "blockdev-setbsz"
20627 #: ../fish/guestfish-actions.pod:513
20630 " blockdev-setbsz device blocksize\n"
20635 #: ../fish/guestfish-actions.pod:522
20636 msgid "blockdev-setro"
20640 #: ../fish/guestfish-actions.pod:524
20643 " blockdev-setro device\n"
20648 #: ../fish/guestfish-actions.pod:530
20649 msgid "blockdev-setrw"
20653 #: ../fish/guestfish-actions.pod:532
20656 " blockdev-setrw device\n"
20661 #: ../fish/guestfish-actions.pod:538
20662 msgid "case-sensitive-path"
20666 #: ../fish/guestfish-actions.pod:540
20669 " case-sensitive-path path\n"
20674 #: ../fish/guestfish-actions.pod:564
20676 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
20677 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
20678 "how the directories were originally created under Windows)."
20682 #: ../fish/guestfish-actions.pod:572
20683 msgid "See also L</realpath>."
20687 #: ../fish/guestfish-actions.pod:574
20692 #: ../fish/guestfish-actions.pod:576
20700 #: ../fish/guestfish-actions.pod:580
20702 "Note that this function cannot correctly handle binary files (specifically, "
20703 "files containing C<\\0> character which is treated as end of string). For "
20704 "those you need to use the L</read-file> or L</download> functions which have "
20705 "a more complex interface."
20709 #: ../fish/guestfish-actions.pod:588
20714 #: ../fish/guestfish-actions.pod:590
20717 " checksum csumtype path\n"
20722 #: ../fish/guestfish-actions.pod:633
20723 msgid "To get the checksum for a device, use L</checksum-device>."
20727 #: ../fish/guestfish-actions.pod:635
20728 msgid "To get the checksums for many files, use L</checksums-out>."
20732 #: ../fish/guestfish-actions.pod:637
20733 msgid "checksum-device"
20737 #: ../fish/guestfish-actions.pod:639
20740 " checksum-device csumtype device\n"
20745 #: ../fish/guestfish-actions.pod:641
20747 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20748 "device named C<device>. For the types of checksums supported see the "
20749 "L</checksum> command."
20753 #: ../fish/guestfish-actions.pod:645
20754 msgid "checksums-out"
20758 #: ../fish/guestfish-actions.pod:647
20761 " checksums-out csumtype directory (sumsfile|-)\n"
20766 #: ../fish/guestfish-actions.pod:663
20771 #: ../fish/guestfish-actions.pod:665
20774 " chmod mode path\n"
20779 #: ../fish/guestfish-actions.pod:676
20784 #: ../fish/guestfish-actions.pod:678
20787 " chown owner group path\n"
20792 #: ../fish/guestfish-actions.pod:686
20797 #: ../fish/guestfish-actions.pod:688
20800 " command 'arguments ...'\n"
20805 #: ../fish/guestfish-actions.pod:695
20807 "The single parameter is an argv-style list of arguments. The first element "
20808 "is the name of the program to run. Subsequent elements are parameters. The "
20809 "list must be non-empty (ie. must contain a program name). Note that the "
20810 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20814 #: ../fish/guestfish-actions.pod:723
20815 msgid "command-lines"
20819 #: ../fish/guestfish-actions.pod:725
20822 " command-lines 'arguments ...'\n"
20827 #: ../fish/guestfish-actions.pod:727
20828 msgid "This is the same as L</command>, but splits the result into a list of lines."
20832 #: ../fish/guestfish-actions.pod:730
20833 msgid "See also: L</sh-lines>"
20837 #: ../fish/guestfish-actions.pod:735
20842 #: ../fish/guestfish-actions.pod:737
20845 " config qemuparam qemuvalue\n"
20850 #: ../fish/guestfish-actions.pod:748
20855 #: ../fish/guestfish-actions.pod:750
20858 " copy-size src dest size\n"
20863 #: ../fish/guestfish-actions.pod:758
20868 #: ../fish/guestfish-actions.pod:760
20876 #: ../fish/guestfish-actions.pod:765
20881 #: ../fish/guestfish-actions.pod:767
20889 #: ../fish/guestfish-actions.pod:772
20894 #: ../fish/guestfish-actions.pod:774
20902 #: ../fish/guestfish-actions.pod:781
20904 "If the destination is a device, it must be as large or larger than the "
20905 "source file or device, otherwise the copy will fail. This command cannot do "
20906 "partial copies (see L</copy-size>)."
20910 #: ../fish/guestfish-actions.pod:785
20915 #: ../fish/guestfish-actions.pod:787
20923 #: ../fish/guestfish-actions.pod:791 ../fish/guestfish-actions.pod:802
20925 "This command is mostly useful for interactive sessions. It is I<not> "
20926 "intended that you try to parse the output string. Use L</statvfs> from "
20931 #: ../fish/guestfish-actions.pod:795
20936 #: ../fish/guestfish-actions.pod:797
20944 #: ../fish/guestfish-actions.pod:806
20949 #: ../fish/guestfish-actions.pod:808
20957 #: ../fish/guestfish-actions.pod:814
20959 "Another way to get the same information is to enable verbose messages with "
20960 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20961 "before running the program."
20965 #: ../fish/guestfish-actions.pod:819
20970 #: ../fish/guestfish-actions.pod:821
20973 " download remotefilename (filename|-)\n"
20978 #: ../fish/guestfish-actions.pod:828
20979 msgid "See also L</upload>, L</cat>."
20983 #: ../fish/guestfish-actions.pod:832
20984 msgid "download-offset"
20988 #: ../fish/guestfish-actions.pod:834
20991 " download-offset remotefilename (filename|-) offset size\n"
20996 #: ../fish/guestfish-actions.pod:842
20998 "Note that there is no limit on the amount of data that can be downloaded "
20999 "with this call, unlike with L</pread>, and this call always reads the full "
21000 "amount unless an error occurs."
21004 #: ../fish/guestfish-actions.pod:847
21005 msgid "See also L</download>, L</pread>."
21009 #: ../fish/guestfish-actions.pod:851
21010 msgid "drop-caches"
21014 #: ../fish/guestfish-actions.pod:853
21017 " drop-caches whattodrop\n"
21022 #: ../fish/guestfish-actions.pod:865
21027 #: ../fish/guestfish-actions.pod:867
21035 #: ../fish/guestfish-actions.pod:879
21040 #: ../fish/guestfish-actions.pod:881
21043 " e2fsck-f device\n"
21048 #: ../fish/guestfish-actions.pod:887
21050 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
21051 "should use L</fsck>."
21055 #: ../fish/guestfish-actions.pod:890
21056 msgid "echo-daemon"
21060 #: ../fish/guestfish-actions.pod:892
21063 " echo-daemon 'words ...'\n"
21068 #: ../fish/guestfish-actions.pod:899
21069 msgid "See also L</ping-daemon>."
21073 #: ../fish/guestfish-actions.pod:901
21078 #: ../fish/guestfish-actions.pod:903
21081 " egrep regex path\n"
21086 #: ../fish/guestfish-actions.pod:911
21091 #: ../fish/guestfish-actions.pod:913
21094 " egrepi regex path\n"
21099 #: ../fish/guestfish-actions.pod:921
21104 #: ../fish/guestfish-actions.pod:923
21107 " equal file1 file2\n"
21112 #: ../fish/guestfish-actions.pod:930
21117 #: ../fish/guestfish-actions.pod:932
21125 #: ../fish/guestfish-actions.pod:937
21126 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21130 #: ../fish/guestfish-actions.pod:939
21135 #: ../fish/guestfish-actions.pod:941
21138 " fallocate path len\n"
21143 #: ../fish/guestfish-actions.pod:951
21145 "This function is deprecated. In new code, use the L</fallocate64> call "
21150 #: ../fish/guestfish-actions.pod:958
21151 msgid "fallocate64"
21155 #: ../fish/guestfish-actions.pod:960
21158 " fallocate64 path len\n"
21163 #: ../fish/guestfish-actions.pod:966
21165 "Note that this call allocates disk blocks for the file. To create a sparse "
21166 "file use L</truncate-size> instead."
21170 #: ../fish/guestfish-actions.pod:969
21172 "The deprecated call L</fallocate> does the same, but owing to an oversight "
21173 "it only allowed 30 bit lengths to be specified, effectively limiting the "
21174 "maximum size of files created through that call to 1GB."
21178 #: ../fish/guestfish-actions.pod:978
21183 #: ../fish/guestfish-actions.pod:980
21186 " fgrep pattern path\n"
21191 #: ../fish/guestfish-actions.pod:988
21196 #: ../fish/guestfish-actions.pod:990
21199 " fgrepi pattern path\n"
21204 #: ../fish/guestfish-actions.pod:998
21209 #: ../fish/guestfish-actions.pod:1000
21217 #: ../fish/guestfish-actions.pod:1016
21219 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
21224 #: ../fish/guestfish-actions.pod:1019
21225 msgid "file-architecture"
21229 #: ../fish/guestfish-actions.pod:1021
21232 " file-architecture filename\n"
21237 #: ../fish/guestfish-actions.pod:1124
21242 #: ../fish/guestfish-actions.pod:1126
21250 #: ../fish/guestfish-actions.pod:1130
21252 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
21253 "L</is-file> etc. To get the size of block devices, use "
21254 "L</blockdev-getsize64>."
21258 #: ../fish/guestfish-actions.pod:1134
21263 #: ../fish/guestfish-actions.pod:1136
21266 " fill c len path\n"
21271 #: ../fish/guestfish-actions.pod:1142
21273 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
21274 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
21275 "L</fill-pattern>."
21279 #: ../fish/guestfish-actions.pod:1147
21280 msgid "fill-pattern"
21284 #: ../fish/guestfish-actions.pod:1149
21287 " fill-pattern pattern len path\n"
21292 #: ../fish/guestfish-actions.pod:1151
21294 "This function is like L</fill> except that it creates a new file of length "
21295 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
21296 "is truncated if necessary to ensure the length of the file is exactly C<len> "
21301 #: ../fish/guestfish-actions.pod:1156
21306 #: ../fish/guestfish-actions.pod:1158
21309 " find directory\n"
21314 #: ../fish/guestfish-actions.pod:1172
21315 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
21319 #: ../fish/guestfish-actions.pod:1185
21320 msgid "See also L</find0>."
21324 #: ../fish/guestfish-actions.pod:1190
21329 #: ../fish/guestfish-actions.pod:1192
21332 " find0 directory (files|-)\n"
21337 #: ../fish/guestfish-actions.pod:1198
21338 msgid "This command works the same way as L</find> with the following exceptions:"
21342 #: ../fish/guestfish-actions.pod:1225
21343 msgid "findfs-label"
21347 #: ../fish/guestfish-actions.pod:1227
21350 " findfs-label label\n"
21355 #: ../fish/guestfish-actions.pod:1233
21356 msgid "To find the label of a filesystem, use L</vfs-label>."
21360 #: ../fish/guestfish-actions.pod:1235
21361 msgid "findfs-uuid"
21365 #: ../fish/guestfish-actions.pod:1237
21368 " findfs-uuid uuid\n"
21373 #: ../fish/guestfish-actions.pod:1243
21374 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
21378 #: ../fish/guestfish-actions.pod:1245
21383 #: ../fish/guestfish-actions.pod:1247
21386 " fsck fstype device\n"
21391 #: ../fish/guestfish-actions.pod:1277
21396 #: ../fish/guestfish-actions.pod:1279
21404 #: ../fish/guestfish-actions.pod:1286
21405 msgid "get-autosync"
21409 #: ../fish/guestfish-actions.pod:1288
21417 #: ../fish/guestfish-actions.pod:1292
21422 #: ../fish/guestfish-actions.pod:1294
21430 #: ../fish/guestfish-actions.pod:1298
21431 msgid "get-e2label"
21435 #: ../fish/guestfish-actions.pod:1300
21438 " get-e2label device\n"
21443 #: ../fish/guestfish-actions.pod:1305
21445 "This function is deprecated. In new code, use the L</vfs_label> call "
21450 #: ../fish/guestfish-actions.pod:1312
21455 #: ../fish/guestfish-actions.pod:1314
21458 " get-e2uuid device\n"
21463 #: ../fish/guestfish-actions.pod:1319
21465 "This function is deprecated. In new code, use the L</vfs_uuid> call "
21470 #: ../fish/guestfish-actions.pod:1326
21471 msgid "get-memsize"
21475 #: ../fish/guestfish-actions.pod:1328
21483 #: ../fish/guestfish-actions.pod:1333
21485 "If L</set-memsize> was not called on this handle, and if "
21486 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
21487 "value for memsize."
21491 #: ../fish/guestfish-actions.pod:1340
21492 msgid "get-network"
21496 #: ../fish/guestfish-actions.pod:1342
21504 #: ../fish/guestfish-actions.pod:1346
21509 #: ../fish/guestfish-actions.pod:1348
21517 #: ../fish/guestfish-actions.pod:1355
21522 #: ../fish/guestfish-actions.pod:1357
21527 #: ../fish/guestfish-actions.pod:1359
21535 #: ../fish/guestfish-actions.pod:1366
21540 #: ../fish/guestfish-actions.pod:1368
21548 #: ../fish/guestfish-actions.pod:1375
21549 msgid "get-recovery-proc"
21553 #: ../fish/guestfish-actions.pod:1377
21556 " get-recovery-proc\n"
21561 #: ../fish/guestfish-actions.pod:1381
21562 msgid "get-selinux"
21566 #: ../fish/guestfish-actions.pod:1383
21574 #: ../fish/guestfish-actions.pod:1385
21576 "This returns the current setting of the selinux flag which is passed to the "
21577 "appliance at boot time. See L</set-selinux>."
21581 #: ../fish/guestfish-actions.pod:1391
21586 #: ../fish/guestfish-actions.pod:1393
21594 #: ../fish/guestfish-actions.pod:1400
21599 #: ../fish/guestfish-actions.pod:1402
21607 #: ../fish/guestfish-actions.pod:1406
21612 #: ../fish/guestfish-actions.pod:1408
21620 #: ../fish/guestfish-actions.pod:1410
21622 "Return the current umask. By default the umask is C<022> unless it has been "
21623 "set by calling L</umask>."
21627 #: ../fish/guestfish-actions.pod:1413
21628 msgid "get-verbose"
21632 #: ../fish/guestfish-actions.pod:1415
21640 #: ../fish/guestfish-actions.pod:1419
21645 #: ../fish/guestfish-actions.pod:1421
21653 #: ../fish/guestfish-actions.pod:1425
21654 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
21658 #: ../fish/guestfish-actions.pod:1428
21663 #: ../fish/guestfish-actions.pod:1430
21666 " getxattr path name\n"
21671 #: ../fish/guestfish-actions.pod:1432
21673 "Get a single extended attribute from file C<path> named C<name>. This call "
21674 "follows symlinks. If you want to lookup an extended attribute for the "
21675 "symlink itself, use L</lgetxattr>."
21679 #: ../fish/guestfish-actions.pod:1436 ../fish/guestfish-actions.pod:2289
21681 "Normally it is better to get all extended attributes from a file in one go "
21682 "by calling L</getxattrs>. However some Linux filesystem implementations are "
21683 "buggy and do not provide a way to list out attributes. For these "
21684 "filesystems (notably ntfs-3g) you have to know the names of the extended "
21685 "attributes you want in advance and call this function."
21689 #: ../fish/guestfish-actions.pod:1446
21690 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
21694 #: ../fish/guestfish-actions.pod:1448
21699 #: ../fish/guestfish-actions.pod:1450
21702 " getxattrs path\n"
21707 #: ../fish/guestfish-actions.pod:1458
21708 msgid "See also: L</lgetxattrs>, L<attr(5)>."
21712 #: ../fish/guestfish-actions.pod:1460
21713 msgid "glob-expand"
21717 #: ../fish/guestfish-actions.pod:1462
21720 " glob-expand pattern\n"
21725 #: ../fish/guestfish-actions.pod:1475
21730 #: ../fish/guestfish-actions.pod:1477
21733 " grep regex path\n"
21738 #: ../fish/guestfish-actions.pod:1485
21743 #: ../fish/guestfish-actions.pod:1487
21746 " grepi regex path\n"
21751 #: ../fish/guestfish-actions.pod:1495
21752 msgid "grub-install"
21756 #: ../fish/guestfish-actions.pod:1497
21759 " grub-install root device\n"
21764 #: ../fish/guestfish-actions.pod:1535
21769 #: ../fish/guestfish-actions.pod:1537
21777 #: ../fish/guestfish-actions.pod:1545
21782 #: ../fish/guestfish-actions.pod:1547
21785 " head-n nrlines path\n"
21790 #: ../fish/guestfish-actions.pod:1560
21795 #: ../fish/guestfish-actions.pod:1562
21803 #: ../fish/guestfish-actions.pod:1570
21808 #: ../fish/guestfish-actions.pod:1572
21811 " initrd-cat initrdpath filename\n"
21816 #: ../fish/guestfish-actions.pod:1584
21817 msgid "See also L</initrd-list>."
21821 #: ../fish/guestfish-actions.pod:1589
21822 msgid "initrd-list"
21826 #: ../fish/guestfish-actions.pod:1591
21829 " initrd-list path\n"
21834 #: ../fish/guestfish-actions.pod:1603
21835 msgid "inotify-add-watch"
21839 #: ../fish/guestfish-actions.pod:1605
21842 " inotify-add-watch path mask\n"
21847 #: ../fish/guestfish-actions.pod:1617
21848 msgid "inotify-close"
21852 #: ../fish/guestfish-actions.pod:1619
21860 #: ../fish/guestfish-actions.pod:1625
21861 msgid "inotify-files"
21865 #: ../fish/guestfish-actions.pod:1627
21873 #: ../fish/guestfish-actions.pod:1629
21875 "This function is a helpful wrapper around L</inotify-read> which just "
21876 "returns a list of pathnames of objects that were touched. The returned "
21877 "pathnames are sorted and deduplicated."
21881 #: ../fish/guestfish-actions.pod:1633
21882 msgid "inotify-init"
21886 #: ../fish/guestfish-actions.pod:1635
21889 " inotify-init maxevents\n"
21894 #: ../fish/guestfish-actions.pod:1641
21896 "C<maxevents> is the maximum number of events which will be queued up between "
21897 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21898 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21899 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21900 "but records the fact that it threw them away by setting a flag "
21901 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21905 #: ../fish/guestfish-actions.pod:1651
21907 "Before any events are generated, you have to add some watches to the "
21908 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21909 "L</inotify-watch-all>."
21913 #: ../fish/guestfish-actions.pod:1657
21915 "Queued up events should be read periodically by calling L</inotify-read> (or "
21916 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21917 "If you don't read the events out often enough then you risk the internal "
21918 "queue overflowing."
21922 #: ../fish/guestfish-actions.pod:1664
21924 "The handle should be closed after use by calling L</inotify-close>. This "
21925 "also removes any watches automatically."
21929 #: ../fish/guestfish-actions.pod:1673
21930 msgid "inotify-read"
21934 #: ../fish/guestfish-actions.pod:1675
21942 #: ../fish/guestfish-actions.pod:1688
21943 msgid "inotify-rm-watch"
21947 #: ../fish/guestfish-actions.pod:1690
21950 " inotify-rm-watch wd\n"
21955 #: ../fish/guestfish-actions.pod:1692
21956 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21960 #: ../fish/guestfish-actions.pod:1695
21961 msgid "inspect-get-arch"
21965 #: ../fish/guestfish-actions.pod:1697
21968 " inspect-get-arch root\n"
21973 #: ../fish/guestfish-actions.pod:1699 ../fish/guestfish-actions.pod:1715 ../fish/guestfish-actions.pod:1789 ../fish/guestfish-actions.pod:1807 ../fish/guestfish-actions.pod:1822 ../fish/guestfish-actions.pod:1843 ../fish/guestfish-actions.pod:1858 ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1907 ../fish/guestfish-actions.pod:1931 ../fish/guestfish-actions.pod:1961 ../fish/guestfish-actions.pod:1996 ../fish/guestfish-actions.pod:2012
21975 "This function should only be called with a root device string as returned by "
21980 #: ../fish/guestfish-actions.pod:1702
21982 "This returns the architecture of the inspected operating system. The "
21983 "possible return values are listed under L</file-architecture>."
21987 #: ../fish/guestfish-actions.pod:1711
21988 msgid "inspect-get-distro"
21992 #: ../fish/guestfish-actions.pod:1713
21995 " inspect-get-distro root\n"
22000 #: ../fish/guestfish-actions.pod:1785
22001 msgid "inspect-get-filesystems"
22005 #: ../fish/guestfish-actions.pod:1787
22008 " inspect-get-filesystems root\n"
22013 #: ../fish/guestfish-actions.pod:1800
22015 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22016 "L</inspect-get-mountpoints>."
22020 #: ../fish/guestfish-actions.pod:1803
22021 msgid "inspect-get-hostname"
22025 #: ../fish/guestfish-actions.pod:1805
22028 " inspect-get-hostname root\n"
22033 #: ../fish/guestfish-actions.pod:1818
22034 msgid "inspect-get-major-version"
22038 #: ../fish/guestfish-actions.pod:1820
22041 " inspect-get-major-version root\n"
22046 #: ../fish/guestfish-actions.pod:1839
22047 msgid "inspect-get-minor-version"
22051 #: ../fish/guestfish-actions.pod:1841
22054 " inspect-get-minor-version root\n"
22059 #: ../fish/guestfish-actions.pod:1851
22061 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22062 "L</inspect-get-major-version>."
22066 #: ../fish/guestfish-actions.pod:1854
22067 msgid "inspect-get-mountpoints"
22071 #: ../fish/guestfish-actions.pod:1856
22074 " inspect-get-mountpoints root\n"
22079 #: ../fish/guestfish-actions.pod:1878
22081 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22082 "L</inspect-get-filesystems>."
22086 #: ../fish/guestfish-actions.pod:1881
22087 msgid "inspect-get-package-format"
22091 #: ../fish/guestfish-actions.pod:1883
22094 " inspect-get-package-format root\n"
22099 #: ../fish/guestfish-actions.pod:1888
22101 "This function and L</inspect-get-package-management> return the package "
22102 "format and package management tool used by the inspected operating system. "
22103 "For example for Fedora these functions would return C<rpm> (package format) "
22104 "and C<yum> (package management)."
22108 #: ../fish/guestfish-actions.pod:1903
22109 msgid "inspect-get-package-management"
22113 #: ../fish/guestfish-actions.pod:1905
22116 " inspect-get-package-management root\n"
22121 #: ../fish/guestfish-actions.pod:1910
22123 "L</inspect-get-package-format> and this function return the package format "
22124 "and package management tool used by the inspected operating system. For "
22125 "example for Fedora these functions would return C<rpm> (package format) and "
22126 "C<yum> (package management)."
22130 #: ../fish/guestfish-actions.pod:1927
22131 msgid "inspect-get-product-name"
22135 #: ../fish/guestfish-actions.pod:1929
22138 " inspect-get-product-name root\n"
22143 #: ../fish/guestfish-actions.pod:1944
22144 msgid "inspect-get-roots"
22148 #: ../fish/guestfish-actions.pod:1946
22151 " inspect-get-roots\n"
22156 #: ../fish/guestfish-actions.pod:1948
22158 "This function is a convenient way to get the list of root devices, as "
22159 "returned from a previous call to L</inspect-os>, but without redoing the "
22160 "whole inspection process."
22164 #: ../fish/guestfish-actions.pod:1952
22166 "This returns an empty list if either no root devices were found or the "
22167 "caller has not called L</inspect-os>."
22171 #: ../fish/guestfish-actions.pod:1957
22172 msgid "inspect-get-type"
22176 #: ../fish/guestfish-actions.pod:1959
22179 " inspect-get-type root\n"
22184 #: ../fish/guestfish-actions.pod:1992
22185 msgid "inspect-get-windows-systemroot"
22189 #: ../fish/guestfish-actions.pod:1994
22192 " inspect-get-windows-systemroot root\n"
22197 #: ../fish/guestfish-actions.pod:2008
22198 msgid "inspect-list-applications"
22202 #: ../fish/guestfish-actions.pod:2010
22205 " inspect-list-applications root\n"
22210 #: ../fish/guestfish-actions.pod:2017
22212 "I<Note:> This call works differently from other parts of the inspection "
22213 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
22214 "then mount up the disks, before calling this. Listing applications is a "
22215 "significantly more difficult operation which requires access to the full "
22216 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
22217 "are just returning data cached in the libguestfs handle, this call actually "
22218 "reads parts of the mounted filesystems during the call."
22222 #: ../fish/guestfish-actions.pod:2107
22227 #: ../fish/guestfish-actions.pod:2109
22235 #: ../fish/guestfish-actions.pod:2124
22237 "You can pass the root string(s) returned to other L</inspect-get-*> "
22238 "functions in order to query further information about each operating system, "
22239 "such as the name and version."
22243 #: ../fish/guestfish-actions.pod:2129
22245 "This function uses other libguestfs features such as L</mount-ro> and "
22246 "L</umount-all> in order to mount and unmount filesystems and look at the "
22247 "contents. This should be called with no disks currently mounted. The "
22248 "function may also use Augeas, so any existing Augeas handle will be closed."
22252 #: ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2317 ../fish/guestfish-actions.pod:2363
22253 msgid "See also L</list-filesystems>."
22257 #: ../fish/guestfish-actions.pod:2143
22258 msgid "is-blockdev"
22262 #: ../fish/guestfish-actions.pod:2145
22265 " is-blockdev path\n"
22270 #: ../fish/guestfish-actions.pod:2150 ../fish/guestfish-actions.pod:2168 ../fish/guestfish-actions.pod:2187 ../fish/guestfish-actions.pod:2196 ../fish/guestfish-actions.pod:2206 ../fish/guestfish-actions.pod:2240 ../fish/guestfish-actions.pod:2249
22271 msgid "See also L</stat>."
22275 #: ../fish/guestfish-actions.pod:2152
22280 #: ../fish/guestfish-actions.pod:2154
22288 #: ../fish/guestfish-actions.pod:2161
22293 #: ../fish/guestfish-actions.pod:2163
22296 " is-chardev path\n"
22301 #: ../fish/guestfish-actions.pod:2170
22306 #: ../fish/guestfish-actions.pod:2172
22314 #: ../fish/guestfish-actions.pod:2179
22319 #: ../fish/guestfish-actions.pod:2181
22327 #: ../fish/guestfish-actions.pod:2189
22332 #: ../fish/guestfish-actions.pod:2191
22340 #: ../fish/guestfish-actions.pod:2198
22345 #: ../fish/guestfish-actions.pod:2200
22353 #: ../fish/guestfish-actions.pod:2208
22354 msgid "is-launching"
22358 #: ../fish/guestfish-actions.pod:2210
22366 #: ../fish/guestfish-actions.pod:2217
22371 #: ../fish/guestfish-actions.pod:2219
22379 #: ../fish/guestfish-actions.pod:2224
22384 #: ../fish/guestfish-actions.pod:2226
22392 #: ../fish/guestfish-actions.pod:2233
22397 #: ../fish/guestfish-actions.pod:2235
22400 " is-socket path\n"
22405 #: ../fish/guestfish-actions.pod:2242
22410 #: ../fish/guestfish-actions.pod:2244
22413 " is-symlink path\n"
22418 #: ../fish/guestfish-actions.pod:2251
22419 msgid "kill-subprocess"
22423 #: ../fish/guestfish-actions.pod:2253
22426 " kill-subprocess\n"
22431 #: ../fish/guestfish-actions.pod:2257
22436 #: ../fish/guestfish-actions.pod:2259
22441 #: ../fish/guestfish-actions.pod:2261
22449 #: ../fish/guestfish-actions.pod:2269
22454 #: ../fish/guestfish-actions.pod:2271
22457 " lchown owner group path\n"
22462 #: ../fish/guestfish-actions.pod:2273
22464 "Change the file owner to C<owner> and group to C<group>. This is like "
22465 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
22470 #: ../fish/guestfish-actions.pod:2281
22475 #: ../fish/guestfish-actions.pod:2283
22478 " lgetxattr path name\n"
22483 #: ../fish/guestfish-actions.pod:2299
22484 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
22488 #: ../fish/guestfish-actions.pod:2301
22493 #: ../fish/guestfish-actions.pod:2303
22496 " lgetxattrs path\n"
22501 #: ../fish/guestfish-actions.pod:2305
22503 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
22504 "it returns the extended attributes of the link itself."
22508 #: ../fish/guestfish-actions.pod:2309
22509 msgid "list-devices"
22513 #: ../fish/guestfish-actions.pod:2311
22521 #: ../fish/guestfish-actions.pod:2319
22522 msgid "list-filesystems"
22526 #: ../fish/guestfish-actions.pod:2321
22529 " list-filesystems\n"
22534 #: ../fish/guestfish-actions.pod:2340
22536 "This command runs other libguestfs commands, which might include L</mount> "
22537 "and L</umount>, and therefore you should use this soon after launch and only "
22538 "when nothing is mounted."
22542 #: ../fish/guestfish-actions.pod:2344
22544 "Not all of the filesystems returned will be mountable. In particular, swap "
22545 "partitions are returned in the list. Also this command does not check that "
22546 "each filesystem found is valid and mountable, and some filesystems might be "
22547 "mountable but require special options. Filesystems may not all belong to a "
22548 "single logical operating system (use L</inspect-os> to look for OSes)."
22552 #: ../fish/guestfish-actions.pod:2352
22553 msgid "list-partitions"
22557 #: ../fish/guestfish-actions.pod:2354
22560 " list-partitions\n"
22565 #: ../fish/guestfish-actions.pod:2360
22567 "This does not return logical volumes. For that you will need to call "
22572 #: ../fish/guestfish-actions.pod:2365
22577 #: ../fish/guestfish-actions.pod:2367
22585 #: ../fish/guestfish-actions.pod:2375
22590 #: ../fish/guestfish-actions.pod:2377
22593 " ln target linkname\n"
22598 #: ../fish/guestfish-actions.pod:2381
22603 #: ../fish/guestfish-actions.pod:2383
22606 " ln-f target linkname\n"
22611 #: ../fish/guestfish-actions.pod:2388
22616 #: ../fish/guestfish-actions.pod:2390
22619 " ln-s target linkname\n"
22624 #: ../fish/guestfish-actions.pod:2394
22629 #: ../fish/guestfish-actions.pod:2396
22632 " ln-sf target linkname\n"
22637 #: ../fish/guestfish-actions.pod:2401
22638 msgid "lremovexattr"
22642 #: ../fish/guestfish-actions.pod:2403
22645 " lremovexattr xattr path\n"
22650 #: ../fish/guestfish-actions.pod:2405
22652 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
22653 "it removes an extended attribute of the link itself."
22657 #: ../fish/guestfish-actions.pod:2409
22662 #: ../fish/guestfish-actions.pod:2411
22670 #: ../fish/guestfish-actions.pod:2417
22672 "This command is mostly useful for interactive sessions. Programs should "
22673 "probably use L</readdir> instead."
22677 #: ../fish/guestfish-actions.pod:2420
22682 #: ../fish/guestfish-actions.pod:2422
22685 " lsetxattr xattr val vallen path\n"
22690 #: ../fish/guestfish-actions.pod:2424
22692 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
22693 "sets an extended attribute of the link itself."
22697 #: ../fish/guestfish-actions.pod:2428
22702 #: ../fish/guestfish-actions.pod:2430
22710 #: ../fish/guestfish-actions.pod:2434
22712 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
22713 "the link is stat-ed, not the file it refers to."
22717 #: ../fish/guestfish-actions.pod:2440
22722 #: ../fish/guestfish-actions.pod:2442
22725 " lstatlist path 'names ...'\n"
22730 #: ../fish/guestfish-actions.pod:2444
22732 "This call allows you to perform the L</lstat> operation on multiple files, "
22733 "where all files are in the directory C<path>. C<names> is the list of files "
22734 "from this directory."
22738 #: ../fish/guestfish-actions.pod:2453
22740 "This call is intended for programs that want to efficiently list a directory "
22741 "contents without making many round-trips. See also L</lxattrlist> for a "
22742 "similarly efficient call for getting extended attributes. Very long "
22743 "directory listings might cause the protocol message size to be exceeded, "
22744 "causing this call to fail. The caller must split up such requests into "
22745 "smaller groups of names."
22749 #: ../fish/guestfish-actions.pod:2461
22750 msgid "luks-add-key"
22754 #: ../fish/guestfish-actions.pod:2463
22757 " luks-add-key device keyslot\n"
22762 #: ../fish/guestfish-actions.pod:2470
22764 "Note that if C<keyslot> already contains a key, then this command will "
22765 "fail. You have to use L</luks-kill-slot> first to remove that key."
22769 #: ../fish/guestfish-actions.pod:2474 ../fish/guestfish-actions.pod:2496 ../fish/guestfish-actions.pod:2509 ../fish/guestfish-actions.pod:2523 ../fish/guestfish-actions.pod:2546 ../fish/guestfish-actions.pod:2556
22771 "This command has one or more key or passphrase parameters. Guestfish will "
22772 "prompt for these separately."
22776 #: ../fish/guestfish-actions.pod:2477
22781 #: ../fish/guestfish-actions.pod:2479
22784 " luks-close device\n"
22789 #: ../fish/guestfish-actions.pod:2481
22791 "This closes a LUKS device that was created earlier by L</luks-open> or "
22792 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
22793 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
22794 "underlying block device."
22798 #: ../fish/guestfish-actions.pod:2487
22799 msgid "luks-format"
22803 #: ../fish/guestfish-actions.pod:2489
22806 " luks-format device keyslot\n"
22811 #: ../fish/guestfish-actions.pod:2502
22812 msgid "luks-format-cipher"
22816 #: ../fish/guestfish-actions.pod:2504
22819 " luks-format-cipher device keyslot cipher\n"
22824 #: ../fish/guestfish-actions.pod:2506
22826 "This command is the same as L</luks-format> but it also allows you to set "
22827 "the C<cipher> used."
22831 #: ../fish/guestfish-actions.pod:2515
22832 msgid "luks-kill-slot"
22836 #: ../fish/guestfish-actions.pod:2517
22839 " luks-kill-slot device keyslot\n"
22844 #: ../fish/guestfish-actions.pod:2526
22849 #: ../fish/guestfish-actions.pod:2528
22852 " luks-open device mapname\n"
22857 #: ../fish/guestfish-actions.pod:2542
22859 "If this block device contains LVM volume groups, then calling L</vgscan> "
22860 "followed by L</vg-activate-all> will make them visible."
22864 #: ../fish/guestfish-actions.pod:2549
22865 msgid "luks-open-ro"
22869 #: ../fish/guestfish-actions.pod:2551
22872 " luks-open-ro device mapname\n"
22877 #: ../fish/guestfish-actions.pod:2553
22879 "This is the same as L</luks-open> except that a read-only mapping is "
22884 #: ../fish/guestfish-actions.pod:2559
22889 #: ../fish/guestfish-actions.pod:2561
22892 " lvcreate logvol volgroup mbytes\n"
22897 #: ../fish/guestfish-actions.pod:2566
22898 msgid "lvm-canonical-lv-name"
22902 #: ../fish/guestfish-actions.pod:2568
22905 " lvm-canonical-lv-name lvname\n"
22910 #: ../fish/guestfish-actions.pod:2577
22911 msgid "See also L</is-lv>."
22915 #: ../fish/guestfish-actions.pod:2579
22916 msgid "lvm-clear-filter"
22920 #: ../fish/guestfish-actions.pod:2581
22923 " lvm-clear-filter\n"
22928 #: ../fish/guestfish-actions.pod:2583
22930 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22935 #: ../fish/guestfish-actions.pod:2589
22936 msgid "lvm-remove-all"
22940 #: ../fish/guestfish-actions.pod:2591
22943 " lvm-remove-all\n"
22948 #: ../fish/guestfish-actions.pod:2599
22949 msgid "lvm-set-filter"
22953 #: ../fish/guestfish-actions.pod:2601
22956 " lvm-set-filter 'devices ...'\n"
22961 #: ../fish/guestfish-actions.pod:2626
22966 #: ../fish/guestfish-actions.pod:2628
22969 " lvremove device\n"
22974 #: ../fish/guestfish-actions.pod:2636
22979 #: ../fish/guestfish-actions.pod:2638
22982 " lvrename logvol newlogvol\n"
22987 #: ../fish/guestfish-actions.pod:2642
22992 #: ../fish/guestfish-actions.pod:2644
22995 " lvresize device mbytes\n"
23000 #: ../fish/guestfish-actions.pod:2650
23001 msgid "lvresize-free"
23005 #: ../fish/guestfish-actions.pod:2652
23008 " lvresize-free lv percent\n"
23013 #: ../fish/guestfish-actions.pod:2660
23018 #: ../fish/guestfish-actions.pod:2662
23026 #: ../fish/guestfish-actions.pod:2670
23027 msgid "See also L</lvs-full>, L</list-filesystems>."
23031 #: ../fish/guestfish-actions.pod:2672
23036 #: ../fish/guestfish-actions.pod:2674
23044 #: ../fish/guestfish-actions.pod:2679
23049 #: ../fish/guestfish-actions.pod:2681
23057 #: ../fish/guestfish-actions.pod:2685
23062 #: ../fish/guestfish-actions.pod:2687
23065 " lxattrlist path 'names ...'\n"
23070 #: ../fish/guestfish-actions.pod:2703
23072 "This call is intended for programs that want to efficiently list a directory "
23073 "contents without making many round-trips. See also L</lstatlist> for a "
23074 "similarly efficient call for getting standard stats. Very long directory "
23075 "listings might cause the protocol message size to be exceeded, causing this "
23076 "call to fail. The caller must split up such requests into smaller groups of "
23081 #: ../fish/guestfish-actions.pod:2711
23086 #: ../fish/guestfish-actions.pod:2713
23094 #: ../fish/guestfish-actions.pod:2717
23099 #: ../fish/guestfish-actions.pod:2719
23102 " mkdir-mode path mode\n"
23107 #: ../fish/guestfish-actions.pod:2728
23108 msgid "See also L</mkdir>, L</umask>"
23112 #: ../fish/guestfish-actions.pod:2730
23117 #: ../fish/guestfish-actions.pod:2732
23125 #: ../fish/guestfish-actions.pod:2737
23130 #: ../fish/guestfish-actions.pod:2739
23133 " mkdtemp template\n"
23138 #: ../fish/guestfish-actions.pod:2760
23143 #: ../fish/guestfish-actions.pod:2762
23146 " mke2fs-J fstype blocksize device journal\n"
23151 #: ../fish/guestfish-actions.pod:2770
23152 msgid "See also L</mke2journal>."
23156 #: ../fish/guestfish-actions.pod:2772
23161 #: ../fish/guestfish-actions.pod:2774
23164 " mke2fs-JL fstype blocksize device label\n"
23169 #: ../fish/guestfish-actions.pod:2779
23170 msgid "See also L</mke2journal-L>."
23174 #: ../fish/guestfish-actions.pod:2781
23179 #: ../fish/guestfish-actions.pod:2783
23182 " mke2fs-JU fstype blocksize device uuid\n"
23187 #: ../fish/guestfish-actions.pod:2788
23188 msgid "See also L</mke2journal-U>."
23192 #: ../fish/guestfish-actions.pod:2790
23193 msgid "mke2journal"
23197 #: ../fish/guestfish-actions.pod:2792
23200 " mke2journal blocksize device\n"
23205 #: ../fish/guestfish-actions.pod:2799
23206 msgid "mke2journal-L"
23210 #: ../fish/guestfish-actions.pod:2801
23213 " mke2journal-L blocksize label device\n"
23218 #: ../fish/guestfish-actions.pod:2805
23219 msgid "mke2journal-U"
23223 #: ../fish/guestfish-actions.pod:2807
23226 " mke2journal-U blocksize uuid device\n"
23231 #: ../fish/guestfish-actions.pod:2811
23236 #: ../fish/guestfish-actions.pod:2813
23239 " mkfifo mode path\n"
23244 #: ../fish/guestfish-actions.pod:2815
23246 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
23247 "is just a convenient wrapper around L</mknod>."
23251 #: ../fish/guestfish-actions.pod:2821
23256 #: ../fish/guestfish-actions.pod:2823
23259 " mkfs fstype device\n"
23264 #: ../fish/guestfish-actions.pod:2829
23269 #: ../fish/guestfish-actions.pod:2831
23272 " mkfs-b fstype blocksize device\n"
23277 #: ../fish/guestfish-actions.pod:2833
23279 "This call is similar to L</mkfs>, but it allows you to control the block "
23280 "size of the resulting filesystem. Supported block sizes depend on the "
23281 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
23285 #: ../fish/guestfish-actions.pod:2841
23287 "This function is deprecated. In new code, use the L</mkfs_opts> call "
23292 #: ../fish/guestfish-actions.pod:2848
23297 #: ../fish/guestfish-actions.pod:2850
23300 " mkfs-opts fstype device [blocksize:..]\n"
23305 #: ../fish/guestfish-actions.pod:2874
23306 msgid "mkmountpoint"
23310 #: ../fish/guestfish-actions.pod:2876
23313 " mkmountpoint exemptpath\n"
23318 #: ../fish/guestfish-actions.pod:2878
23320 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
23321 "to create extra mountpoints before mounting the first filesystem."
23325 #: ../fish/guestfish-actions.pod:2902
23327 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
23328 "unexpected errors if you try to mix these calls. It is safest to manually "
23329 "unmount filesystems and remove mountpoints after use."
23333 #: ../fish/guestfish-actions.pod:2906
23335 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
23336 "for this to work for manual mountpoints, you must ensure that the innermost "
23337 "mountpoints have the longest pathnames, as in the example code above."
23341 #: ../fish/guestfish-actions.pod:2913
23343 "Autosync [see L</set-autosync>, this is set by default on handles] means "
23344 "that L</umount-all> is called when the handle is closed which can also "
23345 "trigger these issues."
23349 #: ../fish/guestfish-actions.pod:2917
23354 #: ../fish/guestfish-actions.pod:2919
23357 " mknod mode devmajor devminor path\n"
23362 #: ../fish/guestfish-actions.pod:2929
23364 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
23365 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
23366 "regular file). These constants are available in the standard Linux header "
23367 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
23368 "wrappers around this command which bitwise OR in the appropriate constant "
23373 #: ../fish/guestfish-actions.pod:2939
23378 #: ../fish/guestfish-actions.pod:2941
23381 " mknod-b mode devmajor devminor path\n"
23386 #: ../fish/guestfish-actions.pod:2943
23388 "This call creates a block device node called C<path> with mode C<mode> and "
23389 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23390 "wrapper around L</mknod>."
23394 #: ../fish/guestfish-actions.pod:2949
23399 #: ../fish/guestfish-actions.pod:2951
23402 " mknod-c mode devmajor devminor path\n"
23407 #: ../fish/guestfish-actions.pod:2953
23409 "This call creates a char device node called C<path> with mode C<mode> and "
23410 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23411 "wrapper around L</mknod>."
23415 #: ../fish/guestfish-actions.pod:2959
23420 #: ../fish/guestfish-actions.pod:2961
23428 #: ../fish/guestfish-actions.pod:2965
23433 #: ../fish/guestfish-actions.pod:2967
23436 " mkswap-L label device\n"
23441 #: ../fish/guestfish-actions.pod:2975
23446 #: ../fish/guestfish-actions.pod:2977
23449 " mkswap-U uuid device\n"
23454 #: ../fish/guestfish-actions.pod:2981
23455 msgid "mkswap-file"
23459 #: ../fish/guestfish-actions.pod:2983
23462 " mkswap-file path\n"
23467 #: ../fish/guestfish-actions.pod:2987
23469 "This command just writes a swap file signature to an existing file. To "
23470 "create the file itself, use something like L</fallocate>."
23474 #: ../fish/guestfish-actions.pod:2990
23479 #: ../fish/guestfish-actions.pod:2992
23482 " modprobe modulename\n"
23487 #: ../fish/guestfish-actions.pod:2999
23492 #: ../fish/guestfish-actions.pod:3001
23495 " mount device mountpoint\n"
23500 #: ../fish/guestfish-actions.pod:3017
23502 "B<Important note:> When you use this call, the filesystem options C<sync> "
23503 "and C<noatime> are set implicitly. This was originally done because we "
23504 "thought it would improve reliability, but it turns out that I<-o sync> has a "
23505 "very large negative performance impact and negligible effect on "
23506 "reliability. Therefore we recommend that you avoid using L</mount> in any "
23507 "code that needs performance, and instead use L</mount-options> (use an empty "
23508 "string for the first parameter if you don't want any options)."
23512 #: ../fish/guestfish-actions.pod:3027
23517 #: ../fish/guestfish-actions.pod:3029
23520 " mount-loop file mountpoint\n"
23525 #: ../fish/guestfish-actions.pod:3035
23526 msgid "mount-options"
23530 #: ../fish/guestfish-actions.pod:3037
23533 " mount-options options device mountpoint\n"
23538 #: ../fish/guestfish-actions.pod:3039
23540 "This is the same as the L</mount> command, but it allows you to set the "
23541 "mount options as for the L<mount(8)> I<-o> flag."
23545 #: ../fish/guestfish-actions.pod:3047
23550 #: ../fish/guestfish-actions.pod:3049
23553 " mount-ro device mountpoint\n"
23558 #: ../fish/guestfish-actions.pod:3051
23560 "This is the same as the L</mount> command, but it mounts the filesystem with "
23561 "the read-only (I<-o ro>) flag."
23565 #: ../fish/guestfish-actions.pod:3054
23570 #: ../fish/guestfish-actions.pod:3056
23573 " mount-vfs options vfstype device mountpoint\n"
23578 #: ../fish/guestfish-actions.pod:3058
23580 "This is the same as the L</mount> command, but it allows you to set both the "
23581 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
23585 #: ../fish/guestfish-actions.pod:3062
23586 msgid "mountpoints"
23590 #: ../fish/guestfish-actions.pod:3064
23598 #: ../fish/guestfish-actions.pod:3066
23600 "This call is similar to L</mounts>. That call returns a list of devices. "
23601 "This one returns a hash table (map) of device name to directory where the "
23602 "device is mounted."
23606 #: ../fish/guestfish-actions.pod:3070
23611 #: ../fish/guestfish-actions.pod:3072
23619 #: ../fish/guestfish-actions.pod:3079
23620 msgid "See also: L</mountpoints>"
23624 #: ../fish/guestfish-actions.pod:3081
23629 #: ../fish/guestfish-actions.pod:3083
23637 #: ../fish/guestfish-actions.pod:3088
23638 msgid "ntfs-3g-probe"
23642 #: ../fish/guestfish-actions.pod:3090
23645 " ntfs-3g-probe true|false device\n"
23650 #: ../fish/guestfish-actions.pod:3104
23655 #: ../fish/guestfish-actions.pod:3106
23658 " ntfsresize device\n"
23663 #: ../fish/guestfish-actions.pod:3121
23664 msgid "ntfsresize-size"
23668 #: ../fish/guestfish-actions.pod:3123
23671 " ntfsresize-size device size\n"
23676 #: ../fish/guestfish-actions.pod:3125
23678 "This command is the same as L</ntfsresize> except that it allows you to "
23679 "specify the new size (in bytes) explicitly."
23683 #: ../fish/guestfish-actions.pod:3128
23688 #: ../fish/guestfish-actions.pod:3130
23691 " part-add device prlogex startsect endsect\n"
23696 #: ../fish/guestfish-actions.pod:3132
23698 "This command adds a partition to C<device>. If there is no partition table "
23699 "on the device, call L</part-init> first."
23703 #: ../fish/guestfish-actions.pod:3144
23705 "Creating a partition which covers the whole disk is not so easy. Use "
23706 "L</part-disk> to do that."
23710 #: ../fish/guestfish-actions.pod:3147
23715 #: ../fish/guestfish-actions.pod:3149
23718 " part-del device partnum\n"
23723 #: ../fish/guestfish-actions.pod:3157
23728 #: ../fish/guestfish-actions.pod:3159
23731 " part-disk device parttype\n"
23736 #: ../fish/guestfish-actions.pod:3161
23738 "This command is simply a combination of L</part-init> followed by "
23739 "L</part-add> to create a single primary partition covering the whole disk."
23743 #: ../fish/guestfish-actions.pod:3165
23745 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
23746 "possible values are described in L</part-init>."
23750 #: ../fish/guestfish-actions.pod:3171
23751 msgid "part-get-bootable"
23755 #: ../fish/guestfish-actions.pod:3173
23758 " part-get-bootable device partnum\n"
23763 #: ../fish/guestfish-actions.pod:3178
23764 msgid "See also L</part-set-bootable>."
23768 #: ../fish/guestfish-actions.pod:3180
23769 msgid "part-get-mbr-id"
23773 #: ../fish/guestfish-actions.pod:3182
23776 " part-get-mbr-id device partnum\n"
23781 #: ../fish/guestfish-actions.pod:3187 ../fish/guestfish-actions.pod:3325
23783 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
23784 "undefined results for other partition table types (see "
23785 "L</part-get-parttype>)."
23789 #: ../fish/guestfish-actions.pod:3191
23790 msgid "part-get-parttype"
23794 #: ../fish/guestfish-actions.pod:3193
23797 " part-get-parttype device\n"
23802 #: ../fish/guestfish-actions.pod:3198
23804 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
23805 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
23806 "possible, although unusual. See L</part-init> for a full list."
23810 #: ../fish/guestfish-actions.pod:3203
23815 #: ../fish/guestfish-actions.pod:3205
23818 " part-init device parttype\n"
23823 #: ../fish/guestfish-actions.pod:3211
23825 "Initially there are no partitions. Following this, you should call "
23826 "L</part-add> for each partition required."
23830 #: ../fish/guestfish-actions.pod:3274
23835 #: ../fish/guestfish-actions.pod:3276
23838 " part-list device\n"
23843 #: ../fish/guestfish-actions.pod:3291
23845 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23846 "the device's sector size, see L</blockdev-getss>."
23850 #: ../fish/guestfish-actions.pod:3304
23851 msgid "part-set-bootable"
23855 #: ../fish/guestfish-actions.pod:3306
23858 " part-set-bootable device partnum true|false\n"
23863 #: ../fish/guestfish-actions.pod:3315
23864 msgid "part-set-mbr-id"
23868 #: ../fish/guestfish-actions.pod:3317
23871 " part-set-mbr-id device partnum idbyte\n"
23876 #: ../fish/guestfish-actions.pod:3329
23877 msgid "part-set-name"
23881 #: ../fish/guestfish-actions.pod:3331
23884 " part-set-name device partnum name\n"
23889 #: ../fish/guestfish-actions.pod:3339
23890 msgid "part-to-dev"
23894 #: ../fish/guestfish-actions.pod:3341
23897 " part-to-dev partition\n"
23902 #: ../fish/guestfish-actions.pod:3347
23904 "The named partition must exist, for example as a string returned from "
23905 "L</list-partitions>."
23909 #: ../fish/guestfish-actions.pod:3350
23910 msgid "ping-daemon"
23914 #: ../fish/guestfish-actions.pod:3352
23922 #: ../fish/guestfish-actions.pod:3359
23927 #: ../fish/guestfish-actions.pod:3361
23930 " pread path count offset\n"
23935 #: ../fish/guestfish-actions.pod:3369
23936 msgid "See also L</pwrite>, L</pread-device>."
23940 #: ../fish/guestfish-actions.pod:3374
23941 msgid "pread-device"
23945 #: ../fish/guestfish-actions.pod:3376
23948 " pread-device device count offset\n"
23953 #: ../fish/guestfish-actions.pod:3384
23954 msgid "See also L</pread>."
23958 #: ../fish/guestfish-actions.pod:3389
23963 #: ../fish/guestfish-actions.pod:3391
23966 " pvcreate device\n"
23971 #: ../fish/guestfish-actions.pod:3397
23976 #: ../fish/guestfish-actions.pod:3399
23979 " pvremove device\n"
23984 #: ../fish/guestfish-actions.pod:3408
23989 #: ../fish/guestfish-actions.pod:3410
23992 " pvresize device\n"
23997 #: ../fish/guestfish-actions.pod:3415
23998 msgid "pvresize-size"
24002 #: ../fish/guestfish-actions.pod:3417
24005 " pvresize-size device size\n"
24010 #: ../fish/guestfish-actions.pod:3419
24012 "This command is the same as L</pvresize> except that it allows you to "
24013 "specify the new size (in bytes) explicitly."
24017 #: ../fish/guestfish-actions.pod:3422
24022 #: ../fish/guestfish-actions.pod:3424
24030 #: ../fish/guestfish-actions.pod:3432
24031 msgid "See also L</pvs-full>."
24035 #: ../fish/guestfish-actions.pod:3434
24040 #: ../fish/guestfish-actions.pod:3436
24048 #: ../fish/guestfish-actions.pod:3441
24053 #: ../fish/guestfish-actions.pod:3443
24061 #: ../fish/guestfish-actions.pod:3447
24066 #: ../fish/guestfish-actions.pod:3449
24069 " pwrite path content offset\n"
24074 #: ../fish/guestfish-actions.pod:3460
24075 msgid "See also L</pread>, L</pwrite-device>."
24079 #: ../fish/guestfish-actions.pod:3465
24080 msgid "pwrite-device"
24084 #: ../fish/guestfish-actions.pod:3467
24087 " pwrite-device device content offset\n"
24092 #: ../fish/guestfish-actions.pod:3477
24093 msgid "See also L</pwrite>."
24097 #: ../fish/guestfish-actions.pod:3482
24102 #: ../fish/guestfish-actions.pod:3484
24105 " read-file path\n"
24110 #: ../fish/guestfish-actions.pod:3489
24112 "Unlike L</cat>, this function can correctly handle files that contain "
24113 "embedded ASCII NUL characters. However unlike L</download>, this function "
24114 "is limited in the total size of file that can be handled."
24118 #: ../fish/guestfish-actions.pod:3497
24123 #: ../fish/guestfish-actions.pod:3499
24126 " read-lines path\n"
24131 #: ../fish/guestfish-actions.pod:3506
24133 "Note that this function cannot correctly handle binary files (specifically, "
24134 "files containing C<\\0> character which is treated as end of line). For "
24135 "those you need to use the L</read-file> function which has a more complex "
24140 #: ../fish/guestfish-actions.pod:3511
24145 #: ../fish/guestfish-actions.pod:3513
24153 #: ../fish/guestfish-actions.pod:3565
24155 "This function is primarily intended for use by programs. To get a simple "
24156 "list of names, use L</ls>. To get a printable directory for human "
24157 "consumption, use L</ll>."
24161 #: ../fish/guestfish-actions.pod:3569
24166 #: ../fish/guestfish-actions.pod:3571
24174 #: ../fish/guestfish-actions.pod:3575
24175 msgid "readlinklist"
24179 #: ../fish/guestfish-actions.pod:3577
24182 " readlinklist path 'names ...'\n"
24187 #: ../fish/guestfish-actions.pod:3601
24192 #: ../fish/guestfish-actions.pod:3603
24200 #: ../fish/guestfish-actions.pod:3608
24201 msgid "removexattr"
24205 #: ../fish/guestfish-actions.pod:3610
24208 " removexattr xattr path\n"
24213 #: ../fish/guestfish-actions.pod:3615
24214 msgid "See also: L</lremovexattr>, L<attr(5)>."
24218 #: ../fish/guestfish-actions.pod:3617
24223 #: ../fish/guestfish-actions.pod:3619
24226 " resize2fs device\n"
24231 #: ../fish/guestfish-actions.pod:3624
24233 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
24234 "before calling this command. For unknown reasons C<resize2fs> sometimes "
24235 "gives an error about this and sometimes not. In any case, it is always safe "
24236 "to call L</e2fsck-f> before calling this function."
24240 #: ../fish/guestfish-actions.pod:3630
24241 msgid "resize2fs-size"
24245 #: ../fish/guestfish-actions.pod:3632
24248 " resize2fs-size device size\n"
24253 #: ../fish/guestfish-actions.pod:3634
24255 "This command is the same as L</resize2fs> except that it allows you to "
24256 "specify the new size (in bytes) explicitly."
24260 #: ../fish/guestfish-actions.pod:3637
24265 #: ../fish/guestfish-actions.pod:3639
24273 #: ../fish/guestfish-actions.pod:3643
24278 #: ../fish/guestfish-actions.pod:3645
24286 #: ../fish/guestfish-actions.pod:3651
24291 #: ../fish/guestfish-actions.pod:3653
24299 #: ../fish/guestfish-actions.pod:3657
24300 msgid "rmmountpoint"
24304 #: ../fish/guestfish-actions.pod:3659
24307 " rmmountpoint exemptpath\n"
24312 #: ../fish/guestfish-actions.pod:3661
24314 "This calls removes a mountpoint that was previously created with "
24315 "L</mkmountpoint>. See L</mkmountpoint> for full details."
24319 #: ../fish/guestfish-actions.pod:3665
24320 msgid "scrub-device"
24324 #: ../fish/guestfish-actions.pod:3667
24327 " scrub-device device\n"
24332 #: ../fish/guestfish-actions.pod:3678
24337 #: ../fish/guestfish-actions.pod:3680
24340 " scrub-file file\n"
24345 #: ../fish/guestfish-actions.pod:3690
24346 msgid "scrub-freespace"
24350 #: ../fish/guestfish-actions.pod:3692
24353 " scrub-freespace dir\n"
24358 #: ../fish/guestfish-actions.pod:3694
24360 "This command creates the directory C<dir> and then fills it with files until "
24361 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
24362 "deletes them. The intention is to scrub any free space on the partition "
24363 "containing C<dir>."
24367 #: ../fish/guestfish-actions.pod:3703
24372 #: ../fish/guestfish-actions.pod:3705
24377 #: ../fish/guestfish-actions.pod:3707
24380 " set-append append\n"
24385 #: ../fish/guestfish-actions.pod:3718
24386 msgid "set-autosync"
24390 #: ../fish/guestfish-actions.pod:3720
24395 #: ../fish/guestfish-actions.pod:3722
24398 " set-autosync true|false\n"
24403 #: ../fish/guestfish-actions.pod:3724
24405 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
24406 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
24407 "closed (also if the program exits without closing handles)."
24411 #: ../fish/guestfish-actions.pod:3732
24416 #: ../fish/guestfish-actions.pod:3734
24421 #: ../fish/guestfish-actions.pod:3736
24424 " set-direct true|false\n"
24429 #: ../fish/guestfish-actions.pod:3742
24431 "One consequence of this is that log messages aren't caught by the library "
24432 "and handled by L</set-log-message-callback>, but go straight to stdout."
24436 #: ../fish/guestfish-actions.pod:3751
24437 msgid "set-e2label"
24441 #: ../fish/guestfish-actions.pod:3753
24444 " set-e2label device label\n"
24449 #: ../fish/guestfish-actions.pod:3759
24451 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
24452 "label on a filesystem."
24456 #: ../fish/guestfish-actions.pod:3762
24461 #: ../fish/guestfish-actions.pod:3764
24464 " set-e2uuid device uuid\n"
24469 #: ../fish/guestfish-actions.pod:3771
24471 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
24472 "UUID of a filesystem."
24476 #: ../fish/guestfish-actions.pod:3774
24477 msgid "set-memsize"
24481 #: ../fish/guestfish-actions.pod:3776
24486 #: ../fish/guestfish-actions.pod:3778
24489 " set-memsize memsize\n"
24494 #: ../fish/guestfish-actions.pod:3780
24496 "This sets the memory size in megabytes allocated to the qemu subprocess. "
24497 "This only has any effect if called before L</launch>."
24501 #: ../fish/guestfish-actions.pod:3791
24502 msgid "set-network"
24506 #: ../fish/guestfish-actions.pod:3793
24511 #: ../fish/guestfish-actions.pod:3795
24514 " set-network true|false\n"
24519 #: ../fish/guestfish-actions.pod:3803
24520 msgid "You must call this before calling L</launch>, otherwise it has no effect."
24524 #: ../fish/guestfish-actions.pod:3806
24529 #: ../fish/guestfish-actions.pod:3808
24534 #: ../fish/guestfish-actions.pod:3810
24537 " set-path searchpath\n"
24542 #: ../fish/guestfish-actions.pod:3819
24547 #: ../fish/guestfish-actions.pod:3821
24552 #: ../fish/guestfish-actions.pod:3823
24560 #: ../fish/guestfish-actions.pod:3843
24561 msgid "set-recovery-proc"
24565 #: ../fish/guestfish-actions.pod:3845
24566 msgid "recovery-proc"
24570 #: ../fish/guestfish-actions.pod:3847
24573 " set-recovery-proc true|false\n"
24578 #: ../fish/guestfish-actions.pod:3849
24580 "If this is called with the parameter C<false> then L</launch> does not "
24581 "create a recovery process. The purpose of the recovery process is to stop "
24582 "runaway qemu processes in the case where the main program aborts abruptly."
24586 #: ../fish/guestfish-actions.pod:3854
24588 "This only has any effect if called before L</launch>, and the default is "
24593 #: ../fish/guestfish-actions.pod:3863
24594 msgid "set-selinux"
24598 #: ../fish/guestfish-actions.pod:3865
24603 #: ../fish/guestfish-actions.pod:3867
24606 " set-selinux true|false\n"
24611 #: ../fish/guestfish-actions.pod:3878
24616 #: ../fish/guestfish-actions.pod:3880
24621 #: ../fish/guestfish-actions.pod:3882
24624 " set-trace true|false\n"
24629 #: ../fish/guestfish-actions.pod:3898
24630 msgid "set-verbose"
24634 #: ../fish/guestfish-actions.pod:3900
24639 #: ../fish/guestfish-actions.pod:3902
24642 " set-verbose true|false\n"
24647 #: ../fish/guestfish-actions.pod:3909
24652 #: ../fish/guestfish-actions.pod:3911
24655 " setcon context\n"
24660 #: ../fish/guestfish-actions.pod:3918
24665 #: ../fish/guestfish-actions.pod:3920
24668 " setxattr xattr val vallen path\n"
24673 #: ../fish/guestfish-actions.pod:3926
24674 msgid "See also: L</lsetxattr>, L<attr(5)>."
24678 #: ../fish/guestfish-actions.pod:3928
24683 #: ../fish/guestfish-actions.pod:3930
24686 " sfdisk device cyls heads sectors 'lines ...'\n"
24691 #: ../fish/guestfish-actions.pod:3952
24692 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
24696 #: ../fish/guestfish-actions.pod:3958
24701 #: ../fish/guestfish-actions.pod:3960
24704 " sfdiskM device 'lines ...'\n"
24709 #: ../fish/guestfish-actions.pod:3962
24711 "This is a simplified interface to the L</sfdisk> command, where partition "
24712 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
24713 "you don't need to specify the cyls, heads and sectors parameters which were "
24714 "rarely if ever used anyway."
24718 #: ../fish/guestfish-actions.pod:3968
24719 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
24723 #: ../fish/guestfish-actions.pod:3974
24728 #: ../fish/guestfish-actions.pod:3976
24731 " sfdisk-N device partnum cyls heads sectors line\n"
24736 #: ../fish/guestfish-actions.pod:3981
24738 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
24739 "cyls/heads/sectors parameters."
24743 #: ../fish/guestfish-actions.pod:3984
24744 msgid "See also: L</part-add>"
24748 #: ../fish/guestfish-actions.pod:3989
24749 msgid "sfdisk-disk-geometry"
24753 #: ../fish/guestfish-actions.pod:3991
24756 " sfdisk-disk-geometry device\n"
24761 #: ../fish/guestfish-actions.pod:3993
24763 "This displays the disk geometry of C<device> read from the partition table. "
24764 "Especially in the case where the underlying block device has been resized, "
24765 "this can be different from the kernel's idea of the geometry (see "
24766 "L</sfdisk-kernel-geometry>)."
24770 #: ../fish/guestfish-actions.pod:4001
24771 msgid "sfdisk-kernel-geometry"
24775 #: ../fish/guestfish-actions.pod:4003
24778 " sfdisk-kernel-geometry device\n"
24783 #: ../fish/guestfish-actions.pod:4010
24788 #: ../fish/guestfish-actions.pod:4012
24791 " sfdisk-l device\n"
24796 #: ../fish/guestfish-actions.pod:4018
24797 msgid "See also: L</part-list>"
24801 #: ../fish/guestfish-actions.pod:4020
24806 #: ../fish/guestfish-actions.pod:4022
24814 #: ../fish/guestfish-actions.pod:4027
24815 msgid "This is like L</command>, but passes the command to:"
24819 #: ../fish/guestfish-actions.pod:4035
24820 msgid "All the provisos about L</command> apply to this call."
24824 #: ../fish/guestfish-actions.pod:4037
24829 #: ../fish/guestfish-actions.pod:4039
24832 " sh-lines command\n"
24837 #: ../fish/guestfish-actions.pod:4041
24838 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24842 #: ../fish/guestfish-actions.pod:4044
24843 msgid "See also: L</command-lines>"
24847 #: ../fish/guestfish-actions.pod:4046
24852 #: ../fish/guestfish-actions.pod:4048
24860 #: ../fish/guestfish-actions.pod:4052
24865 #: ../fish/guestfish-actions.pod:4054
24873 #: ../fish/guestfish-actions.pod:4060
24878 #: ../fish/guestfish-actions.pod:4062
24886 #: ../fish/guestfish-actions.pod:4070
24891 #: ../fish/guestfish-actions.pod:4072
24899 #: ../fish/guestfish-actions.pod:4080
24904 #: ../fish/guestfish-actions.pod:4082
24907 " strings-e encoding path\n"
24912 #: ../fish/guestfish-actions.pod:4084
24914 "This is like the L</strings> command, but allows you to specify the encoding "
24915 "of strings that are looked for in the source file C<path>."
24919 #: ../fish/guestfish-actions.pod:4094
24921 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24922 "ISO-8859-X (this is what L</strings> uses)."
24926 #: ../fish/guestfish-actions.pod:4126
24927 msgid "swapoff-device"
24931 #: ../fish/guestfish-actions.pod:4128
24934 " swapoff-device device\n"
24939 #: ../fish/guestfish-actions.pod:4130
24941 "This command disables the libguestfs appliance swap device or partition "
24942 "named C<device>. See L</swapon-device>."
24946 #: ../fish/guestfish-actions.pod:4134
24947 msgid "swapoff-file"
24951 #: ../fish/guestfish-actions.pod:4136
24954 " swapoff-file file\n"
24959 #: ../fish/guestfish-actions.pod:4140
24960 msgid "swapoff-label"
24964 #: ../fish/guestfish-actions.pod:4142
24967 " swapoff-label label\n"
24972 #: ../fish/guestfish-actions.pod:4147
24973 msgid "swapoff-uuid"
24977 #: ../fish/guestfish-actions.pod:4149
24980 " swapoff-uuid uuid\n"
24985 #: ../fish/guestfish-actions.pod:4154
24986 msgid "swapon-device"
24990 #: ../fish/guestfish-actions.pod:4156
24993 " swapon-device device\n"
24998 #: ../fish/guestfish-actions.pod:4158
25000 "This command enables the libguestfs appliance to use the swap device or "
25001 "partition named C<device>. The increased memory is made available for all "
25002 "commands, for example those run using L</command> or L</sh>."
25006 #: ../fish/guestfish-actions.pod:4170
25007 msgid "swapon-file"
25011 #: ../fish/guestfish-actions.pod:4172
25014 " swapon-file file\n"
25019 #: ../fish/guestfish-actions.pod:4174
25020 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
25024 #: ../fish/guestfish-actions.pod:4177
25025 msgid "swapon-label"
25029 #: ../fish/guestfish-actions.pod:4179
25032 " swapon-label label\n"
25037 #: ../fish/guestfish-actions.pod:4181
25039 "This command enables swap to a labeled swap partition. See "
25040 "L</swapon-device> for other notes."
25044 #: ../fish/guestfish-actions.pod:4184
25045 msgid "swapon-uuid"
25049 #: ../fish/guestfish-actions.pod:4186
25052 " swapon-uuid uuid\n"
25057 #: ../fish/guestfish-actions.pod:4188
25059 "This command enables swap to a swap partition with the given UUID. See "
25060 "L</swapon-device> for other notes."
25064 #: ../fish/guestfish-actions.pod:4191
25069 #: ../fish/guestfish-actions.pod:4193
25077 #: ../fish/guestfish-actions.pod:4201
25082 #: ../fish/guestfish-actions.pod:4203
25090 #: ../fish/guestfish-actions.pod:4211
25095 #: ../fish/guestfish-actions.pod:4213
25098 " tail-n nrlines path\n"
25103 #: ../fish/guestfish-actions.pod:4226
25108 #: ../fish/guestfish-actions.pod:4228
25111 " tar-in (tarfile|-) directory\n"
25116 #: ../fish/guestfish-actions.pod:4233
25117 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
25121 #: ../fish/guestfish-actions.pod:4238
25126 #: ../fish/guestfish-actions.pod:4240
25129 " tar-out directory (tarfile|-)\n"
25134 #: ../fish/guestfish-actions.pod:4245
25135 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
25139 #: ../fish/guestfish-actions.pod:4250
25144 #: ../fish/guestfish-actions.pod:4252
25147 " tgz-in (tarball|-) directory\n"
25152 #: ../fish/guestfish-actions.pod:4257
25153 msgid "To upload an uncompressed tarball, use L</tar-in>."
25157 #: ../fish/guestfish-actions.pod:4261
25162 #: ../fish/guestfish-actions.pod:4263
25165 " tgz-out directory (tarball|-)\n"
25170 #: ../fish/guestfish-actions.pod:4268
25171 msgid "To download an uncompressed tarball, use L</tar-out>."
25175 #: ../fish/guestfish-actions.pod:4272
25180 #: ../fish/guestfish-actions.pod:4274
25188 #: ../fish/guestfish-actions.pod:4283
25193 #: ../fish/guestfish-actions.pod:4285
25201 #: ../fish/guestfish-actions.pod:4290
25202 msgid "truncate-size"
25206 #: ../fish/guestfish-actions.pod:4292
25209 " truncate-size path size\n"
25214 #: ../fish/guestfish-actions.pod:4297
25216 "If the current file size is less than C<size> then the file is extended to "
25217 "the required size with zero bytes. This creates a sparse file (ie. disk "
25218 "blocks are not allocated for the file until you write to it). To create a "
25219 "non-sparse file of zeroes, use L</fallocate64> instead."
25223 #: ../fish/guestfish-actions.pod:4303
25228 #: ../fish/guestfish-actions.pod:4305
25231 " tune2fs-l device\n"
25236 #: ../fish/guestfish-actions.pod:4315
25241 #: ../fish/guestfish-actions.pod:4317
25244 " txz-in (tarball|-) directory\n"
25249 #: ../fish/guestfish-actions.pod:4324
25254 #: ../fish/guestfish-actions.pod:4326
25257 " txz-out directory (tarball|-)\n"
25262 #: ../fish/guestfish-actions.pod:4333
25267 #: ../fish/guestfish-actions.pod:4335
25275 #: ../fish/guestfish-actions.pod:4349
25276 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
25280 #: ../fish/guestfish-actions.pod:4354
25285 #: ../fish/guestfish-actions.pod:4356
25290 #: ../fish/guestfish-actions.pod:4358
25293 " umount pathordevice\n"
25298 #: ../fish/guestfish-actions.pod:4364
25303 #: ../fish/guestfish-actions.pod:4366
25304 msgid "unmount-all"
25308 #: ../fish/guestfish-actions.pod:4368
25316 #: ../fish/guestfish-actions.pod:4374
25321 #: ../fish/guestfish-actions.pod:4376
25324 " upload (filename|-) remotefilename\n"
25329 #: ../fish/guestfish-actions.pod:4383
25330 msgid "See also L</download>."
25334 #: ../fish/guestfish-actions.pod:4387
25335 msgid "upload-offset"
25339 #: ../fish/guestfish-actions.pod:4389
25342 " upload-offset (filename|-) remotefilename offset\n"
25347 #: ../fish/guestfish-actions.pod:4401
25349 "Note that there is no limit on the amount of data that can be uploaded with "
25350 "this call, unlike with L</pwrite>, and this call always writes the full "
25351 "amount unless an error occurs."
25355 #: ../fish/guestfish-actions.pod:4406
25356 msgid "See also L</upload>, L</pwrite>."
25360 #: ../fish/guestfish-actions.pod:4410
25365 #: ../fish/guestfish-actions.pod:4412
25368 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
25373 #: ../fish/guestfish-actions.pod:4431
25378 #: ../fish/guestfish-actions.pod:4433
25386 #: ../fish/guestfish-actions.pod:4460
25388 "I<Note:> Don't use this call to test for availability of features. In "
25389 "enterprise distributions we backport features from later versions into "
25390 "earlier versions, making this an unreliable way to test for features. Use "
25391 "L</available> instead."
25395 #: ../fish/guestfish-actions.pod:4466
25400 #: ../fish/guestfish-actions.pod:4468
25403 " vfs-label device\n"
25408 #: ../fish/guestfish-actions.pod:4475
25409 msgid "To find a filesystem from the label, use L</findfs-label>."
25413 #: ../fish/guestfish-actions.pod:4477
25418 #: ../fish/guestfish-actions.pod:4479
25421 " vfs-type device\n"
25426 #: ../fish/guestfish-actions.pod:4489
25431 #: ../fish/guestfish-actions.pod:4491
25434 " vfs-uuid device\n"
25439 #: ../fish/guestfish-actions.pod:4498
25440 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
25444 #: ../fish/guestfish-actions.pod:4500
25445 msgid "vg-activate"
25449 #: ../fish/guestfish-actions.pod:4502
25452 " vg-activate true|false 'volgroups ...'\n"
25457 #: ../fish/guestfish-actions.pod:4515
25458 msgid "vg-activate-all"
25462 #: ../fish/guestfish-actions.pod:4517
25465 " vg-activate-all true|false\n"
25470 #: ../fish/guestfish-actions.pod:4527
25475 #: ../fish/guestfish-actions.pod:4529
25478 " vgcreate volgroup 'physvols ...'\n"
25483 #: ../fish/guestfish-actions.pod:4534
25488 #: ../fish/guestfish-actions.pod:4536
25491 " vglvuuids vgname\n"
25496 #: ../fish/guestfish-actions.pod:4541
25498 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
25499 "logical volumes and volume groups."
25503 #: ../fish/guestfish-actions.pod:4544
25504 msgid "See also L</vgpvuuids>."
25508 #: ../fish/guestfish-actions.pod:4546
25513 #: ../fish/guestfish-actions.pod:4548
25516 " vgpvuuids vgname\n"
25521 #: ../fish/guestfish-actions.pod:4553
25523 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
25524 "physical volumes and volume groups."
25528 #: ../fish/guestfish-actions.pod:4556
25529 msgid "See also L</vglvuuids>."
25533 #: ../fish/guestfish-actions.pod:4558
25538 #: ../fish/guestfish-actions.pod:4560
25541 " vgremove vgname\n"
25546 #: ../fish/guestfish-actions.pod:4567
25551 #: ../fish/guestfish-actions.pod:4569
25554 " vgrename volgroup newvolgroup\n"
25559 #: ../fish/guestfish-actions.pod:4573
25564 #: ../fish/guestfish-actions.pod:4575
25572 #: ../fish/guestfish-actions.pod:4583
25573 msgid "See also L</vgs-full>."
25577 #: ../fish/guestfish-actions.pod:4585
25582 #: ../fish/guestfish-actions.pod:4587
25590 #: ../fish/guestfish-actions.pod:4592
25595 #: ../fish/guestfish-actions.pod:4594
25603 #: ../fish/guestfish-actions.pod:4599
25608 #: ../fish/guestfish-actions.pod:4601
25616 #: ../fish/guestfish-actions.pod:4605
25621 #: ../fish/guestfish-actions.pod:4607
25629 #: ../fish/guestfish-actions.pod:4612
25634 #: ../fish/guestfish-actions.pod:4614
25642 #: ../fish/guestfish-actions.pod:4619
25647 #: ../fish/guestfish-actions.pod:4621
25655 #: ../fish/guestfish-actions.pod:4626
25660 #: ../fish/guestfish-actions.pod:4628
25663 " write path content\n"
25668 #: ../fish/guestfish-actions.pod:4636
25673 #: ../fish/guestfish-actions.pod:4638
25676 " write-file path content size\n"
25681 #: ../fish/guestfish-actions.pod:4654
25682 msgid "This function is deprecated. In new code, use the L</write> call instead."
25686 #: ../fish/guestfish-actions.pod:4661
25691 #: ../fish/guestfish-actions.pod:4663
25694 " zegrep regex path\n"
25699 #: ../fish/guestfish-actions.pod:4671
25704 #: ../fish/guestfish-actions.pod:4673
25707 " zegrepi regex path\n"
25712 #: ../fish/guestfish-actions.pod:4681
25717 #: ../fish/guestfish-actions.pod:4683
25725 #: ../fish/guestfish-actions.pod:4691
25726 msgid "See also: L</zero-device>, L</scrub-device>."
25730 #: ../fish/guestfish-actions.pod:4693
25731 msgid "zero-device"
25735 #: ../fish/guestfish-actions.pod:4695
25738 " zero-device device\n"
25743 #: ../fish/guestfish-actions.pod:4697
25745 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
25746 "which just zeroes the first few blocks of a device."
25750 #: ../fish/guestfish-actions.pod:4704
25755 #: ../fish/guestfish-actions.pod:4706
25758 " zerofree device\n"
25763 #: ../fish/guestfish-actions.pod:4719
25768 #: ../fish/guestfish-actions.pod:4721
25771 " zfgrep pattern path\n"
25776 #: ../fish/guestfish-actions.pod:4729
25781 #: ../fish/guestfish-actions.pod:4731
25784 " zfgrepi pattern path\n"
25789 #: ../fish/guestfish-actions.pod:4739
25794 #: ../fish/guestfish-actions.pod:4741
25797 " zfile meth path\n"
25802 #: ../fish/guestfish-actions.pod:4748
25803 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
25807 #: ../fish/guestfish-actions.pod:4751
25808 msgid "This function is deprecated. In new code, use the L</file> call instead."
25812 #: ../fish/guestfish-actions.pod:4758
25817 #: ../fish/guestfish-actions.pod:4760
25820 " zgrep regex path\n"
25825 #: ../fish/guestfish-actions.pod:4768
25830 #: ../fish/guestfish-actions.pod:4770
25833 " zgrepi regex path\n"
25838 #: ../fish/guestfish-commands.pod:1
25843 #: ../fish/guestfish-commands.pod:3
25848 #: ../fish/guestfish-commands.pod:5
25851 " alloc filename size\n"
25856 #: ../fish/guestfish-commands.pod:7
25858 "This creates an empty (zeroed) file of the given size, and then adds so it "
25859 "can be further examined."
25863 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25864 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25868 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25869 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25873 #: ../fish/guestfish-commands.pod:14
25875 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25876 "image, see L</PREPARED DISK IMAGES>."
25880 #: ../fish/guestfish-commands.pod:17
25885 #: ../fish/guestfish-commands.pod:19
25888 " copy-in local [local ...] /remotedir\n"
25893 #: ../fish/guestfish-commands.pod:21
25895 "C<copy-in> copies local files or directories recursively into the disk "
25896 "image, placing them in the directory called C</remotedir> (which must "
25897 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25898 "other commands as necessary."
25902 #: ../fish/guestfish-commands.pod:26
25904 "Multiple local files and directories can be specified, but the last "
25905 "parameter must always be a remote directory. Wildcards cannot be used."
25909 #: ../fish/guestfish-commands.pod:30
25914 #: ../fish/guestfish-commands.pod:32
25917 " copy-out remote [remote ...] localdir\n"
25922 #: ../fish/guestfish-commands.pod:34
25924 "C<copy-out> copies remote files or directories recursively out of the disk "
25925 "image, placing them on the host disk in a local directory called C<localdir> "
25926 "(which must exist). This guestfish meta-command turns into a sequence of "
25927 "L</download>, L</tar-out> and other commands as necessary."
25931 #: ../fish/guestfish-commands.pod:40
25933 "Multiple remote files and directories can be specified, but the last "
25934 "parameter must always be a local directory. To download to the current "
25935 "directory, use C<.> as in:"
25939 #: ../fish/guestfish-commands.pod:44
25942 " copy-out /home .\n"
25947 #: ../fish/guestfish-commands.pod:46
25949 "Wildcards cannot be used in the ordinary command, but you can use them with "
25950 "the help of L</glob> like this:"
25954 #: ../fish/guestfish-commands.pod:49
25957 " glob copy-out /home/* .\n"
25962 #: ../fish/guestfish-commands.pod:51
25967 #: ../fish/guestfish-commands.pod:53
25970 " echo [params ...]\n"
25975 #: ../fish/guestfish-commands.pod:55
25976 msgid "This echos the parameters to the terminal."
25980 #: ../fish/guestfish-commands.pod:57
25985 #: ../fish/guestfish-commands.pod:59
25990 #: ../fish/guestfish-commands.pod:61
25995 #: ../fish/guestfish-commands.pod:63
26003 #: ../fish/guestfish-commands.pod:65
26005 "This is used to edit a file. It downloads the file, edits it locally using "
26006 "your editor, then uploads the result."
26010 #: ../fish/guestfish-commands.pod:68
26012 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
26013 "or C<emacs> you will get those corresponding editors."
26017 #: ../fish/guestfish-commands.pod:72
26022 #: ../fish/guestfish-commands.pod:74
26025 " glob command args...\n"
26030 #: ../fish/guestfish-commands.pod:76
26032 "Expand wildcards in any paths in the args list, and run C<command> "
26033 "repeatedly on each matching path."
26037 #: ../fish/guestfish-commands.pod:79
26038 msgid "See L</WILDCARDS AND GLOBBING>."
26042 #: ../fish/guestfish-commands.pod:81
26047 #: ../fish/guestfish-commands.pod:83
26050 " hexedit <filename|device>\n"
26051 " hexedit <filename|device> <max>\n"
26052 " hexedit <filename|device> <start> <max>\n"
26057 #: ../fish/guestfish-commands.pod:87
26059 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
26064 #: ../fish/guestfish-commands.pod:90
26066 "This command works by downloading potentially the whole file or device, "
26067 "editing it locally, then uploading it. If the file or device is large, you "
26068 "have to specify which part you wish to edit by using C<max> and/or C<start> "
26069 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
26070 "usual modifiers allowed such as C<1M> (1 megabyte)."
26074 #: ../fish/guestfish-commands.pod:97
26075 msgid "For example to edit the first few sectors of a disk you might do:"
26079 #: ../fish/guestfish-commands.pod:100
26082 " hexedit /dev/sda 1M\n"
26087 #: ../fish/guestfish-commands.pod:102
26089 "which would allow you to edit anywhere within the first megabyte of the "
26094 #: ../fish/guestfish-commands.pod:105
26095 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
26099 #: ../fish/guestfish-commands.pod:107
26102 " hexedit /dev/sda1 0x400 0x400\n"
26107 #: ../fish/guestfish-commands.pod:109
26108 msgid "(assuming the superblock is in the standard location)."
26112 #: ../fish/guestfish-commands.pod:111
26114 "This command requires the external L<hexedit(1)> program. You can specify "
26115 "another program to use by setting the C<HEXEDITOR> environment variable."
26119 #: ../fish/guestfish-commands.pod:115
26120 msgid "See also L</hexdump>."
26124 #: ../fish/guestfish-commands.pod:117
26129 #: ../fish/guestfish-commands.pod:119
26137 #: ../fish/guestfish-commands.pod:121
26138 msgid "Change the local directory, ie. the current directory of guestfish itself."
26142 #: ../fish/guestfish-commands.pod:124
26143 msgid "Note that C<!cd> won't do what you might expect."
26147 #: ../fish/guestfish-commands.pod:126
26152 #: ../fish/guestfish-commands.pod:128
26157 #: ../fish/guestfish-commands.pod:130
26165 #: ../fish/guestfish-commands.pod:132
26166 msgid "Opens the manual page for guestfish."
26170 #: ../fish/guestfish-commands.pod:134
26175 #: ../fish/guestfish-commands.pod:136
26180 #: ../fish/guestfish-commands.pod:138
26188 #: ../fish/guestfish-commands.pod:140
26196 #: ../fish/guestfish-commands.pod:142
26197 msgid "This is used to view a file."
26201 #: ../fish/guestfish-commands.pod:144
26203 "The default viewer is C<$PAGER>. However if you use the alternate command "
26204 "C<less> you will get the C<less> command specifically."
26208 #: ../fish/guestfish-commands.pod:147
26213 #: ../fish/guestfish-commands.pod:149
26221 #: ../fish/guestfish-commands.pod:151
26223 "Close and reopen the libguestfs handle. It is not necessary to use this "
26224 "normally, because the handle is closed properly when guestfish exits. "
26225 "However this is occasionally useful for testing."
26229 #: ../fish/guestfish-commands.pod:155
26234 #: ../fish/guestfish-commands.pod:157
26237 " sparse filename size\n"
26242 #: ../fish/guestfish-commands.pod:159
26244 "This creates an empty sparse file of the given size, and then adds so it can "
26245 "be further examined."
26249 #: ../fish/guestfish-commands.pod:162
26251 "In all respects it works the same as the L</alloc> command, except that the "
26252 "image file is allocated sparsely, which means that disk blocks are not "
26253 "assigned to the file until they are needed. Sparse disk files only use "
26254 "space when written to, but they are slower and there is a danger you could "
26255 "run out of real disk space during a write operation."
26259 #: ../fish/guestfish-commands.pod:172
26264 #: ../fish/guestfish-commands.pod:174
26272 #: ../fish/guestfish-commands.pod:176
26274 "This command returns a list of the optional groups known to the daemon, and "
26275 "indicates which ones are supported by this build of the libguestfs "
26280 #: ../fish/guestfish-commands.pod:180
26281 msgid "See also L<guestfs(3)/AVAILABILITY>."
26285 #: ../fish/guestfish-commands.pod:182
26290 #: ../fish/guestfish-commands.pod:184
26293 " time command args...\n"
26298 #: ../fish/guestfish-commands.pod:186
26300 "Run the command as usual, but print the elapsed time afterwards. This can "
26301 "be useful for benchmarking operations."
26305 #: ../test-tool/libguestfs-test-tool.pod:5
26306 msgid "libguestfs-test-tool - End user tests for libguestfs"
26310 #: ../test-tool/libguestfs-test-tool.pod:9
26313 " libguestfs-test-tool [--options]\n"
26318 #: ../test-tool/libguestfs-test-tool.pod:13
26320 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
26321 "and developers, to allow them to check basic libguestfs functionality is "
26322 "working. This is needed because libguestfs occasionally breaks for reasons "
26323 "beyond our control: usually because of changes in the underlying qemu or "
26324 "kernel packages, or the host environment."
26328 #: ../test-tool/libguestfs-test-tool.pod:20
26329 msgid "If you suspect a problem in libguestfs, then just run:"
26333 #: ../test-tool/libguestfs-test-tool.pod:22
26336 " libguestfs-test-tool\n"
26341 #: ../test-tool/libguestfs-test-tool.pod:24
26342 msgid "It will print lots of diagnostic messages."
26346 #: ../test-tool/libguestfs-test-tool.pod:26
26347 msgid "If it runs to completion successfully, you will see this near the end:"
26351 #: ../test-tool/libguestfs-test-tool.pod:28
26354 " ===== TEST FINISHED OK =====\n"
26359 #: ../test-tool/libguestfs-test-tool.pod:30
26360 msgid "and the test tool will exit with code 0."
26364 #: ../test-tool/libguestfs-test-tool.pod:32
26366 "If it fails (and/or exits with non-zero error code), please paste the "
26367 "B<complete, unedited> output of the test tool into a bug report. More "
26368 "information about reporting bugs can be found on the "
26369 "L<http://libguestfs.org/> website."
26373 #: ../test-tool/libguestfs-test-tool.pod:41
26378 #: ../test-tool/libguestfs-test-tool.pod:43
26379 msgid "Display short usage information and exit."
26383 #: ../test-tool/libguestfs-test-tool.pod:45
26384 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
26388 #: ../test-tool/libguestfs-test-tool.pod:47
26390 "Pass an alternate name for the helper program. libguestfs-test-tool will "
26391 "normally look in the C<$libexec> directory that was configured when the tool "
26396 #: ../test-tool/libguestfs-test-tool.pod:51
26397 msgid "I<--qemu qemu_binary>"
26401 #: ../test-tool/libguestfs-test-tool.pod:53
26403 "If you have downloaded another qemu binary, point this option at the full "
26404 "path of the binary to try it."
26408 #: ../test-tool/libguestfs-test-tool.pod:56
26409 msgid "I<--qemudir qemu_source_dir>"
26413 #: ../test-tool/libguestfs-test-tool.pod:58
26415 "If you have compiled qemu from source, point this option at the source "
26416 "directory to try it."
26420 #: ../test-tool/libguestfs-test-tool.pod:61
26421 msgid "I<--timeout N>"
26425 #: ../test-tool/libguestfs-test-tool.pod:63
26427 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
26428 "does not usually need to be adjusted unless your machine is very slow."
26432 #: ../test-tool/libguestfs-test-tool.pod:69
26433 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
26437 #: ../test-tool/libguestfs-test-tool.pod:71
26439 "If you have compiled another version of qemu from source and would like to "
26440 "try that, then you can use the I<--qemudir> option to point to the qemu "
26441 "source directory."
26445 #: ../test-tool/libguestfs-test-tool.pod:75
26447 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
26448 "option to point to the binary."
26452 #: ../test-tool/libguestfs-test-tool.pod:78
26454 "When using an alternate qemu with libguestfs, usually you would need to "
26455 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
26456 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
26457 "when you use either of the I<--qemudir> or I<--qemu> options."
26461 #: ../test-tool/libguestfs-test-tool.pod:85
26463 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
26464 "I<1> if there was an error."
26468 #: ../test-tool/libguestfs-test-tool.pod:92
26469 msgid "/usr/libexec/libguestfs-test-tool-helper"
26473 #: ../test-tool/libguestfs-test-tool.pod:94
26475 "This helper program is run inside the appliance and provides additional "
26480 #: ../test-tool/libguestfs-test-tool.pod:97
26481 msgid "/usr/bin/mkisofs"
26485 #: ../test-tool/libguestfs-test-tool.pod:99
26487 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
26488 "which is used as part of the tests."
26492 #: ../test-tool/libguestfs-test-tool.pod:106
26494 "For the full list of environment variables which may affect libguestfs, "
26495 "please see the L<guestfs(3)> manual page."
26499 #: ../test-tool/libguestfs-test-tool.pod:111
26500 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
26504 #: ../test-tool/libguestfs-test-tool.pod:121
26505 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
26509 #: ../fuse/guestmount.pod:5
26510 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
26514 #: ../fuse/guestmount.pod:9
26517 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
26522 #: ../fuse/guestmount.pod:11
26525 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
26530 #: ../fuse/guestmount.pod:13
26533 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
26538 #: ../fuse/guestmount.pod:17
26540 "You must I<not> use C<guestmount> in read-write mode on live virtual "
26541 "machines. If you do this, you risk disk corruption in the VM."
26545 #: ../fuse/guestmount.pod:22
26547 "The guestmount program can be used to mount virtual machine filesystems and "
26548 "other disk images on the host. It uses libguestfs for access to the guest "
26549 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
26550 "a mountable device."
26554 #: ../fuse/guestmount.pod:27
26556 "Along with other options, you have to give at least one device (I<-a> "
26557 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
26558 "option) or use the I<-i> inspection option. How this works is better "
26559 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
26564 #: ../fuse/guestmount.pod:33
26566 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
26567 "by you, and the filesystem will not be visible to any other users unless you "
26568 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
26569 "the filesystem, use the C<fusermount -u> command."
26573 #: ../fuse/guestmount.pod:41
26575 "For a typical Windows guest which has its main filesystem on the first "
26580 #: ../fuse/guestmount.pod:44
26583 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
26588 #: ../fuse/guestmount.pod:46
26590 "For a typical Linux guest which has a /boot filesystem on the first "
26591 "partition, and the root filesystem on a logical volume:"
26595 #: ../fuse/guestmount.pod:49
26598 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
26603 #: ../fuse/guestmount.pod:51
26604 msgid "To get libguestfs to detect guest mountpoints for you:"
26608 #: ../fuse/guestmount.pod:53
26611 " guestmount -a guest.img -i --ro /mnt\n"
26616 #: ../fuse/guestmount.pod:55
26617 msgid "For a libvirt guest called \"Guest\" you could do:"
26621 #: ../fuse/guestmount.pod:57
26624 " guestmount -d Guest -i --ro /mnt\n"
26629 #: ../fuse/guestmount.pod:59
26631 "If you don't know what filesystems are contained in a guest or disk image, "
26632 "use L<virt-filesystems(1)> first:"
26636 #: ../fuse/guestmount.pod:62
26639 " virt-filesystems MyGuest\n"
26644 #: ../fuse/guestmount.pod:64
26646 "If you want to trace the libguestfs calls but without excessive debugging "
26647 "information, we recommend:"
26651 #: ../fuse/guestmount.pod:67
26654 " guestmount [...] --trace /mnt\n"
26659 #: ../fuse/guestmount.pod:69
26660 msgid "If you want to debug the program, we recommend:"
26664 #: ../fuse/guestmount.pod:71
26667 " guestmount [...] --trace --verbose /mnt\n"
26672 #: ../fuse/guestmount.pod:77
26673 msgid "B<-a image> | B<--add image>"
26677 #: ../fuse/guestmount.pod:79
26678 msgid "Add a block device or virtual machine image."
26682 #: ../fuse/guestmount.pod:84
26683 msgid "B<-c URI> | B<--connect URI>"
26687 #: ../fuse/guestmount.pod:90
26688 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
26692 #: ../fuse/guestmount.pod:96
26693 msgid "B<--dir-cache-timeout N>"
26697 #: ../fuse/guestmount.pod:98
26699 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
26700 "seconds. The readdir cache [actually, there are several semi-independent "
26701 "caches] is populated after a readdir(2) call with the stat and extended "
26702 "attributes of the files in the directory, in anticipation that they will be "
26703 "requested soon after."
26707 #: ../fuse/guestmount.pod:104
26709 "There is also a different attribute cache implemented by FUSE (see the FUSE "
26710 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
26711 "requests, only cache existing ones."
26715 #: ../fuse/guestmount.pod:115
26716 msgid "B<--format=raw|qcow2|..> | B<--format>"
26720 #: ../fuse/guestmount.pod:122
26722 "If you have untrusted raw-format guest disk images, you should use this "
26723 "option to specify the disk format. This avoids a possible security problem "
26724 "with malicious guests (CVE-2010-3851). See also "
26725 "L<guestfs(3)/guestfs_add_drive_opts>."
26729 #: ../fuse/guestmount.pod:127
26730 msgid "B<--fuse-help>"
26734 #: ../fuse/guestmount.pod:129
26735 msgid "Display help on special FUSE options (see I<-o> below)."
26739 #: ../fuse/guestmount.pod:133
26740 msgid "Display brief help and exit."
26744 #: ../fuse/guestmount.pod:135
26745 msgid "B<-i> | B<--inspector>"
26749 #: ../fuse/guestmount.pod:146
26750 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
26754 #: ../fuse/guestmount.pod:148
26756 "Mount the named partition or logical volume on the given mountpoint B<in the "
26757 "guest> (this has nothing to do with mountpoints in the host)."
26761 #: ../fuse/guestmount.pod:151
26763 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
26764 "something on C</>."
26768 #: ../fuse/guestmount.pod:154
26769 msgid "B<-n> | B<--no-sync>"
26773 #: ../fuse/guestmount.pod:156
26775 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
26776 "unmounted. If you specify this option, then we don't attempt to sync the "
26777 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
26781 #: ../fuse/guestmount.pod:161
26782 msgid "B<-o option> | B<--option option>"
26786 #: ../fuse/guestmount.pod:163
26787 msgid "Pass extra options to FUSE."
26791 #: ../fuse/guestmount.pod:165
26793 "To get a list of all the extra options supported by FUSE, use the command "
26794 "below. Note that only the FUSE I<-o> options can be passed, and only some "
26795 "of them are a good idea."
26799 #: ../fuse/guestmount.pod:169
26802 " guestmount --fuse-help\n"
26807 #: ../fuse/guestmount.pod:171
26808 msgid "Some potentially useful FUSE options:"
26812 #: ../fuse/guestmount.pod:175
26813 msgid "B<-o allow_other>"
26817 #: ../fuse/guestmount.pod:177
26818 msgid "Allow other users to see the filesystem."
26822 #: ../fuse/guestmount.pod:179
26823 msgid "B<-o attr_timeout=N>"
26827 #: ../fuse/guestmount.pod:181
26828 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
26832 #: ../fuse/guestmount.pod:183
26833 msgid "B<-o kernel_cache>"
26837 #: ../fuse/guestmount.pod:185
26839 "Allow the kernel to cache files (reduces the number of reads that have to go "
26840 "through the L<guestfs(3)> API). This is generally a good idea if you can "
26841 "afford the extra memory usage."
26845 #: ../fuse/guestmount.pod:189
26846 msgid "B<-o uid=N> B<-o gid=N>"
26850 #: ../fuse/guestmount.pod:191
26852 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
26853 "the chosen values."
26857 #: ../fuse/guestmount.pod:196
26858 msgid "B<-r> | B<--ro>"
26862 #: ../fuse/guestmount.pod:198
26864 "Add devices and mount everything read-only. Also disallow writes and make "
26865 "the disk appear read-only to FUSE."
26869 #: ../fuse/guestmount.pod:201
26871 "This is highly recommended if you are not going to edit the guest disk. If "
26872 "the guest is running and this option is I<not> supplied, then there is a "
26873 "strong risk of disk corruption in the guest. We try to prevent this from "
26874 "happening, but it is not always possible."
26878 #: ../fuse/guestmount.pod:206
26879 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26883 #: ../fuse/guestmount.pod:210
26884 msgid "Enable SELinux support for the guest."
26888 #: ../fuse/guestmount.pod:212
26889 msgid "B<-v> | B<--verbose>"
26893 #: ../fuse/guestmount.pod:214
26894 msgid "Enable verbose messages from underlying libguestfs."
26898 #: ../fuse/guestmount.pod:216
26899 msgid "B<-V> | B<--version>"
26903 #: ../fuse/guestmount.pod:218
26904 msgid "Display the program version and exit."
26908 #: ../fuse/guestmount.pod:220
26909 msgid "B<-w> | B<--rw>"
26913 #: ../fuse/guestmount.pod:222
26915 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26916 "FOR READ AND WRITE>."
26920 #: ../fuse/guestmount.pod:225
26921 msgid "B<-x> | B<--trace>"
26925 #: ../fuse/guestmount.pod:227
26926 msgid "Trace libguestfs calls and entry into each FUSE function."
26930 #: ../fuse/guestmount.pod:229
26931 msgid "This also stops the daemon from forking into the background."
26935 #: ../fuse/guestmount.pod:235
26937 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26938 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
26939 "L<http://fuse.sf.net/>."
26943 #: ../tools/virt-edit.pl:34
26944 msgid "virt-edit - Edit a file in a virtual machine"
26948 #: ../tools/virt-edit.pl:38
26951 " virt-edit [--options] domname file\n"
26956 #: ../tools/virt-edit.pl:40
26959 " virt-edit [--options] disk.img [disk.img ...] file\n"
26964 #: ../tools/virt-edit.pl:42
26967 " virt-edit [domname|disk.img] file -e 'expr'\n"
26972 #: ../tools/virt-edit.pl:46
26974 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26975 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26976 "doing this, but doesn't catch all cases."
26980 #: ../tools/virt-edit.pl:52
26982 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26983 "the named virtual machine (or disk image)."
26987 #: ../tools/virt-edit.pl:55
26988 msgid "If you want to just view a file, use L<virt-cat(1)>."
26992 #: ../tools/virt-edit.pl:57
26994 "For more complex cases you should look at the L<guestfish(1)> tool (see "
26995 "L</USING GUESTFISH> below)."
26999 #: ../tools/virt-edit.pl:60
27001 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
27002 "files. L<guestfish(1)> can do that and much more."
27006 #: ../tools/virt-edit.pl:65
27007 msgid "Edit the named files interactively:"
27011 #: ../tools/virt-edit.pl:67
27014 " virt-edit mydomain /boot/grub/grub.conf\n"
27019 #: ../tools/virt-edit.pl:69
27022 " virt-edit mydomain /etc/passwd\n"
27027 #: ../tools/virt-edit.pl:71
27029 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
27030 "below). To change the init default level to 5:"
27034 #: ../tools/virt-edit.pl:75
27037 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
27042 #: ../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
27043 msgid "Display brief help."
27047 #: ../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
27048 msgid "Display version number and exit."
27052 #: ../tools/virt-edit.pl:101
27053 msgid "B<--backup extension> | B<-b extension>"
27057 #: ../tools/virt-edit.pl:103
27059 "Create a backup of the original file I<in the guest disk image>. The backup "
27060 "has the original filename with C<extension> added."
27064 #: ../tools/virt-edit.pl:106
27066 "Usually the first character of C<extension> would be a dot C<.> so you would "
27071 #: ../tools/virt-edit.pl:109
27074 " virt-edit -b .orig [etc]\n"
27079 #: ../tools/virt-edit.pl:111
27080 msgid "By default, no backup file is made."
27084 #: ../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
27085 msgid "B<--connect URI> | B<-c URI>"
27089 #: ../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
27091 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
27092 "to the default libvirt hypervisor."
27096 #: ../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
27098 "If you specify guest block devices directly, then libvirt is not used at "
27103 #: ../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
27104 msgid "B<--format> raw"
27108 #: ../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
27110 "Specify the format of disk images given on the command line. If this is "
27111 "omitted then the format is autodetected from the content of the disk image."
27115 #: ../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
27117 "If disk images are requested from libvirt, then this program asks libvirt "
27118 "for this information. In this case, the value of the format parameter is "
27123 #: ../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
27125 "If working with untrusted raw-format guest disk images, you should ensure "
27126 "the format is always specified."
27130 #: ../tools/virt-edit.pl:146
27131 msgid "B<--expr EXPR> | B<-e EXPR>"
27135 #: ../tools/virt-edit.pl:148
27137 "Instead of launching the external editor, non-interactively apply the Perl "
27138 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
27143 #: ../tools/virt-edit.pl:152
27145 "Be careful to properly quote the expression to prevent it from being altered "
27150 #: ../tools/virt-edit.pl:272
27151 msgid "NON-INTERACTIVE EDITING"
27155 #: ../tools/virt-edit.pl:274
27157 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
27158 "administrator can interactively edit the file."
27162 #: ../tools/virt-edit.pl:277
27164 "There are two ways also to use C<virt-edit> from scripts in order to make "
27165 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
27166 "like this, it's less error-prone to write scripts directly using the "
27167 "libguestfs API and Augeas for configuration file editing.)"
27171 #: ../tools/virt-edit.pl:283
27173 "The first method is to temporarily set C<$EDITOR> to any script or program "
27174 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
27175 "update C<tmpfile> in place however it likes."
27179 #: ../tools/virt-edit.pl:287
27181 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
27182 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
27183 "instances of C<foo> with C<bar> in a file:"
27187 #: ../tools/virt-edit.pl:291
27190 " virt-edit domname filename -e 's/foo/bar/'\n"
27195 #: ../tools/virt-edit.pl:293
27197 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
27198 "For example to delete root's password you could do:"
27202 #: ../tools/virt-edit.pl:296
27205 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
27210 #: ../tools/virt-edit.pl:298
27212 "What really happens is that the snippet is evaluated as a Perl expression "
27213 "for each line of the file. The line, including the final C<\\n>, is passed "
27214 "in C<$_> and the expression should update C<$_> or leave it unchanged."
27218 #: ../tools/virt-edit.pl:303
27220 "To delete a line, set C<$_> to the empty string. For example, to delete the "
27221 "C<apache> user account from the password file you can do:"
27225 #: ../tools/virt-edit.pl:306
27228 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
27233 #: ../tools/virt-edit.pl:308
27235 "To insert a line, prepend or append it to C<$_>. However appending lines to "
27236 "the end of the file is rather difficult this way since there is no concept "
27237 "of \"last line of the file\" - your expression just doesn't get called "
27238 "again. You might want to use the first method (setting C<$EDITOR>) if you "
27243 #: ../tools/virt-edit.pl:314
27245 "The variable C<$lineno> contains the current line number. As is "
27246 "traditional, the first line in the file is number C<1>."
27250 #: ../tools/virt-edit.pl:317
27252 "The return value from the expression is ignored, but the expression may call "
27253 "C<die> in order to abort the whole program, leaving the original file "
27258 #: ../tools/virt-edit.pl:321
27260 "Remember when matching the end of a line that C<$_> may contain the final "
27261 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
27262 "newline then neither of these. Thus to match or substitute some text at the "
27263 "end of a line, use this regular expression:"
27267 #: ../tools/virt-edit.pl:326
27270 " /some text(\\r?\\n)?$/\n"
27275 #: ../tools/virt-edit.pl:328
27277 "Alternately, use the perl C<chomp> function, being careful not to chomp "
27278 "C<$_> itself (since that would remove all newlines from the file):"
27282 #: ../tools/virt-edit.pl:332
27285 " my $m = $_; chomp $m; $m =~ /some text$/\n"
27290 #: ../tools/virt-edit.pl:334
27291 msgid "USING GUESTFISH"
27295 #: ../tools/virt-edit.pl:336
27297 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
27298 "C<virt-edit> doesn't work."
27302 #: ../tools/virt-edit.pl:339
27303 msgid "Using C<virt-edit> is approximately equivalent to doing:"
27307 #: ../tools/virt-edit.pl:341
27310 " guestfish --rw -i -d domname edit /file\n"
27315 #: ../tools/virt-edit.pl:343
27317 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
27318 "path to the file."
27322 #: ../tools/virt-edit.pl:346
27324 "The command above uses libguestfs's guest inspection feature and so does not "
27325 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
27326 "disk images that don't contain guests. To edit a file on a disk image "
27331 #: ../tools/virt-edit.pl:351
27334 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
27339 #: ../tools/virt-edit.pl:353
27341 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
27342 "the disk image to edit, and C</file> is the full path to the file."
27346 #: ../tools/virt-edit.pl:357
27348 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
27349 "C<write> or C<upload> instead:"
27353 #: ../tools/virt-edit.pl:360
27356 " guestfish --rw -i -d domname touch /newfile\n"
27361 #: ../tools/virt-edit.pl:362
27364 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
27369 #: ../tools/virt-edit.pl:364
27372 " guestfish --rw -i -d domname upload localfile /newfile\n"
27377 #: ../tools/virt-edit.pl:366
27378 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
27382 #: ../tools/virt-edit.pl:369
27385 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
27390 #: ../tools/virt-edit.pl:379
27395 #: ../tools/virt-edit.pl:381
27397 "If set, this string is used as the editor. It may contain arguments, "
27398 "eg. C<\"emacs -nw\">"
27402 #: ../tools/virt-edit.pl:384
27403 msgid "If not set, C<vi> is used."
27407 #: ../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
27408 msgid "SHELL QUOTING"
27412 #: ../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
27414 "Libvirt guest names can contain arbitrary characters, some of which have "
27415 "meaning to the shell such as C<#> and space. You may need to quote or "
27416 "escape these characters on the command line. See the shell manual page "
27417 "L<sh(1)> for details."
27421 #: ../tools/virt-edit.pl:397
27423 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27424 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
27425 "L<perl(1)>, L<perlre(1)>."
27429 #: ../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
27434 #: ../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
27435 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
27439 #: ../tools/virt-edit.pl:413
27440 msgid "Copyright (C) 2009-2011 Red Hat Inc."
27444 #: ../tools/virt-win-reg.pl:37
27446 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
27451 #: ../tools/virt-win-reg.pl:41
27454 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
27459 #: ../tools/virt-win-reg.pl:43
27462 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
27467 #: ../tools/virt-win-reg.pl:45
27470 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
27475 #: ../tools/virt-win-reg.pl:47
27478 " virt-win-reg --merge domname [input.reg ...]\n"
27483 #: ../tools/virt-win-reg.pl:49
27486 " virt-win-reg [--options] disk.img ... # instead of domname\n"
27491 #: ../tools/virt-win-reg.pl:53
27493 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
27494 "virtual machines. If you do this, you I<will> get irreversible disk "
27495 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
27496 "but doesn't catch all cases."
27500 #: ../tools/virt-win-reg.pl:58
27502 "Modifying the Windows Registry is an inherently risky operation. The format "
27503 "is deliberately obscure and undocumented, and Registry changes can leave the "
27504 "system unbootable. Therefore when using the C<--merge> option, make sure "
27505 "you have a reliable backup first."
27509 #: ../tools/virt-win-reg.pl:65
27511 "This program can export and merge Windows Registry entries from a Windows "
27516 #: ../tools/virt-win-reg.pl:68
27518 "The first parameter is the libvirt guest name or the raw disk image of a "
27523 #: ../tools/virt-win-reg.pl:71
27525 "If C<--merge> is I<not> specified, then the chosen registry key is "
27526 "displayed/exported (recursively). For example:"
27530 #: ../tools/virt-win-reg.pl:74
27533 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
27538 #: ../tools/virt-win-reg.pl:76
27539 msgid "You can also display single values from within registry keys, for example:"
27543 #: ../tools/virt-win-reg.pl:79
27546 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
27547 " $ virt-win-reg Windows7 $cvkey ProductName\n"
27548 " Windows 7 Enterprise\n"
27553 #: ../tools/virt-win-reg.pl:83
27555 "With C<--merge>, you can merge a textual regedit file into the Windows "
27560 #: ../tools/virt-win-reg.pl:86
27563 " $ virt-win-reg --merge Windows7 changes.reg\n"
27568 #: ../tools/virt-win-reg.pl:88
27573 #: ../tools/virt-win-reg.pl:90
27575 "This program is only meant for simple access to the registry. If you want "
27576 "to do complicated things with the registry, we suggest you download the "
27577 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27578 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27579 "L<hivexregedit(1)>."
27583 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
27588 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
27589 msgid "Enable debugging messages."
27593 #: ../tools/virt-win-reg.pl:157
27598 #: ../tools/virt-win-reg.pl:159
27600 "In merge mode, this merges a textual regedit file into the Windows Registry "
27601 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27602 "displays or exports Registry entries instead."
27606 #: ../tools/virt-win-reg.pl:163
27608 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27609 "result in disk corruption. However exporting (without this flag) is always "
27614 #: ../tools/virt-win-reg.pl:171
27615 msgid "B<--encoding> UTF-16LE|ASCII"
27619 #: ../tools/virt-win-reg.pl:173
27621 "When merging (only), you may need to specify the encoding for strings to be "
27622 "used in the hive file. This is explained in detail in "
27623 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
27627 #: ../tools/virt-win-reg.pl:177
27629 "The default is to use UTF-16LE, which should work with recent versions of "
27634 #: ../tools/virt-win-reg.pl:402
27635 msgid "SUPPORTED SYSTEMS"
27639 #: ../tools/virt-win-reg.pl:404
27641 "The program currently supports Windows NT-derived guests starting with "
27642 "Windows XP through to at least Windows 7."
27646 #: ../tools/virt-win-reg.pl:407
27648 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
27649 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
27650 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
27654 #: ../tools/virt-win-reg.pl:411
27656 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
27661 #: ../tools/virt-win-reg.pl:414
27663 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
27668 #: ../tools/virt-win-reg.pl:417
27673 #: ../tools/virt-win-reg.pl:419
27675 "C<virt-win-reg> expects that regedit files have already been reencoded in "
27676 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
27677 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
27678 "with Windows-style line endings, you may need to reencode the whole file "
27679 "before or after processing."
27683 #: ../tools/virt-win-reg.pl:425
27685 "To reencode a file from Windows format to Linux (before processing it with "
27686 "the C<--merge> option), you would do something like this:"
27690 #: ../tools/virt-win-reg.pl:428
27693 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
27698 #: ../tools/virt-win-reg.pl:430
27700 "To go in the opposite direction, after exporting and before sending the file "
27701 "to a Windows user, do something like this:"
27705 #: ../tools/virt-win-reg.pl:433
27708 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
27713 #: ../tools/virt-win-reg.pl:435
27714 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
27718 #: ../tools/virt-win-reg.pl:437
27720 "If you are unsure about the current encoding, use the L<file(1)> command. "
27721 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
27722 "Windows-style (CRLF) line endings, like this:"
27726 #: ../tools/virt-win-reg.pl:441
27729 " $ file software.reg\n"
27730 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
27731 " with CRLF line terminators\n"
27736 #: ../tools/virt-win-reg.pl:445
27737 msgid "This file would need conversion before you could C<--merge> it."
27741 #: ../tools/virt-win-reg.pl:447
27742 msgid "CurrentControlSet etc."
27746 #: ../tools/virt-win-reg.pl:449
27748 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
27749 "Registry at the level of the hive file, and therefore you cannot modify "
27754 #: ../tools/virt-win-reg.pl:453
27756 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
27757 "circumstances it might refer to another control set. The way to find out is "
27758 "to look at the C<HKLM\\SYSTEM\\Select> key:"
27762 #: ../tools/virt-win-reg.pl:457
27765 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
27766 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
27767 " \"Current\"=dword:00000001\n"
27768 " \"Default\"=dword:00000001\n"
27769 " \"Failed\"=dword:00000000\n"
27770 " \"LastKnownGood\"=dword:00000002\n"
27775 #: ../tools/virt-win-reg.pl:464
27776 msgid "\"Current\" is the one which Windows will choose when it boots."
27780 #: ../tools/virt-win-reg.pl:466
27781 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
27785 #: ../tools/virt-win-reg.pl:469
27786 msgid "WINDOWS TIPS"
27790 #: ../tools/virt-win-reg.pl:471
27792 "Note that some of these tips modify the guest disk image. The guest I<must> "
27793 "be shut off, else you will get disk corruption."
27797 #: ../tools/virt-win-reg.pl:474
27798 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
27802 #: ../tools/virt-win-reg.pl:476
27804 "Prepare a DOS batch script, VBScript or executable. Upload this using "
27805 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
27806 "is uploaded into C<C:\\>:"
27810 #: ../tools/virt-win-reg.pl:480
27813 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
27818 #: ../tools/virt-win-reg.pl:482
27819 msgid "Prepare a regedit file containing the registry change:"
27823 #: ../tools/virt-win-reg.pl:484
27826 " cat > test.reg <<'EOF'\n"
27827 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
27828 " \"Test\"=\"c:\\\\test.bat\"\n"
27834 #: ../tools/virt-win-reg.pl:489
27836 "In this example we use the key C<RunOnce> which means that the script will "
27837 "run precisely once when the first user logs in. If you want it to run every "
27838 "time a user logs in, replace C<RunOnce> with C<Run>."
27842 #: ../tools/virt-win-reg.pl:493
27843 msgid "Now update the registry:"
27847 #: ../tools/virt-win-reg.pl:495
27850 " virt-win-reg --merge WindowsGuest test.reg\n"
27855 #: ../tools/virt-win-reg.pl:497
27856 msgid "INSTALLING A SERVICE"
27860 #: ../tools/virt-win-reg.pl:499
27862 "This section assumes you are familiar with Windows services, and you either "
27863 "have a program which handles the Windows Service Control Protocol directly "
27864 "or you want to run any program using a service wrapper like SrvAny or the "
27869 #: ../tools/virt-win-reg.pl:504
27871 "First upload the program and optionally the service wrapper. In this case "
27872 "the test program is called C<test.exe> and we are using the RHSrvAny "
27877 #: ../tools/virt-win-reg.pl:508
27880 " guestfish -i -d WindowsGuest <<EOF\n"
27881 " upload rhsrvany.exe /rhsrvany.exe\n"
27882 " upload test.exe /test.exe\n"
27888 #: ../tools/virt-win-reg.pl:513
27890 "Prepare a regedit file containing the registry changes. In this example, "
27891 "the first registry change is needed for the service itself or the service "
27892 "wrapper (if used). The second registry change is only needed because I am "
27893 "using the RHSrvAny service wrapper."
27897 #: ../tools/virt-win-reg.pl:518
27900 " cat > service.reg <<'EOF'\n"
27901 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
27902 " \"Type\"=dword:00000010\n"
27903 " \"Start\"=dword:00000002\n"
27904 " \"ErrorControl\"=dword:00000001\n"
27905 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
27906 " \"DisplayName\"=\"RHSrvAny\"\n"
27907 " \"ObjectName\"=\"NetworkService\"\n"
27912 #: ../tools/virt-win-reg.pl:527
27915 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
27916 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
27917 " \"PWD\"=\"c:\\\\Temp\"\n"
27923 #: ../tools/virt-win-reg.pl:538
27925 "For use of C<ControlSet001> see the section above in this manual page. You "
27926 "may need to adjust this according to the control set that is in use by the "
27931 #: ../tools/virt-win-reg.pl:544
27933 "C<\"ObjectName\"> controls the privileges that the service will have. An "
27934 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
27935 "privileged account."
27939 #: ../tools/virt-win-reg.pl:550
27941 "For the meaning of the magic numbers, see this Microsoft KB article: "
27942 "L<http://support.microsoft.com/kb/103000>."
27946 #: ../tools/virt-win-reg.pl:555
27947 msgid "Update the registry:"
27951 #: ../tools/virt-win-reg.pl:557
27954 " virt-win-reg --merge WindowsGuest service.reg\n"
27959 #: ../tools/virt-win-reg.pl:561
27961 "Be careful when passing parameters containing C<\\> (backslash) in the "
27962 "shell. Usually you will have to use 'single quotes' or double backslashes "
27963 "(but not both) to protect them from the shell."
27967 #: ../tools/virt-win-reg.pl:565
27968 msgid "Paths and value names are case-insensitive."
27972 #: ../tools/virt-win-reg.pl:574
27974 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
27975 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27976 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
27977 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27981 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
27983 "When reporting bugs, please enable debugging and capture the I<complete> "
27988 #: ../tools/virt-win-reg.pl:592
27991 " export LIBGUESTFS_DEBUG=1\n"
27992 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
27997 #: ../tools/virt-win-reg.pl:595
27999 "Attach /tmp/virt-win-reg.log to a new bug report at "
28000 "L<https://bugzilla.redhat.com/>"
28004 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:570
28005 msgid "Copyright (C) 2010 Red Hat Inc."
28009 #: ../tools/virt-resize.pl:42
28010 msgid "virt-resize - Resize a virtual machine disk"
28014 #: ../tools/virt-resize.pl:46
28017 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
28018 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
28019 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
28024 #: ../tools/virt-resize.pl:52
28026 "Virt-resize is a tool which can resize a virtual machine disk, making it "
28027 "larger or smaller overall, and resizing or deleting any partitions contained "
28032 #: ../tools/virt-resize.pl:56
28034 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
28035 "not> be used on live virtual machines - for consistent results, shut the "
28036 "virtual machine down before resizing it."
28040 #: ../tools/virt-resize.pl:60
28042 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
28043 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
28047 #: ../tools/virt-resize.pl:66
28049 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
28050 "fill the extra 5GB of space."
28054 #: ../tools/virt-resize.pl:69
28057 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
28058 " virt-filesystems --long -h --all -a olddisk\n"
28059 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
28060 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
28065 #: ../tools/virt-resize.pl:74
28067 "As above, but make the /boot partition 200MB bigger, while giving the "
28068 "remaining space to /dev/sda2:"
28072 #: ../tools/virt-resize.pl:77
28075 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
28080 #: ../tools/virt-resize.pl:79
28081 msgid "As above, but the output format will be uncompressed qcow2:"
28085 #: ../tools/virt-resize.pl:81
28088 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
28089 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
28094 #: ../tools/virt-resize.pl:84
28095 msgid "DETAILED USAGE"
28099 #: ../tools/virt-resize.pl:86
28100 msgid "EXPANDING A VIRTUAL MACHINE DISK"
28104 #: ../tools/virt-resize.pl:90
28105 msgid "1. Shut down the virtual machine"
28109 #: ../tools/virt-resize.pl:92
28110 msgid "2. Locate input disk image"
28114 #: ../tools/virt-resize.pl:94
28116 "Locate the input disk image (ie. the file or device on the host containing "
28117 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
28118 "dumpxml> like this to find the disk image name:"
28122 #: ../tools/virt-resize.pl:98
28125 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
28126 " Found 1 nodes:\n"
28128 " <source dev=\"/dev/vg/lv_guest\" />\n"
28133 #: ../tools/virt-resize.pl:103
28134 msgid "3. Look at current sizing"
28138 #: ../tools/virt-resize.pl:105
28139 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
28143 #: ../tools/virt-resize.pl:108
28146 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
28147 " Name Type Size Parent\n"
28148 " /dev/sda1 partition 101M /dev/sda\n"
28149 " /dev/sda2 partition 7.9G /dev/sda\n"
28150 " /dev/sda device 8.0G -\n"
28155 #: ../tools/virt-resize.pl:114
28157 "(This example is a virtual machine with an 8 GB disk which we would like to "
28158 "expand up to 10 GB)."
28162 #: ../tools/virt-resize.pl:117
28163 msgid "4. Create output disk"
28167 #: ../tools/virt-resize.pl:119
28169 "Virt-resize cannot do in-place disk modifications. You have to have space "
28170 "to store the resized output disk."
28174 #: ../tools/virt-resize.pl:122
28175 msgid "To store the resized disk image in a file, create a file of a suitable size:"
28179 #: ../tools/virt-resize.pl:125
28182 " # rm -f outdisk\n"
28183 " # truncate -s 10G outdisk\n"
28188 #: ../tools/virt-resize.pl:128
28189 msgid "Or use L<lvcreate(1)> to create a logical volume:"
28193 #: ../tools/virt-resize.pl:130
28196 " # lvcreate -L 10G -n lv_name vg_name\n"
28201 #: ../tools/virt-resize.pl:132
28202 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
28206 #: ../tools/virt-resize.pl:134
28209 " # virsh pool-list\n"
28210 " # virsh vol-create-as poolname newvol 10G\n"
28215 #: ../tools/virt-resize.pl:137
28220 #: ../tools/virt-resize.pl:139
28222 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
28223 "file) and the output disk. The output disk is the one created in the "
28228 #: ../tools/virt-resize.pl:143
28231 " # virt-resize indisk outdisk\n"
28236 #: ../tools/virt-resize.pl:145
28238 "This command just copies disk image C<indisk> to disk image C<outdisk> "
28239 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
28240 "larger, then an extra, empty partition is created at the end of the disk "
28241 "covering the extra space. If C<outdisk> is smaller, then it will give an "
28246 #: ../tools/virt-resize.pl:151
28248 "More realistically you'd want to expand existing partitions in the disk "
28249 "image by passing extra options (for the full list see the L</OPTIONS> "
28254 #: ../tools/virt-resize.pl:155
28256 "L</--expand> is the most useful option. It expands the named partition "
28257 "within the disk to fill any extra space:"
28261 #: ../tools/virt-resize.pl:158
28264 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
28269 #: ../tools/virt-resize.pl:160
28271 "(In this case, an extra partition is I<not> created at the end of the disk, "
28272 "because there will be no unused space)."
28276 #: ../tools/virt-resize.pl:163
28278 "L</--resize> is the other commonly used option. The following would "
28279 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
28280 "rest of the available space:"
28284 #: ../tools/virt-resize.pl:167
28287 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
28288 " indisk outdisk\n"
28293 #: ../tools/virt-resize.pl:170
28295 "If the expanded partition in the image contains a filesystem or LVM PV, then "
28296 "if virt-resize knows how, it will resize the contents, the equivalent of "
28297 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
28298 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
28299 "filesystems, so you would have to online resize them after booting the "
28304 #: ../tools/virt-resize.pl:177
28305 msgid "Other options are covered below."
28309 #: ../tools/virt-resize.pl:179
28314 #: ../tools/virt-resize.pl:181
28315 msgid "Thoroughly test the new disk image I<before> discarding the old one."
28319 #: ../tools/virt-resize.pl:183
28320 msgid "If you are using libvirt, edit the XML to point at the new disk:"
28324 #: ../tools/virt-resize.pl:185
28327 " # virsh edit guestname\n"
28332 #: ../tools/virt-resize.pl:187
28334 "Change E<lt>source ...E<gt>, see "
28335 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
28339 #: ../tools/virt-resize.pl:190
28340 msgid "Then start up the domain with the new, resized disk:"
28344 #: ../tools/virt-resize.pl:192
28347 " # virsh start guestname\n"
28352 #: ../tools/virt-resize.pl:194
28354 "and check that it still works. See also the L</NOTES> section below for "
28355 "additional information."
28359 #: ../tools/virt-resize.pl:197
28360 msgid "7. Resize LVs etc inside the guest"
28364 #: ../tools/virt-resize.pl:199
28365 msgid "(This can also be done offline using L<guestfish(1)>)"
28369 #: ../tools/virt-resize.pl:201
28371 "Once the guest has booted you should see the new space available, at least "
28372 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
28373 "may need to resize LVs inside PVs, and also resize filesystem types that "
28374 "virt-resize does not know how to expand."
28378 #: ../tools/virt-resize.pl:208
28379 msgid "SHRINKING A VIRTUAL MACHINE DISK"
28383 #: ../tools/virt-resize.pl:210
28385 "Shrinking is somewhat more complex than expanding, and only an overview is "
28390 #: ../tools/virt-resize.pl:213
28392 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
28393 "filesystems). The user has to shrink content before passing the disk image "
28394 "to virt-resize, and virt-resize will check that the content has been shrunk "
28399 #: ../tools/virt-resize.pl:218
28400 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28404 #: ../tools/virt-resize.pl:220
28406 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28407 "steps 3 and 4 above to allocate a new disk image."
28411 #: ../tools/virt-resize.pl:223
28412 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28416 #: ../tools/virt-resize.pl:226
28417 msgid "IGNORING OR DELETING PARTITIONS"
28421 #: ../tools/virt-resize.pl:228
28423 "virt-resize also gives a convenient way to ignore or delete partitions when "
28424 "copying from the input disk to the output disk. Ignoring a partition speeds "
28425 "up the copy where you don't care about the existing contents of a "
28426 "partition. Deleting a partition removes it completely, but note that it "
28427 "also renumbers any partitions after the one which is deleted, which can "
28428 "leave some guests unbootable."
28432 #: ../tools/virt-resize.pl:235
28433 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28437 #: ../tools/virt-resize.pl:237
28439 "If the input disk is in qcow2 format, then you may prefer that the output is "
28440 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28441 "the fly. The output format is simply determined by the format of the empty "
28442 "output container that you provide. Thus to create qcow2 output, use:"
28446 #: ../tools/virt-resize.pl:243
28449 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28454 #: ../tools/virt-resize.pl:245
28455 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28459 #: ../tools/virt-resize.pl:247
28460 msgid "Similarly, to get non-sparse raw output use:"
28464 #: ../tools/virt-resize.pl:249
28467 " fallocate -l size outdisk\n"
28472 #: ../tools/virt-resize.pl:251
28474 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
28475 "if=/dev/zero of=outdisk bs=1M count=..>)"
28479 #: ../tools/virt-resize.pl:264
28480 msgid "Display help."
28484 #: ../tools/virt-resize.pl:278
28485 msgid "B<--resize part=size>"
28489 #: ../tools/virt-resize.pl:280
28491 "Resize the named partition (expanding or shrinking it) so that it has the "
28496 #: ../tools/virt-resize.pl:283
28498 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28499 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28500 "Exabytes; or as a percentage of the current size; or as a relative number or "
28501 "percentage. For example:"
28505 #: ../tools/virt-resize.pl:288
28508 " --resize /dev/sda2=10G\n"
28513 #: ../tools/virt-resize.pl:290
28516 " --resize /dev/sda4=90%\n"
28521 #: ../tools/virt-resize.pl:292
28524 " --resize /dev/sda2=+1G\n"
28529 #: ../tools/virt-resize.pl:294
28532 " --resize /dev/sda2=-200M\n"
28537 #: ../tools/virt-resize.pl:296
28540 " --resize /dev/sda1=+128K\n"
28545 #: ../tools/virt-resize.pl:298
28548 " --resize /dev/sda1=+10%\n"
28553 #: ../tools/virt-resize.pl:300
28556 " --resize /dev/sda1=-10%\n"
28561 #: ../tools/virt-resize.pl:302
28563 "You can increase the size of any partition. Virt-resize will expand the "
28564 "direct content of the partition if it knows how (see C<--expand> below)."
28568 #: ../tools/virt-resize.pl:306
28570 "You can only I<decrease> the size of partitions that contain filesystems or "
28571 "PVs which have already been shrunk. Virt-resize will check this has been "
28572 "done before proceeding, or else will print an error (see also "
28573 "C<--resize-force>)."
28577 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
28578 msgid "You can give this option multiple times."
28582 #: ../tools/virt-resize.pl:317
28583 msgid "B<--resize-force part=size>"
28587 #: ../tools/virt-resize.pl:319
28589 "This is the same as C<--resize> except that it will let you decrease the "
28590 "size of any partition. Generally this means you will lose any data which "
28591 "was at the end of the partition you shrink, but you may not care about that "
28592 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28593 "as a swap partition)."
28597 #: ../tools/virt-resize.pl:325
28598 msgid "See also the C<--ignore> option."
28602 #: ../tools/virt-resize.pl:331
28603 msgid "B<--expand part>"
28607 #: ../tools/virt-resize.pl:333
28609 "Expand the named partition so it uses up all extra space (space left over "
28610 "after any other resize changes that you request have been done)."
28614 #: ../tools/virt-resize.pl:336
28616 "If virt-resize knows how, it will expand the direct content of the "
28617 "partition. For example, if the partition is an LVM PV, it will expand the "
28618 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28619 "content it doesn't know about alone."
28623 #: ../tools/virt-resize.pl:341
28624 msgid "Currently virt-resize can resize:"
28628 #: ../tools/virt-resize.pl:347
28630 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28635 #: ../tools/virt-resize.pl:352
28637 "NTFS filesystems contained directly in a partition, if libguestfs was "
28638 "compiled with support for NTFS."
28642 #: ../tools/virt-resize.pl:355
28644 "The filesystem must have been shut down consistently last time it was used. "
28645 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
28646 "consistency check, so at the first boot after resizing Windows will check "
28651 #: ../tools/virt-resize.pl:362
28653 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
28654 "inside the PV, but see the C<--LV-expand> option. The user could also "
28655 "resize LVs as desired after boot."
28659 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
28660 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
28664 #: ../tools/virt-resize.pl:374
28665 msgid "B<--shrink part>"
28669 #: ../tools/virt-resize.pl:376
28671 "Shrink the named partition until the overall disk image fits in the "
28672 "destination. The named partition B<must> contain a filesystem or PV which "
28673 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
28674 "online tools). Virt-resize will check this and give an error if it has not "
28679 #: ../tools/virt-resize.pl:382
28681 "The amount by which the overall disk must be shrunk (after carrying out all "
28682 "other operations requested by the user) is called the \"deficit\". For "
28683 "example, a straight copy (assume no other operations) from a 5GB disk image "
28684 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
28685 "would give an error unless the user specified a partition to shrink and that "
28686 "partition had more than a gigabyte of free space."
28690 #: ../tools/virt-resize.pl:396
28691 msgid "B<--ignore part>"
28695 #: ../tools/virt-resize.pl:398
28697 "Ignore the named partition. Effectively this means the partition is "
28698 "allocated on the destination disk, but the content is not copied across from "
28699 "the source disk. The content of the partition will be blank (all zero "
28704 #: ../tools/virt-resize.pl:409
28705 msgid "B<--delete part>"
28709 #: ../tools/virt-resize.pl:411
28711 "Delete the named partition. It would be more accurate to describe this as "
28712 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
28713 "the original disk image is left intact."
28717 #: ../tools/virt-resize.pl:415
28719 "Note that when you delete a partition, then anything contained in the "
28720 "partition is also deleted. Furthermore, this causes any partitions that "
28721 "come after to be I<renumbered>, which can easily make your guest unbootable."
28725 #: ../tools/virt-resize.pl:426
28726 msgid "B<--LV-expand logvol>"
28730 #: ../tools/virt-resize.pl:428
28732 "This takes the logical volume and, as a final step, expands it to fill all "
28733 "the space available in its volume group. A typical usage, assuming a Linux "
28734 "guest with a single PV C</dev/sda2> and a root device called "
28735 "C</dev/vg_guest/lv_root> would be:"
28739 #: ../tools/virt-resize.pl:433
28742 " virt-resize indisk outdisk \\\n"
28743 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
28748 #: ../tools/virt-resize.pl:436
28750 "This would first expand the partition (and PV), and then expand the root "
28751 "device to fill the extra space in the PV."
28755 #: ../tools/virt-resize.pl:439
28757 "The contents of the LV are also resized if virt-resize knows how to do "
28758 "that. You can stop virt-resize from trying to expand the content by using "
28759 "the option C<--no-expand-content>."
28763 #: ../tools/virt-resize.pl:443
28764 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
28768 #: ../tools/virt-resize.pl:446
28770 "You can give this option multiple times, I<but> it doesn't make sense to do "
28771 "this unless the logical volumes you specify are all in different volume "
28776 #: ../tools/virt-resize.pl:454
28777 msgid "B<--no-copy-boot-loader>"
28781 #: ../tools/virt-resize.pl:456
28783 "By default, virt-resize copies over some sectors at the start of the disk "
28784 "(up to the beginning of the first partition). Commonly these sectors "
28785 "contain the Master Boot Record (MBR) and the boot loader, and are required "
28786 "in order for the guest to boot correctly."
28790 #: ../tools/virt-resize.pl:461
28792 "If you specify this flag, then this initial copy is not done. You may need "
28793 "to reinstall the boot loader in this case."
28797 #: ../tools/virt-resize.pl:469
28798 msgid "B<--no-extra-partition>"
28802 #: ../tools/virt-resize.pl:471
28804 "By default, virt-resize creates an extra partition if there is any extra, "
28805 "unused space after all resizing has happened. Use this option to prevent "
28806 "the extra partition from being created. If you do this then the extra space "
28807 "will be inaccessible until you run fdisk, parted, or some other partitioning "
28808 "tool in the guest."
28812 #: ../tools/virt-resize.pl:477
28814 "Note that if the surplus space is smaller than 10 MB, no extra partition "
28819 #: ../tools/virt-resize.pl:484
28820 msgid "B<--no-expand-content>"
28824 #: ../tools/virt-resize.pl:486
28826 "By default, virt-resize will try to expand the direct contents of "
28827 "partitions, if it knows how (see C<--expand> option above)."
28831 #: ../tools/virt-resize.pl:489
28833 "If you give the C<--no-expand-content> option then virt-resize will not "
28838 #: ../tools/virt-resize.pl:496
28839 msgid "B<-d> | B<--debug>"
28843 #: ../tools/virt-resize.pl:504
28844 msgid "B<-n> | B<--dryrun>"
28848 #: ../tools/virt-resize.pl:506
28849 msgid "Print a summary of what would be done, but don't do anything."
28853 #: ../tools/virt-resize.pl:512
28854 msgid "B<-q> | B<--quiet>"
28858 #: ../tools/virt-resize.pl:514
28859 msgid "Don't print the summary."
28863 #: ../tools/virt-resize.pl:522
28865 "Specify the format of the input disk image. If this flag is not given then "
28866 "it is auto-detected from the image itself."
28870 #: ../tools/virt-resize.pl:528
28872 "Note that this option I<does not> affect the output format. See L</QCOW2 "
28873 "AND NON-SPARSE RAW FORMATS>."
28877 #: ../tools/virt-resize.pl:535
28878 msgid "B<--output-format> raw"
28882 #: ../tools/virt-resize.pl:537
28884 "Specify the format of the output disk image. If this flag is not given then "
28885 "it is auto-detected from the image itself."
28889 #: ../tools/virt-resize.pl:543
28891 "Note that you still need to create the output disk with the right format. "
28892 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28896 #: ../tools/virt-resize.pl:1419
28901 #: ../tools/virt-resize.pl:1421
28902 msgid "\"Partition 1 does not end on cylinder boundary.\""
28906 #: ../tools/virt-resize.pl:1423
28908 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28909 "means the partitions will not be aligned to the ancient CHS geometry. "
28910 "However CHS geometry is meaningless for disks manufactured since the early "
28911 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28912 "cylinders is not required by any modern operating system."
28916 #: ../tools/virt-resize.pl:1430
28917 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28921 #: ../tools/virt-resize.pl:1432
28923 "In Windows Vista and later versions, Microsoft switched to using a separate "
28924 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28925 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28926 "the boot partition. Doing so seems to break the guest completely. However "
28927 "expanding the second partition (ie. C: drive) should work."
28931 #: ../tools/virt-resize.pl:1439
28933 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28934 "NTFS partitions have been expanded. This is just a safety check and (unless "
28935 "it find errors) is nothing to worry about."
28939 #: ../tools/virt-resize.pl:1443
28940 msgid "GUEST BOOT STUCK AT \"GRUB\""
28944 #: ../tools/virt-resize.pl:1445
28946 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28947 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28948 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28949 "although we think is to do with partition alignment."
28953 #: ../tools/virt-resize.pl:1450
28956 " guestfish -i -a newdisk\n"
28957 " ><fs> cat /boot/grub/device.map\n"
28958 " # check the contents of this file are sensible or\n"
28959 " # edit the file if necessary\n"
28960 " ><fs> grub-install / /dev/vda\n"
28966 #: ../tools/virt-resize.pl:1457
28968 "For more flexible guest reconfiguration, including if you need to specify "
28969 "other parameters to grub-install, use L<virt-rescue(1)>."
28973 #: ../tools/virt-resize.pl:1460
28974 msgid "ALTERNATIVE TOOLS"
28978 #: ../tools/virt-resize.pl:1462
28980 "There are several proprietary tools for resizing partitions. We won't "
28981 "mention any here."
28985 #: ../tools/virt-resize.pl:1465
28987 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28988 "operations on disk images. They can resize and move partitions, but I don't "
28989 "think they can do anything with the contents, and they certainly don't "
28994 #: ../tools/virt-resize.pl:1470
28996 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28997 "but at a much lower level. You will probably end up hand-calculating sector "
28998 "offsets, which is something that virt-resize was designed to avoid. If you "
28999 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
29004 #: ../tools/virt-resize.pl:1485
29006 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
29007 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
29008 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
29009 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
29010 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29014 #: ../tools/virt-list-filesystems.pl:32
29015 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29019 #: ../tools/virt-list-filesystems.pl:36
29022 " virt-list-filesystems [--options] domname\n"
29027 #: ../tools/virt-list-filesystems.pl:38
29030 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29035 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29037 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29042 #: ../tools/virt-list-filesystems.pl:45
29044 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29045 "are contained in a virtual machine or disk image."
29049 #: ../tools/virt-list-filesystems.pl:49
29051 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29052 "functionality. For more complex cases you should look at the "
29053 "L<guestfish(1)> tool."
29057 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29058 msgid "B<-l> | B<--long>"
29062 #: ../tools/virt-list-filesystems.pl:108
29064 "With this option, C<virt-list-filesystems> displays the type of each "
29065 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29069 #: ../tools/virt-list-filesystems.pl:115
29070 msgid "B<-a> | B<--all>"
29074 #: ../tools/virt-list-filesystems.pl:117
29076 "Normally we only show mountable filesystems. If this option is given then "
29077 "swap devices are shown too."
29081 #: ../tools/virt-list-filesystems.pl:191
29083 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29084 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29085 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29089 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
29090 msgid "Copyright (C) 2009 Red Hat Inc."
29094 #: ../tools/virt-tar.pl:33
29095 msgid "virt-tar - Extract or upload files to a virtual machine"
29099 #: ../tools/virt-tar.pl:37
29102 " virt-tar [--options] -x domname directory tarball\n"
29107 #: ../tools/virt-tar.pl:39
29110 " virt-tar [--options] -u domname tarball directory\n"
29115 #: ../tools/virt-tar.pl:41
29118 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29123 #: ../tools/virt-tar.pl:43
29126 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29131 #: ../tools/virt-tar.pl:47
29132 msgid "Download C</home> from the VM into a local tarball:"
29136 #: ../tools/virt-tar.pl:49
29139 " virt-tar -x domname /home home.tar\n"
29144 #: ../tools/virt-tar.pl:51
29147 " virt-tar -zx domname /home home.tar.gz\n"
29152 #: ../tools/virt-tar.pl:53
29153 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29157 #: ../tools/virt-tar.pl:55
29160 " virt-tar -u domname uploadstuff.tar /tmp\n"
29165 #: ../tools/virt-tar.pl:57
29168 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29173 #: ../tools/virt-tar.pl:61
29175 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
29176 "virtual machines. If you do this, you risk disk corruption in the VM. "
29177 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29181 #: ../tools/virt-tar.pl:66
29183 "You can use C<-x> (extract) on live virtual machines, but you might get "
29184 "inconsistent results or errors if there is filesystem activity inside the "
29185 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29186 "work, but the only way to guarantee consistent results is if the virtual "
29187 "machine is shut down."
29191 #: ../tools/virt-tar.pl:74
29193 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29194 "parts of a guest filesystem. There are many possibilities: making backups, "
29195 "uploading data files, snooping on guest activity, fixing or customizing "
29200 #: ../tools/virt-tar.pl:79
29202 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29203 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29204 "should look at the L<guestfish(1)> tool."
29208 #: ../tools/virt-tar.pl:83
29210 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
29211 "its contents (recursively) from the virtual machine into a local tarball. "
29212 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
29213 "virtual machine. You cannot use these two options together."
29217 #: ../tools/virt-tar.pl:89
29219 "In addition, you may need to use the C<-z> (gZip) option to enable "
29220 "compression. When uploading, you have to specify C<-z> if the upload file "
29221 "is compressed because virt-tar won't detect this on its own."
29225 #: ../tools/virt-tar.pl:93
29227 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29228 "example it cannot do PKZip files or bzip2 compression. If you want that "
29229 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29230 "the L<libguestfs(3)> API)."
29234 #: ../tools/virt-tar.pl:151
29235 msgid "B<-x> | B<--extract> | B<--download>"
29239 #: ../tools/virt-tar.pl:153
29240 msgid "B<-u> | B<--upload>"
29244 #: ../tools/virt-tar.pl:155
29246 "Use C<-x> to extract (download) a directory from a virtual machine to a "
29251 #: ../tools/virt-tar.pl:158
29253 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
29254 "Please read the L</WARNING> section above before using this option."
29258 #: ../tools/virt-tar.pl:162
29259 msgid "You must specify exactly one of these options."
29263 #: ../tools/virt-tar.pl:168
29264 msgid "B<-z> | B<--gzip>"
29268 #: ../tools/virt-tar.pl:170
29269 msgid "Specify that the input or output tarball is gzip-compressed."
29273 #: ../tools/virt-tar.pl:283
29275 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29276 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29277 "L<http://libguestfs.org/>."
29281 #: ../tools/virt-make-fs.pl:37
29282 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29286 #: ../tools/virt-make-fs.pl:41
29289 " virt-make-fs [--options] input.tar output.img\n"
29294 #: ../tools/virt-make-fs.pl:43
29297 " virt-make-fs [--options] input.tar.gz output.img\n"
29302 #: ../tools/virt-make-fs.pl:45
29305 " virt-make-fs [--options] directory output.img\n"
29310 #: ../tools/virt-make-fs.pl:49
29312 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29313 "archive or some files in a directory. It is similar to tools like "
29314 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29315 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29316 "useful if you want to attach these filesystems to existing virtual machines "
29317 "(eg. to import large amounts of read-only data to a VM)."
29321 #: ../tools/virt-make-fs.pl:57
29322 msgid "Basic usage is:"
29326 #: ../tools/virt-make-fs.pl:59
29329 " virt-make-fs input output\n"
29334 #: ../tools/virt-make-fs.pl:61
29336 "where C<input> is either a directory containing files that you want to add, "
29337 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29338 "C<output> is a disk image. The input type is detected automatically. The "
29339 "output disk image defaults to a raw ext2 image unless you specify extra "
29340 "flags (see L</OPTIONS> below)."
29344 #: ../tools/virt-make-fs.pl:67
29345 msgid "EXTRA SPACE"
29349 #: ../tools/virt-make-fs.pl:69
29351 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29352 "the files that it contains, but might have extra space. Depending on how "
29353 "you are going to use the output, you might think this extra space is wasted "
29354 "and want to minimize it, or you might want to leave space so that more files "
29355 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29356 "but you can use the C<--size> flag to leave space in the filesystem if you "
29361 #: ../tools/virt-make-fs.pl:77
29363 "An alternative way to leave extra space but not make the output image any "
29364 "bigger is to use an alternative disk image format (instead of the default "
29365 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29366 "image format (check your hypervisor supports this before using it). This "
29367 "allows you to choose a large C<--size> but the extra space won't actually be "
29368 "allocated in the image until you try to store something in it."
29372 #: ../tools/virt-make-fs.pl:85
29374 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29375 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29376 "to build another image from scratch."
29380 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29385 #: ../tools/virt-make-fs.pl:91
29388 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29393 #: ../tools/virt-make-fs.pl:93
29394 msgid "FILESYSTEM TYPE"
29398 #: ../tools/virt-make-fs.pl:95
29400 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29401 "libguestfs supports can be used (but I<not> read-only formats like "
29402 "ISO9660). Here are some of the more common choices:"
29406 #: ../tools/virt-make-fs.pl:101
29411 #: ../tools/virt-make-fs.pl:103
29413 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29414 "you are not going to use the filesystem in a way that requires the journal, "
29415 "then this is just wasted overhead."
29419 #: ../tools/virt-make-fs.pl:107
29420 msgid "I<ntfs> or I<vfat>"
29424 #: ../tools/virt-make-fs.pl:109
29425 msgid "Useful if exporting data to a Windows guest."
29429 #: ../tools/virt-make-fs.pl:111
29431 "I<Note for vfat>: The tar archive or local directory must only contain files "
29432 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29433 "program running within libguestfs is unable to change the ownership of "
29434 "non-root files, since vfat itself does not support this."
29438 #: ../tools/virt-make-fs.pl:116
29443 #: ../tools/virt-make-fs.pl:118
29445 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29446 "total filesystem size."
29450 #: ../tools/virt-make-fs.pl:125
29453 " virt-make-fs --type=minix input minixfs.img\n"
29458 #: ../tools/virt-make-fs.pl:127
29459 msgid "TO PARTITION OR NOT TO PARTITION"
29463 #: ../tools/virt-make-fs.pl:129
29464 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29468 #: ../tools/virt-make-fs.pl:131
29470 "Adding a partition can make the disk image more compatible with certain "
29471 "virtualized operating systems which don't expect to see a filesystem "
29472 "directly located on a block device (Linux doesn't care and will happily "
29473 "handle both types)."
29477 #: ../tools/virt-make-fs.pl:136
29479 "On the other hand, if you have a partition table then the output image is no "
29480 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29481 "directly on a partitioned disk image. (However libguestfs tools such as "
29482 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29486 #: ../tools/virt-make-fs.pl:144
29487 msgid "Add an MBR partition:"
29491 #: ../tools/virt-make-fs.pl:146
29494 " virt-make-fs --partition -- input disk.img\n"
29499 #: ../tools/virt-make-fs.pl:148
29501 "If the output disk image could be terabyte-sized or larger, it's better to "
29502 "use an EFI/GPT-compatible partition table:"
29506 #: ../tools/virt-make-fs.pl:151
29509 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29514 #: ../tools/virt-make-fs.pl:179
29515 msgid "Enable debugging information."
29519 #: ../tools/virt-make-fs.pl:185
29520 msgid "B<--size=E<lt>NE<gt>>"
29524 #: ../tools/virt-make-fs.pl:187
29525 msgid "B<--size=+E<lt>NE<gt>>"
29529 #: ../tools/virt-make-fs.pl:189
29530 msgid "B<-s E<lt>NE<gt>>"
29534 #: ../tools/virt-make-fs.pl:191
29535 msgid "B<-s +E<lt>NE<gt>>"
29539 #: ../tools/virt-make-fs.pl:193
29540 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29544 #: ../tools/virt-make-fs.pl:196
29546 "If this option is I<not> given, then the output image will be just large "
29547 "enough to contain all the files, with not much wasted space."
29551 #: ../tools/virt-make-fs.pl:199
29553 "To choose a fixed size output disk, specify an absolute number followed by "
29554 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29555 "Petabytes or Exabytes. This must be large enough to contain all the input "
29556 "files, else you will get an error."
29560 #: ../tools/virt-make-fs.pl:204
29562 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29563 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29564 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29565 "the input files, and (approximately) an extra 200 MB free space."
29569 #: ../tools/virt-make-fs.pl:210
29571 "Note that virt-make-fs estimates free space, and therefore will not produce "
29572 "filesystems containing precisely the free space requested. (It is much more "
29573 "expensive and time-consuming to produce a filesystem which has precisely the "
29574 "desired free space)."
29578 #: ../tools/virt-make-fs.pl:219
29579 msgid "B<--format=E<lt>fmtE<gt>>"
29583 #: ../tools/virt-make-fs.pl:221
29584 msgid "B<-F E<lt>fmtE<gt>>"
29588 #: ../tools/virt-make-fs.pl:223
29589 msgid "Choose the output disk image format."
29593 #: ../tools/virt-make-fs.pl:225
29594 msgid "The default is C<raw> (raw disk image)."
29598 #: ../tools/virt-make-fs.pl:227
29600 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29601 "that would really make sense here is C<qcow2>."
29605 #: ../tools/virt-make-fs.pl:234
29606 msgid "B<--type=E<lt>fsE<gt>>"
29610 #: ../tools/virt-make-fs.pl:236
29611 msgid "B<-t E<lt>fsE<gt>>"
29615 #: ../tools/virt-make-fs.pl:238
29616 msgid "Choose the output filesystem type."
29620 #: ../tools/virt-make-fs.pl:240
29621 msgid "The default is C<ext2>."
29625 #: ../tools/virt-make-fs.pl:242
29626 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29630 #: ../tools/virt-make-fs.pl:249
29631 msgid "B<--partition>"
29635 #: ../tools/virt-make-fs.pl:251
29636 msgid "B<--partition=E<lt>parttypeE<gt>>"
29640 #: ../tools/virt-make-fs.pl:253
29642 "If specified, this flag adds an MBR partition table to the output disk "
29647 #: ../tools/virt-make-fs.pl:256
29649 "You can change the partition table type, eg. C<--partition=gpt> for large "
29654 #: ../tools/virt-make-fs.pl:259
29656 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29657 "might consider the next parameter to be the partition type. For example:"
29661 #: ../tools/virt-make-fs.pl:263
29664 " virt-make-fs --partition input.tar ...\n"
29669 #: ../tools/virt-make-fs.pl:265
29671 "would cause virt-make-fs to think you wanted to use a partition type of "
29672 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29673 "dash) between options and the input file argument:"
29677 #: ../tools/virt-make-fs.pl:269
29680 " virt-make-fs --partition -- input.tar ...\n"
29685 #: ../tools/virt-make-fs.pl:541
29687 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
29688 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29689 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29693 #: ../tools/virt-make-fs.pl:558
29696 " export LIBGUESTFS_DEBUG=1\n"
29697 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29702 #: ../tools/virt-make-fs.pl:561
29704 "Attach /tmp/virt-make-fs.log to a new bug report at "
29705 "L<https://bugzilla.redhat.com/>"
29709 #: ../tools/virt-list-partitions.pl:32
29710 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29714 #: ../tools/virt-list-partitions.pl:36
29717 " virt-list-partitions [--options] domname\n"
29722 #: ../tools/virt-list-partitions.pl:38
29725 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29730 #: ../tools/virt-list-partitions.pl:45
29732 "C<virt-list-partitions> is a command line tool to list the partitions that "
29733 "are contained in a virtual machine or disk image. It is mainly useful as a "
29734 "first step to using L<virt-resize(1)>."
29738 #: ../tools/virt-list-partitions.pl:50
29740 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29741 "functionality. For more complex cases you should look at the "
29742 "L<guestfish(1)> tool."
29746 #: ../tools/virt-list-partitions.pl:107
29747 msgid "B<-h> | B<--human-readable>"
29751 #: ../tools/virt-list-partitions.pl:109
29752 msgid "Show sizes in human-readable form (eg. \"1G\")."
29756 #: ../tools/virt-list-partitions.pl:117
29758 "With this option, C<virt-list-partitions> displays the type and size of each "
29759 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29763 #: ../tools/virt-list-partitions.pl:124
29764 msgid "B<-t> | B<--total>"
29768 #: ../tools/virt-list-partitions.pl:126
29769 msgid "Display the total size of each block device (as a separate row or rows)."
29773 #: ../tools/virt-list-partitions.pl:259
29775 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29776 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29777 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29781 #: ../tools/virt-list-partitions.pl:275
29782 msgid "Copyright (C) 2009-2010 Red Hat Inc."